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