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/fifo.h"
32 #include "libavutil/mathematics.h"
33 #include "libavutil/pixfmt.h"
34 #include "avcodec.h"
35 #include "bsf.h"
36 #include "config.h"
37 
38 /**
39  * The codec does not modify any global variables in the init function,
40  * allowing to call the init function without locking any global mutexes.
41  */
42 #define FF_CODEC_CAP_INIT_THREADSAFE (1 << 0)
43 /**
44  * The codec allows calling the close function for deallocation even if
45  * the init function returned a failure. Without this capability flag, a
46  * codec does such cleanup internally when returning failures from the
47  * init function and does not expect the close function to be called at
48  * all.
49  */
50 #define FF_CODEC_CAP_INIT_CLEANUP (1 << 1)
51 /**
52  * Decoders marked with FF_CODEC_CAP_SETS_PKT_DTS want to set
53  * AVFrame.pkt_dts manually. If the flag is set, decode.c won't overwrite
54  * this field. If it's unset, decode.c tries to guess the pkt_dts field
55  * from the input AVPacket.
56  */
57 #define FF_CODEC_CAP_SETS_PKT_DTS (1 << 2)
58 /**
59  * The decoder extracts and fills its parameters even if the frame is
60  * skipped due to the skip_frame setting.
61  */
62 #define FF_CODEC_CAP_SKIP_FRAME_FILL_PARAM (1 << 3)
63 /**
64  * The decoder sets the cropping fields in the output frames manually.
65  * If this cap is set, the generic code will initialize output frame
66  * dimensions to coded rather than display values.
67  */
68 #define FF_CODEC_CAP_EXPORTS_CROPPING (1 << 4)
69 /**
70  * Codec initializes slice-based threading with a main function
71  */
72 #define FF_CODEC_CAP_SLICE_THREAD_HAS_MF (1 << 5)
73 /*
74  * The codec supports frame threading and has inter-frame dependencies, so it
75  * uses ff_thread_report/await_progress().
76  */
77 #define FF_CODEC_CAP_ALLOCATE_PROGRESS (1 << 6)
78 /**
79  * Codec handles avctx->thread_count == 0 (auto) internally.
80  */
81 #define FF_CODEC_CAP_AUTO_THREADS (1 << 7)
82 /**
83  * Codec handles output frame properties internally instead of letting the
84  * internal logic derive them from AVCodecInternal.last_pkt_props.
85  */
86 #define FF_CODEC_CAP_SETS_FRAME_PROPS (1 << 8)
87 
88 /**
89  * AVCodec.codec_tags termination value
90  */
91 #define FF_CODEC_TAGS_END -1
92 
93 
94 #define FF_DEFAULT_QUANT_BIAS 999999
95 
96 #define FF_QSCALE_TYPE_MPEG1 0
97 #define FF_QSCALE_TYPE_MPEG2 1
98 #define FF_QSCALE_TYPE_H264 2
99 #define FF_QSCALE_TYPE_VP56 3
100 
101 #define FF_SANE_NB_CHANNELS 512U
102 
103 #define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
104 
105 #if HAVE_SIMD_ALIGN_64
106 # define STRIDE_ALIGN 64 /* AVX-512 */
107 #elif HAVE_SIMD_ALIGN_32
108 # define STRIDE_ALIGN 32
109 #elif HAVE_SIMD_ALIGN_16
110 # define STRIDE_ALIGN 16
111 #else
112 # define STRIDE_ALIGN 8
113 #endif
114 
115 typedef struct EncodeSimpleContext {
118 
119 typedef struct AVCodecInternal {
120  /**
121  * When using frame-threaded decoding, this field is set for the first
122  * worker thread (e.g. to decode extradata just once).
123  */
124  int is_copy;
125 
126  /**
127  * An audio frame with less than required samples has been submitted and
128  * padded with silence. Reject all subsequent frames.
129  */
131 
133 
134  void *thread_ctx;
135 
136  /**
137  * This packet is used to hold the packet given to decoders
138  * implementing the .decode API; it is unused by the generic
139  * code for decoders implementing the .receive_frame API and
140  * may be freely used (but not freed) by them with the caveat
141  * that the packet will be unreferenced generically in
142  * avcodec_flush_buffers().
143  */
146 
147  /**
148  * Properties (timestamps+side data) extracted from the last packet passed
149  * for decoding.
150  */
153 
154  /**
155  * temporary buffer used for encoders to store their bitstream
156  */
157  uint8_t *byte_buffer;
158  unsigned int byte_buffer_size;
159 
160  /**
161  * This is set to AV_PKT_FLAG_KEY for encoders that encode intra-only
162  * formats (i.e. whose codec descriptor has AV_CODEC_PROP_INTRA_ONLY set).
163  * This is used to set said flag generically for said encoders.
164  */
166 
168 
170 
171  /**
172  * If this is set, then AVCodec->close (if existing) needs to be called
173  * for the parent AVCodecContext.
174  */
176 
177  /**
178  * Number of audio samples to skip at the start of the next decoded frame
179  */
181 
182  /**
183  * hwaccel-specific private data
184  */
186 
187  /**
188  * checks API usage: after codec draining, flush is required to resume operation
189  */
190  int draining;
191 
192  /**
193  * buffers for using new encode/decode API through legacy API
194  */
198 
200 
202 
203  /* to prevent infinite loop on errors when draining */
205 
206  /* used when avctx flag AV_CODEC_FLAG_DROPCHANGED is set */
214 
216  const uint8_t *key;
217  const uint8_t *value;
218 };
219 
220 extern const uint8_t ff_log2_run[41];
221 
222 /**
223  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
224  * If there is no such matching pair then size is returned.
225  */
226 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
227 
228 unsigned int ff_toupper4(unsigned int x);
229 
230 void ff_color_frame(AVFrame *frame, const int color[4]);
231 
232 /**
233  * Maximum size in bytes of extradata.
234  * This value was chosen such that every bit of the buffer is
235  * addressable by a 32-bit signed integer as used by get_bits.
236  */
237 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
238 
239 /**
240  * Rescale from sample rate to AVCodecContext.time_base.
241  */
243  int64_t samples)
244 {
245  if(samples == AV_NOPTS_VALUE)
246  return AV_NOPTS_VALUE;
247  return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
248  avctx->time_base);
249 }
250 
251 /**
252  * 2^(x) for integer x
253  * @return correctly rounded float
254  */
255 static av_always_inline float ff_exp2fi(int x) {
256  /* Normal range */
257  if (-126 <= x && x <= 128)
258  return av_int2float((x+127) << 23);
259  /* Too large */
260  else if (x > 128)
261  return INFINITY;
262  /* Subnormal numbers */
263  else if (x > -150)
264  return av_int2float(1 << (x+149));
265  /* Negligibly small */
266  else
267  return 0;
268 }
269 
270 /**
271  * Get a buffer for a frame. This is a wrapper around
272  * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
273  * directly.
274  */
275 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
276 
277 #define FF_REGET_BUFFER_FLAG_READONLY 1 ///< the returned buffer does not need to be writable
278 /**
279  * Identical in function to ff_get_buffer(), except it reuses the existing buffer
280  * if available.
281  */
283 
285 
287 
288 const uint8_t *avpriv_find_start_code(const uint8_t *p,
289  const uint8_t *end,
290  uint32_t *state);
291 
293 
294 /**
295  * Check that the provided frame dimensions are valid and set them on the codec
296  * context.
297  */
299 
300 /**
301  * Check that the provided sample aspect ratio is valid and set it on the codec
302  * context.
303  */
304 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
305 
306 /**
307  * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
308  */
310  enum AVMatrixEncoding matrix_encoding);
311 
312 /**
313  * Select the (possibly hardware accelerated) pixel format.
314  * This is a wrapper around AVCodecContext.get_format() and should be used
315  * instead of calling get_format() directly.
316  *
317  * The list of pixel formats must contain at least one valid entry, and is
318  * terminated with AV_PIX_FMT_NONE. If it is possible to decode to software,
319  * the last entry in the list must be the most accurate software format.
320  * If it is not possible to decode to software, AVCodecContext.sw_pix_fmt
321  * must be set before calling this function.
322  */
323 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
324 
325 /**
326  * Add a CPB properties side data to an encoding context.
327  */
329 
330 /**
331  * Check AVFrame for S12M timecode side data and allocate and fill TC SEI message with timecode info
332  *
333  * @param frame Raw frame to get S12M timecode side data from
334  * @param rate The frame rate
335  * @param prefix_len Number of bytes to allocate before SEI message
336  * @param data Pointer to a variable to store allocated memory
337  * Upon return the variable will hold NULL on error or if frame has no S12M timecode info.
338  * Otherwise it will point to prefix_len uninitialized bytes followed by
339  * *sei_size SEI message
340  * @param sei_size Pointer to a variable to store generated SEI message length
341  * @return Zero on success, negative error code on failure
342  */
343 int ff_alloc_timecode_sei(const AVFrame *frame, AVRational rate, size_t prefix_len,
344  void **data, size_t *sei_size);
345 
346 /**
347  * Get an estimated video bitrate based on frame size, frame rate and coded
348  * bits per pixel.
349  */
350 int64_t ff_guess_coded_bitrate(AVCodecContext *avctx);
351 
352 /**
353  * Check if a value is in the list. If not, return the default value
354  *
355  * @param ctx Context for the log msg
356  * @param val_name Name of the checked value, for log msg
357  * @param array_valid_values Array of valid int, ended with INT_MAX
358  * @param default_value Value return if checked value is not in the array
359  * @return Value or default_value.
360  */
361 int ff_int_from_list_or_default(void *ctx, const char * val_name, int val,
362  const int * array_valid_values, int default_value);
363 
364 void ff_dvdsub_parse_palette(uint32_t *palette, const char *p);
365 
366 #endif /* AVCODEC_INTERNAL_H */
ff_guess_coded_bitrate
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:1094
AVCodecInternal::initial_sample_rate
int initial_sample_rate
Definition: internal.h:210
AVCodec
AVCodec.
Definition: codec.h:202
AVCodecDefault::value
const uint8_t * value
Definition: internal.h:217
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
INFINITY
#define INFINITY
Definition: mathematics.h:67
AVCodecContext::sample_rate
int sample_rate
samples per second
Definition: avcodec.h:992
color
Definition: vf_paletteuse.c:600
ff_thread_can_start_frame
int ff_thread_can_start_frame(AVCodecContext *avctx)
Definition: pthread_frame.c:934
AVCodecInternal::es
EncodeSimpleContext es
Definition: internal.h:169
AVCodecInternal::skip_samples
int skip_samples
Number of audio samples to skip at the start of the next decoded frame.
Definition: internal.h:180
state
static struct @321 state
AVCodecDefault::key
const uint8_t * key
Definition: internal.h:216
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:317
AVCodecInternal::frame_thread_encoder
void * frame_thread_encoder
Definition: internal.h:167
b
#define b
Definition: input.c:40
data
const char data[16]
Definition: mxf.c:143
ff_toupper4
unsigned int ff_toupper4(unsigned int x)
Definition: to_upper4.h:29
mathematics.h
avpriv_find_start_code
const uint8_t * avpriv_find_start_code(const uint8_t *p, const uint8_t *end, uint32_t *state)
ff_add_cpb_side_data
AVCPBProperties * ff_add_cpb_side_data(AVCodecContext *avctx)
Add a CPB properties side data to an encoding context.
Definition: utils.c:990
AVBSFContext
The bitstream filter state.
Definition: bsf.h:47
AVCodecInternal::pool
AVBufferRef * pool
Definition: internal.h:132
AVCodecInternal::initial_channel_layout
uint64_t initial_channel_layout
Definition: internal.h:212
AVFifoBuffer
Definition: fifo.h:31
AVCodecInternal::is_copy
int is_copy
When using frame-threaded decoding, this field is set for the first worker thread (e....
Definition: internal.h:124
EncodeSimpleContext::in_frame
AVFrame * in_frame
Definition: internal.h:116
fifo.h
bsf.h
ff_match_2uint16
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:848
AVCodecInternal::showed_multi_packet_warning
int showed_multi_packet_warning
Definition: internal.h:199
av_int2float
static av_always_inline float av_int2float(uint32_t i)
Reinterpret a 32-bit integer as a float.
Definition: intfloat.h:40
tab
static const struct twinvq_data tab
Definition: twinvq_data.h:10345
val
static double val(void *priv, double ch)
Definition: aeval.c:76
ff_reget_buffer
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:1759
ff_get_buffer
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1652
ff_samples_to_time_base
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:242
ff_exp2fi
static av_always_inline float ff_exp2fi(int x)
2^(x) for integer x
Definition: internal.h:255
ff_color_frame
void ff_color_frame(AVFrame *frame, const int color[4])
Definition: utils.c:410
width
#define width
s
#define s(width, name)
Definition: cbs_vp9.c:257
AVCodecInternal::buffer_pkt
AVPacket * buffer_pkt
buffers for using new encode/decode API through legacy API
Definition: internal.h:195
ctx
AVFormatContext * ctx
Definition: movenc.c:48
av_rescale_q
int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq)
Rescale a 64-bit integer by 2 rational numbers.
Definition: mathematics.c:141
AVCPBProperties
This structure describes the bitrate properties of an encoded bitstream.
Definition: defs.h:104
AVCodecDefault
Definition: internal.h:215
AVMatrixEncoding
AVMatrixEncoding
Definition: channel_layout.h:120
AVCodecInternal::changed_frames_dropped
int changed_frames_dropped
Definition: internal.h:207
ff_get_format
int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt)
Select the (possibly hardware accelerated) pixel format.
Definition: decode.c:1089
AVRational
Rational number (pair of numerator and denominator).
Definition: rational.h:58
AVCodecInternal::initial_height
int initial_height
Definition: internal.h:209
AVCodecInternal::skip_samples_multiplier
int skip_samples_multiplier
Definition: internal.h:201
AVCodecInternal::draining_done
int draining_done
Definition: internal.h:197
AVCodecInternal::bsf
AVBSFContext * bsf
Definition: internal.h:145
AVCodecInternal::last_pkt_props
AVPacket * last_pkt_props
Properties (timestamps+side data) extracted from the last packet passed for decoding.
Definition: internal.h:151
AVCodecContext::time_base
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented.
Definition: avcodec.h:506
AVCodecInternal::hwaccel_priv_data
void * hwaccel_priv_data
hwaccel-specific private data
Definition: internal.h:185
ff_alloc_timecode_sei
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:1030
AVCodecInternal::initial_channels
int initial_channels
Definition: internal.h:211
AVCodecInternal::initial_format
int initial_format
Definition: internal.h:208
ff_dvdsub_parse_palette
void ff_dvdsub_parse_palette(uint32_t *palette, const char *p)
Definition: dvdsub.c:26
size
int size
Definition: twinvq_data.h:10344
AV_NOPTS_VALUE
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
AVCodecInternal::byte_buffer
uint8_t * byte_buffer
temporary buffer used for encoders to store their bitstream
Definition: internal.h:157
EncodeSimpleContext
Definition: internal.h:115
buffer.h
height
#define height
a
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:41
AVCodecInternal
Definition: internal.h:119
AVCodecInternal::byte_buffer_size
unsigned int byte_buffer_size
Definition: internal.h:158
AVCodecInternal::initial_width
int initial_width
Definition: internal.h:209
AVCodecInternal::pkt_props
AVFifoBuffer * pkt_props
Definition: internal.h:152
AVCodecInternal::in_pkt
AVPacket * in_pkt
This packet is used to hold the packet given to decoders implementing the .decode API; it is unused b...
Definition: internal.h:144
av_always_inline
#define av_always_inline
Definition: attributes.h:49
AVCodecInternal::nb_draining_errors
int nb_draining_errors
Definition: internal.h:204
AVCodecInternal::last_audio_frame
int last_audio_frame
An audio frame with less than required samples has been submitted and padded with silence.
Definition: internal.h:130
avcodec.h
pixfmt.h
frame
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
Definition: filter_design.txt:264
AVCodecInternal::needs_close
int needs_close
If this is set, then AVCodec->close (if existing) needs to be called for the parent AVCodecContext.
Definition: internal.h:175
ff_set_sar
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:101
AVCodecContext
main external API structure.
Definition: avcodec.h:383
channel_layout.h
ff_log2_run
const uint8_t ff_log2_run[41]
Definition: bitstream.c:50
samples
Filter the word “frame” indicates either a video frame or a group of audio samples
Definition: filter_design.txt:8
AVCodecInternal::buffer_frame
AVFrame * buffer_frame
Definition: internal.h:196
AVCodecInternal::draining
int draining
checks API usage: after codec draining, flush is required to resume operation
Definition: internal.h:190
ff_side_data_update_matrix_encoding
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:116
AVCodecInternal::intra_only_flag
int intra_only_flag
This is set to AV_PKT_FLAG_KEY for encoders that encode intra-only formats (i.e.
Definition: internal.h:165
ff_set_dimensions
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:86
AVBufferRef
A reference to a data buffer.
Definition: buffer.h:82
AVPacket
This structure stores compressed data.
Definition: packet.h:350
AVCodecInternal::thread_ctx
void * thread_ctx
Definition: internal.h:134
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
avpriv_h264_has_num_reorder_frames
int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx)
Definition: h264dec.c:61
avpriv_codec_get_cap_skip_frame_fill_param
int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec)
Definition: utils.c:439
ff_int_from_list_or_default
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:1115