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