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