avcodec/decode: port last_pkt_props to AVFifoBuffer
[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/fifo.h"
32 #include "libavutil/mathematics.h"
33 #include "libavutil/pixfmt.h"
34 #include "avcodec.h"
35 #include "config.h"
36
37 /**
38  * The codec does not modify any global variables in the init function,
39  * allowing to call the init function without locking any global mutexes.
40  */
41 #define FF_CODEC_CAP_INIT_THREADSAFE        (1 << 0)
42 /**
43  * The codec allows calling the close function for deallocation even if
44  * the init function returned a failure. Without this capability flag, a
45  * codec does such cleanup internally when returning failures from the
46  * init function and does not expect the close function to be called at
47  * all.
48  */
49 #define FF_CODEC_CAP_INIT_CLEANUP           (1 << 1)
50 /**
51  * Decoders marked with FF_CODEC_CAP_SETS_PKT_DTS want to set
52  * AVFrame.pkt_dts manually. If the flag is set, decode.c won't overwrite
53  * this field. If it's unset, decode.c tries to guess the pkt_dts field
54  * from the input AVPacket.
55  */
56 #define FF_CODEC_CAP_SETS_PKT_DTS           (1 << 2)
57 /**
58  * The decoder extracts and fills its parameters even if the frame is
59  * skipped due to the skip_frame setting.
60  */
61 #define FF_CODEC_CAP_SKIP_FRAME_FILL_PARAM  (1 << 3)
62 /**
63  * The decoder sets the cropping fields in the output frames manually.
64  * If this cap is set, the generic code will initialize output frame
65  * dimensions to coded rather than display values.
66  */
67 #define FF_CODEC_CAP_EXPORTS_CROPPING       (1 << 4)
68 /**
69  * Codec initializes slice-based threading with a main function
70  */
71 #define FF_CODEC_CAP_SLICE_THREAD_HAS_MF    (1 << 5)
72 /*
73  * The codec supports frame threading and has inter-frame dependencies, so it
74  * uses ff_thread_report/await_progress().
75  */
76 #define FF_CODEC_CAP_ALLOCATE_PROGRESS      (1 << 6)
77
78 /**
79  * AVCodec.codec_tags termination value
80  */
81 #define FF_CODEC_TAGS_END -1
82
83
84 #ifdef TRACE
85 #   define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
86 #else
87 #   define ff_tlog(ctx, ...) do { } while(0)
88 #endif
89
90
91 #define FF_DEFAULT_QUANT_BIAS 999999
92
93 #define FF_QSCALE_TYPE_MPEG1 0
94 #define FF_QSCALE_TYPE_MPEG2 1
95 #define FF_QSCALE_TYPE_H264  2
96 #define FF_QSCALE_TYPE_VP56  3
97
98 #define FF_SANE_NB_CHANNELS 512U
99
100 #define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
101
102 #if HAVE_SIMD_ALIGN_64
103 #   define STRIDE_ALIGN 64 /* AVX-512 */
104 #elif HAVE_SIMD_ALIGN_32
105 #   define STRIDE_ALIGN 32
106 #elif HAVE_SIMD_ALIGN_16
107 #   define STRIDE_ALIGN 16
108 #else
109 #   define STRIDE_ALIGN 8
110 #endif
111
112 typedef struct DecodeSimpleContext {
113     AVPacket *in_pkt;
114 } DecodeSimpleContext;
115
116 typedef struct EncodeSimpleContext {
117     AVFrame *in_frame;
118 } EncodeSimpleContext;
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      * An audio frame with less than required samples has been submitted and
131      * padded with silence. Reject all subsequent frames.
132      */
133     int last_audio_frame;
134
135 #if FF_API_OLD_ENCDEC
136     AVFrame *to_free;
137 #endif
138
139     AVBufferRef *pool;
140
141     void *thread_ctx;
142
143     DecodeSimpleContext ds;
144     AVBSFContext *bsf;
145
146     /**
147      * Properties (timestamps+side data) extracted from the last packet passed
148      * for decoding.
149      */
150     AVPacket *last_pkt_props;
151     AVFifoBuffer *pkt_props;
152
153     /**
154      * temporary buffer used for encoders to store their bitstream
155      */
156     uint8_t *byte_buffer;
157     unsigned int byte_buffer_size;
158
159     void *frame_thread_encoder;
160
161     EncodeSimpleContext es;
162
163     /**
164      * Number of audio samples to skip at the start of the next decoded frame
165      */
166     int skip_samples;
167
168     /**
169      * hwaccel-specific private data
170      */
171     void *hwaccel_priv_data;
172
173     /**
174      * checks API usage: after codec draining, flush is required to resume operation
175      */
176     int draining;
177
178     /**
179      * buffers for using new encode/decode API through legacy API
180      */
181     AVPacket *buffer_pkt;
182     AVFrame *buffer_frame;
183     int draining_done;
184
185 #if FF_API_OLD_ENCDEC
186     int compat_decode_warned;
187     /* this variable is set by the decoder internals to signal to the old
188      * API compat wrappers the amount of data consumed from the last packet */
189     size_t compat_decode_consumed;
190     /* when a partial packet has been consumed, this stores the remaining size
191      * of the packet (that should be submitted in the next decode call */
192     size_t compat_decode_partial_size;
193     AVFrame *compat_decode_frame;
194     AVPacket *compat_encode_packet;
195 #endif
196
197     int showed_multi_packet_warning;
198
199     int skip_samples_multiplier;
200
201     /* to prevent infinite loop on errors when draining */
202     int nb_draining_errors;
203
204     /* used when avctx flag AV_CODEC_FLAG_DROPCHANGED is set */
205     int changed_frames_dropped;
206     int initial_format;
207     int initial_width, initial_height;
208     int initial_sample_rate;
209     int initial_channels;
210     uint64_t initial_channel_layout;
211 } AVCodecInternal;
212
213 struct AVCodecDefault {
214     const uint8_t *key;
215     const uint8_t *value;
216 };
217
218 extern const uint8_t ff_log2_run[41];
219
220 /**
221  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
222  * If there is no such matching pair then size is returned.
223  */
224 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
225
226 unsigned int avpriv_toupper4(unsigned int x);
227
228 void ff_color_frame(AVFrame *frame, const int color[4]);
229
230 /**
231  * Maximum size in bytes of extradata.
232  * This value was chosen such that every bit of the buffer is
233  * addressable by a 32-bit signed integer as used by get_bits.
234  */
235 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
236
237 /**
238  * Check AVPacket size and/or allocate data.
239  *
240  * Encoders supporting AVCodec.encode2() can use this as a convenience to
241  * ensure the output packet data is large enough, whether provided by the user
242  * or allocated in this function.
243  *
244  * @param avctx   the AVCodecContext of the encoder
245  * @param avpkt   the AVPacket
246  *                If avpkt->data is already set, avpkt->size is checked
247  *                to ensure it is large enough.
248  *                If avpkt->data is NULL, a new buffer is allocated.
249  *                avpkt->size is set to the specified size.
250  *                All other AVPacket fields will be reset with av_init_packet().
251  * @param size    the minimum required packet size
252  * @param min_size This is a hint to the allocation algorithm, which indicates
253  *                to what minimal size the caller might later shrink the packet
254  *                to. Encoders often allocate packets which are larger than the
255  *                amount of data that is written into them as the exact amount is
256  *                not known at the time of allocation. min_size represents the
257  *                size a packet might be shrunk to by the caller. Can be set to
258  *                0. setting this roughly correctly allows the allocation code
259  *                to choose between several allocation strategies to improve
260  *                speed slightly.
261  * @return        non negative on success, negative error code on failure
262  */
263 int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
264
265 /**
266  * Rescale from sample rate to AVCodecContext.time_base.
267  */
268 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
269                                                         int64_t samples)
270 {
271     if(samples == AV_NOPTS_VALUE)
272         return AV_NOPTS_VALUE;
273     return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
274                         avctx->time_base);
275 }
276
277 /**
278  * 2^(x) for integer x
279  * @return correctly rounded float
280  */
281 static av_always_inline float ff_exp2fi(int x) {
282     /* Normal range */
283     if (-126 <= x && x <= 128)
284         return av_int2float((x+127) << 23);
285     /* Too large */
286     else if (x > 128)
287         return INFINITY;
288     /* Subnormal numbers */
289     else if (x > -150)
290         return av_int2float(1 << (x+149));
291     /* Negligibly small */
292     else
293         return 0;
294 }
295
296 /**
297  * Get a buffer for a frame. This is a wrapper around
298  * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
299  * directly.
300  */
301 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
302
303 #define FF_REGET_BUFFER_FLAG_READONLY 1 ///< the returned buffer does not need to be writable
304 /**
305  * Identical in function to ff_get_buffer(), except it reuses the existing buffer
306  * if available.
307  */
308 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
309
310 int ff_thread_can_start_frame(AVCodecContext *avctx);
311
312 int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx);
313
314 const uint8_t *avpriv_find_start_code(const uint8_t *p,
315                                       const uint8_t *end,
316                                       uint32_t *state);
317
318 int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec);
319
320 /**
321  * Check that the provided frame dimensions are valid and set them on the codec
322  * context.
323  */
324 int ff_set_dimensions(AVCodecContext *s, int width, int height);
325
326 /**
327  * Check that the provided sample aspect ratio is valid and set it on the codec
328  * context.
329  */
330 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
331
332 /**
333  * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
334  */
335 int ff_side_data_update_matrix_encoding(AVFrame *frame,
336                                         enum AVMatrixEncoding matrix_encoding);
337
338 /**
339  * Select the (possibly hardware accelerated) pixel format.
340  * This is a wrapper around AVCodecContext.get_format() and should be used
341  * instead of calling get_format() directly.
342  *
343  * The list of pixel formats must contain at least one valid entry, and is
344  * terminated with AV_PIX_FMT_NONE.  If it is possible to decode to software,
345  * the last entry in the list must be the most accurate software format.
346  * If it is not possible to decode to software, AVCodecContext.sw_pix_fmt
347  * must be set before calling this function.
348  */
349 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
350
351 /**
352  * Add a CPB properties side data to an encoding context.
353  */
354 AVCPBProperties *ff_add_cpb_side_data(AVCodecContext *avctx);
355
356 /**
357  * Check AVFrame for S12M timecode side data and allocate and fill TC SEI message with timecode info
358  *
359  * @param frame      Raw frame to get S12M timecode side data from
360  * @param rate       The frame rate
361  * @param prefix_len Number of bytes to allocate before SEI message
362  * @param data       Pointer to a variable to store allocated memory
363  *                   Upon return the variable will hold NULL on error or if frame has no S12M timecode info.
364  *                   Otherwise it will point to prefix_len uninitialized bytes followed by
365  *                   *sei_size SEI message
366  * @param sei_size   Pointer to a variable to store generated SEI message length
367  * @return           Zero on success, negative error code on failure
368  */
369 int ff_alloc_timecode_sei(const AVFrame *frame, AVRational rate, size_t prefix_len,
370                      void **data, size_t *sei_size);
371
372 /**
373  * Get an estimated video bitrate based on frame size, frame rate and coded
374  * bits per pixel.
375  */
376 int64_t ff_guess_coded_bitrate(AVCodecContext *avctx);
377
378 /**
379  * Check if a value is in the list. If not, return the default value
380  *
381  * @param ctx                Context for the log msg
382  * @param val_name           Name of the checked value, for log msg
383  * @param array_valid_values Array of valid int, ended with INT_MAX
384  * @param default_value      Value return if checked value is not in the array
385  * @return                   Value or default_value.
386  */
387 int ff_int_from_list_or_default(void *ctx, const char * val_name, int val,
388                                 const int * array_valid_values, int default_value);
389
390 void ff_dvdsub_parse_palette(uint32_t *palette, const char *p);
391
392 #if defined(_WIN32) && CONFIG_SHARED && !defined(BUILDING_avcodec)
393 #    define av_export_avcodec __declspec(dllimport)
394 #else
395 #    define av_export_avcodec
396 #endif
397
398 #endif /* AVCODEC_INTERNAL_H */