git.sesse.net Git - ffmpeg/blob - libavcodec/internal.h

   1 /*
   2  * This file is part of Libav.
   3  *
   4  * Libav 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  * Libav 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 Libav; 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 DEBUG
  52 #   define ff_dlog(ctx, ...) av_log(ctx, AV_LOG_DEBUG, __VA_ARGS__)
  53 #else
  54 #   define ff_dlog(ctx, ...) while(0)
  55 #endif
  56
  57 #ifdef TRACE
  58 #   define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
  59 #else
  60 #   define ff_tlog(ctx, ...) while(0)
  61 #endif
  62
  63
  64 #if !FF_API_QUANT_BIAS
  65 #define FF_DEFAULT_QUANT_BIAS 999999
  66 #endif
  67
  68 #define FF_SANE_NB_CHANNELS 63U
  69
  70 #define FF_SIGNBIT(x) (x >> CHAR_BIT * sizeof(x) - 1)
  71
  72 typedef struct FramePool {
  73     /**
  74      * Pools for each data plane. For audio all the planes have the same size,
  75      * so only pools[0] is used.
  76      */
  77     AVBufferPool *pools[4];
  78
  79     /*
  80      * Pool parameters
  81      */
  82     int format;
  83     int width, height;
  84     int stride_align[AV_NUM_DATA_POINTERS];
  85     int linesize[4];
  86     int planes;
  87     int channels;
  88     int samples;
  89 } FramePool;
  90
  91 typedef struct AVCodecInternal {
  92     /**
  93      * Whether the parent AVCodecContext is a copy of the context which had
  94      * init() called on it.
  95      * This is used by multithreading - shared tables and picture pointers
  96      * should be freed from the original context only.
  97      */
  98     int is_copy;
  99
 100     /**
 101      * Whether to allocate progress for frame threading.
 102      *
 103      * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
 104      * then progress will be allocated in ff_thread_get_buffer(). The frames
 105      * then MUST be freed with ff_thread_release_buffer().
 106      *
 107      * If the codec does not need to call the progress functions (there are no
 108      * dependencies between the frames), it should leave this at 0. Then it can
 109      * decode straight to the user-provided frames (which the user will then
 110      * free with av_frame_unref()), there is no need to call
 111      * ff_thread_release_buffer().
 112      */
 113     int allocate_progress;
 114
 115     /**
 116      * An audio frame with less than required samples has been submitted and
 117      * padded with silence. Reject all subsequent frames.
 118      */
 119     int last_audio_frame;
 120
 121     AVFrame *to_free;
 122
 123     FramePool *pool;
 124
 125     void *thread_ctx;
 126
 127     /**
 128      * Current packet as passed into the decoder, to avoid having to pass the
 129      * packet into every function.
 130      */
 131     AVPacket *pkt;
 132
 133     /**
 134      * hwaccel-specific private data
 135      */
 136     void *hwaccel_priv_data;
 137 } AVCodecInternal;
 138
 139 struct AVCodecDefault {
 140     const uint8_t *key;
 141     const uint8_t *value;
 142 };
 143
 144 /**
 145  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
 146  * If there is no such matching pair then size is returned.
 147  */
 148 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
 149
 150 unsigned int avpriv_toupper4(unsigned int x);
 151
 152 int avpriv_lock_avformat(void);
 153 int avpriv_unlock_avformat(void);
 154
 155 /**
 156  * Maximum size in bytes of extradata.
 157  * This value was chosen such that every bit of the buffer is
 158  * addressable by a 32-bit signed integer as used by get_bits.
 159  */
 160 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - FF_INPUT_BUFFER_PADDING_SIZE)
 161
 162 /**
 163  * Check AVPacket size and/or allocate data.
 164  *
 165  * Encoders supporting AVCodec.encode2() can use this as a convenience to
 166  * ensure the output packet data is large enough, whether provided by the user
 167  * or allocated in this function.
 168  *
 169  * @param avpkt   the AVPacket
 170  *                If avpkt->data is already set, avpkt->size is checked
 171  *                to ensure it is large enough.
 172  *                If avpkt->data is NULL, a new buffer is allocated.
 173  *                avpkt->size is set to the specified size.
 174  *                All other AVPacket fields will be reset with av_init_packet().
 175  * @param size    the minimum required packet size
 176  * @return        0 on success, negative error code on failure
 177  */
 178 int ff_alloc_packet(AVPacket *avpkt, int size);
 179
 180 /**
 181  * Rescale from sample rate to AVCodecContext.time_base.
 182  */
 183 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
 184                                                         int64_t samples)
 185 {
 186     return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
 187                         avctx->time_base);
 188 }
 189
 190 /**
 191  * Get a buffer for a frame. This is a wrapper around
 192  * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
 193  * directly.
 194  */
 195 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
 196
 197 /**
 198  * Identical in function to av_frame_make_writable(), except it uses
 199  * ff_get_buffer() to allocate the buffer when needed.
 200  */
 201 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
 202
 203 const uint8_t *avpriv_find_start_code(const uint8_t *restrict p,
 204                                       const uint8_t *end,
 205                                       uint32_t *restrict state);
 206
 207 /**
 208  * Check that the provided frame dimensions are valid and set them on the codec
 209  * context.
 210  */
 211 int ff_set_dimensions(AVCodecContext *s, int width, int height);
 212
 213 /**
 214  * Check that the provided sample aspect ratio is valid and set it on the codec
 215  * context.
 216  */
 217 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
 218
 219 /**
 220  * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
 221  */
 222 int ff_side_data_update_matrix_encoding(AVFrame *frame,
 223                                         enum AVMatrixEncoding matrix_encoding);
 224
 225 /**
 226  * Select the (possibly hardware accelerated) pixel format.
 227  * This is a wrapper around AVCodecContext.get_format() and should be used
 228  * instead of calling get_format() directly.
 229  */
 230 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
 231
 232 /**
 233  * Set various frame properties from the codec context / packet data.
 234  */
 235 int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
 236
 237 #endif /* AVCODEC_INTERNAL_H */