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