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