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