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