avcodec: Avoid splitting side data repeatedly
[ffmpeg.git] / libavcodec / internal.h
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"
30 #include "libavutil/channel_layout.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 #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_SIMD_ALIGN_32
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      */
90     AVBufferPool *pools[4];
91
92     /*
93      * Pool parameters
94      */
95     int format;
96     int width, height;
97     int stride_align[AV_NUM_DATA_POINTERS];
98     int linesize[4];
99     int planes;
100     int channels;
101     int samples;
102 } FramePool;
103
104 typedef struct DecodeSimpleContext {
105     AVPacket *in_pkt;
106     AVFrame  *out_frame;
107 } DecodeSimpleContext;
108
109 typedef struct DecodeFilterContext {
110     AVBSFContext **bsfs;
111     int         nb_bsfs;
112 } DecodeFilterContext;
113
114 typedef struct AVCodecInternal {
115     /**
116      * Whether the parent AVCodecContext is a copy of the context which had
117      * init() called on it.
118      * This is used by multithreading - shared tables and picture pointers
119      * should be freed from the original context only.
120      */
121     int is_copy;
122
123     /**
124      * Whether to allocate progress for frame threading.
125      *
126      * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
127      * then progress will be allocated in ff_thread_get_buffer(). The frames
128      * then MUST be freed with ff_thread_release_buffer().
129      *
130      * If the codec does not need to call the progress functions (there are no
131      * dependencies between the frames), it should leave this at 0. Then it can
132      * decode straight to the user-provided frames (which the user will then
133      * free with av_frame_unref()), there is no need to call
134      * ff_thread_release_buffer().
135      */
136     int allocate_progress;
137
138     /**
139      * An audio frame with less than required samples has been submitted and
140      * padded with silence. Reject all subsequent frames.
141      */
142     int last_audio_frame;
143
144     AVFrame *to_free;
145
146     FramePool *pool;
147
148     void *thread_ctx;
149
150     DecodeSimpleContext ds;
151     DecodeFilterContext filter;
152
153     /**
154      * Properties (timestamps+side data) extracted from the last packet passed
155      * for decoding.
156      */
157     AVPacket *last_pkt_props;
158
159     /**
160      * temporary buffer used for encoders to store their bitstream
161      */
162     uint8_t *byte_buffer;
163     unsigned int byte_buffer_size;
164
165     void *frame_thread_encoder;
166
167     /**
168      * Number of audio samples to skip at the start of the next decoded frame
169      */
170     int skip_samples;
171
172     /**
173      * hwaccel-specific private data
174      */
175     void *hwaccel_priv_data;
176
177     /**
178      * checks API usage: after codec draining, flush is required to resume operation
179      */
180     int draining;
181
182     /**
183      * buffers for using new encode/decode API through legacy API
184      */
185     AVPacket *buffer_pkt;
186     int buffer_pkt_valid; // encoding: packet without data can be valid
187     AVFrame *buffer_frame;
188     int draining_done;
189     /* set to 1 when the caller is using the old decoding API */
190     int compat_decode;
191     int compat_decode_warned;
192     /* this variable is set by the decoder internals to signal to the old
193      * API compat wrappers the amount of data consumed from the last packet */
194     size_t compat_decode_consumed;
195     /* when a partial packet has been consumed, this stores the remaining size
196      * of the packet (that should be submitted in the next decode call */
197     size_t compat_decode_partial_size;
198     AVFrame *compat_decode_frame;
199
200     int showed_multi_packet_warning;
201
202     int skip_samples_multiplier;
203
204     /* to prevent infinite loop on errors when draining */
205     int nb_draining_errors;
206 } AVCodecInternal;
207
208 struct AVCodecDefault {
209     const uint8_t *key;
210     const uint8_t *value;
211 };
212
213 extern const uint8_t ff_log2_run[41];
214
215 /**
216  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
217  * If there is no such matching pair then size is returned.
218  */
219 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
220
221 unsigned int avpriv_toupper4(unsigned int x);
222
223 /**
224  * does needed setup of pkt_pts/pos and such for (re)get_buffer();
225  */
226 int ff_init_buffer_info(AVCodecContext *s, AVFrame *frame);
227
228
229 void ff_color_frame(AVFrame *frame, const int color[4]);
230
231 extern volatile int ff_avcodec_locked;
232 int ff_lock_avcodec(AVCodecContext *log_ctx, const AVCodec *codec);
233 int ff_unlock_avcodec(const AVCodec *codec);
234
235 int avpriv_lock_avformat(void);
236 int avpriv_unlock_avformat(void);
237
238 /**
239  * Maximum size in bytes of extradata.
240  * This value was chosen such that every bit of the buffer is
241  * addressable by a 32-bit signed integer as used by get_bits.
242  */
243 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
244
245 /**
246  * Check AVPacket size and/or allocate data.
247  *
248  * Encoders supporting AVCodec.encode2() can use this as a convenience to
249  * ensure the output packet data is large enough, whether provided by the user
250  * or allocated in this function.
251  *
252  * @param avctx   the AVCodecContext of the encoder
253  * @param avpkt   the AVPacket
254  *                If avpkt->data is already set, avpkt->size is checked
255  *                to ensure it is large enough.
256  *                If avpkt->data is NULL, a new buffer is allocated.
257  *                avpkt->size is set to the specified size.
258  *                All other AVPacket fields will be reset with av_init_packet().
259  * @param size    the minimum required packet size
260  * @param min_size This is a hint to the allocation algorithm, which indicates
261  *                to what minimal size the caller might later shrink the packet
262  *                to. Encoders often allocate packets which are larger than the
263  *                amount of data that is written into them as the exact amount is
264  *                not known at the time of allocation. min_size represents the
265  *                size a packet might be shrunk to by the caller. Can be set to
266  *                0. setting this roughly correctly allows the allocation code
267  *                to choose between several allocation strategies to improve
268  *                speed slightly.
269  * @return        non negative on success, negative error code on failure
270  */
271 int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
272
273 attribute_deprecated int ff_alloc_packet(AVPacket *avpkt, int size);
274
275 /**
276  * Rescale from sample rate to AVCodecContext.time_base.
277  */
278 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
279                                                         int64_t samples)
280 {
281     if(samples == AV_NOPTS_VALUE)
282         return AV_NOPTS_VALUE;
283     return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
284                         avctx->time_base);
285 }
286
287 /**
288  * 2^(x) for integer x
289  * @return correctly rounded float
290  */
291 static av_always_inline float ff_exp2fi(int x) {
292     /* Normal range */
293     if (-126 <= x && x <= 128)
294         return av_int2float((x+127) << 23);
295     /* Too large */
296     else if (x > 128)
297         return INFINITY;
298     /* Subnormal numbers */
299     else if (x > -150)
300         return av_int2float(1 << (x+149));
301     /* Negligibly small */
302     else
303         return 0;
304 }
305
306 /**
307  * Get a buffer for a frame. This is a wrapper around
308  * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
309  * directly.
310  */
311 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
312
313 /**
314  * Identical in function to av_frame_make_writable(), except it uses
315  * ff_get_buffer() to allocate the buffer when needed.
316  */
317 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
318
319 int ff_thread_can_start_frame(AVCodecContext *avctx);
320
321 int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx);
322
323 /**
324  * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
325  * calling the function and then restoring again. Assumes the mutex is
326  * already locked
327  */
328 int ff_codec_open2_recursive(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
329
330 /**
331  * Finalize buf into extradata and set its size appropriately.
332  */
333 int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf);
334
335 const uint8_t *avpriv_find_start_code(const uint8_t *p,
336                                       const uint8_t *end,
337                                       uint32_t *state);
338
339 int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec);
340
341 /**
342  * Check that the provided frame dimensions are valid and set them on the codec
343  * context.
344  */
345 int ff_set_dimensions(AVCodecContext *s, int width, int height);
346
347 /**
348  * Check that the provided sample aspect ratio is valid and set it on the codec
349  * context.
350  */
351 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
352
353 /**
354  * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
355  */
356 int ff_side_data_update_matrix_encoding(AVFrame *frame,
357                                         enum AVMatrixEncoding matrix_encoding);
358
359 #if FF_API_MERGE_SD
360 int ff_packet_split_and_drop_side_data(AVPacket *pkt);
361 #endif
362
363 /**
364  * Select the (possibly hardware accelerated) pixel format.
365  * This is a wrapper around AVCodecContext.get_format() and should be used
366  * instead of calling get_format() directly.
367  */
368 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
369
370 /**
371  * Set various frame properties from the codec context / packet data.
372  */
373 int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
374
375 /**
376  * Add a CPB properties side data to an encoding context.
377  */
378 AVCPBProperties *ff_add_cpb_side_data(AVCodecContext *avctx);
379
380 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type);
381
382 /**
383  * Check AVFrame for A53 side data and allocate and fill SEI message with A53 info
384  *
385  * @param frame      Raw frame to get A53 side data from
386  * @param prefix_len Number of bytes to allocate before SEI message
387  * @param data       Pointer to a variable to store allocated memory
388  *                   Upon return the variable will hold NULL on error or if frame has no A53 info.
389  *                   Otherwise it will point to prefix_len uninitialized bytes followed by
390  *                   *sei_size SEI message
391  * @param sei_size   Pointer to a variable to store generated SEI message length
392  * @return           Zero on success, negative error code on failure
393  */
394 int ff_alloc_a53_sei(const AVFrame *frame, size_t prefix_len,
395                      void **data, size_t *sei_size);
396
397 /**
398  * Get an estimated video bitrate based on frame size, frame rate and coded
399  * bits per pixel.
400  */
401 int64_t ff_guess_coded_bitrate(AVCodecContext *avctx);
402
403 #endif /* AVCODEC_INTERNAL_H */