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