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