2 * This file is part of Libav.
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.
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.
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
21 * common internal api header.
24 #ifndef AVCODEC_INTERNAL_H
25 #define AVCODEC_INTERNAL_H
29 #include "libavutil/buffer.h"
30 #include "libavutil/channel_layout.h"
31 #include "libavutil/mathematics.h"
32 #include "libavutil/pixfmt.h"
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.
40 #define FF_CODEC_CAP_INIT_THREADSAFE (1 << 0)
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
48 #define FF_CODEC_CAP_INIT_CLEANUP (1 << 1)
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.
55 #define FF_CODEC_CAP_SETS_PKT_DTS (1 << 2)
58 # define ff_dlog(ctx, ...) av_log(ctx, AV_LOG_DEBUG, __VA_ARGS__)
60 # define ff_dlog(ctx, ...) while(0)
64 # define ff_tlog(ctx, ...) av_log(ctx, AV_LOG_TRACE, __VA_ARGS__)
66 # define ff_tlog(ctx, ...) while(0)
70 #if !FF_API_QUANT_BIAS
71 #define FF_DEFAULT_QUANT_BIAS 999999
74 #define FF_SANE_NB_CHANNELS 63U
76 #define FF_SIGNBIT(x) (x >> CHAR_BIT * sizeof(x) - 1)
78 typedef struct FramePool {
80 * Pools for each data plane. For audio all the planes have the same size,
81 * so only pools[0] is used.
83 AVBufferPool *pools[4];
90 int stride_align[AV_NUM_DATA_POINTERS];
97 typedef struct AVCodecInternal {
99 * Whether the parent AVCodecContext is a copy of the context which had
100 * init() called on it.
101 * This is used by multithreading - shared tables and picture pointers
102 * should be freed from the original context only.
107 * Whether to allocate progress for frame threading.
109 * The codec must set it to 1 if it uses ff_thread_await/report_progress(),
110 * then progress will be allocated in ff_thread_get_buffer(). The frames
111 * then MUST be freed with ff_thread_release_buffer().
113 * If the codec does not need to call the progress functions (there are no
114 * dependencies between the frames), it should leave this at 0. Then it can
115 * decode straight to the user-provided frames (which the user will then
116 * free with av_frame_unref()), there is no need to call
117 * ff_thread_release_buffer().
119 int allocate_progress;
122 * An audio frame with less than required samples has been submitted and
123 * padded with silence. Reject all subsequent frames.
125 int last_audio_frame;
134 * Current packet as passed into the decoder, to avoid having to pass the
135 * packet into every function.
140 * hwaccel-specific private data
142 void *hwaccel_priv_data;
145 struct AVCodecDefault {
147 const uint8_t *value;
151 * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
152 * If there is no such matching pair then size is returned.
154 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
156 unsigned int avpriv_toupper4(unsigned int x);
158 int avpriv_lock_avformat(void);
159 int avpriv_unlock_avformat(void);
162 * Maximum size in bytes of extradata.
163 * This value was chosen such that every bit of the buffer is
164 * addressable by a 32-bit signed integer as used by get_bits.
166 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - AV_INPUT_BUFFER_PADDING_SIZE)
169 * Check AVPacket size and/or allocate data.
171 * Encoders supporting AVCodec.encode2() can use this as a convenience to
172 * ensure the output packet data is large enough, whether provided by the user
173 * or allocated in this function.
175 * @param avpkt the AVPacket
176 * If avpkt->data is already set, avpkt->size is checked
177 * to ensure it is large enough.
178 * If avpkt->data is NULL, a new buffer is allocated.
179 * avpkt->size is set to the specified size.
180 * All other AVPacket fields will be reset with av_init_packet().
181 * @param size the minimum required packet size
182 * @return 0 on success, negative error code on failure
184 int ff_alloc_packet(AVPacket *avpkt, int size);
187 * Rescale from sample rate to AVCodecContext.time_base.
189 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
192 return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
197 * Get a buffer for a frame. This is a wrapper around
198 * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
201 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
204 * Identical in function to av_frame_make_writable(), except it uses
205 * ff_get_buffer() to allocate the buffer when needed.
207 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
209 const uint8_t *avpriv_find_start_code(const uint8_t *restrict p,
211 uint32_t *restrict state);
214 * Check that the provided frame dimensions are valid and set them on the codec
217 int ff_set_dimensions(AVCodecContext *s, int width, int height);
220 * Check that the provided sample aspect ratio is valid and set it on the codec
223 int ff_set_sar(AVCodecContext *avctx, AVRational sar);
226 * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
228 int ff_side_data_update_matrix_encoding(AVFrame *frame,
229 enum AVMatrixEncoding matrix_encoding);
232 * Select the (possibly hardware accelerated) pixel format.
233 * This is a wrapper around AVCodecContext.get_format() and should be used
234 * instead of calling get_format() directly.
236 int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);
239 * Set various frame properties from the codec context / packet data.
241 int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
243 #endif /* AVCODEC_INTERNAL_H */