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