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