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