- Added MP3 encoding through libmp3lame contributed by Lennert Buytenhek.
[libav.git] / libavcodec / avcodec.h
CommitLineData
a96b68b7
FB
1#ifndef AVCODEC_H
2#define AVCODEC_H
3
de6d9b64
FB
4#include "common.h"
5
6enum CodecID {
7 CODEC_ID_NONE,
8 CODEC_ID_MPEG1VIDEO,
9 CODEC_ID_H263,
10 CODEC_ID_RV10,
11 CODEC_ID_MP2,
12 CODEC_ID_AC3,
13 CODEC_ID_MJPEG,
bf89e6b1 14 CODEC_ID_MPEG4,
de6d9b64
FB
15 CODEC_ID_RAWVIDEO,
16 CODEC_ID_MSMPEG4,
17 CODEC_ID_H263P,
18 CODEC_ID_H263I,
a96b68b7
FB
19
20 /* various pcm "codecs" */
21 CODEC_ID_PCM_S16LE,
22 CODEC_ID_PCM_S16BE,
23 CODEC_ID_PCM_U16LE,
24 CODEC_ID_PCM_U16BE,
25 CODEC_ID_PCM_S8,
26 CODEC_ID_PCM_U8,
27 CODEC_ID_PCM_MULAW,
28 CODEC_ID_PCM_ALAW,
de6d9b64
FB
29};
30
31enum CodecType {
32 CODEC_TYPE_VIDEO,
33 CODEC_TYPE_AUDIO,
34};
35
36enum PixelFormat {
37 PIX_FMT_YUV420P,
38 PIX_FMT_YUV422,
39 PIX_FMT_RGB24,
40 PIX_FMT_BGR24,
d9fea0b5
FB
41 PIX_FMT_YUV422P,
42 PIX_FMT_YUV444P,
de6d9b64
FB
43};
44
a96b68b7
FB
45/* currently unused, may be used if 24/32 bits samples ever supported */
46enum SampleFormat {
47 SAMPLE_FMT_S16 = 0, /* signed 16 bits */
48};
49
de6d9b64
FB
50/* in bytes */
51#define AVCODEC_MAX_AUDIO_FRAME_SIZE 18432
52
53/* motion estimation type */
54extern int motion_estimation_method;
55#define ME_ZERO 0
56#define ME_FULL 1
57#define ME_LOG 2
58#define ME_PHODS 3
59
60/* encoding support */
61
62#define CODEC_FLAG_HQ 0x0001 /* high quality (non real time) encoding */
63#define CODEC_FLAG_QSCALE 0x0002 /* use fixed qscale */
64
bf89e6b1
FB
65/* codec capabilities */
66
67/* decoder can use draw_horiz_band callback */
68#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001
69
de6d9b64
FB
70#define FRAME_RATE_BASE 10000
71
72typedef struct AVCodecContext {
73 int bit_rate;
74 int flags;
75 int sub_id; /* some codecs needs additionnal format info. It is
76 stored there */
77 /* video only */
78 int frame_rate; /* frames per sec multiplied by FRAME_RATE_BASE */
79 int width, height;
80 int gop_size; /* 0 = intra only */
81 int pix_fmt; /* pixel format, see PIX_FMT_xxx */
bf89e6b1
FB
82
83 /* if non NULL, 'draw_horiz_band' is called by the libavcodec
84 decoder to draw an horizontal band. It improve cache usage. Not
85 all codecs can do that. You must check the codec capabilities
86 before */
87 void (*draw_horiz_band)(struct AVCodecContext *s,
88 UINT8 **src_ptr, int linesize,
89 int y, int width, int height);
90
de6d9b64
FB
91 /* audio only */
92 int sample_rate; /* samples per sec */
93 int channels;
a96b68b7 94 int sample_fmt; /* sample format, currenly unused */
de6d9b64
FB
95
96 /* the following data should not be initialized */
97 int frame_size; /* in samples, initialized when calling 'init' */
98 int frame_number; /* audio or video frame number */
99 int key_frame; /* true if the previous compressed frame was
100 a key frame (intra, or seekable) */
101 int quality; /* quality of the previous encoded frame
102 (between 1 (good) and 31 (bad)) */
103 struct AVCodec *codec;
104 void *priv_data;
105
644d98a4
J
106 /* The following data is for RTP friendly coding */
107 /* By now only H.263/H.263+ coder honours this */
108 int rtp_mode; /* 1 for activate RTP friendly-mode */
109 /* highers numbers represent more error-prone */
110 /* enviroments, by now just "1" exist */
111
112 int rtp_payload_size; /* The size of the RTP payload, the coder will */
113 /* do it's best to deliver a chunk with size */
114 /* below rtp_payload_size, the chunk will start */
115 /* with a start code on some codecs like H.263 */
116 /* This doesn't take account of any particular */
117 /* headers inside the transmited RTP payload */
81401c1f
J
118
119
120 /* The RTP callcack: This function is called */
121 /* every time the encoder as a packet to send */
122 /* Depends on the encoder if the data starts */
123 /* with a Start Code (it should) H.263 does */
124 void (*rtp_callback)(void *data, int size, int packet_number);
125
43f1708f
J
126 /* These are for PSNR calculation, if you set get_psnr to 1 */
127 /* after encoding you will have the PSNR on psnr_y/cb/cr */
128 int get_psnr;
129 float psnr_y;
130 float psnr_cb;
131 float psnr_cr;
644d98a4 132
de6d9b64 133 /* the following fields are ignored */
bf89e6b1 134 void *opaque; /* can be used to carry app specific stuff */
de6d9b64
FB
135 char codec_name[32];
136 int codec_type; /* see CODEC_TYPE_xxx */
137 int codec_id; /* see CODEC_ID_xxx */
138 unsigned int codec_tag; /* codec tag, only used if unknown codec */
139} AVCodecContext;
140
141typedef struct AVCodec {
142 char *name;
143 int type;
144 int id;
145 int priv_data_size;
146 int (*init)(AVCodecContext *);
147 int (*encode)(AVCodecContext *, UINT8 *buf, int buf_size, void *data);
148 int (*close)(AVCodecContext *);
149 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
150 UINT8 *buf, int buf_size);
bf89e6b1 151 int capabilities;
de6d9b64
FB
152 struct AVCodec *next;
153} AVCodec;
154
155/* three components are given, that's all */
156typedef struct AVPicture {
157 UINT8 *data[3];
158 int linesize[3];
159} AVPicture;
160
161extern AVCodec ac3_encoder;
162extern AVCodec mp2_encoder;
163extern AVCodec mpeg1video_encoder;
164extern AVCodec h263_encoder;
165extern AVCodec h263p_encoder;
166extern AVCodec rv10_encoder;
167extern AVCodec mjpeg_encoder;
bf89e6b1 168extern AVCodec mpeg4_encoder;
de6d9b64
FB
169extern AVCodec msmpeg4_encoder;
170
171extern AVCodec h263_decoder;
bf89e6b1 172extern AVCodec mpeg4_decoder;
de6d9b64
FB
173extern AVCodec msmpeg4_decoder;
174extern AVCodec mpeg_decoder;
175extern AVCodec h263i_decoder;
176extern AVCodec rv10_decoder;
4e66ab3b 177extern AVCodec mjpeg_decoder;
a96b68b7 178extern AVCodec mp3_decoder;
de6d9b64 179
a96b68b7
FB
180/* pcm codecs */
181#define PCM_CODEC(id, name) \
182extern AVCodec name ## _decoder; \
183extern AVCodec name ## _encoder;
184
185PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
186PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
187PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
188PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
189PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
190PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
191PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
192PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
193
194#undef PCM_CODEC
195
196/* dummy raw video codec */
de6d9b64
FB
197extern AVCodec rawvideo_codec;
198
199/* the following codecs use external GPL libs */
de6d9b64
FB
200extern AVCodec ac3_decoder;
201
202/* resample.c */
203
204struct ReSampleContext;
205
206typedef struct ReSampleContext ReSampleContext;
207
208ReSampleContext *audio_resample_init(int output_channels, int input_channels,
209 int output_rate, int input_rate);
210int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
211void audio_resample_close(ReSampleContext *s);
212
213/* YUV420 format is assumed ! */
214
215struct ImgReSampleContext;
216
217typedef struct ImgReSampleContext ImgReSampleContext;
218
219ImgReSampleContext *img_resample_init(int output_width, int output_height,
220 int input_width, int input_height);
221void img_resample(ImgReSampleContext *s,
222 AVPicture *output, AVPicture *input);
223
224void img_resample_close(ImgReSampleContext *s);
225
219b06c6
FB
226void avpicture_fill(AVPicture *picture, UINT8 *ptr,
227 int pix_fmt, int width, int height);
228int avpicture_get_size(int pix_fmt, int width, int height);
229
230/* convert among pixel formats */
231int img_convert(AVPicture *dst, int dst_pix_fmt,
232 AVPicture *src, int pix_fmt,
233 int width, int height);
234
235/* deinterlace a picture */
236int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
de6d9b64
FB
237 int pix_fmt, int width, int height);
238
239/* external high level API */
240
241extern AVCodec *first_avcodec;
242
243void avcodec_init(void);
244
245void register_avcodec(AVCodec *format);
246AVCodec *avcodec_find_encoder(enum CodecID id);
98f3b098 247AVCodec *avcodec_find_encoder_by_name(const char *name);
de6d9b64
FB
248AVCodec *avcodec_find_decoder(enum CodecID id);
249AVCodec *avcodec_find_decoder_by_name(const char *name);
250void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
251
252int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
253int avcodec_decode_audio(AVCodecContext *avctx, INT16 *samples,
254 int *frame_size_ptr,
255 UINT8 *buf, int buf_size);
256int avcodec_decode_video(AVCodecContext *avctx, AVPicture *picture,
257 int *got_picture_ptr,
258 UINT8 *buf, int buf_size);
259int avcodec_encode_audio(AVCodecContext *avctx, UINT8 *buf, int buf_size,
260 const short *samples);
261int avcodec_encode_video(AVCodecContext *avctx, UINT8 *buf, int buf_size,
262 const AVPicture *pict);
263
264int avcodec_close(AVCodecContext *avctx);
265
266void avcodec_register_all(void);
a96b68b7 267
79e7b305
A
268#ifdef FF_POSTPROCESS
269#ifndef MBC
644d98a4
J
270#define MBC 48
271#define MBR 36
79e7b305
A
272#endif
273extern int quant_store[MBR+1][MBC+1]; // [Review]
274#endif
275
a96b68b7 276#endif /* AVCODEC_H */