* by Thomas Sailer:
[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"
2417652e
MN
8#define LIBAVCODEC_BUILD 4604
9#define LIBAVCODEC_BUILD_STR "4604"
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 143 int delay; /* number of frames the decoded output will be delayed relative to the encoded input */
2417652e
MN
144 uint8_t *mbskip_table; /* =1 if MB didnt change, is only valid for I/P frames
145 stride= mb_width = (width+15)>>4 */
1ff662cc
MN
146
147 /* encoding parameters */
de6d9b64 148 int quality; /* quality of the previous encoded frame
8b4c7dbc
MN
149 (between 1 (good) and 31 (bad))
150 this is allso used to set the quality in vbr mode
151 and the per frame quality in CODEC_FLAG_TYPE (second pass mode) */
9cdd6a24
MN
152 float qcompress; /* amount of qscale change between easy & hard scenes (0.0-1.0)*/
153 float qblur; /* amount of qscale smoothing over time (0.0-1.0) */
154 int qmin; /* min qscale */
155 int qmax; /* max qscale */
156 int max_qdiff; /* max qscale difference between frames */
9dbcbd92 157 int max_b_frames; /* maximum b frames, the output will be delayed by max_b_frames+1 relative to the input */
8b4c7dbc
MN
158 float b_quant_factor;/* qscale factor between ips and b frames */
159 int rc_strategy;
160 int b_frame_strategy;
9dbcbd92 161
2417652e
MN
162 int hurry_up; /* when set to 1 during decoding, b frames will be skiped
163 when set to 2 idct/dequant will be skipped too */
164
de6d9b64
FB
165 struct AVCodec *codec;
166 void *priv_data;
167
644d98a4
J
168 /* The following data is for RTP friendly coding */
169 /* By now only H.263/H.263+ coder honours this */
170 int rtp_mode; /* 1 for activate RTP friendly-mode */
171 /* highers numbers represent more error-prone */
172 /* enviroments, by now just "1" exist */
173
174 int rtp_payload_size; /* The size of the RTP payload, the coder will */
175 /* do it's best to deliver a chunk with size */
176 /* below rtp_payload_size, the chunk will start */
177 /* with a start code on some codecs like H.263 */
178 /* This doesn't take account of any particular */
179 /* headers inside the transmited RTP payload */
81401c1f
J
180
181
182 /* The RTP callcack: This function is called */
183 /* every time the encoder as a packet to send */
184 /* Depends on the encoder if the data starts */
185 /* with a Start Code (it should) H.263 does */
186 void (*rtp_callback)(void *data, int size, int packet_number);
187
43f1708f
J
188 /* These are for PSNR calculation, if you set get_psnr to 1 */
189 /* after encoding you will have the PSNR on psnr_y/cb/cr */
190 int get_psnr;
191 float psnr_y;
192 float psnr_cb;
193 float psnr_cr;
098eefe1
MN
194
195 /* statistics, used for 2-pass encoding */
196 int mv_bits;
197 int header_bits;
198 int i_tex_bits;
199 int p_tex_bits;
200 int i_count;
201 int p_count;
202 int skip_count;
203 int misc_bits; // cbp, mb_type
204 int frame_bits;
644d98a4 205
de6d9b64 206 /* the following fields are ignored */
bf89e6b1 207 void *opaque; /* can be used to carry app specific stuff */
de6d9b64
FB
208 char codec_name[32];
209 int codec_type; /* see CODEC_TYPE_xxx */
210 int codec_id; /* see CODEC_ID_xxx */
211 unsigned int codec_tag; /* codec tag, only used if unknown codec */
212} AVCodecContext;
213
214typedef struct AVCodec {
215 char *name;
216 int type;
217 int id;
218 int priv_data_size;
219 int (*init)(AVCodecContext *);
220 int (*encode)(AVCodecContext *, UINT8 *buf, int buf_size, void *data);
221 int (*close)(AVCodecContext *);
222 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
223 UINT8 *buf, int buf_size);
bf89e6b1 224 int capabilities;
de6d9b64
FB
225 struct AVCodec *next;
226} AVCodec;
227
228/* three components are given, that's all */
229typedef struct AVPicture {
230 UINT8 *data[3];
231 int linesize[3];
232} AVPicture;
233
234extern AVCodec ac3_encoder;
235extern AVCodec mp2_encoder;
9d36bdc9 236extern AVCodec mp3lame_encoder;
de6d9b64
FB
237extern AVCodec mpeg1video_encoder;
238extern AVCodec h263_encoder;
239extern AVCodec h263p_encoder;
240extern AVCodec rv10_encoder;
241extern AVCodec mjpeg_encoder;
bf89e6b1 242extern AVCodec mpeg4_encoder;
84afee34
MN
243extern AVCodec msmpeg4v1_encoder;
244extern AVCodec msmpeg4v2_encoder;
245extern AVCodec msmpeg4v3_encoder;
de6d9b64
FB
246
247extern AVCodec h263_decoder;
bf89e6b1 248extern AVCodec mpeg4_decoder;
84afee34
MN
249extern AVCodec msmpeg4v1_decoder;
250extern AVCodec msmpeg4v2_decoder;
251extern AVCodec msmpeg4v3_decoder;
e1a9dbff 252extern AVCodec wmv1_decoder;
de6d9b64
FB
253extern AVCodec mpeg_decoder;
254extern AVCodec h263i_decoder;
255extern AVCodec rv10_decoder;
4e66ab3b 256extern AVCodec mjpeg_decoder;
4b1f4f23 257extern AVCodec mp2_decoder;
a96b68b7 258extern AVCodec mp3_decoder;
de6d9b64 259
a96b68b7
FB
260/* pcm codecs */
261#define PCM_CODEC(id, name) \
262extern AVCodec name ## _decoder; \
263extern AVCodec name ## _encoder;
264
265PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
266PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
267PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
268PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
269PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
270PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
271PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
272PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
273
274#undef PCM_CODEC
275
276/* dummy raw video codec */
de6d9b64
FB
277extern AVCodec rawvideo_codec;
278
279/* the following codecs use external GPL libs */
de6d9b64
FB
280extern AVCodec ac3_decoder;
281
282/* resample.c */
283
284struct ReSampleContext;
285
286typedef struct ReSampleContext ReSampleContext;
287
288ReSampleContext *audio_resample_init(int output_channels, int input_channels,
289 int output_rate, int input_rate);
290int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
291void audio_resample_close(ReSampleContext *s);
292
293/* YUV420 format is assumed ! */
294
295struct ImgReSampleContext;
296
297typedef struct ImgReSampleContext ImgReSampleContext;
298
299ImgReSampleContext *img_resample_init(int output_width, int output_height,
300 int input_width, int input_height);
301void img_resample(ImgReSampleContext *s,
302 AVPicture *output, AVPicture *input);
303
304void img_resample_close(ImgReSampleContext *s);
305
219b06c6
FB
306void avpicture_fill(AVPicture *picture, UINT8 *ptr,
307 int pix_fmt, int width, int height);
308int avpicture_get_size(int pix_fmt, int width, int height);
309
310/* convert among pixel formats */
311int img_convert(AVPicture *dst, int dst_pix_fmt,
312 AVPicture *src, int pix_fmt,
313 int width, int height);
314
315/* deinterlace a picture */
316int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
de6d9b64
FB
317 int pix_fmt, int width, int height);
318
319/* external high level API */
320
321extern AVCodec *first_avcodec;
322
323void avcodec_init(void);
324
325void register_avcodec(AVCodec *format);
326AVCodec *avcodec_find_encoder(enum CodecID id);
98f3b098 327AVCodec *avcodec_find_encoder_by_name(const char *name);
de6d9b64
FB
328AVCodec *avcodec_find_decoder(enum CodecID id);
329AVCodec *avcodec_find_decoder_by_name(const char *name);
330void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
331
332int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
333int avcodec_decode_audio(AVCodecContext *avctx, INT16 *samples,
334 int *frame_size_ptr,
335 UINT8 *buf, int buf_size);
336int avcodec_decode_video(AVCodecContext *avctx, AVPicture *picture,
337 int *got_picture_ptr,
338 UINT8 *buf, int buf_size);
339int avcodec_encode_audio(AVCodecContext *avctx, UINT8 *buf, int buf_size,
340 const short *samples);
341int avcodec_encode_video(AVCodecContext *avctx, UINT8 *buf, int buf_size,
342 const AVPicture *pict);
343
344int avcodec_close(AVCodecContext *avctx);
345
346void avcodec_register_all(void);
a96b68b7 347
1c2a8c7f
MN
348void avcodec_flush_buffers(AVCodecContext *avctx);
349
79e7b305
A
350#ifdef FF_POSTPROCESS
351#ifndef MBC
2c029cd1
A
352#define MBC 128
353#define MBR 96
79e7b305
A
354#endif
355extern int quant_store[MBR+1][MBC+1]; // [Review]
356#endif
357
a96b68b7 358#endif /* AVCODEC_H */