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