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