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 
51 #ifdef TRACE
52 # define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
53 #else
54 # define ff_tlog(ctx, ...) while(0)
55 #endif
56 
57 
58 #if !FF_API_QUANT_BIAS
59 #define FF_DEFAULT_QUANT_BIAS 999999
60 #endif
61 
62 #define FF_SANE_NB_CHANNELS 64U
63 
64 #define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
65 
66 #if HAVE_AVX
67 # define STRIDE_ALIGN 32
68 #elif HAVE_SIMD_ALIGN_16
69 # define STRIDE_ALIGN 16
70 #else
71 # define STRIDE_ALIGN 8
72 #endif
73 
74 typedef struct FramePool {
75  /**
76  * Pools for each data plane. For audio all the planes have the same size,
77  * so only pools[0] is used.
78  */
80 
81  /*
82  * Pool parameters
83  */
84  int format;
85  int width, height;
87  int linesize[4];
88  int planes;
89  int channels;
90  int samples;
91 } FramePool;
92 
93 typedef struct AVCodecInternal {
94  /**
95  * Whether the parent AVCodecContext is a copy of the context which had
96  * init() called on it.
97  * This is used by multithreading - shared tables and picture pointers
98  * should be freed from the original context only.
99  */
100  int is_copy;
101 
102  /**
103  * Whether to allocate progress for frame threading.
104  *
105  * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
106  * then progress will be allocated in ff_thread_get_buffer(). The frames
107  * then MUST be freed with ff_thread_release_buffer().
108  *
109  * If the codec does not need to call the progress functions (there are no
110  * dependencies between the frames), it should leave this at 0. Then it can
111  * decode straight to the user-provided frames (which the user will then
112  * free with av_frame_unref()), there is no need to call
113  * ff_thread_release_buffer().
114  */
116 
117 #if FF_API_OLD_ENCODE_AUDIO
118  /**
119  * Internal sample count used by avcodec_encode_audio() to fabricate pts.
120  * Can be removed along with avcodec_encode_audio().
121  */
122  int64_t sample_count;
123 #endif
124 
125  /**
126  * An audio frame with less than required samples has been submitted and
127  * padded with silence. Reject all subsequent frames.
128  */
130 
132 
134 
135  void *thread_ctx;
136 
137  /**
138  * Current packet as passed into the decoder, to avoid having to pass the
139  * packet into every function.
140  */
142 
143  /**
144  * temporary buffer used for encoders to store their bitstream
145  */
147  unsigned int byte_buffer_size;
148 
150 
151  /**
152  * Number of audio samples to skip at the start of the next decoded frame
153  */
155 
156  /**
157  * hwaccel-specific private data
158  */
161 
163  const uint8_t *key;
164  const uint8_t *value;
165 };
166 
167 extern const uint8_t ff_log2_run[41];
168 
169 /**
170  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
171  * If there is no such matching pair then size is returned.
172  */
173 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
174 
175 unsigned int avpriv_toupper4(unsigned int x);
176 
177 /**
178  * does needed setup of pkt_pts/pos and such for (re)get_buffer();
179  */
181 
182 
183 void avpriv_color_frame(AVFrame *frame, const int color[4]);
184 
185 extern volatile int ff_avcodec_locked;
186 int ff_lock_avcodec(AVCodecContext *log_ctx, const AVCodec *codec);
187 int ff_unlock_avcodec(void);
188 
189 int avpriv_lock_avformat(void);
190 int avpriv_unlock_avformat(void);
191 
192 /**
193  * Maximum size in bytes of extradata.
194  * This value was chosen such that every bit of the buffer is
195  * addressable by a 32-bit signed integer as used by get_bits.
196  */
197 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
198 
199 /**
200  * Check AVPacket size and/or allocate data.
201  *
202  * Encoders supporting AVCodec.encode2() can use this as a convenience to
203  * ensure the output packet data is large enough, whether provided by the user
204  * or allocated in this function.
205  *
206  * @param avctx the AVCodecContext of the encoder
207  * @param avpkt the AVPacket
208  * If avpkt->data is already set, avpkt->size is checked
209  * to ensure it is large enough.
210  * If avpkt->data is NULL, a new buffer is allocated.
211  * avpkt->size is set to the specified size.
212  * All other AVPacket fields will be reset with av_init_packet().
213  * @param size the minimum required packet size
214  * @param min_size This is a hint to the allocation algorithm, which indicates
215  * to what minimal size the caller might later shrink the packet
216  * to. Encoders often allocate packets which are larger than the
217  * amount of data that is written into them as the exact amount is
218  * not known at the time of allocation. min_size represents the
219  * size a packet might be shrunk to by the caller. Can be set to
220  * 0. setting this roughly correctly allows the allocation code
221  * to choose between several allocation strategies to improve
222  * speed slightly.
223  * @return non negative on success, negative error code on failure
224  */
225 int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
226 
228 
229 /**
230  * Rescale from sample rate to AVCodecContext.time_base.
231  */
233  int64_t samples)
234 {
235  if(samples == AV_NOPTS_VALUE)
236  return AV_NOPTS_VALUE;
237  return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
238  avctx->time_base);
239 }
240 
241 /**
242  * Get a buffer for a frame. This is a wrapper around
243  * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
244  * directly.
245  */
246 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
247 
248 /**
249  * Identical in function to av_frame_make_writable(), except it uses
250  * ff_get_buffer() to allocate the buffer when needed.
251  */
253 
255 
257 
258 /**
259  * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
260  * calling the function and then restoring again. Assumes the mutex is
261  * already locked
262  */
264 
265 /**
266  * Finalize buf into extradata and set its size appropriately.
267  */
268 int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf);
269 
270 const uint8_t *avpriv_find_start_code(const uint8_t *p,
271  const uint8_t *end,
272  uint32_t *state);
273 
274 /**
275  * Check that the provided frame dimensions are valid and set them on the codec
276  * context.
277  */
279 
280 /**
281  * Check that the provided sample aspect ratio is valid and set it on the codec
282  * context.
283  */
284 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
285 
286 /**
287  * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
288  */
290  enum AVMatrixEncoding matrix_encoding);
291 
292 /**
293  * Select the (possibly hardware accelerated) pixel format.
294  * This is a wrapper around AVCodecContext.get_format() and should be used
295  * instead of calling get_format() directly.
296  */
297 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
298 
299 /**
300  * Set various frame properties from the codec context / packet data.
301  */
303 
304 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type);
305 
306 #endif /* AVCODEC_INTERNAL_H */
int ff_unlock_avcodec(void)
Definition: utils.c:3723
int ff_thread_can_start_frame(AVCodecContext *avctx)
const char * s
Definition: avisynth_c.h:631
#define AV_NUM_DATA_POINTERS
Definition: frame.h:172
This structure describes decoded (raw) audio or video data.
Definition: frame.h:171
int avpriv_unlock_avformat(void)
Definition: utils.c:3745
int stride_align[AV_NUM_DATA_POINTERS]
Definition: internal.h:86
const char * fmt
Definition: avisynth_c.h:632
AVFrame * to_free
Definition: internal.h:131
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:216
int width
Definition: internal.h:85
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:141
int samples
Definition: internal.h:90
AVBufferPool * pools[4]
Pools for each data plane.
Definition: internal.h:79
static AVPacket pkt
AVCodec.
Definition: avcodec.h:3472
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avcodec.h:1631
int height
Definition: internal.h:85
uint8_t
void * thread_ctx
Definition: internal.h:135
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:875
int64_t sample_count
Internal sample count used by avcodec_encode_audio() to fabricate pts.
Definition: internal.h:122
static AVFrame * frame
int planes
Definition: internal.h:88
void * frame_thread_encoder
Definition: internal.h:149
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:231
ptrdiff_t size
Definition: opengl_enc.c:101
const OptionDef options[]
Definition: ffserver.c:3807
int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf)
Finalize buf into extradata and set its size appropriately.
Definition: utils.c:3863
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:133
int64_t av_rescale_q(int64_t a, AVRational bq, AVRational cq)
Rescale a 64-bit integer by 2 rational numbers.
Definition: mathematics.c:140
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:1337
int is_copy
Whether the parent AVCodecContext is a copy of the context which had init() called on it...
Definition: internal.h:100
int avpriv_lock_avformat(void)
Definition: utils.c:3736
Libavcodec external API header.
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:1087
audio channel layout utility functions
int channels
Definition: internal.h:89
static struct @197 state
int linesize[4]
Definition: internal.h:87
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:246
int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt)
Select the (possibly hardware accelerated) pixel format.
Definition: utils.c:1210
int sample_rate
samples per second
Definition: avcodec.h:2262
void avpriv_color_frame(AVFrame *frame, const int color[4])
Definition: utils.c:690
main external API structure.
Definition: avcodec.h:1502
volatile int ff_avcodec_locked
Definition: utils.c:121
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: utils.c:1040
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:748
BYTE int const BYTE int int int height
Definition: avisynth_c.h:676
unsigned int avpriv_toupper4(unsigned int x)
Definition: utils.c:3754
rational number numerator/denominator
Definition: rational.h:43
int skip_samples
Number of audio samples to skip at the start of the next decoded frame.
Definition: internal.h:154
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:1782
int allocate_progress
Whether to allocate progress for frame threading.
Definition: internal.h:115
static int flags
Definition: cpu.c:47
#define attribute_deprecated
Definition: attributes.h:86
const uint8_t * key
Definition: internal.h:163
const uint8_t * value
Definition: internal.h:164
int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type)
Definition: avpacket.c:606
int ff_lock_avcodec(AVCodecContext *log_ctx, const AVCodec *codec)
Definition: utils.c:3699
int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx)
Definition: h264.c:56
void * hwaccel_priv_data
hwaccel-specific private data
Definition: internal.h:159
pixel format definitions
attribute_deprecated int ff_alloc_packet(AVPacket *avpkt, int size)
Definition: utils.c:1838
static const struct twinvq_data tab
unsigned int byte_buffer_size
Definition: internal.h:147
#define av_always_inline
Definition: attributes.h:37
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:232
AVMatrixEncoding
int format
Definition: internal.h:84
AVPixelFormat
Pixel format.
Definition: pixfmt.h:61
This structure stores compressed data.
Definition: avcodec.h:1400
uint8_t * byte_buffer
temporary buffer used for encoders to store their bitstream
Definition: internal.h:146
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:3614
#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:129
static int width