preparing integration of new AC3 decoder
[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"
d6db1c9c
MN
8#define LIBAVCODEC_BUILD 4632
9#define LIBAVCODEC_BUILD_STR "4632"
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,
bf89e6b1 21 CODEC_ID_MPEG4,
de6d9b64 22 CODEC_ID_RAWVIDEO,
84afee34
MN
23 CODEC_ID_MSMPEG4V1,
24 CODEC_ID_MSMPEG4V2,
25 CODEC_ID_MSMPEG4V3,
e1a9dbff 26 CODEC_ID_WMV1,
b50eef3a 27 CODEC_ID_WMV2,
de6d9b64
FB
28 CODEC_ID_H263P,
29 CODEC_ID_H263I,
be8ffec9 30 CODEC_ID_SVQ1,
020fcc94
FB
31 CODEC_ID_DVVIDEO,
32 CODEC_ID_DVAUDIO,
a96b68b7
FB
33
34 /* various pcm "codecs" */
35 CODEC_ID_PCM_S16LE,
36 CODEC_ID_PCM_S16BE,
37 CODEC_ID_PCM_U16LE,
38 CODEC_ID_PCM_U16BE,
39 CODEC_ID_PCM_S8,
40 CODEC_ID_PCM_U8,
41 CODEC_ID_PCM_MULAW,
42 CODEC_ID_PCM_ALAW,
0147f198
FR
43
44 /* various adpcm codecs */
45 CODEC_ID_ADPCM_IMA_QT,
46 CODEC_ID_ADPCM_IMA_WAV,
47 CODEC_ID_ADPCM_MS,
de6d9b64 48};
84afee34 49#define CODEC_ID_MSMPEG4 CODEC_ID_MSMPEG4V3
de6d9b64
FB
50
51enum CodecType {
4a663d80 52 CODEC_TYPE_UNKNOWN = -1,
de6d9b64
FB
53 CODEC_TYPE_VIDEO,
54 CODEC_TYPE_AUDIO,
55};
56
57enum PixelFormat {
9f862d11 58 PIX_FMT_ANY = -1,
de6d9b64
FB
59 PIX_FMT_YUV420P,
60 PIX_FMT_YUV422,
61 PIX_FMT_RGB24,
62 PIX_FMT_BGR24,
d9fea0b5
FB
63 PIX_FMT_YUV422P,
64 PIX_FMT_YUV444P,
b71472eb
PG
65 PIX_FMT_RGBA32,
66 PIX_FMT_BGRA32,
e9feea59
A
67 PIX_FMT_YUV410P,
68 PIX_FMT_YUV411P
de6d9b64
FB
69};
70
a96b68b7
FB
71/* currently unused, may be used if 24/32 bits samples ever supported */
72enum SampleFormat {
73 SAMPLE_FMT_S16 = 0, /* signed 16 bits */
74};
75
de6d9b64
FB
76/* in bytes */
77#define AVCODEC_MAX_AUDIO_FRAME_SIZE 18432
78
e4986da9
J
79/* motion estimation type, EPZS by default */
80enum Motion_Est_ID {
101bea5f 81 ME_ZERO = 1,
e4986da9
J
82 ME_FULL,
83 ME_LOG,
84 ME_PHODS,
85 ME_EPZS,
86 ME_X1
87};
88
ce980a95
MN
89typedef struct RcOverride{
90 int start_frame;
91 int end_frame;
92 int qscale; // if this is 0 then quality_factor will be used instead
93 float quality_factor;
94} RcOverride;
95
101bea5f
J
96/* only for ME compatiblity with old apps */
97extern int motion_estimation_method;
98
e4986da9 99/* ME algos sorted by quality */
bc6caae2
J
100static const int Motion_Est_QTab[] = { ME_ZERO, ME_PHODS, ME_LOG,
101 ME_X1, ME_EPZS, ME_FULL };
de6d9b64 102
28db7fce 103
9dbcbd92
MN
104#define FF_MAX_B_FRAMES 4
105
a949d72e
MN
106/* encoding support
107 these flags can be passed in AVCodecContext.flags before initing
108 Note: note not everything is supported yet
109*/
de6d9b64 110
b71901e6
MN
111#define CODEC_FLAG_HQ 0x0001 /* brute force MB-type decission mode (slow) */
112#define CODEC_FLAG_QSCALE 0x0002 /* use fixed qscale */
113#define CODEC_FLAG_4MV 0x0004 /* 4 MV per MB allowed */
114#define CODEC_FLAG_QPEL 0x0010 /* use qpel MC */
115#define CODEC_FLAG_GMC 0x0020 /* use GMC */
116#define CODEC_FLAG_TYPE 0x0040 /* fixed I/P frame type, from avctx->key_frame */
117#define CODEC_FLAG_PART 0x0080 /* use data partitioning */
9dbcbd92
MN
118/* parent program gurantees that the input for b-frame containing streams is not written to
119 for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
8b4c7dbc 120#define CODEC_FLAG_INPUT_PRESERVED 0x0100
b71901e6
MN
121#define CODEC_FLAG_PASS1 0x0200 /* use internal 2pass ratecontrol in first pass mode */
122#define CODEC_FLAG_PASS2 0x0400 /* use internal 2pass ratecontrol in second pass mode */
e84c31dc 123#define CODEC_FLAG_EXTERN_HUFF 0x1000 /* use external huffman table (for mjpeg) */
b71901e6 124#define CODEC_FLAG_GRAY 0x2000 /* only decode/encode grayscale */
93a21abd 125#define CODEC_FLAG_EMU_EDGE 0x4000/* dont draw edges */
b71901e6
MN
126#define CODEC_FLAG_DR1 0x8000 /* direct renderig type 1 (store internal frames in external buffers) */
127#define CODEC_FLAG_NOT_TRUNCATED 0x00010000 /* input bitstream is not truncated, except before a startcode
128 allows the last part of a frame to be decoded earlier */
c5d309f2 129#define CODEC_FLAG_NORMALIZE_AQP 0x00020000 /* normalize adaptive quantization */
fcb48651 130#define CODEC_FLAG_INTERLACED_DCT 0x00040000 /* use interlaced dct */
c5d309f2 131
bf89e6b1
FB
132/* codec capabilities */
133
b71901e6 134#define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 /* decoder can use draw_horiz_band callback */
93a21abd 135#define CODEC_CAP_DR1 0x0002 /* direct rendering method 1 */
917e06c8
FB
136/* if 'parse_only' field is true, then avcodec_parse_frame() can be
137 used */
138#define CODEC_CAP_PARSE_ONLY 0x0004
bf89e6b1 139
de6d9b64
FB
140#define FRAME_RATE_BASE 10000
141
142typedef struct AVCodecContext {
b71901e6
MN
143 /**
144 * the average bitrate
145 * encoding: set by user. unused for constant quantizer encoding
146 * decoding: set by lavc. 0 or some bitrate if this info is available in the stream
147 */
de6d9b64 148 int bit_rate;
b71901e6
MN
149
150 /**
151 * number of bits the bitstream is allowed to diverge from the reference
152 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
153 * encoding: set by user. unused for constant quantizer encoding
154 * decoding: unused
155 */
156 int bit_rate_tolerance;
157
158 /**
159 * CODEC_FLAG_*
160 * encoding: set by user.
161 * decoding: set by user.
162 */
de6d9b64 163 int flags;
b71901e6
MN
164
165 /**
166 * some codecs needs additionnal format info. It is stored here
167 * encoding: set by user.
168 * decoding: set by lavc. (FIXME is this ok?)
169 */
170 int sub_id;
171
172 /**
173 * motion estimation algorithm used for video coding
174 * encoding: set by user.
175 * decoding: unused
176 */
177 int me_method;
178
179 /**
180 * some codecs need / can use extra-data like huffman tables
181 * mjpeg: huffman tables
182 * rv10: additional flags
b704e742 183 * mpeg4: global headers (they can be in the bitstream or here)
c5d309f2
MN
184 * encoding: set/allocated/freed by lavc.
185 * decoding: set/allocated/freed by user.
b71901e6 186 */
e84c31dc
A
187 void *extradata;
188 int extradata_size;
189
de6d9b64 190 /* video only */
b71901e6
MN
191 /**
192 * frames per sec multiplied by FRAME_RATE_BASE
193 * for variable fps this is the precission, so if the timestamps
194 * can be specified in msec precssion then this is 1000*FRAME_RATE_BASE
195 * encoding: set by user
196 * decoding: set by lavc. 0 or the frame_rate if available
197 */
198 int frame_rate;
199
200 /**
201 * encoding: set by user.
202 * decoding: set by user, some codecs might override / change it during playback
203 */
de6d9b64 204 int width, height;
b71901e6
MN
205
206 /**
207 * encoding: set by user. 0 if not known
208 * decoding: set by lavc. 0 if not known
209 */
11ce8834 210 int aspect_ratio_info;
2efe097a
MN
211#define FF_ASPECT_SQUARE 1
212#define FF_ASPECT_4_3_625 2
213#define FF_ASPECT_4_3_525 3
214#define FF_ASPECT_16_9_625 4
215#define FF_ASPECT_16_9_525 5
e769f053 216#define FF_ASPECT_EXTENDED 15
b71901e6
MN
217
218 /**
219 * the number of pictures in a group of pitures, or 0 for intra_only
220 * encoding: set by user.
221 * decoding: unused
222 */
223 int gop_size;
224
225 /**
226 * pixel format, see PIX_FMT_xxx
227 * encoding: unused
228 * decoding: set by lavc.
229 */
230 enum PixelFormat pix_fmt;
231
e0a3d744
J
232 int repeat_pict; /* when decoding, this signal how much the picture */
233 /* must be delayed. */
234 /* extra_delay = (repeat_pict / 2) * (1/fps) */
b71901e6
MN
235
236 /**
237 * if non NULL, 'draw_horiz_band' is called by the libavcodec
238 * decoder to draw an horizontal band. It improve cache usage. Not
239 * all codecs can do that. You must check the codec capabilities
240 * before
241 * encoding: unused
242 * decoding: set by user.
243 */
bf89e6b1
FB
244 void (*draw_horiz_band)(struct AVCodecContext *s,
245 UINT8 **src_ptr, int linesize,
246 int y, int width, int height);
247
de6d9b64
FB
248 /* audio only */
249 int sample_rate; /* samples per sec */
250 int channels;
a96b68b7 251 int sample_fmt; /* sample format, currenly unused */
de6d9b64
FB
252
253 /* the following data should not be initialized */
9cd3766f
J
254 int frame_size; /* in samples, initialized when calling 'init' */
255 int frame_number; /* audio or video frame number */
256 int real_pict_num; /* returns the real picture number of
257 previous encoded frame */
b71901e6
MN
258
259 /**
260 * 1 -> keyframe, 0-> not
261 * encoding: set by lavc (for the outputed bitstream, not the input frame)
262 * decoding: set by lavc (for the decoded bitstream, not the displayed frame)
263 */
264 int key_frame;
265
266 /**
267 * picture type of the previous en/decoded frame, see ?_TYPE below
268 * encoding: set by lavc (for the outputed bitstream, not the input frame)
269 * decoding: set by lavc (for the decoded bitstream, not the displayed frame)
270 */
271 int pict_type;
9cd3766f
J
272/* FIXME: these should have FF_ */
273#define I_TYPE 1 // Intra
274#define P_TYPE 2 // Predicted
275#define B_TYPE 3 // Bi-dir predicted
276#define S_TYPE 4 // S(GMC)-VOP MPEG4
277
b71901e6
MN
278 /**
279 * number of frames the decoded output will be delayed relative to
280 * the encoded input
281 * encoding: set by lavc.
282 * decoding: unused
283 */
284 int delay;
285
286 /**
287 * mbskip_table[mb]=1 if MB didnt change, is only valid for I/P frames
288 * stride= mb_width = (width+15)>>4 (FIXME export stride?)
289 * encoding: unused
290 * decoding: set by lavc
291 */
292 uint8_t *mbskip_table;
1ff662cc
MN
293
294 /* encoding parameters */
c5d309f2
MN
295 /**
296 * quality (between 1 (good) and 31 (bad))
297 * encoding: set by user if CODEC_FLAG_QSCALE is set otherwise set by lavc
298 * decoding: set by lavc
299 */
de6d9b64 300 int quality; /* quality of the previous encoded frame
c5d309f2 301
8b4c7dbc
MN
302 this is allso used to set the quality in vbr mode
303 and the per frame quality in CODEC_FLAG_TYPE (second pass mode) */
9cdd6a24
MN
304 float qcompress; /* amount of qscale change between easy & hard scenes (0.0-1.0)*/
305 float qblur; /* amount of qscale smoothing over time (0.0-1.0) */
b71901e6
MN
306
307 /**
308 * minimum quantizer
309 * encoding: set by user.
310 * decoding: unused
311 */
312 int qmin;
313
314 /**
315 * maximum quantizer
316 * encoding: set by user.
317 * decoding: unused
318 */
319 int qmax;
320
321 /**
322 * maximum quantizer difference etween frames
323 * encoding: set by user.
324 * decoding: unused
325 */
326 int max_qdiff;
327
328 /**
329 * maximum number of b frames between non b frames
330 * note: the output will be delayed by max_b_frames+1 relative to the input
331 * encoding: set by user.
332 * decoding: unused
333 */
334 int max_b_frames;
335
336 /**
337 * qscale factor between ip and b frames
338 * encoding: set by user.
339 * decoding: unused
340 */
341 float b_quant_factor;
342
343 /** obsolete FIXME remove */
344 int rc_strategy;
8b4c7dbc 345 int b_frame_strategy;
9dbcbd92 346
b71901e6
MN
347 /**
348 * encoding: unused
349 * decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too
350 */
351 int hurry_up;
2417652e 352
de6d9b64 353 struct AVCodec *codec;
b71901e6 354
de6d9b64
FB
355 void *priv_data;
356
644d98a4 357 /* The following data is for RTP friendly coding */
1f6b6e50 358 /* By now only H.263/H.263+/MPEG4 coder honours this */
644d98a4
J
359 int rtp_mode; /* 1 for activate RTP friendly-mode */
360 /* highers numbers represent more error-prone */
361 /* enviroments, by now just "1" exist */
362
363 int rtp_payload_size; /* The size of the RTP payload, the coder will */
364 /* do it's best to deliver a chunk with size */
365 /* below rtp_payload_size, the chunk will start */
366 /* with a start code on some codecs like H.263 */
367 /* This doesn't take account of any particular */
368 /* headers inside the transmited RTP payload */
81401c1f
J
369
370
371 /* The RTP callcack: This function is called */
372 /* every time the encoder as a packet to send */
373 /* Depends on the encoder if the data starts */
374 /* with a Start Code (it should) H.263 does */
375 void (*rtp_callback)(void *data, int size, int packet_number);
376
b71901e6
MN
377 /**
378 * if you set get_psnr to 1 then after encoding you will have the
379 * PSNR on psnr_y/cb/cr
380 * encoding: set by user (1-> on, 0-> off)
381 * decoding: unused
382 */
43f1708f
J
383 int get_psnr;
384 float psnr_y;
385 float psnr_cb;
386 float psnr_cr;
098eefe1
MN
387
388 /* statistics, used for 2-pass encoding */
389 int mv_bits;
390 int header_bits;
391 int i_tex_bits;
392 int p_tex_bits;
393 int i_count;
394 int p_count;
395 int skip_count;
b71901e6
MN
396 int misc_bits;
397
398 /**
399 * number of bits used for the previously encoded frame
400 * encoding: set by lavc
401 * decoding: unused
402 */
098eefe1 403 int frame_bits;
644d98a4 404
b71901e6
MN
405 /**
406 * private data of the user, can be used to carry app specific stuff
407 * encoding: set by user
408 * decoding: set by user
409 */
410 void *opaque;
411
de6d9b64 412 char codec_name[32];
4a663d80
PG
413 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
414 enum CodecID codec_id; /* see CODEC_ID_xxx */
de6d9b64 415 unsigned int codec_tag; /* codec tag, only used if unknown codec */
92ba5ffb 416
b71901e6 417 /**
4d2858de 418 * workaround bugs in encoders which sometimes cannot be detected automatically
b71901e6
MN
419 * encoding: unused
420 * decoding: set by user
421 */
422 int workaround_bugs;
4d2858de
MN
423#define FF_BUG_AUTODETECT 1 //autodetection
424#define FF_BUG_OLD_MSMPEG4 2
425#define FF_BUG_XVID_ILACE 4
426#define FF_BUG_UMP4 8
427#define FF_BUG_NO_PADDING 16
428#define FF_BUG_AC_VLC 32
03e93d35 429#define FF_BUG_QPEL_CHROMA 64
4d2858de
MN
430//#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
431
b71901e6
MN
432 /**
433 * encoding: set by user
434 * decoding: unused
435 */
1f6b6e50 436 int luma_elim_threshold;
b71901e6
MN
437
438 /**
439 * encoding: set by user
440 * decoding: unused
441 */
1f6b6e50 442 int chroma_elim_threshold;
b71901e6
MN
443
444 /**
445 * strictly follow the std (MPEG4, ...)
446 * encoding: set by user
447 * decoding: unused
448 */
449 int strict_std_compliance;
450
451 /**
452 * qscale offset between ip and b frames
b3a391e8
MN
453 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
454 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
b71901e6
MN
455 * encoding: set by user.
456 * decoding: unused
457 */
458 float b_quant_offset;
459
460 /**
461 * error resilience {-1,0,1} higher values will detect more errors but may missdetect
462 * some more or less valid parts as errors
463 * encoding: unused
464 * decoding: set by user
465 */
1f6b6e50 466 int error_resilience;
ae72cda6
NK
467
468#ifndef MBC
469#define MBC 128
470#define MBR 96
471#endif
93a21abd
MN
472#define QP_TYPE int //FIXME note xxx this might be changed to int8_t
473
474 QP_TYPE *quant_store; /* field for communicating with external postprocessing */
93a21abd 475
917e06c8 476 unsigned qstride;
b71901e6
MN
477
478 /**
479 * buffer, where the next picture should be decoded into
480 * encoding: unused
481 * decoding: set by user in get_buffer_callback to a buffer into which the next part
482 * of the bitstream will be decoded, and set by lavc at end of frame to the
483 * next frame which needs to be displayed
484 */
93a21abd 485 uint8_t *dr_buffer[3];
b71901e6
MN
486
487 /**
488 * stride of the luminance part of the dr buffer
489 * encoding: unused
490 * decoding: set by user
491 */
93a21abd 492 int dr_stride;
b71901e6
MN
493
494 /**
495 * same behavior as dr_buffer, just for some private data of the user
496 * encoding: unused
497 * decoding: set by user in get_buffer_callback, and set by lavc at end of frame
498 */
93a21abd 499 void *dr_opaque_frame;
b71901e6
MN
500
501 /**
502 * called at the beginning of each frame to get a buffer for it
503 * encoding: unused
504 * decoding: set by user
505 */
d6db1c9c 506 int (*get_buffer_callback)(struct AVCodecContext *c, int width, int height, int pict_type);
0fd90455 507
b71901e6
MN
508 /**
509 * is 1 if the decoded stream contains b frames, 0 otherwise
510 * encoding: unused
511 * decoding: set by lavc
512 */
513 int has_b_frames;
514
515 /**
516 * stride of the chrominance part of the dr buffer
517 * encoding: unused
518 * decoding: set by user
519 */
0fd90455 520 int dr_uvstride;
b71901e6
MN
521
522 /**
523 * number of dr buffers
524 * encoding: unused
525 * decoding: set by user
526 */
0fd90455 527 int dr_ip_buffer_count;
b71901e6 528
0147f198 529 int block_align; /* currently only for adpcm codec in wav/avi */
ce980a95 530
917e06c8
FB
531 int parse_only; /* decoding only: if true, only parsing is done
532 (function avcodec_parse_frame()). The frame
533 data is returned. Only MPEG codecs support this now. */
ce980a95 534
b71901e6
MN
535 /**
536 * 0-> h263 quant 1-> mpeg quant
537 * encoding: set by user.
538 * decoding: unused
539 */
540 int mpeg_quant;
ce980a95 541
b71901e6
MN
542 /**
543 * pass1 encoding statistics output buffer
544 * encoding: set by lavc
545 * decoding: unused
546 */
ce980a95 547 char *stats_out; /* encoding statistics output buffer */
b71901e6
MN
548
549 /**
550 * pass2 encoding statistics input buffer.
551 * concatenated stuff from stats_out of pass1 should be placed here
552 * encoding: allocated/set/freed by user
553 * decoding: unused
554 */
555 char *stats_in;
556
557 /**
558 * ratecontrol qmin qmax limiting method
559 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
560 * encoding: set by user.
561 * decoding: unused
562 */
ce980a95 563 float rc_qsquish;
b71901e6 564
ce980a95
MN
565 float rc_qmod_amp;
566 int rc_qmod_freq;
b71901e6
MN
567
568 /**
569 * ratecontrol override, see RcOverride
570 * encoding: allocated/set/freed by user.
571 * decoding: unused
572 */
ce980a95
MN
573 RcOverride *rc_override;
574 int rc_override_count;
b71901e6
MN
575
576 /**
577 * rate control equation
578 * encoding: set by user
579 * decoding: unused
580 */
ce980a95 581 char *rc_eq;
b71901e6
MN
582
583 /**
584 * maximum bitrate
585 * encoding: set by user.
586 * decoding: unused
587 */
ce980a95 588 int rc_max_rate;
b71901e6
MN
589
590 /**
591 * minimum bitrate
592 * encoding: set by user.
593 * decoding: unused
594 */
ce980a95 595 int rc_min_rate;
b71901e6
MN
596
597 /**
598 * decoder bitstream buffer size
599 * encoding: set by user.
600 * decoding: unused
601 */
ce980a95
MN
602 int rc_buffer_size;
603 float rc_buffer_aggressivity;
b71901e6
MN
604
605 /**
606 * qscale factor between p and i frames
607 * encoding: set by user.
608 * decoding: unused
609 */
610 float i_quant_factor;
611
612 /**
613 * qscale offset between p and i frames
b3a391e8
MN
614 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
615 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
b71901e6
MN
616 * encoding: set by user.
617 * decoding: unused
618 */
619 float i_quant_offset;
620
621 /**
622 * initial complexity for pass1 ratecontrol
623 * encoding: set by user.
624 * decoding: unused
625 */
ce980a95 626 float rc_initial_cplx;
917e06c8 627
b71901e6
MN
628 /**
629 * custom aspect ratio, used if aspect_info==FF_ASPECT_EXTENDED
630 * encoding: set by user.
631 * decoding: set by lavc.
632 */
e769f053
AB
633 int aspected_width;
634 int aspected_height;
635
b71901e6
MN
636 /**
637 * dct algorithm, see FF_DCT_* below
638 * encoding: set by user
639 * decoding: unused
640 */
28db7fce 641 int dct_algo;
c7e07931 642#define FF_DCT_AUTO 0
28db7fce 643#define FF_DCT_FASTINT 1
c7e07931
MO
644#define FF_DCT_INT 2
645#define FF_DCT_MMX 3
646#define FF_DCT_MLIB 4
28db7fce 647
b71901e6
MN
648 /**
649 * presentation timestamp in micro seconds (time when frame should be shown to user)
650 * if 0 then the frame_rate will be used as reference
651 * encoding: set by user
652 * decoding; set by lavc
653 */
654 long long int pts;
c5d309f2
MN
655
656 /**
657 * luminance masking (0-> disabled)
658 * encoding: set by user
659 * decoding: unused
660 */
661 float lumi_masking;
662
663 /**
664 * temporary complexity masking (0-> disabled)
665 * encoding: set by user
666 * decoding: unused
667 */
668 float temporal_cplx_masking;
669
670 /**
671 * spatial complexity masking (0-> disabled)
672 * encoding: set by user
673 * decoding: unused
674 */
675 float spatial_cplx_masking;
676
677 /**
678 * p block masking (0-> disabled)
679 * encoding: set by user
680 * decoding: unused
681 */
682 float p_masking;
15415af4 683
5e746b99
MN
684 /**
685 * darkness masking (0-> disabled)
686 * encoding: set by user
687 * decoding: unused
688 */
689 float dark_masking;
0c2dd16e
MN
690
691 /**
692 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A')
693 * this is used to workaround some encoder bugs
694 * encoding: unused
202ef8b8 695 * decoding: set by user, will be converted to upper case by lavc during init
0c2dd16e
MN
696 */
697 int fourcc;
5e746b99 698
2ad1516a
MN
699 /**
700 * idct algorithm, see FF_IDCT_* below
701 * encoding: set by user
702 * decoding: set by user
703 */
704 int idct_algo;
705#define FF_IDCT_AUTO 0
706#define FF_IDCT_INT 1
707#define FF_IDCT_SIMPLE 2
708#define FF_IDCT_SIMPLEMMX 3
709#define FF_IDCT_LIBMPEG2MMX 4
710#define FF_IDCT_PS2 5
711#define FF_IDCT_MLIB 6
712#define FF_IDCT_ARM 7
713
144f0625
MN
714 /**
715 * slice count
716 * encoding: set by lavc
717 * decoding: set by user (or 0)
718 */
719 int slice_count;
720 /**
721 * slice offsets in the frame in bytes
722 * encoding: set/allocated by lavc
723 * decoding: set/allocated by user (or NULL)
724 */
725 int *slice_offset;
726
4d2858de
MN
727 /**
728 * error concealment flags
729 * encoding: unused
730 * decoding: set by user
731 */
732 int error_concealment;
733#define FF_EC_GUESS_MVS 1
734#define FF_EC_DEBLOCK 2
735
1f6b6e50 736 //FIXME this should be reordered after kabis API is finished ...
ce980a95 737 //TODO kill kabi
5d27890a
NK
738 /*
739 Note: Below are located reserved fields for further usage
740 It requires for ABI !!!
741 If you'll perform some changes then borrow new space from these fields
742 (void * can be safety replaced with struct * ;)
743 P L E A S E ! ! !
b71901e6
MN
744 Note: use avcodec_alloc_context instead of malloc to allocate this,
745 otherwise the ABI compatibility will be broken between versions
746 IMPORTANT: Never change order of already declared fields!!!
747 */
748 //TODO: remove mess below
5d27890a
NK
749 unsigned long long int
750 ull_res0,ull_res1,ull_res2,ull_res3,ull_res4,ull_res5,
15415af4 751 ull_res6,ull_res7,ull_res8,ull_res9,ull_res10,ull_res11;
5d27890a
NK
752 float
753 flt_res0,flt_res1,flt_res2,flt_res3,flt_res4,flt_res5,
ce980a95 754 flt_res6,flt_res7,flt_res8,flt_res9,flt_res10,flt_res11,flt_res12;
5d27890a
NK
755 void
756 *ptr_res0,*ptr_res1,*ptr_res2,*ptr_res3,*ptr_res4,*ptr_res5,
ce980a95 757 *ptr_res6,*ptr_res7,*ptr_res8,*ptr_res9,*ptr_res10,*ptr_res11,*ptr_res12;
5d27890a
NK
758 unsigned long int
759 ul_res0,ul_res1,ul_res2,ul_res3,ul_res4,ul_res5,
760 ul_res6,ul_res7,ul_res8,ul_res9,ul_res10,ul_res11,ul_res12;
5d27890a
NK
761 unsigned short int
762 us_res0,us_res1,us_res2,us_res3,us_res4,us_res5,
763 us_res6,us_res7,us_res8,us_res9,us_res10,us_res11,us_res12;
764 unsigned char
765 uc_res0,uc_res1,uc_res2,uc_res3,uc_res4,uc_res5,
0fd90455 766 uc_res6,uc_res7,uc_res8,uc_res9,uc_res10,uc_res11,uc_res12;
ce980a95
MN
767 unsigned int
768 ui_res0,ui_res1,ui_res2,ui_res3,ui_res4,ui_res5,ui_res6,ui_res7,ui_res8,ui_res9,
28db7fce 769 ui_res10,ui_res11,ui_res12,ui_res13,ui_res14,ui_res15,ui_res16;
de6d9b64
FB
770} AVCodecContext;
771
772typedef struct AVCodec {
773 char *name;
774 int type;
775 int id;
776 int priv_data_size;
777 int (*init)(AVCodecContext *);
778 int (*encode)(AVCodecContext *, UINT8 *buf, int buf_size, void *data);
779 int (*close)(AVCodecContext *);
0fd90455 780 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
de6d9b64 781 UINT8 *buf, int buf_size);
bf89e6b1 782 int capabilities;
de6d9b64 783 struct AVCodec *next;
5d27890a
NK
784 /*
785 Note: Below are located reserved fields for further usage
786 It requires for ABI !!!
787 If you'll perform some changes then borrow new space from these fields
788 (void * can be safety replaced with struct * ;)
789 P L E A S E ! ! !
790 IMPORTANT: Never change order of already declared fields!!!
791 */
792 unsigned long long int
793 ull_res0,ull_res1,ull_res2,ull_res3,ull_res4,ull_res5,
794 ull_res6,ull_res7,ull_res8,ull_res9,ull_res10,ull_res11,ull_res12;
795 float
796 flt_res0,flt_res1,flt_res2,flt_res3,flt_res4,flt_res5,
797 flt_res6,flt_res7,flt_res8,flt_res9,flt_res10,flt_res11,flt_res12;
798 void
799 *ptr_res0,*ptr_res1,*ptr_res2,*ptr_res3,*ptr_res4,*ptr_res5,
800 *ptr_res6,*ptr_res7,*ptr_res8,*ptr_res9,*ptr_res10,*ptr_res11,*ptr_res12;
de6d9b64
FB
801} AVCodec;
802
803/* three components are given, that's all */
804typedef struct AVPicture {
805 UINT8 *data[3];
806 int linesize[3];
807} AVPicture;
808
809extern AVCodec ac3_encoder;
810extern AVCodec mp2_encoder;
9d36bdc9 811extern AVCodec mp3lame_encoder;
81e0d0b4 812extern AVCodec oggvorbis_encoder;
de6d9b64
FB
813extern AVCodec mpeg1video_encoder;
814extern AVCodec h263_encoder;
815extern AVCodec h263p_encoder;
816extern AVCodec rv10_encoder;
817extern AVCodec mjpeg_encoder;
bf89e6b1 818extern AVCodec mpeg4_encoder;
84afee34
MN
819extern AVCodec msmpeg4v1_encoder;
820extern AVCodec msmpeg4v2_encoder;
821extern AVCodec msmpeg4v3_encoder;
0151a6f5
MN
822extern AVCodec wmv1_encoder;
823extern AVCodec wmv2_encoder;
de6d9b64
FB
824
825extern AVCodec h263_decoder;
bf89e6b1 826extern AVCodec mpeg4_decoder;
84afee34
MN
827extern AVCodec msmpeg4v1_decoder;
828extern AVCodec msmpeg4v2_decoder;
829extern AVCodec msmpeg4v3_decoder;
e1a9dbff 830extern AVCodec wmv1_decoder;
0151a6f5 831extern AVCodec wmv2_decoder;
de6d9b64
FB
832extern AVCodec mpeg_decoder;
833extern AVCodec h263i_decoder;
834extern AVCodec rv10_decoder;
be8ffec9 835extern AVCodec svq1_decoder;
020fcc94
FB
836extern AVCodec dvvideo_decoder;
837extern AVCodec dvaudio_decoder;
4e66ab3b 838extern AVCodec mjpeg_decoder;
4b1f4f23 839extern AVCodec mp2_decoder;
a96b68b7 840extern AVCodec mp3_decoder;
de6d9b64 841
a96b68b7
FB
842/* pcm codecs */
843#define PCM_CODEC(id, name) \
844extern AVCodec name ## _decoder; \
845extern AVCodec name ## _encoder;
846
847PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
848PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
849PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
850PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
851PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
852PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
853PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
854PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
855
0147f198
FR
856/* adpcm codecs */
857
858PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
859PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
860PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
861
a96b68b7
FB
862#undef PCM_CODEC
863
864/* dummy raw video codec */
de6d9b64
FB
865extern AVCodec rawvideo_codec;
866
867/* the following codecs use external GPL libs */
de6d9b64
FB
868extern AVCodec ac3_decoder;
869
870/* resample.c */
871
872struct ReSampleContext;
873
874typedef struct ReSampleContext ReSampleContext;
875
876ReSampleContext *audio_resample_init(int output_channels, int input_channels,
877 int output_rate, int input_rate);
878int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
879void audio_resample_close(ReSampleContext *s);
880
881/* YUV420 format is assumed ! */
882
883struct ImgReSampleContext;
884
885typedef struct ImgReSampleContext ImgReSampleContext;
886
887ImgReSampleContext *img_resample_init(int output_width, int output_height,
888 int input_width, int input_height);
ab6d194a
MN
889
890ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
891 int iwidth, int iheight,
892 int topBand, int bottomBand,
893 int leftBand, int rightBand);
894
de6d9b64
FB
895void img_resample(ImgReSampleContext *s,
896 AVPicture *output, AVPicture *input);
897
898void img_resample_close(ImgReSampleContext *s);
899
219b06c6
FB
900void avpicture_fill(AVPicture *picture, UINT8 *ptr,
901 int pix_fmt, int width, int height);
902int avpicture_get_size(int pix_fmt, int width, int height);
903
904/* convert among pixel formats */
905int img_convert(AVPicture *dst, int dst_pix_fmt,
906 AVPicture *src, int pix_fmt,
907 int width, int height);
908
909/* deinterlace a picture */
910int avpicture_deinterlace(AVPicture *dst, AVPicture *src,
de6d9b64
FB
911 int pix_fmt, int width, int height);
912
913/* external high level API */
914
915extern AVCodec *first_avcodec;
916
156e5023 917/* returns LIBAVCODEC_VERSION_INT constant */
51a49663 918unsigned avcodec_version(void);
8bceb6af 919/* returns LIBAVCODEC_BUILD constant */
51a49663 920unsigned avcodec_build(void);
de6d9b64
FB
921void avcodec_init(void);
922
51a49663
FB
923void avcodec_set_bit_exact(void);
924
de6d9b64
FB
925void register_avcodec(AVCodec *format);
926AVCodec *avcodec_find_encoder(enum CodecID id);
98f3b098 927AVCodec *avcodec_find_encoder_by_name(const char *name);
de6d9b64
FB
928AVCodec *avcodec_find_decoder(enum CodecID id);
929AVCodec *avcodec_find_decoder_by_name(const char *name);
930void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
931
7ffbb60e 932AVCodecContext *avcodec_alloc_context(void);
de6d9b64
FB
933int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
934int avcodec_decode_audio(AVCodecContext *avctx, INT16 *samples,
935 int *frame_size_ptr,
936 UINT8 *buf, int buf_size);
937int avcodec_decode_video(AVCodecContext *avctx, AVPicture *picture,
938 int *got_picture_ptr,
939 UINT8 *buf, int buf_size);
917e06c8
FB
940int avcodec_parse_frame(AVCodecContext *avctx, UINT8 **pdata,
941 int *data_size_ptr,
942 UINT8 *buf, int buf_size);
de6d9b64
FB
943int avcodec_encode_audio(AVCodecContext *avctx, UINT8 *buf, int buf_size,
944 const short *samples);
945int avcodec_encode_video(AVCodecContext *avctx, UINT8 *buf, int buf_size,
946 const AVPicture *pict);
947
948int avcodec_close(AVCodecContext *avctx);
949
950void avcodec_register_all(void);
a96b68b7 951
1c2a8c7f
MN
952void avcodec_flush_buffers(AVCodecContext *avctx);
953
79e7b305 954#ifdef FF_POSTPROCESS
79e7b305
A
955extern int quant_store[MBR+1][MBC+1]; // [Review]
956#endif
957
e8f14793
ZK
958
959/**
960 * Interface for 0.5.0 version
961 *
962 * do not even think about it's usage for this moment
963 */
964
965typedef struct {
966 // compressed size used from given memory buffer
967 int size;
968 /// I/P/B frame type
969 int frame_type;
970} avc_enc_result_t;
971
972/**
973 * Commands
974 * order can't be changed - once it was defined
975 */
976typedef enum {
977 // general commands
978 AVC_OPEN_BY_NAME = 0xACA000,
979 AVC_OPEN_BY_CODEC_ID,
980 AVC_OPEN_BY_FOURCC,
981 AVC_CLOSE,
982
983 AVC_FLUSH,
984 // pin - struct { uint8_t* src, uint_t src_size }
985 // pout - struct { AVPicture* img, consumed_bytes,
986 AVC_DECODE,
987 // pin - struct { AVPicture* img, uint8_t* dest, uint_t dest_size }
988 // pout - uint_t used_from_dest_size
989 AVC_ENCODE,
990
991 // query/get video commands
992 AVC_GET_VERSION = 0xACB000,
993 AVC_GET_WIDTH,
994 AVC_GET_HEIGHT,
995 AVC_GET_DELAY,
996 AVC_GET_QUANT_TABLE,
997 // ...
998
999 // query/get audio commands
1000 AVC_GET_FRAME_SIZE = 0xABC000,
1001
1002 // maybe define some simple structure which
1003 // might be passed to the user - but they can't
1004 // contain any codec specific parts and these
1005 // calls are usualy necessary only few times
1006
1007 // set video commands
1008 AVC_SET_WIDTH = 0xACD000,
1009 AVC_SET_HEIGHT,
1010
1011 // set video encoding commands
1012 AVC_SET_FRAME_RATE = 0xACD800,
1013 AVC_SET_QUALITY,
1014 AVC_SET_HURRY_UP,
1015
1016 // set audio commands
1017 AVC_SET_SAMPLE_RATE = 0xACE000,
1018 AVC_SET_CHANNELS,
1019
1020} avc_cmd_t;
1021
1022/**
1023 * \param handle allocated private structure by libavcodec
1024 * for initialization pass NULL - will be returned pout
1025 * user is supposed to know nothing about its structure
1026 * \param cmd type of operation to be performed
1027 * \param pint input parameter
1028 * \param pout output parameter
1029 *
1030 * \returns command status - eventually for query command it might return
1031 * integer resulting value
1032 */
1033int avcodec(void* handle, avc_cmd_t cmd, void* pin, void* pout);
1034
544eb99c
FB
1035/* memory */
1036void *av_malloc(int size);
1037void *av_mallocz(int size);
1038void av_free(void *ptr);
1039void __av_freep(void **ptr);
1040#define av_freep(p) __av_freep((void **)(p))
1041
a96b68b7 1042#endif /* AVCODEC_H */