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