FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavcodec/internal.h
Date: 2022-01-18 10:05:52
Exec Total Coverage
Lines: 6 12 50.0%
Branches: 3 10 30.0%
Line Branch Exec Source
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 "bsf.h"
36 #include "config.h"
37
38 /**
39 * The codec does not modify any global variables in the init function,
40 * allowing to call the init function without locking any global mutexes.
41 */
42 #define FF_CODEC_CAP_INIT_THREADSAFE (1 << 0)
43 /**
44 * The codec allows calling the close function for deallocation even if
45 * the init function returned a failure. Without this capability flag, a
46 * codec does such cleanup internally when returning failures from the
47 * init function and does not expect the close function to be called at
48 * all.
49 */
50 #define FF_CODEC_CAP_INIT_CLEANUP (1 << 1)
51 /**
52 * Decoders marked with FF_CODEC_CAP_SETS_PKT_DTS want to set
53 * AVFrame.pkt_dts manually. If the flag is set, decode.c won't overwrite
54 * this field. If it's unset, decode.c tries to guess the pkt_dts field
55 * from the input AVPacket.
56 */
57 #define FF_CODEC_CAP_SETS_PKT_DTS (1 << 2)
58 /**
59 * The decoder extracts and fills its parameters even if the frame is
60 * skipped due to the skip_frame setting.
61 */
62 #define FF_CODEC_CAP_SKIP_FRAME_FILL_PARAM (1 << 3)
63 /**
64 * The decoder sets the cropping fields in the output frames manually.
65 * If this cap is set, the generic code will initialize output frame
66 * dimensions to coded rather than display values.
67 */
68 #define FF_CODEC_CAP_EXPORTS_CROPPING (1 << 4)
69 /**
70 * Codec initializes slice-based threading with a main function
71 */
72 #define FF_CODEC_CAP_SLICE_THREAD_HAS_MF (1 << 5)
73 /*
74 * The codec supports frame threading and has inter-frame dependencies, so it
75 * uses ff_thread_report/await_progress().
76 */
77 #define FF_CODEC_CAP_ALLOCATE_PROGRESS (1 << 6)
78 /**
79 * Codec handles avctx->thread_count == 0 (auto) internally.
80 */
81 #define FF_CODEC_CAP_AUTO_THREADS (1 << 7)
82 /**
83 * Codec handles output frame properties internally instead of letting the
84 * internal logic derive them from AVCodecInternal.last_pkt_props.
85 */
86 #define FF_CODEC_CAP_SETS_FRAME_PROPS (1 << 8)
87
88 /**
89 * AVCodec.codec_tags termination value
90 */
91 #define FF_CODEC_TAGS_END -1
92
93
94 #define FF_DEFAULT_QUANT_BIAS 999999
95
96 #define FF_QSCALE_TYPE_MPEG1 0
97 #define FF_QSCALE_TYPE_MPEG2 1
98 #define FF_QSCALE_TYPE_H264 2
99 #define FF_QSCALE_TYPE_VP56 3
100
101 #define FF_SANE_NB_CHANNELS 512U
102
103 #define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
104
105 #if HAVE_SIMD_ALIGN_64
106 # define STRIDE_ALIGN 64 /* AVX-512 */
107 #elif HAVE_SIMD_ALIGN_32
108 # define STRIDE_ALIGN 32
109 #elif HAVE_SIMD_ALIGN_16
110 # define STRIDE_ALIGN 16
111 #else
112 # define STRIDE_ALIGN 8
113 #endif
114
115 typedef struct EncodeSimpleContext {
116 AVFrame *in_frame;
117 } EncodeSimpleContext;
118
119 typedef struct AVCodecInternal {
120 /**
121 * When using frame-threaded decoding, this field is set for the first
122 * worker thread (e.g. to decode extradata just once).
123 */
124 int is_copy;
125
126 /**
127 * An audio frame with less than required samples has been submitted and
128 * padded with silence. Reject all subsequent frames.
129 */
130 int last_audio_frame;
131
132 AVBufferRef *pool;
133
134 void *thread_ctx;
135
136 /**
137 * This packet is used to hold the packet given to decoders
138 * implementing the .decode API; it is unused by the generic
139 * code for decoders implementing the .receive_frame API and
140 * may be freely used (but not freed) by them with the caveat
141 * that the packet will be unreferenced generically in
142 * avcodec_flush_buffers().
143 */
144 AVPacket *in_pkt;
145 AVBSFContext *bsf;
146
147 /**
148 * Properties (timestamps+side data) extracted from the last packet passed
149 * for decoding.
150 */
151 AVPacket *last_pkt_props;
152 AVFifoBuffer *pkt_props;
153
154 /**
155 * temporary buffer used for encoders to store their bitstream
156 */
157 uint8_t *byte_buffer;
158 unsigned int byte_buffer_size;
159
160 /**
161 * This is set to AV_PKT_FLAG_KEY for encoders that encode intra-only
162 * formats (i.e. whose codec descriptor has AV_CODEC_PROP_INTRA_ONLY set).
163 * This is used to set said flag generically for said encoders.
164 */
165 int intra_only_flag;
166
167 void *frame_thread_encoder;
168
169 EncodeSimpleContext es;
170
171 /**
172 * If this is set, then AVCodec->close (if existing) needs to be called
173 * for the parent AVCodecContext.
174 */
175 int needs_close;
176
177 /**
178 * Number of audio samples to skip at the start of the next decoded frame
179 */
180 int skip_samples;
181
182 /**
183 * hwaccel-specific private data
184 */
185 void *hwaccel_priv_data;
186
187 /**
188 * checks API usage: after codec draining, flush is required to resume operation
189 */
190 int draining;
191
192 /**
193 * buffers for using new encode/decode API through legacy API
194 */
195 AVPacket *buffer_pkt;
196 AVFrame *buffer_frame;
197 int draining_done;
198
199 int showed_multi_packet_warning;
200
201 int skip_samples_multiplier;
202
203 /* to prevent infinite loop on errors when draining */
204 int nb_draining_errors;
205
206 /* used when avctx flag AV_CODEC_FLAG_DROPCHANGED is set */
207 int changed_frames_dropped;
208 int initial_format;
209 int initial_width, initial_height;
210 int initial_sample_rate;
211 int initial_channels;
212 uint64_t initial_channel_layout;
213 } AVCodecInternal;
214
215 struct AVCodecDefault {
216 const uint8_t *key;
217 const uint8_t *value;
218 };
219
220 extern const uint8_t ff_log2_run[41];
221
222 /**
223 * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
224 * If there is no such matching pair then size is returned.
225 */
226 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
227
228 unsigned int ff_toupper4(unsigned int x);
229
230 void ff_color_frame(AVFrame *frame, const int color[4]);
231
232 /**
233 * Maximum size in bytes of extradata.
234 * This value was chosen such that every bit of the buffer is
235 * addressable by a 32-bit signed integer as used by get_bits.
236 */
237 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
238
239 /**
240 * Rescale from sample rate to AVCodecContext.time_base.
241 */
242 302349 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
243 int64_t samples)
244 {
245
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 302349 times.
 302349 if(samples == AV_NOPTS_VALUE)
246 ✗ return AV_NOPTS_VALUE;
247 302349 return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
248 avctx->time_base);
249 }
250
251 /**
252 * 2^(x) for integer x
253 * @return correctly rounded float
254 */
255 179564 static av_always_inline float ff_exp2fi(int x) {
256 /* Normal range */
257
2/4
✓ Branch 0 taken 179564 times.
✗ Branch 1 not taken.
✓ Branch 2 taken 179564 times.
✗ Branch 3 not taken.
 179564 if (-126 <= x && x <= 128)
258 179564 return av_int2float((x+127) << 23);
259 /* Too large */
260 ✗ else if (x > 128)
261 ✗ return INFINITY;
262 /* Subnormal numbers */
263 ✗ else if (x > -150)
264 ✗ return av_int2float(1 << (x+149));
265 /* Negligibly small */
266 else
267 ✗ return 0;
268 }
269
270 /**
271 * Get a buffer for a frame. This is a wrapper around
272 * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
273 * directly.
274 */
275 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
276
277 #define FF_REGET_BUFFER_FLAG_READONLY 1 ///< the returned buffer does not need to be writable
278 /**
279 * Identical in function to ff_get_buffer(), except it reuses the existing buffer
280 * if available.
281 */
282 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
283
284 int ff_thread_can_start_frame(AVCodecContext *avctx);
285
286 int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx);
287
288 const uint8_t *avpriv_find_start_code(const uint8_t *p,
289 const uint8_t *end,
290 uint32_t *state);
291
292 int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec);
293
294 /**
295 * Check that the provided frame dimensions are valid and set them on the codec
296 * context.
297 */
298 int ff_set_dimensions(AVCodecContext *s, int width, int height);
299
300 /**
301 * Check that the provided sample aspect ratio is valid and set it on the codec
302 * context.
303 */
304 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
305
306 /**
307 * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
308 */
309 int ff_side_data_update_matrix_encoding(AVFrame *frame,
310 enum AVMatrixEncoding matrix_encoding);
311
312 /**
313 * Select the (possibly hardware accelerated) pixel format.
314 * This is a wrapper around AVCodecContext.get_format() and should be used
315 * instead of calling get_format() directly.
316 *
317 * The list of pixel formats must contain at least one valid entry, and is
318 * terminated with AV_PIX_FMT_NONE. If it is possible to decode to software,
319 * the last entry in the list must be the most accurate software format.
320 * If it is not possible to decode to software, AVCodecContext.sw_pix_fmt
321 * must be set before calling this function.
322 */
323 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
324
325 /**
326 * Add a CPB properties side data to an encoding context.
327 */
328 AVCPBProperties *ff_add_cpb_side_data(AVCodecContext *avctx);
329
330 /**
331 * Check AVFrame for S12M timecode side data and allocate and fill TC SEI message with timecode info
332 *
333 * @param frame Raw frame to get S12M timecode side data from
334 * @param rate The frame rate
335 * @param prefix_len Number of bytes to allocate before SEI message
336 * @param data Pointer to a variable to store allocated memory
337 * Upon return the variable will hold NULL on error or if frame has no S12M timecode info.
338 * Otherwise it will point to prefix_len uninitialized bytes followed by
339 * *sei_size SEI message
340 * @param sei_size Pointer to a variable to store generated SEI message length
341 * @return Zero on success, negative error code on failure
342 */
343 int ff_alloc_timecode_sei(const AVFrame *frame, AVRational rate, size_t prefix_len,
344 void **data, size_t *sei_size);
345
346 /**
347 * Get an estimated video bitrate based on frame size, frame rate and coded
348 * bits per pixel.
349 */
350 int64_t ff_guess_coded_bitrate(AVCodecContext *avctx);
351
352 /**
353 * Check if a value is in the list. If not, return the default value
354 *
355 * @param ctx Context for the log msg
356 * @param val_name Name of the checked value, for log msg
357 * @param array_valid_values Array of valid int, ended with INT_MAX
358 * @param default_value Value return if checked value is not in the array
359 * @return Value or default_value.
360 */
361 int ff_int_from_list_or_default(void *ctx, const char * val_name, int val,
362 const int * array_valid_values, int default_value);
363
364 void ff_dvdsub_parse_palette(uint32_t *palette, const char *p);
365
366 #endif /* AVCODEC_INTERNAL_H */
367