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