internal.h 10.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/*
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
20
 * @file
21 22 23 24 25 26
 * common internal api header.
 */

#ifndef AVCODEC_INTERNAL_H
#define AVCODEC_INTERNAL_H

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 38
 * The codec does not modify any global variables in the init function,
 * allowing to call the init function without locking any global mutexes.
39 40 41
 */
#define FF_CODEC_CAP_INIT_THREADSAFE        (1 << 0)
/**
42 43 44 45 46
 * The codec allows calling the close function for deallocation even if
 * the init function returned a failure. Without this capability flag, a
 * codec does such cleanup internally when returning failures from the
 * init function and does not expect the close function to be called at
 * all.
47 48
 */
#define FF_CODEC_CAP_INIT_CLEANUP           (1 << 1)
49 50 51 52 53 54 55
/**
 * Decoders marked with FF_CODEC_CAP_SETS_PKT_DTS want to set
 * AVFrame.pkt_dts manually. If the flag is set, utils.c won't overwrite
 * this field. If it's unset, utils.c tries to guess the pkt_dts field
 * from the input AVPacket.
 */
#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 63 64
#ifdef TRACE
#   define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
#else
65
#   define ff_tlog(ctx, ...) do { } while(0)
66 67 68
#endif


69 70 71 72
#if !FF_API_QUANT_BIAS
#define FF_DEFAULT_QUANT_BIAS 999999
#endif

73
#define FF_SANE_NB_CHANNELS 64U
74

75
#define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
76

77 78
#if HAVE_AVX
#   define STRIDE_ALIGN 32
79
#elif HAVE_SIMD_ALIGN_16
80 81 82 83 84
#   define STRIDE_ALIGN 16
#else
#   define STRIDE_ALIGN 8
#endif

85
typedef struct FramePool {
86
    /**
87 88
     * Pools for each data plane. For audio all the planes have the same size,
     * so only pools[0] is used.
89
     */
90
    AVBufferPool *pools[4];
91

92 93
    /*
     * Pool parameters
94
     */
95 96 97 98 99 100 101 102
    int format;
    int width, height;
    int stride_align[AV_NUM_DATA_POINTERS];
    int linesize[4];
    int planes;
    int channels;
    int samples;
} FramePool;
103

104
typedef struct AVCodecInternal {
105 106 107 108 109 110 111
    /**
     * Whether the parent AVCodecContext is a copy of the context which had
     * init() called on it.
     * This is used by multithreading - shared tables and picture pointers
     * should be freed from the original context only.
     */
    int is_copy;
112

113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
    /**
     * Whether to allocate progress for frame threading.
     *
     * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
     * then progress will be allocated in ff_thread_get_buffer(). The frames
     * then MUST be freed with ff_thread_release_buffer().
     *
     * If the codec does not need to call the progress functions (there are no
     * dependencies between the frames), it should leave this at 0. Then it can
     * decode straight to the user-provided frames (which the user will then
     * free with av_frame_unref()), there is no need to call
     * ff_thread_release_buffer().
     */
    int allocate_progress;

128 129 130 131 132
    /**
     * An audio frame with less than required samples has been submitted and
     * padded with silence. Reject all subsequent frames.
     */
    int last_audio_frame;
133

134
    AVFrame *to_free;
135 136

    FramePool *pool;
137

138
    void *thread_ctx;
139

140 141 142 143 144
    /**
     * Current packet as passed into the decoder, to avoid having to pass the
     * packet into every function.
     */
    AVPacket *pkt;
145

146 147 148 149 150
    /**
     * temporary buffer used for encoders to store their bitstream
     */
    uint8_t *byte_buffer;
    unsigned int byte_buffer_size;
151 152

    void *frame_thread_encoder;
153 154 155 156 157

    /**
     * Number of audio samples to skip at the start of the next decoded frame
     */
    int skip_samples;
158

159 160 161 162
    /**
     * hwaccel-specific private data
     */
    void *hwaccel_priv_data;
163 164 165 166 167 168 169 170 171 172 173 174 175

    /**
     * checks API usage: after codec draining, flush is required to resume operation
     */
    int draining;

    /**
     * buffers for using new encode/decode API through legacy API
     */
    AVPacket *buffer_pkt;
    int buffer_pkt_valid; // encoding: packet without data can be valid
    AVFrame *buffer_frame;
    int draining_done;
176 177
} AVCodecInternal;

178 179 180 181 182
struct AVCodecDefault {
    const uint8_t *key;
    const uint8_t *value;
};

183 184
extern const uint8_t ff_log2_run[41];

185 186 187 188
/**
 * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
 * If there is no such matching pair then size is returned.
 */
189 190
int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);

191
unsigned int avpriv_toupper4(unsigned int x);
192

193 194 195
/**
 * does needed setup of pkt_pts/pos and such for (re)get_buffer();
 */
196
int ff_init_buffer_info(AVCodecContext *s, AVFrame *frame);
197

198

199
void ff_color_frame(AVFrame *frame, const int color[4]);
200

201
extern volatile int ff_avcodec_locked;
202
int ff_lock_avcodec(AVCodecContext *log_ctx, const AVCodec *codec);
203
int ff_unlock_avcodec(const AVCodec *codec);
204

205 206 207
int avpriv_lock_avformat(void);
int avpriv_unlock_avformat(void);

208 209 210 211 212
/**
 * Maximum size in bytes of extradata.
 * This value was chosen such that every bit of the buffer is
 * addressable by a 32-bit signed integer as used by get_bits.
 */
213
#define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
214

215 216 217 218 219 220 221
/**
 * Check AVPacket size and/or allocate data.
 *
 * Encoders supporting AVCodec.encode2() can use this as a convenience to
 * ensure the output packet data is large enough, whether provided by the user
 * or allocated in this function.
 *
222
 * @param avctx   the AVCodecContext of the encoder
223 224 225 226
 * @param avpkt   the AVPacket
 *                If avpkt->data is already set, avpkt->size is checked
 *                to ensure it is large enough.
 *                If avpkt->data is NULL, a new buffer is allocated.
227
 *                avpkt->size is set to the specified size.
228 229
 *                All other AVPacket fields will be reset with av_init_packet().
 * @param size    the minimum required packet size
230 231 232 233 234 235 236 237
 * @param min_size This is a hint to the allocation algorithm, which indicates
 *                to what minimal size the caller might later shrink the packet
 *                to. Encoders often allocate packets which are larger than the
 *                amount of data that is written into them as the exact amount is
 *                not known at the time of allocation. min_size represents the
 *                size a packet might be shrunk to by the caller. Can be set to
 *                0. setting this roughly correctly allows the allocation code
 *                to choose between several allocation strategies to improve
238
 *                speed slightly.
239
 * @return        non negative on success, negative error code on failure
240
 */
241
int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
242

243
attribute_deprecated int ff_alloc_packet(AVPacket *avpkt, int size);
244

245 246 247 248 249 250
/**
 * Rescale from sample rate to AVCodecContext.time_base.
 */
static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
                                                        int64_t samples)
{
251 252
    if(samples == AV_NOPTS_VALUE)
        return AV_NOPTS_VALUE;
253 254 255 256
    return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
                        avctx->time_base);
}

257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
/**
 * 2^(x) for integer x
 * @return correctly rounded float
 */
static av_always_inline float ff_exp2fi(int x) {
    /* Normal range */
    if (-126 <= x && x <= 128)
        return av_int2float(x+127 << 23);
    /* Too large */
    else if (x > 128)
        return INFINITY;
    /* Subnormal numbers */
    else if (x > -150)
        return av_int2float(1 << (x+149));
    /* Negligibly small */
    else
        return 0;
}

276 277 278 279 280
/**
 * Get a buffer for a frame. This is a wrapper around
 * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
 * directly.
 */
281 282 283 284 285 286 287
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);

/**
 * Identical in function to av_frame_make_writable(), except it uses
 * ff_get_buffer() to allocate the buffer when needed.
 */
int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
288

289 290
int ff_thread_can_start_frame(AVCodecContext *avctx);

291 292
int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx);

293 294 295 296 297 298 299
/**
 * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
 * calling the function and then restoring again. Assumes the mutex is
 * already locked
 */
int ff_codec_open2_recursive(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);

300 301 302
/**
 * Finalize buf into extradata and set its size appropriately.
 */
303
int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf);
304

305
const uint8_t *avpriv_find_start_code(const uint8_t *p,
306
                                      const uint8_t *end,
307
                                      uint32_t *state);
308

309 310
int avpriv_codec_get_cap_skip_frame_fill_param(const AVCodec *codec);

311 312 313 314 315 316
/**
 * Check that the provided frame dimensions are valid and set them on the codec
 * context.
 */
int ff_set_dimensions(AVCodecContext *s, int width, int height);

317 318 319 320 321 322
/**
 * Check that the provided sample aspect ratio is valid and set it on the codec
 * context.
 */
int ff_set_sar(AVCodecContext *avctx, AVRational sar);

323 324 325 326 327 328
/**
 * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
 */
int ff_side_data_update_matrix_encoding(AVFrame *frame,
                                        enum AVMatrixEncoding matrix_encoding);

329 330 331 332 333 334 335
/**
 * Select the (possibly hardware accelerated) pixel format.
 * This is a wrapper around AVCodecContext.get_format() and should be used
 * instead of calling get_format() directly.
 */
int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);

336 337 338 339
/**
 * Set various frame properties from the codec context / packet data.
 */
int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
340

341 342 343 344 345
/**
 * Add a CPB properties side data to an encoding context.
 */
AVCPBProperties *ff_add_cpb_side_data(AVCodecContext *avctx);

346 347
int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type);

348
#endif /* AVCODEC_INTERNAL_H */