added release tar target
[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"
17a70fde
MN
8#define LIBAVCODEC_BUILD 4646
9#define LIBAVCODEC_BUILD_STR "4646"
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 {
9f862d11 63 PIX_FMT_ANY = -1,
de6d9b64
FB
64 PIX_FMT_YUV420P,
65 PIX_FMT_YUV422,
66 PIX_FMT_RGB24,
67 PIX_FMT_BGR24,
d9fea0b5
FB
68 PIX_FMT_YUV422P,
69 PIX_FMT_YUV444P,
b71472eb
PG
70 PIX_FMT_RGBA32,
71 PIX_FMT_BGRA32,
e9feea59 72 PIX_FMT_YUV410P,
a32072d0
JY
73 PIX_FMT_YUV411P,
74 PIX_FMT_RGB565,
75 PIX_FMT_RGB555,
76// PIX_FMT_RGB5551,
77 PIX_FMT_BGR565,
78 PIX_FMT_BGR555,
79// PIX_FMT_GBR565,
80// PIX_FMT_GBR555
de6d9b64
FB
81};
82
a96b68b7
FB
83/* currently unused, may be used if 24/32 bits samples ever supported */
84enum SampleFormat {
85 SAMPLE_FMT_S16 = 0, /* signed 16 bits */
86};
87
de6d9b64 88/* in bytes */
bc8d1857 89#define AVCODEC_MAX_AUDIO_FRAME_SIZE 131072
de6d9b64 90
d7425f59
MN
91/**
92 * Required number of zero bytes at the end of the input bitstream for decoding.
93 * to avoid overreading (and possibly segfaulting)
94 */
95#define FF_INPUT_BUFFER_PADDING_SIZE 8
96
e4986da9
J
97/* motion estimation type, EPZS by default */
98enum Motion_Est_ID {
101bea5f 99 ME_ZERO = 1,
e4986da9
J
100 ME_FULL,
101 ME_LOG,
102 ME_PHODS,
103 ME_EPZS,
104 ME_X1
105};
106
ce980a95
MN
107typedef struct RcOverride{
108 int start_frame;
109 int end_frame;
110 int qscale; // if this is 0 then quality_factor will be used instead
111 float quality_factor;
112} RcOverride;
113
101bea5f
J
114/* only for ME compatiblity with old apps */
115extern int motion_estimation_method;
116
e4986da9 117/* ME algos sorted by quality */
bc6caae2
J
118static const int Motion_Est_QTab[] = { ME_ZERO, ME_PHODS, ME_LOG,
119 ME_X1, ME_EPZS, ME_FULL };
de6d9b64 120
28db7fce 121
4e00e76b 122#define FF_MAX_B_FRAMES 8
9dbcbd92 123
a949d72e
MN
124/* encoding support
125 these flags can be passed in AVCodecContext.flags before initing
126 Note: note not everything is supported yet
127*/
de6d9b64 128
b71901e6
MN
129#define CODEC_FLAG_HQ 0x0001 /* brute force MB-type decission mode (slow) */
130#define CODEC_FLAG_QSCALE 0x0002 /* use fixed qscale */
131#define CODEC_FLAG_4MV 0x0004 /* 4 MV per MB allowed */
132#define CODEC_FLAG_QPEL 0x0010 /* use qpel MC */
133#define CODEC_FLAG_GMC 0x0020 /* use GMC */
b71901e6 134#define CODEC_FLAG_PART 0x0080 /* use data partitioning */
9dbcbd92
MN
135/* parent program gurantees that the input for b-frame containing streams is not written to
136 for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
8b4c7dbc 137#define CODEC_FLAG_INPUT_PRESERVED 0x0100
b71901e6
MN
138#define CODEC_FLAG_PASS1 0x0200 /* use internal 2pass ratecontrol in first pass mode */
139#define CODEC_FLAG_PASS2 0x0400 /* use internal 2pass ratecontrol in second pass mode */
e84c31dc 140#define CODEC_FLAG_EXTERN_HUFF 0x1000 /* use external huffman table (for mjpeg) */
b71901e6 141#define CODEC_FLAG_GRAY 0x2000 /* only decode/encode grayscale */
93a21abd 142#define CODEC_FLAG_EMU_EDGE 0x4000/* dont draw edges */
140cb663 143#define CODEC_FLAG_PSNR 0x8000 /* error[?] variables will be set during encoding */
d7425f59
MN
144#define CODEC_FLAG_TRUNCATED 0x00010000 /* input bitstream might be truncated at a random location instead
145 of only at frame boundaries */
c5d309f2 146#define CODEC_FLAG_NORMALIZE_AQP 0x00020000 /* normalize adaptive quantization */
fcb48651 147#define CODEC_FLAG_INTERLACED_DCT 0x00040000 /* use interlaced dct */
9f9c3229 148#define CODEC_FLAG_LOW_DELAY 0x00080000 /* force low delay / will fail on b frames */
5d3cea3a 149#define CODEC_FLAG_ALT_SCAN 0x00100000 /* use alternate scan */
c5d309f2 150
bf89e6b1
FB
151/* codec capabilities */
152
b71901e6 153#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 /* decoder can use draw_horiz_band callback */
93a21abd 154#define CODEC_CAP_DR1 0x0002 /* direct rendering method 1 */
917e06c8
FB
155/* if 'parse_only' field is true, then avcodec_parse_frame() can be
156 used */
157#define CODEC_CAP_PARSE_ONLY 0x0004
d7425f59 158#define CODEC_CAP_TRUNCATED 0x0008
bf89e6b1 159
de6d9b64
FB
160#define FRAME_RATE_BASE 10000
161
492cd3a9 162#define FF_COMMON_FRAME \
1e491e29
MN
163 uint8_t *data[4];\
164 int linesize[4];\
165 /**\
32db2b1d 166 * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
1e491e29
MN
167 * this isnt used by lavc unless the default get/release_buffer() is used\
168 * encoding: \
169 * decoding: \
170 */\
171 uint8_t *base[4];\
172 /**\
173 * 1 -> keyframe, 0-> not\
174 * encoding: set by lavc\
175 * decoding: set by lavc\
176 */\
177 int key_frame;\
178\
179 /**\
180 * picture type of the frame, see ?_TYPE below\
181 * encoding: set by lavc for coded_picture (and set by user for input)\
182 * decoding: set by lavc\
183 */\
184 int pict_type;\
185\
186 /**\
187 * presentation timestamp in micro seconds (time when frame should be shown to user)\
188 * if 0 then the frame_rate will be used as reference\
189 * encoding: MUST be set by user\
190 * decoding: set by lavc\
191 */\
192 long long int pts;\
193\
194 /**\
195 * picture number in bitstream order.\
196 * encoding: set by\
197 * decoding: set by lavc\
198 */\
199 int coded_picture_number;\
200 /**\
201 * encoding: set by\
202 * decoding: set by lavc\
203 * picture number in display order.\
204 */\
205 int display_picture_number;\
206\
207 /**\
208 * quality (between 1 (good) and 31 (bad)) \
209 * encoding: set by lavc for coded_picture (and set by user for input)\
210 * decoding: set by lavc\
211 */\
212 float quality; \
213\
214 /**\
215 * buffer age (1->was last buffer and dint change, 2->..., ...).\
216 * set to something large if the buffer has not been used yet \
217 * encoding: unused\
218 * decoding: MUST be set by get_buffer()\
219 */\
220 int age;\
221\
222 /**\
223 * is this picture used as reference\
224 * encoding: unused\
225 * decoding: set by lavc (before get_buffer() call))\
226 */\
227 int reference;\
228\
229 /**\
230 * QP table\
231 * encoding: unused\
232 * decoding: set by lavc\
233 */\
234 int8_t *qscale_table;\
235 /**\
236 * QP store stride\
237 * encoding: unused\
238 * decoding: set by lavc\
239 */\
240 int qstride;\
241\
242 /**\
243 * mbskip_table[mb]>=1 if MB didnt change\
244 * stride= mb_width = (width+15)>>4\
245 * encoding: unused\
246 * decoding: set by lavc\
247 */\
248 uint8_t *mbskip_table;\
249\
250 /**\
251 * for some private data of the user\
252 * encoding: unused\
253 * decoding: set by user\
254 */\
255 void *opaque;\
140cb663
MN
256\
257 /**\
258 * error\
259 * encoding: set by lavc if flags&CODEC_FLAG_PSNR\
260 * decoding: unused\
261 */\
262 uint64_t error[4];\
4e00e76b
MN
263\
264 /**\
265 * type of the buffer (to keep track of who has to dealloc data[*])\
266 * encoding: set by the one who allocs it\
267 * decoding: set by the one who allocs it\
268 * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
269 */\
270 int type;\
271
272#define FF_BUFFER_TYPE_INTERNAL 1
273#define FF_BUFFER_TYPE_USER 2 // Direct rendering buffers
274#define FF_BUFFER_TYPE_SHARED 4 // input frame for encoding(wont be dealloced)
275
1e491e29 276
140cb663
MN
277#define FF_I_TYPE 1 // Intra
278#define FF_P_TYPE 2 // Predicted
279#define FF_B_TYPE 3 // Bi-dir predicted
280#define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
1e491e29 281
492cd3a9
MN
282typedef struct AVFrame {
283 FF_COMMON_FRAME
284} AVFrame;
1e491e29 285
de6d9b64 286typedef struct AVCodecContext {
b71901e6
MN
287 /**
288 * the average bitrate
289 * encoding: set by user. unused for constant quantizer encoding
290 * decoding: set by lavc. 0 or some bitrate if this info is available in the stream
291 */
de6d9b64 292 int bit_rate;
b71901e6
MN
293
294 /**
295 * number of bits the bitstream is allowed to diverge from the reference
296 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
297 * encoding: set by user. unused for constant quantizer encoding
298 * decoding: unused
299 */
300 int bit_rate_tolerance;
301
302 /**
303 * CODEC_FLAG_*
304 * encoding: set by user.
305 * decoding: set by user.
306 */
de6d9b64 307 int flags;
b71901e6
MN
308
309 /**
310 * some codecs needs additionnal format info. It is stored here
311 * encoding: set by user.
312 * decoding: set by lavc. (FIXME is this ok?)
313 */
314 int sub_id;
315
316 /**
317 * motion estimation algorithm used for video coding
1e491e29 318 * encoding: MUST be set by user.
b71901e6
MN
319 * decoding: unused
320 */
321 int me_method;
322
323 /**
324 * some codecs need / can use extra-data like huffman tables
325 * mjpeg: huffman tables
326 * rv10: additional flags
b704e742 327 * mpeg4: global headers (they can be in the bitstream or here)
c5d309f2
MN
328 * encoding: set/allocated/freed by lavc.
329 * decoding: set/allocated/freed by user.
b71901e6 330 */
e84c31dc
A
331 void *extradata;
332 int extradata_size;
333
de6d9b64 334 /* video only */
b71901e6
MN
335 /**
336 * frames per sec multiplied by FRAME_RATE_BASE
337 * for variable fps this is the precission, so if the timestamps
338 * can be specified in msec precssion then this is 1000*FRAME_RATE_BASE
1e491e29 339 * encoding: MUST be set by user
b71901e6
MN
340 * decoding: set by lavc. 0 or the frame_rate if available
341 */
342 int frame_rate;
343
344 /**
1e491e29 345 * encoding: MUST be set by user.
b71901e6
MN
346 * decoding: set by user, some codecs might override / change it during playback
347 */
de6d9b64 348 int width, height;
b71901e6 349
2efe097a
MN
350#define FF_ASPECT_SQUARE 1
351#define FF_ASPECT_4_3_625 2
352#define FF_ASPECT_4_3_525 3
353#define FF_ASPECT_16_9_625 4
354#define FF_ASPECT_16_9_525 5
e769f053 355#define FF_ASPECT_EXTENDED 15
b71901e6
MN
356
357 /**
358 * the number of pictures in a group of pitures, or 0 for intra_only
359 * encoding: set by user.
360 * decoding: unused
361 */
362 int gop_size;
363
364 /**
365 * pixel format, see PIX_FMT_xxx
366 * encoding: unused
367 * decoding: set by lavc.
368 */
369 enum PixelFormat pix_fmt;
370
e0a3d744
J
371 int repeat_pict; /* when decoding, this signal how much the picture */
372 /* must be delayed. */
373 /* extra_delay = (repeat_pict / 2) * (1/fps) */
b71901e6
MN
374
375 /**
376 * if non NULL, 'draw_horiz_band' is called by the libavcodec
377 * decoder to draw an horizontal band. It improve cache usage. Not
378 * all codecs can do that. You must check the codec capabilities
379 * before
380 * encoding: unused
381 * decoding: set by user.
382 */
bf89e6b1
FB
383 void (*draw_horiz_band)(struct AVCodecContext *s,
384 UINT8 **src_ptr, int linesize,
385 int y, int width, int height);
386
de6d9b64
FB
387 /* audio only */
388 int sample_rate; /* samples per sec */
389 int channels;
a96b68b7 390 int sample_fmt; /* sample format, currenly unused */
de6d9b64
FB
391
392 /* the following data should not be initialized */
9cd3766f
J
393 int frame_size; /* in samples, initialized when calling 'init' */
394 int frame_number; /* audio or video frame number */
395 int real_pict_num; /* returns the real picture number of
396 previous encoded frame */
1e491e29 397
b71901e6 398 /**
b71901e6
MN
399 * number of frames the decoded output will be delayed relative to
400 * the encoded input
401 * encoding: set by lavc.
402 * decoding: unused
403 */
404 int delay;
1ff662cc
MN
405
406 /* encoding parameters */
9cdd6a24
MN
407 float qcompress; /* amount of qscale change between easy & hard scenes (0.0-1.0)*/
408 float qblur; /* amount of qscale smoothing over time (0.0-1.0) */
b71901e6
MN
409
410 /**
411 * minimum quantizer
412 * encoding: set by user.
413 * decoding: unused
414 */
415 int qmin;
416
417 /**
418 * maximum quantizer
419 * encoding: set by user.
420 * decoding: unused
421 */
422 int qmax;
423
424 /**
425 * maximum quantizer difference etween frames
426 * encoding: set by user.
427 * decoding: unused
428 */
429 int max_qdiff;
430
431 /**
432 * maximum number of b frames between non b frames
433 * note: the output will be delayed by max_b_frames+1 relative to the input
434 * encoding: set by user.
435 * decoding: unused
436 */
437 int max_b_frames;
438
439 /**
440 * qscale factor between ip and b frames
441 * encoding: set by user.
442 * decoding: unused
443 */
444 float b_quant_factor;
445
446 /** obsolete FIXME remove */
447 int rc_strategy;
8b4c7dbc 448 int b_frame_strategy;
9dbcbd92 449
b71901e6
MN
450 /**
451 * encoding: unused
347ae22e 452 * decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
b71901e6
MN
453 */
454 int hurry_up;
2417652e 455
de6d9b64 456 struct AVCodec *codec;
b71901e6 457
de6d9b64
FB
458 void *priv_data;
459
644d98a4 460 /* The following data is for RTP friendly coding */
1f6b6e50 461 /* By now only H.263/H.263+/MPEG4 coder honours this */
644d98a4
J
462 int rtp_mode; /* 1 for activate RTP friendly-mode */
463 /* highers numbers represent more error-prone */
464 /* enviroments, by now just "1" exist */
465
466 int rtp_payload_size; /* The size of the RTP payload, the coder will */
467 /* do it's best to deliver a chunk with size */
468 /* below rtp_payload_size, the chunk will start */
469 /* with a start code on some codecs like H.263 */
470 /* This doesn't take account of any particular */
471 /* headers inside the transmited RTP payload */
81401c1f
J
472
473
474 /* The RTP callcack: This function is called */
475 /* every time the encoder as a packet to send */
476 /* Depends on the encoder if the data starts */
477 /* with a Start Code (it should) H.263 does */
478 void (*rtp_callback)(void *data, int size, int packet_number);
479
098eefe1
MN
480 /* statistics, used for 2-pass encoding */
481 int mv_bits;
482 int header_bits;
483 int i_tex_bits;
484 int p_tex_bits;
485 int i_count;
486 int p_count;
487 int skip_count;
b71901e6
MN
488 int misc_bits;
489
490 /**
491 * number of bits used for the previously encoded frame
492 * encoding: set by lavc
8350df97 493 * decoding: - for audio - bits_per_sample
b71901e6 494 */
098eefe1 495 int frame_bits;
644d98a4 496
b71901e6
MN
497 /**
498 * private data of the user, can be used to carry app specific stuff
499 * encoding: set by user
500 * decoding: set by user
501 */
502 void *opaque;
503
de6d9b64 504 char codec_name[32];
4a663d80
PG
505 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
506 enum CodecID codec_id; /* see CODEC_ID_xxx */
de6d9b64 507 unsigned int codec_tag; /* codec tag, only used if unknown codec */
92ba5ffb 508
b71901e6 509 /**
4d2858de 510 * workaround bugs in encoders which sometimes cannot be detected automatically
b71901e6
MN
511 * encoding: unused
512 * decoding: set by user
513 */
514 int workaround_bugs;
4d2858de
MN
515#define FF_BUG_AUTODETECT 1 //autodetection
516#define FF_BUG_OLD_MSMPEG4 2
517#define FF_BUG_XVID_ILACE 4
518#define FF_BUG_UMP4 8
519#define FF_BUG_NO_PADDING 16
520#define FF_BUG_AC_VLC 32
03e93d35 521#define FF_BUG_QPEL_CHROMA 64
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
830#define FF_DEBUG_VIS_MV 64
17a70fde 831#define FF_DEBUG_SKIP 128
140cb663
MN
832
833 /**
834 * error
835 * encoding: set by lavc if flags&CODEC_FLAG_PSNR
836 * decoding: unused
837 */
838 uint64_t error[4];
17a70fde
MN
839
840 /**
841 * minimum MB quantizer
842 * encoding: set by user.
843 * decoding: unused
844 */
845 int mb_qmin;
846
847 /**
848 * maximum MB quantizer
849 * encoding: set by user.
850 * decoding: unused
851 */
852 int mb_qmax;
de6d9b64
FB
853} AVCodecContext;
854
855typedef struct AVCodec {
18f77016 856 const char *name;
de6d9b64
FB
857 int type;
858 int id;
859 int priv_data_size;
860 int (*init)(AVCodecContext *);
861 int (*encode)(AVCodecContext *, UINT8 *buf, int buf_size, void *data);
862 int (*close)(AVCodecContext *);
0fd90455 863 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
de6d9b64 864 UINT8 *buf, int buf_size);
bf89e6b1 865 int capabilities;
de6d9b64
FB
866 struct AVCodec *next;
867} AVCodec;
868
d7425f59
MN
869/**
870 * four components are given, that's all.
871 * the last component is alpha
872 */
de6d9b64 873typedef struct AVPicture {
d7425f59
MN
874 UINT8 *data[4];
875 int linesize[4];
de6d9b64
FB
876} AVPicture;
877
878extern AVCodec ac3_encoder;
879extern AVCodec mp2_encoder;
9d36bdc9 880extern AVCodec mp3lame_encoder;
81e0d0b4 881extern AVCodec oggvorbis_encoder;
de6d9b64
FB
882extern AVCodec mpeg1video_encoder;
883extern AVCodec h263_encoder;
884extern AVCodec h263p_encoder;
885extern AVCodec rv10_encoder;
886extern AVCodec mjpeg_encoder;
bf89e6b1 887extern AVCodec mpeg4_encoder;
84afee34
MN
888extern AVCodec msmpeg4v1_encoder;
889extern AVCodec msmpeg4v2_encoder;
890extern AVCodec msmpeg4v3_encoder;
0151a6f5
MN
891extern AVCodec wmv1_encoder;
892extern AVCodec wmv2_encoder;
11f18faf 893extern AVCodec huffyuv_encoder;
de6d9b64
FB
894
895extern AVCodec h263_decoder;
bf89e6b1 896extern AVCodec mpeg4_decoder;
84afee34
MN
897extern AVCodec msmpeg4v1_decoder;
898extern AVCodec msmpeg4v2_decoder;
899extern AVCodec msmpeg4v3_decoder;
e1a9dbff 900extern AVCodec wmv1_decoder;
0151a6f5 901extern AVCodec wmv2_decoder;
de6d9b64
FB
902extern AVCodec mpeg_decoder;
903extern AVCodec h263i_decoder;
904extern AVCodec rv10_decoder;
be8ffec9 905extern AVCodec svq1_decoder;
020fcc94
FB
906extern AVCodec dvvideo_decoder;
907extern AVCodec dvaudio_decoder;
bc8d1857
FB
908extern AVCodec wmav1_decoder;
909extern AVCodec wmav2_decoder;
4e66ab3b 910extern AVCodec mjpeg_decoder;
b135d9fb 911extern AVCodec mjpegb_decoder;
4b1f4f23 912extern AVCodec mp2_decoder;
a96b68b7 913extern AVCodec mp3_decoder;
3f95e843
FR
914extern AVCodec mace3_decoder;
915extern AVCodec mace6_decoder;
11f18faf 916extern AVCodec huffyuv_decoder;
3aca208a 917extern AVCodec oggvorbis_decoder;
de6d9b64 918
a96b68b7
FB
919/* pcm codecs */
920#define PCM_CODEC(id, name) \
921extern AVCodec name ## _decoder; \
f11d3f23 922extern AVCodec name ## _encoder
a96b68b7
FB
923
924PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
925PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
926PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
927PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
928PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
929PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
930PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
931PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
932
0147f198
FR
933/* adpcm codecs */
934
935PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
936PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
937PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
938
a96b68b7
FB
939#undef PCM_CODEC
940
941/* dummy raw video codec */
de6d9b64
FB
942extern AVCodec rawvideo_codec;
943
944/* the following codecs use external GPL libs */
de6d9b64
FB
945extern AVCodec ac3_decoder;
946
947/* resample.c */
948
949struct ReSampleContext;
950
951typedef struct ReSampleContext ReSampleContext;
952
953ReSampleContext *audio_resample_init(int output_channels, int input_channels,
954 int output_rate, int input_rate);
955int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
956void audio_resample_close(ReSampleContext *s);
957
958/* YUV420 format is assumed ! */
959
960struct ImgReSampleContext;
961
962typedef struct ImgReSampleContext ImgReSampleContext;
963
964ImgReSampleContext *img_resample_init(int output_width, int output_height,
965 int input_width, int input_height);
ab6d194a
MN
966
967ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
968 int iwidth, int iheight,
969 int topBand, int bottomBand,
970 int leftBand, int rightBand);
971
de6d9b64
FB
972void img_resample(ImgReSampleContext *s,
973 AVPicture *output, AVPicture *input);
974
975void img_resample_close(ImgReSampleContext *s);
976
219b06c6
FB
977void avpicture_fill(AVPicture *picture, UINT8 *ptr,
978 int pix_fmt, int width, int height);
979int avpicture_get_size(int pix_fmt, int width, int height);
1e491e29 980void avcodec_get_chroma_sub_sample(int fmt, int *h_shift, int *v_shift);
219b06c6
FB
981
982/* convert among pixel formats */
983int img_convert(AVPicture *dst, int dst_pix_fmt,
984 AVPicture *src, int pix_fmt,
985 int width, int height);
986
987/* deinterlace a picture */
988int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
de6d9b64
FB
989 int pix_fmt, int width, int height);
990
991/* external high level API */
992
993extern AVCodec *first_avcodec;
994
156e5023 995/* returns LIBAVCODEC_VERSION_INT constant */
51a49663 996unsigned avcodec_version(void);
8bceb6af 997/* returns LIBAVCODEC_BUILD constant */
51a49663 998unsigned avcodec_build(void);
de6d9b64
FB
999void avcodec_init(void);
1000
51a49663
FB
1001void avcodec_set_bit_exact(void);
1002
de6d9b64
FB
1003void register_avcodec(AVCodec *format);
1004AVCodec *avcodec_find_encoder(enum CodecID id);
98f3b098 1005AVCodec *avcodec_find_encoder_by_name(const char *name);
de6d9b64
FB
1006AVCodec *avcodec_find_decoder(enum CodecID id);
1007AVCodec *avcodec_find_decoder_by_name(const char *name);
1008void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
1009
1e491e29 1010void avcodec_get_context_defaults(AVCodecContext *s);
7ffbb60e 1011AVCodecContext *avcodec_alloc_context(void);
492cd3a9 1012AVFrame *avcodec_alloc_frame(void);
1e491e29 1013
492cd3a9
MN
1014int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
1015void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
1e491e29 1016
de6d9b64
FB
1017int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
1018int avcodec_decode_audio(AVCodecContext *avctx, INT16 *samples,
1019 int *frame_size_ptr,
1020 UINT8 *buf, int buf_size);
492cd3a9 1021int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
de6d9b64
FB
1022 int *got_picture_ptr,
1023 UINT8 *buf, int buf_size);
917e06c8
FB
1024int avcodec_parse_frame(AVCodecContext *avctx, UINT8 **pdata,
1025 int *data_size_ptr,
1026 UINT8 *buf, int buf_size);
de6d9b64
FB
1027int avcodec_encode_audio(AVCodecContext *avctx, UINT8 *buf, int buf_size,
1028 const short *samples);
1029int avcodec_encode_video(AVCodecContext *avctx, UINT8 *buf, int buf_size,
492cd3a9 1030 const AVFrame *pict);
de6d9b64
FB
1031
1032int avcodec_close(AVCodecContext *avctx);
1033
1034void avcodec_register_all(void);
a96b68b7 1035
1c2a8c7f
MN
1036void avcodec_flush_buffers(AVCodecContext *avctx);
1037
e8f14793
ZK
1038/**
1039 * Interface for 0.5.0 version
1040 *
1041 * do not even think about it's usage for this moment
1042 */
1043
1044typedef struct {
1045 // compressed size used from given memory buffer
1046 int size;
1047 /// I/P/B frame type
1048 int frame_type;
1049} avc_enc_result_t;
1050
1051/**
1052 * Commands
1053 * order can't be changed - once it was defined
1054 */
1055typedef enum {
1056 // general commands
1057 AVC_OPEN_BY_NAME = 0xACA000,
1058 AVC_OPEN_BY_CODEC_ID,
1059 AVC_OPEN_BY_FOURCC,
1060 AVC_CLOSE,
1061
1062 AVC_FLUSH,
1063 // pin - struct { uint8_t* src, uint_t src_size }
1064 // pout - struct { AVPicture* img, consumed_bytes,
1065 AVC_DECODE,
1066 // pin - struct { AVPicture* img, uint8_t* dest, uint_t dest_size }
1067 // pout - uint_t used_from_dest_size
1068 AVC_ENCODE,
1069
1070 // query/get video commands
1071 AVC_GET_VERSION = 0xACB000,
1072 AVC_GET_WIDTH,
1073 AVC_GET_HEIGHT,
1074 AVC_GET_DELAY,
1075 AVC_GET_QUANT_TABLE,
1076 // ...
1077
1078 // query/get audio commands
1079 AVC_GET_FRAME_SIZE = 0xABC000,
1080
1081 // maybe define some simple structure which
1082 // might be passed to the user - but they can't
1083 // contain any codec specific parts and these
1084 // calls are usualy necessary only few times
1085
1086 // set video commands
1087 AVC_SET_WIDTH = 0xACD000,
1088 AVC_SET_HEIGHT,
1089
1090 // set video encoding commands
1091 AVC_SET_FRAME_RATE = 0xACD800,
1092 AVC_SET_QUALITY,
1093 AVC_SET_HURRY_UP,
1094
1095 // set audio commands
1096 AVC_SET_SAMPLE_RATE = 0xACE000,
1097 AVC_SET_CHANNELS,
1098
1099} avc_cmd_t;
1100
1101/**
1102 * \param handle allocated private structure by libavcodec
1103 * for initialization pass NULL - will be returned pout
1104 * user is supposed to know nothing about its structure
1105 * \param cmd type of operation to be performed
1106 * \param pint input parameter
1107 * \param pout output parameter
1108 *
1109 * \returns command status - eventually for query command it might return
1110 * integer resulting value
1111 */
1112int avcodec(void* handle, avc_cmd_t cmd, void* pin, void* pout);
1113
544eb99c 1114/* memory */
18f77016
ZK
1115void *av_malloc(unsigned int size);
1116void *av_mallocz(unsigned int size);
544eb99c
FB
1117void av_free(void *ptr);
1118void __av_freep(void **ptr);
1119#define av_freep(p) __av_freep((void **)(p))
855ea723
ZK
1120/* for static data only */
1121/* call av_free_static to release all staticaly allocated tables */
1122void av_free_static();
1123void *__av_mallocz_static(void** location, unsigned int size);
1124#define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
544eb99c 1125
a96b68b7 1126#endif /* AVCODEC_H */