2 * This file is part of FFmpeg.
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.
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.
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
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"
36 #define FF_SANE_NB_CHANNELS 63U
38 #if HAVE_NEON || ARCH_PPC || HAVE_MMX
39 # define STRIDE_ALIGN 16
41 # define STRIDE_ALIGN 8
44 typedef struct FramePool {
46 * Pools for each data plane. For audio all the planes have the same size,
47 * so only pools[0] is used.
49 AVBufferPool *pools[4];
56 int stride_align[AV_NUM_DATA_POINTERS];
63 typedef struct AVCodecInternal {
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.
73 * Whether to allocate progress for frame threading.
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().
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().
85 int allocate_progress;
87 #if FF_API_OLD_ENCODE_AUDIO
89 * Internal sample count used by avcodec_encode_audio() to fabricate pts.
90 * Can be removed along with avcodec_encode_audio().
96 * An audio frame with less than required samples has been submitted and
97 * padded with silence. Reject all subsequent frames.
108 * Current packet as passed into the decoder, to avoid having to pass the
109 * packet into every function.
114 * temporary buffer used for encoders to store their bitstream
116 uint8_t *byte_buffer;
117 unsigned int byte_buffer_size;
119 void *frame_thread_encoder;
122 * Number of audio samples to skip at the start of the next decoded frame
127 struct AVCodecDefault {
129 const uint8_t *value;
132 extern const uint8_t ff_log2_run[41];
135 * Return the hardware accelerated codec for codec codec_id and
136 * pixel format pix_fmt.
138 * @param avctx The codec context containing the codec_id and pixel format.
139 * @return the hardware accelerated codec, or NULL if none was found.
141 AVHWAccel *ff_find_hwaccel(AVCodecContext *avctx);
144 * Return the index into tab at which {a,b} match elements {[0],[1]} of tab.
145 * If there is no such matching pair then size is returned.
147 int ff_match_2uint16(const uint16_t (*tab)[2], int size, int a, int b);
149 unsigned int avpriv_toupper4(unsigned int x);
152 * does needed setup of pkt_pts/pos and such for (re)get_buffer();
154 int ff_init_buffer_info(AVCodecContext *s, AVFrame *frame);
157 void avpriv_color_frame(AVFrame *frame, const int color[4]);
159 extern volatile int ff_avcodec_locked;
160 int ff_lock_avcodec(AVCodecContext *log_ctx);
161 int ff_unlock_avcodec(void);
163 int avpriv_lock_avformat(void);
164 int avpriv_unlock_avformat(void);
167 * Maximum size in bytes of extradata.
168 * This value was chosen such that every bit of the buffer is
169 * addressable by a 32-bit signed integer as used by get_bits.
171 #define FF_MAX_EXTRADATA_SIZE ((1 << 28) - FF_INPUT_BUFFER_PADDING_SIZE)
174 * Check AVPacket size and/or allocate data.
176 * Encoders supporting AVCodec.encode2() can use this as a convenience to
177 * ensure the output packet data is large enough, whether provided by the user
178 * or allocated in this function.
180 * @param avctx the AVCodecContext of the encoder
181 * @param avpkt the AVPacket
182 * If avpkt->data is already set, avpkt->size is checked
183 * to ensure it is large enough.
184 * If avpkt->data is NULL, a new buffer is allocated.
185 * avpkt->size is set to the specified size.
186 * All other AVPacket fields will be reset with av_init_packet().
187 * @param size the minimum required packet size
188 * @return 0 on success, negative error code on failure
190 int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size);
192 int ff_alloc_packet(AVPacket *avpkt, int size);
195 * Rescale from sample rate to AVCodecContext.time_base.
197 static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx,
200 if(samples == AV_NOPTS_VALUE)
201 return AV_NOPTS_VALUE;
202 return av_rescale_q(samples, (AVRational){ 1, avctx->sample_rate },
207 * Get a buffer for a frame. This is a wrapper around
208 * AVCodecContext.get_buffer() and should be used instead calling get_buffer()
211 int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags);
214 * Identical in function to av_frame_make_writable(), except it uses
215 * ff_get_buffer() to allocate the buffer when needed.
217 int ff_reget_buffer(AVCodecContext *avctx, AVFrame *frame);
219 int ff_thread_can_start_frame(AVCodecContext *avctx);
221 int avpriv_h264_has_num_reorder_frames(AVCodecContext *avctx);
224 * Call avcodec_open2 recursively by decrementing counter, unlocking mutex,
225 * calling the function and then restoring again. Assumes the mutex is
228 int ff_codec_open2_recursive(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
231 * Call avcodec_close recursively, counterpart to avcodec_open2_recursive.
233 int ff_codec_close_recursive(AVCodecContext *avctx);
236 * Finalize buf into extradata and set its size appropriately.
238 int avpriv_bprint_to_extradata(AVCodecContext *avctx, struct AVBPrint *buf);
240 const uint8_t *avpriv_find_start_code(const uint8_t *p,
245 * Check that the provided frame dimensions are valid and set them on the codec
248 int ff_set_dimensions(AVCodecContext *s, int width, int height);
251 * Add or update AV_FRAME_DATA_MATRIXENCODING side data.
253 int ff_side_data_update_matrix_encoding(AVFrame *frame,
254 enum AVMatrixEncoding matrix_encoding);
257 * Set various frame properties from the codec context / packet data.
259 int ff_decode_frame_props(AVCodecContext *avctx, AVFrame *frame);
261 #endif /* AVCODEC_INTERNAL_H */