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,
263 /* various PCM "codecs" */
264 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
265 CODEC_ID_PCM_S16LE = 0x10000,
281 CODEC_ID_PCM_S24DAUD,
283 CODEC_ID_PCM_S16LE_PLANAR,
292 CODEC_ID_PCM_S8_PLANAR,
294 /* various ADPCM codecs */
295 CODEC_ID_ADPCM_IMA_QT = 0x11000,
296 CODEC_ID_ADPCM_IMA_WAV,
297 CODEC_ID_ADPCM_IMA_DK3,
298 CODEC_ID_ADPCM_IMA_DK4,
299 CODEC_ID_ADPCM_IMA_WS,
300 CODEC_ID_ADPCM_IMA_SMJPEG,
309 CODEC_ID_ADPCM_YAMAHA,
310 CODEC_ID_ADPCM_SBPRO_4,
311 CODEC_ID_ADPCM_SBPRO_3,
312 CODEC_ID_ADPCM_SBPRO_2,
314 CODEC_ID_ADPCM_IMA_AMV,
315 CODEC_ID_ADPCM_EA_R1,
316 CODEC_ID_ADPCM_EA_R3,
317 CODEC_ID_ADPCM_EA_R2,
318 CODEC_ID_ADPCM_IMA_EA_SEAD,
319 CODEC_ID_ADPCM_IMA_EA_EACS,
320 CODEC_ID_ADPCM_EA_XAS,
321 CODEC_ID_ADPCM_EA_MAXIS_XA,
322 CODEC_ID_ADPCM_IMA_ISS,
324 CODEC_ID_ADPCM_IMA_APC,
327 CODEC_ID_AMR_NB = 0x12000,
330 /* RealAudio codecs*/
331 CODEC_ID_RA_144 = 0x13000,
334 /* various DPCM codecs */
335 CODEC_ID_ROQ_DPCM = 0x14000,
336 CODEC_ID_INTERPLAY_DPCM,
341 CODEC_ID_MP2 = 0x15000,
342 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
358 CODEC_ID_WESTWOOD_SND1,
359 CODEC_ID_GSM, ///< as in Berlin toast format
367 CODEC_ID_DSICINAUDIO,
371 CODEC_ID_GSM_MS, /* as found in WAV */
380 CODEC_ID_WMALOSSLESS,
389 CODEC_ID_BINKAUDIO_RDFT,
390 CODEC_ID_BINKAUDIO_DCT,
403 /* subtitle codecs */
404 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
405 CODEC_ID_DVD_SUBTITLE = 0x17000,
406 CODEC_ID_DVB_SUBTITLE,
407 CODEC_ID_TEXT, ///< raw UTF-8 text
411 CODEC_ID_HDMV_PGS_SUBTITLE,
412 CODEC_ID_DVB_TELETEXT,
415 /* other specific kind of codecs (generally used for attachments) */
416 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
417 CODEC_ID_TTF = 0x18000,
419 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
421 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
422 * stream (only used by libavformat) */
423 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
424 * stream (only used by libavformat) */
425 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
428 #if FF_API_OLD_DECODE_AUDIO
430 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
434 * @ingroup lavc_decoding
435 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
436 * This is mainly needed because some optimized bitstream readers read
437 * 32 or 64 bit at once and could read over the end.<br>
438 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
439 * MPEG bitstreams could cause overread and segfault.
441 #define FF_INPUT_BUFFER_PADDING_SIZE 8
444 * @ingroup lavc_encoding
445 * minimum encoding buffer size
446 * Used to avoid some checks during header writing.
448 #define FF_MIN_BUFFER_SIZE 16384
452 * @ingroup lavc_encoding
453 * motion estimation type.
456 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
460 ME_EPZS, ///< enhanced predictive zonal search
461 ME_X1, ///< reserved for experiments
462 ME_HEX, ///< hexagon based search
463 ME_UMH, ///< uneven multi-hexagon search
464 ME_ITER, ///< iterative search
465 ME_TESA, ///< transformed exhaustive search algorithm
469 * @ingroup lavc_decoding
472 /* We leave some space between them for extensions (drop some
473 * keyframes for intra-only or drop just some bidir frames). */
474 AVDISCARD_NONE =-16, ///< discard nothing
475 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
476 AVDISCARD_NONREF = 8, ///< discard all non reference
477 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
478 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
479 AVDISCARD_ALL = 48, ///< discard all
482 enum AVColorPrimaries{
483 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
484 AVCOL_PRI_UNSPECIFIED = 2,
485 AVCOL_PRI_BT470M = 4,
486 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
487 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
488 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
490 AVCOL_PRI_NB , ///< Not part of ABI
493 enum AVColorTransferCharacteristic{
494 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
495 AVCOL_TRC_UNSPECIFIED = 2,
496 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
497 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
498 AVCOL_TRC_SMPTE240M = 7,
499 AVCOL_TRC_NB , ///< Not part of ABI
504 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
505 AVCOL_SPC_UNSPECIFIED = 2,
507 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
508 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
509 AVCOL_SPC_SMPTE240M = 7,
510 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
511 AVCOL_SPC_NB , ///< Not part of ABI
515 AVCOL_RANGE_UNSPECIFIED = 0,
516 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
517 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
518 AVCOL_RANGE_NB , ///< Not part of ABI
522 * X X 3 4 X X are luma samples,
523 * 1 2 1-6 are possible chroma positions
524 * X X 5 6 X 0 is undefined/unknown position
526 enum AVChromaLocation{
527 AVCHROMA_LOC_UNSPECIFIED = 0,
528 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
529 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
530 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
531 AVCHROMA_LOC_TOP = 4,
532 AVCHROMA_LOC_BOTTOMLEFT = 5,
533 AVCHROMA_LOC_BOTTOM = 6,
534 AVCHROMA_LOC_NB , ///< Not part of ABI
537 enum AVAudioServiceType {
538 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
539 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
540 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
541 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
542 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
543 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
544 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
545 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
546 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
547 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
551 * @ingroup lavc_encoding
553 typedef struct RcOverride{
556 int qscale; // If this is 0 then quality_factor will be used instead.
557 float quality_factor;
560 #define FF_MAX_B_FRAMES 16
563 These flags can be passed in AVCodecContext.flags before initialization.
564 Note: Not everything is supported yet.
567 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
568 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
569 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
570 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
571 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
573 * The parent program guarantees that the input for B-frames containing
574 * streams is not written to for at least s->max_b_frames+1 frames, if
575 * this is not set the input will be copied.
577 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
578 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
579 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
580 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
581 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
582 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
583 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
584 location instead of only at frame boundaries. */
585 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
586 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
587 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
588 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
589 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
590 /* Fx : Flag for h263+ extra options */
591 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
592 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
593 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
594 #define CODEC_FLAG_CLOSED_GOP 0x80000000
595 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
596 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
597 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
598 #if FF_API_MPV_GLOBAL_OPTS
599 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
600 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
601 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
602 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
604 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
606 /* Unsupported options :
607 * Syntax Arithmetic coding (SAC)
608 * Reference Picture Selection
609 * Independent Segment Decoding */
611 /* codec capabilities */
613 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
615 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
616 * If not set, it might not use get_buffer() at all or use operations that
617 * assume the buffer was allocated by avcodec_default_get_buffer.
619 #define CODEC_CAP_DR1 0x0002
620 #define CODEC_CAP_TRUNCATED 0x0008
621 /* Codec can export data for HW decoding (XvMC). */
622 #define CODEC_CAP_HWACCEL 0x0010
624 * Encoder or decoder requires flushing with NULL input at the end in order to
625 * give the complete and correct output.
627 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
628 * with NULL data. The user can still send NULL data to the public encode
629 * or decode function, but libavcodec will not pass it along to the codec
630 * unless this flag is set.
633 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
634 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
638 * The encoder needs to be fed with NULL data at the end of encoding until the
639 * encoder no longer returns data.
641 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
642 * flag also means that the encoder must set the pts and duration for
643 * each output packet. If this flag is not set, the pts and duration will
644 * be determined by libavcodec from the input frame.
646 #define CODEC_CAP_DELAY 0x0020
648 * Codec can be fed a final frame with a smaller size.
649 * This can be used to prevent truncation of the last audio samples.
651 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
653 * Codec can export data for HW decoding (VDPAU).
655 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
657 * Codec can output multiple frames per AVPacket
658 * Normally demuxers return one frame at a time, demuxers which do not do
659 * are connected to a parser to split what they return into proper frames.
660 * This flag is reserved to the very rare category of codecs which have a
661 * bitstream that cannot be split into frames without timeconsuming
662 * operations like full decoding. Demuxers carring such bitstreams thus
663 * may return multiple frames in a packet. This has many disadvantages like
664 * prohibiting stream copy in many cases thus it should only be considered
667 #define CODEC_CAP_SUBFRAMES 0x0100
669 * Codec is experimental and is thus avoided in favor of non experimental
672 #define CODEC_CAP_EXPERIMENTAL 0x0200
674 * Codec should fill in channel configuration and samplerate instead of container
676 #define CODEC_CAP_CHANNEL_CONF 0x0400
678 * Codec is able to deal with negative linesizes
680 #define CODEC_CAP_NEG_LINESIZES 0x0800
682 * Codec supports frame-level multithreading.
684 #define CODEC_CAP_FRAME_THREADS 0x1000
686 * Codec supports slice-based (or partition-based) multithreading.
688 #define CODEC_CAP_SLICE_THREADS 0x2000
690 * Codec supports changed parameters at any point.
692 #define CODEC_CAP_PARAM_CHANGE 0x4000
694 * Codec supports avctx->thread_count == 0 (auto).
696 #define CODEC_CAP_AUTO_THREADS 0x8000
698 * Audio encoder supports receiving a different number of samples in each call.
700 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
702 //The following defines may change, don't expect compatibility if you use them.
703 #define MB_TYPE_INTRA4x4 0x0001
704 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
705 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
706 #define MB_TYPE_16x16 0x0008
707 #define MB_TYPE_16x8 0x0010
708 #define MB_TYPE_8x16 0x0020
709 #define MB_TYPE_8x8 0x0040
710 #define MB_TYPE_INTERLACED 0x0080
711 #define MB_TYPE_DIRECT2 0x0100 //FIXME
712 #define MB_TYPE_ACPRED 0x0200
713 #define MB_TYPE_GMC 0x0400
714 #define MB_TYPE_SKIP 0x0800
715 #define MB_TYPE_P0L0 0x1000
716 #define MB_TYPE_P1L0 0x2000
717 #define MB_TYPE_P0L1 0x4000
718 #define MB_TYPE_P1L1 0x8000
719 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
720 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
721 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
722 #define MB_TYPE_QUANT 0x00010000
723 #define MB_TYPE_CBP 0x00020000
724 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
728 * This specifies the area which should be displayed.
729 * Note there may be multiple such areas for one frame.
731 typedef struct AVPanScan{
734 * - encoding: Set by user.
735 * - decoding: Set by libavcodec.
740 * width and height in 1/16 pel
741 * - encoding: Set by user.
742 * - decoding: Set by libavcodec.
748 * position of the top left corner in 1/16 pel for up to 3 fields/frames
749 * - encoding: Set by user.
750 * - decoding: Set by libavcodec.
752 int16_t position[3][2];
755 #define FF_QSCALE_TYPE_MPEG1 0
756 #define FF_QSCALE_TYPE_MPEG2 1
757 #define FF_QSCALE_TYPE_H264 2
758 #define FF_QSCALE_TYPE_VP56 3
760 #define FF_BUFFER_TYPE_INTERNAL 1
761 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
762 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
763 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
765 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
766 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
767 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
768 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
771 * @defgroup lavc_packet AVPacket
773 * Types and functions for working with AVPacket.
776 enum AVPacketSideDataType {
778 AV_PKT_DATA_NEW_EXTRADATA,
781 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
784 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
785 * s32le channel_count
786 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
787 * u64le channel_layout
788 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
790 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
795 AV_PKT_DATA_PARAM_CHANGE,
798 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
799 * structures with info about macroblocks relevant to splitting the
800 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
801 * That is, it does not necessarily contain info about all macroblocks,
802 * as long as the distance between macroblocks in the info is smaller
803 * than the target payload size.
804 * Each MB info structure is 12 bytes, and is laid out as follows:
806 * u32le bit offset from the start of the packet
807 * u8 current quantizer at the start of the macroblock
809 * u16le macroblock address within the GOB
810 * u8 horizontal MV predictor
811 * u8 vertical MV predictor
812 * u8 horizontal MV predictor for block number 3
813 * u8 vertical MV predictor for block number 3
816 AV_PKT_DATA_H263_MB_INFO,
819 typedef struct AVPacket {
821 * Presentation timestamp in AVStream->time_base units; the time at which
822 * the decompressed packet will be presented to the user.
823 * Can be AV_NOPTS_VALUE if it is not stored in the file.
824 * pts MUST be larger or equal to dts as presentation cannot happen before
825 * decompression, unless one wants to view hex dumps. Some formats misuse
826 * the terms dts and pts/cts to mean something different. Such timestamps
827 * must be converted to true pts/dts before they are stored in AVPacket.
831 * Decompression timestamp in AVStream->time_base units; the time at which
832 * the packet is decompressed.
833 * Can be AV_NOPTS_VALUE if it is not stored in the file.
840 * A combination of AV_PKT_FLAG values
844 * Additional packet data that can be provided by the container.
845 * Packet can contain several types of side information.
850 enum AVPacketSideDataType type;
855 * Duration of this packet in AVStream->time_base units, 0 if unknown.
856 * Equals next_pts - this_pts in presentation order.
859 void (*destruct)(struct AVPacket *);
861 int64_t pos; ///< byte position in stream, -1 if unknown
864 * Time difference in AVStream->time_base units from the pts of this
865 * packet to the point at which the output from the decoder has converged
866 * independent from the availability of previous frames. That is, the
867 * frames are virtually identical no matter if decoding started from
868 * the very first frame or from this keyframe.
869 * Is AV_NOPTS_VALUE if unknown.
870 * This field is not the display duration of the current packet.
871 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
874 * The purpose of this field is to allow seeking in streams that have no
875 * keyframes in the conventional sense. It corresponds to the
876 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
877 * essential for some types of subtitle streams to ensure that all
878 * subtitles are correctly displayed after seeking.
880 int64_t convergence_duration;
882 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
883 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
885 enum AVSideDataParamChangeFlags {
886 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
887 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
888 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
889 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
897 * New fields can be added to the end of AVFRAME with minor version
898 * bumps. Removal, reordering and changes to existing fields require
899 * a major version bump.
900 * sizeof(AVFrame) must not be used outside libav*.
902 typedef struct AVFrame {
903 #define AV_NUM_DATA_POINTERS 8
905 * pointer to the picture/channel planes.
906 * This might be different from the first allocated byte
907 * - encoding: Set by user
908 * - decoding: set by AVCodecContext.get_buffer()
910 uint8_t *data[AV_NUM_DATA_POINTERS];
913 * Size, in bytes, of the data for each picture/channel plane.
915 * For audio, only linesize[0] may be set. For planar audio, each channel
916 * plane must be the same size.
918 * - encoding: Set by user
919 * - decoding: set by AVCodecContext.get_buffer()
921 int linesize[AV_NUM_DATA_POINTERS];
924 * pointers to the data planes/channels.
926 * For video, this should simply point to data[].
928 * For planar audio, each channel has a separate data pointer, and
929 * linesize[0] contains the size of each channel buffer.
930 * For packed audio, there is just one data pointer, and linesize[0]
931 * contains the total size of the buffer for all channels.
933 * Note: Both data and extended_data will always be set by get_buffer(),
934 * but for planar audio with more channels that can fit in data,
935 * extended_data must be used by the decoder in order to access all
939 * decoding: set by AVCodecContext.get_buffer()
941 uint8_t **extended_data;
944 * width and height of the video frame
946 * - decoding: Read by user.
951 * number of audio samples (per channel) described by this frame
952 * - encoding: Set by user
953 * - decoding: Set by libavcodec
958 * format of the frame, -1 if unknown or unset
959 * Values correspond to enum PixelFormat for video frames,
960 * enum AVSampleFormat for audio)
962 * - decoding: Read by user.
967 * 1 -> keyframe, 0-> not
968 * - encoding: Set by libavcodec.
969 * - decoding: Set by libavcodec.
974 * Picture type of the frame, see ?_TYPE below.
975 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
976 * - decoding: Set by libavcodec.
978 enum AVPictureType pict_type;
981 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
982 * This isn't used by libavcodec unless the default get/release_buffer() is used.
986 uint8_t *base[AV_NUM_DATA_POINTERS];
989 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
991 * - decoding: Read by user.
993 AVRational sample_aspect_ratio;
996 * presentation timestamp in time_base units (time when frame should be shown to user)
997 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
998 * - encoding: MUST be set by user.
999 * - decoding: Set by libavcodec.
1004 * reordered pts from the last AVPacket that has been input into the decoder
1005 * - encoding: unused
1006 * - decoding: Read by user.
1011 * dts from the last AVPacket that has been input into the decoder
1012 * - encoding: unused
1013 * - decoding: Read by user.
1018 * picture number in bitstream order
1019 * - encoding: set by
1020 * - decoding: Set by libavcodec.
1022 int coded_picture_number;
1024 * picture number in display order
1025 * - encoding: set by
1026 * - decoding: Set by libavcodec.
1028 int display_picture_number;
1031 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1032 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1033 * - decoding: Set by libavcodec.
1038 * is this picture used as reference
1039 * The values for this are the same as the MpegEncContext.picture_structure
1040 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1041 * Set to 4 for delayed, non-reference frames.
1042 * - encoding: unused
1043 * - decoding: Set by libavcodec. (before get_buffer() call)).
1049 * - encoding: unused
1050 * - decoding: Set by libavcodec.
1052 int8_t *qscale_table;
1055 * - encoding: unused
1056 * - decoding: Set by libavcodec.
1066 * mbskip_table[mb]>=1 if MB didn't change
1067 * stride= mb_width = (width+15)>>4
1068 * - encoding: unused
1069 * - decoding: Set by libavcodec.
1071 uint8_t *mbskip_table;
1074 * motion vector table
1077 * int mv_sample_log2= 4 - motion_subsample_log2;
1078 * int mb_width= (width+15)>>4;
1079 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1080 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1082 * - encoding: Set by user.
1083 * - decoding: Set by libavcodec.
1085 int16_t (*motion_val[2])[2];
1088 * macroblock type table
1089 * mb_type_base + mb_width + 2
1090 * - encoding: Set by user.
1091 * - decoding: Set by libavcodec.
1097 * - encoding: unused
1098 * - decoding: Set by libavcodec.
1103 * motion reference frame index
1104 * the order in which these are stored can depend on the codec.
1105 * - encoding: Set by user.
1106 * - decoding: Set by libavcodec.
1108 int8_t *ref_index[2];
1111 * for some private data of the user
1112 * - encoding: unused
1113 * - decoding: Set by user.
1119 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1120 * - decoding: unused
1122 uint64_t error[AV_NUM_DATA_POINTERS];
1125 * type of the buffer (to keep track of who has to deallocate data[*])
1126 * - encoding: Set by the one who allocates it.
1127 * - decoding: Set by the one who allocates it.
1128 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1133 * When decoding, this signals how much the picture must be delayed.
1134 * extra_delay = repeat_pict / (2*fps)
1135 * - encoding: unused
1136 * - decoding: Set by libavcodec.
1141 * The content of the picture is interlaced.
1142 * - encoding: Set by user.
1143 * - decoding: Set by libavcodec. (default 0)
1145 int interlaced_frame;
1148 * If the content is interlaced, is top field displayed first.
1149 * - encoding: Set by user.
1150 * - decoding: Set by libavcodec.
1152 int top_field_first;
1155 * Tell user application that palette has changed from previous frame.
1156 * - encoding: ??? (no palette-enabled encoder yet)
1157 * - decoding: Set by libavcodec. (default 0).
1159 int palette_has_changed;
1162 * codec suggestion on buffer type if != 0
1163 * - encoding: unused
1164 * - decoding: Set by libavcodec. (before get_buffer() call)).
1170 * - encoding: Set by user.
1171 * - decoding: Set by libavcodec.
1173 AVPanScan *pan_scan;
1176 * reordered opaque 64bit (generally an integer or a double precision float
1177 * PTS but can be anything).
1178 * The user sets AVCodecContext.reordered_opaque to represent the input at
1180 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1181 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1182 * @deprecated in favor of pkt_pts
1183 * - encoding: unused
1184 * - decoding: Read by user.
1186 int64_t reordered_opaque;
1189 * hardware accelerator private data (Libav-allocated)
1190 * - encoding: unused
1191 * - decoding: Set by libavcodec
1193 void *hwaccel_picture_private;
1196 * the AVCodecContext which ff_thread_get_buffer() was last called on
1197 * - encoding: Set by libavcodec.
1198 * - decoding: Set by libavcodec.
1200 struct AVCodecContext *owner;
1203 * used by multithreading to store frame-specific info
1204 * - encoding: Set by libavcodec.
1205 * - decoding: Set by libavcodec.
1207 void *thread_opaque;
1210 * log2 of the size of the block which a single vector in motion_val represents:
1211 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1212 * - encoding: unused
1213 * - decoding: Set by libavcodec.
1215 uint8_t motion_subsample_log2;
1218 * Sample rate of the audio data.
1220 * - encoding: unused
1221 * - decoding: set by get_buffer()
1226 * Channel layout of the audio data.
1228 * - encoding: unused
1229 * - decoding: set by get_buffer()
1231 uint64_t channel_layout;
1234 struct AVCodecInternal;
1238 AV_FIELD_PROGRESSIVE,
1239 AV_FIELD_TT, //< Top coded_first, top displayed first
1240 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1241 AV_FIELD_TB, //< Top coded first, bottom displayed first
1242 AV_FIELD_BT, //< Bottom coded first, top displayed first
1246 * main external API structure.
1247 * New fields can be added to the end with minor version bumps.
1248 * Removal, reordering and changes to existing fields require a major
1250 * sizeof(AVCodecContext) must not be used outside libav*.
1252 typedef struct AVCodecContext {
1254 * information on struct for av_log
1255 * - set by avcodec_alloc_context3
1257 const AVClass *av_class;
1258 int log_level_offset;
1260 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1261 struct AVCodec *codec;
1262 char codec_name[32];
1263 enum CodecID codec_id; /* see CODEC_ID_xxx */
1266 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1267 * This is used to work around some encoder bugs.
1268 * A demuxer should set this to what is stored in the field used to identify the codec.
1269 * If there are multiple such fields in a container then the demuxer should choose the one
1270 * which maximizes the information about the used codec.
1271 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1272 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1273 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1275 * - encoding: Set by user, if not then the default based on codec_id will be used.
1276 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1278 unsigned int codec_tag;
1281 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1282 * This is used to work around some encoder bugs.
1283 * - encoding: unused
1284 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1286 unsigned int stream_codec_tag;
1290 * @deprecated this field is unused
1292 attribute_deprecated int sub_id;
1298 * Private context used for internal data.
1300 * Unlike priv_data, this is not codec-specific. It is used in general
1301 * libavcodec functions.
1303 struct AVCodecInternal *internal;
1306 * Private data of the user, can be used to carry app specific stuff.
1307 * - encoding: Set by user.
1308 * - decoding: Set by user.
1313 * the average bitrate
1314 * - encoding: Set by user; unused for constant quantizer encoding.
1315 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1320 * number of bits the bitstream is allowed to diverge from the reference.
1321 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1322 * - encoding: Set by user; unused for constant quantizer encoding.
1323 * - decoding: unused
1325 int bit_rate_tolerance;
1328 * Global quality for codecs which cannot change it per frame.
1329 * This should be proportional to MPEG-1/2/4 qscale.
1330 * - encoding: Set by user.
1331 * - decoding: unused
1336 * - encoding: Set by user.
1337 * - decoding: unused
1339 int compression_level;
1340 #define FF_COMPRESSION_DEFAULT -1
1344 * - encoding: Set by user.
1345 * - decoding: Set by user.
1351 * - encoding: Set by user.
1352 * - decoding: Set by user.
1357 * some codecs need / can use extradata like Huffman tables.
1358 * mjpeg: Huffman tables
1359 * rv10: additional flags
1360 * mpeg4: global headers (they can be in the bitstream or here)
1361 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1362 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1363 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1364 * - encoding: Set/allocated/freed by libavcodec.
1365 * - decoding: Set/allocated/freed by user.
1371 * This is the fundamental unit of time (in seconds) in terms
1372 * of which frame timestamps are represented. For fixed-fps content,
1373 * timebase should be 1/framerate and timestamp increments should be
1375 * - encoding: MUST be set by user.
1376 * - decoding: Set by libavcodec.
1378 AVRational time_base;
1381 * For some codecs, the time base is closer to the field rate than the frame rate.
1382 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1383 * if no telecine is used ...
1385 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1387 int ticks_per_frame;
1393 * Number of frames the decoded output will be delayed relative to the
1397 * Number of "priming" samples added to the beginning of the stream
1398 * during encoding. The decoded output will be delayed by this many
1399 * samples relative to the input to the encoder. Note that this field is
1400 * purely informational and does not directly affect the pts output by
1401 * the encoder, which should always be based on the actual presentation
1402 * time, including any delay.
1404 * - encoding: Set by libavcodec.
1405 * - decoding: unused
1412 * picture width / height.
1413 * - encoding: MUST be set by user.
1414 * - decoding: Set by libavcodec.
1415 * Note: For compatibility it is possible to set this instead of
1416 * coded_width/height before decoding.
1421 * Bitstream width / height, may be different from width/height.
1422 * - encoding: unused
1423 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1425 int coded_width, coded_height;
1427 #define FF_ASPECT_EXTENDED 15
1430 * the number of pictures in a group of pictures, or 0 for intra_only
1431 * - encoding: Set by user.
1432 * - decoding: unused
1437 * Pixel format, see PIX_FMT_xxx.
1438 * May be set by the demuxer if known from headers.
1439 * May be overriden by the decoder if it knows better.
1440 * - encoding: Set by user.
1441 * - decoding: Set by user if known, overridden by libavcodec if known
1443 enum PixelFormat pix_fmt;
1446 * Motion estimation algorithm used for video coding.
1447 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1448 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1449 * - encoding: MUST be set by user.
1450 * - decoding: unused
1455 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1456 * decoder to draw a horizontal band. It improves cache usage. Not
1457 * all codecs can do that. You must check the codec capabilities
1459 * When multithreading is used, it may be called from multiple threads
1460 * at the same time; threads might draw different parts of the same AVFrame,
1461 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1463 * The function is also used by hardware acceleration APIs.
1464 * It is called at least once during frame decoding to pass
1465 * the data needed for hardware render.
1466 * In that mode instead of pixel data, AVFrame points to
1467 * a structure specific to the acceleration API. The application
1468 * reads the structure and can change some fields to indicate progress
1470 * - encoding: unused
1471 * - decoding: Set by user.
1472 * @param height the height of the slice
1473 * @param y the y position of the slice
1474 * @param type 1->top field, 2->bottom field, 3->frame
1475 * @param offset offset into the AVFrame.data from which the slice should be read
1477 void (*draw_horiz_band)(struct AVCodecContext *s,
1478 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1479 int y, int type, int height);
1482 * callback to negotiate the pixelFormat
1483 * @param fmt is the list of formats which are supported by the codec,
1484 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1485 * The first is always the native one.
1486 * @return the chosen format
1487 * - encoding: unused
1488 * - decoding: Set by user, if not set the native format will be chosen.
1490 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1493 * maximum number of B-frames between non-B-frames
1494 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1495 * - encoding: Set by user.
1496 * - decoding: unused
1501 * qscale factor between IP and B-frames
1502 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1503 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1504 * - encoding: Set by user.
1505 * - decoding: unused
1507 float b_quant_factor;
1509 /** obsolete FIXME remove */
1511 #define FF_RC_STRATEGY_XVID 1
1513 int b_frame_strategy;
1515 #if FF_API_MPV_GLOBAL_OPTS
1517 * luma single coefficient elimination threshold
1518 * - encoding: Set by user.
1519 * - decoding: unused
1521 attribute_deprecated int luma_elim_threshold;
1524 * chroma single coeff elimination threshold
1525 * - encoding: Set by user.
1526 * - decoding: unused
1528 attribute_deprecated int chroma_elim_threshold;
1532 * qscale offset between IP and B-frames
1533 * - encoding: Set by user.
1534 * - decoding: unused
1536 float b_quant_offset;
1539 * Size of the frame reordering buffer in the decoder.
1540 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1541 * - encoding: Set by libavcodec.
1542 * - decoding: Set by libavcodec.
1547 * 0-> h263 quant 1-> mpeg quant
1548 * - encoding: Set by user.
1549 * - decoding: unused
1554 * qscale factor between P and I-frames
1555 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1556 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1557 * - encoding: Set by user.
1558 * - decoding: unused
1560 float i_quant_factor;
1563 * qscale offset between P and I-frames
1564 * - encoding: Set by user.
1565 * - decoding: unused
1567 float i_quant_offset;
1570 * luminance masking (0-> disabled)
1571 * - encoding: Set by user.
1572 * - decoding: unused
1577 * temporary complexity masking (0-> disabled)
1578 * - encoding: Set by user.
1579 * - decoding: unused
1581 float temporal_cplx_masking;
1584 * spatial complexity masking (0-> disabled)
1585 * - encoding: Set by user.
1586 * - decoding: unused
1588 float spatial_cplx_masking;
1591 * p block masking (0-> disabled)
1592 * - encoding: Set by user.
1593 * - decoding: unused
1598 * darkness masking (0-> disabled)
1599 * - encoding: Set by user.
1600 * - decoding: unused
1606 * - encoding: Set by libavcodec.
1607 * - decoding: Set by user (or 0).
1611 * prediction method (needed for huffyuv)
1612 * - encoding: Set by user.
1613 * - decoding: unused
1615 int prediction_method;
1616 #define FF_PRED_LEFT 0
1617 #define FF_PRED_PLANE 1
1618 #define FF_PRED_MEDIAN 2
1621 * slice offsets in the frame in bytes
1622 * - encoding: Set/allocated by libavcodec.
1623 * - decoding: Set/allocated by user (or NULL).
1628 * sample aspect ratio (0 if unknown)
1629 * That is the width of a pixel divided by the height of the pixel.
1630 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1631 * - encoding: Set by user.
1632 * - decoding: Set by libavcodec.
1634 AVRational sample_aspect_ratio;
1637 * motion estimation comparison function
1638 * - encoding: Set by user.
1639 * - decoding: unused
1643 * subpixel motion estimation comparison function
1644 * - encoding: Set by user.
1645 * - decoding: unused
1649 * macroblock comparison function (not supported yet)
1650 * - encoding: Set by user.
1651 * - decoding: unused
1655 * interlaced DCT comparison function
1656 * - encoding: Set by user.
1657 * - decoding: unused
1660 #define FF_CMP_SAD 0
1661 #define FF_CMP_SSE 1
1662 #define FF_CMP_SATD 2
1663 #define FF_CMP_DCT 3
1664 #define FF_CMP_PSNR 4
1665 #define FF_CMP_BIT 5
1667 #define FF_CMP_ZERO 7
1668 #define FF_CMP_VSAD 8
1669 #define FF_CMP_VSSE 9
1670 #define FF_CMP_NSSE 10
1671 #define FF_CMP_W53 11
1672 #define FF_CMP_W97 12
1673 #define FF_CMP_DCTMAX 13
1674 #define FF_CMP_DCT264 14
1675 #define FF_CMP_CHROMA 256
1678 * ME diamond size & shape
1679 * - encoding: Set by user.
1680 * - decoding: unused
1685 * amount of previous MV predictors (2a+1 x 2a+1 square)
1686 * - encoding: Set by user.
1687 * - decoding: unused
1689 int last_predictor_count;
1692 * prepass for motion estimation
1693 * - encoding: Set by user.
1694 * - decoding: unused
1699 * motion estimation prepass comparison function
1700 * - encoding: Set by user.
1701 * - decoding: unused
1706 * ME prepass diamond size & shape
1707 * - encoding: Set by user.
1708 * - decoding: unused
1714 * - encoding: Set by user.
1715 * - decoding: unused
1717 int me_subpel_quality;
1720 * DTG active format information (additional aspect ratio
1721 * information only used in DVB MPEG-2 transport streams)
1724 * - encoding: unused
1725 * - decoding: Set by decoder.
1727 int dtg_active_format;
1728 #define FF_DTG_AFD_SAME 8
1729 #define FF_DTG_AFD_4_3 9
1730 #define FF_DTG_AFD_16_9 10
1731 #define FF_DTG_AFD_14_9 11
1732 #define FF_DTG_AFD_4_3_SP_14_9 13
1733 #define FF_DTG_AFD_16_9_SP_14_9 14
1734 #define FF_DTG_AFD_SP_4_3 15
1737 * maximum motion estimation search range in subpel units
1738 * If 0 then no limit.
1740 * - encoding: Set by user.
1741 * - decoding: unused
1746 * intra quantizer bias
1747 * - encoding: Set by user.
1748 * - decoding: unused
1750 int intra_quant_bias;
1751 #define FF_DEFAULT_QUANT_BIAS 999999
1754 * inter quantizer bias
1755 * - encoding: Set by user.
1756 * - decoding: unused
1758 int inter_quant_bias;
1760 #if FF_API_COLOR_TABLE_ID
1763 * - encoding: unused
1764 * - decoding: Which clrtable should be used for 8bit RGB images.
1765 * Tables have to be stored somewhere. FIXME
1767 attribute_deprecated int color_table_id;
1772 * - encoding: unused
1773 * - decoding: Set by user.
1776 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1777 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1778 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1781 * XVideo Motion Acceleration
1782 * - encoding: forbidden
1783 * - decoding: set by decoder
1785 int xvmc_acceleration;
1788 * macroblock decision mode
1789 * - encoding: Set by user.
1790 * - decoding: unused
1793 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1794 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1795 #define FF_MB_DECISION_RD 2 ///< rate distortion
1798 * custom intra quantization matrix
1799 * - encoding: Set by user, can be NULL.
1800 * - decoding: Set by libavcodec.
1802 uint16_t *intra_matrix;
1805 * custom inter quantization matrix
1806 * - encoding: Set by user, can be NULL.
1807 * - decoding: Set by libavcodec.
1809 uint16_t *inter_matrix;
1812 * scene change detection threshold
1813 * 0 is default, larger means fewer detected scene changes.
1814 * - encoding: Set by user.
1815 * - decoding: unused
1817 int scenechange_threshold;
1820 * noise reduction strength
1821 * - encoding: Set by user.
1822 * - decoding: unused
1824 int noise_reduction;
1826 #if FF_API_INTER_THRESHOLD
1828 * @deprecated this field is unused
1830 attribute_deprecated int inter_threshold;
1833 #if FF_API_MPV_GLOBAL_OPTS
1835 * @deprecated use mpegvideo private options instead
1837 attribute_deprecated int quantizer_noise_shaping;
1841 * Motion estimation threshold below which no motion estimation is
1842 * performed, but instead the user specified motion vectors are used.
1844 * - encoding: Set by user.
1845 * - decoding: unused
1850 * Macroblock threshold below which the user specified macroblock types will be used.
1851 * - encoding: Set by user.
1852 * - decoding: unused
1857 * precision of the intra DC coefficient - 8
1858 * - encoding: Set by user.
1859 * - decoding: unused
1861 int intra_dc_precision;
1864 * Number of macroblock rows at the top which are skipped.
1865 * - encoding: unused
1866 * - decoding: Set by user.
1871 * Number of macroblock rows at the bottom which are skipped.
1872 * - encoding: unused
1873 * - decoding: Set by user.
1878 * Border processing masking, raises the quantizer for mbs on the borders
1880 * - encoding: Set by user.
1881 * - decoding: unused
1883 float border_masking;
1886 * minimum MB lagrange multipler
1887 * - encoding: Set by user.
1888 * - decoding: unused
1893 * maximum MB lagrange multipler
1894 * - encoding: Set by user.
1895 * - decoding: unused
1901 * - encoding: Set by user.
1902 * - decoding: unused
1904 int me_penalty_compensation;
1908 * - encoding: Set by user.
1909 * - decoding: unused
1915 * - encoding: Set by user.
1916 * - decoding: unused
1922 * - encoding: Set by user.
1923 * - decoding: unused
1928 * number of reference frames
1929 * - encoding: Set by user.
1930 * - decoding: Set by lavc.
1935 * chroma qp offset from luma
1936 * - encoding: Set by user.
1937 * - decoding: unused
1942 * Multiplied by qscale for each frame and added to scene_change_score.
1943 * - encoding: Set by user.
1944 * - decoding: unused
1946 int scenechange_factor;
1950 * Note: Value depends upon the compare function used for fullpel ME.
1951 * - encoding: Set by user.
1952 * - decoding: unused
1957 * Adjust sensitivity of b_frame_strategy 1.
1958 * - encoding: Set by user.
1959 * - decoding: unused
1964 * Chromaticity coordinates of the source primaries.
1965 * - encoding: Set by user
1966 * - decoding: Set by libavcodec
1968 enum AVColorPrimaries color_primaries;
1971 * Color Transfer Characteristic.
1972 * - encoding: Set by user
1973 * - decoding: Set by libavcodec
1975 enum AVColorTransferCharacteristic color_trc;
1978 * YUV colorspace type.
1979 * - encoding: Set by user
1980 * - decoding: Set by libavcodec
1982 enum AVColorSpace colorspace;
1985 * MPEG vs JPEG YUV range.
1986 * - encoding: Set by user
1987 * - decoding: Set by libavcodec
1989 enum AVColorRange color_range;
1992 * This defines the location of chroma samples.
1993 * - encoding: Set by user
1994 * - decoding: Set by libavcodec
1996 enum AVChromaLocation chroma_sample_location;
2000 * Indicates number of picture subdivisions. Used for parallelized
2002 * - encoding: Set by user
2003 * - decoding: unused
2008 * - encoding: set by libavcodec
2009 * - decoding: Set by libavcodec
2011 enum AVFieldOrder field_order;
2014 int sample_rate; ///< samples per second
2015 int channels; ///< number of audio channels
2018 * audio sample format
2019 * - encoding: Set by user.
2020 * - decoding: Set by libavcodec.
2022 enum AVSampleFormat sample_fmt; ///< sample format
2024 /* The following data should not be initialized. */
2026 * Samples per packet, initialized when calling 'init'.
2031 * Frame counter, set by libavcodec.
2033 * - decoding: total number of frames returned from the decoder so far.
2034 * - encoding: total number of frames passed to the encoder so far.
2036 * @note the counter is not incremented if encoding/decoding resulted in
2042 * number of bytes per packet if constant and known or 0
2043 * Used by some WAV based audio codecs.
2048 * Audio cutoff bandwidth (0 means "automatic")
2049 * - encoding: Set by user.
2050 * - decoding: unused
2054 #if FF_API_REQUEST_CHANNELS
2056 * Decoder should decode to this many channels if it can (0 for default)
2057 * - encoding: unused
2058 * - decoding: Set by user.
2059 * @deprecated Deprecated in favor of request_channel_layout.
2061 int request_channels;
2065 * Audio channel layout.
2066 * - encoding: set by user.
2067 * - decoding: set by libavcodec.
2069 uint64_t channel_layout;
2072 * Request decoder to use this channel layout if it can (0 for default)
2073 * - encoding: unused
2074 * - decoding: Set by user.
2076 uint64_t request_channel_layout;
2079 * Type of service that the audio stream conveys.
2080 * - encoding: Set by user.
2081 * - decoding: Set by libavcodec.
2083 enum AVAudioServiceType audio_service_type;
2086 * Used to request a sample format from the decoder.
2087 * - encoding: unused.
2088 * - decoding: Set by user.
2090 enum AVSampleFormat request_sample_fmt;
2093 * Called at the beginning of each frame to get a buffer for it.
2095 * The function will set AVFrame.data[], AVFrame.linesize[].
2096 * AVFrame.extended_data[] must also be set, but it should be the same as
2097 * AVFrame.data[] except for planar audio with more channels than can fit
2098 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2099 * many data pointers as it can hold.
2101 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2102 * avcodec_default_get_buffer() instead of providing buffers allocated by
2105 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2106 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2107 * but if get_buffer() is overridden then alignment considerations should
2108 * be taken into account.
2110 * @see avcodec_default_get_buffer()
2114 * If pic.reference is set then the frame will be read later by libavcodec.
2115 * avcodec_align_dimensions2() should be used to find the required width and
2116 * height, as they normally need to be rounded up to the next multiple of 16.
2118 * If frame multithreading is used and thread_safe_callbacks is set,
2119 * it may be called from a different thread, but not from more than one at
2120 * once. Does not need to be reentrant.
2122 * @see release_buffer(), reget_buffer()
2123 * @see avcodec_align_dimensions2()
2127 * Decoders request a buffer of a particular size by setting
2128 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2129 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2130 * to a smaller value in the output frame.
2132 * Decoders cannot use the buffer after returning from
2133 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2134 * is assumed to be released immediately upon return.
2136 * As a convenience, av_samples_get_buffer_size() and
2137 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2138 * functions to find the required data size and to fill data pointers and
2139 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2140 * since all planes must be the same size.
2142 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2144 * - encoding: unused
2145 * - decoding: Set by libavcodec, user can override.
2147 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2150 * Called to release buffers which were allocated with get_buffer.
2151 * A released buffer can be reused in get_buffer().
2152 * pic.data[*] must be set to NULL.
2153 * May be called from a different thread if frame multithreading is used,
2154 * but not by more than one thread at once, so does not need to be reentrant.
2155 * - encoding: unused
2156 * - decoding: Set by libavcodec, user can override.
2158 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2161 * Called at the beginning of a frame to get cr buffer for it.
2162 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2163 * libavcodec will pass previous buffer in pic, function should return
2164 * same buffer or new buffer with old frame "painted" into it.
2165 * If pic.data[0] == NULL must behave like get_buffer().
2166 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2167 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2169 * - encoding: unused
2170 * - decoding: Set by libavcodec, user can override.
2172 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2175 /* - encoding parameters */
2176 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2177 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2181 * - encoding: Set by user.
2182 * - decoding: unused
2188 * - encoding: Set by user.
2189 * - decoding: unused
2194 * maximum quantizer difference between frames
2195 * - encoding: Set by user.
2196 * - decoding: unused
2201 * ratecontrol qmin qmax limiting method
2202 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2203 * - encoding: Set by user.
2204 * - decoding: unused
2212 * decoder bitstream buffer size
2213 * - encoding: Set by user.
2214 * - decoding: unused
2219 * ratecontrol override, see RcOverride
2220 * - encoding: Allocated/set/freed by user.
2221 * - decoding: unused
2223 int rc_override_count;
2224 RcOverride *rc_override;
2227 * rate control equation
2228 * - encoding: Set by user
2229 * - decoding: unused
2235 * - encoding: Set by user.
2236 * - decoding: unused
2242 * - encoding: Set by user.
2243 * - decoding: unused
2247 float rc_buffer_aggressivity;
2250 * initial complexity for pass1 ratecontrol
2251 * - encoding: Set by user.
2252 * - decoding: unused
2254 float rc_initial_cplx;
2257 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2258 * - encoding: Set by user.
2259 * - decoding: unused.
2261 float rc_max_available_vbv_use;
2264 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2265 * - encoding: Set by user.
2266 * - decoding: unused.
2268 float rc_min_vbv_overflow_use;
2271 * Number of bits which should be loaded into the rc buffer before decoding starts.
2272 * - encoding: Set by user.
2273 * - decoding: unused
2275 int rc_initial_buffer_occupancy;
2277 #define FF_CODER_TYPE_VLC 0
2278 #define FF_CODER_TYPE_AC 1
2279 #define FF_CODER_TYPE_RAW 2
2280 #define FF_CODER_TYPE_RLE 3
2281 #define FF_CODER_TYPE_DEFLATE 4
2284 * - encoding: Set by user.
2285 * - decoding: unused
2291 * - encoding: Set by user.
2292 * - decoding: unused
2297 * minimum Lagrange multipler
2298 * - encoding: Set by user.
2299 * - decoding: unused
2304 * maximum Lagrange multipler
2305 * - encoding: Set by user.
2306 * - decoding: unused
2311 * frame skip threshold
2312 * - encoding: Set by user.
2313 * - decoding: unused
2315 int frame_skip_threshold;
2319 * - encoding: Set by user.
2320 * - decoding: unused
2322 int frame_skip_factor;
2325 * frame skip exponent
2326 * - encoding: Set by user.
2327 * - decoding: unused
2332 * frame skip comparison function
2333 * - encoding: Set by user.
2334 * - decoding: unused
2339 * trellis RD quantization
2340 * - encoding: Set by user.
2341 * - decoding: unused
2346 * - encoding: Set by user.
2347 * - decoding: unused
2349 int min_prediction_order;
2352 * - encoding: Set by user.
2353 * - decoding: unused
2355 int max_prediction_order;
2358 * GOP timecode frame start number, in non drop frame format
2359 * - encoding: Set by user.
2360 * - decoding: unused
2362 int64_t timecode_frame_start;
2364 /* The RTP callback: This function is called */
2365 /* every time the encoder has a packet to send. */
2366 /* It depends on the encoder if the data starts */
2367 /* with a Start Code (it should). H.263 does. */
2368 /* mb_nb contains the number of macroblocks */
2369 /* encoded in the RTP payload. */
2370 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2372 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2373 /* do its best to deliver a chunk with size */
2374 /* below rtp_payload_size, the chunk will start */
2375 /* with a start code on some codecs like H.263. */
2376 /* This doesn't take account of any particular */
2377 /* headers inside the transmitted RTP payload. */
2379 /* statistics, used for 2-pass encoding */
2390 * number of bits used for the previously encoded frame
2391 * - encoding: Set by libavcodec.
2392 * - decoding: unused
2397 * pass1 encoding statistics output buffer
2398 * - encoding: Set by libavcodec.
2399 * - decoding: unused
2404 * pass2 encoding statistics input buffer
2405 * Concatenated stuff from stats_out of pass1 should be placed here.
2406 * - encoding: Allocated/set/freed by user.
2407 * - decoding: unused
2412 * Work around bugs in encoders which sometimes cannot be detected automatically.
2413 * - encoding: Set by user
2414 * - decoding: Set by user
2416 int workaround_bugs;
2417 #define FF_BUG_AUTODETECT 1 ///< autodetection
2418 #define FF_BUG_OLD_MSMPEG4 2
2419 #define FF_BUG_XVID_ILACE 4
2420 #define FF_BUG_UMP4 8
2421 #define FF_BUG_NO_PADDING 16
2422 #define FF_BUG_AMV 32
2423 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2424 #define FF_BUG_QPEL_CHROMA 64
2425 #define FF_BUG_STD_QPEL 128
2426 #define FF_BUG_QPEL_CHROMA2 256
2427 #define FF_BUG_DIRECT_BLOCKSIZE 512
2428 #define FF_BUG_EDGE 1024
2429 #define FF_BUG_HPEL_CHROMA 2048
2430 #define FF_BUG_DC_CLIP 4096
2431 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2432 #define FF_BUG_TRUNCATED 16384
2435 * strictly follow the standard (MPEG4, ...).
2436 * - encoding: Set by user.
2437 * - decoding: Set by user.
2438 * Setting this to STRICT or higher means the encoder and decoder will
2439 * generally do stupid things, whereas setting it to unofficial or lower
2440 * will mean the encoder might produce output that is not supported by all
2441 * spec-compliant decoders. Decoders don't differentiate between normal,
2442 * unofficial and experimental (that is, they always try to decode things
2443 * when they can) unless they are explicitly asked to behave stupidly
2444 * (=strictly conform to the specs)
2446 int strict_std_compliance;
2447 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2448 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2449 #define FF_COMPLIANCE_NORMAL 0
2450 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2451 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2454 * error concealment flags
2455 * - encoding: unused
2456 * - decoding: Set by user.
2458 int error_concealment;
2459 #define FF_EC_GUESS_MVS 1
2460 #define FF_EC_DEBLOCK 2
2464 * - encoding: Set by user.
2465 * - decoding: Set by user.
2468 #define FF_DEBUG_PICT_INFO 1
2469 #define FF_DEBUG_RC 2
2470 #define FF_DEBUG_BITSTREAM 4
2471 #define FF_DEBUG_MB_TYPE 8
2472 #define FF_DEBUG_QP 16
2473 #define FF_DEBUG_MV 32
2474 #define FF_DEBUG_DCT_COEFF 0x00000040
2475 #define FF_DEBUG_SKIP 0x00000080
2476 #define FF_DEBUG_STARTCODE 0x00000100
2477 #define FF_DEBUG_PTS 0x00000200
2478 #define FF_DEBUG_ER 0x00000400
2479 #define FF_DEBUG_MMCO 0x00000800
2480 #define FF_DEBUG_BUGS 0x00001000
2481 #define FF_DEBUG_VIS_QP 0x00002000
2482 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2483 #define FF_DEBUG_BUFFERS 0x00008000
2484 #define FF_DEBUG_THREADS 0x00010000
2488 * - encoding: Set by user.
2489 * - decoding: Set by user.
2492 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2493 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2494 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2497 * Error recognition; may misdetect some more or less valid parts as errors.
2498 * - encoding: unused
2499 * - decoding: Set by user.
2501 int err_recognition;
2502 #define AV_EF_CRCCHECK (1<<0)
2503 #define AV_EF_BITSTREAM (1<<1)
2504 #define AV_EF_BUFFER (1<<2)
2505 #define AV_EF_EXPLODE (1<<3)
2508 * opaque 64bit number (generally a PTS) that will be reordered and
2509 * output in AVFrame.reordered_opaque
2510 * @deprecated in favor of pkt_pts
2511 * - encoding: unused
2512 * - decoding: Set by user.
2514 int64_t reordered_opaque;
2517 * Hardware accelerator in use
2518 * - encoding: unused.
2519 * - decoding: Set by libavcodec
2521 struct AVHWAccel *hwaccel;
2524 * Hardware accelerator context.
2525 * For some hardware accelerators, a global context needs to be
2526 * provided by the user. In that case, this holds display-dependent
2527 * data Libav cannot instantiate itself. Please refer to the
2528 * Libav HW accelerator documentation to know how to fill this
2529 * is. e.g. for VA API, this is a struct vaapi_context.
2530 * - encoding: unused
2531 * - decoding: Set by user
2533 void *hwaccel_context;
2537 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2538 * - decoding: unused
2540 uint64_t error[AV_NUM_DATA_POINTERS];
2543 * DCT algorithm, see FF_DCT_* below
2544 * - encoding: Set by user.
2545 * - decoding: unused
2548 #define FF_DCT_AUTO 0
2549 #define FF_DCT_FASTINT 1
2550 #define FF_DCT_INT 2
2551 #define FF_DCT_MMX 3
2552 #define FF_DCT_ALTIVEC 5
2553 #define FF_DCT_FAAN 6
2556 * IDCT algorithm, see FF_IDCT_* below.
2557 * - encoding: Set by user.
2558 * - decoding: Set by user.
2561 #define FF_IDCT_AUTO 0
2562 #define FF_IDCT_INT 1
2563 #define FF_IDCT_SIMPLE 2
2564 #define FF_IDCT_SIMPLEMMX 3
2565 #define FF_IDCT_LIBMPEG2MMX 4
2566 #define FF_IDCT_MMI 5
2567 #define FF_IDCT_ARM 7
2568 #define FF_IDCT_ALTIVEC 8
2569 #define FF_IDCT_SH4 9
2570 #define FF_IDCT_SIMPLEARM 10
2571 #define FF_IDCT_H264 11
2572 #define FF_IDCT_VP3 12
2573 #define FF_IDCT_IPP 13
2574 #define FF_IDCT_XVIDMMX 14
2575 #define FF_IDCT_CAVS 15
2576 #define FF_IDCT_SIMPLEARMV5TE 16
2577 #define FF_IDCT_SIMPLEARMV6 17
2578 #define FF_IDCT_SIMPLEVIS 18
2579 #define FF_IDCT_WMV2 19
2580 #define FF_IDCT_FAAN 20
2581 #define FF_IDCT_EA 21
2582 #define FF_IDCT_SIMPLENEON 22
2583 #define FF_IDCT_SIMPLEALPHA 23
2584 #define FF_IDCT_BINK 24
2589 * @deprecated use av_set_cpu_flags_mask() instead.
2591 attribute_deprecated unsigned dsp_mask;
2595 * bits per sample/pixel from the demuxer (needed for huffyuv).
2596 * - encoding: Set by libavcodec.
2597 * - decoding: Set by user.
2599 int bits_per_coded_sample;
2602 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2603 * - encoding: set by user.
2604 * - decoding: set by libavcodec.
2606 int bits_per_raw_sample;
2609 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2610 * - encoding: unused
2611 * - decoding: Set by user.
2613 attribute_deprecated int lowres;
2616 * the picture in the bitstream
2617 * - encoding: Set by libavcodec.
2618 * - decoding: Set by libavcodec.
2620 AVFrame *coded_frame;
2624 * is used to decide how many independent tasks should be passed to execute()
2625 * - encoding: Set by user.
2626 * - decoding: Set by user.
2631 * Which multithreading methods to use.
2632 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2633 * so clients which cannot provide future frames should not use it.
2635 * - encoding: Set by user, otherwise the default is used.
2636 * - decoding: Set by user, otherwise the default is used.
2639 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2640 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2643 * Which multithreading methods are in use by the codec.
2644 * - encoding: Set by libavcodec.
2645 * - decoding: Set by libavcodec.
2647 int active_thread_type;
2650 * Set by the client if its custom get_buffer() callback can be called
2651 * synchronously from another thread, which allows faster multithreaded decoding.
2652 * draw_horiz_band() will be called from other threads regardless of this setting.
2653 * Ignored if the default get_buffer() is used.
2654 * - encoding: Set by user.
2655 * - decoding: Set by user.
2657 int thread_safe_callbacks;
2660 * The codec may call this to execute several independent things.
2661 * It will return only after finishing all tasks.
2662 * The user may replace this with some multithreaded implementation,
2663 * the default implementation will execute the parts serially.
2664 * @param count the number of things to execute
2665 * - encoding: Set by libavcodec, user can override.
2666 * - decoding: Set by libavcodec, user can override.
2668 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2671 * The codec may call this to execute several independent things.
2672 * It will return only after finishing all tasks.
2673 * The user may replace this with some multithreaded implementation,
2674 * the default implementation will execute the parts serially.
2675 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2676 * @param c context passed also to func
2677 * @param count the number of things to execute
2678 * @param arg2 argument passed unchanged to func
2679 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2680 * @param func function that will be called count times, with jobnr from 0 to count-1.
2681 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2682 * two instances of func executing at the same time will have the same threadnr.
2683 * @return always 0 currently, but code should handle a future improvement where when any call to func
2684 * returns < 0 no further calls to func may be done and < 0 is returned.
2685 * - encoding: Set by libavcodec, user can override.
2686 * - decoding: Set by libavcodec, user can override.
2688 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2692 * Can be used by execute() to store some per AVCodecContext stuff.
2693 * - encoding: set by execute()
2694 * - decoding: set by execute()
2696 void *thread_opaque;
2699 * noise vs. sse weight for the nsse comparsion function
2700 * - encoding: Set by user.
2701 * - decoding: unused
2707 * - encoding: Set by user.
2708 * - decoding: Set by libavcodec.
2711 #define FF_PROFILE_UNKNOWN -99
2712 #define FF_PROFILE_RESERVED -100
2714 #define FF_PROFILE_AAC_MAIN 0
2715 #define FF_PROFILE_AAC_LOW 1
2716 #define FF_PROFILE_AAC_SSR 2
2717 #define FF_PROFILE_AAC_LTP 3
2718 #define FF_PROFILE_AAC_HE 4
2719 #define FF_PROFILE_AAC_HE_V2 28
2720 #define FF_PROFILE_AAC_LD 22
2721 #define FF_PROFILE_AAC_ELD 38
2723 #define FF_PROFILE_DTS 20
2724 #define FF_PROFILE_DTS_ES 30
2725 #define FF_PROFILE_DTS_96_24 40
2726 #define FF_PROFILE_DTS_HD_HRA 50
2727 #define FF_PROFILE_DTS_HD_MA 60
2729 #define FF_PROFILE_MPEG2_422 0
2730 #define FF_PROFILE_MPEG2_HIGH 1
2731 #define FF_PROFILE_MPEG2_SS 2
2732 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2733 #define FF_PROFILE_MPEG2_MAIN 4
2734 #define FF_PROFILE_MPEG2_SIMPLE 5
2736 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2737 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2739 #define FF_PROFILE_H264_BASELINE 66
2740 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2741 #define FF_PROFILE_H264_MAIN 77
2742 #define FF_PROFILE_H264_EXTENDED 88
2743 #define FF_PROFILE_H264_HIGH 100
2744 #define FF_PROFILE_H264_HIGH_10 110
2745 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2746 #define FF_PROFILE_H264_HIGH_422 122
2747 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2748 #define FF_PROFILE_H264_HIGH_444 144
2749 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2750 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2751 #define FF_PROFILE_H264_CAVLC_444 44
2753 #define FF_PROFILE_VC1_SIMPLE 0
2754 #define FF_PROFILE_VC1_MAIN 1
2755 #define FF_PROFILE_VC1_COMPLEX 2
2756 #define FF_PROFILE_VC1_ADVANCED 3
2758 #define FF_PROFILE_MPEG4_SIMPLE 0
2759 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2760 #define FF_PROFILE_MPEG4_CORE 2
2761 #define FF_PROFILE_MPEG4_MAIN 3
2762 #define FF_PROFILE_MPEG4_N_BIT 4
2763 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2764 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2765 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2766 #define FF_PROFILE_MPEG4_HYBRID 8
2767 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2768 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2769 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2770 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2771 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2772 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2773 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2777 * - encoding: Set by user.
2778 * - decoding: Set by libavcodec.
2781 #define FF_LEVEL_UNKNOWN -99
2785 * - encoding: unused
2786 * - decoding: Set by user.
2788 enum AVDiscard skip_loop_filter;
2792 * - encoding: unused
2793 * - decoding: Set by user.
2795 enum AVDiscard skip_idct;
2799 * - encoding: unused
2800 * - decoding: Set by user.
2802 enum AVDiscard skip_frame;
2805 * Header containing style information for text subtitles.
2806 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2807 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2808 * the Format line following. It shouldn't include any Dialogue line.
2809 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2810 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2812 uint8_t *subtitle_header;
2813 int subtitle_header_size;
2816 * Simulates errors in the bitstream to test error concealment.
2817 * - encoding: Set by user.
2818 * - decoding: unused
2823 * Current packet as passed into the decoder, to avoid having
2824 * to pass the packet into every function. Currently only valid
2825 * inside lavc and get/release_buffer callbacks.
2826 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2827 * - encoding: unused
2832 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2833 * Used for compliant TS muxing.
2834 * - encoding: Set by libavcodec.
2835 * - decoding: unused.
2843 typedef struct AVProfile {
2845 const char *name; ///< short name for the profile
2848 typedef struct AVCodecDefault AVCodecDefault;
2853 typedef struct AVCodec {
2855 * Name of the codec implementation.
2856 * The name is globally unique among encoders and among decoders (but an
2857 * encoder and a decoder can share the same name).
2858 * This is the primary way to find a codec from the user perspective.
2862 * Descriptive name for the codec, meant to be more human readable than name.
2863 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2865 const char *long_name;
2866 enum AVMediaType type;
2869 * Codec capabilities.
2873 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2874 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2875 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2876 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2877 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2878 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2879 const AVClass *priv_class; ///< AVClass for the private context
2880 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2882 /*****************************************************************
2883 * No fields below this line are part of the public API. They
2884 * may not be used outside of libavcodec and can be changed and
2886 * New public fields should be added right above.
2887 *****************************************************************
2890 struct AVCodec *next;
2892 * @name Frame-level threading support functions
2896 * If defined, called on thread contexts when they are created.
2897 * If the codec allocates writable tables in init(), re-allocate them here.
2898 * priv_data will be set to a copy of the original.
2900 int (*init_thread_copy)(AVCodecContext *);
2902 * Copy necessary context variables from a previous thread context to the current one.
2903 * If not defined, the next thread will start automatically; otherwise, the codec
2904 * must call ff_thread_finish_setup().
2906 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2908 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2912 * Private codec-specific defaults.
2914 const AVCodecDefault *defaults;
2917 * Initialize codec static data, called from avcodec_register().
2919 void (*init_static_data)(struct AVCodec *codec);
2921 int (*init)(AVCodecContext *);
2922 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2924 * Encode data to an AVPacket.
2926 * @param avctx codec context
2927 * @param avpkt output AVPacket (may contain a user-provided buffer)
2928 * @param[in] frame AVFrame containing the raw data to be encoded
2929 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2930 * non-empty packet was returned in avpkt.
2931 * @return 0 on success, negative error code on failure
2933 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2934 int *got_packet_ptr);
2935 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2936 int (*close)(AVCodecContext *);
2939 * Will be called when seeking
2941 void (*flush)(AVCodecContext *);
2947 typedef struct AVHWAccel {
2949 * Name of the hardware accelerated codec.
2950 * The name is globally unique among encoders and among decoders (but an
2951 * encoder and a decoder can share the same name).
2956 * Type of codec implemented by the hardware accelerator.
2958 * See AVMEDIA_TYPE_xxx
2960 enum AVMediaType type;
2963 * Codec implemented by the hardware accelerator.
2970 * Supported pixel format.
2972 * Only hardware accelerated formats are supported here.
2974 enum PixelFormat pix_fmt;
2977 * Hardware accelerated codec capabilities.
2978 * see FF_HWACCEL_CODEC_CAP_*
2982 struct AVHWAccel *next;
2985 * Called at the beginning of each frame or field picture.
2987 * Meaningful frame information (codec specific) is guaranteed to
2988 * be parsed at this point. This function is mandatory.
2990 * Note that buf can be NULL along with buf_size set to 0.
2991 * Otherwise, this means the whole frame is available at this point.
2993 * @param avctx the codec context
2994 * @param buf the frame data buffer base
2995 * @param buf_size the size of the frame in bytes
2996 * @return zero if successful, a negative value otherwise
2998 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3001 * Callback for each slice.
3003 * Meaningful slice information (codec specific) is guaranteed to
3004 * be parsed at this point. This function is mandatory.
3006 * @param avctx the codec context
3007 * @param buf the slice data buffer base
3008 * @param buf_size the size of the slice in bytes
3009 * @return zero if successful, a negative value otherwise
3011 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3014 * Called at the end of each frame or field picture.
3016 * The whole picture is parsed at this point and can now be sent
3017 * to the hardware accelerator. This function is mandatory.
3019 * @param avctx the codec context
3020 * @return zero if successful, a negative value otherwise
3022 int (*end_frame)(AVCodecContext *avctx);
3025 * Size of HW accelerator private data.
3027 * Private data is allocated with av_mallocz() before
3028 * AVCodecContext.get_buffer() and deallocated after
3029 * AVCodecContext.release_buffer().
3035 * @defgroup lavc_picture AVPicture
3037 * Functions for working with AVPicture
3042 * four components are given, that's all.
3043 * the last component is alpha
3045 typedef struct AVPicture {
3046 uint8_t *data[AV_NUM_DATA_POINTERS];
3047 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3054 #define AVPALETTE_SIZE 1024
3055 #define AVPALETTE_COUNT 256
3057 enum AVSubtitleType {
3060 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3063 * Plain text, the text field must be set by the decoder and is
3064 * authoritative. ass and pict fields may contain approximations.
3069 * Formatted text, the ass field must be set by the decoder and is
3070 * authoritative. pict and text fields may contain approximations.
3075 typedef struct AVSubtitleRect {
3076 int x; ///< top left corner of pict, undefined when pict is not set
3077 int y; ///< top left corner of pict, undefined when pict is not set
3078 int w; ///< width of pict, undefined when pict is not set
3079 int h; ///< height of pict, undefined when pict is not set
3080 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3083 * data+linesize for the bitmap of this subtitle.
3084 * can be set for text/ass as well once they where rendered
3087 enum AVSubtitleType type;
3089 char *text; ///< 0 terminated plain UTF-8 text
3092 * 0 terminated ASS/SSA compatible event line.
3093 * The pressentation of this is unaffected by the other values in this
3099 typedef struct AVSubtitle {
3100 uint16_t format; /* 0 = graphics */
3101 uint32_t start_display_time; /* relative to packet pts, in ms */
3102 uint32_t end_display_time; /* relative to packet pts, in ms */
3104 AVSubtitleRect **rects;
3105 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3109 * If c is NULL, returns the first registered codec,
3110 * if c is non-NULL, returns the next registered codec after c,
3111 * or NULL if c is the last one.
3113 AVCodec *av_codec_next(AVCodec *c);
3116 * Return the LIBAVCODEC_VERSION_INT constant.
3118 unsigned avcodec_version(void);
3121 * Return the libavcodec build-time configuration.
3123 const char *avcodec_configuration(void);
3126 * Return the libavcodec license.
3128 const char *avcodec_license(void);
3131 * Register the codec codec and initialize libavcodec.
3133 * @warning either this function or avcodec_register_all() must be called
3134 * before any other libavcodec functions.
3136 * @see avcodec_register_all()
3138 void avcodec_register(AVCodec *codec);
3141 * Register all the codecs, parsers and bitstream filters which were enabled at
3142 * configuration time. If you do not call this function you can select exactly
3143 * which formats you want to support, by using the individual registration
3146 * @see avcodec_register
3147 * @see av_register_codec_parser
3148 * @see av_register_bitstream_filter
3150 void avcodec_register_all(void);
3153 * Allocate an AVCodecContext and set its fields to default values. The
3154 * resulting struct can be deallocated by calling avcodec_close() on it followed
3157 * @param codec if non-NULL, allocate private data and initialize defaults
3158 * for the given codec. It is illegal to then call avcodec_open2()
3159 * with a different codec.
3160 * If NULL, then the codec-specific defaults won't be initialized,
3161 * which may result in suboptimal default settings (this is
3162 * important mainly for encoders, e.g. libx264).
3164 * @return An AVCodecContext filled with default values or NULL on failure.
3165 * @see avcodec_get_context_defaults
3167 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3170 * Set the fields of the given AVCodecContext to default values corresponding
3171 * to the given codec (defaults may be codec-dependent).
3173 * Do not call this function if a non-NULL codec has been passed
3174 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3175 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3176 * different codec on this AVCodecContext.
3178 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3181 * Get the AVClass for AVCodecContext. It can be used in combination with
3182 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3184 * @see av_opt_find().
3186 const AVClass *avcodec_get_class(void);
3189 * Copy the settings of the source AVCodecContext into the destination
3190 * AVCodecContext. The resulting destination codec context will be
3191 * unopened, i.e. you are required to call avcodec_open2() before you
3192 * can use this AVCodecContext to decode/encode video/audio data.
3194 * @param dest target codec context, should be initialized with
3195 * avcodec_alloc_context3(), but otherwise uninitialized
3196 * @param src source codec context
3197 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3199 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3202 * Allocate an AVFrame and set its fields to default values. The resulting
3203 * struct can be deallocated by simply calling av_free().
3205 * @return An AVFrame filled with default values or NULL on failure.
3206 * @see avcodec_get_frame_defaults
3208 AVFrame *avcodec_alloc_frame(void);
3211 * Set the fields of the given AVFrame to default values.
3213 * @param pic The AVFrame of which the fields should be set to default values.
3215 void avcodec_get_frame_defaults(AVFrame *pic);
3218 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3219 * function the context has to be allocated with avcodec_alloc_context3().
3221 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3222 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3223 * retrieving a codec.
3225 * @warning This function is not thread safe!
3228 * avcodec_register_all();
3229 * av_dict_set(&opts, "b", "2.5M", 0);
3230 * codec = avcodec_find_decoder(CODEC_ID_H264);
3234 * context = avcodec_alloc_context3(codec);
3236 * if (avcodec_open2(context, codec, opts) < 0)
3240 * @param avctx The context to initialize.
3241 * @param codec The codec to open this context for. If a non-NULL codec has been
3242 * previously passed to avcodec_alloc_context3() or
3243 * avcodec_get_context_defaults3() for this context, then this
3244 * parameter MUST be either NULL or equal to the previously passed
3246 * @param options A dictionary filled with AVCodecContext and codec-private options.
3247 * On return this object will be filled with options that were not found.
3249 * @return zero on success, a negative value on error
3250 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3251 * av_dict_set(), av_opt_find().
3253 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3256 * Close a given AVCodecContext and free all the data associated with it
3257 * (but not the AVCodecContext itself).
3259 * Calling this function on an AVCodecContext that hasn't been opened will free
3260 * the codec-specific data allocated in avcodec_alloc_context3() /
3261 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3264 int avcodec_close(AVCodecContext *avctx);
3267 * Free all allocated data in the given subtitle struct.
3269 * @param sub AVSubtitle to free.
3271 void avsubtitle_free(AVSubtitle *sub);
3278 * @addtogroup lavc_packet
3283 * @deprecated use NULL instead
3285 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3288 * Default packet destructor.
3290 void av_destruct_packet(AVPacket *pkt);
3293 * Initialize optional fields of a packet with default values.
3295 * Note, this does not touch the data and size members, which have to be
3296 * initialized separately.
3300 void av_init_packet(AVPacket *pkt);
3303 * Allocate the payload of a packet and initialize its fields with
3307 * @param size wanted payload size
3308 * @return 0 if OK, AVERROR_xxx otherwise
3310 int av_new_packet(AVPacket *pkt, int size);
3313 * Reduce packet size, correctly zeroing padding
3316 * @param size new size
3318 void av_shrink_packet(AVPacket *pkt, int size);
3321 * Increase packet size, correctly zeroing padding
3324 * @param grow_by number of bytes by which to increase the size of the packet
3326 int av_grow_packet(AVPacket *pkt, int grow_by);
3329 * @warning This is a hack - the packet memory allocation stuff is broken. The
3330 * packet is allocated if it was not really allocated.
3332 int av_dup_packet(AVPacket *pkt);
3337 * @param pkt packet to free
3339 void av_free_packet(AVPacket *pkt);
3342 * Allocate new information of a packet.
3345 * @param type side information type
3346 * @param size side information size
3347 * @return pointer to fresh allocated data or NULL otherwise
3349 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3353 * Shrink the already allocated side data buffer
3356 * @param type side information type
3357 * @param size new side information size
3358 * @return 0 on success, < 0 on failure
3360 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3364 * Get side information from packet.
3367 * @param type desired side information type
3368 * @param size pointer for side information size to store (optional)
3369 * @return pointer to data if present or NULL otherwise
3371 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3379 * @addtogroup lavc_decoding
3384 * Find a registered decoder with a matching codec ID.
3386 * @param id CodecID of the requested decoder
3387 * @return A decoder if one was found, NULL otherwise.
3389 AVCodec *avcodec_find_decoder(enum CodecID id);
3392 * Find a registered decoder with the specified name.
3394 * @param name name of the requested decoder
3395 * @return A decoder if one was found, NULL otherwise.
3397 AVCodec *avcodec_find_decoder_by_name(const char *name);
3399 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3400 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3401 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3404 * Return the amount of padding in pixels which the get_buffer callback must
3405 * provide around the edge of the image for codecs which do not have the
3406 * CODEC_FLAG_EMU_EDGE flag.
3408 * @return Required padding in pixels.
3410 unsigned avcodec_get_edge_width(void);
3413 * Modify width and height values so that they will result in a memory
3414 * buffer that is acceptable for the codec if you do not use any horizontal
3417 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3418 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3419 * according to avcodec_get_edge_width() before.
3421 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3424 * Modify width and height values so that they will result in a memory
3425 * buffer that is acceptable for the codec if you also ensure that all
3426 * line sizes are a multiple of the respective linesize_align[i].
3428 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3429 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3430 * according to avcodec_get_edge_width() before.
3432 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3433 int linesize_align[AV_NUM_DATA_POINTERS]);
3435 #if FF_API_OLD_DECODE_AUDIO
3437 * Wrapper function which calls avcodec_decode_audio4.
3439 * @deprecated Use avcodec_decode_audio4 instead.
3441 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3442 * Some decoders may support multiple frames in a single AVPacket, such
3443 * decoders would then just decode the first frame. In this case,
3444 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3445 * the remaining data in order to decode the second frame etc.
3447 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3448 * decompressed frame size in bytes.
3450 * @warning You must set frame_size_ptr to the allocated size of the
3451 * output buffer before calling avcodec_decode_audio3().
3453 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3454 * the actual read bytes because some optimized bitstream readers read 32 or 64
3455 * bits at once and could read over the end.
3457 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3458 * no overreading happens for damaged MPEG streams.
3460 * @warning You must not provide a custom get_buffer() when using
3461 * avcodec_decode_audio3(). Doing so will override it with
3462 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3463 * which does allow the application to provide a custom get_buffer().
3465 * @note You might have to align the input buffer avpkt->data and output buffer
3466 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3467 * necessary at all, on others it won't work at all if not aligned and on others
3468 * it will work but it will have an impact on performance.
3470 * In practice, avpkt->data should have 4 byte alignment at minimum and
3471 * samples should be 16 byte aligned unless the CPU doesn't need it
3472 * (AltiVec and SSE do).
3474 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3475 * between input and output, these need to be fed with avpkt->data=NULL,
3476 * avpkt->size=0 at the end to return the remaining frames.
3478 * @param avctx the codec context
3479 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3480 * If the sample format is planar, each channel plane will
3481 * be the same size, with no padding between channels.
3482 * @param[in,out] frame_size_ptr the output buffer size in bytes
3483 * @param[in] avpkt The input AVPacket containing the input buffer.
3484 * You can create such packet with av_init_packet() and by then setting
3485 * data and size, some decoders might in addition need other fields.
3486 * All decoders are designed to use the least fields possible though.
3487 * @return On error a negative value is returned, otherwise the number of bytes
3488 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3490 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3491 int *frame_size_ptr,
3496 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3498 * Some decoders may support multiple frames in a single AVPacket. Such
3499 * decoders would then just decode the first frame. In this case,
3500 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3501 * the remaining data in order to decode the second frame, etc...
3502 * Even if no frames are returned, the packet needs to be fed to the decoder
3503 * with remaining data until it is completely consumed or an error occurs.
3505 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3506 * larger than the actual read bytes because some optimized bitstream
3507 * readers read 32 or 64 bits at once and could read over the end.
3509 * @note You might have to align the input buffer. The alignment requirements
3510 * depend on the CPU and the decoder.
3512 * @param avctx the codec context
3513 * @param[out] frame The AVFrame in which to store decoded audio samples.
3514 * Decoders request a buffer of a particular size by setting
3515 * AVFrame.nb_samples prior to calling get_buffer(). The
3516 * decoder may, however, only utilize part of the buffer by
3517 * setting AVFrame.nb_samples to a smaller value in the
3519 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3521 * @param[in] avpkt The input AVPacket containing the input buffer.
3522 * At least avpkt->data and avpkt->size should be set. Some
3523 * decoders might also require additional fields to be set.
3524 * @return A negative error code is returned if an error occurred during
3525 * decoding, otherwise the number of bytes consumed from the input
3526 * AVPacket is returned.
3528 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3529 int *got_frame_ptr, AVPacket *avpkt);
3532 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3533 * Some decoders may support multiple frames in a single AVPacket, such
3534 * decoders would then just decode the first frame.
3536 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3537 * the actual read bytes because some optimized bitstream readers read 32 or 64
3538 * bits at once and could read over the end.
3540 * @warning The end of the input buffer buf should be set to 0 to ensure that
3541 * no overreading happens for damaged MPEG streams.
3543 * @note You might have to align the input buffer avpkt->data.
3544 * The alignment requirements depend on the CPU: on some CPUs it isn't
3545 * necessary at all, on others it won't work at all if not aligned and on others
3546 * it will work but it will have an impact on performance.
3548 * In practice, avpkt->data should have 4 byte alignment at minimum.
3550 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3551 * between input and output, these need to be fed with avpkt->data=NULL,
3552 * avpkt->size=0 at the end to return the remaining frames.
3554 * @param avctx the codec context
3555 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3556 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3557 * allocate memory for the actual bitmap.
3558 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3559 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3560 * decodes and the decoder tells the user once it does not need the data anymore,
3561 * the user app can at this point free/reuse/keep the memory as it sees fit.
3563 * @param[in] avpkt The input AVpacket containing the input buffer.
3564 * You can create such packet with av_init_packet() and by then setting
3565 * data and size, some decoders might in addition need other fields like
3566 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3568 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3569 * @return On error a negative value is returned, otherwise the number of bytes
3570 * used or zero if no frame could be decompressed.
3572 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3573 int *got_picture_ptr,
3577 * Decode a subtitle message.
3578 * Return a negative value on error, otherwise return the number of bytes used.
3579 * If no subtitle could be decompressed, got_sub_ptr is zero.
3580 * Otherwise, the subtitle is stored in *sub.
3581 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3582 * simplicity, because the performance difference is expect to be negligible
3583 * and reusing a get_buffer written for video codecs would probably perform badly
3584 * due to a potentially very different allocation pattern.
3586 * @param avctx the codec context
3587 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3588 freed with avsubtitle_free if *got_sub_ptr is set.
3589 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3590 * @param[in] avpkt The input AVPacket containing the input buffer.
3592 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3597 * @defgroup lavc_parsing Frame parsing
3601 typedef struct AVCodecParserContext {
3603 struct AVCodecParser *parser;
3604 int64_t frame_offset; /* offset of the current frame */
3605 int64_t cur_offset; /* current offset
3606 (incremented by each av_parser_parse()) */
3607 int64_t next_frame_offset; /* offset of the next frame */
3609 int pict_type; /* XXX: Put it back in AVCodecContext. */
3611 * This field is used for proper frame duration computation in lavf.
3612 * It signals, how much longer the frame duration of the current frame
3613 * is compared to normal frame duration.
3615 * frame_duration = (1 + repeat_pict) * time_base
3617 * It is used by codecs like H.264 to display telecined material.
3619 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3620 int64_t pts; /* pts of the current frame */
3621 int64_t dts; /* dts of the current frame */
3626 int fetch_timestamp;
3628 #define AV_PARSER_PTS_NB 4
3629 int cur_frame_start_index;
3630 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3631 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3632 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3635 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3636 #define PARSER_FLAG_ONCE 0x0002
3637 /// Set if the parser has a valid file offset
3638 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3640 int64_t offset; ///< byte offset from starting packet start
3641 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3644 * Set by parser to 1 for key frames and 0 for non-key frames.
3645 * It is initialized to -1, so if the parser doesn't set this flag,
3646 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3652 * Time difference in stream time base units from the pts of this
3653 * packet to the point at which the output from the decoder has converged
3654 * independent from the availability of previous frames. That is, the
3655 * frames are virtually identical no matter if decoding started from
3656 * the very first frame or from this keyframe.
3657 * Is AV_NOPTS_VALUE if unknown.
3658 * This field is not the display duration of the current frame.
3659 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3662 * The purpose of this field is to allow seeking in streams that have no
3663 * keyframes in the conventional sense. It corresponds to the
3664 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3665 * essential for some types of subtitle streams to ensure that all
3666 * subtitles are correctly displayed after seeking.
3668 int64_t convergence_duration;
3670 // Timestamp generation support:
3672 * Synchronization point for start of timestamp generation.
3674 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3677 * For example, this corresponds to presence of H.264 buffering period
3683 * Offset of the current timestamp against last timestamp sync point in
3684 * units of AVCodecContext.time_base.
3686 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3687 * contain a valid timestamp offset.
3689 * Note that the timestamp of sync point has usually a nonzero
3690 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3691 * the next frame after timestamp sync point will be usually 1.
3693 * For example, this corresponds to H.264 cpb_removal_delay.
3695 int dts_ref_dts_delta;
3698 * Presentation delay of current frame in units of AVCodecContext.time_base.
3700 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3701 * contain valid non-negative timestamp delta (presentation time of a frame
3702 * must not lie in the past).
3704 * This delay represents the difference between decoding and presentation
3705 * time of the frame.
3707 * For example, this corresponds to H.264 dpb_output_delay.
3712 * Position of the packet in file.
3714 * Analogous to cur_frame_pts/dts
3716 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3719 * Byte position of currently parsed frame in stream.
3724 * Previous frame byte position.
3729 * Duration of the current frame.
3730 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3731 * For all other types, this is in units of AVCodecContext.time_base.
3734 } AVCodecParserContext;
3736 typedef struct AVCodecParser {
3737 int codec_ids[5]; /* several codec IDs are permitted */
3739 int (*parser_init)(AVCodecParserContext *s);
3740 int (*parser_parse)(AVCodecParserContext *s,
3741 AVCodecContext *avctx,
3742 const uint8_t **poutbuf, int *poutbuf_size,
3743 const uint8_t *buf, int buf_size);
3744 void (*parser_close)(AVCodecParserContext *s);
3745 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3746 struct AVCodecParser *next;
3749 AVCodecParser *av_parser_next(AVCodecParser *c);
3751 void av_register_codec_parser(AVCodecParser *parser);
3752 AVCodecParserContext *av_parser_init(int codec_id);
3757 * @param s parser context.
3758 * @param avctx codec context.
3759 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3760 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3761 * @param buf input buffer.
3762 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3763 * @param pts input presentation timestamp.
3764 * @param dts input decoding timestamp.
3765 * @param pos input byte position in stream.
3766 * @return the number of bytes of the input bitstream used.
3771 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3778 * decode_frame(data, size);
3782 int av_parser_parse2(AVCodecParserContext *s,
3783 AVCodecContext *avctx,
3784 uint8_t **poutbuf, int *poutbuf_size,
3785 const uint8_t *buf, int buf_size,
3786 int64_t pts, int64_t dts,
3789 int av_parser_change(AVCodecParserContext *s,
3790 AVCodecContext *avctx,
3791 uint8_t **poutbuf, int *poutbuf_size,
3792 const uint8_t *buf, int buf_size, int keyframe);
3793 void av_parser_close(AVCodecParserContext *s);
3801 * @addtogroup lavc_encoding
3806 * Find a registered encoder with a matching codec ID.
3808 * @param id CodecID of the requested encoder
3809 * @return An encoder if one was found, NULL otherwise.
3811 AVCodec *avcodec_find_encoder(enum CodecID id);
3814 * Find a registered encoder with the specified name.
3816 * @param name name of the requested encoder
3817 * @return An encoder if one was found, NULL otherwise.
3819 AVCodec *avcodec_find_encoder_by_name(const char *name);
3821 #if FF_API_OLD_ENCODE_AUDIO
3823 * Encode an audio frame from samples into buf.
3825 * @deprecated Use avcodec_encode_audio2 instead.
3827 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3828 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3829 * will know how much space is needed because it depends on the value passed
3830 * in buf_size as described below. In that case a lower value can be used.
3832 * @param avctx the codec context
3833 * @param[out] buf the output buffer
3834 * @param[in] buf_size the output buffer size
3835 * @param[in] samples the input buffer containing the samples
3836 * The number of samples read from this buffer is frame_size*channels,
3837 * both of which are defined in avctx.
3838 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3839 * samples read from samples is equal to:
3840 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3841 * This also implies that av_get_bits_per_sample() must not return 0 for these
3843 * @return On error a negative value is returned, on success zero or the number
3844 * of bytes used to encode the data read from the input buffer.
3846 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3847 uint8_t *buf, int buf_size,
3848 const short *samples);
3852 * Encode a frame of audio.
3854 * Takes input samples from frame and writes the next output packet, if
3855 * available, to avpkt. The output packet does not necessarily contain data for
3856 * the most recent frame, as encoders can delay, split, and combine input frames
3857 * internally as needed.
3859 * @param avctx codec context
3860 * @param avpkt output AVPacket.
3861 * The user can supply an output buffer by setting
3862 * avpkt->data and avpkt->size prior to calling the
3863 * function, but if the size of the user-provided data is not
3864 * large enough, encoding will fail. All other AVPacket fields
3865 * will be reset by the encoder using av_init_packet(). If
3866 * avpkt->data is NULL, the encoder will allocate it.
3867 * The encoder will set avpkt->size to the size of the
3870 * If this function fails or produces no output, avpkt will be
3871 * freed using av_free_packet() (i.e. avpkt->destruct will be
3872 * called to free the user supplied buffer).
3873 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3874 * May be NULL when flushing an encoder that has the
3875 * CODEC_CAP_DELAY capability set.
3876 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3877 * can have any number of samples.
3878 * If it is not set, frame->nb_samples must be equal to
3879 * avctx->frame_size for all frames except the last.
3880 * The final frame may be smaller than avctx->frame_size.
3881 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3882 * output packet is non-empty, and to 0 if it is
3883 * empty. If the function returns an error, the
3884 * packet can be assumed to be invalid, and the
3885 * value of got_packet_ptr is undefined and should
3887 * @return 0 on success, negative error code on failure
3889 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3890 const AVFrame *frame, int *got_packet_ptr);
3892 #if FF_API_OLD_ENCODE_VIDEO
3894 * @deprecated use avcodec_encode_video2() instead.
3896 * Encode a video frame from pict into buf.
3897 * The input picture should be
3898 * stored using a specific format, namely avctx.pix_fmt.
3900 * @param avctx the codec context
3901 * @param[out] buf the output buffer for the bitstream of encoded frame
3902 * @param[in] buf_size the size of the output buffer in bytes
3903 * @param[in] pict the input picture to encode
3904 * @return On error a negative value is returned, on success zero or the number
3905 * of bytes used from the output buffer.
3907 attribute_deprecated
3908 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3909 const AVFrame *pict);
3913 * Encode a frame of video.
3915 * Takes input raw video data from frame and writes the next output packet, if
3916 * available, to avpkt. The output packet does not necessarily contain data for
3917 * the most recent frame, as encoders can delay and reorder input frames
3918 * internally as needed.
3920 * @param avctx codec context
3921 * @param avpkt output AVPacket.
3922 * The user can supply an output buffer by setting
3923 * avpkt->data and avpkt->size prior to calling the
3924 * function, but if the size of the user-provided data is not
3925 * large enough, encoding will fail. All other AVPacket fields
3926 * will be reset by the encoder using av_init_packet(). If
3927 * avpkt->data is NULL, the encoder will allocate it.
3928 * The encoder will set avpkt->size to the size of the
3929 * output packet. The returned data (if any) belongs to the
3930 * caller, he is responsible for freeing it.
3932 * If this function fails or produces no output, avpkt will be
3933 * freed using av_free_packet() (i.e. avpkt->destruct will be
3934 * called to free the user supplied buffer).
3935 * @param[in] frame AVFrame containing the raw video data to be encoded.
3936 * May be NULL when flushing an encoder that has the
3937 * CODEC_CAP_DELAY capability set.
3938 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3939 * output packet is non-empty, and to 0 if it is
3940 * empty. If the function returns an error, the
3941 * packet can be assumed to be invalid, and the
3942 * value of got_packet_ptr is undefined and should
3944 * @return 0 on success, negative error code on failure
3946 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3947 const AVFrame *frame, int *got_packet_ptr);
3949 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3950 const AVSubtitle *sub);
3958 * @defgroup lavc_resample Audio resampling
3963 struct ReSampleContext;
3964 struct AVResampleContext;
3966 typedef struct ReSampleContext ReSampleContext;
3969 * Initialize audio resampling context.
3971 * @param output_channels number of output channels
3972 * @param input_channels number of input channels
3973 * @param output_rate output sample rate
3974 * @param input_rate input sample rate
3975 * @param sample_fmt_out requested output sample format
3976 * @param sample_fmt_in input sample format
3977 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3978 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3979 * @param linear if 1 then the used FIR filter will be linearly interpolated
3980 between the 2 closest, if 0 the closest will be used
3981 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3982 * @return allocated ReSampleContext, NULL if error occurred
3984 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3985 int output_rate, int input_rate,
3986 enum AVSampleFormat sample_fmt_out,
3987 enum AVSampleFormat sample_fmt_in,
3988 int filter_length, int log2_phase_count,
3989 int linear, double cutoff);
3991 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3994 * Free resample context.
3996 * @param s a non-NULL pointer to a resample context previously
3997 * created with av_audio_resample_init()
3999 void audio_resample_close(ReSampleContext *s);
4003 * Initialize an audio resampler.
4004 * Note, if either rate is not an integer then simply scale both rates up so they are.
4005 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4006 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4007 * @param linear If 1 then the used FIR filter will be linearly interpolated
4008 between the 2 closest, if 0 the closest will be used
4009 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4011 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4014 * Resample an array of samples using a previously configured context.
4015 * @param src an array of unconsumed samples
4016 * @param consumed the number of samples of src which have been consumed are returned here
4017 * @param src_size the number of unconsumed samples available
4018 * @param dst_size the amount of space in samples available in dst
4019 * @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.
4020 * @return the number of samples written in dst or -1 if an error occurred
4022 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4026 * Compensate samplerate/timestamp drift. The compensation is done by changing
4027 * the resampler parameters, so no audible clicks or similar distortions occur
4028 * @param compensation_distance distance in output samples over which the compensation should be performed
4029 * @param sample_delta number of output samples which should be output less
4031 * example: av_resample_compensate(c, 10, 500)
4032 * here instead of 510 samples only 500 samples would be output
4034 * note, due to rounding the actual compensation might be slightly different,
4035 * especially if the compensation_distance is large and the in_rate used during init is small
4037 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4038 void av_resample_close(struct AVResampleContext *c);
4045 * @addtogroup lavc_picture
4050 * Allocate memory for a picture. Call avpicture_free() to free it.
4052 * @see avpicture_fill()
4054 * @param picture the picture to be filled in
4055 * @param pix_fmt the format of the picture
4056 * @param width the width of the picture
4057 * @param height the height of the picture
4058 * @return zero if successful, a negative value if not
4060 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
4063 * Free a picture previously allocated by avpicture_alloc().
4064 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4067 * @param picture the AVPicture to be freed
4069 void avpicture_free(AVPicture *picture);
4072 * Fill in the AVPicture fields.
4073 * The fields of the given AVPicture are filled in by using the 'ptr' address
4074 * which points to the image data buffer. Depending on the specified picture
4075 * format, one or multiple image data pointers and line sizes will be set.
4076 * If a planar format is specified, several pointers will be set pointing to
4077 * the different picture planes and the line sizes of the different planes
4078 * will be stored in the lines_sizes array.
4079 * Call with ptr == NULL to get the required size for the ptr buffer.
4081 * To allocate the buffer and fill in the AVPicture fields in one call,
4082 * use avpicture_alloc().
4084 * @param picture AVPicture whose fields are to be filled in
4085 * @param ptr Buffer which will contain or contains the actual image data
4086 * @param pix_fmt The format in which the picture data is stored.
4087 * @param width the width of the image in pixels
4088 * @param height the height of the image in pixels
4089 * @return size of the image data in bytes
4091 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4092 enum PixelFormat pix_fmt, int width, int height);
4095 * Copy pixel data from an AVPicture into a buffer.
4096 * The data is stored compactly, without any gaps for alignment or padding
4097 * which may be applied by avpicture_fill().
4099 * @see avpicture_get_size()
4101 * @param[in] src AVPicture containing image data
4102 * @param[in] pix_fmt The format in which the picture data is stored.
4103 * @param[in] width the width of the image in pixels.
4104 * @param[in] height the height of the image in pixels.
4105 * @param[out] dest A buffer into which picture data will be copied.
4106 * @param[in] dest_size The size of 'dest'.
4107 * @return The number of bytes written to dest, or a negative value (error code) on error.
4109 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
4110 unsigned char *dest, int dest_size);
4113 * Calculate the size in bytes that a picture of the given width and height
4114 * would occupy if stored in the given picture format.
4115 * Note that this returns the size of a compact representation as generated
4116 * by avpicture_layout(), which can be smaller than the size required for e.g.
4119 * @param pix_fmt the given picture format
4120 * @param width the width of the image
4121 * @param height the height of the image
4122 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
4124 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
4127 * deinterlace - if not supported return -1
4129 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4130 enum PixelFormat pix_fmt, int width, int height);
4132 * Copy image src to dst. Wraps av_picture_data_copy() above.
4134 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4135 enum PixelFormat pix_fmt, int width, int height);
4138 * Crop image top and left side.
4140 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4141 enum PixelFormat pix_fmt, int top_band, int left_band);
4146 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4147 int padtop, int padbottom, int padleft, int padright, int *color);
4154 * @defgroup lavc_misc Utility functions
4157 * Miscellaneous utility functions related to both encoding and decoding
4163 * @defgroup lavc_misc_pixfmt Pixel formats
4165 * Functions for working with pixel formats.
4169 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
4172 * Return a value representing the fourCC code associated to the
4173 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4176 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
4178 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4179 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4180 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4181 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4182 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4183 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4186 * Compute what kind of losses will occur when converting from one specific
4187 * pixel format to another.
4188 * When converting from one pixel format to another, information loss may occur.
4189 * For example, when converting from RGB24 to GRAY, the color information will
4190 * be lost. Similarly, other losses occur when converting from some formats to
4191 * other formats. These losses can involve loss of chroma, but also loss of
4192 * resolution, loss of color depth, loss due to the color space conversion, loss
4193 * of the alpha bits or loss due to color quantization.
4194 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4195 * which will occur when converting from one pixel format to another.
4197 * @param[in] dst_pix_fmt destination pixel format
4198 * @param[in] src_pix_fmt source pixel format
4199 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4200 * @return Combination of flags informing you what kind of losses will occur.
4202 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
4206 * Find the best pixel format to convert to given a certain source pixel
4207 * format. When converting from one pixel format to another, information loss
4208 * may occur. For example, when converting from RGB24 to GRAY, the color
4209 * information will be lost. Similarly, other losses occur when converting from
4210 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4211 * the given pixel formats should be used to suffer the least amount of loss.
4212 * The pixel formats from which it chooses one, are determined by the
4213 * pix_fmt_mask parameter.
4216 * src_pix_fmt = PIX_FMT_YUV420P;
4217 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
4218 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4221 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4222 * @param[in] src_pix_fmt source pixel format
4223 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4224 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4225 * @return The best pixel format to convert to or -1 if none was found.
4227 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
4228 int has_alpha, int *loss_ptr);
4230 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4236 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4239 * Put a string representing the codec tag codec_tag in buf.
4241 * @param buf_size size in bytes of buf
4242 * @return the length of the string that would have been generated if
4243 * enough space had been available, excluding the trailing null
4245 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4247 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4250 * Return a name for the specified profile, if available.
4252 * @param codec the codec that is searched for the given profile
4253 * @param profile the profile value for which a name is requested
4254 * @return A name for the profile if found, NULL otherwise.
4256 const char *av_get_profile_name(const AVCodec *codec, int profile);
4258 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4259 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4260 //FIXME func typedef
4263 * Fill audio frame data and linesize.
4264 * AVFrame extended_data channel pointers are allocated if necessary for
4267 * @param frame the AVFrame
4268 * frame->nb_samples must be set prior to calling the
4269 * function. This function fills in frame->data,
4270 * frame->extended_data, frame->linesize[0].
4271 * @param nb_channels channel count
4272 * @param sample_fmt sample format
4273 * @param buf buffer to use for frame data
4274 * @param buf_size size of buffer
4275 * @param align plane size sample alignment (0 = default)
4276 * @return 0 on success, negative error code on failure
4278 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4279 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4280 int buf_size, int align);
4283 * Flush buffers, should be called when seeking or when switching to a different stream.
4285 void avcodec_flush_buffers(AVCodecContext *avctx);
4287 void avcodec_default_free_buffers(AVCodecContext *s);
4290 * Return codec bits per sample.
4292 * @param[in] codec_id the codec
4293 * @return Number of bits per sample or zero if unknown for the given codec.
4295 int av_get_bits_per_sample(enum CodecID codec_id);
4298 * Return codec bits per sample.
4299 * Only return non-zero if the bits per sample is exactly correct, not an
4302 * @param[in] codec_id the codec
4303 * @return Number of bits per sample or zero if unknown for the given codec.
4305 int av_get_exact_bits_per_sample(enum CodecID codec_id);
4308 * Return audio frame duration.
4310 * @param avctx codec context
4311 * @param frame_bytes size of the frame, or 0 if unknown
4312 * @return frame duration, in samples, if known. 0 if not able to
4315 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4318 typedef struct AVBitStreamFilterContext {
4320 struct AVBitStreamFilter *filter;
4321 AVCodecParserContext *parser;
4322 struct AVBitStreamFilterContext *next;
4323 } AVBitStreamFilterContext;
4326 typedef struct AVBitStreamFilter {
4329 int (*filter)(AVBitStreamFilterContext *bsfc,
4330 AVCodecContext *avctx, const char *args,
4331 uint8_t **poutbuf, int *poutbuf_size,
4332 const uint8_t *buf, int buf_size, int keyframe);
4333 void (*close)(AVBitStreamFilterContext *bsfc);
4334 struct AVBitStreamFilter *next;
4335 } AVBitStreamFilter;
4337 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4338 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4339 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4340 AVCodecContext *avctx, const char *args,
4341 uint8_t **poutbuf, int *poutbuf_size,
4342 const uint8_t *buf, int buf_size, int keyframe);
4343 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4345 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4350 * Reallocate the given block if it is not large enough, otherwise do nothing.
4354 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4357 * Allocate a buffer, reusing the given one if large enough.
4359 * Contrary to av_fast_realloc the current buffer contents might not be
4360 * preserved and on error the old buffer is freed, thus no special
4361 * handling to avoid memleaks is necessary.
4363 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4364 * @param size size of the buffer *ptr points to
4365 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4366 * *size 0 if an error occurred.
4368 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4371 * Allocate a buffer with padding, reusing the given one if large enough.
4373 * Same behaviour av_fast_malloc but the buffer has additional
4374 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4377 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4380 * Encode extradata length to a buffer. Used by xiph codecs.
4382 * @param s buffer to write to; must be at least (v/255+1) bytes long
4383 * @param v size of extradata in bytes
4384 * @return number of bytes written to the buffer.
4386 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4389 * Log a generic warning message about a missing feature. This function is
4390 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4391 * only, and would normally not be used by applications.
4392 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4393 * a pointer to an AVClass struct
4394 * @param[in] feature string containing the name of the missing feature
4395 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4396 * If want_sample is non-zero, additional verbage will be added to the log
4397 * message which tells the user how to report samples to the development
4400 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4403 * Log a generic warning message asking for a sample. This function is
4404 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4405 * only, and would normally not be used by applications.
4406 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4407 * a pointer to an AVClass struct
4408 * @param[in] msg string containing an optional message, or NULL if no message
4410 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4413 * Register the hardware accelerator hwaccel.
4415 void av_register_hwaccel(AVHWAccel *hwaccel);
4418 * If hwaccel is NULL, returns the first registered hardware accelerator,
4419 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4420 * after hwaccel, or NULL if hwaccel is the last one.
4422 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4426 * Lock operation used by lockmgr
4429 AV_LOCK_CREATE, ///< Create a mutex
4430 AV_LOCK_OBTAIN, ///< Lock the mutex
4431 AV_LOCK_RELEASE, ///< Unlock the mutex
4432 AV_LOCK_DESTROY, ///< Free mutex resources
4436 * Register a user provided lock manager supporting the operations
4437 * specified by AVLockOp. mutex points to a (void *) where the
4438 * lockmgr should store/get a pointer to a user allocated mutex. It's
4439 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4441 * @param cb User defined callback. Note: Libav may invoke calls to this
4442 * callback during the call to av_lockmgr_register().
4443 * Thus, the application must be prepared to handle that.
4444 * If cb is set to NULL the lockmgr will be unregistered.
4445 * Also note that during unregistration the previously registered
4446 * lockmgr callback may also be invoked.
4448 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4451 * Get the type of the given codec.
4453 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4456 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4457 * with no corresponding avcodec_close()), 0 otherwise.
4459 int avcodec_is_open(AVCodecContext *s);
4462 * @return a non-zero number if codec is an encoder, zero otherwise
4464 int av_codec_is_encoder(AVCodec *codec);
4467 * @return a non-zero number if codec is a decoder, zero otherwise
4469 int av_codec_is_decoder(AVCodec *codec);
4475 #endif /* AVCODEC_AVCODEC_H */