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