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