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