GCC Code Coverage Report
Directory: ../../../ffmpeg/ Exec Total Coverage
File: src/libavcodec/internal.h Lines: 6 12 50.0 %
Date: 2020-09-21 17:35:45 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/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
 * The codec supports frame threading and has inter-frame dependencies, so it
73
 * uses ff_thread_report/await_progress().
74
 */
75
#define FF_CODEC_CAP_ALLOCATE_PROGRESS      (1 << 6)
76
77
/**
78
 * AVCodec.codec_tags termination value
79
 */
80
#define FF_CODEC_TAGS_END -1
81
82
83
#ifdef TRACE
84
#   define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
85
#else
86
#   define ff_tlog(ctx, ...) do { } while(0)
87
#endif
88
89
90
#define FF_DEFAULT_QUANT_BIAS 999999
91
92
#define FF_QSCALE_TYPE_MPEG1 0
93
#define FF_QSCALE_TYPE_MPEG2 1
94
#define FF_QSCALE_TYPE_H264  2
95
#define FF_QSCALE_TYPE_VP56  3
96
97
#define FF_SANE_NB_CHANNELS 512U
98
99
#define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
100
101
#if HAVE_SIMD_ALIGN_64
102
#   define STRIDE_ALIGN 64 /* AVX-512 */
103
#elif HAVE_SIMD_ALIGN_32
104
#   define STRIDE_ALIGN 32
105
#elif HAVE_SIMD_ALIGN_16
106
#   define STRIDE_ALIGN 16
107
#else
108
#   define STRIDE_ALIGN 8
109
#endif
110
111
typedef struct DecodeSimpleContext {
112
    AVPacket *in_pkt;
113
} DecodeSimpleContext;
114
115
typedef struct EncodeSimpleContext {
116
    AVFrame *in_frame;
117
} EncodeSimpleContext;
118
119
typedef struct AVCodecInternal {
120
    /**
121
     * Whether the parent AVCodecContext is a copy of the context which had
122
     * init() called on it.
123
     * This is used by multithreading - shared tables and picture pointers
124
     * should be freed from the original context only.
125
     */
126
    int is_copy;
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
    AVBufferRef *pool;
137
138
    void *thread_ctx;
139
140
    DecodeSimpleContext ds;
141
    AVBSFContext *bsf;
142
143
    /**
144
     * Properties (timestamps+side data) extracted from the last packet passed
145
     * for decoding.
146
     */
147
    AVPacket *last_pkt_props;
148
    AVPacketList *pkt_props;
149
    AVPacketList *pkt_props_tail;
150
151
    /**
152
     * temporary buffer used for encoders to store their bitstream
153
     */
154
    uint8_t *byte_buffer;
155
    unsigned int byte_buffer_size;
156
157
    void *frame_thread_encoder;
158
159
    EncodeSimpleContext es;
160
161
    /**
162
     * Number of audio samples to skip at the start of the next decoded frame
163
     */
164
    int skip_samples;
165
166
    /**
167
     * hwaccel-specific private data
168
     */
169
    void *hwaccel_priv_data;
170
171
    /**
172
     * checks API usage: after codec draining, flush is required to resume operation
173
     */
174
    int draining;
175
176
    /**
177
     * buffers for using new encode/decode API through legacy API
178
     */
179
    AVPacket *buffer_pkt;
180
    AVFrame *buffer_frame;
181
    int draining_done;
182
    int compat_decode_warned;
183
    /* this variable is set by the decoder internals to signal to the old
184
     * API compat wrappers the amount of data consumed from the last packet */
185
    size_t compat_decode_consumed;
186
    /* when a partial packet has been consumed, this stores the remaining size
187
     * of the packet (that should be submitted in the next decode call */
188
    size_t compat_decode_partial_size;
189
    AVFrame *compat_decode_frame;
190
    AVPacket *compat_encode_packet;
191
192
    int showed_multi_packet_warning;
193
194
    int skip_samples_multiplier;
195
196
    /* to prevent infinite loop on errors when draining */
197
    int nb_draining_errors;
198
199
    /* used when avctx flag AV_CODEC_FLAG_DROPCHANGED is set */
200
    int changed_frames_dropped;
201
    int initial_format;
202
    int initial_width, initial_height;
203
    int initial_sample_rate;
204
    int initial_channels;
205
    uint64_t initial_channel_layout;
206
} AVCodecInternal;
207
208
struct AVCodecDefault {
209
    const uint8_t *key;
210
    const uint8_t *value;
211
};
212
213
extern const uint8_t ff_log2_run[41];
214
215
/**
216
 * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
217
 * If there is no such matching pair then size is returned.
218
 */
219
int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
220
221
unsigned int avpriv_toupper4(unsigned int x);
222
223
void ff_color_frame(AVFrame *frame, const int color[4]);
224
225
/**
226
 * Maximum size in bytes of extradata.
227
 * This value was chosen such that every bit of the buffer is
228
 * addressable by a 32-bit signed integer as used by get_bits.
229
 */
230
#define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
231
232
/**
233
 * Check AVPacket size and/or allocate data.
234
 *
235
 * Encoders supporting AVCodec.encode2() can use this as a convenience to
236
 * ensure the output packet data is large enough, whether provided by the user
237
 * or allocated in this function.
238
 *
239
 * @param avctx   the AVCodecContext of the encoder
240
 * @param avpkt   the AVPacket
241
 *                If avpkt->data is already set, avpkt->size is checked
242
 *                to ensure it is large enough.
243
 *                If avpkt->data is NULL, a new buffer is allocated.
244
 *                avpkt->size is set to the specified size.
245
 *                All other AVPacket fields will be reset with av_init_packet().
246
 * @param size    the minimum required packet size
247
 * @param min_size This is a hint to the allocation algorithm, which indicates
248
 *                to what minimal size the caller might later shrink the packet
249
 *                to. Encoders often allocate packets which are larger than the
250
 *                amount of data that is written into them as the exact amount is
251
 *                not known at the time of allocation. min_size represents the
252
 *                size a packet might be shrunk to by the caller. Can be set to
253
 *                0. setting this roughly correctly allows the allocation code
254
 *                to choose between several allocation strategies to improve
255
 *                speed slightly.
256
 * @return        non negative on success, negative error code on failure
257
 */
258
int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
259
260
/**
261
 * Rescale from sample rate to AVCodecContext.time_base.
262
 */
263
312416
static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
264
                                                        int64_t samples)
265
{
266
312416
    if(samples == AV_NOPTS_VALUE)
267
        return AV_NOPTS_VALUE;
268
312416
    return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
269
                        avctx->time_base);
270
}
271
272
/**
273
 * 2^(x) for integer x
274
 * @return correctly rounded float
275
 */
276
179564
static av_always_inline float ff_exp2fi(int x) {
277
    /* Normal range */
278

179564
    if (-126 <= x && x <= 128)
279
179564
        return av_int2float((x+127) << 23);
280
    /* Too large */
281
    else if (x > 128)
282
        return INFINITY;
283
    /* Subnormal numbers */
284
    else if (x > -150)
285
        return av_int2float(1 << (x+149));
286
    /* Negligibly small */
287
    else
288
        return 0;
289
}
290
291
/**
292
 * Get a buffer for a frame. This is a wrapper around
293
 * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
294
 * directly.
295
 */
296
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
297
298
#define FF_REGET_BUFFER_FLAG_READONLY 1 ///< the returned buffer does not need to be writable
299
/**
300
 * Identical in function to ff_get_buffer(), except it reuses the existing buffer
301
 * if available.
302
 */
303
int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
304
305
int ff_thread_can_start_frame(AVCodecContext *avctx);
306
307
int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx);
308
309
/**
310
 * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
311
 * calling the function and then restoring again. Assumes the mutex is
312
 * already locked
313
 */
314
int ff_codec_open2_recursive(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
315
316
/**
317
 * Finalize buf into extradata and set its size appropriately.
318
 */
319
int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf);
320
321
const uint8_t *avpriv_find_start_code(const uint8_t *p,
322
                                      const uint8_t *end,
323
                                      uint32_t *state);
324
325
int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec);
326
327
/**
328
 * Check that the provided frame dimensions are valid and set them on the codec
329
 * context.
330
 */
331
int ff_set_dimensions(AVCodecContext *s, int width, int height);
332
333
/**
334
 * Check that the provided sample aspect ratio is valid and set it on the codec
335
 * context.
336
 */
337
int ff_set_sar(AVCodecContext *avctx, AVRational sar);
338
339
/**
340
 * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
341
 */
342
int ff_side_data_update_matrix_encoding(AVFrame *frame,
343
                                        enum AVMatrixEncoding matrix_encoding);
344
345
/**
346
 * Select the (possibly hardware accelerated) pixel format.
347
 * This is a wrapper around AVCodecContext.get_format() and should be used
348
 * instead of calling get_format() directly.
349
 *
350
 * The list of pixel formats must contain at least one valid entry, and is
351
 * terminated with AV_PIX_FMT_NONE.  If it is possible to decode to software,
352
 * the last entry in the list must be the most accurate software format.
353
 * If it is not possible to decode to software, AVCodecContext.sw_pix_fmt
354
 * must be set before calling this function.
355
 */
356
int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
357
358
/**
359
 * Add a CPB properties side data to an encoding context.
360
 */
361
AVCPBProperties *ff_add_cpb_side_data(AVCodecContext *avctx);
362
363
/**
364
 * Check AVFrame for S12M timecode side data and allocate and fill TC SEI message with timecode info
365
 *
366
 * @param frame      Raw frame to get S12M timecode side data from
367
 * @param rate       The frame rate
368
 * @param prefix_len Number of bytes to allocate before SEI message
369
 * @param data       Pointer to a variable to store allocated memory
370
 *                   Upon return the variable will hold NULL on error or if frame has no S12M timecode info.
371
 *                   Otherwise it will point to prefix_len uninitialized bytes followed by
372
 *                   *sei_size SEI message
373
 * @param sei_size   Pointer to a variable to store generated SEI message length
374
 * @return           Zero on success, negative error code on failure
375
 */
376
int ff_alloc_timecode_sei(const AVFrame *frame, AVRational rate, size_t prefix_len,
377
                     void **data, size_t *sei_size);
378
379
/**
380
 * Get an estimated video bitrate based on frame size, frame rate and coded
381
 * bits per pixel.
382
 */
383
int64_t ff_guess_coded_bitrate(AVCodecContext *avctx);
384
385
/**
386
 * Check if a value is in the list. If not, return the default value
387
 *
388
 * @param ctx                Context for the log msg
389
 * @param val_name           Name of the checked value, for log msg
390
 * @param array_valid_values Array of valid int, ended with INT_MAX
391
 * @param default_value      Value return if checked value is not in the array
392
 * @return                   Value or default_value.
393
 */
394
int ff_int_from_list_or_default(void *ctx, const char * val_name, int val,
395
                                const int * array_valid_values, int default_value);
396
397
void ff_dvdsub_parse_palette(uint32_t *palette, const char *p);
398
399
#if defined(_WIN32) && CONFIG_SHARED && !defined(BUILDING_avcodec)
400
#    define av_export_avcodec __declspec(dllimport)
401
#else
402
#    define av_export_avcodec
403
#endif
404
405
#endif /* AVCODEC_INTERNAL_H */