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/mathematics.h"
  30 #include "libavutil/pixfmt.h"
  31 #include "avcodec.h"
  32
  33 #define FF_SANE_NB_CHANNELS 128U
  34
  35 typedef struct InternalBuffer {
  36     uint8_t *base[AV_NUM_DATA_POINTERS];
  37     uint8_t *data[AV_NUM_DATA_POINTERS];
  38     int linesize[AV_NUM_DATA_POINTERS];
  39     int width;
  40     int height;
  41     enum AVPixelFormat pix_fmt;
  42 } InternalBuffer;
  43
  44 typedef struct AVCodecInternal {
  45     /**
  46      * internal buffer count
  47      * used by default get/release/reget_buffer().
  48      */
  49     int buffer_count;
  50
  51     /**
  52      * internal buffers
  53      * used by default get/release/reget_buffer().
  54      */
  55     InternalBuffer *buffer;
  56
  57     /**
  58      * Whether the parent AVCodecContext is a copy of the context which had
  59      * init() called on it.
  60      * This is used by multithreading - shared tables and picture pointers
  61      * should be freed from the original context only.
  62      */
  63     int is_copy;
  64
  65 #if FF_API_OLD_DECODE_AUDIO
  66     /**
  67      * Internal sample count used by avcodec_encode_audio() to fabricate pts.
  68      * Can be removed along with avcodec_encode_audio().
  69      */
  70     int sample_count;
  71 #endif
  72
  73     /**
  74      * An audio frame with less than required samples has been submitted and
  75      * padded with silence. Reject all subsequent frames.
  76      */
  77     int last_audio_frame;
  78
  79     /**
  80      * The data for the last allocated audio frame.
  81      * Stored here so we can free it.
  82      */
  83     uint8_t *audio_data;
  84 } AVCodecInternal;
  85
  86 struct AVCodecDefault {
  87     const uint8_t *key;
  88     const uint8_t *value;
  89 };
  90
  91 /**
  92  * Return the hardware accelerated codec for codec codec_id and
  93  * pixel format pix_fmt.
  94  *
  95  * @param codec_id the codec to match
  96  * @param pix_fmt the pixel format to match
  97  * @return the hardware accelerated codec, or NULL if none was found.
  98  */
  99 AVHWAccel *ff_find_hwaccel(enum AVCodecID codec_id, enum AVPixelFormat pix_fmt);
 100
 101 /**
 102  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
 103  * If there is no such matching pair then size is returned.
 104  */
 105 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
 106
 107 unsigned int avpriv_toupper4(unsigned int x);
 108
 109 int avpriv_lock_avformat(void);
 110 int avpriv_unlock_avformat(void);
 111
 112 /**
 113  * Maximum size in bytes of extradata.
 114  * This value was chosen such that every bit of the buffer is
 115  * addressable by a 32-bit signed integer as used by get_bits.
 116  */
 117 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - FF_INPUT_BUFFER_PADDING_SIZE)
 118
 119 /**
 120  * Check AVPacket size and/or allocate data.
 121  *
 122  * Encoders supporting AVCodec.encode2() can use this as a convenience to
 123  * ensure the output packet data is large enough, whether provided by the user
 124  * or allocated in this function.
 125  *
 126  * @param avpkt   the AVPacket
 127  *                If avpkt->data is already set, avpkt->size is checked
 128  *                to ensure it is large enough.
 129  *                If avpkt->data is NULL, a new buffer is allocated.
 130  *                avpkt->size is set to the specified size.
 131  *                All other AVPacket fields will be reset with av_init_packet().
 132  * @param size    the minimum required packet size
 133  * @return        0 on success, negative error code on failure
 134  */
 135 int ff_alloc_packet(AVPacket *avpkt, int size);
 136
 137 /**
 138  * Rescale from sample rate to AVCodecContext.time_base.
 139  */
 140 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
 141                                                         int64_t samples)
 142 {
 143     return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
 144                         avctx->time_base);
 145 }
 146
 147 /**
 148  * Get a buffer for a frame. This is a wrapper around
 149  * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
 150  * directly.
 151  */
 152 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame);
 153
 154 #endif /* AVCODEC_INTERNAL_H */