2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
26 * external api header.
35 #include <sys/types.h> /* size_t */
37 #define AV_STRINGIFY(s) AV_TOSTRING(s)
38 #define AV_TOSTRING(s) #s
40 #define LIBAVCODEC_VERSION_INT ((51<<16)+(40<<8)+0)
41 #define LIBAVCODEC_VERSION 51.40.0
42 #define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT
44 #define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
46 #define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
47 #define AV_TIME_BASE 1000000
48 #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
53 CODEC_ID_MPEG2VIDEO, /* prefered ID for MPEG Video 1 or 2 decoding */
54 CODEC_ID_MPEG2VIDEO_XVMC,
91 CODEC_ID_INTERPLAY_VIDEO,
103 CODEC_ID_TRUEMOTION1,
131 CODEC_ID_TRUEMOTION2,
148 CODEC_ID_DSICINVIDEO,
149 CODEC_ID_TIERTEXSEQVIDEO,
156 /* various pcm "codecs" */
157 CODEC_ID_PCM_S16LE= 0x10000,
173 CODEC_ID_PCM_S24DAUD,
175 /* various adpcm codecs */
176 CODEC_ID_ADPCM_IMA_QT= 0x11000,
177 CODEC_ID_ADPCM_IMA_WAV,
178 CODEC_ID_ADPCM_IMA_DK3,
179 CODEC_ID_ADPCM_IMA_DK4,
180 CODEC_ID_ADPCM_IMA_WS,
181 CODEC_ID_ADPCM_IMA_SMJPEG,
190 CODEC_ID_ADPCM_YAMAHA,
191 CODEC_ID_ADPCM_SBPRO_4,
192 CODEC_ID_ADPCM_SBPRO_3,
193 CODEC_ID_ADPCM_SBPRO_2,
196 CODEC_ID_AMR_NB= 0x12000,
199 /* RealAudio codecs*/
200 CODEC_ID_RA_144= 0x13000,
203 /* various DPCM codecs */
204 CODEC_ID_ROQ_DPCM= 0x14000,
205 CODEC_ID_INTERPLAY_DPCM,
209 CODEC_ID_MP2= 0x15000,
210 CODEC_ID_MP3, /* prefered ID for MPEG Audio layer 1, 2 or3 decoding */
212 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
231 CODEC_ID_WESTWOOD_SND1,
232 CODEC_ID_GSM, /* As in Berlin toast format */
240 CODEC_ID_DSICINAUDIO,
244 CODEC_ID_GSM_MS, /* As found in WAV */
246 /* subtitle codecs */
247 CODEC_ID_DVD_SUBTITLE= 0x17000,
248 CODEC_ID_DVB_SUBTITLE,
250 CODEC_ID_MPEG2TS= 0x20000, /* _FAKE_ codec to indicate a raw MPEG2 transport
251 stream (only used by libavformat) */
254 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
255 /* CODEC_ID_MP3LAME is absolete */
256 #define CODEC_ID_MP3LAME CODEC_ID_MP3
257 #define CODEC_ID_MPEG4AAC CODEC_ID_AAC
261 CODEC_TYPE_UNKNOWN = -1,
269 /* currently unused, may be used if 24/32 bits samples ever supported */
270 /* all in native endian */
272 SAMPLE_FMT_NONE = -1,
273 SAMPLE_FMT_U8, ///< unsigned 8 bits
274 SAMPLE_FMT_S16, ///< signed 16 bits
275 SAMPLE_FMT_S24, ///< signed 24 bits
276 SAMPLE_FMT_S32, ///< signed 32 bits
277 SAMPLE_FMT_FLT, ///< float
281 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
284 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
285 * this is mainly needed because some optimized bitstream readers read
286 * 32 or 64 bit at once and could read over the end<br>
287 * Note, if the first 23 bits of the additional bytes are not 0 then damaged
288 * MPEG bitstreams could cause overread and segfault
290 #define FF_INPUT_BUFFER_PADDING_SIZE 8
293 * minimum encoding buffer size.
294 * used to avoid some checks during header writing
296 #define FF_MIN_BUFFER_SIZE 16384
298 /* motion estimation type, EPZS by default */
312 //we leave some space between them for extensions (drop some keyframes for intra only or drop just some bidir frames)
313 AVDISCARD_NONE =-16, ///< discard nothing
314 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
315 AVDISCARD_NONREF = 8, ///< discard all non reference
316 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
317 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
318 AVDISCARD_ALL = 48, ///< discard all
321 typedef struct RcOverride{
324 int qscale; // if this is 0 then quality_factor will be used instead
325 float quality_factor;
328 #define FF_MAX_B_FRAMES 16
331 these flags can be passed in AVCodecContext.flags before initing
332 Note: not everything is supported yet.
335 #define CODEC_FLAG_QSCALE 0x0002 ///< use fixed qscale
336 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / Advanced prediction for H263
337 #define CODEC_FLAG_QPEL 0x0010 ///< use qpel MC
338 #define CODEC_FLAG_GMC 0x0020 ///< use GMC
339 #define CODEC_FLAG_MV0 0x0040 ///< always try a MB with MV=<0,0>
340 #define CODEC_FLAG_PART 0x0080 ///< use data partitioning
341 /* parent program guarantees that the input for b-frame containing streams is not written to
342 for at least s->max_b_frames+1 frames, if this is not set than the input will be copied */
343 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
344 #define CODEC_FLAG_PASS1 0x0200 ///< use internal 2pass ratecontrol in first pass mode
345 #define CODEC_FLAG_PASS2 0x0400 ///< use internal 2pass ratecontrol in second pass mode
346 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< use external huffman table (for mjpeg)
347 #define CODEC_FLAG_GRAY 0x2000 ///< only decode/encode grayscale
348 #define CODEC_FLAG_EMU_EDGE 0x4000///< don't draw edges
349 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding
350 #define CODEC_FLAG_TRUNCATED 0x00010000 /** input bitstream might be truncated at a random location instead
351 of only at frame boundaries */
352 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< normalize adaptive quantization
353 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< use interlaced dct
354 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< force low delay
355 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< use alternate scan
356 #define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< use trellis quantization
357 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< place global headers in extradata instead of every keyframe
358 #define CODEC_FLAG_BITEXACT 0x00800000 ///< use only bitexact stuff (except (i)dct)
359 /* Fx : Flag for h263+ extra options */
360 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
361 #define CODEC_FLAG_H263P_AIC 0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction (remove this)
363 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H263 Advanced intra coding / MPEG4 AC prediction
364 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< Unlimited motion vector
365 #define CODEC_FLAG_CBP_RD 0x04000000 ///< use rate distortion optimization for cbp
366 #define CODEC_FLAG_QP_RD 0x08000000 ///< use rate distortion optimization for qp selectioon
367 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H263 Alternative inter vlc
368 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
369 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
370 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
371 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
372 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< will reserve space for SVCD scan offset user data
373 #define CODEC_FLAG_CLOSED_GOP ((int)0x80000000)
374 #define CODEC_FLAG2_FAST 0x00000001 ///< allow non spec compliant speedup tricks
375 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< strictly enforce GOP size
376 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< skip bitstream encoding
377 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< place global headers at every keyframe instead of in extradata
378 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow b-frames to be used as references
379 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for b-frames
380 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
381 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
382 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
383 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
384 #define CODEC_FLAG2_BRDO 0x00000400 ///< b-frame rate-distortion optimization
385 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< use MPEG-2 intra VLC table
386 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< only do ME/MC (I frames -> ref, P frame -> ME+MC)
387 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format
388 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skiping
389 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< input bitstream might be truncated at a packet boundaries instead of only at frame boundaries
390 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< use MPEG-2 non linear quantizer
392 /* Unsupported options :
393 * Syntax Arithmetic coding (SAC)
394 * Reference Picture Selection
395 * Independent Segment Decoding */
397 /* codec capabilities */
399 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< decoder can use draw_horiz_band callback
401 * Codec uses get_buffer() for allocating buffers.
402 * direct rendering method 1
404 #define CODEC_CAP_DR1 0x0002
405 /* if 'parse_only' field is true, then avcodec_parse_frame() can be
407 #define CODEC_CAP_PARSE_ONLY 0x0004
408 #define CODEC_CAP_TRUNCATED 0x0008
409 /* codec can export data for HW decoding (XvMC) */
410 #define CODEC_CAP_HWACCEL 0x0010
412 * codec has a non zero delay and needs to be feeded with NULL at the end to get the delayed data.
413 * if this is not set, the codec is guaranteed to never be feeded with NULL data
415 #define CODEC_CAP_DELAY 0x0020
417 * Codec can be fed a final frame with a smaller size.
418 * This can be used to prevent truncation of the last audio samples.
420 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
422 //the following defines may change, don't expect compatibility if you use them
423 #define MB_TYPE_INTRA4x4 0x0001
424 #define MB_TYPE_INTRA16x16 0x0002 //FIXME h264 specific
425 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME h264 specific
426 #define MB_TYPE_16x16 0x0008
427 #define MB_TYPE_16x8 0x0010
428 #define MB_TYPE_8x16 0x0020
429 #define MB_TYPE_8x8 0x0040
430 #define MB_TYPE_INTERLACED 0x0080
431 #define MB_TYPE_DIRECT2 0x0100 //FIXME
432 #define MB_TYPE_ACPRED 0x0200
433 #define MB_TYPE_GMC 0x0400
434 #define MB_TYPE_SKIP 0x0800
435 #define MB_TYPE_P0L0 0x1000
436 #define MB_TYPE_P1L0 0x2000
437 #define MB_TYPE_P0L1 0x4000
438 #define MB_TYPE_P1L1 0x8000
439 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
440 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
441 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
442 #define MB_TYPE_QUANT 0x00010000
443 #define MB_TYPE_CBP 0x00020000
444 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
448 * this specifies the area which should be displayed. Note there may be multiple such areas for one frame
450 typedef struct AVPanScan{
453 * - encoding: set by user.
454 * - decoding: set by lavc
459 * width and height in 1/16 pel
460 * - encoding: set by user.
461 * - decoding: set by lavc
467 * position of the top left corner in 1/16 pel for up to 3 fields/frames.
468 * - encoding: set by user.
469 * - decoding: set by lavc
471 int16_t position[3][2];
474 #define FF_COMMON_FRAME \
476 * pointer to the picture planes.\
477 * this might be different from the first allocated byte\
484 * pointer to the first allocated byte of the picture. can be used in get_buffer/release_buffer\
485 * this isn't used by lavc unless the default get/release_buffer() is used\
491 * 1 -> keyframe, 0-> not\
492 * - encoding: set by lavc\
493 * - decoding: set by lavc\
498 * picture type of the frame, see ?_TYPE below.\
499 * - encoding: set by lavc for coded_picture (and set by user for input)\
500 * - decoding: set by lavc\
505 * presentation timestamp in time_base units (time when frame should be shown to user)\
506 * if AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed\
507 * - encoding: MUST be set by user\
508 * - decoding: set by lavc\
513 * picture number in bitstream order.\
514 * - encoding: set by\
515 * - decoding: set by lavc\
517 int coded_picture_number;\
519 * picture number in display order.\
520 * - encoding: set by\
521 * - decoding: set by lavc\
523 int display_picture_number;\
526 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
527 * - encoding: set by lavc for coded_picture (and set by user for input)\
528 * - decoding: set by lavc\
533 * buffer age (1->was last buffer and dint change, 2->..., ...).\
534 * set to INT_MAX if the buffer has not been used yet \
535 * - encoding: unused\
536 * - decoding: MUST be set by get_buffer()\
541 * is this picture used as reference\
542 * - encoding: unused\
543 * - decoding: set by lavc (before get_buffer() call))\
549 * - encoding: unused\
550 * - decoding: set by lavc\
552 int8_t *qscale_table;\
555 * - encoding: unused\
556 * - decoding: set by lavc\
561 * mbskip_table[mb]>=1 if MB didnt change\
562 * stride= mb_width = (width+15)>>4\
563 * - encoding: unused\
564 * - decoding: set by lavc\
566 uint8_t *mbskip_table;\
569 * Motion vector table.\
572 * int mv_sample_log2= 4 - motion_subsample_log2;\
573 * int mb_width= (width+15)>>4;\
574 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
575 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
577 * - encoding: set by user\
578 * - decoding: set by lavc\
580 int16_t (*motion_val[2])[2];\
583 * Macroblock type table\
584 * mb_type_base + mb_width + 2\
585 * - encoding: set by user\
586 * - decoding: set by lavc\
591 * log2 of the size of the block which a single vector in motion_val represents: \
592 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
593 * - encoding: unused\
594 * - decoding: set by lavc\
596 uint8_t motion_subsample_log2;\
599 * for some private data of the user\
600 * - encoding: unused\
601 * - decoding: set by user\
607 * - encoding: set by lavc if flags&CODEC_FLAG_PSNR\
608 * - decoding: unused\
613 * type of the buffer (to keep track of who has to dealloc data[*])\
614 * - encoding: set by the one who allocs it\
615 * - decoding: set by the one who allocs it\
616 * Note: user allocated (direct rendering) & internal buffers can not coexist currently\
621 * when decoding, this signal how much the picture must be delayed.\
622 * extra_delay = repeat_pict / (2*fps)\
623 * - encoding: unused\
624 * - decoding: set by lavc\
634 * The content of the picture is interlaced.\
635 * - encoding: set by user\
636 * - decoding: set by lavc (default 0)\
638 int interlaced_frame;\
641 * if the content is interlaced, is top field displayed first.\
642 * - encoding: set by user\
643 * - decoding: set by lavc\
645 int top_field_first;\
649 * - encoding: set by user\
650 * - decoding: set by lavc\
652 AVPanScan *pan_scan;\
655 * tell user application that palette has changed from previous frame.\
656 * - encoding: ??? (no palette-enabled encoder yet)\
657 * - decoding: set by lavc (default 0)\
659 int palette_has_changed;\
662 * Codec suggestion on buffer type if != 0\
663 * - encoding: unused\
664 * - decoding: set by lavc (before get_buffer() call))\
670 * - encoding: unused\
671 * - decoding: set by lavc\
676 * Motion referece frame index\
677 * - encoding: set by user\
678 * - decoding: set by lavc\
680 int8_t *ref_index[2];
682 #define FF_QSCALE_TYPE_MPEG1 0
683 #define FF_QSCALE_TYPE_MPEG2 1
684 #define FF_QSCALE_TYPE_H264 2
686 #define FF_BUFFER_TYPE_INTERNAL 1
687 #define FF_BUFFER_TYPE_USER 2 ///< Direct rendering buffers (image is (de)allocated by user)
688 #define FF_BUFFER_TYPE_SHARED 4 ///< buffer from somewhere else, don't dealloc image (data/base), all other tables are not shared
689 #define FF_BUFFER_TYPE_COPY 8 ///< just a (modified) copy of some other buffer, don't dealloc anything
692 #define FF_I_TYPE 1 // Intra
693 #define FF_P_TYPE 2 // Predicted
694 #define FF_B_TYPE 3 // Bi-dir predicted
695 #define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
699 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore)
700 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer
701 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content
702 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update)
707 typedef struct AVFrame {
711 #define DEFAULT_FRAME_RATE_BASE 1001000
714 * main external api structure.
716 typedef struct AVCodecContext {
718 * Info on struct for av_log
719 * - set by avcodec_alloc_context
723 * the average bitrate.
724 * - encoding: set by user. unused for constant quantizer encoding
725 * - decoding: set by lavc. 0 or some bitrate if this info is available in the stream
730 * number of bits the bitstream is allowed to diverge from the reference.
731 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
732 * - encoding: set by user. unused for constant quantizer encoding
735 int bit_rate_tolerance;
739 * - encoding: set by user.
740 * - decoding: set by user.
745 * some codecs needs additionnal format info. It is stored here
746 * if any muxer uses this then ALL demuxers/parsers AND encoders for the specific codec MUST set it correctly
747 * too otherwise stream copy breaks
748 * in general use of this field by muxers is not recommanded
749 * - encoding: set by lavc.
750 * - decoding: set by lavc. (FIXME is this ok?)
755 * motion estimation algorithm used for video coding.
756 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
757 * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
758 * - encoding: MUST be set by user.
764 * some codecs need / can use extra-data like huffman tables.
765 * mjpeg: huffman tables
766 * rv10: additional flags
767 * mpeg4: global headers (they can be in the bitstream or here)
768 * the allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
769 * then extradata_size to avoid prolems if its read with the bitstream reader
770 * the bytewise contents of extradata must not depend on the architecture or cpu endianness
771 * - encoding: set/allocated/freed by lavc.
772 * - decoding: set/allocated/freed by user.
778 * this is the fundamental unit of time (in seconds) in terms
779 * of which frame timestamps are represented. for fixed-fps content,
780 * timebase should be 1/framerate and timestamp increments should be
782 * - encoding: MUST be set by user
783 * - decoding: set by lavc.
785 AVRational time_base;
789 * picture width / height.
790 * - encoding: MUST be set by user.
791 * - decoding: set by lavc.
792 * Note, for compatibility its possible to set this instead of
793 * coded_width/height before decoding
797 #define FF_ASPECT_EXTENDED 15
800 * the number of pictures in a group of pitures, or 0 for intra_only.
801 * - encoding: set by user.
807 * pixel format, see PIX_FMT_xxx.
808 * - encoding: set by user.
809 * - decoding: set by lavc.
811 enum PixelFormat pix_fmt;
814 * Frame rate emulation. If not zero lower layer (i.e. format handler)
815 * has to read frames at native frame rate.
816 * - encoding: set by user.
817 * - decoding: unused.
822 * if non NULL, 'draw_horiz_band' is called by the libavcodec
823 * decoder to draw an horizontal band. It improve cache usage. Not
824 * all codecs can do that. You must check the codec capabilities
827 * - decoding: set by user.
828 * @param height the height of the slice
829 * @param y the y position of the slice
830 * @param type 1->top field, 2->bottom field, 3->frame
831 * @param offset offset into the AVFrame.data from which the slice should be read
833 void (*draw_horiz_band)(struct AVCodecContext *s,
834 const AVFrame *src, int offset[4],
835 int y, int type, int height);
838 int sample_rate; ///< samples per sec
842 * audio sample format.
843 * - encoding: set by user.
844 * - decoding: set by lavc.
846 enum SampleFormat sample_fmt; ///< sample format, currenly unused
848 /* the following data should not be initialized */
850 * samples per packet. initialized when calling 'init'
853 int frame_number; ///< audio or video frame number
854 int real_pict_num; ///< returns the real picture number of previous encoded frame
857 * number of frames the decoded output will be delayed relative to
859 * - encoding: set by lavc.
864 /* - encoding parameters */
865 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
866 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
870 * - encoding: set by user.
877 * - encoding: set by user.
883 * maximum quantizer difference between frames.
884 * - encoding: set by user.
890 * maximum number of b frames between non b frames.
891 * note: the output will be delayed by max_b_frames+1 relative to the input
892 * - encoding: set by user.
898 * qscale factor between ip and b frames.
899 * - encoding: set by user.
902 float b_quant_factor;
904 /** obsolete FIXME remove */
906 #define FF_RC_STRATEGY_XVID 1
908 int b_frame_strategy;
913 * - decoding: set by user. 1-> skip b frames, 2-> skip idct/dequant too, 5-> skip everything except header
914 * @deprecated Deprecated in favor of skip_idct and skip_frame.
918 struct AVCodec *codec;
922 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
923 /* unused, FIXME remove*/
927 int rtp_payload_size; /* The size of the RTP payload: the coder will */
928 /* do it's best to deliver a chunk with size */
929 /* below rtp_payload_size, the chunk will start */
930 /* with a start code on some codecs like H.263 */
931 /* This doesn't take account of any particular */
932 /* headers inside the transmited RTP payload */
935 /* The RTP callback: This function is called */
936 /* every time the encoder has a packet to send */
937 /* Depends on the encoder if the data starts */
938 /* with a Start Code (it should) H.263 does. */
939 /* mb_nb contains the number of macroblocks */
940 /* encoded in the RTP payload */
941 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
943 /* statistics, used for 2-pass encoding */
954 * number of bits used for the previously encoded frame.
955 * - encoding: set by lavc
961 * private data of the user, can be used to carry app specific stuff.
962 * - encoding: set by user
963 * - decoding: set by user
968 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
969 enum CodecID codec_id; /* see CODEC_ID_xxx */
972 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
973 * this is used to workaround some encoder bugs
974 * a demuxer should set this to what is stored in the field used to identify the codec
975 * if there are mutiple such fields in a container then the demuxer should choose the one
976 * which maximizes the information about the used codec
977 * if the codec tag field in a container is larger then 32bit then the demxuer should
978 * remap the longer id to 32bit with a table or other structure alternatively a new
979 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
981 * - encoding: set by user, if not then the default based on codec_id will be used
982 * - decoding: set by user, will be converted to upper case by lavc during init
984 unsigned int codec_tag;
987 * workaround bugs in encoders which sometimes cannot be detected automatically.
988 * - encoding: set by user
989 * - decoding: set by user
992 #define FF_BUG_AUTODETECT 1 ///< autodetection
993 #define FF_BUG_OLD_MSMPEG4 2
994 #define FF_BUG_XVID_ILACE 4
995 #define FF_BUG_UMP4 8
996 #define FF_BUG_NO_PADDING 16
997 #define FF_BUG_AMV 32
998 #define FF_BUG_AC_VLC 0 ///< will be removed, libavcodec can now handle these non compliant files by default
999 #define FF_BUG_QPEL_CHROMA 64
1000 #define FF_BUG_STD_QPEL 128
1001 #define FF_BUG_QPEL_CHROMA2 256
1002 #define FF_BUG_DIRECT_BLOCKSIZE 512
1003 #define FF_BUG_EDGE 1024
1004 #define FF_BUG_HPEL_CHROMA 2048
1005 #define FF_BUG_DC_CLIP 4096
1006 #define FF_BUG_MS 8192 ///< workaround various bugs in microsofts broken decoders
1007 //#define FF_BUG_FAKE_SCALABILITY 16 //autodetection should work 100%
1010 * luma single coeff elimination threshold.
1011 * - encoding: set by user
1012 * - decoding: unused
1014 int luma_elim_threshold;
1017 * chroma single coeff elimination threshold.
1018 * - encoding: set by user
1019 * - decoding: unused
1021 int chroma_elim_threshold;
1024 * strictly follow the std (MPEG4, ...).
1025 * - encoding: set by user
1026 * - decoding: unused
1028 int strict_std_compliance;
1029 #define FF_COMPLIANCE_VERY_STRICT 2 ///< strictly conform to a older more strict version of the spec or reference software
1030 #define FF_COMPLIANCE_STRICT 1 ///< strictly conform to all the things in the spec no matter what consequences
1031 #define FF_COMPLIANCE_NORMAL 0
1032 #define FF_COMPLIANCE_INOFFICIAL -1 ///< allow inofficial extensions
1033 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< allow non standarized experimental things
1036 * qscale offset between ip and b frames.
1037 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
1038 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
1039 * - encoding: set by user.
1040 * - decoding: unused
1042 float b_quant_offset;
1045 * error resilience higher values will detect more errors but may missdetect
1046 * some more or less valid parts as errors.
1047 * - encoding: unused
1048 * - decoding: set by user
1050 int error_resilience;
1051 #define FF_ER_CAREFUL 1
1052 #define FF_ER_COMPLIANT 2
1053 #define FF_ER_AGGRESSIVE 3
1054 #define FF_ER_VERY_AGGRESSIVE 4
1057 * called at the beginning of each frame to get a buffer for it.
1058 * if pic.reference is set then the frame will be read later by lavc
1059 * avcodec_align_dimensions() should be used to find the required width and
1060 * height, as they normally need to be rounded up to the next multiple of 16
1061 * - encoding: unused
1062 * - decoding: set by lavc, user can override
1064 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1067 * called to release buffers which where allocated with get_buffer.
1068 * a released buffer can be reused in get_buffer()
1069 * pic.data[*] must be set to NULL
1070 * - encoding: unused
1071 * - decoding: set by lavc, user can override
1073 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1076 * if 1 the stream has a 1 frame delay during decoding.
1077 * - encoding: set by lavc
1078 * - decoding: set by lavc
1083 * number of bytes per packet if constant and known or 0
1084 * used by some WAV based audio codecs
1088 int parse_only; /* - decoding only: if true, only parsing is done
1089 (function avcodec_parse_frame()). The frame
1090 data is returned. Only MPEG codecs support this now. */
1093 * 0-> h263 quant 1-> mpeg quant.
1094 * - encoding: set by user.
1095 * - decoding: unused
1100 * pass1 encoding statistics output buffer.
1101 * - encoding: set by lavc
1102 * - decoding: unused
1107 * pass2 encoding statistics input buffer.
1108 * concatenated stuff from stats_out of pass1 should be placed here
1109 * - encoding: allocated/set/freed by user
1110 * - decoding: unused
1115 * ratecontrol qmin qmax limiting method.
1116 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax
1117 * - encoding: set by user.
1118 * - decoding: unused
1126 * ratecontrol override, see RcOverride.
1127 * - encoding: allocated/set/freed by user.
1128 * - decoding: unused
1130 RcOverride *rc_override;
1131 int rc_override_count;
1134 * rate control equation.
1135 * - encoding: set by user
1136 * - decoding: unused
1142 * - encoding: set by user.
1143 * - decoding: unused
1149 * - encoding: set by user.
1150 * - decoding: unused
1155 * decoder bitstream buffer size.
1156 * - encoding: set by user.
1157 * - decoding: unused
1160 float rc_buffer_aggressivity;
1163 * qscale factor between p and i frames.
1164 * if > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset)
1165 * if < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset)
1166 * - encoding: set by user.
1167 * - decoding: unused
1169 float i_quant_factor;
1172 * qscale offset between p and i frames.
1173 * - encoding: set by user.
1174 * - decoding: unused
1176 float i_quant_offset;
1179 * initial complexity for pass1 ratecontrol.
1180 * - encoding: set by user.
1181 * - decoding: unused
1183 float rc_initial_cplx;
1186 * dct algorithm, see FF_DCT_* below.
1187 * - encoding: set by user
1188 * - decoding: unused
1191 #define FF_DCT_AUTO 0
1192 #define FF_DCT_FASTINT 1
1193 #define FF_DCT_INT 2
1194 #define FF_DCT_MMX 3
1195 #define FF_DCT_MLIB 4
1196 #define FF_DCT_ALTIVEC 5
1197 #define FF_DCT_FAAN 6
1200 * luminance masking (0-> disabled).
1201 * - encoding: set by user
1202 * - decoding: unused
1207 * temporary complexity masking (0-> disabled).
1208 * - encoding: set by user
1209 * - decoding: unused
1211 float temporal_cplx_masking;
1214 * spatial complexity masking (0-> disabled).
1215 * - encoding: set by user
1216 * - decoding: unused
1218 float spatial_cplx_masking;
1221 * p block masking (0-> disabled).
1222 * - encoding: set by user
1223 * - decoding: unused
1228 * darkness masking (0-> disabled).
1229 * - encoding: set by user
1230 * - decoding: unused
1235 /* for binary compatibility */
1239 * idct algorithm, see FF_IDCT_* below.
1240 * - encoding: set by user
1241 * - decoding: set by user
1244 #define FF_IDCT_AUTO 0
1245 #define FF_IDCT_INT 1
1246 #define FF_IDCT_SIMPLE 2
1247 #define FF_IDCT_SIMPLEMMX 3
1248 #define FF_IDCT_LIBMPEG2MMX 4
1249 #define FF_IDCT_PS2 5
1250 #define FF_IDCT_MLIB 6
1251 #define FF_IDCT_ARM 7
1252 #define FF_IDCT_ALTIVEC 8
1253 #define FF_IDCT_SH4 9
1254 #define FF_IDCT_SIMPLEARM 10
1255 #define FF_IDCT_H264 11
1256 #define FF_IDCT_VP3 12
1257 #define FF_IDCT_IPP 13
1258 #define FF_IDCT_XVIDMMX 14
1259 #define FF_IDCT_CAVS 15
1260 #define FF_IDCT_SIMPLEARMV5TE 16
1261 #define FF_IDCT_SIMPLEARMV6 17
1265 * - encoding: set by lavc
1266 * - decoding: set by user (or 0)
1270 * slice offsets in the frame in bytes.
1271 * - encoding: set/allocated by lavc
1272 * - decoding: set/allocated by user (or NULL)
1277 * error concealment flags.
1278 * - encoding: unused
1279 * - decoding: set by user
1281 int error_concealment;
1282 #define FF_EC_GUESS_MVS 1
1283 #define FF_EC_DEBLOCK 2
1286 * dsp_mask could be add used to disable unwanted CPU features
1287 * CPU features (i.e. MMX, SSE. ...)
1289 * with FORCE flag you may instead enable given CPU features
1290 * (Dangerous: usable in case of misdetection, improper usage however will
1291 * result into program crash)
1294 #define FF_MM_FORCE 0x80000000 /* force usage of selected flags (OR) */
1295 /* lower 16 bits - CPU features */
1297 #define FF_MM_MMX 0x0001 /* standard MMX */
1298 #define FF_MM_3DNOW 0x0004 /* AMD 3DNOW */
1299 #define FF_MM_MMXEXT 0x0002 /* SSE integer functions or AMD MMX ext */
1300 #define FF_MM_SSE 0x0008 /* SSE functions */
1301 #define FF_MM_SSE2 0x0010 /* PIV SSE2 functions */
1302 #define FF_MM_3DNOWEXT 0x0020 /* AMD 3DNowExt */
1303 #endif /* HAVE_MMX */
1305 #define FF_MM_IWMMXT 0x0100 /* XScale IWMMXT */
1306 #endif /* HAVE_IWMMXT */
1309 * bits per sample/pixel from the demuxer (needed for huffyuv).
1310 * - encoding: set by lavc
1311 * - decoding: set by user
1313 int bits_per_sample;
1316 * prediction method (needed for huffyuv).
1317 * - encoding: set by user
1318 * - decoding: unused
1320 int prediction_method;
1321 #define FF_PRED_LEFT 0
1322 #define FF_PRED_PLANE 1
1323 #define FF_PRED_MEDIAN 2
1326 * sample aspect ratio (0 if unknown).
1327 * numerator and denominator must be relative prime and smaller then 256 for some video standards
1328 * - encoding: set by user.
1329 * - decoding: set by lavc.
1331 AVRational sample_aspect_ratio;
1334 * the picture in the bitstream.
1335 * - encoding: set by lavc
1336 * - decoding: set by lavc
1338 AVFrame *coded_frame;
1342 * - encoding: set by user.
1343 * - decoding: set by user.
1346 #define FF_DEBUG_PICT_INFO 1
1347 #define FF_DEBUG_RC 2
1348 #define FF_DEBUG_BITSTREAM 4
1349 #define FF_DEBUG_MB_TYPE 8
1350 #define FF_DEBUG_QP 16
1351 #define FF_DEBUG_MV 32
1352 #define FF_DEBUG_DCT_COEFF 0x00000040
1353 #define FF_DEBUG_SKIP 0x00000080
1354 #define FF_DEBUG_STARTCODE 0x00000100
1355 #define FF_DEBUG_PTS 0x00000200
1356 #define FF_DEBUG_ER 0x00000400
1357 #define FF_DEBUG_MMCO 0x00000800
1358 #define FF_DEBUG_BUGS 0x00001000
1359 #define FF_DEBUG_VIS_QP 0x00002000
1360 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1364 * - encoding: set by user.
1365 * - decoding: set by user.
1368 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1369 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1370 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1374 * - encoding: set by lavc if flags&CODEC_FLAG_PSNR
1375 * - decoding: unused
1380 * minimum MB quantizer.
1381 * - encoding: unused
1382 * - decoding: unused
1387 * maximum MB quantizer.
1388 * - encoding: unused
1389 * - decoding: unused
1394 * motion estimation compare function.
1395 * - encoding: set by user.
1396 * - decoding: unused
1400 * subpixel motion estimation compare function.
1401 * - encoding: set by user.
1402 * - decoding: unused
1406 * macroblock compare function (not supported yet).
1407 * - encoding: set by user.
1408 * - decoding: unused
1412 * interlaced dct compare function
1413 * - encoding: set by user.
1414 * - decoding: unused
1417 #define FF_CMP_SAD 0
1418 #define FF_CMP_SSE 1
1419 #define FF_CMP_SATD 2
1420 #define FF_CMP_DCT 3
1421 #define FF_CMP_PSNR 4
1422 #define FF_CMP_BIT 5
1424 #define FF_CMP_ZERO 7
1425 #define FF_CMP_VSAD 8
1426 #define FF_CMP_VSSE 9
1427 #define FF_CMP_NSSE 10
1428 #define FF_CMP_W53 11
1429 #define FF_CMP_W97 12
1430 #define FF_CMP_DCTMAX 13
1431 #define FF_CMP_DCT264 14
1432 #define FF_CMP_CHROMA 256
1435 * ME diamond size & shape.
1436 * - encoding: set by user.
1437 * - decoding: unused
1442 * amount of previous MV predictors (2a+1 x 2a+1 square).
1443 * - encoding: set by user.
1444 * - decoding: unused
1446 int last_predictor_count;
1449 * pre pass for motion estimation.
1450 * - encoding: set by user.
1451 * - decoding: unused
1456 * motion estimation pre pass compare function.
1457 * - encoding: set by user.
1458 * - decoding: unused
1463 * ME pre pass diamond size & shape.
1464 * - encoding: set by user.
1465 * - decoding: unused
1470 * subpel ME quality.
1471 * - encoding: set by user.
1472 * - decoding: unused
1474 int me_subpel_quality;
1477 * callback to negotiate the pixelFormat.
1478 * @param fmt is the list of formats which are supported by the codec,
1479 * its terminated by -1 as 0 is a valid format, the formats are ordered by quality
1480 * the first is allways the native one
1481 * @return the choosen format
1482 * - encoding: unused
1483 * - decoding: set by user, if not set then the native format will always be choosen
1485 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1488 * DTG active format information (additionnal aspect ratio
1489 * information only used in DVB MPEG2 transport streams). 0 if
1492 * - encoding: unused.
1493 * - decoding: set by decoder
1495 int dtg_active_format;
1496 #define FF_DTG_AFD_SAME 8
1497 #define FF_DTG_AFD_4_3 9
1498 #define FF_DTG_AFD_16_9 10
1499 #define FF_DTG_AFD_14_9 11
1500 #define FF_DTG_AFD_4_3_SP_14_9 13
1501 #define FF_DTG_AFD_16_9_SP_14_9 14
1502 #define FF_DTG_AFD_SP_4_3 15
1505 * Maximum motion estimation search range in subpel units.
1506 * if 0 then no limit
1508 * - encoding: set by user.
1509 * - decoding: unused.
1514 * intra quantizer bias.
1515 * - encoding: set by user.
1516 * - decoding: unused
1518 int intra_quant_bias;
1519 #define FF_DEFAULT_QUANT_BIAS 999999
1522 * inter quantizer bias.
1523 * - encoding: set by user.
1524 * - decoding: unused
1526 int inter_quant_bias;
1530 * - encoding: unused.
1531 * - decoding: which clrtable should be used for 8bit RGB images
1532 * table have to be stored somewhere FIXME
1537 * internal_buffer count.
1538 * Don't touch, used by lavc default_get_buffer()
1540 int internal_buffer_count;
1544 * Don't touch, used by lavc default_get_buffer()
1546 void *internal_buffer;
1548 #define FF_LAMBDA_SHIFT 7
1549 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1550 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1551 #define FF_LAMBDA_MAX (256*128-1)
1553 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1555 * global quality for codecs which cannot change it per frame.
1556 * this should be proportional to MPEG1/2/4 qscale.
1557 * - encoding: set by user.
1558 * - decoding: unused
1562 #define FF_CODER_TYPE_VLC 0
1563 #define FF_CODER_TYPE_AC 1
1566 * - encoding: set by user.
1567 * - decoding: unused
1573 * - encoding: set by user.
1574 * - decoding: unused
1580 * - encoding: unused
1581 * - decoding: set by user.
1583 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1588 * - encoding: unused
1589 * - decoding: set by user.
1592 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1593 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1594 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1597 * XVideo Motion Acceleration
1598 * - encoding: forbidden
1599 * - decoding: set by decoder
1601 int xvmc_acceleration;
1604 * macroblock decision mode
1605 * - encoding: set by user.
1606 * - decoding: unused
1609 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1610 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1611 #define FF_MB_DECISION_RD 2 ///< rate distoration
1614 * custom intra quantization matrix
1615 * - encoding: set by user, can be NULL
1616 * - decoding: set by lavc
1618 uint16_t *intra_matrix;
1621 * custom inter quantization matrix
1622 * - encoding: set by user, can be NULL
1623 * - decoding: set by lavc
1625 uint16_t *inter_matrix;
1628 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1629 * this is used to workaround some encoder bugs
1630 * - encoding: unused
1631 * - decoding: set by user, will be converted to upper case by lavc during init
1633 unsigned int stream_codec_tag;
1636 * scene change detection threshold.
1637 * 0 is default, larger means fewer detected scene changes
1638 * - encoding: set by user.
1639 * - decoding: unused
1641 int scenechange_threshold;
1644 * minimum lagrange multipler
1645 * - encoding: set by user.
1646 * - decoding: unused
1651 * maximum lagrange multipler
1652 * - encoding: set by user.
1653 * - decoding: unused
1658 * Palette control structure
1659 * - encoding: ??? (no palette-enabled encoder yet)
1660 * - decoding: set by user.
1662 struct AVPaletteControl *palctrl;
1665 * noise reduction strength
1666 * - encoding: set by user.
1667 * - decoding: unused
1669 int noise_reduction;
1672 * called at the beginning of a frame to get cr buffer for it.
1673 * buffer type (size, hints) must be the same. lavc won't check it.
1674 * lavc will pass previous buffer in pic, function should return
1675 * same buffer or new buffer with old frame "painted" into it.
1676 * if pic.data[0] == NULL must behave like get_buffer().
1677 * - encoding: unused
1678 * - decoding: set by lavc, user can override
1680 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1683 * number of bits which should be loaded into the rc buffer before decoding starts
1684 * - encoding: set by user.
1685 * - decoding: unused
1687 int rc_initial_buffer_occupancy;
1691 * - encoding: set by user.
1692 * - decoding: unused
1694 int inter_threshold;
1698 * - encoding: set by user.
1699 * - decoding: set by user.
1704 * simulates errors in the bitstream to test error concealment.
1705 * - encoding: set by user.
1706 * - decoding: unused.
1711 * MP3 antialias algorithm, see FF_AA_* below.
1712 * - encoding: unused
1713 * - decoding: set by user
1716 #define FF_AA_AUTO 0
1717 #define FF_AA_FASTINT 1 //not implemented yet
1719 #define FF_AA_FLOAT 3
1721 * Quantizer noise shaping.
1722 * - encoding: set by user
1723 * - decoding: unused
1725 int quantizer_noise_shaping;
1729 * is used to decide how many independent tasks should be passed to execute()
1730 * - encoding: set by user
1731 * - decoding: set by user
1736 * the codec may call this to execute several independent things. it will return only after
1737 * finishing all tasks, the user may replace this with some multithreaded implementation, the
1738 * default implementation will execute the parts serially
1739 * @param count the number of things to execute
1740 * - encoding: set by lavc, user can override
1741 * - decoding: set by lavc, user can override
1743 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1747 * can be used by execute() to store some per AVCodecContext stuff.
1748 * - encoding: set by execute()
1749 * - decoding: set by execute()
1751 void *thread_opaque;
1754 * Motion estimation threshold. under which no motion estimation is
1755 * performed, but instead the user specified motion vectors are used
1757 * - encoding: set by user
1758 * - decoding: unused
1763 * Macroblock threshold. under which the user specified macroblock types will be used
1764 * - encoding: set by user
1765 * - decoding: unused
1770 * precision of the intra dc coefficient - 8.
1771 * - encoding: set by user
1772 * - decoding: unused
1774 int intra_dc_precision;
1777 * noise vs. sse weight for the nsse comparsion function.
1778 * - encoding: set by user
1779 * - decoding: unused
1784 * number of macroblock rows at the top which are skipped.
1785 * - encoding: unused
1786 * - decoding: set by user
1791 * number of macroblock rows at the bottom which are skipped.
1792 * - encoding: unused
1793 * - decoding: set by user
1799 * - encoding: set by user
1800 * - decoding: set by lavc
1803 #define FF_PROFILE_UNKNOWN -99
1807 * - encoding: set by user
1808 * - decoding: set by lavc
1811 #define FF_LEVEL_UNKNOWN -99
1814 * low resolution decoding. 1-> 1/2 size, 2->1/4 size
1815 * - encoding: unused
1816 * - decoding: set by user
1821 * bitsream width / height. may be different from width/height if lowres
1822 * or other things are used
1823 * - encoding: unused
1824 * - decoding: set by user before init if known, codec should override / dynamically change if needed
1826 int coded_width, coded_height;
1829 * frame skip threshold
1830 * - encoding: set by user
1831 * - decoding: unused
1833 int frame_skip_threshold;
1837 * - encoding: set by user
1838 * - decoding: unused
1840 int frame_skip_factor;
1843 * frame skip exponent
1844 * - encoding: set by user
1845 * - decoding: unused
1850 * frame skip comparission function
1851 * - encoding: set by user.
1852 * - decoding: unused
1857 * border processing masking. raises the quantizer for mbs on the borders
1859 * - encoding: set by user
1860 * - decoding: unused
1862 float border_masking;
1865 * minimum MB lagrange multipler.
1866 * - encoding: set by user.
1867 * - decoding: unused
1872 * maximum MB lagrange multipler.
1873 * - encoding: set by user.
1874 * - decoding: unused
1880 * - encoding: set by user.
1881 * - decoding: unused
1883 int me_penalty_compensation;
1887 * - encoding: unused
1888 * - decoding: set by user.
1890 enum AVDiscard skip_loop_filter;
1894 * - encoding: unused
1895 * - decoding: set by user.
1897 enum AVDiscard skip_idct;
1901 * - encoding: unused
1902 * - decoding: set by user.
1904 enum AVDiscard skip_frame;
1908 * - encoding: set by user.
1909 * - decoding: unused
1915 * - encoding: set by user.
1916 * - decoding: unused
1921 * constant rate factor - quality-based VBR - values ~correspond to qps
1922 * - encoding: set by user.
1923 * - decoding: unused
1928 * constant quantization parameter rate control method
1929 * - encoding: set by user.
1930 * - decoding: unused
1936 * - encoding: set by user.
1937 * - decoding: unused
1942 * number of reference frames
1943 * - encoding: set by user.
1944 * - decoding: unused
1949 * chroma qp offset from luma
1950 * - encoding: set by user.
1951 * - decoding: unused
1956 * influences how often b-frames are used
1957 * - encoding: set by user.
1958 * - decoding: unused
1963 * trellis RD quantization
1964 * - encoding: set by user.
1965 * - decoding: unused
1970 * reduce fluctuations in qp (before curve compression)
1971 * - encoding: set by user.
1972 * - decoding: unused
1974 float complexityblur;
1977 * in-loop deblocking filter alphac0 parameter
1978 * alpha is in the range -6...6
1979 * - encoding: set by user.
1980 * - decoding: unused
1985 * in-loop deblocking filter beta parameter
1986 * beta is in the range -6...6
1987 * - encoding: set by user.
1988 * - decoding: unused
1993 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
1994 * - encoding: set by user.
1995 * - decoding: unused
1998 #define X264_PART_I4X4 0x001 /* Analyse i4x4 */
1999 #define X264_PART_I8X8 0x002 /* Analyse i8x8 (requires 8x8 transform) */
2000 #define X264_PART_P8X8 0x010 /* Analyse p16x8, p8x16 and p8x8 */
2001 #define X264_PART_P4X4 0x020 /* Analyse p8x4, p4x8, p4x4 */
2002 #define X264_PART_B8X8 0x100 /* Analyse b16x8, b8x16 and b8x8 */
2005 * direct mv prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2006 * - encoding: set by user.
2007 * - decoding: unused
2012 * audio cutoff bandwidth (0 means "automatic") . Currently used only by FAAC
2013 * - encoding: set by user.
2014 * - decoding: unused
2019 * multiplied by qscale for each frame and added to scene_change_score
2020 * - encoding: set by user.
2021 * - decoding: unused
2023 int scenechange_factor;
2027 * note: value depends upon the compare functin used for fullpel ME
2028 * - encoding: set by user.
2029 * - decoding: unused
2034 * adjusts sensitivity of b_frame_strategy 1
2035 * - encoding: set by user.
2036 * - decoding: unused
2041 * - encoding: set by user.
2042 * - decoding: unused
2044 int compression_level;
2045 #define FF_COMPRESSION_DEFAULT -1
2048 * sets whether to use LPC mode - used by FLAC encoder
2049 * - encoding: set by user.
2050 * - decoding: unused.
2055 * LPC coefficient precision - used by FLAC encoder
2056 * - encoding: set by user.
2057 * - decoding: unused.
2059 int lpc_coeff_precision;
2062 * - encoding: set by user.
2063 * - decoding: unused.
2065 int min_prediction_order;
2068 * - encoding: set by user.
2069 * - decoding: unused.
2071 int max_prediction_order;
2074 * search method for selecting prediction order
2075 * - encoding: set by user.
2076 * - decoding: unused.
2078 int prediction_order_method;
2081 * - encoding: set by user.
2082 * - decoding: unused.
2084 int min_partition_order;
2087 * - encoding: set by user.
2088 * - decoding: unused.
2090 int max_partition_order;
2093 * GOP timecode frame start number, in non drop frame format
2094 * - encoding: set by user.
2095 * - decoding: unused.
2097 int64_t timecode_frame_start;
2103 typedef struct AVCodec {
2105 enum CodecType type;
2108 int (*init)(AVCodecContext *);
2109 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2110 int (*close)(AVCodecContext *);
2111 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2112 uint8_t *buf, int buf_size);
2114 struct AVCodec *next;
2115 void (*flush)(AVCodecContext *);
2116 const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
2117 const enum PixelFormat *pix_fmts; ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
2121 * four components are given, that's all.
2122 * the last component is alpha
2124 typedef struct AVPicture {
2126 int linesize[4]; ///< number of bytes per line
2131 * This structure defines a method for communicating palette changes
2132 * between and demuxer and a decoder.
2133 * this is totally broken, palette changes should be sent as AVPackets
2135 #define AVPALETTE_SIZE 1024
2136 #define AVPALETTE_COUNT 256
2137 typedef struct AVPaletteControl {
2139 /* demuxer sets this to 1 to indicate the palette has changed;
2140 * decoder resets to 0 */
2141 int palette_changed;
2143 /* 4-byte ARGB palette entries, stored in native byte order; note that
2144 * the individual palette components should be on a 8-bit scale; if
2145 * the palette data comes from a IBM VGA native format, the component
2146 * data is probably 6 bits in size and needs to be scaled */
2147 unsigned int palette[AVPALETTE_COUNT];
2149 } AVPaletteControl attribute_deprecated;
2151 typedef struct AVSubtitleRect {
2158 uint32_t *rgba_palette;
2162 typedef struct AVSubtitle {
2163 uint16_t format; /* 0 = graphics */
2164 uint32_t start_display_time; /* relative to packet pts, in ms */
2165 uint32_t end_display_time; /* relative to packet pts, in ms */
2167 AVSubtitleRect *rects;
2170 extern AVCodec ac3_encoder;
2171 extern AVCodec amr_nb_encoder;
2172 extern AVCodec amr_wb_encoder;
2173 extern AVCodec asv1_encoder;
2174 extern AVCodec asv2_encoder;
2175 extern AVCodec bmp_encoder;
2176 extern AVCodec dvvideo_encoder;
2177 extern AVCodec faac_encoder;
2178 extern AVCodec ffv1_encoder;
2179 extern AVCodec ffvhuff_encoder;
2180 extern AVCodec flac_encoder;
2181 extern AVCodec flashsv_encoder;
2182 extern AVCodec flv_encoder;
2183 extern AVCodec gif_encoder;
2184 extern AVCodec h261_encoder;
2185 extern AVCodec h263_encoder;
2186 extern AVCodec h263p_encoder;
2187 extern AVCodec h264_encoder;
2188 extern AVCodec huffyuv_encoder;
2189 extern AVCodec jpegls_encoder;
2190 extern AVCodec libgsm_encoder;
2191 extern AVCodec libgsm_ms_encoder;
2192 extern AVCodec libtheora_encoder;
2193 extern AVCodec ljpeg_encoder;
2194 extern AVCodec mdec_encoder;
2195 extern AVCodec mjpeg_encoder;
2196 extern AVCodec mp2_encoder;
2197 extern AVCodec mp3lame_encoder;
2198 extern AVCodec mpeg1video_encoder;
2199 extern AVCodec mpeg2video_encoder;
2200 extern AVCodec mpeg4_encoder;
2201 extern AVCodec msmpeg4v1_encoder;
2202 extern AVCodec msmpeg4v2_encoder;
2203 extern AVCodec msmpeg4v3_encoder;
2204 extern AVCodec oggvorbis_encoder;
2205 extern AVCodec pam_encoder;
2206 extern AVCodec pbm_encoder;
2207 extern AVCodec pgm_encoder;
2208 extern AVCodec pgmyuv_encoder;
2209 extern AVCodec png_encoder;
2210 extern AVCodec ppm_encoder;
2211 extern AVCodec rv10_encoder;
2212 extern AVCodec rv20_encoder;
2213 extern AVCodec snow_encoder;
2214 extern AVCodec sonic_encoder;
2215 extern AVCodec sonic_ls_encoder;
2216 extern AVCodec svq1_encoder;
2217 extern AVCodec targa_encoder;
2218 extern AVCodec vcr1_encoder;
2219 extern AVCodec vorbis_encoder;
2220 extern AVCodec wmav1_encoder;
2221 extern AVCodec wmav2_encoder;
2222 extern AVCodec wmv1_encoder;
2223 extern AVCodec wmv2_encoder;
2224 extern AVCodec x264_encoder;
2225 extern AVCodec xvid_encoder;
2226 extern AVCodec zlib_encoder;
2227 extern AVCodec zmbv_encoder;
2229 extern AVCodec aac_decoder;
2230 extern AVCodec aasc_decoder;
2231 extern AVCodec alac_decoder;
2232 extern AVCodec amr_nb_decoder;
2233 extern AVCodec amr_wb_decoder;
2234 extern AVCodec asv1_decoder;
2235 extern AVCodec asv2_decoder;
2236 extern AVCodec avs_decoder;
2237 extern AVCodec bmp_decoder;
2238 extern AVCodec cavs_decoder;
2239 extern AVCodec cinepak_decoder;
2240 extern AVCodec cljr_decoder;
2241 extern AVCodec cook_decoder;
2242 extern AVCodec cscd_decoder;
2243 extern AVCodec cyuv_decoder;
2244 extern AVCodec dca_decoder;
2245 extern AVCodec dnxhd_decoder;
2246 extern AVCodec dsicinaudio_decoder;
2247 extern AVCodec dsicinvideo_decoder;
2248 extern AVCodec dvvideo_decoder;
2249 extern AVCodec dxa_decoder;
2250 extern AVCodec eightbps_decoder;
2251 extern AVCodec ffv1_decoder;
2252 extern AVCodec ffvhuff_decoder;
2253 extern AVCodec flac_decoder;
2254 extern AVCodec flashsv_decoder;
2255 extern AVCodec flic_decoder;
2256 extern AVCodec flv_decoder;
2257 extern AVCodec fourxm_decoder;
2258 extern AVCodec fraps_decoder;
2259 extern AVCodec gif_decoder;
2260 extern AVCodec h261_decoder;
2261 extern AVCodec h263_decoder;
2262 extern AVCodec h263i_decoder;
2263 extern AVCodec h264_decoder;
2264 extern AVCodec huffyuv_decoder;
2265 extern AVCodec idcin_decoder;
2266 extern AVCodec imc_decoder;
2267 extern AVCodec indeo2_decoder;
2268 extern AVCodec indeo3_decoder;
2269 extern AVCodec interplay_dpcm_decoder;
2270 extern AVCodec interplay_video_decoder;
2271 extern AVCodec kmvc_decoder;
2272 extern AVCodec libgsm_decoder;
2273 extern AVCodec libgsm_ms_decoder;
2274 extern AVCodec loco_decoder;
2275 extern AVCodec mace3_decoder;
2276 extern AVCodec mace6_decoder;
2277 extern AVCodec mdec_decoder;
2278 extern AVCodec mjpeg_decoder;
2279 extern AVCodec mjpegb_decoder;
2280 extern AVCodec mmvideo_decoder;
2281 extern AVCodec mp2_decoder;
2282 extern AVCodec mp3_decoder;
2283 extern AVCodec mp3adu_decoder;
2284 extern AVCodec mp3on4_decoder;
2285 extern AVCodec mpc7_decoder;
2286 extern AVCodec mpeg1video_decoder;
2287 extern AVCodec mpeg2video_decoder;
2288 extern AVCodec mpeg4_decoder;
2289 extern AVCodec mpeg4aac_decoder;
2290 extern AVCodec mpeg_xvmc_decoder;
2291 extern AVCodec mpegvideo_decoder;
2292 extern AVCodec msmpeg4v1_decoder;
2293 extern AVCodec msmpeg4v2_decoder;
2294 extern AVCodec msmpeg4v3_decoder;
2295 extern AVCodec msrle_decoder;
2296 extern AVCodec msvideo1_decoder;
2297 extern AVCodec mszh_decoder;
2298 extern AVCodec nuv_decoder;
2299 extern AVCodec oggvorbis_decoder;
2300 extern AVCodec png_decoder;
2301 extern AVCodec qdm2_decoder;
2302 extern AVCodec qdraw_decoder;
2303 extern AVCodec qpeg_decoder;
2304 extern AVCodec qtrle_decoder;
2305 extern AVCodec ra_144_decoder;
2306 extern AVCodec ra_288_decoder;
2307 extern AVCodec roq_decoder;
2308 extern AVCodec roq_dpcm_decoder;
2309 extern AVCodec rpza_decoder;
2310 extern AVCodec rv10_decoder;
2311 extern AVCodec rv20_decoder;
2312 extern AVCodec rv30_decoder;
2313 extern AVCodec rv40_decoder;
2314 extern AVCodec shorten_decoder;
2315 extern AVCodec smackaud_decoder;
2316 extern AVCodec smacker_decoder;
2317 extern AVCodec smc_decoder;
2318 extern AVCodec snow_decoder;
2319 extern AVCodec sol_dpcm_decoder;
2320 extern AVCodec sonic_decoder;
2321 extern AVCodec sp5x_decoder;
2322 extern AVCodec svq1_decoder;
2323 extern AVCodec svq3_decoder;
2324 extern AVCodec targa_decoder;
2325 extern AVCodec theora_decoder;
2326 extern AVCodec tiertexseqvideo_decoder;
2327 extern AVCodec tiff_decoder;
2328 extern AVCodec truemotion1_decoder;
2329 extern AVCodec truemotion2_decoder;
2330 extern AVCodec truespeech_decoder;
2331 extern AVCodec tscc_decoder;
2332 extern AVCodec tta_decoder;
2333 extern AVCodec ulti_decoder;
2334 extern AVCodec vc1_decoder;
2335 extern AVCodec vcr1_decoder;
2336 extern AVCodec vmdaudio_decoder;
2337 extern AVCodec vmdvideo_decoder;
2338 extern AVCodec vmnc_decoder;
2339 extern AVCodec vorbis_decoder;
2340 extern AVCodec vp3_decoder;
2341 extern AVCodec vp5_decoder;
2342 extern AVCodec vp6_decoder;
2343 extern AVCodec vp6f_decoder;
2344 extern AVCodec vqa_decoder;
2345 extern AVCodec wavpack_decoder;
2346 extern AVCodec wmav1_decoder;
2347 extern AVCodec wmav2_decoder;
2348 extern AVCodec wmv1_decoder;
2349 extern AVCodec wmv2_decoder;
2350 extern AVCodec wmv3_decoder;
2351 extern AVCodec wnv1_decoder;
2352 extern AVCodec ws_snd1_decoder;
2353 extern AVCodec xan_dpcm_decoder;
2354 extern AVCodec xan_wc3_decoder;
2355 extern AVCodec xl_decoder;
2356 extern AVCodec zlib_decoder;
2357 extern AVCodec zmbv_decoder;
2360 #define PCM_CODEC(id, name) \
2361 extern AVCodec name ## _decoder; \
2362 extern AVCodec name ## _encoder
2364 PCM_CODEC(CODEC_ID_PCM_ALAW, pcm_alaw);
2365 PCM_CODEC(CODEC_ID_PCM_MULAW, pcm_mulaw);
2366 PCM_CODEC(CODEC_ID_PCM_S8, pcm_s8);
2367 PCM_CODEC(CODEC_ID_PCM_S16BE, pcm_s16be);
2368 PCM_CODEC(CODEC_ID_PCM_S16LE, pcm_s16le);
2369 PCM_CODEC(CODEC_ID_PCM_S24BE, pcm_s24be);
2370 PCM_CODEC(CODEC_ID_PCM_S24DAUD, pcm_s24daud);
2371 PCM_CODEC(CODEC_ID_PCM_S24LE, pcm_s24le);
2372 PCM_CODEC(CODEC_ID_PCM_S32BE, pcm_s32be);
2373 PCM_CODEC(CODEC_ID_PCM_S32LE, pcm_s32le);
2374 PCM_CODEC(CODEC_ID_PCM_U8, pcm_u8);
2375 PCM_CODEC(CODEC_ID_PCM_U16BE, pcm_u16be);
2376 PCM_CODEC(CODEC_ID_PCM_U16LE, pcm_u16le);
2377 PCM_CODEC(CODEC_ID_PCM_U24BE, pcm_u24be);
2378 PCM_CODEC(CODEC_ID_PCM_U24LE, pcm_u24le);
2379 PCM_CODEC(CODEC_ID_PCM_U32BE, pcm_u32be);
2380 PCM_CODEC(CODEC_ID_PCM_U32LE, pcm_u32le);
2384 PCM_CODEC(CODEC_ID_ADPCM_4XM, adpcm_4xm);
2385 PCM_CODEC(CODEC_ID_ADPCM_ADX, adpcm_adx);
2386 PCM_CODEC(CODEC_ID_ADPCM_CT, adpcm_ct);
2387 PCM_CODEC(CODEC_ID_ADPCM_EA, adpcm_ea);
2388 PCM_CODEC(CODEC_ID_ADPCM_G726, adpcm_g726);
2389 PCM_CODEC(CODEC_ID_ADPCM_IMA_DK3, adpcm_ima_dk3);
2390 PCM_CODEC(CODEC_ID_ADPCM_IMA_DK4, adpcm_ima_dk4);
2391 PCM_CODEC(CODEC_ID_ADPCM_IMA_QT, adpcm_ima_qt);
2392 PCM_CODEC(CODEC_ID_ADPCM_IMA_WAV, adpcm_ima_wav);
2393 PCM_CODEC(CODEC_ID_ADPCM_IMA_WS, adpcm_ima_ws);
2394 PCM_CODEC(CODEC_ID_ADPCM_MS, adpcm_ms);
2395 PCM_CODEC(CODEC_ID_ADPCM_SBPRO_2, adpcm_sbpro_2);
2396 PCM_CODEC(CODEC_ID_ADPCM_SBPRO_3, adpcm_sbpro_3);
2397 PCM_CODEC(CODEC_ID_ADPCM_SBPRO_4, adpcm_sbpro_4);
2398 PCM_CODEC(CODEC_ID_ADPCM_SMJPEG, adpcm_ima_smjpeg);
2399 PCM_CODEC(CODEC_ID_ADPCM_SWF, adpcm_swf);
2400 PCM_CODEC(CODEC_ID_ADPCM_XA, adpcm_xa);
2401 PCM_CODEC(CODEC_ID_ADPCM_YAMAHA, adpcm_yamaha);
2405 /* dummy raw video codec */
2406 extern AVCodec rawvideo_decoder;
2407 extern AVCodec rawvideo_encoder;
2409 /* the following codecs use external GPL libs */
2410 extern AVCodec dts_decoder;
2411 extern AVCodec liba52_decoder;
2414 extern AVCodec dvbsub_decoder;
2415 extern AVCodec dvbsub_encoder;
2416 extern AVCodec dvdsub_decoder;
2417 extern AVCodec dvdsub_encoder;
2421 struct ReSampleContext;
2422 struct AVResampleContext;
2424 typedef struct ReSampleContext ReSampleContext;
2426 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2427 int output_rate, int input_rate);
2428 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2429 void audio_resample_close(ReSampleContext *s);
2431 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2432 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2433 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2434 void av_resample_close(struct AVResampleContext *c);
2436 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2437 /* YUV420 format is assumed ! */
2439 struct ImgReSampleContext attribute_deprecated;
2441 typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2443 attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2444 int input_width, int input_height);
2446 attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2447 int iwidth, int iheight,
2448 int topBand, int bottomBand,
2449 int leftBand, int rightBand,
2450 int padtop, int padbottom,
2451 int padleft, int padright);
2454 attribute_deprecated void img_resample(ImgReSampleContext *s,
2455 AVPicture *output, const AVPicture *input);
2457 attribute_deprecated void img_resample_close(ImgReSampleContext *s);
2462 * Allocate memory for a picture. Call avpicture_free to free it.
2464 * @param picture the picture to be filled in.
2465 * @param pix_fmt the format of the picture.
2466 * @param width the width of the picture.
2467 * @param height the height of the picture.
2468 * @return Zero if successful, a negative value if not.
2470 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2473 * Free a picture previously allocated by avpicture_alloc().
2475 * @param picture The AVPicture to be freed.
2477 void avpicture_free(AVPicture *picture);
2480 * Fill in AVPicture's fields.
2481 * The fields of the given AVPicture are filled in by using the 'ptr' address
2482 * which points to the image data buffer. Depending on the specified picture
2483 * format, one or multiple image data pointers and line sizes will be set.
2484 * If a planar format is specified, several pointers will be set pointing to
2485 * the different picture planes and the line sizes of the different planes
2486 * will be stored in the lines_sizes array.
2488 * @param picture AVPicture who's fields are to be filled in
2489 * @param ptr Buffer which will contain or contains the actual image data
2490 * @param pix_fmt The format in which the picture data is stored
2491 * @param width The width of the image in pixels
2492 * @param height The height of the image in pixels
2493 * @return Size of the image data in bytes.
2495 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2496 int pix_fmt, int width, int height);
2497 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2498 unsigned char *dest, int dest_size);
2501 * Calculate the size in bytes that a picture of the given width and height
2502 * would occupy if stored in the given picture format.
2504 * @param pix_fmt The given picture format
2505 * @param width The width of the image
2506 * @param height The height of the image
2507 * @return Image data size in bytes
2509 int avpicture_get_size(int pix_fmt, int width, int height);
2510 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2511 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2512 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2513 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2514 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2516 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2517 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2518 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2519 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2520 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2521 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2524 * Computes what kind of losses will occur when converting from one specific
2525 * pixel format to another.
2526 * When converting from one pixel format to another, information loss may occur.
2527 * For example, when converting from RGB24 to GRAY, the color information will
2528 * be lost. Similarly, other losses occur when converting from some formats to
2529 * other formats. These losses can involve loss of chroma, but also loss of
2530 * resolution, loss of color depth, loss due to the color space conversion, loss
2531 * of the alpha bits or loss due to color quantization.
2532 * avcodec_get_fix_fmt_loss() informs you on the various types of losses which
2533 * will occur when converting from one pixel format to another.
2535 * @param[in] dst_pix_fmt Destination pixel format.
2536 * @param[in] src_pix_fmt Source pixel format.
2537 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2538 * @return Combination of flags informing you what kind of losses will occur.
2540 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2544 * Finds the best pixel format to convert to given a certain source pixel
2545 * format. When converting from one pixel format to another, information loss
2546 * may occur. For example, when converting from RGB24 to GRAY, the color
2547 * information will be lost. Similarly, other losses occur when converting from
2548 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2549 * the given pixel formats should be used to undergo the least amount of losses.
2550 * The pixel formats from which it choses one, are determined by the
2551 * \p pix_fmt_mask parameter.
2554 * src_pix_fmt = PIX_FMT_YUV420P;
2555 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2556 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2559 * @param[in] pix_fmt_mask Bitmask determining which pixel format to choose from.
2560 * @param[in] src_pix_fmt Source pixel format.
2561 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2562 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2563 * @return The best pixel format to convert to or -1 if none was found.
2565 int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2566 int has_alpha, int *loss_ptr);
2568 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2569 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
2572 * Tell if an image really has transparent alpha values.
2573 * @return ored mask of FF_ALPHA_xxx constants
2575 int img_get_alpha_info(const AVPicture *src,
2576 int pix_fmt, int width, int height);
2578 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2579 /* convert among pixel formats */
2580 attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2581 const AVPicture *src, int pix_fmt,
2582 int width, int height);
2585 /* deinterlace a picture */
2586 /* deinterlace - if not supported return -1 */
2587 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2588 int pix_fmt, int width, int height);
2590 /* external high level API */
2592 extern AVCodec *first_avcodec;
2594 /* returns LIBAVCODEC_VERSION_INT constant */
2595 unsigned avcodec_version(void);
2596 /* returns LIBAVCODEC_BUILD constant */
2597 unsigned avcodec_build(void);
2600 * Initializes libavcodec.
2602 * @warning This function \e must be called before any other libavcodec
2605 void avcodec_init(void);
2607 void register_avcodec(AVCodec *format);
2610 * Finds an encoder with a matching codec ID.
2612 * @param id CodecID of the requested encoder.
2613 * @return An encoder if one was found, NULL otherwise.
2615 AVCodec *avcodec_find_encoder(enum CodecID id);
2618 * Finds an encoder with the specified name.
2620 * @param name Name of the requested encoder.
2621 * @return An encoder if one was found, NULL otherwise.
2623 AVCodec *avcodec_find_encoder_by_name(const char *name);
2626 * Finds a decoder with a matching codec ID.
2628 * @param id CodecID of the requested decoder.
2629 * @return A decoder if one was found, NULL otherwise.
2631 AVCodec *avcodec_find_decoder(enum CodecID id);
2634 * Finds an decoder with the specified name.
2636 * @param name Name of the requested decoder.
2637 * @return A decoder if one was found, NULL otherwise.
2639 AVCodec *avcodec_find_decoder_by_name(const char *name);
2640 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2643 * Sets the fields of the given AVCodecContext to default values.
2645 * @param s The AVCodecContext of which the fields should be set to default values.
2647 void avcodec_get_context_defaults(AVCodecContext *s);
2649 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2650 * we WILL change its arguments and name a few times! */
2651 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2654 * Allocates an AVCodecContext and sets its fields to default values. The
2655 * resulting struct can be deallocated by simply calling av_free().
2657 * @return An AVCodecContext filled with default values or NULL on failure.
2658 * @see avcodec_get_context_defaults
2660 AVCodecContext *avcodec_alloc_context(void);
2662 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2663 * we WILL change its arguments and name a few times! */
2664 AVCodecContext *avcodec_alloc_context2(enum CodecType);
2667 * Sets the fields of the given AVFrame to default values.
2669 * @param pic The AVFrame of which the fields should be set to default values.
2671 void avcodec_get_frame_defaults(AVFrame *pic);
2674 * Allocates an AVFrame and sets its fields to default values. The resulting
2675 * struct can be deallocated by simply calling av_free().
2677 * @return An AVFrame filled with default values or NULL on failure.
2678 * @see avcodec_get_frame_defaults
2680 AVFrame *avcodec_alloc_frame(void);
2682 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2683 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2684 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2685 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2688 * Checks if the given dimension of a picture is valid, meaning that all
2689 * bytes of the picture can be addressed with a signed int.
2691 * @param[in] w Width of the picture.
2692 * @param[in] h Height of the picture.
2693 * @return Zero if valid, a negative value if invalid.
2695 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2696 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2698 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2699 void avcodec_thread_free(AVCodecContext *s);
2700 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2701 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2702 //FIXME func typedef
2705 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2706 * function the context has to be allocated.
2708 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2709 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2710 * retrieving a codec.
2712 * @warning This function is not thread save!
2715 * codec = avcodec_find_decoder(CODEC_ID_H264);
2719 * context = avcodec_alloc_context();
2721 * if (avcodec_open(context, codec) < 0)
2725 * @param avctx The context which will be setup to use the given codec.
2726 * @param codec The codec to use within the context.
2727 * @return Zero on success, a negative value on error.
2728 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2730 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2733 * @deprecated Use avcodec_decode_audio2() instead.
2735 attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2736 int *frame_size_ptr,
2737 uint8_t *buf, int buf_size);
2740 * Decodes an audio frame from \p buf into \p samples.
2741 * The avcodec_decode_audio2() function decodes a frame of audio from the input
2742 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2743 * audiocodec which was coupled with \p avctx using avcodec_open(). The
2744 * resulting decoded frame is stored in output buffer \p samples. If no frame
2745 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2746 * decompressed frame size in \e bytes.
2748 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2749 * output buffer before calling avcodec_decode_audio2().
2751 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2752 * the actual read bytes because some optimized bitstream readers read 32 or 64
2753 * bits at once and could read over the end.
2755 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2756 * no overreading happens for damaged MPEG streams.
2758 * @note You might have to align the input buffer \p buf and output buffer \p
2759 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2760 * necessary at all, on others it won't work at all if not aligned and on others
2761 * it will work but it will have an impact on performance. In practice, the
2762 * bitstream should have 4 byte alignment at minimum and all sample data should
2763 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2764 * the linesize is not a multiple of 16 then there's no sense in aligning the
2765 * start of the buffer to 16.
2767 * @param avctx The codec context.
2768 * @param[out] samples The output buffer.
2769 * @param[in,out] frame_size_ptr The output buffer size in bytes.
2770 * @param[in] buf The input buffer.
2771 * @param[in] buf_size The input buffer size in bytes.
2772 * @return On error a negative value is returned, otherwise the number of bytes
2773 * used or zero if no frame could be decompressed.
2775 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2776 int *frame_size_ptr,
2777 uint8_t *buf, int buf_size);
2780 * Decodes a video frame from \p buf into \p picture.
2781 * The avcodec_decode_video() function decodes a frame of video from the input
2782 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2783 * videocodec which was coupled with \p avctx using avcodec_open(). The
2784 * resulting decoded frame is stored in \p picture.
2786 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2787 * the actual read bytes because some optimized bitstream readers read 32 or 64
2788 * bits at once and could read over the end.
2790 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2791 * no overreading happens for damaged MPEG streams.
2793 * @note You might have to align the input buffer \p buf and output buffer \p
2794 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2795 * necessary at all, on others it won't work at all if not aligned and on others
2796 * it will work but it will have an impact on performance. In practice, the
2797 * bitstream should have 4 byte alignment at minimum and all sample data should
2798 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2799 * the linesize is not a multiple of 16 then there's no sense in aligning the
2800 * start of the buffer to 16.
2802 * @param avctx The codec context.
2803 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2804 * @param[in] buf The input buffer.
2805 * @param[in] buf_size The size of the input buffer in bytes.
2806 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is non zero.
2807 * @return On error a negative value is returned, otherwise the number of bytes
2808 * used or zero if no frame could be decompressed.
2810 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2811 int *got_picture_ptr,
2812 uint8_t *buf, int buf_size);
2814 /* decode a subtitle message. return -1 if error, otherwise return the
2815 *number of bytes used. If no subtitle could be decompressed,
2816 *got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2817 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2819 const uint8_t *buf, int buf_size);
2820 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2822 uint8_t *buf, int buf_size);
2825 * Encodes an audio frame from \p samples into \p buf.
2826 * The avcodec_encode_audio() function encodes a frame of audio from the input
2827 * buffer \p samples. To encode it, it makes use of the audiocodec which was
2828 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2829 * stored in output buffer \p buf.
2831 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2833 * @param avctx The codec context.
2834 * @param[out] buf The output buffer.
2835 * @param[in] buf_size The output buffer size.
2836 * @param[in] samples The input buffer containing the samples.
2837 * @return On error a negative value is returned, on succes zero or the number
2838 * of bytes used from the input buffer.
2840 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2841 const short *samples);
2844 * Encodes a video frame from \p pict into \p buf.
2845 * The avcodec_encode_video() function encodes a frame of video from the input
2846 * \p pict. To encode it, it makes use of the videocodec which was coupled with
2847 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2848 * frame are stored in the output buffer \p buf. The input picture should be
2849 * stored using a specific format, namely \c avctx.pix_fmt.
2851 * @param avctx The codec context.
2852 * @param[out] buf The output buffer for the bitstream of encoded frame.
2853 * @param[in] buf_size The size of the outputbuffer in bytes.
2854 * @param[in] pict The input picture to encode.
2855 * @return On error a negative value is returned, on success zero or the number
2856 * of bytes used from the input buffer.
2858 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2859 const AVFrame *pict);
2860 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2861 const AVSubtitle *sub);
2863 int avcodec_close(AVCodecContext *avctx);
2865 void avcodec_register_all(void);
2868 * Flush buffers, should be called when seeking or when switching to a different stream.
2870 void avcodec_flush_buffers(AVCodecContext *avctx);
2872 void avcodec_default_free_buffers(AVCodecContext *s);
2874 /* misc useful functions */
2877 * Returns a single letter to describe the given picture type \p pict_type.
2879 * @param[in] pict_type The picture type.
2880 * @return A single character representing the picture type.
2882 char av_get_pict_type_char(int pict_type);
2885 * Returns codec bits per sample.
2887 * @param[in] codec_id The codec.
2888 * @return Number of bits per sample or zero if unknown for the given codec.
2890 int av_get_bits_per_sample(enum CodecID codec_id);
2893 typedef struct AVCodecParserContext {
2895 struct AVCodecParser *parser;
2896 int64_t frame_offset; /* offset of the current frame */
2897 int64_t cur_offset; /* current offset
2898 (incremented by each av_parser_parse()) */
2899 int64_t last_frame_offset; /* offset of the last frame */
2901 int pict_type; /* XXX: put it back in AVCodecContext */
2902 int repeat_pict; /* XXX: put it back in AVCodecContext */
2903 int64_t pts; /* pts of the current frame */
2904 int64_t dts; /* dts of the current frame */
2909 int fetch_timestamp;
2911 #define AV_PARSER_PTS_NB 4
2912 int cur_frame_start_index;
2913 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2914 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2915 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2918 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
2919 } AVCodecParserContext;
2921 typedef struct AVCodecParser {
2922 int codec_ids[5]; /* several codec IDs are permitted */
2924 int (*parser_init)(AVCodecParserContext *s);
2925 int (*parser_parse)(AVCodecParserContext *s,
2926 AVCodecContext *avctx,
2927 uint8_t **poutbuf, int *poutbuf_size,
2928 const uint8_t *buf, int buf_size);
2929 void (*parser_close)(AVCodecParserContext *s);
2930 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2931 struct AVCodecParser *next;
2934 extern AVCodecParser *av_first_parser;
2936 void av_register_codec_parser(AVCodecParser *parser);
2937 AVCodecParserContext *av_parser_init(int codec_id);
2938 int av_parser_parse(AVCodecParserContext *s,
2939 AVCodecContext *avctx,
2940 uint8_t **poutbuf, int *poutbuf_size,
2941 const uint8_t *buf, int buf_size,
2942 int64_t pts, int64_t dts);
2943 int av_parser_change(AVCodecParserContext *s,
2944 AVCodecContext *avctx,
2945 uint8_t **poutbuf, int *poutbuf_size,
2946 const uint8_t *buf, int buf_size, int keyframe);
2947 void av_parser_close(AVCodecParserContext *s);
2949 extern AVCodecParser aac_parser;
2950 extern AVCodecParser ac3_parser;
2951 extern AVCodecParser cavsvideo_parser;
2952 extern AVCodecParser dca_parser;
2953 extern AVCodecParser dvbsub_parser;
2954 extern AVCodecParser dvdsub_parser;
2955 extern AVCodecParser h261_parser;
2956 extern AVCodecParser h263_parser;
2957 extern AVCodecParser h264_parser;
2958 extern AVCodecParser mjpeg_parser;
2959 extern AVCodecParser mpeg4video_parser;
2960 extern AVCodecParser mpegaudio_parser;
2961 extern AVCodecParser mpegvideo_parser;
2962 extern AVCodecParser pnm_parser;
2963 extern AVCodecParser vc1_parser;
2966 typedef struct AVBitStreamFilterContext {
2968 struct AVBitStreamFilter *filter;
2969 AVCodecParserContext *parser;
2970 struct AVBitStreamFilterContext *next;
2971 } AVBitStreamFilterContext;
2974 typedef struct AVBitStreamFilter {
2977 int (*filter)(AVBitStreamFilterContext *bsfc,
2978 AVCodecContext *avctx, const char *args,
2979 uint8_t **poutbuf, int *poutbuf_size,
2980 const uint8_t *buf, int buf_size, int keyframe);
2981 struct AVBitStreamFilter *next;
2982 } AVBitStreamFilter;
2984 extern AVBitStreamFilter *av_first_bitstream_filter;
2986 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2987 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2988 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2989 AVCodecContext *avctx, const char *args,
2990 uint8_t **poutbuf, int *poutbuf_size,
2991 const uint8_t *buf, int buf_size, int keyframe);
2992 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2994 extern AVBitStreamFilter dump_extradata_bsf;
2995 extern AVBitStreamFilter remove_extradata_bsf;
2996 extern AVBitStreamFilter noise_bsf;
2997 extern AVBitStreamFilter mp3_header_compress_bsf;
2998 extern AVBitStreamFilter mp3_header_decompress_bsf;
2999 extern AVBitStreamFilter mjpega_dump_header_bsf;
3000 extern AVBitStreamFilter imx_dump_header_bsf;
3006 * Reallocates the given block if it is not large enough, otherwise it
3011 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3013 /* for static data only */
3016 * Frees all static arrays and reset their pointers to 0.
3017 * Call this function to release all statically allocated tables.
3019 attribute_deprecated void av_free_static(void);
3022 * Allocation of static arrays.
3024 * @warning Do not use for normal allocation.
3026 * @param[in] size The amount of memory you need in bytes.
3027 * @return Block of memory of the requested size.
3029 attribute_deprecated void *av_mallocz_static(unsigned int size);
3032 * Copy image 'src' to 'dst'.
3034 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3035 int pix_fmt, int width, int height);
3038 * Crop image top and left side
3040 int av_picture_crop(AVPicture *dst, const AVPicture *src,
3041 int pix_fmt, int top_band, int left_band);
3046 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
3047 int padtop, int padbottom, int padleft, int padright, int *color);
3049 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
3050 attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
3051 int pix_fmt, int width, int height);
3053 attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
3054 int pix_fmt, int top_band, int left_band);
3056 attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
3057 int padtop, int padbottom, int padleft, int padright, int *color);
3060 extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3062 /* error handling */
3064 #define AVERROR(e) (-(e)) /**< returns a negative error code from a POSIX error code, to return from library functions. */
3065 #define AVUNERROR(e) (-(e)) /**< returns a POSIX error code from a library function error return value. */
3067 /* some platforms have E* and errno already negated. */
3068 #define AVERROR(e) (e)
3069 #define AVUNERROR(e) (e)
3071 #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
3072 #define AVERROR_IO AVERROR(EIO) /**< i/o error */
3073 #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< number syntax expected in filename */
3074 #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
3075 #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
3076 #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
3077 #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< operation not supported */
3083 #endif /* AVCODEC_H */