2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin 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"
40 * @defgroup libavc Encoding/Decoding Library
43 * @defgroup lavc_decoding Decoding
47 * @defgroup lavc_encoding Encoding
51 * @defgroup lavc_codec Codecs
53 * @defgroup lavc_codec_native Native Codecs
56 * @defgroup lavc_codec_wrappers External library wrappers
59 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
63 * @defgroup lavc_internal Internal
72 * Identify the syntax and semantics of the bitstream.
73 * The principle is roughly:
74 * Two decoders with the same ID can decode the same streams.
75 * Two encoders with the same ID can encode compatible streams.
76 * There may be slight deviations from the principle due to implementation
79 * If you add a codec ID to this list, add it so that
80 * 1. no value of a existing codec ID changes (that would break ABI),
81 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
82 * This ensures that 2 forks can independantly add CodecIDs without producing conflicts.
89 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
90 CODEC_ID_MPEG2VIDEO_XVMC,
127 CODEC_ID_INTERPLAY_VIDEO,
139 CODEC_ID_TRUEMOTION1,
166 CODEC_ID_TRUEMOTION2,
183 CODEC_ID_DSICINVIDEO,
184 CODEC_ID_TIERTEXSEQVIDEO,
187 #if LIBAVCODEC_VERSION_MAJOR == 53
195 CODEC_ID_BETHSOFTVID,
207 #if LIBAVCODEC_VERSION_MAJOR == 53
215 CODEC_ID_MOTIONPIXELS,
233 CODEC_ID_IFF_BYTERUN1,
249 #if LIBAVCODEC_VERSION_MAJOR == 53
250 CODEC_ID_G723_1_DEPRECATED,
251 CODEC_ID_G729_DEPRECATED,
253 CODEC_ID_UTVIDEO_DEPRECATED,
259 CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
260 CODEC_ID_UTVIDEO = 0x800,
261 CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
262 CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
264 CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
265 CODEC_ID_V308 = MKBETAG('V','3','0','8'),
266 CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
268 /* various PCM "codecs" */
269 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
270 CODEC_ID_PCM_S16LE = 0x10000,
286 CODEC_ID_PCM_S24DAUD,
288 CODEC_ID_PCM_S16LE_PLANAR,
297 CODEC_ID_PCM_S8_PLANAR,
299 /* various ADPCM codecs */
300 CODEC_ID_ADPCM_IMA_QT = 0x11000,
301 CODEC_ID_ADPCM_IMA_WAV,
302 CODEC_ID_ADPCM_IMA_DK3,
303 CODEC_ID_ADPCM_IMA_DK4,
304 CODEC_ID_ADPCM_IMA_WS,
305 CODEC_ID_ADPCM_IMA_SMJPEG,
314 CODEC_ID_ADPCM_YAMAHA,
315 CODEC_ID_ADPCM_SBPRO_4,
316 CODEC_ID_ADPCM_SBPRO_3,
317 CODEC_ID_ADPCM_SBPRO_2,
319 CODEC_ID_ADPCM_IMA_AMV,
320 CODEC_ID_ADPCM_EA_R1,
321 CODEC_ID_ADPCM_EA_R3,
322 CODEC_ID_ADPCM_EA_R2,
323 CODEC_ID_ADPCM_IMA_EA_SEAD,
324 CODEC_ID_ADPCM_IMA_EA_EACS,
325 CODEC_ID_ADPCM_EA_XAS,
326 CODEC_ID_ADPCM_EA_MAXIS_XA,
327 CODEC_ID_ADPCM_IMA_ISS,
329 CODEC_ID_ADPCM_IMA_APC,
332 CODEC_ID_AMR_NB = 0x12000,
335 /* RealAudio codecs*/
336 CODEC_ID_RA_144 = 0x13000,
339 /* various DPCM codecs */
340 CODEC_ID_ROQ_DPCM = 0x14000,
341 CODEC_ID_INTERPLAY_DPCM,
346 CODEC_ID_MP2 = 0x15000,
347 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
358 #if LIBAVCODEC_VERSION_MAJOR == 53
367 CODEC_ID_WESTWOOD_SND1,
368 CODEC_ID_GSM, ///< as in Berlin toast format
376 CODEC_ID_DSICINAUDIO,
380 CODEC_ID_GSM_MS, /* as found in WAV */
389 CODEC_ID_WMALOSSLESS,
398 CODEC_ID_BINKAUDIO_RDFT,
399 CODEC_ID_BINKAUDIO_DCT,
403 #if LIBAVCODEC_VERSION_MAJOR > 53
404 CODEC_ID_G723_1_DEPRECATED,
405 CODEC_ID_G729_DEPRECATED,
410 CODEC_ID_G729 = 0x15800,
411 CODEC_ID_G723_1= 0x15801,
412 CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
413 CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
415 /* subtitle codecs */
416 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
417 CODEC_ID_DVD_SUBTITLE = 0x17000,
418 CODEC_ID_DVB_SUBTITLE,
419 CODEC_ID_TEXT, ///< raw UTF-8 text
423 CODEC_ID_HDMV_PGS_SUBTITLE,
424 CODEC_ID_DVB_TELETEXT,
426 CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
428 /* other specific kind of codecs (generally used for attachments) */
429 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
430 CODEC_ID_TTF = 0x18000,
431 CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
432 CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
433 CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
435 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
437 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
438 * stream (only used by libavformat) */
439 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
440 * stream (only used by libavformat) */
441 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
444 #if FF_API_OLD_SAMPLE_FMT
445 #define SampleFormat AVSampleFormat
447 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
448 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
449 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
450 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
451 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
452 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
453 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
456 #if FF_API_OLD_AUDIOCONVERT
457 #include "libavutil/audioconvert.h"
459 /* Audio channel masks */
460 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
461 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
462 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
463 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
464 #define CH_BACK_LEFT AV_CH_BACK_LEFT
465 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
466 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
467 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
468 #define CH_BACK_CENTER AV_CH_BACK_CENTER
469 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
470 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
471 #define CH_TOP_CENTER AV_CH_TOP_CENTER
472 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
473 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
474 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
475 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
476 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
477 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
478 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
479 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
481 /** Channel mask value used for AVCodecContext.request_channel_layout
482 to indicate that the user requests the channel order of the decoder output
483 to be the native codec channel order. */
484 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
486 /* Audio channel convenience macros */
487 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
488 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
489 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
490 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
491 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
492 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
493 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
494 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
495 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
496 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
497 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
498 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
499 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
500 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
501 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
504 #if FF_API_OLD_DECODE_AUDIO
506 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
510 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
511 * This is mainly needed because some optimized bitstream readers read
512 * 32 or 64 bit at once and could read over the end.<br>
513 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
514 * MPEG bitstreams could cause overread and segfault.
516 #define FF_INPUT_BUFFER_PADDING_SIZE 16
519 * minimum encoding buffer size
520 * Used to avoid some checks during header writing.
522 #define FF_MIN_BUFFER_SIZE 16384
526 * motion estimation type.
529 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
533 ME_EPZS, ///< enhanced predictive zonal search
534 ME_X1, ///< reserved for experiments
535 ME_HEX, ///< hexagon based search
536 ME_UMH, ///< uneven multi-hexagon search
537 ME_ITER, ///< iterative search
538 ME_TESA, ///< transformed exhaustive search algorithm
542 /* We leave some space between them for extensions (drop some
543 * keyframes for intra-only or drop just some bidir frames). */
544 AVDISCARD_NONE =-16, ///< discard nothing
545 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
546 AVDISCARD_NONREF = 8, ///< discard all non reference
547 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
548 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
549 AVDISCARD_ALL = 48, ///< discard all
552 enum AVColorPrimaries{
553 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
554 AVCOL_PRI_UNSPECIFIED=2,
556 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
557 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
558 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
560 AVCOL_PRI_NB , ///< Not part of ABI
563 enum AVColorTransferCharacteristic{
564 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
565 AVCOL_TRC_UNSPECIFIED=2,
566 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
567 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
568 AVCOL_TRC_SMPTE240M =7,
569 AVCOL_TRC_NB , ///< Not part of ABI
574 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
575 AVCOL_SPC_UNSPECIFIED=2,
577 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
578 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
579 AVCOL_SPC_SMPTE240M =7,
581 AVCOL_SPC_NB , ///< Not part of ABI
585 AVCOL_RANGE_UNSPECIFIED=0,
586 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
587 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
588 AVCOL_RANGE_NB , ///< Not part of ABI
592 * X X 3 4 X X are luma samples,
593 * 1 2 1-6 are possible chroma positions
594 * X X 5 6 X 0 is undefined/unknown position
596 enum AVChromaLocation{
597 AVCHROMA_LOC_UNSPECIFIED=0,
598 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
599 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
600 AVCHROMA_LOC_TOPLEFT =3, ///< DV
602 AVCHROMA_LOC_BOTTOMLEFT =5,
603 AVCHROMA_LOC_BOTTOM =6,
604 AVCHROMA_LOC_NB , ///< Not part of ABI
607 #if FF_API_FLAC_GLOBAL_OPTS
612 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
613 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
614 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
615 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
616 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
617 AV_LPC_TYPE_NB , ///< Not part of ABI
621 enum AVAudioServiceType {
622 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
623 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
624 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
625 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
626 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
627 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
628 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
629 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
630 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
631 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
634 typedef struct RcOverride{
637 int qscale; // If this is 0 then quality_factor will be used instead.
638 float quality_factor;
641 #define FF_MAX_B_FRAMES 16
644 These flags can be passed in AVCodecContext.flags before initialization.
645 Note: Not everything is supported yet.
648 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
649 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
650 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
651 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
652 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
654 * The parent program guarantees that the input for B-frames containing
655 * streams is not written to for at least s->max_b_frames+1 frames, if
656 * this is not set the input will be copied.
658 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
659 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
660 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
661 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
662 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
663 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
664 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
665 location instead of only at frame boundaries. */
666 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
667 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
668 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
669 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
670 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
671 /* Fx : Flag for h263+ extra options */
672 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
673 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
674 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
675 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
676 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
677 #define CODEC_FLAG_CLOSED_GOP 0x80000000
678 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
679 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
680 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
681 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
682 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
683 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
684 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
686 * @defgroup deprecated_flags Deprecated codec flags
687 * Use corresponding private codec options instead.
690 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
691 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
692 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
693 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
694 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
695 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
696 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
697 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
698 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
699 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
700 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
702 #if FF_API_MJPEG_GLOBAL_OPTS
703 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
705 #if FF_API_X264_GLOBAL_OPTS
706 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
707 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
708 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
709 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
710 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
711 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
712 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
713 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
714 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
715 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
716 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
718 #if FF_API_SNOW_GLOBAL_OPTS
719 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
721 #if FF_API_LAME_GLOBAL_OPTS
722 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
728 /* Unsupported options :
729 * Syntax Arithmetic coding (SAC)
730 * Reference Picture Selection
731 * Independent Segment Decoding */
733 /* codec capabilities */
735 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
737 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
738 * If not set, it might not use get_buffer() at all or use operations that
739 * assume the buffer was allocated by avcodec_default_get_buffer.
741 #define CODEC_CAP_DR1 0x0002
742 #if FF_API_PARSE_FRAME
743 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
744 #define CODEC_CAP_PARSE_ONLY 0x0004
746 #define CODEC_CAP_TRUNCATED 0x0008
747 /* Codec can export data for HW decoding (XvMC). */
748 #define CODEC_CAP_HWACCEL 0x0010
750 * Encoder or decoder requires flushing with NULL input at the end in order to
751 * give the complete and correct output.
753 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
754 * with NULL data. The user can still send NULL data to the public encode
755 * or decode function, but libavcodec will not pass it along to the codec
756 * unless this flag is set.
759 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
760 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
764 * The encoder needs to be fed with NULL data at the end of encoding until the
765 * encoder no longer returns data.
767 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
768 * flag also means that the encoder must set the pts and duration for
769 * each output packet. If this flag is not set, the pts and duration will
770 * be determined by libavcodec from the input frame.
772 #define CODEC_CAP_DELAY 0x0020
774 * Codec can be fed a final frame with a smaller size.
775 * This can be used to prevent truncation of the last audio samples.
777 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
779 * Codec can export data for HW decoding (VDPAU).
781 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
783 * Codec can output multiple frames per AVPacket
784 * Normally demuxers return one frame at a time, demuxers which do not do
785 * are connected to a parser to split what they return into proper frames.
786 * This flag is reserved to the very rare category of codecs which have a
787 * bitstream that cannot be split into frames without timeconsuming
788 * operations like full decoding. Demuxers carring such bitstreams thus
789 * may return multiple frames in a packet. This has many disadvantages like
790 * prohibiting stream copy in many cases thus it should only be considered
793 #define CODEC_CAP_SUBFRAMES 0x0100
795 * Codec is experimental and is thus avoided in favor of non experimental
798 #define CODEC_CAP_EXPERIMENTAL 0x0200
800 * Codec should fill in channel configuration and samplerate instead of container
802 #define CODEC_CAP_CHANNEL_CONF 0x0400
805 * Codec is able to deal with negative linesizes
807 #define CODEC_CAP_NEG_LINESIZES 0x0800
810 * Codec supports frame-level multithreading.
812 #define CODEC_CAP_FRAME_THREADS 0x1000
814 * Codec supports slice-based (or partition-based) multithreading.
816 #define CODEC_CAP_SLICE_THREADS 0x2000
818 * Codec supports changed parameters at any point.
820 #define CODEC_CAP_PARAM_CHANGE 0x4000
822 * Codec supports avctx->thread_count == 0 (auto).
824 #define CODEC_CAP_AUTO_THREADS 0x8000
826 * Audio encoder supports receiving a different number of samples in each call.
828 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
832 #define CODEC_CAP_LOSSLESS 0x80000000
834 //The following defines may change, don't expect compatibility if you use them.
835 #define MB_TYPE_INTRA4x4 0x0001
836 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
837 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
838 #define MB_TYPE_16x16 0x0008
839 #define MB_TYPE_16x8 0x0010
840 #define MB_TYPE_8x16 0x0020
841 #define MB_TYPE_8x8 0x0040
842 #define MB_TYPE_INTERLACED 0x0080
843 #define MB_TYPE_DIRECT2 0x0100 //FIXME
844 #define MB_TYPE_ACPRED 0x0200
845 #define MB_TYPE_GMC 0x0400
846 #define MB_TYPE_SKIP 0x0800
847 #define MB_TYPE_P0L0 0x1000
848 #define MB_TYPE_P1L0 0x2000
849 #define MB_TYPE_P0L1 0x4000
850 #define MB_TYPE_P1L1 0x8000
851 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
852 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
853 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
854 #define MB_TYPE_QUANT 0x00010000
855 #define MB_TYPE_CBP 0x00020000
856 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
860 * This specifies the area which should be displayed.
861 * Note there may be multiple such areas for one frame.
863 typedef struct AVPanScan{
866 * - encoding: Set by user.
867 * - decoding: Set by libavcodec.
872 * width and height in 1/16 pel
873 * - encoding: Set by user.
874 * - decoding: Set by libavcodec.
880 * position of the top left corner in 1/16 pel for up to 3 fields/frames
881 * - encoding: Set by user.
882 * - decoding: Set by libavcodec.
884 int16_t position[3][2];
887 #define FF_QSCALE_TYPE_MPEG1 0
888 #define FF_QSCALE_TYPE_MPEG2 1
889 #define FF_QSCALE_TYPE_H264 2
890 #define FF_QSCALE_TYPE_VP56 3
892 #define FF_BUFFER_TYPE_INTERNAL 1
893 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
894 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
895 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
897 #if FF_API_OLD_FF_PICT_TYPES
898 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
899 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
900 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
901 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
902 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
903 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
904 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
905 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
908 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
909 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
910 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
911 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
913 enum AVPacketSideDataType {
915 AV_PKT_DATA_NEW_EXTRADATA,
916 AV_PKT_DATA_PARAM_CHANGE,
919 typedef struct AVPacket {
921 * Presentation timestamp in AVStream->time_base units; the time at which
922 * the decompressed packet will be presented to the user.
923 * Can be AV_NOPTS_VALUE if it is not stored in the file.
924 * pts MUST be larger or equal to dts as presentation cannot happen before
925 * decompression, unless one wants to view hex dumps. Some formats misuse
926 * the terms dts and pts/cts to mean something different. Such timestamps
927 * must be converted to true pts/dts before they are stored in AVPacket.
931 * Decompression timestamp in AVStream->time_base units; the time at which
932 * the packet is decompressed.
933 * Can be AV_NOPTS_VALUE if it is not stored in the file.
940 * A combination of AV_PKT_FLAG values
944 * Additional packet data that can be provided by the container.
945 * Packet can contain several types of side information.
950 enum AVPacketSideDataType type;
955 * Duration of this packet in AVStream->time_base units, 0 if unknown.
956 * Equals next_pts - this_pts in presentation order.
959 void (*destruct)(struct AVPacket *);
961 int64_t pos; ///< byte position in stream, -1 if unknown
964 * Time difference in AVStream->time_base units from the pts of this
965 * packet to the point at which the output from the decoder has converged
966 * independent from the availability of previous frames. That is, the
967 * frames are virtually identical no matter if decoding started from
968 * the very first frame or from this keyframe.
969 * Is AV_NOPTS_VALUE if unknown.
970 * This field is not the display duration of the current packet.
971 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
974 * The purpose of this field is to allow seeking in streams that have no
975 * keyframes in the conventional sense. It corresponds to the
976 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
977 * essential for some types of subtitle streams to ensure that all
978 * subtitles are correctly displayed after seeking.
980 int64_t convergence_duration;
982 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
983 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
986 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
988 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
989 * s32le channel_count
990 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
991 * u64le channel_layout
992 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
994 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
999 enum AVSideDataParamChangeFlags {
1000 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1001 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1002 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1003 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1007 * Audio Video Frame.
1008 * New fields can be added to the end of AVFRAME with minor version
1009 * bumps. Similarly fields that are marked as to be only accessed by
1010 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
1011 * without breaking compatibility with each other.
1012 * Removal, reordering and changes in the remaining cases require
1013 * a major version bump.
1014 * sizeof(AVFrame) must not be used outside libavcodec.
1016 typedef struct AVFrame {
1017 #if FF_API_DATA_POINTERS
1018 #define AV_NUM_DATA_POINTERS 4
1020 #define AV_NUM_DATA_POINTERS 8
1023 * pointer to the picture/channel planes.
1024 * This might be different from the first allocated byte
1025 * - encoding: Set by user
1026 * - decoding: set by AVCodecContext.get_buffer()
1028 uint8_t *data[AV_NUM_DATA_POINTERS];
1031 * Size, in bytes, of the data for each picture/channel plane.
1033 * For audio, only linesize[0] may be set. For planar audio, each channel
1034 * plane must be the same size.
1036 * - encoding: Set by user (video only)
1037 * - decoding: set by AVCodecContext.get_buffer()
1039 int linesize[AV_NUM_DATA_POINTERS];
1042 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1043 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1047 uint8_t *base[AV_NUM_DATA_POINTERS];
1049 * 1 -> keyframe, 0-> not
1050 * - encoding: Set by libavcodec.
1051 * - decoding: Set by libavcodec.
1056 * Picture type of the frame, see ?_TYPE below.
1057 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1058 * - decoding: Set by libavcodec.
1060 enum AVPictureType pict_type;
1063 * presentation timestamp in time_base units (time when frame should be shown to user)
1064 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1065 * - encoding: MUST be set by user.
1066 * - decoding: Set by libavcodec.
1071 * picture number in bitstream order
1072 * - encoding: set by
1073 * - decoding: Set by libavcodec.
1075 int coded_picture_number;
1077 * picture number in display order
1078 * - encoding: set by
1079 * - decoding: Set by libavcodec.
1081 int display_picture_number;
1084 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1085 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1086 * - decoding: Set by libavcodec.
1090 #if FF_API_AVFRAME_AGE
1092 * @deprecated unused
1094 attribute_deprecated int age;
1098 * is this picture used as reference
1099 * The values for this are the same as the MpegEncContext.picture_structure
1100 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1101 * Set to 4 for delayed, non-reference frames.
1102 * - encoding: unused
1103 * - decoding: Set by libavcodec. (before get_buffer() call)).
1109 * - encoding: unused
1110 * - decoding: Set by libavcodec.
1112 int8_t *qscale_table;
1115 * - encoding: unused
1116 * - decoding: Set by libavcodec.
1121 * mbskip_table[mb]>=1 if MB didn't change
1122 * stride= mb_width = (width+15)>>4
1123 * - encoding: unused
1124 * - decoding: Set by libavcodec.
1126 uint8_t *mbskip_table;
1129 * motion vector table
1132 * int mv_sample_log2= 4 - motion_subsample_log2;
1133 * int mb_width= (width+15)>>4;
1134 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1135 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1137 * - encoding: Set by user.
1138 * - decoding: Set by libavcodec.
1140 int16_t (*motion_val[2])[2];
1143 * macroblock type table
1144 * mb_type_base + mb_width + 2
1145 * - encoding: Set by user.
1146 * - decoding: Set by libavcodec.
1151 * log2 of the size of the block which a single vector in motion_val represents:
1152 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1153 * - encoding: unused
1154 * - decoding: Set by libavcodec.
1156 uint8_t motion_subsample_log2;
1159 * for some private data of the user
1160 * - encoding: unused
1161 * - decoding: Set by user.
1167 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1168 * - decoding: unused
1170 uint64_t error[AV_NUM_DATA_POINTERS];
1173 * type of the buffer (to keep track of who has to deallocate data[*])
1174 * - encoding: Set by the one who allocates it.
1175 * - decoding: Set by the one who allocates it.
1176 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1181 * When decoding, this signals how much the picture must be delayed.
1182 * extra_delay = repeat_pict / (2*fps)
1183 * - encoding: unused
1184 * - decoding: Set by libavcodec.
1194 * The content of the picture is interlaced.
1195 * - encoding: Set by user.
1196 * - decoding: Set by libavcodec. (default 0)
1198 int interlaced_frame;
1201 * If the content is interlaced, is top field displayed first.
1202 * - encoding: Set by user.
1203 * - decoding: Set by libavcodec.
1205 int top_field_first;
1209 * - encoding: Set by user.
1210 * - decoding: Set by libavcodec.
1212 AVPanScan *pan_scan;
1215 * Tell user application that palette has changed from previous frame.
1216 * - encoding: ??? (no palette-enabled encoder yet)
1217 * - decoding: Set by libavcodec. (default 0).
1219 int palette_has_changed;
1222 * codec suggestion on buffer type if != 0
1223 * - encoding: unused
1224 * - decoding: Set by libavcodec. (before get_buffer() call)).
1230 * - encoding: unused
1231 * - decoding: Set by libavcodec.
1236 * motion reference frame index
1237 * the order in which these are stored can depend on the codec.
1238 * - encoding: Set by user.
1239 * - decoding: Set by libavcodec.
1241 int8_t *ref_index[2];
1244 * reordered opaque 64bit (generally an integer or a double precision float
1245 * PTS but can be anything).
1246 * The user sets AVCodecContext.reordered_opaque to represent the input at
1248 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1249 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1250 * @deprecated in favor of pkt_pts
1251 * - encoding: unused
1252 * - decoding: Read by user.
1254 int64_t reordered_opaque;
1257 * hardware accelerator private data (FFmpeg-allocated)
1258 * - encoding: unused
1259 * - decoding: Set by libavcodec
1261 void *hwaccel_picture_private;
1264 * reordered pts from the last AVPacket that has been input into the decoder
1265 * - encoding: unused
1266 * - decoding: Read by user.
1271 * dts from the last AVPacket that has been input into the decoder
1272 * - encoding: unused
1273 * - decoding: Read by user.
1278 * the AVCodecContext which ff_thread_get_buffer() was last called on
1279 * - encoding: Set by libavcodec.
1280 * - decoding: Set by libavcodec.
1282 struct AVCodecContext *owner;
1285 * used by multithreading to store frame-specific info
1286 * - encoding: Set by libavcodec.
1287 * - decoding: Set by libavcodec.
1289 void *thread_opaque;
1292 * number of audio samples (per channel) described by this frame
1293 * - encoding: unused
1294 * - decoding: Set by libavcodec
1299 * pointers to the data planes/channels.
1301 * For video, this should simply point to data[].
1303 * For planar audio, each channel has a separate data pointer, and
1304 * linesize[0] contains the size of each channel buffer.
1305 * For packed audio, there is just one data pointer, and linesize[0]
1306 * contains the total size of the buffer for all channels.
1308 * Note: Both data and extended_data will always be set by get_buffer(),
1309 * but for planar audio with more channels that can fit in data,
1310 * extended_data must be used by the decoder in order to access all
1314 * decoding: set by AVCodecContext.get_buffer()
1316 uint8_t **extended_data;
1319 * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1320 * - encoding: unused
1321 * - decoding: Read by user.
1323 AVRational sample_aspect_ratio;
1326 * width and height of the video frame
1327 * - encoding: unused
1328 * - decoding: Read by user.
1333 * format of the frame, -1 if unknown or unset
1334 * Values correspond to enum PixelFormat for video frames,
1335 * enum AVSampleFormat for audio)
1336 * - encoding: unused
1337 * - decoding: Read by user.
1342 * frame timestamp estimated using various heuristics, in stream time base
1343 * Code outside libavcodec should access this field using:
1344 * av_opt_ptr(avcodec_get_frame_class(), frame, "best_effort_timestamp");
1345 * - encoding: unused
1346 * - decoding: set by libavcodec, read by user.
1348 int64_t best_effort_timestamp;
1351 * reordered pos from the last AVPacket that has been input into the decoder
1352 * Code outside libavcodec should access this field using:
1353 * av_opt_ptr(avcodec_get_frame_class(), frame, "pkt_pos");
1354 * - encoding: unused
1355 * - decoding: Read by user.
1361 struct AVCodecInternal;
1365 AV_FIELD_PROGRESSIVE,
1366 AV_FIELD_TT, //< Top coded_first, top displayed first
1367 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1368 AV_FIELD_TB, //< Top coded first, bottom displayed first
1369 AV_FIELD_BT, //< Bottom coded first, top displayed first
1373 * main external API structure.
1374 * New fields can be added to the end with minor version bumps.
1375 * Removal, reordering and changes to existing fields require a major
1377 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1379 * sizeof(AVCodecContext) must not be used outside libav*.
1381 typedef struct AVCodecContext {
1383 * information on struct for av_log
1384 * - set by avcodec_alloc_context3
1386 const AVClass *av_class;
1388 * the average bitrate
1389 * - encoding: Set by user; unused for constant quantizer encoding.
1390 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1395 * number of bits the bitstream is allowed to diverge from the reference.
1396 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1397 * - encoding: Set by user; unused for constant quantizer encoding.
1398 * - decoding: unused
1400 int bit_rate_tolerance;
1404 * - encoding: Set by user.
1405 * - decoding: Set by user.
1410 * Some codecs need additional format info. It is stored here.
1411 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1412 * specific codec MUST set it correctly otherwise stream copy breaks.
1413 * In general use of this field by muxers is not recommended.
1414 * - encoding: Set by libavcodec.
1415 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1420 * Motion estimation algorithm used for video coding.
1421 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1422 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1423 * - encoding: MUST be set by user.
1424 * - decoding: unused
1429 * some codecs need / can use extradata like Huffman tables.
1430 * mjpeg: Huffman tables
1431 * rv10: additional flags
1432 * mpeg4: global headers (they can be in the bitstream or here)
1433 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1434 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1435 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1436 * - encoding: Set/allocated/freed by libavcodec.
1437 * - decoding: Set/allocated/freed by user.
1443 * This is the fundamental unit of time (in seconds) in terms
1444 * of which frame timestamps are represented. For fixed-fps content,
1445 * timebase should be 1/framerate and timestamp increments should be
1447 * - encoding: MUST be set by user.
1448 * - decoding: Set by libavcodec.
1450 AVRational time_base;
1454 * picture width / height.
1455 * - encoding: MUST be set by user.
1456 * - decoding: Set by libavcodec.
1457 * Note: For compatibility it is possible to set this instead of
1458 * coded_width/height before decoding.
1462 #define FF_ASPECT_EXTENDED 15
1465 * the number of pictures in a group of pictures, or 0 for intra_only
1466 * - encoding: Set by user.
1467 * - decoding: unused
1472 * Pixel format, see PIX_FMT_xxx.
1473 * May be set by the demuxer if known from headers.
1474 * May be overriden by the decoder if it knows better.
1475 * - encoding: Set by user.
1476 * - decoding: Set by user if known, overridden by libavcodec if known
1478 enum PixelFormat pix_fmt;
1481 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1482 * decoder to draw a horizontal band. It improves cache usage. Not
1483 * all codecs can do that. You must check the codec capabilities
1485 * When multithreading is used, it may be called from multiple threads
1486 * at the same time; threads might draw different parts of the same AVFrame,
1487 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1489 * The function is also used by hardware acceleration APIs.
1490 * It is called at least once during frame decoding to pass
1491 * the data needed for hardware render.
1492 * In that mode instead of pixel data, AVFrame points to
1493 * a structure specific to the acceleration API. The application
1494 * reads the structure and can change some fields to indicate progress
1496 * - encoding: unused
1497 * - decoding: Set by user.
1498 * @param height the height of the slice
1499 * @param y the y position of the slice
1500 * @param type 1->top field, 2->bottom field, 3->frame
1501 * @param offset offset into the AVFrame.data from which the slice should be read
1503 void (*draw_horiz_band)(struct AVCodecContext *s,
1504 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1505 int y, int type, int height);
1508 int sample_rate; ///< samples per second
1509 int channels; ///< number of audio channels
1512 * audio sample format
1513 * - encoding: Set by user.
1514 * - decoding: Set by libavcodec.
1516 enum AVSampleFormat sample_fmt; ///< sample format
1518 /* The following data should not be initialized. */
1520 * Samples per packet, initialized when calling 'init'.
1523 int frame_number; ///< audio or video frame number
1526 * Encoding: Number of frames delay there will be from the encoder input to
1527 * the decoder output. (we assume the decoder matches the spec)
1528 * Decoding: Number of frames delay in addition to what a standard decoder
1529 * as specified in the spec would produce.
1530 * - encoding: Set by libavcodec.
1531 * - decoding: Set by libavcodec.
1535 /* - encoding parameters */
1536 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1537 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1541 * - encoding: Set by user.
1542 * - decoding: unused
1548 * - encoding: Set by user.
1549 * - decoding: unused
1554 * maximum quantizer difference between frames
1555 * - encoding: Set by user.
1556 * - decoding: unused
1561 * maximum number of B-frames between non-B-frames
1562 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1563 * - encoding: Set by user.
1564 * - decoding: unused
1569 * qscale factor between IP and B-frames
1570 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1571 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1572 * - encoding: Set by user.
1573 * - decoding: unused
1575 float b_quant_factor;
1577 /** obsolete FIXME remove */
1579 #define FF_RC_STRATEGY_XVID 1
1581 int b_frame_strategy;
1583 struct AVCodec *codec;
1587 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1588 /* do its best to deliver a chunk with size */
1589 /* below rtp_payload_size, the chunk will start */
1590 /* with a start code on some codecs like H.263. */
1591 /* This doesn't take account of any particular */
1592 /* headers inside the transmitted RTP payload. */
1595 /* The RTP callback: This function is called */
1596 /* every time the encoder has a packet to send. */
1597 /* It depends on the encoder if the data starts */
1598 /* with a Start Code (it should). H.263 does. */
1599 /* mb_nb contains the number of macroblocks */
1600 /* encoded in the RTP payload. */
1601 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1603 /* statistics, used for 2-pass encoding */
1614 * number of bits used for the previously encoded frame
1615 * - encoding: Set by libavcodec.
1616 * - decoding: unused
1621 * Private data of the user, can be used to carry app specific stuff.
1622 * - encoding: Set by user.
1623 * - decoding: Set by user.
1627 char codec_name[32];
1628 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1629 enum CodecID codec_id; /* see CODEC_ID_xxx */
1632 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1633 * This is used to work around some encoder bugs.
1634 * A demuxer should set this to what is stored in the field used to identify the codec.
1635 * If there are multiple such fields in a container then the demuxer should choose the one
1636 * which maximizes the information about the used codec.
1637 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1638 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1639 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1641 * - encoding: Set by user, if not then the default based on codec_id will be used.
1642 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1644 unsigned int codec_tag;
1647 * Work around bugs in encoders which sometimes cannot be detected automatically.
1648 * - encoding: Set by user
1649 * - decoding: Set by user
1651 int workaround_bugs;
1652 #define FF_BUG_AUTODETECT 1 ///< autodetection
1653 #define FF_BUG_OLD_MSMPEG4 2
1654 #define FF_BUG_XVID_ILACE 4
1655 #define FF_BUG_UMP4 8
1656 #define FF_BUG_NO_PADDING 16
1657 #define FF_BUG_AMV 32
1658 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1659 #define FF_BUG_QPEL_CHROMA 64
1660 #define FF_BUG_STD_QPEL 128
1661 #define FF_BUG_QPEL_CHROMA2 256
1662 #define FF_BUG_DIRECT_BLOCKSIZE 512
1663 #define FF_BUG_EDGE 1024
1664 #define FF_BUG_HPEL_CHROMA 2048
1665 #define FF_BUG_DC_CLIP 4096
1666 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1667 #define FF_BUG_TRUNCATED 16384
1668 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1671 * luma single coefficient elimination threshold
1672 * - encoding: Set by user.
1673 * - decoding: unused
1675 int luma_elim_threshold;
1678 * chroma single coeff elimination threshold
1679 * - encoding: Set by user.
1680 * - decoding: unused
1682 int chroma_elim_threshold;
1685 * strictly follow the standard (MPEG4, ...).
1686 * - encoding: Set by user.
1687 * - decoding: Set by user.
1688 * Setting this to STRICT or higher means the encoder and decoder will
1689 * generally do stupid things, whereas setting it to unofficial or lower
1690 * will mean the encoder might produce output that is not supported by all
1691 * spec-compliant decoders. Decoders don't differentiate between normal,
1692 * unofficial and experimental (that is, they always try to decode things
1693 * when they can) unless they are explicitly asked to behave stupidly
1694 * (=strictly conform to the specs)
1696 int strict_std_compliance;
1697 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1698 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1699 #define FF_COMPLIANCE_NORMAL 0
1700 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1701 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1704 * qscale offset between IP and B-frames
1705 * - encoding: Set by user.
1706 * - decoding: unused
1708 float b_quant_offset;
1712 * Error recognition; higher values will detect more errors but may
1713 * misdetect some more or less valid parts as errors.
1714 * - encoding: unused
1715 * - decoding: Set by user.
1717 attribute_deprecated int error_recognition;
1718 #define FF_ER_CAREFUL 1
1719 #define FF_ER_COMPLIANT 2
1720 #define FF_ER_AGGRESSIVE 3
1721 #define FF_ER_VERY_AGGRESSIVE 4
1722 #define FF_ER_EXPLODE 5
1723 #endif /* FF_API_ER */
1726 * Called at the beginning of each frame to get a buffer for it.
1728 * The function will set AVFrame.data[], AVFrame.linesize[].
1729 * AVFrame.extended_data[] must also be set, but it should be the same as
1730 * AVFrame.data[] except for planar audio with more channels than can fit
1731 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1732 * many data pointers as it can hold.
1734 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1735 * avcodec_default_get_buffer() instead of providing buffers allocated by
1738 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1739 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1740 * but if get_buffer() is overridden then alignment considerations should
1741 * be taken into account.
1743 * @see avcodec_default_get_buffer()
1747 * If pic.reference is set then the frame will be read later by libavcodec.
1748 * avcodec_align_dimensions2() should be used to find the required width and
1749 * height, as they normally need to be rounded up to the next multiple of 16.
1751 * If frame multithreading is used and thread_safe_callbacks is set,
1752 * it may be called from a different thread, but not from more than one at
1753 * once. Does not need to be reentrant.
1755 * @see release_buffer(), reget_buffer()
1756 * @see avcodec_align_dimensions2()
1760 * Decoders request a buffer of a particular size by setting
1761 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1762 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1763 * to a smaller value in the output frame.
1765 * Decoders cannot use the buffer after returning from
1766 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1767 * is assumed to be released immediately upon return.
1769 * As a convenience, av_samples_get_buffer_size() and
1770 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1771 * functions to find the required data size and to fill data pointers and
1772 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1773 * since all planes must be the same size.
1775 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1777 * - encoding: unused
1778 * - decoding: Set by libavcodec, user can override.
1780 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1783 * Called to release buffers which were allocated with get_buffer.
1784 * A released buffer can be reused in get_buffer().
1785 * pic.data[*] must be set to NULL.
1786 * May be called from a different thread if frame multithreading is used,
1787 * but not by more than one thread at once, so does not need to be reentrant.
1788 * - encoding: unused
1789 * - decoding: Set by libavcodec, user can override.
1791 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1794 * Size of the frame reordering buffer in the decoder.
1795 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1796 * - encoding: Set by libavcodec.
1797 * - decoding: Set by libavcodec.
1802 * number of bytes per packet if constant and known or 0
1803 * Used by some WAV based audio codecs.
1807 #if FF_API_PARSE_FRAME
1809 * If true, only parsing is done. The frame data is returned.
1810 * Only MPEG audio decoders support this now.
1811 * - encoding: unused
1812 * - decoding: Set by user
1814 attribute_deprecated int parse_only;
1818 * 0-> h263 quant 1-> mpeg quant
1819 * - encoding: Set by user.
1820 * - decoding: unused
1825 * pass1 encoding statistics output buffer
1826 * - encoding: Set by libavcodec.
1827 * - decoding: unused
1832 * pass2 encoding statistics input buffer
1833 * Concatenated stuff from stats_out of pass1 should be placed here.
1834 * - encoding: Allocated/set/freed by user.
1835 * - decoding: unused
1840 * ratecontrol qmin qmax limiting method
1841 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1842 * - encoding: Set by user.
1843 * - decoding: unused
1851 * ratecontrol override, see RcOverride
1852 * - encoding: Allocated/set/freed by user.
1853 * - decoding: unused
1855 RcOverride *rc_override;
1856 int rc_override_count;
1859 * rate control equation
1860 * - encoding: Set by user
1861 * - decoding: unused
1867 * - encoding: Set by user.
1868 * - decoding: unused
1874 * - encoding: Set by user.
1875 * - decoding: unused
1880 * decoder bitstream buffer size
1881 * - encoding: Set by user.
1882 * - decoding: unused
1885 float rc_buffer_aggressivity;
1888 * qscale factor between P and I-frames
1889 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1890 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1891 * - encoding: Set by user.
1892 * - decoding: unused
1894 float i_quant_factor;
1897 * qscale offset between P and I-frames
1898 * - encoding: Set by user.
1899 * - decoding: unused
1901 float i_quant_offset;
1904 * initial complexity for pass1 ratecontrol
1905 * - encoding: Set by user.
1906 * - decoding: unused
1908 float rc_initial_cplx;
1911 * DCT algorithm, see FF_DCT_* below
1912 * - encoding: Set by user.
1913 * - decoding: unused
1916 #define FF_DCT_AUTO 0
1917 #define FF_DCT_FASTINT 1
1918 #define FF_DCT_INT 2
1919 #define FF_DCT_MMX 3
1920 #define FF_DCT_MLIB 4
1921 #define FF_DCT_ALTIVEC 5
1922 #define FF_DCT_FAAN 6
1925 * luminance masking (0-> disabled)
1926 * - encoding: Set by user.
1927 * - decoding: unused
1932 * temporary complexity masking (0-> disabled)
1933 * - encoding: Set by user.
1934 * - decoding: unused
1936 float temporal_cplx_masking;
1939 * spatial complexity masking (0-> disabled)
1940 * - encoding: Set by user.
1941 * - decoding: unused
1943 float spatial_cplx_masking;
1946 * p block masking (0-> disabled)
1947 * - encoding: Set by user.
1948 * - decoding: unused
1953 * darkness masking (0-> disabled)
1954 * - encoding: Set by user.
1955 * - decoding: unused
1960 * IDCT algorithm, see FF_IDCT_* below.
1961 * - encoding: Set by user.
1962 * - decoding: Set by user.
1965 #define FF_IDCT_AUTO 0
1966 #define FF_IDCT_INT 1
1967 #define FF_IDCT_SIMPLE 2
1968 #define FF_IDCT_SIMPLEMMX 3
1969 #define FF_IDCT_LIBMPEG2MMX 4
1970 #define FF_IDCT_PS2 5
1971 #define FF_IDCT_MLIB 6
1972 #define FF_IDCT_ARM 7
1973 #define FF_IDCT_ALTIVEC 8
1974 #define FF_IDCT_SH4 9
1975 #define FF_IDCT_SIMPLEARM 10
1976 #define FF_IDCT_H264 11
1977 #define FF_IDCT_VP3 12
1978 #define FF_IDCT_IPP 13
1979 #define FF_IDCT_XVIDMMX 14
1980 #define FF_IDCT_CAVS 15
1981 #define FF_IDCT_SIMPLEARMV5TE 16
1982 #define FF_IDCT_SIMPLEARMV6 17
1983 #define FF_IDCT_SIMPLEVIS 18
1984 #define FF_IDCT_WMV2 19
1985 #define FF_IDCT_FAAN 20
1986 #define FF_IDCT_EA 21
1987 #define FF_IDCT_SIMPLENEON 22
1988 #define FF_IDCT_SIMPLEALPHA 23
1989 #define FF_IDCT_BINK 24
1993 * - encoding: Set by libavcodec.
1994 * - decoding: Set by user (or 0).
1998 * slice offsets in the frame in bytes
1999 * - encoding: Set/allocated by libavcodec.
2000 * - decoding: Set/allocated by user (or NULL).
2005 * error concealment flags
2006 * - encoding: unused
2007 * - decoding: Set by user.
2009 int error_concealment;
2010 #define FF_EC_GUESS_MVS 1
2011 #define FF_EC_DEBLOCK 2
2014 * dsp_mask could be add used to disable unwanted CPU features
2015 * CPU features (i.e. MMX, SSE. ...)
2017 * With the FORCE flag you may instead enable given CPU features.
2018 * (Dangerous: Usable in case of misdetection, improper usage however will
2019 * result into program crash.)
2024 * bits per sample/pixel from the demuxer (needed for huffyuv).
2025 * - encoding: Set by libavcodec.
2026 * - decoding: Set by user.
2028 int bits_per_coded_sample;
2031 * prediction method (needed for huffyuv)
2032 * - encoding: Set by user.
2033 * - decoding: unused
2035 int prediction_method;
2036 #define FF_PRED_LEFT 0
2037 #define FF_PRED_PLANE 1
2038 #define FF_PRED_MEDIAN 2
2041 * sample aspect ratio (0 if unknown)
2042 * That is the width of a pixel divided by the height of the pixel.
2043 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2044 * - encoding: Set by user.
2045 * - decoding: Set by libavcodec.
2047 AVRational sample_aspect_ratio;
2050 * the picture in the bitstream
2051 * - encoding: Set by libavcodec.
2052 * - decoding: Set by libavcodec.
2054 AVFrame *coded_frame;
2058 * - encoding: Set by user.
2059 * - decoding: Set by user.
2062 #define FF_DEBUG_PICT_INFO 1
2063 #define FF_DEBUG_RC 2
2064 #define FF_DEBUG_BITSTREAM 4
2065 #define FF_DEBUG_MB_TYPE 8
2066 #define FF_DEBUG_QP 16
2067 #define FF_DEBUG_MV 32
2068 #define FF_DEBUG_DCT_COEFF 0x00000040
2069 #define FF_DEBUG_SKIP 0x00000080
2070 #define FF_DEBUG_STARTCODE 0x00000100
2071 #define FF_DEBUG_PTS 0x00000200
2072 #define FF_DEBUG_ER 0x00000400
2073 #define FF_DEBUG_MMCO 0x00000800
2074 #define FF_DEBUG_BUGS 0x00001000
2075 #define FF_DEBUG_VIS_QP 0x00002000
2076 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2077 #define FF_DEBUG_BUFFERS 0x00008000
2078 #define FF_DEBUG_THREADS 0x00010000
2082 * - encoding: Set by user.
2083 * - decoding: Set by user.
2086 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2087 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2088 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2092 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2093 * - decoding: unused
2095 uint64_t error[AV_NUM_DATA_POINTERS];
2098 * motion estimation comparison function
2099 * - encoding: Set by user.
2100 * - decoding: unused
2104 * subpixel motion estimation comparison function
2105 * - encoding: Set by user.
2106 * - decoding: unused
2110 * macroblock comparison function (not supported yet)
2111 * - encoding: Set by user.
2112 * - decoding: unused
2116 * interlaced DCT comparison function
2117 * - encoding: Set by user.
2118 * - decoding: unused
2121 #define FF_CMP_SAD 0
2122 #define FF_CMP_SSE 1
2123 #define FF_CMP_SATD 2
2124 #define FF_CMP_DCT 3
2125 #define FF_CMP_PSNR 4
2126 #define FF_CMP_BIT 5
2128 #define FF_CMP_ZERO 7
2129 #define FF_CMP_VSAD 8
2130 #define FF_CMP_VSSE 9
2131 #define FF_CMP_NSSE 10
2132 #define FF_CMP_W53 11
2133 #define FF_CMP_W97 12
2134 #define FF_CMP_DCTMAX 13
2135 #define FF_CMP_DCT264 14
2136 #define FF_CMP_CHROMA 256
2139 * ME diamond size & shape
2140 * - encoding: Set by user.
2141 * - decoding: unused
2146 * amount of previous MV predictors (2a+1 x 2a+1 square)
2147 * - encoding: Set by user.
2148 * - decoding: unused
2150 int last_predictor_count;
2153 * prepass for motion estimation
2154 * - encoding: Set by user.
2155 * - decoding: unused
2160 * motion estimation prepass comparison function
2161 * - encoding: Set by user.
2162 * - decoding: unused
2167 * ME prepass diamond size & shape
2168 * - encoding: Set by user.
2169 * - decoding: unused
2175 * - encoding: Set by user.
2176 * - decoding: unused
2178 int me_subpel_quality;
2181 * callback to negotiate the pixelFormat
2182 * @param fmt is the list of formats which are supported by the codec,
2183 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2184 * The first is always the native one.
2185 * @return the chosen format
2186 * - encoding: unused
2187 * - decoding: Set by user, if not set the native format will be chosen.
2189 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
2192 * DTG active format information (additional aspect ratio
2193 * information only used in DVB MPEG-2 transport streams)
2196 * - encoding: unused
2197 * - decoding: Set by decoder.
2199 int dtg_active_format;
2200 #define FF_DTG_AFD_SAME 8
2201 #define FF_DTG_AFD_4_3 9
2202 #define FF_DTG_AFD_16_9 10
2203 #define FF_DTG_AFD_14_9 11
2204 #define FF_DTG_AFD_4_3_SP_14_9 13
2205 #define FF_DTG_AFD_16_9_SP_14_9 14
2206 #define FF_DTG_AFD_SP_4_3 15
2209 * maximum motion estimation search range in subpel units
2210 * If 0 then no limit.
2212 * - encoding: Set by user.
2213 * - decoding: unused
2218 * intra quantizer bias
2219 * - encoding: Set by user.
2220 * - decoding: unused
2222 int intra_quant_bias;
2223 #define FF_DEFAULT_QUANT_BIAS 999999
2226 * inter quantizer bias
2227 * - encoding: Set by user.
2228 * - decoding: unused
2230 int inter_quant_bias;
2234 * - encoding: unused
2235 * - decoding: Which clrtable should be used for 8bit RGB images.
2236 * Tables have to be stored somewhere. FIXME
2240 #if FF_API_INTERNAL_CONTEXT
2242 * internal_buffer count
2243 * Don't touch, used by libavcodec default_get_buffer().
2244 * @deprecated this field was moved to an internal context
2246 attribute_deprecated int internal_buffer_count;
2250 * Don't touch, used by libavcodec default_get_buffer().
2251 * @deprecated this field was moved to an internal context
2253 attribute_deprecated void *internal_buffer;
2257 * Global quality for codecs which cannot change it per frame.
2258 * This should be proportional to MPEG-1/2/4 qscale.
2259 * - encoding: Set by user.
2260 * - decoding: unused
2264 #define FF_CODER_TYPE_VLC 0
2265 #define FF_CODER_TYPE_AC 1
2266 #define FF_CODER_TYPE_RAW 2
2267 #define FF_CODER_TYPE_RLE 3
2268 #define FF_CODER_TYPE_DEFLATE 4
2271 * - encoding: Set by user.
2272 * - decoding: unused
2278 * - encoding: Set by user.
2279 * - decoding: unused
2285 * - encoding: unused
2286 * - decoding: Set by user.
2288 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2293 * - encoding: unused
2294 * - decoding: Set by user.
2297 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2298 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2299 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2302 * XVideo Motion Acceleration
2303 * - encoding: forbidden
2304 * - decoding: set by decoder
2306 int xvmc_acceleration;
2309 * macroblock decision mode
2310 * - encoding: Set by user.
2311 * - decoding: unused
2314 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2315 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2316 #define FF_MB_DECISION_RD 2 ///< rate distortion
2319 * custom intra quantization matrix
2320 * - encoding: Set by user, can be NULL.
2321 * - decoding: Set by libavcodec.
2323 uint16_t *intra_matrix;
2326 * custom inter quantization matrix
2327 * - encoding: Set by user, can be NULL.
2328 * - decoding: Set by libavcodec.
2330 uint16_t *inter_matrix;
2333 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2334 * This is used to work around some encoder bugs.
2335 * - encoding: unused
2336 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2338 unsigned int stream_codec_tag;
2341 * scene change detection threshold
2342 * 0 is default, larger means fewer detected scene changes.
2343 * - encoding: Set by user.
2344 * - decoding: unused
2346 int scenechange_threshold;
2349 * minimum Lagrange multipler
2350 * - encoding: Set by user.
2351 * - decoding: unused
2356 * maximum Lagrange multipler
2357 * - encoding: Set by user.
2358 * - decoding: unused
2362 #if FF_API_PALETTE_CONTROL
2364 * palette control structure
2365 * - encoding: ??? (no palette-enabled encoder yet)
2366 * - decoding: Set by user.
2368 struct AVPaletteControl *palctrl;
2372 * noise reduction strength
2373 * - encoding: Set by user.
2374 * - decoding: unused
2376 int noise_reduction;
2379 * Called at the beginning of a frame to get cr buffer for it.
2380 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2381 * libavcodec will pass previous buffer in pic, function should return
2382 * same buffer or new buffer with old frame "painted" into it.
2383 * If pic.data[0] == NULL must behave like get_buffer().
2384 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2385 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2387 * - encoding: unused
2388 * - decoding: Set by libavcodec, user can override.
2390 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2393 * Number of bits which should be loaded into the rc buffer before decoding starts.
2394 * - encoding: Set by user.
2395 * - decoding: unused
2397 int rc_initial_buffer_occupancy;
2401 * - encoding: Set by user.
2402 * - decoding: unused
2404 int inter_threshold;
2408 * - encoding: Set by user.
2409 * - decoding: Set by user.
2414 * Simulates errors in the bitstream to test error concealment.
2415 * - encoding: Set by user.
2416 * - decoding: unused
2420 #if FF_API_ANTIALIAS_ALGO
2422 * MP3 antialias algorithm, see FF_AA_* below.
2423 * - encoding: unused
2424 * - decoding: Set by user.
2426 attribute_deprecated int antialias_algo;
2427 #define FF_AA_AUTO 0
2428 #define FF_AA_FASTINT 1 //not implemented yet
2430 #define FF_AA_FLOAT 3
2434 * quantizer noise shaping
2435 * - encoding: Set by user.
2436 * - decoding: unused
2438 int quantizer_noise_shaping;
2442 * is used to decide how many independent tasks should be passed to execute()
2443 * - encoding: Set by user.
2444 * - decoding: Set by user.
2449 * The codec may call this to execute several independent things.
2450 * It will return only after finishing all tasks.
2451 * The user may replace this with some multithreaded implementation,
2452 * the default implementation will execute the parts serially.
2453 * @param count the number of things to execute
2454 * - encoding: Set by libavcodec, user can override.
2455 * - decoding: Set by libavcodec, user can override.
2457 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2461 * Can be used by execute() to store some per AVCodecContext stuff.
2462 * - encoding: set by execute()
2463 * - decoding: set by execute()
2465 void *thread_opaque;
2468 * Motion estimation threshold below which no motion estimation is
2469 * performed, but instead the user specified motion vectors are used.
2471 * - encoding: Set by user.
2472 * - decoding: unused
2477 * Macroblock threshold below which the user specified macroblock types will be used.
2478 * - encoding: Set by user.
2479 * - decoding: unused
2484 * precision of the intra DC coefficient - 8
2485 * - encoding: Set by user.
2486 * - decoding: unused
2488 int intra_dc_precision;
2491 * noise vs. sse weight for the nsse comparsion function
2492 * - encoding: Set by user.
2493 * - decoding: unused
2498 * Number of macroblock rows at the top which are skipped.
2499 * - encoding: unused
2500 * - decoding: Set by user.
2505 * Number of macroblock rows at the bottom which are skipped.
2506 * - encoding: unused
2507 * - decoding: Set by user.
2513 * - encoding: Set by user.
2514 * - decoding: Set by libavcodec.
2517 #define FF_PROFILE_UNKNOWN -99
2518 #define FF_PROFILE_RESERVED -100
2520 #define FF_PROFILE_AAC_MAIN 0
2521 #define FF_PROFILE_AAC_LOW 1
2522 #define FF_PROFILE_AAC_SSR 2
2523 #define FF_PROFILE_AAC_LTP 3
2525 #define FF_PROFILE_DTS 20
2526 #define FF_PROFILE_DTS_ES 30
2527 #define FF_PROFILE_DTS_96_24 40
2528 #define FF_PROFILE_DTS_HD_HRA 50
2529 #define FF_PROFILE_DTS_HD_MA 60
2531 #define FF_PROFILE_MPEG2_422 0
2532 #define FF_PROFILE_MPEG2_HIGH 1
2533 #define FF_PROFILE_MPEG2_SS 2
2534 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2535 #define FF_PROFILE_MPEG2_MAIN 4
2536 #define FF_PROFILE_MPEG2_SIMPLE 5
2538 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2539 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2541 #define FF_PROFILE_H264_BASELINE 66
2542 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2543 #define FF_PROFILE_H264_MAIN 77
2544 #define FF_PROFILE_H264_EXTENDED 88
2545 #define FF_PROFILE_H264_HIGH 100
2546 #define FF_PROFILE_H264_HIGH_10 110
2547 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2548 #define FF_PROFILE_H264_HIGH_422 122
2549 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2550 #define FF_PROFILE_H264_HIGH_444 144
2551 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2552 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2553 #define FF_PROFILE_H264_CAVLC_444 44
2555 #define FF_PROFILE_VC1_SIMPLE 0
2556 #define FF_PROFILE_VC1_MAIN 1
2557 #define FF_PROFILE_VC1_COMPLEX 2
2558 #define FF_PROFILE_VC1_ADVANCED 3
2560 #define FF_PROFILE_MPEG4_SIMPLE 0
2561 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2562 #define FF_PROFILE_MPEG4_CORE 2
2563 #define FF_PROFILE_MPEG4_MAIN 3
2564 #define FF_PROFILE_MPEG4_N_BIT 4
2565 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2566 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2567 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2568 #define FF_PROFILE_MPEG4_HYBRID 8
2569 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2570 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2571 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2572 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2573 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2574 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2575 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2579 * - encoding: Set by user.
2580 * - decoding: Set by libavcodec.
2583 #define FF_LEVEL_UNKNOWN -99
2586 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2587 * - encoding: unused
2588 * - decoding: Set by user.
2593 * Bitstream width / height, may be different from width/height if lowres enabled.
2594 * - encoding: unused
2595 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2597 int coded_width, coded_height;
2600 * frame skip threshold
2601 * - encoding: Set by user.
2602 * - decoding: unused
2604 int frame_skip_threshold;
2608 * - encoding: Set by user.
2609 * - decoding: unused
2611 int frame_skip_factor;
2614 * frame skip exponent
2615 * - encoding: Set by user.
2616 * - decoding: unused
2621 * frame skip comparison function
2622 * - encoding: Set by user.
2623 * - decoding: unused
2628 * Border processing masking, raises the quantizer for mbs on the borders
2630 * - encoding: Set by user.
2631 * - decoding: unused
2633 float border_masking;
2636 * minimum MB lagrange multipler
2637 * - encoding: Set by user.
2638 * - decoding: unused
2643 * maximum MB lagrange multipler
2644 * - encoding: Set by user.
2645 * - decoding: unused
2651 * - encoding: Set by user.
2652 * - decoding: unused
2654 int me_penalty_compensation;
2658 * - encoding: unused
2659 * - decoding: Set by user.
2661 enum AVDiscard skip_loop_filter;
2665 * - encoding: unused
2666 * - decoding: Set by user.
2668 enum AVDiscard skip_idct;
2672 * - encoding: unused
2673 * - decoding: Set by user.
2675 enum AVDiscard skip_frame;
2679 * - encoding: Set by user.
2680 * - decoding: unused
2686 * - encoding: Set by user.
2687 * - decoding: unused
2691 #if FF_API_X264_GLOBAL_OPTS
2693 * constant rate factor - quality-based VBR - values ~correspond to qps
2694 * - encoding: Set by user.
2695 * - decoding: unused
2696 * @deprecated use 'crf' libx264 private option
2698 attribute_deprecated float crf;
2701 * constant quantization parameter rate control method
2702 * - encoding: Set by user.
2703 * - decoding: unused
2704 * @deprecated use 'cqp' libx264 private option
2706 attribute_deprecated int cqp;
2711 * - encoding: Set by user.
2712 * - decoding: unused
2717 * number of reference frames
2718 * - encoding: Set by user.
2719 * - decoding: Set by lavc.
2724 * chroma qp offset from luma
2725 * - encoding: Set by user.
2726 * - decoding: unused
2730 #if FF_API_X264_GLOBAL_OPTS
2732 * Influence how often B-frames are used.
2733 * - encoding: Set by user.
2734 * - decoding: unused
2736 attribute_deprecated int bframebias;
2740 * trellis RD quantization
2741 * - encoding: Set by user.
2742 * - decoding: unused
2746 #if FF_API_X264_GLOBAL_OPTS
2748 * Reduce fluctuations in qp (before curve compression).
2749 * - encoding: Set by user.
2750 * - decoding: unused
2752 attribute_deprecated float complexityblur;
2755 * in-loop deblocking filter alphac0 parameter
2756 * alpha is in the range -6...6
2757 * - encoding: Set by user.
2758 * - decoding: unused
2760 attribute_deprecated int deblockalpha;
2763 * in-loop deblocking filter beta parameter
2764 * beta is in the range -6...6
2765 * - encoding: Set by user.
2766 * - decoding: unused
2768 attribute_deprecated int deblockbeta;
2771 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2772 * - encoding: Set by user.
2773 * - decoding: unused
2775 attribute_deprecated int partitions;
2776 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2777 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2778 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2779 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2780 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2783 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2784 * - encoding: Set by user.
2785 * - decoding: unused
2787 attribute_deprecated int directpred;
2791 * Audio cutoff bandwidth (0 means "automatic")
2792 * - encoding: Set by user.
2793 * - decoding: unused
2798 * Multiplied by qscale for each frame and added to scene_change_score.
2799 * - encoding: Set by user.
2800 * - decoding: unused
2802 int scenechange_factor;
2806 * Note: Value depends upon the compare function used for fullpel ME.
2807 * - encoding: Set by user.
2808 * - decoding: unused
2813 * Adjust sensitivity of b_frame_strategy 1.
2814 * - encoding: Set by user.
2815 * - decoding: unused
2820 * - encoding: Set by user.
2821 * - decoding: unused
2823 int compression_level;
2824 #define FF_COMPRESSION_DEFAULT -1
2827 * - encoding: Set by user.
2828 * - decoding: unused
2830 int min_prediction_order;
2833 * - encoding: Set by user.
2834 * - decoding: unused
2836 int max_prediction_order;
2838 #if FF_API_FLAC_GLOBAL_OPTS
2840 * @name FLAC options
2841 * @deprecated Use FLAC encoder private options instead.
2846 * LPC coefficient precision - used by FLAC encoder
2847 * - encoding: Set by user.
2848 * - decoding: unused
2850 attribute_deprecated int lpc_coeff_precision;
2853 * search method for selecting prediction order
2854 * - encoding: Set by user.
2855 * - decoding: unused
2857 attribute_deprecated int prediction_order_method;
2860 * - encoding: Set by user.
2861 * - decoding: unused
2863 attribute_deprecated int min_partition_order;
2866 * - encoding: Set by user.
2867 * - decoding: unused
2869 attribute_deprecated int max_partition_order;
2876 * GOP timecode frame start number
2877 * - encoding: Set by user, in non drop frame format
2878 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2880 int64_t timecode_frame_start;
2882 #if FF_API_REQUEST_CHANNELS
2884 * Decoder should decode to this many channels if it can (0 for default)
2885 * - encoding: unused
2886 * - decoding: Set by user.
2887 * @deprecated Deprecated in favor of request_channel_layout.
2889 int request_channels;
2892 #if FF_API_DRC_SCALE
2894 * Percentage of dynamic range compression to be applied by the decoder.
2895 * The default value is 1.0, corresponding to full compression.
2896 * - encoding: unused
2897 * - decoding: Set by user.
2898 * @deprecated use AC3 decoder private option instead.
2900 attribute_deprecated float drc_scale;
2904 * opaque 64bit number (generally a PTS) that will be reordered and
2905 * output in AVFrame.reordered_opaque
2906 * @deprecated in favor of pkt_pts
2907 * - encoding: unused
2908 * - decoding: Set by user.
2910 int64_t reordered_opaque;
2913 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2914 * - encoding: set by user.
2915 * - decoding: set by libavcodec.
2917 int bits_per_raw_sample;
2920 * Audio channel layout.
2921 * - encoding: set by user.
2922 * - decoding: set by user, may be overwritten by libavcodec.
2924 uint64_t channel_layout;
2927 * Request decoder to use this channel layout if it can (0 for default)
2928 * - encoding: unused
2929 * - decoding: Set by user.
2931 uint64_t request_channel_layout;
2934 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2935 * - encoding: Set by user.
2936 * - decoding: unused.
2938 float rc_max_available_vbv_use;
2941 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2942 * - encoding: Set by user.
2943 * - decoding: unused.
2945 float rc_min_vbv_overflow_use;
2948 * Hardware accelerator in use
2949 * - encoding: unused.
2950 * - decoding: Set by libavcodec
2952 struct AVHWAccel *hwaccel;
2955 * For some codecs, the time base is closer to the field rate than the frame rate.
2956 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2957 * if no telecine is used ...
2959 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2961 int ticks_per_frame;
2964 * Hardware accelerator context.
2965 * For some hardware accelerators, a global context needs to be
2966 * provided by the user. In that case, this holds display-dependent
2967 * data FFmpeg cannot instantiate itself. Please refer to the
2968 * FFmpeg HW accelerator documentation to know how to fill this
2969 * is. e.g. for VA API, this is a struct vaapi_context.
2970 * - encoding: unused
2971 * - decoding: Set by user
2973 void *hwaccel_context;
2976 * Chromaticity coordinates of the source primaries.
2977 * - encoding: Set by user
2978 * - decoding: Set by libavcodec
2980 enum AVColorPrimaries color_primaries;
2983 * Color Transfer Characteristic.
2984 * - encoding: Set by user
2985 * - decoding: Set by libavcodec
2987 enum AVColorTransferCharacteristic color_trc;
2990 * YUV colorspace type.
2991 * - encoding: Set by user
2992 * - decoding: Set by libavcodec
2994 enum AVColorSpace colorspace;
2997 * MPEG vs JPEG YUV range.
2998 * - encoding: Set by user
2999 * - decoding: Set by libavcodec
3001 enum AVColorRange color_range;
3004 * This defines the location of chroma samples.
3005 * - encoding: Set by user
3006 * - decoding: Set by libavcodec
3008 enum AVChromaLocation chroma_sample_location;
3011 * The codec may call this to execute several independent things.
3012 * It will return only after finishing all tasks.
3013 * The user may replace this with some multithreaded implementation,
3014 * the default implementation will execute the parts serially.
3015 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3016 * @param c context passed also to func
3017 * @param count the number of things to execute
3018 * @param arg2 argument passed unchanged to func
3019 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3020 * @param func function that will be called count times, with jobnr from 0 to count-1.
3021 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3022 * two instances of func executing at the same time will have the same threadnr.
3023 * @return always 0 currently, but code should handle a future improvement where when any call to func
3024 * returns < 0 no further calls to func may be done and < 0 is returned.
3025 * - encoding: Set by libavcodec, user can override.
3026 * - decoding: Set by libavcodec, user can override.
3028 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3030 #if FF_API_X264_GLOBAL_OPTS
3032 * explicit P-frame weighted prediction analysis method
3034 * 1: fast blind weighting (one reference duplicate with -1 offset)
3035 * 2: smart weighting (full fade detection analysis)
3036 * - encoding: Set by user.
3037 * - decoding: unused
3039 attribute_deprecated int weighted_p_pred;
3044 * 1: Variance AQ (complexity mask)
3045 * 2: Auto-variance AQ (experimental)
3046 * - encoding: Set by user
3047 * - decoding: unused
3049 attribute_deprecated int aq_mode;
3053 * Reduces blocking and blurring in flat and textured areas.
3054 * - encoding: Set by user
3055 * - decoding: unused
3057 attribute_deprecated float aq_strength;
3061 * Strength of psychovisual optimization
3062 * - encoding: Set by user
3063 * - decoding: unused
3065 attribute_deprecated float psy_rd;
3069 * Strength of psychovisual optimization
3070 * - encoding: Set by user
3071 * - decoding: unused
3073 attribute_deprecated float psy_trellis;
3077 * Number of frames for frametype and ratecontrol lookahead
3078 * - encoding: Set by user
3079 * - decoding: unused
3081 attribute_deprecated int rc_lookahead;
3084 * Constant rate factor maximum
3085 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
3086 * than crf_max, even if doing so would violate VBV restrictions.
3087 * - encoding: Set by user.
3088 * - decoding: unused
3090 attribute_deprecated float crf_max;
3093 int log_level_offset;
3095 #if FF_API_FLAC_GLOBAL_OPTS
3097 * Determine which LPC analysis algorithm to use.
3098 * - encoding: Set by user
3099 * - decoding: unused
3101 attribute_deprecated enum AVLPCType lpc_type;
3104 * Number of passes to use for Cholesky factorization during LPC analysis
3105 * - encoding: Set by user
3106 * - decoding: unused
3108 attribute_deprecated int lpc_passes;
3113 * Indicates number of picture subdivisions. Used for parallelized
3115 * - encoding: Set by user
3116 * - decoding: unused
3121 * Header containing style information for text subtitles.
3122 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3123 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3124 * the Format line following. It shouldn't include any Dialogue line.
3125 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3126 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3128 uint8_t *subtitle_header;
3129 int subtitle_header_size;
3132 * Current packet as passed into the decoder, to avoid having
3133 * to pass the packet into every function. Currently only valid
3134 * inside lavc and get/release_buffer callbacks.
3135 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
3136 * - encoding: unused
3140 #if FF_API_INTERNAL_CONTEXT
3142 * Whether this is a copy of the context which had init() called on it.
3143 * This is used by multithreading - shared tables and picture pointers
3144 * should be freed from the original context only.
3145 * - encoding: Set by libavcodec.
3146 * - decoding: Set by libavcodec.
3148 * @deprecated this field has been moved to an internal context
3150 attribute_deprecated int is_copy;
3154 * Which multithreading methods to use.
3155 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3156 * so clients which cannot provide future frames should not use it.
3158 * - encoding: Set by user, otherwise the default is used.
3159 * - decoding: Set by user, otherwise the default is used.
3162 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3163 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3166 * Which multithreading methods are in use by the codec.
3167 * - encoding: Set by libavcodec.
3168 * - decoding: Set by libavcodec.
3170 int active_thread_type;
3173 * Set by the client if its custom get_buffer() callback can be called
3174 * from another thread, which allows faster multithreaded decoding.
3175 * draw_horiz_band() will be called from other threads regardless of this setting.
3176 * Ignored if the default get_buffer() is used.
3177 * - encoding: Set by user.
3178 * - decoding: Set by user.
3180 int thread_safe_callbacks;
3183 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3184 * Used for compliant TS muxing.
3185 * - encoding: Set by libavcodec.
3186 * - decoding: unused.
3191 * Type of service that the audio stream conveys.
3192 * - encoding: Set by user.
3193 * - decoding: Set by libavcodec.
3195 enum AVAudioServiceType audio_service_type;
3198 * desired sample format
3199 * - encoding: Not used.
3200 * - decoding: Set by user.
3201 * Decoder will decode to this format if it can.
3203 enum AVSampleFormat request_sample_fmt;
3206 * Error recognition; may misdetect some more or less valid parts as errors.
3207 * - encoding: unused
3208 * - decoding: Set by user.
3210 int err_recognition;
3211 #define AV_EF_CRCCHECK (1<<0)
3212 #define AV_EF_BITSTREAM (1<<1)
3213 #define AV_EF_BUFFER (1<<2)
3214 #define AV_EF_EXPLODE (1<<3)
3216 #define AV_EF_CAREFUL (1<<16)
3217 #define AV_EF_COMPLIANT (1<<17)
3218 #define AV_EF_AGGRESSIVE (1<<18)
3221 * Private context used for internal data.
3223 * Unlike priv_data, this is not codec-specific. It is used in general
3224 * libavcodec functions.
3226 struct AVCodecInternal *internal;
3229 * - encoding: set by libavcodec
3230 * - decoding: Set by libavcodec
3232 enum AVFieldOrder field_order;
3235 * Current statistics for PTS correction.
3236 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3237 * - encoding: unused
3239 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3240 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3241 int64_t pts_correction_last_pts; /// PTS of the last frame
3242 int64_t pts_correction_last_dts; /// DTS of the last frame
3249 typedef struct AVProfile {
3251 const char *name; ///< short name for the profile
3254 typedef struct AVCodecDefault AVCodecDefault;
3259 typedef struct AVCodec {
3261 * Name of the codec implementation.
3262 * The name is globally unique among encoders and among decoders (but an
3263 * encoder and a decoder can share the same name).
3264 * This is the primary way to find a codec from the user perspective.
3267 enum AVMediaType type;
3270 int (*init)(AVCodecContext *);
3271 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
3272 int (*close)(AVCodecContext *);
3273 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3275 * Codec capabilities.
3279 struct AVCodec *next;
3282 * Will be called when seeking
3284 void (*flush)(AVCodecContext *);
3285 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3286 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3288 * Descriptive name for the codec, meant to be more human readable than name.
3289 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3291 const char *long_name;
3292 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3293 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3294 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3295 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3296 const AVClass *priv_class; ///< AVClass for the private context
3297 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3300 * @name Frame-level threading support functions
3304 * If defined, called on thread contexts when they are created.
3305 * If the codec allocates writable tables in init(), re-allocate them here.
3306 * priv_data will be set to a copy of the original.
3308 int (*init_thread_copy)(AVCodecContext *);
3310 * Copy necessary context variables from a previous thread context to the current one.
3311 * If not defined, the next thread will start automatically; otherwise, the codec
3312 * must call ff_thread_finish_setup().
3314 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3316 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3320 * Private codec-specific defaults.
3322 const AVCodecDefault *defaults;
3325 * Initialize codec static data, called from avcodec_register().
3327 void (*init_static_data)(struct AVCodec *codec);
3330 * Encode data to an AVPacket.
3332 * @param avctx codec context
3333 * @param avpkt output AVPacket (may contain a user-provided buffer)
3334 * @param[in] frame AVFrame containing the raw data to be encoded
3335 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3336 * non-empty packet was returned in avpkt.
3337 * @return 0 on success, negative error code on failure
3339 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3340 int *got_packet_ptr);
3346 typedef struct AVHWAccel {
3348 * Name of the hardware accelerated codec.
3349 * The name is globally unique among encoders and among decoders (but an
3350 * encoder and a decoder can share the same name).
3355 * Type of codec implemented by the hardware accelerator.
3357 * See AVMEDIA_TYPE_xxx
3359 enum AVMediaType type;
3362 * Codec implemented by the hardware accelerator.
3369 * Supported pixel format.
3371 * Only hardware accelerated formats are supported here.
3373 enum PixelFormat pix_fmt;
3376 * Hardware accelerated codec capabilities.
3377 * see FF_HWACCEL_CODEC_CAP_*
3381 struct AVHWAccel *next;
3384 * Called at the beginning of each frame or field picture.
3386 * Meaningful frame information (codec specific) is guaranteed to
3387 * be parsed at this point. This function is mandatory.
3389 * Note that buf can be NULL along with buf_size set to 0.
3390 * Otherwise, this means the whole frame is available at this point.
3392 * @param avctx the codec context
3393 * @param buf the frame data buffer base
3394 * @param buf_size the size of the frame in bytes
3395 * @return zero if successful, a negative value otherwise
3397 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3400 * Callback for each slice.
3402 * Meaningful slice information (codec specific) is guaranteed to
3403 * be parsed at this point. This function is mandatory.
3405 * @param avctx the codec context
3406 * @param buf the slice data buffer base
3407 * @param buf_size the size of the slice in bytes
3408 * @return zero if successful, a negative value otherwise
3410 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3413 * Called at the end of each frame or field picture.
3415 * The whole picture is parsed at this point and can now be sent
3416 * to the hardware accelerator. This function is mandatory.
3418 * @param avctx the codec context
3419 * @return zero if successful, a negative value otherwise
3421 int (*end_frame)(AVCodecContext *avctx);
3424 * Size of HW accelerator private data.
3426 * Private data is allocated with av_mallocz() before
3427 * AVCodecContext.get_buffer() and deallocated after
3428 * AVCodecContext.release_buffer().
3434 * four components are given, that's all.
3435 * the last component is alpha
3437 typedef struct AVPicture {
3438 uint8_t *data[AV_NUM_DATA_POINTERS];
3439 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3442 #define AVPALETTE_SIZE 1024
3443 #define AVPALETTE_COUNT 256
3444 #if FF_API_PALETTE_CONTROL
3447 * This structure defines a method for communicating palette changes
3448 * between and demuxer and a decoder.
3450 * @deprecated Use AVPacket to send palette changes instead.
3451 * This is totally broken.
3453 typedef struct AVPaletteControl {
3455 /* Demuxer sets this to 1 to indicate the palette has changed;
3456 * decoder resets to 0. */
3457 int palette_changed;
3459 /* 4-byte ARGB palette entries, stored in native byte order; note that
3460 * the individual palette components should be on a 8-bit scale; if
3461 * the palette data comes from an IBM VGA native format, the component
3462 * data is probably 6 bits in size and needs to be scaled. */
3463 unsigned int palette[AVPALETTE_COUNT];
3465 } AVPaletteControl attribute_deprecated;
3468 enum AVSubtitleType {
3471 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3474 * Plain text, the text field must be set by the decoder and is
3475 * authoritative. ass and pict fields may contain approximations.
3480 * Formatted text, the ass field must be set by the decoder and is
3481 * authoritative. pict and text fields may contain approximations.
3486 typedef struct AVSubtitleRect {
3487 int x; ///< top left corner of pict, undefined when pict is not set
3488 int y; ///< top left corner of pict, undefined when pict is not set
3489 int w; ///< width of pict, undefined when pict is not set
3490 int h; ///< height of pict, undefined when pict is not set
3491 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3494 * data+linesize for the bitmap of this subtitle.
3495 * can be set for text/ass as well once they where rendered
3498 enum AVSubtitleType type;
3500 char *text; ///< 0 terminated plain UTF-8 text
3503 * 0 terminated ASS/SSA compatible event line.
3504 * The pressentation of this is unaffected by the other values in this
3510 typedef struct AVSubtitle {
3511 uint16_t format; /* 0 = graphics */
3512 uint32_t start_display_time; /* relative to packet pts, in ms */
3513 uint32_t end_display_time; /* relative to packet pts, in ms */
3515 AVSubtitleRect **rects;
3516 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3519 /* packet functions */
3522 * @deprecated use NULL instead
3524 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3527 * Default packet destructor.
3529 void av_destruct_packet(AVPacket *pkt);
3532 * Initialize optional fields of a packet with default values.
3536 void av_init_packet(AVPacket *pkt);
3539 * Allocate the payload of a packet and initialize its fields with
3543 * @param size wanted payload size
3544 * @return 0 if OK, AVERROR_xxx otherwise
3546 int av_new_packet(AVPacket *pkt, int size);
3549 * Reduce packet size, correctly zeroing padding
3552 * @param size new size
3554 void av_shrink_packet(AVPacket *pkt, int size);
3557 * Increase packet size, correctly zeroing padding
3560 * @param grow_by number of bytes by which to increase the size of the packet
3562 int av_grow_packet(AVPacket *pkt, int grow_by);
3565 * @warning This is a hack - the packet memory allocation stuff is broken. The
3566 * packet is allocated if it was not really allocated.
3568 int av_dup_packet(AVPacket *pkt);
3573 * @param pkt packet to free
3575 void av_free_packet(AVPacket *pkt);
3578 * Allocate new information of a packet.
3581 * @param type side information type
3582 * @param size side information size
3583 * @return pointer to fresh allocated data or NULL otherwise
3585 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3589 * Get side information from packet.
3592 * @param type desired side information type
3593 * @param size pointer for side information size to store (optional)
3594 * @return pointer to data if present or NULL otherwise
3596 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3599 int av_packet_merge_side_data(AVPacket *pkt);
3601 int av_packet_split_side_data(AVPacket *pkt);
3606 struct ReSampleContext;
3607 struct AVResampleContext;
3609 typedef struct ReSampleContext ReSampleContext;
3612 * Initialize audio resampling context.
3614 * @param output_channels number of output channels
3615 * @param input_channels number of input channels
3616 * @param output_rate output sample rate
3617 * @param input_rate input sample rate
3618 * @param sample_fmt_out requested output sample format
3619 * @param sample_fmt_in input sample format
3620 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3621 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3622 * @param linear if 1 then the used FIR filter will be linearly interpolated
3623 between the 2 closest, if 0 the closest will be used
3624 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3625 * @return allocated ReSampleContext, NULL if error occurred
3627 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3628 int output_rate, int input_rate,
3629 enum AVSampleFormat sample_fmt_out,
3630 enum AVSampleFormat sample_fmt_in,
3631 int filter_length, int log2_phase_count,
3632 int linear, double cutoff);
3634 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3637 * Free resample context.
3639 * @param s a non-NULL pointer to a resample context previously
3640 * created with av_audio_resample_init()
3642 void audio_resample_close(ReSampleContext *s);
3646 * Initialize an audio resampler.
3647 * Note, if either rate is not an integer then simply scale both rates up so they are.
3648 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3649 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3650 * @param linear If 1 then the used FIR filter will be linearly interpolated
3651 between the 2 closest, if 0 the closest will be used
3652 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3654 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3657 * Resample an array of samples using a previously configured context.
3658 * @param src an array of unconsumed samples
3659 * @param consumed the number of samples of src which have been consumed are returned here
3660 * @param src_size the number of unconsumed samples available
3661 * @param dst_size the amount of space in samples available in dst
3662 * @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.
3663 * @return the number of samples written in dst or -1 if an error occurred
3665 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3669 * Compensate samplerate/timestamp drift. The compensation is done by changing
3670 * the resampler parameters, so no audible clicks or similar distortions occur
3671 * @param compensation_distance distance in output samples over which the compensation should be performed
3672 * @param sample_delta number of output samples which should be output less
3674 * example: av_resample_compensate(c, 10, 500)
3675 * here instead of 510 samples only 500 samples would be output
3677 * note, due to rounding the actual compensation might be slightly different,
3678 * especially if the compensation_distance is large and the in_rate used during init is small
3680 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3681 void av_resample_close(struct AVResampleContext *c);
3684 * Allocate memory for a picture. Call avpicture_free() to free it.
3686 * @see avpicture_fill()
3688 * @param picture the picture to be filled in
3689 * @param pix_fmt the format of the picture
3690 * @param width the width of the picture
3691 * @param height the height of the picture
3692 * @return zero if successful, a negative value if not
3694 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3697 * Free a picture previously allocated by avpicture_alloc().
3698 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3701 * @param picture the AVPicture to be freed
3703 void avpicture_free(AVPicture *picture);
3706 * Fill in the AVPicture fields.
3707 * The fields of the given AVPicture are filled in by using the 'ptr' address
3708 * which points to the image data buffer. Depending on the specified picture
3709 * format, one or multiple image data pointers and line sizes will be set.
3710 * If a planar format is specified, several pointers will be set pointing to
3711 * the different picture planes and the line sizes of the different planes
3712 * will be stored in the lines_sizes array.
3713 * Call with ptr == NULL to get the required size for the ptr buffer.
3715 * To allocate the buffer and fill in the AVPicture fields in one call,
3716 * use avpicture_alloc().
3718 * @param picture AVPicture whose fields are to be filled in
3719 * @param ptr Buffer which will contain or contains the actual image data
3720 * @param pix_fmt The format in which the picture data is stored.
3721 * @param width the width of the image in pixels
3722 * @param height the height of the image in pixels
3723 * @return size of the image data in bytes
3725 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3726 enum PixelFormat pix_fmt, int width, int height);
3729 * Copy pixel data from an AVPicture into a buffer.
3730 * The data is stored compactly, without any gaps for alignment or padding
3731 * which may be applied by avpicture_fill().
3733 * @see avpicture_get_size()
3735 * @param[in] src AVPicture containing image data
3736 * @param[in] pix_fmt The format in which the picture data is stored.
3737 * @param[in] width the width of the image in pixels.
3738 * @param[in] height the height of the image in pixels.
3739 * @param[out] dest A buffer into which picture data will be copied.
3740 * @param[in] dest_size The size of 'dest'.
3741 * @return The number of bytes written to dest, or a negative value (error code) on error.
3743 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3744 unsigned char *dest, int dest_size);
3747 * Calculate the size in bytes that a picture of the given width and height
3748 * would occupy if stored in the given picture format.
3749 * Note that this returns the size of a compact representation as generated
3750 * by avpicture_layout(), which can be smaller than the size required for e.g.
3753 * @param pix_fmt the given picture format
3754 * @param width the width of the image
3755 * @param height the height of the image
3756 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3758 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3759 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3762 * Get the name of a codec.
3763 * @return a static string identifying the codec; never NULL
3765 const char *avcodec_get_name(enum CodecID id);
3767 #if FF_API_GET_PIX_FMT_NAME
3769 * Return the short name for a pixel format.
3771 * \see av_get_pix_fmt(), av_get_pix_fmt_string().
3772 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3774 attribute_deprecated
3775 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3778 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3781 * Return a value representing the fourCC code associated to the
3782 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3785 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3788 * Put a string representing the codec tag codec_tag in buf.
3790 * @param buf_size size in bytes of buf
3791 * @return the length of the string that would have been generated if
3792 * enough space had been available, excluding the trailing null
3794 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3796 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3797 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3798 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3799 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3800 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3801 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3804 * Compute what kind of losses will occur when converting from one specific
3805 * pixel format to another.
3806 * When converting from one pixel format to another, information loss may occur.
3807 * For example, when converting from RGB24 to GRAY, the color information will
3808 * be lost. Similarly, other losses occur when converting from some formats to
3809 * other formats. These losses can involve loss of chroma, but also loss of
3810 * resolution, loss of color depth, loss due to the color space conversion, loss
3811 * of the alpha bits or loss due to color quantization.
3812 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3813 * which will occur when converting from one pixel format to another.
3815 * @param[in] dst_pix_fmt destination pixel format
3816 * @param[in] src_pix_fmt source pixel format
3817 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3818 * @return Combination of flags informing you what kind of losses will occur
3819 * (maximum loss for an invalid dst_pix_fmt).
3821 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3825 * Find the best pixel format to convert to given a certain source pixel
3826 * format. When converting from one pixel format to another, information loss
3827 * may occur. For example, when converting from RGB24 to GRAY, the color
3828 * information will be lost. Similarly, other losses occur when converting from
3829 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3830 * the given pixel formats should be used to suffer the least amount of loss.
3831 * The pixel formats from which it chooses one, are determined by the
3832 * pix_fmt_mask parameter.
3834 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
3837 * src_pix_fmt = PIX_FMT_YUV420P;
3838 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
3839 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3842 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3843 * @param[in] src_pix_fmt source pixel format
3844 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3845 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3846 * @return The best pixel format to convert to or -1 if none was found.
3848 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3849 int has_alpha, int *loss_ptr);
3852 * Find the best pixel format to convert to given a certain source pixel
3853 * format and a selection of two destination pixel formats. When converting from
3854 * one pixel format to another, information loss may occur. For example, when converting
3855 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
3856 * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
3857 * the given pixel formats should be used to suffer the least amount of loss.
3859 * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
3863 * src_pix_fmt = PIX_FMT_YUV420P;
3864 * dst_pix_fmt1= PIX_FMT_RGB24;
3865 * dst_pix_fmt2= PIX_FMT_GRAY8;
3866 * dst_pix_fmt3= PIX_FMT_RGB8;
3867 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
3868 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
3869 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
3872 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
3873 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
3874 * @param[in] src_pix_fmt Source pixel format
3875 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3876 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
3877 * NULL or value of zero means we care about all losses. Out: the loss
3878 * that occurs when converting from src to selected dst pixel format.
3879 * @return The best pixel format to convert to or -1 if none was found.
3881 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
3882 enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
3884 #if FF_API_GET_ALPHA_INFO
3885 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3886 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3889 * Tell if an image really has transparent alpha values.
3890 * @return ored mask of FF_ALPHA_xxx constants
3892 attribute_deprecated
3893 int img_get_alpha_info(const AVPicture *src,
3894 enum PixelFormat pix_fmt, int width, int height);
3897 /* deinterlace a picture */
3898 /* deinterlace - if not supported return -1 */
3899 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3900 enum PixelFormat pix_fmt, int width, int height);
3902 /* external high level API */
3905 * If c is NULL, returns the first registered codec,
3906 * if c is non-NULL, returns the next registered codec after c,
3907 * or NULL if c is the last one.
3909 AVCodec *av_codec_next(AVCodec *c);
3912 * Return the LIBAVCODEC_VERSION_INT constant.
3914 unsigned avcodec_version(void);
3917 * Return the libavcodec build-time configuration.
3919 const char *avcodec_configuration(void);
3922 * Return the libavcodec license.
3924 const char *avcodec_license(void);
3926 #if FF_API_AVCODEC_INIT
3928 * @deprecated this function is called automatically from avcodec_register()
3929 * and avcodec_register_all(), there is no need to call it manually
3931 attribute_deprecated
3932 void avcodec_init(void);
3936 * Register the codec codec and initialize libavcodec.
3938 * @warning either this function or avcodec_register_all() must be called
3939 * before any other libavcodec functions.
3941 * @see avcodec_register_all()
3943 void avcodec_register(AVCodec *codec);
3946 * Find a registered encoder with a matching codec ID.
3948 * @param id CodecID of the requested encoder
3949 * @return An encoder if one was found, NULL otherwise.
3951 AVCodec *avcodec_find_encoder(enum CodecID id);
3954 * Find a registered encoder with the specified name.
3956 * @param name name of the requested encoder
3957 * @return An encoder if one was found, NULL otherwise.
3959 AVCodec *avcodec_find_encoder_by_name(const char *name);
3962 * Find a registered decoder with a matching codec ID.
3964 * @param id CodecID of the requested decoder
3965 * @return A decoder if one was found, NULL otherwise.
3967 AVCodec *avcodec_find_decoder(enum CodecID id);
3970 * Find a registered decoder with the specified name.
3972 * @param name name of the requested decoder
3973 * @return A decoder if one was found, NULL otherwise.
3975 AVCodec *avcodec_find_decoder_by_name(const char *name);
3976 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3979 * Return a name for the specified profile, if available.
3981 * @param codec the codec that is searched for the given profile
3982 * @param profile the profile value for which a name is requested
3983 * @return A name for the profile if found, NULL otherwise.
3985 const char *av_get_profile_name(const AVCodec *codec, int profile);
3987 #if FF_API_ALLOC_CONTEXT
3989 * Set the fields of the given AVCodecContext to default values.
3991 * @param s The AVCodecContext of which the fields should be set to default values.
3992 * @deprecated use avcodec_get_context_defaults3
3994 attribute_deprecated
3995 void avcodec_get_context_defaults(AVCodecContext *s);
3997 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3998 * we WILL change its arguments and name a few times! */
3999 attribute_deprecated
4000 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
4004 * Set the fields of the given AVCodecContext to default values corresponding
4005 * to the given codec (defaults may be codec-dependent).
4007 * Do not call this function if a non-NULL codec has been passed
4008 * to avcodec_alloc_context3() that allocated this AVCodecContext.
4009 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
4010 * different codec on this AVCodecContext.
4012 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
4014 #if FF_API_ALLOC_CONTEXT
4016 * Allocate an AVCodecContext and set its fields to default values. The
4017 * resulting struct can be deallocated by simply calling av_free().
4019 * @return An AVCodecContext filled with default values or NULL on failure.
4020 * @see avcodec_get_context_defaults
4022 * @deprecated use avcodec_alloc_context3()
4024 attribute_deprecated
4025 AVCodecContext *avcodec_alloc_context(void);
4027 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
4028 * we WILL change its arguments and name a few times! */
4029 attribute_deprecated
4030 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
4034 * Allocate an AVCodecContext and set its fields to default values. The
4035 * resulting struct can be deallocated by simply calling av_free().
4037 * @param codec if non-NULL, allocate private data and initialize defaults
4038 * for the given codec. It is illegal to then call avcodec_open2()
4039 * with a different codec.
4041 * @return An AVCodecContext filled with default values or NULL on failure.
4042 * @see avcodec_get_context_defaults
4044 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
4047 * Copy the settings of the source AVCodecContext into the destination
4048 * AVCodecContext. The resulting destination codec context will be
4049 * unopened, i.e. you are required to call avcodec_open2() before you
4050 * can use this AVCodecContext to decode/encode video/audio data.
4052 * @param dest target codec context, should be initialized with
4053 * avcodec_alloc_context3(), but otherwise uninitialized
4054 * @param src source codec context
4055 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4057 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4060 * Set the fields of the given AVFrame to default values.
4062 * @param pic The AVFrame of which the fields should be set to default values.
4064 void avcodec_get_frame_defaults(AVFrame *pic);
4067 * Allocate an AVFrame and set its fields to default values. The resulting
4068 * struct can be deallocated by simply calling av_free().
4070 * @return An AVFrame filled with default values or NULL on failure.
4071 * @see avcodec_get_frame_defaults
4073 AVFrame *avcodec_alloc_frame(void);
4075 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
4076 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
4077 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
4080 * Return the amount of padding in pixels which the get_buffer callback must
4081 * provide around the edge of the image for codecs which do not have the
4082 * CODEC_FLAG_EMU_EDGE flag.
4084 * @return Required padding in pixels.
4086 unsigned avcodec_get_edge_width(void);
4088 * Modify width and height values so that they will result in a memory
4089 * buffer that is acceptable for the codec if you do not use any horizontal
4092 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
4093 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
4094 * according to avcodec_get_edge_width() before.
4096 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4098 * Modify width and height values so that they will result in a memory
4099 * buffer that is acceptable for the codec if you also ensure that all
4100 * line sizes are a multiple of the respective linesize_align[i].
4102 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
4103 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
4104 * according to avcodec_get_edge_width() before.
4106 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4107 int linesize_align[AV_NUM_DATA_POINTERS]);
4109 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4111 #if FF_API_THREAD_INIT
4113 * @deprecated Set s->thread_count before calling avcodec_open2() instead of calling this.
4115 attribute_deprecated
4116 int avcodec_thread_init(AVCodecContext *s, int thread_count);
4119 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4120 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4121 //FIXME func typedef
4123 #if FF_API_AVCODEC_OPEN
4125 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4126 * function the context has to be allocated.
4128 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4129 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4130 * retrieving a codec.
4132 * @warning This function is not thread safe!
4135 * avcodec_register_all();
4136 * codec = avcodec_find_decoder(CODEC_ID_H264);
4140 * context = avcodec_alloc_context3(codec);
4142 * if (avcodec_open(context, codec) < 0)
4146 * @param avctx The context which will be set up to use the given codec.
4147 * @param codec The codec to use within the context.
4148 * @return zero on success, a negative value on error
4149 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
4151 * @deprecated use avcodec_open2
4153 attribute_deprecated
4154 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
4158 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4159 * function the context has to be allocated with avcodec_alloc_context3().
4161 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4162 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4163 * retrieving a codec.
4165 * @warning This function is not thread safe!
4168 * avcodec_register_all();
4169 * av_dict_set(&opts, "b", "2.5M", 0);
4170 * codec = avcodec_find_decoder(CODEC_ID_H264);
4174 * context = avcodec_alloc_context3(codec);
4176 * if (avcodec_open2(context, codec, opts) < 0)
4180 * @param avctx The context to initialize.
4181 * @param options A dictionary filled with AVCodecContext and codec-private options.
4182 * On return this object will be filled with options that were not found.
4184 * @return zero on success, a negative value on error
4185 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4186 * av_dict_set(), av_opt_find().
4188 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
4190 #if FF_API_OLD_DECODE_AUDIO
4192 * Wrapper function which calls avcodec_decode_audio4.
4194 * @deprecated Use avcodec_decode_audio4 instead.
4196 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
4197 * Some decoders may support multiple frames in a single AVPacket, such
4198 * decoders would then just decode the first frame. In this case,
4199 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
4200 * the remaining data in order to decode the second frame etc.
4202 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
4203 * decompressed frame size in bytes.
4205 * @warning You must set frame_size_ptr to the allocated size of the
4206 * output buffer before calling avcodec_decode_audio3().
4208 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4209 * the actual read bytes because some optimized bitstream readers read 32 or 64
4210 * bits at once and could read over the end.
4212 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
4213 * no overreading happens for damaged MPEG streams.
4215 * @warning You must not provide a custom get_buffer() when using
4216 * avcodec_decode_audio3(). Doing so will override it with
4217 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
4218 * which does allow the application to provide a custom get_buffer().
4220 * @note You might have to align the input buffer avpkt->data and output buffer
4221 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
4222 * necessary at all, on others it won't work at all if not aligned and on others
4223 * it will work but it will have an impact on performance.
4225 * In practice, avpkt->data should have 4 byte alignment at minimum and
4226 * samples should be 16 byte aligned unless the CPU doesn't need it
4227 * (AltiVec and SSE do).
4229 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4230 * between input and output, these need to be fed with avpkt->data=NULL,
4231 * avpkt->size=0 at the end to return the remaining frames.
4233 * @param avctx the codec context
4234 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
4235 * If the sample format is planar, each channel plane will
4236 * be the same size, with no padding between channels.
4237 * @param[in,out] frame_size_ptr the output buffer size in bytes
4238 * @param[in] avpkt The input AVPacket containing the input buffer.
4239 * You can create such packet with av_init_packet() and by then setting
4240 * data and size, some decoders might in addition need other fields.
4241 * All decoders are designed to use the least fields possible though.
4242 * @return On error a negative value is returned, otherwise the number of bytes
4243 * used or zero if no frame data was decompressed (used) from the input AVPacket.
4245 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
4246 int *frame_size_ptr,
4251 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4253 * Some decoders may support multiple frames in a single AVPacket. Such
4254 * decoders would then just decode the first frame. In this case,
4255 * avcodec_decode_audio4 has to be called again with an AVPacket containing
4256 * the remaining data in order to decode the second frame, etc...
4257 * Even if no frames are returned, the packet needs to be fed to the decoder
4258 * with remaining data until it is completely consumed or an error occurs.
4260 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
4261 * larger than the actual read bytes because some optimized bitstream
4262 * readers read 32 or 64 bits at once and could read over the end.
4264 * @note You might have to align the input buffer. The alignment requirements
4265 * depend on the CPU and the decoder.
4267 * @param avctx the codec context
4268 * @param[out] frame The AVFrame in which to store decoded audio samples.
4269 * Decoders request a buffer of a particular size by setting
4270 * AVFrame.nb_samples prior to calling get_buffer(). The
4271 * decoder may, however, only utilize part of the buffer by
4272 * setting AVFrame.nb_samples to a smaller value in the
4274 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4276 * @param[in] avpkt The input AVPacket containing the input buffer.
4277 * At least avpkt->data and avpkt->size should be set. Some
4278 * decoders might also require additional fields to be set.
4279 * @return A negative error code is returned if an error occurred during
4280 * decoding, otherwise the number of bytes consumed from the input
4281 * AVPacket is returned.
4283 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4284 int *got_frame_ptr, AVPacket *avpkt);
4287 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4288 * Some decoders may support multiple frames in a single AVPacket, such
4289 * decoders would then just decode the first frame.
4291 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4292 * the actual read bytes because some optimized bitstream readers read 32 or 64
4293 * bits at once and could read over the end.
4295 * @warning The end of the input buffer buf should be set to 0 to ensure that
4296 * no overreading happens for damaged MPEG streams.
4298 * @note You might have to align the input buffer avpkt->data.
4299 * The alignment requirements depend on the CPU: on some CPUs it isn't
4300 * necessary at all, on others it won't work at all if not aligned and on others
4301 * it will work but it will have an impact on performance.
4303 * In practice, avpkt->data should have 4 byte alignment at minimum.
4305 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4306 * between input and output, these need to be fed with avpkt->data=NULL,
4307 * avpkt->size=0 at the end to return the remaining frames.
4309 * @param avctx the codec context
4310 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4311 * Use avcodec_alloc_frame to get an AVFrame, the codec will
4312 * allocate memory for the actual bitmap.
4313 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
4314 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
4315 * decodes and the decoder tells the user once it does not need the data anymore,
4316 * the user app can at this point free/reuse/keep the memory as it sees fit.
4318 * @param[in] avpkt The input AVpacket containing the input buffer.
4319 * You can create such packet with av_init_packet() and by then setting
4320 * data and size, some decoders might in addition need other fields like
4321 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4323 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4324 * @return On error a negative value is returned, otherwise the number of bytes
4325 * used or zero if no frame could be decompressed.
4327 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4328 int *got_picture_ptr,
4329 const AVPacket *avpkt);
4332 * Decode a subtitle message.
4333 * Return a negative value on error, otherwise return the number of bytes used.
4334 * If no subtitle could be decompressed, got_sub_ptr is zero.
4335 * Otherwise, the subtitle is stored in *sub.
4336 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4337 * simplicity, because the performance difference is expect to be negligible
4338 * and reusing a get_buffer written for video codecs would probably perform badly
4339 * due to a potentially very different allocation pattern.
4341 * @param avctx the codec context
4342 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4343 freed with avsubtitle_free if *got_sub_ptr is set.
4344 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4345 * @param[in] avpkt The input AVPacket containing the input buffer.
4347 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4352 * Free all allocated data in the given subtitle struct.
4354 * @param sub AVSubtitle to free.
4356 void avsubtitle_free(AVSubtitle *sub);
4358 #if FF_API_OLD_ENCODE_AUDIO
4360 * Encode an audio frame from samples into buf.
4362 * @deprecated Use avcodec_encode_audio2 instead.
4364 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4365 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4366 * will know how much space is needed because it depends on the value passed
4367 * in buf_size as described below. In that case a lower value can be used.
4369 * @param avctx the codec context
4370 * @param[out] buf the output buffer
4371 * @param[in] buf_size the output buffer size
4372 * @param[in] samples the input buffer containing the samples
4373 * The number of samples read from this buffer is frame_size*channels,
4374 * both of which are defined in avctx.
4375 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4376 * samples read from samples is equal to:
4377 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4378 * This also implies that av_get_bits_per_sample() must not return 0 for these
4380 * @return On error a negative value is returned, on success zero or the number
4381 * of bytes used to encode the data read from the input buffer.
4383 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4384 uint8_t *buf, int buf_size,
4385 const short *samples);
4389 * Encode a frame of audio.
4391 * Takes input samples from frame and writes the next output packet, if
4392 * available, to avpkt. The output packet does not necessarily contain data for
4393 * the most recent frame, as encoders can delay, split, and combine input frames
4394 * internally as needed.
4396 * @param avctx codec context
4397 * @param avpkt output AVPacket.
4398 * The user can supply an output buffer by setting
4399 * avpkt->data and avpkt->size prior to calling the
4400 * function, but if the size of the user-provided data is not
4401 * large enough, encoding will fail. All other AVPacket fields
4402 * will be reset by the encoder using av_init_packet(). If
4403 * avpkt->data is NULL, the encoder will allocate it.
4404 * The encoder will set avpkt->size to the size of the
4406 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4407 * May be NULL when flushing an encoder that has the
4408 * CODEC_CAP_DELAY capability set.
4409 * There are 2 codec capabilities that affect the allowed
4410 * values of frame->nb_samples.
4411 * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
4412 * frame may be smaller than avctx->frame_size, and all other
4413 * frames must be equal to avctx->frame_size.
4414 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4415 * can have any number of samples.
4416 * If neither is set, frame->nb_samples must be equal to
4417 * avctx->frame_size for all frames.
4418 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4419 * output packet is non-empty, and to 0 if it is
4420 * empty. If the function returns an error, the
4421 * packet can be assumed to be invalid, and the
4422 * value of got_packet_ptr is undefined and should
4424 * @return 0 on success, negative error code on failure
4426 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4427 const AVFrame *frame, int *got_packet_ptr);
4430 * Fill audio frame data and linesize.
4431 * AVFrame extended_data channel pointers are allocated if necessary for
4434 * @param frame the AVFrame
4435 * frame->nb_samples must be set prior to calling the
4436 * function. This function fills in frame->data,
4437 * frame->extended_data, frame->linesize[0].
4438 * @param nb_channels channel count
4439 * @param sample_fmt sample format
4440 * @param buf buffer to use for frame data
4441 * @param buf_size size of buffer
4442 * @param align plane size sample alignment
4443 * @return 0 on success, negative error code on failure
4445 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4446 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4447 int buf_size, int align);
4450 * Encode a video frame from pict into buf.
4451 * The input picture should be
4452 * stored using a specific format, namely avctx.pix_fmt.
4454 * @param avctx the codec context
4455 * @param[out] buf the output buffer for the bitstream of encoded frame
4456 * @param[in] buf_size the size of the output buffer in bytes
4457 * @param[in] pict the input picture to encode
4458 * @return On error a negative value is returned, on success zero or the number
4459 * of bytes used from the output buffer.
4461 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4462 const AVFrame *pict);
4463 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4464 const AVSubtitle *sub);
4466 int avcodec_close(AVCodecContext *avctx);
4469 * Register all the codecs, parsers and bitstream filters which were enabled at
4470 * configuration time. If you do not call this function you can select exactly
4471 * which formats you want to support, by using the individual registration
4474 * @see avcodec_register
4475 * @see av_register_codec_parser
4476 * @see av_register_bitstream_filter
4478 void avcodec_register_all(void);
4481 * Flush buffers, should be called when seeking or when switching to a different stream.
4483 void avcodec_flush_buffers(AVCodecContext *avctx);
4485 void avcodec_default_free_buffers(AVCodecContext *s);
4487 /* misc useful functions */
4489 #if FF_API_OLD_FF_PICT_TYPES
4491 * Return a single letter to describe the given picture type pict_type.
4493 * @param[in] pict_type the picture type
4494 * @return A single character representing the picture type.
4495 * @deprecated Use av_get_picture_type_char() instead.
4497 attribute_deprecated
4498 char av_get_pict_type_char(int pict_type);
4502 * Return codec bits per sample.
4504 * @param[in] codec_id the codec
4505 * @return Number of bits per sample or zero if unknown for the given codec.
4507 int av_get_bits_per_sample(enum CodecID codec_id);
4509 #if FF_API_OLD_SAMPLE_FMT
4511 * @deprecated Use av_get_bytes_per_sample() instead.
4513 attribute_deprecated
4514 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
4518 typedef struct AVCodecParserContext {
4520 struct AVCodecParser *parser;
4521 int64_t frame_offset; /* offset of the current frame */
4522 int64_t cur_offset; /* current offset
4523 (incremented by each av_parser_parse()) */
4524 int64_t next_frame_offset; /* offset of the next frame */
4526 int pict_type; /* XXX: Put it back in AVCodecContext. */
4528 * This field is used for proper frame duration computation in lavf.
4529 * It signals, how much longer the frame duration of the current frame
4530 * is compared to normal frame duration.
4532 * frame_duration = (1 + repeat_pict) * time_base
4534 * It is used by codecs like H.264 to display telecined material.
4536 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4537 int64_t pts; /* pts of the current frame */
4538 int64_t dts; /* dts of the current frame */
4543 int fetch_timestamp;
4545 #define AV_PARSER_PTS_NB 4
4546 int cur_frame_start_index;
4547 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4548 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4549 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4552 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4553 #define PARSER_FLAG_ONCE 0x0002
4554 /// Set if the parser has a valid file offset
4555 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4557 int64_t offset; ///< byte offset from starting packet start
4558 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4561 * Set by parser to 1 for key frames and 0 for non-key frames.
4562 * It is initialized to -1, so if the parser doesn't set this flag,
4563 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4569 * Time difference in stream time base units from the pts of this
4570 * packet to the point at which the output from the decoder has converged
4571 * independent from the availability of previous frames. That is, the
4572 * frames are virtually identical no matter if decoding started from
4573 * the very first frame or from this keyframe.
4574 * Is AV_NOPTS_VALUE if unknown.
4575 * This field is not the display duration of the current frame.
4576 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4579 * The purpose of this field is to allow seeking in streams that have no
4580 * keyframes in the conventional sense. It corresponds to the
4581 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4582 * essential for some types of subtitle streams to ensure that all
4583 * subtitles are correctly displayed after seeking.
4585 int64_t convergence_duration;
4587 // Timestamp generation support:
4589 * Synchronization point for start of timestamp generation.
4591 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4594 * For example, this corresponds to presence of H.264 buffering period
4600 * Offset of the current timestamp against last timestamp sync point in
4601 * units of AVCodecContext.time_base.
4603 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4604 * contain a valid timestamp offset.
4606 * Note that the timestamp of sync point has usually a nonzero
4607 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4608 * the next frame after timestamp sync point will be usually 1.
4610 * For example, this corresponds to H.264 cpb_removal_delay.
4612 int dts_ref_dts_delta;
4615 * Presentation delay of current frame in units of AVCodecContext.time_base.
4617 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4618 * contain valid non-negative timestamp delta (presentation time of a frame
4619 * must not lie in the past).
4621 * This delay represents the difference between decoding and presentation
4622 * time of the frame.
4624 * For example, this corresponds to H.264 dpb_output_delay.
4629 * Position of the packet in file.
4631 * Analogous to cur_frame_pts/dts
4633 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4636 * Byte position of currently parsed frame in stream.
4641 * Previous frame byte position.
4644 } AVCodecParserContext;
4646 typedef struct AVCodecParser {
4647 int codec_ids[5]; /* several codec IDs are permitted */
4649 int (*parser_init)(AVCodecParserContext *s);
4650 int (*parser_parse)(AVCodecParserContext *s,
4651 AVCodecContext *avctx,
4652 const uint8_t **poutbuf, int *poutbuf_size,
4653 const uint8_t *buf, int buf_size);
4654 void (*parser_close)(AVCodecParserContext *s);
4655 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4656 struct AVCodecParser *next;
4659 AVCodecParser *av_parser_next(AVCodecParser *c);
4661 void av_register_codec_parser(AVCodecParser *parser);
4662 AVCodecParserContext *av_parser_init(int codec_id);
4667 * @param s parser context.
4668 * @param avctx codec context.
4669 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4670 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4671 * @param buf input buffer.
4672 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4673 * @param pts input presentation timestamp.
4674 * @param dts input decoding timestamp.
4675 * @param pos input byte position in stream.
4676 * @return the number of bytes of the input bitstream used.
4681 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4688 * decode_frame(data, size);
4692 int av_parser_parse2(AVCodecParserContext *s,
4693 AVCodecContext *avctx,
4694 uint8_t **poutbuf, int *poutbuf_size,
4695 const uint8_t *buf, int buf_size,
4696 int64_t pts, int64_t dts,
4699 int av_parser_change(AVCodecParserContext *s,
4700 AVCodecContext *avctx,
4701 uint8_t **poutbuf, int *poutbuf_size,
4702 const uint8_t *buf, int buf_size, int keyframe);
4703 void av_parser_close(AVCodecParserContext *s);
4706 typedef struct AVBitStreamFilterContext {
4708 struct AVBitStreamFilter *filter;
4709 AVCodecParserContext *parser;
4710 struct AVBitStreamFilterContext *next;
4711 } AVBitStreamFilterContext;
4714 typedef struct AVBitStreamFilter {
4717 int (*filter)(AVBitStreamFilterContext *bsfc,
4718 AVCodecContext *avctx, const char *args,
4719 uint8_t **poutbuf, int *poutbuf_size,
4720 const uint8_t *buf, int buf_size, int keyframe);
4721 void (*close)(AVBitStreamFilterContext *bsfc);
4722 struct AVBitStreamFilter *next;
4723 } AVBitStreamFilter;
4725 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4726 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4727 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4728 AVCodecContext *avctx, const char *args,
4729 uint8_t **poutbuf, int *poutbuf_size,
4730 const uint8_t *buf, int buf_size, int keyframe);
4731 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4733 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4738 * Reallocate the given block if it is not large enough, otherwise do nothing.
4742 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4745 * Allocate a buffer, reusing the given one if large enough.
4747 * Contrary to av_fast_realloc the current buffer contents might not be
4748 * preserved and on error the old buffer is freed, thus no special
4749 * handling to avoid memleaks is necessary.
4751 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4752 * @param size size of the buffer *ptr points to
4753 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4754 * *size 0 if an error occurred.
4756 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4759 * Same behaviour av_fast_malloc but the buffer has additional
4760 * FF_INPUT_PADDING_SIZE at the end which will will always be 0.
4762 * In addition the whole buffer will initially and after resizes
4763 * be 0-initialized so that no uninitialized data will ever appear.
4765 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4768 * Copy image src to dst. Wraps av_picture_data_copy() above.
4770 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4771 enum PixelFormat pix_fmt, int width, int height);
4774 * Crop image top and left side.
4776 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4777 enum PixelFormat pix_fmt, int top_band, int left_band);
4782 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4783 int padtop, int padbottom, int padleft, int padright, int *color);
4786 * Encode extradata length to a buffer. Used by xiph codecs.
4788 * @param s buffer to write to; must be at least (v/255+1) bytes long
4789 * @param v size of extradata in bytes
4790 * @return number of bytes written to the buffer.
4792 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4795 * Log a generic warning message about a missing feature. This function is
4796 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4797 * only, and would normally not be used by applications.
4798 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4799 * a pointer to an AVClass struct
4800 * @param[in] feature string containing the name of the missing feature
4801 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4802 * If want_sample is non-zero, additional verbage will be added to the log
4803 * message which tells the user how to report samples to the development
4806 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4809 * Log a generic warning message asking for a sample. This function is
4810 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4811 * only, and would normally not be used by applications.
4812 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4813 * a pointer to an AVClass struct
4814 * @param[in] msg string containing an optional message, or NULL if no message
4816 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4819 * Register the hardware accelerator hwaccel.
4821 void av_register_hwaccel(AVHWAccel *hwaccel);
4824 * If hwaccel is NULL, returns the first registered hardware accelerator,
4825 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4826 * after hwaccel, or NULL if hwaccel is the last one.
4828 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4832 * Lock operation used by lockmgr
4835 AV_LOCK_CREATE, ///< Create a mutex
4836 AV_LOCK_OBTAIN, ///< Lock the mutex
4837 AV_LOCK_RELEASE, ///< Unlock the mutex
4838 AV_LOCK_DESTROY, ///< Free mutex resources
4842 * Register a user provided lock manager supporting the operations
4843 * specified by AVLockOp. mutex points to a (void *) where the
4844 * lockmgr should store/get a pointer to a user allocated mutex. It's
4845 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4847 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4848 * callback during the call to av_lockmgr_register().
4849 * Thus, the application must be prepared to handle that.
4850 * If cb is set to NULL the lockmgr will be unregistered.
4851 * Also note that during unregistration the previously registered
4852 * lockmgr callback may also be invoked.
4854 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4857 * Get the type of the given codec.
4859 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4862 * Get the AVClass for AVCodecContext. It can be used in combination with
4863 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4865 * @see av_opt_find().
4867 const AVClass *avcodec_get_class(void);
4870 * Get the AVClass for AVFrame. It can be used in combination with
4871 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4873 * @see av_opt_find().
4875 const AVClass *avcodec_get_frame_class(void);
4877 #endif /* AVCODEC_AVCODEC_H */