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