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