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