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