FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavcodec/internal.h
Date: 2021-09-16 08:47:15
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 DecodeSimpleContext {
116 AVPacket *in_pkt;
117 } DecodeSimpleContext;
118
119 typedef struct EncodeSimpleContext {
120 AVFrame *in_frame;
121 } EncodeSimpleContext;
122
123 typedef struct AVCodecInternal {
124 /**
125 * Whether the parent AVCodecContext is a copy of the context which had
126 * init() called on it.
127 * This is used by multithreading - shared tables and picture pointers
128 * should be freed from the original context only.
129 */
130 int is_copy;
131
132 /**
133 * An audio frame with less than required samples has been submitted and
134 * padded with silence. Reject all subsequent frames.
135 */
136 int last_audio_frame;
137
138 AVBufferRef *pool;
139
140 void *thread_ctx;
141
142 DecodeSimpleContext ds;
143 AVBSFContext *bsf;
144
145 /**
146 * Properties (timestamps+side data) extracted from the last packet passed
147 * for decoding.
148 */
149 AVPacket *last_pkt_props;
150 AVFifoBuffer *pkt_props;
151
152 /**
153 * temporary buffer used for encoders to store their bitstream
154 */
155 uint8_t *byte_buffer;
156 unsigned int byte_buffer_size;
157
158 void *frame_thread_encoder;
159
160 EncodeSimpleContext es;
161
162 /**
163 * If this is set, then AVCodec->close (if existing) needs to be called
164 * for the parent AVCodecContext.
165 */
166 int needs_close;
167
168 /**
169 * Number of audio samples to skip at the start of the next decoded frame
170 */
171 int skip_samples;
172
173 /**
174 * hwaccel-specific private data
175 */
176 void *hwaccel_priv_data;
177
178 /**
179 * checks API usage: after codec draining, flush is required to resume operation
180 */
181 int draining;
182
183 /**
184 * buffers for using new encode/decode API through legacy API
185 */
186 AVPacket *buffer_pkt;
187 AVFrame *buffer_frame;
188 int draining_done;
189
190 int showed_multi_packet_warning;
191
192 int skip_samples_multiplier;
193
194 /* to prevent infinite loop on errors when draining */
195 int nb_draining_errors;
196
197 /* used when avctx flag AV_CODEC_FLAG_DROPCHANGED is set */
198 int changed_frames_dropped;
199 int initial_format;
200 int initial_width, initial_height;
201 int initial_sample_rate;
202 int initial_channels;
203 uint64_t initial_channel_layout;
204 } AVCodecInternal;
205
206 struct AVCodecDefault {
207 const uint8_t *key;
208 const uint8_t *value;
209 };
210
211 extern const uint8_t ff_log2_run[41];
212
213 /**
214 * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
215 * If there is no such matching pair then size is returned.
216 */
217 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
218
219 unsigned int avpriv_toupper4(unsigned int x);
220
221 void ff_color_frame(AVFrame *frame, const int color[4]);
222
223 /**
224 * Maximum size in bytes of extradata.
225 * This value was chosen such that every bit of the buffer is
226 * addressable by a 32-bit signed integer as used by get_bits.
227 */
228 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
229
230 /**
231 * Rescale from sample rate to AVCodecContext.time_base.
232 */
233 296317 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
234 int64_t samples)
235 {
236
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 296317 times.
 296317 if(samples == AV_NOPTS_VALUE)
237 ✗ return AV_NOPTS_VALUE;
238 296317 return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
239 avctx->time_base);
240 }
241
242 /**
243 * 2^(x) for integer x
244 * @return correctly rounded float
245 */
246 179564 static av_always_inline float ff_exp2fi(int x) {
247 /* Normal range */
248
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)
249 179564 return av_int2float((x+127) << 23);
250 /* Too large */
251 ✗ else if (x > 128)
252 ✗ return INFINITY;
253 /* Subnormal numbers */
254 ✗ else if (x > -150)
255 ✗ return av_int2float(1 << (x+149));
256 /* Negligibly small */
257 else
258 ✗ return 0;
259 }
260
261 /**
262 * Get a buffer for a frame. This is a wrapper around
263 * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
264 * directly.
265 */
266 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
267
268 #define FF_REGET_BUFFER_FLAG_READONLY 1 ///< the returned buffer does not need to be writable
269 /**
270 * Identical in function to ff_get_buffer(), except it reuses the existing buffer
271 * if available.
272 */
273 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
274
275 int ff_thread_can_start_frame(AVCodecContext *avctx);
276
277 int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx);
278
279 const uint8_t *avpriv_find_start_code(const uint8_t *p,
280 const uint8_t *end,
281 uint32_t *state);
282
283 int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec);
284
285 /**
286 * Check that the provided frame dimensions are valid and set them on the codec
287 * context.
288 */
289 int ff_set_dimensions(AVCodecContext *s, int width, int height);
290
291 /**
292 * Check that the provided sample aspect ratio is valid and set it on the codec
293 * context.
294 */
295 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
296
297 /**
298 * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
299 */
300 int ff_side_data_update_matrix_encoding(AVFrame *frame,
301 enum AVMatrixEncoding matrix_encoding);
302
303 /**
304 * Select the (possibly hardware accelerated) pixel format.
305 * This is a wrapper around AVCodecContext.get_format() and should be used
306 * instead of calling get_format() directly.
307 *
308 * The list of pixel formats must contain at least one valid entry, and is
309 * terminated with AV_PIX_FMT_NONE. If it is possible to decode to software,
310 * the last entry in the list must be the most accurate software format.
311 * If it is not possible to decode to software, AVCodecContext.sw_pix_fmt
312 * must be set before calling this function.
313 */
314 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
315
316 /**
317 * Add a CPB properties side data to an encoding context.
318 */
319 AVCPBProperties *ff_add_cpb_side_data(AVCodecContext *avctx);
320
321 /**
322 * Check AVFrame for S12M timecode side data and allocate and fill TC SEI message with timecode info
323 *
324 * @param frame Raw frame to get S12M timecode side data from
325 * @param rate The frame rate
326 * @param prefix_len Number of bytes to allocate before SEI message
327 * @param data Pointer to a variable to store allocated memory
328 * Upon return the variable will hold NULL on error or if frame has no S12M timecode info.
329 * Otherwise it will point to prefix_len uninitialized bytes followed by
330 * *sei_size SEI message
331 * @param sei_size Pointer to a variable to store generated SEI message length
332 * @return Zero on success, negative error code on failure
333 */
334 int ff_alloc_timecode_sei(const AVFrame *frame, AVRational rate, size_t prefix_len,
335 void **data, size_t *sei_size);
336
337 /**
338 * Get an estimated video bitrate based on frame size, frame rate and coded
339 * bits per pixel.
340 */
341 int64_t ff_guess_coded_bitrate(AVCodecContext *avctx);
342
343 /**
344 * Check if a value is in the list. If not, return the default value
345 *
346 * @param ctx Context for the log msg
347 * @param val_name Name of the checked value, for log msg
348 * @param array_valid_values Array of valid int, ended with INT_MAX
349 * @param default_value Value return if checked value is not in the array
350 * @return Value or default_value.
351 */
352 int ff_int_from_list_or_default(void *ctx, const char * val_name, int val,
353 const int * array_valid_values, int default_value);
354
355 void ff_dvdsub_parse_palette(uint32_t *palette, const char *p);
356
357 #if defined(_WIN32) && CONFIG_SHARED && !defined(BUILDING_avcodec)
358 # define av_export_avcodec __declspec(dllimport)
359 #else
360 # define av_export_avcodec
361 #endif
362
363 #endif /* AVCODEC_INTERNAL_H */
364