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