cleaning corners of green dirt ;)
[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"
1457ab52
MN
8#define LIBAVCODEC_BUILD 4647
9#define LIBAVCODEC_BUILD_STR "4647"
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,
65 PIX_FMT_RGB24,
66 PIX_FMT_BGR24,
d9fea0b5
FB
67 PIX_FMT_YUV422P,
68 PIX_FMT_YUV444P,
b71472eb
PG
69 PIX_FMT_RGBA32,
70 PIX_FMT_BGRA32,
e9feea59 71 PIX_FMT_YUV410P,
a32072d0
JY
72 PIX_FMT_YUV411P,
73 PIX_FMT_RGB565,
74 PIX_FMT_RGB555,
75// PIX_FMT_RGB5551,
76 PIX_FMT_BGR565,
77 PIX_FMT_BGR555,
78// PIX_FMT_GBR565,
79// PIX_FMT_GBR555
de6d9b64
FB
80};
81
a96b68b7
FB
82/* currently unused, may be used if 24/32 bits samples ever supported */
83enum SampleFormat {
84 SAMPLE_FMT_S16 = 0, /* signed 16 bits */
85};
86
de6d9b64 87/* in bytes */
bc8d1857 88#define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
de6d9b64 89
d7425f59
MN
90/**
91 * Required number of zero bytes at the end of the input bitstream for decoding.
92 * to avoid overreading (and possibly segfaulting)
93 */
94#define FF_INPUT_BUFFER_PADDING_SIZE 8
95
e4986da9
J
96/* motion estimation type, EPZS by default */
97enum Motion_Est_ID {
101bea5f 98 ME_ZERO = 1,
e4986da9
J
99 ME_FULL,
100 ME_LOG,
101 ME_PHODS,
102 ME_EPZS,
103 ME_X1
104};
105
ce980a95
MN
106typedef struct RcOverride{
107 int start_frame;
108 int end_frame;
109 int qscale; // if this is 0 then quality_factor will be used instead
110 float quality_factor;
111} RcOverride;
112
101bea5f
J
113/* only for ME compatiblity with old apps */
114extern int motion_estimation_method;
115
e4986da9 116/* ME algos sorted by quality */
bc6caae2
J
117static const int Motion_Est_QTab[] = { ME_ZERO, ME_PHODS, ME_LOG,
118 ME_X1, ME_EPZS, ME_FULL };
de6d9b64 119
28db7fce 120
4e00e76b 121#define FF_MAX_B_FRAMES 8
9dbcbd92 122
a949d72e
MN
123/* encoding support
124 these flags can be passed in AVCodecContext.flags before initing
125 Note: note not everything is supported yet
126*/
de6d9b64 127
b71901e6
MN
128#define CODEC_FLAG_HQ 0x0001 /* brute force MB-type decission mode (slow) */
129#define CODEC_FLAG_QSCALE 0x0002 /* use fixed qscale */
130#define CODEC_FLAG_4MV 0x0004 /* 4 MV per MB allowed */
131#define CODEC_FLAG_QPEL 0x0010 /* use qpel MC */
132#define CODEC_FLAG_GMC 0x0020 /* use GMC */
b71901e6 133#define CODEC_FLAG_PART 0x0080 /* use data partitioning */
9dbcbd92
MN
134/* parent program gurantees that the input for b-frame containing streams is not written to
135 for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
8b4c7dbc 136#define CODEC_FLAG_INPUT_PRESERVED 0x0100
b71901e6
MN
137#define CODEC_FLAG_PASS1 0x0200 /* use internal 2pass ratecontrol in first pass mode */
138#define CODEC_FLAG_PASS2 0x0400 /* use internal 2pass ratecontrol in second pass mode */
e84c31dc 139#define CODEC_FLAG_EXTERN_HUFF 0x1000 /* use external huffman table (for mjpeg) */
b71901e6 140#define CODEC_FLAG_GRAY 0x2000 /* only decode/encode grayscale */
93a21abd 141#define CODEC_FLAG_EMU_EDGE 0x4000/* dont draw edges */
140cb663 142#define CODEC_FLAG_PSNR 0x8000 /* error[?] variables will be set during encoding */
d7425f59
MN
143#define CODEC_FLAG_TRUNCATED 0x00010000 /* input bitstream might be truncated at a random location instead
144 of only at frame boundaries */
c5d309f2 145#define CODEC_FLAG_NORMALIZE_AQP 0x00020000 /* normalize adaptive quantization */
fcb48651 146#define CODEC_FLAG_INTERLACED_DCT 0x00040000 /* use interlaced dct */
9f9c3229 147#define CODEC_FLAG_LOW_DELAY 0x00080000 /* force low delay / will fail on b frames */
5d3cea3a 148#define CODEC_FLAG_ALT_SCAN 0x00100000 /* use alternate scan */
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
4d2858de
MN
521//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
522
b71901e6
MN
523 /**
524 * encoding: set by user
525 * decoding: unused
526 */
1f6b6e50 527 int luma_elim_threshold;
b71901e6
MN
528
529 /**
530 * encoding: set by user
531 * decoding: unused
532 */
1f6b6e50 533 int chroma_elim_threshold;
b71901e6
MN
534
535 /**
536 * strictly follow the std (MPEG4, ...)
537 * encoding: set by user
538 * decoding: unused
539 */
540 int strict_std_compliance;
541
542 /**
543 * qscale offset between ip and b frames
b3a391e8
MN
544 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
545 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
b71901e6
MN
546 * encoding: set by user.
547 * decoding: unused
548 */
549 float b_quant_offset;
550
551 /**
ce3bcaed 552 * error resilience higher values will detect more errors but may missdetect
b71901e6
MN
553 * some more or less valid parts as errors
554 * encoding: unused
555 * decoding: set by user
556 */
1f6b6e50 557 int error_resilience;
ce3bcaed
MN
558#define FF_ER_CAREFULL 1
559#define FF_ER_COMPLIANT 2
560#define FF_ER_AGGRESSIVE 3
561#define FF_ER_VERY_AGGRESSIVE 4
ae72cda6 562
6b72ac63 563 /**
1e491e29
MN
564 * called at the beginning of each frame to get a buffer for it.
565 * if pic.reference is set then the frame will be read later by lavc
b71901e6 566 * encoding: unused
1e491e29 567 * decoding: set by lavc, user can override
b71901e6 568 */
492cd3a9 569 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
b71901e6
MN
570
571 /**
1e491e29
MN
572 * called to release buffers which where allocated with get_buffer.
573 * a released buffer can be reused in get_buffer()
574 * pic.data[*] must be set to NULL
b71901e6 575 * encoding: unused
1e491e29 576 * decoding: set by lavc, user can override
b71901e6 577 */
492cd3a9 578 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
0fd90455 579
b71901e6
MN
580 /**
581 * is 1 if the decoded stream contains b frames, 0 otherwise
582 * encoding: unused
583 * decoding: set by lavc
584 */
585 int has_b_frames;
b71901e6 586
bc8d1857 587 int block_align; /* used by some WAV based audio codecs */
ce980a95 588
917e06c8
FB
589 int parse_only; /* decoding only: if true, only parsing is done
590 (function avcodec_parse_frame()). The frame
591 data is returned. Only MPEG codecs support this now. */
ce980a95 592
b71901e6
MN
593 /**
594 * 0-> h263 quant 1-> mpeg quant
595 * encoding: set by user.
596 * decoding: unused
597 */
598 int mpeg_quant;
ce980a95 599
b71901e6
MN
600 /**
601 * pass1 encoding statistics output buffer
602 * encoding: set by lavc
603 * decoding: unused
604 */
ce980a95 605 char *stats_out; /* encoding statistics output buffer */
b71901e6
MN
606
607 /**
608 * pass2 encoding statistics input buffer.
609 * concatenated stuff from stats_out of pass1 should be placed here
610 * encoding: allocated/set/freed by user
611 * decoding: unused
612 */
613 char *stats_in;
614
615 /**
616 * ratecontrol qmin qmax limiting method
617 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
618 * encoding: set by user.
619 * decoding: unused
620 */
ce980a95 621 float rc_qsquish;
b71901e6 622
ce980a95
MN
623 float rc_qmod_amp;
624 int rc_qmod_freq;
b71901e6
MN
625
626 /**
627 * ratecontrol override, see RcOverride
628 * encoding: allocated/set/freed by user.
629 * decoding: unused
630 */
ce980a95
MN
631 RcOverride *rc_override;
632 int rc_override_count;
b71901e6
MN
633
634 /**
635 * rate control equation
636 * encoding: set by user
637 * decoding: unused
638 */
ce980a95 639 char *rc_eq;
b71901e6
MN
640
641 /**
642 * maximum bitrate
643 * encoding: set by user.
644 * decoding: unused
645 */
ce980a95 646 int rc_max_rate;
b71901e6
MN
647
648 /**
649 * minimum bitrate
650 * encoding: set by user.
651 * decoding: unused
652 */
ce980a95 653 int rc_min_rate;
b71901e6
MN
654
655 /**
656 * decoder bitstream buffer size
657 * encoding: set by user.
658 * decoding: unused
659 */
ce980a95
MN
660 int rc_buffer_size;
661 float rc_buffer_aggressivity;
b71901e6
MN
662
663 /**
664 * qscale factor between p and i frames
665 * encoding: set by user.
666 * decoding: unused
667 */
668 float i_quant_factor;
669
670 /**
671 * qscale offset between p and i frames
b3a391e8
MN
672 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
673 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
b71901e6
MN
674 * encoding: set by user.
675 * decoding: unused
676 */
677 float i_quant_offset;
678
679 /**
680 * initial complexity for pass1 ratecontrol
681 * encoding: set by user.
682 * decoding: unused
683 */
ce980a95 684 float rc_initial_cplx;
917e06c8 685
b71901e6 686 /**
b71901e6
MN
687 * dct algorithm, see FF_DCT_* below
688 * encoding: set by user
689 * decoding: unused
690 */
28db7fce 691 int dct_algo;
c7e07931 692#define FF_DCT_AUTO 0
28db7fce 693#define FF_DCT_FASTINT 1
c7e07931
MO
694#define FF_DCT_INT 2
695#define FF_DCT_MMX 3
696#define FF_DCT_MLIB 4
05c4072b 697#define FF_DCT_ALTIVEC 5
c5d309f2
MN
698
699 /**
700 * luminance masking (0-> disabled)
701 * encoding: set by user
702 * decoding: unused
703 */
704 float lumi_masking;
705
706 /**
707 * temporary complexity masking (0-> disabled)
708 * encoding: set by user
709 * decoding: unused
710 */
711 float temporal_cplx_masking;
712
713 /**
714 * spatial complexity masking (0-> disabled)
715 * encoding: set by user
716 * decoding: unused
717 */
718 float spatial_cplx_masking;
719
720 /**
721 * p block masking (0-> disabled)
722 * encoding: set by user
723 * decoding: unused
724 */
725 float p_masking;
15415af4 726
5e746b99
MN
727 /**
728 * darkness masking (0-> disabled)
729 * encoding: set by user
730 * decoding: unused
731 */
732 float dark_masking;
0c2dd16e
MN
733
734 /**
735 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A')
736 * this is used to workaround some encoder bugs
737 * encoding: unused
202ef8b8 738 * decoding: set by user, will be converted to upper case by lavc during init
0c2dd16e
MN
739 */
740 int fourcc;
5e746b99 741
2ad1516a
MN
742 /**
743 * idct algorithm, see FF_IDCT_* below
744 * encoding: set by user
745 * decoding: set by user
746 */
747 int idct_algo;
748#define FF_IDCT_AUTO 0
749#define FF_IDCT_INT 1
750#define FF_IDCT_SIMPLE 2
751#define FF_IDCT_SIMPLEMMX 3
752#define FF_IDCT_LIBMPEG2MMX 4
753#define FF_IDCT_PS2 5
754#define FF_IDCT_MLIB 6
755#define FF_IDCT_ARM 7
05c4072b 756#define FF_IDCT_ALTIVEC 8
2ad1516a 757
144f0625
MN
758 /**
759 * slice count
760 * encoding: set by lavc
761 * decoding: set by user (or 0)
762 */
763 int slice_count;
764 /**
765 * slice offsets in the frame in bytes
766 * encoding: set/allocated by lavc
767 * decoding: set/allocated by user (or NULL)
768 */
769 int *slice_offset;
770
4d2858de
MN
771 /**
772 * error concealment flags
773 * encoding: unused
774 * decoding: set by user
775 */
776 int error_concealment;
777#define FF_EC_GUESS_MVS 1
778#define FF_EC_DEBLOCK 2
779
6b72ac63 780 /**
8350df97
ZK
781 * dsp_mask could be used to disable unwanted
782 * CPU features (i.e. MMX, SSE. ...)
783 */
784 unsigned dsp_mask;
11f18faf
MN
785
786 /**
787 * bits per sample/pixel from the demuxer (needed for huffyuv)
1e491e29 788 * encoding: set by lavc
11f18faf
MN
789 * decoding: set by user
790 */
791 int bits_per_sample;
792
793 /**
794 * prediction method (needed for huffyuv)
1e491e29 795 * encoding: set by user
11f18faf
MN
796 * decoding: unused
797 */
798 int prediction_method;
799#define FF_PRED_LEFT 0
800#define FF_PRED_PLANE 1
801#define FF_PRED_MEDIAN 2
5d3cea3a
MN
802
803 /**
804 * aspect ratio. (0 if unknown)
805 * encoding: set by user.
806 * decoding: set by lavc.
807 */
808 float aspect_ratio;
1e491e29
MN
809
810 /**
811 * the picture in the bitstream
812 * encoding: set by lavc
813 * decoding: set by lavc
814 */
492cd3a9 815 AVFrame *coded_frame;
c8c437bc
MN
816
817 /**
818 * debug
819 * encoding: set by user.
820 * decoding: set by user.
821 */
822 int debug;
823#define FF_DEBUG_PICT_INFO 1
824#define FF_DEBUG_RC 2
825#define FF_DEBUG_BITSTREAM 4
826#define FF_DEBUG_MB_TYPE 8
827#define FF_DEBUG_QP 16
828#define FF_DEBUG_MV 32
829#define FF_DEBUG_VIS_MV 64
17a70fde 830#define FF_DEBUG_SKIP 128
140cb663
MN
831
832 /**
833 * error
834 * encoding: set by lavc if flags&CODEC_FLAG_PSNR
835 * decoding: unused
836 */
837 uint64_t error[4];
17a70fde
MN
838
839 /**
840 * minimum MB quantizer
841 * encoding: set by user.
842 * decoding: unused
843 */
844 int mb_qmin;
845
846 /**
847 * maximum MB quantizer
848 * encoding: set by user.
849 * decoding: unused
850 */
851 int mb_qmax;
1457ab52
MN
852
853 /**
854 * motion estimation compare function
855 * encoding: set by user.
856 * decoding: unused
857 */
858 int me_cmp;
859 /**
860 * subpixel motion estimation compare function
861 * encoding: set by user.
862 * decoding: unused
863 */
864 int me_sub_cmp;
865 /**
866 * macroblock compare function (not supported yet)
867 * encoding: set by user.
868 * decoding: unused
869 */
870 int mb_cmp;
871#define FF_CMP_SAD 0
872#define FF_CMP_SSE 1
873#define FF_CMP_SATD 2
874#define FF_CMP_DCT 3
875#define FF_CMP_PSNR 4
876#define FF_CMP_BIT 5
877#define FF_CMP_RD 6
878#define FF_CMP_ZERO 7
879#define FF_CMP_CHROMA 256
880
881 /**
882 * ME diamond size
883 * encoding: set by user.
884 * decoding: unused
885 */
886 int dia_size;
de6d9b64
FB
887} AVCodecContext;
888
889typedef struct AVCodec {
18f77016 890 const char *name;
de6d9b64
FB
891 int type;
892 int id;
893 int priv_data_size;
894 int (*init)(AVCodecContext *);
895 int (*encode)(AVCodecContext *, UINT8 *buf, int buf_size, void *data);
896 int (*close)(AVCodecContext *);
0fd90455 897 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
de6d9b64 898 UINT8 *buf, int buf_size);
bf89e6b1 899 int capabilities;
de6d9b64
FB
900 struct AVCodec *next;
901} AVCodec;
902
d7425f59
MN
903/**
904 * four components are given, that's all.
905 * the last component is alpha
906 */
de6d9b64 907typedef struct AVPicture {
d7425f59
MN
908 UINT8 *data[4];
909 int linesize[4];
de6d9b64
FB
910} AVPicture;
911
912extern AVCodec ac3_encoder;
913extern AVCodec mp2_encoder;
9d36bdc9 914extern AVCodec mp3lame_encoder;
81e0d0b4 915extern AVCodec oggvorbis_encoder;
de6d9b64
FB
916extern AVCodec mpeg1video_encoder;
917extern AVCodec h263_encoder;
918extern AVCodec h263p_encoder;
919extern AVCodec rv10_encoder;
920extern AVCodec mjpeg_encoder;
bf89e6b1 921extern AVCodec mpeg4_encoder;
84afee34
MN
922extern AVCodec msmpeg4v1_encoder;
923extern AVCodec msmpeg4v2_encoder;
924extern AVCodec msmpeg4v3_encoder;
0151a6f5
MN
925extern AVCodec wmv1_encoder;
926extern AVCodec wmv2_encoder;
11f18faf 927extern AVCodec huffyuv_encoder;
de6d9b64
FB
928
929extern AVCodec h263_decoder;
bf89e6b1 930extern AVCodec mpeg4_decoder;
84afee34
MN
931extern AVCodec msmpeg4v1_decoder;
932extern AVCodec msmpeg4v2_decoder;
933extern AVCodec msmpeg4v3_decoder;
e1a9dbff 934extern AVCodec wmv1_decoder;
0151a6f5 935extern AVCodec wmv2_decoder;
de6d9b64
FB
936extern AVCodec mpeg_decoder;
937extern AVCodec h263i_decoder;
938extern AVCodec rv10_decoder;
be8ffec9 939extern AVCodec svq1_decoder;
020fcc94
FB
940extern AVCodec dvvideo_decoder;
941extern AVCodec dvaudio_decoder;
bc8d1857
FB
942extern AVCodec wmav1_decoder;
943extern AVCodec wmav2_decoder;
4e66ab3b 944extern AVCodec mjpeg_decoder;
b135d9fb 945extern AVCodec mjpegb_decoder;
4b1f4f23 946extern AVCodec mp2_decoder;
a96b68b7 947extern AVCodec mp3_decoder;
3f95e843
FR
948extern AVCodec mace3_decoder;
949extern AVCodec mace6_decoder;
11f18faf 950extern AVCodec huffyuv_decoder;
3aca208a 951extern AVCodec oggvorbis_decoder;
de6d9b64 952
a96b68b7
FB
953/* pcm codecs */
954#define PCM_CODEC(id, name) \
955extern AVCodec name ## _decoder; \
f11d3f23 956extern AVCodec name ## _encoder
a96b68b7
FB
957
958PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
959PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
960PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
961PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
962PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
963PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
964PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
965PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
966
0147f198
FR
967/* adpcm codecs */
968
969PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
970PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
971PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
972
a96b68b7
FB
973#undef PCM_CODEC
974
975/* dummy raw video codec */
de6d9b64
FB
976extern AVCodec rawvideo_codec;
977
978/* the following codecs use external GPL libs */
de6d9b64
FB
979extern AVCodec ac3_decoder;
980
981/* resample.c */
982
983struct ReSampleContext;
984
985typedef struct ReSampleContext ReSampleContext;
986
987ReSampleContext *audio_resample_init(int output_channels, int input_channels,
988 int output_rate, int input_rate);
989int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
990void audio_resample_close(ReSampleContext *s);
991
992/* YUV420 format is assumed ! */
993
994struct ImgReSampleContext;
995
996typedef struct ImgReSampleContext ImgReSampleContext;
997
998ImgReSampleContext *img_resample_init(int output_width, int output_height,
999 int input_width, int input_height);
ab6d194a
MN
1000
1001ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
1002 int iwidth, int iheight,
1003 int topBand, int bottomBand,
1004 int leftBand, int rightBand);
1005
de6d9b64
FB
1006void img_resample(ImgReSampleContext *s,
1007 AVPicture *output, AVPicture *input);
1008
1009void img_resample_close(ImgReSampleContext *s);
1010
219b06c6
FB
1011void avpicture_fill(AVPicture *picture, UINT8 *ptr,
1012 int pix_fmt, int width, int height);
1013int avpicture_get_size(int pix_fmt, int width, int height);
1e491e29 1014void avcodec_get_chroma_sub_sample(int fmt, int *h_shift, int *v_shift);
219b06c6
FB
1015
1016/* convert among pixel formats */
1017int img_convert(AVPicture *dst, int dst_pix_fmt,
1018 AVPicture *src, int pix_fmt,
1019 int width, int height);
1020
1021/* deinterlace a picture */
1022int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
de6d9b64
FB
1023 int pix_fmt, int width, int height);
1024
1025/* external high level API */
1026
1027extern AVCodec *first_avcodec;
1028
156e5023 1029/* returns LIBAVCODEC_VERSION_INT constant */
51a49663 1030unsigned avcodec_version(void);
8bceb6af 1031/* returns LIBAVCODEC_BUILD constant */
51a49663 1032unsigned avcodec_build(void);
de6d9b64
FB
1033void avcodec_init(void);
1034
51a49663
FB
1035void avcodec_set_bit_exact(void);
1036
de6d9b64
FB
1037void register_avcodec(AVCodec *format);
1038AVCodec *avcodec_find_encoder(enum CodecID id);
98f3b098 1039AVCodec *avcodec_find_encoder_by_name(const char *name);
de6d9b64
FB
1040AVCodec *avcodec_find_decoder(enum CodecID id);
1041AVCodec *avcodec_find_decoder_by_name(const char *name);
1042void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
1043
1e491e29 1044void avcodec_get_context_defaults(AVCodecContext *s);
7ffbb60e 1045AVCodecContext *avcodec_alloc_context(void);
492cd3a9 1046AVFrame *avcodec_alloc_frame(void);
1e491e29 1047
492cd3a9
MN
1048int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
1049void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
1e491e29 1050
de6d9b64
FB
1051int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
1052int avcodec_decode_audio(AVCodecContext *avctx, INT16 *samples,
1053 int *frame_size_ptr,
1054 UINT8 *buf, int buf_size);
492cd3a9 1055int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
de6d9b64
FB
1056 int *got_picture_ptr,
1057 UINT8 *buf, int buf_size);
917e06c8
FB
1058int avcodec_parse_frame(AVCodecContext *avctx, UINT8 **pdata,
1059 int *data_size_ptr,
1060 UINT8 *buf, int buf_size);
de6d9b64
FB
1061int avcodec_encode_audio(AVCodecContext *avctx, UINT8 *buf, int buf_size,
1062 const short *samples);
1063int avcodec_encode_video(AVCodecContext *avctx, UINT8 *buf, int buf_size,
492cd3a9 1064 const AVFrame *pict);
de6d9b64
FB
1065
1066int avcodec_close(AVCodecContext *avctx);
1067
1068void avcodec_register_all(void);
a96b68b7 1069
1c2a8c7f
MN
1070void avcodec_flush_buffers(AVCodecContext *avctx);
1071
e8f14793
ZK
1072/**
1073 * Interface for 0.5.0 version
1074 *
1075 * do not even think about it's usage for this moment
1076 */
1077
1078typedef struct {
1079 // compressed size used from given memory buffer
1080 int size;
1081 /// I/P/B frame type
1082 int frame_type;
1083} avc_enc_result_t;
1084
1085/**
1086 * Commands
1087 * order can't be changed - once it was defined
1088 */
1089typedef enum {
1090 // general commands
1091 AVC_OPEN_BY_NAME = 0xACA000,
1092 AVC_OPEN_BY_CODEC_ID,
1093 AVC_OPEN_BY_FOURCC,
1094 AVC_CLOSE,
1095
1096 AVC_FLUSH,
1097 // pin - struct { uint8_t* src, uint_t src_size }
1098 // pout - struct { AVPicture* img, consumed_bytes,
1099 AVC_DECODE,
1100 // pin - struct { AVPicture* img, uint8_t* dest, uint_t dest_size }
1101 // pout - uint_t used_from_dest_size
1102 AVC_ENCODE,
1103
1104 // query/get video commands
1105 AVC_GET_VERSION = 0xACB000,
1106 AVC_GET_WIDTH,
1107 AVC_GET_HEIGHT,
1108 AVC_GET_DELAY,
1109 AVC_GET_QUANT_TABLE,
1110 // ...
1111
1112 // query/get audio commands
1113 AVC_GET_FRAME_SIZE = 0xABC000,
1114
1115 // maybe define some simple structure which
1116 // might be passed to the user - but they can't
1117 // contain any codec specific parts and these
1118 // calls are usualy necessary only few times
1119
1120 // set video commands
1121 AVC_SET_WIDTH = 0xACD000,
1122 AVC_SET_HEIGHT,
1123
1124 // set video encoding commands
1125 AVC_SET_FRAME_RATE = 0xACD800,
1126 AVC_SET_QUALITY,
1127 AVC_SET_HURRY_UP,
1128
1129 // set audio commands
1130 AVC_SET_SAMPLE_RATE = 0xACE000,
1131 AVC_SET_CHANNELS,
1132
1133} avc_cmd_t;
1134
1135/**
1136 * \param handle allocated private structure by libavcodec
1137 * for initialization pass NULL - will be returned pout
1138 * user is supposed to know nothing about its structure
1139 * \param cmd type of operation to be performed
1140 * \param pint input parameter
1141 * \param pout output parameter
1142 *
1143 * \returns command status - eventually for query command it might return
1144 * integer resulting value
1145 */
1146int avcodec(void* handle, avc_cmd_t cmd, void* pin, void* pout);
1147
544eb99c 1148/* memory */
18f77016
ZK
1149void *av_malloc(unsigned int size);
1150void *av_mallocz(unsigned int size);
544eb99c
FB
1151void av_free(void *ptr);
1152void __av_freep(void **ptr);
1153#define av_freep(p) __av_freep((void **)(p))
855ea723
ZK
1154/* for static data only */
1155/* call av_free_static to release all staticaly allocated tables */
1156void av_free_static();
1157void *__av_mallocz_static(void** location, unsigned int size);
1158#define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
544eb99c 1159
a96b68b7 1160#endif /* AVCODEC_H */