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)
57 * The decoder extracts and fills its parameters even if the frame is
58 * skipped due to the skip_frame setting.
60 #define FF_CODEC_CAP_SKIP_FRAME_FILL_PARAM (1 << 3)
63 # define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
65 # define ff_tlog(ctx, ...) do { } while(0)
69 #if !FF_API_QUANT_BIAS
70 #define FF_DEFAULT_QUANT_BIAS 999999
73 #define FF_SANE_NB_CHANNELS 64U
75 #define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
77 #if HAVE_SIMD_ALIGN_32
78 # define STRIDE_ALIGN 32
79 #elif HAVE_SIMD_ALIGN_16
80 # define STRIDE_ALIGN 16
82 # define STRIDE_ALIGN 8
85 typedef struct FramePool {
87 * Pools for each data plane. For audio all the planes have the same size,
88 * so only pools[0] is used.
90 AVBufferPool *pools[4];
97 int stride_align[AV_NUM_DATA_POINTERS];
104 typedef struct AVCodecInternal {
106 * Whether the parent AVCodecContext is a copy of the context which had
107 * init() called on it.
108 * This is used by multithreading - shared tables and picture pointers
109 * should be freed from the original context only.
114 * Whether to allocate progress for frame threading.
116 * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
117 * then progress will be allocated in ff_thread_get_buffer(). The frames
118 * then MUST be freed with ff_thread_release_buffer().
120 * If the codec does not need to call the progress functions (there are no
121 * dependencies between the frames), it should leave this at 0. Then it can
122 * decode straight to the user-provided frames (which the user will then
123 * free with av_frame_unref()), there is no need to call
124 * ff_thread_release_buffer().
126 int allocate_progress;
129 * An audio frame with less than required samples has been submitted and
130 * padded with silence. Reject all subsequent frames.
132 int last_audio_frame;
141 * Current packet as passed into the decoder, to avoid having to pass the
142 * packet into every function.
147 * temporary buffer used for encoders to store their bitstream
149 uint8_t *byte_buffer;
150 unsigned int byte_buffer_size;
152 void *frame_thread_encoder;
155 * Number of audio samples to skip at the start of the next decoded frame
160 * hwaccel-specific private data
162 void *hwaccel_priv_data;
165 * checks API usage: after codec draining, flush is required to resume operation
170 * buffers for using new encode/decode API through legacy API
172 AVPacket *buffer_pkt;
173 int buffer_pkt_valid; // encoding: packet without data can be valid
174 AVFrame *buffer_frame;
176 int showed_multi_packet_warning;
178 int skip_samples_multiplier;
181 struct AVCodecDefault {
183 const uint8_t *value;
186 extern const uint8_t ff_log2_run[41];
189 * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
190 * If there is no such matching pair then size is returned.
192 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
194 unsigned int avpriv_toupper4(unsigned int x);
197 * does needed setup of pkt_pts/pos and such for (re)get_buffer();
199 int ff_init_buffer_info(AVCodecContext *s, AVFrame *frame);
202 void ff_color_frame(AVFrame *frame, const int color[4]);
204 extern volatile int ff_avcodec_locked;
205 int ff_lock_avcodec(AVCodecContext *log_ctx, const AVCodec *codec);
206 int ff_unlock_avcodec(const AVCodec *codec);
208 int avpriv_lock_avformat(void);
209 int avpriv_unlock_avformat(void);
212 * Maximum size in bytes of extradata.
213 * This value was chosen such that every bit of the buffer is
214 * addressable by a 32-bit signed integer as used by get_bits.
216 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
219 * Check AVPacket size and/or allocate data.
221 * Encoders supporting AVCodec.encode2() can use this as a convenience to
222 * ensure the output packet data is large enough, whether provided by the user
223 * or allocated in this function.
225 * @param avctx the AVCodecContext of the encoder
226 * @param avpkt the AVPacket
227 * If avpkt->data is already set, avpkt->size is checked
228 * to ensure it is large enough.
229 * If avpkt->data is NULL, a new buffer is allocated.
230 * avpkt->size is set to the specified size.
231 * All other AVPacket fields will be reset with av_init_packet().
232 * @param size the minimum required packet size
233 * @param min_size This is a hint to the allocation algorithm, which indicates
234 * to what minimal size the caller might later shrink the packet
235 * to. Encoders often allocate packets which are larger than the
236 * amount of data that is written into them as the exact amount is
237 * not known at the time of allocation. min_size represents the
238 * size a packet might be shrunk to by the caller. Can be set to
239 * 0. setting this roughly correctly allows the allocation code
240 * to choose between several allocation strategies to improve
242 * @return non negative on success, negative error code on failure
244 int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
246 attribute_deprecated int ff_alloc_packet(AVPacket *avpkt, int size);
249 * Rescale from sample rate to AVCodecContext.time_base.
251 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
254 if(samples == AV_NOPTS_VALUE)
255 return AV_NOPTS_VALUE;
256 return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
261 * 2^(x) for integer x
262 * @return correctly rounded float
264 static av_always_inline float ff_exp2fi(int x) {
266 if (-126 <= x && x <= 128)
267 return av_int2float((x+127) << 23);
271 /* Subnormal numbers */
273 return av_int2float(1 << (x+149));
274 /* Negligibly small */
280 * Get a buffer for a frame. This is a wrapper around
281 * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
284 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
287 * Identical in function to av_frame_make_writable(), except it uses
288 * ff_get_buffer() to allocate the buffer when needed.
290 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
292 int ff_thread_can_start_frame(AVCodecContext *avctx);
294 int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx);
297 * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
298 * calling the function and then restoring again. Assumes the mutex is
301 int ff_codec_open2_recursive(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
304 * Finalize buf into extradata and set its size appropriately.
306 int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf);
308 const uint8_t *avpriv_find_start_code(const uint8_t *p,
312 int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec);
315 * Check that the provided frame dimensions are valid and set them on the codec
318 int ff_set_dimensions(AVCodecContext *s, int width, int height);
321 * Check that the provided sample aspect ratio is valid and set it on the codec
324 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
327 * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
329 int ff_side_data_update_matrix_encoding(AVFrame *frame,
330 enum AVMatrixEncoding matrix_encoding);
333 * Select the (possibly hardware accelerated) pixel format.
334 * This is a wrapper around AVCodecContext.get_format() and should be used
335 * instead of calling get_format() directly.
337 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
340 * Set various frame properties from the codec context / packet data.
342 int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
345 * Add a CPB properties side data to an encoding context.
347 AVCPBProperties *ff_add_cpb_side_data(AVCodecContext *avctx);
349 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type);
352 * Check AVFrame for A53 side data and allocate and fill SEI message with A53 info
354 * @param frame Raw frame to get A53 side data from
355 * @param prefix_len Number of bytes to allocate before SEI message
356 * @param data Pointer to a variable to store allocated memory
357 * Upon return the variable will hold NULL on error or if frame has no A53 info.
358 * Otherwise it will point to prefix_len uninitialized bytes followed by
359 * *sei_size SEI message
360 * @param sei_size Pointer to a variable to store generated SEI message length
361 * @return Zero on success, negative error code on failure
363 int ff_alloc_a53_sei(const AVFrame *frame, size_t prefix_len,
364 void **data, size_t *sei_size);
367 * Get an estimated video bitrate based on frame size, frame rate and coded
370 int64_t ff_guess_coded_bitrate(AVCodecContext *avctx);
372 #endif /* AVCODEC_INTERNAL_H */