print a warning if something allocates 0 bytes
[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"
c8c437bc
MN
8#define LIBAVCODEC_BUILD 4642
9#define LIBAVCODEC_BUILD_STR "4642"
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
9dbcbd92
MN
122#define FF_MAX_B_FRAMES 4
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 */
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
1e491e29
MN
161#define FF_COMMON_PICTURE \
162 uint8_t *data[4];\
163 int linesize[4];\
164 /**\
165 * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer
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;\
255
256/* FIXME: these should have FF_ */
257#define I_TYPE 1 // Intra
258#define P_TYPE 2 // Predicted
259#define B_TYPE 3 // Bi-dir predicted
260#define S_TYPE 4 // S(GMC)-VOP MPEG4
261
262typedef struct AVVideoFrame {
263 FF_COMMON_PICTURE
264} AVVideoFrame;
265
de6d9b64 266typedef struct AVCodecContext {
b71901e6
MN
267 /**
268 * the average bitrate
269 * encoding: set by user. unused for constant quantizer encoding
270 * decoding: set by lavc. 0 or some bitrate if this info is available in the stream
271 */
de6d9b64 272 int bit_rate;
b71901e6
MN
273
274 /**
275 * number of bits the bitstream is allowed to diverge from the reference
276 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
277 * encoding: set by user. unused for constant quantizer encoding
278 * decoding: unused
279 */
280 int bit_rate_tolerance;
281
282 /**
283 * CODEC_FLAG_*
284 * encoding: set by user.
285 * decoding: set by user.
286 */
de6d9b64 287 int flags;
b71901e6
MN
288
289 /**
290 * some codecs needs additionnal format info. It is stored here
291 * encoding: set by user.
292 * decoding: set by lavc. (FIXME is this ok?)
293 */
294 int sub_id;
295
296 /**
297 * motion estimation algorithm used for video coding
1e491e29 298 * encoding: MUST be set by user.
b71901e6
MN
299 * decoding: unused
300 */
301 int me_method;
302
303 /**
304 * some codecs need / can use extra-data like huffman tables
305 * mjpeg: huffman tables
306 * rv10: additional flags
b704e742 307 * mpeg4: global headers (they can be in the bitstream or here)
c5d309f2
MN
308 * encoding: set/allocated/freed by lavc.
309 * decoding: set/allocated/freed by user.
b71901e6 310 */
e84c31dc
A
311 void *extradata;
312 int extradata_size;
313
de6d9b64 314 /* video only */
b71901e6
MN
315 /**
316 * frames per sec multiplied by FRAME_RATE_BASE
317 * for variable fps this is the precission, so if the timestamps
318 * can be specified in msec precssion then this is 1000*FRAME_RATE_BASE
1e491e29 319 * encoding: MUST be set by user
b71901e6
MN
320 * decoding: set by lavc. 0 or the frame_rate if available
321 */
322 int frame_rate;
323
324 /**
1e491e29 325 * encoding: MUST be set by user.
b71901e6
MN
326 * decoding: set by user, some codecs might override / change it during playback
327 */
de6d9b64 328 int width, height;
b71901e6 329
2efe097a
MN
330#define FF_ASPECT_SQUARE 1
331#define FF_ASPECT_4_3_625 2
332#define FF_ASPECT_4_3_525 3
333#define FF_ASPECT_16_9_625 4
334#define FF_ASPECT_16_9_525 5
e769f053 335#define FF_ASPECT_EXTENDED 15
b71901e6
MN
336
337 /**
338 * the number of pictures in a group of pitures, or 0 for intra_only
339 * encoding: set by user.
340 * decoding: unused
341 */
342 int gop_size;
343
344 /**
345 * pixel format, see PIX_FMT_xxx
346 * encoding: unused
347 * decoding: set by lavc.
348 */
349 enum PixelFormat pix_fmt;
350
e0a3d744
J
351 int repeat_pict; /* when decoding, this signal how much the picture */
352 /* must be delayed. */
353 /* extra_delay = (repeat_pict / 2) * (1/fps) */
b71901e6
MN
354
355 /**
356 * if non NULL, 'draw_horiz_band' is called by the libavcodec
357 * decoder to draw an horizontal band. It improve cache usage. Not
358 * all codecs can do that. You must check the codec capabilities
359 * before
360 * encoding: unused
361 * decoding: set by user.
362 */
bf89e6b1
FB
363 void (*draw_horiz_band)(struct AVCodecContext *s,
364 UINT8 **src_ptr, int linesize,
365 int y, int width, int height);
366
de6d9b64
FB
367 /* audio only */
368 int sample_rate; /* samples per sec */
369 int channels;
a96b68b7 370 int sample_fmt; /* sample format, currenly unused */
de6d9b64
FB
371
372 /* the following data should not be initialized */
9cd3766f
J
373 int frame_size; /* in samples, initialized when calling 'init' */
374 int frame_number; /* audio or video frame number */
375 int real_pict_num; /* returns the real picture number of
376 previous encoded frame */
1e491e29 377
b71901e6 378 /**
1e491e29 379 * 1 -> keyframe, 0-> not (this if for audio only, for video, AVVideoFrame.key_frame should be used)
b71901e6
MN
380 * encoding: set by lavc (for the outputed bitstream, not the input frame)
381 * decoding: set by lavc (for the decoded bitstream, not the displayed frame)
382 */
383 int key_frame;
384
385 /**
b71901e6
MN
386 * number of frames the decoded output will be delayed relative to
387 * the encoded input
388 * encoding: set by lavc.
389 * decoding: unused
390 */
391 int delay;
1ff662cc
MN
392
393 /* encoding parameters */
9cdd6a24
MN
394 float qcompress; /* amount of qscale change between easy & hard scenes (0.0-1.0)*/
395 float qblur; /* amount of qscale smoothing over time (0.0-1.0) */
b71901e6
MN
396
397 /**
398 * minimum quantizer
399 * encoding: set by user.
400 * decoding: unused
401 */
402 int qmin;
403
404 /**
405 * maximum quantizer
406 * encoding: set by user.
407 * decoding: unused
408 */
409 int qmax;
410
411 /**
412 * maximum quantizer difference etween frames
413 * encoding: set by user.
414 * decoding: unused
415 */
416 int max_qdiff;
417
418 /**
419 * maximum number of b frames between non b frames
420 * note: the output will be delayed by max_b_frames+1 relative to the input
421 * encoding: set by user.
422 * decoding: unused
423 */
424 int max_b_frames;
425
426 /**
427 * qscale factor between ip and b frames
428 * encoding: set by user.
429 * decoding: unused
430 */
431 float b_quant_factor;
432
433 /** obsolete FIXME remove */
434 int rc_strategy;
8b4c7dbc 435 int b_frame_strategy;
9dbcbd92 436
b71901e6
MN
437 /**
438 * encoding: unused
347ae22e 439 * decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
b71901e6
MN
440 */
441 int hurry_up;
2417652e 442
de6d9b64 443 struct AVCodec *codec;
b71901e6 444
de6d9b64
FB
445 void *priv_data;
446
644d98a4 447 /* The following data is for RTP friendly coding */
1f6b6e50 448 /* By now only H.263/H.263+/MPEG4 coder honours this */
644d98a4
J
449 int rtp_mode; /* 1 for activate RTP friendly-mode */
450 /* highers numbers represent more error-prone */
451 /* enviroments, by now just "1" exist */
452
453 int rtp_payload_size; /* The size of the RTP payload, the coder will */
454 /* do it's best to deliver a chunk with size */
455 /* below rtp_payload_size, the chunk will start */
456 /* with a start code on some codecs like H.263 */
457 /* This doesn't take account of any particular */
458 /* headers inside the transmited RTP payload */
81401c1f
J
459
460
461 /* The RTP callcack: This function is called */
462 /* every time the encoder as a packet to send */
463 /* Depends on the encoder if the data starts */
464 /* with a Start Code (it should) H.263 does */
465 void (*rtp_callback)(void *data, int size, int packet_number);
466
b71901e6
MN
467 /**
468 * if you set get_psnr to 1 then after encoding you will have the
469 * PSNR on psnr_y/cb/cr
470 * encoding: set by user (1-> on, 0-> off)
471 * decoding: unused
472 */
43f1708f
J
473 int get_psnr;
474 float psnr_y;
475 float psnr_cb;
476 float psnr_cr;
098eefe1
MN
477
478 /* statistics, used for 2-pass encoding */
479 int mv_bits;
480 int header_bits;
481 int i_tex_bits;
482 int p_tex_bits;
483 int i_count;
484 int p_count;
485 int skip_count;
b71901e6
MN
486 int misc_bits;
487
488 /**
489 * number of bits used for the previously encoded frame
490 * encoding: set by lavc
8350df97 491 * decoding: - for audio - bits_per_sample
b71901e6 492 */
098eefe1 493 int frame_bits;
644d98a4 494
b71901e6
MN
495 /**
496 * private data of the user, can be used to carry app specific stuff
497 * encoding: set by user
498 * decoding: set by user
499 */
500 void *opaque;
501
de6d9b64 502 char codec_name[32];
4a663d80
PG
503 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
504 enum CodecID codec_id; /* see CODEC_ID_xxx */
de6d9b64 505 unsigned int codec_tag; /* codec tag, only used if unknown codec */
92ba5ffb 506
b71901e6 507 /**
4d2858de 508 * workaround bugs in encoders which sometimes cannot be detected automatically
b71901e6
MN
509 * encoding: unused
510 * decoding: set by user
511 */
512 int workaround_bugs;
4d2858de
MN
513#define FF_BUG_AUTODETECT 1 //autodetection
514#define FF_BUG_OLD_MSMPEG4 2
515#define FF_BUG_XVID_ILACE 4
516#define FF_BUG_UMP4 8
517#define FF_BUG_NO_PADDING 16
518#define FF_BUG_AC_VLC 32
03e93d35 519#define FF_BUG_QPEL_CHROMA 64
4d2858de
MN
520//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
521
b71901e6
MN
522 /**
523 * encoding: set by user
524 * decoding: unused
525 */
1f6b6e50 526 int luma_elim_threshold;
b71901e6
MN
527
528 /**
529 * encoding: set by user
530 * decoding: unused
531 */
1f6b6e50 532 int chroma_elim_threshold;
b71901e6
MN
533
534 /**
535 * strictly follow the std (MPEG4, ...)
536 * encoding: set by user
537 * decoding: unused
538 */
539 int strict_std_compliance;
540
541 /**
542 * qscale offset between ip and b frames
b3a391e8
MN
543 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
544 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
b71901e6
MN
545 * encoding: set by user.
546 * decoding: unused
547 */
548 float b_quant_offset;
549
550 /**
ce3bcaed 551 * error resilience higher values will detect more errors but may missdetect
b71901e6
MN
552 * some more or less valid parts as errors
553 * encoding: unused
554 * decoding: set by user
555 */
1f6b6e50 556 int error_resilience;
ce3bcaed
MN
557#define FF_ER_CAREFULL 1
558#define FF_ER_COMPLIANT 2
559#define FF_ER_AGGRESSIVE 3
560#define FF_ER_VERY_AGGRESSIVE 4
ae72cda6 561
6b72ac63 562 /**
1e491e29
MN
563 * called at the beginning of each frame to get a buffer for it.
564 * if pic.reference is set then the frame will be read later by lavc
b71901e6 565 * encoding: unused
1e491e29 566 * decoding: set by lavc, user can override
b71901e6 567 */
1e491e29 568 int (*get_buffer)(struct AVCodecContext *c, AVVideoFrame *pic);
b71901e6
MN
569
570 /**
1e491e29
MN
571 * called to release buffers which where allocated with get_buffer.
572 * a released buffer can be reused in get_buffer()
573 * pic.data[*] must be set to NULL
b71901e6 574 * encoding: unused
1e491e29 575 * decoding: set by lavc, user can override
b71901e6 576 */
1e491e29 577 void (*release_buffer)(struct AVCodecContext *c, AVVideoFrame *pic);
0fd90455 578
b71901e6
MN
579 /**
580 * is 1 if the decoded stream contains b frames, 0 otherwise
581 * encoding: unused
582 * decoding: set by lavc
583 */
584 int has_b_frames;
b71901e6 585
bc8d1857 586 int block_align; /* used by some WAV based audio codecs */
ce980a95 587
917e06c8
FB
588 int parse_only; /* decoding only: if true, only parsing is done
589 (function avcodec_parse_frame()). The frame
590 data is returned. Only MPEG codecs support this now. */
ce980a95 591
b71901e6
MN
592 /**
593 * 0-> h263 quant 1-> mpeg quant
594 * encoding: set by user.
595 * decoding: unused
596 */
597 int mpeg_quant;
ce980a95 598
b71901e6
MN
599 /**
600 * pass1 encoding statistics output buffer
601 * encoding: set by lavc
602 * decoding: unused
603 */
ce980a95 604 char *stats_out; /* encoding statistics output buffer */
b71901e6
MN
605
606 /**
607 * pass2 encoding statistics input buffer.
608 * concatenated stuff from stats_out of pass1 should be placed here
609 * encoding: allocated/set/freed by user
610 * decoding: unused
611 */
612 char *stats_in;
613
614 /**
615 * ratecontrol qmin qmax limiting method
616 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
617 * encoding: set by user.
618 * decoding: unused
619 */
ce980a95 620 float rc_qsquish;
b71901e6 621
ce980a95
MN
622 float rc_qmod_amp;
623 int rc_qmod_freq;
b71901e6
MN
624
625 /**
626 * ratecontrol override, see RcOverride
627 * encoding: allocated/set/freed by user.
628 * decoding: unused
629 */
ce980a95
MN
630 RcOverride *rc_override;
631 int rc_override_count;
b71901e6
MN
632
633 /**
634 * rate control equation
635 * encoding: set by user
636 * decoding: unused
637 */
ce980a95 638 char *rc_eq;
b71901e6
MN
639
640 /**
641 * maximum bitrate
642 * encoding: set by user.
643 * decoding: unused
644 */
ce980a95 645 int rc_max_rate;
b71901e6
MN
646
647 /**
648 * minimum bitrate
649 * encoding: set by user.
650 * decoding: unused
651 */
ce980a95 652 int rc_min_rate;
b71901e6
MN
653
654 /**
655 * decoder bitstream buffer size
656 * encoding: set by user.
657 * decoding: unused
658 */
ce980a95
MN
659 int rc_buffer_size;
660 float rc_buffer_aggressivity;
b71901e6
MN
661
662 /**
663 * qscale factor between p and i frames
664 * encoding: set by user.
665 * decoding: unused
666 */
667 float i_quant_factor;
668
669 /**
670 * qscale offset between p and i frames
b3a391e8
MN
671 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
672 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
b71901e6
MN
673 * encoding: set by user.
674 * decoding: unused
675 */
676 float i_quant_offset;
677
678 /**
679 * initial complexity for pass1 ratecontrol
680 * encoding: set by user.
681 * decoding: unused
682 */
ce980a95 683 float rc_initial_cplx;
917e06c8 684
b71901e6 685 /**
b71901e6
MN
686 * dct algorithm, see FF_DCT_* below
687 * encoding: set by user
688 * decoding: unused
689 */
28db7fce 690 int dct_algo;
c7e07931 691#define FF_DCT_AUTO 0
28db7fce 692#define FF_DCT_FASTINT 1
c7e07931
MO
693#define FF_DCT_INT 2
694#define FF_DCT_MMX 3
695#define FF_DCT_MLIB 4
05c4072b 696#define FF_DCT_ALTIVEC 5
c5d309f2
MN
697
698 /**
699 * luminance masking (0-> disabled)
700 * encoding: set by user
701 * decoding: unused
702 */
703 float lumi_masking;
704
705 /**
706 * temporary complexity masking (0-> disabled)
707 * encoding: set by user
708 * decoding: unused
709 */
710 float temporal_cplx_masking;
711
712 /**
713 * spatial complexity masking (0-> disabled)
714 * encoding: set by user
715 * decoding: unused
716 */
717 float spatial_cplx_masking;
718
719 /**
720 * p block masking (0-> disabled)
721 * encoding: set by user
722 * decoding: unused
723 */
724 float p_masking;
15415af4 725
5e746b99
MN
726 /**
727 * darkness masking (0-> disabled)
728 * encoding: set by user
729 * decoding: unused
730 */
731 float dark_masking;
0c2dd16e
MN
732
733 /**
734 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A')
735 * this is used to workaround some encoder bugs
736 * encoding: unused
202ef8b8 737 * decoding: set by user, will be converted to upper case by lavc during init
0c2dd16e
MN
738 */
739 int fourcc;
5e746b99 740
2ad1516a
MN
741 /**
742 * idct algorithm, see FF_IDCT_* below
743 * encoding: set by user
744 * decoding: set by user
745 */
746 int idct_algo;
747#define FF_IDCT_AUTO 0
748#define FF_IDCT_INT 1
749#define FF_IDCT_SIMPLE 2
750#define FF_IDCT_SIMPLEMMX 3
751#define FF_IDCT_LIBMPEG2MMX 4
752#define FF_IDCT_PS2 5
753#define FF_IDCT_MLIB 6
754#define FF_IDCT_ARM 7
05c4072b 755#define FF_IDCT_ALTIVEC 8
2ad1516a 756
144f0625
MN
757 /**
758 * slice count
759 * encoding: set by lavc
760 * decoding: set by user (or 0)
761 */
762 int slice_count;
763 /**
764 * slice offsets in the frame in bytes
765 * encoding: set/allocated by lavc
766 * decoding: set/allocated by user (or NULL)
767 */
768 int *slice_offset;
769
4d2858de
MN
770 /**
771 * error concealment flags
772 * encoding: unused
773 * decoding: set by user
774 */
775 int error_concealment;
776#define FF_EC_GUESS_MVS 1
777#define FF_EC_DEBLOCK 2
778
6b72ac63 779 /**
8350df97
ZK
780 * dsp_mask could be used to disable unwanted
781 * CPU features (i.e. MMX, SSE. ...)
782 */
783 unsigned dsp_mask;
11f18faf
MN
784
785 /**
786 * bits per sample/pixel from the demuxer (needed for huffyuv)
1e491e29 787 * encoding: set by lavc
11f18faf
MN
788 * decoding: set by user
789 */
790 int bits_per_sample;
791
792 /**
793 * prediction method (needed for huffyuv)
1e491e29 794 * encoding: set by user
11f18faf
MN
795 * decoding: unused
796 */
797 int prediction_method;
798#define FF_PRED_LEFT 0
799#define FF_PRED_PLANE 1
800#define FF_PRED_MEDIAN 2
5d3cea3a
MN
801
802 /**
803 * aspect ratio. (0 if unknown)
804 * encoding: set by user.
805 * decoding: set by lavc.
806 */
807 float aspect_ratio;
1e491e29
MN
808
809 /**
810 * the picture in the bitstream
811 * encoding: set by lavc
812 * decoding: set by lavc
813 */
814 AVVideoFrame *coded_picture;
c8c437bc
MN
815
816 /**
817 * debug
818 * encoding: set by user.
819 * decoding: set by user.
820 */
821 int debug;
822#define FF_DEBUG_PICT_INFO 1
823#define FF_DEBUG_RC 2
824#define FF_DEBUG_BITSTREAM 4
825#define FF_DEBUG_MB_TYPE 8
826#define FF_DEBUG_QP 16
827#define FF_DEBUG_MV 32
828#define FF_DEBUG_VIS_MV 64
de6d9b64
FB
829} AVCodecContext;
830
831typedef struct AVCodec {
18f77016 832 const char *name;
de6d9b64
FB
833 int type;
834 int id;
835 int priv_data_size;
836 int (*init)(AVCodecContext *);
837 int (*encode)(AVCodecContext *, UINT8 *buf, int buf_size, void *data);
838 int (*close)(AVCodecContext *);
0fd90455 839 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
de6d9b64 840 UINT8 *buf, int buf_size);
bf89e6b1 841 int capabilities;
de6d9b64
FB
842 struct AVCodec *next;
843} AVCodec;
844
d7425f59
MN
845/**
846 * four components are given, that's all.
847 * the last component is alpha
848 */
de6d9b64 849typedef struct AVPicture {
d7425f59
MN
850 UINT8 *data[4];
851 int linesize[4];
de6d9b64
FB
852} AVPicture;
853
854extern AVCodec ac3_encoder;
855extern AVCodec mp2_encoder;
9d36bdc9 856extern AVCodec mp3lame_encoder;
81e0d0b4 857extern AVCodec oggvorbis_encoder;
de6d9b64
FB
858extern AVCodec mpeg1video_encoder;
859extern AVCodec h263_encoder;
860extern AVCodec h263p_encoder;
861extern AVCodec rv10_encoder;
862extern AVCodec mjpeg_encoder;
bf89e6b1 863extern AVCodec mpeg4_encoder;
84afee34
MN
864extern AVCodec msmpeg4v1_encoder;
865extern AVCodec msmpeg4v2_encoder;
866extern AVCodec msmpeg4v3_encoder;
0151a6f5
MN
867extern AVCodec wmv1_encoder;
868extern AVCodec wmv2_encoder;
11f18faf 869extern AVCodec huffyuv_encoder;
de6d9b64
FB
870
871extern AVCodec h263_decoder;
bf89e6b1 872extern AVCodec mpeg4_decoder;
84afee34
MN
873extern AVCodec msmpeg4v1_decoder;
874extern AVCodec msmpeg4v2_decoder;
875extern AVCodec msmpeg4v3_decoder;
e1a9dbff 876extern AVCodec wmv1_decoder;
0151a6f5 877extern AVCodec wmv2_decoder;
de6d9b64
FB
878extern AVCodec mpeg_decoder;
879extern AVCodec h263i_decoder;
880extern AVCodec rv10_decoder;
be8ffec9 881extern AVCodec svq1_decoder;
020fcc94
FB
882extern AVCodec dvvideo_decoder;
883extern AVCodec dvaudio_decoder;
bc8d1857
FB
884extern AVCodec wmav1_decoder;
885extern AVCodec wmav2_decoder;
4e66ab3b 886extern AVCodec mjpeg_decoder;
b135d9fb 887extern AVCodec mjpegb_decoder;
4b1f4f23 888extern AVCodec mp2_decoder;
a96b68b7 889extern AVCodec mp3_decoder;
3f95e843
FR
890extern AVCodec mace3_decoder;
891extern AVCodec mace6_decoder;
11f18faf 892extern AVCodec huffyuv_decoder;
3aca208a 893extern AVCodec oggvorbis_decoder;
de6d9b64 894
a96b68b7
FB
895/* pcm codecs */
896#define PCM_CODEC(id, name) \
897extern AVCodec name ## _decoder; \
f11d3f23 898extern AVCodec name ## _encoder
a96b68b7
FB
899
900PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
901PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
902PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
903PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
904PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
905PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
906PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
907PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
908
0147f198
FR
909/* adpcm codecs */
910
911PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
912PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
913PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
914
a96b68b7
FB
915#undef PCM_CODEC
916
917/* dummy raw video codec */
de6d9b64
FB
918extern AVCodec rawvideo_codec;
919
920/* the following codecs use external GPL libs */
de6d9b64
FB
921extern AVCodec ac3_decoder;
922
923/* resample.c */
924
925struct ReSampleContext;
926
927typedef struct ReSampleContext ReSampleContext;
928
929ReSampleContext *audio_resample_init(int output_channels, int input_channels,
930 int output_rate, int input_rate);
931int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
932void audio_resample_close(ReSampleContext *s);
933
934/* YUV420 format is assumed ! */
935
936struct ImgReSampleContext;
937
938typedef struct ImgReSampleContext ImgReSampleContext;
939
940ImgReSampleContext *img_resample_init(int output_width, int output_height,
941 int input_width, int input_height);
ab6d194a
MN
942
943ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
944 int iwidth, int iheight,
945 int topBand, int bottomBand,
946 int leftBand, int rightBand);
947
de6d9b64
FB
948void img_resample(ImgReSampleContext *s,
949 AVPicture *output, AVPicture *input);
950
951void img_resample_close(ImgReSampleContext *s);
952
219b06c6
FB
953void avpicture_fill(AVPicture *picture, UINT8 *ptr,
954 int pix_fmt, int width, int height);
955int avpicture_get_size(int pix_fmt, int width, int height);
1e491e29 956void avcodec_get_chroma_sub_sample(int fmt, int *h_shift, int *v_shift);
219b06c6
FB
957
958/* convert among pixel formats */
959int img_convert(AVPicture *dst, int dst_pix_fmt,
960 AVPicture *src, int pix_fmt,
961 int width, int height);
962
963/* deinterlace a picture */
964int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
de6d9b64
FB
965 int pix_fmt, int width, int height);
966
967/* external high level API */
968
969extern AVCodec *first_avcodec;
970
156e5023 971/* returns LIBAVCODEC_VERSION_INT constant */
51a49663 972unsigned avcodec_version(void);
8bceb6af 973/* returns LIBAVCODEC_BUILD constant */
51a49663 974unsigned avcodec_build(void);
de6d9b64
FB
975void avcodec_init(void);
976
51a49663
FB
977void avcodec_set_bit_exact(void);
978
de6d9b64
FB
979void register_avcodec(AVCodec *format);
980AVCodec *avcodec_find_encoder(enum CodecID id);
98f3b098 981AVCodec *avcodec_find_encoder_by_name(const char *name);
de6d9b64
FB
982AVCodec *avcodec_find_decoder(enum CodecID id);
983AVCodec *avcodec_find_decoder_by_name(const char *name);
984void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
985
1e491e29 986void avcodec_get_context_defaults(AVCodecContext *s);
7ffbb60e 987AVCodecContext *avcodec_alloc_context(void);
1e491e29
MN
988AVVideoFrame *avcodec_alloc_picture(void);
989
990int avcodec_default_get_buffer(AVCodecContext *s, AVVideoFrame *pic);
991void avcodec_default_release_buffer(AVCodecContext *s, AVVideoFrame *pic);
992
de6d9b64
FB
993int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
994int avcodec_decode_audio(AVCodecContext *avctx, INT16 *samples,
995 int *frame_size_ptr,
996 UINT8 *buf, int buf_size);
1e491e29 997int avcodec_decode_video(AVCodecContext *avctx, AVVideoFrame *picture,
de6d9b64
FB
998 int *got_picture_ptr,
999 UINT8 *buf, int buf_size);
917e06c8
FB
1000int avcodec_parse_frame(AVCodecContext *avctx, UINT8 **pdata,
1001 int *data_size_ptr,
1002 UINT8 *buf, int buf_size);
de6d9b64
FB
1003int avcodec_encode_audio(AVCodecContext *avctx, UINT8 *buf, int buf_size,
1004 const short *samples);
1005int avcodec_encode_video(AVCodecContext *avctx, UINT8 *buf, int buf_size,
1e491e29 1006 const AVVideoFrame *pict);
de6d9b64
FB
1007
1008int avcodec_close(AVCodecContext *avctx);
1009
1010void avcodec_register_all(void);
a96b68b7 1011
1c2a8c7f
MN
1012void avcodec_flush_buffers(AVCodecContext *avctx);
1013
e8f14793
ZK
1014/**
1015 * Interface for 0.5.0 version
1016 *
1017 * do not even think about it's usage for this moment
1018 */
1019
1020typedef struct {
1021 // compressed size used from given memory buffer
1022 int size;
1023 /// I/P/B frame type
1024 int frame_type;
1025} avc_enc_result_t;
1026
1027/**
1028 * Commands
1029 * order can't be changed - once it was defined
1030 */
1031typedef enum {
1032 // general commands
1033 AVC_OPEN_BY_NAME = 0xACA000,
1034 AVC_OPEN_BY_CODEC_ID,
1035 AVC_OPEN_BY_FOURCC,
1036 AVC_CLOSE,
1037
1038 AVC_FLUSH,
1039 // pin - struct { uint8_t* src, uint_t src_size }
1040 // pout - struct { AVPicture* img, consumed_bytes,
1041 AVC_DECODE,
1042 // pin - struct { AVPicture* img, uint8_t* dest, uint_t dest_size }
1043 // pout - uint_t used_from_dest_size
1044 AVC_ENCODE,
1045
1046 // query/get video commands
1047 AVC_GET_VERSION = 0xACB000,
1048 AVC_GET_WIDTH,
1049 AVC_GET_HEIGHT,
1050 AVC_GET_DELAY,
1051 AVC_GET_QUANT_TABLE,
1052 // ...
1053
1054 // query/get audio commands
1055 AVC_GET_FRAME_SIZE = 0xABC000,
1056
1057 // maybe define some simple structure which
1058 // might be passed to the user - but they can't
1059 // contain any codec specific parts and these
1060 // calls are usualy necessary only few times
1061
1062 // set video commands
1063 AVC_SET_WIDTH = 0xACD000,
1064 AVC_SET_HEIGHT,
1065
1066 // set video encoding commands
1067 AVC_SET_FRAME_RATE = 0xACD800,
1068 AVC_SET_QUALITY,
1069 AVC_SET_HURRY_UP,
1070
1071 // set audio commands
1072 AVC_SET_SAMPLE_RATE = 0xACE000,
1073 AVC_SET_CHANNELS,
1074
1075} avc_cmd_t;
1076
1077/**
1078 * \param handle allocated private structure by libavcodec
1079 * for initialization pass NULL - will be returned pout
1080 * user is supposed to know nothing about its structure
1081 * \param cmd type of operation to be performed
1082 * \param pint input parameter
1083 * \param pout output parameter
1084 *
1085 * \returns command status - eventually for query command it might return
1086 * integer resulting value
1087 */
1088int avcodec(void* handle, avc_cmd_t cmd, void* pin, void* pout);
1089
544eb99c 1090/* memory */
18f77016
ZK
1091void *av_malloc(unsigned int size);
1092void *av_mallocz(unsigned int size);
544eb99c
FB
1093void av_free(void *ptr);
1094void __av_freep(void **ptr);
1095#define av_freep(p) __av_freep((void **)(p))
855ea723
ZK
1096/* for static data only */
1097/* call av_free_static to release all staticaly allocated tables */
1098void av_free_static();
1099void *__av_mallocz_static(void** location, unsigned int size);
1100#define av_mallocz_static(p, s) __av_mallocz_static((void **)(p), s)
544eb99c 1101
a96b68b7 1102#endif /* AVCODEC_H */