403fb4a090bcc35f9d9ab643ed53c453cc2f850b
[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/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 /**
37  * The codec does not modify any global variables in the init function,
38  * allowing to call the init function without locking any global mutexes.
39  */
40 #define FF_CODEC_CAP_INIT_THREADSAFE        (1 << 0)
41 /**
42  * The codec allows calling the close function for deallocation even if
43  * the init function returned a failure. Without this capability flag, a
44  * codec does such cleanup internally when returning failures from the
45  * init function and does not expect the close function to be called at
46  * all.
47  */
48 #define FF_CODEC_CAP_INIT_CLEANUP           (1 << 1)
49 /**
50  * Decoders marked with FF_CODEC_CAP_SETS_PKT_DTS want to set
51  * AVFrame.pkt_dts manually. If the flag is set, utils.c won't overwrite
52  * this field. If it's unset, utils.c tries to guess the pkt_dts field
53  * from the input AVPacket.
54  */
55 #define FF_CODEC_CAP_SETS_PKT_DTS           (1 << 2)
56 /**
57  * The decoder sets the cropping fields in the output frames manually.
58  * If this cap is set, the generic code will initialize output frame
59  * dimensions to coded rather than display values.
60  */
61 #define FF_CODEC_CAP_EXPORTS_CROPPING       (1 << 3)
62
63 #ifdef DEBUG
64 #   define ff_dlog(ctx, ...) av_log(ctx, AV_LOG_DEBUG, __VA_ARGS__)
65 #else
66 #   define ff_dlog(ctx, ...) do { } while (0)
67 #endif
68
69 #ifdef TRACE
70 #   define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
71 #else
72 #   define ff_tlog(ctx, ...) do { } while (0)
73 #endif
74
75
76 #define FF_DEFAULT_QUANT_BIAS 999999
77
78 #define FF_SANE_NB_CHANNELS 63U
79
80 #define FF_SIGNBIT(x) (x >> CHAR_BIT * sizeof(x) - 1)
81
82 typedef struct FramePool {
83     /**
84      * Pools for each data plane. For audio all the planes have the same size,
85      * so only pools[0] is used.
86      */
87     AVBufferPool *pools[4];
88
89     /*
90      * Pool parameters
91      */
92     int format;
93     int width, height;
94     int stride_align[AV_NUM_DATA_POINTERS];
95     int linesize[4];
96     int planes;
97     int channels;
98     int samples;
99 } FramePool;
100
101 typedef struct DecodeSimpleContext {
102     AVPacket *in_pkt;
103     AVFrame  *out_frame;
104 } DecodeSimpleContext;
105
106 typedef struct DecodeFilterContext {
107     AVBSFContext **bsfs;
108     int         nb_bsfs;
109 } DecodeFilterContext;
110
111 typedef struct AVCodecInternal {
112     /**
113      * Whether the parent AVCodecContext is a copy of the context which had
114      * init() called on it.
115      * This is used by multithreading - shared tables and picture pointers
116      * should be freed from the original context only.
117      */
118     int is_copy;
119
120     /**
121      * Whether to allocate progress for frame threading.
122      *
123      * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
124      * then progress will be allocated in ff_thread_get_buffer(). The frames
125      * then MUST be freed with ff_thread_release_buffer().
126      *
127      * If the codec does not need to call the progress functions (there are no
128      * dependencies between the frames), it should leave this at 0. Then it can
129      * decode straight to the user-provided frames (which the user will then
130      * free with av_frame_unref()), there is no need to call
131      * ff_thread_release_buffer().
132      */
133     int allocate_progress;
134
135     /**
136      * An audio frame with less than required samples has been submitted and
137      * padded with silence. Reject all subsequent frames.
138      */
139     int last_audio_frame;
140
141     AVFrame *to_free;
142
143     FramePool *pool;
144
145     void *thread_ctx;
146
147     DecodeSimpleContext ds;
148     DecodeFilterContext filter;
149
150     /**
151      * Properties (timestamps+side data) extracted from the last packet passed
152      * for decoding.
153      */
154     AVPacket *last_pkt_props;
155
156     /**
157      * hwaccel-specific private data
158      */
159     void *hwaccel_priv_data;
160
161     /**
162      * checks API usage: after codec draining, flush is required to resume operation
163      */
164     int draining;
165
166     /**
167      * buffers for using new encode/decode API through legacy API
168      */
169     AVPacket *buffer_pkt;
170     int buffer_pkt_valid; // encoding: packet without data can be valid
171     AVFrame *buffer_frame;
172     int draining_done;
173     /* set to 1 when the caller is using the old decoding API */
174     int compat_decode;
175     int compat_decode_warned;
176     /* this variable is set by the decoder internals to signal to the old
177      * API compat wrappers the amount of data consumed from the last packet */
178     size_t compat_decode_consumed;
179     /* when a partial packet has been consumed, this stores the remaining size
180      * of the packet (that should be submitted in the next decode call */
181     size_t compat_decode_partial_size;
182     AVFrame *compat_decode_frame;
183 } AVCodecInternal;
184
185 struct AVCodecDefault {
186     const uint8_t *key;
187     const uint8_t *value;
188 };
189
190 /**
191  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
192  * If there is no such matching pair then size is returned.
193  */
194 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
195
196 unsigned int avpriv_toupper4(unsigned int x);
197
198 int avpriv_lock_avformat(void);
199 int avpriv_unlock_avformat(void);
200
201 /**
202  * Maximum size in bytes of extradata.
203  * This value was chosen such that every bit of the buffer is
204  * addressable by a 32-bit signed integer as used by get_bits.
205  */
206 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
207
208 /**
209  * Check AVPacket size and/or allocate data.
210  *
211  * Encoders supporting AVCodec.encode2() can use this as a convenience to
212  * ensure the output packet data is large enough, whether provided by the user
213  * or allocated in this function.
214  *
215  * @param avpkt   the AVPacket
216  *                If avpkt->data is already set, avpkt->size is checked
217  *                to ensure it is large enough.
218  *                If avpkt->data is NULL, a new buffer is allocated.
219  *                avpkt->size is set to the specified size.
220  *                All other AVPacket fields will be reset with av_init_packet().
221  * @param size    the minimum required packet size
222  * @return        0 on success, negative error code on failure
223  */
224 int ff_alloc_packet(AVPacket *avpkt, int size);
225
226 /**
227  * Rescale from sample rate to AVCodecContext.time_base.
228  */
229 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
230                                                         int64_t samples)
231 {
232     return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
233                         avctx->time_base);
234 }
235
236 /**
237  * Get a buffer for a frame. This is a wrapper around
238  * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
239  * directly.
240  */
241 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
242
243 /**
244  * Identical in function to av_frame_make_writable(), except it uses
245  * ff_get_buffer() to allocate the buffer when needed.
246  */
247 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
248
249 const uint8_t *avpriv_find_start_code(const uint8_t *restrict p,
250                                       const uint8_t *end,
251                                       uint32_t *restrict state);
252
253 /**
254  * Check that the provided frame dimensions are valid and set them on the codec
255  * context.
256  */
257 int ff_set_dimensions(AVCodecContext *s, int width, int height);
258
259 /**
260  * Check that the provided sample aspect ratio is valid and set it on the codec
261  * context.
262  */
263 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
264
265 /**
266  * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
267  */
268 int ff_side_data_update_matrix_encoding(AVFrame *frame,
269                                         enum AVMatrixEncoding matrix_encoding);
270
271 /**
272  * Select the (possibly hardware accelerated) pixel format.
273  * This is a wrapper around AVCodecContext.get_format() and should be used
274  * instead of calling get_format() directly.
275  */
276 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
277
278 /**
279  * Set various frame properties from the codec context / packet data.
280  */
281 int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
282
283 /**
284  * Add a CPB properties side data to an encoding context.
285  */
286 AVCPBProperties *ff_add_cpb_side_data(AVCodecContext *avctx);
287
288 #endif /* AVCODEC_INTERNAL_H */