make consistent decisions for dlopen/dlfcn and vhook
[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"
2d1a4094
FB
8#define LIBAVCODEC_BUILD 4654
9#define LIBAVCODEC_BUILD_STR "4654"
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,
81e0d0b4 18 CODEC_ID_VORBIS,
de6d9b64
FB
19 CODEC_ID_AC3,
20 CODEC_ID_MJPEG,
b135d9fb 21 CODEC_ID_MJPEGB,
bf89e6b1 22 CODEC_ID_MPEG4,
de6d9b64 23 CODEC_ID_RAWVIDEO,
84afee34
MN
24 CODEC_ID_MSMPEG4V1,
25 CODEC_ID_MSMPEG4V2,
26 CODEC_ID_MSMPEG4V3,
e1a9dbff 27 CODEC_ID_WMV1,
b50eef3a 28 CODEC_ID_WMV2,
de6d9b64
FB
29 CODEC_ID_H263P,
30 CODEC_ID_H263I,
be8ffec9 31 CODEC_ID_SVQ1,
020fcc94
FB
32 CODEC_ID_DVVIDEO,
33 CODEC_ID_DVAUDIO,
bc8d1857
FB
34 CODEC_ID_WMAV1,
35 CODEC_ID_WMAV2,
3f95e843
FR
36 CODEC_ID_MACE3,
37 CODEC_ID_MACE6,
11f18faf 38 CODEC_ID_HUFFYUV,
a96b68b7
FB
39
40 /* various pcm "codecs" */
41 CODEC_ID_PCM_S16LE,
42 CODEC_ID_PCM_S16BE,
43 CODEC_ID_PCM_U16LE,
44 CODEC_ID_PCM_U16BE,
45 CODEC_ID_PCM_S8,
46 CODEC_ID_PCM_U8,
47 CODEC_ID_PCM_MULAW,
48 CODEC_ID_PCM_ALAW,
0147f198
FR
49
50 /* various adpcm codecs */
51 CODEC_ID_ADPCM_IMA_QT,
52 CODEC_ID_ADPCM_IMA_WAV,
53 CODEC_ID_ADPCM_MS,
de6d9b64
FB
54};
55
56enum CodecType {
4a663d80 57 CODEC_TYPE_UNKNOWN = -1,
de6d9b64
FB
58 CODEC_TYPE_VIDEO,
59 CODEC_TYPE_AUDIO,
60};
61
62enum PixelFormat {
63 PIX_FMT_YUV420P,
64 PIX_FMT_YUV422,
dab64ebc
FB
65 PIX_FMT_RGB24, /* 3 bytes, R is first */
66 PIX_FMT_BGR24, /* 3 bytes, B is first */
d9fea0b5
FB
67 PIX_FMT_YUV422P,
68 PIX_FMT_YUV444P,
dab64ebc 69 PIX_FMT_RGBA32, /* always stored in cpu endianness */
e9feea59 70 PIX_FMT_YUV410P,
a32072d0 71 PIX_FMT_YUV411P,
dab64ebc
FB
72 PIX_FMT_RGB565, /* always stored in cpu endianness */
73 PIX_FMT_RGB555, /* always stored in cpu endianness, most significant bit to 1 */
74 PIX_FMT_GRAY8,
75 PIX_FMT_MONOWHITE, /* 0 is white */
76 PIX_FMT_MONOBLACK, /* 0 is black */
77 PIX_FMT_NB,
de6d9b64
FB
78};
79
a96b68b7
FB
80/* currently unused, may be used if 24/32 bits samples ever supported */
81enum SampleFormat {
82 SAMPLE_FMT_S16 = 0, /* signed 16 bits */
83};
84
de6d9b64 85/* in bytes */
bc8d1857 86#define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
de6d9b64 87
d7425f59
MN
88/**
89 * Required number of zero bytes at the end of the input bitstream for decoding.
90 * to avoid overreading (and possibly segfaulting)
91 */
92#define FF_INPUT_BUFFER_PADDING_SIZE 8
93
e4986da9
J
94/* motion estimation type, EPZS by default */
95enum Motion_Est_ID {
101bea5f 96 ME_ZERO = 1,
e4986da9
J
97 ME_FULL,
98 ME_LOG,
99 ME_PHODS,
100 ME_EPZS,
101 ME_X1
102};
103
ce980a95
MN
104typedef struct RcOverride{
105 int start_frame;
106 int end_frame;
107 int qscale; // if this is 0 then quality_factor will be used instead
108 float quality_factor;
109} RcOverride;
110
101bea5f
J
111/* only for ME compatiblity with old apps */
112extern int motion_estimation_method;
113
e4986da9 114/* ME algos sorted by quality */
bc6caae2
J
115static const int Motion_Est_QTab[] = { ME_ZERO, ME_PHODS, ME_LOG,
116 ME_X1, ME_EPZS, ME_FULL };
de6d9b64 117
28db7fce 118
4e00e76b 119#define FF_MAX_B_FRAMES 8
9dbcbd92 120
a949d72e
MN
121/* encoding support
122 these flags can be passed in AVCodecContext.flags before initing
123 Note: note not everything is supported yet
124*/
de6d9b64 125
b71901e6
MN
126#define CODEC_FLAG_HQ 0x0001 /* brute force MB-type decission mode (slow) */
127#define CODEC_FLAG_QSCALE 0x0002 /* use fixed qscale */
128#define CODEC_FLAG_4MV 0x0004 /* 4 MV per MB allowed */
129#define CODEC_FLAG_QPEL 0x0010 /* use qpel MC */
130#define CODEC_FLAG_GMC 0x0020 /* use GMC */
b71901e6 131#define CODEC_FLAG_PART 0x0080 /* use data partitioning */
9dbcbd92
MN
132/* parent program gurantees that the input for b-frame containing streams is not written to
133 for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
8b4c7dbc 134#define CODEC_FLAG_INPUT_PRESERVED 0x0100
b71901e6
MN
135#define CODEC_FLAG_PASS1 0x0200 /* use internal 2pass ratecontrol in first pass mode */
136#define CODEC_FLAG_PASS2 0x0400 /* use internal 2pass ratecontrol in second pass mode */
e84c31dc 137#define CODEC_FLAG_EXTERN_HUFF 0x1000 /* use external huffman table (for mjpeg) */
b71901e6 138#define CODEC_FLAG_GRAY 0x2000 /* only decode/encode grayscale */
93a21abd 139#define CODEC_FLAG_EMU_EDGE 0x4000/* dont draw edges */
140cb663 140#define CODEC_FLAG_PSNR 0x8000 /* error[?] variables will be set during encoding */
d7425f59
MN
141#define CODEC_FLAG_TRUNCATED 0x00010000 /* input bitstream might be truncated at a random location instead
142 of only at frame boundaries */
c5d309f2 143#define CODEC_FLAG_NORMALIZE_AQP 0x00020000 /* normalize adaptive quantization */
fcb48651 144#define CODEC_FLAG_INTERLACED_DCT 0x00040000 /* use interlaced dct */
9f9c3229 145#define CODEC_FLAG_LOW_DELAY 0x00080000 /* force low delay / will fail on b frames */
5d3cea3a 146#define CODEC_FLAG_ALT_SCAN 0x00100000 /* use alternate scan */
477ab036 147#define CODEC_FLAG_TRELLIS_QUANT 0x00200000 /* use trellis quantization */
70ac76c0 148#define CODEC_FLAG_GLOBAL_HEADER 0x00400000 /* place global headers in extradata instead of every keyframe */
c5d309f2 149
bf89e6b1
FB
150/* codec capabilities */
151
b71901e6 152#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 /* decoder can use draw_horiz_band callback */
93a21abd 153#define CODEC_CAP_DR1 0x0002 /* direct rendering method 1 */
917e06c8
FB
154/* if 'parse_only' field is true, then avcodec_parse_frame() can be
155 used */
156#define CODEC_CAP_PARSE_ONLY 0x0004
d7425f59 157#define CODEC_CAP_TRUNCATED 0x0008
bf89e6b1 158
de6d9b64
FB
159#define FRAME_RATE_BASE 10000
160
492cd3a9 161#define FF_COMMON_FRAME \
1e491e29
MN
162 uint8_t *data[4];\
163 int linesize[4];\
164 /**\
32db2b1d 165 * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
1e491e29
MN
166 * this isnt used by lavc unless the default get/release_buffer() is used\
167 * encoding: \
168 * decoding: \
169 */\
170 uint8_t *base[4];\
171 /**\
172 * 1 -> keyframe, 0-> not\
173 * encoding: set by lavc\
174 * decoding: set by lavc\
175 */\
176 int key_frame;\
177\
178 /**\
179 * picture type of the frame, see ?_TYPE below\
180 * encoding: set by lavc for coded_picture (and set by user for input)\
181 * decoding: set by lavc\
182 */\
183 int pict_type;\
184\
185 /**\
186 * presentation timestamp in micro seconds (time when frame should be shown to user)\
187 * if 0 then the frame_rate will be used as reference\
188 * encoding: MUST be set by user\
189 * decoding: set by lavc\
190 */\
191 long long int pts;\
192\
193 /**\
194 * picture number in bitstream order.\
195 * encoding: set by\
196 * decoding: set by lavc\
197 */\
198 int coded_picture_number;\
199 /**\
200 * encoding: set by\
201 * decoding: set by lavc\
202 * picture number in display order.\
203 */\
204 int display_picture_number;\
205\
206 /**\
207 * quality (between 1 (good) and 31 (bad)) \
208 * encoding: set by lavc for coded_picture (and set by user for input)\
209 * decoding: set by lavc\
210 */\
211 float quality; \
212\
213 /**\
214 * buffer age (1->was last buffer and dint change, 2->..., ...).\
215 * set to something large if the buffer has not been used yet \
216 * encoding: unused\
217 * decoding: MUST be set by get_buffer()\
218 */\
219 int age;\
220\
221 /**\
222 * is this picture used as reference\
223 * encoding: unused\
224 * decoding: set by lavc (before get_buffer() call))\
225 */\
226 int reference;\
227\
228 /**\
229 * QP table\
230 * encoding: unused\
231 * decoding: set by lavc\
232 */\
233 int8_t *qscale_table;\
234 /**\
235 * QP store stride\
236 * encoding: unused\
237 * decoding: set by lavc\
238 */\
239 int qstride;\
240\
241 /**\
242 * mbskip_table[mb]>=1 if MB didnt change\
243 * stride= mb_width = (width+15)>>4\
244 * encoding: unused\
245 * decoding: set by lavc\
246 */\
247 uint8_t *mbskip_table;\
248\
249 /**\
250 * for some private data of the user\
251 * encoding: unused\
252 * decoding: set by user\
253 */\
254 void *opaque;\
140cb663
MN
255\
256 /**\
257 * error\
258 * encoding: set by lavc if flags&CODEC_FLAG_PSNR\
259 * decoding: unused\
260 */\
261 uint64_t error[4];\
4e00e76b
MN
262\
263 /**\
264 * type of the buffer (to keep track of who has to dealloc data[*])\
265 * encoding: set by the one who allocs it\
266 * decoding: set by the one who allocs it\
267 * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
268 */\
269 int type;\
270
271#define FF_BUFFER_TYPE_INTERNAL 1
272#define FF_BUFFER_TYPE_USER 2 // Direct rendering buffers
273#define FF_BUFFER_TYPE_SHARED 4 // input frame for encoding(wont be dealloced)
274
1e491e29 275
140cb663
MN
276#define FF_I_TYPE 1 // Intra
277#define FF_P_TYPE 2 // Predicted
278#define FF_B_TYPE 3 // Bi-dir predicted
279#define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
1e491e29 280
492cd3a9
MN
281typedef struct AVFrame {
282 FF_COMMON_FRAME
283} AVFrame;
1e491e29 284
de6d9b64 285typedef struct AVCodecContext {
b71901e6
MN
286 /**
287 * the average bitrate
288 * encoding: set by user. unused for constant quantizer encoding
289 * decoding: set by lavc. 0 or some bitrate if this info is available in the stream
290 */
de6d9b64 291 int bit_rate;
b71901e6
MN
292
293 /**
294 * number of bits the bitstream is allowed to diverge from the reference
295 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
296 * encoding: set by user. unused for constant quantizer encoding
297 * decoding: unused
298 */
299 int bit_rate_tolerance;
300
301 /**
302 * CODEC_FLAG_*
303 * encoding: set by user.
304 * decoding: set by user.
305 */
de6d9b64 306 int flags;
b71901e6
MN
307
308 /**
309 * some codecs needs additionnal format info. It is stored here
310 * encoding: set by user.
311 * decoding: set by lavc. (FIXME is this ok?)
312 */
313 int sub_id;
314
315 /**
316 * motion estimation algorithm used for video coding
1e491e29 317 * encoding: MUST be set by user.
b71901e6
MN
318 * decoding: unused
319 */
320 int me_method;
321
322 /**
323 * some codecs need / can use extra-data like huffman tables
324 * mjpeg: huffman tables
325 * rv10: additional flags
b704e742 326 * mpeg4: global headers (they can be in the bitstream or here)
c5d309f2
MN
327 * encoding: set/allocated/freed by lavc.
328 * decoding: set/allocated/freed by user.
b71901e6 329 */
e84c31dc
A
330 void *extradata;
331 int extradata_size;
332
de6d9b64 333 /* video only */
b71901e6
MN
334 /**
335 * frames per sec multiplied by FRAME_RATE_BASE
336 * for variable fps this is the precission, so if the timestamps
337 * can be specified in msec precssion then this is 1000*FRAME_RATE_BASE
1e491e29 338 * encoding: MUST be set by user
b71901e6
MN
339 * decoding: set by lavc. 0 or the frame_rate if available
340 */
341 int frame_rate;
342
343 /**
1e491e29 344 * encoding: MUST be set by user.
b71901e6
MN
345 * decoding: set by user, some codecs might override / change it during playback
346 */
de6d9b64 347 int width, height;
b71901e6 348
2efe097a
MN
349#define FF_ASPECT_SQUARE 1
350#define FF_ASPECT_4_3_625 2
351#define FF_ASPECT_4_3_525 3
352#define FF_ASPECT_16_9_625 4
353#define FF_ASPECT_16_9_525 5
e769f053 354#define FF_ASPECT_EXTENDED 15
b71901e6
MN
355
356 /**
357 * the number of pictures in a group of pitures, or 0 for intra_only
358 * encoding: set by user.
359 * decoding: unused
360 */
361 int gop_size;
362
363 /**
364 * pixel format, see PIX_FMT_xxx
365 * encoding: unused
366 * decoding: set by lavc.
367 */
368 enum PixelFormat pix_fmt;
369
e0a3d744
J
370 int repeat_pict; /* when decoding, this signal how much the picture */
371 /* must be delayed. */
372 /* extra_delay = (repeat_pict / 2) * (1/fps) */
b71901e6
MN
373
374 /**
375 * if non NULL, 'draw_horiz_band' is called by the libavcodec
376 * decoder to draw an horizontal band. It improve cache usage. Not
377 * all codecs can do that. You must check the codec capabilities
378 * before
379 * encoding: unused
380 * decoding: set by user.
381 */
bf89e6b1
FB
382 void (*draw_horiz_band)(struct AVCodecContext *s,
383 UINT8 **src_ptr, int linesize,
384 int y, int width, int height);
385
de6d9b64
FB
386 /* audio only */
387 int sample_rate; /* samples per sec */
388 int channels;
a96b68b7 389 int sample_fmt; /* sample format, currenly unused */
de6d9b64
FB
390
391 /* the following data should not be initialized */
9cd3766f
J
392 int frame_size; /* in samples, initialized when calling 'init' */
393 int frame_number; /* audio or video frame number */
394 int real_pict_num; /* returns the real picture number of
395 previous encoded frame */
1e491e29 396
b71901e6 397 /**
b71901e6
MN
398 * number of frames the decoded output will be delayed relative to
399 * the encoded input
400 * encoding: set by lavc.
401 * decoding: unused
402 */
403 int delay;
1ff662cc
MN
404
405 /* encoding parameters */
9cdd6a24
MN
406 float qcompress; /* amount of qscale change between easy & hard scenes (0.0-1.0)*/
407 float qblur; /* amount of qscale smoothing over time (0.0-1.0) */
b71901e6
MN
408
409 /**
410 * minimum quantizer
411 * encoding: set by user.
412 * decoding: unused
413 */
414 int qmin;
415
416 /**
417 * maximum quantizer
418 * encoding: set by user.
419 * decoding: unused
420 */
421 int qmax;
422
423 /**
424 * maximum quantizer difference etween frames
425 * encoding: set by user.
426 * decoding: unused
427 */
428 int max_qdiff;
429
430 /**
431 * maximum number of b frames between non b frames
432 * note: the output will be delayed by max_b_frames+1 relative to the input
433 * encoding: set by user.
434 * decoding: unused
435 */
436 int max_b_frames;
437
438 /**
439 * qscale factor between ip and b frames
440 * encoding: set by user.
441 * decoding: unused
442 */
443 float b_quant_factor;
444
445 /** obsolete FIXME remove */
446 int rc_strategy;
8b4c7dbc 447 int b_frame_strategy;
9dbcbd92 448
b71901e6
MN
449 /**
450 * encoding: unused
347ae22e 451 * decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
b71901e6
MN
452 */
453 int hurry_up;
2417652e 454
de6d9b64 455 struct AVCodec *codec;
b71901e6 456
de6d9b64
FB
457 void *priv_data;
458
644d98a4 459 /* The following data is for RTP friendly coding */
1f6b6e50 460 /* By now only H.263/H.263+/MPEG4 coder honours this */
644d98a4
J
461 int rtp_mode; /* 1 for activate RTP friendly-mode */
462 /* highers numbers represent more error-prone */
463 /* enviroments, by now just "1" exist */
464
465 int rtp_payload_size; /* The size of the RTP payload, the coder will */
466 /* do it's best to deliver a chunk with size */
467 /* below rtp_payload_size, the chunk will start */
468 /* with a start code on some codecs like H.263 */
469 /* This doesn't take account of any particular */
470 /* headers inside the transmited RTP payload */
81401c1f
J
471
472
473 /* The RTP callcack: This function is called */
474 /* every time the encoder as a packet to send */
475 /* Depends on the encoder if the data starts */
476 /* with a Start Code (it should) H.263 does */
477 void (*rtp_callback)(void *data, int size, int packet_number);
478
098eefe1
MN
479 /* statistics, used for 2-pass encoding */
480 int mv_bits;
481 int header_bits;
482 int i_tex_bits;
483 int p_tex_bits;
484 int i_count;
485 int p_count;
486 int skip_count;
b71901e6
MN
487 int misc_bits;
488
489 /**
490 * number of bits used for the previously encoded frame
491 * encoding: set by lavc
8350df97 492 * decoding: - for audio - bits_per_sample
b71901e6 493 */
098eefe1 494 int frame_bits;
644d98a4 495
b71901e6
MN
496 /**
497 * private data of the user, can be used to carry app specific stuff
498 * encoding: set by user
499 * decoding: set by user
500 */
501 void *opaque;
502
de6d9b64 503 char codec_name[32];
4a663d80
PG
504 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
505 enum CodecID codec_id; /* see CODEC_ID_xxx */
de6d9b64 506 unsigned int codec_tag; /* codec tag, only used if unknown codec */
92ba5ffb 507
b71901e6 508 /**
4d2858de 509 * workaround bugs in encoders which sometimes cannot be detected automatically
b71901e6
MN
510 * encoding: unused
511 * decoding: set by user
512 */
513 int workaround_bugs;
4d2858de
MN
514#define FF_BUG_AUTODETECT 1 //autodetection
515#define FF_BUG_OLD_MSMPEG4 2
516#define FF_BUG_XVID_ILACE 4
517#define FF_BUG_UMP4 8
518#define FF_BUG_NO_PADDING 16
519#define FF_BUG_AC_VLC 32
03e93d35 520#define FF_BUG_QPEL_CHROMA 64
db794953 521#define FF_BUG_STD_QPEL 128
4d2858de
MN
522//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
523
b71901e6
MN
524 /**
525 * encoding: set by user
526 * decoding: unused
527 */
1f6b6e50 528 int luma_elim_threshold;
b71901e6
MN
529
530 /**
531 * encoding: set by user
532 * decoding: unused
533 */
1f6b6e50 534 int chroma_elim_threshold;
b71901e6
MN
535
536 /**
537 * strictly follow the std (MPEG4, ...)
538 * encoding: set by user
539 * decoding: unused
540 */
541 int strict_std_compliance;
542
543 /**
544 * qscale offset between ip and b frames
b3a391e8
MN
545 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
546 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
b71901e6
MN
547 * encoding: set by user.
548 * decoding: unused
549 */
550 float b_quant_offset;
551
552 /**
ce3bcaed 553 * error resilience higher values will detect more errors but may missdetect
b71901e6
MN
554 * some more or less valid parts as errors
555 * encoding: unused
556 * decoding: set by user
557 */
1f6b6e50 558 int error_resilience;
ce3bcaed
MN
559#define FF_ER_CAREFULL 1
560#define FF_ER_COMPLIANT 2
561#define FF_ER_AGGRESSIVE 3
562#define FF_ER_VERY_AGGRESSIVE 4
ae72cda6 563
6b72ac63 564 /**
1e491e29
MN
565 * called at the beginning of each frame to get a buffer for it.
566 * if pic.reference is set then the frame will be read later by lavc
b71901e6 567 * encoding: unused
1e491e29 568 * decoding: set by lavc, user can override
b71901e6 569 */
492cd3a9 570 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
b71901e6
MN
571
572 /**
1e491e29
MN
573 * called to release buffers which where allocated with get_buffer.
574 * a released buffer can be reused in get_buffer()
575 * pic.data[*] must be set to NULL
b71901e6 576 * encoding: unused
1e491e29 577 * decoding: set by lavc, user can override
b71901e6 578 */
492cd3a9 579 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
0fd90455 580
b71901e6
MN
581 /**
582 * is 1 if the decoded stream contains b frames, 0 otherwise
583 * encoding: unused
584 * decoding: set by lavc
585 */
586 int has_b_frames;
b71901e6 587
bc8d1857 588 int block_align; /* used by some WAV based audio codecs */
ce980a95 589
917e06c8
FB
590 int parse_only; /* decoding only: if true, only parsing is done
591 (function avcodec_parse_frame()). The frame
592 data is returned. Only MPEG codecs support this now. */
ce980a95 593
b71901e6
MN
594 /**
595 * 0-> h263 quant 1-> mpeg quant
596 * encoding: set by user.
597 * decoding: unused
598 */
599 int mpeg_quant;
ce980a95 600
b71901e6
MN
601 /**
602 * pass1 encoding statistics output buffer
603 * encoding: set by lavc
604 * decoding: unused
605 */
ce980a95 606 char *stats_out; /* encoding statistics output buffer */
b71901e6
MN
607
608 /**
609 * pass2 encoding statistics input buffer.
610 * concatenated stuff from stats_out of pass1 should be placed here
611 * encoding: allocated/set/freed by user
612 * decoding: unused
613 */
614 char *stats_in;
615
616 /**
617 * ratecontrol qmin qmax limiting method
618 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
619 * encoding: set by user.
620 * decoding: unused
621 */
ce980a95 622 float rc_qsquish;
b71901e6 623
ce980a95
MN
624 float rc_qmod_amp;
625 int rc_qmod_freq;
b71901e6
MN
626
627 /**
628 * ratecontrol override, see RcOverride
629 * encoding: allocated/set/freed by user.
630 * decoding: unused
631 */
ce980a95
MN
632 RcOverride *rc_override;
633 int rc_override_count;
b71901e6
MN
634
635 /**
636 * rate control equation
637 * encoding: set by user
638 * decoding: unused
639 */
ce980a95 640 char *rc_eq;
b71901e6
MN
641
642 /**
643 * maximum bitrate
644 * encoding: set by user.
645 * decoding: unused
646 */
ce980a95 647 int rc_max_rate;
b71901e6
MN
648
649 /**
650 * minimum bitrate
651 * encoding: set by user.
652 * decoding: unused
653 */
ce980a95 654 int rc_min_rate;
b71901e6
MN
655
656 /**
657 * decoder bitstream buffer size
658 * encoding: set by user.
659 * decoding: unused
660 */
ce980a95
MN
661 int rc_buffer_size;
662 float rc_buffer_aggressivity;
b71901e6
MN
663
664 /**
665 * qscale factor between p and i frames
666 * encoding: set by user.
667 * decoding: unused
668 */
669 float i_quant_factor;
670
671 /**
672 * qscale offset between p and i frames
b3a391e8
MN
673 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
674 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
b71901e6
MN
675 * encoding: set by user.
676 * decoding: unused
677 */
678 float i_quant_offset;
679
680 /**
681 * initial complexity for pass1 ratecontrol
682 * encoding: set by user.
683 * decoding: unused
684 */
ce980a95 685 float rc_initial_cplx;
917e06c8 686
b71901e6 687 /**
b71901e6
MN
688 * dct algorithm, see FF_DCT_* below
689 * encoding: set by user
690 * decoding: unused
691 */
28db7fce 692 int dct_algo;
c7e07931 693#define FF_DCT_AUTO 0
28db7fce 694#define FF_DCT_FASTINT 1
c7e07931
MO
695#define FF_DCT_INT 2
696#define FF_DCT_MMX 3
697#define FF_DCT_MLIB 4
05c4072b 698#define FF_DCT_ALTIVEC 5
c5d309f2
MN
699
700 /**
701 * luminance masking (0-> disabled)
702 * encoding: set by user
703 * decoding: unused
704 */
705 float lumi_masking;
706
707 /**
708 * temporary complexity masking (0-> disabled)
709 * encoding: set by user
710 * decoding: unused
711 */
712 float temporal_cplx_masking;
713
714 /**
715 * spatial complexity masking (0-> disabled)
716 * encoding: set by user
717 * decoding: unused
718 */
719 float spatial_cplx_masking;
720
721 /**
722 * p block masking (0-> disabled)
723 * encoding: set by user
724 * decoding: unused
725 */
726 float p_masking;
15415af4 727
5e746b99
MN
728 /**
729 * darkness masking (0-> disabled)
730 * encoding: set by user
731 * decoding: unused
732 */
733 float dark_masking;
0c2dd16e
MN
734
735 /**
736 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A')
737 * this is used to workaround some encoder bugs
738 * encoding: unused
202ef8b8 739 * decoding: set by user, will be converted to upper case by lavc during init
0c2dd16e
MN
740 */
741 int fourcc;
5e746b99 742
2ad1516a
MN
743 /**
744 * idct algorithm, see FF_IDCT_* below
745 * encoding: set by user
746 * decoding: set by user
747 */
748 int idct_algo;
749#define FF_IDCT_AUTO 0
750#define FF_IDCT_INT 1
751#define FF_IDCT_SIMPLE 2
752#define FF_IDCT_SIMPLEMMX 3
753#define FF_IDCT_LIBMPEG2MMX 4
754#define FF_IDCT_PS2 5
755#define FF_IDCT_MLIB 6
756#define FF_IDCT_ARM 7
05c4072b 757#define FF_IDCT_ALTIVEC 8
2ad1516a 758
144f0625
MN
759 /**
760 * slice count
761 * encoding: set by lavc
762 * decoding: set by user (or 0)
763 */
764 int slice_count;
765 /**
766 * slice offsets in the frame in bytes
767 * encoding: set/allocated by lavc
768 * decoding: set/allocated by user (or NULL)
769 */
770 int *slice_offset;
771
4d2858de
MN
772 /**
773 * error concealment flags
774 * encoding: unused
775 * decoding: set by user
776 */
777 int error_concealment;
778#define FF_EC_GUESS_MVS 1
779#define FF_EC_DEBLOCK 2
780
6b72ac63 781 /**
8350df97
ZK
782 * dsp_mask could be used to disable unwanted
783 * CPU features (i.e. MMX, SSE. ...)
784 */
785 unsigned dsp_mask;
11f18faf
MN
786
787 /**
788 * bits per sample/pixel from the demuxer (needed for huffyuv)
1e491e29 789 * encoding: set by lavc
11f18faf
MN
790 * decoding: set by user
791 */
792 int bits_per_sample;
793
794 /**
795 * prediction method (needed for huffyuv)
1e491e29 796 * encoding: set by user
11f18faf
MN
797 * decoding: unused
798 */
799 int prediction_method;
800#define FF_PRED_LEFT 0
801#define FF_PRED_PLANE 1
802#define FF_PRED_MEDIAN 2
5d3cea3a
MN
803
804 /**
805 * aspect ratio. (0 if unknown)
806 * encoding: set by user.
807 * decoding: set by lavc.
808 */
809 float aspect_ratio;
1e491e29
MN
810
811 /**
812 * the picture in the bitstream
813 * encoding: set by lavc
814 * decoding: set by lavc
815 */
492cd3a9 816 AVFrame *coded_frame;
c8c437bc
MN
817
818 /**
819 * debug
820 * encoding: set by user.
821 * decoding: set by user.
822 */
823 int debug;
824#define FF_DEBUG_PICT_INFO 1
825#define FF_DEBUG_RC 2
826#define FF_DEBUG_BITSTREAM 4
827#define FF_DEBUG_MB_TYPE 8
828#define FF_DEBUG_QP 16
829#define FF_DEBUG_MV 32
41773b73
MN
830#define FF_DEBUG_VIS_MV 0x00000040
831#define FF_DEBUG_SKIP 0x00000080
832#define FF_DEBUG_STARTCODE 0x00000100
833#define FF_DEBUG_PTS 0x00000200
140cb663
MN
834
835 /**
836 * error
837 * encoding: set by lavc if flags&CODEC_FLAG_PSNR
838 * decoding: unused
839 */
840 uint64_t error[4];
17a70fde
MN
841
842 /**
843 * minimum MB quantizer
844 * encoding: set by user.
845 * decoding: unused
846 */
847 int mb_qmin;
848
849 /**
850 * maximum MB quantizer
851 * encoding: set by user.
852 * decoding: unused
853 */
854 int mb_qmax;
1457ab52
MN
855
856 /**
857 * motion estimation compare function
858 * encoding: set by user.
859 * decoding: unused
860 */
861 int me_cmp;
862 /**
863 * subpixel motion estimation compare function
864 * encoding: set by user.
865 * decoding: unused
866 */
867 int me_sub_cmp;
868 /**
869 * macroblock compare function (not supported yet)
870 * encoding: set by user.
871 * decoding: unused
872 */
873 int mb_cmp;
874#define FF_CMP_SAD 0
875#define FF_CMP_SSE 1
876#define FF_CMP_SATD 2
877#define FF_CMP_DCT 3
878#define FF_CMP_PSNR 4
879#define FF_CMP_BIT 5
880#define FF_CMP_RD 6
881#define FF_CMP_ZERO 7
882#define FF_CMP_CHROMA 256
883
884 /**
b07a5980 885 * ME diamond size & shape
1457ab52
MN
886 * encoding: set by user.
887 * decoding: unused
888 */
889 int dia_size;
b07a5980
MN
890
891 /**
892 * amount of previous MV predictors (2a+1 x 2a+1 square)
893 * encoding: set by user.
894 * decoding: unused
895 */
896 int last_predictor_count;
70ac76c0 897
f5fb6b34
MN
898 /**
899 * pre pass for motion estimation
900 * encoding: set by user.
901 * decoding: unused
902 */
903 int pre_me;
b07a5980 904
70ac76c0
MN
905 /**
906 * motion estimation pre pass compare function
907 * encoding: set by user.
908 * decoding: unused
909 */
910 int me_pre_cmp;
826f429a 911
70ac76c0
MN
912 /**
913 * ME pre pass diamond size & shape
914 * encoding: set by user.
915 * decoding: unused
916 */
917 int pre_dia_size;
918
826f429a
MN
919 /**
920 * subpel ME quality
921 * encoding: set by user.
922 * decoding: unused
923 */
924 int me_subpel_quality;
925
a33c7159
MN
926 /**
927 * callback to negotiate the pixelFormat
928 * @param fmt is the list of formats which are supported by the codec,
929 * its terminated by -1 as 0 is a valid format, the formats are ordered by quality
930 * the first is allways the native one
931 * @return the choosen format
932 * encoding: unused
933 * decoding: set by user, if not set then the native format will always be choosen
934 */
935 enum PixelFormat (*get_format)(struct AVCodecContext *s, enum PixelFormat * fmt);
de6d9b64
FB
936} AVCodecContext;
937
938typedef struct AVCodec {
18f77016 939 const char *name;
de6d9b64
FB
940 int type;
941 int id;
942 int priv_data_size;
943 int (*init)(AVCodecContext *);
944 int (*encode)(AVCodecContext *, UINT8 *buf, int buf_size, void *data);
945 int (*close)(AVCodecContext *);
0fd90455 946 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
de6d9b64 947 UINT8 *buf, int buf_size);
bf89e6b1 948 int capabilities;
de6d9b64
FB
949 struct AVCodec *next;
950} AVCodec;
951
d7425f59
MN
952/**
953 * four components are given, that's all.
954 * the last component is alpha
955 */
de6d9b64 956typedef struct AVPicture {
d7425f59
MN
957 UINT8 *data[4];
958 int linesize[4];
de6d9b64
FB
959} AVPicture;
960
961extern AVCodec ac3_encoder;
962extern AVCodec mp2_encoder;
9d36bdc9 963extern AVCodec mp3lame_encoder;
81e0d0b4 964extern AVCodec oggvorbis_encoder;
de6d9b64
FB
965extern AVCodec mpeg1video_encoder;
966extern AVCodec h263_encoder;
967extern AVCodec h263p_encoder;
968extern AVCodec rv10_encoder;
969extern AVCodec mjpeg_encoder;
bf89e6b1 970extern AVCodec mpeg4_encoder;
84afee34
MN
971extern AVCodec msmpeg4v1_encoder;
972extern AVCodec msmpeg4v2_encoder;
973extern AVCodec msmpeg4v3_encoder;
0151a6f5
MN
974extern AVCodec wmv1_encoder;
975extern AVCodec wmv2_encoder;
11f18faf 976extern AVCodec huffyuv_encoder;
de6d9b64
FB
977
978extern AVCodec h263_decoder;
bf89e6b1 979extern AVCodec mpeg4_decoder;
84afee34
MN
980extern AVCodec msmpeg4v1_decoder;
981extern AVCodec msmpeg4v2_decoder;
982extern AVCodec msmpeg4v3_decoder;
e1a9dbff 983extern AVCodec wmv1_decoder;
0151a6f5 984extern AVCodec wmv2_decoder;
de6d9b64
FB
985extern AVCodec mpeg_decoder;
986extern AVCodec h263i_decoder;
987extern AVCodec rv10_decoder;
be8ffec9 988extern AVCodec svq1_decoder;
020fcc94
FB
989extern AVCodec dvvideo_decoder;
990extern AVCodec dvaudio_decoder;
bc8d1857
FB
991extern AVCodec wmav1_decoder;
992extern AVCodec wmav2_decoder;
4e66ab3b 993extern AVCodec mjpeg_decoder;
b135d9fb 994extern AVCodec mjpegb_decoder;
4b1f4f23 995extern AVCodec mp2_decoder;
a96b68b7 996extern AVCodec mp3_decoder;
3f95e843
FR
997extern AVCodec mace3_decoder;
998extern AVCodec mace6_decoder;
11f18faf 999extern AVCodec huffyuv_decoder;
3aca208a 1000extern AVCodec oggvorbis_decoder;
de6d9b64 1001
a96b68b7
FB
1002/* pcm codecs */
1003#define PCM_CODEC(id, name) \
1004extern AVCodec name ## _decoder; \
f11d3f23 1005extern AVCodec name ## _encoder
a96b68b7
FB
1006
1007PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
1008PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
1009PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
1010PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
1011PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
1012PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
1013PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
1014PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
1015
0147f198
FR
1016/* adpcm codecs */
1017
1018PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
1019PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
1020PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
1021
a96b68b7
FB
1022#undef PCM_CODEC
1023
1024/* dummy raw video codec */
de6d9b64
FB
1025extern AVCodec rawvideo_codec;
1026
1027/* the following codecs use external GPL libs */
de6d9b64
FB
1028extern AVCodec ac3_decoder;
1029
1030/* resample.c */
1031
1032struct ReSampleContext;
1033
1034typedef struct ReSampleContext ReSampleContext;
1035
1036ReSampleContext *audio_resample_init(int output_channels, int input_channels,
1037 int output_rate, int input_rate);
1038int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
1039void audio_resample_close(ReSampleContext *s);
1040
1041/* YUV420 format is assumed ! */
1042
1043struct ImgReSampleContext;
1044
1045typedef struct ImgReSampleContext ImgReSampleContext;
1046
1047ImgReSampleContext *img_resample_init(int output_width, int output_height,
1048 int input_width, int input_height);
ab6d194a
MN
1049
1050ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
1051 int iwidth, int iheight,
1052 int topBand, int bottomBand,
1053 int leftBand, int rightBand);
1054
de6d9b64
FB
1055void img_resample(ImgReSampleContext *s,
1056 AVPicture *output, AVPicture *input);
1057
1058void img_resample_close(ImgReSampleContext *s);
1059
2d1a4094
FB
1060int avpicture_fill(AVPicture *picture, UINT8 *ptr,
1061 int pix_fmt, int width, int height);
219b06c6 1062int avpicture_get_size(int pix_fmt, int width, int height);
dab64ebc
FB
1063void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
1064const char *avcodec_get_pix_fmt_name(int pix_fmt);
219b06c6
FB
1065
1066/* convert among pixel formats */
1067int img_convert(AVPicture *dst, int dst_pix_fmt,
1068 AVPicture *src, int pix_fmt,
1069 int width, int height);
1070
1071/* deinterlace a picture */
1072int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
de6d9b64
FB
1073 int pix_fmt, int width, int height);
1074
1075/* external high level API */
1076
1077extern AVCodec *first_avcodec;
1078
156e5023 1079/* returns LIBAVCODEC_VERSION_INT constant */
51a49663 1080unsigned avcodec_version(void);
8bceb6af 1081/* returns LIBAVCODEC_BUILD constant */
51a49663 1082unsigned avcodec_build(void);
de6d9b64
FB
1083void avcodec_init(void);
1084
51a49663
FB
1085void avcodec_set_bit_exact(void);
1086
de6d9b64
FB
1087void register_avcodec(AVCodec *format);
1088AVCodec *avcodec_find_encoder(enum CodecID id);
98f3b098 1089AVCodec *avcodec_find_encoder_by_name(const char *name);
de6d9b64
FB
1090AVCodec *avcodec_find_decoder(enum CodecID id);
1091AVCodec *avcodec_find_decoder_by_name(const char *name);
1092void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
1093
1e491e29 1094void avcodec_get_context_defaults(AVCodecContext *s);
7ffbb60e 1095AVCodecContext *avcodec_alloc_context(void);
492cd3a9 1096AVFrame *avcodec_alloc_frame(void);
1e491e29 1097
492cd3a9
MN
1098int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
1099void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
1e491e29 1100
de6d9b64
FB
1101int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
1102int avcodec_decode_audio(AVCodecContext *avctx, INT16 *samples,
1103 int *frame_size_ptr,
1104 UINT8 *buf, int buf_size);
492cd3a9 1105int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
de6d9b64
FB
1106 int *got_picture_ptr,
1107 UINT8 *buf, int buf_size);
917e06c8
FB
1108int avcodec_parse_frame(AVCodecContext *avctx, UINT8 **pdata,
1109 int *data_size_ptr,
1110 UINT8 *buf, int buf_size);
de6d9b64
FB
1111int avcodec_encode_audio(AVCodecContext *avctx, UINT8 *buf, int buf_size,
1112 const short *samples);
1113int avcodec_encode_video(AVCodecContext *avctx, UINT8 *buf, int buf_size,
492cd3a9 1114 const AVFrame *pict);
de6d9b64
FB
1115
1116int avcodec_close(AVCodecContext *avctx);
1117
1118void avcodec_register_all(void);
a96b68b7 1119
1c2a8c7f
MN
1120void avcodec_flush_buffers(AVCodecContext *avctx);
1121
628d601b
ZK
1122typedef struct {
1123 /** options' name with default value*/
1124 const char* name;
1125 /** English text help */
1126 const char* help;
1127 /** type of variable */
1128 int type;
1129#define FF_CONF_TYPE_BOOL 1 // boolean - true,1,on (or simply presence)
1130#define FF_CONF_TYPE_DOUBLE 2 // double
1131#define FF_CONF_TYPE_INT 3 // integer
1132#define FF_CONF_TYPE_STRING 4 // string (finished with \0)
1133#define FF_CONF_TYPE_MASK 0x1f // mask for types - upper bits are various flags
1134#define FF_CONF_TYPE_EXPERT 0x20 // flag for expert option
1135#define FF_CONF_TYPE_FLAG (FF_CONF_TYPE_BOOL | 0x40)
1136#define FF_CONF_TYPE_RCOVERIDE (FF_CONF_TYPE_STRING | 0x80)
1137 /** where the parsed value should be stored */
1138 void* val;
1139 /** min value (min == max -> no limits) */
1140 double min;
1141 /** maximum value for double/int */
1142 double max;
1143 /** default boo [0,1]l/double/int value */
1144 double defval;
1145 /**
1146 * default string value (with optional semicolon delimited extra option-list
1147 * i.e. option1;option2;option3
1148 * defval might select other then first argument as default
1149 */
1150 const char* defstr;
1151 /** char* list of supported codecs (i.e. ",msmpeg4,h263," NULL - everything */
1152 const char* supported;
1153} avc_config_t;
1154
2a743f63 1155void avcodec_getopt(AVCodecContext* avctx, const char* str, avc_config_t** config);
628d601b 1156
e8f14793
ZK
1157/**
1158 * Interface for 0.5.0 version
1159 *
1160 * do not even think about it's usage for this moment
1161 */
1162
1163typedef struct {
1164 // compressed size used from given memory buffer
1165 int size;
1166 /// I/P/B frame type
1167 int frame_type;
1168} avc_enc_result_t;
1169
1170/**
1171 * Commands
1172 * order can't be changed - once it was defined
1173 */
1174typedef enum {
1175 // general commands
1176 AVC_OPEN_BY_NAME = 0xACA000,
1177 AVC_OPEN_BY_CODEC_ID,
1178 AVC_OPEN_BY_FOURCC,
1179 AVC_CLOSE,
1180
1181 AVC_FLUSH,
1182 // pin - struct { uint8_t* src, uint_t src_size }
1183 // pout - struct { AVPicture* img, consumed_bytes,
1184 AVC_DECODE,
1185 // pin - struct { AVPicture* img, uint8_t* dest, uint_t dest_size }
1186 // pout - uint_t used_from_dest_size
1187 AVC_ENCODE,
1188
1189 // query/get video commands
1190 AVC_GET_VERSION = 0xACB000,
1191 AVC_GET_WIDTH,
1192 AVC_GET_HEIGHT,
1193 AVC_GET_DELAY,
1194 AVC_GET_QUANT_TABLE,
1195 // ...
1196
1197 // query/get audio commands
1198 AVC_GET_FRAME_SIZE = 0xABC000,
1199
1200 // maybe define some simple structure which
1201 // might be passed to the user - but they can't
1202 // contain any codec specific parts and these
1203 // calls are usualy necessary only few times
1204
1205 // set video commands
1206 AVC_SET_WIDTH = 0xACD000,
1207 AVC_SET_HEIGHT,
1208
1209 // set video encoding commands
1210 AVC_SET_FRAME_RATE = 0xACD800,
1211 AVC_SET_QUALITY,
1212 AVC_SET_HURRY_UP,
1213
1214 // set audio commands
1215 AVC_SET_SAMPLE_RATE = 0xACE000,
1216 AVC_SET_CHANNELS,
1217
1218} avc_cmd_t;
1219
1220/**
1221 * \param handle allocated private structure by libavcodec
1222 * for initialization pass NULL - will be returned pout
1223 * user is supposed to know nothing about its structure
1224 * \param cmd type of operation to be performed
1225 * \param pint input parameter
1226 * \param pout output parameter
1227 *
1228 * \returns command status - eventually for query command it might return
1229 * integer resulting value
1230 */
1231int avcodec(void* handle, avc_cmd_t cmd, void* pin, void* pout);
1232
544eb99c 1233/* memory */
18f77016
ZK
1234void *av_malloc(unsigned int size);
1235void *av_mallocz(unsigned int size);
8e1e6f31 1236void *av_realloc(void *ptr, unsigned int size);
544eb99c 1237void av_free(void *ptr);
8e1e6f31 1238char *av_strdup(const char *s);
544eb99c
FB
1239void __av_freep(void **ptr);
1240#define av_freep(p) __av_freep((void **)(p))
b7a22d84 1241void *av_fast_realloc(void *ptr, int *size, int min_size);
855ea723
ZK
1242/* for static data only */
1243/* call av_free_static to release all staticaly allocated tables */
628d601b 1244void av_free_static(void);
855ea723
ZK
1245void *__av_mallocz_static(void** location, unsigned int size);
1246#define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
544eb99c 1247
a96b68b7 1248#endif /* AVCODEC_H */