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