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