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