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