2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * Libav is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
38 #include "libavcodec/version.h"
40 * @defgroup libavc Encoding/Decoding Library
43 * @defgroup lavc_decoding Decoding
47 * @defgroup lavc_encoding Encoding
51 * @defgroup lavc_codec Codecs
53 * @defgroup lavc_codec_native Native Codecs
56 * @defgroup lavc_codec_wrappers External library wrappers
59 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
63 * @defgroup lavc_internal Internal
71 * @defgroup lavc_core Core functions/structures.
74 * Basic definitions, functions for querying libavcodec capabilities,
75 * allocating core structures, etc.
80 * Identify the syntax and semantics of the bitstream.
81 * The principle is roughly:
82 * Two decoders with the same ID can decode the same streams.
83 * Two encoders with the same ID can encode compatible streams.
84 * There may be slight deviations from the principle due to implementation
87 * If you add a codec ID to this list, add it so that
88 * 1. no value of a existing codec ID changes (that would break ABI),
89 * 2. it is as close as possible to similar codecs.
96 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
97 CODEC_ID_MPEG2VIDEO_XVMC,
134 CODEC_ID_INTERPLAY_VIDEO,
146 CODEC_ID_TRUEMOTION1,
173 CODEC_ID_TRUEMOTION2,
190 CODEC_ID_DSICINVIDEO,
191 CODEC_ID_TIERTEXSEQVIDEO,
199 CODEC_ID_BETHSOFTVID,
215 CODEC_ID_MOTIONPIXELS,
233 CODEC_ID_IFF_BYTERUN1,
259 /* various PCM "codecs" */
260 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
261 CODEC_ID_PCM_S16LE = 0x10000,
277 CODEC_ID_PCM_S24DAUD,
279 CODEC_ID_PCM_S16LE_PLANAR,
288 CODEC_ID_PCM_S8_PLANAR,
290 /* various ADPCM codecs */
291 CODEC_ID_ADPCM_IMA_QT = 0x11000,
292 CODEC_ID_ADPCM_IMA_WAV,
293 CODEC_ID_ADPCM_IMA_DK3,
294 CODEC_ID_ADPCM_IMA_DK4,
295 CODEC_ID_ADPCM_IMA_WS,
296 CODEC_ID_ADPCM_IMA_SMJPEG,
305 CODEC_ID_ADPCM_YAMAHA,
306 CODEC_ID_ADPCM_SBPRO_4,
307 CODEC_ID_ADPCM_SBPRO_3,
308 CODEC_ID_ADPCM_SBPRO_2,
310 CODEC_ID_ADPCM_IMA_AMV,
311 CODEC_ID_ADPCM_EA_R1,
312 CODEC_ID_ADPCM_EA_R3,
313 CODEC_ID_ADPCM_EA_R2,
314 CODEC_ID_ADPCM_IMA_EA_SEAD,
315 CODEC_ID_ADPCM_IMA_EA_EACS,
316 CODEC_ID_ADPCM_EA_XAS,
317 CODEC_ID_ADPCM_EA_MAXIS_XA,
318 CODEC_ID_ADPCM_IMA_ISS,
320 CODEC_ID_ADPCM_IMA_APC,
323 CODEC_ID_AMR_NB = 0x12000,
326 /* RealAudio codecs*/
327 CODEC_ID_RA_144 = 0x13000,
330 /* various DPCM codecs */
331 CODEC_ID_ROQ_DPCM = 0x14000,
332 CODEC_ID_INTERPLAY_DPCM,
337 CODEC_ID_MP2 = 0x15000,
338 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
354 CODEC_ID_WESTWOOD_SND1,
355 CODEC_ID_GSM, ///< as in Berlin toast format
363 CODEC_ID_DSICINAUDIO,
367 CODEC_ID_GSM_MS, /* as found in WAV */
376 CODEC_ID_WMALOSSLESS,
385 CODEC_ID_BINKAUDIO_RDFT,
386 CODEC_ID_BINKAUDIO_DCT,
397 /* subtitle codecs */
398 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
399 CODEC_ID_DVD_SUBTITLE = 0x17000,
400 CODEC_ID_DVB_SUBTITLE,
401 CODEC_ID_TEXT, ///< raw UTF-8 text
405 CODEC_ID_HDMV_PGS_SUBTITLE,
406 CODEC_ID_DVB_TELETEXT,
409 /* other specific kind of codecs (generally used for attachments) */
410 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
411 CODEC_ID_TTF = 0x18000,
413 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
415 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
416 * stream (only used by libavformat) */
417 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
418 * stream (only used by libavformat) */
419 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
422 #if FF_API_OLD_DECODE_AUDIO
424 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
428 * @ingroup lavc_decoding
429 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
430 * This is mainly needed because some optimized bitstream readers read
431 * 32 or 64 bit at once and could read over the end.<br>
432 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
433 * MPEG bitstreams could cause overread and segfault.
435 #define FF_INPUT_BUFFER_PADDING_SIZE 8
438 * @ingroup lavc_encoding
439 * minimum encoding buffer size
440 * Used to avoid some checks during header writing.
442 #define FF_MIN_BUFFER_SIZE 16384
446 * @ingroup lavc_encoding
447 * motion estimation type.
450 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
454 ME_EPZS, ///< enhanced predictive zonal search
455 ME_X1, ///< reserved for experiments
456 ME_HEX, ///< hexagon based search
457 ME_UMH, ///< uneven multi-hexagon search
458 ME_ITER, ///< iterative search
459 ME_TESA, ///< transformed exhaustive search algorithm
463 * @ingroup lavc_decoding
466 /* We leave some space between them for extensions (drop some
467 * keyframes for intra-only or drop just some bidir frames). */
468 AVDISCARD_NONE =-16, ///< discard nothing
469 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
470 AVDISCARD_NONREF = 8, ///< discard all non reference
471 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
472 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
473 AVDISCARD_ALL = 48, ///< discard all
476 enum AVColorPrimaries{
477 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
478 AVCOL_PRI_UNSPECIFIED = 2,
479 AVCOL_PRI_BT470M = 4,
480 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
481 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
482 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
484 AVCOL_PRI_NB , ///< Not part of ABI
487 enum AVColorTransferCharacteristic{
488 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
489 AVCOL_TRC_UNSPECIFIED = 2,
490 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
491 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
492 AVCOL_TRC_SMPTE240M = 7,
493 AVCOL_TRC_NB , ///< Not part of ABI
498 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
499 AVCOL_SPC_UNSPECIFIED = 2,
501 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
502 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
503 AVCOL_SPC_SMPTE240M = 7,
504 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
505 AVCOL_SPC_NB , ///< Not part of ABI
509 AVCOL_RANGE_UNSPECIFIED = 0,
510 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
511 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
512 AVCOL_RANGE_NB , ///< Not part of ABI
516 * X X 3 4 X X are luma samples,
517 * 1 2 1-6 are possible chroma positions
518 * X X 5 6 X 0 is undefined/unknown position
520 enum AVChromaLocation{
521 AVCHROMA_LOC_UNSPECIFIED = 0,
522 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
523 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
524 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
525 AVCHROMA_LOC_TOP = 4,
526 AVCHROMA_LOC_BOTTOMLEFT = 5,
527 AVCHROMA_LOC_BOTTOM = 6,
528 AVCHROMA_LOC_NB , ///< Not part of ABI
531 enum AVAudioServiceType {
532 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
533 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
534 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
535 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
536 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
537 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
538 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
539 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
540 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
541 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
545 * @ingroup lavc_encoding
547 typedef struct RcOverride{
550 int qscale; // If this is 0 then quality_factor will be used instead.
551 float quality_factor;
554 #define FF_MAX_B_FRAMES 16
557 These flags can be passed in AVCodecContext.flags before initialization.
558 Note: Not everything is supported yet.
561 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
562 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
563 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
564 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
565 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
567 * The parent program guarantees that the input for B-frames containing
568 * streams is not written to for at least s->max_b_frames+1 frames, if
569 * this is not set the input will be copied.
571 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
572 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
573 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
574 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
575 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
576 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
577 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
578 location instead of only at frame boundaries. */
579 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
580 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
581 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
582 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
583 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
584 /* Fx : Flag for h263+ extra options */
585 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
586 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
587 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
588 #define CODEC_FLAG_CLOSED_GOP 0x80000000
589 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
590 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
591 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
592 #if FF_API_MPV_GLOBAL_OPTS
593 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
594 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
595 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
596 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
598 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
600 /* Unsupported options :
601 * Syntax Arithmetic coding (SAC)
602 * Reference Picture Selection
603 * Independent Segment Decoding */
605 /* codec capabilities */
607 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
609 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
610 * If not set, it might not use get_buffer() at all or use operations that
611 * assume the buffer was allocated by avcodec_default_get_buffer.
613 #define CODEC_CAP_DR1 0x0002
614 #define CODEC_CAP_TRUNCATED 0x0008
615 /* Codec can export data for HW decoding (XvMC). */
616 #define CODEC_CAP_HWACCEL 0x0010
618 * Encoder or decoder requires flushing with NULL input at the end in order to
619 * give the complete and correct output.
621 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
622 * with NULL data. The user can still send NULL data to the public encode
623 * or decode function, but libavcodec will not pass it along to the codec
624 * unless this flag is set.
627 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
628 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
632 * The encoder needs to be fed with NULL data at the end of encoding until the
633 * encoder no longer returns data.
635 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
636 * flag also means that the encoder must set the pts and duration for
637 * each output packet. If this flag is not set, the pts and duration will
638 * be determined by libavcodec from the input frame.
640 #define CODEC_CAP_DELAY 0x0020
642 * Codec can be fed a final frame with a smaller size.
643 * This can be used to prevent truncation of the last audio samples.
645 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
647 * Codec can export data for HW decoding (VDPAU).
649 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
651 * Codec can output multiple frames per AVPacket
652 * Normally demuxers return one frame at a time, demuxers which do not do
653 * are connected to a parser to split what they return into proper frames.
654 * This flag is reserved to the very rare category of codecs which have a
655 * bitstream that cannot be split into frames without timeconsuming
656 * operations like full decoding. Demuxers carring such bitstreams thus
657 * may return multiple frames in a packet. This has many disadvantages like
658 * prohibiting stream copy in many cases thus it should only be considered
661 #define CODEC_CAP_SUBFRAMES 0x0100
663 * Codec is experimental and is thus avoided in favor of non experimental
666 #define CODEC_CAP_EXPERIMENTAL 0x0200
668 * Codec should fill in channel configuration and samplerate instead of container
670 #define CODEC_CAP_CHANNEL_CONF 0x0400
672 * Codec is able to deal with negative linesizes
674 #define CODEC_CAP_NEG_LINESIZES 0x0800
676 * Codec supports frame-level multithreading.
678 #define CODEC_CAP_FRAME_THREADS 0x1000
680 * Codec supports slice-based (or partition-based) multithreading.
682 #define CODEC_CAP_SLICE_THREADS 0x2000
684 * Codec supports changed parameters at any point.
686 #define CODEC_CAP_PARAM_CHANGE 0x4000
688 * Codec supports avctx->thread_count == 0 (auto).
690 #define CODEC_CAP_AUTO_THREADS 0x8000
692 * Audio encoder supports receiving a different number of samples in each call.
694 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
696 //The following defines may change, don't expect compatibility if you use them.
697 #define MB_TYPE_INTRA4x4 0x0001
698 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
699 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
700 #define MB_TYPE_16x16 0x0008
701 #define MB_TYPE_16x8 0x0010
702 #define MB_TYPE_8x16 0x0020
703 #define MB_TYPE_8x8 0x0040
704 #define MB_TYPE_INTERLACED 0x0080
705 #define MB_TYPE_DIRECT2 0x0100 //FIXME
706 #define MB_TYPE_ACPRED 0x0200
707 #define MB_TYPE_GMC 0x0400
708 #define MB_TYPE_SKIP 0x0800
709 #define MB_TYPE_P0L0 0x1000
710 #define MB_TYPE_P1L0 0x2000
711 #define MB_TYPE_P0L1 0x4000
712 #define MB_TYPE_P1L1 0x8000
713 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
714 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
715 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
716 #define MB_TYPE_QUANT 0x00010000
717 #define MB_TYPE_CBP 0x00020000
718 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
722 * This specifies the area which should be displayed.
723 * Note there may be multiple such areas for one frame.
725 typedef struct AVPanScan{
728 * - encoding: Set by user.
729 * - decoding: Set by libavcodec.
734 * width and height in 1/16 pel
735 * - encoding: Set by user.
736 * - decoding: Set by libavcodec.
742 * position of the top left corner in 1/16 pel for up to 3 fields/frames
743 * - encoding: Set by user.
744 * - decoding: Set by libavcodec.
746 int16_t position[3][2];
749 #define FF_QSCALE_TYPE_MPEG1 0
750 #define FF_QSCALE_TYPE_MPEG2 1
751 #define FF_QSCALE_TYPE_H264 2
752 #define FF_QSCALE_TYPE_VP56 3
754 #define FF_BUFFER_TYPE_INTERNAL 1
755 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
756 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
757 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
759 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
760 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
761 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
762 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
765 * @defgroup lavc_packet AVPacket
767 * Types and functions for working with AVPacket.
770 enum AVPacketSideDataType {
772 AV_PKT_DATA_NEW_EXTRADATA,
775 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
778 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
779 * s32le channel_count
780 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
781 * u64le channel_layout
782 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
784 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
789 AV_PKT_DATA_PARAM_CHANGE,
792 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
793 * structures with info about macroblocks relevant to splitting the
794 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
795 * That is, it does not necessarily contain info about all macroblocks,
796 * as long as the distance between macroblocks in the info is smaller
797 * than the target payload size.
798 * Each MB info structure is 12 bytes, and is laid out as follows:
800 * u32le bit offset from the start of the packet
801 * u8 current quantizer at the start of the macroblock
803 * u16le macroblock address within the GOB
804 * u8 horizontal MV predictor
805 * u8 vertical MV predictor
806 * u8 horizontal MV predictor for block number 3
807 * u8 vertical MV predictor for block number 3
810 AV_PKT_DATA_H263_MB_INFO,
813 typedef struct AVPacket {
815 * Presentation timestamp in AVStream->time_base units; the time at which
816 * the decompressed packet will be presented to the user.
817 * Can be AV_NOPTS_VALUE if it is not stored in the file.
818 * pts MUST be larger or equal to dts as presentation cannot happen before
819 * decompression, unless one wants to view hex dumps. Some formats misuse
820 * the terms dts and pts/cts to mean something different. Such timestamps
821 * must be converted to true pts/dts before they are stored in AVPacket.
825 * Decompression timestamp in AVStream->time_base units; the time at which
826 * the packet is decompressed.
827 * Can be AV_NOPTS_VALUE if it is not stored in the file.
834 * A combination of AV_PKT_FLAG values
838 * Additional packet data that can be provided by the container.
839 * Packet can contain several types of side information.
844 enum AVPacketSideDataType type;
849 * Duration of this packet in AVStream->time_base units, 0 if unknown.
850 * Equals next_pts - this_pts in presentation order.
853 void (*destruct)(struct AVPacket *);
855 int64_t pos; ///< byte position in stream, -1 if unknown
858 * Time difference in AVStream->time_base units from the pts of this
859 * packet to the point at which the output from the decoder has converged
860 * independent from the availability of previous frames. That is, the
861 * frames are virtually identical no matter if decoding started from
862 * the very first frame or from this keyframe.
863 * Is AV_NOPTS_VALUE if unknown.
864 * This field is not the display duration of the current packet.
865 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
868 * The purpose of this field is to allow seeking in streams that have no
869 * keyframes in the conventional sense. It corresponds to the
870 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
871 * essential for some types of subtitle streams to ensure that all
872 * subtitles are correctly displayed after seeking.
874 int64_t convergence_duration;
876 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
877 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
879 enum AVSideDataParamChangeFlags {
880 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
881 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
882 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
883 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
891 * New fields can be added to the end of AVFRAME with minor version
892 * bumps. Removal, reordering and changes to existing fields require
893 * a major version bump.
894 * sizeof(AVFrame) must not be used outside libav*.
896 typedef struct AVFrame {
897 #define AV_NUM_DATA_POINTERS 8
899 * pointer to the picture/channel planes.
900 * This might be different from the first allocated byte
901 * - encoding: Set by user
902 * - decoding: set by AVCodecContext.get_buffer()
904 uint8_t *data[AV_NUM_DATA_POINTERS];
907 * Size, in bytes, of the data for each picture/channel plane.
909 * For audio, only linesize[0] may be set. For planar audio, each channel
910 * plane must be the same size.
912 * - encoding: Set by user
913 * - decoding: set by AVCodecContext.get_buffer()
915 int linesize[AV_NUM_DATA_POINTERS];
918 * pointers to the data planes/channels.
920 * For video, this should simply point to data[].
922 * For planar audio, each channel has a separate data pointer, and
923 * linesize[0] contains the size of each channel buffer.
924 * For packed audio, there is just one data pointer, and linesize[0]
925 * contains the total size of the buffer for all channels.
927 * Note: Both data and extended_data will always be set by get_buffer(),
928 * but for planar audio with more channels that can fit in data,
929 * extended_data must be used by the decoder in order to access all
933 * decoding: set by AVCodecContext.get_buffer()
935 uint8_t **extended_data;
938 * width and height of the video frame
940 * - decoding: Read by user.
945 * number of audio samples (per channel) described by this frame
946 * - encoding: Set by user
947 * - decoding: Set by libavcodec
952 * format of the frame, -1 if unknown or unset
953 * Values correspond to enum PixelFormat for video frames,
954 * enum AVSampleFormat for audio)
956 * - decoding: Read by user.
961 * 1 -> keyframe, 0-> not
962 * - encoding: Set by libavcodec.
963 * - decoding: Set by libavcodec.
968 * Picture type of the frame, see ?_TYPE below.
969 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
970 * - decoding: Set by libavcodec.
972 enum AVPictureType pict_type;
975 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
976 * This isn't used by libavcodec unless the default get/release_buffer() is used.
980 uint8_t *base[AV_NUM_DATA_POINTERS];
983 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
985 * - decoding: Read by user.
987 AVRational sample_aspect_ratio;
990 * presentation timestamp in time_base units (time when frame should be shown to user)
991 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
992 * - encoding: MUST be set by user.
993 * - decoding: Set by libavcodec.
998 * reordered pts from the last AVPacket that has been input into the decoder
1000 * - decoding: Read by user.
1005 * dts from the last AVPacket that has been input into the decoder
1006 * - encoding: unused
1007 * - decoding: Read by user.
1012 * picture number in bitstream order
1013 * - encoding: set by
1014 * - decoding: Set by libavcodec.
1016 int coded_picture_number;
1018 * picture number in display order
1019 * - encoding: set by
1020 * - decoding: Set by libavcodec.
1022 int display_picture_number;
1025 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1026 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1027 * - decoding: Set by libavcodec.
1032 * is this picture used as reference
1033 * The values for this are the same as the MpegEncContext.picture_structure
1034 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1035 * Set to 4 for delayed, non-reference frames.
1036 * - encoding: unused
1037 * - decoding: Set by libavcodec. (before get_buffer() call)).
1043 * - encoding: unused
1044 * - decoding: Set by libavcodec.
1046 int8_t *qscale_table;
1049 * - encoding: unused
1050 * - decoding: Set by libavcodec.
1060 * mbskip_table[mb]>=1 if MB didn't change
1061 * stride= mb_width = (width+15)>>4
1062 * - encoding: unused
1063 * - decoding: Set by libavcodec.
1065 uint8_t *mbskip_table;
1068 * motion vector table
1071 * int mv_sample_log2= 4 - motion_subsample_log2;
1072 * int mb_width= (width+15)>>4;
1073 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1074 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1076 * - encoding: Set by user.
1077 * - decoding: Set by libavcodec.
1079 int16_t (*motion_val[2])[2];
1082 * macroblock type table
1083 * mb_type_base + mb_width + 2
1084 * - encoding: Set by user.
1085 * - decoding: Set by libavcodec.
1091 * - encoding: unused
1092 * - decoding: Set by libavcodec.
1097 * motion reference frame index
1098 * the order in which these are stored can depend on the codec.
1099 * - encoding: Set by user.
1100 * - decoding: Set by libavcodec.
1102 int8_t *ref_index[2];
1105 * for some private data of the user
1106 * - encoding: unused
1107 * - decoding: Set by user.
1113 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1114 * - decoding: unused
1116 uint64_t error[AV_NUM_DATA_POINTERS];
1119 * type of the buffer (to keep track of who has to deallocate data[*])
1120 * - encoding: Set by the one who allocates it.
1121 * - decoding: Set by the one who allocates it.
1122 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1127 * When decoding, this signals how much the picture must be delayed.
1128 * extra_delay = repeat_pict / (2*fps)
1129 * - encoding: unused
1130 * - decoding: Set by libavcodec.
1135 * The content of the picture is interlaced.
1136 * - encoding: Set by user.
1137 * - decoding: Set by libavcodec. (default 0)
1139 int interlaced_frame;
1142 * If the content is interlaced, is top field displayed first.
1143 * - encoding: Set by user.
1144 * - decoding: Set by libavcodec.
1146 int top_field_first;
1149 * Tell user application that palette has changed from previous frame.
1150 * - encoding: ??? (no palette-enabled encoder yet)
1151 * - decoding: Set by libavcodec. (default 0).
1153 int palette_has_changed;
1156 * codec suggestion on buffer type if != 0
1157 * - encoding: unused
1158 * - decoding: Set by libavcodec. (before get_buffer() call)).
1164 * - encoding: Set by user.
1165 * - decoding: Set by libavcodec.
1167 AVPanScan *pan_scan;
1170 * reordered opaque 64bit (generally an integer or a double precision float
1171 * PTS but can be anything).
1172 * The user sets AVCodecContext.reordered_opaque to represent the input at
1174 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1175 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1176 * @deprecated in favor of pkt_pts
1177 * - encoding: unused
1178 * - decoding: Read by user.
1180 int64_t reordered_opaque;
1183 * hardware accelerator private data (Libav-allocated)
1184 * - encoding: unused
1185 * - decoding: Set by libavcodec
1187 void *hwaccel_picture_private;
1190 * the AVCodecContext which ff_thread_get_buffer() was last called on
1191 * - encoding: Set by libavcodec.
1192 * - decoding: Set by libavcodec.
1194 struct AVCodecContext *owner;
1197 * used by multithreading to store frame-specific info
1198 * - encoding: Set by libavcodec.
1199 * - decoding: Set by libavcodec.
1201 void *thread_opaque;
1204 * log2 of the size of the block which a single vector in motion_val represents:
1205 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1206 * - encoding: unused
1207 * - decoding: Set by libavcodec.
1209 uint8_t motion_subsample_log2;
1212 * Sample rate of the audio data.
1214 * - encoding: unused
1215 * - decoding: set by get_buffer()
1220 * Channel layout of the audio data.
1222 * - encoding: unused
1223 * - decoding: set by get_buffer()
1225 uint64_t channel_layout;
1228 struct AVCodecInternal;
1232 AV_FIELD_PROGRESSIVE,
1233 AV_FIELD_TT, //< Top coded_first, top displayed first
1234 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1235 AV_FIELD_TB, //< Top coded first, bottom displayed first
1236 AV_FIELD_BT, //< Bottom coded first, top displayed first
1240 * main external API structure.
1241 * New fields can be added to the end with minor version bumps.
1242 * Removal, reordering and changes to existing fields require a major
1244 * sizeof(AVCodecContext) must not be used outside libav*.
1246 typedef struct AVCodecContext {
1248 * information on struct for av_log
1249 * - set by avcodec_alloc_context3
1251 const AVClass *av_class;
1252 int log_level_offset;
1254 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1255 struct AVCodec *codec;
1256 char codec_name[32];
1257 enum CodecID codec_id; /* see CODEC_ID_xxx */
1260 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1261 * This is used to work around some encoder bugs.
1262 * A demuxer should set this to what is stored in the field used to identify the codec.
1263 * If there are multiple such fields in a container then the demuxer should choose the one
1264 * which maximizes the information about the used codec.
1265 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1266 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1267 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1269 * - encoding: Set by user, if not then the default based on codec_id will be used.
1270 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1272 unsigned int codec_tag;
1275 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1276 * This is used to work around some encoder bugs.
1277 * - encoding: unused
1278 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1280 unsigned int stream_codec_tag;
1284 * @deprecated this field is unused
1286 attribute_deprecated int sub_id;
1292 * Private context used for internal data.
1294 * Unlike priv_data, this is not codec-specific. It is used in general
1295 * libavcodec functions.
1297 struct AVCodecInternal *internal;
1300 * Private data of the user, can be used to carry app specific stuff.
1301 * - encoding: Set by user.
1302 * - decoding: Set by user.
1307 * the average bitrate
1308 * - encoding: Set by user; unused for constant quantizer encoding.
1309 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1314 * number of bits the bitstream is allowed to diverge from the reference.
1315 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1316 * - encoding: Set by user; unused for constant quantizer encoding.
1317 * - decoding: unused
1319 int bit_rate_tolerance;
1322 * Global quality for codecs which cannot change it per frame.
1323 * This should be proportional to MPEG-1/2/4 qscale.
1324 * - encoding: Set by user.
1325 * - decoding: unused
1330 * - encoding: Set by user.
1331 * - decoding: unused
1333 int compression_level;
1334 #define FF_COMPRESSION_DEFAULT -1
1338 * - encoding: Set by user.
1339 * - decoding: Set by user.
1345 * - encoding: Set by user.
1346 * - decoding: Set by user.
1351 * some codecs need / can use extradata like Huffman tables.
1352 * mjpeg: Huffman tables
1353 * rv10: additional flags
1354 * mpeg4: global headers (they can be in the bitstream or here)
1355 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1356 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1357 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1358 * - encoding: Set/allocated/freed by libavcodec.
1359 * - decoding: Set/allocated/freed by user.
1365 * This is the fundamental unit of time (in seconds) in terms
1366 * of which frame timestamps are represented. For fixed-fps content,
1367 * timebase should be 1/framerate and timestamp increments should be
1369 * - encoding: MUST be set by user.
1370 * - decoding: Set by libavcodec.
1372 AVRational time_base;
1375 * For some codecs, the time base is closer to the field rate than the frame rate.
1376 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1377 * if no telecine is used ...
1379 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1381 int ticks_per_frame;
1387 * Number of frames the decoded output will be delayed relative to the
1391 * Number of "priming" samples added to the beginning of the stream
1392 * during encoding. The decoded output will be delayed by this many
1393 * samples relative to the input to the encoder. Note that this field is
1394 * purely informational and does not directly affect the pts output by
1395 * the encoder, which should always be based on the actual presentation
1396 * time, including any delay.
1398 * - encoding: Set by libavcodec.
1399 * - decoding: unused
1406 * picture width / height.
1407 * - encoding: MUST be set by user.
1408 * - decoding: Set by libavcodec.
1409 * Note: For compatibility it is possible to set this instead of
1410 * coded_width/height before decoding.
1415 * Bitstream width / height, may be different from width/height.
1416 * - encoding: unused
1417 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1419 int coded_width, coded_height;
1421 #define FF_ASPECT_EXTENDED 15
1424 * the number of pictures in a group of pictures, or 0 for intra_only
1425 * - encoding: Set by user.
1426 * - decoding: unused
1431 * Pixel format, see PIX_FMT_xxx.
1432 * May be set by the demuxer if known from headers.
1433 * May be overriden by the decoder if it knows better.
1434 * - encoding: Set by user.
1435 * - decoding: Set by user if known, overridden by libavcodec if known
1437 enum PixelFormat pix_fmt;
1440 * Motion estimation algorithm used for video coding.
1441 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1442 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1443 * - encoding: MUST be set by user.
1444 * - decoding: unused
1449 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1450 * decoder to draw a horizontal band. It improves cache usage. Not
1451 * all codecs can do that. You must check the codec capabilities
1453 * When multithreading is used, it may be called from multiple threads
1454 * at the same time; threads might draw different parts of the same AVFrame,
1455 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1457 * The function is also used by hardware acceleration APIs.
1458 * It is called at least once during frame decoding to pass
1459 * the data needed for hardware render.
1460 * In that mode instead of pixel data, AVFrame points to
1461 * a structure specific to the acceleration API. The application
1462 * reads the structure and can change some fields to indicate progress
1464 * - encoding: unused
1465 * - decoding: Set by user.
1466 * @param height the height of the slice
1467 * @param y the y position of the slice
1468 * @param type 1->top field, 2->bottom field, 3->frame
1469 * @param offset offset into the AVFrame.data from which the slice should be read
1471 void (*draw_horiz_band)(struct AVCodecContext *s,
1472 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1473 int y, int type, int height);
1476 * callback to negotiate the pixelFormat
1477 * @param fmt is the list of formats which are supported by the codec,
1478 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1479 * The first is always the native one.
1480 * @return the chosen format
1481 * - encoding: unused
1482 * - decoding: Set by user, if not set the native format will be chosen.
1484 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1487 * maximum number of B-frames between non-B-frames
1488 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1489 * - encoding: Set by user.
1490 * - decoding: unused
1495 * qscale factor between IP and B-frames
1496 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1497 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1498 * - encoding: Set by user.
1499 * - decoding: unused
1501 float b_quant_factor;
1503 /** obsolete FIXME remove */
1505 #define FF_RC_STRATEGY_XVID 1
1507 int b_frame_strategy;
1509 #if FF_API_MPV_GLOBAL_OPTS
1511 * luma single coefficient elimination threshold
1512 * - encoding: Set by user.
1513 * - decoding: unused
1515 attribute_deprecated int luma_elim_threshold;
1518 * chroma single coeff elimination threshold
1519 * - encoding: Set by user.
1520 * - decoding: unused
1522 attribute_deprecated int chroma_elim_threshold;
1526 * qscale offset between IP and B-frames
1527 * - encoding: Set by user.
1528 * - decoding: unused
1530 float b_quant_offset;
1533 * Size of the frame reordering buffer in the decoder.
1534 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1535 * - encoding: Set by libavcodec.
1536 * - decoding: Set by libavcodec.
1541 * 0-> h263 quant 1-> mpeg quant
1542 * - encoding: Set by user.
1543 * - decoding: unused
1548 * qscale factor between P and I-frames
1549 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1550 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1551 * - encoding: Set by user.
1552 * - decoding: unused
1554 float i_quant_factor;
1557 * qscale offset between P and I-frames
1558 * - encoding: Set by user.
1559 * - decoding: unused
1561 float i_quant_offset;
1564 * luminance masking (0-> disabled)
1565 * - encoding: Set by user.
1566 * - decoding: unused
1571 * temporary complexity masking (0-> disabled)
1572 * - encoding: Set by user.
1573 * - decoding: unused
1575 float temporal_cplx_masking;
1578 * spatial complexity masking (0-> disabled)
1579 * - encoding: Set by user.
1580 * - decoding: unused
1582 float spatial_cplx_masking;
1585 * p block masking (0-> disabled)
1586 * - encoding: Set by user.
1587 * - decoding: unused
1592 * darkness masking (0-> disabled)
1593 * - encoding: Set by user.
1594 * - decoding: unused
1600 * - encoding: Set by libavcodec.
1601 * - decoding: Set by user (or 0).
1605 * prediction method (needed for huffyuv)
1606 * - encoding: Set by user.
1607 * - decoding: unused
1609 int prediction_method;
1610 #define FF_PRED_LEFT 0
1611 #define FF_PRED_PLANE 1
1612 #define FF_PRED_MEDIAN 2
1615 * slice offsets in the frame in bytes
1616 * - encoding: Set/allocated by libavcodec.
1617 * - decoding: Set/allocated by user (or NULL).
1622 * sample aspect ratio (0 if unknown)
1623 * That is the width of a pixel divided by the height of the pixel.
1624 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1625 * - encoding: Set by user.
1626 * - decoding: Set by libavcodec.
1628 AVRational sample_aspect_ratio;
1631 * motion estimation comparison function
1632 * - encoding: Set by user.
1633 * - decoding: unused
1637 * subpixel motion estimation comparison function
1638 * - encoding: Set by user.
1639 * - decoding: unused
1643 * macroblock comparison function (not supported yet)
1644 * - encoding: Set by user.
1645 * - decoding: unused
1649 * interlaced DCT comparison function
1650 * - encoding: Set by user.
1651 * - decoding: unused
1654 #define FF_CMP_SAD 0
1655 #define FF_CMP_SSE 1
1656 #define FF_CMP_SATD 2
1657 #define FF_CMP_DCT 3
1658 #define FF_CMP_PSNR 4
1659 #define FF_CMP_BIT 5
1661 #define FF_CMP_ZERO 7
1662 #define FF_CMP_VSAD 8
1663 #define FF_CMP_VSSE 9
1664 #define FF_CMP_NSSE 10
1665 #define FF_CMP_W53 11
1666 #define FF_CMP_W97 12
1667 #define FF_CMP_DCTMAX 13
1668 #define FF_CMP_DCT264 14
1669 #define FF_CMP_CHROMA 256
1672 * ME diamond size & shape
1673 * - encoding: Set by user.
1674 * - decoding: unused
1679 * amount of previous MV predictors (2a+1 x 2a+1 square)
1680 * - encoding: Set by user.
1681 * - decoding: unused
1683 int last_predictor_count;
1686 * prepass for motion estimation
1687 * - encoding: Set by user.
1688 * - decoding: unused
1693 * motion estimation prepass comparison function
1694 * - encoding: Set by user.
1695 * - decoding: unused
1700 * ME prepass diamond size & shape
1701 * - encoding: Set by user.
1702 * - decoding: unused
1708 * - encoding: Set by user.
1709 * - decoding: unused
1711 int me_subpel_quality;
1714 * DTG active format information (additional aspect ratio
1715 * information only used in DVB MPEG-2 transport streams)
1718 * - encoding: unused
1719 * - decoding: Set by decoder.
1721 int dtg_active_format;
1722 #define FF_DTG_AFD_SAME 8
1723 #define FF_DTG_AFD_4_3 9
1724 #define FF_DTG_AFD_16_9 10
1725 #define FF_DTG_AFD_14_9 11
1726 #define FF_DTG_AFD_4_3_SP_14_9 13
1727 #define FF_DTG_AFD_16_9_SP_14_9 14
1728 #define FF_DTG_AFD_SP_4_3 15
1731 * maximum motion estimation search range in subpel units
1732 * If 0 then no limit.
1734 * - encoding: Set by user.
1735 * - decoding: unused
1740 * intra quantizer bias
1741 * - encoding: Set by user.
1742 * - decoding: unused
1744 int intra_quant_bias;
1745 #define FF_DEFAULT_QUANT_BIAS 999999
1748 * inter quantizer bias
1749 * - encoding: Set by user.
1750 * - decoding: unused
1752 int inter_quant_bias;
1754 #if FF_API_COLOR_TABLE_ID
1757 * - encoding: unused
1758 * - decoding: Which clrtable should be used for 8bit RGB images.
1759 * Tables have to be stored somewhere. FIXME
1761 attribute_deprecated int color_table_id;
1766 * - encoding: unused
1767 * - decoding: Set by user.
1770 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1771 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1772 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1775 * XVideo Motion Acceleration
1776 * - encoding: forbidden
1777 * - decoding: set by decoder
1779 int xvmc_acceleration;
1782 * macroblock decision mode
1783 * - encoding: Set by user.
1784 * - decoding: unused
1787 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1788 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1789 #define FF_MB_DECISION_RD 2 ///< rate distortion
1792 * custom intra quantization matrix
1793 * - encoding: Set by user, can be NULL.
1794 * - decoding: Set by libavcodec.
1796 uint16_t *intra_matrix;
1799 * custom inter quantization matrix
1800 * - encoding: Set by user, can be NULL.
1801 * - decoding: Set by libavcodec.
1803 uint16_t *inter_matrix;
1806 * scene change detection threshold
1807 * 0 is default, larger means fewer detected scene changes.
1808 * - encoding: Set by user.
1809 * - decoding: unused
1811 int scenechange_threshold;
1814 * noise reduction strength
1815 * - encoding: Set by user.
1816 * - decoding: unused
1818 int noise_reduction;
1820 #if FF_API_INTER_THRESHOLD
1822 * @deprecated this field is unused
1824 attribute_deprecated int inter_threshold;
1827 #if FF_API_MPV_GLOBAL_OPTS
1829 * @deprecated use mpegvideo private options instead
1831 attribute_deprecated int quantizer_noise_shaping;
1835 * Motion estimation threshold below which no motion estimation is
1836 * performed, but instead the user specified motion vectors are used.
1838 * - encoding: Set by user.
1839 * - decoding: unused
1844 * Macroblock threshold below which the user specified macroblock types will be used.
1845 * - encoding: Set by user.
1846 * - decoding: unused
1851 * precision of the intra DC coefficient - 8
1852 * - encoding: Set by user.
1853 * - decoding: unused
1855 int intra_dc_precision;
1858 * Number of macroblock rows at the top which are skipped.
1859 * - encoding: unused
1860 * - decoding: Set by user.
1865 * Number of macroblock rows at the bottom which are skipped.
1866 * - encoding: unused
1867 * - decoding: Set by user.
1872 * Border processing masking, raises the quantizer for mbs on the borders
1874 * - encoding: Set by user.
1875 * - decoding: unused
1877 float border_masking;
1880 * minimum MB lagrange multipler
1881 * - encoding: Set by user.
1882 * - decoding: unused
1887 * maximum MB lagrange multipler
1888 * - encoding: Set by user.
1889 * - decoding: unused
1895 * - encoding: Set by user.
1896 * - decoding: unused
1898 int me_penalty_compensation;
1902 * - encoding: Set by user.
1903 * - decoding: unused
1909 * - encoding: Set by user.
1910 * - decoding: unused
1916 * - encoding: Set by user.
1917 * - decoding: unused
1922 * number of reference frames
1923 * - encoding: Set by user.
1924 * - decoding: Set by lavc.
1929 * chroma qp offset from luma
1930 * - encoding: Set by user.
1931 * - decoding: unused
1936 * Multiplied by qscale for each frame and added to scene_change_score.
1937 * - encoding: Set by user.
1938 * - decoding: unused
1940 int scenechange_factor;
1944 * Note: Value depends upon the compare function used for fullpel ME.
1945 * - encoding: Set by user.
1946 * - decoding: unused
1951 * Adjust sensitivity of b_frame_strategy 1.
1952 * - encoding: Set by user.
1953 * - decoding: unused
1958 * Chromaticity coordinates of the source primaries.
1959 * - encoding: Set by user
1960 * - decoding: Set by libavcodec
1962 enum AVColorPrimaries color_primaries;
1965 * Color Transfer Characteristic.
1966 * - encoding: Set by user
1967 * - decoding: Set by libavcodec
1969 enum AVColorTransferCharacteristic color_trc;
1972 * YUV colorspace type.
1973 * - encoding: Set by user
1974 * - decoding: Set by libavcodec
1976 enum AVColorSpace colorspace;
1979 * MPEG vs JPEG YUV range.
1980 * - encoding: Set by user
1981 * - decoding: Set by libavcodec
1983 enum AVColorRange color_range;
1986 * This defines the location of chroma samples.
1987 * - encoding: Set by user
1988 * - decoding: Set by libavcodec
1990 enum AVChromaLocation chroma_sample_location;
1994 * Indicates number of picture subdivisions. Used for parallelized
1996 * - encoding: Set by user
1997 * - decoding: unused
2002 * - encoding: set by libavcodec
2003 * - decoding: Set by libavcodec
2005 enum AVFieldOrder field_order;
2008 int sample_rate; ///< samples per second
2009 int channels; ///< number of audio channels
2012 * audio sample format
2013 * - encoding: Set by user.
2014 * - decoding: Set by libavcodec.
2016 enum AVSampleFormat sample_fmt; ///< sample format
2018 /* The following data should not be initialized. */
2020 * Samples per packet, initialized when calling 'init'.
2025 * Frame counter, set by libavcodec.
2027 * - decoding: total number of frames returned from the decoder so far.
2028 * - encoding: total number of frames passed to the encoder so far.
2030 * @note the counter is not incremented if encoding/decoding resulted in
2036 * number of bytes per packet if constant and known or 0
2037 * Used by some WAV based audio codecs.
2042 * Audio cutoff bandwidth (0 means "automatic")
2043 * - encoding: Set by user.
2044 * - decoding: unused
2048 #if FF_API_REQUEST_CHANNELS
2050 * Decoder should decode to this many channels if it can (0 for default)
2051 * - encoding: unused
2052 * - decoding: Set by user.
2053 * @deprecated Deprecated in favor of request_channel_layout.
2055 int request_channels;
2059 * Audio channel layout.
2060 * - encoding: set by user.
2061 * - decoding: set by libavcodec.
2063 uint64_t channel_layout;
2066 * Request decoder to use this channel layout if it can (0 for default)
2067 * - encoding: unused
2068 * - decoding: Set by user.
2070 uint64_t request_channel_layout;
2073 * Type of service that the audio stream conveys.
2074 * - encoding: Set by user.
2075 * - decoding: Set by libavcodec.
2077 enum AVAudioServiceType audio_service_type;
2080 * Used to request a sample format from the decoder.
2081 * - encoding: unused.
2082 * - decoding: Set by user.
2084 enum AVSampleFormat request_sample_fmt;
2087 * Called at the beginning of each frame to get a buffer for it.
2089 * The function will set AVFrame.data[], AVFrame.linesize[].
2090 * AVFrame.extended_data[] must also be set, but it should be the same as
2091 * AVFrame.data[] except for planar audio with more channels than can fit
2092 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2093 * many data pointers as it can hold.
2095 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2096 * avcodec_default_get_buffer() instead of providing buffers allocated by
2099 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2100 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2101 * but if get_buffer() is overridden then alignment considerations should
2102 * be taken into account.
2104 * @see avcodec_default_get_buffer()
2108 * If pic.reference is set then the frame will be read later by libavcodec.
2109 * avcodec_align_dimensions2() should be used to find the required width and
2110 * height, as they normally need to be rounded up to the next multiple of 16.
2112 * If frame multithreading is used and thread_safe_callbacks is set,
2113 * it may be called from a different thread, but not from more than one at
2114 * once. Does not need to be reentrant.
2116 * @see release_buffer(), reget_buffer()
2117 * @see avcodec_align_dimensions2()
2121 * Decoders request a buffer of a particular size by setting
2122 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2123 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2124 * to a smaller value in the output frame.
2126 * Decoders cannot use the buffer after returning from
2127 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2128 * is assumed to be released immediately upon return.
2130 * As a convenience, av_samples_get_buffer_size() and
2131 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2132 * functions to find the required data size and to fill data pointers and
2133 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2134 * since all planes must be the same size.
2136 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2138 * - encoding: unused
2139 * - decoding: Set by libavcodec, user can override.
2141 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2144 * Called to release buffers which were allocated with get_buffer.
2145 * A released buffer can be reused in get_buffer().
2146 * pic.data[*] must be set to NULL.
2147 * May be called from a different thread if frame multithreading is used,
2148 * but not by more than one thread at once, so does not need to be reentrant.
2149 * - encoding: unused
2150 * - decoding: Set by libavcodec, user can override.
2152 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2155 * Called at the beginning of a frame to get cr buffer for it.
2156 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2157 * libavcodec will pass previous buffer in pic, function should return
2158 * same buffer or new buffer with old frame "painted" into it.
2159 * If pic.data[0] == NULL must behave like get_buffer().
2160 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2161 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2163 * - encoding: unused
2164 * - decoding: Set by libavcodec, user can override.
2166 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2169 /* - encoding parameters */
2170 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2171 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2175 * - encoding: Set by user.
2176 * - decoding: unused
2182 * - encoding: Set by user.
2183 * - decoding: unused
2188 * maximum quantizer difference between frames
2189 * - encoding: Set by user.
2190 * - decoding: unused
2195 * ratecontrol qmin qmax limiting method
2196 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2197 * - encoding: Set by user.
2198 * - decoding: unused
2206 * decoder bitstream buffer size
2207 * - encoding: Set by user.
2208 * - decoding: unused
2213 * ratecontrol override, see RcOverride
2214 * - encoding: Allocated/set/freed by user.
2215 * - decoding: unused
2217 int rc_override_count;
2218 RcOverride *rc_override;
2221 * rate control equation
2222 * - encoding: Set by user
2223 * - decoding: unused
2229 * - encoding: Set by user.
2230 * - decoding: unused
2236 * - encoding: Set by user.
2237 * - decoding: unused
2241 float rc_buffer_aggressivity;
2244 * initial complexity for pass1 ratecontrol
2245 * - encoding: Set by user.
2246 * - decoding: unused
2248 float rc_initial_cplx;
2251 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2252 * - encoding: Set by user.
2253 * - decoding: unused.
2255 float rc_max_available_vbv_use;
2258 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2259 * - encoding: Set by user.
2260 * - decoding: unused.
2262 float rc_min_vbv_overflow_use;
2265 * Number of bits which should be loaded into the rc buffer before decoding starts.
2266 * - encoding: Set by user.
2267 * - decoding: unused
2269 int rc_initial_buffer_occupancy;
2271 #define FF_CODER_TYPE_VLC 0
2272 #define FF_CODER_TYPE_AC 1
2273 #define FF_CODER_TYPE_RAW 2
2274 #define FF_CODER_TYPE_RLE 3
2275 #define FF_CODER_TYPE_DEFLATE 4
2278 * - encoding: Set by user.
2279 * - decoding: unused
2285 * - encoding: Set by user.
2286 * - decoding: unused
2291 * minimum Lagrange multipler
2292 * - encoding: Set by user.
2293 * - decoding: unused
2298 * maximum Lagrange multipler
2299 * - encoding: Set by user.
2300 * - decoding: unused
2305 * frame skip threshold
2306 * - encoding: Set by user.
2307 * - decoding: unused
2309 int frame_skip_threshold;
2313 * - encoding: Set by user.
2314 * - decoding: unused
2316 int frame_skip_factor;
2319 * frame skip exponent
2320 * - encoding: Set by user.
2321 * - decoding: unused
2326 * frame skip comparison function
2327 * - encoding: Set by user.
2328 * - decoding: unused
2333 * trellis RD quantization
2334 * - encoding: Set by user.
2335 * - decoding: unused
2340 * - encoding: Set by user.
2341 * - decoding: unused
2343 int min_prediction_order;
2346 * - encoding: Set by user.
2347 * - decoding: unused
2349 int max_prediction_order;
2352 * GOP timecode frame start number, in non drop frame format
2353 * - encoding: Set by user.
2354 * - decoding: unused
2356 int64_t timecode_frame_start;
2358 /* The RTP callback: This function is called */
2359 /* every time the encoder has a packet to send. */
2360 /* It depends on the encoder if the data starts */
2361 /* with a Start Code (it should). H.263 does. */
2362 /* mb_nb contains the number of macroblocks */
2363 /* encoded in the RTP payload. */
2364 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2366 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2367 /* do its best to deliver a chunk with size */
2368 /* below rtp_payload_size, the chunk will start */
2369 /* with a start code on some codecs like H.263. */
2370 /* This doesn't take account of any particular */
2371 /* headers inside the transmitted RTP payload. */
2373 /* statistics, used for 2-pass encoding */
2384 * number of bits used for the previously encoded frame
2385 * - encoding: Set by libavcodec.
2386 * - decoding: unused
2391 * pass1 encoding statistics output buffer
2392 * - encoding: Set by libavcodec.
2393 * - decoding: unused
2398 * pass2 encoding statistics input buffer
2399 * Concatenated stuff from stats_out of pass1 should be placed here.
2400 * - encoding: Allocated/set/freed by user.
2401 * - decoding: unused
2406 * Work around bugs in encoders which sometimes cannot be detected automatically.
2407 * - encoding: Set by user
2408 * - decoding: Set by user
2410 int workaround_bugs;
2411 #define FF_BUG_AUTODETECT 1 ///< autodetection
2412 #define FF_BUG_OLD_MSMPEG4 2
2413 #define FF_BUG_XVID_ILACE 4
2414 #define FF_BUG_UMP4 8
2415 #define FF_BUG_NO_PADDING 16
2416 #define FF_BUG_AMV 32
2417 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2418 #define FF_BUG_QPEL_CHROMA 64
2419 #define FF_BUG_STD_QPEL 128
2420 #define FF_BUG_QPEL_CHROMA2 256
2421 #define FF_BUG_DIRECT_BLOCKSIZE 512
2422 #define FF_BUG_EDGE 1024
2423 #define FF_BUG_HPEL_CHROMA 2048
2424 #define FF_BUG_DC_CLIP 4096
2425 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2426 #define FF_BUG_TRUNCATED 16384
2429 * strictly follow the standard (MPEG4, ...).
2430 * - encoding: Set by user.
2431 * - decoding: Set by user.
2432 * Setting this to STRICT or higher means the encoder and decoder will
2433 * generally do stupid things, whereas setting it to unofficial or lower
2434 * will mean the encoder might produce output that is not supported by all
2435 * spec-compliant decoders. Decoders don't differentiate between normal,
2436 * unofficial and experimental (that is, they always try to decode things
2437 * when they can) unless they are explicitly asked to behave stupidly
2438 * (=strictly conform to the specs)
2440 int strict_std_compliance;
2441 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2442 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2443 #define FF_COMPLIANCE_NORMAL 0
2444 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2445 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2448 * error concealment flags
2449 * - encoding: unused
2450 * - decoding: Set by user.
2452 int error_concealment;
2453 #define FF_EC_GUESS_MVS 1
2454 #define FF_EC_DEBLOCK 2
2458 * - encoding: Set by user.
2459 * - decoding: Set by user.
2462 #define FF_DEBUG_PICT_INFO 1
2463 #define FF_DEBUG_RC 2
2464 #define FF_DEBUG_BITSTREAM 4
2465 #define FF_DEBUG_MB_TYPE 8
2466 #define FF_DEBUG_QP 16
2467 #define FF_DEBUG_MV 32
2468 #define FF_DEBUG_DCT_COEFF 0x00000040
2469 #define FF_DEBUG_SKIP 0x00000080
2470 #define FF_DEBUG_STARTCODE 0x00000100
2471 #define FF_DEBUG_PTS 0x00000200
2472 #define FF_DEBUG_ER 0x00000400
2473 #define FF_DEBUG_MMCO 0x00000800
2474 #define FF_DEBUG_BUGS 0x00001000
2475 #define FF_DEBUG_VIS_QP 0x00002000
2476 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2477 #define FF_DEBUG_BUFFERS 0x00008000
2478 #define FF_DEBUG_THREADS 0x00010000
2482 * - encoding: Set by user.
2483 * - decoding: Set by user.
2486 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2487 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2488 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2491 * Error recognition; may misdetect some more or less valid parts as errors.
2492 * - encoding: unused
2493 * - decoding: Set by user.
2495 int err_recognition;
2496 #define AV_EF_CRCCHECK (1<<0)
2497 #define AV_EF_BITSTREAM (1<<1)
2498 #define AV_EF_BUFFER (1<<2)
2499 #define AV_EF_EXPLODE (1<<3)
2502 * opaque 64bit number (generally a PTS) that will be reordered and
2503 * output in AVFrame.reordered_opaque
2504 * @deprecated in favor of pkt_pts
2505 * - encoding: unused
2506 * - decoding: Set by user.
2508 int64_t reordered_opaque;
2511 * Hardware accelerator in use
2512 * - encoding: unused.
2513 * - decoding: Set by libavcodec
2515 struct AVHWAccel *hwaccel;
2518 * Hardware accelerator context.
2519 * For some hardware accelerators, a global context needs to be
2520 * provided by the user. In that case, this holds display-dependent
2521 * data Libav cannot instantiate itself. Please refer to the
2522 * Libav HW accelerator documentation to know how to fill this
2523 * is. e.g. for VA API, this is a struct vaapi_context.
2524 * - encoding: unused
2525 * - decoding: Set by user
2527 void *hwaccel_context;
2531 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2532 * - decoding: unused
2534 uint64_t error[AV_NUM_DATA_POINTERS];
2537 * DCT algorithm, see FF_DCT_* below
2538 * - encoding: Set by user.
2539 * - decoding: unused
2542 #define FF_DCT_AUTO 0
2543 #define FF_DCT_FASTINT 1
2544 #define FF_DCT_INT 2
2545 #define FF_DCT_MMX 3
2546 #define FF_DCT_ALTIVEC 5
2547 #define FF_DCT_FAAN 6
2550 * IDCT algorithm, see FF_IDCT_* below.
2551 * - encoding: Set by user.
2552 * - decoding: Set by user.
2555 #define FF_IDCT_AUTO 0
2556 #define FF_IDCT_INT 1
2557 #define FF_IDCT_SIMPLE 2
2558 #define FF_IDCT_SIMPLEMMX 3
2559 #define FF_IDCT_LIBMPEG2MMX 4
2560 #define FF_IDCT_MMI 5
2561 #define FF_IDCT_ARM 7
2562 #define FF_IDCT_ALTIVEC 8
2563 #define FF_IDCT_SH4 9
2564 #define FF_IDCT_SIMPLEARM 10
2565 #define FF_IDCT_H264 11
2566 #define FF_IDCT_VP3 12
2567 #define FF_IDCT_IPP 13
2568 #define FF_IDCT_XVIDMMX 14
2569 #define FF_IDCT_CAVS 15
2570 #define FF_IDCT_SIMPLEARMV5TE 16
2571 #define FF_IDCT_SIMPLEARMV6 17
2572 #define FF_IDCT_SIMPLEVIS 18
2573 #define FF_IDCT_WMV2 19
2574 #define FF_IDCT_FAAN 20
2575 #define FF_IDCT_EA 21
2576 #define FF_IDCT_SIMPLENEON 22
2577 #define FF_IDCT_SIMPLEALPHA 23
2578 #define FF_IDCT_BINK 24
2583 * @deprecated use av_set_cpu_flags_mask() instead.
2585 attribute_deprecated unsigned dsp_mask;
2589 * bits per sample/pixel from the demuxer (needed for huffyuv).
2590 * - encoding: Set by libavcodec.
2591 * - decoding: Set by user.
2593 int bits_per_coded_sample;
2596 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2597 * - encoding: set by user.
2598 * - decoding: set by libavcodec.
2600 int bits_per_raw_sample;
2603 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2604 * - encoding: unused
2605 * - decoding: Set by user.
2607 attribute_deprecated int lowres;
2610 * the picture in the bitstream
2611 * - encoding: Set by libavcodec.
2612 * - decoding: Set by libavcodec.
2614 AVFrame *coded_frame;
2618 * is used to decide how many independent tasks should be passed to execute()
2619 * - encoding: Set by user.
2620 * - decoding: Set by user.
2625 * Which multithreading methods to use.
2626 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2627 * so clients which cannot provide future frames should not use it.
2629 * - encoding: Set by user, otherwise the default is used.
2630 * - decoding: Set by user, otherwise the default is used.
2633 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2634 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2637 * Which multithreading methods are in use by the codec.
2638 * - encoding: Set by libavcodec.
2639 * - decoding: Set by libavcodec.
2641 int active_thread_type;
2644 * Set by the client if its custom get_buffer() callback can be called
2645 * synchronously from another thread, which allows faster multithreaded decoding.
2646 * draw_horiz_band() will be called from other threads regardless of this setting.
2647 * Ignored if the default get_buffer() is used.
2648 * - encoding: Set by user.
2649 * - decoding: Set by user.
2651 int thread_safe_callbacks;
2654 * The codec may call this to execute several independent things.
2655 * It will return only after finishing all tasks.
2656 * The user may replace this with some multithreaded implementation,
2657 * the default implementation will execute the parts serially.
2658 * @param count the number of things to execute
2659 * - encoding: Set by libavcodec, user can override.
2660 * - decoding: Set by libavcodec, user can override.
2662 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2665 * The codec may call this to execute several independent things.
2666 * It will return only after finishing all tasks.
2667 * The user may replace this with some multithreaded implementation,
2668 * the default implementation will execute the parts serially.
2669 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2670 * @param c context passed also to func
2671 * @param count the number of things to execute
2672 * @param arg2 argument passed unchanged to func
2673 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2674 * @param func function that will be called count times, with jobnr from 0 to count-1.
2675 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2676 * two instances of func executing at the same time will have the same threadnr.
2677 * @return always 0 currently, but code should handle a future improvement where when any call to func
2678 * returns < 0 no further calls to func may be done and < 0 is returned.
2679 * - encoding: Set by libavcodec, user can override.
2680 * - decoding: Set by libavcodec, user can override.
2682 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2686 * Can be used by execute() to store some per AVCodecContext stuff.
2687 * - encoding: set by execute()
2688 * - decoding: set by execute()
2690 void *thread_opaque;
2693 * noise vs. sse weight for the nsse comparsion function
2694 * - encoding: Set by user.
2695 * - decoding: unused
2701 * - encoding: Set by user.
2702 * - decoding: Set by libavcodec.
2705 #define FF_PROFILE_UNKNOWN -99
2706 #define FF_PROFILE_RESERVED -100
2708 #define FF_PROFILE_AAC_MAIN 0
2709 #define FF_PROFILE_AAC_LOW 1
2710 #define FF_PROFILE_AAC_SSR 2
2711 #define FF_PROFILE_AAC_LTP 3
2713 #define FF_PROFILE_DTS 20
2714 #define FF_PROFILE_DTS_ES 30
2715 #define FF_PROFILE_DTS_96_24 40
2716 #define FF_PROFILE_DTS_HD_HRA 50
2717 #define FF_PROFILE_DTS_HD_MA 60
2719 #define FF_PROFILE_MPEG2_422 0
2720 #define FF_PROFILE_MPEG2_HIGH 1
2721 #define FF_PROFILE_MPEG2_SS 2
2722 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2723 #define FF_PROFILE_MPEG2_MAIN 4
2724 #define FF_PROFILE_MPEG2_SIMPLE 5
2726 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2727 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2729 #define FF_PROFILE_H264_BASELINE 66
2730 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2731 #define FF_PROFILE_H264_MAIN 77
2732 #define FF_PROFILE_H264_EXTENDED 88
2733 #define FF_PROFILE_H264_HIGH 100
2734 #define FF_PROFILE_H264_HIGH_10 110
2735 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2736 #define FF_PROFILE_H264_HIGH_422 122
2737 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2738 #define FF_PROFILE_H264_HIGH_444 144
2739 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2740 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2741 #define FF_PROFILE_H264_CAVLC_444 44
2743 #define FF_PROFILE_VC1_SIMPLE 0
2744 #define FF_PROFILE_VC1_MAIN 1
2745 #define FF_PROFILE_VC1_COMPLEX 2
2746 #define FF_PROFILE_VC1_ADVANCED 3
2748 #define FF_PROFILE_MPEG4_SIMPLE 0
2749 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2750 #define FF_PROFILE_MPEG4_CORE 2
2751 #define FF_PROFILE_MPEG4_MAIN 3
2752 #define FF_PROFILE_MPEG4_N_BIT 4
2753 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2754 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2755 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2756 #define FF_PROFILE_MPEG4_HYBRID 8
2757 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2758 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2759 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2760 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2761 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2762 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2763 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2767 * - encoding: Set by user.
2768 * - decoding: Set by libavcodec.
2771 #define FF_LEVEL_UNKNOWN -99
2775 * - encoding: unused
2776 * - decoding: Set by user.
2778 enum AVDiscard skip_loop_filter;
2782 * - encoding: unused
2783 * - decoding: Set by user.
2785 enum AVDiscard skip_idct;
2789 * - encoding: unused
2790 * - decoding: Set by user.
2792 enum AVDiscard skip_frame;
2795 * Header containing style information for text subtitles.
2796 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2797 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2798 * the Format line following. It shouldn't include any Dialogue line.
2799 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2800 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2802 uint8_t *subtitle_header;
2803 int subtitle_header_size;
2806 * Simulates errors in the bitstream to test error concealment.
2807 * - encoding: Set by user.
2808 * - decoding: unused
2813 * Current packet as passed into the decoder, to avoid having
2814 * to pass the packet into every function. Currently only valid
2815 * inside lavc and get/release_buffer callbacks.
2816 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2817 * - encoding: unused
2822 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2823 * Used for compliant TS muxing.
2824 * - encoding: Set by libavcodec.
2825 * - decoding: unused.
2833 typedef struct AVProfile {
2835 const char *name; ///< short name for the profile
2838 typedef struct AVCodecDefault AVCodecDefault;
2843 typedef struct AVCodec {
2845 * Name of the codec implementation.
2846 * The name is globally unique among encoders and among decoders (but an
2847 * encoder and a decoder can share the same name).
2848 * This is the primary way to find a codec from the user perspective.
2852 * Descriptive name for the codec, meant to be more human readable than name.
2853 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2855 const char *long_name;
2856 enum AVMediaType type;
2859 * Codec capabilities.
2863 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2864 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2865 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2866 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2867 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2868 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2869 const AVClass *priv_class; ///< AVClass for the private context
2870 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2872 /*****************************************************************
2873 * No fields below this line are part of the public API. They
2874 * may not be used outside of libavcodec and can be changed and
2876 * New public fields should be added right above.
2877 *****************************************************************
2880 struct AVCodec *next;
2882 * @name Frame-level threading support functions
2886 * If defined, called on thread contexts when they are created.
2887 * If the codec allocates writable tables in init(), re-allocate them here.
2888 * priv_data will be set to a copy of the original.
2890 int (*init_thread_copy)(AVCodecContext *);
2892 * Copy necessary context variables from a previous thread context to the current one.
2893 * If not defined, the next thread will start automatically; otherwise, the codec
2894 * must call ff_thread_finish_setup().
2896 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2898 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2902 * Private codec-specific defaults.
2904 const AVCodecDefault *defaults;
2907 * Initialize codec static data, called from avcodec_register().
2909 void (*init_static_data)(struct AVCodec *codec);
2911 int (*init)(AVCodecContext *);
2912 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2914 * Encode data to an AVPacket.
2916 * @param avctx codec context
2917 * @param avpkt output AVPacket (may contain a user-provided buffer)
2918 * @param[in] frame AVFrame containing the raw data to be encoded
2919 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2920 * non-empty packet was returned in avpkt.
2921 * @return 0 on success, negative error code on failure
2923 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2924 int *got_packet_ptr);
2925 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2926 int (*close)(AVCodecContext *);
2929 * Will be called when seeking
2931 void (*flush)(AVCodecContext *);
2937 typedef struct AVHWAccel {
2939 * Name of the hardware accelerated codec.
2940 * The name is globally unique among encoders and among decoders (but an
2941 * encoder and a decoder can share the same name).
2946 * Type of codec implemented by the hardware accelerator.
2948 * See AVMEDIA_TYPE_xxx
2950 enum AVMediaType type;
2953 * Codec implemented by the hardware accelerator.
2960 * Supported pixel format.
2962 * Only hardware accelerated formats are supported here.
2964 enum PixelFormat pix_fmt;
2967 * Hardware accelerated codec capabilities.
2968 * see FF_HWACCEL_CODEC_CAP_*
2972 struct AVHWAccel *next;
2975 * Called at the beginning of each frame or field picture.
2977 * Meaningful frame information (codec specific) is guaranteed to
2978 * be parsed at this point. This function is mandatory.
2980 * Note that buf can be NULL along with buf_size set to 0.
2981 * Otherwise, this means the whole frame is available at this point.
2983 * @param avctx the codec context
2984 * @param buf the frame data buffer base
2985 * @param buf_size the size of the frame in bytes
2986 * @return zero if successful, a negative value otherwise
2988 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2991 * Callback for each slice.
2993 * Meaningful slice information (codec specific) is guaranteed to
2994 * be parsed at this point. This function is mandatory.
2996 * @param avctx the codec context
2997 * @param buf the slice data buffer base
2998 * @param buf_size the size of the slice in bytes
2999 * @return zero if successful, a negative value otherwise
3001 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3004 * Called at the end of each frame or field picture.
3006 * The whole picture is parsed at this point and can now be sent
3007 * to the hardware accelerator. This function is mandatory.
3009 * @param avctx the codec context
3010 * @return zero if successful, a negative value otherwise
3012 int (*end_frame)(AVCodecContext *avctx);
3015 * Size of HW accelerator private data.
3017 * Private data is allocated with av_mallocz() before
3018 * AVCodecContext.get_buffer() and deallocated after
3019 * AVCodecContext.release_buffer().
3025 * @defgroup lavc_picture AVPicture
3027 * Functions for working with AVPicture
3032 * four components are given, that's all.
3033 * the last component is alpha
3035 typedef struct AVPicture {
3036 uint8_t *data[AV_NUM_DATA_POINTERS];
3037 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3044 #define AVPALETTE_SIZE 1024
3045 #define AVPALETTE_COUNT 256
3047 enum AVSubtitleType {
3050 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3053 * Plain text, the text field must be set by the decoder and is
3054 * authoritative. ass and pict fields may contain approximations.
3059 * Formatted text, the ass field must be set by the decoder and is
3060 * authoritative. pict and text fields may contain approximations.
3065 typedef struct AVSubtitleRect {
3066 int x; ///< top left corner of pict, undefined when pict is not set
3067 int y; ///< top left corner of pict, undefined when pict is not set
3068 int w; ///< width of pict, undefined when pict is not set
3069 int h; ///< height of pict, undefined when pict is not set
3070 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3073 * data+linesize for the bitmap of this subtitle.
3074 * can be set for text/ass as well once they where rendered
3077 enum AVSubtitleType type;
3079 char *text; ///< 0 terminated plain UTF-8 text
3082 * 0 terminated ASS/SSA compatible event line.
3083 * The pressentation of this is unaffected by the other values in this
3089 typedef struct AVSubtitle {
3090 uint16_t format; /* 0 = graphics */
3091 uint32_t start_display_time; /* relative to packet pts, in ms */
3092 uint32_t end_display_time; /* relative to packet pts, in ms */
3094 AVSubtitleRect **rects;
3095 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3099 * If c is NULL, returns the first registered codec,
3100 * if c is non-NULL, returns the next registered codec after c,
3101 * or NULL if c is the last one.
3103 AVCodec *av_codec_next(AVCodec *c);
3106 * Return the LIBAVCODEC_VERSION_INT constant.
3108 unsigned avcodec_version(void);
3111 * Return the libavcodec build-time configuration.
3113 const char *avcodec_configuration(void);
3116 * Return the libavcodec license.
3118 const char *avcodec_license(void);
3121 * Register the codec codec and initialize libavcodec.
3123 * @warning either this function or avcodec_register_all() must be called
3124 * before any other libavcodec functions.
3126 * @see avcodec_register_all()
3128 void avcodec_register(AVCodec *codec);
3131 * Register all the codecs, parsers and bitstream filters which were enabled at
3132 * configuration time. If you do not call this function you can select exactly
3133 * which formats you want to support, by using the individual registration
3136 * @see avcodec_register
3137 * @see av_register_codec_parser
3138 * @see av_register_bitstream_filter
3140 void avcodec_register_all(void);
3143 * Allocate an AVCodecContext and set its fields to default values. The
3144 * resulting struct can be deallocated by calling avcodec_close() on it followed
3147 * @param codec if non-NULL, allocate private data and initialize defaults
3148 * for the given codec. It is illegal to then call avcodec_open2()
3149 * with a different codec.
3150 * If NULL, then the codec-specific defaults won't be initialized,
3151 * which may result in suboptimal default settings (this is
3152 * important mainly for encoders, e.g. libx264).
3154 * @return An AVCodecContext filled with default values or NULL on failure.
3155 * @see avcodec_get_context_defaults
3157 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3160 * Set the fields of the given AVCodecContext to default values corresponding
3161 * to the given codec (defaults may be codec-dependent).
3163 * Do not call this function if a non-NULL codec has been passed
3164 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3165 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3166 * different codec on this AVCodecContext.
3168 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3171 * Get the AVClass for AVCodecContext. It can be used in combination with
3172 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3174 * @see av_opt_find().
3176 const AVClass *avcodec_get_class(void);
3179 * Copy the settings of the source AVCodecContext into the destination
3180 * AVCodecContext. The resulting destination codec context will be
3181 * unopened, i.e. you are required to call avcodec_open2() before you
3182 * can use this AVCodecContext to decode/encode video/audio data.
3184 * @param dest target codec context, should be initialized with
3185 * avcodec_alloc_context3(), but otherwise uninitialized
3186 * @param src source codec context
3187 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3189 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3192 * Allocate an AVFrame and set its fields to default values. The resulting
3193 * struct can be deallocated by simply calling av_free().
3195 * @return An AVFrame filled with default values or NULL on failure.
3196 * @see avcodec_get_frame_defaults
3198 AVFrame *avcodec_alloc_frame(void);
3201 * Set the fields of the given AVFrame to default values.
3203 * @param pic The AVFrame of which the fields should be set to default values.
3205 void avcodec_get_frame_defaults(AVFrame *pic);
3208 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3209 * function the context has to be allocated with avcodec_alloc_context3().
3211 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3212 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3213 * retrieving a codec.
3215 * @warning This function is not thread safe!
3218 * avcodec_register_all();
3219 * av_dict_set(&opts, "b", "2.5M", 0);
3220 * codec = avcodec_find_decoder(CODEC_ID_H264);
3224 * context = avcodec_alloc_context3(codec);
3226 * if (avcodec_open2(context, codec, opts) < 0)
3230 * @param avctx The context to initialize.
3231 * @param codec The codec to open this context for. If a non-NULL codec has been
3232 * previously passed to avcodec_alloc_context3() or
3233 * avcodec_get_context_defaults3() for this context, then this
3234 * parameter MUST be either NULL or equal to the previously passed
3236 * @param options A dictionary filled with AVCodecContext and codec-private options.
3237 * On return this object will be filled with options that were not found.
3239 * @return zero on success, a negative value on error
3240 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3241 * av_dict_set(), av_opt_find().
3243 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3246 * Close a given AVCodecContext and free all the data associated with it
3247 * (but not the AVCodecContext itself).
3249 * Calling this function on an AVCodecContext that hasn't been opened will free
3250 * the codec-specific data allocated in avcodec_alloc_context3() /
3251 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3254 int avcodec_close(AVCodecContext *avctx);
3257 * Free all allocated data in the given subtitle struct.
3259 * @param sub AVSubtitle to free.
3261 void avsubtitle_free(AVSubtitle *sub);
3268 * @addtogroup lavc_packet
3273 * @deprecated use NULL instead
3275 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3278 * Default packet destructor.
3280 void av_destruct_packet(AVPacket *pkt);
3283 * Initialize optional fields of a packet with default values.
3287 void av_init_packet(AVPacket *pkt);
3290 * Allocate the payload of a packet and initialize its fields with
3294 * @param size wanted payload size
3295 * @return 0 if OK, AVERROR_xxx otherwise
3297 int av_new_packet(AVPacket *pkt, int size);
3300 * Reduce packet size, correctly zeroing padding
3303 * @param size new size
3305 void av_shrink_packet(AVPacket *pkt, int size);
3308 * Increase packet size, correctly zeroing padding
3311 * @param grow_by number of bytes by which to increase the size of the packet
3313 int av_grow_packet(AVPacket *pkt, int grow_by);
3316 * @warning This is a hack - the packet memory allocation stuff is broken. The
3317 * packet is allocated if it was not really allocated.
3319 int av_dup_packet(AVPacket *pkt);
3324 * @param pkt packet to free
3326 void av_free_packet(AVPacket *pkt);
3329 * Allocate new information of a packet.
3332 * @param type side information type
3333 * @param size side information size
3334 * @return pointer to fresh allocated data or NULL otherwise
3336 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3340 * Shrink the already allocated side data buffer
3343 * @param type side information type
3344 * @param size new side information size
3345 * @return 0 on success, < 0 on failure
3347 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3351 * Get side information from packet.
3354 * @param type desired side information type
3355 * @param size pointer for side information size to store (optional)
3356 * @return pointer to data if present or NULL otherwise
3358 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3366 * @addtogroup lavc_decoding
3371 * Find a registered decoder with a matching codec ID.
3373 * @param id CodecID of the requested decoder
3374 * @return A decoder if one was found, NULL otherwise.
3376 AVCodec *avcodec_find_decoder(enum CodecID id);
3379 * Find a registered decoder with the specified name.
3381 * @param name name of the requested decoder
3382 * @return A decoder if one was found, NULL otherwise.
3384 AVCodec *avcodec_find_decoder_by_name(const char *name);
3386 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3387 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3388 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3391 * Return the amount of padding in pixels which the get_buffer callback must
3392 * provide around the edge of the image for codecs which do not have the
3393 * CODEC_FLAG_EMU_EDGE flag.
3395 * @return Required padding in pixels.
3397 unsigned avcodec_get_edge_width(void);
3400 * Modify width and height values so that they will result in a memory
3401 * buffer that is acceptable for the codec if you do not use any horizontal
3404 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3405 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3406 * according to avcodec_get_edge_width() before.
3408 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3411 * Modify width and height values so that they will result in a memory
3412 * buffer that is acceptable for the codec if you also ensure that all
3413 * line sizes are a multiple of the respective linesize_align[i].
3415 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3416 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3417 * according to avcodec_get_edge_width() before.
3419 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3420 int linesize_align[AV_NUM_DATA_POINTERS]);
3422 #if FF_API_OLD_DECODE_AUDIO
3424 * Wrapper function which calls avcodec_decode_audio4.
3426 * @deprecated Use avcodec_decode_audio4 instead.
3428 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3429 * Some decoders may support multiple frames in a single AVPacket, such
3430 * decoders would then just decode the first frame. In this case,
3431 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3432 * the remaining data in order to decode the second frame etc.
3434 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3435 * decompressed frame size in bytes.
3437 * @warning You must set frame_size_ptr to the allocated size of the
3438 * output buffer before calling avcodec_decode_audio3().
3440 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3441 * the actual read bytes because some optimized bitstream readers read 32 or 64
3442 * bits at once and could read over the end.
3444 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3445 * no overreading happens for damaged MPEG streams.
3447 * @warning You must not provide a custom get_buffer() when using
3448 * avcodec_decode_audio3(). Doing so will override it with
3449 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3450 * which does allow the application to provide a custom get_buffer().
3452 * @note You might have to align the input buffer avpkt->data and output buffer
3453 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3454 * necessary at all, on others it won't work at all if not aligned and on others
3455 * it will work but it will have an impact on performance.
3457 * In practice, avpkt->data should have 4 byte alignment at minimum and
3458 * samples should be 16 byte aligned unless the CPU doesn't need it
3459 * (AltiVec and SSE do).
3461 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3462 * between input and output, these need to be fed with avpkt->data=NULL,
3463 * avpkt->size=0 at the end to return the remaining frames.
3465 * @param avctx the codec context
3466 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3467 * If the sample format is planar, each channel plane will
3468 * be the same size, with no padding between channels.
3469 * @param[in,out] frame_size_ptr the output buffer size in bytes
3470 * @param[in] avpkt The input AVPacket containing the input buffer.
3471 * You can create such packet with av_init_packet() and by then setting
3472 * data and size, some decoders might in addition need other fields.
3473 * All decoders are designed to use the least fields possible though.
3474 * @return On error a negative value is returned, otherwise the number of bytes
3475 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3477 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3478 int *frame_size_ptr,
3483 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3485 * Some decoders may support multiple frames in a single AVPacket. Such
3486 * decoders would then just decode the first frame. In this case,
3487 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3488 * the remaining data in order to decode the second frame, etc...
3489 * Even if no frames are returned, the packet needs to be fed to the decoder
3490 * with remaining data until it is completely consumed or an error occurs.
3492 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3493 * larger than the actual read bytes because some optimized bitstream
3494 * readers read 32 or 64 bits at once and could read over the end.
3496 * @note You might have to align the input buffer. The alignment requirements
3497 * depend on the CPU and the decoder.
3499 * @param avctx the codec context
3500 * @param[out] frame The AVFrame in which to store decoded audio samples.
3501 * Decoders request a buffer of a particular size by setting
3502 * AVFrame.nb_samples prior to calling get_buffer(). The
3503 * decoder may, however, only utilize part of the buffer by
3504 * setting AVFrame.nb_samples to a smaller value in the
3506 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3508 * @param[in] avpkt The input AVPacket containing the input buffer.
3509 * At least avpkt->data and avpkt->size should be set. Some
3510 * decoders might also require additional fields to be set.
3511 * @return A negative error code is returned if an error occurred during
3512 * decoding, otherwise the number of bytes consumed from the input
3513 * AVPacket is returned.
3515 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3516 int *got_frame_ptr, AVPacket *avpkt);
3519 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3520 * Some decoders may support multiple frames in a single AVPacket, such
3521 * decoders would then just decode the first frame.
3523 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3524 * the actual read bytes because some optimized bitstream readers read 32 or 64
3525 * bits at once and could read over the end.
3527 * @warning The end of the input buffer buf should be set to 0 to ensure that
3528 * no overreading happens for damaged MPEG streams.
3530 * @note You might have to align the input buffer avpkt->data.
3531 * The alignment requirements depend on the CPU: on some CPUs it isn't
3532 * necessary at all, on others it won't work at all if not aligned and on others
3533 * it will work but it will have an impact on performance.
3535 * In practice, avpkt->data should have 4 byte alignment at minimum.
3537 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3538 * between input and output, these need to be fed with avpkt->data=NULL,
3539 * avpkt->size=0 at the end to return the remaining frames.
3541 * @param avctx the codec context
3542 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3543 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3544 * allocate memory for the actual bitmap.
3545 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3546 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3547 * decodes and the decoder tells the user once it does not need the data anymore,
3548 * the user app can at this point free/reuse/keep the memory as it sees fit.
3550 * @param[in] avpkt The input AVpacket containing the input buffer.
3551 * You can create such packet with av_init_packet() and by then setting
3552 * data and size, some decoders might in addition need other fields like
3553 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3555 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3556 * @return On error a negative value is returned, otherwise the number of bytes
3557 * used or zero if no frame could be decompressed.
3559 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3560 int *got_picture_ptr,
3564 * Decode a subtitle message.
3565 * Return a negative value on error, otherwise return the number of bytes used.
3566 * If no subtitle could be decompressed, got_sub_ptr is zero.
3567 * Otherwise, the subtitle is stored in *sub.
3568 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3569 * simplicity, because the performance difference is expect to be negligible
3570 * and reusing a get_buffer written for video codecs would probably perform badly
3571 * due to a potentially very different allocation pattern.
3573 * @param avctx the codec context
3574 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3575 freed with avsubtitle_free if *got_sub_ptr is set.
3576 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3577 * @param[in] avpkt The input AVPacket containing the input buffer.
3579 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3584 * @defgroup lavc_parsing Frame parsing
3588 typedef struct AVCodecParserContext {
3590 struct AVCodecParser *parser;
3591 int64_t frame_offset; /* offset of the current frame */
3592 int64_t cur_offset; /* current offset
3593 (incremented by each av_parser_parse()) */
3594 int64_t next_frame_offset; /* offset of the next frame */
3596 int pict_type; /* XXX: Put it back in AVCodecContext. */
3598 * This field is used for proper frame duration computation in lavf.
3599 * It signals, how much longer the frame duration of the current frame
3600 * is compared to normal frame duration.
3602 * frame_duration = (1 + repeat_pict) * time_base
3604 * It is used by codecs like H.264 to display telecined material.
3606 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3607 int64_t pts; /* pts of the current frame */
3608 int64_t dts; /* dts of the current frame */
3613 int fetch_timestamp;
3615 #define AV_PARSER_PTS_NB 4
3616 int cur_frame_start_index;
3617 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3618 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3619 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3622 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3623 #define PARSER_FLAG_ONCE 0x0002
3624 /// Set if the parser has a valid file offset
3625 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3627 int64_t offset; ///< byte offset from starting packet start
3628 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3631 * Set by parser to 1 for key frames and 0 for non-key frames.
3632 * It is initialized to -1, so if the parser doesn't set this flag,
3633 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3639 * Time difference in stream time base units from the pts of this
3640 * packet to the point at which the output from the decoder has converged
3641 * independent from the availability of previous frames. That is, the
3642 * frames are virtually identical no matter if decoding started from
3643 * the very first frame or from this keyframe.
3644 * Is AV_NOPTS_VALUE if unknown.
3645 * This field is not the display duration of the current frame.
3646 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3649 * The purpose of this field is to allow seeking in streams that have no
3650 * keyframes in the conventional sense. It corresponds to the
3651 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3652 * essential for some types of subtitle streams to ensure that all
3653 * subtitles are correctly displayed after seeking.
3655 int64_t convergence_duration;
3657 // Timestamp generation support:
3659 * Synchronization point for start of timestamp generation.
3661 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3664 * For example, this corresponds to presence of H.264 buffering period
3670 * Offset of the current timestamp against last timestamp sync point in
3671 * units of AVCodecContext.time_base.
3673 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3674 * contain a valid timestamp offset.
3676 * Note that the timestamp of sync point has usually a nonzero
3677 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3678 * the next frame after timestamp sync point will be usually 1.
3680 * For example, this corresponds to H.264 cpb_removal_delay.
3682 int dts_ref_dts_delta;
3685 * Presentation delay of current frame in units of AVCodecContext.time_base.
3687 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3688 * contain valid non-negative timestamp delta (presentation time of a frame
3689 * must not lie in the past).
3691 * This delay represents the difference between decoding and presentation
3692 * time of the frame.
3694 * For example, this corresponds to H.264 dpb_output_delay.
3699 * Position of the packet in file.
3701 * Analogous to cur_frame_pts/dts
3703 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3706 * Byte position of currently parsed frame in stream.
3711 * Previous frame byte position.
3716 * Duration of the current frame.
3717 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3718 * For all other types, this is in units of AVCodecContext.time_base.
3721 } AVCodecParserContext;
3723 typedef struct AVCodecParser {
3724 int codec_ids[5]; /* several codec IDs are permitted */
3726 int (*parser_init)(AVCodecParserContext *s);
3727 int (*parser_parse)(AVCodecParserContext *s,
3728 AVCodecContext *avctx,
3729 const uint8_t **poutbuf, int *poutbuf_size,
3730 const uint8_t *buf, int buf_size);
3731 void (*parser_close)(AVCodecParserContext *s);
3732 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3733 struct AVCodecParser *next;
3736 AVCodecParser *av_parser_next(AVCodecParser *c);
3738 void av_register_codec_parser(AVCodecParser *parser);
3739 AVCodecParserContext *av_parser_init(int codec_id);
3744 * @param s parser context.
3745 * @param avctx codec context.
3746 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3747 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3748 * @param buf input buffer.
3749 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3750 * @param pts input presentation timestamp.
3751 * @param dts input decoding timestamp.
3752 * @param pos input byte position in stream.
3753 * @return the number of bytes of the input bitstream used.
3758 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3765 * decode_frame(data, size);
3769 int av_parser_parse2(AVCodecParserContext *s,
3770 AVCodecContext *avctx,
3771 uint8_t **poutbuf, int *poutbuf_size,
3772 const uint8_t *buf, int buf_size,
3773 int64_t pts, int64_t dts,
3776 int av_parser_change(AVCodecParserContext *s,
3777 AVCodecContext *avctx,
3778 uint8_t **poutbuf, int *poutbuf_size,
3779 const uint8_t *buf, int buf_size, int keyframe);
3780 void av_parser_close(AVCodecParserContext *s);
3788 * @addtogroup lavc_encoding
3793 * Find a registered encoder with a matching codec ID.
3795 * @param id CodecID of the requested encoder
3796 * @return An encoder if one was found, NULL otherwise.
3798 AVCodec *avcodec_find_encoder(enum CodecID id);
3801 * Find a registered encoder with the specified name.
3803 * @param name name of the requested encoder
3804 * @return An encoder if one was found, NULL otherwise.
3806 AVCodec *avcodec_find_encoder_by_name(const char *name);
3808 #if FF_API_OLD_ENCODE_AUDIO
3810 * Encode an audio frame from samples into buf.
3812 * @deprecated Use avcodec_encode_audio2 instead.
3814 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3815 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3816 * will know how much space is needed because it depends on the value passed
3817 * in buf_size as described below. In that case a lower value can be used.
3819 * @param avctx the codec context
3820 * @param[out] buf the output buffer
3821 * @param[in] buf_size the output buffer size
3822 * @param[in] samples the input buffer containing the samples
3823 * The number of samples read from this buffer is frame_size*channels,
3824 * both of which are defined in avctx.
3825 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3826 * samples read from samples is equal to:
3827 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3828 * This also implies that av_get_bits_per_sample() must not return 0 for these
3830 * @return On error a negative value is returned, on success zero or the number
3831 * of bytes used to encode the data read from the input buffer.
3833 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3834 uint8_t *buf, int buf_size,
3835 const short *samples);
3839 * Encode a frame of audio.
3841 * Takes input samples from frame and writes the next output packet, if
3842 * available, to avpkt. The output packet does not necessarily contain data for
3843 * the most recent frame, as encoders can delay, split, and combine input frames
3844 * internally as needed.
3846 * @param avctx codec context
3847 * @param avpkt output AVPacket.
3848 * The user can supply an output buffer by setting
3849 * avpkt->data and avpkt->size prior to calling the
3850 * function, but if the size of the user-provided data is not
3851 * large enough, encoding will fail. All other AVPacket fields
3852 * will be reset by the encoder using av_init_packet(). If
3853 * avpkt->data is NULL, the encoder will allocate it.
3854 * The encoder will set avpkt->size to the size of the
3857 * If this function fails or produces no output, avpkt will be
3858 * freed using av_free_packet() (i.e. avpkt->destruct will be
3859 * called to free the user supplied buffer).
3860 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3861 * May be NULL when flushing an encoder that has the
3862 * CODEC_CAP_DELAY capability set.
3863 * There are 2 codec capabilities that affect the allowed
3864 * values of frame->nb_samples.
3865 * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
3866 * frame may be smaller than avctx->frame_size, and all other
3867 * frames must be equal to avctx->frame_size.
3868 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3869 * can have any number of samples.
3870 * If neither is set, frame->nb_samples must be equal to
3871 * avctx->frame_size for all frames.
3872 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3873 * output packet is non-empty, and to 0 if it is
3874 * empty. If the function returns an error, the
3875 * packet can be assumed to be invalid, and the
3876 * value of got_packet_ptr is undefined and should
3878 * @return 0 on success, negative error code on failure
3880 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3881 const AVFrame *frame, int *got_packet_ptr);
3883 #if FF_API_OLD_ENCODE_VIDEO
3885 * @deprecated use avcodec_encode_video2() instead.
3887 * Encode a video frame from pict into buf.
3888 * The input picture should be
3889 * stored using a specific format, namely avctx.pix_fmt.
3891 * @param avctx the codec context
3892 * @param[out] buf the output buffer for the bitstream of encoded frame
3893 * @param[in] buf_size the size of the output buffer in bytes
3894 * @param[in] pict the input picture to encode
3895 * @return On error a negative value is returned, on success zero or the number
3896 * of bytes used from the output buffer.
3898 attribute_deprecated
3899 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3900 const AVFrame *pict);
3904 * Encode a frame of video.
3906 * Takes input raw video data from frame and writes the next output packet, if
3907 * available, to avpkt. The output packet does not necessarily contain data for
3908 * the most recent frame, as encoders can delay and reorder input frames
3909 * internally as needed.
3911 * @param avctx codec context
3912 * @param avpkt output AVPacket.
3913 * The user can supply an output buffer by setting
3914 * avpkt->data and avpkt->size prior to calling the
3915 * function, but if the size of the user-provided data is not
3916 * large enough, encoding will fail. All other AVPacket fields
3917 * will be reset by the encoder using av_init_packet(). If
3918 * avpkt->data is NULL, the encoder will allocate it.
3919 * The encoder will set avpkt->size to the size of the
3920 * output packet. The returned data (if any) belongs to the
3921 * caller, he is responsible for freeing it.
3923 * If this function fails or produces no output, avpkt will be
3924 * freed using av_free_packet() (i.e. avpkt->destruct will be
3925 * called to free the user supplied buffer).
3926 * @param[in] frame AVFrame containing the raw video data to be encoded.
3927 * May be NULL when flushing an encoder that has the
3928 * CODEC_CAP_DELAY capability set.
3929 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3930 * output packet is non-empty, and to 0 if it is
3931 * empty. If the function returns an error, the
3932 * packet can be assumed to be invalid, and the
3933 * value of got_packet_ptr is undefined and should
3935 * @return 0 on success, negative error code on failure
3937 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3938 const AVFrame *frame, int *got_packet_ptr);
3940 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3941 const AVSubtitle *sub);
3949 * @defgroup lavc_resample Audio resampling
3954 struct ReSampleContext;
3955 struct AVResampleContext;
3957 typedef struct ReSampleContext ReSampleContext;
3960 * Initialize audio resampling context.
3962 * @param output_channels number of output channels
3963 * @param input_channels number of input channels
3964 * @param output_rate output sample rate
3965 * @param input_rate input sample rate
3966 * @param sample_fmt_out requested output sample format
3967 * @param sample_fmt_in input sample format
3968 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3969 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3970 * @param linear if 1 then the used FIR filter will be linearly interpolated
3971 between the 2 closest, if 0 the closest will be used
3972 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3973 * @return allocated ReSampleContext, NULL if error occurred
3975 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3976 int output_rate, int input_rate,
3977 enum AVSampleFormat sample_fmt_out,
3978 enum AVSampleFormat sample_fmt_in,
3979 int filter_length, int log2_phase_count,
3980 int linear, double cutoff);
3982 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3985 * Free resample context.
3987 * @param s a non-NULL pointer to a resample context previously
3988 * created with av_audio_resample_init()
3990 void audio_resample_close(ReSampleContext *s);
3994 * Initialize an audio resampler.
3995 * Note, if either rate is not an integer then simply scale both rates up so they are.
3996 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3997 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3998 * @param linear If 1 then the used FIR filter will be linearly interpolated
3999 between the 2 closest, if 0 the closest will be used
4000 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4002 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4005 * Resample an array of samples using a previously configured context.
4006 * @param src an array of unconsumed samples
4007 * @param consumed the number of samples of src which have been consumed are returned here
4008 * @param src_size the number of unconsumed samples available
4009 * @param dst_size the amount of space in samples available in dst
4010 * @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.
4011 * @return the number of samples written in dst or -1 if an error occurred
4013 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4017 * Compensate samplerate/timestamp drift. The compensation is done by changing
4018 * the resampler parameters, so no audible clicks or similar distortions occur
4019 * @param compensation_distance distance in output samples over which the compensation should be performed
4020 * @param sample_delta number of output samples which should be output less
4022 * example: av_resample_compensate(c, 10, 500)
4023 * here instead of 510 samples only 500 samples would be output
4025 * note, due to rounding the actual compensation might be slightly different,
4026 * especially if the compensation_distance is large and the in_rate used during init is small
4028 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4029 void av_resample_close(struct AVResampleContext *c);
4036 * @addtogroup lavc_picture
4041 * Allocate memory for a picture. Call avpicture_free() to free it.
4043 * @see avpicture_fill()
4045 * @param picture the picture to be filled in
4046 * @param pix_fmt the format of the picture
4047 * @param width the width of the picture
4048 * @param height the height of the picture
4049 * @return zero if successful, a negative value if not
4051 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
4054 * Free a picture previously allocated by avpicture_alloc().
4055 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4058 * @param picture the AVPicture to be freed
4060 void avpicture_free(AVPicture *picture);
4063 * Fill in the AVPicture fields.
4064 * The fields of the given AVPicture are filled in by using the 'ptr' address
4065 * which points to the image data buffer. Depending on the specified picture
4066 * format, one or multiple image data pointers and line sizes will be set.
4067 * If a planar format is specified, several pointers will be set pointing to
4068 * the different picture planes and the line sizes of the different planes
4069 * will be stored in the lines_sizes array.
4070 * Call with ptr == NULL to get the required size for the ptr buffer.
4072 * To allocate the buffer and fill in the AVPicture fields in one call,
4073 * use avpicture_alloc().
4075 * @param picture AVPicture whose fields are to be filled in
4076 * @param ptr Buffer which will contain or contains the actual image data
4077 * @param pix_fmt The format in which the picture data is stored.
4078 * @param width the width of the image in pixels
4079 * @param height the height of the image in pixels
4080 * @return size of the image data in bytes
4082 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4083 enum PixelFormat pix_fmt, int width, int height);
4086 * Copy pixel data from an AVPicture into a buffer.
4087 * The data is stored compactly, without any gaps for alignment or padding
4088 * which may be applied by avpicture_fill().
4090 * @see avpicture_get_size()
4092 * @param[in] src AVPicture containing image data
4093 * @param[in] pix_fmt The format in which the picture data is stored.
4094 * @param[in] width the width of the image in pixels.
4095 * @param[in] height the height of the image in pixels.
4096 * @param[out] dest A buffer into which picture data will be copied.
4097 * @param[in] dest_size The size of 'dest'.
4098 * @return The number of bytes written to dest, or a negative value (error code) on error.
4100 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
4101 unsigned char *dest, int dest_size);
4104 * Calculate the size in bytes that a picture of the given width and height
4105 * would occupy if stored in the given picture format.
4106 * Note that this returns the size of a compact representation as generated
4107 * by avpicture_layout(), which can be smaller than the size required for e.g.
4110 * @param pix_fmt the given picture format
4111 * @param width the width of the image
4112 * @param height the height of the image
4113 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
4115 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
4118 * deinterlace - if not supported return -1
4120 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4121 enum PixelFormat pix_fmt, int width, int height);
4123 * Copy image src to dst. Wraps av_picture_data_copy() above.
4125 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4126 enum PixelFormat pix_fmt, int width, int height);
4129 * Crop image top and left side.
4131 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4132 enum PixelFormat pix_fmt, int top_band, int left_band);
4137 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4138 int padtop, int padbottom, int padleft, int padright, int *color);
4145 * @defgroup lavc_misc Utility functions
4148 * Miscellaneous utility functions related to both encoding and decoding
4154 * @defgroup lavc_misc_pixfmt Pixel formats
4156 * Functions for working with pixel formats.
4160 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
4163 * Return a value representing the fourCC code associated to the
4164 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4167 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
4169 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4170 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4171 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4172 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4173 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4174 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4177 * Compute what kind of losses will occur when converting from one specific
4178 * pixel format to another.
4179 * When converting from one pixel format to another, information loss may occur.
4180 * For example, when converting from RGB24 to GRAY, the color information will
4181 * be lost. Similarly, other losses occur when converting from some formats to
4182 * other formats. These losses can involve loss of chroma, but also loss of
4183 * resolution, loss of color depth, loss due to the color space conversion, loss
4184 * of the alpha bits or loss due to color quantization.
4185 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4186 * which will occur when converting from one pixel format to another.
4188 * @param[in] dst_pix_fmt destination pixel format
4189 * @param[in] src_pix_fmt source pixel format
4190 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4191 * @return Combination of flags informing you what kind of losses will occur.
4193 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
4197 * Find the best pixel format to convert to given a certain source pixel
4198 * format. When converting from one pixel format to another, information loss
4199 * may occur. For example, when converting from RGB24 to GRAY, the color
4200 * information will be lost. Similarly, other losses occur when converting from
4201 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4202 * the given pixel formats should be used to suffer the least amount of loss.
4203 * The pixel formats from which it chooses one, are determined by the
4204 * pix_fmt_mask parameter.
4207 * src_pix_fmt = PIX_FMT_YUV420P;
4208 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
4209 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4212 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4213 * @param[in] src_pix_fmt source pixel format
4214 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4215 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4216 * @return The best pixel format to convert to or -1 if none was found.
4218 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
4219 int has_alpha, int *loss_ptr);
4221 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4227 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4230 * Put a string representing the codec tag codec_tag in buf.
4232 * @param buf_size size in bytes of buf
4233 * @return the length of the string that would have been generated if
4234 * enough space had been available, excluding the trailing null
4236 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4238 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4241 * Return a name for the specified profile, if available.
4243 * @param codec the codec that is searched for the given profile
4244 * @param profile the profile value for which a name is requested
4245 * @return A name for the profile if found, NULL otherwise.
4247 const char *av_get_profile_name(const AVCodec *codec, int profile);
4249 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4250 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4251 //FIXME func typedef
4254 * Fill audio frame data and linesize.
4255 * AVFrame extended_data channel pointers are allocated if necessary for
4258 * @param frame the AVFrame
4259 * frame->nb_samples must be set prior to calling the
4260 * function. This function fills in frame->data,
4261 * frame->extended_data, frame->linesize[0].
4262 * @param nb_channels channel count
4263 * @param sample_fmt sample format
4264 * @param buf buffer to use for frame data
4265 * @param buf_size size of buffer
4266 * @param align plane size sample alignment (0 = default)
4267 * @return 0 on success, negative error code on failure
4269 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4270 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4271 int buf_size, int align);
4274 * Flush buffers, should be called when seeking or when switching to a different stream.
4276 void avcodec_flush_buffers(AVCodecContext *avctx);
4278 void avcodec_default_free_buffers(AVCodecContext *s);
4281 * Return codec bits per sample.
4283 * @param[in] codec_id the codec
4284 * @return Number of bits per sample or zero if unknown for the given codec.
4286 int av_get_bits_per_sample(enum CodecID codec_id);
4289 * Return codec bits per sample.
4290 * Only return non-zero if the bits per sample is exactly correct, not an
4293 * @param[in] codec_id the codec
4294 * @return Number of bits per sample or zero if unknown for the given codec.
4296 int av_get_exact_bits_per_sample(enum CodecID codec_id);
4299 * Return audio frame duration.
4301 * @param avctx codec context
4302 * @param frame_bytes size of the frame, or 0 if unknown
4303 * @return frame duration, in samples, if known. 0 if not able to
4306 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4309 typedef struct AVBitStreamFilterContext {
4311 struct AVBitStreamFilter *filter;
4312 AVCodecParserContext *parser;
4313 struct AVBitStreamFilterContext *next;
4314 } AVBitStreamFilterContext;
4317 typedef struct AVBitStreamFilter {
4320 int (*filter)(AVBitStreamFilterContext *bsfc,
4321 AVCodecContext *avctx, const char *args,
4322 uint8_t **poutbuf, int *poutbuf_size,
4323 const uint8_t *buf, int buf_size, int keyframe);
4324 void (*close)(AVBitStreamFilterContext *bsfc);
4325 struct AVBitStreamFilter *next;
4326 } AVBitStreamFilter;
4328 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4329 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4330 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4331 AVCodecContext *avctx, const char *args,
4332 uint8_t **poutbuf, int *poutbuf_size,
4333 const uint8_t *buf, int buf_size, int keyframe);
4334 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4336 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4341 * Reallocate the given block if it is not large enough, otherwise do nothing.
4345 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4348 * Allocate a buffer, reusing the given one if large enough.
4350 * Contrary to av_fast_realloc the current buffer contents might not be
4351 * preserved and on error the old buffer is freed, thus no special
4352 * handling to avoid memleaks is necessary.
4354 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4355 * @param size size of the buffer *ptr points to
4356 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4357 * *size 0 if an error occurred.
4359 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4362 * Allocate a buffer with padding, reusing the given one if large enough.
4364 * Same behaviour av_fast_malloc but the buffer has additional
4365 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4368 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4371 * Encode extradata length to a buffer. Used by xiph codecs.
4373 * @param s buffer to write to; must be at least (v/255+1) bytes long
4374 * @param v size of extradata in bytes
4375 * @return number of bytes written to the buffer.
4377 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4380 * Log a generic warning message about a missing feature. This function is
4381 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4382 * only, and would normally not be used by applications.
4383 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4384 * a pointer to an AVClass struct
4385 * @param[in] feature string containing the name of the missing feature
4386 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4387 * If want_sample is non-zero, additional verbage will be added to the log
4388 * message which tells the user how to report samples to the development
4391 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4394 * Log a generic warning message asking for a sample. This function is
4395 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4396 * only, and would normally not be used by applications.
4397 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4398 * a pointer to an AVClass struct
4399 * @param[in] msg string containing an optional message, or NULL if no message
4401 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4404 * Register the hardware accelerator hwaccel.
4406 void av_register_hwaccel(AVHWAccel *hwaccel);
4409 * If hwaccel is NULL, returns the first registered hardware accelerator,
4410 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4411 * after hwaccel, or NULL if hwaccel is the last one.
4413 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4417 * Lock operation used by lockmgr
4420 AV_LOCK_CREATE, ///< Create a mutex
4421 AV_LOCK_OBTAIN, ///< Lock the mutex
4422 AV_LOCK_RELEASE, ///< Unlock the mutex
4423 AV_LOCK_DESTROY, ///< Free mutex resources
4427 * Register a user provided lock manager supporting the operations
4428 * specified by AVLockOp. mutex points to a (void *) where the
4429 * lockmgr should store/get a pointer to a user allocated mutex. It's
4430 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4432 * @param cb User defined callback. Note: Libav may invoke calls to this
4433 * callback during the call to av_lockmgr_register().
4434 * Thus, the application must be prepared to handle that.
4435 * If cb is set to NULL the lockmgr will be unregistered.
4436 * Also note that during unregistration the previously registered
4437 * lockmgr callback may also be invoked.
4439 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4442 * Get the type of the given codec.
4444 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4447 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4448 * with no corresponding avcodec_close()), 0 otherwise.
4450 int avcodec_is_open(AVCodecContext *s);
4453 * @return a non-zero number if codec is an encoder, zero otherwise
4455 int av_codec_is_encoder(AVCodec *codec);
4458 * @return a non-zero number if codec is a decoder, zero otherwise
4460 int av_codec_is_decoder(AVCodec *codec);
4466 #endif /* AVCODEC_AVCODEC_H */