lavc: Add an internal wrapper around get_format()
[libav.git] / libavcodec / internal.h
1 /*
2 * This file is part of Libav.
3 *
4 * Libav is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * Libav is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with Libav; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18
19 /**
20 * @file
21 * common internal api header.
22 */
23
24 #ifndef AVCODEC_INTERNAL_H
25 #define AVCODEC_INTERNAL_H
26
27 #include <stdint.h>
28
29 #include "libavutil/buffer.h"
30 #include "libavutil/channel_layout.h"
31 #include "libavutil/mathematics.h"
32 #include "libavutil/pixfmt.h"
33 #include "avcodec.h"
34 #include "config.h"
35
36 #define FF_SANE_NB_CHANNELS 63U
37
38 typedef struct FramePool {
39 /**
40 * Pools for each data plane. For audio all the planes have the same size,
41 * so only pools[0] is used.
42 */
43 AVBufferPool *pools[4];
44
45 /*
46 * Pool parameters
47 */
48 int format;
49 int width, height;
50 int stride_align[AV_NUM_DATA_POINTERS];
51 int linesize[4];
52 int planes;
53 int channels;
54 int samples;
55 } FramePool;
56
57 typedef struct AVCodecInternal {
58 /**
59 * Whether the parent AVCodecContext is a copy of the context which had
60 * init() called on it.
61 * This is used by multithreading - shared tables and picture pointers
62 * should be freed from the original context only.
63 */
64 int is_copy;
65
66 /**
67 * Whether to allocate progress for frame threading.
68 *
69 * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
70 * then progress will be allocated in ff_thread_get_buffer(). The frames
71 * then MUST be freed with ff_thread_release_buffer().
72 *
73 * If the codec does not need to call the progress functions (there are no
74 * dependencies between the frames), it should leave this at 0. Then it can
75 * decode straight to the user-provided frames (which the user will then
76 * free with av_frame_unref()), there is no need to call
77 * ff_thread_release_buffer().
78 */
79 int allocate_progress;
80
81 /**
82 * An audio frame with less than required samples has been submitted and
83 * padded with silence. Reject all subsequent frames.
84 */
85 int last_audio_frame;
86
87 AVFrame *to_free;
88
89 FramePool *pool;
90
91 void *thread_ctx;
92
93 /**
94 * Current packet as passed into the decoder, to avoid having to pass the
95 * packet into every function.
96 */
97 AVPacket *pkt;
98 } AVCodecInternal;
99
100 struct AVCodecDefault {
101 const uint8_t *key;
102 const uint8_t *value;
103 };
104
105 /**
106 * Return the hardware accelerated codec for codec codec_id and
107 * pixel format pix_fmt.
108 *
109 * @param avctx The codec context containing the codec_id and pixel format.
110 * @return the hardware accelerated codec, or NULL if none was found.
111 */
112 AVHWAccel *ff_find_hwaccel(AVCodecContext *avctx);
113
114 /**
115 * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
116 * If there is no such matching pair then size is returned.
117 */
118 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
119
120 unsigned int avpriv_toupper4(unsigned int x);
121
122 int avpriv_lock_avformat(void);
123 int avpriv_unlock_avformat(void);
124
125 /**
126 * Maximum size in bytes of extradata.
127 * This value was chosen such that every bit of the buffer is
128 * addressable by a 32-bit signed integer as used by get_bits.
129 */
130 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - FF_INPUT_BUFFER_PADDING_SIZE)
131
132 /**
133 * Check AVPacket size and/or allocate data.
134 *
135 * Encoders supporting AVCodec.encode2() can use this as a convenience to
136 * ensure the output packet data is large enough, whether provided by the user
137 * or allocated in this function.
138 *
139 * @param avpkt the AVPacket
140 * If avpkt->data is already set, avpkt->size is checked
141 * to ensure it is large enough.
142 * If avpkt->data is NULL, a new buffer is allocated.
143 * avpkt->size is set to the specified size.
144 * All other AVPacket fields will be reset with av_init_packet().
145 * @param size the minimum required packet size
146 * @return 0 on success, negative error code on failure
147 */
148 int ff_alloc_packet(AVPacket *avpkt, int size);
149
150 /**
151 * Rescale from sample rate to AVCodecContext.time_base.
152 */
153 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
154 int64_t samples)
155 {
156 return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
157 avctx->time_base);
158 }
159
160 /**
161 * Get a buffer for a frame. This is a wrapper around
162 * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
163 * directly.
164 */
165 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
166
167 /**
168 * Identical in function to av_frame_make_writable(), except it uses
169 * ff_get_buffer() to allocate the buffer when needed.
170 */
171 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
172
173 const uint8_t *avpriv_find_start_code(const uint8_t *restrict p,
174 const uint8_t *end,
175 uint32_t *restrict state);
176
177 /**
178 * Check that the provided frame dimensions are valid and set them on the codec
179 * context.
180 */
181 int ff_set_dimensions(AVCodecContext *s, int width, int height);
182
183 /**
184 * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
185 */
186 int ff_side_data_update_matrix_encoding(AVFrame *frame,
187 enum AVMatrixEncoding matrix_encoding);
188
189 /**
190 * Select the (possibly hardware accelerated) pixel format.
191 * This is a wrapper around AVCodecContext.get_format() and should be used
192 * instead of calling get_format() directly.
193 */
194 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
195
196 /**
197 * Set various frame properties from the codec context / packet data.
198 */
199 int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
200
201 #endif /* AVCODEC_INTERNAL_H */