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