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, utils.c won't overwrite
52  * this field. If it's unset, utils.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 #ifdef TRACE
63 # define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
64 #else
65 # define ff_tlog(ctx, ...) do { } while(0)
66 #endif
67 
68 
69 #if !FF_API_QUANT_BIAS
70 #define FF_DEFAULT_QUANT_BIAS 999999
71 #endif
72 
73 #define FF_SANE_NB_CHANNELS 64U
74 
75 #define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
76 
77 #if HAVE_AVX
78 # define STRIDE_ALIGN 32
79 #elif HAVE_SIMD_ALIGN_16
80 # define STRIDE_ALIGN 16
81 #else
82 # define STRIDE_ALIGN 8
83 #endif
84 
85 typedef struct FramePool {
86  /**
87  * Pools for each data plane. For audio all the planes have the same size,
88  * so only pools[0] is used.
89  */
91 
92  /*
93  * Pool parameters
94  */
95  int format;
96  int width, height;
98  int linesize[4];
99  int planes;
100  int channels;
101  int samples;
102 } FramePool;
103 
104 typedef struct AVCodecInternal {
105  /**
106  * Whether the parent AVCodecContext is a copy of the context which had
107  * init() called on it.
108  * This is used by multithreading - shared tables and picture pointers
109  * should be freed from the original context only.
110  */
111  int is_copy;
112 
113  /**
114  * Whether to allocate progress for frame threading.
115  *
116  * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
117  * then progress will be allocated in ff_thread_get_buffer(). The frames
118  * then MUST be freed with ff_thread_release_buffer().
119  *
120  * If the codec does not need to call the progress functions (there are no
121  * dependencies between the frames), it should leave this at 0. Then it can
122  * decode straight to the user-provided frames (which the user will then
123  * free with av_frame_unref()), there is no need to call
124  * ff_thread_release_buffer().
125  */
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 
140  /**
141  * Current packet as passed into the decoder, to avoid having to pass the
142  * packet into every function.
143  */
145 
146  /**
147  * temporary buffer used for encoders to store their bitstream
148  */
150  unsigned int byte_buffer_size;
151 
153 
154  /**
155  * Number of audio samples to skip at the start of the next decoded frame
156  */
158 
159  /**
160  * hwaccel-specific private data
161  */
163 
164  /**
165  * checks API usage: after codec draining, flush is required to resume operation
166  */
167  int draining;
168 
169  /**
170  * buffers for using new encode/decode API through legacy API
171  */
173  int buffer_pkt_valid; // encoding: packet without data can be valid
177 
179  const uint8_t *key;
180  const uint8_t *value;
181 };
182 
183 extern const uint8_t ff_log2_run[41];
184 
185 /**
186  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
187  * If there is no such matching pair then size is returned.
188  */
189 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
190 
191 unsigned int avpriv_toupper4(unsigned int x);
192 
193 /**
194  * does needed setup of pkt_pts/pos and such for (re)get_buffer();
195  */
197 
198 
199 void ff_color_frame(AVFrame *frame, const int color[4]);
200 
201 extern volatile int ff_avcodec_locked;
202 int ff_lock_avcodec(AVCodecContext *log_ctx, const AVCodec *codec);
203 int ff_unlock_avcodec(const AVCodec *codec);
204 
205 int avpriv_lock_avformat(void);
206 int avpriv_unlock_avformat(void);
207 
208 /**
209  * Maximum size in bytes of extradata.
210  * This value was chosen such that every bit of the buffer is
211  * addressable by a 32-bit signed integer as used by get_bits.
212  */
213 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
214 
215 /**
216  * Check AVPacket size and/or allocate data.
217  *
218  * Encoders supporting AVCodec.encode2() can use this as a convenience to
219  * ensure the output packet data is large enough, whether provided by the user
220  * or allocated in this function.
221  *
222  * @param avctx the AVCodecContext of the encoder
223  * @param avpkt the AVPacket
224  * If avpkt->data is already set, avpkt->size is checked
225  * to ensure it is large enough.
226  * If avpkt->data is NULL, a new buffer is allocated.
227  * avpkt->size is set to the specified size.
228  * All other AVPacket fields will be reset with av_init_packet().
229  * @param size the minimum required packet size
230  * @param min_size This is a hint to the allocation algorithm, which indicates
231  * to what minimal size the caller might later shrink the packet
232  * to. Encoders often allocate packets which are larger than the
233  * amount of data that is written into them as the exact amount is
234  * not known at the time of allocation. min_size represents the
235  * size a packet might be shrunk to by the caller. Can be set to
236  * 0. setting this roughly correctly allows the allocation code
237  * to choose between several allocation strategies to improve
238  * speed slightly.
239  * @return non negative on success, negative error code on failure
240  */
241 int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
242 
244 
245 /**
246  * Rescale from sample rate to AVCodecContext.time_base.
247  */
249  int64_t samples)
250 {
251  if(samples == AV_NOPTS_VALUE)
252  return AV_NOPTS_VALUE;
253  return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
254  avctx->time_base);
255 }
256 
257 /**
258  * 2^(x) for integer x
259  * @return correctly rounded float
260  */
261 static av_always_inline float ff_exp2fi(int x) {
262  /* Normal range */
263  if (-126 <= x && x <= 128)
264  return av_int2float(x+127 << 23);
265  /* Too large */
266  else if (x > 128)
267  return INFINITY;
268  /* Subnormal numbers */
269  else if (x > -150)
270  return av_int2float(1 << (x+149));
271  /* Negligibly small */
272  else
273  return 0;
274 }
275 
276 /**
277  * Get a buffer for a frame. This is a wrapper around
278  * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
279  * directly.
280  */
281 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
282 
283 /**
284  * Identical in function to av_frame_make_writable(), except it uses
285  * ff_get_buffer() to allocate the buffer when needed.
286  */
288 
290 
292 
293 /**
294  * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
295  * calling the function and then restoring again. Assumes the mutex is
296  * already locked
297  */
299 
300 /**
301  * Finalize buf into extradata and set its size appropriately.
302  */
303 int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf);
304 
305 const uint8_t *avpriv_find_start_code(const uint8_t *p,
306  const uint8_t *end,
307  uint32_t *state);
308 
310 
311 /**
312  * Check that the provided frame dimensions are valid and set them on the codec
313  * context.
314  */
316 
317 /**
318  * Check that the provided sample aspect ratio is valid and set it on the codec
319  * context.
320  */
321 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
322 
323 /**
324  * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
325  */
327  enum AVMatrixEncoding matrix_encoding);
328 
329 /**
330  * Select the (possibly hardware accelerated) pixel format.
331  * This is a wrapper around AVCodecContext.get_format() and should be used
332  * instead of calling get_format() directly.
333  */
334 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
335 
336 /**
337  * Set various frame properties from the codec context / packet data.
338  */
340 
341 /**
342  * Add a CPB properties side data to an encoding context.
343  */
345 
346 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type);
347 
348 /**
349  * Check AVFrame for A53 side data and allocate and fill SEI message with A53 info
350  *
351  * @param frame Raw frame to get A53 side data from
352  * @param prefix_len Number of bytes to allocate before SEI message
353  * @param data Pointer to a variable to store allocated memory
354  * Upon return the variable will hold NULL on error or if frame has no A53 info.
355  * Otherwise it will point to prefix_len uninitialized bytes followed by
356  * *sei_size SEI message
357  * @param sei_size Pointer to a variable to store generated SEI message length
358  * @return Zero on success, negative error code on failure
359  */
360 int ff_alloc_a53_sei(const AVFrame *frame, size_t prefix_len,
361  void **data, size_t *sei_size);
362 
363 #endif /* AVCODEC_INTERNAL_H */
int ff_thread_can_start_frame(AVCodecContext *avctx)
const char * s
Definition: avisynth_c.h:631
#define AV_NUM_DATA_POINTERS
Definition: frame.h:185
This structure describes decoded (raw) audio or video data.
Definition: frame.h:184
int avpriv_unlock_avformat(void)
Definition: utils.c:3824
int stride_align[AV_NUM_DATA_POINTERS]
Definition: internal.h:97
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:101
const char * fmt
Definition: avisynth_c.h:632
AVFrame * to_free
Definition: internal.h:134
int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec)
Definition: utils.c:1163
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:210
int width
Definition: internal.h:96
static av_always_inline float av_int2float(uint32_t i)
Reinterpret a 32-bit integer as a float.
Definition: intfloat.h:40
const char * b
Definition: vf_curves.c:109
AVPacket * pkt
Current packet as passed into the decoder, to avoid having to pass the packet into every function...
Definition: internal.h:144
int samples
Definition: internal.h:101
AVBufferPool * pools[4]
Pools for each data plane.
Definition: internal.h:90
static AVPacket pkt
AVCodec.
Definition: avcodec.h:3559
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avcodec.h:1794
int ff_unlock_avcodec(const AVCodec *codec)
Definition: utils.c:3799
void ff_color_frame(AVFrame *frame, const int color[4])
Definition: utils.c:700
int height
Definition: internal.h:96
uint8_t
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: utils.c:851
static AVFrame * frame
int planes
Definition: internal.h:99
void * frame_thread_encoder
Definition: internal.h:152
#define height
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:225
ptrdiff_t size
Definition: opengl_enc.c:101
const OptionDef options[]
Definition: ffserver.c:3969
int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf)
Finalize buf into extradata and set its size appropriately.
Definition: utils.c:3922
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:136
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:1196
int is_copy
Whether the parent AVCodecContext is a copy of the context which had init() called on it...
Definition: internal.h:111
AVFrame * buffer_frame
Definition: internal.h:174
static av_always_inline float ff_exp2fi(int x)
2^(x) for integer x
Definition: internal.h:261
int avpriv_lock_avformat(void)
Definition: utils.c:3815
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: utils.c:977
audio channel layout utility functions
int channels
Definition: internal.h:100
#define width
int draining
checks API usage: after codec draining, flush is required to resume operation
Definition: internal.h:167
int linesize[4]
Definition: internal.h:98
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:240
#define INFINITY
Definition: math.h:27
int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt)
Select the (possibly hardware accelerated) pixel format.
Definition: utils.c:1090
This structure describes the bitrate properties of an encoded bitstream.
Definition: avcodec.h:1298
Libavcodec external API header.
int sample_rate
samples per second
Definition: avcodec.h:2418
main external API structure.
Definition: avcodec.h:1657
volatile int ff_avcodec_locked
Definition: utils.c:115
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: utils.c:928
void * buf
Definition: avisynth_c.h:553
int ff_init_buffer_info(AVCodecContext *s, AVFrame *frame)
does needed setup of pkt_pts/pos and such for (re)get_buffer();
Definition: utils.c:752
unsigned int avpriv_toupper4(unsigned int x)
Definition: utils.c:3833
rational number numerator/denominator
Definition: rational.h:43
int buffer_pkt_valid
Definition: internal.h:173
int skip_samples
Number of audio samples to skip at the start of the next decoded frame.
Definition: internal.h:157
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: utils.c:1690
int allocate_progress
Whether to allocate progress for frame threading.
Definition: internal.h:126
static int flags
Definition: cpu.c:47
#define attribute_deprecated
Definition: attributes.h:94
const uint8_t * key
Definition: internal.h:179
const uint8_t * value
Definition: internal.h:180
int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type)
Definition: avpacket.c:641
AVPacket * buffer_pkt
buffers for using new encode/decode API through legacy API
Definition: internal.h:172
int ff_lock_avcodec(AVCodecContext *log_ctx, const AVCodec *codec)
Definition: utils.c:3773
int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx)
Definition: h264.c:60
void * hwaccel_priv_data
hwaccel-specific private data
Definition: internal.h:162
AVCPBProperties * ff_add_cpb_side_data(AVCodecContext *avctx)
Add a CPB properties side data to an encoding context.
Definition: utils.c:3992
pixel format definitions
attribute_deprecated int ff_alloc_packet(AVPacket *avpkt, int size)
Definition: utils.c:1731
static const struct twinvq_data tab
unsigned int byte_buffer_size
Definition: internal.h:150
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:4189
#define av_always_inline
Definition: attributes.h:39
const uint8_t ff_log2_run[41]
Definition: bitstream.c:40
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:248
AVMatrixEncoding
static struct @230 state
int format
Definition: internal.h:95
AVPixelFormat
Pixel format.
Definition: pixfmt.h:60
This structure stores compressed data.
Definition: avcodec.h:1565
uint8_t * byte_buffer
temporary buffer used for encoders to store their bitstream
Definition: internal.h:149
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:3688
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:240
int last_audio_frame
An audio frame with less than required samples has been submitted and padded with silence...
Definition: internal.h:132