git.sesse.net Git - ffmpeg/blob - libavcodec/internal.h

   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
  51 #ifdef DEBUG
  52 #   define ff_dlog(ctx, ...) av_log(ctx, AV_LOG_DEBUG, __VA_ARGS__)
  53 #else
  54 #   define ff_dlog(ctx, ...) do { if (0) av_log(ctx, AV_LOG_DEBUG, __VA_ARGS__); } while (0)
  55 #endif
  56
  57 #ifdef TRACE
  58 #   define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
  59 #else
  60 #   define ff_tlog(ctx, ...) while(0)
  61 #endif
  62
  63
  64 #if !FF_API_QUANT_BIAS
  65 #define FF_DEFAULT_QUANT_BIAS 999999
  66 #endif
  67
  68 #define FF_SANE_NB_CHANNELS 64U
  69
  70 #define FF_SIGNBIT(x) ((x) >> CHAR_BIT * sizeof(x) - 1)
  71
  72 #if HAVE_AVX
  73 #   define STRIDE_ALIGN 32
  74 #elif HAVE_SIMD_ALIGN_16
  75 #   define STRIDE_ALIGN 16
  76 #else
  77 #   define STRIDE_ALIGN 8
  78 #endif
  79
  80 typedef struct FramePool {
  81     /**
  82      * Pools for each data plane. For audio all the planes have the same size,
  83      * so only pools[0] is used.
  84      */
  85     AVBufferPool *pools[4];
  86
  87     /*
  88      * Pool parameters
  89      */
  90     int format;
  91     int width, height;
  92     int stride_align[AV_NUM_DATA_POINTERS];
  93     int linesize[4];
  94     int planes;
  95     int channels;
  96     int samples;
  97 } FramePool;
  98
  99 typedef struct AVCodecInternal {
 100     /**
 101      * Whether the parent AVCodecContext is a copy of the context which had
 102      * init() called on it.
 103      * This is used by multithreading - shared tables and picture pointers
 104      * should be freed from the original context only.
 105      */
 106     int is_copy;
 107
 108     /**
 109      * Whether to allocate progress for frame threading.
 110      *
 111      * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
 112      * then progress will be allocated in ff_thread_get_buffer(). The frames
 113      * then MUST be freed with ff_thread_release_buffer().
 114      *
 115      * If the codec does not need to call the progress functions (there are no
 116      * dependencies between the frames), it should leave this at 0. Then it can
 117      * decode straight to the user-provided frames (which the user will then
 118      * free with av_frame_unref()), there is no need to call
 119      * ff_thread_release_buffer().
 120      */
 121     int allocate_progress;
 122
 123 #if FF_API_OLD_ENCODE_AUDIO
 124     /**
 125      * Internal sample count used by avcodec_encode_audio() to fabricate pts.
 126      * Can be removed along with avcodec_encode_audio().
 127      */
 128     int64_t sample_count;
 129 #endif
 130
 131     /**
 132      * An audio frame with less than required samples has been submitted and
 133      * padded with silence. Reject all subsequent frames.
 134      */
 135     int last_audio_frame;
 136
 137     AVFrame *to_free;
 138
 139     FramePool *pool;
 140
 141     void *thread_ctx;
 142
 143     /**
 144      * Current packet as passed into the decoder, to avoid having to pass the
 145      * packet into every function.
 146      */
 147     AVPacket *pkt;
 148
 149     /**
 150      * temporary buffer used for encoders to store their bitstream
 151      */
 152     uint8_t *byte_buffer;
 153     unsigned int byte_buffer_size;
 154
 155     void *frame_thread_encoder;
 156
 157     /**
 158      * Number of audio samples to skip at the start of the next decoded frame
 159      */
 160     int skip_samples;
 161
 162     /**
 163      * hwaccel-specific private data
 164      */
 165     void *hwaccel_priv_data;
 166 } AVCodecInternal;
 167
 168 struct AVCodecDefault {
 169     const uint8_t *key;
 170     const uint8_t *value;
 171 };
 172
 173 extern const uint8_t ff_log2_run[41];
 174
 175 /**
 176  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
 177  * If there is no such matching pair then size is returned.
 178  */
 179 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
 180
 181 unsigned int avpriv_toupper4(unsigned int x);
 182
 183 /**
 184  * does needed setup of pkt_pts/pos and such for (re)get_buffer();
 185  */
 186 int ff_init_buffer_info(AVCodecContext *s, AVFrame *frame);
 187
 188
 189 void avpriv_color_frame(AVFrame *frame, const int color[4]);
 190
 191 extern volatile int ff_avcodec_locked;
 192 int ff_lock_avcodec(AVCodecContext *log_ctx, const AVCodec *codec);
 193 int ff_unlock_avcodec(void);
 194
 195 int avpriv_lock_avformat(void);
 196 int avpriv_unlock_avformat(void);
 197
 198 /**
 199  * Maximum size in bytes of extradata.
 200  * This value was chosen such that every bit of the buffer is
 201  * addressable by a 32-bit signed integer as used by get_bits.
 202  */
 203 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
 204
 205 /**
 206  * Check AVPacket size and/or allocate data.
 207  *
 208  * Encoders supporting AVCodec.encode2() can use this as a convenience to
 209  * ensure the output packet data is large enough, whether provided by the user
 210  * or allocated in this function.
 211  *
 212  * @param avctx   the AVCodecContext of the encoder
 213  * @param avpkt   the AVPacket
 214  *                If avpkt->data is already set, avpkt->size is checked
 215  *                to ensure it is large enough.
 216  *                If avpkt->data is NULL, a new buffer is allocated.
 217  *                avpkt->size is set to the specified size.
 218  *                All other AVPacket fields will be reset with av_init_packet().
 219  * @param size    the minimum required packet size
 220  * @param min_size This is a hint to the allocation algorithm, which indicates
 221  *                to what minimal size the caller might later shrink the packet
 222  *                to. Encoders often allocate packets which are larger than the
 223  *                amount of data that is written into them as the exact amount is
 224  *                not known at the time of allocation. min_size represents the
 225  *                size a packet might be shrunk to by the caller. Can be set to
 226  *                0. setting this roughly correctly allows the allocation code
 227  *                to choose between several allocation strategies to improve
 228  *                speed slightly.
 229  * @return        non negative on success, negative error code on failure
 230  */
 231 int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size);
 232
 233 attribute_deprecated int ff_alloc_packet(AVPacket *avpkt, int size);
 234
 235 /**
 236  * Rescale from sample rate to AVCodecContext.time_base.
 237  */
 238 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
 239                                                         int64_t samples)
 240 {
 241     if(samples == AV_NOPTS_VALUE)
 242         return AV_NOPTS_VALUE;
 243     return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
 244                         avctx->time_base);
 245 }
 246
 247 /**
 248  * Get a buffer for a frame. This is a wrapper around
 249  * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
 250  * directly.
 251  */
 252 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
 253
 254 /**
 255  * Identical in function to av_frame_make_writable(), except it uses
 256  * ff_get_buffer() to allocate the buffer when needed.
 257  */
 258 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
 259
 260 int ff_thread_can_start_frame(AVCodecContext *avctx);
 261
 262 int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx);
 263
 264 /**
 265  * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
 266  * calling the function and then restoring again. Assumes the mutex is
 267  * already locked
 268  */
 269 int ff_codec_open2_recursive(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
 270
 271 /**
 272  * Finalize buf into extradata and set its size appropriately.
 273  */
 274 int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf);
 275
 276 const uint8_t *avpriv_find_start_code(const uint8_t *p,
 277                                       const uint8_t *end,
 278                                       uint32_t *state);
 279
 280 /**
 281  * Check that the provided frame dimensions are valid and set them on the codec
 282  * context.
 283  */
 284 int ff_set_dimensions(AVCodecContext *s, int width, int height);
 285
 286 /**
 287  * Check that the provided sample aspect ratio is valid and set it on the codec
 288  * context.
 289  */
 290 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
 291
 292 /**
 293  * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
 294  */
 295 int ff_side_data_update_matrix_encoding(AVFrame *frame,
 296                                         enum AVMatrixEncoding matrix_encoding);
 297
 298 /**
 299  * Select the (possibly hardware accelerated) pixel format.
 300  * This is a wrapper around AVCodecContext.get_format() and should be used
 301  * instead of calling get_format() directly.
 302  */
 303 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
 304
 305 /**
 306  * Set various frame properties from the codec context / packet data.
 307  */
 308 int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
 309
 310 int ff_side_data_set_encoder_stats(AVPacket *pkt, int quality, int64_t *error, int error_count, int pict_type);
 311
 312 #endif /* AVCODEC_INTERNAL_H */