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