FFmpeg
internal.h
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
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.
8  *
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.
13  *
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
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"
31 #include "libavutil/mathematics.h"
32 #include "libavutil/pixfmt.h"
33 #include "avcodec.h"
34 #include "config.h"
35 
36 /**
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.
39  */
40 #define FF_CODEC_CAP_INIT_THREADSAFE (1 << 0)
41 /**
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
46  * all.
47  */
48 #define FF_CODEC_CAP_INIT_CLEANUP (1 << 1)
49 /**
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.
54  */
55 #define FF_CODEC_CAP_SETS_PKT_DTS (1 << 2)
56 /**
57  * The decoder extracts and fills its parameters even if the frame is
58  * skipped due to the skip_frame setting.
59  */
60 #define FF_CODEC_CAP_SKIP_FRAME_FILL_PARAM (1 << 3)
61 /**
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.
65  */
66 #define FF_CODEC_CAP_EXPORTS_CROPPING (1 << 4)
67 /**
68  * Codec initializes slice-based threading with a main function
69  */
70 #define FF_CODEC_CAP_SLICE_THREAD_HAS_MF (1 << 5)
71 /*
72  * The codec supports frame threading and has inter-frame dependencies, so it
73  * uses ff_thread_report/await_progress().
74  */
75 #define FF_CODEC_CAP_ALLOCATE_PROGRESS (1 << 6)
76 
77 /**
78  * AVCodec.codec_tags termination value
79  */
80 #define FF_CODEC_TAGS_END -1
81 
82 
83 #ifdef TRACE
84 # define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
85 #else
86 # define ff_tlog(ctx, ...) do { } while(0)
87 #endif
88 
89 
90 #define FF_DEFAULT_QUANT_BIAS 999999
91 
92 #define FF_QSCALE_TYPE_MPEG1 0
93 #define FF_QSCALE_TYPE_MPEG2 1
94 #define FF_QSCALE_TYPE_H264 2
95 #define FF_QSCALE_TYPE_VP56 3
96 
97 #define FF_SANE_NB_CHANNELS 512U
98 
99 #define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
100 
101 #if HAVE_SIMD_ALIGN_64
102 # define STRIDE_ALIGN 64 /* AVX-512 */
103 #elif HAVE_SIMD_ALIGN_32
104 # define STRIDE_ALIGN 32
105 #elif HAVE_SIMD_ALIGN_16
106 # define STRIDE_ALIGN 16
107 #else
108 # define STRIDE_ALIGN 8
109 #endif
110 
111 typedef struct DecodeSimpleContext {
114 
115 typedef struct EncodeSimpleContext {
118 
119 typedef struct AVCodecInternal {
120  /**
121  * Whether the parent AVCodecContext is a copy of the context which had
122  * init() called on it.
123  * This is used by multithreading - shared tables and picture pointers
124  * should be freed from the original context only.
125  */
126  int is_copy;
127 
128  /**
129  * An audio frame with less than required samples has been submitted and
130  * padded with silence. Reject all subsequent frames.
131  */
133 
135 
137 
138  void *thread_ctx;
139 
142 
143  /**
144  * Properties (timestamps+side data) extracted from the last packet passed
145  * for decoding.
146  */
148 
149  /**
150  * temporary buffer used for encoders to store their bitstream
151  */
153  unsigned int byte_buffer_size;
154 
156 
158 
159  /**
160  * Number of audio samples to skip at the start of the next decoded frame
161  */
163 
164  /**
165  * hwaccel-specific private data
166  */
168 
169  /**
170  * checks API usage: after codec draining, flush is required to resume operation
171  */
172  int draining;
173 
174  /**
175  * buffers for using new encode/decode API through legacy API
176  */
181  /* this variable is set by the decoder internals to signal to the old
182  * API compat wrappers the amount of data consumed from the last packet */
184  /* when a partial packet has been consumed, this stores the remaining size
185  * of the packet (that should be submitted in the next decode call */
189 
191 
193 
194  /* to prevent infinite loop on errors when draining */
196 
197  /* used when avctx flag AV_CODEC_FLAG_DROPCHANGED is set */
200  int initial_width, initial_height;
205 
207  const uint8_t *key;
208  const uint8_t *value;
209 };
210 
211 extern const uint8_t ff_log2_run[41];
212 
213 /**
214  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
215  * If there is no such matching pair then size is returned.
216  */
217 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
218 
219 unsigned int avpriv_toupper4(unsigned int x);
220 
221 void ff_color_frame(AVFrame *frame, const int color[4]);
222 
223 /**
224  * Maximum size in bytes of extradata.
225  * This value was chosen such that every bit of the buffer is
226  * addressable by a 32-bit signed integer as used by get_bits.
227  */
228 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
229 
230 /**
231  * Check AVPacket size and/or allocate data.
232  *
233  * Encoders supporting AVCodec.encode2() can use this as a convenience to
234  * ensure the output packet data is large enough, whether provided by the user
235  * or allocated in this function.
236  *
237  * @param avctx the AVCodecContext of the encoder
238  * @param avpkt the AVPacket
239  * If avpkt->data is already set, avpkt->size is checked
240  * to ensure it is large enough.
241  * If avpkt->data is NULL, a new buffer is allocated.
242  * avpkt->size is set to the specified size.
243  * All other AVPacket fields will be reset with av_init_packet().
244  * @param size the minimum required packet size
245  * @param min_size This is a hint to the allocation algorithm, which indicates
246  * to what minimal size the caller might later shrink the packet
247  * to. Encoders often allocate packets which are larger than the
248  * amount of data that is written into them as the exact amount is
249  * not known at the time of allocation. min_size represents the
250  * size a packet might be shrunk to by the caller. Can be set to
251  * 0. setting this roughly correctly allows the allocation code
252  * to choose between several allocation strategies to improve
253  * speed slightly.
254  * @return non negative on success, negative error code on failure
255  */
256 int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
257 
258 /**
259  * Rescale from sample rate to AVCodecContext.time_base.
260  */
262  int64_t samples)
263 {
264  if(samples == AV_NOPTS_VALUE)
265  return AV_NOPTS_VALUE;
266  return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
267  avctx->time_base);
268 }
269 
270 /**
271  * 2^(x) for integer x
272  * @return correctly rounded float
273  */
274 static av_always_inline float ff_exp2fi(int x) {
275  /* Normal range */
276  if (-126 <= x && x <= 128)
277  return av_int2float((x+127) << 23);
278  /* Too large */
279  else if (x > 128)
280  return INFINITY;
281  /* Subnormal numbers */
282  else if (x > -150)
283  return av_int2float(1 << (x+149));
284  /* Negligibly small */
285  else
286  return 0;
287 }
288 
289 /**
290  * Get a buffer for a frame. This is a wrapper around
291  * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
292  * directly.
293  */
294 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
295 
296 #define FF_REGET_BUFFER_FLAG_READONLY 1 ///< the returned buffer does not need to be writable
297 /**
298  * Identical in function to ff_get_buffer(), except it reuses the existing buffer
299  * if available.
300  */
301 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
302 
304 
306 
307 /**
308  * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
309  * calling the function and then restoring again. Assumes the mutex is
310  * already locked
311  */
313 
314 /**
315  * Finalize buf into extradata and set its size appropriately.
316  */
317 int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf);
318 
319 const uint8_t *avpriv_find_start_code(const uint8_t *p,
320  const uint8_t *end,
321  uint32_t *state);
322 
324 
325 /**
326  * Check that the provided frame dimensions are valid and set them on the codec
327  * context.
328  */
330 
331 /**
332  * Check that the provided sample aspect ratio is valid and set it on the codec
333  * context.
334  */
335 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
336 
337 /**
338  * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
339  */
341  enum AVMatrixEncoding matrix_encoding);
342 
343 /**
344  * Select the (possibly hardware accelerated) pixel format.
345  * This is a wrapper around AVCodecContext.get_format() and should be used
346  * instead of calling get_format() directly.
347  *
348  * The list of pixel formats must contain at least one valid entry, and is
349  * terminated with AV_PIX_FMT_NONE. If it is possible to decode to software,
350  * the last entry in the list must be the most accurate software format.
351  * If it is not possible to decode to software, AVCodecContext.sw_pix_fmt
352  * must be set before calling this function.
353  */
354 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
355 
356 /**
357  * Set various frame properties from the codec context / packet data.
358  */
359 int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
360 
361 /**
362  * Add a CPB properties side data to an encoding context.
363  */
365 
366 /**
367  * Check AVFrame for A53 side data and allocate and fill SEI message with A53 info
368  *
369  * @param frame Raw frame to get A53 side data from
370  * @param prefix_len Number of bytes to allocate before SEI message
371  * @param data Pointer to a variable to store allocated memory
372  * Upon return the variable will hold NULL on error or if frame has no A53 info.
373  * Otherwise it will point to prefix_len uninitialized bytes followed by
374  * *sei_size SEI message
375  * @param sei_size Pointer to a variable to store generated SEI message length
376  * @return Zero on success, negative error code on failure
377  */
378 int ff_alloc_a53_sei(const AVFrame *frame, size_t prefix_len,
379  void **data, size_t *sei_size);
380 
381 /**
382  * Check AVFrame for S12M timecode side data and allocate and fill TC SEI message with timecode info
383  *
384  * @param frame Raw frame to get S12M timecode side data from
385  * @param prefix_len Number of bytes to allocate before SEI message
386  * @param data Pointer to a variable to store allocated memory
387  * Upon return the variable will hold NULL on error or if frame has no S12M timecode info.
388  * Otherwise it will point to prefix_len uninitialized bytes followed by
389  * *sei_size SEI message
390  * @param sei_size Pointer to a variable to store generated SEI message length
391  * @return Zero on success, negative error code on failure
392  */
393 int ff_alloc_timecode_sei(const AVFrame *frame, size_t prefix_len,
394  void **data, size_t *sei_size);
395 
396 /**
397  * Get an estimated video bitrate based on frame size, frame rate and coded
398  * bits per pixel.
399  */
400 int64_t ff_guess_coded_bitrate(AVCodecContext *avctx);
401 
402 /**
403  * Check if a value is in the list. If not, return the default value
404  *
405  * @param ctx Context for the log msg
406  * @param val_name Name of the checked value, for log msg
407  * @param array_valid_values Array of valid int, ended with INT_MAX
408  * @param default_value Value return if checked value is not in the array
409  * @return Value or default_value.
410  */
411 int ff_int_from_list_or_default(void *ctx, const char * val_name, int val,
412  const int * array_valid_values, int default_value);
413 
414 void ff_dvdsub_parse_palette(uint32_t *palette, const char *p);
415 
416 #if defined(_WIN32) && CONFIG_SHARED && !defined(BUILDING_avcodec)
417 # define av_export_avcodec __declspec(dllimport)
418 #else
419 # define av_export_avcodec
420 #endif
421 
422 #endif /* AVCODEC_INTERNAL_H */
int nb_draining_errors
Definition: internal.h:195
int ff_thread_can_start_frame(AVCodecContext *avctx)
int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Identical in function to ff_get_buffer(), except it reuses the existing buffer if available...
Definition: decode.c:1960
This structure describes decoded (raw) audio or video data.
Definition: frame.h:308
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:100
AVPacket * last_pkt_props
Properties (timestamps+side data) extracted from the last packet passed for decoding.
Definition: internal.h:147
int changed_frames_dropped
Definition: internal.h:198
AVFrame * to_free
Definition: internal.h:134
int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec)
Definition: utils.c:497
int ff_set_dimensions(AVCodecContext *s, int width, int height)
Check that the provided frame dimensions are valid and set them on the codec context.
Definition: utils.c:105
static av_always_inline float av_int2float(uint32_t i)
Reinterpret a 32-bit integer as a float.
Definition: intfloat.h:40
The bitstream filter state.
Definition: bsf.h:49
int initial_channels
Definition: internal.h:202
The reader does not expect b to be semantically here and if the code is changed by maybe adding a a division or other the signedness will almost certainly be mistaken To avoid this confusion a new type was SUINT is the C unsigned type but it holds a signed int to use the same example SUINT a
Definition: undefined.txt:36
AVCodec.
Definition: codec.h:190
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avcodec.h:649
void ff_color_frame(AVFrame *frame, const int color[4])
Definition: utils.c:413
uint8_t
int ff_alloc_timecode_sei(const AVFrame *frame, size_t prefix_len, void **data, size_t *sei_size)
Check AVFrame for S12M timecode side data and allocate and fill TC SEI message with timecode info...
Definition: utils.c:2258
void * thread_ctx
Definition: internal.h:138
static av_cold int end(AVCodecContext *avctx)
Definition: avrndec.c:90
int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame)
Set various frame properties from the codec context / packet data.
Definition: decode.c:1684
void * frame_thread_encoder
Definition: internal.h:155
#define height
size_t compat_decode_consumed
Definition: internal.h:183
int ff_set_sar(AVCodecContext *avctx, AVRational sar)
Check that the provided sample aspect ratio is valid and set it on the codec context.
Definition: utils.c:120
ptrdiff_t size
Definition: opengl_enc.c:100
int initial_format
Definition: internal.h:199
int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf)
Finalize buf into extradata and set its size appropriately.
Definition: utils.c:1932
const uint8_t * avpriv_find_start_code(const uint8_t *p, const uint8_t *end, uint32_t *state)
int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq)
Rescale a 64-bit integer by 2 rational numbers.
Definition: mathematics.c:142
AVBSFContext * bsf
Definition: internal.h:141
int ff_codec_open2_recursive(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options)
Call avcodec_open2 recursively by decrementing counter, unlocking mutex, calling the function and the...
Definition: utils.c:537
int is_copy
Whether the parent AVCodecContext is a copy of the context which had init() called on it...
Definition: internal.h:126
AVFrame * in_frame
Definition: internal.h:116
AVFrame * buffer_frame
Definition: internal.h:178
static av_always_inline float ff_exp2fi(int x)
2^(x) for integer x
Definition: internal.h:274
int64_t ff_guess_coded_bitrate(AVCodecContext *avctx)
Get an estimated video bitrate based on frame size, frame rate and coded bits per pixel...
Definition: utils.c:2311
#define b
Definition: input.c:41
audio channel layout utility functions
#define width
AVFrame * compat_decode_frame
Definition: internal.h:187
AVPacket * in_pkt
Definition: internal.h:112
AVFormatContext * ctx
Definition: movenc.c:48
static struct @318 state
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
#define s(width, name)
Definition: cbs_vp9.c:257
DecodeSimpleContext ds
Definition: internal.h:140
int draining
checks API usage: after codec draining, flush is required to resume operation
Definition: internal.h:172
int ff_side_data_update_matrix_encoding(AVFrame *frame, enum AVMatrixEncoding matrix_encoding)
Add or update AV_FRAME_DATA_MATRIXENCODING side data.
Definition: utils.c:135
int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt)
Select the (possibly hardware accelerated) pixel format.
Definition: decode.c:1279
This structure describes the bitrate properties of an encoded bitstream.
Definition: avcodec.h:448
Libavcodec external API header.
int compat_decode_warned
Definition: internal.h:180
EncodeSimpleContext es
Definition: internal.h:157
int sample_rate
samples per second
Definition: avcodec.h:1186
int initial_sample_rate
Definition: internal.h:201
main external API structure.
Definition: avcodec.h:526
int skip_samples_multiplier
Definition: internal.h:192
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1854
AVPacket * compat_encode_packet
Definition: internal.h:188
int showed_multi_packet_warning
Definition: internal.h:190
unsigned int avpriv_toupper4(unsigned int x)
Definition: utils.c:1842
Rational number (pair of numerator and denominator).
Definition: rational.h:58
int skip_samples
Number of audio samples to skip at the start of the next decoded frame.
Definition: internal.h:162
refcounted data buffer API
int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size)
Check AVPacket size and/or allocate data.
Definition: encode.c:33
AVBufferRef * pool
Definition: internal.h:136
#define flags(name, subs,...)
Definition: cbs_av1.c:560
const uint8_t * key
Definition: internal.h:207
const uint8_t * value
Definition: internal.h:208
AVPacket * buffer_pkt
buffers for using new encode/decode API through legacy API
Definition: internal.h:177
A reference to a data buffer.
Definition: buffer.h:81
void ff_dvdsub_parse_palette(uint32_t *palette, const char *p)
Definition: dvdsub.c:26
const OptionDef options[]
Definition: ffmpeg_opt.c:3392
int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx)
Definition: h264dec.c:61
void * hwaccel_priv_data
hwaccel-specific private data
Definition: internal.h:167
uint64_t initial_channel_layout
Definition: internal.h:203
AVCPBProperties * ff_add_cpb_side_data(AVCodecContext *avctx)
Add a CPB properties side data to an encoding context.
Definition: utils.c:2002
pixel format definitions
static const struct twinvq_data tab
unsigned int byte_buffer_size
Definition: internal.h:153
int ff_alloc_a53_sei(const AVFrame *frame, size_t prefix_len, void **data, size_t *sei_size)
Check AVFrame for A53 side data and allocate and fill SEI message with A53 info.
Definition: utils.c:2206
size_t compat_decode_partial_size
Definition: internal.h:186
Filter the word “frame” indicates either a video frame or a group of audio samples
#define av_always_inline
Definition: attributes.h:45
const uint8_t ff_log2_run[41]
Definition: bitstream.c:39
static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx, int64_t samples)
Rescale from sample rate to AVCodecContext.time_base.
Definition: internal.h:261
int ff_int_from_list_or_default(void *ctx, const char *val_name, int val, const int *array_valid_values, int default_value)
Check if a value is in the list.
Definition: utils.c:2332
AVMatrixEncoding
#define INFINITY
Definition: mathematics.h:67
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
static double val(void *priv, double ch)
Definition: aeval.c:76
This structure stores compressed data.
Definition: packet.h:340
uint8_t * byte_buffer
temporary buffer used for encoders to store their bitstream
Definition: internal.h:152
int ff_match_2uint16(const uint16_t(*tab)[2], int size, int a, int b)
Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
Definition: utils.c:1806
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
int last_audio_frame
An audio frame with less than required samples has been submitted and padded with silence...
Definition: internal.h:132