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