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 DecodeSimpleContext {
107 } DecodeSimpleContext;
109 typedef struct DecodeFilterContext {
112 } DecodeFilterContext;
114 typedef struct AVCodecInternal {
116 * Whether the parent AVCodecContext is a copy of the context which had
117 * init() called on it.
118 * This is used by multithreading - shared tables and picture pointers
119 * should be freed from the original context only.
124 * Whether to allocate progress for frame threading.
126 * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
127 * then progress will be allocated in ff_thread_get_buffer(). The frames
128 * then MUST be freed with ff_thread_release_buffer().
130 * If the codec does not need to call the progress functions (there are no
131 * dependencies between the frames), it should leave this at 0. Then it can
132 * decode straight to the user-provided frames (which the user will then
133 * free with av_frame_unref()), there is no need to call
134 * ff_thread_release_buffer().
136 int allocate_progress;
139 * An audio frame with less than required samples has been submitted and
140 * padded with silence. Reject all subsequent frames.
142 int last_audio_frame;
150 DecodeSimpleContext ds;
151 DecodeFilterContext filter;
154 * Properties (timestamps+side data) extracted from the last packet passed
157 AVPacket *last_pkt_props;
160 * temporary buffer used for encoders to store their bitstream
162 uint8_t *byte_buffer;
163 unsigned int byte_buffer_size;
165 void *frame_thread_encoder;
168 * Number of audio samples to skip at the start of the next decoded frame
173 * hwaccel-specific private data
175 void *hwaccel_priv_data;
178 * checks API usage: after codec draining, flush is required to resume operation
183 * buffers for using new encode/decode API through legacy API
185 AVPacket *buffer_pkt;
186 int buffer_pkt_valid; // encoding: packet without data can be valid
187 AVFrame *buffer_frame;
189 /* set to 1 when the caller is using the old decoding API */
191 int compat_decode_warned;
192 /* this variable is set by the decoder internals to signal to the old
193 * API compat wrappers the amount of data consumed from the last packet */
194 size_t compat_decode_consumed;
195 /* when a partial packet has been consumed, this stores the remaining size
196 * of the packet (that should be submitted in the next decode call */
197 size_t compat_decode_partial_size;
198 AVFrame *compat_decode_frame;
200 int showed_multi_packet_warning;
202 int skip_samples_multiplier;
205 struct AVCodecDefault {
207 const uint8_t *value;
210 extern const uint8_t ff_log2_run[41];
213 * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
214 * If there is no such matching pair then size is returned.
216 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
218 unsigned int avpriv_toupper4(unsigned int x);
221 * does needed setup of pkt_pts/pos and such for (re)get_buffer();
223 int ff_init_buffer_info(AVCodecContext *s, AVFrame *frame);
226 void ff_color_frame(AVFrame *frame, const int color[4]);
228 extern volatile int ff_avcodec_locked;
229 int ff_lock_avcodec(AVCodecContext *log_ctx, const AVCodec *codec);
230 int ff_unlock_avcodec(const AVCodec *codec);
232 int avpriv_lock_avformat(void);
233 int avpriv_unlock_avformat(void);
236 * Maximum size in bytes of extradata.
237 * This value was chosen such that every bit of the buffer is
238 * addressable by a 32-bit signed integer as used by get_bits.
240 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
243 * Check AVPacket size and/or allocate data.
245 * Encoders supporting AVCodec.encode2() can use this as a convenience to
246 * ensure the output packet data is large enough, whether provided by the user
247 * or allocated in this function.
249 * @param avctx the AVCodecContext of the encoder
250 * @param avpkt the AVPacket
251 * If avpkt->data is already set, avpkt->size is checked
252 * to ensure it is large enough.
253 * If avpkt->data is NULL, a new buffer is allocated.
254 * avpkt->size is set to the specified size.
255 * All other AVPacket fields will be reset with av_init_packet().
256 * @param size the minimum required packet size
257 * @param min_size This is a hint to the allocation algorithm, which indicates
258 * to what minimal size the caller might later shrink the packet
259 * to. Encoders often allocate packets which are larger than the
260 * amount of data that is written into them as the exact amount is
261 * not known at the time of allocation. min_size represents the
262 * size a packet might be shrunk to by the caller. Can be set to
263 * 0. setting this roughly correctly allows the allocation code
264 * to choose between several allocation strategies to improve
266 * @return non negative on success, negative error code on failure
268 int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
270 attribute_deprecated int ff_alloc_packet(AVPacket *avpkt, int size);
273 * Rescale from sample rate to AVCodecContext.time_base.
275 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
278 if(samples == AV_NOPTS_VALUE)
279 return AV_NOPTS_VALUE;
280 return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
285 * 2^(x) for integer x
286 * @return correctly rounded float
288 static av_always_inline float ff_exp2fi(int x) {
290 if (-126 <= x && x <= 128)
291 return av_int2float((x+127) << 23);
295 /* Subnormal numbers */
297 return av_int2float(1 << (x+149));
298 /* Negligibly small */
304 * Get a buffer for a frame. This is a wrapper around
305 * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
308 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
311 * Identical in function to av_frame_make_writable(), except it uses
312 * ff_get_buffer() to allocate the buffer when needed.
314 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
316 int ff_thread_can_start_frame(AVCodecContext *avctx);
318 int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx);
321 * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
322 * calling the function and then restoring again. Assumes the mutex is
325 int ff_codec_open2_recursive(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
328 * Finalize buf into extradata and set its size appropriately.
330 int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf);
332 const uint8_t *avpriv_find_start_code(const uint8_t *p,
336 int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec);
339 * Check that the provided frame dimensions are valid and set them on the codec
342 int ff_set_dimensions(AVCodecContext *s, int width, int height);
345 * Check that the provided sample aspect ratio is valid and set it on the codec
348 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
351 * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
353 int ff_side_data_update_matrix_encoding(AVFrame *frame,
354 enum AVMatrixEncoding matrix_encoding);
357 * Select the (possibly hardware accelerated) pixel format.
358 * This is a wrapper around AVCodecContext.get_format() and should be used
359 * instead of calling get_format() directly.
361 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
364 * Set various frame properties from the codec context / packet data.
366 int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
369 * Add a CPB properties side data to an encoding context.
371 AVCPBProperties *ff_add_cpb_side_data(AVCodecContext *avctx);
373 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type);
376 * Check AVFrame for A53 side data and allocate and fill SEI message with A53 info
378 * @param frame Raw frame to get A53 side data from
379 * @param prefix_len Number of bytes to allocate before SEI message
380 * @param data Pointer to a variable to store allocated memory
381 * Upon return the variable will hold NULL on error or if frame has no A53 info.
382 * Otherwise it will point to prefix_len uninitialized bytes followed by
383 * *sei_size SEI message
384 * @param sei_size Pointer to a variable to store generated SEI message length
385 * @return Zero on success, negative error code on failure
387 int ff_alloc_a53_sei(const AVFrame *frame, size_t prefix_len,
388 void **data, size_t *sei_size);
391 * Get an estimated video bitrate based on frame size, frame rate and coded
394 int64_t ff_guess_coded_bitrate(AVCodecContext *avctx);
396 #endif /* AVCODEC_INTERNAL_H */