internal.h 9.44 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 49 50
 */
#define FF_CODEC_CAP_INIT_CLEANUP           (1 << 1)


51 52 53
#ifdef TRACE
#   define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
#else
54
#   define ff_tlog(ctx, ...) while(0)
55 56 57
#endif


58 59 60 61
#if !FF_API_QUANT_BIAS
#define FF_DEFAULT_QUANT_BIAS 999999
#endif

62
#define FF_SANE_NB_CHANNELS 64U
63

64
#define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
65

66 67
#if HAVE_AVX
#   define STRIDE_ALIGN 32
68
#elif HAVE_SIMD_ALIGN_16
69 70 71 72 73
#   define STRIDE_ALIGN 16
#else
#   define STRIDE_ALIGN 8
#endif

74
typedef struct FramePool {
75
    /**
76 77
     * Pools for each data plane. For audio all the planes have the same size,
     * so only pools[0] is used.
78
     */
79
    AVBufferPool *pools[4];
80

81 82
    /*
     * Pool parameters
83
     */
84 85 86 87 88 89 90 91
    int format;
    int width, height;
    int stride_align[AV_NUM_DATA_POINTERS];
    int linesize[4];
    int planes;
    int channels;
    int samples;
} FramePool;
92

93
typedef struct AVCodecInternal {
94 95 96 97 98 99 100
    /**
     * 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;
101

102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
    /**
     * 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;

117
#if FF_API_OLD_ENCODE_AUDIO
118 119 120 121
    /**
     * Internal sample count used by avcodec_encode_audio() to fabricate pts.
     * Can be removed along with avcodec_encode_audio().
     */
122
    int64_t sample_count;
123
#endif
124

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

131
    AVFrame *to_free;
132 133

    FramePool *pool;
134

135
    void *thread_ctx;
136

137 138 139 140 141
    /**
     * Current packet as passed into the decoder, to avoid having to pass the
     * packet into every function.
     */
    AVPacket *pkt;
142

143 144 145 146 147
    /**
     * temporary buffer used for encoders to store their bitstream
     */
    uint8_t *byte_buffer;
    unsigned int byte_buffer_size;
148 149

    void *frame_thread_encoder;
150 151 152 153 154

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

156 157 158 159
    /**
     * hwaccel-specific private data
     */
    void *hwaccel_priv_data;
160 161
} AVCodecInternal;

162 163 164 165 166
struct AVCodecDefault {
    const uint8_t *key;
    const uint8_t *value;
};

167 168
extern const uint8_t ff_log2_run[41];

169 170 171 172
/**
 * 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.
 */
173 174
int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);

175
unsigned int avpriv_toupper4(unsigned int x);
176

177 178 179
/**
 * does needed setup of pkt_pts/pos and such for (re)get_buffer();
 */
180
int ff_init_buffer_info(AVCodecContext *s, AVFrame *frame);
181

182 183 184

void avpriv_color_frame(AVFrame *frame, const int color[4]);

185
extern volatile int ff_avcodec_locked;
186
int ff_lock_avcodec(AVCodecContext *log_ctx, const AVCodec *codec);
187 188
int ff_unlock_avcodec(void);

189 190 191
int avpriv_lock_avformat(void);
int avpriv_unlock_avformat(void);

192 193 194 195 196
/**
 * 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.
 */
197
#define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
198

199 200 201 202 203 204 205
/**
 * 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.
 *
206
 * @param avctx   the AVCodecContext of the encoder
207 208 209 210
 * @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.
211
 *                avpkt->size is set to the specified size.
212 213
 *                All other AVPacket fields will be reset with av_init_packet().
 * @param size    the minimum required packet size
214 215 216 217 218 219 220 221
 * @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
222
 *                speed slightly.
223
 * @return        non negative on success, negative error code on failure
224
 */
225
int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
226

227
attribute_deprecated int ff_alloc_packet(AVPacket *avpkt, int size);
228

229 230 231 232 233 234
/**
 * Rescale from sample rate to AVCodecContext.time_base.
 */
static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
                                                        int64_t samples)
{
235 236
    if(samples == AV_NOPTS_VALUE)
        return AV_NOPTS_VALUE;
237 238 239 240
    return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
                        avctx->time_base);
}

241 242 243 244 245
/**
 * Get a buffer for a frame. This is a wrapper around
 * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
 * directly.
 */
246 247 248 249 250 251 252
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);
253

254 255
int ff_thread_can_start_frame(AVCodecContext *avctx);

256 257
int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx);

258 259 260 261 262 263 264
/**
 * 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);

265 266 267
/**
 * Finalize buf into extradata and set its size appropriately.
 */
268
int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf);
269

270
const uint8_t *avpriv_find_start_code(const uint8_t *p,
271
                                      const uint8_t *end,
272
                                      uint32_t *state);
273

274 275 276 277 278 279
/**
 * 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);

280 281 282 283 284 285
/**
 * Check that the provided sample aspect ratio is valid and set it on the codec
 * context.
 */
int ff_set_sar(AVCodecContext *avctx, AVRational sar);

286 287 288 289 290 291
/**
 * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
 */
int ff_side_data_update_matrix_encoding(AVFrame *frame,
                                        enum AVMatrixEncoding matrix_encoding);

292 293 294 295 296 297 298
/**
 * 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);

299 300 301 302
/**
 * Set various frame properties from the codec context / packet data.
 */
int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
303

304 305
int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type);

306
#endif /* AVCODEC_INTERNAL_H */