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