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