FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 #ifdef TRACE
73 # define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
74 #else
75 # define ff_tlog(ctx, ...) do { } while(0)
76 #endif
77 
78 
79 #if !FF_API_QUANT_BIAS
80 #define FF_DEFAULT_QUANT_BIAS 999999
81 #endif
82 
83 #if !FF_API_QSCALE_TYPE
84 #define FF_QSCALE_TYPE_MPEG1 0
85 #define FF_QSCALE_TYPE_MPEG2 1
86 #define FF_QSCALE_TYPE_H264 2
87 #define FF_QSCALE_TYPE_VP56 3
88 #endif
89 
90 #define FF_SANE_NB_CHANNELS 64U
91 
92 #define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
93 
94 #if HAVE_SIMD_ALIGN_32
95 # define STRIDE_ALIGN 32
96 #elif HAVE_SIMD_ALIGN_16
97 # define STRIDE_ALIGN 16
98 #else
99 # define STRIDE_ALIGN 8
100 #endif
101 
102 typedef struct FramePool {
103  /**
104  * Pools for each data plane. For audio all the planes have the same size,
105  * so only pools[0] is used.
106  */
108 
109  /*
110  * Pool parameters
111  */
112  int format;
113  int width, height;
115  int linesize[4];
116  int planes;
117  int channels;
118  int samples;
119 } FramePool;
120 
121 typedef struct DecodeSimpleContext {
125 
126 typedef struct DecodeFilterContext {
128  int nb_bsfs;
130 
131 typedef struct AVCodecInternal {
132  /**
133  * Whether the parent AVCodecContext is a copy of the context which had
134  * init() called on it.
135  * This is used by multithreading - shared tables and picture pointers
136  * should be freed from the original context only.
137  */
138  int is_copy;
139 
140  /**
141  * Whether to allocate progress for frame threading.
142  *
143  * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
144  * then progress will be allocated in ff_thread_get_buffer(). The frames
145  * then MUST be freed with ff_thread_release_buffer().
146  *
147  * If the codec does not need to call the progress functions (there are no
148  * dependencies between the frames), it should leave this at 0. Then it can
149  * decode straight to the user-provided frames (which the user will then
150  * free with av_frame_unref()), there is no need to call
151  * ff_thread_release_buffer().
152  */
154 
155  /**
156  * An audio frame with less than required samples has been submitted and
157  * padded with silence. Reject all subsequent frames.
158  */
160 
162 
164 
165  void *thread_ctx;
166 
169 
170  /**
171  * Properties (timestamps+side data) extracted from the last packet passed
172  * for decoding.
173  */
175 
176  /**
177  * temporary buffer used for encoders to store their bitstream
178  */
180  unsigned int byte_buffer_size;
181 
183 
184  /**
185  * Number of audio samples to skip at the start of the next decoded frame
186  */
188 
189  /**
190  * hwaccel-specific private data
191  */
193 
194  /**
195  * checks API usage: after codec draining, flush is required to resume operation
196  */
197  int draining;
198 
199  /**
200  * buffers for using new encode/decode API through legacy API
201  */
203  int buffer_pkt_valid; // encoding: packet without data can be valid
206  /* set to 1 when the caller is using the old decoding API */
209  /* this variable is set by the decoder internals to signal to the old
210  * API compat wrappers the amount of data consumed from the last packet */
212  /* when a partial packet has been consumed, this stores the remaining size
213  * of the packet (that should be submitted in the next decode call */
216 
218 
220 
221  /* to prevent infinite loop on errors when draining */
224 
226  const uint8_t *key;
227  const uint8_t *value;
228 };
229 
230 extern const uint8_t ff_log2_run[41];
231 
232 /**
233  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
234  * If there is no such matching pair then size is returned.
235  */
236 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
237 
238 unsigned int avpriv_toupper4(unsigned int x);
239 
240 /**
241  * does needed setup of pkt_pts/pos and such for (re)get_buffer();
242  */
244 
245 
246 void ff_color_frame(AVFrame *frame, const int color[4]);
247 
248 extern volatile int ff_avcodec_locked;
249 int ff_lock_avcodec(AVCodecContext *log_ctx, const AVCodec *codec);
250 int ff_unlock_avcodec(const AVCodec *codec);
251 
252 int avpriv_lock_avformat(void);
253 int avpriv_unlock_avformat(void);
254 
255 /**
256  * Maximum size in bytes of extradata.
257  * This value was chosen such that every bit of the buffer is
258  * addressable by a 32-bit signed integer as used by get_bits.
259  */
260 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
261 
262 /**
263  * Check AVPacket size and/or allocate data.
264  *
265  * Encoders supporting AVCodec.encode2() can use this as a convenience to
266  * ensure the output packet data is large enough, whether provided by the user
267  * or allocated in this function.
268  *
269  * @param avctx the AVCodecContext of the encoder
270  * @param avpkt the AVPacket
271  * If avpkt->data is already set, avpkt->size is checked
272  * to ensure it is large enough.
273  * If avpkt->data is NULL, a new buffer is allocated.
274  * avpkt->size is set to the specified size.
275  * All other AVPacket fields will be reset with av_init_packet().
276  * @param size the minimum required packet size
277  * @param min_size This is a hint to the allocation algorithm, which indicates
278  * to what minimal size the caller might later shrink the packet
279  * to. Encoders often allocate packets which are larger than the
280  * amount of data that is written into them as the exact amount is
281  * not known at the time of allocation. min_size represents the
282  * size a packet might be shrunk to by the caller. Can be set to
283  * 0. setting this roughly correctly allows the allocation code
284  * to choose between several allocation strategies to improve
285  * speed slightly.
286  * @return non negative on success, negative error code on failure
287  */
288 int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
289 
291 
292 /**
293  * Rescale from sample rate to AVCodecContext.time_base.
294  */
296  int64_t samples)
297 {
298  if(samples == AV_NOPTS_VALUE)
299  return AV_NOPTS_VALUE;
300  return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
301  avctx->time_base);
302 }
303 
304 /**
305  * 2^(x) for integer x
306  * @return correctly rounded float
307  */
308 static av_always_inline float ff_exp2fi(int x) {
309  /* Normal range */
310  if (-126 <= x && x <= 128)
311  return av_int2float((x+127) << 23);
312  /* Too large */
313  else if (x > 128)
314  return INFINITY;
315  /* Subnormal numbers */
316  else if (x > -150)
317  return av_int2float(1 << (x+149));
318  /* Negligibly small */
319  else
320  return 0;
321 }
322 
323 /**
324  * Get a buffer for a frame. This is a wrapper around
325  * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
326  * directly.
327  */
328 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
329 
330 /**
331  * Identical in function to av_frame_make_writable(), except it uses
332  * ff_get_buffer() to allocate the buffer when needed.
333  */
335 
337 
339 
340 /**
341  * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
342  * calling the function and then restoring again. Assumes the mutex is
343  * already locked
344  */
346 
347 /**
348  * Finalize buf into extradata and set its size appropriately.
349  */
350 int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf);
351 
352 const uint8_t *avpriv_find_start_code(const uint8_t *p,
353  const uint8_t *end,
354  uint32_t *state);
355 
357 
358 /**
359  * Check that the provided frame dimensions are valid and set them on the codec
360  * context.
361  */
363 
364 /**
365  * Check that the provided sample aspect ratio is valid and set it on the codec
366  * context.
367  */
368 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
369 
370 /**
371  * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
372  */
374  enum AVMatrixEncoding matrix_encoding);
375 
376 #if FF_API_MERGE_SD
378 #endif
379 
380 /**
381  * Select the (possibly hardware accelerated) pixel format.
382  * This is a wrapper around AVCodecContext.get_format() and should be used
383  * instead of calling get_format() directly.
384  */
385 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
386 
387 /**
388  * Set various frame properties from the codec context / packet data.
389  */
391 
392 /**
393  * Add a CPB properties side data to an encoding context.
394  */
396 
397 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type);
398 
399 /**
400  * Check AVFrame for A53 side data and allocate and fill SEI message with A53 info
401  *
402  * @param frame Raw frame to get A53 side data from
403  * @param prefix_len Number of bytes to allocate before SEI message
404  * @param data Pointer to a variable to store allocated memory
405  * Upon return the variable will hold NULL on error or if frame has no A53 info.
406  * Otherwise it will point to prefix_len uninitialized bytes followed by
407  * *sei_size SEI message
408  * @param sei_size Pointer to a variable to store generated SEI message length
409  * @return Zero on success, negative error code on failure
410  */
411 int ff_alloc_a53_sei(const AVFrame *frame, size_t prefix_len,
412  void **data, size_t *sei_size);
413 
414 /**
415  * Get an estimated video bitrate based on frame size, frame rate and coded
416  * bits per pixel.
417  */
418 int64_t ff_guess_coded_bitrate(AVCodecContext *avctx);
419 
420 #endif /* AVCODEC_INTERNAL_H */
int nb_draining_errors
Definition: internal.h:222
int ff_thread_can_start_frame(AVCodecContext *avctx)
const char * s
Definition: avisynth_c.h:768
#define AV_NUM_DATA_POINTERS
Definition: frame.h:202
This structure describes decoded (raw) audio or video data.
Definition: frame.h:201
int avpriv_unlock_avformat(void)
Definition: utils.c:2043
int stride_align[AV_NUM_DATA_POINTERS]
Definition: internal.h:114
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:101
static struct @260 state
const char * fmt
Definition: avisynth_c.h:769
AVPacket * last_pkt_props
Properties (timestamps+side data) extracted from the last packet passed for decoding.
Definition: internal.h:174
AVFrame * to_free
Definition: internal.h:161
int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec)
Definition: utils.c:588
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:211
int width
Definition: internal.h:113
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: avcodec.h:5914
const char * b
Definition: vf_curves.c:113
int samples
Definition: internal.h:118
AVBufferPool * pools[4]
Pools for each data plane.
Definition: internal.h:107
static AVPacket pkt
AVCodec.
Definition: avcodec.h:3739
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avcodec.h:1898
int ff_unlock_avcodec(const AVCodec *codec)
Definition: utils.c:2018
void ff_color_frame(AVFrame *frame, const int color[4])
Definition: utils.c:512
DecodeFilterContext filter
Definition: internal.h:168
int height
Definition: internal.h:113
uint8_t
void * thread_ctx
Definition: internal.h:165
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:1586
static AVFrame * frame
int planes
Definition: internal.h:116
void * frame_thread_encoder
Definition: internal.h:182
#define height
size_t compat_decode_consumed
Definition: internal.h:211
static int flags
Definition: log.c:57
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:226
ptrdiff_t size
Definition: opengl_enc.c:101
const OptionDef options[]
Definition: ffserver.c:3952
int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf)
Finalize buf into extradata and set its size appropriately.
Definition: utils.c:2142
The buffer pool.
const uint8_t * avpriv_find_start_code(const uint8_t *p, const uint8_t *end, uint32_t *state)
FramePool * pool
Definition: internal.h:163
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
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:615
int is_copy
Whether the parent AVCodecContext is a copy of the context which had init() called on it...
Definition: internal.h:138
AVFrame * buffer_frame
Definition: internal.h:204
uint16_t width
Definition: gdv.c:47
static av_always_inline float ff_exp2fi(int x)
2^(x) for integer x
Definition: internal.h:308
int avpriv_lock_avformat(void)
Definition: utils.c:2034
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:2454
int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame)
Identical in function to av_frame_make_writable(), except it uses ff_get_buffer() to allocate the buf...
Definition: decode.c:1713
audio channel layout utility functions
int channels
Definition: internal.h:117
AVFrame * compat_decode_frame
Definition: internal.h:215
AVPacket * in_pkt
Definition: internal.h:122
int ff_packet_split_and_drop_side_data(AVPacket *pkt)
Definition: avpacket.c:483
DecodeSimpleContext ds
Definition: internal.h:167
static void error(const char *err)
int draining
checks API usage: after codec draining, flush is required to resume operation
Definition: internal.h:197
int linesize[4]
Definition: internal.h:115
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:241
#define INFINITY
Definition: math.h:27
int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt)
Select the (possibly hardware accelerated) pixel format.
Definition: decode.c:1179
This structure describes the bitrate properties of an encoded bitstream.
Definition: avcodec.h:1354
Libavcodec external API header.
int compat_decode_warned
Definition: internal.h:208
int sample_rate
samples per second
Definition: avcodec.h:2523
main external API structure.
Definition: avcodec.h:1761
int skip_samples_multiplier
Definition: internal.h:219
volatile int ff_avcodec_locked
Definition: utils.c:116
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1664
void * buf
Definition: avisynth_c.h:690
int ff_init_buffer_info(AVCodecContext *s, AVFrame *frame)
does needed setup of pkt_pts/pos and such for (re)get_buffer();
Definition: decode.c:1478
int showed_multi_packet_warning
Definition: internal.h:217
unsigned int avpriv_toupper4(unsigned int x)
Definition: utils.c:2052
Rational number (pair of numerator and denominator).
Definition: rational.h:58
int buffer_pkt_valid
Definition: internal.h:203
int skip_samples
Number of audio samples to skip at the start of the next decoded frame.
Definition: internal.h:187
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:32
int allocate_progress
Whether to allocate progress for frame threading.
Definition: internal.h:153
#define attribute_deprecated
Definition: attributes.h:94
const uint8_t * key
Definition: internal.h:226
const uint8_t * value
Definition: internal.h:227
int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type)
Definition: avpacket.c:697
AVPacket * buffer_pkt
buffers for using new encode/decode API through legacy API
Definition: internal.h:202
int ff_lock_avcodec(AVCodecContext *log_ctx, const AVCodec *codec)
Definition: utils.c:1992
int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx)
Definition: h264dec.c:60
void * hwaccel_priv_data
hwaccel-specific private data
Definition: internal.h:192
AVCPBProperties * ff_add_cpb_side_data(AVCodecContext *avctx)
Add a CPB properties side data to an encoding context.
Definition: utils.c:2212
AVBSFContext ** bsfs
Definition: internal.h:127
pixel format definitions
attribute_deprecated int ff_alloc_packet(AVPacket *avpkt, int size)
Definition: encode.c:73
static const struct twinvq_data tab
unsigned int byte_buffer_size
Definition: internal.h:180
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:2411
size_t compat_decode_partial_size
Definition: internal.h:214
#define av_always_inline
Definition: attributes.h:39
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:295
AVMatrixEncoding
int format
Definition: internal.h:112
AVPixelFormat
Pixel format.
Definition: pixfmt.h:60
This structure stores compressed data.
Definition: avcodec.h:1656
uint8_t * byte_buffer
temporary buffer used for encoders to store their bitstream
Definition: internal.h:179
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:1907
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
AVFrame * out_frame
Definition: internal.h:123
int last_audio_frame
An audio frame with less than required samples has been submitted and padded with silence...
Definition: internal.h:159