Clarify ref_index.
[libav.git] / libavcodec / avcodec.h
CommitLineData
04d7f601
DB
1/*
2 * copyright (c) 2001 Fabrice Bellard
3 *
b78e7197
DB
4 * This file is part of FFmpeg.
5 *
6 * FFmpeg 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 *
b78e7197 11 * FFmpeg 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
b78e7197 17 * License along with FFmpeg; 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/**
bad5537e 25 * @file libavcodec/avcodec.h
f5bccd85 26 * external API header
36df8805
MN
27 */
28
c60208e7 29#include <errno.h>
76a448ed 30#include "libavutil/avutil.h"
de6d9b64 31
dd1c8f3e 32#define LIBAVCODEC_VERSION_MAJOR 52
342c7dfd 33#define LIBAVCODEC_VERSION_MINOR 55
5aea268d 34#define LIBAVCODEC_VERSION_MICRO 0
e97ac1e6 35
800c289a
MR
36#define LIBAVCODEC_VERSION_INT AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
37 LIBAVCODEC_VERSION_MINOR, \
38 LIBAVCODEC_VERSION_MICRO)
39#define LIBAVCODEC_VERSION AV_VERSION(LIBAVCODEC_VERSION_MAJOR, \
40 LIBAVCODEC_VERSION_MINOR, \
41 LIBAVCODEC_VERSION_MICRO)
bb270c08 42#define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT
5aa083ee 43
bb270c08 44#define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
ce2749d2 45
8da9266c 46#define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
bb270c08
DB
47#define AV_TIME_BASE 1000000
48#define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
9740beff 49
7ebf5927 50/**
6b0cdb6e
NG
51 * Identifies the syntax and semantics of the bitstream.
52 * The principle is roughly:
53 * Two decoders with the same ID can decode the same streams.
54 * Two encoders with the same ID can encode compatible streams.
55 * There may be slight deviations from the principle due to implementation
56 * details.
7ebf5927 57 *
f5bccd85
DB
58 * If you add a codec ID to this list, add it so that
59 * 1. no value of a existing codec ID changes (that would break ABI),
60 * 2. it is as close as possible to similar codecs.
7ebf5927 61 */
de6d9b64 62enum CodecID {
115329f1 63 CODEC_ID_NONE,
ba0dabbf
DB
64
65 /* video codecs */
de6d9b64 66 CODEC_ID_MPEG1VIDEO,
0e373b95 67 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
fb364ada 68 CODEC_ID_MPEG2VIDEO_XVMC,
c6148de2 69 CODEC_ID_H261,
de6d9b64
FB
70 CODEC_ID_H263,
71 CODEC_ID_RV10,
68b94c35 72 CODEC_ID_RV20,
de6d9b64 73 CODEC_ID_MJPEG,
b135d9fb 74 CODEC_ID_MJPEGB,
b1e6b355 75 CODEC_ID_LJPEG,
5e83dec4 76 CODEC_ID_SP5X,
5639729b 77 CODEC_ID_JPEGLS,
bf89e6b1 78 CODEC_ID_MPEG4,
de6d9b64 79 CODEC_ID_RAWVIDEO,
84afee34
MN
80 CODEC_ID_MSMPEG4V1,
81 CODEC_ID_MSMPEG4V2,
82 CODEC_ID_MSMPEG4V3,
e1a9dbff 83 CODEC_ID_WMV1,
b50eef3a 84 CODEC_ID_WMV2,
de6d9b64
FB
85 CODEC_ID_H263P,
86 CODEC_ID_H263I,
d4f5d74a 87 CODEC_ID_FLV1,
be8ffec9 88 CODEC_ID_SVQ1,
8b82a956 89 CODEC_ID_SVQ3,
020fcc94 90 CODEC_ID_DVVIDEO,
11f18faf 91 CODEC_ID_HUFFYUV,
f70f7c6d 92 CODEC_ID_CYUV,
0da71265 93 CODEC_ID_H264,
deabd4fd 94 CODEC_ID_INDEO3,
d86053a4 95 CODEC_ID_VP3,
f44ee2c3 96 CODEC_ID_THEORA,
3d2e8cce 97 CODEC_ID_ASV1,
9b56edf5 98 CODEC_ID_ASV2,
5e20f836 99 CODEC_ID_FFV1,
e2a7bb28 100 CODEC_ID_4XM,
be3564ed 101 CODEC_ID_VCR1,
3aff069b 102 CODEC_ID_CLJR,
c3bf0288 103 CODEC_ID_MDEC,
3ef8be2b
MM
104 CODEC_ID_ROQ,
105 CODEC_ID_INTERPLAY_VIDEO,
9937e686
MM
106 CODEC_ID_XAN_WC3,
107 CODEC_ID_XAN_WC4,
2fdf638b
MM
108 CODEC_ID_RPZA,
109 CODEC_ID_CINEPAK,
110 CODEC_ID_WS_VQA,
111 CODEC_ID_MSRLE,
112 CODEC_ID_MSVIDEO1,
4120a53a 113 CODEC_ID_IDCIN,
1dc1ed99 114 CODEC_ID_8BPS,
11e29a41 115 CODEC_ID_SMC,
42cad81a 116 CODEC_ID_FLIC,
9a4117d5 117 CODEC_ID_TRUEMOTION1,
fafa0b75 118 CODEC_ID_VMDVIDEO,
a273bbfb
RT
119 CODEC_ID_MSZH,
120 CODEC_ID_ZLIB,
070ed1bc 121 CODEC_ID_QTRLE,
791e7b83 122 CODEC_ID_SNOW,
9d53d58e 123 CODEC_ID_TSCC,
d0a0bbd2 124 CODEC_ID_ULTI,
d08d7142 125 CODEC_ID_QDRAW,
ab711b3c 126 CODEC_ID_VIXL,
acfd8f0f 127 CODEC_ID_QPEG,
17179d2d
MN
128 CODEC_ID_XVID,
129 CODEC_ID_PNG,
130 CODEC_ID_PPM,
131 CODEC_ID_PBM,
132 CODEC_ID_PGM,
133 CODEC_ID_PGMYUV,
134 CODEC_ID_PAM,
f37b9768 135 CODEC_ID_FFVHUFF,
3f05305d
MN
136 CODEC_ID_RV30,
137 CODEC_ID_RV40,
10b9c374 138 CODEC_ID_VC1,
21aa398f 139 CODEC_ID_WMV3,
9c7fb608 140 CODEC_ID_LOCO,
a8a15e9d 141 CODEC_ID_WNV1,
589f8220 142 CODEC_ID_AASC,
856dbbff 143 CODEC_ID_INDEO2,
b81f8949 144 CODEC_ID_FRAPS,
64af6168 145 CODEC_ID_TRUEMOTION2,
9fa62f2a 146 CODEC_ID_BMP,
e0f80bd7 147 CODEC_ID_CSCD,
4e114829 148 CODEC_ID_MMVIDEO,
9c8d8e84 149 CODEC_ID_ZMBV,
26376701 150 CODEC_ID_AVS,
348efc18 151 CODEC_ID_SMACKVIDEO,
dfca23e3 152 CODEC_ID_NUV,
fd7b1991 153 CODEC_ID_KMVC,
0919e788 154 CODEC_ID_FLASHSV,
20ffddb9 155 CODEC_ID_CAVS,
f31065f6 156 CODEC_ID_JPEG2000,
eb57c889 157 CODEC_ID_VMNC,
5ce117c3
AJ
158 CODEC_ID_VP5,
159 CODEC_ID_VP6,
160 CODEC_ID_VP6F,
3689cf16 161 CODEC_ID_TARGA,
72450e50 162 CODEC_ID_DSICINVIDEO,
29f86228 163 CODEC_ID_TIERTEXSEQVIDEO,
a991b1fe 164 CODEC_ID_TIFF,
06d392a7 165 CODEC_ID_GIF,
3edeab82 166 CODEC_ID_FFH264,
33a0dd37 167 CODEC_ID_DXA,
52b6bad2 168 CODEC_ID_DNXHD,
efb0c399 169 CODEC_ID_THP,
2d99eed1 170 CODEC_ID_SGI,
9a0ddd09 171 CODEC_ID_C93,
1e6c6759 172 CODEC_ID_BETHSOFTVID,
b46d68c6 173 CODEC_ID_PTX,
1ca779e7 174 CODEC_ID_TXD,
91fc2cf1 175 CODEC_ID_VP6A,
8787d837 176 CODEC_ID_AMV,
66f7679c 177 CODEC_ID_VB,
b4abe1d1 178 CODEC_ID_PCX,
d43df959 179 CODEC_ID_SUNRAST,
800b9c24
BL
180 CODEC_ID_INDEO4,
181 CODEC_ID_INDEO5,
a7129de5 182 CODEC_ID_MIMIC,
975cdc8f 183 CODEC_ID_RL2,
cb21e0a7
JM
184 CODEC_ID_8SVX_EXP,
185 CODEC_ID_8SVX_FIB,
40d26273 186 CODEC_ID_ESCAPE124,
782a58ec 187 CODEC_ID_DIRAC,
b64c096b 188 CODEC_ID_BFI,
495900f7 189 CODEC_ID_CMV,
974e0eee 190 CODEC_ID_MOTIONPIXELS,
cfc78718 191 CODEC_ID_TGV,
42b30357 192 CODEC_ID_TGQ,
d8964f3a 193 CODEC_ID_TQI,
c21fbefb
KS
194 CODEC_ID_AURA,
195 CODEC_ID_AURA2,
97f92143 196 CODEC_ID_V210X,
a1fd2bc3 197 CODEC_ID_TMV,
ca0bb1c4 198 CODEC_ID_V210,
94d3d6a4 199 CODEC_ID_DPX,
c63ea92b 200 CODEC_ID_MAD,
d8b35b85 201 CODEC_ID_FRWU,
0aa6a518 202 CODEC_ID_FLASHSV2,
a3d995c1 203 CODEC_ID_CDGRAPHICS,
4aaab0a3 204 CODEC_ID_R210,
a1ae40fd 205 CODEC_ID_ANM,
4e5f42dd 206 CODEC_ID_BINKVIDEO,
b9e06ddd
PR
207 CODEC_ID_IFF_ILBM,
208 CODEC_ID_IFF_BYTERUN1,
a96b68b7 209
f5bccd85 210 /* various PCM "codecs" */
17179d2d 211 CODEC_ID_PCM_S16LE= 0x10000,
a96b68b7
FB
212 CODEC_ID_PCM_S16BE,
213 CODEC_ID_PCM_U16LE,
214 CODEC_ID_PCM_U16BE,
215 CODEC_ID_PCM_S8,
216 CODEC_ID_PCM_U8,
217 CODEC_ID_PCM_MULAW,
218 CODEC_ID_PCM_ALAW,
b461b3bc
RD
219 CODEC_ID_PCM_S32LE,
220 CODEC_ID_PCM_S32BE,
221 CODEC_ID_PCM_U32LE,
222 CODEC_ID_PCM_U32BE,
223 CODEC_ID_PCM_S24LE,
224 CODEC_ID_PCM_S24BE,
225 CODEC_ID_PCM_U24LE,
226 CODEC_ID_PCM_U24BE,
227 CODEC_ID_PCM_S24DAUD,
a11c2a2c 228 CODEC_ID_PCM_ZORK,
725d86bf 229 CODEC_ID_PCM_S16LE_PLANAR,
1472b7dd 230 CODEC_ID_PCM_DVD,
aa29709e 231 CODEC_ID_PCM_F32BE,
143a5d6f
PR
232 CODEC_ID_PCM_F32LE,
233 CODEC_ID_PCM_F64BE,
234 CODEC_ID_PCM_F64LE,
5dd3707b 235 CODEC_ID_PCM_BLURAY,
0147f198 236
f5bccd85 237 /* various ADPCM codecs */
17179d2d 238 CODEC_ID_ADPCM_IMA_QT= 0x11000,
0147f198 239 CODEC_ID_ADPCM_IMA_WAV,
9937e686
MM
240 CODEC_ID_ADPCM_IMA_DK3,
241 CODEC_ID_ADPCM_IMA_DK4,
2fdf638b 242 CODEC_ID_ADPCM_IMA_WS,
7d8379f2 243 CODEC_ID_ADPCM_IMA_SMJPEG,
0147f198 244 CODEC_ID_ADPCM_MS,
e2a7bb28 245 CODEC_ID_ADPCM_4XM,
fc384777
MM
246 CODEC_ID_ADPCM_XA,
247 CODEC_ID_ADPCM_ADX,
7d8379f2 248 CODEC_ID_ADPCM_EA,
e5966052 249 CODEC_ID_ADPCM_G726,
b3bfb299 250 CODEC_ID_ADPCM_CT,
659c3692 251 CODEC_ID_ADPCM_SWF,
2ff4524e 252 CODEC_ID_ADPCM_YAMAHA,
2433f24f
AJ
253 CODEC_ID_ADPCM_SBPRO_4,
254 CODEC_ID_ADPCM_SBPRO_3,
255 CODEC_ID_ADPCM_SBPRO_2,
d1e0d21f 256 CODEC_ID_ADPCM_THP,
3a7f5d07 257 CODEC_ID_ADPCM_IMA_AMV,
e7583962
PR
258 CODEC_ID_ADPCM_EA_R1,
259 CODEC_ID_ADPCM_EA_R3,
260 CODEC_ID_ADPCM_EA_R2,
7bb65d89 261 CODEC_ID_ADPCM_IMA_EA_SEAD,
fac84d3c 262 CODEC_ID_ADPCM_IMA_EA_EACS,
271b4095 263 CODEC_ID_ADPCM_EA_XAS,
861c63a2 264 CODEC_ID_ADPCM_EA_MAXIS_XA,
055dc116 265 CODEC_ID_ADPCM_IMA_ISS,
891f64b3 266
17179d2d
MN
267 /* AMR */
268 CODEC_ID_AMR_NB= 0x12000,
d663a1fd
MN
269 CODEC_ID_AMR_WB,
270
b8414bbd 271 /* RealAudio codecs*/
17179d2d 272 CODEC_ID_RA_144= 0x13000,
b8414bbd 273 CODEC_ID_RA_288,
3ef8be2b
MM
274
275 /* various DPCM codecs */
17179d2d 276 CODEC_ID_ROQ_DPCM= 0x14000,
3ef8be2b 277 CODEC_ID_INTERPLAY_DPCM,
9937e686 278 CODEC_ID_XAN_DPCM,
d08d7142 279 CODEC_ID_SOL_DPCM,
115329f1 280
ba0dabbf 281 /* audio codecs */
17179d2d 282 CODEC_ID_MP2= 0x15000,
0e373b95 283 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
17179d2d 284 CODEC_ID_AAC,
17179d2d
MN
285 CODEC_ID_AC3,
286 CODEC_ID_DTS,
287 CODEC_ID_VORBIS,
288 CODEC_ID_DVAUDIO,
289 CODEC_ID_WMAV1,
290 CODEC_ID_WMAV2,
291 CODEC_ID_MACE3,
292 CODEC_ID_MACE6,
293 CODEC_ID_VMDAUDIO,
294 CODEC_ID_SONIC,
295 CODEC_ID_SONIC_LS,
ac2570a8 296 CODEC_ID_FLAC,
1ede228a 297 CODEC_ID_MP3ADU,
d2a7718d 298 CODEC_ID_MP3ON4,
85ad5695 299 CODEC_ID_SHORTEN,
5df8a0c6 300 CODEC_ID_ALAC,
034eeaa1 301 CODEC_ID_WESTWOOD_SND1,
0e373b95 302 CODEC_ID_GSM, ///< as in Berlin toast format
d9b1c197 303 CODEC_ID_QDM2,
e0f7e329 304 CODEC_ID_COOK,
bf3027c8 305 CODEC_ID_TRUESPEECH,
a24c4a2a 306 CODEC_ID_TTA,
348efc18 307 CODEC_ID_SMACKAUDIO,
6c496518 308 CODEC_ID_QCELP,
730581f3 309 CODEC_ID_WAVPACK,
72450e50 310 CODEC_ID_DSICINAUDIO,
84ed36da 311 CODEC_ID_IMC,
185c7b6b 312 CODEC_ID_MUSEPACK7,
aad512b4 313 CODEC_ID_MLP,
f5bccd85 314 CODEC_ID_GSM_MS, /* as found in WAV */
10e26bc7 315 CODEC_ID_ATRAC3,
8950f828 316 CODEC_ID_VOXWARE,
bf4a1f17 317 CODEC_ID_APE,
636b13c5 318 CODEC_ID_NELLYMOSER,
12877faf 319 CODEC_ID_MUSEPACK8,
cb4ddf77 320 CODEC_ID_SPEEX,
7bb8d51c
BL
321 CODEC_ID_WMAVOICE,
322 CODEC_ID_WMAPRO,
800b9c24 323 CODEC_ID_WMALOSSLESS,
b339f0c6 324 CODEC_ID_ATRAC3P,
2988c93d 325 CODEC_ID_EAC3,
faeedbbb 326 CODEC_ID_SIPR,
7f507b2d 327 CODEC_ID_MP1,
616e899c 328 CODEC_ID_TWINVQ,
9ba4821d 329 CODEC_ID_TRUEHD,
b24bbbb4 330 CODEC_ID_MP4ALS,
223e8df1 331 CODEC_ID_ATRAC1,
4e5f42dd
DV
332 CODEC_ID_BINKAUDIO_RDFT,
333 CODEC_ID_BINKAUDIO_DCT,
115329f1 334
240c1657 335 /* subtitle codecs */
115329f1
DB
336 CODEC_ID_DVD_SUBTITLE= 0x17000,
337 CODEC_ID_DVB_SUBTITLE,
0e373b95 338 CODEC_ID_TEXT, ///< raw UTF-8 text
7e2643ae 339 CODEC_ID_XSUB,
f9a9b350 340 CODEC_ID_SSA,
cc8c2c6a 341 CODEC_ID_MOV_TEXT,
c58b82a2 342 CODEC_ID_HDMV_PGS_SUBTITLE,
e58992e4 343 CODEC_ID_DVB_TELETEXT,
115329f1 344
7ce68923 345 /* other specific kind of codecs (generally used for attachments) */
f8d7c9d3
ES
346 CODEC_ID_TTF= 0x18000,
347
0bef08e5
MN
348 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
349
0e373b95 350 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
f5bccd85 351 * stream (only used by libavformat) */
de6d9b64 352};
dcedf586 353
de6d9b64 354enum CodecType {
4a663d80 355 CODEC_TYPE_UNKNOWN = -1,
de6d9b64
FB
356 CODEC_TYPE_VIDEO,
357 CODEC_TYPE_AUDIO,
985180a1 358 CODEC_TYPE_DATA,
240c1657 359 CODEC_TYPE_SUBTITLE,
f8d7c9d3 360 CODEC_TYPE_ATTACHMENT,
9ff77d17 361 CODEC_TYPE_NB
de6d9b64
FB
362};
363
0e373b95 364/**
0e373b95
MN
365 * all in native-endian format
366 */
a96b68b7 367enum SampleFormat {
9076fee4 368 SAMPLE_FMT_NONE = -1,
1319a77b
AB
369 SAMPLE_FMT_U8, ///< unsigned 8 bits
370 SAMPLE_FMT_S16, ///< signed 16 bits
115329f1 371 SAMPLE_FMT_S32, ///< signed 32 bits
a3a5f4d6 372 SAMPLE_FMT_FLT, ///< float
e06b00f3 373 SAMPLE_FMT_DBL, ///< double
88a07af7 374 SAMPLE_FMT_NB ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
a96b68b7
FB
375};
376
0d72e7d0 377/* Audio channel masks */
9d9b9d32
378#define CH_FRONT_LEFT 0x00000001
379#define CH_FRONT_RIGHT 0x00000002
380#define CH_FRONT_CENTER 0x00000004
381#define CH_LOW_FREQUENCY 0x00000008
382#define CH_BACK_LEFT 0x00000010
383#define CH_BACK_RIGHT 0x00000020
384#define CH_FRONT_LEFT_OF_CENTER 0x00000040
385#define CH_FRONT_RIGHT_OF_CENTER 0x00000080
386#define CH_BACK_CENTER 0x00000100
387#define CH_SIDE_LEFT 0x00000200
388#define CH_SIDE_RIGHT 0x00000400
389#define CH_TOP_CENTER 0x00000800
390#define CH_TOP_FRONT_LEFT 0x00001000
391#define CH_TOP_FRONT_CENTER 0x00002000
392#define CH_TOP_FRONT_RIGHT 0x00004000
393#define CH_TOP_BACK_LEFT 0x00008000
394#define CH_TOP_BACK_CENTER 0x00010000
395#define CH_TOP_BACK_RIGHT 0x00020000
396#define CH_STEREO_LEFT 0x20000000 ///< Stereo downmix.
397#define CH_STEREO_RIGHT 0x40000000 ///< See CH_STEREO_LEFT.
0d72e7d0 398
31557166
JR
399/** Channel mask value used for AVCodecContext.request_channel_layout
400 to indicate that the user requests the channel order of the decoder output
401 to be the native codec channel order. */
402#define CH_LAYOUT_NATIVE 0x8000000000000000LL
403
0d72e7d0 404/* Audio channel convenience macros */
9d9b9d32
405#define CH_LAYOUT_MONO (CH_FRONT_CENTER)
406#define CH_LAYOUT_STEREO (CH_FRONT_LEFT|CH_FRONT_RIGHT)
1b7bc4a2 407#define CH_LAYOUT_2_1 (CH_LAYOUT_STEREO|CH_BACK_CENTER)
9d9b9d32 408#define CH_LAYOUT_SURROUND (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
1b7bc4a2
JR
409#define CH_LAYOUT_4POINT0 (CH_LAYOUT_SURROUND|CH_BACK_CENTER)
410#define CH_LAYOUT_2_2 (CH_LAYOUT_STEREO|CH_SIDE_LEFT|CH_SIDE_RIGHT)
9d9b9d32
411#define CH_LAYOUT_QUAD (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
412#define CH_LAYOUT_5POINT0 (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
413#define CH_LAYOUT_5POINT1 (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
8613af0a
JR
414#define CH_LAYOUT_5POINT0_BACK (CH_LAYOUT_SURROUND|CH_BACK_LEFT|CH_BACK_RIGHT)
415#define CH_LAYOUT_5POINT1_BACK (CH_LAYOUT_5POINT0_BACK|CH_LOW_FREQUENCY)
5dd3707b 416#define CH_LAYOUT_7POINT0 (CH_LAYOUT_5POINT0|CH_BACK_LEFT|CH_BACK_RIGHT)
9d9b9d32 417#define CH_LAYOUT_7POINT1 (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
8613af0a 418#define CH_LAYOUT_7POINT1_WIDE (CH_LAYOUT_5POINT1_BACK|\
9d9b9d32
419 CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
420#define CH_LAYOUT_STEREO_DOWNMIX (CH_STEREO_LEFT|CH_STEREO_RIGHT)
0d72e7d0 421
de6d9b64 422/* in bytes */
8170e5fb 423#define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
de6d9b64 424
d7425f59 425/**
cf713bb8 426 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
f5bccd85
DB
427 * This is mainly needed because some optimized bitstream readers read
428 * 32 or 64 bit at once and could read over the end.<br>
429 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
430 * MPEG bitstreams could cause overread and segfault.
d7425f59
MN
431 */
432#define FF_INPUT_BUFFER_PADDING_SIZE 8
433
0ecca7a4 434/**
f5bccd85
DB
435 * minimum encoding buffer size
436 * Used to avoid some checks during header writing.
0ecca7a4
MN
437 */
438#define FF_MIN_BUFFER_SIZE 16384
439
47146dfb 440
0e373b95 441/**
bafc102b 442 * motion estimation type.
0e373b95 443 */
e4986da9 444enum Motion_Est_ID {
9b4dd1b8 445 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
e4986da9
J
446 ME_FULL,
447 ME_LOG,
448 ME_PHODS,
9b4dd1b8
MN
449 ME_EPZS, ///< enhanced predictive zonal search
450 ME_X1, ///< reserved for experiments
451 ME_HEX, ///< hexagon based search
452 ME_UMH, ///< uneven multi-hexagon search
453 ME_ITER, ///< iterative search
359bbdab 454 ME_TESA, ///< transformed exhaustive search algorithm
e4986da9
J
455};
456
8c3eba7c 457enum AVDiscard{
f5bccd85
DB
458 /* We leave some space between them for extensions (drop some
459 * keyframes for intra-only or drop just some bidir frames). */
8c3eba7c
MN
460 AVDISCARD_NONE =-16, ///< discard nothing
461 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
462 AVDISCARD_NONREF = 8, ///< discard all non reference
463 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
464 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
465 AVDISCARD_ALL = 48, ///< discard all
466};
467
4ee6a5c1
MN
468enum AVColorPrimaries{
469 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
470 AVCOL_PRI_UNSPECIFIED=2,
471 AVCOL_PRI_BT470M =4,
472 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
473 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
474 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
475 AVCOL_PRI_FILM =8,
476 AVCOL_PRI_NB , ///< Not part of ABI
477};
478
479enum AVColorTransferCharacteristic{
480 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
481 AVCOL_TRC_UNSPECIFIED=2,
482 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
483 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
484 AVCOL_TRC_NB , ///< Not part of ABI
485};
486
487enum AVColorSpace{
488 AVCOL_SPC_RGB =0,
489 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
490 AVCOL_SPC_UNSPECIFIED=2,
491 AVCOL_SPC_FCC =4,
492 AVCOL_SPC_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
493 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
494 AVCOL_SPC_SMPTE240M =7,
495 AVCOL_SPC_NB , ///< Not part of ABI
496};
497
498enum AVColorRange{
499 AVCOL_RANGE_UNSPECIFIED=0,
500 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
501 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
502 AVCOL_RANGE_NB , ///< Not part of ABI
503};
504
580a7465
DC
505/**
506 * X X 3 4 X X are luma samples,
507 * 1 2 1-6 are possible chroma positions
508 * X X 5 6 X 0 is undefined/unknown position
509 */
510enum AVChromaLocation{
511 AVCHROMA_LOC_UNSPECIFIED=0,
512 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
513 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
514 AVCHROMA_LOC_TOPLEFT =3, ///< DV
515 AVCHROMA_LOC_TOP =4,
516 AVCHROMA_LOC_BOTTOMLEFT =5,
517 AVCHROMA_LOC_BOTTOM =6,
518 AVCHROMA_LOC_NB , ///< Not part of ABI
519};
520
ce980a95
MN
521typedef struct RcOverride{
522 int start_frame;
523 int end_frame;
f5bccd85 524 int qscale; // If this is 0 then quality_factor will be used instead.
ce980a95
MN
525 float quality_factor;
526} RcOverride;
527
b0ec9efd 528#define FF_MAX_B_FRAMES 16
9dbcbd92 529
a949d72e 530/* encoding support
f5bccd85
DB
531 These flags can be passed in AVCodecContext.flags before initialization.
532 Note: Not everything is supported yet.
a949d72e 533*/
de6d9b64 534
f5bccd85
DB
535#define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
536#define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
537#define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
538#define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
539#define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
540#define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
1ba8f5eb
MN
541/**
542 * The parent program guarantees that the input for B-frames containing
f5bccd85 543 * streams is not written to for at least s->max_b_frames+1 frames, if
1ba8f5eb
MN
544 * this is not set the input will be copied.
545 */
8b4c7dbc 546#define CODEC_FLAG_INPUT_PRESERVED 0x0100
273b0cd3
DB
547#define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
548#define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
549#define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
550#define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
551#define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
552#define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
553#define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
554 location instead of only at frame boundaries. */
f5bccd85
DB
555#define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
556#define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
557#define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
558#define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
f5bccd85
DB
559#define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
560#define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
21e59552 561/* Fx : Flag for h263+ extra options */
f5bccd85
DB
562#define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
563#define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
564#define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
565#define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
566#define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
332f9ac4
MN
567#define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
568#define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
bb198e19
MN
569#define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
570#define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
f5bccd85 571#define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
f3eec1cf 572#define CODEC_FLAG_CLOSED_GOP 0x80000000
f5bccd85
DB
573#define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
574#define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
575#define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
576#define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
577#define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
578#define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
d3075ed5 579#define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
58f7833e
RS
580#define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
581#define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
582#define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
f5bccd85
DB
583#define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
584#define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
585#define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
586#define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
587#define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
588#define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
589#define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
f1618fd9 590#define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
25a42948 591#define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
6fc5b059 592
21e59552 593/* Unsupported options :
bb270c08
DB
594 * Syntax Arithmetic coding (SAC)
595 * Reference Picture Selection
eafcac6a 596 * Independent Segment Decoding */
21e59552 597/* /Fx */
bf89e6b1
FB
598/* codec capabilities */
599
f5bccd85 600#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
6814a25c
MN
601/**
602 * Codec uses get_buffer() for allocating buffers.
603 * direct rendering method 1
604 */
605#define CODEC_CAP_DR1 0x0002
f5bccd85 606/* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
917e06c8 607#define CODEC_CAP_PARSE_ONLY 0x0004
d7425f59 608#define CODEC_CAP_TRUNCATED 0x0008
f5bccd85 609/* Codec can export data for HW decoding (XvMC). */
5e5c247a 610#define CODEC_CAP_HWACCEL 0x0010
115329f1 611/**
f5bccd85
DB
612 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
613 * If this is not set, the codec is guaranteed to never be fed with NULL data.
934982c4 614 */
6f824977 615#define CODEC_CAP_DELAY 0x0020
cef7cc72
JR
616/**
617 * Codec can be fed a final frame with a smaller size.
618 * This can be used to prevent truncation of the last audio samples.
619 */
620#define CODEC_CAP_SMALL_LAST_FRAME 0x0040
369122dd
NC
621/**
622 * Codec can export data for HW decoding (VDPAU).
623 */
624#define CODEC_CAP_HWACCEL_VDPAU 0x0080
d859bb1d
SS
625/**
626 * Codec can output multiple frames per AVPacket
e9e949cf
MN
627 * Normally demuxers return one frame at a time, demuxers which do not do
628 * are connected to a parser to split what they return into proper frames.
629 * This flag is reserved to the very rare category of codecs which have a
630 * bitstream that cannot be split into frames without timeconsuming
631 * operations like full decoding. Demuxers carring such bitstreams thus
632 * may return multiple frames in a packet. This has many disadvantages like
633 * prohibiting stream copy in many cases thus it should only be considered
634 * as a last resort.
d859bb1d
SS
635 */
636#define CODEC_CAP_SUBFRAMES 0x0100
bf89e6b1 637
f5bccd85 638//The following defines may change, don't expect compatibility if you use them.
8d7ec294 639#define MB_TYPE_INTRA4x4 0x0001
f5bccd85
DB
640#define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
641#define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
8d7ec294
WH
642#define MB_TYPE_16x16 0x0008
643#define MB_TYPE_16x8 0x0010
644#define MB_TYPE_8x16 0x0020
645#define MB_TYPE_8x8 0x0040
646#define MB_TYPE_INTERLACED 0x0080
273b0cd3 647#define MB_TYPE_DIRECT2 0x0100 //FIXME
8d7ec294
WH
648#define MB_TYPE_ACPRED 0x0200
649#define MB_TYPE_GMC 0x0400
650#define MB_TYPE_SKIP 0x0800
651#define MB_TYPE_P0L0 0x1000
652#define MB_TYPE_P1L0 0x2000
653#define MB_TYPE_P0L1 0x4000
654#define MB_TYPE_P1L1 0x8000
655#define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
656#define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
657#define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
658#define MB_TYPE_QUANT 0x00010000
659#define MB_TYPE_CBP 0x00020000
660//Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
661
fa384dcc
MN
662/**
663 * Pan Scan area.
f5bccd85
DB
664 * This specifies the area which should be displayed.
665 * Note there may be multiple such areas for one frame.
fa384dcc
MN
666 */
667typedef struct AVPanScan{
668 /**
f5bccd85
DB
669 * id
670 * - encoding: Set by user.
671 * - decoding: Set by libavcodec.
fa384dcc
MN
672 */
673 int id;
674
675 /**
676 * width and height in 1/16 pel
f5bccd85
DB
677 * - encoding: Set by user.
678 * - decoding: Set by libavcodec.
fa384dcc
MN
679 */
680 int width;
681 int height;
682
683 /**
f5bccd85
DB
684 * position of the top left corner in 1/16 pel for up to 3 fields/frames
685 * - encoding: Set by user.
686 * - decoding: Set by libavcodec.
fa384dcc
MN
687 */
688 int16_t position[3][2];
689}AVPanScan;
690
492cd3a9 691#define FF_COMMON_FRAME \
b536d0aa
MN
692 /**\
693 * pointer to the picture planes.\
f5bccd85 694 * This might be different from the first allocated byte\
b536d0aa
MN
695 * - encoding: \
696 * - decoding: \
697 */\
1e491e29
MN
698 uint8_t *data[4];\
699 int linesize[4];\
700 /**\
f5bccd85
DB
701 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
702 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
64863965
MN
703 * - encoding: \
704 * - decoding: \
1e491e29
MN
705 */\
706 uint8_t *base[4];\
707 /**\
708 * 1 -> keyframe, 0-> not\
f5bccd85
DB
709 * - encoding: Set by libavcodec.\
710 * - decoding: Set by libavcodec.\
1e491e29
MN
711 */\
712 int key_frame;\
713\
714 /**\
f5bccd85
DB
715 * Picture type of the frame, see ?_TYPE below.\
716 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
717 * - decoding: Set by libavcodec.\
1e491e29
MN
718 */\
719 int pict_type;\
720\
721 /**\
c0df9d75 722 * presentation timestamp in time_base units (time when frame should be shown to user)\
f5bccd85
DB
723 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
724 * - encoding: MUST be set by user.\
725 * - decoding: Set by libavcodec.\
1e491e29 726 */\
be6784dc 727 int64_t pts;\
1e491e29
MN
728\
729 /**\
f5bccd85 730 * picture number in bitstream order\
64863965 731 * - encoding: set by\
f5bccd85 732 * - decoding: Set by libavcodec.\
1e491e29
MN
733 */\
734 int coded_picture_number;\
735 /**\
f5bccd85 736 * picture number in display order\
64863965 737 * - encoding: set by\
f5bccd85 738 * - decoding: Set by libavcodec.\
1e491e29
MN
739 */\
740 int display_picture_number;\
741\
742 /**\
158c7f05 743 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
f5bccd85
DB
744 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
745 * - decoding: Set by libavcodec.\
1e491e29 746 */\
158c7f05 747 int quality; \
1e491e29
MN
748\
749 /**\
750 * buffer age (1->was last buffer and dint change, 2->..., ...).\
f5bccd85 751 * Set to INT_MAX if the buffer has not been used yet.\
64863965 752 * - encoding: unused\
f5bccd85 753 * - decoding: MUST be set by get_buffer().\
1e491e29
MN
754 */\
755 int age;\
756\
757 /**\
758 * is this picture used as reference\
8474f58e
MN
759 * The values for this are the same as the MpegEncContext.picture_structure\
760 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
5fe2a515 761 * Set to 4 for delayed, non-reference frames.\
64863965 762 * - encoding: unused\
f5bccd85 763 * - decoding: Set by libavcodec. (before get_buffer() call)).\
1e491e29
MN
764 */\
765 int reference;\
766\
767 /**\
768 * QP table\
64863965 769 * - encoding: unused\
f5bccd85 770 * - decoding: Set by libavcodec.\
1e491e29
MN
771 */\
772 int8_t *qscale_table;\
773 /**\
774 * QP store stride\
64863965 775 * - encoding: unused\
f5bccd85 776 * - decoding: Set by libavcodec.\
1e491e29
MN
777 */\
778 int qstride;\
779\
780 /**\
f5bccd85 781 * mbskip_table[mb]>=1 if MB didn't change\
1e491e29 782 * stride= mb_width = (width+15)>>4\
64863965 783 * - encoding: unused\
f5bccd85 784 * - decoding: Set by libavcodec.\
1e491e29
MN
785 */\
786 uint8_t *mbskip_table;\
787\
788 /**\
f5bccd85 789 * motion vector table\
61436073
MN
790 * @code\
791 * example:\
792 * int mv_sample_log2= 4 - motion_subsample_log2;\
793 * int mb_width= (width+15)>>4;\
794 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
795 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
796 * @endcode\
f5bccd85
DB
797 * - encoding: Set by user.\
798 * - decoding: Set by libavcodec.\
8d7ec294
WH
799 */\
800 int16_t (*motion_val[2])[2];\
801\
802 /**\
f5bccd85 803 * macroblock type table\
8d7ec294 804 * mb_type_base + mb_width + 2\
f5bccd85
DB
805 * - encoding: Set by user.\
806 * - decoding: Set by libavcodec.\
8d7ec294
WH
807 */\
808 uint32_t *mb_type;\
809\
810 /**\
f0b77c69
MN
811 * log2 of the size of the block which a single vector in motion_val represents: \
812 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
8d7ec294 813 * - encoding: unused\
f5bccd85 814 * - decoding: Set by libavcodec.\
8d7ec294
WH
815 */\
816 uint8_t motion_subsample_log2;\
817\
818 /**\
1e491e29 819 * for some private data of the user\
64863965 820 * - encoding: unused\
f5bccd85 821 * - decoding: Set by user.\
1e491e29
MN
822 */\
823 void *opaque;\
140cb663
MN
824\
825 /**\
826 * error\
f5bccd85 827 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
64863965 828 * - decoding: unused\
140cb663
MN
829 */\
830 uint64_t error[4];\
4e00e76b
MN
831\
832 /**\
f5bccd85
DB
833 * type of the buffer (to keep track of who has to deallocate data[*])\
834 * - encoding: Set by the one who allocates it.\
835 * - decoding: Set by the one who allocates it.\
836 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
4e00e76b
MN
837 */\
838 int type;\
2ec23b6d
MN
839 \
840 /**\
f5bccd85 841 * When decoding, this signals how much the picture must be delayed.\
2ec23b6d 842 * extra_delay = repeat_pict / (2*fps)\
64863965 843 * - encoding: unused\
f5bccd85 844 * - decoding: Set by libavcodec.\
2ec23b6d 845 */\
0426af31
MN
846 int repeat_pict;\
847 \
848 /**\
849 * \
850 */\
851 int qscale_type;\
2744ca9a
RS
852 \
853 /**\
854 * The content of the picture is interlaced.\
f5bccd85
DB
855 * - encoding: Set by user.\
856 * - decoding: Set by libavcodec. (default 0)\
2744ca9a
RS
857 */\
858 int interlaced_frame;\
859 \
860 /**\
f5bccd85
DB
861 * If the content is interlaced, is top field displayed first.\
862 * - encoding: Set by user.\
863 * - decoding: Set by libavcodec.\
2744ca9a 864 */\
9dad924e 865 int top_field_first;\
fa384dcc
MN
866 \
867 /**\
868 * Pan scan.\
f5bccd85
DB
869 * - encoding: Set by user.\
870 * - decoding: Set by libavcodec.\
fa384dcc
MN
871 */\
872 AVPanScan *pan_scan;\
2a2bbcb0
MM
873 \
874 /**\
f5bccd85 875 * Tell user application that palette has changed from previous frame.\
2a2bbcb0 876 * - encoding: ??? (no palette-enabled encoder yet)\
f5bccd85 877 * - decoding: Set by libavcodec. (default 0).\
2a2bbcb0
MM
878 */\
879 int palette_has_changed;\
074c4ca7
RT
880 \
881 /**\
f5bccd85 882 * codec suggestion on buffer type if != 0\
074c4ca7 883 * - encoding: unused\
f5bccd85 884 * - decoding: Set by libavcodec. (before get_buffer() call)).\
074c4ca7
RT
885 */\
886 int buffer_hints;\
8289c6fa
WH
887\
888 /**\
f5bccd85 889 * DCT coefficients\
8289c6fa 890 * - encoding: unused\
f5bccd85 891 * - decoding: Set by libavcodec.\
8289c6fa
WH
892 */\
893 short *dct_coeff;\
a4d36c11
MN
894\
895 /**\
f5bccd85 896 * motion referece frame index\
f57a5dcd 897 * the order in which these are stored can depends on the codec.\
f5bccd85
DB
898 * - encoding: Set by user.\
899 * - decoding: Set by libavcodec.\
a4d36c11 900 */\
79de84f2
MN
901 int8_t *ref_index[2];\
902\
903 /**\
904 * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
905 * output in AVFrame.reordered_opaque\
906 * - encoding: unused\
907 * - decoding: Read by user.\
908 */\
909 int64_t reordered_opaque;\
68e5d523
GB
910\
911 /**\
912 * hardware accelerator private data (FFmpeg allocated)\
913 * - encoding: unused\
914 * - decoding: Set by libavcodec\
915 */\
952e2083 916 void *hwaccel_picture_private;\
79de84f2 917
2ec23b6d 918
bb270c08
DB
919#define FF_QSCALE_TYPE_MPEG1 0
920#define FF_QSCALE_TYPE_MPEG2 1
921#define FF_QSCALE_TYPE_H264 2
800274f8 922#define FF_QSCALE_TYPE_VP56 3
4e00e76b
MN
923
924#define FF_BUFFER_TYPE_INTERNAL 1
f5bccd85
DB
925#define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
926#define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
927#define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
4e00e76b 928
1e491e29 929
dc85e859
AJ
930#define FF_I_TYPE 1 ///< Intra
931#define FF_P_TYPE 2 ///< Predicted
932#define FF_B_TYPE 3 ///< Bi-dir predicted
933#define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
934#define FF_SI_TYPE 5 ///< Switching Intra
935#define FF_SP_TYPE 6 ///< Switching Predicted
48d533e6 936#define FF_BI_TYPE 7
1e491e29 937
f5bccd85
DB
938#define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
939#define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
940#define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
941#define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
074c4ca7 942
18c915ee
TB
943typedef struct AVPacket {
944 /**
7b356d39
RS
945 * Presentation timestamp in AVStream->time_base units; the time at which
946 * the decompressed packet will be presented to the user.
18c915ee
TB
947 * Can be AV_NOPTS_VALUE if it is not stored in the file.
948 * pts MUST be larger or equal to dts as presentation cannot happen before
949 * decompression, unless one wants to view hex dumps. Some formats misuse
950 * the terms dts and pts/cts to mean something different. Such timestamps
951 * must be converted to true pts/dts before they are stored in AVPacket.
952 */
953 int64_t pts;
954 /**
7b356d39
RS
955 * Decompression timestamp in AVStream->time_base units; the time at which
956 * the packet is decompressed.
18c915ee
TB
957 * Can be AV_NOPTS_VALUE if it is not stored in the file.
958 */
959 int64_t dts;
960 uint8_t *data;
961 int size;
962 int stream_index;
963 int flags;
964 /**
7b356d39 965 * Duration of this packet in AVStream->time_base units, 0 if unknown.
18c915ee
TB
966 * Equals next_pts - this_pts in presentation order.
967 */
968 int duration;
969 void (*destruct)(struct AVPacket *);
970 void *priv;
971 int64_t pos; ///< byte position in stream, -1 if unknown
972
973 /**
7b356d39 974 * Time difference in AVStream->time_base units from the pts of this
18c915ee
TB
975 * packet to the point at which the output from the decoder has converged
976 * independent from the availability of previous frames. That is, the
977 * frames are virtually identical no matter if decoding started from
978 * the very first frame or from this keyframe.
979 * Is AV_NOPTS_VALUE if unknown.
980 * This field is not the display duration of the current packet.
981 *
982 * The purpose of this field is to allow seeking in streams that have no
983 * keyframes in the conventional sense. It corresponds to the
984 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
985 * essential for some types of subtitle streams to ensure that all
986 * subtitles are correctly displayed after seeking.
987 */
988 int64_t convergence_duration;
989} AVPacket;
8f3f2e06
RD
990#define AV_PKT_FLAG_KEY 0x0001
991#if LIBAVCODEC_VERSION_MAJOR < 53
992#define PKT_FLAG_KEY AV_PKT_FLAG_KEY
993#endif
18c915ee 994
0da71265
MN
995/**
996 * Audio Video Frame.
ba66ae94
MN
997 * New fields can be added to the end of FF_COMMON_FRAME with minor version
998 * bumps.
8bfb108b 999 * Removal, reordering and changes to existing fields require a major
ba66ae94
MN
1000 * version bump. No fields should be added into AVFrame before or after
1001 * FF_COMMON_FRAME!
8bfb108b 1002 * sizeof(AVFrame) must not be used outside libav*.
0da71265 1003 */
492cd3a9
MN
1004typedef struct AVFrame {
1005 FF_COMMON_FRAME
1006} AVFrame;
1e491e29 1007
d33c949c 1008/**
252f17e2
MN
1009 * main external API structure.
1010 * New fields can be added to the end with minor version bumps.
8bfb108b 1011 * Removal, reordering and changes to existing fields require a major
252f17e2 1012 * version bump.
8bfb108b 1013 * sizeof(AVCodecContext) must not be used outside libav*.
d33c949c 1014 */
de6d9b64 1015typedef struct AVCodecContext {
b71901e6 1016 /**
f5bccd85 1017 * information on struct for av_log
bc874dae
MB
1018 * - set by avcodec_alloc_context
1019 */
d42a814e 1020 const AVClass *av_class;
bc874dae 1021 /**
f5bccd85
DB
1022 * the average bitrate
1023 * - encoding: Set by user; unused for constant quantizer encoding.
1024 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
b71901e6 1025 */
de6d9b64 1026 int bit_rate;
b71901e6
MN
1027
1028 /**
64863965 1029 * number of bits the bitstream is allowed to diverge from the reference.
b71901e6 1030 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
f5bccd85 1031 * - encoding: Set by user; unused for constant quantizer encoding.
64863965 1032 * - decoding: unused
b71901e6 1033 */
115329f1 1034 int bit_rate_tolerance;
b71901e6
MN
1035
1036 /**
64863965 1037 * CODEC_FLAG_*.
f5bccd85
DB
1038 * - encoding: Set by user.
1039 * - decoding: Set by user.
b71901e6 1040 */
de6d9b64 1041 int flags;
b71901e6
MN
1042
1043 /**
f5bccd85
DB
1044 * Some codecs need additional format info. It is stored here.
1045 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1046 * specific codec MUST set it correctly otherwise stream copy breaks.
1047 * In general use of this field by muxers is not recommanded.
1048 * - encoding: Set by libavcodec.
1049 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
b71901e6
MN
1050 */
1051 int sub_id;
1052
1053 /**
f5bccd85 1054 * Motion estimation algorithm used for video coding.
58f7833e 1055 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
89223ef6 1056 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
64863965
MN
1057 * - encoding: MUST be set by user.
1058 * - decoding: unused
b71901e6
MN
1059 */
1060 int me_method;
1061
1062 /**
f5bccd85
DB
1063 * some codecs need / can use extradata like Huffman tables.
1064 * mjpeg: Huffman tables
b71901e6 1065 * rv10: additional flags
b704e742 1066 * mpeg4: global headers (they can be in the bitstream or here)
f5bccd85
DB
1067 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1068 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1069 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1070 * - encoding: Set/allocated/freed by libavcodec.
1071 * - decoding: Set/allocated/freed by user.
b71901e6 1072 */
58f2a4b0 1073 uint8_t *extradata;
e84c31dc 1074 int extradata_size;
115329f1 1075
b71901e6 1076 /**
f5bccd85
DB
1077 * This is the fundamental unit of time (in seconds) in terms
1078 * of which frame timestamps are represented. For fixed-fps content,
5b28c8c3
MN
1079 * timebase should be 1/framerate and timestamp increments should be
1080 * identically 1.
f5bccd85
DB
1081 * - encoding: MUST be set by user.
1082 * - decoding: Set by libavcodec.
b71901e6 1083 */
c0df9d75 1084 AVRational time_base;
115329f1 1085
5b28c8c3 1086 /* video only */
14bea432 1087 /**
21adafec 1088 * picture width / height.
115329f1 1089 * - encoding: MUST be set by user.
f5bccd85
DB
1090 * - decoding: Set by libavcodec.
1091 * Note: For compatibility it is possible to set this instead of
1092 * coded_width/height before decoding.
b71901e6 1093 */
de6d9b64 1094 int width, height;
115329f1 1095
e769f053 1096#define FF_ASPECT_EXTENDED 15
b71901e6
MN
1097
1098 /**
f5bccd85
DB
1099 * the number of pictures in a group of pictures, or 0 for intra_only
1100 * - encoding: Set by user.
64863965 1101 * - decoding: unused
b71901e6
MN
1102 */
1103 int gop_size;
1104
1105 /**
f5bccd85
DB
1106 * Pixel format, see PIX_FMT_xxx.
1107 * - encoding: Set by user.
1108 * - decoding: Set by libavcodec.
b71901e6 1109 */
e4eadb4b 1110 enum PixelFormat pix_fmt;
115329f1 1111
bdfcbbed 1112 /**
f5bccd85 1113 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
bdfcbbed 1114 * has to read frames at native frame rate.
f5bccd85
DB
1115 * - encoding: Set by user.
1116 * - decoding: unused
bdfcbbed
MK
1117 */
1118 int rate_emu;
115329f1 1119
b71901e6 1120 /**
f5bccd85
DB
1121 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1122 * decoder to draw a horizontal band. It improves cache usage. Not
b71901e6 1123 * all codecs can do that. You must check the codec capabilities
f5bccd85 1124 * beforehand.
24b1583a
IK
1125 * The function is also used by hardware acceleration APIs.
1126 * It is called at least once during frame decoding to pass
1127 * the data needed for hardware render.
1128 * In that mode instead of pixel data, AVFrame points to
1129 * a structure specific to the acceleration API. The application
1130 * reads the structure and can change some fields to indicate progress
1131 * or mark state.
64863965 1132 * - encoding: unused
f5bccd85 1133 * - decoding: Set by user.
3bb07d61
MN
1134 * @param height the height of the slice
1135 * @param y the y position of the slice
1136 * @param type 1->top field, 2->bottom field, 3->frame
1137 * @param offset offset into the AVFrame.data from which the slice should be read
b71901e6 1138 */
bf89e6b1 1139 void (*draw_horiz_band)(struct AVCodecContext *s,
da64ecc3 1140 const AVFrame *src, int offset[4],
3bb07d61 1141 int y, int type, int height);
bf89e6b1 1142
de6d9b64 1143 /* audio only */
f5bccd85 1144 int sample_rate; ///< samples per second
5fcc4a23 1145 int channels; ///< number of audio channels
a3a5f4d6
MN
1146
1147 /**
f5bccd85
DB
1148 * audio sample format
1149 * - encoding: Set by user.
1150 * - decoding: Set by libavcodec.
a3a5f4d6 1151 */
ce9dd8f5 1152 enum SampleFormat sample_fmt; ///< sample format
de6d9b64 1153
f5bccd85 1154 /* The following data should not be initialized. */
718b27a7 1155 /**
f5bccd85 1156 * Samples per packet, initialized when calling 'init'.
718b27a7
MN
1157 */
1158 int frame_size;
115329f1 1159 int frame_number; ///< audio or video frame number
c0601d70 1160#if LIBAVCODEC_VERSION_MAJOR < 53
f5bccd85 1161 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
c0601d70 1162#endif
115329f1 1163
b71901e6 1164 /**
f5bccd85 1165 * Number of frames the decoded output will be delayed relative to
64863965 1166 * the encoded input.
f5bccd85 1167 * - encoding: Set by libavcodec.
64863965 1168 * - decoding: unused
b71901e6
MN
1169 */
1170 int delay;
115329f1 1171
64863965
MN
1172 /* - encoding parameters */
1173 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
115329f1
DB
1174 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1175
b71901e6 1176 /**
f5bccd85
DB
1177 * minimum quantizer
1178 * - encoding: Set by user.
64863965 1179 * - decoding: unused
b71901e6
MN
1180 */
1181 int qmin;
1182
1183 /**
f5bccd85
DB
1184 * maximum quantizer
1185 * - encoding: Set by user.
64863965 1186 * - decoding: unused
b71901e6
MN
1187 */
1188 int qmax;
1189
1190 /**
f5bccd85
DB
1191 * maximum quantizer difference between frames
1192 * - encoding: Set by user.
64863965 1193 * - decoding: unused
b71901e6
MN
1194 */
1195 int max_qdiff;
1196
1197 /**
f5bccd85
DB
1198 * maximum number of B-frames between non-B-frames
1199 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1200 * - encoding: Set by user.
64863965 1201 * - decoding: unused
b71901e6
MN
1202 */
1203 int max_b_frames;
1204
1205 /**
f5bccd85 1206 * qscale factor between IP and B-frames
662e5411 1207 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1208 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
f5bccd85 1209 * - encoding: Set by user.
64863965 1210 * - decoding: unused
b71901e6
MN
1211 */
1212 float b_quant_factor;
115329f1 1213
b71901e6
MN
1214 /** obsolete FIXME remove */
1215 int rc_strategy;
64b7c5b6
MN
1216#define FF_RC_STRATEGY_XVID 1
1217
8b4c7dbc 1218 int b_frame_strategy;
9dbcbd92 1219
b71901e6 1220 /**
85947156
VS
1221 * hurry up amount
1222 * - encoding: unused
1223 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
f9ec0aa1 1224 * @deprecated Deprecated in favor of skip_idct and skip_frame.
b71901e6
MN
1225 */
1226 int hurry_up;
115329f1 1227
de6d9b64 1228 struct AVCodec *codec;
115329f1 1229
de6d9b64
FB
1230 void *priv_data;
1231
bb628dae 1232 int rtp_payload_size; /* The size of the RTP payload: the coder will */
f5bccd85 1233 /* do its best to deliver a chunk with size */
644d98a4 1234 /* below rtp_payload_size, the chunk will start */
f5bccd85 1235 /* with a start code on some codecs like H.263. */
644d98a4 1236 /* This doesn't take account of any particular */
f5bccd85 1237 /* headers inside the transmitted RTP payload. */
81401c1f 1238
115329f1 1239
f5bccd85
DB
1240 /* The RTP callback: This function is called */
1241 /* every time the encoder has a packet to send. */
1242 /* It depends on the encoder if the data starts */
1243 /* with a Start Code (it should). H.263 does. */
1244 /* mb_nb contains the number of macroblocks */
1245 /* encoded in the RTP payload. */
115329f1 1246 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
81401c1f 1247
098eefe1
MN
1248 /* statistics, used for 2-pass encoding */
1249 int mv_bits;
1250 int header_bits;
1251 int i_tex_bits;
1252 int p_tex_bits;
1253 int i_count;
1254 int p_count;
1255 int skip_count;
b71901e6 1256 int misc_bits;
115329f1 1257
b71901e6 1258 /**
f5bccd85
DB
1259 * number of bits used for the previously encoded frame
1260 * - encoding: Set by libavcodec.
7004ffb3 1261 * - decoding: unused
b71901e6 1262 */
098eefe1 1263 int frame_bits;
7004ffb3 1264
b71901e6 1265 /**
f5bccd85
DB
1266 * Private data of the user, can be used to carry app specific stuff.
1267 * - encoding: Set by user.
1268 * - decoding: Set by user.
b71901e6
MN
1269 */
1270 void *opaque;
1271
de6d9b64 1272 char codec_name[32];
4a663d80
PG
1273 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1274 enum CodecID codec_id; /* see CODEC_ID_xxx */
115329f1 1275
7004ffb3
MN
1276 /**
1277 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
f5bccd85
DB
1278 * This is used to work around some encoder bugs.
1279 * A demuxer should set this to what is stored in the field used to identify the codec.
1280 * If there are multiple such fields in a container then the demuxer should choose the one
1281 * which maximizes the information about the used codec.
1282 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1283 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
47bbf8a7 1284 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
f5bccd85
DB
1285 * first.
1286 * - encoding: Set by user, if not then the default based on codec_id will be used.
1287 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
7004ffb3
MN
1288 */
1289 unsigned int codec_tag;
115329f1 1290
b71901e6 1291 /**
f5bccd85
DB
1292 * Work around bugs in encoders which sometimes cannot be detected automatically.
1293 * - encoding: Set by user
1294 * - decoding: Set by user
b71901e6
MN
1295 */
1296 int workaround_bugs;
64863965 1297#define FF_BUG_AUTODETECT 1 ///< autodetection
4d2858de
MN
1298#define FF_BUG_OLD_MSMPEG4 2
1299#define FF_BUG_XVID_ILACE 4
1300#define FF_BUG_UMP4 8
1301#define FF_BUG_NO_PADDING 16
3116cb14 1302#define FF_BUG_AMV 32
f5bccd85 1303#define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
03e93d35 1304#define FF_BUG_QPEL_CHROMA 64
db794953 1305#define FF_BUG_STD_QPEL 128
36df8805 1306#define FF_BUG_QPEL_CHROMA2 256
c40c3482 1307#define FF_BUG_DIRECT_BLOCKSIZE 512
1c6dcb0f 1308#define FF_BUG_EDGE 1024
b44bdf7e 1309#define FF_BUG_HPEL_CHROMA 2048
4ccde216 1310#define FF_BUG_DC_CLIP 4096
f5bccd85 1311#define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
3566042a 1312#define FF_BUG_TRUNCATED 16384
f5bccd85 1313//#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
115329f1 1314
b71901e6 1315 /**
f5bccd85
DB
1316 * luma single coefficient elimination threshold
1317 * - encoding: Set by user.
64863965 1318 * - decoding: unused
b71901e6 1319 */
1f6b6e50 1320 int luma_elim_threshold;
115329f1 1321
b71901e6 1322 /**
f5bccd85
DB
1323 * chroma single coeff elimination threshold
1324 * - encoding: Set by user.
64863965 1325 * - decoding: unused
b71901e6 1326 */
1f6b6e50 1327 int chroma_elim_threshold;
115329f1 1328
b71901e6 1329 /**
f5bccd85
DB
1330 * strictly follow the standard (MPEG4, ...).
1331 * - encoding: Set by user.
5771b2c3
MN
1332 * - decoding: Set by user.
1333 * Setting this to STRICT or higher means the encoder and decoder will
1334 * generally do stupid things. While setting it to inofficial or lower
1335 * will mean the encoder might use things that are not supported by all
1336 * spec compliant decoders. Decoders make no difference between normal,
1337 * inofficial and experimental, that is they always try to decode things
1338 * when they can unless they are explicitly asked to behave stupid
1339 * (=strictly conform to the specs)
b71901e6
MN
1340 */
1341 int strict_std_compliance;
f5bccd85
DB
1342#define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1343#define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
9cd81798 1344#define FF_COMPLIANCE_NORMAL 0
f5bccd85
DB
1345#define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1346#define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
9cd81798 1347
b71901e6 1348 /**
f5bccd85 1349 * qscale offset between IP and B-frames
f5bccd85 1350 * - encoding: Set by user.
64863965 1351 * - decoding: unused
b71901e6
MN
1352 */
1353 float b_quant_offset;
115329f1 1354
b71901e6 1355 /**
047599a4 1356 * Error recognization; higher values will detect more errors but may
f5bccd85 1357 * misdetect some more or less valid parts as errors.
64863965 1358 * - encoding: unused
f5bccd85 1359 * - decoding: Set by user.
b71901e6 1360 */
047599a4 1361 int error_recognition;
1471c6c2 1362#define FF_ER_CAREFUL 1
ce3bcaed
MN
1363#define FF_ER_COMPLIANT 2
1364#define FF_ER_AGGRESSIVE 3
1365#define FF_ER_VERY_AGGRESSIVE 4
115329f1 1366
6b72ac63 1367 /**
f5bccd85
DB
1368 * Called at the beginning of each frame to get a buffer for it.
1369 * If pic.reference is set then the frame will be read later by libavcodec.
2b5296d2 1370 * avcodec_align_dimensions() should be used to find the required width and
f5bccd85 1371 * height, as they normally need to be rounded up to the next multiple of 16.
f1b99cc6
MN
1372 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1373 * avcodec_default_get_buffer() instead of providing buffers allocated by
1374 * some other means.
64863965 1375 * - encoding: unused
f5bccd85 1376 * - decoding: Set by libavcodec., user can override.
b71901e6 1377 */
492cd3a9 1378 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
115329f1 1379
b71901e6 1380 /**
69b192ac 1381 * Called to release buffers which were allocated with get_buffer.
f5bccd85
DB
1382 * A released buffer can be reused in get_buffer().
1383 * pic.data[*] must be set to NULL.
64863965 1384 * - encoding: unused
f5bccd85 1385 * - decoding: Set by libavcodec., user can override.
b71901e6 1386 */
492cd3a9 1387 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
0fd90455 1388
b71901e6 1389 /**
eb8a25c8 1390 * Size of the frame reordering buffer in the decoder.
2d7b0560 1391 * For MPEG-2 it is 1 IPB or 0 low delay IP.
f5bccd85
DB
1392 * - encoding: Set by libavcodec.
1393 * - decoding: Set by libavcodec.
b71901e6
MN
1394 */
1395 int has_b_frames;
718b27a7
MN
1396
1397 /**
1398 * number of bytes per packet if constant and known or 0
f5bccd85 1399 * Used by some WAV based audio codecs.
718b27a7
MN
1400 */
1401 int block_align;
115329f1 1402
f5bccd85 1403 int parse_only; /* - decoding only: If true, only parsing is done
917e06c8
FB
1404 (function avcodec_parse_frame()). The frame
1405 data is returned. Only MPEG codecs support this now. */
115329f1 1406
b71901e6 1407 /**
f5bccd85
DB
1408 * 0-> h263 quant 1-> mpeg quant
1409 * - encoding: Set by user.
64863965 1410 * - decoding: unused
b71901e6
MN
1411 */
1412 int mpeg_quant;
115329f1 1413
b71901e6 1414 /**
f5bccd85
DB
1415 * pass1 encoding statistics output buffer
1416 * - encoding: Set by libavcodec.
64863965 1417 * - decoding: unused
b71901e6 1418 */
64863965 1419 char *stats_out;
115329f1 1420
b71901e6 1421 /**
f5bccd85
DB
1422 * pass2 encoding statistics input buffer
1423 * Concatenated stuff from stats_out of pass1 should be placed here.
1424 * - encoding: Allocated/set/freed by user.
64863965 1425 * - decoding: unused
b71901e6
MN
1426 */
1427 char *stats_in;
115329f1 1428
b71901e6 1429 /**
f5bccd85
DB
1430 * ratecontrol qmin qmax limiting method
1431 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1432 * - encoding: Set by user.
64863965 1433 * - decoding: unused
b71901e6 1434 */
ce980a95 1435 float rc_qsquish;
b71901e6 1436
ce980a95
MN
1437 float rc_qmod_amp;
1438 int rc_qmod_freq;
115329f1 1439
b71901e6 1440 /**
f5bccd85
DB
1441 * ratecontrol override, see RcOverride
1442 * - encoding: Allocated/set/freed by user.
64863965 1443 * - decoding: unused
b71901e6 1444 */
ce980a95
MN
1445 RcOverride *rc_override;
1446 int rc_override_count;
115329f1 1447
b71901e6 1448 /**
f5bccd85
DB
1449 * rate control equation
1450 * - encoding: Set by user
64863965 1451 * - decoding: unused
b71901e6 1452 */
6881b8e5 1453 const char *rc_eq;
115329f1 1454
b71901e6 1455 /**
f5bccd85
DB
1456 * maximum bitrate
1457 * - encoding: Set by user.
64863965 1458 * - decoding: unused
b71901e6 1459 */
ce980a95 1460 int rc_max_rate;
115329f1 1461
b71901e6 1462 /**
f5bccd85
DB
1463 * minimum bitrate
1464 * - encoding: Set by user.
64863965 1465 * - decoding: unused
b71901e6 1466 */
ce980a95 1467 int rc_min_rate;
115329f1 1468
b71901e6 1469 /**
f5bccd85
DB
1470 * decoder bitstream buffer size
1471 * - encoding: Set by user.
64863965 1472 * - decoding: unused
b71901e6 1473 */
ce980a95
MN
1474 int rc_buffer_size;
1475 float rc_buffer_aggressivity;
b71901e6
MN
1476
1477 /**
f5bccd85
DB
1478 * qscale factor between P and I-frames
1479 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1480 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1481 * - encoding: Set by user.
64863965 1482 * - decoding: unused
b71901e6
MN
1483 */
1484 float i_quant_factor;
115329f1 1485
b71901e6 1486 /**
f5bccd85
DB
1487 * qscale offset between P and I-frames
1488 * - encoding: Set by user.
64863965 1489 * - decoding: unused
b71901e6
MN
1490 */
1491 float i_quant_offset;
115329f1 1492
b71901e6 1493 /**
f5bccd85
DB
1494 * initial complexity for pass1 ratecontrol
1495 * - encoding: Set by user.
64863965 1496 * - decoding: unused
b71901e6 1497 */
ce980a95 1498 float rc_initial_cplx;
917e06c8 1499
b71901e6 1500 /**
f5bccd85
DB
1501 * DCT algorithm, see FF_DCT_* below
1502 * - encoding: Set by user.
64863965 1503 * - decoding: unused
b71901e6 1504 */
28db7fce 1505 int dct_algo;
c7e07931 1506#define FF_DCT_AUTO 0
28db7fce 1507#define FF_DCT_FASTINT 1
c7e07931
MO
1508#define FF_DCT_INT 2
1509#define FF_DCT_MMX 3
1510#define FF_DCT_MLIB 4
05c4072b 1511#define FF_DCT_ALTIVEC 5
65e4c8c9 1512#define FF_DCT_FAAN 6
115329f1 1513
c5d309f2 1514 /**
f5bccd85
DB
1515 * luminance masking (0-> disabled)
1516 * - encoding: Set by user.
64863965 1517 * - decoding: unused
c5d309f2
MN
1518 */
1519 float lumi_masking;
115329f1 1520
c5d309f2 1521 /**
f5bccd85
DB
1522 * temporary complexity masking (0-> disabled)
1523 * - encoding: Set by user.
64863965 1524 * - decoding: unused
c5d309f2
MN
1525 */
1526 float temporal_cplx_masking;
115329f1 1527
c5d309f2 1528 /**
f5bccd85
DB
1529 * spatial complexity masking (0-> disabled)
1530 * - encoding: Set by user.
64863965 1531 * - decoding: unused
c5d309f2
MN
1532 */
1533 float spatial_cplx_masking;
115329f1 1534
c5d309f2 1535 /**
f5bccd85
DB
1536 * p block masking (0-> disabled)
1537 * - encoding: Set by user.
64863965 1538 * - decoding: unused
c5d309f2
MN
1539 */
1540 float p_masking;
15415af4 1541
5e746b99 1542 /**
f5bccd85
DB
1543 * darkness masking (0-> disabled)
1544 * - encoding: Set by user.
64863965 1545 * - decoding: unused
5e746b99
MN
1546 */
1547 float dark_masking;
115329f1 1548
0c2dd16e 1549 /**
f5bccd85
DB
1550 * IDCT algorithm, see FF_IDCT_* below.
1551 * - encoding: Set by user.
1552 * - decoding: Set by user.
2ad1516a
MN
1553 */
1554 int idct_algo;
273b0cd3
DB
1555#define FF_IDCT_AUTO 0
1556#define FF_IDCT_INT 1
1557#define FF_IDCT_SIMPLE 2
1558#define FF_IDCT_SIMPLEMMX 3
1559#define FF_IDCT_LIBMPEG2MMX 4
1560#define FF_IDCT_PS2 5
1561#define FF_IDCT_MLIB 6
1562#define FF_IDCT_ARM 7
1563#define FF_IDCT_ALTIVEC 8
1564#define FF_IDCT_SH4 9
1565#define FF_IDCT_SIMPLEARM 10
1566#define FF_IDCT_H264 11
1567#define FF_IDCT_VP3 12
1568#define FF_IDCT_IPP 13
1569#define FF_IDCT_XVIDMMX 14
1570#define FF_IDCT_CAVS 15
a0403006 1571#define FF_IDCT_SIMPLEARMV5TE 16
273b0cd3 1572#define FF_IDCT_SIMPLEARMV6 17
d9420d4d 1573#define FF_IDCT_SIMPLEVIS 18
9abc7e0f 1574#define FF_IDCT_WMV2 19
6f08c541 1575#define FF_IDCT_FAAN 20
42b30357 1576#define FF_IDCT_EA 21
7eec4328 1577#define FF_IDCT_SIMPLENEON 22
74c47463 1578#define FF_IDCT_SIMPLEALPHA 23
342c7dfd 1579#define FF_IDCT_BINK 24
2ad1516a 1580
144f0625 1581 /**
f5bccd85
DB
1582 * slice count
1583 * - encoding: Set by libavcodec.
1584 * - decoding: Set by user (or 0).
144f0625
MN
1585 */
1586 int slice_count;
1587 /**
f5bccd85
DB
1588 * slice offsets in the frame in bytes
1589 * - encoding: Set/allocated by libavcodec.
1590 * - decoding: Set/allocated by user (or NULL).
144f0625
MN
1591 */
1592 int *slice_offset;
1593
4d2858de 1594 /**
f5bccd85 1595 * error concealment flags
64863965 1596 * - encoding: unused
f5bccd85 1597 * - decoding: Set by user.
4d2858de
MN
1598 */
1599 int error_concealment;
1600#define FF_EC_GUESS_MVS 1
1601#define FF_EC_DEBLOCK 2
1602
6b72ac63 1603 /**
bec89a84 1604 * dsp_mask could be add used to disable unwanted CPU features
8350df97 1605 * CPU features (i.e. MMX, SSE. ...)
bec89a84 1606 *
f5bccd85
DB
1607 * With the FORCE flag you may instead enable given CPU features.
1608 * (Dangerous: Usable in case of misdetection, improper usage however will
1609 * result into program crash.)
bec89a84
ZK
1610 */
1611 unsigned dsp_mask;
f5bccd85 1612#define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
bec89a84 1613 /* lower 16 bits - CPU features */
0cd60abf
MN
1614#define FF_MM_MMX 0x0001 ///< standard MMX
1615#define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
6b434361 1616#if LIBAVCODEC_VERSION_MAJOR < 53
0cd60abf 1617#define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
6b434361
SS
1618#endif
1619#define FF_MM_MMX2 0x0002 ///< SSE integer functions or AMD MMX ext
0cd60abf
MN
1620#define FF_MM_SSE 0x0008 ///< SSE functions
1621#define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1622#define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1623#define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1624#define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
710441c2
DC
1625#define FF_MM_SSE4 0x0100 ///< Penryn SSE4.1 functions
1626#define FF_MM_SSE42 0x0200 ///< Nehalem SSE4.2 functions
0cd60abf 1627#define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
82d1605f 1628#define FF_MM_ALTIVEC 0x0001 ///< standard AltiVec
11f18faf
MN
1629
1630 /**
64863965 1631 * bits per sample/pixel from the demuxer (needed for huffyuv).
f5bccd85
DB
1632 * - encoding: Set by libavcodec.
1633 * - decoding: Set by user.
11f18faf 1634 */
46a73068 1635 int bits_per_coded_sample;
115329f1 1636
11f18faf 1637 /**
f5bccd85
DB
1638 * prediction method (needed for huffyuv)
1639 * - encoding: Set by user.
64863965 1640 * - decoding: unused
11f18faf
MN
1641 */
1642 int prediction_method;
1643#define FF_PRED_LEFT 0
1644#define FF_PRED_PLANE 1
1645#define FF_PRED_MEDIAN 2
115329f1 1646
5d3cea3a 1647 /**
f5bccd85 1648 * sample aspect ratio (0 if unknown)
8e5af7a6 1649 * That is the width of a pixel divided by the height of the pixel.
f5bccd85
DB
1650 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1651 * - encoding: Set by user.
1652 * - decoding: Set by libavcodec.
5d3cea3a 1653 */
5ff85f1d 1654 AVRational sample_aspect_ratio;
1e491e29
MN
1655
1656 /**
f5bccd85
DB
1657 * the picture in the bitstream
1658 * - encoding: Set by libavcodec.
1659 * - decoding: Set by libavcodec.
1e491e29 1660 */
492cd3a9 1661 AVFrame *coded_frame;
c8c437bc
MN
1662
1663 /**
f5bccd85
DB
1664 * debug
1665 * - encoding: Set by user.
1666 * - decoding: Set by user.
c8c437bc
MN
1667 */
1668 int debug;
273b0cd3
DB
1669#define FF_DEBUG_PICT_INFO 1
1670#define FF_DEBUG_RC 2
1671#define FF_DEBUG_BITSTREAM 4
1672#define FF_DEBUG_MB_TYPE 8
1673#define FF_DEBUG_QP 16
1674#define FF_DEBUG_MV 32
1675#define FF_DEBUG_DCT_COEFF 0x00000040
1676#define FF_DEBUG_SKIP 0x00000080
1677#define FF_DEBUG_STARTCODE 0x00000100
1678#define FF_DEBUG_PTS 0x00000200
1679#define FF_DEBUG_ER 0x00000400
1680#define FF_DEBUG_MMCO 0x00000800
1681#define FF_DEBUG_BUGS 0x00001000
1682#define FF_DEBUG_VIS_QP 0x00002000
864119b6 1683#define FF_DEBUG_VIS_MB_TYPE 0x00004000
385c820b 1684#define FF_DEBUG_BUFFERS 0x00008000
115329f1 1685
140cb663 1686 /**
f5bccd85
DB
1687 * debug
1688 * - encoding: Set by user.
1689 * - decoding: Set by user.
0c9bbaec
WH
1690 */
1691 int debug_mv;
1692#define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1693#define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1694#define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1695
1696 /**
f5bccd85
DB
1697 * error
1698 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
64863965 1699 * - decoding: unused
140cb663
MN
1700 */
1701 uint64_t error[4];
115329f1 1702
17a70fde 1703 /**
f5bccd85 1704 * minimum MB quantizer
6e0d8c06 1705 * - encoding: unused
64863965 1706 * - decoding: unused
17a70fde
MN
1707 */
1708 int mb_qmin;
1709
1710 /**
f5bccd85 1711 * maximum MB quantizer
6e0d8c06 1712 * - encoding: unused
64863965 1713 * - decoding: unused
17a70fde
MN
1714 */
1715 int mb_qmax;
115329f1 1716
1457ab52 1717 /**
f5bccd85
DB
1718 * motion estimation comparison function
1719 * - encoding: Set by user.
64863965 1720 * - decoding: unused
1457ab52
MN
1721 */
1722 int me_cmp;
1723 /**
f5bccd85
DB
1724 * subpixel motion estimation comparison function
1725 * - encoding: Set by user.
64863965 1726 * - decoding: unused
1457ab52
MN
1727 */
1728 int me_sub_cmp;
1729 /**
f5bccd85
DB
1730 * macroblock comparison function (not supported yet)
1731 * - encoding: Set by user.
64863965 1732 * - decoding: unused
1457ab52
MN
1733 */
1734 int mb_cmp;
622348f9 1735 /**
f5bccd85
DB
1736 * interlaced DCT comparison function
1737 * - encoding: Set by user.
622348f9
MN
1738 * - decoding: unused
1739 */
1740 int ildct_cmp;
273b0cd3
DB
1741#define FF_CMP_SAD 0
1742#define FF_CMP_SSE 1
1743#define FF_CMP_SATD 2
1744#define FF_CMP_DCT 3
1745#define FF_CMP_PSNR 4
1746#define FF_CMP_BIT 5
1747#define FF_CMP_RD 6
1748#define FF_CMP_ZERO 7
1749#define FF_CMP_VSAD 8
1750#define FF_CMP_VSSE 9
1751#define FF_CMP_NSSE 10
1752#define FF_CMP_W53 11
1753#define FF_CMP_W97 12
0fd6aea1 1754#define FF_CMP_DCTMAX 13
27c61ac5 1755#define FF_CMP_DCT264 14
1457ab52 1756#define FF_CMP_CHROMA 256
115329f1 1757
1457ab52 1758 /**
f5bccd85
DB
1759 * ME diamond size & shape
1760 * - encoding: Set by user.
64863965 1761 * - decoding: unused
1457ab52
MN
1762 */
1763 int dia_size;
b07a5980
MN
1764
1765 /**
f5bccd85
DB
1766 * amount of previous MV predictors (2a+1 x 2a+1 square)
1767 * - encoding: Set by user.
64863965 1768 * - decoding: unused
b07a5980
MN
1769 */
1770 int last_predictor_count;
70ac76c0 1771
f5fb6b34 1772 /**
f5bccd85
DB
1773 * prepass for motion estimation
1774 * - encoding: Set by user.
64863965 1775 * - decoding: unused
f5fb6b34
MN
1776 */
1777 int pre_me;
b07a5980 1778
70ac76c0 1779 /**
f5bccd85
DB
1780 * motion estimation prepass comparison function
1781 * - encoding: Set by user.
64863965 1782 * - decoding: unused
70ac76c0
MN
1783 */
1784 int me_pre_cmp;
826f429a 1785
70ac76c0 1786 /**
f5bccd85
DB
1787 * ME prepass diamond size & shape
1788 * - encoding: Set by user.
64863965 1789 * - decoding: unused
70ac76c0
MN
1790 */
1791 int pre_dia_size;
1792
826f429a 1793 /**
f5bccd85
DB
1794 * subpel ME quality
1795 * - encoding: Set by user.
64863965 1796 * - decoding: unused
826f429a
MN
1797 */
1798 int me_subpel_quality;
1799
a33c7159 1800 /**
f5bccd85 1801 * callback to negotiate the pixelFormat
a33c7159 1802 * @param fmt is the list of formats which are supported by the codec,
f5bccd85
DB
1803 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1804 * The first is always the native one.
1805 * @return the chosen format
64863965 1806 * - encoding: unused
f5bccd85 1807 * - decoding: Set by user, if not set the native format will be chosen.
a33c7159 1808 */
494c56d3 1809 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
e2f9490e
FB
1810
1811 /**
f5bccd85
DB
1812 * DTG active format information (additional aspect ratio
1813 * information only used in DVB MPEG-2 transport streams)
1814 * 0 if not set.
115329f1 1815 *
f5bccd85
DB
1816 * - encoding: unused
1817 * - decoding: Set by decoder.
e2f9490e
FB
1818 */
1819 int dtg_active_format;
1820#define FF_DTG_AFD_SAME 8
1821#define FF_DTG_AFD_4_3 9
1822#define FF_DTG_AFD_16_9 10
1823#define FF_DTG_AFD_14_9 11
1824#define FF_DTG_AFD_4_3_SP_14_9 13
1825#define FF_DTG_AFD_16_9_SP_14_9 14
1826#define FF_DTG_AFD_SP_4_3 15
1827
ebbcdc9a 1828 /**
f5bccd85
DB
1829 * maximum motion estimation search range in subpel units
1830 * If 0 then no limit.
115329f1 1831 *
f5bccd85
DB
1832 * - encoding: Set by user.
1833 * - decoding: unused
ebbcdc9a 1834 */
59e0ac8e 1835 int me_range;
ebbcdc9a 1836
65f7062d 1837 /**
f5bccd85
DB
1838 * intra quantizer bias
1839 * - encoding: Set by user.
1984f635
MN
1840 * - decoding: unused
1841 */
1842 int intra_quant_bias;
1843#define FF_DEFAULT_QUANT_BIAS 999999
115329f1 1844
1984f635 1845 /**
f5bccd85
DB
1846 * inter quantizer bias
1847 * - encoding: Set by user.
1984f635
MN
1848 * - decoding: unused
1849 */
1850 int inter_quant_bias;
5cd62665
ZK
1851
1852 /**
f5bccd85
DB
1853 * color table ID
1854 * - encoding: unused
1855 * - decoding: Which clrtable should be used for 8bit RGB images.
1856 * Tables have to be stored somewhere. FIXME
5cd62665
ZK
1857 */
1858 int color_table_id;
115329f1 1859
d90cf87b 1860 /**
f5bccd85
DB
1861 * internal_buffer count
1862 * Don't touch, used by libavcodec default_get_buffer().
d90cf87b
MN
1863 */
1864 int internal_buffer_count;
115329f1 1865
d90cf87b 1866 /**
f5bccd85
DB
1867 * internal_buffers
1868 * Don't touch, used by libavcodec default_get_buffer().
d90cf87b
MN
1869 */
1870 void *internal_buffer;
158c7f05
MN
1871
1872#define FF_LAMBDA_SHIFT 7
1873#define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1874#define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1875#define FF_LAMBDA_MAX (256*128-1)
1876
1877#define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
3d2e8cce 1878 /**
f5bccd85
DB
1879 * Global quality for codecs which cannot change it per frame.
1880 * This should be proportional to MPEG-1/2/4 qscale.
1881 * - encoding: Set by user.
3d2e8cce
MN
1882 * - decoding: unused
1883 */
1884 int global_quality;
115329f1 1885
bd446bb1
MN
1886#define FF_CODER_TYPE_VLC 0
1887#define FF_CODER_TYPE_AC 1
f87459e4
KN
1888#define FF_CODER_TYPE_RAW 2
1889#define FF_CODER_TYPE_RLE 3
1890#define FF_CODER_TYPE_DEFLATE 4
11e659c2
MN
1891 /**
1892 * coder type
f5bccd85 1893 * - encoding: Set by user.
11e659c2
MN
1894 * - decoding: unused
1895 */
1896 int coder_type;
1897
1898 /**
1899 * context model
f5bccd85 1900 * - encoding: Set by user.
11e659c2
MN
1901 * - decoding: unused
1902 */
1903 int context_model;
5639729b
MN
1904#if 0
1905 /**
1906 *
1907 * - encoding: unused
f5bccd85 1908 * - decoding: Set by user.
5639729b
MN
1909 */
1910 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1911#endif
115329f1 1912
3bb07d61
MN
1913 /**
1914 * slice flags
1915 * - encoding: unused
f5bccd85 1916 * - decoding: Set by user.
3bb07d61
MN
1917 */
1918 int slice_flags;
1919#define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1920#define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1921#define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1922
fb364ada
IK
1923 /**
1924 * XVideo Motion Acceleration
1925 * - encoding: forbidden
1926 * - decoding: set by decoder
1927 */
1928 int xvmc_acceleration;
115329f1 1929
7d1c3fc1
MN
1930 /**
1931 * macroblock decision mode
f5bccd85 1932 * - encoding: Set by user.
7d1c3fc1
MN
1933 * - decoding: unused
1934 */
1935 int mb_decision;
1936#define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1937#define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
e6dba5df 1938#define FF_MB_DECISION_RD 2 ///< rate distortion
d6eb3c50
MN
1939
1940 /**
1941 * custom intra quantization matrix
f5bccd85
DB
1942 * - encoding: Set by user, can be NULL.
1943 * - decoding: Set by libavcodec.
d6eb3c50
MN
1944 */
1945 uint16_t *intra_matrix;
1946
1947 /**
1948 * custom inter quantization matrix
f5bccd85
DB
1949 * - encoding: Set by user, can be NULL.
1950 * - decoding: Set by libavcodec.
d6eb3c50
MN
1951 */
1952 uint16_t *inter_matrix;
115329f1 1953
541ae140
MN
1954 /**
1955 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
f5bccd85 1956 * This is used to work around some encoder bugs.
541ae140 1957 * - encoding: unused
f5bccd85 1958 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
541ae140
MN
1959 */
1960 unsigned int stream_codec_tag;
05fbd0a2
MN
1961
1962 /**
f5bccd85
DB
1963 * scene change detection threshold
1964 * 0 is default, larger means fewer detected scene changes.
1965 * - encoding: Set by user.
05fbd0a2
MN
1966 * - decoding: unused
1967 */
1968 int scenechange_threshold;
158c7f05
MN
1969
1970 /**
f5bccd85
DB
1971 * minimum Lagrange multipler
1972 * - encoding: Set by user.
158c7f05
MN
1973 * - decoding: unused
1974 */
1975 int lmin;
1976
1977 /**
f5bccd85
DB
1978 * maximum Lagrange multipler
1979 * - encoding: Set by user.
158c7f05
MN
1980 * - decoding: unused
1981 */
1982 int lmax;
2a2bbcb0
MM
1983
1984 /**
f5bccd85 1985 * palette control structure
2a2bbcb0 1986 * - encoding: ??? (no palette-enabled encoder yet)
f5bccd85 1987 * - decoding: Set by user.
2a2bbcb0
MM
1988 */
1989 struct AVPaletteControl *palctrl;
821cb11f
MN
1990
1991 /**
1992 * noise reduction strength
f5bccd85 1993 * - encoding: Set by user.
821cb11f
MN
1994 * - decoding: unused
1995 */
1996 int noise_reduction;
115329f1 1997
074c4ca7 1998 /**
f5bccd85
DB
1999 * Called at the beginning of a frame to get cr buffer for it.
2000 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2001 * libavcodec will pass previous buffer in pic, function should return
e1c2a5a0 2002 * same buffer or new buffer with old frame "painted" into it.
f5bccd85 2003 * If pic.data[0] == NULL must behave like get_buffer().
f1b99cc6
MN
2004 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2005 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2006 * some other means.
074c4ca7 2007 * - encoding: unused
f5bccd85 2008 * - decoding: Set by libavcodec., user can override
074c4ca7 2009 */
e1c2a5a0 2010 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
ba58dabc
MN
2011
2012 /**
f5bccd85
DB
2013 * Number of bits which should be loaded into the rc buffer before decoding starts.
2014 * - encoding: Set by user.
ba58dabc
MN
2015 * - decoding: unused
2016 */
2017 int rc_initial_buffer_occupancy;
2018
2019 /**
2020 *
f5bccd85 2021 * - encoding: Set by user.
ba58dabc
MN
2022 * - decoding: unused
2023 */
2024 int inter_threshold;
2025
2026 /**
f5bccd85
DB
2027 * CODEC_FLAG2_*
2028 * - encoding: Set by user.
2029 * - decoding: Set by user.
ba58dabc
MN
2030 */
2031 int flags2;
7ebfc0ea
MN
2032
2033 /**
f5bccd85
DB
2034 * Simulates errors in the bitstream to test error concealment.
2035 * - encoding: Set by user.
2036 * - decoding: unused
7ebfc0ea
MN
2037 */
2038 int error_rate;
115329f1 2039
a1e257b2
MN
2040 /**
2041 * MP3 antialias algorithm, see FF_AA_* below.
2042 * - encoding: unused
f5bccd85 2043 * - decoding: Set by user.
a1e257b2
MN
2044 */
2045 int antialias_algo;
2046#define FF_AA_AUTO 0
2047#define FF_AA_FASTINT 1 //not implemented yet
2048#define FF_AA_INT 2
2049#define FF_AA_FLOAT 3
77ea0d4b 2050 /**
f5bccd85
DB
2051 * quantizer noise shaping
2052 * - encoding: Set by user.
77ea0d4b
MN
2053 * - decoding: unused
2054 */
2055 int quantizer_noise_shaping;
9c3d33d6
MN
2056
2057 /**
f5bccd85 2058 * thread count
eafcac6a 2059 * is used to decide how many independent tasks should be passed to execute()
f5bccd85
DB
2060 * - encoding: Set by user.
2061 * - decoding: Set by user.
9c3d33d6
MN
2062 */
2063 int thread_count;
115329f1 2064
9c3d33d6 2065 /**
f5bccd85
DB
2066 * The codec may call this to execute several independent things.
2067 * It will return only after finishing all tasks.
2068 * The user may replace this with some multithreaded implementation,
2069 * the default implementation will execute the parts serially.
399cec2f 2070 * @param count the number of things to execute
f5bccd85
DB
2071 * - encoding: Set by libavcodec, user can override.
2072 * - decoding: Set by libavcodec, user can override.
9c3d33d6 2073 */
3a84713a 2074 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
115329f1 2075
9c3d33d6 2076 /**
f5bccd85
DB
2077 * thread opaque
2078 * Can be used by execute() to store some per AVCodecContext stuff.
9c3d33d6
MN
2079 * - encoding: set by execute()
2080 * - decoding: set by execute()
2081 */
2082 void *thread_opaque;
a4d36c11
MN
2083
2084 /**
f5bccd85
DB
2085 * Motion estimation threshold below which no motion estimation is
2086 * performed, but instead the user specified motion vectors are used.
115329f1 2087 *
f5bccd85 2088 * - encoding: Set by user.
f20f8a8b 2089 * - decoding: unused
a4d36c11 2090 */
2750b827 2091 int me_threshold;
f20f8a8b
MN
2092
2093 /**
f5bccd85
DB
2094 * Macroblock threshold below which the user specified macroblock types will be used.
2095 * - encoding: Set by user.
f20f8a8b
MN
2096 * - decoding: unused
2097 */
2098 int mb_threshold;
bf266e19
MN
2099
2100 /**
f5bccd85
DB
2101 * precision of the intra DC coefficient - 8
2102 * - encoding: Set by user.
bf266e19
MN
2103 * - decoding: unused
2104 */
2105 int intra_dc_precision;
d4c5d2ad
MN
2106
2107 /**
f5bccd85
DB
2108 * noise vs. sse weight for the nsse comparsion function
2109 * - encoding: Set by user.
d4c5d2ad
MN
2110 * - decoding: unused
2111 */
2112 int nsse_weight;
0dfd33c3
MN
2113
2114 /**
f5bccd85 2115 * Number of macroblock rows at the top which are skipped.
0dfd33c3 2116 * - encoding: unused
f5bccd85 2117 * - decoding: Set by user.
0dfd33c3
MN
2118 */
2119 int skip_top;
2120
2121 /**
f5bccd85 2122 * Number of macroblock rows at the bottom which are skipped.
0dfd33c3 2123 * - encoding: unused
f5bccd85 2124 * - decoding: Set by user.
0dfd33c3
MN
2125 */
2126 int skip_bottom;
baced9f5
MN
2127
2128 /**
2129 * profile
f5bccd85
DB
2130 * - encoding: Set by user.
2131 * - decoding: Set by libavcodec.
baced9f5
MN
2132 */
2133 int profile;
2134#define FF_PROFILE_UNKNOWN -99
dd0cd3d2 2135
4f2c36ac 2136#define FF_PROFILE_AAC_MAIN 0
273b0cd3
DB
2137#define FF_PROFILE_AAC_LOW 1
2138#define FF_PROFILE_AAC_SSR 2
2139#define FF_PROFILE_AAC_LTP 3
baced9f5 2140
dd0cd3d2
RC
2141#define FF_PROFILE_H264_BASELINE 66
2142#define FF_PROFILE_H264_MAIN 77
2143#define FF_PROFILE_H264_EXTENDED 88
2144#define FF_PROFILE_H264_HIGH 100
2145#define FF_PROFILE_H264_HIGH_10 110
2146#define FF_PROFILE_H264_HIGH_422 122
2147#define FF_PROFILE_H264_HIGH_444 244
2148#define FF_PROFILE_H264_CAVLC_444 44
2149
baced9f5
MN
2150 /**
2151 * level
f5bccd85
DB
2152 * - encoding: Set by user.
2153 * - decoding: Set by libavcodec.
baced9f5
MN
2154 */
2155 int level;
2156#define FF_LEVEL_UNKNOWN -99
178fcca8
MN
2157
2158 /**
f5bccd85 2159 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
178fcca8 2160 * - encoding: unused
f5bccd85 2161 * - decoding: Set by user.
178fcca8
MN
2162 */
2163 int lowres;
21adafec
MN
2164
2165 /**
f5bccd85
DB
2166 * Bitstream width / height, may be different from width/height if lowres
2167 * or other things are used.
21adafec 2168 * - encoding: unused
f5bccd85 2169 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
21adafec
MN
2170 */
2171 int coded_width, coded_height;
bbf18b21
MN
2172
2173 /**
2174 * frame skip threshold
f5bccd85 2175 * - encoding: Set by user.
bbf18b21
MN
2176 * - decoding: unused
2177 */
2178 int frame_skip_threshold;
2179
2180 /**
2181 * frame skip factor
f5bccd85 2182 * - encoding: Set by user.
bbf18b21
MN
2183 * - decoding: unused
2184 */
2185 int frame_skip_factor;
0fd6aea1
MN
2186
2187 /**
2188 * frame skip exponent
f5bccd85 2189 * - encoding: Set by user.
0fd6aea1
MN
2190 * - decoding: unused
2191 */
2192 int frame_skip_exp;
2193
2194 /**
f5bccd85
DB
2195 * frame skip comparison function
2196 * - encoding: Set by user.
0fd6aea1
MN
2197 * - decoding: unused
2198 */
2199 int frame_skip_cmp;
957c743a
CM
2200
2201 /**
f5bccd85 2202 * Border processing masking, raises the quantizer for mbs on the borders
957c743a 2203 * of the picture.
f5bccd85 2204 * - encoding: Set by user.
957c743a
CM
2205 * - decoding: unused
2206 */
2207 float border_masking;
6e0d8c06
MN
2208
2209 /**
f5bccd85
DB
2210 * minimum MB lagrange multipler
2211 * - encoding: Set by user.
6e0d8c06
MN
2212 * - decoding: unused
2213 */
2214 int mb_lmin;
2215
2216 /**
f5bccd85
DB
2217 * maximum MB lagrange multipler
2218 * - encoding: Set by user.
6e0d8c06
MN
2219 * - decoding: unused
2220 */
2221 int mb_lmax;
09c3e44e
MN
2222
2223 /**
115329f1 2224 *
f5bccd85 2225 * - encoding: Set by user.
09c3e44e
MN
2226 * - decoding: unused
2227 */
2228 int me_penalty_compensation;
8c3eba7c
MN
2229
2230 /**
115329f1 2231 *
8c3eba7c 2232 * - encoding: unused
f5bccd85 2233 * - decoding: Set by user.
8c3eba7c
MN
2234 */
2235 enum AVDiscard skip_loop_filter;
2236
2237 /**
115329f1 2238 *
8c3eba7c 2239 * - encoding: unused
f5bccd85 2240 * - decoding: Set by user.
8c3eba7c
MN
2241 */
2242 enum AVDiscard skip_idct;
2243
2244 /**
115329f1 2245 *
8c3eba7c 2246 * - encoding: unused
f5bccd85 2247 * - decoding: Set by user.
8c3eba7c
MN
2248 */
2249 enum AVDiscard skip_frame;
316a2ec8
MN
2250
2251 /**
2252 *
f5bccd85 2253 * - encoding: Set by user.
316a2ec8
MN
2254 * - decoding: unused
2255 */
2256 int bidir_refine;
e8501c93
MN
2257
2258 /**
2259 *
f5bccd85 2260 * - encoding: Set by user.
e8501c93
MN
2261 * - decoding: unused
2262 */
2263 int brd_scale;
58f7833e
RS
2264
2265 /**
2266 * constant rate factor - quality-based VBR - values ~correspond to qps
f5bccd85 2267 * - encoding: Set by user.
58f7833e
RS
2268 * - decoding: unused
2269 */
9f1c1c99 2270 float crf;
58f7833e
RS
2271
2272 /**
2273 * constant quantization parameter rate control method
f5bccd85 2274 * - encoding: Set by user.
58f7833e
RS
2275 * - decoding: unused
2276 */
2277 int cqp;
2278
2279 /**
f5bccd85
DB
2280 * minimum GOP size
2281 * - encoding: Set by user.
58f7833e
RS
2282 * - decoding: unused
2283 */
2284 int keyint_min;
2285
2286 /**
2287 * number of reference frames
f5bccd85 2288 * - encoding: Set by user.
53d55e9e 2289 * - decoding: Set by lavc.
58f7833e
RS
2290 */
2291 int refs;
2292
2293 /**
2294 * chroma qp offset from luma
f5bccd85 2295 * - encoding: Set by user.
58f7833e
RS
2296 * - decoding: unused
2297 */
2298 int chromaoffset;
2299
2300 /**
f5bccd85
DB
2301 * Influences how often B-frames are used.
2302 * - encoding: Set by user.
58f7833e
RS
2303 * - decoding: unused
2304 */
2305 int bframebias;
2306
2307 /**
2308 * trellis RD quantization
f5bccd85 2309 * - encoding: Set by user.
58f7833e
RS
2310 * - decoding: unused
2311 */
2312 int trellis;
2313
2314 /**
f5bccd85
DB
2315 * Reduce fluctuations in qp (before curve compression).
2316 * - encoding: Set by user.
58f7833e
RS
2317 * - decoding: unused
2318 */
2319 float complexityblur;
2320
2321 /**
2322 * in-loop deblocking filter alphac0 parameter
2323 * alpha is in the range -6...6
f5bccd85 2324 * - encoding: Set by user.
58f7833e
RS
2325 * - decoding: unused
2326 */
2327 int deblockalpha;
2328
2329 /**
2330 * in-loop deblocking filter beta parameter
2331 * beta is in the range -6...6
f5bccd85 2332 * - encoding: Set by user.
58f7833e
RS
2333 * - decoding: unused
2334 */
2335 int deblockbeta;
2336
2337 /**
2338 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
f5bccd85 2339 * - encoding: Set by user.
58f7833e
RS
2340 * - decoding: unused
2341 */
2342 int partitions;
56cc85a0
DB
2343#define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2344#define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2345#define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2346#define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2347#define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
58f7833e
RS
2348
2349 /**
30ab4ded 2350 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
f5bccd85 2351 * - encoding: Set by user.
58f7833e
RS
2352 * - decoding: unused
2353 */
2354 int directpred;
4f59b684 2355
14f0c8e2 2356 /**
02c164c1 2357 * Audio cutoff bandwidth (0 means "automatic")
f5bccd85 2358 * - encoding: Set by user.
14f0c8e2
LA
2359 * - decoding: unused
2360 */
2361 int cutoff;
39a64e30
CH
2362
2363 /**
f5bccd85
DB
2364 * Multiplied by qscale for each frame and added to scene_change_score.
2365 * - encoding: Set by user.
39a64e30
CH
2366 * - decoding: unused
2367 */
2368 int scenechange_factor;
1dd509b1
MN
2369
2370 /**
2371 *
f5bccd85
DB
2372 * Note: Value depends upon the compare function used for fullpel ME.
2373 * - encoding: Set by user.
1dd509b1
MN
2374 * - decoding: unused
2375 */
2376 int mv0_threshold;
f9243d34
CH
2377
2378 /**
f5bccd85
DB
2379 * Adjusts sensitivity of b_frame_strategy 1.
2380 * - encoding: Set by user.
f9243d34
CH
2381 * - decoding: unused
2382 */
2383 int b_sensitivity;
a403fc03
JR
2384
2385 /**
f5bccd85 2386 * - encoding: Set by user.
a403fc03
JR
2387 * - decoding: unused
2388 */
2389 int compression_level;
2390#define FF_COMPRESSION_DEFAULT -1
2391
2392 /**
f5bccd85
DB
2393 * Sets whether to use LPC mode - used by FLAC encoder.
2394 * - encoding: Set by user.
2395 * - decoding: unused
a403fc03
JR
2396 */
2397 int use_lpc;
2398
2399 /**
2400 * LPC coefficient precision - used by FLAC encoder
f5bccd85
DB
2401 * - encoding: Set by user.
2402 * - decoding: unused
a403fc03
JR
2403 */
2404 int lpc_coeff_precision;
2405
2406 /**
f5bccd85
DB
2407 * - encoding: Set by user.
2408 * - decoding: unused
a403fc03
JR
2409 */
2410 int min_prediction_order;
2411
2412 /**
f5bccd85
DB
2413 * - encoding: Set by user.
2414 * - decoding: unused
a403fc03
JR
2415 */
2416 int max_prediction_order;
2417
2418 /**
2419 * search method for selecting prediction order
f5bccd85
DB
2420 * - encoding: Set by user.
2421 * - decoding: unused
a403fc03
JR
2422 */
2423 int prediction_order_method;
2424
2425 /**
f5bccd85
DB
2426 * - encoding: Set by user.
2427 * - decoding: unused
a403fc03
JR
2428 */
2429 int min_partition_order;
2430
2431 /**
f5bccd85
DB
2432 * - encoding: Set by user.
2433 * - decoding: unused
a403fc03
JR
2434 */
2435 int max_partition_order;
80d617f5
BC
2436
2437 /**
2438 * GOP timecode frame start number, in non drop frame format
f5bccd85
DB
2439 * - encoding: Set by user.
2440 * - decoding: unused
80d617f5
BC
2441 */
2442 int64_t timecode_frame_start;
b1ec601f 2443
0d72e7d0 2444#if LIBAVCODEC_VERSION_MAJOR < 53
b1ec601f 2445 /**
85947156
VS
2446 * Decoder should decode to this many channels if it can (0 for default)
2447 * - encoding: unused
2448 * - decoding: Set by user.
0d72e7d0 2449 * @deprecated Deprecated in favor of request_channel_layout.
b1ec601f
RD
2450 */
2451 int request_channels;
0d72e7d0 2452#endif
1408352a
JR
2453
2454 /**
2455 * Percentage of dynamic range compression to be applied by the decoder.
2456 * The default value is 1.0, corresponding to full compression.
2457 * - encoding: unused
2458 * - decoding: Set by user.
2459 */
2460 float drc_scale;
79de84f2
MN
2461
2462 /**
2463 * opaque 64bit number (generally a PTS) that will be reordered and
2464 * output in AVFrame.reordered_opaque
2465 * - encoding: unused
2466 * - decoding: Set by user.
2467 */
2468 int64_t reordered_opaque;
312420f3
PR
2469
2470 /**
2471 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2472 * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2473 * - encoding: set by user.
2474 * - decoding: set by libavcodec.
2475 */
2476 int bits_per_raw_sample;
0d72e7d0
PR
2477
2478 /**
2479 * Audio channel layout.
2480 * - encoding: set by user.
2481 * - decoding: set by libavcodec.
2482 */
2483 int64_t channel_layout;
2484
2485 /**
2486 * Request decoder to use this channel layout if it can (0 for default)
2487 * - encoding: unused
2488 * - decoding: Set by user.
2489 */
2490 int64_t request_channel_layout;
3bff4d8b
BC
2491
2492 /**
2493 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2494 * - encoding: Set by user.
2495 * - decoding: unused.
2496 */
2497 float rc_max_available_vbv_use;
2498
2499 /**
2500 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2501 * - encoding: Set by user.
2502 * - decoding: unused.
2503 */
2504 float rc_min_vbv_overflow_use;
40e5d31b
GB
2505
2506 /**
2507 * Hardware accelerator in use
2508 * - encoding: unused.
2509 * - decoding: Set by libavcodec
2510 */
2511 struct AVHWAccel *hwaccel;
3797c74b
MN
2512
2513 /**
2514 * For some codecs, the time base is closer to the field rate than the frame rate.
2515 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2516 * if no telecine is used ...
2517 *
2518 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2519 */
2520 int ticks_per_frame;
1aea7018
GB
2521
2522 /**
2523 * Hardware accelerator context.
2524 * For some hardware accelerators, a global context needs to be
2525 * provided by the user. In that case, this holds display-dependent
2526 * data FFmpeg cannot instantiate itself. Please refer to the
2527 * FFmpeg HW accelerator documentation to know how to fill this
2528 * is. e.g. for VA API, this is a struct vaapi_context.
2529 * - encoding: unused
2530 * - decoding: Set by user
2531 */
2532 void *hwaccel_context;
4ee6a5c1
MN
2533
2534 /**
2535 * Chromaticity coordinates of the source primaries.
2536 * - encoding: Set by user
2537 * - decoding: Set by libavcodec
2538 */
2539 enum AVColorPrimaries color_primaries;
2540
2541 /**
2542 * Color Transfer Characteristic.
2543 * - encoding: Set by user
2544 * - decoding: Set by libavcodec
2545 */
2546 enum AVColorTransferCharacteristic color_trc;
2547
2548 /**
2549 * YUV colorspace type.
2550 * - encoding: Set by user
2551 * - decoding: Set by libavcodec
2552 */
2553 enum AVColorSpace colorspace;
2554
2555 /**
2556 * MPEG vs JPEG YUV range.
2557 * - encoding: Set by user
2558 * - decoding: Set by libavcodec
2559 */
2560 enum AVColorRange color_range;
580a7465
DC
2561
2562 /**
2563 * This defines the location of chroma samples.
2564 * - encoding: Set by user
2565 * - decoding: Set by libavcodec
2566 */
8ea08bec 2567 enum AVChromaLocation chroma_sample_location;
8d23a86f
RD
2568
2569 /**
2570 * The codec may call this to execute several independent things.
2571 * It will return only after finishing all tasks.
2572 * The user may replace this with some multithreaded implementation,
2573 * the default implementation will execute the parts serially.
2574 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2575 * @param c context passed also to func
2576 * @param count the number of things to execute
2577 * @param arg2 argument passed unchanged to func
2578 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2579 * @param func function that will be called count times, with jobnr from 0 to count-1.
2580 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2581 * two instances of func executing at the same time will have the same threadnr.
2582 * @return always 0 currently, but code should handle a future improvement where when any call to func
2583 * returns < 0 no further calls to func may be done and < 0 is returned.
2584 * - encoding: Set by libavcodec, user can override.
2585 * - decoding: Set by libavcodec, user can override.
2586 */
2587 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
096c87f6
JGG
2588
2589 /**
2590 * explicit P-frame weighted prediction analysis method
2591 * 0: off
2592 * 1: fast blind weighting (one reference duplicate with -1 offset)
2593 * 2: smart weighting (full fade detection analysis)
2594 * - encoding: Set by user.
2595 * - decoding: unused
2596 */
2597 int weighted_p_pred;
de6d9b64
FB
2598} AVCodecContext;
2599
64863965
MN
2600/**
2601 * AVCodec.
2602 */
de6d9b64 2603typedef struct AVCodec {
6b0cdb6e
NG
2604 /**
2605 * Name of the codec implementation.
2606 * The name is globally unique among encoders and among decoders (but an
2607 * encoder and a decoder can share the same name).
2608 * This is the primary way to find a codec from the user perspective.
2609 */
18f77016 2610 const char *name;
5d234974 2611 enum CodecType type;
9297ddd3 2612 enum CodecID id;
de6d9b64
FB
2613 int priv_data_size;
2614 int (*init)(AVCodecContext *);
0c1a9eda 2615 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
de6d9b64 2616 int (*close)(AVCodecContext *);
7a00bbad 2617 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
a2d11246
MN
2618 /**
2619 * Codec capabilities.
2620 * see CODEC_CAP_*
2621 */
bf89e6b1 2622 int capabilities;
de6d9b64 2623 struct AVCodec *next;
c8cf325a
MN
2624 /**
2625 * Flush buffers.
2626 * Will be called when seeking
2627 */
7a06ff14 2628 void (*flush)(AVCodecContext *);
716e31ea 2629 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
1beb670a 2630 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
fe4bf374 2631 /**
bf7e799c
SS
2632 * Descriptive name for the codec, meant to be more human readable than name.
2633 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
fe4bf374
SS
2634 */
2635 const char *long_name;
3ade5d56 2636 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
88a07af7 2637 const enum SampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
0d72e7d0 2638 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
de6d9b64
FB
2639} AVCodec;
2640
97d96aaa 2641/**
40e5d31b
GB
2642 * AVHWAccel.
2643 */
2644typedef struct AVHWAccel {
2645 /**
2646 * Name of the hardware accelerated codec.
2647 * The name is globally unique among encoders and among decoders (but an
2648 * encoder and a decoder can share the same name).
2649 */
2650 const char *name;
2651
2652 /**
2653 * Type of codec implemented by the hardware accelerator.
2654 *
2655 * See CODEC_TYPE_xxx
2656 */
2657 enum CodecType type;
2658
2659 /**
2660 * Codec implemented by the hardware accelerator.
2661 *
2662 * See CODEC_ID_xxx
2663 */
2664 enum CodecID id;
2665
2666 /**
2667 * Supported pixel format.
2668 *
2669 * Only hardware accelerated formats are supported here.
2670 */
2671 enum PixelFormat pix_fmt;
2672
2673 /**
2674 * Hardware accelerated codec capabilities.
2675 * see FF_HWACCEL_CODEC_CAP_*
2676 */
2677 int capabilities;
2678
2679 struct AVHWAccel *next;
2680
2681 /**
2682 * Called at the beginning of each frame or field picture.
2683 *
2684 * Meaningful frame information (codec specific) is guaranteed to
2685 * be parsed at this point. This function is mandatory.
2686 *
bf7e799c 2687 * Note that buf can be NULL along with buf_size set to 0.
40e5d31b
GB
2688 * Otherwise, this means the whole frame is available at this point.
2689 *
2690 * @param avctx the codec context
2691 * @param buf the frame data buffer base
2692 * @param buf_size the size of the frame in bytes
2693 * @return zero if successful, a negative value otherwise
2694 */
2695 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2696
2697 /**
2698 * Callback for each slice.
2699 *
2700 * Meaningful slice information (codec specific) is guaranteed to
2701 * be parsed at this point. This function is mandatory.
2702 *
2703 * @param avctx the codec context
2704 * @param buf the slice data buffer base
2705 * @param buf_size the size of the slice in bytes
2706 * @return zero if successful, a negative value otherwise
2707 */
2708 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2709
2710 /**
2711 * Called at the end of each frame or field picture.
2712 *
2713 * The whole picture is parsed at this point and can now be sent
2714 * to the hardware accelerator. This function is mandatory.
2715 *
2716 * @param avctx the codec context
2717 * @return zero if successful, a negative value otherwise
2718 */
2719 int (*end_frame)(AVCodecContext *avctx);
68e5d523
GB
2720
2721 /**
2722 * Size of HW accelerator private data.
2723 *
cd823ff9
GB
2724 * Private data is allocated with av_mallocz() before
2725 * AVCodecContext.get_buffer() and deallocated after
2726 * AVCodecContext.release_buffer().
68e5d523
GB
2727 */
2728 int priv_data_size;
40e5d31b
GB
2729} AVHWAccel;
2730
2731/**
d7425f59
MN
2732 * four components are given, that's all.
2733 * the last component is alpha
2734 */
de6d9b64 2735typedef struct AVPicture {
0c1a9eda 2736 uint8_t *data[4];
cd394651 2737 int linesize[4]; ///< number of bytes per line
de6d9b64
FB
2738} AVPicture;
2739
2bbd8571 2740#if LIBAVCODEC_VERSION_MAJOR < 53
ba118447 2741/**
85947156
VS
2742 * AVPaletteControl
2743 * This structure defines a method for communicating palette changes
2744 * between and demuxer and a decoder.
2745 *
671adb17 2746 * @deprecated Use AVPacket to send palette changes instead.
85947156 2747 * This is totally broken.
ba118447 2748 */
2e99641b 2749#define AVPALETTE_SIZE 1024
432d84c3 2750#define AVPALETTE_COUNT 256
ba118447
MM
2751typedef struct AVPaletteControl {
2752
f5bccd85
DB
2753 /* Demuxer sets this to 1 to indicate the palette has changed;
2754 * decoder resets to 0. */
ba118447
MM
2755 int palette_changed;
2756
2a2bbcb0
MM
2757 /* 4-byte ARGB palette entries, stored in native byte order; note that
2758 * the individual palette components should be on a 8-bit scale; if
f5bccd85
DB
2759 * the palette data comes from an IBM VGA native format, the component
2760 * data is probably 6 bits in size and needs to be scaled. */
2e99641b 2761 unsigned int palette[AVPALETTE_COUNT];
ba118447 2762
18239edf 2763} AVPaletteControl attribute_deprecated;
2bbd8571 2764#endif
ba118447 2765
c66216ed
MN
2766enum AVSubtitleType {
2767 SUBTITLE_NONE,
2768
2769 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2770
2771 /**
2772 * Plain text, the text field must be set by the decoder and is
2773 * authoritative. ass and pict fields may contain approximations.
2774 */
2775 SUBTITLE_TEXT,
2776
2777 /**
2778 * Formatted text, the ass field must be set by the decoder and is
2779 * authoritative. pict and text fields may contain approximations.
2780 */
2781 SUBTITLE_ASS,
2782};
2783
c6ec28b1 2784typedef struct AVSubtitleRect {
ebc466bb
MN
2785 int x; ///< top left corner of pict, undefined when pict is not set
2786 int y; ///< top left corner of pict, undefined when pict is not set
2787 int w; ///< width of pict, undefined when pict is not set
2788 int h; ///< height of pict, undefined when pict is not set
2789 int nb_colors; ///< number of colors in pict, undefined when pict is not set
25b4c651
MN
2790
2791 /**
2792 * data+linesize for the bitmap of this subtitle.
2793 * can be set for text/ass as well once they where rendered
2794 */
2795 AVPicture pict;
f656106f
MN
2796 enum AVSubtitleType type;
2797
2798 char *text; ///< 0 terminated plain UTF-8 text
2799
2800 /**
2801 * 0 terminated ASS/SSA compatible event line.
2802 * The pressentation of this is unaffected by the other values in this
2803 * struct.
2804 */
2805 char *ass;
c6ec28b1
MN
2806} AVSubtitleRect;
2807
2808typedef struct AVSubtitle {
2809 uint16_t format; /* 0 = graphics */
2810 uint32_t start_display_time; /* relative to packet pts, in ms */
2811 uint32_t end_display_time; /* relative to packet pts, in ms */
ebc466bb 2812 unsigned num_rects;
db4fac64 2813 AVSubtitleRect **rects;
4bbe788a 2814 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
240c1657
FB
2815} AVSubtitle;
2816
cdd8930e
TB
2817/* packet functions */
2818
80d403fc
RD
2819/**
2820 * @deprecated use NULL instead
2821 */
2822attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
cdd8930e
TB
2823
2824/**
2825 * Default packet destructor.
2826 */
2827void av_destruct_packet(AVPacket *pkt);
2828
2829/**
2830 * Initialize optional fields of a packet with default values.
2831 *
2832 * @param pkt packet
2833 */
2834void av_init_packet(AVPacket *pkt);
2835
2836/**
2837 * Allocate the payload of a packet and initialize its fields with
2838 * default values.
2839 *
2840 * @param pkt packet
2841 * @param size wanted payload size
2842 * @return 0 if OK, AVERROR_xxx otherwise
2843 */
2844int av_new_packet(AVPacket *pkt, int size);
2845
2846/**
feb993e5
RD
2847 * Reduce packet size, correctly zeroing padding
2848 *
2849 * @param pkt packet
2850 * @param size new size
2851 */
2852void av_shrink_packet(AVPacket *pkt, int size);
2853
2854/**
cdd8930e
TB
2855 * @warning This is a hack - the packet memory allocation stuff is broken. The
2856 * packet is allocated if it was not really allocated.
2857 */
2858int av_dup_packet(AVPacket *pkt);
2859
2860/**
2861 * Free a packet.
2862 *
2863 * @param pkt packet to free
2864 */
ce1d9c85 2865void av_free_packet(AVPacket *pkt);
240c1657 2866
de6d9b64
FB
2867/* resample.c */
2868
2869struct ReSampleContext;
aaaf1635 2870struct AVResampleContext;
de6d9b64
FB
2871
2872typedef struct ReSampleContext ReSampleContext;
2873
d1e3c6fd
BC
2874#if LIBAVCODEC_VERSION_MAJOR < 53
2875/**
2876 * @deprecated Use av_audio_resample_init() instead.
2877 */
2878attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2879 int output_rate, int input_rate);
2880#endif
2881/**
2882 * Initializes audio resampling context
2883 *
2884 * @param output_channels number of output channels
2885 * @param input_channels number of input channels
2886 * @param output_rate output sample rate
2887 * @param input_rate input sample rate
2888 * @param sample_fmt_out requested output sample format
2889 * @param sample_fmt_in input sample format
2890 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2891 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2892 * @param linear If 1 then the used FIR filter will be linearly interpolated
2893 between the 2 closest, if 0 the closest will be used
2894 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2895 * @return allocated ReSampleContext, NULL if error occured
2896 */
2897ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2898 int output_rate, int input_rate,
2899 enum SampleFormat sample_fmt_out,
2900 enum SampleFormat sample_fmt_in,
2901 int filter_length, int log2_phase_count,
2902 int linear, double cutoff);
2903
de6d9b64
FB
2904int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2905void audio_resample_close(ReSampleContext *s);
2906
3136fcf4
MN
2907
2908/**
2909 * Initializes an audio resampler.
2910 * Note, if either rate is not an integer then simply scale both rates up so they are.
990058bd
MN
2911 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2912 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2913 * @param linear If 1 then the used FIR filter will be linearly interpolated
2914 between the 2 closest, if 0 the closest will be used
2915 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3136fcf4 2916 */
6e225de2 2917struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3136fcf4
MN
2918
2919/**
2920 * resamples.
2921 * @param src an array of unconsumed samples
2922 * @param consumed the number of samples of src which have been consumed are returned here
2923 * @param src_size the number of unconsumed samples available
2924 * @param dst_size the amount of space in samples available in dst
2925 * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
2926 * @return the number of samples written in dst or -1 if an error occurred
2927 */
aaaf1635 2928int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3136fcf4
MN
2929
2930
2931/**
2932 * Compensates samplerate/timestamp drift. The compensation is done by changing
2933 * the resampler parameters, so no audible clicks or similar distortions occur
2934 * @param compensation_distance distance in output samples over which the compensation should be performed
2935 * @param sample_delta number of output samples which should be output less
2936 *
2937 * example: av_resample_compensate(c, 10, 500)
2938 * here instead of 510 samples only 500 samples would be output
2939 *
2940 * note, due to rounding the actual compensation might be slightly different,
2941 * especially if the compensation_distance is large and the in_rate used during init is small
2942 */
2d48eddd 2943void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
d88443ae 2944void av_resample_close(struct AVResampleContext *c);
aaaf1635 2945
75917b88
DH
2946/**
2947 * Allocate memory for a picture. Call avpicture_free to free it.
2948 *
f5bccd85
DB
2949 * @param picture the picture to be filled in
2950 * @param pix_fmt the format of the picture
2951 * @param width the width of the picture
2952 * @param height the height of the picture
2953 * @return zero if successful, a negative value if not
75917b88 2954 */
a61ec8e7 2955int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
75917b88 2956
8fc3d25c
PI
2957/**
2958 * Free a picture previously allocated by avpicture_alloc().
2959 *
f5bccd85 2960 * @param picture the AVPicture to be freed
8fc3d25c 2961 */
75917b88
DH
2962void avpicture_free(AVPicture *picture);
2963
392cf77a 2964/**
f5bccd85 2965 * Fill in the AVPicture fields.
392cf77a
PI
2966 * The fields of the given AVPicture are filled in by using the 'ptr' address
2967 * which points to the image data buffer. Depending on the specified picture
2968 * format, one or multiple image data pointers and line sizes will be set.
2969 * If a planar format is specified, several pointers will be set pointing to
2970 * the different picture planes and the line sizes of the different planes
2971 * will be stored in the lines_sizes array.
899a8fa1 2972 * Call with ptr == NULL to get the required size for the ptr buffer.
392cf77a 2973 *
f5bccd85 2974 * @param picture AVPicture whose fields are to be filled in
392cf77a 2975 * @param ptr Buffer which will contain or contains the actual image data
f5bccd85
DB
2976 * @param pix_fmt The format in which the picture data is stored.
2977 * @param width the width of the image in pixels
2978 * @param height the height of the image in pixels
2979 * @return size of the image data in bytes
392cf77a 2980 */
0c1a9eda 2981int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4a30fff6 2982 enum PixelFormat pix_fmt, int width, int height);
a61ec8e7 2983int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
63167088 2984 unsigned char *dest, int dest_size);
392cf77a
PI
2985
2986/**
2987 * Calculate the size in bytes that a picture of the given width and height
2988 * would occupy if stored in the given picture format.
899a8fa1
RD
2989 * Note that this returns the size of a compact representation as generated
2990 * by avpicture_layout, which can be smaller than the size required for e.g.
2991 * avpicture_fill.
392cf77a 2992 *
f5bccd85
DB
2993 * @param pix_fmt the given picture format
2994 * @param width the width of the image
2995 * @param height the height of the image
899a8fa1 2996 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
392cf77a 2997 */
a61ec8e7
SS
2998int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
2999void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3000const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
21adafec 3001void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
d89f692f 3002
80a07f6e 3003#if LIBAVCODEC_VERSION_MAJOR < 53
d89f692f 3004/**
bf7e799c 3005 * Returns the pixel format corresponding to the name name.
d89f692f 3006 *
bf7e799c 3007 * If there is no pixel format with name name, then looks for a
d89f692f 3008 * pixel format with the name corresponding to the native endian
bf7e799c 3009 * format of name.
d89f692f
SS
3010 * For example in a little-endian system, first looks for "gray16",
3011 * then for "gray16le".
3012 *
bf7e799c 3013 * Finally if no pixel format has been found, returns PIX_FMT_NONE.
80a07f6e
SS
3014 *
3015 * @deprecated Deprecated in favor of av_get_pix_fmt().
d89f692f 3016 */
80a07f6e
SS
3017attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3018#endif
fa4dc9f0
SS
3019
3020/**
3021 * Returns a value representing the fourCC code associated to the
3022 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3023 * found.
3024 */
3025unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
219b06c6 3026
81299d42
PI
3027#define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3028#define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3029#define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3030#define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3031#define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3032#define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
fab21997 3033
392cf77a 3034/**
81299d42
PI
3035 * Computes what kind of losses will occur when converting from one specific
3036 * pixel format to another.
3037 * When converting from one pixel format to another, information loss may occur.
3038 * For example, when converting from RGB24 to GRAY, the color information will
3039 * be lost. Similarly, other losses occur when converting from some formats to
3040 * other formats. These losses can involve loss of chroma, but also loss of
3041 * resolution, loss of color depth, loss due to the color space conversion, loss
3042 * of the alpha bits or loss due to color quantization.
f5bccd85
DB
3043 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3044 * which will occur when converting from one pixel format to another.
81299d42 3045 *
f5bccd85
DB
3046 * @param[in] dst_pix_fmt destination pixel format
3047 * @param[in] src_pix_fmt source pixel format
81299d42
PI
3048 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3049 * @return Combination of flags informing you what kind of losses will occur.
392cf77a 3050 */
a61ec8e7 3051int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
fab21997 3052 int has_alpha);
392cf77a
PI
3053
3054/**
81299d42
PI
3055 * Finds the best pixel format to convert to given a certain source pixel
3056 * format. When converting from one pixel format to another, information loss
3057 * may occur. For example, when converting from RGB24 to GRAY, the color
3058 * information will be lost. Similarly, other losses occur when converting from
3059 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
f5bccd85
DB
3060 * the given pixel formats should be used to suffer the least amount of loss.
3061 * The pixel formats from which it chooses one, are determined by the
bf7e799c 3062 * pix_fmt_mask parameter.
81299d42
PI
3063 *
3064 * @code
3065 * src_pix_fmt = PIX_FMT_YUV420P;
3066 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3067 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3068 * @endcode
3069 *
f5bccd85
DB
3070 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3071 * @param[in] src_pix_fmt source pixel format
81299d42
PI
3072 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3073 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3074 * @return The best pixel format to convert to or -1 if none was found.
392cf77a 3075 */
a61ec8e7 3076enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
fab21997
FB
3077 int has_alpha, int *loss_ptr);
3078
c3b95b1d
SS
3079
3080/**
3081 * Print in buf the string corresponding to the pixel format with
3082 * number pix_fmt, or an header if pix_fmt is negative.
3083 *
9bd51b9a
PI
3084 * @param[in] buf the buffer where to write the string
3085 * @param[in] buf_size the size of buf
3086 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
c3b95b1d
SS
3087 * a negative value to print the corresponding header.
3088 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
3089 */
a61ec8e7 3090void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
c3b95b1d 3091
0469baf1
FB
3092#define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3093#define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
392cf77a
PI
3094
3095/**
3096 * Tell if an image really has transparent alpha values.
3097 * @return ored mask of FF_ALPHA_xxx constants
3098 */
da64ecc3 3099int img_get_alpha_info(const AVPicture *src,
a61ec8e7 3100 enum PixelFormat pix_fmt, int width, int height);
0469baf1 3101
219b06c6 3102/* deinterlace a picture */
392cf77a 3103/* deinterlace - if not supported return -1 */
da64ecc3 3104int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
a61ec8e7 3105 enum PixelFormat pix_fmt, int width, int height);
de6d9b64
FB
3106
3107/* external high level API */
3108
0334f799
SS
3109/**
3110 * If c is NULL, returns the first registered codec,
c1b02101 3111 * if c is non-NULL, returns the next registered codec after c,
0334f799
SS
3112 * or NULL if c is the last one.
3113 */
55b9e69a 3114AVCodec *av_codec_next(AVCodec *c);
de6d9b64 3115
96afa6be
SS
3116/**
3117 * Returns the LIBAVCODEC_VERSION_INT constant.
3118 */
51a49663 3119unsigned avcodec_version(void);
96afa6be 3120
f9ec0aa1 3121/**
c1736936
DB
3122 * Returns the libavcodec build-time configuration.
3123 */
41600690 3124const char *avcodec_configuration(void);
c1736936
DB
3125
3126/**
3127 * Returns the libavcodec license.
3128 */
41600690 3129const char *avcodec_license(void);
c1736936
DB
3130
3131/**
f9ec0aa1
PI
3132 * Initializes libavcodec.
3133 *
bf7e799c 3134 * @warning This function must be called before any other libavcodec
f9ec0aa