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