bedb2ed85d03b85c35b9e84ab92e74b6312fa483
[ffmpeg.git] / 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 typedef struct InternalBuffer {
34     uint8_t *base[AV_NUM_DATA_POINTERS];
35     uint8_t *data[AV_NUM_DATA_POINTERS];
36     int linesize[AV_NUM_DATA_POINTERS];
37     int width;
38     int height;
39     enum PixelFormat pix_fmt;
40     uint8_t **extended_data;
41     int audio_data_size;
42     int nb_channels;
43 } InternalBuffer;
44
45 typedef struct AVCodecInternal {
46     /**
47      * internal buffer count
48      * used by default get/release/reget_buffer().
49      */
50     int buffer_count;
51
52     /**
53      * internal buffers
54      * used by default get/release/reget_buffer().
55      */
56     InternalBuffer *buffer;
57
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 #if FF_API_OLD_DECODE_AUDIO
67     /**
68      * Internal sample count used by avcodec_encode_audio() to fabricate pts.
69      * Can be removed along with avcodec_encode_audio().
70      */
71     int sample_count;
72 #endif
73 } AVCodecInternal;
74
75 struct AVCodecDefault {
76     const uint8_t *key;
77     const uint8_t *value;
78 };
79
80 /**
81  * Determine whether pix_fmt is a hardware accelerated format.
82  */
83 int ff_is_hwaccel_pix_fmt(enum PixelFormat pix_fmt);
84
85 /**
86  * Return the hardware accelerated codec for codec codec_id and
87  * pixel format pix_fmt.
88  *
89  * @param codec_id the codec to match
90  * @param pix_fmt the pixel format to match
91  * @return the hardware accelerated codec, or NULL if none was found.
92  */
93 AVHWAccel *ff_find_hwaccel(enum CodecID codec_id, enum PixelFormat pix_fmt);
94
95 /**
96  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
97  * If there is no such matching pair then size is returned.
98  */
99 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
100
101 unsigned int avpriv_toupper4(unsigned int x);
102
103 int avpriv_lock_avformat(void);
104 int avpriv_unlock_avformat(void);
105
106 /**
107  * Maximum size in bytes of extradata.
108  * This value was chosen such that every bit of the buffer is
109  * addressable by a 32-bit signed integer as used by get_bits.
110  */
111 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - FF_INPUT_BUFFER_PADDING_SIZE)
112
113 /**
114  * Check AVPacket size and/or allocate data.
115  *
116  * Encoders supporting AVCodec.encode2() can use this as a convenience to
117  * ensure the output packet data is large enough, whether provided by the user
118  * or allocated in this function.
119  *
120  * @param avpkt   the AVPacket
121  *                If avpkt->data is already set, avpkt->size is checked
122  *                to ensure it is large enough.
123  *                If avpkt->data is NULL, a new buffer is allocated.
124  *                avpkt->size is set to the specified size.
125  *                All other AVPacket fields will be reset with av_init_packet().
126  * @param size    the minimum required packet size
127  * @return        0 on success, negative error code on failure
128  */
129 int ff_alloc_packet(AVPacket *avpkt, int size);
130
131 /**
132  * Rescale from sample rate to AVCodecContext.time_base.
133  */
134 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
135                                                         int64_t samples)
136 {
137     return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
138                         avctx->time_base);
139 }
140
141 #endif /* AVCODEC_INTERNAL_H */