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