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