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