634400f384fd5dd528bb61295b37d4db2c1b793b
[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
51 #ifdef DEBUG
52 #   define ff_dlog(ctx, ...) av_log(ctx, AV_LOG_DEBUG, __VA_ARGS__)
53 #else
54 #   define ff_dlog(ctx, ...) while(0)
55 #endif
56
57 #ifdef TRACE
58 #   define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
59 #else
60 #   define ff_tlog(ctx, ...) while(0)
61 #endif
62
63
64 #define FF_SANE_NB_CHANNELS 63U
65
66 #define FF_SIGNBIT(x) (x >> CHAR_BIT * sizeof(x) - 1)
67
68 typedef struct FramePool {
69     /**
70      * Pools for each data plane. For audio all the planes have the same size,
71      * so only pools[0] is used.
72      */
73     AVBufferPool *pools[4];
74
75     /*
76      * Pool parameters
77      */
78     int format;
79     int width, height;
80     int stride_align[AV_NUM_DATA_POINTERS];
81     int linesize[4];
82     int planes;
83     int channels;
84     int samples;
85 } FramePool;
86
87 typedef struct AVCodecInternal {
88     /**
89      * Whether the parent AVCodecContext is a copy of the context which had
90      * init() called on it.
91      * This is used by multithreading - shared tables and picture pointers
92      * should be freed from the original context only.
93      */
94     int is_copy;
95
96     /**
97      * Whether to allocate progress for frame threading.
98      *
99      * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
100      * then progress will be allocated in ff_thread_get_buffer(). The frames
101      * then MUST be freed with ff_thread_release_buffer().
102      *
103      * If the codec does not need to call the progress functions (there are no
104      * dependencies between the frames), it should leave this at 0. Then it can
105      * decode straight to the user-provided frames (which the user will then
106      * free with av_frame_unref()), there is no need to call
107      * ff_thread_release_buffer().
108      */
109     int allocate_progress;
110
111     /**
112      * An audio frame with less than required samples has been submitted and
113      * padded with silence. Reject all subsequent frames.
114      */
115     int last_audio_frame;
116
117     AVFrame *to_free;
118
119     FramePool *pool;
120
121     void *thread_ctx;
122
123     /**
124      * Current packet as passed into the decoder, to avoid having to pass the
125      * packet into every function.
126      */
127     AVPacket *pkt;
128
129     /**
130      * hwaccel-specific private data
131      */
132     void *hwaccel_priv_data;
133 } AVCodecInternal;
134
135 struct AVCodecDefault {
136     const uint8_t *key;
137     const uint8_t *value;
138 };
139
140 /**
141  * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
142  * If there is no such matching pair then size is returned.
143  */
144 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
145
146 unsigned int avpriv_toupper4(unsigned int x);
147
148 int avpriv_lock_avformat(void);
149 int avpriv_unlock_avformat(void);
150
151 /**
152  * Maximum size in bytes of extradata.
153  * This value was chosen such that every bit of the buffer is
154  * addressable by a 32-bit signed integer as used by get_bits.
155  */
156 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - FF_INPUT_BUFFER_PADDING_SIZE)
157
158 /**
159  * Check AVPacket size and/or allocate data.
160  *
161  * Encoders supporting AVCodec.encode2() can use this as a convenience to
162  * ensure the output packet data is large enough, whether provided by the user
163  * or allocated in this function.
164  *
165  * @param avpkt   the AVPacket
166  *                If avpkt->data is already set, avpkt->size is checked
167  *                to ensure it is large enough.
168  *                If avpkt->data is NULL, a new buffer is allocated.
169  *                avpkt->size is set to the specified size.
170  *                All other AVPacket fields will be reset with av_init_packet().
171  * @param size    the minimum required packet size
172  * @return        0 on success, negative error code on failure
173  */
174 int ff_alloc_packet(AVPacket *avpkt, int size);
175
176 /**
177  * Rescale from sample rate to AVCodecContext.time_base.
178  */
179 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
180                                                         int64_t samples)
181 {
182     return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
183                         avctx->time_base);
184 }
185
186 /**
187  * Get a buffer for a frame. This is a wrapper around
188  * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
189  * directly.
190  */
191 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
192
193 /**
194  * Identical in function to av_frame_make_writable(), except it uses
195  * ff_get_buffer() to allocate the buffer when needed.
196  */
197 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
198
199 const uint8_t *avpriv_find_start_code(const uint8_t *restrict p,
200                                       const uint8_t *end,
201                                       uint32_t *restrict state);
202
203 /**
204  * Check that the provided frame dimensions are valid and set them on the codec
205  * context.
206  */
207 int ff_set_dimensions(AVCodecContext *s, int width, int height);
208
209 /**
210  * Check that the provided sample aspect ratio is valid and set it on the codec
211  * context.
212  */
213 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
214
215 /**
216  * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
217  */
218 int ff_side_data_update_matrix_encoding(AVFrame *frame,
219                                         enum AVMatrixEncoding matrix_encoding);
220
221 /**
222  * Select the (possibly hardware accelerated) pixel format.
223  * This is a wrapper around AVCodecContext.get_format() and should be used
224  * instead of calling get_format() directly.
225  */
226 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
227
228 /**
229  * Set various frame properties from the codec context / packet data.
230  */
231 int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
232
233 #endif /* AVCODEC_INTERNAL_H */