* Start using enumerated types (makes debugging much easier)
[ffmpeg.git] / libavcodec / avcodec.h
1 #ifndef AVCODEC_H
2 #define AVCODEC_H
3
4 #include "common.h"
5
6 #define LIBAVCODEC_VERSION_INT 0x000406
7 #define LIBAVCODEC_VERSION     "0.4.6"
8 #define LIBAVCODEC_BUILD       4605
9 #define LIBAVCODEC_BUILD_STR   "4605"
10
11 enum CodecID {
12     CODEC_ID_NONE, 
13     CODEC_ID_MPEG1VIDEO,
14     CODEC_ID_H263,
15     CODEC_ID_RV10,
16     CODEC_ID_MP2,
17     CODEC_ID_MP3LAME,
18     CODEC_ID_AC3,
19     CODEC_ID_MJPEG,
20     CODEC_ID_MPEG4,
21     CODEC_ID_RAWVIDEO,
22     CODEC_ID_MSMPEG4V1,
23     CODEC_ID_MSMPEG4V2,
24     CODEC_ID_MSMPEG4V3,
25     CODEC_ID_WMV1,
26     CODEC_ID_H263P,
27     CODEC_ID_H263I,
28
29     /* various pcm "codecs" */
30     CODEC_ID_PCM_S16LE,
31     CODEC_ID_PCM_S16BE,
32     CODEC_ID_PCM_U16LE,
33     CODEC_ID_PCM_U16BE,
34     CODEC_ID_PCM_S8,
35     CODEC_ID_PCM_U8,
36     CODEC_ID_PCM_MULAW,
37     CODEC_ID_PCM_ALAW,
38 };
39 #define CODEC_ID_MSMPEG4 CODEC_ID_MSMPEG4V3
40
41 enum CodecType {
42     CODEC_TYPE_UNKNOWN = -1,
43     CODEC_TYPE_VIDEO,
44     CODEC_TYPE_AUDIO,
45 };
46
47 enum PixelFormat {
48     PIX_FMT_ANY = -1,
49     PIX_FMT_YUV420P,
50     PIX_FMT_YUV422,
51     PIX_FMT_RGB24,
52     PIX_FMT_BGR24,
53     PIX_FMT_YUV422P,
54     PIX_FMT_YUV444P,
55 };
56
57 /* currently unused, may be used if 24/32 bits samples ever supported */
58 enum SampleFormat {
59     SAMPLE_FMT_S16 = 0,         /* signed 16 bits */
60 };
61
62 /* in bytes */
63 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 18432
64
65 /* motion estimation type, EPZS by default */
66 enum Motion_Est_ID {
67     ME_ZERO = 1,
68     ME_FULL,
69     ME_LOG,
70     ME_PHODS,
71     ME_EPZS,
72     ME_X1
73 };
74
75 /* only for ME compatiblity with old apps */
76 extern int motion_estimation_method;
77
78 /* ME algos sorted by quality */
79 static const int Motion_Est_QTab[] = { ME_ZERO, ME_PHODS, ME_LOG, 
80                                        ME_X1, ME_EPZS, ME_FULL };
81
82 #define FF_MAX_B_FRAMES 4
83
84 /* encoding support */
85 /* note not everything is supported yet */
86
87 #define CODEC_FLAG_HQ     0x0001 /* high quality (non real time) encoding */
88 #define CODEC_FLAG_QSCALE 0x0002 /* use fixed qscale */
89 #define CODEC_FLAG_4MV    0x0004 /* 4 MV per MB allowed */
90 #define CODEC_FLAG_QPEL   0x0010 /* use qpel MC */
91 #define CODEC_FLAG_GMC    0x0020 /* use GMC */
92 #define CODEC_FLAG_TYPE   0x0040 /* fixed I/P frame type, from avctx->key_frame */
93 /* parent program gurantees that the input for b-frame containing streams is not written to 
94    for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
95 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
96 #define CODEC_FLAG_PASS1 0x0200  /* use internal 2pass ratecontrol in first  pass mode */
97 #define CODEC_FLAG_PASS2 0x0400  /* use internal 2pass ratecontrol in second pass mode */
98 #define CODEC_FLAG_EXTERN_HUFF 0x1000 /* use external huffman table (for mjpeg) */
99
100 /* codec capabilities */
101
102 /* decoder can use draw_horiz_band callback */
103 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001
104
105 #define FRAME_RATE_BASE 10000
106
107 typedef struct AVCodecContext {
108     int bit_rate;
109     int bit_rate_tolerance; /* amount of +- bits (>0)*/
110     int flags;
111     int sub_id;    /* some codecs needs additionnal format info. It is
112                       stored there */
113     
114     int me_method; /* ME algorithm used for video coding */
115     
116     /* extra data from parent application to codec, e.g. huffman table
117        for mjpeg */
118     /* the parent should allocate and free this buffer */
119     void *extradata;
120     int extradata_size;
121     
122     /* video only */
123     int frame_rate; /* frames per sec multiplied by FRAME_RATE_BASE */
124     int width, height;
125     int aspect_ratio_info;
126 #define FF_ASPECT_SQUARE 1
127 #define FF_ASPECT_4_3_625 2
128 #define FF_ASPECT_4_3_525 3
129 #define FF_ASPECT_16_9_625 4
130 #define FF_ASPECT_16_9_525 5
131     int gop_size; /* 0 = intra only */
132     enum PixelFormat pix_fmt;  /* pixel format, see PIX_FMT_xxx */
133
134     /* if non NULL, 'draw_horiz_band' is called by the libavcodec
135        decoder to draw an horizontal band. It improve cache usage. Not
136        all codecs can do that. You must check the codec capabilities
137        before */
138     void (*draw_horiz_band)(struct AVCodecContext *s,
139                             UINT8 **src_ptr, int linesize,
140                             int y, int width, int height);
141
142     /* audio only */
143     int sample_rate; /* samples per sec */
144     int channels;
145     int sample_fmt;  /* sample format, currenly unused */
146
147     /* the following data should not be initialized */
148     int frame_size; /* in samples, initialized when calling 'init' */
149     int frame_number; /* audio or video frame number */
150     int key_frame;    /* true if the previous compressed frame was 
151                          a key frame (intra, or seekable) */
152     int delay;        /* number of frames the decoded output will be delayed relative to the encoded input */
153     uint8_t *mbskip_table; /* =1 if MB didnt change, is only valid for I/P frames 
154                               stride= mb_width = (width+15)>>4 */
155     
156     /* encoding parameters */
157     int quality;      /* quality of the previous encoded frame 
158                          (between 1 (good) and 31 (bad)) 
159                          this is allso used to set the quality in vbr mode
160                          and the per frame quality in CODEC_FLAG_TYPE (second pass mode) */
161     float qcompress;  /* amount of qscale change between easy & hard scenes (0.0-1.0)*/
162     float qblur;      /* amount of qscale smoothing over time (0.0-1.0) */
163     int qmin;         /* min qscale */
164     int qmax;         /* max qscale */
165     int max_qdiff;    /* max qscale difference between frames */
166     int max_b_frames; /* maximum b frames, the output will be delayed by max_b_frames+1 relative to the input */
167     float b_quant_factor;/* qscale factor between ips and b frames */
168     int rc_strategy;
169     int b_frame_strategy;
170
171     int hurry_up;     /* when set to 1 during decoding, b frames will be skiped
172                          when set to 2 idct/dequant will be skipped too */
173     
174     struct AVCodec *codec;
175     void *priv_data;
176
177     /* The following data is for RTP friendly coding */
178     /* By now only H.263/H.263+ coder honours this   */
179     int rtp_mode;   /* 1 for activate RTP friendly-mode           */
180                     /* highers numbers represent more error-prone */
181                     /* enviroments, by now just "1" exist         */
182     
183     int rtp_payload_size;   /* The size of the RTP payload, the coder will  */
184                             /* do it's best to deliver a chunk with size    */
185                             /* below rtp_payload_size, the chunk will start */
186                             /* with a start code on some codecs like H.263  */
187                             /* This doesn't take account of any particular  */
188                             /* headers inside the transmited RTP payload    */
189
190     
191     /* The RTP callcack: This function is called  */
192     /* every time the encoder as a packet to send */
193     /* Depends on the encoder if the data starts  */
194     /* with a Start Code (it should) H.263 does   */
195     void (*rtp_callback)(void *data, int size, int packet_number); 
196
197     /* These are for PSNR calculation, if you set get_psnr to 1 */
198     /* after encoding you will have the PSNR on psnr_y/cb/cr    */
199     int get_psnr;
200     float psnr_y;
201     float psnr_cb;
202     float psnr_cr;
203     
204     /* statistics, used for 2-pass encoding */
205     int mv_bits;
206     int header_bits;
207     int i_tex_bits;
208     int p_tex_bits;
209     int i_count;
210     int p_count;
211     int skip_count;
212     int misc_bits; // cbp, mb_type
213     int frame_bits;
214                  
215     /* the following fields are ignored */
216     void *opaque;   /* can be used to carry app specific stuff */
217     char codec_name[32];
218     enum CodecType codec_type; /* see CODEC_TYPE_xxx */
219     enum CodecID codec_id; /* see CODEC_ID_xxx */
220     unsigned int codec_tag;  /* codec tag, only used if unknown codec */
221 } AVCodecContext;
222
223 typedef struct AVCodec {
224     char *name;
225     int type;
226     int id;
227     int priv_data_size;
228     int (*init)(AVCodecContext *);
229     int (*encode)(AVCodecContext *, UINT8 *buf, int buf_size, void *data);
230     int (*close)(AVCodecContext *);
231     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, 
232                   UINT8 *buf, int buf_size);
233     int capabilities;
234     struct AVCodec *next;
235 } AVCodec;
236
237 /* three components are given, that's all */
238 typedef struct AVPicture {
239     UINT8 *data[3];
240     int linesize[3];
241 } AVPicture;
242
243 extern AVCodec ac3_encoder;
244 extern AVCodec mp2_encoder;
245 extern AVCodec mp3lame_encoder;
246 extern AVCodec mpeg1video_encoder;
247 extern AVCodec h263_encoder;
248 extern AVCodec h263p_encoder;
249 extern AVCodec rv10_encoder;
250 extern AVCodec mjpeg_encoder;
251 extern AVCodec mpeg4_encoder;
252 extern AVCodec msmpeg4v1_encoder;
253 extern AVCodec msmpeg4v2_encoder;
254 extern AVCodec msmpeg4v3_encoder;
255
256 extern AVCodec h263_decoder;
257 extern AVCodec mpeg4_decoder;
258 extern AVCodec msmpeg4v1_decoder;
259 extern AVCodec msmpeg4v2_decoder;
260 extern AVCodec msmpeg4v3_decoder;
261 extern AVCodec wmv1_decoder;
262 extern AVCodec mpeg_decoder;
263 extern AVCodec h263i_decoder;
264 extern AVCodec rv10_decoder;
265 extern AVCodec mjpeg_decoder;
266 extern AVCodec mp2_decoder;
267 extern AVCodec mp3_decoder;
268
269 /* pcm codecs */
270 #define PCM_CODEC(id, name) \
271 extern AVCodec name ## _decoder; \
272 extern AVCodec name ## _encoder;
273
274 PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
275 PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
276 PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
277 PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
278 PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
279 PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
280 PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
281 PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
282
283 #undef PCM_CODEC
284
285 /* dummy raw video codec */
286 extern AVCodec rawvideo_codec;
287
288 /* the following codecs use external GPL libs */
289 extern AVCodec ac3_decoder;
290
291 /* resample.c */
292
293 struct ReSampleContext;
294
295 typedef struct ReSampleContext ReSampleContext;
296
297 ReSampleContext *audio_resample_init(int output_channels, int input_channels, 
298                                      int output_rate, int input_rate);
299 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
300 void audio_resample_close(ReSampleContext *s);
301
302 /* YUV420 format is assumed ! */
303
304 struct ImgReSampleContext;
305
306 typedef struct ImgReSampleContext ImgReSampleContext;
307
308 ImgReSampleContext *img_resample_init(int output_width, int output_height,
309                                       int input_width, int input_height);
310 void img_resample(ImgReSampleContext *s, 
311                   AVPicture *output, AVPicture *input);
312
313 void img_resample_close(ImgReSampleContext *s);
314
315 void avpicture_fill(AVPicture *picture, UINT8 *ptr,
316                     int pix_fmt, int width, int height);
317 int avpicture_get_size(int pix_fmt, int width, int height);
318
319 /* convert among pixel formats */
320 int img_convert(AVPicture *dst, int dst_pix_fmt,
321                 AVPicture *src, int pix_fmt, 
322                 int width, int height);
323
324 /* deinterlace a picture */
325 int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
326                           int pix_fmt, int width, int height);
327
328 /* external high level API */
329
330 extern AVCodec *first_avcodec;
331
332 /* returns LIBAVCODEC_VERSION_INT constant */
333 unsigned avcodec_version( void );
334 void avcodec_init(void);
335
336 void register_avcodec(AVCodec *format);
337 AVCodec *avcodec_find_encoder(enum CodecID id);
338 AVCodec *avcodec_find_encoder_by_name(const char *name);
339 AVCodec *avcodec_find_decoder(enum CodecID id);
340 AVCodec *avcodec_find_decoder_by_name(const char *name);
341 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
342
343 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
344 int avcodec_decode_audio(AVCodecContext *avctx, INT16 *samples, 
345                          int *frame_size_ptr,
346                          UINT8 *buf, int buf_size);
347 int avcodec_decode_video(AVCodecContext *avctx, AVPicture *picture, 
348                          int *got_picture_ptr,
349                          UINT8 *buf, int buf_size);
350 int avcodec_encode_audio(AVCodecContext *avctx, UINT8 *buf, int buf_size, 
351                          const short *samples);
352 int avcodec_encode_video(AVCodecContext *avctx, UINT8 *buf, int buf_size, 
353                          const AVPicture *pict);
354
355 int avcodec_close(AVCodecContext *avctx);
356
357 void avcodec_register_all(void);
358
359 void avcodec_flush_buffers(AVCodecContext *avctx);
360
361 #ifdef FF_POSTPROCESS
362 #ifndef MBC
363 #define MBC 128
364 #define MBR 96
365 #endif
366 extern int quant_store[MBR+1][MBC+1]; // [Review]
367 #endif
368
369 #endif /* AVCODEC_H */