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