2 * This file is part of FFmpeg.
4 * FFmpeg 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.
9 * FFmpeg 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.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with FFmpeg; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 * common internal api header.
24 #ifndef AVCODEC_INTERNAL_H
25 #define AVCODEC_INTERNAL_H
29 #include "libavutil/buffer.h"
30 #include "libavutil/channel_layout.h"
31 #include "libavutil/mathematics.h"
32 #include "libavutil/pixfmt.h"
37 * The codec does not modify any global variables in the init function,
38 * allowing to call the init function without locking any global mutexes.
40 #define FF_CODEC_CAP_INIT_THREADSAFE (1 << 0)
42 * The codec allows calling the close function for deallocation even if
43 * the init function returned a failure. Without this capability flag, a
44 * codec does such cleanup internally when returning failures from the
45 * init function and does not expect the close function to be called at
48 #define FF_CODEC_CAP_INIT_CLEANUP (1 << 1)
50 * Decoders marked with FF_CODEC_CAP_SETS_PKT_DTS want to set
51 * AVFrame.pkt_dts manually. If the flag is set, utils.c won't overwrite
52 * this field. If it's unset, utils.c tries to guess the pkt_dts field
53 * from the input AVPacket.
55 #define FF_CODEC_CAP_SETS_PKT_DTS (1 << 2)
58 # define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
60 # define ff_tlog(ctx, ...) do {} while(0)
64 #if !FF_API_QUANT_BIAS
65 #define FF_DEFAULT_QUANT_BIAS 999999
68 #define FF_SANE_NB_CHANNELS 64U
70 #define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
73 # define STRIDE_ALIGN 32
74 #elif HAVE_SIMD_ALIGN_16
75 # define STRIDE_ALIGN 16
77 # define STRIDE_ALIGN 8
80 typedef struct FramePool {
82 * Pools for each data plane. For audio all the planes have the same size,
83 * so only pools[0] is used.
85 AVBufferPool *pools[4];
92 int stride_align[AV_NUM_DATA_POINTERS];
99 typedef struct AVCodecInternal {
101 * Whether the parent AVCodecContext is a copy of the context which had
102 * init() called on it.
103 * This is used by multithreading - shared tables and picture pointers
104 * should be freed from the original context only.
109 * Whether to allocate progress for frame threading.
111 * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
112 * then progress will be allocated in ff_thread_get_buffer(). The frames
113 * then MUST be freed with ff_thread_release_buffer().
115 * If the codec does not need to call the progress functions (there are no
116 * dependencies between the frames), it should leave this at 0. Then it can
117 * decode straight to the user-provided frames (which the user will then
118 * free with av_frame_unref()), there is no need to call
119 * ff_thread_release_buffer().
121 int allocate_progress;
124 * An audio frame with less than required samples has been submitted and
125 * padded with silence. Reject all subsequent frames.
127 int last_audio_frame;
136 * Current packet as passed into the decoder, to avoid having to pass the
137 * packet into every function.
142 * temporary buffer used for encoders to store their bitstream
144 uint8_t *byte_buffer;
145 unsigned int byte_buffer_size;
147 void *frame_thread_encoder;
150 * Number of audio samples to skip at the start of the next decoded frame
155 * hwaccel-specific private data
157 void *hwaccel_priv_data;
160 struct AVCodecDefault {
162 const uint8_t *value;
165 extern const uint8_t ff_log2_run[41];
168 * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
169 * If there is no such matching pair then size is returned.
171 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
173 unsigned int avpriv_toupper4(unsigned int x);
176 * does needed setup of pkt_pts/pos and such for (re)get_buffer();
178 int ff_init_buffer_info(AVCodecContext *s, AVFrame *frame);
181 void avpriv_color_frame(AVFrame *frame, const int color[4]);
183 extern volatile int ff_avcodec_locked;
184 int ff_lock_avcodec(AVCodecContext *log_ctx, const AVCodec *codec);
185 int ff_unlock_avcodec(void);
187 int avpriv_lock_avformat(void);
188 int avpriv_unlock_avformat(void);
191 * Maximum size in bytes of extradata.
192 * This value was chosen such that every bit of the buffer is
193 * addressable by a 32-bit signed integer as used by get_bits.
195 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
198 * Check AVPacket size and/or allocate data.
200 * Encoders supporting AVCodec.encode2() can use this as a convenience to
201 * ensure the output packet data is large enough, whether provided by the user
202 * or allocated in this function.
204 * @param avctx the AVCodecContext of the encoder
205 * @param avpkt the AVPacket
206 * If avpkt->data is already set, avpkt->size is checked
207 * to ensure it is large enough.
208 * If avpkt->data is NULL, a new buffer is allocated.
209 * avpkt->size is set to the specified size.
210 * All other AVPacket fields will be reset with av_init_packet().
211 * @param size the minimum required packet size
212 * @param min_size This is a hint to the allocation algorithm, which indicates
213 * to what minimal size the caller might later shrink the packet
214 * to. Encoders often allocate packets which are larger than the
215 * amount of data that is written into them as the exact amount is
216 * not known at the time of allocation. min_size represents the
217 * size a packet might be shrunk to by the caller. Can be set to
218 * 0. setting this roughly correctly allows the allocation code
219 * to choose between several allocation strategies to improve
221 * @return non negative on success, negative error code on failure
223 int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
225 attribute_deprecated int ff_alloc_packet(AVPacket *avpkt, int size);
228 * Rescale from sample rate to AVCodecContext.time_base.
230 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
233 if(samples == AV_NOPTS_VALUE)
234 return AV_NOPTS_VALUE;
235 return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
240 * Get a buffer for a frame. This is a wrapper around
241 * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
244 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
247 * Identical in function to av_frame_make_writable(), except it uses
248 * ff_get_buffer() to allocate the buffer when needed.
250 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
252 int ff_thread_can_start_frame(AVCodecContext *avctx);
254 int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx);
257 * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
258 * calling the function and then restoring again. Assumes the mutex is
261 int ff_codec_open2_recursive(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
264 * Finalize buf into extradata and set its size appropriately.
266 int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf);
268 const uint8_t *avpriv_find_start_code(const uint8_t *p,
273 * Check that the provided frame dimensions are valid and set them on the codec
276 int ff_set_dimensions(AVCodecContext *s, int width, int height);
279 * Check that the provided sample aspect ratio is valid and set it on the codec
282 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
285 * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
287 int ff_side_data_update_matrix_encoding(AVFrame *frame,
288 enum AVMatrixEncoding matrix_encoding);
291 * Select the (possibly hardware accelerated) pixel format.
292 * This is a wrapper around AVCodecContext.get_format() and should be used
293 * instead of calling get_format() directly.
295 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
298 * Set various frame properties from the codec context / packet data.
300 int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
302 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type);
304 #endif /* AVCODEC_INTERNAL_H */