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"
37 #include "libavutil/audioconvert.h"
39 #include "libavcodec/version.h"
41 * @defgroup libavc Encoding/Decoding Library
44 * @defgroup lavc_decoding Decoding
48 * @defgroup lavc_encoding Encoding
52 * @defgroup lavc_codec Codecs
54 * @defgroup lavc_codec_native Native Codecs
57 * @defgroup lavc_codec_wrappers External library wrappers
60 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
64 * @defgroup lavc_internal Internal
72 * @defgroup lavc_core Core functions/structures.
75 * Basic definitions, functions for querying libavcodec capabilities,
76 * allocating core structures, etc.
81 * Identify the syntax and semantics of the bitstream.
82 * The principle is roughly:
83 * Two decoders with the same ID can decode the same streams.
84 * Two encoders with the same ID can encode compatible streams.
85 * There may be slight deviations from the principle due to implementation
88 * If you add a codec ID to this list, add it so that
89 * 1. no value of a existing codec ID changes (that would break ABI),
90 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
91 * This ensures that 2 forks can independently add CodecIDs without producing conflicts.
98 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
99 CODEC_ID_MPEG2VIDEO_XVMC,
136 CODEC_ID_INTERPLAY_VIDEO,
148 CODEC_ID_TRUEMOTION1,
175 CODEC_ID_TRUEMOTION2,
192 CODEC_ID_DSICINVIDEO,
193 CODEC_ID_TIERTEXSEQVIDEO,
201 CODEC_ID_BETHSOFTVID,
217 CODEC_ID_MOTIONPIXELS,
235 CODEC_ID_IFF_BYTERUN1,
261 CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
262 CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
263 CODEC_ID_EXR = MKBETAG('0','E','X','R'),
264 CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
266 CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
267 CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
268 CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
269 CODEC_ID_V308 = MKBETAG('V','3','0','8'),
270 CODEC_ID_V408 = MKBETAG('V','4','0','8'),
271 CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
272 CODEC_ID_SANM = MKBETAG('S','A','N','M'),
274 /* various PCM "codecs" */
275 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
276 CODEC_ID_PCM_S16LE = 0x10000,
292 CODEC_ID_PCM_S24DAUD,
294 CODEC_ID_PCM_S16LE_PLANAR,
303 CODEC_ID_PCM_S8_PLANAR,
305 /* various ADPCM codecs */
306 CODEC_ID_ADPCM_IMA_QT = 0x11000,
307 CODEC_ID_ADPCM_IMA_WAV,
308 CODEC_ID_ADPCM_IMA_DK3,
309 CODEC_ID_ADPCM_IMA_DK4,
310 CODEC_ID_ADPCM_IMA_WS,
311 CODEC_ID_ADPCM_IMA_SMJPEG,
320 CODEC_ID_ADPCM_YAMAHA,
321 CODEC_ID_ADPCM_SBPRO_4,
322 CODEC_ID_ADPCM_SBPRO_3,
323 CODEC_ID_ADPCM_SBPRO_2,
325 CODEC_ID_ADPCM_IMA_AMV,
326 CODEC_ID_ADPCM_EA_R1,
327 CODEC_ID_ADPCM_EA_R3,
328 CODEC_ID_ADPCM_EA_R2,
329 CODEC_ID_ADPCM_IMA_EA_SEAD,
330 CODEC_ID_ADPCM_IMA_EA_EACS,
331 CODEC_ID_ADPCM_EA_XAS,
332 CODEC_ID_ADPCM_EA_MAXIS_XA,
333 CODEC_ID_ADPCM_IMA_ISS,
335 CODEC_ID_ADPCM_IMA_APC,
336 CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
339 CODEC_ID_AMR_NB = 0x12000,
342 /* RealAudio codecs*/
343 CODEC_ID_RA_144 = 0x13000,
346 /* various DPCM codecs */
347 CODEC_ID_ROQ_DPCM = 0x14000,
348 CODEC_ID_INTERPLAY_DPCM,
353 CODEC_ID_MP2 = 0x15000,
354 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
370 CODEC_ID_WESTWOOD_SND1,
371 CODEC_ID_GSM, ///< as in Berlin toast format
379 CODEC_ID_DSICINAUDIO,
383 CODEC_ID_GSM_MS, /* as found in WAV */
392 CODEC_ID_WMALOSSLESS,
401 CODEC_ID_BINKAUDIO_RDFT,
402 CODEC_ID_BINKAUDIO_DCT,
414 CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
415 CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
416 CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
417 CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
419 /* subtitle codecs */
420 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
421 CODEC_ID_DVD_SUBTITLE = 0x17000,
422 CODEC_ID_DVB_SUBTITLE,
423 CODEC_ID_TEXT, ///< raw UTF-8 text
427 CODEC_ID_HDMV_PGS_SUBTITLE,
428 CODEC_ID_DVB_TELETEXT,
430 CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
431 CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
432 CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
433 CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
434 CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
436 /* other specific kind of codecs (generally used for attachments) */
437 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
438 CODEC_ID_TTF = 0x18000,
439 CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
440 CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
441 CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
443 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
445 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
446 * stream (only used by libavformat) */
447 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
448 * stream (only used by libavformat) */
449 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
452 #if FF_API_OLD_DECODE_AUDIO
454 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
458 * @ingroup lavc_decoding
459 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
460 * This is mainly needed because some optimized bitstream readers read
461 * 32 or 64 bit at once and could read over the end.<br>
462 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
463 * MPEG bitstreams could cause overread and segfault.
465 #define FF_INPUT_BUFFER_PADDING_SIZE 16
468 * @ingroup lavc_encoding
469 * minimum encoding buffer size
470 * Used to avoid some checks during header writing.
472 #define FF_MIN_BUFFER_SIZE 16384
476 * @ingroup lavc_encoding
477 * motion estimation type.
480 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
484 ME_EPZS, ///< enhanced predictive zonal search
485 ME_X1, ///< reserved for experiments
486 ME_HEX, ///< hexagon based search
487 ME_UMH, ///< uneven multi-hexagon search
488 ME_ITER, ///< iterative search
489 ME_TESA, ///< transformed exhaustive search algorithm
493 * @ingroup lavc_decoding
496 /* We leave some space between them for extensions (drop some
497 * keyframes for intra-only or drop just some bidir frames). */
498 AVDISCARD_NONE =-16, ///< discard nothing
499 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
500 AVDISCARD_NONREF = 8, ///< discard all non reference
501 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
502 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
503 AVDISCARD_ALL = 48, ///< discard all
506 enum AVColorPrimaries{
507 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
508 AVCOL_PRI_UNSPECIFIED = 2,
509 AVCOL_PRI_BT470M = 4,
510 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
511 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
512 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
514 AVCOL_PRI_NB , ///< Not part of ABI
517 enum AVColorTransferCharacteristic{
518 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
519 AVCOL_TRC_UNSPECIFIED = 2,
520 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
521 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
522 AVCOL_TRC_SMPTE240M = 7,
523 AVCOL_TRC_NB , ///< Not part of ABI
528 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
529 AVCOL_SPC_UNSPECIFIED = 2,
531 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
532 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
533 AVCOL_SPC_SMPTE240M = 7,
534 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
535 AVCOL_SPC_NB , ///< Not part of ABI
537 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
540 AVCOL_RANGE_UNSPECIFIED = 0,
541 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
542 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
543 AVCOL_RANGE_NB , ///< Not part of ABI
547 * X X 3 4 X X are luma samples,
548 * 1 2 1-6 are possible chroma positions
549 * X X 5 6 X 0 is undefined/unknown position
551 enum AVChromaLocation{
552 AVCHROMA_LOC_UNSPECIFIED = 0,
553 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
554 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
555 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
556 AVCHROMA_LOC_TOP = 4,
557 AVCHROMA_LOC_BOTTOMLEFT = 5,
558 AVCHROMA_LOC_BOTTOM = 6,
559 AVCHROMA_LOC_NB , ///< Not part of ABI
562 enum AVAudioServiceType {
563 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
564 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
565 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
566 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
567 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
568 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
569 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
570 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
571 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
572 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
576 * @ingroup lavc_encoding
578 typedef struct RcOverride{
581 int qscale; // If this is 0 then quality_factor will be used instead.
582 float quality_factor;
585 #define FF_MAX_B_FRAMES 16
588 These flags can be passed in AVCodecContext.flags before initialization.
589 Note: Not everything is supported yet.
592 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
593 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
594 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
595 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
596 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
598 * The parent program guarantees that the input for B-frames containing
599 * streams is not written to for at least s->max_b_frames+1 frames, if
600 * this is not set the input will be copied.
602 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
603 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
604 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
605 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
606 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
607 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
608 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
609 location instead of only at frame boundaries. */
610 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
611 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
612 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
613 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
614 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
615 /* Fx : Flag for h263+ extra options */
616 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
617 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
618 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
619 #define CODEC_FLAG_CLOSED_GOP 0x80000000
620 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
621 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
622 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
623 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
624 #if FF_API_MPV_GLOBAL_OPTS
625 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
626 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
627 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
628 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
630 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
631 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
633 /* Unsupported options :
634 * Syntax Arithmetic coding (SAC)
635 * Reference Picture Selection
636 * Independent Segment Decoding */
638 /* codec capabilities */
640 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
642 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
643 * If not set, it might not use get_buffer() at all or use operations that
644 * assume the buffer was allocated by avcodec_default_get_buffer.
646 #define CODEC_CAP_DR1 0x0002
647 #define CODEC_CAP_TRUNCATED 0x0008
648 /* Codec can export data for HW decoding (XvMC). */
649 #define CODEC_CAP_HWACCEL 0x0010
651 * Encoder or decoder requires flushing with NULL input at the end in order to
652 * give the complete and correct output.
654 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
655 * with NULL data. The user can still send NULL data to the public encode
656 * or decode function, but libavcodec will not pass it along to the codec
657 * unless this flag is set.
660 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
661 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
665 * The encoder needs to be fed with NULL data at the end of encoding until the
666 * encoder no longer returns data.
668 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
669 * flag also means that the encoder must set the pts and duration for
670 * each output packet. If this flag is not set, the pts and duration will
671 * be determined by libavcodec from the input frame.
673 #define CODEC_CAP_DELAY 0x0020
675 * Codec can be fed a final frame with a smaller size.
676 * This can be used to prevent truncation of the last audio samples.
678 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
680 * Codec can export data for HW decoding (VDPAU).
682 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
684 * Codec can output multiple frames per AVPacket
685 * Normally demuxers return one frame at a time, demuxers which do not do
686 * are connected to a parser to split what they return into proper frames.
687 * This flag is reserved to the very rare category of codecs which have a
688 * bitstream that cannot be split into frames without timeconsuming
689 * operations like full decoding. Demuxers carring such bitstreams thus
690 * may return multiple frames in a packet. This has many disadvantages like
691 * prohibiting stream copy in many cases thus it should only be considered
694 #define CODEC_CAP_SUBFRAMES 0x0100
696 * Codec is experimental and is thus avoided in favor of non experimental
699 #define CODEC_CAP_EXPERIMENTAL 0x0200
701 * Codec should fill in channel configuration and samplerate instead of container
703 #define CODEC_CAP_CHANNEL_CONF 0x0400
706 * Codec is able to deal with negative linesizes
708 #define CODEC_CAP_NEG_LINESIZES 0x0800
711 * Codec supports frame-level multithreading.
713 #define CODEC_CAP_FRAME_THREADS 0x1000
715 * Codec supports slice-based (or partition-based) multithreading.
717 #define CODEC_CAP_SLICE_THREADS 0x2000
719 * Codec supports changed parameters at any point.
721 #define CODEC_CAP_PARAM_CHANGE 0x4000
723 * Codec supports avctx->thread_count == 0 (auto).
725 #define CODEC_CAP_AUTO_THREADS 0x8000
727 * Audio encoder supports receiving a different number of samples in each call.
729 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
731 * Codec is intra only.
733 #define CODEC_CAP_INTRA_ONLY 0x40000000
737 #define CODEC_CAP_LOSSLESS 0x80000000
739 //The following defines may change, don't expect compatibility if you use them.
740 #define MB_TYPE_INTRA4x4 0x0001
741 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
742 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
743 #define MB_TYPE_16x16 0x0008
744 #define MB_TYPE_16x8 0x0010
745 #define MB_TYPE_8x16 0x0020
746 #define MB_TYPE_8x8 0x0040
747 #define MB_TYPE_INTERLACED 0x0080
748 #define MB_TYPE_DIRECT2 0x0100 //FIXME
749 #define MB_TYPE_ACPRED 0x0200
750 #define MB_TYPE_GMC 0x0400
751 #define MB_TYPE_SKIP 0x0800
752 #define MB_TYPE_P0L0 0x1000
753 #define MB_TYPE_P1L0 0x2000
754 #define MB_TYPE_P0L1 0x4000
755 #define MB_TYPE_P1L1 0x8000
756 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
757 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
758 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
759 #define MB_TYPE_QUANT 0x00010000
760 #define MB_TYPE_CBP 0x00020000
761 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
765 * This specifies the area which should be displayed.
766 * Note there may be multiple such areas for one frame.
768 typedef struct AVPanScan{
771 * - encoding: Set by user.
772 * - decoding: Set by libavcodec.
777 * width and height in 1/16 pel
778 * - encoding: Set by user.
779 * - decoding: Set by libavcodec.
785 * position of the top left corner in 1/16 pel for up to 3 fields/frames
786 * - encoding: Set by user.
787 * - decoding: Set by libavcodec.
789 int16_t position[3][2];
792 #define FF_QSCALE_TYPE_MPEG1 0
793 #define FF_QSCALE_TYPE_MPEG2 1
794 #define FF_QSCALE_TYPE_H264 2
795 #define FF_QSCALE_TYPE_VP56 3
797 #define FF_BUFFER_TYPE_INTERNAL 1
798 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
799 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
800 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
802 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
803 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
804 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
805 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
808 * @defgroup lavc_packet AVPacket
810 * Types and functions for working with AVPacket.
813 enum AVPacketSideDataType {
815 AV_PKT_DATA_NEW_EXTRADATA,
818 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
821 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
822 * s32le channel_count
823 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
824 * u64le channel_layout
825 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
827 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
832 AV_PKT_DATA_PARAM_CHANGE,
835 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
836 * structures with info about macroblocks relevant to splitting the
837 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
838 * That is, it does not necessarily contain info about all macroblocks,
839 * as long as the distance between macroblocks in the info is smaller
840 * than the target payload size.
841 * Each MB info structure is 12 bytes, and is laid out as follows:
843 * u32le bit offset from the start of the packet
844 * u8 current quantizer at the start of the macroblock
846 * u16le macroblock address within the GOB
847 * u8 horizontal MV predictor
848 * u8 vertical MV predictor
849 * u8 horizontal MV predictor for block number 3
850 * u8 vertical MV predictor for block number 3
853 AV_PKT_DATA_H263_MB_INFO,
856 typedef struct AVPacket {
858 * Presentation timestamp in AVStream->time_base units; the time at which
859 * the decompressed packet will be presented to the user.
860 * Can be AV_NOPTS_VALUE if it is not stored in the file.
861 * pts MUST be larger or equal to dts as presentation cannot happen before
862 * decompression, unless one wants to view hex dumps. Some formats misuse
863 * the terms dts and pts/cts to mean something different. Such timestamps
864 * must be converted to true pts/dts before they are stored in AVPacket.
868 * Decompression timestamp in AVStream->time_base units; the time at which
869 * the packet is decompressed.
870 * Can be AV_NOPTS_VALUE if it is not stored in the file.
877 * A combination of AV_PKT_FLAG values
881 * Additional packet data that can be provided by the container.
882 * Packet can contain several types of side information.
887 enum AVPacketSideDataType type;
892 * Duration of this packet in AVStream->time_base units, 0 if unknown.
893 * Equals next_pts - this_pts in presentation order.
896 void (*destruct)(struct AVPacket *);
898 int64_t pos; ///< byte position in stream, -1 if unknown
901 * Time difference in AVStream->time_base units from the pts of this
902 * packet to the point at which the output from the decoder has converged
903 * independent from the availability of previous frames. That is, the
904 * frames are virtually identical no matter if decoding started from
905 * the very first frame or from this keyframe.
906 * Is AV_NOPTS_VALUE if unknown.
907 * This field is not the display duration of the current packet.
908 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
911 * The purpose of this field is to allow seeking in streams that have no
912 * keyframes in the conventional sense. It corresponds to the
913 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
914 * essential for some types of subtitle streams to ensure that all
915 * subtitles are correctly displayed after seeking.
917 int64_t convergence_duration;
919 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
920 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
922 enum AVSideDataParamChangeFlags {
923 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
924 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
925 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
926 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
934 * New fields can be added to the end of AVFRAME with minor version
935 * bumps. Similarly fields that are marked as to be only accessed by
936 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
937 * without breaking compatibility with each other.
938 * Removal, reordering and changes in the remaining cases require
939 * a major version bump.
940 * sizeof(AVFrame) must not be used outside libavcodec.
942 typedef struct AVFrame {
943 #define AV_NUM_DATA_POINTERS 8
945 * pointer to the picture/channel planes.
946 * This might be different from the first allocated byte
947 * - encoding: Set by user
948 * - decoding: set by AVCodecContext.get_buffer()
950 uint8_t *data[AV_NUM_DATA_POINTERS];
953 * Size, in bytes, of the data for each picture/channel plane.
955 * For audio, only linesize[0] may be set. For planar audio, each channel
956 * plane must be the same size.
958 * - encoding: Set by user
959 * - decoding: set by AVCodecContext.get_buffer()
961 int linesize[AV_NUM_DATA_POINTERS];
964 * pointers to the data planes/channels.
966 * For video, this should simply point to data[].
968 * For planar audio, each channel has a separate data pointer, and
969 * linesize[0] contains the size of each channel buffer.
970 * For packed audio, there is just one data pointer, and linesize[0]
971 * contains the total size of the buffer for all channels.
973 * Note: Both data and extended_data will always be set by get_buffer(),
974 * but for planar audio with more channels that can fit in data,
975 * extended_data must be used by the decoder in order to access all
979 * decoding: set by AVCodecContext.get_buffer()
981 uint8_t **extended_data;
984 * width and height of the video frame
986 * - decoding: Read by user.
991 * number of audio samples (per channel) described by this frame
992 * - encoding: Set by user
993 * - decoding: Set by libavcodec
998 * format of the frame, -1 if unknown or unset
999 * Values correspond to enum PixelFormat for video frames,
1000 * enum AVSampleFormat for audio)
1001 * - encoding: unused
1002 * - decoding: Read by user.
1007 * 1 -> keyframe, 0-> not
1008 * - encoding: Set by libavcodec.
1009 * - decoding: Set by libavcodec.
1014 * Picture type of the frame, see ?_TYPE below.
1015 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1016 * - decoding: Set by libavcodec.
1018 enum AVPictureType pict_type;
1021 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1022 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1026 uint8_t *base[AV_NUM_DATA_POINTERS];
1029 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1030 * - encoding: unused
1031 * - decoding: Read by user.
1033 AVRational sample_aspect_ratio;
1036 * presentation timestamp in time_base units (time when frame should be shown to user)
1037 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1038 * - encoding: MUST be set by user.
1039 * - decoding: Set by libavcodec.
1044 * reordered pts from the last AVPacket that has been input into the decoder
1045 * - encoding: unused
1046 * - decoding: Read by user.
1051 * dts from the last AVPacket that has been input into the decoder
1052 * - encoding: unused
1053 * - decoding: Read by user.
1058 * picture number in bitstream order
1059 * - encoding: set by
1060 * - decoding: Set by libavcodec.
1062 int coded_picture_number;
1064 * picture number in display order
1065 * - encoding: set by
1066 * - decoding: Set by libavcodec.
1068 int display_picture_number;
1071 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1072 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1073 * - decoding: Set by libavcodec.
1078 * is this picture used as reference
1079 * The values for this are the same as the MpegEncContext.picture_structure
1080 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1081 * Set to 4 for delayed, non-reference frames.
1082 * - encoding: unused
1083 * - decoding: Set by libavcodec. (before get_buffer() call)).
1089 * - encoding: unused
1090 * - decoding: Set by libavcodec.
1092 int8_t *qscale_table;
1095 * - encoding: unused
1096 * - decoding: Set by libavcodec.
1106 * mbskip_table[mb]>=1 if MB didn't change
1107 * stride= mb_width = (width+15)>>4
1108 * - encoding: unused
1109 * - decoding: Set by libavcodec.
1111 uint8_t *mbskip_table;
1114 * motion vector table
1117 * int mv_sample_log2= 4 - motion_subsample_log2;
1118 * int mb_width= (width+15)>>4;
1119 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1120 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1122 * - encoding: Set by user.
1123 * - decoding: Set by libavcodec.
1125 int16_t (*motion_val[2])[2];
1128 * macroblock type table
1129 * mb_type_base + mb_width + 2
1130 * - encoding: Set by user.
1131 * - decoding: Set by libavcodec.
1137 * - encoding: unused
1138 * - decoding: Set by libavcodec.
1143 * motion reference frame index
1144 * the order in which these are stored can depend on the codec.
1145 * - encoding: Set by user.
1146 * - decoding: Set by libavcodec.
1148 int8_t *ref_index[2];
1151 * for some private data of the user
1152 * - encoding: unused
1153 * - decoding: Set by user.
1159 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1160 * - decoding: unused
1162 uint64_t error[AV_NUM_DATA_POINTERS];
1165 * type of the buffer (to keep track of who has to deallocate data[*])
1166 * - encoding: Set by the one who allocates it.
1167 * - decoding: Set by the one who allocates it.
1168 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1173 * When decoding, this signals how much the picture must be delayed.
1174 * extra_delay = repeat_pict / (2*fps)
1175 * - encoding: unused
1176 * - decoding: Set by libavcodec.
1181 * The content of the picture is interlaced.
1182 * - encoding: Set by user.
1183 * - decoding: Set by libavcodec. (default 0)
1185 int interlaced_frame;
1188 * If the content is interlaced, is top field displayed first.
1189 * - encoding: Set by user.
1190 * - decoding: Set by libavcodec.
1192 int top_field_first;
1195 * Tell user application that palette has changed from previous frame.
1196 * - encoding: ??? (no palette-enabled encoder yet)
1197 * - decoding: Set by libavcodec. (default 0).
1199 int palette_has_changed;
1202 * codec suggestion on buffer type if != 0
1203 * - encoding: unused
1204 * - decoding: Set by libavcodec. (before get_buffer() call)).
1210 * - encoding: Set by user.
1211 * - decoding: Set by libavcodec.
1213 AVPanScan *pan_scan;
1216 * reordered opaque 64bit (generally an integer or a double precision float
1217 * PTS but can be anything).
1218 * The user sets AVCodecContext.reordered_opaque to represent the input at
1220 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1221 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1222 * @deprecated in favor of pkt_pts
1223 * - encoding: unused
1224 * - decoding: Read by user.
1226 int64_t reordered_opaque;
1229 * hardware accelerator private data (FFmpeg-allocated)
1230 * - encoding: unused
1231 * - decoding: Set by libavcodec
1233 void *hwaccel_picture_private;
1236 * the AVCodecContext which ff_thread_get_buffer() was last called on
1237 * - encoding: Set by libavcodec.
1238 * - decoding: Set by libavcodec.
1240 struct AVCodecContext *owner;
1243 * used by multithreading to store frame-specific info
1244 * - encoding: Set by libavcodec.
1245 * - decoding: Set by libavcodec.
1247 void *thread_opaque;
1250 * log2 of the size of the block which a single vector in motion_val represents:
1251 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1252 * - encoding: unused
1253 * - decoding: Set by libavcodec.
1255 uint8_t motion_subsample_log2;
1258 * Sample rate of the audio data.
1260 * - encoding: unused
1261 * - decoding: read by user
1266 * Channel layout of the audio data.
1268 * - encoding: unused
1269 * - decoding: read by user.
1271 uint64_t channel_layout;
1274 * frame timestamp estimated using various heuristics, in stream time base
1275 * Code outside libavcodec should access this field using:
1276 * av_frame_get_best_effort_timestamp(frame)
1277 * - encoding: unused
1278 * - decoding: set by libavcodec, read by user.
1280 int64_t best_effort_timestamp;
1283 * reordered pos from the last AVPacket that has been input into the decoder
1284 * Code outside libavcodec should access this field using:
1285 * av_frame_get_pkt_pos(frame)
1286 * - encoding: unused
1287 * - decoding: Read by user.
1292 * duration of the corresponding packet, expressed in
1293 * AVStream->time_base units, 0 if unknown.
1294 * Code outside libavcodec should access this field using:
1295 * av_frame_get_pkt_duration(frame)
1296 * - encoding: unused
1297 * - decoding: Read by user.
1299 int64_t pkt_duration;
1303 * Accessors for some AVFrame fields.
1304 * The position of these field in the structure is not part of the ABI,
1305 * they should not be accessed directly outside libavcodec.
1307 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
1308 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
1309 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
1310 int64_t av_frame_get_channel_layout (const AVFrame *frame);
1311 int av_frame_get_sample_rate (const AVFrame *frame);
1312 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
1313 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
1314 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
1315 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
1316 void av_frame_set_sample_rate (AVFrame *frame, int val);
1318 struct AVCodecInternal;
1322 AV_FIELD_PROGRESSIVE,
1323 AV_FIELD_TT, //< Top coded_first, top displayed first
1324 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1325 AV_FIELD_TB, //< Top coded first, bottom displayed first
1326 AV_FIELD_BT, //< Bottom coded first, top displayed first
1330 * main external API structure.
1331 * New fields can be added to the end with minor version bumps.
1332 * Removal, reordering and changes to existing fields require a major
1334 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1336 * sizeof(AVCodecContext) must not be used outside libav*.
1338 typedef struct AVCodecContext {
1340 * information on struct for av_log
1341 * - set by avcodec_alloc_context3
1343 const AVClass *av_class;
1344 int log_level_offset;
1346 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1347 struct AVCodec *codec;
1348 char codec_name[32];
1349 enum CodecID codec_id; /* see CODEC_ID_xxx */
1352 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1353 * This is used to work around some encoder bugs.
1354 * A demuxer should set this to what is stored in the field used to identify the codec.
1355 * If there are multiple such fields in a container then the demuxer should choose the one
1356 * which maximizes the information about the used codec.
1357 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1358 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1359 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1361 * - encoding: Set by user, if not then the default based on codec_id will be used.
1362 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1364 unsigned int codec_tag;
1367 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1368 * This is used to work around some encoder bugs.
1369 * - encoding: unused
1370 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1372 unsigned int stream_codec_tag;
1376 * @deprecated this field is unused
1378 attribute_deprecated int sub_id;
1384 * Private context used for internal data.
1386 * Unlike priv_data, this is not codec-specific. It is used in general
1387 * libavcodec functions.
1389 struct AVCodecInternal *internal;
1392 * Private data of the user, can be used to carry app specific stuff.
1393 * - encoding: Set by user.
1394 * - decoding: Set by user.
1399 * the average bitrate
1400 * - encoding: Set by user; unused for constant quantizer encoding.
1401 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1406 * number of bits the bitstream is allowed to diverge from the reference.
1407 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1408 * - encoding: Set by user; unused for constant quantizer encoding.
1409 * - decoding: unused
1411 int bit_rate_tolerance;
1414 * Global quality for codecs which cannot change it per frame.
1415 * This should be proportional to MPEG-1/2/4 qscale.
1416 * - encoding: Set by user.
1417 * - decoding: unused
1422 * - encoding: Set by user.
1423 * - decoding: unused
1425 int compression_level;
1426 #define FF_COMPRESSION_DEFAULT -1
1430 * - encoding: Set by user.
1431 * - decoding: Set by user.
1437 * - encoding: Set by user.
1438 * - decoding: Set by user.
1443 * some codecs need / can use extradata like Huffman tables.
1444 * mjpeg: Huffman tables
1445 * rv10: additional flags
1446 * mpeg4: global headers (they can be in the bitstream or here)
1447 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1448 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1449 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1450 * - encoding: Set/allocated/freed by libavcodec.
1451 * - decoding: Set/allocated/freed by user.
1457 * This is the fundamental unit of time (in seconds) in terms
1458 * of which frame timestamps are represented. For fixed-fps content,
1459 * timebase should be 1/framerate and timestamp increments should be
1461 * - encoding: MUST be set by user.
1462 * - decoding: Set by libavcodec.
1464 AVRational time_base;
1467 * For some codecs, the time base is closer to the field rate than the frame rate.
1468 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1469 * if no telecine is used ...
1471 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1473 int ticks_per_frame;
1476 * Encoding: Number of frames delay there will be from the encoder input to
1477 * the decoder output. (we assume the decoder matches the spec)
1478 * Decoding: Number of frames delay in addition to what a standard decoder
1479 * as specified in the spec would produce.
1482 * Number of frames the decoded output will be delayed relative to the
1486 * Number of "priming" samples added to the beginning of the stream
1487 * during encoding. The decoded output will be delayed by this many
1488 * samples relative to the input to the encoder. Note that this field is
1489 * purely informational and does not directly affect the pts output by
1490 * the encoder, which should always be based on the actual presentation
1491 * time, including any delay.
1493 * - encoding: Set by libavcodec.
1494 * - decoding: Set by libavcodec.
1501 * picture width / height.
1502 * - encoding: MUST be set by user.
1503 * - decoding: Set by libavcodec.
1504 * Note: For compatibility it is possible to set this instead of
1505 * coded_width/height before decoding.
1510 * Bitstream width / height, may be different from width/height if lowres enabled.
1511 * - encoding: unused
1512 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1514 int coded_width, coded_height;
1516 #define FF_ASPECT_EXTENDED 15
1519 * the number of pictures in a group of pictures, or 0 for intra_only
1520 * - encoding: Set by user.
1521 * - decoding: unused
1526 * Pixel format, see PIX_FMT_xxx.
1527 * May be set by the demuxer if known from headers.
1528 * May be overridden by the decoder if it knows better.
1529 * - encoding: Set by user.
1530 * - decoding: Set by user if known, overridden by libavcodec if known
1532 enum PixelFormat pix_fmt;
1535 * Motion estimation algorithm used for video coding.
1536 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1537 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1538 * - encoding: MUST be set by user.
1539 * - decoding: unused
1544 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1545 * decoder to draw a horizontal band. It improves cache usage. Not
1546 * all codecs can do that. You must check the codec capabilities
1548 * When multithreading is used, it may be called from multiple threads
1549 * at the same time; threads might draw different parts of the same AVFrame,
1550 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1552 * The function is also used by hardware acceleration APIs.
1553 * It is called at least once during frame decoding to pass
1554 * the data needed for hardware render.
1555 * In that mode instead of pixel data, AVFrame points to
1556 * a structure specific to the acceleration API. The application
1557 * reads the structure and can change some fields to indicate progress
1559 * - encoding: unused
1560 * - decoding: Set by user.
1561 * @param height the height of the slice
1562 * @param y the y position of the slice
1563 * @param type 1->top field, 2->bottom field, 3->frame
1564 * @param offset offset into the AVFrame.data from which the slice should be read
1566 void (*draw_horiz_band)(struct AVCodecContext *s,
1567 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1568 int y, int type, int height);
1571 * callback to negotiate the pixelFormat
1572 * @param fmt is the list of formats which are supported by the codec,
1573 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1574 * The first is always the native one.
1575 * @return the chosen format
1576 * - encoding: unused
1577 * - decoding: Set by user, if not set the native format will be chosen.
1579 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1582 * maximum number of B-frames between non-B-frames
1583 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1584 * - encoding: Set by user.
1585 * - decoding: unused
1590 * qscale factor between IP and B-frames
1591 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1592 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1593 * - encoding: Set by user.
1594 * - decoding: unused
1596 float b_quant_factor;
1598 /** obsolete FIXME remove */
1600 #define FF_RC_STRATEGY_XVID 1
1602 int b_frame_strategy;
1604 #if FF_API_MPV_GLOBAL_OPTS
1606 * luma single coefficient elimination threshold
1607 * - encoding: Set by user.
1608 * - decoding: unused
1610 attribute_deprecated int luma_elim_threshold;
1613 * chroma single coeff elimination threshold
1614 * - encoding: Set by user.
1615 * - decoding: unused
1617 attribute_deprecated int chroma_elim_threshold;
1621 * qscale offset between IP and B-frames
1622 * - encoding: Set by user.
1623 * - decoding: unused
1625 float b_quant_offset;
1628 * Size of the frame reordering buffer in the decoder.
1629 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1630 * - encoding: Set by libavcodec.
1631 * - decoding: Set by libavcodec.
1636 * 0-> h263 quant 1-> mpeg quant
1637 * - encoding: Set by user.
1638 * - decoding: unused
1643 * qscale factor between P and I-frames
1644 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1645 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1646 * - encoding: Set by user.
1647 * - decoding: unused
1649 float i_quant_factor;
1652 * qscale offset between P and I-frames
1653 * - encoding: Set by user.
1654 * - decoding: unused
1656 float i_quant_offset;
1659 * luminance masking (0-> disabled)
1660 * - encoding: Set by user.
1661 * - decoding: unused
1666 * temporary complexity masking (0-> disabled)
1667 * - encoding: Set by user.
1668 * - decoding: unused
1670 float temporal_cplx_masking;
1673 * spatial complexity masking (0-> disabled)
1674 * - encoding: Set by user.
1675 * - decoding: unused
1677 float spatial_cplx_masking;
1680 * p block masking (0-> disabled)
1681 * - encoding: Set by user.
1682 * - decoding: unused
1687 * darkness masking (0-> disabled)
1688 * - encoding: Set by user.
1689 * - decoding: unused
1695 * - encoding: Set by libavcodec.
1696 * - decoding: Set by user (or 0).
1700 * prediction method (needed for huffyuv)
1701 * - encoding: Set by user.
1702 * - decoding: unused
1704 int prediction_method;
1705 #define FF_PRED_LEFT 0
1706 #define FF_PRED_PLANE 1
1707 #define FF_PRED_MEDIAN 2
1710 * slice offsets in the frame in bytes
1711 * - encoding: Set/allocated by libavcodec.
1712 * - decoding: Set/allocated by user (or NULL).
1717 * sample aspect ratio (0 if unknown)
1718 * That is the width of a pixel divided by the height of the pixel.
1719 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1720 * - encoding: Set by user.
1721 * - decoding: Set by libavcodec.
1723 AVRational sample_aspect_ratio;
1726 * motion estimation comparison function
1727 * - encoding: Set by user.
1728 * - decoding: unused
1732 * subpixel motion estimation comparison function
1733 * - encoding: Set by user.
1734 * - decoding: unused
1738 * macroblock comparison function (not supported yet)
1739 * - encoding: Set by user.
1740 * - decoding: unused
1744 * interlaced DCT comparison function
1745 * - encoding: Set by user.
1746 * - decoding: unused
1749 #define FF_CMP_SAD 0
1750 #define FF_CMP_SSE 1
1751 #define FF_CMP_SATD 2
1752 #define FF_CMP_DCT 3
1753 #define FF_CMP_PSNR 4
1754 #define FF_CMP_BIT 5
1756 #define FF_CMP_ZERO 7
1757 #define FF_CMP_VSAD 8
1758 #define FF_CMP_VSSE 9
1759 #define FF_CMP_NSSE 10
1760 #define FF_CMP_W53 11
1761 #define FF_CMP_W97 12
1762 #define FF_CMP_DCTMAX 13
1763 #define FF_CMP_DCT264 14
1764 #define FF_CMP_CHROMA 256
1767 * ME diamond size & shape
1768 * - encoding: Set by user.
1769 * - decoding: unused
1774 * amount of previous MV predictors (2a+1 x 2a+1 square)
1775 * - encoding: Set by user.
1776 * - decoding: unused
1778 int last_predictor_count;
1781 * prepass for motion estimation
1782 * - encoding: Set by user.
1783 * - decoding: unused
1788 * motion estimation prepass comparison function
1789 * - encoding: Set by user.
1790 * - decoding: unused
1795 * ME prepass diamond size & shape
1796 * - encoding: Set by user.
1797 * - decoding: unused
1803 * - encoding: Set by user.
1804 * - decoding: unused
1806 int me_subpel_quality;
1809 * DTG active format information (additional aspect ratio
1810 * information only used in DVB MPEG-2 transport streams)
1813 * - encoding: unused
1814 * - decoding: Set by decoder.
1816 int dtg_active_format;
1817 #define FF_DTG_AFD_SAME 8
1818 #define FF_DTG_AFD_4_3 9
1819 #define FF_DTG_AFD_16_9 10
1820 #define FF_DTG_AFD_14_9 11
1821 #define FF_DTG_AFD_4_3_SP_14_9 13
1822 #define FF_DTG_AFD_16_9_SP_14_9 14
1823 #define FF_DTG_AFD_SP_4_3 15
1826 * maximum motion estimation search range in subpel units
1827 * If 0 then no limit.
1829 * - encoding: Set by user.
1830 * - decoding: unused
1835 * intra quantizer bias
1836 * - encoding: Set by user.
1837 * - decoding: unused
1839 int intra_quant_bias;
1840 #define FF_DEFAULT_QUANT_BIAS 999999
1843 * inter quantizer bias
1844 * - encoding: Set by user.
1845 * - decoding: unused
1847 int inter_quant_bias;
1849 #if FF_API_COLOR_TABLE_ID
1852 * - encoding: unused
1853 * - decoding: Which clrtable should be used for 8bit RGB images.
1854 * Tables have to be stored somewhere. FIXME
1856 attribute_deprecated int color_table_id;
1861 * - encoding: unused
1862 * - decoding: Set by user.
1865 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1866 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1867 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1870 * XVideo Motion Acceleration
1871 * - encoding: forbidden
1872 * - decoding: set by decoder
1874 int xvmc_acceleration;
1877 * macroblock decision mode
1878 * - encoding: Set by user.
1879 * - decoding: unused
1882 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1883 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1884 #define FF_MB_DECISION_RD 2 ///< rate distortion
1887 * custom intra quantization matrix
1888 * - encoding: Set by user, can be NULL.
1889 * - decoding: Set by libavcodec.
1891 uint16_t *intra_matrix;
1894 * custom inter quantization matrix
1895 * - encoding: Set by user, can be NULL.
1896 * - decoding: Set by libavcodec.
1898 uint16_t *inter_matrix;
1901 * scene change detection threshold
1902 * 0 is default, larger means fewer detected scene changes.
1903 * - encoding: Set by user.
1904 * - decoding: unused
1906 int scenechange_threshold;
1909 * noise reduction strength
1910 * - encoding: Set by user.
1911 * - decoding: unused
1913 int noise_reduction;
1915 #if FF_API_INTER_THRESHOLD
1917 * @deprecated this field is unused
1919 attribute_deprecated int inter_threshold;
1922 #if FF_API_MPV_GLOBAL_OPTS
1924 * @deprecated use mpegvideo private options instead
1926 attribute_deprecated int quantizer_noise_shaping;
1930 * Motion estimation threshold below which no motion estimation is
1931 * performed, but instead the user specified motion vectors are used.
1933 * - encoding: Set by user.
1934 * - decoding: unused
1939 * Macroblock threshold below which the user specified macroblock types will be used.
1940 * - encoding: Set by user.
1941 * - decoding: unused
1946 * precision of the intra DC coefficient - 8
1947 * - encoding: Set by user.
1948 * - decoding: unused
1950 int intra_dc_precision;
1953 * Number of macroblock rows at the top which are skipped.
1954 * - encoding: unused
1955 * - decoding: Set by user.
1960 * Number of macroblock rows at the bottom which are skipped.
1961 * - encoding: unused
1962 * - decoding: Set by user.
1967 * Border processing masking, raises the quantizer for mbs on the borders
1969 * - encoding: Set by user.
1970 * - decoding: unused
1972 float border_masking;
1975 * minimum MB lagrange multipler
1976 * - encoding: Set by user.
1977 * - decoding: unused
1982 * maximum MB lagrange multipler
1983 * - encoding: Set by user.
1984 * - decoding: unused
1990 * - encoding: Set by user.
1991 * - decoding: unused
1993 int me_penalty_compensation;
1997 * - encoding: Set by user.
1998 * - decoding: unused
2004 * - encoding: Set by user.
2005 * - decoding: unused
2011 * - encoding: Set by user.
2012 * - decoding: unused
2017 * number of reference frames
2018 * - encoding: Set by user.
2019 * - decoding: Set by lavc.
2024 * chroma qp offset from luma
2025 * - encoding: Set by user.
2026 * - decoding: unused
2031 * Multiplied by qscale for each frame and added to scene_change_score.
2032 * - encoding: Set by user.
2033 * - decoding: unused
2035 int scenechange_factor;
2039 * Note: Value depends upon the compare function used for fullpel ME.
2040 * - encoding: Set by user.
2041 * - decoding: unused
2046 * Adjust sensitivity of b_frame_strategy 1.
2047 * - encoding: Set by user.
2048 * - decoding: unused
2053 * Chromaticity coordinates of the source primaries.
2054 * - encoding: Set by user
2055 * - decoding: Set by libavcodec
2057 enum AVColorPrimaries color_primaries;
2060 * Color Transfer Characteristic.
2061 * - encoding: Set by user
2062 * - decoding: Set by libavcodec
2064 enum AVColorTransferCharacteristic color_trc;
2067 * YUV colorspace type.
2068 * - encoding: Set by user
2069 * - decoding: Set by libavcodec
2071 enum AVColorSpace colorspace;
2074 * MPEG vs JPEG YUV range.
2075 * - encoding: Set by user
2076 * - decoding: Set by libavcodec
2078 enum AVColorRange color_range;
2081 * This defines the location of chroma samples.
2082 * - encoding: Set by user
2083 * - decoding: Set by libavcodec
2085 enum AVChromaLocation chroma_sample_location;
2089 * Indicates number of picture subdivisions. Used for parallelized
2091 * - encoding: Set by user
2092 * - decoding: unused
2097 * - encoding: set by libavcodec
2098 * - decoding: Set by libavcodec
2100 enum AVFieldOrder field_order;
2103 int sample_rate; ///< samples per second
2104 int channels; ///< number of audio channels
2107 * audio sample format
2108 * - encoding: Set by user.
2109 * - decoding: Set by libavcodec.
2111 enum AVSampleFormat sample_fmt; ///< sample format
2113 /* The following data should not be initialized. */
2115 * Samples per packet, initialized when calling 'init'.
2120 * Frame counter, set by libavcodec.
2122 * - decoding: total number of frames returned from the decoder so far.
2123 * - encoding: total number of frames passed to the encoder so far.
2125 * @note the counter is not incremented if encoding/decoding resulted in
2131 * number of bytes per packet if constant and known or 0
2132 * Used by some WAV based audio codecs.
2137 * Audio cutoff bandwidth (0 means "automatic")
2138 * - encoding: Set by user.
2139 * - decoding: unused
2143 #if FF_API_REQUEST_CHANNELS
2145 * Decoder should decode to this many channels if it can (0 for default)
2146 * - encoding: unused
2147 * - decoding: Set by user.
2148 * @deprecated Deprecated in favor of request_channel_layout.
2150 int request_channels;
2154 * Audio channel layout.
2155 * - encoding: set by user.
2156 * - decoding: set by user, may be overwritten by libavcodec.
2158 uint64_t channel_layout;
2161 * Request decoder to use this channel layout if it can (0 for default)
2162 * - encoding: unused
2163 * - decoding: Set by user.
2165 uint64_t request_channel_layout;
2168 * Type of service that the audio stream conveys.
2169 * - encoding: Set by user.
2170 * - decoding: Set by libavcodec.
2172 enum AVAudioServiceType audio_service_type;
2175 * desired sample format
2176 * - encoding: Not used.
2177 * - decoding: Set by user.
2178 * Decoder will decode to this format if it can.
2180 enum AVSampleFormat request_sample_fmt;
2183 * Called at the beginning of each frame to get a buffer for it.
2185 * The function will set AVFrame.data[], AVFrame.linesize[].
2186 * AVFrame.extended_data[] must also be set, but it should be the same as
2187 * AVFrame.data[] except for planar audio with more channels than can fit
2188 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2189 * many data pointers as it can hold.
2191 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2192 * avcodec_default_get_buffer() instead of providing buffers allocated by
2195 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2196 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2197 * but if get_buffer() is overridden then alignment considerations should
2198 * be taken into account.
2200 * @see avcodec_default_get_buffer()
2204 * If pic.reference is set then the frame will be read later by libavcodec.
2205 * avcodec_align_dimensions2() should be used to find the required width and
2206 * height, as they normally need to be rounded up to the next multiple of 16.
2208 * If frame multithreading is used and thread_safe_callbacks is set,
2209 * it may be called from a different thread, but not from more than one at
2210 * once. Does not need to be reentrant.
2212 * @see release_buffer(), reget_buffer()
2213 * @see avcodec_align_dimensions2()
2217 * Decoders request a buffer of a particular size by setting
2218 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2219 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2220 * to a smaller value in the output frame.
2222 * Decoders cannot use the buffer after returning from
2223 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2224 * is assumed to be released immediately upon return.
2226 * As a convenience, av_samples_get_buffer_size() and
2227 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2228 * functions to find the required data size and to fill data pointers and
2229 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2230 * since all planes must be the same size.
2232 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2234 * - encoding: unused
2235 * - decoding: Set by libavcodec, user can override.
2237 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2240 * Called to release buffers which were allocated with get_buffer.
2241 * A released buffer can be reused in get_buffer().
2242 * pic.data[*] must be set to NULL.
2243 * May be called from a different thread if frame multithreading is used,
2244 * but not by more than one thread at once, so does not need to be reentrant.
2245 * - encoding: unused
2246 * - decoding: Set by libavcodec, user can override.
2248 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2251 * Called at the beginning of a frame to get cr buffer for it.
2252 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2253 * libavcodec will pass previous buffer in pic, function should return
2254 * same buffer or new buffer with old frame "painted" into it.
2255 * If pic.data[0] == NULL must behave like get_buffer().
2256 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2257 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2259 * - encoding: unused
2260 * - decoding: Set by libavcodec, user can override.
2262 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2265 /* - encoding parameters */
2266 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2267 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2271 * - encoding: Set by user.
2272 * - decoding: unused
2278 * - encoding: Set by user.
2279 * - decoding: unused
2284 * maximum quantizer difference between frames
2285 * - encoding: Set by user.
2286 * - decoding: unused
2291 * ratecontrol qmin qmax limiting method
2292 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2293 * - encoding: Set by user.
2294 * - decoding: unused
2302 * decoder bitstream buffer size
2303 * - encoding: Set by user.
2304 * - decoding: unused
2309 * ratecontrol override, see RcOverride
2310 * - encoding: Allocated/set/freed by user.
2311 * - decoding: unused
2313 int rc_override_count;
2314 RcOverride *rc_override;
2317 * rate control equation
2318 * - encoding: Set by user
2319 * - decoding: unused
2325 * - encoding: Set by user.
2326 * - decoding: unused
2332 * - encoding: Set by user.
2333 * - decoding: unused
2337 float rc_buffer_aggressivity;
2340 * initial complexity for pass1 ratecontrol
2341 * - encoding: Set by user.
2342 * - decoding: unused
2344 float rc_initial_cplx;
2347 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2348 * - encoding: Set by user.
2349 * - decoding: unused.
2351 float rc_max_available_vbv_use;
2354 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2355 * - encoding: Set by user.
2356 * - decoding: unused.
2358 float rc_min_vbv_overflow_use;
2361 * Number of bits which should be loaded into the rc buffer before decoding starts.
2362 * - encoding: Set by user.
2363 * - decoding: unused
2365 int rc_initial_buffer_occupancy;
2367 #define FF_CODER_TYPE_VLC 0
2368 #define FF_CODER_TYPE_AC 1
2369 #define FF_CODER_TYPE_RAW 2
2370 #define FF_CODER_TYPE_RLE 3
2371 #define FF_CODER_TYPE_DEFLATE 4
2374 * - encoding: Set by user.
2375 * - decoding: unused
2381 * - encoding: Set by user.
2382 * - decoding: unused
2387 * minimum Lagrange multipler
2388 * - encoding: Set by user.
2389 * - decoding: unused
2394 * maximum Lagrange multipler
2395 * - encoding: Set by user.
2396 * - decoding: unused
2401 * frame skip threshold
2402 * - encoding: Set by user.
2403 * - decoding: unused
2405 int frame_skip_threshold;
2409 * - encoding: Set by user.
2410 * - decoding: unused
2412 int frame_skip_factor;
2415 * frame skip exponent
2416 * - encoding: Set by user.
2417 * - decoding: unused
2422 * frame skip comparison function
2423 * - encoding: Set by user.
2424 * - decoding: unused
2429 * trellis RD quantization
2430 * - encoding: Set by user.
2431 * - decoding: unused
2436 * - encoding: Set by user.
2437 * - decoding: unused
2439 int min_prediction_order;
2442 * - encoding: Set by user.
2443 * - decoding: unused
2445 int max_prediction_order;
2448 * GOP timecode frame start number
2449 * - encoding: Set by user, in non drop frame format
2450 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2452 int64_t timecode_frame_start;
2454 /* The RTP callback: This function is called */
2455 /* every time the encoder has a packet to send. */
2456 /* It depends on the encoder if the data starts */
2457 /* with a Start Code (it should). H.263 does. */
2458 /* mb_nb contains the number of macroblocks */
2459 /* encoded in the RTP payload. */
2460 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2462 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2463 /* do its best to deliver a chunk with size */
2464 /* below rtp_payload_size, the chunk will start */
2465 /* with a start code on some codecs like H.263. */
2466 /* This doesn't take account of any particular */
2467 /* headers inside the transmitted RTP payload. */
2469 /* statistics, used for 2-pass encoding */
2480 * number of bits used for the previously encoded frame
2481 * - encoding: Set by libavcodec.
2482 * - decoding: unused
2487 * pass1 encoding statistics output buffer
2488 * - encoding: Set by libavcodec.
2489 * - decoding: unused
2494 * pass2 encoding statistics input buffer
2495 * Concatenated stuff from stats_out of pass1 should be placed here.
2496 * - encoding: Allocated/set/freed by user.
2497 * - decoding: unused
2502 * Work around bugs in encoders which sometimes cannot be detected automatically.
2503 * - encoding: Set by user
2504 * - decoding: Set by user
2506 int workaround_bugs;
2507 #define FF_BUG_AUTODETECT 1 ///< autodetection
2508 #define FF_BUG_OLD_MSMPEG4 2
2509 #define FF_BUG_XVID_ILACE 4
2510 #define FF_BUG_UMP4 8
2511 #define FF_BUG_NO_PADDING 16
2512 #define FF_BUG_AMV 32
2513 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2514 #define FF_BUG_QPEL_CHROMA 64
2515 #define FF_BUG_STD_QPEL 128
2516 #define FF_BUG_QPEL_CHROMA2 256
2517 #define FF_BUG_DIRECT_BLOCKSIZE 512
2518 #define FF_BUG_EDGE 1024
2519 #define FF_BUG_HPEL_CHROMA 2048
2520 #define FF_BUG_DC_CLIP 4096
2521 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2522 #define FF_BUG_TRUNCATED 16384
2525 * strictly follow the standard (MPEG4, ...).
2526 * - encoding: Set by user.
2527 * - decoding: Set by user.
2528 * Setting this to STRICT or higher means the encoder and decoder will
2529 * generally do stupid things, whereas setting it to unofficial or lower
2530 * will mean the encoder might produce output that is not supported by all
2531 * spec-compliant decoders. Decoders don't differentiate between normal,
2532 * unofficial and experimental (that is, they always try to decode things
2533 * when they can) unless they are explicitly asked to behave stupidly
2534 * (=strictly conform to the specs)
2536 int strict_std_compliance;
2537 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2538 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2539 #define FF_COMPLIANCE_NORMAL 0
2540 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2541 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2544 * error concealment flags
2545 * - encoding: unused
2546 * - decoding: Set by user.
2548 int error_concealment;
2549 #define FF_EC_GUESS_MVS 1
2550 #define FF_EC_DEBLOCK 2
2554 * - encoding: Set by user.
2555 * - decoding: Set by user.
2558 #define FF_DEBUG_PICT_INFO 1
2559 #define FF_DEBUG_RC 2
2560 #define FF_DEBUG_BITSTREAM 4
2561 #define FF_DEBUG_MB_TYPE 8
2562 #define FF_DEBUG_QP 16
2563 #define FF_DEBUG_MV 32
2564 #define FF_DEBUG_DCT_COEFF 0x00000040
2565 #define FF_DEBUG_SKIP 0x00000080
2566 #define FF_DEBUG_STARTCODE 0x00000100
2567 #define FF_DEBUG_PTS 0x00000200
2568 #define FF_DEBUG_ER 0x00000400
2569 #define FF_DEBUG_MMCO 0x00000800
2570 #define FF_DEBUG_BUGS 0x00001000
2571 #define FF_DEBUG_VIS_QP 0x00002000
2572 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2573 #define FF_DEBUG_BUFFERS 0x00008000
2574 #define FF_DEBUG_THREADS 0x00010000
2578 * - encoding: Set by user.
2579 * - decoding: Set by user.
2582 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2583 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2584 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2587 * Error recognition; may misdetect some more or less valid parts as errors.
2588 * - encoding: unused
2589 * - decoding: Set by user.
2591 int err_recognition;
2592 #define AV_EF_CRCCHECK (1<<0)
2593 #define AV_EF_BITSTREAM (1<<1)
2594 #define AV_EF_BUFFER (1<<2)
2595 #define AV_EF_EXPLODE (1<<3)
2597 #define AV_EF_CAREFUL (1<<16)
2598 #define AV_EF_COMPLIANT (1<<17)
2599 #define AV_EF_AGGRESSIVE (1<<18)
2603 * opaque 64bit number (generally a PTS) that will be reordered and
2604 * output in AVFrame.reordered_opaque
2605 * @deprecated in favor of pkt_pts
2606 * - encoding: unused
2607 * - decoding: Set by user.
2609 int64_t reordered_opaque;
2612 * Hardware accelerator in use
2613 * - encoding: unused.
2614 * - decoding: Set by libavcodec
2616 struct AVHWAccel *hwaccel;
2619 * Hardware accelerator context.
2620 * For some hardware accelerators, a global context needs to be
2621 * provided by the user. In that case, this holds display-dependent
2622 * data FFmpeg cannot instantiate itself. Please refer to the
2623 * FFmpeg HW accelerator documentation to know how to fill this
2624 * is. e.g. for VA API, this is a struct vaapi_context.
2625 * - encoding: unused
2626 * - decoding: Set by user
2628 void *hwaccel_context;
2632 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2633 * - decoding: unused
2635 uint64_t error[AV_NUM_DATA_POINTERS];
2638 * DCT algorithm, see FF_DCT_* below
2639 * - encoding: Set by user.
2640 * - decoding: unused
2643 #define FF_DCT_AUTO 0
2644 #define FF_DCT_FASTINT 1
2645 #define FF_DCT_INT 2
2646 #define FF_DCT_MMX 3
2647 #define FF_DCT_ALTIVEC 5
2648 #define FF_DCT_FAAN 6
2651 * IDCT algorithm, see FF_IDCT_* below.
2652 * - encoding: Set by user.
2653 * - decoding: Set by user.
2656 #define FF_IDCT_AUTO 0
2657 #define FF_IDCT_INT 1
2658 #define FF_IDCT_SIMPLE 2
2659 #define FF_IDCT_SIMPLEMMX 3
2660 #define FF_IDCT_LIBMPEG2MMX 4
2661 #define FF_IDCT_MMI 5
2662 #define FF_IDCT_ARM 7
2663 #define FF_IDCT_ALTIVEC 8
2664 #define FF_IDCT_SH4 9
2665 #define FF_IDCT_SIMPLEARM 10
2666 #define FF_IDCT_H264 11
2667 #define FF_IDCT_VP3 12
2668 #define FF_IDCT_IPP 13
2669 #define FF_IDCT_XVIDMMX 14
2670 #define FF_IDCT_CAVS 15
2671 #define FF_IDCT_SIMPLEARMV5TE 16
2672 #define FF_IDCT_SIMPLEARMV6 17
2673 #define FF_IDCT_SIMPLEVIS 18
2674 #define FF_IDCT_WMV2 19
2675 #define FF_IDCT_FAAN 20
2676 #define FF_IDCT_EA 21
2677 #define FF_IDCT_SIMPLENEON 22
2678 #define FF_IDCT_SIMPLEALPHA 23
2679 #define FF_IDCT_BINK 24
2684 * @deprecated use av_set_cpu_flags_mask() instead.
2686 attribute_deprecated unsigned dsp_mask;
2690 * bits per sample/pixel from the demuxer (needed for huffyuv).
2691 * - encoding: Set by libavcodec.
2692 * - decoding: Set by user.
2694 int bits_per_coded_sample;
2697 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2698 * - encoding: set by user.
2699 * - decoding: set by libavcodec.
2701 int bits_per_raw_sample;
2704 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2705 * - encoding: unused
2706 * - decoding: Set by user.
2711 * the picture in the bitstream
2712 * - encoding: Set by libavcodec.
2713 * - decoding: Set by libavcodec.
2715 AVFrame *coded_frame;
2719 * is used to decide how many independent tasks should be passed to execute()
2720 * - encoding: Set by user.
2721 * - decoding: Set by user.
2726 * Which multithreading methods to use.
2727 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2728 * so clients which cannot provide future frames should not use it.
2730 * - encoding: Set by user, otherwise the default is used.
2731 * - decoding: Set by user, otherwise the default is used.
2734 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2735 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2738 * Which multithreading methods are in use by the codec.
2739 * - encoding: Set by libavcodec.
2740 * - decoding: Set by libavcodec.
2742 int active_thread_type;
2745 * Set by the client if its custom get_buffer() callback can be called
2746 * synchronously from another thread, which allows faster multithreaded decoding.
2747 * draw_horiz_band() will be called from other threads regardless of this setting.
2748 * Ignored if the default get_buffer() is used.
2749 * - encoding: Set by user.
2750 * - decoding: Set by user.
2752 int thread_safe_callbacks;
2755 * The codec may call this to execute several independent things.
2756 * It will return only after finishing all tasks.
2757 * The user may replace this with some multithreaded implementation,
2758 * the default implementation will execute the parts serially.
2759 * @param count the number of things to execute
2760 * - encoding: Set by libavcodec, user can override.
2761 * - decoding: Set by libavcodec, user can override.
2763 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2766 * The codec may call this to execute several independent things.
2767 * It will return only after finishing all tasks.
2768 * The user may replace this with some multithreaded implementation,
2769 * the default implementation will execute the parts serially.
2770 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2771 * @param c context passed also to func
2772 * @param count the number of things to execute
2773 * @param arg2 argument passed unchanged to func
2774 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2775 * @param func function that will be called count times, with jobnr from 0 to count-1.
2776 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2777 * two instances of func executing at the same time will have the same threadnr.
2778 * @return always 0 currently, but code should handle a future improvement where when any call to func
2779 * returns < 0 no further calls to func may be done and < 0 is returned.
2780 * - encoding: Set by libavcodec, user can override.
2781 * - decoding: Set by libavcodec, user can override.
2783 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2787 * Can be used by execute() to store some per AVCodecContext stuff.
2788 * - encoding: set by execute()
2789 * - decoding: set by execute()
2791 void *thread_opaque;
2794 * noise vs. sse weight for the nsse comparsion function
2795 * - encoding: Set by user.
2796 * - decoding: unused
2802 * - encoding: Set by user.
2803 * - decoding: Set by libavcodec.
2806 #define FF_PROFILE_UNKNOWN -99
2807 #define FF_PROFILE_RESERVED -100
2809 #define FF_PROFILE_AAC_MAIN 0
2810 #define FF_PROFILE_AAC_LOW 1
2811 #define FF_PROFILE_AAC_SSR 2
2812 #define FF_PROFILE_AAC_LTP 3
2814 #define FF_PROFILE_DTS 20
2815 #define FF_PROFILE_DTS_ES 30
2816 #define FF_PROFILE_DTS_96_24 40
2817 #define FF_PROFILE_DTS_HD_HRA 50
2818 #define FF_PROFILE_DTS_HD_MA 60
2820 #define FF_PROFILE_MPEG2_422 0
2821 #define FF_PROFILE_MPEG2_HIGH 1
2822 #define FF_PROFILE_MPEG2_SS 2
2823 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2824 #define FF_PROFILE_MPEG2_MAIN 4
2825 #define FF_PROFILE_MPEG2_SIMPLE 5
2827 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2828 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2830 #define FF_PROFILE_H264_BASELINE 66
2831 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2832 #define FF_PROFILE_H264_MAIN 77
2833 #define FF_PROFILE_H264_EXTENDED 88
2834 #define FF_PROFILE_H264_HIGH 100
2835 #define FF_PROFILE_H264_HIGH_10 110
2836 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2837 #define FF_PROFILE_H264_HIGH_422 122
2838 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2839 #define FF_PROFILE_H264_HIGH_444 144
2840 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2841 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2842 #define FF_PROFILE_H264_CAVLC_444 44
2844 #define FF_PROFILE_VC1_SIMPLE 0
2845 #define FF_PROFILE_VC1_MAIN 1
2846 #define FF_PROFILE_VC1_COMPLEX 2
2847 #define FF_PROFILE_VC1_ADVANCED 3
2849 #define FF_PROFILE_MPEG4_SIMPLE 0
2850 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2851 #define FF_PROFILE_MPEG4_CORE 2
2852 #define FF_PROFILE_MPEG4_MAIN 3
2853 #define FF_PROFILE_MPEG4_N_BIT 4
2854 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2855 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2856 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2857 #define FF_PROFILE_MPEG4_HYBRID 8
2858 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2859 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2860 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2861 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2862 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2863 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2864 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2868 * - encoding: Set by user.
2869 * - decoding: Set by libavcodec.
2872 #define FF_LEVEL_UNKNOWN -99
2876 * - encoding: unused
2877 * - decoding: Set by user.
2879 enum AVDiscard skip_loop_filter;
2883 * - encoding: unused
2884 * - decoding: Set by user.
2886 enum AVDiscard skip_idct;
2890 * - encoding: unused
2891 * - decoding: Set by user.
2893 enum AVDiscard skip_frame;
2896 * Header containing style information for text subtitles.
2897 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2898 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2899 * the Format line following. It shouldn't include any Dialogue line.
2900 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2901 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2903 uint8_t *subtitle_header;
2904 int subtitle_header_size;
2907 * Simulates errors in the bitstream to test error concealment.
2908 * - encoding: Set by user.
2909 * - decoding: unused
2914 * Current packet as passed into the decoder, to avoid having
2915 * to pass the packet into every function. Currently only valid
2916 * inside lavc and get/release_buffer callbacks.
2917 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2918 * - encoding: unused
2923 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2924 * Used for compliant TS muxing.
2925 * - encoding: Set by libavcodec.
2926 * - decoding: unused.
2931 * Current statistics for PTS correction.
2932 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2933 * - encoding: unused
2935 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2936 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2937 int64_t pts_correction_last_pts; /// PTS of the last frame
2938 int64_t pts_correction_last_dts; /// DTS of the last frame
2944 typedef struct AVProfile {
2946 const char *name; ///< short name for the profile
2949 typedef struct AVCodecDefault AVCodecDefault;
2954 typedef struct AVCodec {
2956 * Name of the codec implementation.
2957 * The name is globally unique among encoders and among decoders (but an
2958 * encoder and a decoder can share the same name).
2959 * This is the primary way to find a codec from the user perspective.
2963 * Descriptive name for the codec, meant to be more human readable than name.
2964 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2966 const char *long_name;
2967 enum AVMediaType type;
2970 * Codec capabilities.
2974 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2975 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2976 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2977 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2978 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2979 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2980 const AVClass *priv_class; ///< AVClass for the private context
2981 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2983 /*****************************************************************
2984 * No fields below this line are part of the public API. They
2985 * may not be used outside of libavcodec and can be changed and
2987 * New public fields should be added right above.
2988 *****************************************************************
2991 struct AVCodec *next;
2993 * @name Frame-level threading support functions
2997 * If defined, called on thread contexts when they are created.
2998 * If the codec allocates writable tables in init(), re-allocate them here.
2999 * priv_data will be set to a copy of the original.
3001 int (*init_thread_copy)(AVCodecContext *);
3003 * Copy necessary context variables from a previous thread context to the current one.
3004 * If not defined, the next thread will start automatically; otherwise, the codec
3005 * must call ff_thread_finish_setup().
3007 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3009 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3013 * Private codec-specific defaults.
3015 const AVCodecDefault *defaults;
3018 * Initialize codec static data, called from avcodec_register().
3020 void (*init_static_data)(struct AVCodec *codec);
3022 int (*init)(AVCodecContext *);
3023 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
3025 * Encode data to an AVPacket.
3027 * @param avctx codec context
3028 * @param avpkt output AVPacket (may contain a user-provided buffer)
3029 * @param[in] frame AVFrame containing the raw data to be encoded
3030 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3031 * non-empty packet was returned in avpkt.
3032 * @return 0 on success, negative error code on failure
3034 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3035 int *got_packet_ptr);
3036 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3037 int (*close)(AVCodecContext *);
3040 * Will be called when seeking
3042 void (*flush)(AVCodecContext *);
3048 typedef struct AVHWAccel {
3050 * Name of the hardware accelerated codec.
3051 * The name is globally unique among encoders and among decoders (but an
3052 * encoder and a decoder can share the same name).
3057 * Type of codec implemented by the hardware accelerator.
3059 * See AVMEDIA_TYPE_xxx
3061 enum AVMediaType type;
3064 * Codec implemented by the hardware accelerator.
3071 * Supported pixel format.
3073 * Only hardware accelerated formats are supported here.
3075 enum PixelFormat pix_fmt;
3078 * Hardware accelerated codec capabilities.
3079 * see FF_HWACCEL_CODEC_CAP_*
3083 struct AVHWAccel *next;
3086 * Called at the beginning of each frame or field picture.
3088 * Meaningful frame information (codec specific) is guaranteed to
3089 * be parsed at this point. This function is mandatory.
3091 * Note that buf can be NULL along with buf_size set to 0.
3092 * Otherwise, this means the whole frame is available at this point.
3094 * @param avctx the codec context
3095 * @param buf the frame data buffer base
3096 * @param buf_size the size of the frame in bytes
3097 * @return zero if successful, a negative value otherwise
3099 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3102 * Callback for each slice.
3104 * Meaningful slice information (codec specific) is guaranteed to
3105 * be parsed at this point. This function is mandatory.
3107 * @param avctx the codec context
3108 * @param buf the slice data buffer base
3109 * @param buf_size the size of the slice in bytes
3110 * @return zero if successful, a negative value otherwise
3112 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3115 * Called at the end of each frame or field picture.
3117 * The whole picture is parsed at this point and can now be sent
3118 * to the hardware accelerator. This function is mandatory.
3120 * @param avctx the codec context
3121 * @return zero if successful, a negative value otherwise
3123 int (*end_frame)(AVCodecContext *avctx);
3126 * Size of HW accelerator private data.
3128 * Private data is allocated with av_mallocz() before
3129 * AVCodecContext.get_buffer() and deallocated after
3130 * AVCodecContext.release_buffer().
3136 * @defgroup lavc_picture AVPicture
3138 * Functions for working with AVPicture
3143 * four components are given, that's all.
3144 * the last component is alpha
3146 typedef struct AVPicture {
3147 uint8_t *data[AV_NUM_DATA_POINTERS];
3148 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3155 enum AVSubtitleType {
3158 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3161 * Plain text, the text field must be set by the decoder and is
3162 * authoritative. ass and pict fields may contain approximations.
3167 * Formatted text, the ass field must be set by the decoder and is
3168 * authoritative. pict and text fields may contain approximations.
3173 typedef struct AVSubtitleRect {
3174 int x; ///< top left corner of pict, undefined when pict is not set
3175 int y; ///< top left corner of pict, undefined when pict is not set
3176 int w; ///< width of pict, undefined when pict is not set
3177 int h; ///< height of pict, undefined when pict is not set
3178 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3181 * data+linesize for the bitmap of this subtitle.
3182 * can be set for text/ass as well once they where rendered
3185 enum AVSubtitleType type;
3187 char *text; ///< 0 terminated plain UTF-8 text
3190 * 0 terminated ASS/SSA compatible event line.
3191 * The presentation of this is unaffected by the other values in this
3197 * 1 indicates this subtitle is a forced subtitle.
3198 * A forced subtitle should be displayed even when subtitles are hidden.
3203 typedef struct AVSubtitle {
3204 uint16_t format; /* 0 = graphics */
3205 uint32_t start_display_time; /* relative to packet pts, in ms */
3206 uint32_t end_display_time; /* relative to packet pts, in ms */
3208 AVSubtitleRect **rects;
3209 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3213 * If c is NULL, returns the first registered codec,
3214 * if c is non-NULL, returns the next registered codec after c,
3215 * or NULL if c is the last one.
3217 AVCodec *av_codec_next(AVCodec *c);
3220 * Return the LIBAVCODEC_VERSION_INT constant.
3222 unsigned avcodec_version(void);
3225 * Return the libavcodec build-time configuration.
3227 const char *avcodec_configuration(void);
3230 * Return the libavcodec license.
3232 const char *avcodec_license(void);
3235 * Register the codec codec and initialize libavcodec.
3237 * @warning either this function or avcodec_register_all() must be called
3238 * before any other libavcodec functions.
3240 * @see avcodec_register_all()
3242 void avcodec_register(AVCodec *codec);
3245 * Register all the codecs, parsers and bitstream filters which were enabled at
3246 * configuration time. If you do not call this function you can select exactly
3247 * which formats you want to support, by using the individual registration
3250 * @see avcodec_register
3251 * @see av_register_codec_parser
3252 * @see av_register_bitstream_filter
3254 void avcodec_register_all(void);
3257 #if FF_API_ALLOC_CONTEXT
3259 * Allocate an AVCodecContext and set its fields to default values. The
3260 * resulting struct can be deallocated by simply calling av_free().
3262 * @return An AVCodecContext filled with default values or NULL on failure.
3263 * @see avcodec_get_context_defaults
3265 * @deprecated use avcodec_alloc_context3()
3267 attribute_deprecated
3268 AVCodecContext *avcodec_alloc_context(void);
3270 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3271 * we WILL change its arguments and name a few times! */
3272 attribute_deprecated
3273 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3276 * Set the fields of the given AVCodecContext to default values.
3278 * @param s The AVCodecContext of which the fields should be set to default values.
3279 * @deprecated use avcodec_get_context_defaults3
3281 attribute_deprecated
3282 void avcodec_get_context_defaults(AVCodecContext *s);
3284 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3285 * we WILL change its arguments and name a few times! */
3286 attribute_deprecated
3287 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3291 * Allocate an AVCodecContext and set its fields to default values. The
3292 * resulting struct can be deallocated by calling avcodec_close() on it followed
3295 * @param codec if non-NULL, allocate private data and initialize defaults
3296 * for the given codec. It is illegal to then call avcodec_open2()
3297 * with a different codec.
3298 * If NULL, then the codec-specific defaults won't be initialized,
3299 * which may result in suboptimal default settings (this is
3300 * important mainly for encoders, e.g. libx264).
3302 * @return An AVCodecContext filled with default values or NULL on failure.
3303 * @see avcodec_get_context_defaults
3305 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3308 * Set the fields of the given AVCodecContext to default values corresponding
3309 * to the given codec (defaults may be codec-dependent).
3311 * Do not call this function if a non-NULL codec has been passed
3312 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3313 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3314 * different codec on this AVCodecContext.
3316 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3319 * Get the AVClass for AVCodecContext. It can be used in combination with
3320 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3322 * @see av_opt_find().
3324 const AVClass *avcodec_get_class(void);
3327 * Get the AVClass for AVFrame. It can be used in combination with
3328 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3330 * @see av_opt_find().
3332 const AVClass *avcodec_get_frame_class(void);
3335 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3336 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3338 * @see av_opt_find().
3340 const AVClass *avcodec_get_subtitle_rect_class(void);
3343 * Copy the settings of the source AVCodecContext into the destination
3344 * AVCodecContext. The resulting destination codec context will be
3345 * unopened, i.e. you are required to call avcodec_open2() before you
3346 * can use this AVCodecContext to decode/encode video/audio data.
3348 * @param dest target codec context, should be initialized with
3349 * avcodec_alloc_context3(), but otherwise uninitialized
3350 * @param src source codec context
3351 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3353 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3356 * Allocate an AVFrame and set its fields to default values. The resulting
3357 * struct can be deallocated by simply calling av_free().
3359 * @return An AVFrame filled with default values or NULL on failure.
3360 * @see avcodec_get_frame_defaults
3362 AVFrame *avcodec_alloc_frame(void);
3365 * Set the fields of the given AVFrame to default values.
3367 * @param pic The AVFrame of which the fields should be set to default values.
3369 void avcodec_get_frame_defaults(AVFrame *pic);
3371 #if FF_API_AVCODEC_OPEN
3373 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3374 * function the context has to be allocated.
3376 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3377 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3378 * retrieving a codec.
3380 * @warning This function is not thread safe!
3383 * avcodec_register_all();
3384 * codec = avcodec_find_decoder(CODEC_ID_H264);
3388 * context = avcodec_alloc_context3(codec);
3390 * if (avcodec_open(context, codec) < 0)
3394 * @param avctx The context which will be set up to use the given codec.
3395 * @param codec The codec to use within the context.
3396 * @return zero on success, a negative value on error
3397 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3399 * @deprecated use avcodec_open2
3401 attribute_deprecated
3402 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3406 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3407 * function the context has to be allocated with avcodec_alloc_context3().
3409 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3410 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3411 * retrieving a codec.
3413 * @warning This function is not thread safe!
3416 * avcodec_register_all();
3417 * av_dict_set(&opts, "b", "2.5M", 0);
3418 * codec = avcodec_find_decoder(CODEC_ID_H264);
3422 * context = avcodec_alloc_context3(codec);
3424 * if (avcodec_open2(context, codec, opts) < 0)
3428 * @param avctx The context to initialize.
3429 * @param codec The codec to open this context for. If a non-NULL codec has been
3430 * previously passed to avcodec_alloc_context3() or
3431 * avcodec_get_context_defaults3() for this context, then this
3432 * parameter MUST be either NULL or equal to the previously passed
3434 * @param options A dictionary filled with AVCodecContext and codec-private options.
3435 * On return this object will be filled with options that were not found.
3437 * @return zero on success, a negative value on error
3438 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3439 * av_dict_set(), av_opt_find().
3441 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3444 * Close a given AVCodecContext and free all the data associated with it
3445 * (but not the AVCodecContext itself).
3447 * Calling this function on an AVCodecContext that hasn't been opened will free
3448 * the codec-specific data allocated in avcodec_alloc_context3() /
3449 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3452 int avcodec_close(AVCodecContext *avctx);
3455 * Free all allocated data in the given subtitle struct.
3457 * @param sub AVSubtitle to free.
3459 void avsubtitle_free(AVSubtitle *sub);
3466 * @addtogroup lavc_packet
3471 * @deprecated use NULL instead
3473 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3476 * Default packet destructor.
3478 void av_destruct_packet(AVPacket *pkt);
3481 * Initialize optional fields of a packet with default values.
3483 * Note, this does not touch the data and size members, which have to be
3484 * initialized separately.
3488 void av_init_packet(AVPacket *pkt);
3491 * Allocate the payload of a packet and initialize its fields with
3495 * @param size wanted payload size
3496 * @return 0 if OK, AVERROR_xxx otherwise
3498 int av_new_packet(AVPacket *pkt, int size);
3501 * Reduce packet size, correctly zeroing padding
3504 * @param size new size
3506 void av_shrink_packet(AVPacket *pkt, int size);
3509 * Increase packet size, correctly zeroing padding
3512 * @param grow_by number of bytes by which to increase the size of the packet
3514 int av_grow_packet(AVPacket *pkt, int grow_by);
3517 * @warning This is a hack - the packet memory allocation stuff is broken. The
3518 * packet is allocated if it was not really allocated.
3520 int av_dup_packet(AVPacket *pkt);
3525 * @param pkt packet to free
3527 void av_free_packet(AVPacket *pkt);
3530 * Allocate new information of a packet.
3533 * @param type side information type
3534 * @param size side information size
3535 * @return pointer to fresh allocated data or NULL otherwise
3537 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3541 * Shrink the already allocated side data buffer
3544 * @param type side information type
3545 * @param size new side information size
3546 * @return 0 on success, < 0 on failure
3548 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3552 * Get side information from packet.
3555 * @param type desired side information type
3556 * @param size pointer for side information size to store (optional)
3557 * @return pointer to data if present or NULL otherwise
3559 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3562 int av_packet_merge_side_data(AVPacket *pkt);
3564 int av_packet_split_side_data(AVPacket *pkt);
3572 * @addtogroup lavc_decoding
3577 * Find a registered decoder with a matching codec ID.
3579 * @param id CodecID of the requested decoder
3580 * @return A decoder if one was found, NULL otherwise.
3582 AVCodec *avcodec_find_decoder(enum CodecID id);
3585 * Find a registered decoder with the specified name.
3587 * @param name name of the requested decoder
3588 * @return A decoder if one was found, NULL otherwise.
3590 AVCodec *avcodec_find_decoder_by_name(const char *name);
3592 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3593 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3594 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3597 * Return the amount of padding in pixels which the get_buffer callback must
3598 * provide around the edge of the image for codecs which do not have the
3599 * CODEC_FLAG_EMU_EDGE flag.
3601 * @return Required padding in pixels.
3603 unsigned avcodec_get_edge_width(void);
3606 * Modify width and height values so that they will result in a memory
3607 * buffer that is acceptable for the codec if you do not use any horizontal
3610 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3611 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3612 * according to avcodec_get_edge_width() before.
3614 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3617 * Modify width and height values so that they will result in a memory
3618 * buffer that is acceptable for the codec if you also ensure that all
3619 * line sizes are a multiple of the respective linesize_align[i].
3621 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3622 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3623 * according to avcodec_get_edge_width() before.
3625 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3626 int linesize_align[AV_NUM_DATA_POINTERS]);
3628 #if FF_API_OLD_DECODE_AUDIO
3630 * Wrapper function which calls avcodec_decode_audio4.
3632 * @deprecated Use avcodec_decode_audio4 instead.
3634 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3635 * Some decoders may support multiple frames in a single AVPacket, such
3636 * decoders would then just decode the first frame. In this case,
3637 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3638 * the remaining data in order to decode the second frame etc.
3640 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3641 * decompressed frame size in bytes.
3643 * @warning You must set frame_size_ptr to the allocated size of the
3644 * output buffer before calling avcodec_decode_audio3().
3646 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3647 * the actual read bytes because some optimized bitstream readers read 32 or 64
3648 * bits at once and could read over the end.
3650 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3651 * no overreading happens for damaged MPEG streams.
3653 * @warning You must not provide a custom get_buffer() when using
3654 * avcodec_decode_audio3(). Doing so will override it with
3655 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3656 * which does allow the application to provide a custom get_buffer().
3658 * @note You might have to align the input buffer avpkt->data and output buffer
3659 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3660 * necessary at all, on others it won't work at all if not aligned and on others
3661 * it will work but it will have an impact on performance.
3663 * In practice, avpkt->data should have 4 byte alignment at minimum and
3664 * samples should be 16 byte aligned unless the CPU doesn't need it
3665 * (AltiVec and SSE do).
3667 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3668 * between input and output, these need to be fed with avpkt->data=NULL,
3669 * avpkt->size=0 at the end to return the remaining frames.
3671 * @param avctx the codec context
3672 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3673 * If the sample format is planar, each channel plane will
3674 * be the same size, with no padding between channels.
3675 * @param[in,out] frame_size_ptr the output buffer size in bytes
3676 * @param[in] avpkt The input AVPacket containing the input buffer.
3677 * You can create such packet with av_init_packet() and by then setting
3678 * data and size, some decoders might in addition need other fields.
3679 * All decoders are designed to use the least fields possible though.
3680 * @return On error a negative value is returned, otherwise the number of bytes
3681 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3683 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3684 int *frame_size_ptr,
3689 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3691 * Some decoders may support multiple frames in a single AVPacket. Such
3692 * decoders would then just decode the first frame. In this case,
3693 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3694 * the remaining data in order to decode the second frame, etc...
3695 * Even if no frames are returned, the packet needs to be fed to the decoder
3696 * with remaining data until it is completely consumed or an error occurs.
3698 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3699 * larger than the actual read bytes because some optimized bitstream
3700 * readers read 32 or 64 bits at once and could read over the end.
3702 * @note You might have to align the input buffer. The alignment requirements
3703 * depend on the CPU and the decoder.
3705 * @param avctx the codec context
3706 * @param[out] frame The AVFrame in which to store decoded audio samples.
3707 * Decoders request a buffer of a particular size by setting
3708 * AVFrame.nb_samples prior to calling get_buffer(). The
3709 * decoder may, however, only utilize part of the buffer by
3710 * setting AVFrame.nb_samples to a smaller value in the
3712 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3714 * @param[in] avpkt The input AVPacket containing the input buffer.
3715 * At least avpkt->data and avpkt->size should be set. Some
3716 * decoders might also require additional fields to be set.
3717 * @return A negative error code is returned if an error occurred during
3718 * decoding, otherwise the number of bytes consumed from the input
3719 * AVPacket is returned.
3721 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3722 int *got_frame_ptr, const AVPacket *avpkt);
3725 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3726 * Some decoders may support multiple frames in a single AVPacket, such
3727 * decoders would then just decode the first frame.
3729 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3730 * the actual read bytes because some optimized bitstream readers read 32 or 64
3731 * bits at once and could read over the end.
3733 * @warning The end of the input buffer buf should be set to 0 to ensure that
3734 * no overreading happens for damaged MPEG streams.
3736 * @note You might have to align the input buffer avpkt->data.
3737 * The alignment requirements depend on the CPU: on some CPUs it isn't
3738 * necessary at all, on others it won't work at all if not aligned and on others
3739 * it will work but it will have an impact on performance.
3741 * In practice, avpkt->data should have 4 byte alignment at minimum.
3743 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3744 * between input and output, these need to be fed with avpkt->data=NULL,
3745 * avpkt->size=0 at the end to return the remaining frames.
3747 * @param avctx the codec context
3748 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3749 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3750 * allocate memory for the actual bitmap.
3751 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3752 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3753 * decodes and the decoder tells the user once it does not need the data anymore,
3754 * the user app can at this point free/reuse/keep the memory as it sees fit.
3756 * @param[in] avpkt The input AVpacket containing the input buffer.
3757 * You can create such packet with av_init_packet() and by then setting
3758 * data and size, some decoders might in addition need other fields like
3759 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3761 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3762 * @return On error a negative value is returned, otherwise the number of bytes
3763 * used or zero if no frame could be decompressed.
3765 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3766 int *got_picture_ptr,
3767 const AVPacket *avpkt);
3770 * Decode a subtitle message.
3771 * Return a negative value on error, otherwise return the number of bytes used.
3772 * If no subtitle could be decompressed, got_sub_ptr is zero.
3773 * Otherwise, the subtitle is stored in *sub.
3774 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3775 * simplicity, because the performance difference is expect to be negligible
3776 * and reusing a get_buffer written for video codecs would probably perform badly
3777 * due to a potentially very different allocation pattern.
3779 * @param avctx the codec context
3780 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3781 freed with avsubtitle_free if *got_sub_ptr is set.
3782 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3783 * @param[in] avpkt The input AVPacket containing the input buffer.
3785 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3790 * @defgroup lavc_parsing Frame parsing
3794 typedef struct AVCodecParserContext {
3796 struct AVCodecParser *parser;
3797 int64_t frame_offset; /* offset of the current frame */
3798 int64_t cur_offset; /* current offset
3799 (incremented by each av_parser_parse()) */
3800 int64_t next_frame_offset; /* offset of the next frame */
3802 int pict_type; /* XXX: Put it back in AVCodecContext. */
3804 * This field is used for proper frame duration computation in lavf.
3805 * It signals, how much longer the frame duration of the current frame
3806 * is compared to normal frame duration.
3808 * frame_duration = (1 + repeat_pict) * time_base
3810 * It is used by codecs like H.264 to display telecined material.
3812 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3813 int64_t pts; /* pts of the current frame */
3814 int64_t dts; /* dts of the current frame */
3819 int fetch_timestamp;
3821 #define AV_PARSER_PTS_NB 4
3822 int cur_frame_start_index;
3823 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3824 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3825 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3828 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3829 #define PARSER_FLAG_ONCE 0x0002
3830 /// Set if the parser has a valid file offset
3831 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3832 #define PARSER_FLAG_USE_CODEC_TS 0x1000
3834 int64_t offset; ///< byte offset from starting packet start
3835 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3838 * Set by parser to 1 for key frames and 0 for non-key frames.
3839 * It is initialized to -1, so if the parser doesn't set this flag,
3840 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3846 * Time difference in stream time base units from the pts of this
3847 * packet to the point at which the output from the decoder has converged
3848 * independent from the availability of previous frames. That is, the
3849 * frames are virtually identical no matter if decoding started from
3850 * the very first frame or from this keyframe.
3851 * Is AV_NOPTS_VALUE if unknown.
3852 * This field is not the display duration of the current frame.
3853 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3856 * The purpose of this field is to allow seeking in streams that have no
3857 * keyframes in the conventional sense. It corresponds to the
3858 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3859 * essential for some types of subtitle streams to ensure that all
3860 * subtitles are correctly displayed after seeking.
3862 int64_t convergence_duration;
3864 // Timestamp generation support:
3866 * Synchronization point for start of timestamp generation.
3868 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3871 * For example, this corresponds to presence of H.264 buffering period
3877 * Offset of the current timestamp against last timestamp sync point in
3878 * units of AVCodecContext.time_base.
3880 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3881 * contain a valid timestamp offset.
3883 * Note that the timestamp of sync point has usually a nonzero
3884 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3885 * the next frame after timestamp sync point will be usually 1.
3887 * For example, this corresponds to H.264 cpb_removal_delay.
3889 int dts_ref_dts_delta;
3892 * Presentation delay of current frame in units of AVCodecContext.time_base.
3894 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3895 * contain valid non-negative timestamp delta (presentation time of a frame
3896 * must not lie in the past).
3898 * This delay represents the difference between decoding and presentation
3899 * time of the frame.
3901 * For example, this corresponds to H.264 dpb_output_delay.
3906 * Position of the packet in file.
3908 * Analogous to cur_frame_pts/dts
3910 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3913 * Byte position of currently parsed frame in stream.
3918 * Previous frame byte position.
3923 * Duration of the current frame.
3924 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3925 * For all other types, this is in units of AVCodecContext.time_base.
3928 } AVCodecParserContext;
3930 typedef struct AVCodecParser {
3931 int codec_ids[5]; /* several codec IDs are permitted */
3933 int (*parser_init)(AVCodecParserContext *s);
3934 int (*parser_parse)(AVCodecParserContext *s,
3935 AVCodecContext *avctx,
3936 const uint8_t **poutbuf, int *poutbuf_size,
3937 const uint8_t *buf, int buf_size);
3938 void (*parser_close)(AVCodecParserContext *s);
3939 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3940 struct AVCodecParser *next;
3943 AVCodecParser *av_parser_next(AVCodecParser *c);
3945 void av_register_codec_parser(AVCodecParser *parser);
3946 AVCodecParserContext *av_parser_init(int codec_id);
3951 * @param s parser context.
3952 * @param avctx codec context.
3953 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3954 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3955 * @param buf input buffer.
3956 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3957 * @param pts input presentation timestamp.
3958 * @param dts input decoding timestamp.
3959 * @param pos input byte position in stream.
3960 * @return the number of bytes of the input bitstream used.
3965 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3972 * decode_frame(data, size);
3976 int av_parser_parse2(AVCodecParserContext *s,
3977 AVCodecContext *avctx,
3978 uint8_t **poutbuf, int *poutbuf_size,
3979 const uint8_t *buf, int buf_size,
3980 int64_t pts, int64_t dts,
3983 int av_parser_change(AVCodecParserContext *s,
3984 AVCodecContext *avctx,
3985 uint8_t **poutbuf, int *poutbuf_size,
3986 const uint8_t *buf, int buf_size, int keyframe);
3987 void av_parser_close(AVCodecParserContext *s);
3995 * @addtogroup lavc_encoding
4000 * Find a registered encoder with a matching codec ID.
4002 * @param id CodecID of the requested encoder
4003 * @return An encoder if one was found, NULL otherwise.
4005 AVCodec *avcodec_find_encoder(enum CodecID id);
4008 * Find a registered encoder with the specified name.
4010 * @param name name of the requested encoder
4011 * @return An encoder if one was found, NULL otherwise.
4013 AVCodec *avcodec_find_encoder_by_name(const char *name);
4015 #if FF_API_OLD_ENCODE_AUDIO
4017 * Encode an audio frame from samples into buf.
4019 * @deprecated Use avcodec_encode_audio2 instead.
4021 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4022 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4023 * will know how much space is needed because it depends on the value passed
4024 * in buf_size as described below. In that case a lower value can be used.
4026 * @param avctx the codec context
4027 * @param[out] buf the output buffer
4028 * @param[in] buf_size the output buffer size
4029 * @param[in] samples the input buffer containing the samples
4030 * The number of samples read from this buffer is frame_size*channels,
4031 * both of which are defined in avctx.
4032 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4033 * samples read from samples is equal to:
4034 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4035 * This also implies that av_get_bits_per_sample() must not return 0 for these
4037 * @return On error a negative value is returned, on success zero or the number
4038 * of bytes used to encode the data read from the input buffer.
4040 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4041 uint8_t *buf, int buf_size,
4042 const short *samples);
4046 * Encode a frame of audio.
4048 * Takes input samples from frame and writes the next output packet, if
4049 * available, to avpkt. The output packet does not necessarily contain data for
4050 * the most recent frame, as encoders can delay, split, and combine input frames
4051 * internally as needed.
4053 * @param avctx codec context
4054 * @param avpkt output AVPacket.
4055 * The user can supply an output buffer by setting
4056 * avpkt->data and avpkt->size prior to calling the
4057 * function, but if the size of the user-provided data is not
4058 * large enough, encoding will fail. If avpkt->data and
4059 * avpkt->size are set, avpkt->destruct must also be set. All
4060 * other AVPacket fields will be reset by the encoder using
4061 * av_init_packet(). If avpkt->data is NULL, the encoder will
4062 * allocate it. The encoder will set avpkt->size to the size
4063 * of the output packet.
4065 * If this function fails or produces no output, avpkt will be
4066 * freed using av_free_packet() (i.e. avpkt->destruct will be
4067 * called to free the user supplied buffer).
4068 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4069 * May be NULL when flushing an encoder that has the
4070 * CODEC_CAP_DELAY capability set.
4071 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4072 * can have any number of samples.
4073 * If it is not set, frame->nb_samples must be equal to
4074 * avctx->frame_size for all frames except the last.
4075 * The final frame may be smaller than avctx->frame_size.
4076 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4077 * output packet is non-empty, and to 0 if it is
4078 * empty. If the function returns an error, the
4079 * packet can be assumed to be invalid, and the
4080 * value of got_packet_ptr is undefined and should
4082 * @return 0 on success, negative error code on failure
4084 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4085 const AVFrame *frame, int *got_packet_ptr);
4087 #if FF_API_OLD_ENCODE_VIDEO
4089 * @deprecated use avcodec_encode_video2() instead.
4091 * Encode a video frame from pict into buf.
4092 * The input picture should be
4093 * stored using a specific format, namely avctx.pix_fmt.
4095 * @param avctx the codec context
4096 * @param[out] buf the output buffer for the bitstream of encoded frame
4097 * @param[in] buf_size the size of the output buffer in bytes
4098 * @param[in] pict the input picture to encode
4099 * @return On error a negative value is returned, on success zero or the number
4100 * of bytes used from the output buffer.
4102 attribute_deprecated
4103 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4104 const AVFrame *pict);
4108 * Encode a frame of video.
4110 * Takes input raw video data from frame and writes the next output packet, if
4111 * available, to avpkt. The output packet does not necessarily contain data for
4112 * the most recent frame, as encoders can delay and reorder input frames
4113 * internally as needed.
4115 * @param avctx codec context
4116 * @param avpkt output AVPacket.
4117 * The user can supply an output buffer by setting
4118 * avpkt->data and avpkt->size prior to calling the
4119 * function, but if the size of the user-provided data is not
4120 * large enough, encoding will fail. All other AVPacket fields
4121 * will be reset by the encoder using av_init_packet(). If
4122 * avpkt->data is NULL, the encoder will allocate it.
4123 * The encoder will set avpkt->size to the size of the
4124 * output packet. The returned data (if any) belongs to the
4125 * caller, he is responsible for freeing it.
4127 * If this function fails or produces no output, avpkt will be
4128 * freed using av_free_packet() (i.e. avpkt->destruct will be
4129 * called to free the user supplied buffer).
4130 * @param[in] frame AVFrame containing the raw video data to be encoded.
4131 * May be NULL when flushing an encoder that has the
4132 * CODEC_CAP_DELAY capability set.
4133 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4134 * output packet is non-empty, and to 0 if it is
4135 * empty. If the function returns an error, the
4136 * packet can be assumed to be invalid, and the
4137 * value of got_packet_ptr is undefined and should
4139 * @return 0 on success, negative error code on failure
4141 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4142 const AVFrame *frame, int *got_packet_ptr);
4144 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4145 const AVSubtitle *sub);
4153 * @defgroup lavc_resample Audio resampling
4158 struct ReSampleContext;
4159 struct AVResampleContext;
4161 typedef struct ReSampleContext ReSampleContext;
4164 * Initialize audio resampling context.
4166 * @param output_channels number of output channels
4167 * @param input_channels number of input channels
4168 * @param output_rate output sample rate
4169 * @param input_rate input sample rate
4170 * @param sample_fmt_out requested output sample format
4171 * @param sample_fmt_in input sample format
4172 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4173 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4174 * @param linear if 1 then the used FIR filter will be linearly interpolated
4175 between the 2 closest, if 0 the closest will be used
4176 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4177 * @return allocated ReSampleContext, NULL if error occurred
4179 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4180 int output_rate, int input_rate,
4181 enum AVSampleFormat sample_fmt_out,
4182 enum AVSampleFormat sample_fmt_in,
4183 int filter_length, int log2_phase_count,
4184 int linear, double cutoff);
4186 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4189 * Free resample context.
4191 * @param s a non-NULL pointer to a resample context previously
4192 * created with av_audio_resample_init()
4194 void audio_resample_close(ReSampleContext *s);
4198 * Initialize an audio resampler.
4199 * Note, if either rate is not an integer then simply scale both rates up so they are.
4200 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4201 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4202 * @param linear If 1 then the used FIR filter will be linearly interpolated
4203 between the 2 closest, if 0 the closest will be used
4204 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4206 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4209 * Resample an array of samples using a previously configured context.
4210 * @param src an array of unconsumed samples
4211 * @param consumed the number of samples of src which have been consumed are returned here
4212 * @param src_size the number of unconsumed samples available
4213 * @param dst_size the amount of space in samples available in dst
4214 * @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.
4215 * @return the number of samples written in dst or -1 if an error occurred
4217 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4221 * Compensate samplerate/timestamp drift. The compensation is done by changing
4222 * the resampler parameters, so no audible clicks or similar distortions occur
4223 * @param compensation_distance distance in output samples over which the compensation should be performed
4224 * @param sample_delta number of output samples which should be output less
4226 * example: av_resample_compensate(c, 10, 500)
4227 * here instead of 510 samples only 500 samples would be output
4229 * note, due to rounding the actual compensation might be slightly different,
4230 * especially if the compensation_distance is large and the in_rate used during init is small
4232 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4233 void av_resample_close(struct AVResampleContext *c);
4240 * @addtogroup lavc_picture
4245 * Allocate memory for a picture. Call avpicture_free() to free it.
4247 * @see avpicture_fill()
4249 * @param picture the picture to be filled in
4250 * @param pix_fmt the format of the picture
4251 * @param width the width of the picture
4252 * @param height the height of the picture
4253 * @return zero if successful, a negative value if not
4255 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
4258 * Free a picture previously allocated by avpicture_alloc().
4259 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4262 * @param picture the AVPicture to be freed
4264 void avpicture_free(AVPicture *picture);
4267 * Fill in the AVPicture fields, always assume a linesize alignment of
4270 * @see av_image_fill_arrays()
4272 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4273 enum PixelFormat pix_fmt, int width, int height);
4276 * Copy pixel data from an AVPicture into a buffer, always assume a
4277 * linesize alignment of 1.
4279 * @see av_image_copy_to_buffer()
4281 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
4282 unsigned char *dest, int dest_size);
4285 * Calculate the size in bytes that a picture of the given width and height
4286 * would occupy if stored in the given picture format.
4287 * Always assume a linesize alignment of 1.
4289 * @see av_image_get_buffer_size().
4291 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
4294 * deinterlace - if not supported return -1
4296 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4297 enum PixelFormat pix_fmt, int width, int height);
4299 * Copy image src to dst. Wraps av_image_copy().
4301 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4302 enum PixelFormat pix_fmt, int width, int height);
4305 * Crop image top and left side.
4307 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4308 enum PixelFormat pix_fmt, int top_band, int left_band);
4313 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4314 int padtop, int padbottom, int padleft, int padright, int *color);
4321 * @defgroup lavc_misc Utility functions
4324 * Miscellaneous utility functions related to both encoding and decoding
4330 * @defgroup lavc_misc_pixfmt Pixel formats
4332 * Functions for working with pixel formats.
4336 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
4339 * Return a value representing the fourCC code associated to the
4340 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4343 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
4345 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4346 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4347 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4348 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4349 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4350 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4353 * Compute what kind of losses will occur when converting from one specific
4354 * pixel format to another.
4355 * When converting from one pixel format to another, information loss may occur.
4356 * For example, when converting from RGB24 to GRAY, the color information will
4357 * be lost. Similarly, other losses occur when converting from some formats to
4358 * other formats. These losses can involve loss of chroma, but also loss of
4359 * resolution, loss of color depth, loss due to the color space conversion, loss
4360 * of the alpha bits or loss due to color quantization.
4361 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4362 * which will occur when converting from one pixel format to another.
4364 * @param[in] dst_pix_fmt destination pixel format
4365 * @param[in] src_pix_fmt source pixel format
4366 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4367 * @return Combination of flags informing you what kind of losses will occur
4368 * (maximum loss for an invalid dst_pix_fmt).
4370 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
4374 * Find the best pixel format to convert to given a certain source pixel
4375 * format. When converting from one pixel format to another, information loss
4376 * may occur. For example, when converting from RGB24 to GRAY, the color
4377 * information will be lost. Similarly, other losses occur when converting from
4378 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4379 * the given pixel formats should be used to suffer the least amount of loss.
4380 * The pixel formats from which it chooses one, are determined by the
4381 * pix_fmt_mask parameter.
4383 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
4386 * src_pix_fmt = PIX_FMT_YUV420P;
4387 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
4388 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4391 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4392 * @param[in] src_pix_fmt source pixel format
4393 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4394 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4395 * @return The best pixel format to convert to or -1 if none was found.
4397 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
4398 int has_alpha, int *loss_ptr);
4401 * Find the best pixel format to convert to given a certain source pixel
4402 * format and a selection of two destination pixel formats. When converting from
4403 * one pixel format to another, information loss may occur. For example, when converting
4404 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4405 * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
4406 * the given pixel formats should be used to suffer the least amount of loss.
4408 * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
4412 * src_pix_fmt = PIX_FMT_YUV420P;
4413 * dst_pix_fmt1= PIX_FMT_RGB24;
4414 * dst_pix_fmt2= PIX_FMT_GRAY8;
4415 * dst_pix_fmt3= PIX_FMT_RGB8;
4416 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4417 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4418 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4421 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4422 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4423 * @param[in] src_pix_fmt Source pixel format
4424 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4425 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4426 * NULL or value of zero means we care about all losses. Out: the loss
4427 * that occurs when converting from src to selected dst pixel format.
4428 * @return The best pixel format to convert to or -1 if none was found.
4430 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
4431 enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4433 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4439 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4442 * Put a string representing the codec tag codec_tag in buf.
4444 * @param buf_size size in bytes of buf
4445 * @return the length of the string that would have been generated if
4446 * enough space had been available, excluding the trailing null
4448 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4450 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4453 * Return a name for the specified profile, if available.
4455 * @param codec the codec that is searched for the given profile
4456 * @param profile the profile value for which a name is requested
4457 * @return A name for the profile if found, NULL otherwise.
4459 const char *av_get_profile_name(const AVCodec *codec, int profile);
4461 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4462 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4463 //FIXME func typedef
4466 * Fill audio frame data and linesize.
4467 * AVFrame extended_data channel pointers are allocated if necessary for
4470 * @param frame the AVFrame
4471 * frame->nb_samples must be set prior to calling the
4472 * function. This function fills in frame->data,
4473 * frame->extended_data, frame->linesize[0].
4474 * @param nb_channels channel count
4475 * @param sample_fmt sample format
4476 * @param buf buffer to use for frame data
4477 * @param buf_size size of buffer
4478 * @param align plane size sample alignment (0 = default)
4479 * @return 0 on success, negative error code on failure
4481 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4482 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4483 int buf_size, int align);
4486 * Flush buffers, should be called when seeking or when switching to a different stream.
4488 void avcodec_flush_buffers(AVCodecContext *avctx);
4490 void avcodec_default_free_buffers(AVCodecContext *s);
4493 * Return codec bits per sample.
4495 * @param[in] codec_id the codec
4496 * @return Number of bits per sample or zero if unknown for the given codec.
4498 int av_get_bits_per_sample(enum CodecID codec_id);
4501 * Return the PCM codec associated with a sample format.
4502 * @param be endianness, 0 for little, 1 for big,
4503 * -1 (or anything else) for native
4504 * @return CODEC_ID_PCM_* or CODEC_ID_NONE
4506 enum CodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4509 * Return codec bits per sample.
4510 * Only return non-zero if the bits per sample is exactly correct, not an
4513 * @param[in] codec_id the codec
4514 * @return Number of bits per sample or zero if unknown for the given codec.
4516 int av_get_exact_bits_per_sample(enum CodecID codec_id);
4519 * Return audio frame duration.
4521 * @param avctx codec context
4522 * @param frame_bytes size of the frame, or 0 if unknown
4523 * @return frame duration, in samples, if known. 0 if not able to
4526 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4529 typedef struct AVBitStreamFilterContext {
4531 struct AVBitStreamFilter *filter;
4532 AVCodecParserContext *parser;
4533 struct AVBitStreamFilterContext *next;
4534 } AVBitStreamFilterContext;
4537 typedef struct AVBitStreamFilter {
4540 int (*filter)(AVBitStreamFilterContext *bsfc,
4541 AVCodecContext *avctx, const char *args,
4542 uint8_t **poutbuf, int *poutbuf_size,
4543 const uint8_t *buf, int buf_size, int keyframe);
4544 void (*close)(AVBitStreamFilterContext *bsfc);
4545 struct AVBitStreamFilter *next;
4546 } AVBitStreamFilter;
4548 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4549 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4550 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4551 AVCodecContext *avctx, const char *args,
4552 uint8_t **poutbuf, int *poutbuf_size,
4553 const uint8_t *buf, int buf_size, int keyframe);
4554 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4556 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4561 * Reallocate the given block if it is not large enough, otherwise do nothing.
4565 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4568 * Allocate a buffer, reusing the given one if large enough.
4570 * Contrary to av_fast_realloc the current buffer contents might not be
4571 * preserved and on error the old buffer is freed, thus no special
4572 * handling to avoid memleaks is necessary.
4574 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4575 * @param size size of the buffer *ptr points to
4576 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4577 * *size 0 if an error occurred.
4579 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4582 * Same behaviour av_fast_malloc but the buffer has additional
4583 * FF_INPUT_PADDING_SIZE at the end which will will always be 0.
4585 * In addition the whole buffer will initially and after resizes
4586 * be 0-initialized so that no uninitialized data will ever appear.
4588 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4591 * Encode extradata length to a buffer. Used by xiph codecs.
4593 * @param s buffer to write to; must be at least (v/255+1) bytes long
4594 * @param v size of extradata in bytes
4595 * @return number of bytes written to the buffer.
4597 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4600 * Log a generic warning message about a missing feature. This function is
4601 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4602 * only, and would normally not be used by applications.
4603 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4604 * a pointer to an AVClass struct
4605 * @param[in] feature string containing the name of the missing feature
4606 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4607 * If want_sample is non-zero, additional verbage will be added to the log
4608 * message which tells the user how to report samples to the development
4611 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4614 * Log a generic warning message asking for a sample. This function is
4615 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4616 * only, and would normally not be used by applications.
4617 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4618 * a pointer to an AVClass struct
4619 * @param[in] msg string containing an optional message, or NULL if no message
4621 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4624 * Register the hardware accelerator hwaccel.
4626 void av_register_hwaccel(AVHWAccel *hwaccel);
4629 * If hwaccel is NULL, returns the first registered hardware accelerator,
4630 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4631 * after hwaccel, or NULL if hwaccel is the last one.
4633 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4637 * Lock operation used by lockmgr
4640 AV_LOCK_CREATE, ///< Create a mutex
4641 AV_LOCK_OBTAIN, ///< Lock the mutex
4642 AV_LOCK_RELEASE, ///< Unlock the mutex
4643 AV_LOCK_DESTROY, ///< Free mutex resources
4647 * Register a user provided lock manager supporting the operations
4648 * specified by AVLockOp. mutex points to a (void *) where the
4649 * lockmgr should store/get a pointer to a user allocated mutex. It's
4650 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4652 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4653 * callback during the call to av_lockmgr_register().
4654 * Thus, the application must be prepared to handle that.
4655 * If cb is set to NULL the lockmgr will be unregistered.
4656 * Also note that during unregistration the previously registered
4657 * lockmgr callback may also be invoked.
4659 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4662 * Get the type of the given codec.
4664 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4667 * Get the name of a codec.
4668 * @return a static string identifying the codec; never NULL
4670 const char *avcodec_get_name(enum CodecID id);
4673 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4674 * with no corresponding avcodec_close()), 0 otherwise.
4676 int avcodec_is_open(AVCodecContext *s);
4679 * @return a non-zero number if codec is an encoder, zero otherwise
4681 int av_codec_is_encoder(AVCodec *codec);
4684 * @return a non-zero number if codec is a decoder, zero otherwise
4686 int av_codec_is_decoder(AVCodec *codec);
4692 #endif /* AVCODEC_AVCODEC_H */