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