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