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