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