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