2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav 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 * Libav 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 Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
38 #include "libavcodec/version.h"
41 * Identify the syntax and semantics of the bitstream.
42 * The principle is roughly:
43 * Two decoders with the same ID can decode the same streams.
44 * Two encoders with the same ID can encode compatible streams.
45 * There may be slight deviations from the principle due to implementation
48 * If you add a codec ID to this list, add it so that
49 * 1. no value of a existing codec ID changes (that would break ABI),
50 * 2. it is as close as possible to similar codecs.
57 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
58 CODEC_ID_MPEG2VIDEO_XVMC,
95 CODEC_ID_INTERPLAY_VIDEO,
107 CODEC_ID_TRUEMOTION1,
134 CODEC_ID_TRUEMOTION2,
151 CODEC_ID_DSICINVIDEO,
152 CODEC_ID_TIERTEXSEQVIDEO,
161 CODEC_ID_BETHSOFTVID,
179 CODEC_ID_MOTIONPIXELS,
197 CODEC_ID_IFF_BYTERUN1,
214 /* various PCM "codecs" */
215 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
216 CODEC_ID_PCM_S16LE= 0x10000,
232 CODEC_ID_PCM_S24DAUD,
234 CODEC_ID_PCM_S16LE_PLANAR,
244 /* various ADPCM codecs */
245 CODEC_ID_ADPCM_IMA_QT= 0x11000,
246 CODEC_ID_ADPCM_IMA_WAV,
247 CODEC_ID_ADPCM_IMA_DK3,
248 CODEC_ID_ADPCM_IMA_DK4,
249 CODEC_ID_ADPCM_IMA_WS,
250 CODEC_ID_ADPCM_IMA_SMJPEG,
259 CODEC_ID_ADPCM_YAMAHA,
260 CODEC_ID_ADPCM_SBPRO_4,
261 CODEC_ID_ADPCM_SBPRO_3,
262 CODEC_ID_ADPCM_SBPRO_2,
264 CODEC_ID_ADPCM_IMA_AMV,
265 CODEC_ID_ADPCM_EA_R1,
266 CODEC_ID_ADPCM_EA_R3,
267 CODEC_ID_ADPCM_EA_R2,
268 CODEC_ID_ADPCM_IMA_EA_SEAD,
269 CODEC_ID_ADPCM_IMA_EA_EACS,
270 CODEC_ID_ADPCM_EA_XAS,
271 CODEC_ID_ADPCM_EA_MAXIS_XA,
272 CODEC_ID_ADPCM_IMA_ISS,
276 CODEC_ID_AMR_NB= 0x12000,
279 /* RealAudio codecs*/
280 CODEC_ID_RA_144= 0x13000,
283 /* various DPCM codecs */
284 CODEC_ID_ROQ_DPCM= 0x14000,
285 CODEC_ID_INTERPLAY_DPCM,
290 CODEC_ID_MP2= 0x15000,
291 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
309 CODEC_ID_WESTWOOD_SND1,
310 CODEC_ID_GSM, ///< as in Berlin toast format
318 CODEC_ID_DSICINAUDIO,
322 CODEC_ID_GSM_MS, /* as found in WAV */
331 CODEC_ID_WMALOSSLESS,
340 CODEC_ID_BINKAUDIO_RDFT,
341 CODEC_ID_BINKAUDIO_DCT,
345 /* subtitle codecs */
346 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
347 CODEC_ID_DVD_SUBTITLE= 0x17000,
348 CODEC_ID_DVB_SUBTITLE,
349 CODEC_ID_TEXT, ///< raw UTF-8 text
353 CODEC_ID_HDMV_PGS_SUBTITLE,
354 CODEC_ID_DVB_TELETEXT,
357 /* other specific kind of codecs (generally used for attachments) */
358 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
359 CODEC_ID_TTF= 0x18000,
361 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
363 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
364 * stream (only used by libavformat) */
365 CODEC_ID_FFMETADATA=0x21000, ///< Dummy codec for streams containing only metadata information.
368 #if FF_API_OLD_SAMPLE_FMT
369 #define SampleFormat AVSampleFormat
371 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
372 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
373 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
374 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
375 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
376 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
377 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
380 #if FF_API_OLD_AUDIOCONVERT
381 #include "libavutil/audioconvert.h"
383 /* Audio channel masks */
384 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
385 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
386 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
387 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
388 #define CH_BACK_LEFT AV_CH_BACK_LEFT
389 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
390 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
391 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
392 #define CH_BACK_CENTER AV_CH_BACK_CENTER
393 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
394 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
395 #define CH_TOP_CENTER AV_CH_TOP_CENTER
396 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
397 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
398 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
399 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
400 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
401 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
402 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
403 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
405 /** Channel mask value used for AVCodecContext.request_channel_layout
406 to indicate that the user requests the channel order of the decoder output
407 to be the native codec channel order. */
408 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
410 /* Audio channel convenience macros */
411 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
412 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
413 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
414 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
415 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
416 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
417 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
418 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
419 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
420 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
421 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
422 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
423 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
424 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
425 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
429 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
432 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
433 * This is mainly needed because some optimized bitstream readers read
434 * 32 or 64 bit at once and could read over the end.<br>
435 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
436 * MPEG bitstreams could cause overread and segfault.
438 #define FF_INPUT_BUFFER_PADDING_SIZE 8
441 * minimum encoding buffer size
442 * Used to avoid some checks during header writing.
444 #define FF_MIN_BUFFER_SIZE 16384
448 * motion estimation type.
451 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
455 ME_EPZS, ///< enhanced predictive zonal search
456 ME_X1, ///< reserved for experiments
457 ME_HEX, ///< hexagon based search
458 ME_UMH, ///< uneven multi-hexagon search
459 ME_ITER, ///< iterative search
460 ME_TESA, ///< transformed exhaustive search algorithm
464 /* We leave some space between them for extensions (drop some
465 * keyframes for intra-only or drop just some bidir frames). */
466 AVDISCARD_NONE =-16, ///< discard nothing
467 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
468 AVDISCARD_NONREF = 8, ///< discard all non reference
469 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
470 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
471 AVDISCARD_ALL = 48, ///< discard all
474 enum AVColorPrimaries{
475 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
476 AVCOL_PRI_UNSPECIFIED=2,
478 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
479 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
480 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
482 AVCOL_PRI_NB , ///< Not part of ABI
485 enum AVColorTransferCharacteristic{
486 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
487 AVCOL_TRC_UNSPECIFIED=2,
488 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
489 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
490 AVCOL_TRC_NB , ///< Not part of ABI
495 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
496 AVCOL_SPC_UNSPECIFIED=2,
498 AVCOL_SPC_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
499 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
500 AVCOL_SPC_SMPTE240M =7,
501 AVCOL_SPC_NB , ///< Not part of ABI
505 AVCOL_RANGE_UNSPECIFIED=0,
506 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
507 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
508 AVCOL_RANGE_NB , ///< Not part of ABI
512 * X X 3 4 X X are luma samples,
513 * 1 2 1-6 are possible chroma positions
514 * X X 5 6 X 0 is undefined/unknown position
516 enum AVChromaLocation{
517 AVCHROMA_LOC_UNSPECIFIED=0,
518 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
519 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
520 AVCHROMA_LOC_TOPLEFT =3, ///< DV
522 AVCHROMA_LOC_BOTTOMLEFT =5,
523 AVCHROMA_LOC_BOTTOM =6,
524 AVCHROMA_LOC_NB , ///< Not part of ABI
527 #if FF_API_FLAC_GLOBAL_OPTS
531 attribute_deprecated enum AVLPCType {
532 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
533 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
534 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
535 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
536 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
537 AV_LPC_TYPE_NB , ///< Not part of ABI
541 enum AVAudioServiceType {
542 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
543 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
544 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
545 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
546 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
547 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
548 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
549 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
550 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
551 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
554 typedef struct RcOverride{
557 int qscale; // If this is 0 then quality_factor will be used instead.
558 float quality_factor;
561 #define FF_MAX_B_FRAMES 16
564 These flags can be passed in AVCodecContext.flags before initialization.
565 Note: Not everything is supported yet.
568 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
569 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
570 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
571 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
572 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
573 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
574 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
577 * The parent program guarantees that the input for B-frames containing
578 * streams is not written to for at least s->max_b_frames+1 frames, if
579 * this is not set the input will be copied.
581 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
582 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
583 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
584 #if FF_API_MJPEG_GLOBAL_OPTS
585 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
587 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
588 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
589 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
590 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
591 location instead of only at frame boundaries. */
592 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
593 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
594 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
595 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
596 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
598 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
599 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
600 /* Fx : Flag for h263+ extra options */
601 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
602 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
603 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
605 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
606 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
607 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
608 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
610 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
611 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
612 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
613 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
614 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
615 #define CODEC_FLAG_CLOSED_GOP 0x80000000
616 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
617 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
618 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
619 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
620 #if FF_API_X264_GLOBAL_OPTS
621 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
622 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
623 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
624 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
625 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
626 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
627 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
629 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
630 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
632 #if FF_API_SNOW_GLOBAL_OPTS
633 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
635 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
636 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
638 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
639 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
640 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
641 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
643 #if FF_API_LAME_GLOBAL_OPTS
644 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
646 #if FF_API_X264_GLOBAL_OPTS
647 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
648 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
649 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
650 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
653 /* Unsupported options :
654 * Syntax Arithmetic coding (SAC)
655 * Reference Picture Selection
656 * Independent Segment Decoding */
658 /* codec capabilities */
660 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
662 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
663 * If not set, it might not use get_buffer() at all or use operations that
664 * assume the buffer was allocated by avcodec_default_get_buffer.
666 #define CODEC_CAP_DR1 0x0002
667 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
668 #define CODEC_CAP_PARSE_ONLY 0x0004
669 #define CODEC_CAP_TRUNCATED 0x0008
670 /* Codec can export data for HW decoding (XvMC). */
671 #define CODEC_CAP_HWACCEL 0x0010
673 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
674 * If this is not set, the codec is guaranteed to never be fed with NULL data.
676 #define CODEC_CAP_DELAY 0x0020
678 * Codec can be fed a final frame with a smaller size.
679 * This can be used to prevent truncation of the last audio samples.
681 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
683 * Codec can export data for HW decoding (VDPAU).
685 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
687 * Codec can output multiple frames per AVPacket
688 * Normally demuxers return one frame at a time, demuxers which do not do
689 * are connected to a parser to split what they return into proper frames.
690 * This flag is reserved to the very rare category of codecs which have a
691 * bitstream that cannot be split into frames without timeconsuming
692 * operations like full decoding. Demuxers carring such bitstreams thus
693 * may return multiple frames in a packet. This has many disadvantages like
694 * prohibiting stream copy in many cases thus it should only be considered
697 #define CODEC_CAP_SUBFRAMES 0x0100
699 * Codec is experimental and is thus avoided in favor of non experimental
702 #define CODEC_CAP_EXPERIMENTAL 0x0200
704 * Codec should fill in channel configuration and samplerate instead of container
706 #define CODEC_CAP_CHANNEL_CONF 0x0400
708 * Codec is able to deal with negative linesizes
710 #define CODEC_CAP_NEG_LINESIZES 0x0800
712 * Codec supports frame-level multithreading.
714 #define CODEC_CAP_FRAME_THREADS 0x1000
716 * Codec supports slice-based (or partition-based) multithreading.
718 #define CODEC_CAP_SLICE_THREADS 0x2000
720 //The following defines may change, don't expect compatibility if you use them.
721 #define MB_TYPE_INTRA4x4 0x0001
722 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
723 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
724 #define MB_TYPE_16x16 0x0008
725 #define MB_TYPE_16x8 0x0010
726 #define MB_TYPE_8x16 0x0020
727 #define MB_TYPE_8x8 0x0040
728 #define MB_TYPE_INTERLACED 0x0080
729 #define MB_TYPE_DIRECT2 0x0100 //FIXME
730 #define MB_TYPE_ACPRED 0x0200
731 #define MB_TYPE_GMC 0x0400
732 #define MB_TYPE_SKIP 0x0800
733 #define MB_TYPE_P0L0 0x1000
734 #define MB_TYPE_P1L0 0x2000
735 #define MB_TYPE_P0L1 0x4000
736 #define MB_TYPE_P1L1 0x8000
737 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
738 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
739 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
740 #define MB_TYPE_QUANT 0x00010000
741 #define MB_TYPE_CBP 0x00020000
742 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
746 * This specifies the area which should be displayed.
747 * Note there may be multiple such areas for one frame.
749 typedef struct AVPanScan{
752 * - encoding: Set by user.
753 * - decoding: Set by libavcodec.
758 * width and height in 1/16 pel
759 * - encoding: Set by user.
760 * - decoding: Set by libavcodec.
766 * position of the top left corner in 1/16 pel for up to 3 fields/frames
767 * - encoding: Set by user.
768 * - decoding: Set by libavcodec.
770 int16_t position[3][2];
773 #define FF_QSCALE_TYPE_MPEG1 0
774 #define FF_QSCALE_TYPE_MPEG2 1
775 #define FF_QSCALE_TYPE_H264 2
776 #define FF_QSCALE_TYPE_VP56 3
778 #define FF_BUFFER_TYPE_INTERNAL 1
779 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
780 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
781 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
783 #if FF_API_OLD_FF_PICT_TYPES
784 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
785 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
786 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
787 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
788 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
789 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
790 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
791 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
794 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
795 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
796 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
797 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
799 enum AVPacketSideDataType {
803 typedef struct AVPacket {
805 * Presentation timestamp in AVStream->time_base units; the time at which
806 * the decompressed packet will be presented to the user.
807 * Can be AV_NOPTS_VALUE if it is not stored in the file.
808 * pts MUST be larger or equal to dts as presentation cannot happen before
809 * decompression, unless one wants to view hex dumps. Some formats misuse
810 * the terms dts and pts/cts to mean something different. Such timestamps
811 * must be converted to true pts/dts before they are stored in AVPacket.
815 * Decompression timestamp in AVStream->time_base units; the time at which
816 * the packet is decompressed.
817 * Can be AV_NOPTS_VALUE if it is not stored in the file.
824 * A combination of AV_PKT_FLAG values
828 * Additional packet data that can be provided by the container.
829 * Packet can contain several types of side information.
834 enum AVPacketSideDataType type;
839 * Duration of this packet in AVStream->time_base units, 0 if unknown.
840 * Equals next_pts - this_pts in presentation order.
843 void (*destruct)(struct AVPacket *);
845 int64_t pos; ///< byte position in stream, -1 if unknown
848 * Time difference in AVStream->time_base units from the pts of this
849 * packet to the point at which the output from the decoder has converged
850 * independent from the availability of previous frames. That is, the
851 * frames are virtually identical no matter if decoding started from
852 * the very first frame or from this keyframe.
853 * Is AV_NOPTS_VALUE if unknown.
854 * This field is not the display duration of the current packet.
855 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
858 * The purpose of this field is to allow seeking in streams that have no
859 * keyframes in the conventional sense. It corresponds to the
860 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
861 * essential for some types of subtitle streams to ensure that all
862 * subtitles are correctly displayed after seeking.
864 int64_t convergence_duration;
866 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
867 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
871 * New fields can be added to the end of AVFRAME with minor version
872 * bumps. Removal, reordering and changes to existing fields require
873 * a major version bump.
874 * sizeof(AVFrame) must not be used outside libav*.
876 typedef struct AVFrame {
878 * pointer to the picture planes.
879 * This might be different from the first allocated byte
886 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
887 * This isn't used by libavcodec unless the default get/release_buffer() is used.
893 * 1 -> keyframe, 0-> not
894 * - encoding: Set by libavcodec.
895 * - decoding: Set by libavcodec.
900 * Picture type of the frame, see ?_TYPE below.
901 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
902 * - decoding: Set by libavcodec.
904 enum AVPictureType pict_type;
907 * presentation timestamp in time_base units (time when frame should be shown to user)
908 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
909 * - encoding: MUST be set by user.
910 * - decoding: Set by libavcodec.
915 * picture number in bitstream order
917 * - decoding: Set by libavcodec.
919 int coded_picture_number;
921 * picture number in display order
923 * - decoding: Set by libavcodec.
925 int display_picture_number;
928 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
929 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
930 * - decoding: Set by libavcodec.
935 * buffer age (1->was last buffer and dint change, 2->..., ...).
936 * Set to INT_MAX if the buffer has not been used yet.
938 * - decoding: MUST be set by get_buffer().
943 * is this picture used as reference
944 * The values for this are the same as the MpegEncContext.picture_structure
945 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
946 * Set to 4 for delayed, non-reference frames.
948 * - decoding: Set by libavcodec. (before get_buffer() call)).
955 * - decoding: Set by libavcodec.
957 int8_t *qscale_table;
961 * - decoding: Set by libavcodec.
966 * mbskip_table[mb]>=1 if MB didn't change
967 * stride= mb_width = (width+15)>>4
969 * - decoding: Set by libavcodec.
971 uint8_t *mbskip_table;
974 * motion vector table
977 * int mv_sample_log2= 4 - motion_subsample_log2;
978 * int mb_width= (width+15)>>4;
979 * int mv_stride= (mb_width << mv_sample_log2) + 1;
980 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
982 * - encoding: Set by user.
983 * - decoding: Set by libavcodec.
985 int16_t (*motion_val[2])[2];
988 * macroblock type table
989 * mb_type_base + mb_width + 2
990 * - encoding: Set by user.
991 * - decoding: Set by libavcodec.
996 * log2 of the size of the block which a single vector in motion_val represents:
997 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
999 * - decoding: Set by libavcodec.
1001 uint8_t motion_subsample_log2;
1004 * for some private data of the user
1005 * - encoding: unused
1006 * - decoding: Set by user.
1012 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1013 * - decoding: unused
1018 * type of the buffer (to keep track of who has to deallocate data[*])
1019 * - encoding: Set by the one who allocates it.
1020 * - decoding: Set by the one who allocates it.
1021 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1026 * When decoding, this signals how much the picture must be delayed.
1027 * extra_delay = repeat_pict / (2*fps)
1028 * - encoding: unused
1029 * - decoding: Set by libavcodec.
1039 * The content of the picture is interlaced.
1040 * - encoding: Set by user.
1041 * - decoding: Set by libavcodec. (default 0)
1043 int interlaced_frame;
1046 * If the content is interlaced, is top field displayed first.
1047 * - encoding: Set by user.
1048 * - decoding: Set by libavcodec.
1050 int top_field_first;
1054 * - encoding: Set by user.
1055 * - decoding: Set by libavcodec.
1057 AVPanScan *pan_scan;
1060 * Tell user application that palette has changed from previous frame.
1061 * - encoding: ??? (no palette-enabled encoder yet)
1062 * - decoding: Set by libavcodec. (default 0).
1064 int palette_has_changed;
1067 * codec suggestion on buffer type if != 0
1068 * - encoding: unused
1069 * - decoding: Set by libavcodec. (before get_buffer() call)).
1075 * - encoding: unused
1076 * - decoding: Set by libavcodec.
1081 * motion reference frame index
1082 * the order in which these are stored can depend on the codec.
1083 * - encoding: Set by user.
1084 * - decoding: Set by libavcodec.
1086 int8_t *ref_index[2];
1089 * reordered opaque 64bit (generally an integer or a double precision float
1090 * PTS but can be anything).
1091 * The user sets AVCodecContext.reordered_opaque to represent the input at
1093 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1094 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1095 * @deprecated in favor of pkt_pts
1096 * - encoding: unused
1097 * - decoding: Read by user.
1099 int64_t reordered_opaque;
1102 * hardware accelerator private data (Libav-allocated)
1103 * - encoding: unused
1104 * - decoding: Set by libavcodec
1106 void *hwaccel_picture_private;
1109 * reordered pts from the last AVPacket that has been input into the decoder
1110 * - encoding: unused
1111 * - decoding: Read by user.
1116 * dts from the last AVPacket that has been input into the decoder
1117 * - encoding: unused
1118 * - decoding: Read by user.
1123 * the AVCodecContext which ff_thread_get_buffer() was last called on
1124 * - encoding: Set by libavcodec.
1125 * - decoding: Set by libavcodec.
1127 struct AVCodecContext *owner;
1130 * used by multithreading to store frame-specific info
1131 * - encoding: Set by libavcodec.
1132 * - decoding: Set by libavcodec.
1134 void *thread_opaque;
1138 * main external API structure.
1139 * New fields can be added to the end with minor version bumps.
1140 * Removal, reordering and changes to existing fields require a major
1142 * sizeof(AVCodecContext) must not be used outside libav*.
1144 typedef struct AVCodecContext {
1146 * information on struct for av_log
1147 * - set by avcodec_alloc_context
1149 const AVClass *av_class;
1151 * the average bitrate
1152 * - encoding: Set by user; unused for constant quantizer encoding.
1153 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1158 * number of bits the bitstream is allowed to diverge from the reference.
1159 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1160 * - encoding: Set by user; unused for constant quantizer encoding.
1161 * - decoding: unused
1163 int bit_rate_tolerance;
1167 * - encoding: Set by user.
1168 * - decoding: Set by user.
1173 * Some codecs need additional format info. It is stored here.
1174 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1175 * specific codec MUST set it correctly otherwise stream copy breaks.
1176 * In general use of this field by muxers is not recommanded.
1177 * - encoding: Set by libavcodec.
1178 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1183 * Motion estimation algorithm used for video coding.
1184 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1185 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1186 * - encoding: MUST be set by user.
1187 * - decoding: unused
1192 * some codecs need / can use extradata like Huffman tables.
1193 * mjpeg: Huffman tables
1194 * rv10: additional flags
1195 * mpeg4: global headers (they can be in the bitstream or here)
1196 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1197 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1198 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1199 * - encoding: Set/allocated/freed by libavcodec.
1200 * - decoding: Set/allocated/freed by user.
1206 * This is the fundamental unit of time (in seconds) in terms
1207 * of which frame timestamps are represented. For fixed-fps content,
1208 * timebase should be 1/framerate and timestamp increments should be
1210 * - encoding: MUST be set by user.
1211 * - decoding: Set by libavcodec.
1213 AVRational time_base;
1217 * picture width / height.
1218 * - encoding: MUST be set by user.
1219 * - decoding: Set by libavcodec.
1220 * Note: For compatibility it is possible to set this instead of
1221 * coded_width/height before decoding.
1225 #define FF_ASPECT_EXTENDED 15
1228 * the number of pictures in a group of pictures, or 0 for intra_only
1229 * - encoding: Set by user.
1230 * - decoding: unused
1235 * Pixel format, see PIX_FMT_xxx.
1236 * May be set by the demuxer if known from headers.
1237 * May be overriden by the decoder if it knows better.
1238 * - encoding: Set by user.
1239 * - decoding: Set by user if known, overridden by libavcodec if known
1241 enum PixelFormat pix_fmt;
1244 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1245 * decoder to draw a horizontal band. It improves cache usage. Not
1246 * all codecs can do that. You must check the codec capabilities
1248 * When multithreading is used, it may be called from multiple threads
1249 * at the same time; threads might draw different parts of the same AVFrame,
1250 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1252 * The function is also used by hardware acceleration APIs.
1253 * It is called at least once during frame decoding to pass
1254 * the data needed for hardware render.
1255 * In that mode instead of pixel data, AVFrame points to
1256 * a structure specific to the acceleration API. The application
1257 * reads the structure and can change some fields to indicate progress
1259 * - encoding: unused
1260 * - decoding: Set by user.
1261 * @param height the height of the slice
1262 * @param y the y position of the slice
1263 * @param type 1->top field, 2->bottom field, 3->frame
1264 * @param offset offset into the AVFrame.data from which the slice should be read
1266 void (*draw_horiz_band)(struct AVCodecContext *s,
1267 const AVFrame *src, int offset[4],
1268 int y, int type, int height);
1271 int sample_rate; ///< samples per second
1272 int channels; ///< number of audio channels
1275 * audio sample format
1276 * - encoding: Set by user.
1277 * - decoding: Set by libavcodec.
1279 enum AVSampleFormat sample_fmt; ///< sample format
1281 /* The following data should not be initialized. */
1283 * Samples per packet, initialized when calling 'init'.
1286 int frame_number; ///< audio or video frame number
1289 * Number of frames the decoded output will be delayed relative to
1290 * the encoded input.
1291 * - encoding: Set by libavcodec.
1292 * - decoding: unused
1296 /* - encoding parameters */
1297 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1298 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1302 * - encoding: Set by user.
1303 * - decoding: unused
1309 * - encoding: Set by user.
1310 * - decoding: unused
1315 * maximum quantizer difference between frames
1316 * - encoding: Set by user.
1317 * - decoding: unused
1322 * maximum number of B-frames between non-B-frames
1323 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1324 * - encoding: Set by user.
1325 * - decoding: unused
1330 * qscale factor between IP and B-frames
1331 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1332 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1333 * - encoding: Set by user.
1334 * - decoding: unused
1336 float b_quant_factor;
1338 /** obsolete FIXME remove */
1340 #define FF_RC_STRATEGY_XVID 1
1342 int b_frame_strategy;
1344 struct AVCodec *codec;
1348 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1349 /* do its best to deliver a chunk with size */
1350 /* below rtp_payload_size, the chunk will start */
1351 /* with a start code on some codecs like H.263. */
1352 /* This doesn't take account of any particular */
1353 /* headers inside the transmitted RTP payload. */
1356 /* The RTP callback: This function is called */
1357 /* every time the encoder has a packet to send. */
1358 /* It depends on the encoder if the data starts */
1359 /* with a Start Code (it should). H.263 does. */
1360 /* mb_nb contains the number of macroblocks */
1361 /* encoded in the RTP payload. */
1362 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1364 /* statistics, used for 2-pass encoding */
1375 * number of bits used for the previously encoded frame
1376 * - encoding: Set by libavcodec.
1377 * - decoding: unused
1382 * Private data of the user, can be used to carry app specific stuff.
1383 * - encoding: Set by user.
1384 * - decoding: Set by user.
1388 char codec_name[32];
1389 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1390 enum CodecID codec_id; /* see CODEC_ID_xxx */
1393 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1394 * This is used to work around some encoder bugs.
1395 * A demuxer should set this to what is stored in the field used to identify the codec.
1396 * If there are multiple such fields in a container then the demuxer should choose the one
1397 * which maximizes the information about the used codec.
1398 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1399 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1400 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1402 * - encoding: Set by user, if not then the default based on codec_id will be used.
1403 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1405 unsigned int codec_tag;
1408 * Work around bugs in encoders which sometimes cannot be detected automatically.
1409 * - encoding: Set by user
1410 * - decoding: Set by user
1412 int workaround_bugs;
1413 #define FF_BUG_AUTODETECT 1 ///< autodetection
1414 #define FF_BUG_OLD_MSMPEG4 2
1415 #define FF_BUG_XVID_ILACE 4
1416 #define FF_BUG_UMP4 8
1417 #define FF_BUG_NO_PADDING 16
1418 #define FF_BUG_AMV 32
1419 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1420 #define FF_BUG_QPEL_CHROMA 64
1421 #define FF_BUG_STD_QPEL 128
1422 #define FF_BUG_QPEL_CHROMA2 256
1423 #define FF_BUG_DIRECT_BLOCKSIZE 512
1424 #define FF_BUG_EDGE 1024
1425 #define FF_BUG_HPEL_CHROMA 2048
1426 #define FF_BUG_DC_CLIP 4096
1427 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1428 #define FF_BUG_TRUNCATED 16384
1429 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1432 * luma single coefficient elimination threshold
1433 * - encoding: Set by user.
1434 * - decoding: unused
1436 int luma_elim_threshold;
1439 * chroma single coeff elimination threshold
1440 * - encoding: Set by user.
1441 * - decoding: unused
1443 int chroma_elim_threshold;
1446 * strictly follow the standard (MPEG4, ...).
1447 * - encoding: Set by user.
1448 * - decoding: Set by user.
1449 * Setting this to STRICT or higher means the encoder and decoder will
1450 * generally do stupid things, whereas setting it to unofficial or lower
1451 * will mean the encoder might produce output that is not supported by all
1452 * spec-compliant decoders. Decoders don't differentiate between normal,
1453 * unofficial and experimental (that is, they always try to decode things
1454 * when they can) unless they are explicitly asked to behave stupidly
1455 * (=strictly conform to the specs)
1457 int strict_std_compliance;
1458 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1459 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1460 #define FF_COMPLIANCE_NORMAL 0
1461 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1462 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1465 * qscale offset between IP and B-frames
1466 * - encoding: Set by user.
1467 * - decoding: unused
1469 float b_quant_offset;
1472 * Error recognition; higher values will detect more errors but may
1473 * misdetect some more or less valid parts as errors.
1474 * - encoding: unused
1475 * - decoding: Set by user.
1477 int error_recognition;
1478 #define FF_ER_CAREFUL 1
1479 #define FF_ER_COMPLIANT 2
1480 #define FF_ER_AGGRESSIVE 3
1481 #if FF_API_VERY_AGGRESSIVE
1482 #define FF_ER_VERY_AGGRESSIVE 4
1483 #define FF_ER_EXPLODE 5
1485 #define FF_ER_EXPLODE 4
1486 #endif /* FF_API_VERY_AGGRESSIVE */
1489 * Called at the beginning of each frame to get a buffer for it.
1490 * If pic.reference is set then the frame will be read later by libavcodec.
1491 * avcodec_align_dimensions2() should be used to find the required width and
1492 * height, as they normally need to be rounded up to the next multiple of 16.
1493 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1494 * avcodec_default_get_buffer() instead of providing buffers allocated by
1496 * If frame multithreading is used and thread_safe_callbacks is set,
1497 * it may be called from a different thread, but not from more than one at once.
1498 * Does not need to be reentrant.
1499 * - encoding: unused
1500 * - decoding: Set by libavcodec, user can override.
1502 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1505 * Called to release buffers which were allocated with get_buffer.
1506 * A released buffer can be reused in get_buffer().
1507 * pic.data[*] must be set to NULL.
1508 * May be called from a different thread if frame multithreading is used,
1509 * but not by more than one thread at once, so does not need to be reentrant.
1510 * - encoding: unused
1511 * - decoding: Set by libavcodec, user can override.
1513 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1516 * Size of the frame reordering buffer in the decoder.
1517 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1518 * - encoding: Set by libavcodec.
1519 * - decoding: Set by libavcodec.
1524 * number of bytes per packet if constant and known or 0
1525 * Used by some WAV based audio codecs.
1529 int parse_only; /* - decoding only: If true, only parsing is done
1530 (function avcodec_parse_frame()). The frame
1531 data is returned. Only MPEG codecs support this now. */
1534 * 0-> h263 quant 1-> mpeg quant
1535 * - encoding: Set by user.
1536 * - decoding: unused
1541 * pass1 encoding statistics output buffer
1542 * - encoding: Set by libavcodec.
1543 * - decoding: unused
1548 * pass2 encoding statistics input buffer
1549 * Concatenated stuff from stats_out of pass1 should be placed here.
1550 * - encoding: Allocated/set/freed by user.
1551 * - decoding: unused
1556 * ratecontrol qmin qmax limiting method
1557 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1558 * - encoding: Set by user.
1559 * - decoding: unused
1567 * ratecontrol override, see RcOverride
1568 * - encoding: Allocated/set/freed by user.
1569 * - decoding: unused
1571 RcOverride *rc_override;
1572 int rc_override_count;
1575 * rate control equation
1576 * - encoding: Set by user
1577 * - decoding: unused
1583 * - encoding: Set by user.
1584 * - decoding: unused
1590 * - encoding: Set by user.
1591 * - decoding: unused
1596 * decoder bitstream buffer size
1597 * - encoding: Set by user.
1598 * - decoding: unused
1601 float rc_buffer_aggressivity;
1604 * qscale factor between P and I-frames
1605 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1606 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1607 * - encoding: Set by user.
1608 * - decoding: unused
1610 float i_quant_factor;
1613 * qscale offset between P and I-frames
1614 * - encoding: Set by user.
1615 * - decoding: unused
1617 float i_quant_offset;
1620 * initial complexity for pass1 ratecontrol
1621 * - encoding: Set by user.
1622 * - decoding: unused
1624 float rc_initial_cplx;
1627 * DCT algorithm, see FF_DCT_* below
1628 * - encoding: Set by user.
1629 * - decoding: unused
1632 #define FF_DCT_AUTO 0
1633 #define FF_DCT_FASTINT 1
1634 #define FF_DCT_INT 2
1635 #define FF_DCT_MMX 3
1636 #define FF_DCT_MLIB 4
1637 #define FF_DCT_ALTIVEC 5
1638 #define FF_DCT_FAAN 6
1641 * luminance masking (0-> disabled)
1642 * - encoding: Set by user.
1643 * - decoding: unused
1648 * temporary complexity masking (0-> disabled)
1649 * - encoding: Set by user.
1650 * - decoding: unused
1652 float temporal_cplx_masking;
1655 * spatial complexity masking (0-> disabled)
1656 * - encoding: Set by user.
1657 * - decoding: unused
1659 float spatial_cplx_masking;
1662 * p block masking (0-> disabled)
1663 * - encoding: Set by user.
1664 * - decoding: unused
1669 * darkness masking (0-> disabled)
1670 * - encoding: Set by user.
1671 * - decoding: unused
1676 * IDCT algorithm, see FF_IDCT_* below.
1677 * - encoding: Set by user.
1678 * - decoding: Set by user.
1681 #define FF_IDCT_AUTO 0
1682 #define FF_IDCT_INT 1
1683 #define FF_IDCT_SIMPLE 2
1684 #define FF_IDCT_SIMPLEMMX 3
1685 #define FF_IDCT_LIBMPEG2MMX 4
1686 #define FF_IDCT_PS2 5
1687 #define FF_IDCT_MLIB 6
1688 #define FF_IDCT_ARM 7
1689 #define FF_IDCT_ALTIVEC 8
1690 #define FF_IDCT_SH4 9
1691 #define FF_IDCT_SIMPLEARM 10
1692 #define FF_IDCT_H264 11
1693 #define FF_IDCT_VP3 12
1694 #define FF_IDCT_IPP 13
1695 #define FF_IDCT_XVIDMMX 14
1696 #define FF_IDCT_CAVS 15
1697 #define FF_IDCT_SIMPLEARMV5TE 16
1698 #define FF_IDCT_SIMPLEARMV6 17
1699 #define FF_IDCT_SIMPLEVIS 18
1700 #define FF_IDCT_WMV2 19
1701 #define FF_IDCT_FAAN 20
1702 #define FF_IDCT_EA 21
1703 #define FF_IDCT_SIMPLENEON 22
1704 #define FF_IDCT_SIMPLEALPHA 23
1705 #define FF_IDCT_BINK 24
1709 * - encoding: Set by libavcodec.
1710 * - decoding: Set by user (or 0).
1714 * slice offsets in the frame in bytes
1715 * - encoding: Set/allocated by libavcodec.
1716 * - decoding: Set/allocated by user (or NULL).
1721 * error concealment flags
1722 * - encoding: unused
1723 * - decoding: Set by user.
1725 int error_concealment;
1726 #define FF_EC_GUESS_MVS 1
1727 #define FF_EC_DEBLOCK 2
1730 * dsp_mask could be add used to disable unwanted CPU features
1731 * CPU features (i.e. MMX, SSE. ...)
1733 * With the FORCE flag you may instead enable given CPU features.
1734 * (Dangerous: Usable in case of misdetection, improper usage however will
1735 * result into program crash.)
1740 * bits per sample/pixel from the demuxer (needed for huffyuv).
1741 * - encoding: Set by libavcodec.
1742 * - decoding: Set by user.
1744 int bits_per_coded_sample;
1747 * prediction method (needed for huffyuv)
1748 * - encoding: Set by user.
1749 * - decoding: unused
1751 int prediction_method;
1752 #define FF_PRED_LEFT 0
1753 #define FF_PRED_PLANE 1
1754 #define FF_PRED_MEDIAN 2
1757 * sample aspect ratio (0 if unknown)
1758 * That is the width of a pixel divided by the height of the pixel.
1759 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1760 * - encoding: Set by user.
1761 * - decoding: Set by libavcodec.
1763 AVRational sample_aspect_ratio;
1766 * the picture in the bitstream
1767 * - encoding: Set by libavcodec.
1768 * - decoding: Set by libavcodec.
1770 AVFrame *coded_frame;
1774 * - encoding: Set by user.
1775 * - decoding: Set by user.
1778 #define FF_DEBUG_PICT_INFO 1
1779 #define FF_DEBUG_RC 2
1780 #define FF_DEBUG_BITSTREAM 4
1781 #define FF_DEBUG_MB_TYPE 8
1782 #define FF_DEBUG_QP 16
1783 #define FF_DEBUG_MV 32
1784 #define FF_DEBUG_DCT_COEFF 0x00000040
1785 #define FF_DEBUG_SKIP 0x00000080
1786 #define FF_DEBUG_STARTCODE 0x00000100
1787 #define FF_DEBUG_PTS 0x00000200
1788 #define FF_DEBUG_ER 0x00000400
1789 #define FF_DEBUG_MMCO 0x00000800
1790 #define FF_DEBUG_BUGS 0x00001000
1791 #define FF_DEBUG_VIS_QP 0x00002000
1792 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1793 #define FF_DEBUG_BUFFERS 0x00008000
1794 #define FF_DEBUG_THREADS 0x00010000
1798 * - encoding: Set by user.
1799 * - decoding: Set by user.
1802 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1803 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1804 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1808 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1809 * - decoding: unused
1814 * motion estimation comparison function
1815 * - encoding: Set by user.
1816 * - decoding: unused
1820 * subpixel motion estimation comparison function
1821 * - encoding: Set by user.
1822 * - decoding: unused
1826 * macroblock comparison function (not supported yet)
1827 * - encoding: Set by user.
1828 * - decoding: unused
1832 * interlaced DCT comparison function
1833 * - encoding: Set by user.
1834 * - decoding: unused
1837 #define FF_CMP_SAD 0
1838 #define FF_CMP_SSE 1
1839 #define FF_CMP_SATD 2
1840 #define FF_CMP_DCT 3
1841 #define FF_CMP_PSNR 4
1842 #define FF_CMP_BIT 5
1844 #define FF_CMP_ZERO 7
1845 #define FF_CMP_VSAD 8
1846 #define FF_CMP_VSSE 9
1847 #define FF_CMP_NSSE 10
1848 #define FF_CMP_W53 11
1849 #define FF_CMP_W97 12
1850 #define FF_CMP_DCTMAX 13
1851 #define FF_CMP_DCT264 14
1852 #define FF_CMP_CHROMA 256
1855 * ME diamond size & shape
1856 * - encoding: Set by user.
1857 * - decoding: unused
1862 * amount of previous MV predictors (2a+1 x 2a+1 square)
1863 * - encoding: Set by user.
1864 * - decoding: unused
1866 int last_predictor_count;
1869 * prepass for motion estimation
1870 * - encoding: Set by user.
1871 * - decoding: unused
1876 * motion estimation prepass comparison function
1877 * - encoding: Set by user.
1878 * - decoding: unused
1883 * ME prepass diamond size & shape
1884 * - encoding: Set by user.
1885 * - decoding: unused
1891 * - encoding: Set by user.
1892 * - decoding: unused
1894 int me_subpel_quality;
1897 * callback to negotiate the pixelFormat
1898 * @param fmt is the list of formats which are supported by the codec,
1899 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1900 * The first is always the native one.
1901 * @return the chosen format
1902 * - encoding: unused
1903 * - decoding: Set by user, if not set the native format will be chosen.
1905 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1908 * DTG active format information (additional aspect ratio
1909 * information only used in DVB MPEG-2 transport streams)
1912 * - encoding: unused
1913 * - decoding: Set by decoder.
1915 int dtg_active_format;
1916 #define FF_DTG_AFD_SAME 8
1917 #define FF_DTG_AFD_4_3 9
1918 #define FF_DTG_AFD_16_9 10
1919 #define FF_DTG_AFD_14_9 11
1920 #define FF_DTG_AFD_4_3_SP_14_9 13
1921 #define FF_DTG_AFD_16_9_SP_14_9 14
1922 #define FF_DTG_AFD_SP_4_3 15
1925 * maximum motion estimation search range in subpel units
1926 * If 0 then no limit.
1928 * - encoding: Set by user.
1929 * - decoding: unused
1934 * intra quantizer bias
1935 * - encoding: Set by user.
1936 * - decoding: unused
1938 int intra_quant_bias;
1939 #define FF_DEFAULT_QUANT_BIAS 999999
1942 * inter quantizer bias
1943 * - encoding: Set by user.
1944 * - decoding: unused
1946 int inter_quant_bias;
1950 * - encoding: unused
1951 * - decoding: Which clrtable should be used for 8bit RGB images.
1952 * Tables have to be stored somewhere. FIXME
1957 * internal_buffer count
1958 * Don't touch, used by libavcodec default_get_buffer().
1960 int internal_buffer_count;
1964 * Don't touch, used by libavcodec default_get_buffer().
1966 void *internal_buffer;
1969 * Global quality for codecs which cannot change it per frame.
1970 * This should be proportional to MPEG-1/2/4 qscale.
1971 * - encoding: Set by user.
1972 * - decoding: unused
1976 #define FF_CODER_TYPE_VLC 0
1977 #define FF_CODER_TYPE_AC 1
1978 #define FF_CODER_TYPE_RAW 2
1979 #define FF_CODER_TYPE_RLE 3
1980 #define FF_CODER_TYPE_DEFLATE 4
1983 * - encoding: Set by user.
1984 * - decoding: unused
1990 * - encoding: Set by user.
1991 * - decoding: unused
1997 * - encoding: unused
1998 * - decoding: Set by user.
2000 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2005 * - encoding: unused
2006 * - decoding: Set by user.
2009 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2010 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2011 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2014 * XVideo Motion Acceleration
2015 * - encoding: forbidden
2016 * - decoding: set by decoder
2018 int xvmc_acceleration;
2021 * macroblock decision mode
2022 * - encoding: Set by user.
2023 * - decoding: unused
2026 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2027 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2028 #define FF_MB_DECISION_RD 2 ///< rate distortion
2031 * custom intra quantization matrix
2032 * - encoding: Set by user, can be NULL.
2033 * - decoding: Set by libavcodec.
2035 uint16_t *intra_matrix;
2038 * custom inter quantization matrix
2039 * - encoding: Set by user, can be NULL.
2040 * - decoding: Set by libavcodec.
2042 uint16_t *inter_matrix;
2045 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2046 * This is used to work around some encoder bugs.
2047 * - encoding: unused
2048 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2050 unsigned int stream_codec_tag;
2053 * scene change detection threshold
2054 * 0 is default, larger means fewer detected scene changes.
2055 * - encoding: Set by user.
2056 * - decoding: unused
2058 int scenechange_threshold;
2061 * minimum Lagrange multipler
2062 * - encoding: Set by user.
2063 * - decoding: unused
2068 * maximum Lagrange multipler
2069 * - encoding: Set by user.
2070 * - decoding: unused
2074 #if FF_API_PALETTE_CONTROL
2076 * palette control structure
2077 * - encoding: ??? (no palette-enabled encoder yet)
2078 * - decoding: Set by user.
2080 struct AVPaletteControl *palctrl;
2084 * noise reduction strength
2085 * - encoding: Set by user.
2086 * - decoding: unused
2088 int noise_reduction;
2091 * Called at the beginning of a frame to get cr buffer for it.
2092 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2093 * libavcodec will pass previous buffer in pic, function should return
2094 * same buffer or new buffer with old frame "painted" into it.
2095 * If pic.data[0] == NULL must behave like get_buffer().
2096 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2097 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2099 * - encoding: unused
2100 * - decoding: Set by libavcodec, user can override.
2102 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2105 * Number of bits which should be loaded into the rc buffer before decoding starts.
2106 * - encoding: Set by user.
2107 * - decoding: unused
2109 int rc_initial_buffer_occupancy;
2113 * - encoding: Set by user.
2114 * - decoding: unused
2116 int inter_threshold;
2120 * - encoding: Set by user.
2121 * - decoding: Set by user.
2126 * Simulates errors in the bitstream to test error concealment.
2127 * - encoding: Set by user.
2128 * - decoding: unused
2132 #if FF_API_ANTIALIAS_ALGO
2134 * MP3 antialias algorithm, see FF_AA_* below.
2135 * - encoding: unused
2136 * - decoding: Set by user.
2138 attribute_deprecated int antialias_algo;
2139 #define FF_AA_AUTO 0
2140 #define FF_AA_FASTINT 1 //not implemented yet
2142 #define FF_AA_FLOAT 3
2146 * quantizer noise shaping
2147 * - encoding: Set by user.
2148 * - decoding: unused
2150 int quantizer_noise_shaping;
2154 * is used to decide how many independent tasks should be passed to execute()
2155 * - encoding: Set by user.
2156 * - decoding: Set by user.
2161 * The codec may call this to execute several independent things.
2162 * It will return only after finishing all tasks.
2163 * The user may replace this with some multithreaded implementation,
2164 * the default implementation will execute the parts serially.
2165 * @param count the number of things to execute
2166 * - encoding: Set by libavcodec, user can override.
2167 * - decoding: Set by libavcodec, user can override.
2169 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2173 * Can be used by execute() to store some per AVCodecContext stuff.
2174 * - encoding: set by execute()
2175 * - decoding: set by execute()
2177 void *thread_opaque;
2180 * Motion estimation threshold below which no motion estimation is
2181 * performed, but instead the user specified motion vectors are used.
2183 * - encoding: Set by user.
2184 * - decoding: unused
2189 * Macroblock threshold below which the user specified macroblock types will be used.
2190 * - encoding: Set by user.
2191 * - decoding: unused
2196 * precision of the intra DC coefficient - 8
2197 * - encoding: Set by user.
2198 * - decoding: unused
2200 int intra_dc_precision;
2203 * noise vs. sse weight for the nsse comparsion function
2204 * - encoding: Set by user.
2205 * - decoding: unused
2210 * Number of macroblock rows at the top which are skipped.
2211 * - encoding: unused
2212 * - decoding: Set by user.
2217 * Number of macroblock rows at the bottom which are skipped.
2218 * - encoding: unused
2219 * - decoding: Set by user.
2225 * - encoding: Set by user.
2226 * - decoding: Set by libavcodec.
2229 #define FF_PROFILE_UNKNOWN -99
2230 #define FF_PROFILE_RESERVED -100
2232 #define FF_PROFILE_AAC_MAIN 0
2233 #define FF_PROFILE_AAC_LOW 1
2234 #define FF_PROFILE_AAC_SSR 2
2235 #define FF_PROFILE_AAC_LTP 3
2237 #define FF_PROFILE_DTS 20
2238 #define FF_PROFILE_DTS_ES 30
2239 #define FF_PROFILE_DTS_96_24 40
2240 #define FF_PROFILE_DTS_HD_HRA 50
2241 #define FF_PROFILE_DTS_HD_MA 60
2243 #define FF_PROFILE_MPEG2_422 0
2244 #define FF_PROFILE_MPEG2_HIGH 1
2245 #define FF_PROFILE_MPEG2_SS 2
2246 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2247 #define FF_PROFILE_MPEG2_MAIN 4
2248 #define FF_PROFILE_MPEG2_SIMPLE 5
2250 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2251 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2253 #define FF_PROFILE_H264_BASELINE 66
2254 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2255 #define FF_PROFILE_H264_MAIN 77
2256 #define FF_PROFILE_H264_EXTENDED 88
2257 #define FF_PROFILE_H264_HIGH 100
2258 #define FF_PROFILE_H264_HIGH_10 110
2259 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2260 #define FF_PROFILE_H264_HIGH_422 122
2261 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2262 #define FF_PROFILE_H264_HIGH_444 144
2263 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2264 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2265 #define FF_PROFILE_H264_CAVLC_444 44
2267 #define FF_PROFILE_VC1_SIMPLE 0
2268 #define FF_PROFILE_VC1_MAIN 1
2269 #define FF_PROFILE_VC1_COMPLEX 2
2270 #define FF_PROFILE_VC1_ADVANCED 3
2272 #define FF_PROFILE_MPEG4_SIMPLE 0
2273 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2274 #define FF_PROFILE_MPEG4_CORE 2
2275 #define FF_PROFILE_MPEG4_MAIN 3
2276 #define FF_PROFILE_MPEG4_N_BIT 4
2277 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2278 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2279 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2280 #define FF_PROFILE_MPEG4_HYBRID 8
2281 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2282 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2283 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2284 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2285 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2286 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2287 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2291 * - encoding: Set by user.
2292 * - decoding: Set by libavcodec.
2295 #define FF_LEVEL_UNKNOWN -99
2298 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2299 * - encoding: unused
2300 * - decoding: Set by user.
2305 * Bitstream width / height, may be different from width/height if lowres enabled.
2306 * - encoding: unused
2307 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2309 int coded_width, coded_height;
2312 * frame skip threshold
2313 * - encoding: Set by user.
2314 * - decoding: unused
2316 int frame_skip_threshold;
2320 * - encoding: Set by user.
2321 * - decoding: unused
2323 int frame_skip_factor;
2326 * frame skip exponent
2327 * - encoding: Set by user.
2328 * - decoding: unused
2333 * frame skip comparison function
2334 * - encoding: Set by user.
2335 * - decoding: unused
2340 * Border processing masking, raises the quantizer for mbs on the borders
2342 * - encoding: Set by user.
2343 * - decoding: unused
2345 float border_masking;
2348 * minimum MB lagrange multipler
2349 * - encoding: Set by user.
2350 * - decoding: unused
2355 * maximum MB lagrange multipler
2356 * - encoding: Set by user.
2357 * - decoding: unused
2363 * - encoding: Set by user.
2364 * - decoding: unused
2366 int me_penalty_compensation;
2370 * - encoding: unused
2371 * - decoding: Set by user.
2373 enum AVDiscard skip_loop_filter;
2377 * - encoding: unused
2378 * - decoding: Set by user.
2380 enum AVDiscard skip_idct;
2384 * - encoding: unused
2385 * - decoding: Set by user.
2387 enum AVDiscard skip_frame;
2391 * - encoding: Set by user.
2392 * - decoding: unused
2398 * - encoding: Set by user.
2399 * - decoding: unused
2403 #if FF_API_X264_GLOBAL_OPTS
2405 * constant rate factor - quality-based VBR - values ~correspond to qps
2406 * - encoding: Set by user.
2407 * - decoding: unused
2408 * @deprecated use 'crf' libx264 private option
2410 attribute_deprecated float crf;
2413 * constant quantization parameter rate control method
2414 * - encoding: Set by user.
2415 * - decoding: unused
2416 * @deprecated use 'cqp' libx264 private option
2418 attribute_deprecated int cqp;
2423 * - encoding: Set by user.
2424 * - decoding: unused
2429 * number of reference frames
2430 * - encoding: Set by user.
2431 * - decoding: Set by lavc.
2436 * chroma qp offset from luma
2437 * - encoding: Set by user.
2438 * - decoding: unused
2443 * Influences how often B-frames are used.
2444 * - encoding: Set by user.
2445 * - decoding: unused
2450 * trellis RD quantization
2451 * - encoding: Set by user.
2452 * - decoding: unused
2457 * Reduce fluctuations in qp (before curve compression).
2458 * - encoding: Set by user.
2459 * - decoding: unused
2461 float complexityblur;
2464 * in-loop deblocking filter alphac0 parameter
2465 * alpha is in the range -6...6
2466 * - encoding: Set by user.
2467 * - decoding: unused
2472 * in-loop deblocking filter beta parameter
2473 * beta is in the range -6...6
2474 * - encoding: Set by user.
2475 * - decoding: unused
2480 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2481 * - encoding: Set by user.
2482 * - decoding: unused
2485 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2486 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2487 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2488 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2489 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2492 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2493 * - encoding: Set by user.
2494 * - decoding: unused
2499 * Audio cutoff bandwidth (0 means "automatic")
2500 * - encoding: Set by user.
2501 * - decoding: unused
2506 * Multiplied by qscale for each frame and added to scene_change_score.
2507 * - encoding: Set by user.
2508 * - decoding: unused
2510 int scenechange_factor;
2514 * Note: Value depends upon the compare function used for fullpel ME.
2515 * - encoding: Set by user.
2516 * - decoding: unused
2521 * Adjusts sensitivity of b_frame_strategy 1.
2522 * - encoding: Set by user.
2523 * - decoding: unused
2528 * - encoding: Set by user.
2529 * - decoding: unused
2531 int compression_level;
2532 #define FF_COMPRESSION_DEFAULT -1
2535 * - encoding: Set by user.
2536 * - decoding: unused
2538 int min_prediction_order;
2541 * - encoding: Set by user.
2542 * - decoding: unused
2544 int max_prediction_order;
2546 #if FF_API_FLAC_GLOBAL_OPTS
2548 * @name FLAC options
2549 * @deprecated Use FLAC encoder private options instead.
2554 * LPC coefficient precision - used by FLAC encoder
2555 * - encoding: Set by user.
2556 * - decoding: unused
2558 attribute_deprecated int lpc_coeff_precision;
2561 * search method for selecting prediction order
2562 * - encoding: Set by user.
2563 * - decoding: unused
2565 attribute_deprecated int prediction_order_method;
2568 * - encoding: Set by user.
2569 * - decoding: unused
2571 attribute_deprecated int min_partition_order;
2574 * - encoding: Set by user.
2575 * - decoding: unused
2577 attribute_deprecated int max_partition_order;
2584 * GOP timecode frame start number, in non drop frame format
2585 * - encoding: Set by user.
2586 * - decoding: unused
2588 int64_t timecode_frame_start;
2590 #if FF_API_REQUEST_CHANNELS
2592 * Decoder should decode to this many channels if it can (0 for default)
2593 * - encoding: unused
2594 * - decoding: Set by user.
2595 * @deprecated Deprecated in favor of request_channel_layout.
2597 int request_channels;
2600 #if FF_API_DRC_SCALE
2602 * Percentage of dynamic range compression to be applied by the decoder.
2603 * The default value is 1.0, corresponding to full compression.
2604 * - encoding: unused
2605 * - decoding: Set by user.
2606 * @deprecated use AC3 decoder private option instead.
2608 attribute_deprecated float drc_scale;
2612 * opaque 64bit number (generally a PTS) that will be reordered and
2613 * output in AVFrame.reordered_opaque
2614 * @deprecated in favor of pkt_pts
2615 * - encoding: unused
2616 * - decoding: Set by user.
2618 int64_t reordered_opaque;
2621 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2622 * - encoding: set by user.
2623 * - decoding: set by libavcodec.
2625 int bits_per_raw_sample;
2628 * Audio channel layout.
2629 * - encoding: set by user.
2630 * - decoding: set by libavcodec.
2632 int64_t channel_layout;
2635 * Request decoder to use this channel layout if it can (0 for default)
2636 * - encoding: unused
2637 * - decoding: Set by user.
2639 int64_t request_channel_layout;
2642 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2643 * - encoding: Set by user.
2644 * - decoding: unused.
2646 float rc_max_available_vbv_use;
2649 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2650 * - encoding: Set by user.
2651 * - decoding: unused.
2653 float rc_min_vbv_overflow_use;
2656 * Hardware accelerator in use
2657 * - encoding: unused.
2658 * - decoding: Set by libavcodec
2660 struct AVHWAccel *hwaccel;
2663 * For some codecs, the time base is closer to the field rate than the frame rate.
2664 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2665 * if no telecine is used ...
2667 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2669 int ticks_per_frame;
2672 * Hardware accelerator context.
2673 * For some hardware accelerators, a global context needs to be
2674 * provided by the user. In that case, this holds display-dependent
2675 * data Libav cannot instantiate itself. Please refer to the
2676 * Libav HW accelerator documentation to know how to fill this
2677 * is. e.g. for VA API, this is a struct vaapi_context.
2678 * - encoding: unused
2679 * - decoding: Set by user
2681 void *hwaccel_context;
2684 * Chromaticity coordinates of the source primaries.
2685 * - encoding: Set by user
2686 * - decoding: Set by libavcodec
2688 enum AVColorPrimaries color_primaries;
2691 * Color Transfer Characteristic.
2692 * - encoding: Set by user
2693 * - decoding: Set by libavcodec
2695 enum AVColorTransferCharacteristic color_trc;
2698 * YUV colorspace type.
2699 * - encoding: Set by user
2700 * - decoding: Set by libavcodec
2702 enum AVColorSpace colorspace;
2705 * MPEG vs JPEG YUV range.
2706 * - encoding: Set by user
2707 * - decoding: Set by libavcodec
2709 enum AVColorRange color_range;
2712 * This defines the location of chroma samples.
2713 * - encoding: Set by user
2714 * - decoding: Set by libavcodec
2716 enum AVChromaLocation chroma_sample_location;
2719 * The codec may call this to execute several independent things.
2720 * It will return only after finishing all tasks.
2721 * The user may replace this with some multithreaded implementation,
2722 * the default implementation will execute the parts serially.
2723 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2724 * @param c context passed also to func
2725 * @param count the number of things to execute
2726 * @param arg2 argument passed unchanged to func
2727 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2728 * @param func function that will be called count times, with jobnr from 0 to count-1.
2729 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2730 * two instances of func executing at the same time will have the same threadnr.
2731 * @return always 0 currently, but code should handle a future improvement where when any call to func
2732 * returns < 0 no further calls to func may be done and < 0 is returned.
2733 * - encoding: Set by libavcodec, user can override.
2734 * - decoding: Set by libavcodec, user can override.
2736 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2738 #if FF_API_X264_GLOBAL_OPTS
2740 * explicit P-frame weighted prediction analysis method
2742 * 1: fast blind weighting (one reference duplicate with -1 offset)
2743 * 2: smart weighting (full fade detection analysis)
2744 * - encoding: Set by user.
2745 * - decoding: unused
2747 attribute_deprecated int weighted_p_pred;
2752 * 1: Variance AQ (complexity mask)
2753 * 2: Auto-variance AQ (experimental)
2754 * - encoding: Set by user
2755 * - decoding: unused
2757 attribute_deprecated int aq_mode;
2761 * Reduces blocking and blurring in flat and textured areas.
2762 * - encoding: Set by user
2763 * - decoding: unused
2765 attribute_deprecated float aq_strength;
2769 * Strength of psychovisual optimization
2770 * - encoding: Set by user
2771 * - decoding: unused
2773 attribute_deprecated float psy_rd;
2777 * Strength of psychovisual optimization
2778 * - encoding: Set by user
2779 * - decoding: unused
2781 attribute_deprecated float psy_trellis;
2785 * Number of frames for frametype and ratecontrol lookahead
2786 * - encoding: Set by user
2787 * - decoding: unused
2789 attribute_deprecated int rc_lookahead;
2792 * Constant rate factor maximum
2793 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2794 * than crf_max, even if doing so would violate VBV restrictions.
2795 * - encoding: Set by user.
2796 * - decoding: unused
2798 attribute_deprecated float crf_max;
2801 int log_level_offset;
2803 #if FF_API_FLAC_GLOBAL_OPTS
2805 * Determines which LPC analysis algorithm to use.
2806 * - encoding: Set by user
2807 * - decoding: unused
2809 attribute_deprecated enum AVLPCType lpc_type;
2812 * Number of passes to use for Cholesky factorization during LPC analysis
2813 * - encoding: Set by user
2814 * - decoding: unused
2816 attribute_deprecated int lpc_passes;
2821 * Indicates number of picture subdivisions. Used for parallelized
2823 * - encoding: Set by user
2824 * - decoding: unused
2829 * Header containing style information for text subtitles.
2830 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2831 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2832 * the Format line following. It shouldn't include any Dialogue line.
2833 * - encoding: Set/allocated/freed by user (before avcodec_open())
2834 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2836 uint8_t *subtitle_header;
2837 int subtitle_header_size;
2840 * Current packet as passed into the decoder, to avoid having
2841 * to pass the packet into every function. Currently only valid
2842 * inside lavc and get/release_buffer callbacks.
2843 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2844 * - encoding: unused
2849 * Whether this is a copy of the context which had init() called on it.
2850 * This is used by multithreading - shared tables and picture pointers
2851 * should be freed from the original context only.
2852 * - encoding: Set by libavcodec.
2853 * - decoding: Set by libavcodec.
2858 * Which multithreading methods to use.
2859 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2860 * so clients which cannot provide future frames should not use it.
2862 * - encoding: Set by user, otherwise the default is used.
2863 * - decoding: Set by user, otherwise the default is used.
2866 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2867 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2870 * Which multithreading methods are in use by the codec.
2871 * - encoding: Set by libavcodec.
2872 * - decoding: Set by libavcodec.
2874 int active_thread_type;
2877 * Set by the client if its custom get_buffer() callback can be called
2878 * from another thread, which allows faster multithreaded decoding.
2879 * draw_horiz_band() will be called from other threads regardless of this setting.
2880 * Ignored if the default get_buffer() is used.
2881 * - encoding: Set by user.
2882 * - decoding: Set by user.
2884 int thread_safe_callbacks;
2887 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2888 * Used for compliant TS muxing.
2889 * - encoding: Set by libavcodec.
2890 * - decoding: unused.
2895 * Type of service that the audio stream conveys.
2896 * - encoding: Set by user.
2897 * - decoding: Set by libavcodec.
2899 enum AVAudioServiceType audio_service_type;
2902 * Used to request a sample format from the decoder.
2903 * - encoding: unused.
2904 * - decoding: Set by user.
2906 enum AVSampleFormat request_sample_fmt;
2912 typedef struct AVProfile {
2914 const char *name; ///< short name for the profile
2917 typedef struct AVCodecDefault AVCodecDefault;
2922 typedef struct AVCodec {
2924 * Name of the codec implementation.
2925 * The name is globally unique among encoders and among decoders (but an
2926 * encoder and a decoder can share the same name).
2927 * This is the primary way to find a codec from the user perspective.
2930 enum AVMediaType type;
2933 int (*init)(AVCodecContext *);
2934 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2935 int (*close)(AVCodecContext *);
2936 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2938 * Codec capabilities.
2942 struct AVCodec *next;
2945 * Will be called when seeking
2947 void (*flush)(AVCodecContext *);
2948 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2949 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2951 * Descriptive name for the codec, meant to be more human readable than name.
2952 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2954 const char *long_name;
2955 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2956 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2957 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2958 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2959 const AVClass *priv_class; ///< AVClass for the private context
2960 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2963 * @name Frame-level threading support functions
2967 * If defined, called on thread contexts when they are created.
2968 * If the codec allocates writable tables in init(), re-allocate them here.
2969 * priv_data will be set to a copy of the original.
2971 int (*init_thread_copy)(AVCodecContext *);
2973 * Copy necessary context variables from a previous thread context to the current one.
2974 * If not defined, the next thread will start automatically; otherwise, the codec
2975 * must call ff_thread_finish_setup().
2977 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2979 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2983 * Private codec-specific defaults.
2985 const AVCodecDefault *defaults;
2991 typedef struct AVHWAccel {
2993 * Name of the hardware accelerated codec.
2994 * The name is globally unique among encoders and among decoders (but an
2995 * encoder and a decoder can share the same name).
3000 * Type of codec implemented by the hardware accelerator.
3002 * See AVMEDIA_TYPE_xxx
3004 enum AVMediaType type;
3007 * Codec implemented by the hardware accelerator.
3014 * Supported pixel format.
3016 * Only hardware accelerated formats are supported here.
3018 enum PixelFormat pix_fmt;
3021 * Hardware accelerated codec capabilities.
3022 * see FF_HWACCEL_CODEC_CAP_*
3026 struct AVHWAccel *next;
3029 * Called at the beginning of each frame or field picture.
3031 * Meaningful frame information (codec specific) is guaranteed to
3032 * be parsed at this point. This function is mandatory.
3034 * Note that buf can be NULL along with buf_size set to 0.
3035 * Otherwise, this means the whole frame is available at this point.
3037 * @param avctx the codec context
3038 * @param buf the frame data buffer base
3039 * @param buf_size the size of the frame in bytes
3040 * @return zero if successful, a negative value otherwise
3042 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3045 * Callback for each slice.
3047 * Meaningful slice information (codec specific) is guaranteed to
3048 * be parsed at this point. This function is mandatory.
3050 * @param avctx the codec context
3051 * @param buf the slice data buffer base
3052 * @param buf_size the size of the slice in bytes
3053 * @return zero if successful, a negative value otherwise
3055 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3058 * Called at the end of each frame or field picture.
3060 * The whole picture is parsed at this point and can now be sent
3061 * to the hardware accelerator. This function is mandatory.
3063 * @param avctx the codec context
3064 * @return zero if successful, a negative value otherwise
3066 int (*end_frame)(AVCodecContext *avctx);
3069 * Size of HW accelerator private data.
3071 * Private data is allocated with av_mallocz() before
3072 * AVCodecContext.get_buffer() and deallocated after
3073 * AVCodecContext.release_buffer().
3079 * four components are given, that's all.
3080 * the last component is alpha
3082 typedef struct AVPicture {
3084 int linesize[4]; ///< number of bytes per line
3087 #if FF_API_PALETTE_CONTROL
3090 * This structure defines a method for communicating palette changes
3091 * between and demuxer and a decoder.
3093 * @deprecated Use AVPacket to send palette changes instead.
3094 * This is totally broken.
3096 #define AVPALETTE_SIZE 1024
3097 #define AVPALETTE_COUNT 256
3098 typedef struct AVPaletteControl {
3100 /* Demuxer sets this to 1 to indicate the palette has changed;
3101 * decoder resets to 0. */
3102 int palette_changed;
3104 /* 4-byte ARGB palette entries, stored in native byte order; note that
3105 * the individual palette components should be on a 8-bit scale; if
3106 * the palette data comes from an IBM VGA native format, the component
3107 * data is probably 6 bits in size and needs to be scaled. */
3108 unsigned int palette[AVPALETTE_COUNT];
3110 } AVPaletteControl attribute_deprecated;
3113 enum AVSubtitleType {
3116 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3119 * Plain text, the text field must be set by the decoder and is
3120 * authoritative. ass and pict fields may contain approximations.
3125 * Formatted text, the ass field must be set by the decoder and is
3126 * authoritative. pict and text fields may contain approximations.
3131 typedef struct AVSubtitleRect {
3132 int x; ///< top left corner of pict, undefined when pict is not set
3133 int y; ///< top left corner of pict, undefined when pict is not set
3134 int w; ///< width of pict, undefined when pict is not set
3135 int h; ///< height of pict, undefined when pict is not set
3136 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3139 * data+linesize for the bitmap of this subtitle.
3140 * can be set for text/ass as well once they where rendered
3143 enum AVSubtitleType type;
3145 char *text; ///< 0 terminated plain UTF-8 text
3148 * 0 terminated ASS/SSA compatible event line.
3149 * The pressentation of this is unaffected by the other values in this
3155 typedef struct AVSubtitle {
3156 uint16_t format; /* 0 = graphics */
3157 uint32_t start_display_time; /* relative to packet pts, in ms */
3158 uint32_t end_display_time; /* relative to packet pts, in ms */
3160 AVSubtitleRect **rects;
3161 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3164 /* packet functions */
3167 * @deprecated use NULL instead
3169 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3172 * Default packet destructor.
3174 void av_destruct_packet(AVPacket *pkt);
3177 * Initialize optional fields of a packet with default values.
3181 void av_init_packet(AVPacket *pkt);
3184 * Allocate the payload of a packet and initialize its fields with
3188 * @param size wanted payload size
3189 * @return 0 if OK, AVERROR_xxx otherwise
3191 int av_new_packet(AVPacket *pkt, int size);
3194 * Reduce packet size, correctly zeroing padding
3197 * @param size new size
3199 void av_shrink_packet(AVPacket *pkt, int size);
3202 * Increase packet size, correctly zeroing padding
3205 * @param grow_by number of bytes by which to increase the size of the packet
3207 int av_grow_packet(AVPacket *pkt, int grow_by);
3210 * @warning This is a hack - the packet memory allocation stuff is broken. The
3211 * packet is allocated if it was not really allocated.
3213 int av_dup_packet(AVPacket *pkt);
3218 * @param pkt packet to free
3220 void av_free_packet(AVPacket *pkt);
3223 * Allocate new information of a packet.
3226 * @param type side information type
3227 * @param size side information size
3228 * @return pointer to fresh allocated data or NULL otherwise
3230 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3234 * Get side information from packet.
3237 * @param type desired side information type
3238 * @param size pointer for side information size to store (optional)
3239 * @return pointer to data if present or NULL otherwise
3241 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3246 struct ReSampleContext;
3247 struct AVResampleContext;
3249 typedef struct ReSampleContext ReSampleContext;
3252 * Initialize audio resampling context.
3254 * @param output_channels number of output channels
3255 * @param input_channels number of input channels
3256 * @param output_rate output sample rate
3257 * @param input_rate input sample rate
3258 * @param sample_fmt_out requested output sample format
3259 * @param sample_fmt_in input sample format
3260 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3261 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3262 * @param linear if 1 then the used FIR filter will be linearly interpolated
3263 between the 2 closest, if 0 the closest will be used
3264 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3265 * @return allocated ReSampleContext, NULL if error occured
3267 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3268 int output_rate, int input_rate,
3269 enum AVSampleFormat sample_fmt_out,
3270 enum AVSampleFormat sample_fmt_in,
3271 int filter_length, int log2_phase_count,
3272 int linear, double cutoff);
3274 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3277 * Free resample context.
3279 * @param s a non-NULL pointer to a resample context previously
3280 * created with av_audio_resample_init()
3282 void audio_resample_close(ReSampleContext *s);
3286 * Initialize an audio resampler.
3287 * Note, if either rate is not an integer then simply scale both rates up so they are.
3288 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3289 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3290 * @param linear If 1 then the used FIR filter will be linearly interpolated
3291 between the 2 closest, if 0 the closest will be used
3292 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3294 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3297 * Resample an array of samples using a previously configured context.
3298 * @param src an array of unconsumed samples
3299 * @param consumed the number of samples of src which have been consumed are returned here
3300 * @param src_size the number of unconsumed samples available
3301 * @param dst_size the amount of space in samples available in dst
3302 * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
3303 * @return the number of samples written in dst or -1 if an error occurred
3305 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3309 * Compensate samplerate/timestamp drift. The compensation is done by changing
3310 * the resampler parameters, so no audible clicks or similar distortions occur
3311 * @param compensation_distance distance in output samples over which the compensation should be performed
3312 * @param sample_delta number of output samples which should be output less
3314 * example: av_resample_compensate(c, 10, 500)
3315 * here instead of 510 samples only 500 samples would be output
3317 * note, due to rounding the actual compensation might be slightly different,
3318 * especially if the compensation_distance is large and the in_rate used during init is small
3320 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3321 void av_resample_close(struct AVResampleContext *c);
3324 * Allocate memory for a picture. Call avpicture_free() to free it.
3326 * @see avpicture_fill()
3328 * @param picture the picture to be filled in
3329 * @param pix_fmt the format of the picture
3330 * @param width the width of the picture
3331 * @param height the height of the picture
3332 * @return zero if successful, a negative value if not
3334 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3337 * Free a picture previously allocated by avpicture_alloc().
3338 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3341 * @param picture the AVPicture to be freed
3343 void avpicture_free(AVPicture *picture);
3346 * Fill in the AVPicture fields.
3347 * The fields of the given AVPicture are filled in by using the 'ptr' address
3348 * which points to the image data buffer. Depending on the specified picture
3349 * format, one or multiple image data pointers and line sizes will be set.
3350 * If a planar format is specified, several pointers will be set pointing to
3351 * the different picture planes and the line sizes of the different planes
3352 * will be stored in the lines_sizes array.
3353 * Call with ptr == NULL to get the required size for the ptr buffer.
3355 * To allocate the buffer and fill in the AVPicture fields in one call,
3356 * use avpicture_alloc().
3358 * @param picture AVPicture whose fields are to be filled in
3359 * @param ptr Buffer which will contain or contains the actual image data
3360 * @param pix_fmt The format in which the picture data is stored.
3361 * @param width the width of the image in pixels
3362 * @param height the height of the image in pixels
3363 * @return size of the image data in bytes
3365 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3366 enum PixelFormat pix_fmt, int width, int height);
3369 * Copy pixel data from an AVPicture into a buffer.
3370 * The data is stored compactly, without any gaps for alignment or padding
3371 * which may be applied by avpicture_fill().
3373 * @see avpicture_get_size()
3375 * @param[in] src AVPicture containing image data
3376 * @param[in] pix_fmt The format in which the picture data is stored.
3377 * @param[in] width the width of the image in pixels.
3378 * @param[in] height the height of the image in pixels.
3379 * @param[out] dest A buffer into which picture data will be copied.
3380 * @param[in] dest_size The size of 'dest'.
3381 * @return The number of bytes written to dest, or a negative value (error code) on error.
3383 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3384 unsigned char *dest, int dest_size);
3387 * Calculate the size in bytes that a picture of the given width and height
3388 * would occupy if stored in the given picture format.
3389 * Note that this returns the size of a compact representation as generated
3390 * by avpicture_layout(), which can be smaller than the size required for e.g.
3393 * @param pix_fmt the given picture format
3394 * @param width the width of the image
3395 * @param height the height of the image
3396 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3398 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3399 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3401 #if FF_API_GET_PIX_FMT_NAME
3403 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3405 attribute_deprecated
3406 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3409 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3412 * Return a value representing the fourCC code associated to the
3413 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3416 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3419 * Put a string representing the codec tag codec_tag in buf.
3421 * @param buf_size size in bytes of buf
3422 * @return the length of the string that would have been generated if
3423 * enough space had been available, excluding the trailing null
3425 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3427 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3428 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3429 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3430 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3431 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3432 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3435 * Compute what kind of losses will occur when converting from one specific
3436 * pixel format to another.
3437 * When converting from one pixel format to another, information loss may occur.
3438 * For example, when converting from RGB24 to GRAY, the color information will
3439 * be lost. Similarly, other losses occur when converting from some formats to
3440 * other formats. These losses can involve loss of chroma, but also loss of
3441 * resolution, loss of color depth, loss due to the color space conversion, loss
3442 * of the alpha bits or loss due to color quantization.
3443 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3444 * which will occur when converting from one pixel format to another.
3446 * @param[in] dst_pix_fmt destination pixel format
3447 * @param[in] src_pix_fmt source pixel format
3448 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3449 * @return Combination of flags informing you what kind of losses will occur.
3451 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3455 * Find the best pixel format to convert to given a certain source pixel
3456 * format. When converting from one pixel format to another, information loss
3457 * may occur. For example, when converting from RGB24 to GRAY, the color
3458 * information will be lost. Similarly, other losses occur when converting from
3459 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3460 * the given pixel formats should be used to suffer the least amount of loss.
3461 * The pixel formats from which it chooses one, are determined by the
3462 * pix_fmt_mask parameter.
3465 * src_pix_fmt = PIX_FMT_YUV420P;
3466 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3467 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3470 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3471 * @param[in] src_pix_fmt source pixel format
3472 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3473 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3474 * @return The best pixel format to convert to or -1 if none was found.
3476 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3477 int has_alpha, int *loss_ptr);
3479 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3480 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3483 * Tell if an image really has transparent alpha values.
3484 * @return ored mask of FF_ALPHA_xxx constants
3486 int img_get_alpha_info(const AVPicture *src,
3487 enum PixelFormat pix_fmt, int width, int height);
3489 /* deinterlace a picture */
3490 /* deinterlace - if not supported return -1 */
3491 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3492 enum PixelFormat pix_fmt, int width, int height);
3494 /* external high level API */
3497 * If c is NULL, returns the first registered codec,
3498 * if c is non-NULL, returns the next registered codec after c,
3499 * or NULL if c is the last one.
3501 AVCodec *av_codec_next(AVCodec *c);
3504 * Return the LIBAVCODEC_VERSION_INT constant.
3506 unsigned avcodec_version(void);
3509 * Return the libavcodec build-time configuration.
3511 const char *avcodec_configuration(void);
3514 * Return the libavcodec license.
3516 const char *avcodec_license(void);
3518 #if FF_API_AVCODEC_INIT
3520 * @deprecated this function is called automatically from avcodec_register()
3521 * and avcodec_register_all(), there is no need to call it manually
3523 attribute_deprecated
3524 void avcodec_init(void);
3528 * Register the codec codec and initialize libavcodec.
3530 * @warning either this function or avcodec_register_all() must be called
3531 * before any other libavcodec functions.
3533 * @see avcodec_register_all()
3535 void avcodec_register(AVCodec *codec);
3538 * Find a registered encoder with a matching codec ID.
3540 * @param id CodecID of the requested encoder
3541 * @return An encoder if one was found, NULL otherwise.
3543 AVCodec *avcodec_find_encoder(enum CodecID id);
3546 * Find a registered encoder with the specified name.
3548 * @param name name of the requested encoder
3549 * @return An encoder if one was found, NULL otherwise.
3551 AVCodec *avcodec_find_encoder_by_name(const char *name);
3554 * Find a registered decoder with a matching codec ID.
3556 * @param id CodecID of the requested decoder
3557 * @return A decoder if one was found, NULL otherwise.
3559 AVCodec *avcodec_find_decoder(enum CodecID id);
3562 * Find a registered decoder with the specified name.
3564 * @param name name of the requested decoder
3565 * @return A decoder if one was found, NULL otherwise.
3567 AVCodec *avcodec_find_decoder_by_name(const char *name);
3568 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3571 * Return a name for the specified profile, if available.
3573 * @param codec the codec that is searched for the given profile
3574 * @param profile the profile value for which a name is requested
3575 * @return A name for the profile if found, NULL otherwise.
3577 const char *av_get_profile_name(const AVCodec *codec, int profile);
3580 * Set the fields of the given AVCodecContext to default values.
3582 * @param s The AVCodecContext of which the fields should be set to default values.
3584 void avcodec_get_context_defaults(AVCodecContext *s);
3586 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3587 * we WILL change its arguments and name a few times! */
3588 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3590 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3591 * we WILL change its arguments and name a few times! */
3592 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3594 #if FF_API_ALLOC_CONTEXT
3596 * Allocate an AVCodecContext and set its fields to default values. The
3597 * resulting struct can be deallocated by simply calling av_free().
3599 * @return An AVCodecContext filled with default values or NULL on failure.
3600 * @see avcodec_get_context_defaults
3602 * @deprecated use avcodec_alloc_context3()
3604 attribute_deprecated
3605 AVCodecContext *avcodec_alloc_context(void);
3607 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3608 * we WILL change its arguments and name a few times! */
3609 attribute_deprecated
3610 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3614 * Allocate an AVCodecContext and set its fields to default values. The
3615 * resulting struct can be deallocated by simply calling av_free().
3617 * @param codec if non-NULL, allocate private data and initialize defaults
3618 * for the given codec. It is illegal to then call avcodec_open()
3619 * with a different codec.
3621 * @return An AVCodecContext filled with default values or NULL on failure.
3622 * @see avcodec_get_context_defaults
3624 * @deprecated use avcodec_alloc_context3()
3626 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3629 * Copy the settings of the source AVCodecContext into the destination
3630 * AVCodecContext. The resulting destination codec context will be
3631 * unopened, i.e. you are required to call avcodec_open() before you
3632 * can use this AVCodecContext to decode/encode video/audio data.
3634 * @param dest target codec context, should be initialized with
3635 * avcodec_alloc_context3(), but otherwise uninitialized
3636 * @param src source codec context
3637 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3639 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3642 * Set the fields of the given AVFrame to default values.
3644 * @param pic The AVFrame of which the fields should be set to default values.
3646 void avcodec_get_frame_defaults(AVFrame *pic);
3649 * Allocate an AVFrame and set its fields to default values. The resulting
3650 * struct can be deallocated by simply calling av_free().
3652 * @return An AVFrame filled with default values or NULL on failure.
3653 * @see avcodec_get_frame_defaults
3655 AVFrame *avcodec_alloc_frame(void);
3657 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3658 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3659 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3662 * Return the amount of padding in pixels which the get_buffer callback must
3663 * provide around the edge of the image for codecs which do not have the
3664 * CODEC_FLAG_EMU_EDGE flag.
3666 * @return Required padding in pixels.
3668 unsigned avcodec_get_edge_width(void);
3670 * Modify width and height values so that they will result in a memory
3671 * buffer that is acceptable for the codec if you do not use any horizontal
3674 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3675 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3676 * according to avcodec_get_edge_width() before.
3678 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3680 * Modify width and height values so that they will result in a memory
3681 * buffer that is acceptable for the codec if you also ensure that all
3682 * line sizes are a multiple of the respective linesize_align[i].
3684 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3685 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3686 * according to avcodec_get_edge_width() before.
3688 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3689 int linesize_align[4]);
3691 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3693 #if FF_API_THREAD_INIT
3695 * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3697 attribute_deprecated
3698 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3701 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3702 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3703 //FIXME func typedef
3705 #if FF_API_AVCODEC_OPEN
3707 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3708 * function the context has to be allocated.
3710 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3711 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3712 * retrieving a codec.
3714 * @warning This function is not thread safe!
3717 * avcodec_register_all();
3718 * codec = avcodec_find_decoder(CODEC_ID_H264);
3722 * context = avcodec_alloc_context3(codec);
3724 * if (avcodec_open(context, codec) < 0)
3728 * @param avctx The context which will be set up to use the given codec.
3729 * @param codec The codec to use within the context.
3730 * @return zero on success, a negative value on error
3731 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3733 * @deprecated use avcodec_open2
3735 attribute_deprecated
3736 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3740 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3741 * function the context has to be allocated with avcodec_alloc_context().
3743 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3744 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3745 * retrieving a codec.
3747 * @warning This function is not thread safe!
3750 * avcodec_register_all();
3751 * av_dict_set(&opts, "b", "2.5M", 0);
3752 * codec = avcodec_find_decoder(CODEC_ID_H264);
3756 * context = avcodec_alloc_context();
3758 * if (avcodec_open(context, codec, opts) < 0)
3762 * @param avctx The context to initialize.
3763 * @param options A dictionary filled with AVCodecContext and codec-private options.
3764 * On return this object will be filled with options that were not found.
3766 * @return zero on success, a negative value on error
3767 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3768 * av_dict_set(), av_opt_find().
3770 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3773 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3774 * Some decoders may support multiple frames in a single AVPacket, such
3775 * decoders would then just decode the first frame. In this case,
3776 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3777 * the remaining data in order to decode the second frame etc.
3779 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3780 * decompressed frame size in bytes.
3782 * @warning You must set frame_size_ptr to the allocated size of the
3783 * output buffer before calling avcodec_decode_audio3().
3785 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3786 * the actual read bytes because some optimized bitstream readers read 32 or 64
3787 * bits at once and could read over the end.
3789 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3790 * no overreading happens for damaged MPEG streams.
3792 * @note You might have to align the input buffer avpkt->data and output buffer
3793 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3794 * necessary at all, on others it won't work at all if not aligned and on others
3795 * it will work but it will have an impact on performance.
3797 * In practice, avpkt->data should have 4 byte alignment at minimum and
3798 * samples should be 16 byte aligned unless the CPU doesn't need it
3799 * (AltiVec and SSE do).
3801 * @param avctx the codec context
3802 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3803 * @param[in,out] frame_size_ptr the output buffer size in bytes
3804 * @param[in] avpkt The input AVPacket containing the input buffer.
3805 * You can create such packet with av_init_packet() and by then setting
3806 * data and size, some decoders might in addition need other fields.
3807 * All decoders are designed to use the least fields possible though.
3808 * @return On error a negative value is returned, otherwise the number of bytes
3809 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3811 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3812 int *frame_size_ptr,
3816 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3817 * Some decoders may support multiple frames in a single AVPacket, such
3818 * decoders would then just decode the first frame.
3820 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3821 * the actual read bytes because some optimized bitstream readers read 32 or 64
3822 * bits at once and could read over the end.
3824 * @warning The end of the input buffer buf should be set to 0 to ensure that