FFmpeg  4.4.4
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/fifo.h"
32 #include "libavutil/mathematics.h"
33 #include "libavutil/pixfmt.h"
34 #include "avcodec.h"
35 #include "config.h"
36 
37 /**
38  * The codec does not modify any global variables in the init function,
39  * allowing to call the init function without locking any global mutexes.
40  */
41 #define FF_CODEC_CAP_INIT_THREADSAFE (1 << 0)
42 /**
43  * The codec allows calling the close function for deallocation even if
44  * the init function returned a failure. Without this capability flag, a
45  * codec does such cleanup internally when returning failures from the
46  * init function and does not expect the close function to be called at
47  * all.
48  */
49 #define FF_CODEC_CAP_INIT_CLEANUP (1 << 1)
50 /**
51  * Decoders marked with FF_CODEC_CAP_SETS_PKT_DTS want to set
52  * AVFrame.pkt_dts manually. If the flag is set, decode.c won't overwrite
53  * this field. If it's unset, decode.c tries to guess the pkt_dts field
54  * from the input AVPacket.
55  */
56 #define FF_CODEC_CAP_SETS_PKT_DTS (1 << 2)
57 /**
58  * The decoder extracts and fills its parameters even if the frame is
59  * skipped due to the skip_frame setting.
60  */
61 #define FF_CODEC_CAP_SKIP_FRAME_FILL_PARAM (1 << 3)
62 /**
63  * The decoder sets the cropping fields in the output frames manually.
64  * If this cap is set, the generic code will initialize output frame
65  * dimensions to coded rather than display values.
66  */
67 #define FF_CODEC_CAP_EXPORTS_CROPPING (1 << 4)
68 /**
69  * Codec initializes slice-based threading with a main function
70  */
71 #define FF_CODEC_CAP_SLICE_THREAD_HAS_MF (1 << 5)
72 /*
73  * The codec supports frame threading and has inter-frame dependencies, so it
74  * uses ff_thread_report/await_progress().
75  */
76 #define FF_CODEC_CAP_ALLOCATE_PROGRESS (1 << 6)
77 /**
78  * Codec handles avctx->thread_count == 0 (auto) internally.
79  */
80 #define FF_CODEC_CAP_AUTO_THREADS (1 << 7)
81 /**
82  * Codec handles output frame properties internally instead of letting the
83  * internal logic derive them from AVCodecInternal.last_pkt_props.
84  */
85 #define FF_CODEC_CAP_SETS_FRAME_PROPS (1 << 8)
86 
87 /**
88  * AVCodec.codec_tags termination value
89  */
90 #define FF_CODEC_TAGS_END -1
91 
92 
93 #ifdef TRACE
94 # define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
95 #else
96 # define ff_tlog(ctx, ...) do { } while(0)
97 #endif
98 
99 
100 #define FF_DEFAULT_QUANT_BIAS 999999
101 
102 #define FF_QSCALE_TYPE_MPEG1 0
103 #define FF_QSCALE_TYPE_MPEG2 1
104 #define FF_QSCALE_TYPE_H264 2
105 #define FF_QSCALE_TYPE_VP56 3
106 
107 #define FF_SANE_NB_CHANNELS 512U
108 
109 #define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
110 
111 #if HAVE_SIMD_ALIGN_64
112 # define STRIDE_ALIGN 64 /* AVX-512 */
113 #elif HAVE_SIMD_ALIGN_32
114 # define STRIDE_ALIGN 32
115 #elif HAVE_SIMD_ALIGN_16
116 # define STRIDE_ALIGN 16
117 #else
118 # define STRIDE_ALIGN 8
119 #endif
120 
121 typedef struct DecodeSimpleContext {
124 
125 typedef struct EncodeSimpleContext {
128 
129 typedef struct AVCodecInternal {
130  /**
131  * Whether the parent AVCodecContext is a copy of the context which had
132  * init() called on it.
133  * This is used by multithreading - shared tables and picture pointers
134  * should be freed from the original context only.
135  */
136  int is_copy;
137 
138  /**
139  * An audio frame with less than required samples has been submitted and
140  * padded with silence. Reject all subsequent frames.
141  */
143 
144 #if FF_API_OLD_ENCDEC
146 #endif
147 
149 
150  void *thread_ctx;
151 
154 
155  /**
156  * Properties (timestamps+side data) extracted from the last packet passed
157  * for decoding.
158  */
161 
162  /**
163  * temporary buffer used for encoders to store their bitstream
164  */
166  unsigned int byte_buffer_size;
167 
169 
171 
172  /**
173  * Number of audio samples to skip at the start of the next decoded frame
174  */
176 
177  /**
178  * hwaccel-specific private data
179  */
181 
182  /**
183  * checks API usage: after codec draining, flush is required to resume operation
184  */
185  int draining;
186 
187  /**
188  * buffers for using new encode/decode API through legacy API
189  */
193 
194 #if FF_API_OLD_ENCDEC
196  /* this variable is set by the decoder internals to signal to the old
197  * API compat wrappers the amount of data consumed from the last packet */
199  /* when a partial packet has been consumed, this stores the remaining size
200  * of the packet (that should be submitted in the next decode call */
204 #endif
205 
207 
209 
210  /* to prevent infinite loop on errors when draining */
212 
213  /* used when avctx flag AV_CODEC_FLAG_DROPCHANGED is set */
221 
223  const uint8_t *key;
224  const uint8_t *value;
225 };
226 
227 extern const uint8_t ff_log2_run[41];
228 
229 /**
230  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
231  * If there is no such matching pair then size is returned.
232  */
233 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
234 
235 unsigned int avpriv_toupper4(unsigned int x);
236 
237 void ff_color_frame(AVFrame *frame, const int color[4]);
238 
239 /**
240  * Maximum size in bytes of extradata.
241  * This value was chosen such that every bit of the buffer is
242  * addressable by a 32-bit signed integer as used by get_bits.
243  */
244 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
245 
246 /**
247  * Check AVPacket size and/or allocate data.
248  *
249  * Encoders supporting AVCodec.encode2() can use this as a convenience to
250  * ensure the output packet data is large enough, whether provided by the user
251  * or allocated in this function.
252  *
253  * @param avctx the AVCodecContext of the encoder
254  * @param avpkt the AVPacket
255  * If avpkt->data is already set, avpkt->size is checked
256  * to ensure it is large enough.
257  * If avpkt->data is NULL, a new buffer is allocated.
258  * avpkt->size is set to the specified size.
259  * All other AVPacket fields will be reset with av_init_packet().
260  * @param size the minimum required packet size
261  * @param min_size This is a hint to the allocation algorithm, which indicates
262  * to what minimal size the caller might later shrink the packet
263  * to. Encoders often allocate packets which are larger than the
264  * amount of data that is written into them as the exact amount is
265  * not known at the time of allocation. min_size represents the
266  * size a packet might be shrunk to by the caller. Can be set to
267  * 0. setting this roughly correctly allows the allocation code
268  * to choose between several allocation strategies to improve
269  * speed slightly.
270  * @return non negative on success, negative error code on failure
271  */
272 int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
273 
274 /**
275  * Rescale from sample rate to AVCodecContext.time_base.
276  */
278  int64_t samples)
279 {
280  if(samples == AV_NOPTS_VALUE)
281  return AV_NOPTS_VALUE;
282  return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
283  avctx->time_base);
284 }
285 
286 /**
287  * 2^(x) for integer x
288  * @return correctly rounded float
289  */
290 static av_always_inline float ff_exp2fi(int x) {
291  /* Normal range */
292  if (-126 <= x && x <= 128)
293  return av_int2float((x+127) << 23);
294  /* Too large */
295  else if (x > 128)
296  return INFINITY;
297  /* Subnormal numbers */
298  else if (x > -150)
299  return av_int2float(1 << (x+149));
300  /* Negligibly small */
301  else
302  return 0;
303 }
304 
305 /**
306  * Get a buffer for a frame. This is a wrapper around
307  * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
308  * directly.
309  */
310 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
311 
312 #define FF_REGET_BUFFER_FLAG_READONLY 1 ///< the returned buffer does not need to be writable
313 /**
314  * Identical in function to ff_get_buffer(), except it reuses the existing buffer
315  * if available.
316  */
318 
320 
322 
324  const uint8_t *end,
325  uint32_t *state);
326 
328 
329 /**
330  * Check that the provided frame dimensions are valid and set them on the codec
331  * context.
332  */
334 
335 /**
336  * Check that the provided sample aspect ratio is valid and set it on the codec
337  * context.
338  */
339 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
340 
341 /**
342  * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
343  */
345  enum AVMatrixEncoding matrix_encoding);
346 
347 /**
348  * Select the (possibly hardware accelerated) pixel format.
349  * This is a wrapper around AVCodecContext.get_format() and should be used
350  * instead of calling get_format() directly.
351  *
352  * The list of pixel formats must contain at least one valid entry, and is
353  * terminated with AV_PIX_FMT_NONE. If it is possible to decode to software,
354  * the last entry in the list must be the most accurate software format.
355  * If it is not possible to decode to software, AVCodecContext.sw_pix_fmt
356  * must be set before calling this function.
357  */
358 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
359 
360 /**
361  * Add a CPB properties side data to an encoding context.
362  */
364 
365 /**
366  * Check AVFrame for S12M timecode side data and allocate and fill TC SEI message with timecode info
367  *
368  * @param frame Raw frame to get S12M timecode side data from
369  * @param rate The frame rate
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 S12M timecode 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_timecode_sei(const AVFrame *frame, AVRational rate, size_t prefix_len,
379  void **data, size_t *sei_size);
380 
381 /**
382  * Get an estimated video bitrate based on frame size, frame rate and coded
383  * bits per pixel.
384  */
385 int64_t ff_guess_coded_bitrate(AVCodecContext *avctx);
386 
387 /**
388  * Check if a value is in the list. If not, return the default value
389  *
390  * @param ctx Context for the log msg
391  * @param val_name Name of the checked value, for log msg
392  * @param array_valid_values Array of valid int, ended with INT_MAX
393  * @param default_value Value return if checked value is not in the array
394  * @return Value or default_value.
395  */
396 int ff_int_from_list_or_default(void *ctx, const char * val_name, int val,
397  const int * array_valid_values, int default_value);
398 
399 void ff_dvdsub_parse_palette(uint32_t *palette, const char *p);
400 
401 #if defined(_WIN32) && CONFIG_SHARED && !defined(BUILDING_avcodec)
402 # define av_export_avcodec __declspec(dllimport)
403 #else
404 # define av_export_avcodec
405 #endif
406 
407 #endif /* AVCODEC_INTERNAL_H */
static double val(void *priv, double ch)
Definition: aeval.c:76
#define av_always_inline
Definition: attributes.h:45
uint8_t
Libavcodec external API header.
refcounted data buffer API
#define flags(name, subs,...)
Definition: cbs_av1.c:561
#define s(width, name)
Definition: cbs_vp9.c:257
audio channel layout utility functions
static struct @321 state
static AVFrame * frame
a very simple circular buffer FIFO implementation
AVMatrixEncoding
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
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
static av_always_inline float av_int2float(uint32_t i)
Reinterpret a 32-bit integer as a float.
Definition: intfloat.h:40
void ff_color_frame(AVFrame *frame, const int color[4])
Definition: utils.c:415
int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec)
Definition: utils.c:473
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1900
static av_always_inline float ff_exp2fi(int x)
2^(x) for integer x
Definition: internal.h:290
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:114
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:2007
void ff_dvdsub_parse_palette(uint32_t *palette, const char *p)
Definition: dvdsub.c:26
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:1189
const uint8_t * avpriv_find_start_code(const uint8_t *p, const uint8_t *end, uint32_t *state)
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
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:99
int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt)
Select the (possibly hardware accelerated) pixel format.
Definition: decode.c:1326
AVCPBProperties * ff_add_cpb_side_data(AVCodecContext *avctx)
Add a CPB properties side data to an encoding context.
Definition: utils.c:1064
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:277
int ff_alloc_timecode_sei(const AVFrame *frame, AVRational rate, 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:1104
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:1168
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:84
unsigned int avpriv_toupper4(unsigned int x)
Definition: utils.c:932
int ff_thread_can_start_frame(AVCodecContext *avctx)
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:903
const uint8_t ff_log2_run[41]
Definition: bitstream.c:39
int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx)
Definition: h264dec.c:61
#define INFINITY
Definition: mathematics.h:67
const char data[16]
Definition: mxf.c:142
pixel format definitions
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
The bitstream filter state.
Definition: bsf.h:49
A reference to a data buffer.
Definition: buffer.h:84
This structure describes the bitrate properties of an encoded bitstream.
Definition: avcodec.h:453
main external API structure.
Definition: avcodec.h:536
int sample_rate
samples per second
Definition: avcodec.h:1196
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented.
Definition: avcodec.h:659
const uint8_t * key
Definition: internal.h:223
const uint8_t * value
Definition: internal.h:224
int is_copy
Whether the parent AVCodecContext is a copy of the context which had init() called on it.
Definition: internal.h:136
int initial_format
Definition: internal.h:215
int nb_draining_errors
Definition: internal.h:211
size_t compat_decode_consumed
Definition: internal.h:198
AVFrame * to_free
Definition: internal.h:145
void * thread_ctx
Definition: internal.h:150
AVPacket * last_pkt_props
Properties (timestamps+side data) extracted from the last packet passed for decoding.
Definition: internal.h:159
AVFifoBuffer * pkt_props
Definition: internal.h:160
unsigned int byte_buffer_size
Definition: internal.h:166
uint8_t * byte_buffer
temporary buffer used for encoders to store their bitstream
Definition: internal.h:165
EncodeSimpleContext es
Definition: internal.h:170
AVBSFContext * bsf
Definition: internal.h:153
uint64_t initial_channel_layout
Definition: internal.h:219
int last_audio_frame
An audio frame with less than required samples has been submitted and padded with silence.
Definition: internal.h:142
int changed_frames_dropped
Definition: internal.h:214
void * hwaccel_priv_data
hwaccel-specific private data
Definition: internal.h:180
size_t compat_decode_partial_size
Definition: internal.h:201
int initial_channels
Definition: internal.h:218
AVFrame * buffer_frame
Definition: internal.h:191
AVPacket * buffer_pkt
buffers for using new encode/decode API through legacy API
Definition: internal.h:190
AVBufferRef * pool
Definition: internal.h:148
DecodeSimpleContext ds
Definition: internal.h:152
int skip_samples_multiplier
Definition: internal.h:208
int draining
checks API usage: after codec draining, flush is required to resume operation
Definition: internal.h:185
AVFrame * compat_decode_frame
Definition: internal.h:202
void * frame_thread_encoder
Definition: internal.h:168
int initial_sample_rate
Definition: internal.h:217
int initial_height
Definition: internal.h:216
int skip_samples
Number of audio samples to skip at the start of the next decoded frame.
Definition: internal.h:175
AVPacket * compat_encode_packet
Definition: internal.h:203
int compat_decode_warned
Definition: internal.h:195
int showed_multi_packet_warning
Definition: internal.h:206
AVCodec.
Definition: codec.h:197
This structure describes decoded (raw) audio or video data.
Definition: frame.h:318
This structure stores compressed data.
Definition: packet.h:346
Rational number (pair of numerator and denominator).
Definition: rational.h:58
AVPacket * in_pkt
Definition: internal.h:122
AVFrame * in_frame
Definition: internal.h:126
AVFormatContext * ctx
Definition: movenc.c:48
#define height
#define width
int size
static const struct twinvq_data tab
const char * b
Definition: vf_curves.c:118