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