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