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