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