lavc: Add flag to allow profile mismatch with hardware decoding
[libav.git] / libavcodec / avcodec.h
CommitLineData
04d7f601
DB
1/*
2 * copyright (c) 2001 Fabrice Bellard
3 *
2912e87a 4 * This file is part of Libav.
b78e7197 5 *
2912e87a 6 * Libav is free software; you can redistribute it and/or
04d7f601
DB
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
b78e7197 9 * version 2.1 of the License, or (at your option) any later version.
04d7f601 10 *
2912e87a 11 * Libav is distributed in the hope that it will be useful,
04d7f601
DB
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
2912e87a 17 * License along with Libav; if not, write to the Free Software
e5a389a1 18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
04d7f601
DB
19 */
20
98790382
SS
21#ifndef AVCODEC_AVCODEC_H
22#define AVCODEC_AVCODEC_H
a96b68b7 23
36df8805 24/**
ba87f080 25 * @file
f0cebf51
AK
26 * @ingroup libavc
27 * Libavcodec external API header
36df8805
MN
28 */
29
c60208e7 30#include <errno.h>
737eb597 31#include "libavutil/samplefmt.h"
bf4b0ed1 32#include "libavutil/attributes.h"
76a448ed 33#include "libavutil/avutil.h"
1afddbe5 34#include "libavutil/buffer.h"
7160bb71 35#include "libavutil/cpu.h"
0b950fe2 36#include "libavutil/dict.h"
7ecc2d40 37#include "libavutil/frame.h"
abc78a5a 38#include "libavutil/log.h"
d49ea4af 39#include "libavutil/pixfmt.h"
e91709ca 40#include "libavutil/rational.h"
de6d9b64 41
a0b901a3
DB
42#include "version.h"
43
e97e5a2e
LB
44/**
45 * @defgroup libavc Encoding/Decoding Library
46 * @{
47 *
48 * @defgroup lavc_decoding Decoding
49 * @{
50 * @}
51 *
52 * @defgroup lavc_encoding Encoding
53 * @{
54 * @}
55 *
56 * @defgroup lavc_codec Codecs
57 * @{
58 * @defgroup lavc_codec_native Native Codecs
59 * @{
60 * @}
61 * @defgroup lavc_codec_wrappers External library wrappers
62 * @{
63 * @}
64 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
65 * @{
66 * @}
67 * @}
68 * @defgroup lavc_internal Internal
69 * @{
70 * @}
71 * @}
e97e5a2e
LB
72 */
73
294b3a50 74/**
05f66706 75 * @ingroup libavc
76 * @defgroup lavc_encdec send/receive encoding and decoding API overview
77 * @{
78 *
79 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
80 * avcodec_receive_packet() functions provide an encode/decode API, which
81 * decouples input and output.
82 *
83 * The API is very similar for encoding/decoding and audio/video, and works as
84 * follows:
85 * - Set up and open the AVCodecContext as usual.
86 * - Send valid input:
87 * - For decoding, call avcodec_send_packet() to give the decoder raw
88 * compressed data in an AVPacket.
89 * - For encoding, call avcodec_send_frame() to give the decoder an AVFrame
90 * containing uncompressed audio or video.
91 * In both cases, it is recommended that AVPackets and AVFrames are
92 * refcounted, or libavcodec might have to copy the input data. (libavformat
93 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
94 * refcounted AVFrames.)
95 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
96 * functions and process their output:
97 * - For decoding, call avcodec_receive_frame(). On success, it will return
98 * an AVFrame containing uncompressed audio or video data.
99 * - For encoding, call avcodec_receive_packet(). On success, it will return
100 * an AVPacket with a compressed frame.
101 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
102 * AVERROR(EAGAIN) return value means that new input data is required to
103 * return new output. In this case, continue with sending input. For each
104 * input frame/packet, the codec will typically return 1 output frame/packet,
105 * but it can also be 0 or more than 1.
106 *
107 * At the beginning of decoding or encoding, the codec might accept multiple
108 * input frames/packets without returning a frame, until its internal buffers
109 * are filled. This situation is handled transparently if you follow the steps
110 * outlined above.
111 *
8a60bba0 112 * In theory, sending input can result in EAGAIN - this should happen only if
113 * not all output was received. You can use this to structure alternative decode
114 * or encode loops other than the one suggested above. For example, you could
115 * try sending new input on each iteration, and try to receive output if that
116 * returns EAGAIN.
117 *
05f66706 118 * End of stream situations. These require "flushing" (aka draining) the codec,
119 * as the codec might buffer multiple frames or packets internally for
120 * performance or out of necessity (consider B-frames).
121 * This is handled as follows:
122 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
123 * or avcodec_send_frame() (encoding) functions. This will enter draining
124 * mode.
125 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
126 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
127 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
128 * - Before decoding can be resumed again, the codec has to be reset with
129 * avcodec_flush_buffers().
130 *
131 * Using the API as outlined above is highly recommended. But it is also
132 * possible to call functions outside of this rigid schema. For example, you can
133 * call avcodec_send_packet() repeatedly without calling
134 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
135 * until the codec's internal buffer has been filled up (which is typically of
136 * size 1 per output frame, after initial input), and then reject input with
137 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
138 * read at least some output.
139 *
140 * Not all codecs will follow a rigid and predictable dataflow; the only
141 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
142 * one end implies that a receive/send call on the other end will succeed. In
143 * general, no codec will permit unlimited buffering of input or output.
144 *
145 * This API replaces the following legacy functions:
146 * - avcodec_decode_video2() and avcodec_decode_audio4():
147 * Use avcodec_send_packet() to feed input to the decoder, then use
148 * avcodec_receive_frame() to receive decoded frames after each packet.
149 * Unlike with the old video decoding API, multiple frames might result from
150 * a packet. For audio, splitting the input packet into frames by partially
151 * decoding packets becomes transparent to the API user. You never need to
8a60bba0 152 * feed an AVPacket to the API twice (unless it is rejected with EAGAIN - then
153 * no data was read from the packet).
05f66706 154 * Additionally, sending a flush/draining packet is required only once.
155 * - avcodec_encode_video2()/avcodec_encode_audio2():
156 * Use avcodec_send_frame() to feed input to the encoder, then use
157 * avcodec_receive_packet() to receive encoded packets.
158 * Providing user-allocated buffers for avcodec_receive_packet() is not
159 * possible.
160 * - The new API does not handle subtitles yet.
161 *
162 * Mixing new and old function calls on the same AVCodecContext is not allowed,
163 * and will result in arbitrary behavior.
164 *
165 * Some codecs might require using the new API; using the old API will return
8a60bba0 166 * an error when calling it. All codecs support the new API.
167 *
168 * A codec is not allowed to return EAGAIN for both sending and receiving. This
169 * would be an invalid state, which could put the codec user into an endless
170 * loop. The API has no concept of time either: it cannot happen that trying to
171 * do avcodec_send_packet() results in EAGAIN, but a repeated call 1 second
172 * later accepts the packet (with no other receive/flush API calls involved).
173 * The API is a strict state machine, and the passage of time is not supposed
174 * to influence it. Some timing-dependent behavior might still be deemed
175 * acceptable in certain cases. But it must never result in both send/receive
176 * returning EAGAIN at the same time at any point. It must also absolutely be
177 * avoided that the current state is "unstable" and can "flip-flop" between
178 * the send/receive APIs allowing progress. For example, it's not allowed that
179 * the codec randomly decides that it actually wants to consume a packet now
180 * instead of returning a frame, after it just returned EAGAIN on an
181 * avcodec_send_packet() call.
05f66706 182 * @}
183 */
184
185/**
294b3a50
AK
186 * @defgroup lavc_core Core functions/structures.
187 * @ingroup libavc
188 *
189 * Basic definitions, functions for querying libavcodec capabilities,
190 * allocating core structures, etc.
191 * @{
192 */
eda7c983 193
104e10fb 194
7ebf5927 195/**
48966b02 196 * Identify the syntax and semantics of the bitstream.
6b0cdb6e
NG
197 * The principle is roughly:
198 * Two decoders with the same ID can decode the same streams.
199 * Two encoders with the same ID can encode compatible streams.
200 * There may be slight deviations from the principle due to implementation
201 * details.
7ebf5927 202 *
f5bccd85
DB
203 * If you add a codec ID to this list, add it so that
204 * 1. no value of a existing codec ID changes (that would break ABI),
205 * 2. it is as close as possible to similar codecs.
bbabeb56
AK
206 *
207 * After adding new codec IDs, do not forget to add an entry to the codec
208 * descriptor list and bump libavcodec minor version.
7ebf5927 209 */
104e10fb
AK
210enum AVCodecID {
211 AV_CODEC_ID_NONE,
ba0dabbf
DB
212
213 /* video codecs */
104e10fb
AK
214 AV_CODEC_ID_MPEG1VIDEO,
215 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
104e10fb
AK
216 AV_CODEC_ID_H261,
217 AV_CODEC_ID_H263,
218 AV_CODEC_ID_RV10,
219 AV_CODEC_ID_RV20,
220 AV_CODEC_ID_MJPEG,
221 AV_CODEC_ID_MJPEGB,
222 AV_CODEC_ID_LJPEG,
223 AV_CODEC_ID_SP5X,
224 AV_CODEC_ID_JPEGLS,
225 AV_CODEC_ID_MPEG4,
226 AV_CODEC_ID_RAWVIDEO,
227 AV_CODEC_ID_MSMPEG4V1,
228 AV_CODEC_ID_MSMPEG4V2,
229 AV_CODEC_ID_MSMPEG4V3,
230 AV_CODEC_ID_WMV1,
231 AV_CODEC_ID_WMV2,
232 AV_CODEC_ID_H263P,
233 AV_CODEC_ID_H263I,
234 AV_CODEC_ID_FLV1,
235 AV_CODEC_ID_SVQ1,
236 AV_CODEC_ID_SVQ3,
237 AV_CODEC_ID_DVVIDEO,
238 AV_CODEC_ID_HUFFYUV,
239 AV_CODEC_ID_CYUV,
240 AV_CODEC_ID_H264,
241 AV_CODEC_ID_INDEO3,
242 AV_CODEC_ID_VP3,
243 AV_CODEC_ID_THEORA,
244 AV_CODEC_ID_ASV1,
245 AV_CODEC_ID_ASV2,
246 AV_CODEC_ID_FFV1,
247 AV_CODEC_ID_4XM,
248 AV_CODEC_ID_VCR1,
249 AV_CODEC_ID_CLJR,
250 AV_CODEC_ID_MDEC,
251 AV_CODEC_ID_ROQ,
252 AV_CODEC_ID_INTERPLAY_VIDEO,
253 AV_CODEC_ID_XAN_WC3,
254 AV_CODEC_ID_XAN_WC4,
255 AV_CODEC_ID_RPZA,
256 AV_CODEC_ID_CINEPAK,
257 AV_CODEC_ID_WS_VQA,
258 AV_CODEC_ID_MSRLE,
259 AV_CODEC_ID_MSVIDEO1,
260 AV_CODEC_ID_IDCIN,
261 AV_CODEC_ID_8BPS,
262 AV_CODEC_ID_SMC,
263 AV_CODEC_ID_FLIC,
264 AV_CODEC_ID_TRUEMOTION1,
265 AV_CODEC_ID_VMDVIDEO,
266 AV_CODEC_ID_MSZH,
267 AV_CODEC_ID_ZLIB,
268 AV_CODEC_ID_QTRLE,
104e10fb
AK
269 AV_CODEC_ID_TSCC,
270 AV_CODEC_ID_ULTI,
271 AV_CODEC_ID_QDRAW,
272 AV_CODEC_ID_VIXL,
273 AV_CODEC_ID_QPEG,
274 AV_CODEC_ID_PNG,
275 AV_CODEC_ID_PPM,
276 AV_CODEC_ID_PBM,
277 AV_CODEC_ID_PGM,
278 AV_CODEC_ID_PGMYUV,
279 AV_CODEC_ID_PAM,
280 AV_CODEC_ID_FFVHUFF,
281 AV_CODEC_ID_RV30,
282 AV_CODEC_ID_RV40,
283 AV_CODEC_ID_VC1,
284 AV_CODEC_ID_WMV3,
285 AV_CODEC_ID_LOCO,
286 AV_CODEC_ID_WNV1,
287 AV_CODEC_ID_AASC,
288 AV_CODEC_ID_INDEO2,
289 AV_CODEC_ID_FRAPS,
290 AV_CODEC_ID_TRUEMOTION2,
291 AV_CODEC_ID_BMP,
292 AV_CODEC_ID_CSCD,
293 AV_CODEC_ID_MMVIDEO,
294 AV_CODEC_ID_ZMBV,
295 AV_CODEC_ID_AVS,
296 AV_CODEC_ID_SMACKVIDEO,
297 AV_CODEC_ID_NUV,
298 AV_CODEC_ID_KMVC,
299 AV_CODEC_ID_FLASHSV,
300 AV_CODEC_ID_CAVS,
301 AV_CODEC_ID_JPEG2000,
302 AV_CODEC_ID_VMNC,
303 AV_CODEC_ID_VP5,
304 AV_CODEC_ID_VP6,
305 AV_CODEC_ID_VP6F,
306 AV_CODEC_ID_TARGA,
307 AV_CODEC_ID_DSICINVIDEO,
308 AV_CODEC_ID_TIERTEXSEQVIDEO,
309 AV_CODEC_ID_TIFF,
310 AV_CODEC_ID_GIF,
311 AV_CODEC_ID_DXA,
312 AV_CODEC_ID_DNXHD,
313 AV_CODEC_ID_THP,
314 AV_CODEC_ID_SGI,
315 AV_CODEC_ID_C93,
316 AV_CODEC_ID_BETHSOFTVID,
317 AV_CODEC_ID_PTX,
318 AV_CODEC_ID_TXD,
319 AV_CODEC_ID_VP6A,
320 AV_CODEC_ID_AMV,
321 AV_CODEC_ID_VB,
322 AV_CODEC_ID_PCX,
323 AV_CODEC_ID_SUNRAST,
324 AV_CODEC_ID_INDEO4,
325 AV_CODEC_ID_INDEO5,
326 AV_CODEC_ID_MIMIC,
327 AV_CODEC_ID_RL2,
328 AV_CODEC_ID_ESCAPE124,
329 AV_CODEC_ID_DIRAC,
330 AV_CODEC_ID_BFI,
331 AV_CODEC_ID_CMV,
332 AV_CODEC_ID_MOTIONPIXELS,
333 AV_CODEC_ID_TGV,
334 AV_CODEC_ID_TGQ,
335 AV_CODEC_ID_TQI,
336 AV_CODEC_ID_AURA,
337 AV_CODEC_ID_AURA2,
338 AV_CODEC_ID_V210X,
339 AV_CODEC_ID_TMV,
340 AV_CODEC_ID_V210,
341 AV_CODEC_ID_DPX,
342 AV_CODEC_ID_MAD,
343 AV_CODEC_ID_FRWU,
344 AV_CODEC_ID_FLASHSV2,
345 AV_CODEC_ID_CDGRAPHICS,
346 AV_CODEC_ID_R210,
347 AV_CODEC_ID_ANM,
348 AV_CODEC_ID_BINKVIDEO,
349 AV_CODEC_ID_IFF_ILBM,
350 AV_CODEC_ID_IFF_BYTERUN1,
351 AV_CODEC_ID_KGV1,
352 AV_CODEC_ID_YOP,
353 AV_CODEC_ID_VP8,
354 AV_CODEC_ID_PICTOR,
355 AV_CODEC_ID_ANSI,
356 AV_CODEC_ID_A64_MULTI,
357 AV_CODEC_ID_A64_MULTI5,
358 AV_CODEC_ID_R10K,
359 AV_CODEC_ID_MXPEG,
360 AV_CODEC_ID_LAGARITH,
361 AV_CODEC_ID_PRORES,
362 AV_CODEC_ID_JV,
363 AV_CODEC_ID_DFA,
364 AV_CODEC_ID_WMV3IMAGE,
365 AV_CODEC_ID_VC1IMAGE,
366 AV_CODEC_ID_UTVIDEO,
367 AV_CODEC_ID_BMV_VIDEO,
368 AV_CODEC_ID_VBLE,
369 AV_CODEC_ID_DXTORY,
370 AV_CODEC_ID_V410,
371 AV_CODEC_ID_XWD,
372 AV_CODEC_ID_CDXL,
373 AV_CODEC_ID_XBM,
374 AV_CODEC_ID_ZEROCODEC,
375 AV_CODEC_ID_MSS1,
376 AV_CODEC_ID_MSA1,
377 AV_CODEC_ID_TSCC2,
378 AV_CODEC_ID_MTS2,
379 AV_CODEC_ID_CLLC,
ee769c6a 380 AV_CODEC_ID_MSS2,
66aabd76 381 AV_CODEC_ID_VP9,
1232a164 382 AV_CODEC_ID_AIC,
350914fc 383 AV_CODEC_ID_ESCAPE130,
2d66a58c 384 AV_CODEC_ID_G2M,
c4bfa098 385 AV_CODEC_ID_WEBP,
9af7a852 386 AV_CODEC_ID_HNM4_VIDEO,
064698d3 387 AV_CODEC_ID_HEVC,
cde7df25 388 AV_CODEC_ID_FIC,
e50f5d3c 389 AV_CODEC_ID_ALIAS_PIX,
ae17878f 390 AV_CODEC_ID_BRENDER_PIX,
70daeacd 391 AV_CODEC_ID_PAF_VIDEO,
38389058 392 AV_CODEC_ID_EXR,
ac4b32df 393 AV_CODEC_ID_VP7,
a420ccd4 394 AV_CODEC_ID_SANM,
07761294 395 AV_CODEC_ID_SGIRLE,
86a04326
PR
396 AV_CODEC_ID_MVC1,
397 AV_CODEC_ID_MVC2,
35c6ce76 398 AV_CODEC_ID_HQX,
247e370e 399 AV_CODEC_ID_TDSC,
22526c1f 400 AV_CODEC_ID_HQ_HQA,
7ca3e520 401 AV_CODEC_ID_HAP,
5c018ee1 402 AV_CODEC_ID_DDS,
c45fcf30 403 AV_CODEC_ID_DXV,
9a3202a9 404 AV_CODEC_ID_SCREENPRESSO,
533a6198 405 AV_CODEC_ID_RSCC,
d78fd2fa 406 AV_CODEC_ID_MAGICYUV,
470cd0c5 407 AV_CODEC_ID_TRUEMOTION2RT,
d42809f9 408 AV_CODEC_ID_AV1,
aba5b948 409 AV_CODEC_ID_PIXLET,
5f794aa1 410 AV_CODEC_ID_CFHD,
95a8a03a 411 AV_CODEC_ID_FMVC,
189157c3 412 AV_CODEC_ID_CLEARVIDEO,
40c5ee99 413
f5bccd85 414 /* various PCM "codecs" */
104e10fb
AK
415 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
416 AV_CODEC_ID_PCM_S16LE = 0x10000,
417 AV_CODEC_ID_PCM_S16BE,
418 AV_CODEC_ID_PCM_U16LE,
419 AV_CODEC_ID_PCM_U16BE,
420 AV_CODEC_ID_PCM_S8,
421 AV_CODEC_ID_PCM_U8,
422 AV_CODEC_ID_PCM_MULAW,
423 AV_CODEC_ID_PCM_ALAW,
424 AV_CODEC_ID_PCM_S32LE,
425 AV_CODEC_ID_PCM_S32BE,
426 AV_CODEC_ID_PCM_U32LE,
427 AV_CODEC_ID_PCM_U32BE,
428 AV_CODEC_ID_PCM_S24LE,
429 AV_CODEC_ID_PCM_S24BE,
430 AV_CODEC_ID_PCM_U24LE,
431 AV_CODEC_ID_PCM_U24BE,
432 AV_CODEC_ID_PCM_S24DAUD,
433 AV_CODEC_ID_PCM_ZORK,
434 AV_CODEC_ID_PCM_S16LE_PLANAR,
435 AV_CODEC_ID_PCM_DVD,
436 AV_CODEC_ID_PCM_F32BE,
437 AV_CODEC_ID_PCM_F32LE,
438 AV_CODEC_ID_PCM_F64BE,
439 AV_CODEC_ID_PCM_F64LE,
440 AV_CODEC_ID_PCM_BLURAY,
441 AV_CODEC_ID_PCM_LXF,
442 AV_CODEC_ID_S302M,
443 AV_CODEC_ID_PCM_S8_PLANAR,
7e52080c
PM
444 AV_CODEC_ID_PCM_S24LE_PLANAR,
445 AV_CODEC_ID_PCM_S32LE_PLANAR,
5a79bf02 446 AV_CODEC_ID_PCM_S16BE_PLANAR,
0147f198 447
f5bccd85 448 /* various ADPCM codecs */
104e10fb
AK
449 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
450 AV_CODEC_ID_ADPCM_IMA_WAV,
451 AV_CODEC_ID_ADPCM_IMA_DK3,
452 AV_CODEC_ID_ADPCM_IMA_DK4,
453 AV_CODEC_ID_ADPCM_IMA_WS,
454 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
455 AV_CODEC_ID_ADPCM_MS,
456 AV_CODEC_ID_ADPCM_4XM,
457 AV_CODEC_ID_ADPCM_XA,
458 AV_CODEC_ID_ADPCM_ADX,
459 AV_CODEC_ID_ADPCM_EA,
460 AV_CODEC_ID_ADPCM_G726,
461 AV_CODEC_ID_ADPCM_CT,
462 AV_CODEC_ID_ADPCM_SWF,
463 AV_CODEC_ID_ADPCM_YAMAHA,
464 AV_CODEC_ID_ADPCM_SBPRO_4,
465 AV_CODEC_ID_ADPCM_SBPRO_3,
466 AV_CODEC_ID_ADPCM_SBPRO_2,
467 AV_CODEC_ID_ADPCM_THP,
468 AV_CODEC_ID_ADPCM_IMA_AMV,
469 AV_CODEC_ID_ADPCM_EA_R1,
470 AV_CODEC_ID_ADPCM_EA_R3,
471 AV_CODEC_ID_ADPCM_EA_R2,
472 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
473 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
474 AV_CODEC_ID_ADPCM_EA_XAS,
475 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
476 AV_CODEC_ID_ADPCM_IMA_ISS,
477 AV_CODEC_ID_ADPCM_G722,
478 AV_CODEC_ID_ADPCM_IMA_APC,
6f273093 479 AV_CODEC_ID_ADPCM_VIMA,
891f64b3 480
17179d2d 481 /* AMR */
104e10fb
AK
482 AV_CODEC_ID_AMR_NB = 0x12000,
483 AV_CODEC_ID_AMR_WB,
d663a1fd 484
b8414bbd 485 /* RealAudio codecs*/
104e10fb
AK
486 AV_CODEC_ID_RA_144 = 0x13000,
487 AV_CODEC_ID_RA_288,
3ef8be2b
MM
488
489 /* various DPCM codecs */
104e10fb
AK
490 AV_CODEC_ID_ROQ_DPCM = 0x14000,
491 AV_CODEC_ID_INTERPLAY_DPCM,
492 AV_CODEC_ID_XAN_DPCM,
493 AV_CODEC_ID_SOL_DPCM,
115329f1 494
ba0dabbf 495 /* audio codecs */
104e10fb
AK
496 AV_CODEC_ID_MP2 = 0x15000,
497 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
498 AV_CODEC_ID_AAC,
499 AV_CODEC_ID_AC3,
500 AV_CODEC_ID_DTS,
501 AV_CODEC_ID_VORBIS,
502 AV_CODEC_ID_DVAUDIO,
503 AV_CODEC_ID_WMAV1,
504 AV_CODEC_ID_WMAV2,
505 AV_CODEC_ID_MACE3,
506 AV_CODEC_ID_MACE6,
507 AV_CODEC_ID_VMDAUDIO,
508 AV_CODEC_ID_FLAC,
509 AV_CODEC_ID_MP3ADU,
510 AV_CODEC_ID_MP3ON4,
511 AV_CODEC_ID_SHORTEN,
512 AV_CODEC_ID_ALAC,
513 AV_CODEC_ID_WESTWOOD_SND1,
514 AV_CODEC_ID_GSM, ///< as in Berlin toast format
515 AV_CODEC_ID_QDM2,
516 AV_CODEC_ID_COOK,
517 AV_CODEC_ID_TRUESPEECH,
518 AV_CODEC_ID_TTA,
519 AV_CODEC_ID_SMACKAUDIO,
520 AV_CODEC_ID_QCELP,
521 AV_CODEC_ID_WAVPACK,
522 AV_CODEC_ID_DSICINAUDIO,
523 AV_CODEC_ID_IMC,
524 AV_CODEC_ID_MUSEPACK7,
525 AV_CODEC_ID_MLP,
526 AV_CODEC_ID_GSM_MS, /* as found in WAV */
527 AV_CODEC_ID_ATRAC3,
104e10fb
AK
528 AV_CODEC_ID_APE,
529 AV_CODEC_ID_NELLYMOSER,
530 AV_CODEC_ID_MUSEPACK8,
531 AV_CODEC_ID_SPEEX,
532 AV_CODEC_ID_WMAVOICE,
533 AV_CODEC_ID_WMAPRO,
534 AV_CODEC_ID_WMALOSSLESS,
535 AV_CODEC_ID_ATRAC3P,
536 AV_CODEC_ID_EAC3,
537 AV_CODEC_ID_SIPR,
538 AV_CODEC_ID_MP1,
539 AV_CODEC_ID_TWINVQ,
540 AV_CODEC_ID_TRUEHD,
541 AV_CODEC_ID_MP4ALS,
542 AV_CODEC_ID_ATRAC1,
543 AV_CODEC_ID_BINKAUDIO_RDFT,
544 AV_CODEC_ID_BINKAUDIO_DCT,
545 AV_CODEC_ID_AAC_LATM,
546 AV_CODEC_ID_QDMC,
547 AV_CODEC_ID_CELT,
548 AV_CODEC_ID_G723_1,
549 AV_CODEC_ID_G729,
550 AV_CODEC_ID_8SVX_EXP,
551 AV_CODEC_ID_8SVX_FIB,
552 AV_CODEC_ID_BMV_AUDIO,
553 AV_CODEC_ID_RALF,
554 AV_CODEC_ID_IAC,
555 AV_CODEC_ID_ILBC,
2a3d82ab 556 AV_CODEC_ID_OPUS,
9b500b8f 557 AV_CODEC_ID_COMFORT_NOISE,
57231e4d 558 AV_CODEC_ID_TAK,
f544c586 559 AV_CODEC_ID_METASOUND,
70daeacd 560 AV_CODEC_ID_PAF_AUDIO,
e2834567 561 AV_CODEC_ID_ON2AVC,
c56b9b1e 562 AV_CODEC_ID_DSS_SP,
115329f1 563
240c1657 564 /* subtitle codecs */
104e10fb
AK
565 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
566 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
567 AV_CODEC_ID_DVB_SUBTITLE,
568 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
569 AV_CODEC_ID_XSUB,
570 AV_CODEC_ID_SSA,
571 AV_CODEC_ID_MOV_TEXT,
572 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
573 AV_CODEC_ID_DVB_TELETEXT,
574 AV_CODEC_ID_SRT,
115329f1 575
7ce68923 576 /* other specific kind of codecs (generally used for attachments) */
104e10fb
AK
577 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
578 AV_CODEC_ID_TTF = 0x18000,
f8d7c9d3 579
104e10fb 580 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
0bef08e5 581
104e10fb 582 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
f5bccd85 583 * stream (only used by libavformat) */
104e10fb 584 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
77b5c82b 585 * stream (only used by libavformat) */
104e10fb 586 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
00332e0a 587 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
de6d9b64 588};
dcedf586 589
c223d799
AK
590/**
591 * This struct describes the properties of a single codec described by an
592 * AVCodecID.
d07ddc93 593 * @see avcodec_descriptor_get()
c223d799
AK
594 */
595typedef struct AVCodecDescriptor {
596 enum AVCodecID id;
597 enum AVMediaType type;
598 /**
599 * Name of the codec described by this descriptor. It is non-empty and
600 * unique for each codec descriptor. It should contain alphanumeric
601 * characters and '_' only.
602 */
603 const char *name;
604 /**
605 * A more descriptive name for this codec. May be NULL.
606 */
607 const char *long_name;
51efed15
AK
608 /**
609 * Codec properties, a combination of AV_CODEC_PROP_* flags.
610 */
611 int props;
2c681139
AK
612 /**
613 * If non-NULL, an array of profiles recognized for this codec.
614 * Terminated with FF_PROFILE_UNKNOWN.
615 */
616 const struct AVProfile *profiles;
c223d799
AK
617} AVCodecDescriptor;
618
51efed15
AK
619/**
620 * Codec uses only intra compression.
621 * Video codecs only.
622 */
623#define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
a2318326
AK
624/**
625 * Codec supports lossy compression. Audio and video codecs only.
626 * @note a codec may support both lossy and lossless
627 * compression modes
628 */
629#define AV_CODEC_PROP_LOSSY (1 << 1)
630/**
631 * Codec supports lossless compression. Audio and video codecs only.
632 */
633#define AV_CODEC_PROP_LOSSLESS (1 << 2)
c5fca017
AK
634/**
635 * Codec supports frame reordering. That is, the coded order (the order in which
636 * the encoded packets are output by the encoders / stored / input to the
637 * decoders) may be different from the presentation order of the corresponding
638 * frames.
639 *
640 * For codecs that do not have this property set, PTS and DTS should always be
641 * equal.
642 */
643#define AV_CODEC_PROP_REORDER (1 << 3)
51efed15 644
d7425f59 645/**
c8ef8464 646 * @ingroup lavc_decoding
cf713bb8 647 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
171b7b91
AC
648 * This is mainly needed because some optimized bitstream readers read
649 * 32 or 64 bit at once and could read over the end.<br>
f5bccd85
DB
650 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
651 * MPEG bitstreams could cause overread and segfault.
d7425f59 652 */
059a9348 653#define AV_INPUT_BUFFER_PADDING_SIZE 8
d7425f59 654
0ecca7a4 655/**
f038515f 656 * @ingroup lavc_encoding
f5bccd85
DB
657 * minimum encoding buffer size
658 * Used to avoid some checks during header writing.
0ecca7a4 659 */
059a9348 660#define AV_INPUT_BUFFER_MIN_SIZE 16384
0ecca7a4 661
0e373b95 662/**
c8ef8464
AK
663 * @ingroup lavc_decoding
664 */
8c3eba7c 665enum AVDiscard{
f5bccd85
DB
666 /* We leave some space between them for extensions (drop some
667 * keyframes for intra-only or drop just some bidir frames). */
ccc2dfbc
LB
668 AVDISCARD_NONE =-16, ///< discard nothing
669 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
670 AVDISCARD_NONREF = 8, ///< discard all non reference
671 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
672 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
673 AVDISCARD_ALL = 48, ///< discard all
8c3eba7c
MN
674};
675
34b47d7c
JR
676enum AVAudioServiceType {
677 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
678 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
679 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
680 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
681 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
682 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
683 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
684 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
685 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
686 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
687};
688
f038515f
AK
689/**
690 * @ingroup lavc_encoding
691 */
ce980a95
MN
692typedef struct RcOverride{
693 int start_frame;
694 int end_frame;
f5bccd85 695 int qscale; // If this is 0 then quality_factor will be used instead.
ce980a95
MN
696 float quality_factor;
697} RcOverride;
698
a949d72e 699/* encoding support
f5bccd85
DB
700 These flags can be passed in AVCodecContext.flags before initialization.
701 Note: Not everything is supported yet.
a949d72e 702*/
de6d9b64 703
5e83d9ac
AK
704/**
705 * Allow decoders to produce frames with data planes that are not aligned
706 * to CPU requirements (e.g. due to cropping).
707 */
7c6eb0a1
VG
708#define AV_CODEC_FLAG_UNALIGNED (1 << 0)
709/**
710 * Use fixed qscale.
711 */
712#define AV_CODEC_FLAG_QSCALE (1 << 1)
713/**
714 * 4 MV per MB allowed / advanced prediction for H.263.
715 */
716#define AV_CODEC_FLAG_4MV (1 << 2)
717/**
718 * Output even those frames that might be corrupted.
719 */
720#define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
721/**
722 * Use qpel MC.
723 */
724#define AV_CODEC_FLAG_QPEL (1 << 4)
725/**
726 * Use internal 2pass ratecontrol in first pass mode.
727 */
728#define AV_CODEC_FLAG_PASS1 (1 << 9)
729/**
730 * Use internal 2pass ratecontrol in second pass mode.
731 */
732#define AV_CODEC_FLAG_PASS2 (1 << 10)
733/**
734 * loop filter.
735 */
736#define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
737/**
738 * Only decode/encode grayscale.
739 */
740#define AV_CODEC_FLAG_GRAY (1 << 13)
741/**
742 * error[?] variables will be set during encoding.
743 */
744#define AV_CODEC_FLAG_PSNR (1 << 15)
745/**
746 * Input bitstream might be truncated at a random location
747 * instead of only at frame boundaries.
748 */
749#define AV_CODEC_FLAG_TRUNCATED (1 << 16)
750/**
751 * Use interlaced DCT.
752 */
753#define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
754/**
755 * Force low delay.
756 */
757#define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
758/**
759 * Place global headers in extradata instead of every keyframe.
760 */
761#define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
762/**
763 * Use only bitexact stuff (except (I)DCT).
764 */
765#define AV_CODEC_FLAG_BITEXACT (1 << 23)
41ed7ab4 766/* Fx : Flag for H.263+ extra options */
7c6eb0a1
VG
767/**
768 * H.263 advanced intra coding / MPEG-4 AC prediction
769 */
770#define AV_CODEC_FLAG_AC_PRED (1 << 24)
771/**
772 * interlaced motion estimation
773 */
774#define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
79f5347a
AK
775#define AV_CODEC_FLAG_CLOSED_GOP (1 << 31)
776
7c6eb0a1
VG
777/**
778 * Allow non spec compliant speedup tricks.
779 */
7c6eb0a1
VG
780#define AV_CODEC_FLAG2_FAST (1 << 0)
781/**
782 * Skip bitstream encoding.
783 */
784#define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
785/**
786 * Place global headers at every keyframe instead of in extradata.
787 */
788#define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
789/**
790 * Input bitstream might be truncated at a packet boundaries
791 * instead of only at frame boundaries.
792 */
793#define AV_CODEC_FLAG2_CHUNKS (1 << 15)
794/**
795 * Discard cropping information from SPS.
796 */
797#define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
798
def97856
VG
799/* Unsupported options :
800 * Syntax Arithmetic coding (SAC)
801 * Reference Picture Selection
802 * Independent Segment Decoding */
803/* /Fx */
804/* codec capabilities */
805
806/**
807 * Decoder can use draw_horiz_band callback.
808 */
809#define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
810/**
811 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
812 * If not set, it might not use get_buffer() at all or use operations that
813 * assume the buffer was allocated by avcodec_default_get_buffer.
814 */
815#define AV_CODEC_CAP_DR1 (1 << 1)
816#define AV_CODEC_CAP_TRUNCATED (1 << 3)
817/**
818 * Encoder or decoder requires flushing with NULL input at the end in order to
819 * give the complete and correct output.
820 *
821 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
822 * with NULL data. The user can still send NULL data to the public encode
823 * or decode function, but libavcodec will not pass it along to the codec
824 * unless this flag is set.
825 *
826 * Decoders:
827 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
828 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
829 * returns frames.
830 *
831 * Encoders:
832 * The encoder needs to be fed with NULL data at the end of encoding until the
833 * encoder no longer returns data.
834 *
835 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
836 * flag also means that the encoder must set the pts and duration for
837 * each output packet. If this flag is not set, the pts and duration will
838 * be determined by libavcodec from the input frame.
839 */
840#define AV_CODEC_CAP_DELAY (1 << 5)
841/**
842 * Codec can be fed a final frame with a smaller size.
843 * This can be used to prevent truncation of the last audio samples.
844 */
845#define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
846/**
847 * Codec can output multiple frames per AVPacket
848 * Normally demuxers return one frame at a time, demuxers which do not do
849 * are connected to a parser to split what they return into proper frames.
850 * This flag is reserved to the very rare category of codecs which have a
851 * bitstream that cannot be split into frames without timeconsuming
41ed7ab4 852 * operations like full decoding. Demuxers carrying such bitstreams thus
def97856
VG
853 * may return multiple frames in a packet. This has many disadvantages like
854 * prohibiting stream copy in many cases thus it should only be considered
855 * as a last resort.
856 */
857#define AV_CODEC_CAP_SUBFRAMES (1 << 8)
858/**
859 * Codec is experimental and is thus avoided in favor of non experimental
860 * encoders
861 */
862#define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
863/**
864 * Codec should fill in channel configuration and samplerate instead of container
865 */
866#define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
867/**
868 * Codec supports frame-level multithreading.
869 */
870#define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
871/**
872 * Codec supports slice-based (or partition-based) multithreading.
873 */
874#define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
875/**
876 * Codec supports changed parameters at any point.
877 */
878#define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
879/**
880 * Codec supports avctx->thread_count == 0 (auto).
881 */
882#define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
883/**
884 * Audio encoder supports receiving a different number of samples in each call.
885 */
886#define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
887
fa384dcc
MN
888/**
889 * Pan Scan area.
f5bccd85
DB
890 * This specifies the area which should be displayed.
891 * Note there may be multiple such areas for one frame.
fa384dcc
MN
892 */
893typedef struct AVPanScan{
894 /**
f5bccd85
DB
895 * id
896 * - encoding: Set by user.
897 * - decoding: Set by libavcodec.
fa384dcc
MN
898 */
899 int id;
900
901 /**
902 * width and height in 1/16 pel
f5bccd85
DB
903 * - encoding: Set by user.
904 * - decoding: Set by libavcodec.
fa384dcc
MN
905 */
906 int width;
907 int height;
908
909 /**
f5bccd85
DB
910 * position of the top left corner in 1/16 pel for up to 3 fields/frames
911 * - encoding: Set by user.
912 * - decoding: Set by libavcodec.
fa384dcc
MN
913 */
914 int16_t position[3][2];
915}AVPanScan;
916
f0b769c1
AK
917/**
918 * This structure describes the bitrate properties of an encoded bitstream. It
919 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
920 * parameters for H.264/HEVC.
921 */
922typedef struct AVCPBProperties {
923 /**
924 * Maximum bitrate of the stream, in bits per second.
925 * Zero if unknown or unspecified.
926 */
927 int max_bitrate;
928 /**
929 * Minimum bitrate of the stream, in bits per second.
930 * Zero if unknown or unspecified.
931 */
932 int min_bitrate;
933 /**
934 * Average bitrate of the stream, in bits per second.
935 * Zero if unknown or unspecified.
936 */
937 int avg_bitrate;
938
939 /**
940 * The size of the buffer to which the ratecontrol is applied, in bits.
941 * Zero if unknown or unspecified.
942 */
943 int buffer_size;
944
945 /**
946 * The delay between the time the packet this structure is associated with
947 * is received and the time when it should be decoded, in periods of a 27MHz
948 * clock.
949 *
950 * UINT64_MAX when unknown or unspecified.
951 */
952 uint64_t vbv_delay;
953} AVCPBProperties;
954
759001c5
AK
955/**
956 * The decoder will keep a reference to the frame and may reuse it later.
957 */
958#define AV_GET_BUFFER_FLAG_REF (1 << 0)
074c4ca7 959
30f3f625
AK
960/**
961 * @defgroup lavc_packet AVPacket
962 *
963 * Types and functions for working with AVPacket.
964 * @{
965 */
4de339e2 966enum AVPacketSideDataType {
b8d5070d
VG
967 /**
968 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
969 * bytes worth of palette. This side data signals that a new palette is
970 * present.
971 */
4de339e2 972 AV_PKT_DATA_PALETTE,
75872d77
VG
973
974 /**
975 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
976 * that the extradata buffer was changed and the receiving side should
977 * act upon it appropriately. The new extradata is embedded in the side
978 * data buffer and should be immediately used for processing the current
979 * frame or packet.
980 */
195c123c 981 AV_PKT_DATA_NEW_EXTRADATA,
30f3f625
AK
982
983 /**
984 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
199ada49 985 * @code
30f3f625
AK
986 * u32le param_flags
987 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
988 * s32le channel_count
989 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
990 * u64le channel_layout
991 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
992 * s32le sample_rate
993 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
994 * s32le width
995 * s32le height
199ada49 996 * @endcode
30f3f625 997 */
fe75dc85 998 AV_PKT_DATA_PARAM_CHANGE,
30f3f625
AK
999
1000 /**
1001 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1002 * structures with info about macroblocks relevant to splitting the
1003 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1004 * That is, it does not necessarily contain info about all macroblocks,
1005 * as long as the distance between macroblocks in the info is smaller
1006 * than the target payload size.
1007 * Each MB info structure is 12 bytes, and is laid out as follows:
199ada49 1008 * @code
30f3f625
AK
1009 * u32le bit offset from the start of the packet
1010 * u8 current quantizer at the start of the macroblock
1011 * u8 GOB number
1012 * u16le macroblock address within the GOB
1013 * u8 horizontal MV predictor
1014 * u8 vertical MV predictor
1015 * u8 horizontal MV predictor for block number 3
1016 * u8 vertical MV predictor for block number 3
199ada49 1017 * @endcode
30f3f625 1018 */
bdc1220e 1019 AV_PKT_DATA_H263_MB_INFO,
5a7e35dd
AK
1020
1021 /**
1022 * This side data should be associated with an audio stream and contains
1023 * ReplayGain information in form of the AVReplayGain struct.
1024 */
1025 AV_PKT_DATA_REPLAYGAIN,
bddd8cbf
VG
1026
1027 /**
1028 * This side data contains a 3x3 transformation matrix describing an affine
1029 * transformation that needs to be applied to the decoded video frames for
1030 * correct presentation.
1031 *
1032 * See libavutil/display.h for a detailed description of the data.
1033 */
1034 AV_PKT_DATA_DISPLAYMATRIX,
93014864 1035
37c46743 1036 /**
93014864
VG
1037 * This side data should be associated with a video stream and contains
1038 * Stereoscopic 3D information in form of the AVStereo3D struct.
1039 */
1040 AV_PKT_DATA_STEREO3D,
728685f3
AK
1041
1042 /**
1043 * This side data should be associated with an audio stream and corresponds
1044 * to enum AVAudioServiceType.
1045 */
1046 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
5d3addb9
VG
1047
1048 /**
1049 * This side data contains an integer value representing the quality
1050 * factor of the compressed frame. Allowed range is between 1 (good)
1051 * and FF_LAMBDA_MAX (bad).
1052 */
1053 AV_PKT_DATA_QUALITY_FACTOR,
79ae1e63
JS
1054
1055 /**
1056 * This side data contains an integer value representing the stream index
1057 * of a "fallback" track. A fallback track indicates an alternate
1058 * track to use when the current track can not be decoded for some reason.
1059 * e.g. no decoder available for codec.
1060 */
1061 AV_PKT_DATA_FALLBACK_TRACK,
f0b769c1
AK
1062
1063 /**
1064 * This side data corresponds to the AVCPBProperties struct.
1065 */
1066 AV_PKT_DATA_CPB_PROPERTIES,
2fb6acd9
VG
1067
1068 /**
1069 * This side data should be associated with a video stream and corresponds
1070 * to the AVSphericalMapping structure.
1071 */
1072 AV_PKT_DATA_SPHERICAL,
4de339e2
KS
1073};
1074
0e2c3ee9
AK
1075typedef struct AVPacketSideData {
1076 uint8_t *data;
1077 int size;
1078 enum AVPacketSideDataType type;
1079} AVPacketSideData;
1080
0876c280
AK
1081/**
1082 * This structure stores compressed data. It is typically exported by demuxers
1083 * and then passed as input to decoders, or received as output from encoders and
1084 * then passed to muxers.
1085 *
1086 * For video, it should typically contain one compressed frame. For audio it may
6064f697
VG
1087 * contain several compressed frames. Encoders are allowed to output empty
1088 * packets, with no compressed data, containing only side data
1089 * (e.g. to update some stream parameters at the end of encoding).
0876c280
AK
1090 *
1091 * AVPacket is one of the few structs in Libav, whose size is a part of public
1092 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1093 * without libavcodec and libavformat major bump.
1094 *
ce70f28a
LB
1095 * The semantics of data ownership depends on the buf field.
1096 * If it is set, the packet data is dynamically allocated and is
1097 * valid indefinitely until a call to av_packet_unref() reduces the
1098 * reference count to 0.
0876c280 1099 *
ce70f28a
LB
1100 * If the buf field is not set av_packet_ref() would make a copy instead
1101 * of increasing the reference count.
1102 *
1103 * The side data is always allocated with av_malloc(), copied by
1104 * av_packet_ref() and freed by av_packet_unref().
1105 *
1106 * @see av_packet_ref
1107 * @see av_packet_unref
0876c280 1108 */
18c915ee
TB
1109typedef struct AVPacket {
1110 /**
1afddbe5
AK
1111 * A reference to the reference-counted buffer where the packet data is
1112 * stored.
1113 * May be NULL, then the packet data is not reference-counted.
1114 */
1115 AVBufferRef *buf;
1116 /**
7b356d39
RS
1117 * Presentation timestamp in AVStream->time_base units; the time at which
1118 * the decompressed packet will be presented to the user.
18c915ee
TB
1119 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1120 * pts MUST be larger or equal to dts as presentation cannot happen before
1121 * decompression, unless one wants to view hex dumps. Some formats misuse
1122 * the terms dts and pts/cts to mean something different. Such timestamps
1123 * must be converted to true pts/dts before they are stored in AVPacket.
1124 */
1125 int64_t pts;
1126 /**
7b356d39
RS
1127 * Decompression timestamp in AVStream->time_base units; the time at which
1128 * the packet is decompressed.
18c915ee
TB
1129 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1130 */
1131 int64_t dts;
1132 uint8_t *data;
1133 int size;
1134 int stream_index;
9d39cbf6
LB
1135 /**
1136 * A combination of AV_PKT_FLAG values
1137 */
18c915ee
TB
1138 int flags;
1139 /**
4de339e2
KS
1140 * Additional packet data that can be provided by the container.
1141 * Packet can contain several types of side information.
1142 */
0e2c3ee9 1143 AVPacketSideData *side_data;
4de339e2
KS
1144 int side_data_elems;
1145
1146 /**
7b356d39 1147 * Duration of this packet in AVStream->time_base units, 0 if unknown.
18c915ee
TB
1148 * Equals next_pts - this_pts in presentation order.
1149 */
948f3c19 1150 int64_t duration;
01bcc2d5 1151
18c915ee
TB
1152 int64_t pos; ///< byte position in stream, -1 if unknown
1153
948f3c19 1154#if FF_API_CONVERGENCE_DURATION
18c915ee 1155 /**
948f3c19 1156 * @deprecated Same as the duration field, but as int64_t. This was required
1157 * for Matroska subtitles, whose duration values could overflow when the
1158 * duration field was still an int.
18c915ee 1159 */
948f3c19 1160 attribute_deprecated
18c915ee 1161 int64_t convergence_duration;
948f3c19 1162#endif
18c915ee 1163} AVPacket;
9d39cbf6
LB
1164#define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1165#define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
18c915ee 1166
fe75dc85
MS
1167enum AVSideDataParamChangeFlags {
1168 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1169 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1170 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1171 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1172};
30f3f625
AK
1173/**
1174 * @}
1175 */
fe75dc85 1176
f3a29b75
JR
1177struct AVCodecInternal;
1178
4bf3c8f2
AC
1179enum AVFieldOrder {
1180 AV_FIELD_UNKNOWN,
1181 AV_FIELD_PROGRESSIVE,
1182 AV_FIELD_TT, //< Top coded_first, top displayed first
1183 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1184 AV_FIELD_TB, //< Top coded first, bottom displayed first
1185 AV_FIELD_BT, //< Bottom coded first, top displayed first
1186};
1187
d33c949c 1188/**
252f17e2
MN
1189 * main external API structure.
1190 * New fields can be added to the end with minor version bumps.
8bfb108b 1191 * Removal, reordering and changes to existing fields require a major
252f17e2 1192 * version bump.
8bfb108b 1193 * sizeof(AVCodecContext) must not be used outside libav*.
d33c949c 1194 */
de6d9b64 1195typedef struct AVCodecContext {
b71901e6 1196 /**
f5bccd85 1197 * information on struct for av_log
488eec10 1198 * - set by avcodec_alloc_context3
bc874dae 1199 */
d42a814e 1200 const AVClass *av_class;
b1edfce0
AK
1201 int log_level_offset;
1202
1203 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
0a0f19b5 1204 const struct AVCodec *codec;
36ef5369 1205 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
b1edfce0
AK
1206
1207 /**
1208 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1209 * This is used to work around some encoder bugs.
1210 * A demuxer should set this to what is stored in the field used to identify the codec.
1211 * If there are multiple such fields in a container then the demuxer should choose the one
1212 * which maximizes the information about the used codec.
1213 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1214 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1215 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1216 * first.
1217 * - encoding: Set by user, if not then the default based on codec_id will be used.
1218 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1219 */
1220 unsigned int codec_tag;
1221
b1edfce0
AK
1222 void *priv_data;
1223
1224 /**
1225 * Private context used for internal data.
1226 *
1227 * Unlike priv_data, this is not codec-specific. It is used in general
1228 * libavcodec functions.
1229 */
1230 struct AVCodecInternal *internal;
1231
1232 /**
1233 * Private data of the user, can be used to carry app specific stuff.
1234 * - encoding: Set by user.
1235 * - decoding: Set by user.
1236 */
1237 void *opaque;
1238
bc874dae 1239 /**
f5bccd85
DB
1240 * the average bitrate
1241 * - encoding: Set by user; unused for constant quantizer encoding.
1242 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
b71901e6 1243 */
de6d9b64 1244 int bit_rate;
b71901e6
MN
1245
1246 /**
64863965 1247 * number of bits the bitstream is allowed to diverge from the reference.
b71901e6 1248 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
f5bccd85 1249 * - encoding: Set by user; unused for constant quantizer encoding.
64863965 1250 * - decoding: unused
b71901e6 1251 */
115329f1 1252 int bit_rate_tolerance;
b71901e6
MN
1253
1254 /**
b1edfce0
AK
1255 * Global quality for codecs which cannot change it per frame.
1256 * This should be proportional to MPEG-1/2/4 qscale.
f5bccd85 1257 * - encoding: Set by user.
b1edfce0 1258 * - decoding: unused
b71901e6 1259 */
b1edfce0 1260 int global_quality;
b71901e6
MN
1261
1262 /**
b1edfce0
AK
1263 * - encoding: Set by user.
1264 * - decoding: unused
b71901e6 1265 */
b1edfce0
AK
1266 int compression_level;
1267#define FF_COMPRESSION_DEFAULT -1
b71901e6
MN
1268
1269 /**
7c6eb0a1 1270 * AV_CODEC_FLAG_*.
b1edfce0
AK
1271 * - encoding: Set by user.
1272 * - decoding: Set by user.
b71901e6 1273 */
b1edfce0
AK
1274 int flags;
1275
1276 /**
7c6eb0a1 1277 * AV_CODEC_FLAG2_*
b1edfce0
AK
1278 * - encoding: Set by user.
1279 * - decoding: Set by user.
1280 */
1281 int flags2;
b71901e6
MN
1282
1283 /**
f5bccd85 1284 * some codecs need / can use extradata like Huffman tables.
41ed7ab4 1285 * MJPEG: Huffman tables
b71901e6 1286 * rv10: additional flags
41ed7ab4 1287 * MPEG-4: global headers (they can be in the bitstream or here)
059a9348 1288 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
41ed7ab4 1289 * than extradata_size to avoid problems if it is read with the bitstream reader.
f5bccd85
DB
1290 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1291 * - encoding: Set/allocated/freed by libavcodec.
1292 * - decoding: Set/allocated/freed by user.
b71901e6 1293 */
58f2a4b0 1294 uint8_t *extradata;
e84c31dc 1295 int extradata_size;
115329f1 1296
b71901e6 1297 /**
f5bccd85
DB
1298 * This is the fundamental unit of time (in seconds) in terms
1299 * of which frame timestamps are represented. For fixed-fps content,
5b28c8c3
MN
1300 * timebase should be 1/framerate and timestamp increments should be
1301 * identically 1.
f5bccd85 1302 * - encoding: MUST be set by user.
7ea1b347
AK
1303 * - decoding: the use of this field for decoding is deprecated.
1304 * Use framerate instead.
b71901e6 1305 */
c0df9d75 1306 AVRational time_base;
115329f1 1307
b1edfce0
AK
1308 /**
1309 * For some codecs, the time base is closer to the field rate than the frame rate.
1310 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1311 * if no telecine is used ...
1312 *
1313 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1314 */
1315 int ticks_per_frame;
1316
1317 /**
c68317eb 1318 * Codec delay.
b1edfce0
AK
1319 *
1320 * Video:
1321 * Number of frames the decoded output will be delayed relative to the
1322 * encoded input.
1323 *
1324 * Audio:
2df0c32e 1325 * For encoding, this field is unused (see initial_padding).
b19a5e51 1326 *
e4aa3831
NC
1327 * For decoding, this is the number of samples the decoder needs to
1328 * output before the decoder's output is valid. When seeking, you should
1329 * start decoding this many samples prior to your desired seek point.
b1edfce0
AK
1330 *
1331 * - encoding: Set by libavcodec.
e4aa3831 1332 * - decoding: Set by libavcodec.
b1edfce0
AK
1333 */
1334 int delay;
1335
1336
5b28c8c3 1337 /* video only */
14bea432 1338 /**
21adafec 1339 * picture width / height.
9af7e804
LB
1340 *
1341 * @note Those fields may not match the values of the last
41ed7ab4 1342 * AVFrame output by avcodec_decode_video2 due frame
9af7e804
LB
1343 * reordering.
1344 *
115329f1 1345 * - encoding: MUST be set by user.
2d6edb2b
AK
1346 * - decoding: May be set by the user before opening the decoder if known e.g.
1347 * from the container. Some decoders will require the dimensions
1348 * to be set by the caller. During decoding, the decoder may
9af7e804 1349 * overwrite those values as required while parsing the data.
b71901e6 1350 */
de6d9b64 1351 int width, height;
115329f1 1352
b1edfce0 1353 /**
2d6edb2b
AK
1354 * Bitstream width / height, may be different from width/height e.g. when
1355 * the decoded frame is cropped before being output.
9af7e804
LB
1356 *
1357 * @note Those field may not match the value of the last
41ed7ab4 1358 * AVFrame output by avcodec_receive_frame() due frame
9af7e804
LB
1359 * reordering.
1360 *
b1edfce0 1361 * - encoding: unused
2d6edb2b
AK
1362 * - decoding: May be set by the user before opening the decoder if known
1363 * e.g. from the container. During decoding, the decoder may
9af7e804 1364 * overwrite those values as required while parsing the data.
b1edfce0
AK
1365 */
1366 int coded_width, coded_height;
1367
b71901e6 1368 /**
f5bccd85
DB
1369 * the number of pictures in a group of pictures, or 0 for intra_only
1370 * - encoding: Set by user.
64863965 1371 * - decoding: unused
b71901e6
MN
1372 */
1373 int gop_size;
1374
1375 /**
716d413c 1376 * Pixel format, see AV_PIX_FMT_xxx.
c1bdc930 1377 * May be set by the demuxer if known from headers.
41ed7ab4 1378 * May be overridden by the decoder if it knows better.
9af7e804
LB
1379 *
1380 * @note This field may not match the value of the last
41ed7ab4 1381 * AVFrame output by avcodec_receive_frame() due frame
9af7e804
LB
1382 * reordering.
1383 *
f5bccd85 1384 * - encoding: Set by user.
9af7e804
LB
1385 * - decoding: Set by user if known, overridden by libavcodec while
1386 * parsing the data.
b71901e6 1387 */
716d413c 1388 enum AVPixelFormat pix_fmt;
115329f1 1389
b1edfce0 1390 /**
f5bccd85
DB
1391 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1392 * decoder to draw a horizontal band. It improves cache usage. Not
b71901e6 1393 * all codecs can do that. You must check the codec capabilities
f5bccd85 1394 * beforehand.
37b00b47
AS
1395 * When multithreading is used, it may be called from multiple threads
1396 * at the same time; threads might draw different parts of the same AVFrame,
1397 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1398 * in order.
24b1583a
IK
1399 * The function is also used by hardware acceleration APIs.
1400 * It is called at least once during frame decoding to pass
1401 * the data needed for hardware render.
1402 * In that mode instead of pixel data, AVFrame points to
1403 * a structure specific to the acceleration API. The application
1404 * reads the structure and can change some fields to indicate progress
1405 * or mark state.
64863965 1406 * - encoding: unused
f5bccd85 1407 * - decoding: Set by user.
3bb07d61
MN
1408 * @param height the height of the slice
1409 * @param y the y position of the slice
1410 * @param type 1->top field, 2->bottom field, 3->frame
1411 * @param offset offset into the AVFrame.data from which the slice should be read
b71901e6 1412 */
bf89e6b1 1413 void (*draw_horiz_band)(struct AVCodecContext *s,
560f773c 1414 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
3bb07d61 1415 int y, int type, int height);
bf89e6b1 1416
a3a5f4d6 1417 /**
b1edfce0
AK
1418 * callback to negotiate the pixelFormat
1419 * @param fmt is the list of formats which are supported by the codec,
1420 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1421 * The first is always the native one.
1c80c9d7
RDC
1422 * @note The callback may be called again immediately if initialization for
1423 * the selected (hardware-accelerated) pixel format failed.
1424 * @warning Behavior is undefined if the callback returns a value not
1425 * in the fmt list of formats.
b1edfce0
AK
1426 * @return the chosen format
1427 * - encoding: unused
1428 * - decoding: Set by user, if not set the native format will be chosen.
a3a5f4d6 1429 */
716d413c 1430 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
de6d9b64 1431
718b27a7 1432 /**
b1edfce0
AK
1433 * maximum number of B-frames between non-B-frames
1434 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1435 * - encoding: Set by user.
1436 * - decoding: unused
718b27a7 1437 */
b1edfce0 1438 int max_b_frames;
115329f1 1439
b71901e6 1440 /**
b1edfce0
AK
1441 * qscale factor between IP and B-frames
1442 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1443 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1444 * - encoding: Set by user.
64863965 1445 * - decoding: unused
b71901e6 1446 */
b1edfce0 1447 float b_quant_factor;
115329f1 1448
0e6c8532
VG
1449#if FF_API_PRIVATE_OPT
1450 /** @deprecated use encoder private options instead */
1451 attribute_deprecated
b1edfce0 1452 int b_frame_strategy;
0e6c8532 1453#endif
115329f1 1454
b71901e6 1455 /**
b1edfce0 1456 * qscale offset between IP and B-frames
f5bccd85 1457 * - encoding: Set by user.
64863965 1458 * - decoding: unused
b71901e6 1459 */
b1edfce0 1460 float b_quant_offset;
b71901e6
MN
1461
1462 /**
b1edfce0
AK
1463 * Size of the frame reordering buffer in the decoder.
1464 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1465 * - encoding: Set by libavcodec.
1466 * - decoding: Set by libavcodec.
1467 */
1468 int has_b_frames;
1469
12b49769
VG
1470#if FF_API_PRIVATE_OPT
1471 /** @deprecated use encoder private options instead */
1472 attribute_deprecated
b1edfce0 1473 int mpeg_quant;
12b49769 1474#endif
b71901e6
MN
1475
1476 /**
41ed7ab4
VG
1477 * qscale factor between P- and I-frames
1478 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
662e5411 1479 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
f5bccd85 1480 * - encoding: Set by user.
64863965 1481 * - decoding: unused
b71901e6 1482 */
b1edfce0 1483 float i_quant_factor;
64b7c5b6 1484
b1edfce0
AK
1485 /**
1486 * qscale offset between P and I-frames
1487 * - encoding: Set by user.
1488 * - decoding: unused
1489 */
1490 float i_quant_offset;
9dbcbd92 1491
b1edfce0
AK
1492 /**
1493 * luminance masking (0-> disabled)
1494 * - encoding: Set by user.
1495 * - decoding: unused
1496 */
1497 float lumi_masking;
115329f1 1498
b1edfce0
AK
1499 /**
1500 * temporary complexity masking (0-> disabled)
1501 * - encoding: Set by user.
1502 * - decoding: unused
1503 */
1504 float temporal_cplx_masking;
de6d9b64 1505
b1edfce0
AK
1506 /**
1507 * spatial complexity masking (0-> disabled)
1508 * - encoding: Set by user.
1509 * - decoding: unused
1510 */
1511 float spatial_cplx_masking;
115329f1 1512
b71901e6 1513 /**
b1edfce0 1514 * p block masking (0-> disabled)
f5bccd85 1515 * - encoding: Set by user.
64863965 1516 * - decoding: unused
b71901e6 1517 */
b1edfce0 1518 float p_masking;
115329f1 1519
b71901e6 1520 /**
b1edfce0 1521 * darkness masking (0-> disabled)
f5bccd85 1522 * - encoding: Set by user.
64863965 1523 * - decoding: unused
b71901e6 1524 */
b1edfce0 1525 float dark_masking;
115329f1 1526
b71901e6 1527 /**
b1edfce0
AK
1528 * slice count
1529 * - encoding: Set by libavcodec.
1530 * - decoding: Set by user (or 0).
b71901e6 1531 */
b1edfce0 1532 int slice_count;
2862b637
VG
1533
1534#if FF_API_PRIVATE_OPT
1535 /** @deprecated use encoder private options instead */
1536 attribute_deprecated
b1edfce0
AK
1537 int prediction_method;
1538#define FF_PRED_LEFT 0
1539#define FF_PRED_PLANE 1
1540#define FF_PRED_MEDIAN 2
2862b637 1541#endif
115329f1 1542
b71901e6 1543 /**
b1edfce0
AK
1544 * slice offsets in the frame in bytes
1545 * - encoding: Set/allocated by libavcodec.
1546 * - decoding: Set/allocated by user (or NULL).
b71901e6 1547 */
b1edfce0 1548 int *slice_offset;
0fd90455 1549
b71901e6 1550 /**
b1edfce0
AK
1551 * sample aspect ratio (0 if unknown)
1552 * That is the width of a pixel divided by the height of the pixel.
1553 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1554 * - encoding: Set by user.
f5bccd85 1555 * - decoding: Set by libavcodec.
b71901e6 1556 */
b1edfce0 1557 AVRational sample_aspect_ratio;
115329f1 1558
b71901e6 1559 /**
b1edfce0 1560 * motion estimation comparison function
f5bccd85 1561 * - encoding: Set by user.
64863965 1562 * - decoding: unused
b71901e6 1563 */
b1edfce0 1564 int me_cmp;
b71901e6 1565 /**
b1edfce0 1566 * subpixel motion estimation comparison function
f5bccd85 1567 * - encoding: Set by user.
64863965 1568 * - decoding: unused
b71901e6 1569 */
b1edfce0 1570 int me_sub_cmp;
b71901e6 1571 /**
b1edfce0 1572 * macroblock comparison function (not supported yet)
f5bccd85 1573 * - encoding: Set by user.
64863965 1574 * - decoding: unused
b71901e6 1575 */
b1edfce0 1576 int mb_cmp;
b71901e6 1577 /**
b1edfce0 1578 * interlaced DCT comparison function
f5bccd85 1579 * - encoding: Set by user.
64863965 1580 * - decoding: unused
b71901e6 1581 */
b1edfce0
AK
1582 int ildct_cmp;
1583#define FF_CMP_SAD 0
1584#define FF_CMP_SSE 1
1585#define FF_CMP_SATD 2
1586#define FF_CMP_DCT 3
1587#define FF_CMP_PSNR 4
1588#define FF_CMP_BIT 5
1589#define FF_CMP_RD 6
1590#define FF_CMP_ZERO 7
1591#define FF_CMP_VSAD 8
1592#define FF_CMP_VSSE 9
1593#define FF_CMP_NSSE 10
b1edfce0
AK
1594#define FF_CMP_DCTMAX 13
1595#define FF_CMP_DCT264 14
1596#define FF_CMP_CHROMA 256
115329f1 1597
b71901e6 1598 /**
b1edfce0 1599 * ME diamond size & shape
f5bccd85 1600 * - encoding: Set by user.
64863965 1601 * - decoding: unused
b71901e6 1602 */
b1edfce0 1603 int dia_size;
b71901e6
MN
1604
1605 /**
b1edfce0 1606 * amount of previous MV predictors (2a+1 x 2a+1 square)
f5bccd85 1607 * - encoding: Set by user.
64863965 1608 * - decoding: unused
b71901e6 1609 */
b1edfce0 1610 int last_predictor_count;
115329f1 1611
0e9c4fe2
VG
1612#if FF_API_PRIVATE_OPT
1613 /** @deprecated use encoder private options instead */
1614 attribute_deprecated
b1edfce0 1615 int pre_me;
0e9c4fe2 1616#endif
115329f1 1617
b71901e6 1618 /**
b1edfce0 1619 * motion estimation prepass comparison function
f5bccd85 1620 * - encoding: Set by user.
64863965 1621 * - decoding: unused
b71901e6 1622 */
b1edfce0 1623 int me_pre_cmp;
917e06c8 1624
b71901e6 1625 /**
b1edfce0 1626 * ME prepass diamond size & shape
f5bccd85 1627 * - encoding: Set by user.
64863965 1628 * - decoding: unused
b71901e6 1629 */
b1edfce0 1630 int pre_dia_size;
115329f1 1631
c5d309f2 1632 /**
b1edfce0 1633 * subpel ME quality
f5bccd85 1634 * - encoding: Set by user.
64863965 1635 * - decoding: unused
c5d309f2 1636 */
b1edfce0 1637 int me_subpel_quality;
115329f1 1638
c5d309f2 1639 /**
b1edfce0
AK
1640 * maximum motion estimation search range in subpel units
1641 * If 0 then no limit.
1642 *
f5bccd85 1643 * - encoding: Set by user.
64863965 1644 * - decoding: unused
c5d309f2 1645 */
b1edfce0 1646 int me_range;
115329f1 1647
144f0625 1648 /**
b1edfce0
AK
1649 * slice flags
1650 * - encoding: unused
1651 * - decoding: Set by user.
144f0625 1652 */
b1edfce0
AK
1653 int slice_flags;
1654#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
41ed7ab4 1655#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
b1edfce0
AK
1656#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1657
4d2858de 1658 /**
b1edfce0
AK
1659 * macroblock decision mode
1660 * - encoding: Set by user.
1661 * - decoding: unused
4d2858de 1662 */
b1edfce0
AK
1663 int mb_decision;
1664#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1665#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1666#define FF_MB_DECISION_RD 2 ///< rate distortion
4d2858de 1667
6b72ac63 1668 /**
b1edfce0
AK
1669 * custom intra quantization matrix
1670 * - encoding: Set by user, can be NULL.
1671 * - decoding: Set by libavcodec.
bec89a84 1672 */
b1edfce0 1673 uint16_t *intra_matrix;
7160bb71 1674
11f18faf 1675 /**
b1edfce0
AK
1676 * custom inter quantization matrix
1677 * - encoding: Set by user, can be NULL.
1678 * - decoding: Set by libavcodec.
11f18faf 1679 */
b1edfce0 1680 uint16_t *inter_matrix;
115329f1 1681
7c79587d
VG
1682#if FF_API_PRIVATE_OPT
1683 /** @deprecated use encoder private options instead */
1684 attribute_deprecated
b1edfce0 1685 int scenechange_threshold;
115329f1 1686
1482aff2
VG
1687 /** @deprecated use encoder private options instead */
1688 attribute_deprecated
b1edfce0 1689 int noise_reduction;
1482aff2 1690#endif
1e491e29 1691
1457ab52 1692 /**
b1edfce0 1693 * precision of the intra DC coefficient - 8
f5bccd85 1694 * - encoding: Set by user.
64863965 1695 * - decoding: unused
1457ab52 1696 */
b1edfce0
AK
1697 int intra_dc_precision;
1698
1457ab52 1699 /**
b1edfce0
AK
1700 * Number of macroblock rows at the top which are skipped.
1701 * - encoding: unused
1702 * - decoding: Set by user.
1457ab52 1703 */
b1edfce0
AK
1704 int skip_top;
1705
1457ab52 1706 /**
b1edfce0
AK
1707 * Number of macroblock rows at the bottom which are skipped.
1708 * - encoding: unused
1709 * - decoding: Set by user.
1457ab52 1710 */
b1edfce0
AK
1711 int skip_bottom;
1712
1457ab52 1713 /**
41ed7ab4 1714 * minimum MB Lagrange multiplier
f5bccd85 1715 * - encoding: Set by user.
64863965 1716 * - decoding: unused
1457ab52 1717 */
b1edfce0 1718 int mb_lmin;
b07a5980
MN
1719
1720 /**
41ed7ab4 1721 * maximum MB Lagrange multiplier
f5bccd85 1722 * - encoding: Set by user.
64863965 1723 * - decoding: unused
b07a5980 1724 */
b1edfce0 1725 int mb_lmax;
70ac76c0 1726
5b6f42da 1727#if FF_API_PRIVATE_OPT
f5fb6b34 1728 /**
5b6f42da 1729 * @deprecated use encoder private options instead
f5fb6b34 1730 */
5b6f42da 1731 attribute_deprecated
b1edfce0 1732 int me_penalty_compensation;
5b6f42da 1733#endif
b07a5980 1734
70ac76c0 1735 /**
f5bccd85 1736 * - encoding: Set by user.
64863965 1737 * - decoding: unused
70ac76c0 1738 */
b1edfce0 1739 int bidir_refine;
826f429a 1740
84c4714f
VG
1741#if FF_API_PRIVATE_OPT
1742 /** @deprecated use encoder private options instead */
1743 attribute_deprecated
b1edfce0 1744 int brd_scale;
84c4714f 1745#endif
70ac76c0 1746
826f429a 1747 /**
b1edfce0 1748 * minimum GOP size
f5bccd85 1749 * - encoding: Set by user.
64863965 1750 * - decoding: unused
826f429a 1751 */
b1edfce0 1752 int keyint_min;
826f429a 1753
a33c7159 1754 /**
b1edfce0
AK
1755 * number of reference frames
1756 * - encoding: Set by user.
1757 * - decoding: Set by lavc.
a33c7159 1758 */
b1edfce0 1759 int refs;
e2f9490e 1760
5764d381
VG
1761#if FF_API_PRIVATE_OPT
1762 /** @deprecated use encoder private options instead */
1763 attribute_deprecated
b1edfce0 1764 int chromaoffset;
5764d381 1765#endif
e2f9490e 1766
65f7062d 1767 /**
b1edfce0 1768 * Note: Value depends upon the compare function used for fullpel ME.
f5bccd85 1769 * - encoding: Set by user.
1984f635
MN
1770 * - decoding: unused
1771 */
b1edfce0 1772 int mv0_threshold;
115329f1 1773
0e6c8532
VG
1774#if FF_API_PRIVATE_OPT
1775 /** @deprecated use encoder private options instead */
1776 attribute_deprecated
b1edfce0 1777 int b_sensitivity;
0e6c8532 1778#endif
5cd62665
ZK
1779
1780 /**
b1edfce0
AK
1781 * Chromaticity coordinates of the source primaries.
1782 * - encoding: Set by user
1783 * - decoding: Set by libavcodec
5cd62665 1784 */
b1edfce0 1785 enum AVColorPrimaries color_primaries;
115329f1 1786
3d2e8cce 1787 /**
b1edfce0
AK
1788 * Color Transfer Characteristic.
1789 * - encoding: Set by user
1790 * - decoding: Set by libavcodec
3d2e8cce 1791 */
b1edfce0 1792 enum AVColorTransferCharacteristic color_trc;
115329f1 1793
11e659c2 1794 /**
b1edfce0
AK
1795 * YUV colorspace type.
1796 * - encoding: Set by user
1797 * - decoding: Set by libavcodec
1798 */
1799 enum AVColorSpace colorspace;
1800
1801 /**
1802 * MPEG vs JPEG YUV range.
1803 * - encoding: Set by user
1804 * - decoding: Set by libavcodec
1805 */
1806 enum AVColorRange color_range;
1807
1808 /**
1809 * This defines the location of chroma samples.
1810 * - encoding: Set by user
1811 * - decoding: Set by libavcodec
1812 */
1813 enum AVChromaLocation chroma_sample_location;
1814
1815 /**
1816 * Number of slices.
1817 * Indicates number of picture subdivisions. Used for parallelized
1818 * decoding.
1819 * - encoding: Set by user
11e659c2
MN
1820 * - decoding: unused
1821 */
b1edfce0
AK
1822 int slices;
1823
1824 /** Field order
1825 * - encoding: set by libavcodec
1826 * - decoding: Set by libavcodec
1827 */
1828 enum AVFieldOrder field_order;
1829
1830 /* audio only */
1831 int sample_rate; ///< samples per second
1832 int channels; ///< number of audio channels
11e659c2
MN
1833
1834 /**
b1edfce0 1835 * audio sample format
f5bccd85 1836 * - encoding: Set by user.
b1edfce0 1837 * - decoding: Set by libavcodec.
11e659c2 1838 */
b1edfce0 1839 enum AVSampleFormat sample_fmt; ///< sample format
115329f1 1840
b1edfce0 1841 /* The following data should not be initialized. */
3bb07d61 1842 /**
d6f4fe68
AK
1843 * Number of samples per channel in an audio frame.
1844 *
1845 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1846 * except the last must contain exactly frame_size samples per channel.
def97856 1847 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
d6f4fe68
AK
1848 * frame size is not restricted.
1849 * - decoding: may be set by some decoders to indicate constant frame size
3bb07d61 1850 */
b1edfce0 1851 int frame_size;
c179c9e1
AK
1852
1853 /**
1854 * Frame counter, set by libavcodec.
1855 *
1856 * - decoding: total number of frames returned from the decoder so far.
1857 * - encoding: total number of frames passed to the encoder so far.
1858 *
1859 * @note the counter is not incremented if encoding/decoding resulted in
1860 * an error.
1861 */
1862 int frame_number;
3bb07d61 1863
fb364ada 1864 /**
b1edfce0
AK
1865 * number of bytes per packet if constant and known or 0
1866 * Used by some WAV based audio codecs.
fb364ada 1867 */
b1edfce0 1868 int block_align;
115329f1 1869
7d1c3fc1 1870 /**
b1edfce0 1871 * Audio cutoff bandwidth (0 means "automatic")
f5bccd85 1872 * - encoding: Set by user.
7d1c3fc1
MN
1873 * - decoding: unused
1874 */
b1edfce0 1875 int cutoff;
d6eb3c50 1876
d6eb3c50 1877 /**
b1edfce0
AK
1878 * Audio channel layout.
1879 * - encoding: set by user.
1880 * - decoding: set by libavcodec.
d6eb3c50 1881 */
b1edfce0 1882 uint64_t channel_layout;
115329f1 1883
541ae140 1884 /**
b1edfce0 1885 * Request decoder to use this channel layout if it can (0 for default)
541ae140 1886 * - encoding: unused
b1edfce0 1887 * - decoding: Set by user.
541ae140 1888 */
b1edfce0 1889 uint64_t request_channel_layout;
05fbd0a2
MN
1890
1891 /**
b1edfce0 1892 * Type of service that the audio stream conveys.
f5bccd85 1893 * - encoding: Set by user.
b1edfce0 1894 * - decoding: Set by libavcodec.
05fbd0a2 1895 */
b1edfce0 1896 enum AVAudioServiceType audio_service_type;
158c7f05
MN
1897
1898 /**
b1edfce0
AK
1899 * Used to request a sample format from the decoder.
1900 * - encoding: unused.
1901 * - decoding: Set by user.
158c7f05 1902 */
b1edfce0 1903 enum AVSampleFormat request_sample_fmt;
158c7f05 1904
759001c5
AK
1905 /**
1906 * This callback is called at the beginning of each frame to get data
1907 * buffer(s) for it. There may be one contiguous buffer for all the data or
00b8e650
DB
1908 * there may be a buffer per each data plane or anything in between. What
1909 * this means is, you may set however many entries in buf[] you feel necessary.
1910 * Each buffer must be reference-counted using the AVBuffer API (see description
1911 * of buf[] below).
759001c5
AK
1912 *
1913 * The following fields will be set in the frame before this callback is
1914 * called:
1915 * - format
1916 * - width, height (video only)
1917 * - sample_rate, channel_layout, nb_samples (audio only)
1918 * Their values may differ from the corresponding values in
1919 * AVCodecContext. This callback must use the frame values, not the codec
1920 * context values, to calculate the required buffer size.
1921 *
1922 * This callback must fill the following fields in the frame:
1923 * - data[]
1924 * - linesize[]
1925 * - extended_data:
1926 * * if the data is planar audio with more than 8 channels, then this
1927 * callback must allocate and fill extended_data to contain all pointers
1928 * to all data planes. data[] must hold as many pointers as it can.
1929 * extended_data must be allocated with av_malloc() and will be freed in
1930 * av_frame_unref().
41ed7ab4 1931 * * otherwise extended_data must point to data
4cdb3c50
DB
1932 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1933 * the frame's data and extended_data pointers must be contained in these. That
1934 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1935 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1936 * and av_buffer_ref().
759001c5
AK
1937 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1938 * this callback and filled with the extra buffers if there are more
1939 * buffers than buf[] can hold. extended_buf will be freed in
1940 * av_frame_unref().
1941 *
def97856 1942 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
759001c5
AK
1943 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1944 * some other means.
1945 *
1946 * Each data plane must be aligned to the maximum required by the target
1947 * CPU.
1948 *
1949 * @see avcodec_default_get_buffer2()
1950 *
1951 * Video:
1952 *
1953 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1954 * (read and/or written to if it is writable) later by libavcodec.
1955 *
759001c5
AK
1956 * avcodec_align_dimensions2() should be used to find the required width and
1957 * height, as they normally need to be rounded up to the next multiple of 16.
1958 *
1959 * If frame multithreading is used and thread_safe_callbacks is set,
1960 * this callback may be called from a different thread, but not from more
1961 * than one at once. Does not need to be reentrant.
1962 *
1963 * @see avcodec_align_dimensions2()
1964 *
1965 * Audio:
1966 *
1967 * Decoders request a buffer of a particular size by setting
1968 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1969 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1970 * to a smaller value in the output frame.
1971 *
1972 * As a convenience, av_samples_get_buffer_size() and
1973 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1974 * functions to find the required data size and to fill data pointers and
1975 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1976 * since all planes must be the same size.
1977 *
1978 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1979 *
1980 * - encoding: unused
1981 * - decoding: Set by libavcodec, user can override.
1982 */
1983 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
1984
1985 /**
1986 * If non-zero, the decoded audio and video frames returned from
1987 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
1988 * and are valid indefinitely. The caller must free them with
1989 * av_frame_unref() when they are not needed anymore.
1990 * Otherwise, the decoded frames must not be freed by the caller and are
1991 * only valid until the next decode call.
1992 *
05f66706 1993 * This is always automatically enabled if avcodec_receive_frame() is used.
1994 *
759001c5
AK
1995 * - encoding: unused
1996 * - decoding: set by the caller before avcodec_open2().
1997 */
577326d4 1998 attribute_deprecated int refcounted_frames;
ba58dabc 1999
b1edfce0
AK
2000 /* - encoding parameters */
2001 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2002 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
ba58dabc
MN
2003
2004 /**
b1edfce0 2005 * minimum quantizer
f5bccd85 2006 * - encoding: Set by user.
b1edfce0 2007 * - decoding: unused
ba58dabc 2008 */
b1edfce0 2009 int qmin;
7ebfc0ea
MN
2010
2011 /**
b1edfce0 2012 * maximum quantizer
f5bccd85
DB
2013 * - encoding: Set by user.
2014 * - decoding: unused
7ebfc0ea 2015 */
b1edfce0 2016 int qmax;
115329f1 2017
77ea0d4b 2018 /**
b1edfce0 2019 * maximum quantizer difference between frames
f5bccd85 2020 * - encoding: Set by user.
77ea0d4b
MN
2021 * - decoding: unused
2022 */
b1edfce0 2023 int max_qdiff;
9c3d33d6 2024
a4d36c11 2025 /**
b1edfce0 2026 * decoder bitstream buffer size
f5bccd85 2027 * - encoding: Set by user.
f20f8a8b 2028 * - decoding: unused
a4d36c11 2029 */
b1edfce0 2030 int rc_buffer_size;
f20f8a8b
MN
2031
2032 /**
b1edfce0
AK
2033 * ratecontrol override, see RcOverride
2034 * - encoding: Allocated/set/freed by user.
f20f8a8b
MN
2035 * - decoding: unused
2036 */
b1edfce0
AK
2037 int rc_override_count;
2038 RcOverride *rc_override;
bf266e19 2039
d4c5d2ad 2040 /**
b1edfce0 2041 * maximum bitrate
f5bccd85 2042 * - encoding: Set by user.
d4c5d2ad
MN
2043 * - decoding: unused
2044 */
b1edfce0 2045 int rc_max_rate;
baced9f5
MN
2046
2047 /**
b1edfce0 2048 * minimum bitrate
f5bccd85 2049 * - encoding: Set by user.
b1edfce0 2050 * - decoding: unused
baced9f5 2051 */
b1edfce0 2052 int rc_min_rate;
0215006a 2053
21adafec 2054 /**
b1edfce0
AK
2055 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2056 * - encoding: Set by user.
2057 * - decoding: unused.
21adafec 2058 */
b1edfce0 2059 float rc_max_available_vbv_use;
bbf18b21
MN
2060
2061 /**
b1edfce0 2062 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
f5bccd85 2063 * - encoding: Set by user.
b1edfce0 2064 * - decoding: unused.
bbf18b21 2065 */
b1edfce0 2066 float rc_min_vbv_overflow_use;
bbf18b21
MN
2067
2068 /**
b1edfce0 2069 * Number of bits which should be loaded into the rc buffer before decoding starts.
f5bccd85 2070 * - encoding: Set by user.
bbf18b21
MN
2071 * - decoding: unused
2072 */
b1edfce0 2073 int rc_initial_buffer_occupancy;
0fd6aea1 2074
be00ec83 2075#if FF_API_CODER_TYPE
b1edfce0
AK
2076#define FF_CODER_TYPE_VLC 0
2077#define FF_CODER_TYPE_AC 1
2078#define FF_CODER_TYPE_RAW 2
2079#define FF_CODER_TYPE_RLE 3
0fd6aea1 2080 /**
be00ec83 2081 * @deprecated use encoder private options instead
0fd6aea1 2082 */
be00ec83 2083 attribute_deprecated
b1edfce0 2084 int coder_type;
be00ec83 2085#endif /* FF_API_CODER_TYPE */
0fd6aea1 2086
96c373c7
VG
2087#if FF_API_PRIVATE_OPT
2088 /** @deprecated use encoder private options instead */
2089 attribute_deprecated
b1edfce0 2090 int context_model;
96c373c7 2091#endif
957c743a 2092
0ac9f33a
VG
2093#if FF_API_PRIVATE_OPT
2094 /** @deprecated use encoder private options instead */
2095 attribute_deprecated
b1edfce0 2096 int frame_skip_threshold;
09c3e44e 2097
0ac9f33a
VG
2098 /** @deprecated use encoder private options instead */
2099 attribute_deprecated
b1edfce0 2100 int frame_skip_factor;
316a2ec8 2101
0ac9f33a
VG
2102 /** @deprecated use encoder private options instead */
2103 attribute_deprecated
b1edfce0 2104 int frame_skip_exp;
e8501c93 2105
0ac9f33a
VG
2106 /** @deprecated use encoder private options instead */
2107 attribute_deprecated
b1edfce0 2108 int frame_skip_cmp;
0ac9f33a 2109#endif /* FF_API_PRIVATE_OPT */
58f7833e 2110
58f7833e 2111 /**
b1edfce0 2112 * trellis RD quantization
f5bccd85 2113 * - encoding: Set by user.
58f7833e
RS
2114 * - decoding: unused
2115 */
b1edfce0 2116 int trellis;
58f7833e 2117
243df135
VG
2118#if FF_API_PRIVATE_OPT
2119 /** @deprecated use encoder private options instead */
2120 attribute_deprecated
b1edfce0 2121 int min_prediction_order;
58f7833e 2122
243df135
VG
2123 /** @deprecated use encoder private options instead */
2124 attribute_deprecated
b1edfce0 2125 int max_prediction_order;
58f7833e 2126
d7496153
VG
2127 /** @deprecated use encoder private options instead */
2128 attribute_deprecated
b1edfce0 2129 int64_t timecode_frame_start;
d7496153 2130#endif
b1edfce0 2131
462a54e2
VG
2132#if FF_API_RTP_CALLBACK
2133 /**
2134 * @deprecated unused
2135 */
b1edfce0
AK
2136 /* The RTP callback: This function is called */
2137 /* every time the encoder has a packet to send. */
2138 /* It depends on the encoder if the data starts */
2139 /* with a Start Code (it should). H.263 does. */
2140 /* mb_nb contains the number of macroblocks */
2141 /* encoded in the RTP payload. */
462a54e2 2142 attribute_deprecated
b1edfce0 2143 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
462a54e2 2144#endif
b1edfce0 2145
936f0d98
VG
2146#if FF_API_PRIVATE_OPT
2147 /** @deprecated use encoder private options instead */
2148 attribute_deprecated
b1edfce0
AK
2149 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2150 /* do its best to deliver a chunk with size */
2151 /* below rtp_payload_size, the chunk will start */
2152 /* with a start code on some codecs like H.263. */
2153 /* This doesn't take account of any particular */
2154 /* headers inside the transmitted RTP payload. */
936f0d98 2155#endif
b1edfce0 2156
16216b71 2157#if FF_API_STAT_BITS
b1edfce0 2158 /* statistics, used for 2-pass encoding */
16216b71 2159 attribute_deprecated
b1edfce0 2160 int mv_bits;
16216b71 2161 attribute_deprecated
b1edfce0 2162 int header_bits;
16216b71 2163 attribute_deprecated
b1edfce0 2164 int i_tex_bits;
16216b71 2165 attribute_deprecated
b1edfce0 2166 int p_tex_bits;
16216b71 2167 attribute_deprecated
b1edfce0 2168 int i_count;
16216b71 2169 attribute_deprecated
b1edfce0 2170 int p_count;
16216b71 2171 attribute_deprecated
b1edfce0 2172 int skip_count;
16216b71 2173 attribute_deprecated
b1edfce0 2174 int misc_bits;
58f7833e 2175
16216b71
VG
2176 /** @deprecated this field is unused */
2177 attribute_deprecated
b1edfce0 2178 int frame_bits;
16216b71 2179#endif
39a64e30
CH
2180
2181 /**
b1edfce0
AK
2182 * pass1 encoding statistics output buffer
2183 * - encoding: Set by libavcodec.
39a64e30
CH
2184 * - decoding: unused
2185 */
b1edfce0 2186 char *stats_out;
1dd509b1
MN
2187
2188 /**
b1edfce0
AK
2189 * pass2 encoding statistics input buffer
2190 * Concatenated stuff from stats_out of pass1 should be placed here.
2191 * - encoding: Allocated/set/freed by user.
1dd509b1
MN
2192 * - decoding: unused
2193 */
b1edfce0 2194 char *stats_in;
f9243d34
CH
2195
2196 /**
b1edfce0
AK
2197 * Work around bugs in encoders which sometimes cannot be detected automatically.
2198 * - encoding: Set by user
2199 * - decoding: Set by user
f9243d34 2200 */
b1edfce0
AK
2201 int workaround_bugs;
2202#define FF_BUG_AUTODETECT 1 ///< autodetection
b1edfce0
AK
2203#define FF_BUG_XVID_ILACE 4
2204#define FF_BUG_UMP4 8
2205#define FF_BUG_NO_PADDING 16
2206#define FF_BUG_AMV 32
b1edfce0
AK
2207#define FF_BUG_QPEL_CHROMA 64
2208#define FF_BUG_STD_QPEL 128
2209#define FF_BUG_QPEL_CHROMA2 256
2210#define FF_BUG_DIRECT_BLOCKSIZE 512
2211#define FF_BUG_EDGE 1024
2212#define FF_BUG_HPEL_CHROMA 2048
2213#define FF_BUG_DC_CLIP 4096
2214#define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2215#define FF_BUG_TRUNCATED 16384
a403fc03
JR
2216
2217 /**
41ed7ab4 2218 * strictly follow the standard (MPEG-4, ...).
f5bccd85 2219 * - encoding: Set by user.
b1edfce0
AK
2220 * - decoding: Set by user.
2221 * Setting this to STRICT or higher means the encoder and decoder will
2222 * generally do stupid things, whereas setting it to unofficial or lower
2223 * will mean the encoder might produce output that is not supported by all
2224 * spec-compliant decoders. Decoders don't differentiate between normal,
2225 * unofficial and experimental (that is, they always try to decode things
2226 * when they can) unless they are explicitly asked to behave stupidly
2227 * (=strictly conform to the specs)
a403fc03 2228 */
b1edfce0
AK
2229 int strict_std_compliance;
2230#define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2231#define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2232#define FF_COMPLIANCE_NORMAL 0
2233#define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2234#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
a403fc03 2235
a403fc03 2236 /**
b1edfce0
AK
2237 * error concealment flags
2238 * - encoding: unused
2239 * - decoding: Set by user.
a403fc03 2240 */
b1edfce0
AK
2241 int error_concealment;
2242#define FF_EC_GUESS_MVS 1
2243#define FF_EC_DEBLOCK 2
a403fc03
JR
2244
2245 /**
b1edfce0 2246 * debug
f5bccd85 2247 * - encoding: Set by user.
b1edfce0 2248 * - decoding: Set by user.
a403fc03 2249 */
b1edfce0
AK
2250 int debug;
2251#define FF_DEBUG_PICT_INFO 1
2252#define FF_DEBUG_RC 2
2253#define FF_DEBUG_BITSTREAM 4
2254#define FF_DEBUG_MB_TYPE 8
2255#define FF_DEBUG_QP 16
b1edfce0
AK
2256#define FF_DEBUG_DCT_COEFF 0x00000040
2257#define FF_DEBUG_SKIP 0x00000080
2258#define FF_DEBUG_STARTCODE 0x00000100
b1edfce0
AK
2259#define FF_DEBUG_ER 0x00000400
2260#define FF_DEBUG_MMCO 0x00000800
2261#define FF_DEBUG_BUGS 0x00001000
b1edfce0
AK
2262#define FF_DEBUG_BUFFERS 0x00008000
2263#define FF_DEBUG_THREADS 0x00010000
188dea1d 2264
b1ec601f 2265 /**
b1edfce0 2266 * Error recognition; may misdetect some more or less valid parts as errors.
85947156
VS
2267 * - encoding: unused
2268 * - decoding: Set by user.
b1ec601f 2269 */
b1edfce0 2270 int err_recognition;
23a211cb
AK
2271
2272/**
2273 * Verify checksums embedded in the bitstream (could be of either encoded or
2274 * decoded data, depending on the codec) and print an error message on mismatch.
2275 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2276 * decoder returning an error.
2277 */
b1edfce0
AK
2278#define AV_EF_CRCCHECK (1<<0)
2279#define AV_EF_BITSTREAM (1<<1)
2280#define AV_EF_BUFFER (1<<2)
2281#define AV_EF_EXPLODE (1<<3)
1408352a 2282
79de84f2 2283 /**
41ed7ab4 2284 * opaque 64-bit number (generally a PTS) that will be reordered and
79de84f2
MN
2285 * output in AVFrame.reordered_opaque
2286 * - encoding: unused
2287 * - decoding: Set by user.
2288 */
2289 int64_t reordered_opaque;
312420f3
PR
2290
2291 /**
b1edfce0
AK
2292 * Hardware accelerator in use
2293 * - encoding: unused.
2294 * - decoding: Set by libavcodec
312420f3 2295 */
b1edfce0 2296 struct AVHWAccel *hwaccel;
0d72e7d0
PR
2297
2298 /**
b1edfce0
AK
2299 * Hardware accelerator context.
2300 * For some hardware accelerators, a global context needs to be
2301 * provided by the user. In that case, this holds display-dependent
2302 * data Libav cannot instantiate itself. Please refer to the
2303 * Libav HW accelerator documentation to know how to fill this
2304 * is. e.g. for VA API, this is a struct vaapi_context.
2305 * - encoding: unused
2306 * - decoding: Set by user
0d72e7d0 2307 */
b1edfce0 2308 void *hwaccel_context;
0d72e7d0
PR
2309
2310 /**
b1edfce0 2311 * error
7c6eb0a1 2312 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
b1edfce0 2313 * - decoding: unused
0d72e7d0 2314 */
b1edfce0 2315 uint64_t error[AV_NUM_DATA_POINTERS];
3bff4d8b
BC
2316
2317 /**
b1edfce0 2318 * DCT algorithm, see FF_DCT_* below
3bff4d8b 2319 * - encoding: Set by user.
b1edfce0 2320 * - decoding: unused
3bff4d8b 2321 */
b1edfce0
AK
2322 int dct_algo;
2323#define FF_DCT_AUTO 0
2324#define FF_DCT_FASTINT 1
2325#define FF_DCT_INT 2
2326#define FF_DCT_MMX 3
2327#define FF_DCT_ALTIVEC 5
2328#define FF_DCT_FAAN 6
3bff4d8b
BC
2329
2330 /**
b1edfce0 2331 * IDCT algorithm, see FF_IDCT_* below.
3bff4d8b 2332 * - encoding: Set by user.
b1edfce0 2333 * - decoding: Set by user.
3bff4d8b 2334 */
b1edfce0
AK
2335 int idct_algo;
2336#define FF_IDCT_AUTO 0
2337#define FF_IDCT_INT 1
2338#define FF_IDCT_SIMPLE 2
2339#define FF_IDCT_SIMPLEMMX 3
b1edfce0
AK
2340#define FF_IDCT_ARM 7
2341#define FF_IDCT_ALTIVEC 8
b1edfce0 2342#define FF_IDCT_SIMPLEARM 10
d35b94fb 2343#define FF_IDCT_XVID 14
b1edfce0
AK
2344#define FF_IDCT_SIMPLEARMV5TE 16
2345#define FF_IDCT_SIMPLEARMV6 17
b1edfce0 2346#define FF_IDCT_FAAN 20
b1edfce0 2347#define FF_IDCT_SIMPLENEON 22
40e5d31b 2348
b1edfce0
AK
2349 /**
2350 * bits per sample/pixel from the demuxer (needed for huffyuv).
2351 * - encoding: Set by libavcodec.
2352 * - decoding: Set by user.
2353 */
2354 int bits_per_coded_sample;
2355
2356 /**
2357 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2358 * - encoding: set by user.
2359 * - decoding: set by libavcodec.
2360 */
2361 int bits_per_raw_sample;
3797c74b 2362
40cf1bba 2363#if FF_API_CODED_FRAME
1aea7018 2364 /**
b1edfce0
AK
2365 * the picture in the bitstream
2366 * - encoding: Set by libavcodec.
2ff302cb 2367 * - decoding: unused
40cf1bba
VG
2368 *
2369 * @deprecated use the quality factor packet side data instead
1aea7018 2370 */
40cf1bba
VG
2371 attribute_deprecated AVFrame *coded_frame;
2372#endif
4ee6a5c1
MN
2373
2374 /**
b1edfce0
AK
2375 * thread count
2376 * is used to decide how many independent tasks should be passed to execute()
2377 * - encoding: Set by user.
2378 * - decoding: Set by user.
4ee6a5c1 2379 */
b1edfce0 2380 int thread_count;
4ee6a5c1
MN
2381
2382 /**
b1edfce0
AK
2383 * Which multithreading methods to use.
2384 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2385 * so clients which cannot provide future frames should not use it.
2386 *
2387 * - encoding: Set by user, otherwise the default is used.
2388 * - decoding: Set by user, otherwise the default is used.
4ee6a5c1 2389 */
b1edfce0
AK
2390 int thread_type;
2391#define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2392#define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
4ee6a5c1
MN
2393
2394 /**
b1edfce0
AK
2395 * Which multithreading methods are in use by the codec.
2396 * - encoding: Set by libavcodec.
2397 * - decoding: Set by libavcodec.
4ee6a5c1 2398 */
b1edfce0 2399 int active_thread_type;
4ee6a5c1
MN
2400
2401 /**
b1edfce0 2402 * Set by the client if its custom get_buffer() callback can be called
ad027866 2403 * synchronously from another thread, which allows faster multithreaded decoding.
b1edfce0
AK
2404 * draw_horiz_band() will be called from other threads regardless of this setting.
2405 * Ignored if the default get_buffer() is used.
2406 * - encoding: Set by user.
2407 * - decoding: Set by user.
4ee6a5c1 2408 */
b1edfce0 2409 int thread_safe_callbacks;
580a7465
DC
2410
2411 /**
b1edfce0
AK
2412 * The codec may call this to execute several independent things.
2413 * It will return only after finishing all tasks.
2414 * The user may replace this with some multithreaded implementation,
2415 * the default implementation will execute the parts serially.
2416 * @param count the number of things to execute
2417 * - encoding: Set by libavcodec, user can override.
2418 * - decoding: Set by libavcodec, user can override.
580a7465 2419 */
b1edfce0 2420 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
8d23a86f
RD
2421
2422 /**
2423 * The codec may call this to execute several independent things.
2424 * It will return only after finishing all tasks.
2425 * The user may replace this with some multithreaded implementation,
2426 * the default implementation will execute the parts serially.
2427 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2428 * @param c context passed also to func
2429 * @param count the number of things to execute
2430 * @param arg2 argument passed unchanged to func
2431 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2432 * @param func function that will be called count times, with jobnr from 0 to count-1.
2433 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2434 * two instances of func executing at the same time will have the same threadnr.
2435 * @return always 0 currently, but code should handle a future improvement where when any call to func
2436 * returns < 0 no further calls to func may be done and < 0 is returned.
2437 * - encoding: Set by libavcodec, user can override.
2438 * - decoding: Set by libavcodec, user can override.
2439 */
2440 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
096c87f6 2441
2aa72ecc 2442 /**
41ed7ab4 2443 * noise vs. sse weight for the nsse comparison function
b1edfce0 2444 * - encoding: Set by user.
2aa72ecc
JZ
2445 * - decoding: unused
2446 */
b1edfce0 2447 int nsse_weight;
cb2c971d
AJ
2448
2449 /**
b1edfce0
AK
2450 * profile
2451 * - encoding: Set by user.
2452 * - decoding: Set by libavcodec.
cb2c971d 2453 */
b1edfce0
AK
2454 int profile;
2455#define FF_PROFILE_UNKNOWN -99
2456#define FF_PROFILE_RESERVED -100
2457
2458#define FF_PROFILE_AAC_MAIN 0
2459#define FF_PROFILE_AAC_LOW 1
2460#define FF_PROFILE_AAC_SSR 2
2461#define FF_PROFILE_AAC_LTP 3
372597e5
MS
2462#define FF_PROFILE_AAC_HE 4
2463#define FF_PROFILE_AAC_HE_V2 28
2464#define FF_PROFILE_AAC_LD 22
2465#define FF_PROFILE_AAC_ELD 38
95d52464
KK
2466#define FF_PROFILE_MPEG2_AAC_LOW 128
2467#define FF_PROFILE_MPEG2_AAC_HE 131
b1edfce0
AK
2468
2469#define FF_PROFILE_DTS 20
2470#define FF_PROFILE_DTS_ES 30
2471#define FF_PROFILE_DTS_96_24 40
2472#define FF_PROFILE_DTS_HD_HRA 50
2473#define FF_PROFILE_DTS_HD_MA 60
6fe2641d 2474#define FF_PROFILE_DTS_EXPRESS 70
b1edfce0
AK
2475
2476#define FF_PROFILE_MPEG2_422 0
2477#define FF_PROFILE_MPEG2_HIGH 1
2478#define FF_PROFILE_MPEG2_SS 2
2479#define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2480#define FF_PROFILE_MPEG2_MAIN 4
2481#define FF_PROFILE_MPEG2_SIMPLE 5
2482
2483#define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2484#define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2485
2486#define FF_PROFILE_H264_BASELINE 66
2487#define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2488#define FF_PROFILE_H264_MAIN 77
2489#define FF_PROFILE_H264_EXTENDED 88
2490#define FF_PROFILE_H264_HIGH 100
2491#define FF_PROFILE_H264_HIGH_10 110
2492#define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
90f469aa 2493#define FF_PROFILE_H264_MULTIVIEW_HIGH 118
b1edfce0
AK
2494#define FF_PROFILE_H264_HIGH_422 122
2495#define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
90f469aa 2496#define FF_PROFILE_H264_STEREO_HIGH 128
b1edfce0
AK
2497#define FF_PROFILE_H264_HIGH_444 144
2498#define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2499#define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2500#define FF_PROFILE_H264_CAVLC_444 44
2501
2502#define FF_PROFILE_VC1_SIMPLE 0
2503#define FF_PROFILE_VC1_MAIN 1
2504#define FF_PROFILE_VC1_COMPLEX 2
2505#define FF_PROFILE_VC1_ADVANCED 3
2506
2507#define FF_PROFILE_MPEG4_SIMPLE 0
2508#define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2509#define FF_PROFILE_MPEG4_CORE 2
2510#define FF_PROFILE_MPEG4_MAIN 3
2511#define FF_PROFILE_MPEG4_N_BIT 4
2512#define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2513#define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2514#define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2515#define FF_PROFILE_MPEG4_HYBRID 8
2516#define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2517#define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2518#define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2519#define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2520#define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2521#define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2522#define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
393cbb96 2523
ad61da05
FC
2524#define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2525#define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2526#define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
c81a7063
NB
2527#define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2528#define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2529
8655c541
LB
2530#define FF_PROFILE_VP9_0 0
2531#define FF_PROFILE_VP9_1 1
2532#define FF_PROFILE_VP9_2 2
2533#define FF_PROFILE_VP9_3 3
2a41826b
GC
2534
2535#define FF_PROFILE_HEVC_MAIN 1
2536#define FF_PROFILE_HEVC_MAIN_10 2
2537#define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
de64dd13 2538#define FF_PROFILE_HEVC_REXT 4
2a41826b 2539
393cbb96 2540 /**
b1edfce0
AK
2541 * level
2542 * - encoding: Set by user.
2543 * - decoding: Set by libavcodec.
393cbb96 2544 */
b1edfce0
AK
2545 int level;
2546#define FF_LEVEL_UNKNOWN -99
37b00b47 2547
37b00b47 2548 /**
b1edfce0
AK
2549 * - encoding: unused
2550 * - decoding: Set by user.
37b00b47 2551 */
b1edfce0 2552 enum AVDiscard skip_loop_filter;
37b00b47
AS
2553
2554 /**
b1edfce0
AK
2555 * - encoding: unused
2556 * - decoding: Set by user.
37b00b47 2557 */
b1edfce0 2558 enum AVDiscard skip_idct;
37b00b47
AS
2559
2560 /**
b1edfce0 2561 * - encoding: unused
37b00b47
AS
2562 * - decoding: Set by user.
2563 */
b1edfce0 2564 enum AVDiscard skip_frame;
55bad0c6
CM
2565
2566 /**
b1edfce0
AK
2567 * Header containing style information for text subtitles.
2568 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2569 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2570 * the Format line following. It shouldn't include any Dialogue line.
2571 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2572 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
55bad0c6 2573 */
b1edfce0
AK
2574 uint8_t *subtitle_header;
2575 int subtitle_header_size;
34b47d7c 2576
2507b5dd 2577#if FF_API_VBV_DELAY
f3a29b75 2578 /**
b1edfce0
AK
2579 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2580 * Used for compliant TS muxing.
2581 * - encoding: Set by libavcodec.
2582 * - decoding: unused.
2507b5dd
AK
2583 * @deprecated this value is now exported as a part of
2584 * AV_PKT_DATA_CPB_PROPERTIES packet side data
4bf3c8f2 2585 */
2507b5dd 2586 attribute_deprecated
b1edfce0 2587 uint64_t vbv_delay;
2507b5dd 2588#endif
0957b274 2589
6064f697 2590#if FF_API_SIDEDATA_ONLY_PKT
0957b274 2591 /**
6064f697
VG
2592 * Encoding only and set by default. Allow encoders to output packets
2593 * that do not contain any encoded data, only side data.
0957b274
AK
2594 *
2595 * Some encoders need to output such packets, e.g. to update some stream
2596 * parameters at the end of encoding.
2597 *
6064f697
VG
2598 * @deprecated this field disables the default behaviour and
2599 * it is kept only for compatibility.
0957b274 2600 */
6064f697 2601 attribute_deprecated
0957b274 2602 int side_data_only_packets;
6064f697 2603#endif
2df0c32e
AK
2604
2605 /**
2606 * Audio only. The number of "priming" samples (padding) inserted by the
2607 * encoder at the beginning of the audio. I.e. this number of leading
2608 * decoded samples must be discarded by the caller to get the original audio
2609 * without leading padding.
2610 *
2611 * - decoding: unused
2612 * - encoding: Set by libavcodec. The timestamps on the output packets are
2613 * adjusted by the encoder so that they always refer to the
2614 * first sample of the data actually contained in the packet,
2615 * including any added padding. E.g. if the timebase is
2616 * 1/samplerate and the timestamp of the first input sample is
2617 * 0, the timestamp of the first output packet will be
2618 * -initial_padding.
2619 */
2620 int initial_padding;
7ea1b347
AK
2621
2622 /*
2623 * - decoding: For codecs that store a framerate value in the compressed
2624 * bitstream, the decoder may export it here. { 0, 1} when
2625 * unknown.
9d4d9be5
MS
2626 * - encoding: May be used to signal the framerate of CFR content to an
2627 * encoder.
7ea1b347
AK
2628 */
2629 AVRational framerate;
57b6704e
RDC
2630
2631 /**
2632 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2633 * - encoding: unused.
2634 * - decoding: Set by libavcodec before calling get_format()
2635 */
2636 enum AVPixelFormat sw_pix_fmt;
84adab33
AK
2637
2638 /**
2639 * Additional data associated with the entire coded stream.
2640 *
2641 * - decoding: unused
2642 * - encoding: may be set by libavcodec after avcodec_open2().
2643 */
2644 AVPacketSideData *coded_side_data;
2645 int nb_coded_side_data;
2646
7b3214d0 2647 /**
e85f6f7f
AK
2648 * A reference to the AVHWFramesContext describing the input (for encoding)
2649 * or output (decoding) frames. The reference is set by the caller and
44f2eda3
MT
2650 * afterwards owned (and freed) by libavcodec - it should never be read by
2651 * the caller after being set.
7b3214d0 2652 *
e85f6f7f
AK
2653 * - decoding: This field should be set by the caller from the get_format()
2654 * callback. The previous reference (if any) will always be
2655 * unreffed by libavcodec before the get_format() call.
7b3214d0 2656 *
e85f6f7f
AK
2657 * If the default get_buffer2() is used with a hwaccel pixel
2658 * format, then this AVHWFramesContext will be used for
2659 * allocating the frame buffers.
2660 *
2661 * - encoding: For hardware encoders configured to use a hwaccel pixel
2662 * format, this field should be set by the caller to a reference
2663 * to the AVHWFramesContext describing input frames.
2664 * AVHWFramesContext.format must be equal to
2665 * AVCodecContext.pix_fmt.
2666 *
2667 * This field should be set before avcodec_open2() is called.
7b3214d0
AK
2668 */
2669 AVBufferRef *hw_frames_ctx;
019ab88a
AK
2670
2671 /**
2672 * Video decoding only. Certain video codecs support cropping, meaning that
2673 * only a sub-rectangle of the decoded frame is intended for display. This
2674 * option controls how cropping is handled by libavcodec.
2675 *
2676 * When set to 1 (the default), libavcodec will apply cropping internally.
2677 * I.e. it will modify the output frame width/height fields and offset the
2678 * data pointers (only by as much as possible while preserving alignment, or
2679 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
2680 * the frames output by the decoder refer only to the cropped area. The
2681 * crop_* fields of the output frames will be zero.
2682 *
2683 * When set to 0, the width/height fields of the output frames will be set
2684 * to the coded dimensions and the crop_* fields will describe the cropping
2685 * rectangle. Applying the cropping is left to the caller.
2686 *
2687 * @warning When hardware acceleration with opaque output frames is used,
2688 * libavcodec is unable to apply cropping from the top/left border.
2689 *
2690 * @note when this option is set to zero, the width/height fields of the
2691 * AVCodecContext and output AVFrames have different meanings. The codec
2692 * context fields store display dimensions (with the coded dimensions in
2693 * coded_width/height), while the frame fields store the coded dimensions
2694 * (with the display dimensions being determined by the crop_* fields).
2695 */
2696 int apply_cropping;
44f2eda3
MT
2697
2698 /**
2699 * A reference to the AVHWDeviceContext describing the device which will
2700 * be used by a hardware encoder/decoder. The reference is set by the
2701 * caller and afterwards owned (and freed) by libavcodec.
2702 *
2703 * This should be used if either the codec device does not require
2704 * hardware frames or any that are used are to be allocated internally by
2705 * libavcodec. If the user wishes to supply any of the frames used as
2706 * encoder input or decoder output then hw_frames_ctx should be used
2707 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
2708 * field will be ignored while decoding the associated stream segment, but
2709 * may again be used on a following one after another get_format() call.
2710 *
2711 * For both encoders and decoders this field should be set before
2712 * avcodec_open2() is called and must not be written to thereafter.
2713 *
2714 * Note that some decoders may require this field to be set initially in
2715 * order to support hw_frames_ctx at all - in that case, all frames
2716 * contexts used must be created on the same device.
2717 */
2718 AVBufferRef *hw_device_ctx;
16a163b5 2719
2720 /**
2721 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
2722 * decoding (if active).
2723 * - encoding: unused
2724 * - decoding: Set by user (either before avcodec_open2(), or in the
2725 * AVCodecContext.get_format callback)
2726 */
2727 int hwaccel_flags;
de6d9b64
FB
2728} AVCodecContext;
2729
64863965 2730/**
060ec0a8
AH
2731 * AVProfile.
2732 */
2733typedef struct AVProfile {
2734 int profile;
2735 const char *name; ///< short name for the profile
2736} AVProfile;
2737
84626b36
AK
2738typedef struct AVCodecDefault AVCodecDefault;
2739
466b39ef
AK
2740struct AVSubtitle;
2741
060ec0a8 2742/**
64863965
MN
2743 * AVCodec.
2744 */
de6d9b64 2745typedef struct AVCodec {
6b0cdb6e
NG
2746 /**
2747 * Name of the codec implementation.
2748 * The name is globally unique among encoders and among decoders (but an
2749 * encoder and a decoder can share the same name).
2750 * This is the primary way to find a codec from the user perspective.
2751 */
18f77016 2752 const char *name;
f5f49a66
AK
2753 /**
2754 * Descriptive name for the codec, meant to be more human readable than name.
2755 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2756 */
2757 const char *long_name;
72415b2a 2758 enum AVMediaType type;
36ef5369 2759 enum AVCodecID id;
a2d11246
MN
2760 /**
2761 * Codec capabilities.
def97856 2762 * see AV_CODEC_CAP_*
a2d11246 2763 */
bf89e6b1 2764 int capabilities;
716e31ea 2765 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
716d413c 2766 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3ade5d56 2767 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
5d6e4c16 2768 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
cc276c85 2769 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
567ad0e3 2770 const AVClass *priv_class; ///< AVClass for the private context
060ec0a8 2771 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
37b00b47 2772
f5f49a66
AK
2773 /*****************************************************************
2774 * No fields below this line are part of the public API. They
2775 * may not be used outside of libavcodec and can be changed and
2776 * removed at will.
2777 * New public fields should be added right above.
2778 *****************************************************************
2779 */
2780 int priv_data_size;
2781 struct AVCodec *next;
37b00b47 2782 /**
21a19b79 2783 * @name Frame-level threading support functions
37b00b47
AS
2784 * @{
2785 */
2786 /**
2787 * If defined, called on thread contexts when they are created.
2788 * If the codec allocates writable tables in init(), re-allocate them here.
2789 * priv_data will be set to a copy of the original.
2790 */
2791 int (*init_thread_copy)(AVCodecContext *);
2792 /**
2793 * Copy necessary context variables from a previous thread context to the current one.
2794 * If not defined, the next thread will start automatically; otherwise, the codec
2795 * must call ff_thread_finish_setup().
2796 *
2797 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2798 */
2799 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2800 /** @} */
84626b36
AK
2801
2802 /**
2803 * Private codec-specific defaults.
2804 */
2805 const AVCodecDefault *defaults;
d97efd7f
AK
2806
2807 /**
2808 * Initialize codec static data, called from avcodec_register().
2809 */
2810 void (*init_static_data)(struct AVCodec *codec);
b2c75b6e 2811
f5f49a66 2812 int (*init)(AVCodecContext *);
466b39ef
AK
2813 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2814 const struct AVSubtitle *sub);
b2c75b6e
JR
2815 /**
2816 * Encode data to an AVPacket.
2817 *
2818 * @param avctx codec context
2819 * @param avpkt output AVPacket (may contain a user-provided buffer)
2820 * @param[in] frame AVFrame containing the raw data to be encoded
2821 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2822 * non-empty packet was returned in avpkt.
2823 * @return 0 on success, negative error code on failure
2824 */
2825 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2826 int *got_packet_ptr);
f5f49a66
AK
2827 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2828 int (*close)(AVCodecContext *);
2829 /**
061a0c14 2830 * Encode API with decoupled packet/frame dataflow. The API is the
05f66706 2831 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
2832 * that:
2833 * - never called if the codec is closed or the wrong type,
061a0c14
AK
2834 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
2835 * - only one drain frame is ever passed down,
05f66706 2836 */
2837 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
05f66706 2838 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
061a0c14
AK
2839
2840 /**
2841 * Decode API with decoupled packet/frame dataflow. This function is called
2842 * to get one output frame. It should call ff_decode_get_packet() to obtain
2843 * input data.
2844 */
2845 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
05f66706 2846 /**
f5f49a66
AK
2847 * Flush buffers.
2848 * Will be called when seeking
2849 */
2850 void (*flush)(AVCodecContext *);
117b4327
VG
2851 /**
2852 * Internal codec capabilities.
2853 * See FF_CODEC_CAP_* in internal.h
2854 */
2855 int caps_internal;
972c71e9
AK
2856
2857 /**
2858 * Decoding only, a comma-separated list of bitstream filters to apply to
2859 * packets before decoding.
2860 */
2861 const char *bsfs;
de6d9b64
FB
2862} AVCodec;
2863
97d96aaa 2864/**
d565fef1
RDC
2865 * @defgroup lavc_hwaccel AVHWAccel
2866 * @{
40e5d31b
GB
2867 */
2868typedef struct AVHWAccel {
2869 /**
2870 * Name of the hardware accelerated codec.
2871 * The name is globally unique among encoders and among decoders (but an
2872 * encoder and a decoder can share the same name).
2873 */
2874 const char *name;
2875
2876 /**
2877 * Type of codec implemented by the hardware accelerator.
2878 *
72415b2a 2879 * See AVMEDIA_TYPE_xxx
40e5d31b 2880 */
72415b2a 2881 enum AVMediaType type;
40e5d31b
GB
2882
2883 /**
2884 * Codec implemented by the hardware accelerator.
2885 *
36ef5369 2886 * See AV_CODEC_ID_xxx
40e5d31b 2887 */
36ef5369 2888 enum AVCodecID id;
40e5d31b
GB
2889
2890 /**
2891 * Supported pixel format.
2892 *
2893 * Only hardware accelerated formats are supported here.
2894 */
716d413c 2895 enum AVPixelFormat pix_fmt;
40e5d31b
GB
2896
2897 /**
2898 * Hardware accelerated codec capabilities.
2899 * see FF_HWACCEL_CODEC_CAP_*
2900 */
2901 int capabilities;
2902
08bb2567
AK
2903 /*****************************************************************
2904 * No fields below this line are part of the public API. They
2905 * may not be used outside of libavcodec and can be changed and
2906 * removed at will.
2907 * New public fields should be added right above.
2908 *****************************************************************
2909 */
40e5d31b
GB
2910 struct AVHWAccel *next;
2911
2912 /**
ebc29519
LB
2913 * Allocate a custom buffer
2914 */
2915 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
2916
2917 /**
40e5d31b
GB
2918 * Called at the beginning of each frame or field picture.
2919 *
2920 * Meaningful frame information (codec specific) is guaranteed to
2921 * be parsed at this point. This function is mandatory.
2922 *
bf7e799c 2923 * Note that buf can be NULL along with buf_size set to 0.
40e5d31b
GB
2924 * Otherwise, this means the whole frame is available at this point.
2925 *
2926 * @param avctx the codec context
2927 * @param buf the frame data buffer base
2928 * @param buf_size the size of the frame in bytes
2929 * @return zero if successful, a negative value otherwise
2930 */
2931 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2932
2933 /**
2934 * Callback for each slice.
2935 *
2936 * Meaningful slice information (codec specific) is guaranteed to
2937 * be parsed at this point. This function is mandatory.
2938 *
2939 * @param avctx the codec context
2940 * @param buf the slice data buffer base
2941 * @param buf_size the size of the slice in bytes
2942 * @return zero if successful, a negative value otherwise
2943 */
2944 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2945
2946 /**
2947 * Called at the end of each frame or field picture.
2948 *
2949 * The whole picture is parsed at this point and can now be sent
2950 * to the hardware accelerator. This function is mandatory.
2951 *
2952 * @param avctx the codec context
2953 * @return zero if successful, a negative value otherwise
2954 */
2955 int (*end_frame)(AVCodecContext *avctx);
68e5d523
GB
2956
2957 /**
a871ef0c 2958 * Size of per-frame hardware accelerator private data.
68e5d523 2959 *
cd823ff9
GB
2960 * Private data is allocated with av_mallocz() before
2961 * AVCodecContext.get_buffer() and deallocated after
2962 * AVCodecContext.release_buffer().
68e5d523 2963 */
a871ef0c 2964 int frame_priv_data_size;
dd2d3b76
AK
2965
2966 /**
2967 * Initialize the hwaccel private data.
2968 *
2969 * This will be called from ff_get_format(), after hwaccel and
2970 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
2971 * is allocated.
2972 */
2973 int (*init)(AVCodecContext *avctx);
2974
2975 /**
2976 * Uninitialize the hwaccel private data.
2977 *
2978 * This will be called from get_format() or avcodec_close(), after hwaccel
2979 * and hwaccel_context are already uninitialized.
2980 */
2981 int (*uninit)(AVCodecContext *avctx);
2982
2983 /**
2984 * Size of the private data to allocate in
2985 * AVCodecInternal.hwaccel_priv_data.
2986 */
2987 int priv_data_size;
d4a91e65
AK
2988
2989 /**
2990 * Internal hwaccel capabilities.
2991 */
2992 int caps_internal;
40e5d31b
GB
2993} AVHWAccel;
2994
2995/**
d565fef1
RDC
2996 * Hardware acceleration should be used for decoding even if the codec level
2997 * used is unknown or higher than the maximum supported level reported by the
2998 * hardware driver.
2999 */
3000#define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3001
3002/**
6c99c92a
RDC
3003 * Hardware acceleration can output YUV pixel formats with a different chroma
3004 * sampling than 4:2:0 and/or other than 8 bits per component.
3005 */
3006#define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3007
3008/**
64a5260c
MT
3009 * Hardware acceleration should still be attempted for decoding when the
3010 * codec profile does not match the reported capabilities of the hardware.
3011 *
3012 * For example, this can be used to try to decode baseline profile H.264
3013 * streams in hardware - it will often succeed, because many streams marked
3014 * as baseline profile actually conform to constrained baseline profile.
3015 *
3016 * @warning If the stream is actually not supported then the behaviour is
3017 * undefined, and may include returning entirely incorrect output
3018 * while indicating success.
3019 */
3020#define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3021
3022/**
d565fef1
RDC
3023 * @}
3024 */
3025
dca23ffb 3026#if FF_API_AVPICTURE
d565fef1 3027/**
6aadfbda
AK
3028 * @defgroup lavc_picture AVPicture
3029 *
3030 * Functions for working with AVPicture
3031 * @{
3032 */
3033
3034/**
d7425f59
MN
3035 * four components are given, that's all.
3036 * the last component is alpha
f3aff31e 3037 * @deprecated Use the imgutils functions
d7425f59 3038 */
de6d9b64 3039typedef struct AVPicture {
f3aff31e 3040 attribute_deprecated
560f773c 3041 uint8_t *data[AV_NUM_DATA_POINTERS];
f3aff31e 3042 attribute_deprecated
560f773c 3043 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
de6d9b64
FB
3044} AVPicture;
3045
6aadfbda
AK
3046/**
3047 * @}
3048 */
dca23ffb 3049#endif
6aadfbda 3050
63e4c8a6
AK
3051#define AVPALETTE_SIZE 1024
3052#define AVPALETTE_COUNT 256
ba118447 3053
c66216ed
MN
3054enum AVSubtitleType {
3055 SUBTITLE_NONE,
3056
3057 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3058
3059 /**
3060 * Plain text, the text field must be set by the decoder and is
3061 * authoritative. ass and pict fields may contain approximations.
3062 */
3063 SUBTITLE_TEXT,
3064
3065 /**
3066 * Formatted text, the ass field must be set by the decoder and is
3067 * authoritative. pict and text fields may contain approximations.
3068 */
3069 SUBTITLE_ASS,
3070};
3071
85f67c48
JS
3072#define AV_SUBTITLE_FLAG_FORCED 0x00000001
3073
c6ec28b1 3074typedef struct AVSubtitleRect {
ebc466bb
MN
3075 int x; ///< top left corner of pict, undefined when pict is not set
3076 int y; ///< top left corner of pict, undefined when pict is not set
3077 int w; ///< width of pict, undefined when pict is not set
3078 int h; ///< height of pict, undefined when pict is not set
3079 int nb_colors; ///< number of colors in pict, undefined when pict is not set
25b4c651 3080
a17a7661 3081#if FF_API_AVPICTURE
25b4c651 3082 /**
a17a7661 3083 * @deprecated unused
25b4c651 3084 */
a17a7661 3085 attribute_deprecated
25b4c651 3086 AVPicture pict;
a17a7661
VG
3087#endif
3088 /**
3089 * data+linesize for the bitmap of this subtitle.
3090 * Can be set for text/ass as well once they are rendered.
3091 */
3092 uint8_t *data[4];
3093 int linesize[4];
3094
f656106f
MN
3095 enum AVSubtitleType type;
3096
3097 char *text; ///< 0 terminated plain UTF-8 text
3098
3099 /**
3100 * 0 terminated ASS/SSA compatible event line.
41ed7ab4 3101 * The presentation of this is unaffected by the other values in this
f656106f
MN
3102 * struct.
3103 */
3104 char *ass;
85f67c48 3105 int flags;
c6ec28b1
MN
3106} AVSubtitleRect;
3107
3108typedef struct AVSubtitle {
3109 uint16_t format; /* 0 = graphics */
3110 uint32_t start_display_time; /* relative to packet pts, in ms */
3111 uint32_t end_display_time; /* relative to packet pts, in ms */
ebc466bb 3112 unsigned num_rects;
db4fac64 3113 AVSubtitleRect **rects;
4bbe788a 3114 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
240c1657
FB
3115} AVSubtitle;
3116
294b3a50 3117/**
998e1b8f
AK
3118 * This struct describes the properties of an encoded stream.
3119 *
3120 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3121 * be allocated with avcodec_parameters_alloc() and freed with
3122 * avcodec_parameters_free().
3123 */
3124typedef struct AVCodecParameters {
3125 /**
3126 * General type of the encoded data.
3127 */
3128 enum AVMediaType codec_type;
3129 /**
3130 * Specific type of the encoded data (the codec used).
3131 */
3132 enum AVCodecID codec_id;
3133 /**
3134 * Additional information about the codec (corresponds to the AVI FOURCC).
3135 */
3136 uint32_t codec_tag;
3137
3138 /**
3139 * Extra binary data needed for initializing the decoder, codec-dependent.
3140 *
3141 * Must be allocated with av_malloc() and will be freed by
3142 * avcodec_parameters_free(). The allocated size of extradata must be at
3143 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3144 * bytes zeroed.
3145 */
3146 uint8_t *extradata;
3147 /**
3148 * Size of the extradata content in bytes.
3149 */
3150 int extradata_size;
3151
3152 /**
3153 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3154 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3155 */
3156 int format;
3157
3158 /**
3159 * The average bitrate of the encoded data (in bits per second).
3160 */
3161 int bit_rate;
3162
3163 int bits_per_coded_sample;
3164
3165 /**
3166 * Codec-specific bitstream restrictions that the stream conforms to.
3167 */
3168 int profile;
3169 int level;
3170
3171 /**
3172 * Video only. The dimensions of the video frame in pixels.
3173 */
3174 int width;
3175 int height;
3176
3177 /**
3178 * Video only. The aspect ratio (width / height) which a single pixel
3179 * should have when displayed.
3180 *
3181 * When the aspect ratio is unknown / undefined, the numerator should be
3182 * set to 0 (the denominator may have any value).
3183 */
3184 AVRational sample_aspect_ratio;
3185
3186 /**
3187 * Video only. The order of the fields in interlaced video.
3188 */
3189 enum AVFieldOrder field_order;
3190
3191 /**
3192 * Video only. Additional colorspace characteristics.
3193 */
3194 enum AVColorRange color_range;
3195 enum AVColorPrimaries color_primaries;
3196 enum AVColorTransferCharacteristic color_trc;
3197 enum AVColorSpace color_space;
3198 enum AVChromaLocation chroma_location;
3199
3200 /**
3201 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3202 * unknown or unspecified, otherwise the number of bits set must be equal to
3203 * the channels field.
3204 */
3205 uint64_t channel_layout;
3206 /**
3207 * Audio only. The number of audio channels.
3208 */
3209 int channels;
3210 /**
3211 * Audio only. The number of audio samples per second.
3212 */
3213 int sample_rate;
3214 /**
3215 * Audio only. The number of bytes per coded audio frame, required by some
3216 * formats.
3217 *
3218 * Corresponds to nBlockAlign in WAVEFORMATEX.
3219 */
3220 int block_align;
3221
3222 /**
3223 * Audio only. The amount of padding (in samples) inserted by the encoder at
3224 * the beginning of the audio. I.e. this number of leading decoded samples
3225 * must be discarded by the caller to get the original audio without leading
3226 * padding.
3227 */
3228 int initial_padding;
3229 /**
3230 * Audio only. The amount of padding (in samples) appended by the encoder to
3231 * the end of the audio. I.e. this number of decoded samples must be
3232 * discarded by the caller from the end of the stream to get the original
3233 * audio without any trailing padding.
3234 */
3235 int trailing_padding;
3236} AVCodecParameters;
3237
3238/**
294b3a50
AK
3239 * If c is NULL, returns the first registered codec,
3240 * if c is non-NULL, returns the next registered codec after c,
3241 * or NULL if c is the last one.
3242 */
0a0f19b5 3243AVCodec *av_codec_next(const AVCodec *c);
294b3a50
AK
3244
3245/**
3246 * Return the LIBAVCODEC_VERSION_INT constant.
3247 */
3248unsigned avcodec_version(void);
3249
3250/**
3251 * Return the libavcodec build-time configuration.
3252 */
3253const char *avcodec_configuration(void);
3254
3255/**
3256 * Return the libavcodec license.
3257 */
3258const char *avcodec_license(void);
3259
3260/**
3261 * Register the codec codec and initialize libavcodec.
3262 *
3263 * @warning either this function or avcodec_register_all() must be called
3264 * before any other libavcodec functions.
3265 *
3266 * @see avcodec_register_all()
3267 */
3268void avcodec_register(AVCodec *codec);
3269
3270/**
3271 * Register all the codecs, parsers and bitstream filters which were enabled at
3272 * configuration time. If you do not call this function you can select exactly
3273 * which formats you want to support, by using the individual registration
3274 * functions.
3275 *
3276 * @see avcodec_register
3277 * @see av_register_codec_parser
3278 * @see av_register_bitstream_filter
3279 */
3280void avcodec_register_all(void);
3281
3282/**
fd056029
AK
3283 * Allocate an AVCodecContext and set its fields to default values. The
3284 * resulting struct should be freed with avcodec_free_context().
294b3a50
AK
3285 *
3286 * @param codec if non-NULL, allocate private data and initialize defaults
3287 * for the given codec. It is illegal to then call avcodec_open2()
3288 * with a different codec.
3289 * If NULL, then the codec-specific defaults won't be initialized,
3290 * which may result in suboptimal default settings (this is
3291 * important mainly for encoders, e.g. libx264).
3292 *
3293 * @return An AVCodecContext filled with default values or NULL on failure.
294b3a50 3294 */
0a0f19b5 3295AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
294b3a50
AK
3296
3297/**
fd056029
AK
3298 * Free the codec context and everything associated with it and write NULL to
3299 * the provided pointer.
3300 */
3301void avcodec_free_context(AVCodecContext **avctx);
3302
04fc8e24 3303#if FF_API_GET_CONTEXT_DEFAULTS
fd056029 3304/**
04fc8e24
AK
3305 * @deprecated This function should not be used, as closing and opening a codec
3306 * context multiple time is not supported. A new codec context should be
3307 * allocated for each new use.
294b3a50 3308 */
0a0f19b5 3309int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
04fc8e24 3310#endif
294b3a50
AK
3311
3312/**
3313 * Get the AVClass for AVCodecContext. It can be used in combination with
3314 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3315 *
3316 * @see av_opt_find().
3317 */
3318const AVClass *avcodec_get_class(void);
3319
5f30ac27 3320#if FF_API_COPY_CONTEXT
294b3a50
AK
3321/**
3322 * Copy the settings of the source AVCodecContext into the destination
3323 * AVCodecContext. The resulting destination codec context will be
3324 * unopened, i.e. you are required to call avcodec_open2() before you
3325 * can use this AVCodecContext to decode/encode video/audio data.
3326 *
3327 * @param dest target codec context, should be initialized with
3328 * avcodec_alloc_context3(), but otherwise uninitialized
3329 * @param src source codec context
3330 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
5f30ac27
AK
3331 *
3332 * @deprecated The semantics of this function are ill-defined and it should not
3333 * be used. If you need to transfer the stream parameters from one codec context
3334 * to another, use an intermediate AVCodecParameters instance and the
3335 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
3336 * functions.
294b3a50 3337 */
5f30ac27 3338attribute_deprecated
294b3a50 3339int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
5f30ac27 3340#endif
294b3a50 3341
a42aadab 3342/**
998e1b8f
AK
3343 * Allocate a new AVCodecParameters and set its fields to default values
3344 * (unknown/invalid/0). The returned struct must be freed with
3345 * avcodec_parameters_free().
3346 */
3347AVCodecParameters *avcodec_parameters_alloc(void);
3348
3349/**
3350 * Free an AVCodecParameters instance and everything associated with it and
3351 * write NULL to the supplied pointer.
3352 */
3353void avcodec_parameters_free(AVCodecParameters **par);
3354
3355/**
3356 * Copy the contents of src to dst. Any allocated fields in dst are freed and
3357 * replaced with newly allocated duplicates of the corresponding fields in src.
3358 *
3359 * @return >= 0 on success, a negative AVERROR code on failure.
3360 */
3361int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
3362
3363/**
3364 * Fill the parameters struct based on the values from the supplied codec
3365 * context. Any allocated fields in par are freed and replaced with duplicates
3366 * of the corresponding fields in codec.
3367 *
3368 * @return >= 0 on success, a negative AVERROR code on failure
3369 */
3370int avcodec_parameters_from_context(AVCodecParameters *par,
3371 const AVCodecContext *codec);
3372
3373/**
3374 * Fill the codec context based on the values from the supplied codec
3375 * parameters. Any allocated fields in codec that have a corresponding field in
3376 * par are freed and replaced with duplicates of the corresponding field in par.
3377 * Fields in codec that do not have a counterpart in par are not touched.
3378 *
3379 * @return >= 0 on success, a negative AVERROR code on failure.
3380 */
3381int avcodec_parameters_to_context(AVCodecContext *codec,
3382 const AVCodecParameters *par);
3383
3384/**
294b3a50
AK
3385 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3386 * function the context has to be allocated with avcodec_alloc_context3().
3387 *
3388 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3389 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3390 * retrieving a codec.
3391 *
3392 * @warning This function is not thread safe!
3393 *
cb70a93c 3394 * @note Always call this function before using decoding routines (such as
05f66706 3395 * @ref avcodec_receive_frame()).
cb70a93c 3396 *
294b3a50
AK
3397 * @code