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, decode.c won't overwrite
52 * this field. If it's unset, decode.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)
62 * The decoder sets the cropping fields in the output frames manually.
63 * If this cap is set, the generic code will initialize output frame
64 * dimensions to coded rather than display values.
66 #define FF_CODEC_CAP_EXPORTS_CROPPING (1 << 4)
68 * Codec initializes slice-based threading with a main function
70 #define FF_CODEC_CAP_SLICE_THREAD_HAS_MF (1 << 5)
73 * Allow only AVHWAccels which have a matching decoder_class field.
75 #define FF_CODEC_CAP_HWACCEL_REQUIRE_CLASS (1 << 6)
78 # define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
80 # define ff_tlog(ctx, ...) do { } while(0)
84 #define FF_DEFAULT_QUANT_BIAS 999999
86 #define FF_QSCALE_TYPE_MPEG1 0
87 #define FF_QSCALE_TYPE_MPEG2 1
88 #define FF_QSCALE_TYPE_H264 2
89 #define FF_QSCALE_TYPE_VP56 3
91 #define FF_SANE_NB_CHANNELS 64U
93 #define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
95 #if HAVE_SIMD_ALIGN_32
96 # define STRIDE_ALIGN 32
97 #elif HAVE_SIMD_ALIGN_16
98 # define STRIDE_ALIGN 16
100 # define STRIDE_ALIGN 8
103 typedef struct FramePool {
105 * Pools for each data plane. For audio all the planes have the same size,
106 * so only pools[0] is used.
108 AVBufferPool *pools[4];
115 int stride_align[AV_NUM_DATA_POINTERS];
122 typedef struct DecodeSimpleContext {
125 } DecodeSimpleContext;
127 typedef struct DecodeFilterContext {
130 } DecodeFilterContext;
132 typedef struct AVCodecInternal {
134 * Whether the parent AVCodecContext is a copy of the context which had
135 * init() called on it.
136 * This is used by multithreading - shared tables and picture pointers
137 * should be freed from the original context only.
142 * Whether to allocate progress for frame threading.
144 * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
145 * then progress will be allocated in ff_thread_get_buffer(). The frames
146 * then MUST be freed with ff_thread_release_buffer().
148 * If the codec does not need to call the progress functions (there are no
149 * dependencies between the frames), it should leave this at 0. Then it can
150 * decode straight to the user-provided frames (which the user will then
151 * free with av_frame_unref()), there is no need to call
152 * ff_thread_release_buffer().
154 int allocate_progress;
157 * An audio frame with less than required samples has been submitted and
158 * padded with silence. Reject all subsequent frames.
160 int last_audio_frame;
168 DecodeSimpleContext ds;
169 DecodeFilterContext filter;
172 * Properties (timestamps+side data) extracted from the last packet passed
175 AVPacket *last_pkt_props;
178 * temporary buffer used for encoders to store their bitstream
180 uint8_t *byte_buffer;
181 unsigned int byte_buffer_size;
183 void *frame_thread_encoder;
186 * Number of audio samples to skip at the start of the next decoded frame
191 * hwaccel-specific private data
193 void *hwaccel_priv_data;
196 * checks API usage: after codec draining, flush is required to resume operation
201 * buffers for using new encode/decode API through legacy API
203 AVPacket *buffer_pkt;
204 int buffer_pkt_valid; // encoding: packet without data can be valid
205 AVFrame *buffer_frame;
207 /* set to 1 when the caller is using the old decoding API */
209 int compat_decode_warned;
210 /* this variable is set by the decoder internals to signal to the old
211 * API compat wrappers the amount of data consumed from the last packet */
212 size_t compat_decode_consumed;
213 /* when a partial packet has been consumed, this stores the remaining size
214 * of the packet (that should be submitted in the next decode call */
215 size_t compat_decode_partial_size;
216 AVFrame *compat_decode_frame;
218 int showed_multi_packet_warning;
220 int skip_samples_multiplier;
222 /* to prevent infinite loop on errors when draining */
223 int nb_draining_errors;
226 struct AVCodecDefault {
228 const uint8_t *value;
231 extern const uint8_t ff_log2_run[41];
234 * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
235 * If there is no such matching pair then size is returned.
237 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
239 unsigned int avpriv_toupper4(unsigned int x);
242 * does needed setup of pkt_pts/pos and such for (re)get_buffer();
244 int ff_init_buffer_info(AVCodecContext *s, AVFrame *frame);
247 void ff_color_frame(AVFrame *frame, const int color[4]);
249 extern volatile int ff_avcodec_locked;
250 int ff_lock_avcodec(AVCodecContext *log_ctx, const AVCodec *codec);
251 int ff_unlock_avcodec(const AVCodec *codec);
253 int avpriv_lock_avformat(void);
254 int avpriv_unlock_avformat(void);
257 * Maximum size in bytes of extradata.
258 * This value was chosen such that every bit of the buffer is
259 * addressable by a 32-bit signed integer as used by get_bits.
261 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
264 * Check AVPacket size and/or allocate data.
266 * Encoders supporting AVCodec.encode2() can use this as a convenience to
267 * ensure the output packet data is large enough, whether provided by the user
268 * or allocated in this function.
270 * @param avctx the AVCodecContext of the encoder
271 * @param avpkt the AVPacket
272 * If avpkt->data is already set, avpkt->size is checked
273 * to ensure it is large enough.
274 * If avpkt->data is NULL, a new buffer is allocated.
275 * avpkt->size is set to the specified size.
276 * All other AVPacket fields will be reset with av_init_packet().
277 * @param size the minimum required packet size
278 * @param min_size This is a hint to the allocation algorithm, which indicates
279 * to what minimal size the caller might later shrink the packet
280 * to. Encoders often allocate packets which are larger than the
281 * amount of data that is written into them as the exact amount is
282 * not known at the time of allocation. min_size represents the
283 * size a packet might be shrunk to by the caller. Can be set to
284 * 0. setting this roughly correctly allows the allocation code
285 * to choose between several allocation strategies to improve
287 * @return non negative on success, negative error code on failure
289 int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
291 attribute_deprecated int ff_alloc_packet(AVPacket *avpkt, int size);
294 * Rescale from sample rate to AVCodecContext.time_base.
296 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
299 if(samples == AV_NOPTS_VALUE)
300 return AV_NOPTS_VALUE;
301 return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
306 * 2^(x) for integer x
307 * @return correctly rounded float
309 static av_always_inline float ff_exp2fi(int x) {
311 if (-126 <= x && x <= 128)
312 return av_int2float((x+127) << 23);
316 /* Subnormal numbers */
318 return av_int2float(1 << (x+149));
319 /* Negligibly small */
325 * Get a buffer for a frame. This is a wrapper around
326 * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
329 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
332 * Identical in function to av_frame_make_writable(), except it uses
333 * ff_get_buffer() to allocate the buffer when needed.
335 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
337 int ff_thread_can_start_frame(AVCodecContext *avctx);
339 int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx);
342 * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
343 * calling the function and then restoring again. Assumes the mutex is
346 int ff_codec_open2_recursive(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
349 * Finalize buf into extradata and set its size appropriately.
351 int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf);
353 const uint8_t *avpriv_find_start_code(const uint8_t *p,
357 int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec);
360 * Check that the provided frame dimensions are valid and set them on the codec
363 int ff_set_dimensions(AVCodecContext *s, int width, int height);
366 * Check that the provided sample aspect ratio is valid and set it on the codec
369 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
372 * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
374 int ff_side_data_update_matrix_encoding(AVFrame *frame,
375 enum AVMatrixEncoding matrix_encoding);
378 * Select the (possibly hardware accelerated) pixel format.
379 * This is a wrapper around AVCodecContext.get_format() and should be used
380 * instead of calling get_format() directly.
382 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
385 * Set various frame properties from the codec context / packet data.
387 int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
390 * Add a CPB properties side data to an encoding context.
392 AVCPBProperties *ff_add_cpb_side_data(AVCodecContext *avctx);
394 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type);
397 * Check AVFrame for A53 side data and allocate and fill SEI message with A53 info
399 * @param frame Raw frame to get A53 side data from
400 * @param prefix_len Number of bytes to allocate before SEI message
401 * @param data Pointer to a variable to store allocated memory
402 * Upon return the variable will hold NULL on error or if frame has no A53 info.
403 * Otherwise it will point to prefix_len uninitialized bytes followed by
404 * *sei_size SEI message
405 * @param sei_size Pointer to a variable to store generated SEI message length
406 * @return Zero on success, negative error code on failure
408 int ff_alloc_a53_sei(const AVFrame *frame, size_t prefix_len,
409 void **data, size_t *sei_size);
412 * Get an estimated video bitrate based on frame size, frame rate and coded
415 int64_t ff_guess_coded_bitrate(AVCodecContext *avctx);
417 #if defined(_WIN32) && CONFIG_SHARED
418 #ifdef BUILDING_avcodec
419 # define av_export_avcodec __declspec(dllexport)
421 # define av_export_avcodec __declspec(dllimport)
424 # define av_export_avcodec
427 #endif /* AVCODEC_INTERNAL_H */