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