Merge commit '8ac0f6767bf63d3e6b308ee6648ff02598b81e03'
[ffmpeg.git] / 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/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
82     /**
83      * temporary buffer used for encoders to store their bitstream
84      */
85     uint8_t *byte_buffer;
86     unsigned int byte_buffer_size;
87
88     void *frame_thread_encoder;
89
90     /**
91      * Number of audio samples to skip at the start of the next decoded frame
92      */
93     int skip_samples;
94 } AVCodecInternal;
95
96 struct AVCodecDefault {
97     const uint8_t *key;
98     const uint8_t *value;
99 };
100
101 /**
102  * Determine whether pix_fmt is a hardware accelerated format.
103  */
104 int ff_is_hwaccel_pix_fmt(enum AVPixelFormat pix_fmt);
105
106 /**
107  * Return the hardware accelerated codec for codec codec_id and
108  * pixel format pix_fmt.
109  *
110  * @param codec_id the codec to match
111  * @param pix_fmt the pixel format to match
112  * @return the hardware accelerated codec, or NULL if none was found.
113  */
114 AVHWAccel *ff_find_hwaccel(enum AVCodecID codec_id, enum AVPixelFormat pix_fmt);
115
116 /**
117  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
118  * If there is no such matching pair then size is returned.
119  */
120 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
121
122 unsigned int avpriv_toupper4(unsigned int x);
123
124 /**
125  * does needed setup of pkt_pts/pos and such for (re)get_buffer();
126  */
127 void ff_init_buffer_info(AVCodecContext *s, AVFrame *frame);
128
129 /**
130  * Remove and free all side data from packet.
131  */
132 void ff_packet_free_side_data(AVPacket *pkt);
133
134 int avpriv_lock_avformat(void);
135 int avpriv_unlock_avformat(void);
136
137 /**
138  * Maximum size in bytes of extradata.
139  * This value was chosen such that every bit of the buffer is
140  * addressable by a 32-bit signed integer as used by get_bits.
141  */
142 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - FF_INPUT_BUFFER_PADDING_SIZE)
143
144 /**
145  * Check AVPacket size and/or allocate data.
146  *
147  * Encoders supporting AVCodec.encode2() can use this as a convenience to
148  * ensure the output packet data is large enough, whether provided by the user
149  * or allocated in this function.
150  *
151  * @param avctx   the AVCodecContext of the encoder
152  * @param avpkt   the AVPacket
153  *                If avpkt->data is already set, avpkt->size is checked
154  *                to ensure it is large enough.
155  *                If avpkt->data is NULL, a new buffer is allocated.
156  *                avpkt->size is set to the specified size.
157  *                All other AVPacket fields will be reset with av_init_packet().
158  * @param size    the minimum required packet size
159  * @return        0 on success, negative error code on failure
160  */
161 int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int size);
162
163 int ff_alloc_packet(AVPacket *avpkt, int size);
164
165 /**
166  * Rescale from sample rate to AVCodecContext.time_base.
167  */
168 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
169                                                         int64_t samples)
170 {
171     if(samples == AV_NOPTS_VALUE)
172         return AV_NOPTS_VALUE;
173     return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
174                         avctx->time_base);
175 }
176
177 int ff_thread_can_start_frame(AVCodecContext *avctx);
178
179 int ff_get_logical_cpus(AVCodecContext *avctx);
180
181 int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx);
182
183 /**
184  * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
185  * calling the function and then restoring again. Assumes the mutex is
186  * already locked
187  */
188 int ff_codec_open2_recursive(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
189
190 /**
191  * Call avcodec_close recursively, counterpart to avcodec_open2_recursive.
192  */
193 int ff_codec_close_recursive(AVCodecContext *avctx);
194
195 #endif /* AVCODEC_INTERNAL_H */