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