new bitstream reader API (old get_bits() based one is emulated and will still be...
[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"
b50eef3a
MN
8#define LIBAVCODEC_BUILD 4614
9#define LIBAVCODEC_BUILD_STR "4614"
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,
b50eef3a 26 CODEC_ID_WMV2,
de6d9b64
FB
27 CODEC_ID_H263P,
28 CODEC_ID_H263I,
a96b68b7
FB
29
30 /* various pcm "codecs" */
31 CODEC_ID_PCM_S16LE,
32 CODEC_ID_PCM_S16BE,
33 CODEC_ID_PCM_U16LE,
34 CODEC_ID_PCM_U16BE,
35 CODEC_ID_PCM_S8,
36 CODEC_ID_PCM_U8,
37 CODEC_ID_PCM_MULAW,
38 CODEC_ID_PCM_ALAW,
de6d9b64 39};
84afee34 40#define CODEC_ID_MSMPEG4 CODEC_ID_MSMPEG4V3
de6d9b64
FB
41
42enum CodecType {
4a663d80 43 CODEC_TYPE_UNKNOWN = -1,
de6d9b64
FB
44 CODEC_TYPE_VIDEO,
45 CODEC_TYPE_AUDIO,
46};
47
48enum PixelFormat {
9f862d11 49 PIX_FMT_ANY = -1,
de6d9b64
FB
50 PIX_FMT_YUV420P,
51 PIX_FMT_YUV422,
52 PIX_FMT_RGB24,
53 PIX_FMT_BGR24,
d9fea0b5
FB
54 PIX_FMT_YUV422P,
55 PIX_FMT_YUV444P,
de6d9b64
FB
56};
57
a96b68b7
FB
58/* currently unused, may be used if 24/32 bits samples ever supported */
59enum SampleFormat {
60 SAMPLE_FMT_S16 = 0, /* signed 16 bits */
61};
62
de6d9b64
FB
63/* in bytes */
64#define AVCODEC_MAX_AUDIO_FRAME_SIZE 18432
65
e4986da9
J
66/* motion estimation type, EPZS by default */
67enum Motion_Est_ID {
101bea5f 68 ME_ZERO = 1,
e4986da9
J
69 ME_FULL,
70 ME_LOG,
71 ME_PHODS,
72 ME_EPZS,
73 ME_X1
74};
75
101bea5f
J
76/* only for ME compatiblity with old apps */
77extern int motion_estimation_method;
78
e4986da9 79/* ME algos sorted by quality */
bc6caae2
J
80static const int Motion_Est_QTab[] = { ME_ZERO, ME_PHODS, ME_LOG,
81 ME_X1, ME_EPZS, ME_FULL };
de6d9b64 82
9dbcbd92
MN
83#define FF_MAX_B_FRAMES 4
84
de6d9b64 85/* encoding support */
ba6802de 86/* note not everything is supported yet */
de6d9b64
FB
87
88#define CODEC_FLAG_HQ 0x0001 /* high quality (non real time) encoding */
89#define CODEC_FLAG_QSCALE 0x0002 /* use fixed qscale */
ba6802de 90#define CODEC_FLAG_4MV 0x0004 /* 4 MV per MB allowed */
ba6802de
MN
91#define CODEC_FLAG_QPEL 0x0010 /* use qpel MC */
92#define CODEC_FLAG_GMC 0x0020 /* use GMC */
60e575ac 93#define CODEC_FLAG_TYPE 0x0040 /* fixed I/P frame type, from avctx->key_frame */
1f6b6e50 94#define CODEC_FLAG_PART 0x0080 /* use data partitioning */
9dbcbd92
MN
95/* parent program gurantees that the input for b-frame containing streams is not written to
96 for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
8b4c7dbc
MN
97#define CODEC_FLAG_INPUT_PRESERVED 0x0100
98#define CODEC_FLAG_PASS1 0x0200 /* use internal 2pass ratecontrol in first pass mode */
99#define CODEC_FLAG_PASS2 0x0400 /* use internal 2pass ratecontrol in second pass mode */
e84c31dc 100#define CODEC_FLAG_EXTERN_HUFF 0x1000 /* use external huffman table (for mjpeg) */
b50eef3a 101#define CODEC_FLAG_GRAY 0x2000 /* only decode/encode grayscale */
de6d9b64 102
bf89e6b1
FB
103/* codec capabilities */
104
105/* decoder can use draw_horiz_band callback */
106#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001
107
de6d9b64
FB
108#define FRAME_RATE_BASE 10000
109
110typedef struct AVCodecContext {
111 int bit_rate;
9cdd6a24 112 int bit_rate_tolerance; /* amount of +- bits (>0)*/
de6d9b64
FB
113 int flags;
114 int sub_id; /* some codecs needs additionnal format info. It is
115 stored there */
e4986da9
J
116
117 int me_method; /* ME algorithm used for video coding */
118
e84c31dc
A
119 /* extra data from parent application to codec, e.g. huffman table
120 for mjpeg */
121 /* the parent should allocate and free this buffer */
122 void *extradata;
123 int extradata_size;
124
de6d9b64
FB
125 /* video only */
126 int frame_rate; /* frames per sec multiplied by FRAME_RATE_BASE */
127 int width, height;
11ce8834 128 int aspect_ratio_info;
2efe097a
MN
129#define FF_ASPECT_SQUARE 1
130#define FF_ASPECT_4_3_625 2
131#define FF_ASPECT_4_3_525 3
132#define FF_ASPECT_16_9_625 4
133#define FF_ASPECT_16_9_525 5
de6d9b64 134 int gop_size; /* 0 = intra only */
bc657ac3 135 enum PixelFormat pix_fmt; /* pixel format, see PIX_FMT_xxx */
e0a3d744
J
136 int repeat_pict; /* when decoding, this signal how much the picture */
137 /* must be delayed. */
138 /* extra_delay = (repeat_pict / 2) * (1/fps) */
bf89e6b1
FB
139 /* if non NULL, 'draw_horiz_band' is called by the libavcodec
140 decoder to draw an horizontal band. It improve cache usage. Not
141 all codecs can do that. You must check the codec capabilities
142 before */
143 void (*draw_horiz_band)(struct AVCodecContext *s,
144 UINT8 **src_ptr, int linesize,
145 int y, int width, int height);
146
de6d9b64
FB
147 /* audio only */
148 int sample_rate; /* samples per sec */
149 int channels;
a96b68b7 150 int sample_fmt; /* sample format, currenly unused */
de6d9b64
FB
151
152 /* the following data should not be initialized */
9cd3766f
J
153 int frame_size; /* in samples, initialized when calling 'init' */
154 int frame_number; /* audio or video frame number */
155 int real_pict_num; /* returns the real picture number of
156 previous encoded frame */
157 int key_frame; /* true if the previous compressed frame was
158 a key frame (intra, or seekable) */
159 int pict_type; /* picture type of the previous
160 encoded frame */
161/* FIXME: these should have FF_ */
162#define I_TYPE 1 // Intra
163#define P_TYPE 2 // Predicted
164#define B_TYPE 3 // Bi-dir predicted
165#define S_TYPE 4 // S(GMC)-VOP MPEG4
166
167 int delay; /* number of frames the decoded output
168 will be delayed relative to the encoded input */
2417652e
MN
169 uint8_t *mbskip_table; /* =1 if MB didnt change, is only valid for I/P frames
170 stride= mb_width = (width+15)>>4 */
1ff662cc
MN
171
172 /* encoding parameters */
de6d9b64 173 int quality; /* quality of the previous encoded frame
8b4c7dbc
MN
174 (between 1 (good) and 31 (bad))
175 this is allso used to set the quality in vbr mode
176 and the per frame quality in CODEC_FLAG_TYPE (second pass mode) */
9cdd6a24
MN
177 float qcompress; /* amount of qscale change between easy & hard scenes (0.0-1.0)*/
178 float qblur; /* amount of qscale smoothing over time (0.0-1.0) */
179 int qmin; /* min qscale */
180 int qmax; /* max qscale */
181 int max_qdiff; /* max qscale difference between frames */
9dbcbd92 182 int max_b_frames; /* maximum b frames, the output will be delayed by max_b_frames+1 relative to the input */
8b4c7dbc
MN
183 float b_quant_factor;/* qscale factor between ips and b frames */
184 int rc_strategy;
185 int b_frame_strategy;
9dbcbd92 186
2417652e
MN
187 int hurry_up; /* when set to 1 during decoding, b frames will be skiped
188 when set to 2 idct/dequant will be skipped too */
189
de6d9b64
FB
190 struct AVCodec *codec;
191 void *priv_data;
192
644d98a4 193 /* The following data is for RTP friendly coding */
1f6b6e50 194 /* By now only H.263/H.263+/MPEG4 coder honours this */
644d98a4
J
195 int rtp_mode; /* 1 for activate RTP friendly-mode */
196 /* highers numbers represent more error-prone */
197 /* enviroments, by now just "1" exist */
198
199 int rtp_payload_size; /* The size of the RTP payload, the coder will */
200 /* do it's best to deliver a chunk with size */
201 /* below rtp_payload_size, the chunk will start */
202 /* with a start code on some codecs like H.263 */
203 /* This doesn't take account of any particular */
204 /* headers inside the transmited RTP payload */
81401c1f
J
205
206
207 /* The RTP callcack: This function is called */
208 /* every time the encoder as a packet to send */
209 /* Depends on the encoder if the data starts */
210 /* with a Start Code (it should) H.263 does */
211 void (*rtp_callback)(void *data, int size, int packet_number);
212
43f1708f
J
213 /* These are for PSNR calculation, if you set get_psnr to 1 */
214 /* after encoding you will have the PSNR on psnr_y/cb/cr */
215 int get_psnr;
216 float psnr_y;
217 float psnr_cb;
218 float psnr_cr;
098eefe1
MN
219
220 /* statistics, used for 2-pass encoding */
221 int mv_bits;
222 int header_bits;
223 int i_tex_bits;
224 int p_tex_bits;
225 int i_count;
226 int p_count;
227 int skip_count;
228 int misc_bits; // cbp, mb_type
229 int frame_bits;
644d98a4 230
de6d9b64 231 /* the following fields are ignored */
bf89e6b1 232 void *opaque; /* can be used to carry app specific stuff */
de6d9b64 233 char codec_name[32];
4a663d80
PG
234 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
235 enum CodecID codec_id; /* see CODEC_ID_xxx */
de6d9b64 236 unsigned int codec_tag; /* codec tag, only used if unknown codec */
92ba5ffb
MN
237
238 int workaround_bugs; /* workaround bugs in encoders which cannot be detected automatically */
1f6b6e50
MN
239 int luma_elim_threshold;
240 int chroma_elim_threshold;
241 int strict_std_compliance; /* strictly follow the std (MPEG4, ...) */
242 float b_quant_offset;/* qscale offset between ips and b frames, not implemented yet */
243 int error_resilience;
ae72cda6
NK
244
245#ifndef MBC
246#define MBC 128
247#define MBR 96
248#endif
249 int *quant_store; /* field for communicating with external postprocessing */
8696b636 250 unsigned qstride;
1f6b6e50 251 //FIXME this should be reordered after kabis API is finished ...
5d27890a
NK
252 /*
253 Note: Below are located reserved fields for further usage
254 It requires for ABI !!!
255 If you'll perform some changes then borrow new space from these fields
256 (void * can be safety replaced with struct * ;)
257 P L E A S E ! ! !
258 IMPORTANT: Never change order of already declared fields!!!
259 */
260 unsigned long long int
261 ull_res0,ull_res1,ull_res2,ull_res3,ull_res4,ull_res5,
262 ull_res6,ull_res7,ull_res8,ull_res9,ull_res10,ull_res11,ull_res12;
263 float
264 flt_res0,flt_res1,flt_res2,flt_res3,flt_res4,flt_res5,
1f6b6e50 265 flt_res6,flt_res7,flt_res8,flt_res9,flt_res10,flt_res11;
5d27890a
NK
266 void
267 *ptr_res0,*ptr_res1,*ptr_res2,*ptr_res3,*ptr_res4,*ptr_res5,
ae72cda6 268 *ptr_res6,*ptr_res7,*ptr_res8,*ptr_res9,*ptr_res10,*ptr_res11;
5d27890a
NK
269 unsigned long int
270 ul_res0,ul_res1,ul_res2,ul_res3,ul_res4,ul_res5,
271 ul_res6,ul_res7,ul_res8,ul_res9,ul_res10,ul_res11,ul_res12;
272 unsigned int
273 ui_res0,ui_res1,ui_res2,ui_res3,ui_res4,ui_res5,
8696b636 274 ui_res6;
5d27890a
NK
275 unsigned short int
276 us_res0,us_res1,us_res2,us_res3,us_res4,us_res5,
277 us_res6,us_res7,us_res8,us_res9,us_res10,us_res11,us_res12;
278 unsigned char
279 uc_res0,uc_res1,uc_res2,uc_res3,uc_res4,uc_res5,
280 uc_res6,uc_res7,uc_res8,uc_res9,uc_res10,uc_res11,uc_res12;
de6d9b64
FB
281} AVCodecContext;
282
283typedef struct AVCodec {
284 char *name;
285 int type;
286 int id;
287 int priv_data_size;
288 int (*init)(AVCodecContext *);
289 int (*encode)(AVCodecContext *, UINT8 *buf, int buf_size, void *data);
290 int (*close)(AVCodecContext *);
291 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
292 UINT8 *buf, int buf_size);
bf89e6b1 293 int capabilities;
de6d9b64 294 struct AVCodec *next;
5d27890a
NK
295 /*
296 Note: Below are located reserved fields for further usage
297 It requires for ABI !!!
298 If you'll perform some changes then borrow new space from these fields
299 (void * can be safety replaced with struct * ;)
300 P L E A S E ! ! !
301 IMPORTANT: Never change order of already declared fields!!!
302 */
303 unsigned long long int
304 ull_res0,ull_res1,ull_res2,ull_res3,ull_res4,ull_res5,
305 ull_res6,ull_res7,ull_res8,ull_res9,ull_res10,ull_res11,ull_res12;
306 float
307 flt_res0,flt_res1,flt_res2,flt_res3,flt_res4,flt_res5,
308 flt_res6,flt_res7,flt_res8,flt_res9,flt_res10,flt_res11,flt_res12;
309 void
310 *ptr_res0,*ptr_res1,*ptr_res2,*ptr_res3,*ptr_res4,*ptr_res5,
311 *ptr_res6,*ptr_res7,*ptr_res8,*ptr_res9,*ptr_res10,*ptr_res11,*ptr_res12;
de6d9b64
FB
312} AVCodec;
313
314/* three components are given, that's all */
315typedef struct AVPicture {
316 UINT8 *data[3];
317 int linesize[3];
318} AVPicture;
319
320extern AVCodec ac3_encoder;
321extern AVCodec mp2_encoder;
9d36bdc9 322extern AVCodec mp3lame_encoder;
de6d9b64
FB
323extern AVCodec mpeg1video_encoder;
324extern AVCodec h263_encoder;
325extern AVCodec h263p_encoder;
326extern AVCodec rv10_encoder;
327extern AVCodec mjpeg_encoder;
bf89e6b1 328extern AVCodec mpeg4_encoder;
84afee34
MN
329extern AVCodec msmpeg4v1_encoder;
330extern AVCodec msmpeg4v2_encoder;
331extern AVCodec msmpeg4v3_encoder;
0151a6f5
MN
332extern AVCodec wmv1_encoder;
333extern AVCodec wmv2_encoder;
de6d9b64
FB
334
335extern AVCodec h263_decoder;
bf89e6b1 336extern AVCodec mpeg4_decoder;
84afee34
MN
337extern AVCodec msmpeg4v1_decoder;
338extern AVCodec msmpeg4v2_decoder;
339extern AVCodec msmpeg4v3_decoder;
e1a9dbff 340extern AVCodec wmv1_decoder;
0151a6f5 341extern AVCodec wmv2_decoder;
de6d9b64
FB
342extern AVCodec mpeg_decoder;
343extern AVCodec h263i_decoder;
344extern AVCodec rv10_decoder;
4e66ab3b 345extern AVCodec mjpeg_decoder;
4b1f4f23 346extern AVCodec mp2_decoder;
a96b68b7 347extern AVCodec mp3_decoder;
de6d9b64 348
a96b68b7
FB
349/* pcm codecs */
350#define PCM_CODEC(id, name) \
351extern AVCodec name ## _decoder; \
352extern AVCodec name ## _encoder;
353
354PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
355PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
356PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
357PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
358PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
359PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
360PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
361PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
362
363#undef PCM_CODEC
364
365/* dummy raw video codec */
de6d9b64
FB
366extern AVCodec rawvideo_codec;
367
368/* the following codecs use external GPL libs */
de6d9b64
FB
369extern AVCodec ac3_decoder;
370
371/* resample.c */
372
373struct ReSampleContext;
374
375typedef struct ReSampleContext ReSampleContext;
376
377ReSampleContext *audio_resample_init(int output_channels, int input_channels,
378 int output_rate, int input_rate);
379int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
380void audio_resample_close(ReSampleContext *s);
381
382/* YUV420 format is assumed ! */
383
384struct ImgReSampleContext;
385
386typedef struct ImgReSampleContext ImgReSampleContext;
387
388ImgReSampleContext *img_resample_init(int output_width, int output_height,
389 int input_width, int input_height);
390void img_resample(ImgReSampleContext *s,
391 AVPicture *output, AVPicture *input);
392
393void img_resample_close(ImgReSampleContext *s);
394
219b06c6
FB
395void avpicture_fill(AVPicture *picture, UINT8 *ptr,
396 int pix_fmt, int width, int height);
397int avpicture_get_size(int pix_fmt, int width, int height);
398
399/* convert among pixel formats */
400int img_convert(AVPicture *dst, int dst_pix_fmt,
401 AVPicture *src, int pix_fmt,
402 int width, int height);
403
404/* deinterlace a picture */
405int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
de6d9b64
FB
406 int pix_fmt, int width, int height);
407
408/* external high level API */
409
410extern AVCodec *first_avcodec;
411
156e5023 412/* returns LIBAVCODEC_VERSION_INT constant */
51a49663 413unsigned avcodec_version(void);
8bceb6af 414/* returns LIBAVCODEC_BUILD constant */
51a49663 415unsigned avcodec_build(void);
de6d9b64
FB
416void avcodec_init(void);
417
51a49663
FB
418void avcodec_set_bit_exact(void);
419
de6d9b64
FB
420void register_avcodec(AVCodec *format);
421AVCodec *avcodec_find_encoder(enum CodecID id);
98f3b098 422AVCodec *avcodec_find_encoder_by_name(const char *name);
de6d9b64
FB
423AVCodec *avcodec_find_decoder(enum CodecID id);
424AVCodec *avcodec_find_decoder_by_name(const char *name);
425void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
426
427int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
428int avcodec_decode_audio(AVCodecContext *avctx, INT16 *samples,
429 int *frame_size_ptr,
430 UINT8 *buf, int buf_size);
431int avcodec_decode_video(AVCodecContext *avctx, AVPicture *picture,
432 int *got_picture_ptr,
433 UINT8 *buf, int buf_size);
434int avcodec_encode_audio(AVCodecContext *avctx, UINT8 *buf, int buf_size,
435 const short *samples);
436int avcodec_encode_video(AVCodecContext *avctx, UINT8 *buf, int buf_size,
437 const AVPicture *pict);
438
439int avcodec_close(AVCodecContext *avctx);
440
441void avcodec_register_all(void);
a96b68b7 442
1c2a8c7f
MN
443void avcodec_flush_buffers(AVCodecContext *avctx);
444
79e7b305 445#ifdef FF_POSTPROCESS
79e7b305
A
446extern int quant_store[MBR+1][MBC+1]; // [Review]
447#endif
448
e8f14793
ZK
449
450/**
451 * Interface for 0.5.0 version
452 *
453 * do not even think about it's usage for this moment
454 */
455
456typedef struct {
457 // compressed size used from given memory buffer
458 int size;
459 /// I/P/B frame type
460 int frame_type;
461} avc_enc_result_t;
462
463/**
464 * Commands
465 * order can't be changed - once it was defined
466 */
467typedef enum {
468 // general commands
469 AVC_OPEN_BY_NAME = 0xACA000,
470 AVC_OPEN_BY_CODEC_ID,
471 AVC_OPEN_BY_FOURCC,
472 AVC_CLOSE,
473
474 AVC_FLUSH,
475 // pin - struct { uint8_t* src, uint_t src_size }
476 // pout - struct { AVPicture* img, consumed_bytes,
477 AVC_DECODE,
478 // pin - struct { AVPicture* img, uint8_t* dest, uint_t dest_size }
479 // pout - uint_t used_from_dest_size
480 AVC_ENCODE,
481
482 // query/get video commands
483 AVC_GET_VERSION = 0xACB000,
484 AVC_GET_WIDTH,
485 AVC_GET_HEIGHT,
486 AVC_GET_DELAY,
487 AVC_GET_QUANT_TABLE,
488 // ...
489
490 // query/get audio commands
491 AVC_GET_FRAME_SIZE = 0xABC000,
492
493 // maybe define some simple structure which
494 // might be passed to the user - but they can't
495 // contain any codec specific parts and these
496 // calls are usualy necessary only few times
497
498 // set video commands
499 AVC_SET_WIDTH = 0xACD000,
500 AVC_SET_HEIGHT,
501
502 // set video encoding commands
503 AVC_SET_FRAME_RATE = 0xACD800,
504 AVC_SET_QUALITY,
505 AVC_SET_HURRY_UP,
506
507 // set audio commands
508 AVC_SET_SAMPLE_RATE = 0xACE000,
509 AVC_SET_CHANNELS,
510
511} avc_cmd_t;
512
513/**
514 * \param handle allocated private structure by libavcodec
515 * for initialization pass NULL - will be returned pout
516 * user is supposed to know nothing about its structure
517 * \param cmd type of operation to be performed
518 * \param pint input parameter
519 * \param pout output parameter
520 *
521 * \returns command status - eventually for query command it might return
522 * integer resulting value
523 */
524int avcodec(void* handle, avc_cmd_t cmd, void* pin, void* pout);
525
544eb99c
FB
526/* memory */
527void *av_malloc(int size);
528void *av_mallocz(int size);
529void av_free(void *ptr);
530void __av_freep(void **ptr);
531#define av_freep(p) __av_freep((void **)(p))
532
a96b68b7 533#endif /* AVCODEC_H */