2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/log.h"
40 #include "libavutil/pixfmt.h"
41 #include "libavutil/rational.h"
46 * @defgroup libavc Encoding/Decoding Library
49 * @defgroup lavc_decoding Decoding
53 * @defgroup lavc_encoding Encoding
57 * @defgroup lavc_codec Codecs
59 * @defgroup lavc_codec_native Native Codecs
62 * @defgroup lavc_codec_wrappers External library wrappers
65 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
69 * @defgroup lavc_internal Internal
77 * @defgroup lavc_encdec send/receive encoding and decoding API overview
80 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
81 * avcodec_receive_packet() functions provide an encode/decode API, which
82 * decouples input and output.
84 * The API is very similar for encoding/decoding and audio/video, and works as
86 * - Set up and open the AVCodecContext as usual.
88 * - For decoding, call avcodec_send_packet() to give the decoder raw
89 * compressed data in an AVPacket.
90 * - For encoding, call avcodec_send_frame() to give the decoder an AVFrame
91 * containing uncompressed audio or video.
92 * In both cases, it is recommended that AVPackets and AVFrames are
93 * refcounted, or libavcodec might have to copy the input data. (libavformat
94 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
95 * refcounted AVFrames.)
96 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
97 * functions and process their output:
98 * - For decoding, call avcodec_receive_frame(). On success, it will return
99 * an AVFrame containing uncompressed audio or video data.
100 * - For encoding, call avcodec_receive_packet(). On success, it will return
101 * an AVPacket with a compressed frame.
102 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
103 * AVERROR(EAGAIN) return value means that new input data is required to
104 * return new output. In this case, continue with sending input. For each
105 * input frame/packet, the codec will typically return 1 output frame/packet,
106 * but it can also be 0 or more than 1.
108 * At the beginning of decoding or encoding, the codec might accept multiple
109 * input frames/packets without returning a frame, until its internal buffers
110 * are filled. This situation is handled transparently if you follow the steps
113 * End of stream situations. These require "flushing" (aka draining) the codec,
114 * as the codec might buffer multiple frames or packets internally for
115 * performance or out of necessity (consider B-frames).
116 * This is handled as follows:
117 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
118 * or avcodec_send_frame() (encoding) functions. This will enter draining
120 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
121 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
122 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
123 * - Before decoding can be resumed again, the codec has to be reset with
124 * avcodec_flush_buffers().
126 * Using the API as outlined above is highly recommended. But it is also
127 * possible to call functions outside of this rigid schema. For example, you can
128 * call avcodec_send_packet() repeatedly without calling
129 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
130 * until the codec's internal buffer has been filled up (which is typically of
131 * size 1 per output frame, after initial input), and then reject input with
132 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
133 * read at least some output.
135 * Not all codecs will follow a rigid and predictable dataflow; the only
136 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
137 * one end implies that a receive/send call on the other end will succeed. In
138 * general, no codec will permit unlimited buffering of input or output.
140 * This API replaces the following legacy functions:
141 * - avcodec_decode_video2() and avcodec_decode_audio4():
142 * Use avcodec_send_packet() to feed input to the decoder, then use
143 * avcodec_receive_frame() to receive decoded frames after each packet.
144 * Unlike with the old video decoding API, multiple frames might result from
145 * a packet. For audio, splitting the input packet into frames by partially
146 * decoding packets becomes transparent to the API user. You never need to
147 * feed an AVPacket to the API twice.
148 * Additionally, sending a flush/draining packet is required only once.
149 * - avcodec_encode_video2()/avcodec_encode_audio2():
150 * Use avcodec_send_frame() to feed input to the encoder, then use
151 * avcodec_receive_packet() to receive encoded packets.
152 * Providing user-allocated buffers for avcodec_receive_packet() is not
154 * - The new API does not handle subtitles yet.
156 * Mixing new and old function calls on the same AVCodecContext is not allowed,
157 * and will result in undefined behavior.
159 * Some codecs might require using the new API; using the old API will return
160 * an error when calling it.
165 * @defgroup lavc_core Core functions/structures.
168 * Basic definitions, functions for querying libavcodec capabilities,
169 * allocating core structures, etc.
175 * Identify the syntax and semantics of the bitstream.
176 * The principle is roughly:
177 * Two decoders with the same ID can decode the same streams.
178 * Two encoders with the same ID can encode compatible streams.
179 * There may be slight deviations from the principle due to implementation
182 * If you add a codec ID to this list, add it so that
183 * 1. no value of an existing codec ID changes (that would break ABI),
184 * 2. it is as close as possible to similar codecs
186 * After adding new codec IDs, do not forget to add an entry to the codec
187 * descriptor list and bump libavcodec minor version.
193 AV_CODEC_ID_MPEG1VIDEO,
194 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
196 AV_CODEC_ID_MPEG2VIDEO_XVMC,
197 #endif /* FF_API_XVMC */
208 AV_CODEC_ID_RAWVIDEO,
209 AV_CODEC_ID_MSMPEG4V1,
210 AV_CODEC_ID_MSMPEG4V2,
211 AV_CODEC_ID_MSMPEG4V3,
234 AV_CODEC_ID_INTERPLAY_VIDEO,
241 AV_CODEC_ID_MSVIDEO1,
246 AV_CODEC_ID_TRUEMOTION1,
247 AV_CODEC_ID_VMDVIDEO,
272 AV_CODEC_ID_TRUEMOTION2,
278 AV_CODEC_ID_SMACKVIDEO,
283 AV_CODEC_ID_JPEG2000,
289 AV_CODEC_ID_DSICINVIDEO,
290 AV_CODEC_ID_TIERTEXSEQVIDEO,
298 AV_CODEC_ID_BETHSOFTVID,
310 AV_CODEC_ID_ESCAPE124,
314 AV_CODEC_ID_MOTIONPIXELS,
326 AV_CODEC_ID_FLASHSV2,
327 AV_CODEC_ID_CDGRAPHICS,
330 AV_CODEC_ID_BINKVIDEO,
331 AV_CODEC_ID_IFF_ILBM,
332 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
338 AV_CODEC_ID_A64_MULTI,
339 AV_CODEC_ID_A64_MULTI5,
342 AV_CODEC_ID_LAGARITH,
346 AV_CODEC_ID_WMV3IMAGE,
347 AV_CODEC_ID_VC1IMAGE,
349 AV_CODEC_ID_BMV_VIDEO,
356 AV_CODEC_ID_ZEROCODEC,
365 AV_CODEC_ID_ESCAPE130,
368 AV_CODEC_ID_HNM4_VIDEO,
370 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
372 AV_CODEC_ID_ALIAS_PIX,
373 AV_CODEC_ID_BRENDER_PIX,
374 AV_CODEC_ID_PAF_VIDEO,
387 AV_CODEC_ID_SCREENPRESSO,
390 AV_CODEC_ID_Y41P = 0x8000,
395 AV_CODEC_ID_TARGA_Y216,
407 AV_CODEC_ID_TRUEMOTION2RT,
409 /* various PCM "codecs" */
410 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
411 AV_CODEC_ID_PCM_S16LE = 0x10000,
412 AV_CODEC_ID_PCM_S16BE,
413 AV_CODEC_ID_PCM_U16LE,
414 AV_CODEC_ID_PCM_U16BE,
417 AV_CODEC_ID_PCM_MULAW,
418 AV_CODEC_ID_PCM_ALAW,
419 AV_CODEC_ID_PCM_S32LE,
420 AV_CODEC_ID_PCM_S32BE,
421 AV_CODEC_ID_PCM_U32LE,
422 AV_CODEC_ID_PCM_U32BE,
423 AV_CODEC_ID_PCM_S24LE,
424 AV_CODEC_ID_PCM_S24BE,
425 AV_CODEC_ID_PCM_U24LE,
426 AV_CODEC_ID_PCM_U24BE,
427 AV_CODEC_ID_PCM_S24DAUD,
428 AV_CODEC_ID_PCM_ZORK,
429 AV_CODEC_ID_PCM_S16LE_PLANAR,
431 AV_CODEC_ID_PCM_F32BE,
432 AV_CODEC_ID_PCM_F32LE,
433 AV_CODEC_ID_PCM_F64BE,
434 AV_CODEC_ID_PCM_F64LE,
435 AV_CODEC_ID_PCM_BLURAY,
438 AV_CODEC_ID_PCM_S8_PLANAR,
439 AV_CODEC_ID_PCM_S24LE_PLANAR,
440 AV_CODEC_ID_PCM_S32LE_PLANAR,
441 AV_CODEC_ID_PCM_S16BE_PLANAR,
442 /* new PCM "codecs" should be added right below this line starting with
443 * an explicit value of for example 0x10800
446 /* various ADPCM codecs */
447 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
448 AV_CODEC_ID_ADPCM_IMA_WAV,
449 AV_CODEC_ID_ADPCM_IMA_DK3,
450 AV_CODEC_ID_ADPCM_IMA_DK4,
451 AV_CODEC_ID_ADPCM_IMA_WS,
452 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
453 AV_CODEC_ID_ADPCM_MS,
454 AV_CODEC_ID_ADPCM_4XM,
455 AV_CODEC_ID_ADPCM_XA,
456 AV_CODEC_ID_ADPCM_ADX,
457 AV_CODEC_ID_ADPCM_EA,
458 AV_CODEC_ID_ADPCM_G726,
459 AV_CODEC_ID_ADPCM_CT,
460 AV_CODEC_ID_ADPCM_SWF,
461 AV_CODEC_ID_ADPCM_YAMAHA,
462 AV_CODEC_ID_ADPCM_SBPRO_4,
463 AV_CODEC_ID_ADPCM_SBPRO_3,
464 AV_CODEC_ID_ADPCM_SBPRO_2,
465 AV_CODEC_ID_ADPCM_THP,
466 AV_CODEC_ID_ADPCM_IMA_AMV,
467 AV_CODEC_ID_ADPCM_EA_R1,
468 AV_CODEC_ID_ADPCM_EA_R3,
469 AV_CODEC_ID_ADPCM_EA_R2,
470 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
471 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
472 AV_CODEC_ID_ADPCM_EA_XAS,
473 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
474 AV_CODEC_ID_ADPCM_IMA_ISS,
475 AV_CODEC_ID_ADPCM_G722,
476 AV_CODEC_ID_ADPCM_IMA_APC,
477 AV_CODEC_ID_ADPCM_VIMA,
478 #if FF_API_VIMA_DECODER
479 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
482 AV_CODEC_ID_ADPCM_AFC = 0x11800,
483 AV_CODEC_ID_ADPCM_IMA_OKI,
484 AV_CODEC_ID_ADPCM_DTK,
485 AV_CODEC_ID_ADPCM_IMA_RAD,
486 AV_CODEC_ID_ADPCM_G726LE,
487 AV_CODEC_ID_ADPCM_THP_LE,
488 AV_CODEC_ID_ADPCM_PSX,
489 AV_CODEC_ID_ADPCM_AICA,
490 AV_CODEC_ID_ADPCM_IMA_DAT4,
493 AV_CODEC_ID_AMR_NB = 0x12000,
496 /* RealAudio codecs*/
497 AV_CODEC_ID_RA_144 = 0x13000,
500 /* various DPCM codecs */
501 AV_CODEC_ID_ROQ_DPCM = 0x14000,
502 AV_CODEC_ID_INTERPLAY_DPCM,
503 AV_CODEC_ID_XAN_DPCM,
504 AV_CODEC_ID_SOL_DPCM,
506 AV_CODEC_ID_SDX2_DPCM = 0x14800,
509 AV_CODEC_ID_MP2 = 0x15000,
510 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
520 AV_CODEC_ID_VMDAUDIO,
526 AV_CODEC_ID_WESTWOOD_SND1,
527 AV_CODEC_ID_GSM, ///< as in Berlin toast format
530 AV_CODEC_ID_TRUESPEECH,
532 AV_CODEC_ID_SMACKAUDIO,
535 AV_CODEC_ID_DSICINAUDIO,
537 AV_CODEC_ID_MUSEPACK7,
539 AV_CODEC_ID_GSM_MS, /* as found in WAV */
545 AV_CODEC_ID_NELLYMOSER,
546 AV_CODEC_ID_MUSEPACK8,
548 AV_CODEC_ID_WMAVOICE,
550 AV_CODEC_ID_WMALOSSLESS,
559 AV_CODEC_ID_BINKAUDIO_RDFT,
560 AV_CODEC_ID_BINKAUDIO_DCT,
561 AV_CODEC_ID_AAC_LATM,
566 AV_CODEC_ID_8SVX_EXP,
567 AV_CODEC_ID_8SVX_FIB,
568 AV_CODEC_ID_BMV_AUDIO,
573 AV_CODEC_ID_COMFORT_NOISE,
575 AV_CODEC_ID_METASOUND,
576 AV_CODEC_ID_PAF_AUDIO,
580 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
582 AV_CODEC_ID_SONIC_LS,
585 AV_CODEC_ID_DSD_LSBF,
586 AV_CODEC_ID_DSD_MSBF,
587 AV_CODEC_ID_DSD_LSBF_PLANAR,
588 AV_CODEC_ID_DSD_MSBF_PLANAR,
590 AV_CODEC_ID_INTERPLAY_ACM,
594 /* subtitle codecs */
595 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
596 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
597 AV_CODEC_ID_DVB_SUBTITLE,
598 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
601 AV_CODEC_ID_MOV_TEXT,
602 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
603 AV_CODEC_ID_DVB_TELETEXT,
606 AV_CODEC_ID_MICRODVD = 0x17800,
610 AV_CODEC_ID_REALTEXT,
612 AV_CODEC_ID_SUBVIEWER1,
613 AV_CODEC_ID_SUBVIEWER,
620 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
622 /* other specific kind of codecs (generally used for attachments) */
623 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
624 AV_CODEC_ID_TTF = 0x18000,
626 AV_CODEC_ID_BINTEXT = 0x18800,
630 AV_CODEC_ID_SMPTE_KLV,
632 AV_CODEC_ID_TIMED_ID3,
633 AV_CODEC_ID_BIN_DATA,
636 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
638 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
639 * stream (only used by libavformat) */
640 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
641 * stream (only used by libavformat) */
642 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
643 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
647 * This struct describes the properties of a single codec described by an
649 * @see avcodec_descriptor_get()
651 typedef struct AVCodecDescriptor {
653 enum AVMediaType type;
655 * Name of the codec described by this descriptor. It is non-empty and
656 * unique for each codec descriptor. It should contain alphanumeric
657 * characters and '_' only.
661 * A more descriptive name for this codec. May be NULL.
663 const char *long_name;
665 * Codec properties, a combination of AV_CODEC_PROP_* flags.
669 * MIME type(s) associated with the codec.
670 * May be NULL; if not, a NULL-terminated array of MIME types.
671 * The first item is always non-NULL and is the preferred MIME type.
673 const char *const *mime_types;
675 * If non-NULL, an array of profiles recognized for this codec.
676 * Terminated with FF_PROFILE_UNKNOWN.
678 const struct AVProfile *profiles;
682 * Codec uses only intra compression.
685 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
687 * Codec supports lossy compression. Audio and video codecs only.
688 * @note a codec may support both lossy and lossless
691 #define AV_CODEC_PROP_LOSSY (1 << 1)
693 * Codec supports lossless compression. Audio and video codecs only.
695 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
697 * Codec supports frame reordering. That is, the coded order (the order in which
698 * the encoded packets are output by the encoders / stored / input to the
699 * decoders) may be different from the presentation order of the corresponding
702 * For codecs that do not have this property set, PTS and DTS should always be
705 #define AV_CODEC_PROP_REORDER (1 << 3)
707 * Subtitle codec is bitmap based
708 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
710 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
712 * Subtitle codec is text based.
713 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
715 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
718 * @ingroup lavc_decoding
719 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
720 * This is mainly needed because some optimized bitstream readers read
721 * 32 or 64 bit at once and could read over the end.<br>
722 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
723 * MPEG bitstreams could cause overread and segfault.
725 #define AV_INPUT_BUFFER_PADDING_SIZE 32
728 * @ingroup lavc_encoding
729 * minimum encoding buffer size
730 * Used to avoid some checks during header writing.
732 #define AV_INPUT_BUFFER_MIN_SIZE 16384
734 #if FF_API_WITHOUT_PREFIX
736 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
738 #define FF_INPUT_BUFFER_PADDING_SIZE 32
741 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
743 #define FF_MIN_BUFFER_SIZE 16384
744 #endif /* FF_API_WITHOUT_PREFIX */
747 * @ingroup lavc_encoding
748 * motion estimation type.
749 * @deprecated use codec private option instead
751 #if FF_API_MOTION_EST
753 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
757 ME_EPZS, ///< enhanced predictive zonal search
758 ME_X1, ///< reserved for experiments
759 ME_HEX, ///< hexagon based search
760 ME_UMH, ///< uneven multi-hexagon search
761 ME_TESA, ///< transformed exhaustive search algorithm
762 ME_ITER=50, ///< iterative search
767 * @ingroup lavc_decoding
770 /* We leave some space between them for extensions (drop some
771 * keyframes for intra-only or drop just some bidir frames). */
772 AVDISCARD_NONE =-16, ///< discard nothing
773 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
774 AVDISCARD_NONREF = 8, ///< discard all non reference
775 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
776 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
777 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
778 AVDISCARD_ALL = 48, ///< discard all
781 enum AVAudioServiceType {
782 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
783 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
784 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
785 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
786 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
787 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
788 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
789 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
790 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
791 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
795 * @ingroup lavc_encoding
797 typedef struct RcOverride{
800 int qscale; // If this is 0 then quality_factor will be used instead.
801 float quality_factor;
804 #if FF_API_MAX_BFRAMES
806 * @deprecated there is no libavcodec-wide limit on the number of B-frames
808 #define FF_MAX_B_FRAMES 16
812 These flags can be passed in AVCodecContext.flags before initialization.
813 Note: Not everything is supported yet.
817 * Allow decoders to produce frames with data planes that are not aligned
818 * to CPU requirements (e.g. due to cropping).
820 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
824 #define AV_CODEC_FLAG_QSCALE (1 << 1)
826 * 4 MV per MB allowed / advanced prediction for H.263.
828 #define AV_CODEC_FLAG_4MV (1 << 2)
830 * Output even those frames that might be corrupted.
832 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
836 #define AV_CODEC_FLAG_QPEL (1 << 4)
838 * Use internal 2pass ratecontrol in first pass mode.
840 #define AV_CODEC_FLAG_PASS1 (1 << 9)
842 * Use internal 2pass ratecontrol in second pass mode.
844 #define AV_CODEC_FLAG_PASS2 (1 << 10)
848 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
850 * Only decode/encode grayscale.
852 #define AV_CODEC_FLAG_GRAY (1 << 13)
854 * error[?] variables will be set during encoding.
856 #define AV_CODEC_FLAG_PSNR (1 << 15)
858 * Input bitstream might be truncated at a random location
859 * instead of only at frame boundaries.
861 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
863 * Use interlaced DCT.
865 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
869 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
871 * Place global headers in extradata instead of every keyframe.
873 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
875 * Use only bitexact stuff (except (I)DCT).
877 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
878 /* Fx : Flag for h263+ extra options */
880 * H.263 advanced intra coding / MPEG-4 AC prediction
882 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
884 * interlaced motion estimation
886 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
887 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
890 * Allow non spec compliant speedup tricks.
892 #define AV_CODEC_FLAG2_FAST (1 << 0)
894 * Skip bitstream encoding.
896 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
898 * Place global headers at every keyframe instead of in extradata.
900 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
903 * timecode is in drop frame format. DEPRECATED!!!!
905 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
908 * Input bitstream might be truncated at a packet boundaries
909 * instead of only at frame boundaries.
911 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
913 * Discard cropping information from SPS.
915 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
918 * Show all frames before the first keyframe
920 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
922 * Export motion vectors through frame side data
924 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
926 * Do not skip samples and export skip information as frame side data
928 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
930 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
932 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
934 /* Unsupported options :
935 * Syntax Arithmetic coding (SAC)
936 * Reference Picture Selection
937 * Independent Segment Decoding */
939 /* codec capabilities */
942 * Decoder can use draw_horiz_band callback.
944 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
946 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
947 * If not set, it might not use get_buffer() at all or use operations that
948 * assume the buffer was allocated by avcodec_default_get_buffer.
950 #define AV_CODEC_CAP_DR1 (1 << 1)
951 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
953 * Encoder or decoder requires flushing with NULL input at the end in order to
954 * give the complete and correct output.
956 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
957 * with NULL data. The user can still send NULL data to the public encode
958 * or decode function, but libavcodec will not pass it along to the codec
959 * unless this flag is set.
962 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
963 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
967 * The encoder needs to be fed with NULL data at the end of encoding until the
968 * encoder no longer returns data.
970 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
971 * flag also means that the encoder must set the pts and duration for
972 * each output packet. If this flag is not set, the pts and duration will
973 * be determined by libavcodec from the input frame.
975 #define AV_CODEC_CAP_DELAY (1 << 5)
977 * Codec can be fed a final frame with a smaller size.
978 * This can be used to prevent truncation of the last audio samples.
980 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
984 * Codec can export data for HW decoding (VDPAU).
986 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
990 * Codec can output multiple frames per AVPacket
991 * Normally demuxers return one frame at a time, demuxers which do not do
992 * are connected to a parser to split what they return into proper frames.
993 * This flag is reserved to the very rare category of codecs which have a
994 * bitstream that cannot be split into frames without timeconsuming
995 * operations like full decoding. Demuxers carring such bitstreams thus
996 * may return multiple frames in a packet. This has many disadvantages like
997 * prohibiting stream copy in many cases thus it should only be considered
1000 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1002 * Codec is experimental and is thus avoided in favor of non experimental
1005 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1007 * Codec should fill in channel configuration and samplerate instead of container
1009 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1011 * Codec supports frame-level multithreading.
1013 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1015 * Codec supports slice-based (or partition-based) multithreading.
1017 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1019 * Codec supports changed parameters at any point.
1021 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1023 * Codec supports avctx->thread_count == 0 (auto).
1025 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1027 * Audio encoder supports receiving a different number of samples in each call.
1029 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1031 * Codec is intra only.
1033 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1035 * Codec is lossless.
1037 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1040 #if FF_API_WITHOUT_PREFIX
1042 * Allow decoders to produce frames with data planes that are not aligned
1043 * to CPU requirements (e.g. due to cropping).
1045 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1046 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1047 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1048 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1049 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1052 * @deprecated use the "gmc" private option of the libxvid encoder
1054 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1058 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1059 * mpegvideo encoders
1061 #define CODEC_FLAG_MV0 0x0040
1063 #if FF_API_INPUT_PRESERVED
1065 * @deprecated passing reference-counted frames to the encoders replaces this
1068 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1070 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1071 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1072 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1075 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1078 #define CODEC_FLAG_EMU_EDGE 0x4000
1080 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1081 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1083 #if FF_API_NORMALIZE_AQP
1085 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1086 * mpegvideo encoders
1088 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1090 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1091 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1092 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1093 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1094 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1095 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1096 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1097 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1098 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1099 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1100 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1101 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1102 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1104 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1105 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1106 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1107 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1109 /* Unsupported options :
1110 * Syntax Arithmetic coding (SAC)
1111 * Reference Picture Selection
1112 * Independent Segment Decoding */
1114 /* codec capabilities */
1116 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1118 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1119 * If not set, it might not use get_buffer() at all or use operations that
1120 * assume the buffer was allocated by avcodec_default_get_buffer.
1122 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1123 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1125 /* Codec can export data for HW decoding. This flag indicates that
1126 * the codec would call get_format() with list that might contain HW accelerated
1127 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1128 * including raw image format.
1129 * The application can use the passed context to determine bitstream version,
1130 * chroma format, resolution etc.
1132 #define CODEC_CAP_HWACCEL 0x0010
1133 #endif /* FF_API_XVMC */
1135 * Encoder or decoder requires flushing with NULL input at the end in order to
1136 * give the complete and correct output.
1138 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1139 * with NULL data. The user can still send NULL data to the public encode
1140 * or decode function, but libavcodec will not pass it along to the codec
1141 * unless this flag is set.
1144 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1145 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1149 * The encoder needs to be fed with NULL data at the end of encoding until the
1150 * encoder no longer returns data.
1152 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1153 * flag also means that the encoder must set the pts and duration for
1154 * each output packet. If this flag is not set, the pts and duration will
1155 * be determined by libavcodec from the input frame.
1157 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1159 * Codec can be fed a final frame with a smaller size.
1160 * This can be used to prevent truncation of the last audio samples.
1162 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1163 #if FF_API_CAP_VDPAU
1165 * Codec can export data for HW decoding (VDPAU).
1167 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1170 * Codec can output multiple frames per AVPacket
1171 * Normally demuxers return one frame at a time, demuxers which do not do
1172 * are connected to a parser to split what they return into proper frames.
1173 * This flag is reserved to the very rare category of codecs which have a
1174 * bitstream that cannot be split into frames without timeconsuming
1175 * operations like full decoding. Demuxers carring such bitstreams thus
1176 * may return multiple frames in a packet. This has many disadvantages like
1177 * prohibiting stream copy in many cases thus it should only be considered
1180 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1182 * Codec is experimental and is thus avoided in favor of non experimental
1185 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1187 * Codec should fill in channel configuration and samplerate instead of container
1189 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1190 #if FF_API_NEG_LINESIZES
1192 * @deprecated no codecs use this capability
1194 #define CODEC_CAP_NEG_LINESIZES 0x0800
1197 * Codec supports frame-level multithreading.
1199 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1201 * Codec supports slice-based (or partition-based) multithreading.
1203 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1205 * Codec supports changed parameters at any point.
1207 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1209 * Codec supports avctx->thread_count == 0 (auto).
1211 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1213 * Audio encoder supports receiving a different number of samples in each call.
1215 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1217 * Codec is intra only.
1219 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1221 * Codec is lossless.
1223 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1226 * HWAccel is experimental and is thus avoided in favor of non experimental
1229 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1230 #endif /* FF_API_WITHOUT_PREFIX */
1233 //The following defines may change, don't expect compatibility if you use them.
1234 #define MB_TYPE_INTRA4x4 0x0001
1235 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1236 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1237 #define MB_TYPE_16x16 0x0008
1238 #define MB_TYPE_16x8 0x0010
1239 #define MB_TYPE_8x16 0x0020
1240 #define MB_TYPE_8x8 0x0040
1241 #define MB_TYPE_INTERLACED 0x0080
1242 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1243 #define MB_TYPE_ACPRED 0x0200
1244 #define MB_TYPE_GMC 0x0400
1245 #define MB_TYPE_SKIP 0x0800
1246 #define MB_TYPE_P0L0 0x1000
1247 #define MB_TYPE_P1L0 0x2000
1248 #define MB_TYPE_P0L1 0x4000
1249 #define MB_TYPE_P1L1 0x8000
1250 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1251 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1252 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1253 #define MB_TYPE_QUANT 0x00010000
1254 #define MB_TYPE_CBP 0x00020000
1255 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
1260 * This specifies the area which should be displayed.
1261 * Note there may be multiple such areas for one frame.
1263 typedef struct AVPanScan{
1266 * - encoding: Set by user.
1267 * - decoding: Set by libavcodec.
1272 * width and height in 1/16 pel
1273 * - encoding: Set by user.
1274 * - decoding: Set by libavcodec.
1280 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1281 * - encoding: Set by user.
1282 * - decoding: Set by libavcodec.
1284 int16_t position[3][2];
1288 * This structure describes the bitrate properties of an encoded bitstream. It
1289 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1290 * parameters for H.264/HEVC.
1292 typedef struct AVCPBProperties {
1294 * Maximum bitrate of the stream, in bits per second.
1295 * Zero if unknown or unspecified.
1299 * Minimum bitrate of the stream, in bits per second.
1300 * Zero if unknown or unspecified.
1304 * Average bitrate of the stream, in bits per second.
1305 * Zero if unknown or unspecified.
1310 * The size of the buffer to which the ratecontrol is applied, in bits.
1311 * Zero if unknown or unspecified.
1316 * The delay between the time the packet this structure is associated with
1317 * is received and the time when it should be decoded, in periods of a 27MHz
1320 * UINT64_MAX when unknown or unspecified.
1325 #if FF_API_QSCALE_TYPE
1326 #define FF_QSCALE_TYPE_MPEG1 0
1327 #define FF_QSCALE_TYPE_MPEG2 1
1328 #define FF_QSCALE_TYPE_H264 2
1329 #define FF_QSCALE_TYPE_VP56 3
1333 * The decoder will keep a reference to the frame and may reuse it later.
1335 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1338 * @defgroup lavc_packet AVPacket
1340 * Types and functions for working with AVPacket.
1343 enum AVPacketSideDataType {
1344 AV_PKT_DATA_PALETTE,
1345 AV_PKT_DATA_NEW_EXTRADATA,
1348 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1351 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1352 * s32le channel_count
1353 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1354 * u64le channel_layout
1355 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1357 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1362 AV_PKT_DATA_PARAM_CHANGE,
1365 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1366 * structures with info about macroblocks relevant to splitting the
1367 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1368 * That is, it does not necessarily contain info about all macroblocks,
1369 * as long as the distance between macroblocks in the info is smaller
1370 * than the target payload size.
1371 * Each MB info structure is 12 bytes, and is laid out as follows:
1373 * u32le bit offset from the start of the packet
1374 * u8 current quantizer at the start of the macroblock
1376 * u16le macroblock address within the GOB
1377 * u8 horizontal MV predictor
1378 * u8 vertical MV predictor
1379 * u8 horizontal MV predictor for block number 3
1380 * u8 vertical MV predictor for block number 3
1383 AV_PKT_DATA_H263_MB_INFO,
1386 * This side data should be associated with an audio stream and contains
1387 * ReplayGain information in form of the AVReplayGain struct.
1389 AV_PKT_DATA_REPLAYGAIN,
1392 * This side data contains a 3x3 transformation matrix describing an affine
1393 * transformation that needs to be applied to the decoded video frames for
1394 * correct presentation.
1396 * See libavutil/display.h for a detailed description of the data.
1398 AV_PKT_DATA_DISPLAYMATRIX,
1401 * This side data should be associated with a video stream and contains
1402 * Stereoscopic 3D information in form of the AVStereo3D struct.
1404 AV_PKT_DATA_STEREO3D,
1407 * This side data should be associated with an audio stream and corresponds
1408 * to enum AVAudioServiceType.
1410 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1413 * This side data contains quality related information from the encoder.
1415 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1419 * u64le[error count] sum of squared differences between encoder in and output
1422 AV_PKT_DATA_QUALITY_STATS,
1425 * This side data contains an integer value representing the stream index
1426 * of a "fallback" track. A fallback track indicates an alternate
1427 * track to use when the current track can not be decoded for some reason.
1428 * e.g. no decoder available for codec.
1430 AV_PKT_DATA_FALLBACK_TRACK,
1433 * This side data corresponds to the AVCPBProperties struct.
1435 AV_PKT_DATA_CPB_PROPERTIES,
1438 * Recommmends skipping the specified number of samples
1440 * u32le number of samples to skip from start of this packet
1441 * u32le number of samples to skip from end of this packet
1442 * u8 reason for start skip
1443 * u8 reason for end skip (0=padding silence, 1=convergence)
1446 AV_PKT_DATA_SKIP_SAMPLES=70,
1449 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1450 * the packet may contain "dual mono" audio specific to Japanese DTV
1451 * and if it is true, recommends only the selected channel to be used.
1453 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1456 AV_PKT_DATA_JP_DUALMONO,
1459 * A list of zero terminated key/value strings. There is no end marker for
1460 * the list, so it is required to rely on the side data size to stop.
1462 AV_PKT_DATA_STRINGS_METADATA,
1465 * Subtitle event position
1473 AV_PKT_DATA_SUBTITLE_POSITION,
1476 * Data found in BlockAdditional element of matroska container. There is
1477 * no end marker for the data, so it is required to rely on the side data
1478 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1481 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1484 * The optional first identifier line of a WebVTT cue.
1486 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1489 * The optional settings (rendering instructions) that immediately
1490 * follow the timestamp specifier of a WebVTT cue.
1492 AV_PKT_DATA_WEBVTT_SETTINGS,
1495 * A list of zero terminated key/value strings. There is no end marker for
1496 * the list, so it is required to rely on the side data size to stop. This
1497 * side data includes updated metadata which appeared in the stream.
1499 AV_PKT_DATA_METADATA_UPDATE,
1502 * MPEGTS stream ID, this is required to pass the stream ID
1503 * information from the demuxer to the corresponding muxer.
1505 AV_PKT_DATA_MPEGTS_STREAM_ID,
1508 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1509 * should be associated with a video stream and containts data in the form
1510 * of the AVMasteringDisplayMetadata struct.
1512 AV_PKT_DATA_MASTERING_DISPLAY_METADATA
1515 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1517 typedef struct AVPacketSideData {
1520 enum AVPacketSideDataType type;
1524 * This structure stores compressed data. It is typically exported by demuxers
1525 * and then passed as input to decoders, or received as output from encoders and
1526 * then passed to muxers.
1528 * For video, it should typically contain one compressed frame. For audio it may
1529 * contain several compressed frames. Encoders are allowed to output empty
1530 * packets, with no compressed data, containing only side data
1531 * (e.g. to update some stream parameters at the end of encoding).
1533 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1534 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1535 * without libavcodec and libavformat major bump.
1537 * The semantics of data ownership depends on the buf field.
1538 * If it is set, the packet data is dynamically allocated and is
1539 * valid indefinitely until a call to av_packet_unref() reduces the
1540 * reference count to 0.
1542 * If the buf field is not set av_packet_ref() would make a copy instead
1543 * of increasing the reference count.
1545 * The side data is always allocated with av_malloc(), copied by
1546 * av_packet_ref() and freed by av_packet_unref().
1548 * @see av_packet_ref
1549 * @see av_packet_unref
1551 typedef struct AVPacket {
1553 * A reference to the reference-counted buffer where the packet data is
1555 * May be NULL, then the packet data is not reference-counted.
1559 * Presentation timestamp in AVStream->time_base units; the time at which
1560 * the decompressed packet will be presented to the user.
1561 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1562 * pts MUST be larger or equal to dts as presentation cannot happen before
1563 * decompression, unless one wants to view hex dumps. Some formats misuse
1564 * the terms dts and pts/cts to mean something different. Such timestamps
1565 * must be converted to true pts/dts before they are stored in AVPacket.
1569 * Decompression timestamp in AVStream->time_base units; the time at which
1570 * the packet is decompressed.
1571 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1578 * A combination of AV_PKT_FLAG values
1582 * Additional packet data that can be provided by the container.
1583 * Packet can contain several types of side information.
1585 AVPacketSideData *side_data;
1586 int side_data_elems;
1589 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1590 * Equals next_pts - this_pts in presentation order.
1594 int64_t pos; ///< byte position in stream, -1 if unknown
1596 #if FF_API_CONVERGENCE_DURATION
1598 * @deprecated Same as the duration field, but as int64_t. This was required
1599 * for Matroska subtitles, whose duration values could overflow when the
1600 * duration field was still an int.
1602 attribute_deprecated
1603 int64_t convergence_duration;
1606 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1607 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1609 enum AVSideDataParamChangeFlags {
1610 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1611 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1612 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1613 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1619 struct AVCodecInternal;
1623 AV_FIELD_PROGRESSIVE,
1624 AV_FIELD_TT, //< Top coded_first, top displayed first
1625 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1626 AV_FIELD_TB, //< Top coded first, bottom displayed first
1627 AV_FIELD_BT, //< Bottom coded first, top displayed first
1631 * main external API structure.
1632 * New fields can be added to the end with minor version bumps.
1633 * Removal, reordering and changes to existing fields require a major
1635 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1637 * sizeof(AVCodecContext) must not be used outside libav*.
1639 typedef struct AVCodecContext {
1641 * information on struct for av_log
1642 * - set by avcodec_alloc_context3
1644 const AVClass *av_class;
1645 int log_level_offset;
1647 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1648 const struct AVCodec *codec;
1649 #if FF_API_CODEC_NAME
1651 * @deprecated this field is not used for anything in libavcodec
1653 attribute_deprecated
1654 char codec_name[32];
1656 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1659 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1660 * This is used to work around some encoder bugs.
1661 * A demuxer should set this to what is stored in the field used to identify the codec.
1662 * If there are multiple such fields in a container then the demuxer should choose the one
1663 * which maximizes the information about the used codec.
1664 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1665 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1666 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1668 * - encoding: Set by user, if not then the default based on codec_id will be used.
1669 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1671 unsigned int codec_tag;
1673 #if FF_API_STREAM_CODEC_TAG
1675 * @deprecated this field is unused
1677 attribute_deprecated
1678 unsigned int stream_codec_tag;
1684 * Private context used for internal data.
1686 * Unlike priv_data, this is not codec-specific. It is used in general
1687 * libavcodec functions.
1689 struct AVCodecInternal *internal;
1692 * Private data of the user, can be used to carry app specific stuff.
1693 * - encoding: Set by user.
1694 * - decoding: Set by user.
1699 * the average bitrate
1700 * - encoding: Set by user; unused for constant quantizer encoding.
1701 * - decoding: Set by user, may be overwritten by libavcodec
1702 * if this info is available in the stream
1707 * number of bits the bitstream is allowed to diverge from the reference.
1708 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1709 * - encoding: Set by user; unused for constant quantizer encoding.
1710 * - decoding: unused
1712 int bit_rate_tolerance;
1715 * Global quality for codecs which cannot change it per frame.
1716 * This should be proportional to MPEG-1/2/4 qscale.
1717 * - encoding: Set by user.
1718 * - decoding: unused
1723 * - encoding: Set by user.
1724 * - decoding: unused
1726 int compression_level;
1727 #define FF_COMPRESSION_DEFAULT -1
1731 * - encoding: Set by user.
1732 * - decoding: Set by user.
1738 * - encoding: Set by user.
1739 * - decoding: Set by user.
1744 * some codecs need / can use extradata like Huffman tables.
1745 * mjpeg: Huffman tables
1746 * rv10: additional flags
1747 * mpeg4: global headers (they can be in the bitstream or here)
1748 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1749 * than extradata_size to avoid problems if it is read with the bitstream reader.
1750 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1751 * - encoding: Set/allocated/freed by libavcodec.
1752 * - decoding: Set/allocated/freed by user.
1758 * This is the fundamental unit of time (in seconds) in terms
1759 * of which frame timestamps are represented. For fixed-fps content,
1760 * timebase should be 1/framerate and timestamp increments should be
1762 * This often, but not always is the inverse of the frame rate or field rate
1763 * for video. 1/time_base is not the average frame rate if the frame rate is not
1766 * Like containers, elementary streams also can store timestamps, 1/time_base
1767 * is the unit in which these timestamps are specified.
1768 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1769 * vop_time_increment_resolution and fixed_vop_rate
1770 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1772 * - encoding: MUST be set by user.
1773 * - decoding: the use of this field for decoding is deprecated.
1774 * Use framerate instead.
1776 AVRational time_base;
1779 * For some codecs, the time base is closer to the field rate than the frame rate.
1780 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1781 * if no telecine is used ...
1783 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1785 int ticks_per_frame;
1790 * Encoding: Number of frames delay there will be from the encoder input to
1791 * the decoder output. (we assume the decoder matches the spec)
1792 * Decoding: Number of frames delay in addition to what a standard decoder
1793 * as specified in the spec would produce.
1796 * Number of frames the decoded output will be delayed relative to the
1800 * For encoding, this field is unused (see initial_padding).
1802 * For decoding, this is the number of samples the decoder needs to
1803 * output before the decoder's output is valid. When seeking, you should
1804 * start decoding this many samples prior to your desired seek point.
1806 * - encoding: Set by libavcodec.
1807 * - decoding: Set by libavcodec.
1814 * picture width / height.
1816 * @note Those fields may not match the values of the last
1817 * AVFrame outputted by avcodec_decode_video2 due frame
1820 * - encoding: MUST be set by user.
1821 * - decoding: May be set by the user before opening the decoder if known e.g.
1822 * from the container. Some decoders will require the dimensions
1823 * to be set by the caller. During decoding, the decoder may
1824 * overwrite those values as required while parsing the data.
1829 * Bitstream width / height, may be different from width/height e.g. when
1830 * the decoded frame is cropped before being output or lowres is enabled.
1832 * @note Those field may not match the value of the last
1833 * AVFrame outputted by avcodec_receive_frame() due frame
1836 * - encoding: unused
1837 * - decoding: May be set by the user before opening the decoder if known
1838 * e.g. from the container. During decoding, the decoder may
1839 * overwrite those values as required while parsing the data.
1841 int coded_width, coded_height;
1843 #if FF_API_ASPECT_EXTENDED
1844 #define FF_ASPECT_EXTENDED 15
1848 * the number of pictures in a group of pictures, or 0 for intra_only
1849 * - encoding: Set by user.
1850 * - decoding: unused
1855 * Pixel format, see AV_PIX_FMT_xxx.
1856 * May be set by the demuxer if known from headers.
1857 * May be overridden by the decoder if it knows better.
1859 * @note This field may not match the value of the last
1860 * AVFrame outputted by avcodec_receive_frame() due frame
1863 * - encoding: Set by user.
1864 * - decoding: Set by user if known, overridden by libavcodec while
1867 enum AVPixelFormat pix_fmt;
1869 #if FF_API_MOTION_EST
1871 * This option does nothing
1872 * @deprecated use codec private options instead
1874 attribute_deprecated int me_method;
1878 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1879 * decoder to draw a horizontal band. It improves cache usage. Not
1880 * all codecs can do that. You must check the codec capabilities
1882 * When multithreading is used, it may be called from multiple threads
1883 * at the same time; threads might draw different parts of the same AVFrame,
1884 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1886 * The function is also used by hardware acceleration APIs.
1887 * It is called at least once during frame decoding to pass
1888 * the data needed for hardware render.
1889 * In that mode instead of pixel data, AVFrame points to
1890 * a structure specific to the acceleration API. The application
1891 * reads the structure and can change some fields to indicate progress
1893 * - encoding: unused
1894 * - decoding: Set by user.
1895 * @param height the height of the slice
1896 * @param y the y position of the slice
1897 * @param type 1->top field, 2->bottom field, 3->frame
1898 * @param offset offset into the AVFrame.data from which the slice should be read
1900 void (*draw_horiz_band)(struct AVCodecContext *s,
1901 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1902 int y, int type, int height);
1905 * callback to negotiate the pixelFormat
1906 * @param fmt is the list of formats which are supported by the codec,
1907 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1908 * The first is always the native one.
1909 * @note The callback may be called again immediately if initialization for
1910 * the selected (hardware-accelerated) pixel format failed.
1911 * @warning Behavior is undefined if the callback returns a value not
1912 * in the fmt list of formats.
1913 * @return the chosen format
1914 * - encoding: unused
1915 * - decoding: Set by user, if not set the native format will be chosen.
1917 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1920 * maximum number of B-frames between non-B-frames
1921 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1922 * - encoding: Set by user.
1923 * - decoding: unused
1928 * qscale factor between IP and B-frames
1929 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1930 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1931 * - encoding: Set by user.
1932 * - decoding: unused
1934 float b_quant_factor;
1936 #if FF_API_RC_STRATEGY
1937 /** @deprecated use codec private option instead */
1938 attribute_deprecated int rc_strategy;
1939 #define FF_RC_STRATEGY_XVID 1
1942 #if FF_API_PRIVATE_OPT
1943 /** @deprecated use encoder private options instead */
1944 attribute_deprecated
1945 int b_frame_strategy;
1949 * qscale offset between IP and B-frames
1950 * - encoding: Set by user.
1951 * - decoding: unused
1953 float b_quant_offset;
1956 * Size of the frame reordering buffer in the decoder.
1957 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1958 * - encoding: Set by libavcodec.
1959 * - decoding: Set by libavcodec.
1963 #if FF_API_PRIVATE_OPT
1964 /** @deprecated use encoder private options instead */
1965 attribute_deprecated
1970 * qscale factor between P and I-frames
1971 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1972 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1973 * - encoding: Set by user.
1974 * - decoding: unused
1976 float i_quant_factor;
1979 * qscale offset between P and I-frames
1980 * - encoding: Set by user.
1981 * - decoding: unused
1983 float i_quant_offset;
1986 * luminance masking (0-> disabled)
1987 * - encoding: Set by user.
1988 * - decoding: unused
1993 * temporary complexity masking (0-> disabled)
1994 * - encoding: Set by user.
1995 * - decoding: unused
1997 float temporal_cplx_masking;
2000 * spatial complexity masking (0-> disabled)
2001 * - encoding: Set by user.
2002 * - decoding: unused
2004 float spatial_cplx_masking;
2007 * p block masking (0-> disabled)
2008 * - encoding: Set by user.
2009 * - decoding: unused
2014 * darkness masking (0-> disabled)
2015 * - encoding: Set by user.
2016 * - decoding: unused
2022 * - encoding: Set by libavcodec.
2023 * - decoding: Set by user (or 0).
2027 #if FF_API_PRIVATE_OPT
2028 /** @deprecated use encoder private options instead */
2029 attribute_deprecated
2030 int prediction_method;
2031 #define FF_PRED_LEFT 0
2032 #define FF_PRED_PLANE 1
2033 #define FF_PRED_MEDIAN 2
2037 * slice offsets in the frame in bytes
2038 * - encoding: Set/allocated by libavcodec.
2039 * - decoding: Set/allocated by user (or NULL).
2044 * sample aspect ratio (0 if unknown)
2045 * That is the width of a pixel divided by the height of the pixel.
2046 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2047 * - encoding: Set by user.
2048 * - decoding: Set by libavcodec.
2050 AVRational sample_aspect_ratio;
2053 * motion estimation comparison function
2054 * - encoding: Set by user.
2055 * - decoding: unused
2059 * subpixel motion estimation comparison function
2060 * - encoding: Set by user.
2061 * - decoding: unused
2065 * macroblock comparison function (not supported yet)
2066 * - encoding: Set by user.
2067 * - decoding: unused
2071 * interlaced DCT comparison function
2072 * - encoding: Set by user.
2073 * - decoding: unused
2076 #define FF_CMP_SAD 0
2077 #define FF_CMP_SSE 1
2078 #define FF_CMP_SATD 2
2079 #define FF_CMP_DCT 3
2080 #define FF_CMP_PSNR 4
2081 #define FF_CMP_BIT 5
2083 #define FF_CMP_ZERO 7
2084 #define FF_CMP_VSAD 8
2085 #define FF_CMP_VSSE 9
2086 #define FF_CMP_NSSE 10
2087 #define FF_CMP_W53 11
2088 #define FF_CMP_W97 12
2089 #define FF_CMP_DCTMAX 13
2090 #define FF_CMP_DCT264 14
2091 #define FF_CMP_CHROMA 256
2094 * ME diamond size & shape
2095 * - encoding: Set by user.
2096 * - decoding: unused
2101 * amount of previous MV predictors (2a+1 x 2a+1 square)
2102 * - encoding: Set by user.
2103 * - decoding: unused
2105 int last_predictor_count;
2107 #if FF_API_PRIVATE_OPT
2108 /** @deprecated use encoder private options instead */
2109 attribute_deprecated
2114 * motion estimation prepass comparison function
2115 * - encoding: Set by user.
2116 * - decoding: unused
2121 * ME prepass diamond size & shape
2122 * - encoding: Set by user.
2123 * - decoding: unused
2129 * - encoding: Set by user.
2130 * - decoding: unused
2132 int me_subpel_quality;
2136 * DTG active format information (additional aspect ratio
2137 * information only used in DVB MPEG-2 transport streams)
2140 * - encoding: unused
2141 * - decoding: Set by decoder.
2142 * @deprecated Deprecated in favor of AVSideData
2144 attribute_deprecated int dtg_active_format;
2145 #define FF_DTG_AFD_SAME 8
2146 #define FF_DTG_AFD_4_3 9
2147 #define FF_DTG_AFD_16_9 10
2148 #define FF_DTG_AFD_14_9 11
2149 #define FF_DTG_AFD_4_3_SP_14_9 13
2150 #define FF_DTG_AFD_16_9_SP_14_9 14
2151 #define FF_DTG_AFD_SP_4_3 15
2152 #endif /* FF_API_AFD */
2155 * maximum motion estimation search range in subpel units
2156 * If 0 then no limit.
2158 * - encoding: Set by user.
2159 * - decoding: unused
2163 #if FF_API_QUANT_BIAS
2165 * @deprecated use encoder private option instead
2167 attribute_deprecated int intra_quant_bias;
2168 #define FF_DEFAULT_QUANT_BIAS 999999
2171 * @deprecated use encoder private option instead
2173 attribute_deprecated int inter_quant_bias;
2178 * - encoding: unused
2179 * - decoding: Set by user.
2182 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2183 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2184 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2188 * XVideo Motion Acceleration
2189 * - encoding: forbidden
2190 * - decoding: set by decoder
2191 * @deprecated XvMC doesn't need it anymore.
2193 attribute_deprecated int xvmc_acceleration;
2194 #endif /* FF_API_XVMC */
2197 * macroblock decision mode
2198 * - encoding: Set by user.
2199 * - decoding: unused
2202 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2203 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2204 #define FF_MB_DECISION_RD 2 ///< rate distortion
2207 * custom intra quantization matrix
2208 * - encoding: Set by user, can be NULL.
2209 * - decoding: Set by libavcodec.
2211 uint16_t *intra_matrix;
2214 * custom inter quantization matrix
2215 * - encoding: Set by user, can be NULL.
2216 * - decoding: Set by libavcodec.
2218 uint16_t *inter_matrix;
2220 #if FF_API_PRIVATE_OPT
2221 /** @deprecated use encoder private options instead */
2222 attribute_deprecated
2223 int scenechange_threshold;
2225 /** @deprecated use encoder private options instead */
2226 attribute_deprecated
2227 int noise_reduction;
2232 * @deprecated this field is unused
2234 attribute_deprecated
2238 * @deprecated this field is unused
2240 attribute_deprecated
2245 * precision of the intra DC coefficient - 8
2246 * - encoding: Set by user.
2247 * - decoding: Set by libavcodec
2249 int intra_dc_precision;
2252 * Number of macroblock rows at the top which are skipped.
2253 * - encoding: unused
2254 * - decoding: Set by user.
2259 * Number of macroblock rows at the bottom which are skipped.
2260 * - encoding: unused
2261 * - decoding: Set by user.
2267 * @deprecated use encoder private options instead
2269 attribute_deprecated
2270 float border_masking;
2274 * minimum MB lagrange multipler
2275 * - encoding: Set by user.
2276 * - decoding: unused
2281 * maximum MB lagrange multipler
2282 * - encoding: Set by user.
2283 * - decoding: unused
2287 #if FF_API_PRIVATE_OPT
2289 * @deprecated use encoder private options instead
2291 attribute_deprecated
2292 int me_penalty_compensation;
2296 * - encoding: Set by user.
2297 * - decoding: unused
2301 #if FF_API_PRIVATE_OPT
2302 /** @deprecated use encoder private options instead */
2303 attribute_deprecated
2309 * - encoding: Set by user.
2310 * - decoding: unused
2315 * number of reference frames
2316 * - encoding: Set by user.
2317 * - decoding: Set by lavc.
2321 #if FF_API_PRIVATE_OPT
2322 /** @deprecated use encoder private options instead */
2323 attribute_deprecated
2327 #if FF_API_UNUSED_MEMBERS
2329 * Multiplied by qscale for each frame and added to scene_change_score.
2330 * - encoding: Set by user.
2331 * - decoding: unused
2333 attribute_deprecated int scenechange_factor;
2337 * Note: Value depends upon the compare function used for fullpel ME.
2338 * - encoding: Set by user.
2339 * - decoding: unused
2343 #if FF_API_PRIVATE_OPT
2344 /** @deprecated use encoder private options instead */
2345 attribute_deprecated
2350 * Chromaticity coordinates of the source primaries.
2351 * - encoding: Set by user
2352 * - decoding: Set by libavcodec
2354 enum AVColorPrimaries color_primaries;
2357 * Color Transfer Characteristic.
2358 * - encoding: Set by user
2359 * - decoding: Set by libavcodec
2361 enum AVColorTransferCharacteristic color_trc;
2364 * YUV colorspace type.
2365 * - encoding: Set by user
2366 * - decoding: Set by libavcodec
2368 enum AVColorSpace colorspace;
2371 * MPEG vs JPEG YUV range.
2372 * - encoding: Set by user
2373 * - decoding: Set by libavcodec
2375 enum AVColorRange color_range;
2378 * This defines the location of chroma samples.
2379 * - encoding: Set by user
2380 * - decoding: Set by libavcodec
2382 enum AVChromaLocation chroma_sample_location;
2386 * Indicates number of picture subdivisions. Used for parallelized
2388 * - encoding: Set by user
2389 * - decoding: unused
2394 * - encoding: set by libavcodec
2395 * - decoding: Set by user.
2397 enum AVFieldOrder field_order;
2400 int sample_rate; ///< samples per second
2401 int channels; ///< number of audio channels
2404 * audio sample format
2405 * - encoding: Set by user.
2406 * - decoding: Set by libavcodec.
2408 enum AVSampleFormat sample_fmt; ///< sample format
2410 /* The following data should not be initialized. */
2412 * Number of samples per channel in an audio frame.
2414 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2415 * except the last must contain exactly frame_size samples per channel.
2416 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2417 * frame size is not restricted.
2418 * - decoding: may be set by some decoders to indicate constant frame size
2423 * Frame counter, set by libavcodec.
2425 * - decoding: total number of frames returned from the decoder so far.
2426 * - encoding: total number of frames passed to the encoder so far.
2428 * @note the counter is not incremented if encoding/decoding resulted in
2434 * number of bytes per packet if constant and known or 0
2435 * Used by some WAV based audio codecs.
2440 * Audio cutoff bandwidth (0 means "automatic")
2441 * - encoding: Set by user.
2442 * - decoding: unused
2447 * Audio channel layout.
2448 * - encoding: set by user.
2449 * - decoding: set by user, may be overwritten by libavcodec.
2451 uint64_t channel_layout;
2454 * Request decoder to use this channel layout if it can (0 for default)
2455 * - encoding: unused
2456 * - decoding: Set by user.
2458 uint64_t request_channel_layout;
2461 * Type of service that the audio stream conveys.
2462 * - encoding: Set by user.
2463 * - decoding: Set by libavcodec.
2465 enum AVAudioServiceType audio_service_type;
2468 * desired sample format
2469 * - encoding: Not used.
2470 * - decoding: Set by user.
2471 * Decoder will decode to this format if it can.
2473 enum AVSampleFormat request_sample_fmt;
2476 * This callback is called at the beginning of each frame to get data
2477 * buffer(s) for it. There may be one contiguous buffer for all the data or
2478 * there may be a buffer per each data plane or anything in between. What
2479 * this means is, you may set however many entries in buf[] you feel necessary.
2480 * Each buffer must be reference-counted using the AVBuffer API (see description
2483 * The following fields will be set in the frame before this callback is
2486 * - width, height (video only)
2487 * - sample_rate, channel_layout, nb_samples (audio only)
2488 * Their values may differ from the corresponding values in
2489 * AVCodecContext. This callback must use the frame values, not the codec
2490 * context values, to calculate the required buffer size.
2492 * This callback must fill the following fields in the frame:
2496 * * if the data is planar audio with more than 8 channels, then this
2497 * callback must allocate and fill extended_data to contain all pointers
2498 * to all data planes. data[] must hold as many pointers as it can.
2499 * extended_data must be allocated with av_malloc() and will be freed in
2501 * * otherwise exended_data must point to data
2502 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2503 * the frame's data and extended_data pointers must be contained in these. That
2504 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2505 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2506 * and av_buffer_ref().
2507 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2508 * this callback and filled with the extra buffers if there are more
2509 * buffers than buf[] can hold. extended_buf will be freed in
2512 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2513 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2516 * Each data plane must be aligned to the maximum required by the target
2519 * @see avcodec_default_get_buffer2()
2523 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2524 * (read and/or written to if it is writable) later by libavcodec.
2526 * avcodec_align_dimensions2() should be used to find the required width and
2527 * height, as they normally need to be rounded up to the next multiple of 16.
2529 * Some decoders do not support linesizes changing between frames.
2531 * If frame multithreading is used and thread_safe_callbacks is set,
2532 * this callback may be called from a different thread, but not from more
2533 * than one at once. Does not need to be reentrant.
2535 * @see avcodec_align_dimensions2()
2539 * Decoders request a buffer of a particular size by setting
2540 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2541 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2542 * to a smaller value in the output frame.
2544 * As a convenience, av_samples_get_buffer_size() and
2545 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2546 * functions to find the required data size and to fill data pointers and
2547 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2548 * since all planes must be the same size.
2550 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2552 * - encoding: unused
2553 * - decoding: Set by libavcodec, user can override.
2555 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2558 * If non-zero, the decoded audio and video frames returned from
2559 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2560 * and are valid indefinitely. The caller must free them with
2561 * av_frame_unref() when they are not needed anymore.
2562 * Otherwise, the decoded frames must not be freed by the caller and are
2563 * only valid until the next decode call.
2565 * This is always automatically enabled if avcodec_receive_frame() is used.
2567 * - encoding: unused
2568 * - decoding: set by the caller before avcodec_open2().
2570 int refcounted_frames;
2572 /* - encoding parameters */
2573 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2574 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2578 * - encoding: Set by user.
2579 * - decoding: unused
2585 * - encoding: Set by user.
2586 * - decoding: unused
2591 * maximum quantizer difference between frames
2592 * - encoding: Set by user.
2593 * - decoding: unused
2599 * @deprecated use encoder private options instead
2601 attribute_deprecated
2604 attribute_deprecated
2606 attribute_deprecated
2611 * decoder bitstream buffer size
2612 * - encoding: Set by user.
2613 * - decoding: unused
2618 * ratecontrol override, see RcOverride
2619 * - encoding: Allocated/set/freed by user.
2620 * - decoding: unused
2622 int rc_override_count;
2623 RcOverride *rc_override;
2627 * @deprecated use encoder private options instead
2629 attribute_deprecated
2635 * - encoding: Set by user.
2636 * - decoding: Set by user, may be overwritten by libavcodec.
2638 int64_t rc_max_rate;
2642 * - encoding: Set by user.
2643 * - decoding: unused
2645 int64_t rc_min_rate;
2649 * @deprecated use encoder private options instead
2651 attribute_deprecated
2652 float rc_buffer_aggressivity;
2654 attribute_deprecated
2655 float rc_initial_cplx;
2659 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2660 * - encoding: Set by user.
2661 * - decoding: unused.
2663 float rc_max_available_vbv_use;
2666 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2667 * - encoding: Set by user.
2668 * - decoding: unused.
2670 float rc_min_vbv_overflow_use;
2673 * Number of bits which should be loaded into the rc buffer before decoding starts.
2674 * - encoding: Set by user.
2675 * - decoding: unused
2677 int rc_initial_buffer_occupancy;
2679 #if FF_API_CODER_TYPE
2680 #define FF_CODER_TYPE_VLC 0
2681 #define FF_CODER_TYPE_AC 1
2682 #define FF_CODER_TYPE_RAW 2
2683 #define FF_CODER_TYPE_RLE 3
2684 #if FF_API_UNUSED_MEMBERS
2685 #define FF_CODER_TYPE_DEFLATE 4
2686 #endif /* FF_API_UNUSED_MEMBERS */
2688 * @deprecated use encoder private options instead
2690 attribute_deprecated
2692 #endif /* FF_API_CODER_TYPE */
2694 #if FF_API_PRIVATE_OPT
2695 /** @deprecated use encoder private options instead */
2696 attribute_deprecated
2702 * @deprecated use encoder private options instead
2704 attribute_deprecated
2708 * @deprecated use encoder private options instead
2710 attribute_deprecated
2714 #if FF_API_PRIVATE_OPT
2715 /** @deprecated use encoder private options instead */
2716 attribute_deprecated
2717 int frame_skip_threshold;
2719 /** @deprecated use encoder private options instead */
2720 attribute_deprecated
2721 int frame_skip_factor;
2723 /** @deprecated use encoder private options instead */
2724 attribute_deprecated
2727 /** @deprecated use encoder private options instead */
2728 attribute_deprecated
2730 #endif /* FF_API_PRIVATE_OPT */
2733 * trellis RD quantization
2734 * - encoding: Set by user.
2735 * - decoding: unused
2739 #if FF_API_PRIVATE_OPT
2740 /** @deprecated use encoder private options instead */
2741 attribute_deprecated
2742 int min_prediction_order;
2744 /** @deprecated use encoder private options instead */
2745 attribute_deprecated
2746 int max_prediction_order;
2748 /** @deprecated use encoder private options instead */
2749 attribute_deprecated
2750 int64_t timecode_frame_start;
2753 #if FF_API_RTP_CALLBACK
2755 * @deprecated unused
2757 /* The RTP callback: This function is called */
2758 /* every time the encoder has a packet to send. */
2759 /* It depends on the encoder if the data starts */
2760 /* with a Start Code (it should). H.263 does. */
2761 /* mb_nb contains the number of macroblocks */
2762 /* encoded in the RTP payload. */
2763 attribute_deprecated
2764 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2767 #if FF_API_PRIVATE_OPT
2768 /** @deprecated use encoder private options instead */
2769 attribute_deprecated
2770 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2771 /* do its best to deliver a chunk with size */
2772 /* below rtp_payload_size, the chunk will start */
2773 /* with a start code on some codecs like H.263. */
2774 /* This doesn't take account of any particular */
2775 /* headers inside the transmitted RTP payload. */
2778 #if FF_API_STAT_BITS
2779 /* statistics, used for 2-pass encoding */
2780 attribute_deprecated
2782 attribute_deprecated
2784 attribute_deprecated
2786 attribute_deprecated
2788 attribute_deprecated
2790 attribute_deprecated
2792 attribute_deprecated
2794 attribute_deprecated
2797 /** @deprecated this field is unused */
2798 attribute_deprecated
2803 * pass1 encoding statistics output buffer
2804 * - encoding: Set by libavcodec.
2805 * - decoding: unused
2810 * pass2 encoding statistics input buffer
2811 * Concatenated stuff from stats_out of pass1 should be placed here.
2812 * - encoding: Allocated/set/freed by user.
2813 * - decoding: unused
2818 * Work around bugs in encoders which sometimes cannot be detected automatically.
2819 * - encoding: Set by user
2820 * - decoding: Set by user
2822 int workaround_bugs;
2823 #define FF_BUG_AUTODETECT 1 ///< autodetection
2824 #if FF_API_OLD_MSMPEG4
2825 #define FF_BUG_OLD_MSMPEG4 2
2827 #define FF_BUG_XVID_ILACE 4
2828 #define FF_BUG_UMP4 8
2829 #define FF_BUG_NO_PADDING 16
2830 #define FF_BUG_AMV 32
2832 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2834 #define FF_BUG_QPEL_CHROMA 64
2835 #define FF_BUG_STD_QPEL 128
2836 #define FF_BUG_QPEL_CHROMA2 256
2837 #define FF_BUG_DIRECT_BLOCKSIZE 512
2838 #define FF_BUG_EDGE 1024
2839 #define FF_BUG_HPEL_CHROMA 2048
2840 #define FF_BUG_DC_CLIP 4096
2841 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2842 #define FF_BUG_TRUNCATED 16384
2845 * strictly follow the standard (MPEG4, ...).
2846 * - encoding: Set by user.
2847 * - decoding: Set by user.
2848 * Setting this to STRICT or higher means the encoder and decoder will
2849 * generally do stupid things, whereas setting it to unofficial or lower
2850 * will mean the encoder might produce output that is not supported by all
2851 * spec-compliant decoders. Decoders don't differentiate between normal,
2852 * unofficial and experimental (that is, they always try to decode things
2853 * when they can) unless they are explicitly asked to behave stupidly
2854 * (=strictly conform to the specs)
2856 int strict_std_compliance;
2857 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2858 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2859 #define FF_COMPLIANCE_NORMAL 0
2860 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2861 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2864 * error concealment flags
2865 * - encoding: unused
2866 * - decoding: Set by user.
2868 int error_concealment;
2869 #define FF_EC_GUESS_MVS 1
2870 #define FF_EC_DEBLOCK 2
2871 #define FF_EC_FAVOR_INTER 256
2875 * - encoding: Set by user.
2876 * - decoding: Set by user.
2879 #define FF_DEBUG_PICT_INFO 1
2880 #define FF_DEBUG_RC 2
2881 #define FF_DEBUG_BITSTREAM 4
2882 #define FF_DEBUG_MB_TYPE 8
2883 #define FF_DEBUG_QP 16
2886 * @deprecated this option does nothing
2888 #define FF_DEBUG_MV 32
2890 #define FF_DEBUG_DCT_COEFF 0x00000040
2891 #define FF_DEBUG_SKIP 0x00000080
2892 #define FF_DEBUG_STARTCODE 0x00000100
2893 #if FF_API_UNUSED_MEMBERS
2894 #define FF_DEBUG_PTS 0x00000200
2895 #endif /* FF_API_UNUSED_MEMBERS */
2896 #define FF_DEBUG_ER 0x00000400
2897 #define FF_DEBUG_MMCO 0x00000800
2898 #define FF_DEBUG_BUGS 0x00001000
2900 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2901 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2903 #define FF_DEBUG_BUFFERS 0x00008000
2904 #define FF_DEBUG_THREADS 0x00010000
2905 #define FF_DEBUG_GREEN_MD 0x00800000
2906 #define FF_DEBUG_NOMC 0x01000000
2911 * Code outside libavcodec should access this field using AVOptions
2912 * - encoding: Set by user.
2913 * - decoding: Set by user.
2916 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2917 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2918 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2922 * Error recognition; may misdetect some more or less valid parts as errors.
2923 * - encoding: unused
2924 * - decoding: Set by user.
2926 int err_recognition;
2929 * Verify checksums embedded in the bitstream (could be of either encoded or
2930 * decoded data, depending on the codec) and print an error message on mismatch.
2931 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2932 * decoder returning an error.
2934 #define AV_EF_CRCCHECK (1<<0)
2935 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2936 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2937 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2939 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2940 #define AV_EF_CAREFUL (1<<16) ///< consider things that violate the spec, are fast to calculate and have not been seen in the wild as errors
2941 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2942 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2946 * opaque 64bit number (generally a PTS) that will be reordered and
2947 * output in AVFrame.reordered_opaque
2948 * - encoding: unused
2949 * - decoding: Set by user.
2951 int64_t reordered_opaque;
2954 * Hardware accelerator in use
2955 * - encoding: unused.
2956 * - decoding: Set by libavcodec
2958 struct AVHWAccel *hwaccel;
2961 * Hardware accelerator context.
2962 * For some hardware accelerators, a global context needs to be
2963 * provided by the user. In that case, this holds display-dependent
2964 * data FFmpeg cannot instantiate itself. Please refer to the
2965 * FFmpeg HW accelerator documentation to know how to fill this
2966 * is. e.g. for VA API, this is a struct vaapi_context.
2967 * - encoding: unused
2968 * - decoding: Set by user
2970 void *hwaccel_context;
2974 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2975 * - decoding: unused
2977 uint64_t error[AV_NUM_DATA_POINTERS];
2980 * DCT algorithm, see FF_DCT_* below
2981 * - encoding: Set by user.
2982 * - decoding: unused
2985 #define FF_DCT_AUTO 0
2986 #define FF_DCT_FASTINT 1
2987 #define FF_DCT_INT 2
2988 #define FF_DCT_MMX 3
2989 #define FF_DCT_ALTIVEC 5
2990 #define FF_DCT_FAAN 6
2993 * IDCT algorithm, see FF_IDCT_* below.
2994 * - encoding: Set by user.
2995 * - decoding: Set by user.
2998 #define FF_IDCT_AUTO 0
2999 #define FF_IDCT_INT 1
3000 #define FF_IDCT_SIMPLE 2
3001 #define FF_IDCT_SIMPLEMMX 3
3002 #define FF_IDCT_ARM 7
3003 #define FF_IDCT_ALTIVEC 8
3005 #define FF_IDCT_SH4 9
3007 #define FF_IDCT_SIMPLEARM 10
3008 #if FF_API_UNUSED_MEMBERS
3009 #define FF_IDCT_IPP 13
3010 #endif /* FF_API_UNUSED_MEMBERS */
3011 #define FF_IDCT_XVID 14
3012 #if FF_API_IDCT_XVIDMMX
3013 #define FF_IDCT_XVIDMMX 14
3014 #endif /* FF_API_IDCT_XVIDMMX */
3015 #define FF_IDCT_SIMPLEARMV5TE 16
3016 #define FF_IDCT_SIMPLEARMV6 17
3017 #if FF_API_ARCH_SPARC
3018 #define FF_IDCT_SIMPLEVIS 18
3020 #define FF_IDCT_FAAN 20
3021 #define FF_IDCT_SIMPLENEON 22
3022 #if FF_API_ARCH_ALPHA
3023 #define FF_IDCT_SIMPLEALPHA 23
3025 #define FF_IDCT_SIMPLEAUTO 128
3028 * bits per sample/pixel from the demuxer (needed for huffyuv).
3029 * - encoding: Set by libavcodec.
3030 * - decoding: Set by user.
3032 int bits_per_coded_sample;
3035 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3036 * - encoding: set by user.
3037 * - decoding: set by libavcodec.
3039 int bits_per_raw_sample;
3043 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3044 * - encoding: unused
3045 * - decoding: Set by user.
3046 * Code outside libavcodec should access this field using:
3047 * av_codec_{get,set}_lowres(avctx)
3052 #if FF_API_CODED_FRAME
3054 * the picture in the bitstream
3055 * - encoding: Set by libavcodec.
3056 * - decoding: unused
3058 * @deprecated use the quality factor packet side data instead
3060 attribute_deprecated AVFrame *coded_frame;
3065 * is used to decide how many independent tasks should be passed to execute()
3066 * - encoding: Set by user.
3067 * - decoding: Set by user.
3072 * Which multithreading methods to use.
3073 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3074 * so clients which cannot provide future frames should not use it.
3076 * - encoding: Set by user, otherwise the default is used.
3077 * - decoding: Set by user, otherwise the default is used.
3080 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3081 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3084 * Which multithreading methods are in use by the codec.
3085 * - encoding: Set by libavcodec.
3086 * - decoding: Set by libavcodec.
3088 int active_thread_type;
3091 * Set by the client if its custom get_buffer() callback can be called
3092 * synchronously from another thread, which allows faster multithreaded decoding.
3093 * draw_horiz_band() will be called from other threads regardless of this setting.
3094 * Ignored if the default get_buffer() is used.
3095 * - encoding: Set by user.
3096 * - decoding: Set by user.
3098 int thread_safe_callbacks;
3101 * The codec may call this to execute several independent things.
3102 * It will return only after finishing all tasks.
3103 * The user may replace this with some multithreaded implementation,
3104 * the default implementation will execute the parts serially.
3105 * @param count the number of things to execute
3106 * - encoding: Set by libavcodec, user can override.
3107 * - decoding: Set by libavcodec, user can override.
3109 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3112 * The codec may call this to execute several independent things.
3113 * It will return only after finishing all tasks.
3114 * The user may replace this with some multithreaded implementation,
3115 * the default implementation will execute the parts serially.
3116 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3117 * @param c context passed also to func
3118 * @param count the number of things to execute
3119 * @param arg2 argument passed unchanged to func
3120 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3121 * @param func function that will be called count times, with jobnr from 0 to count-1.
3122 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3123 * two instances of func executing at the same time will have the same threadnr.
3124 * @return always 0 currently, but code should handle a future improvement where when any call to func
3125 * returns < 0 no further calls to func may be done and < 0 is returned.
3126 * - encoding: Set by libavcodec, user can override.
3127 * - decoding: Set by libavcodec, user can override.
3129 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3132 * noise vs. sse weight for the nsse comparison function
3133 * - encoding: Set by user.
3134 * - decoding: unused
3140 * - encoding: Set by user.
3141 * - decoding: Set by libavcodec.
3144 #define FF_PROFILE_UNKNOWN -99
3145 #define FF_PROFILE_RESERVED -100
3147 #define FF_PROFILE_AAC_MAIN 0
3148 #define FF_PROFILE_AAC_LOW 1
3149 #define FF_PROFILE_AAC_SSR 2
3150 #define FF_PROFILE_AAC_LTP 3
3151 #define FF_PROFILE_AAC_HE 4
3152 #define FF_PROFILE_AAC_HE_V2 28
3153 #define FF_PROFILE_AAC_LD 22
3154 #define FF_PROFILE_AAC_ELD 38
3155 #define FF_PROFILE_MPEG2_AAC_LOW 128
3156 #define FF_PROFILE_MPEG2_AAC_HE 131
3158 #define FF_PROFILE_DTS 20
3159 #define FF_PROFILE_DTS_ES 30
3160 #define FF_PROFILE_DTS_96_24 40
3161 #define FF_PROFILE_DTS_HD_HRA 50
3162 #define FF_PROFILE_DTS_HD_MA 60
3163 #define FF_PROFILE_DTS_EXPRESS 70
3165 #define FF_PROFILE_MPEG2_422 0
3166 #define FF_PROFILE_MPEG2_HIGH 1
3167 #define FF_PROFILE_MPEG2_SS 2
3168 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3169 #define FF_PROFILE_MPEG2_MAIN 4
3170 #define FF_PROFILE_MPEG2_SIMPLE 5
3172 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3173 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3175 #define FF_PROFILE_H264_BASELINE 66
3176 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3177 #define FF_PROFILE_H264_MAIN 77
3178 #define FF_PROFILE_H264_EXTENDED 88
3179 #define FF_PROFILE_H264_HIGH 100
3180 #define FF_PROFILE_H264_HIGH_10 110
3181 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3182 #define FF_PROFILE_H264_HIGH_422 122
3183 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3184 #define FF_PROFILE_H264_HIGH_444 144
3185 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3186 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3187 #define FF_PROFILE_H264_CAVLC_444 44
3189 #define FF_PROFILE_VC1_SIMPLE 0
3190 #define FF_PROFILE_VC1_MAIN 1
3191 #define FF_PROFILE_VC1_COMPLEX 2
3192 #define FF_PROFILE_VC1_ADVANCED 3
3194 #define FF_PROFILE_MPEG4_SIMPLE 0
3195 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3196 #define FF_PROFILE_MPEG4_CORE 2
3197 #define FF_PROFILE_MPEG4_MAIN 3
3198 #define FF_PROFILE_MPEG4_N_BIT 4
3199 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3200 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3201 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3202 #define FF_PROFILE_MPEG4_HYBRID 8
3203 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3204 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3205 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3206 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3207 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3208 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3209 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3211 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
3212 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
3213 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
3214 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3215 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3217 #define FF_PROFILE_VP9_0 0
3218 #define FF_PROFILE_VP9_1 1
3219 #define FF_PROFILE_VP9_2 2
3220 #define FF_PROFILE_VP9_3 3
3222 #define FF_PROFILE_HEVC_MAIN 1
3223 #define FF_PROFILE_HEVC_MAIN_10 2
3224 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3225 #define FF_PROFILE_HEVC_REXT 4
3229 * - encoding: Set by user.
3230 * - decoding: Set by libavcodec.
3233 #define FF_LEVEL_UNKNOWN -99
3236 * Skip loop filtering for selected frames.
3237 * - encoding: unused
3238 * - decoding: Set by user.
3240 enum AVDiscard skip_loop_filter;
3243 * Skip IDCT/dequantization for selected frames.
3244 * - encoding: unused
3245 * - decoding: Set by user.
3247 enum AVDiscard skip_idct;
3250 * Skip decoding for selected frames.
3251 * - encoding: unused
3252 * - decoding: Set by user.
3254 enum AVDiscard skip_frame;
3257 * Header containing style information for text subtitles.
3258 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3259 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3260 * the Format line following. It shouldn't include any Dialogue line.
3261 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3262 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3264 uint8_t *subtitle_header;
3265 int subtitle_header_size;
3267 #if FF_API_ERROR_RATE
3269 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3272 attribute_deprecated
3276 #if FF_API_VBV_DELAY
3278 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3279 * Used for compliant TS muxing.
3280 * - encoding: Set by libavcodec.
3281 * - decoding: unused.
3282 * @deprecated this value is now exported as a part of
3283 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3285 attribute_deprecated
3289 #if FF_API_SIDEDATA_ONLY_PKT
3291 * Encoding only and set by default. Allow encoders to output packets
3292 * that do not contain any encoded data, only side data.
3294 * Some encoders need to output such packets, e.g. to update some stream
3295 * parameters at the end of encoding.
3297 * @deprecated this field disables the default behaviour and
3298 * it is kept only for compatibility.
3300 attribute_deprecated
3301 int side_data_only_packets;
3305 * Audio only. The number of "priming" samples (padding) inserted by the
3306 * encoder at the beginning of the audio. I.e. this number of leading
3307 * decoded samples must be discarded by the caller to get the original audio
3308 * without leading padding.
3310 * - decoding: unused
3311 * - encoding: Set by libavcodec. The timestamps on the output packets are
3312 * adjusted by the encoder so that they always refer to the
3313 * first sample of the data actually contained in the packet,
3314 * including any added padding. E.g. if the timebase is
3315 * 1/samplerate and the timestamp of the first input sample is
3316 * 0, the timestamp of the first output packet will be
3319 int initial_padding;
3322 * - decoding: For codecs that store a framerate value in the compressed
3323 * bitstream, the decoder may export it here. { 0, 1} when
3325 * - encoding: unused
3327 AVRational framerate;
3330 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3331 * - encoding: unused.
3332 * - decoding: Set by libavcodec before calling get_format()
3334 enum AVPixelFormat sw_pix_fmt;
3337 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3338 * Code outside libavcodec should access this field using:
3339 * av_codec_{get,set}_pkt_timebase(avctx)
3340 * - encoding unused.
3341 * - decoding set by user.
3343 AVRational pkt_timebase;
3347 * Code outside libavcodec should access this field using:
3348 * av_codec_{get,set}_codec_descriptor(avctx)
3349 * - encoding: unused.
3350 * - decoding: set by libavcodec.
3352 const AVCodecDescriptor *codec_descriptor;
3356 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3357 * - encoding: unused
3358 * - decoding: Set by user.
3359 * Code outside libavcodec should access this field using:
3360 * av_codec_{get,set}_lowres(avctx)
3366 * Current statistics for PTS correction.
3367 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3368 * - encoding: unused
3370 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3371 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3372 int64_t pts_correction_last_pts; /// PTS of the last frame
3373 int64_t pts_correction_last_dts; /// DTS of the last frame
3376 * Character encoding of the input subtitles file.
3377 * - decoding: set by user
3378 * - encoding: unused
3383 * Subtitles character encoding mode. Formats or codecs might be adjusting
3384 * this setting (if they are doing the conversion themselves for instance).
3385 * - decoding: set by libavcodec
3386 * - encoding: unused
3388 int sub_charenc_mode;
3389 #define FF_SUB_CHARENC_MODE_DO_NOTHING -1 ///< do nothing (demuxer outputs a stream supposed to be already in UTF-8, or the codec is bitmap for instance)
3390 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3391 #define FF_SUB_CHARENC_MODE_PRE_DECODER 1 ///< the AVPacket data needs to be recoded to UTF-8 before being fed to the decoder, requires iconv
3394 * Skip processing alpha if supported by codec.
3395 * Note that if the format uses pre-multiplied alpha (common with VP6,
3396 * and recommended due to better video quality/compression)
3397 * the image will look as if alpha-blended onto a black background.
3398 * However for formats that do not use pre-multiplied alpha
3399 * there might be serious artefacts (though e.g. libswscale currently
3400 * assumes pre-multiplied alpha anyway).
3401 * Code outside libavcodec should access this field using AVOptions
3403 * - decoding: set by user
3404 * - encoding: unused
3409 * Number of samples to skip after a discontinuity
3410 * - decoding: unused
3411 * - encoding: set by libavcodec
3415 #if !FF_API_DEBUG_MV
3417 * debug motion vectors
3418 * Code outside libavcodec should access this field using AVOptions
3419 * - encoding: Set by user.
3420 * - decoding: Set by user.
3423 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3424 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3425 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3429 * custom intra quantization matrix
3430 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3431 * - encoding: Set by user, can be NULL.
3432 * - decoding: unused.
3434 uint16_t *chroma_intra_matrix;
3437 * dump format separator.
3438 * can be ", " or "\n " or anything else
3439 * Code outside libavcodec should access this field using AVOptions
3440 * (NO direct access).
3441 * - encoding: Set by user.
3442 * - decoding: Set by user.
3444 uint8_t *dump_separator;
3447 * ',' separated list of allowed decoders.
3448 * If NULL then all are allowed
3449 * - encoding: unused
3450 * - decoding: set by user through AVOPtions (NO direct access)
3452 char *codec_whitelist;
3455 * Properties of the stream that gets decoded
3456 * To be accessed through av_codec_get_properties() (NO direct access)
3457 * - encoding: unused
3458 * - decoding: set by libavcodec
3460 unsigned properties;
3461 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3462 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3465 * Additional data associated with the entire coded stream.
3467 * - decoding: unused
3468 * - encoding: may be set by libavcodec after avcodec_open2().
3470 AVPacketSideData *coded_side_data;
3471 int nb_coded_side_data;
3476 * For hardware encoders configured to use a hwaccel pixel format, this
3477 * field should be set by the caller to a reference to the AVHWFramesContext
3478 * describing input frames. AVHWFramesContext.format must be equal to
3479 * AVCodecContext.pix_fmt.
3481 * This field should be set before avcodec_open2() is called and is
3482 * afterwards owned and managed by libavcodec.
3484 AVBufferRef *hw_frames_ctx;
3487 * Control the form of AVSubtitle.rects[N]->ass
3488 * - decoding: set by user
3489 * - encoding: unused
3491 int sub_text_format;
3492 #define FF_SUB_TEXT_FMT_ASS 0
3493 #if FF_API_ASS_TIMING
3494 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3499 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3500 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3502 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3503 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3505 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3507 int av_codec_get_lowres(const AVCodecContext *avctx);
3508 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3510 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3511 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3513 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3514 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3519 typedef struct AVProfile {
3521 const char *name; ///< short name for the profile
3524 typedef struct AVCodecDefault AVCodecDefault;
3531 typedef struct AVCodec {
3533 * Name of the codec implementation.
3534 * The name is globally unique among encoders and among decoders (but an
3535 * encoder and a decoder can share the same name).
3536 * This is the primary way to find a codec from the user perspective.
3540 * Descriptive name for the codec, meant to be more human readable than name.
3541 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3543 const char *long_name;
3544 enum AVMediaType type;
3547 * Codec capabilities.
3548 * see AV_CODEC_CAP_*
3551 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3552 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3553 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3554 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3555 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3556 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3557 const AVClass *priv_class; ///< AVClass for the private context
3558 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3560 /*****************************************************************
3561 * No fields below this line are part of the public API. They
3562 * may not be used outside of libavcodec and can be changed and
3564 * New public fields should be added right above.
3565 *****************************************************************
3568 struct AVCodec *next;
3570 * @name Frame-level threading support functions
3574 * If defined, called on thread contexts when they are created.
3575 * If the codec allocates writable tables in init(), re-allocate them here.
3576 * priv_data will be set to a copy of the original.
3578 int (*init_thread_copy)(AVCodecContext *);
3580 * Copy necessary context variables from a previous thread context to the current one.
3581 * If not defined, the next thread will start automatically; otherwise, the codec
3582 * must call ff_thread_finish_setup().
3584 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3586 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3590 * Private codec-specific defaults.
3592 const AVCodecDefault *defaults;
3595 * Initialize codec static data, called from avcodec_register().
3597 void (*init_static_data)(struct AVCodec *codec);
3599 int (*init)(AVCodecContext *);
3600 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3601 const struct AVSubtitle *sub);
3603 * Encode data to an AVPacket.
3605 * @param avctx codec context
3606 * @param avpkt output AVPacket (may contain a user-provided buffer)
3607 * @param[in] frame AVFrame containing the raw data to be encoded
3608 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3609 * non-empty packet was returned in avpkt.
3610 * @return 0 on success, negative error code on failure
3612 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3613 int *got_packet_ptr);
3614 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3615 int (*close)(AVCodecContext *);
3617 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3618 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3620 * - never called if the codec is closed or the wrong type,
3621 * - AVPacket parameter change side data is applied right before calling
3622 * AVCodec->send_packet,
3623 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3624 * - only one drain packet is ever passed down (until the next flush()),
3625 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3627 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3628 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3629 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3630 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3633 * Will be called when seeking
3635 void (*flush)(AVCodecContext *);
3637 * Internal codec capabilities.
3638 * See FF_CODEC_CAP_* in internal.h
3643 int av_codec_get_max_lowres(const AVCodec *codec);
3645 struct MpegEncContext;
3648 * @defgroup lavc_hwaccel AVHWAccel
3651 typedef struct AVHWAccel {
3653 * Name of the hardware accelerated codec.
3654 * The name is globally unique among encoders and among decoders (but an
3655 * encoder and a decoder can share the same name).
3660 * Type of codec implemented by the hardware accelerator.
3662 * See AVMEDIA_TYPE_xxx
3664 enum AVMediaType type;
3667 * Codec implemented by the hardware accelerator.
3669 * See AV_CODEC_ID_xxx
3674 * Supported pixel format.
3676 * Only hardware accelerated formats are supported here.
3678 enum AVPixelFormat pix_fmt;
3681 * Hardware accelerated codec capabilities.
3682 * see HWACCEL_CODEC_CAP_*
3686 /*****************************************************************
3687 * No fields below this line are part of the public API. They
3688 * may not be used outside of libavcodec and can be changed and
3690 * New public fields should be added right above.
3691 *****************************************************************
3693 struct AVHWAccel *next;
3696 * Allocate a custom buffer
3698 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3701 * Called at the beginning of each frame or field picture.
3703 * Meaningful frame information (codec specific) is guaranteed to
3704 * be parsed at this point. This function is mandatory.
3706 * Note that buf can be NULL along with buf_size set to 0.
3707 * Otherwise, this means the whole frame is available at this point.
3709 * @param avctx the codec context
3710 * @param buf the frame data buffer base
3711 * @param buf_size the size of the frame in bytes
3712 * @return zero if successful, a negative value otherwise
3714 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3717 * Callback for each slice.
3719 * Meaningful slice information (codec specific) is guaranteed to
3720 * be parsed at this point. This function is mandatory.
3721 * The only exception is XvMC, that works on MB level.
3723 * @param avctx the codec context
3724 * @param buf the slice data buffer base
3725 * @param buf_size the size of the slice in bytes
3726 * @return zero if successful, a negative value otherwise
3728 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3731 * Called at the end of each frame or field picture.
3733 * The whole picture is parsed at this point and can now be sent
3734 * to the hardware accelerator. This function is mandatory.
3736 * @param avctx the codec context
3737 * @return zero if successful, a negative value otherwise
3739 int (*end_frame)(AVCodecContext *avctx);
3742 * Size of per-frame hardware accelerator private data.
3744 * Private data is allocated with av_mallocz() before
3745 * AVCodecContext.get_buffer() and deallocated after
3746 * AVCodecContext.release_buffer().
3748 int frame_priv_data_size;
3751 * Called for every Macroblock in a slice.
3753 * XvMC uses it to replace the ff_mpv_decode_mb().
3754 * Instead of decoding to raw picture, MB parameters are
3755 * stored in an array provided by the video driver.
3757 * @param s the mpeg context
3759 void (*decode_mb)(struct MpegEncContext *s);
3762 * Initialize the hwaccel private data.
3764 * This will be called from ff_get_format(), after hwaccel and
3765 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3768 int (*init)(AVCodecContext *avctx);
3771 * Uninitialize the hwaccel private data.
3773 * This will be called from get_format() or avcodec_close(), after hwaccel
3774 * and hwaccel_context are already uninitialized.
3776 int (*uninit)(AVCodecContext *avctx);
3779 * Size of the private data to allocate in
3780 * AVCodecInternal.hwaccel_priv_data.
3786 * Hardware acceleration should be used for decoding even if the codec level
3787 * used is unknown or higher than the maximum supported level reported by the
3790 * It's generally a good idea to pass this flag unless you have a specific
3791 * reason not to, as hardware tends to under-report supported levels.
3793 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3796 * Hardware acceleration can output YUV pixel formats with a different chroma
3797 * sampling than 4:2:0 and/or other than 8 bits per component.
3799 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3805 #if FF_API_AVPICTURE
3807 * @defgroup lavc_picture AVPicture
3809 * Functions for working with AVPicture
3814 * Picture data structure.
3816 * Up to four components can be stored into it, the last component is
3818 * @deprecated use AVFrame or imgutils functions instead
3820 typedef struct AVPicture {
3821 attribute_deprecated
3822 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3823 attribute_deprecated
3824 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3832 enum AVSubtitleType {
3835 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3838 * Plain text, the text field must be set by the decoder and is
3839 * authoritative. ass and pict fields may contain approximations.
3844 * Formatted text, the ass field must be set by the decoder and is
3845 * authoritative. pict and text fields may contain approximations.
3850 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3852 typedef struct AVSubtitleRect {
3853 int x; ///< top left corner of pict, undefined when pict is not set
3854 int y; ///< top left corner of pict, undefined when pict is not set
3855 int w; ///< width of pict, undefined when pict is not set
3856 int h; ///< height of pict, undefined when pict is not set
3857 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3859 #if FF_API_AVPICTURE
3861 * @deprecated unused
3863 attribute_deprecated
3867 * data+linesize for the bitmap of this subtitle.
3868 * Can be set for text/ass as well once they are rendered.
3873 enum AVSubtitleType type;
3875 char *text; ///< 0 terminated plain UTF-8 text
3878 * 0 terminated ASS/SSA compatible event line.
3879 * The presentation of this is unaffected by the other values in this
3887 typedef struct AVSubtitle {
3888 uint16_t format; /* 0 = graphics */
3889 uint32_t start_display_time; /* relative to packet pts, in ms */
3890 uint32_t end_display_time; /* relative to packet pts, in ms */
3892 AVSubtitleRect **rects;
3893 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3897 * This struct describes the properties of an encoded stream.
3899 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3900 * be allocated with avcodec_parameters_alloc() and freed with
3901 * avcodec_parameters_free().
3903 typedef struct AVCodecParameters {
3905 * General type of the encoded data.
3907 enum AVMediaType codec_type;
3909 * Specific type of the encoded data (the codec used).
3911 enum AVCodecID codec_id;
3913 * Additional information about the codec (corresponds to the AVI FOURCC).
3918 * Extra binary data needed for initializing the decoder, codec-dependent.
3920 * Must be allocated with av_malloc() and will be freed by
3921 * avcodec_parameters_free(). The allocated size of extradata must be at
3922 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3927 * Size of the extradata content in bytes.
3932 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3933 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3938 * The average bitrate of the encoded data (in bits per second).
3943 * The number of bits per sample in the codedwords.
3945 * This is basically the bitrate per sample. It is mandatory for a bunch of
3946 * formats to actually decode them. It's the number of bits for one sample in
3947 * the actual coded bitstream.
3949 * This could be for example 4 for ADPCM
3950 * For PCM formats this matches bits_per_raw_sample
3953 int bits_per_coded_sample;
3956 * This is the number of valid bits in each output sample. If the
3957 * sample format has more bits, the least significant bits are additional
3958 * padding bits, which are always 0. Use right shifts to reduce the sample
3959 * to its actual size. For example, audio formats with 24 bit samples will
3960 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3961 * To get the original sample use "(int32_t)sample >> 8"."
3963 * For ADPCM this might be 12 or 16 or similar
3966 int bits_per_raw_sample;
3969 * Codec-specific bitstream restrictions that the stream conforms to.
3975 * Video only. The dimensions of the video frame in pixels.
3981 * Video only. The aspect ratio (width / height) which a single pixel
3982 * should have when displayed.
3984 * When the aspect ratio is unknown / undefined, the numerator should be
3985 * set to 0 (the denominator may have any value).
3987 AVRational sample_aspect_ratio;
3990 * Video only. The order of the fields in interlaced video.
3992 enum AVFieldOrder field_order;
3995 * Video only. Additional colorspace characteristics.
3997 enum AVColorRange color_range;
3998 enum AVColorPrimaries color_primaries;
3999 enum AVColorTransferCharacteristic color_trc;
4000 enum AVColorSpace color_space;
4001 enum AVChromaLocation chroma_location;
4004 * Video only. Number of delayed frames.
4009 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4010 * unknown or unspecified, otherwise the number of bits set must be equal to
4011 * the channels field.
4013 uint64_t channel_layout;
4015 * Audio only. The number of audio channels.
4019 * Audio only. The number of audio samples per second.
4023 * Audio only. The number of bytes per coded audio frame, required by some
4026 * Corresponds to nBlockAlign in WAVEFORMATEX.
4030 * Audio only. Audio frame size, if known. Required by some formats to be static.
4035 * Audio only. The amount of padding (in samples) inserted by the encoder at
4036 * the beginning of the audio. I.e. this number of leading decoded samples
4037 * must be discarded by the caller to get the original audio without leading
4040 int initial_padding;
4042 * Audio only. The amount of padding (in samples) appended by the encoder to
4043 * the end of the audio. I.e. this number of decoded samples must be
4044 * discarded by the caller from the end of the stream to get the original
4045 * audio without any trailing padding.
4047 int trailing_padding;
4049 * Audio only. Number of samples to skip after a discontinuity.
4052 } AVCodecParameters;
4055 * If c is NULL, returns the first registered codec,
4056 * if c is non-NULL, returns the next registered codec after c,
4057 * or NULL if c is the last one.
4059 AVCodec *av_codec_next(const AVCodec *c);
4062 * Return the LIBAVCODEC_VERSION_INT constant.
4064 unsigned avcodec_version(void);
4067 * Return the libavcodec build-time configuration.
4069 const char *avcodec_configuration(void);
4072 * Return the libavcodec license.
4074 const char *avcodec_license(void);
4077 * Register the codec codec and initialize libavcodec.
4079 * @warning either this function or avcodec_register_all() must be called
4080 * before any other libavcodec functions.
4082 * @see avcodec_register_all()
4084 void avcodec_register(AVCodec *codec);
4087 * Register all the codecs, parsers and bitstream filters which were enabled at
4088 * configuration time. If you do not call this function you can select exactly
4089 * which formats you want to support, by using the individual registration
4092 * @see avcodec_register
4093 * @see av_register_codec_parser
4094 * @see av_register_bitstream_filter
4096 void avcodec_register_all(void);
4099 * Allocate an AVCodecContext and set its fields to default values. The
4100 * resulting struct should be freed with avcodec_free_context().
4102 * @param codec if non-NULL, allocate private data and initialize defaults
4103 * for the given codec. It is illegal to then call avcodec_open2()
4104 * with a different codec.
4105 * If NULL, then the codec-specific defaults won't be initialized,
4106 * which may result in suboptimal default settings (this is
4107 * important mainly for encoders, e.g. libx264).
4109 * @return An AVCodecContext filled with default values or NULL on failure.
4110 * @see avcodec_get_context_defaults
4112 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4115 * Free the codec context and everything associated with it and write NULL to
4116 * the provided pointer.
4118 void avcodec_free_context(AVCodecContext **avctx);
4121 * Set the fields of the given AVCodecContext to default values corresponding
4122 * to the given codec (defaults may be codec-dependent).
4124 * Do not call this function if a non-NULL codec has been passed
4125 * to avcodec_alloc_context3() that allocated this AVCodecContext.
4126 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
4127 * different codec on this AVCodecContext.
4129 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4132 * Get the AVClass for AVCodecContext. It can be used in combination with
4133 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4135 * @see av_opt_find().
4137 const AVClass *avcodec_get_class(void);
4140 * Get the AVClass for AVFrame. It can be used in combination with
4141 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4143 * @see av_opt_find().
4145 const AVClass *avcodec_get_frame_class(void);
4148 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4149 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4151 * @see av_opt_find().
4153 const AVClass *avcodec_get_subtitle_rect_class(void);
4156 * Copy the settings of the source AVCodecContext into the destination
4157 * AVCodecContext. The resulting destination codec context will be
4158 * unopened, i.e. you are required to call avcodec_open2() before you
4159 * can use this AVCodecContext to decode/encode video/audio data.
4161 * @param dest target codec context, should be initialized with
4162 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4163 * @param src source codec context
4164 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4166 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4169 * Allocate a new AVCodecParameters and set its fields to default values
4170 * (unknown/invalid/0). The returned struct must be freed with
4171 * avcodec_parameters_free().
4173 AVCodecParameters *avcodec_parameters_alloc(void);
4176 * Free an AVCodecParameters instance and everything associated with it and
4177 * write NULL to the supplied pointer.
4179 void avcodec_parameters_free(AVCodecParameters **par);
4182 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4183 * replaced with newly allocated duplicates of the corresponding fields in src.
4185 * @return >= 0 on success, a negative AVERROR code on failure.
4187 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4190 * Fill the parameters struct based on the values from the supplied codec
4191 * context. Any allocated fields in par are freed and replaced with duplicates
4192 * of the corresponding fields in codec.
4194 * @return >= 0 on success, a negative AVERROR code on failure
4196 int avcodec_parameters_from_context(AVCodecParameters *par,
4197 const AVCodecContext *codec);
4200 * Fill the codec context based on the values from the supplied codec
4201 * parameters. Any allocated fields in codec that have a corresponding field in
4202 * par are freed and replaced with duplicates of the corresponding field in par.
4203 * Fields in codec that do not have a counterpart in par are not touched.
4205 * @return >= 0 on success, a negative AVERROR code on failure.
4207 int avcodec_parameters_to_context(AVCodecContext *codec,
4208 const AVCodecParameters *par);
4211 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4212 * function the context has to be allocated with avcodec_alloc_context3().
4214 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4215 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4216 * retrieving a codec.
4218 * @warning This function is not thread safe!
4220 * @note Always call this function before using decoding routines (such as
4221 * @ref avcodec_receive_frame()).
4224 * avcodec_register_all();
4225 * av_dict_set(&opts, "b", "2.5M", 0);
4226 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4230 * context = avcodec_alloc_context3(codec);
4232 * if (avcodec_open2(context, codec, opts) < 0)
4236 * @param avctx The context to initialize.
4237 * @param codec The codec to open this context for. If a non-NULL codec has been
4238 * previously passed to avcodec_alloc_context3() or
4239 * avcodec_get_context_defaults3() for this context, then this
4240 * parameter MUST be either NULL or equal to the previously passed
4242 * @param options A dictionary filled with AVCodecContext and codec-private options.
4243 * On return this object will be filled with options that were not found.
4245 * @return zero on success, a negative value on error
4246 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4247 * av_dict_set(), av_opt_find().
4249 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4252 * Close a given AVCodecContext and free all the data associated with it
4253 * (but not the AVCodecContext itself).
4255 * Calling this function on an AVCodecContext that hasn't been opened will free
4256 * the codec-specific data allocated in avcodec_alloc_context3() /
4257 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
4260 int avcodec_close(AVCodecContext *avctx);
4263 * Free all allocated data in the given subtitle struct.
4265 * @param sub AVSubtitle to free.
4267 void avsubtitle_free(AVSubtitle *sub);
4274 * @addtogroup lavc_packet
4279 * Allocate an AVPacket and set its fields to default values. The resulting
4280 * struct must be freed using av_packet_free().
4282 * @return An AVPacket filled with default values or NULL on failure.
4284 * @note this only allocates the AVPacket itself, not the data buffers. Those
4285 * must be allocated through other means such as av_new_packet.
4287 * @see av_new_packet
4289 AVPacket *av_packet_alloc(void);
4292 * Create a new packet that references the same data as src.
4294 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4296 * @return newly created AVPacket on success, NULL on error.
4298 * @see av_packet_alloc
4299 * @see av_packet_ref
4301 AVPacket *av_packet_clone(AVPacket *src);
4304 * Free the packet, if the packet is reference counted, it will be
4305 * unreferenced first.
4307 * @param packet packet to be freed. The pointer will be set to NULL.
4308 * @note passing NULL is a no-op.
4310 void av_packet_free(AVPacket **pkt);
4313 * Initialize optional fields of a packet with default values.
4315 * Note, this does not touch the data and size members, which have to be
4316 * initialized separately.
4320 void av_init_packet(AVPacket *pkt);
4323 * Allocate the payload of a packet and initialize its fields with
4327 * @param size wanted payload size
4328 * @return 0 if OK, AVERROR_xxx otherwise
4330 int av_new_packet(AVPacket *pkt, int size);
4333 * Reduce packet size, correctly zeroing padding
4336 * @param size new size
4338 void av_shrink_packet(AVPacket *pkt, int size);
4341 * Increase packet size, correctly zeroing padding
4344 * @param grow_by number of bytes by which to increase the size of the packet
4346 int av_grow_packet(AVPacket *pkt, int grow_by);
4349 * Initialize a reference-counted packet from av_malloc()ed data.
4351 * @param pkt packet to be initialized. This function will set the data, size,
4352 * buf and destruct fields, all others are left untouched.
4353 * @param data Data allocated by av_malloc() to be used as packet data. If this
4354 * function returns successfully, the data is owned by the underlying AVBuffer.
4355 * The caller may not access the data through other means.
4356 * @param size size of data in bytes, without the padding. I.e. the full buffer
4357 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4359 * @return 0 on success, a negative AVERROR on error
4361 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4363 #if FF_API_AVPACKET_OLD_API
4365 * @warning This is a hack - the packet memory allocation stuff is broken. The
4366 * packet is allocated if it was not really allocated.
4368 * @deprecated Use av_packet_ref
4370 attribute_deprecated
4371 int av_dup_packet(AVPacket *pkt);
4373 * Copy packet, including contents
4375 * @return 0 on success, negative AVERROR on fail
4377 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4380 * Copy packet side data
4382 * @return 0 on success, negative AVERROR on fail
4384 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4389 * @deprecated Use av_packet_unref
4391 * @param pkt packet to free
4393 attribute_deprecated
4394 void av_free_packet(AVPacket *pkt);
4397 * Allocate new information of a packet.
4400 * @param type side information type
4401 * @param size side information size
4402 * @return pointer to fresh allocated data or NULL otherwise
4404 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4408 * Wrap an existing array as a packet side data.
4411 * @param type side information type
4412 * @param data the side data array. It must be allocated with the av_malloc()
4413 * family of functions. The ownership of the data is transferred to
4415 * @param size side information size
4416 * @return a non-negative number on success, a negative AVERROR code on
4417 * failure. On failure, the packet is unchanged and the data remains
4418 * owned by the caller.
4420 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4421 uint8_t *data, size_t size);
4424 * Shrink the already allocated side data buffer
4427 * @param type side information type
4428 * @param size new side information size
4429 * @return 0 on success, < 0 on failure
4431 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4435 * Get side information from packet.
4438 * @param type desired side information type
4439 * @param size pointer for side information size to store (optional)
4440 * @return pointer to data if present or NULL otherwise
4442 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4445 int av_packet_merge_side_data(AVPacket *pkt);
4447 int av_packet_split_side_data(AVPacket *pkt);
4449 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4452 * Pack a dictionary for use in side_data.
4454 * @param dict The dictionary to pack.
4455 * @param size pointer to store the size of the returned data
4456 * @return pointer to data if successful, NULL otherwise
4458 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4460 * Unpack a dictionary from side_data.
4462 * @param data data from side_data
4463 * @param size size of the data
4464 * @param dict the metadata storage dictionary
4465 * @return 0 on success, < 0 on failure
4467 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4471 * Convenience function to free all the side data stored.
4472 * All the other fields stay untouched.
4476 void av_packet_free_side_data(AVPacket *pkt);
4479 * Setup a new reference to the data described by a given packet
4481 * If src is reference-counted, setup dst as a new reference to the
4482 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4483 * data from src into it.
4485 * All the other fields are copied from src.
4487 * @see av_packet_unref
4489 * @param dst Destination packet
4490 * @param src Source packet
4492 * @return 0 on success, a negative AVERROR on error.
4494 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4499 * Unreference the buffer referenced by the packet and reset the
4500 * remaining packet fields to their default values.
4502 * @param pkt The packet to be unreferenced.
4504 void av_packet_unref(AVPacket *pkt);
4507 * Move every field in src to dst and reset src.
4509 * @see av_packet_unref
4511 * @param src Source packet, will be reset
4512 * @param dst Destination packet
4514 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4517 * Copy only "properties" fields from src to dst.
4519 * Properties for the purpose of this function are all the fields
4520 * beside those related to the packet data (buf, data, size)
4522 * @param dst Destination packet
4523 * @param src Source packet
4525 * @return 0 on success AVERROR on failure.
4527 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4530 * Convert valid timing fields (timestamps / durations) in a packet from one
4531 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4534 * @param pkt packet on which the conversion will be performed
4535 * @param tb_src source timebase, in which the timing fields in pkt are
4537 * @param tb_dst destination timebase, to which the timing fields will be
4540 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4547 * @addtogroup lavc_decoding
4552 * Find a registered decoder with a matching codec ID.
4554 * @param id AVCodecID of the requested decoder
4555 * @return A decoder if one was found, NULL otherwise.
4557 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4560 * Find a registered decoder with the specified name.
4562 * @param name name of the requested decoder
4563 * @return A decoder if one was found, NULL otherwise.
4565 AVCodec *avcodec_find_decoder_by_name(const char *name);
4568 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4569 * it can be called by custom get_buffer2() implementations for decoders without
4570 * AV_CODEC_CAP_DR1 set.
4572 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4576 * Return the amount of padding in pixels which the get_buffer callback must
4577 * provide around the edge of the image for codecs which do not have the
4578 * CODEC_FLAG_EMU_EDGE flag.
4580 * @return Required padding in pixels.
4582 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4585 attribute_deprecated
4586 unsigned avcodec_get_edge_width(void);
4590 * Modify width and height values so that they will result in a memory
4591 * buffer that is acceptable for the codec if you do not use any horizontal
4594 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4596 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4599 * Modify width and height values so that they will result in a memory
4600 * buffer that is acceptable for the codec if you also ensure that all
4601 * line sizes are a multiple of the respective linesize_align[i].
4603 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4605 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4606 int linesize_align[AV_NUM_DATA_POINTERS]);
4609 * Converts AVChromaLocation to swscale x/y chroma position.
4611 * The positions represent the chroma (0,0) position in a coordinates system
4612 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4614 * @param xpos horizontal chroma sample position
4615 * @param ypos vertical chroma sample position
4617 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4620 * Converts swscale x/y chroma position to AVChromaLocation.
4622 * The positions represent the chroma (0,0) position in a coordinates system
4623 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4625 * @param xpos horizontal chroma sample position
4626 * @param ypos vertical chroma sample position
4628 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4631 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4633 * Some decoders may support multiple frames in a single AVPacket. Such
4634 * decoders would then just decode the first frame and the return value would be
4635 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4636 * called again with an AVPacket containing the remaining data in order to
4637 * decode the second frame, etc... Even if no frames are returned, the packet
4638 * needs to be fed to the decoder with remaining data until it is completely
4639 * consumed or an error occurs.
4641 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4642 * and output. This means that for some packets they will not immediately
4643 * produce decoded output and need to be flushed at the end of decoding to get
4644 * all the decoded data. Flushing is done by calling this function with packets
4645 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4646 * returning samples. It is safe to flush even those decoders that are not
4647 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4649 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4650 * larger than the actual read bytes because some optimized bitstream
4651 * readers read 32 or 64 bits at once and could read over the end.
4653 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4654 * before packets may be fed to the decoder.
4656 * @param avctx the codec context
4657 * @param[out] frame The AVFrame in which to store decoded audio samples.
4658 * The decoder will allocate a buffer for the decoded frame by
4659 * calling the AVCodecContext.get_buffer2() callback.
4660 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4661 * reference counted and the returned reference belongs to the
4662 * caller. The caller must release the frame using av_frame_unref()
4663 * when the frame is no longer needed. The caller may safely write
4664 * to the frame if av_frame_is_writable() returns 1.
4665 * When AVCodecContext.refcounted_frames is set to 0, the returned
4666 * reference belongs to the decoder and is valid only until the
4667 * next call to this function or until closing or flushing the
4668 * decoder. The caller may not write to it.
4669 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4670 * non-zero. Note that this field being set to zero
4671 * does not mean that an error has occurred. For
4672 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4673 * call is guaranteed to produce a frame.
4674 * @param[in] avpkt The input AVPacket containing the input buffer.
4675 * At least avpkt->data and avpkt->size should be set. Some
4676 * decoders might also require additional fields to be set.
4677 * @return A negative error code is returned if an error occurred during
4678 * decoding, otherwise the number of bytes consumed from the input
4679 * AVPacket is returned.
4681 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4683 attribute_deprecated
4684 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4685 int *got_frame_ptr, const AVPacket *avpkt);
4688 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4689 * Some decoders may support multiple frames in a single AVPacket, such
4690 * decoders would then just decode the first frame.
4692 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4693 * the actual read bytes because some optimized bitstream readers read 32 or 64
4694 * bits at once and could read over the end.
4696 * @warning The end of the input buffer buf should be set to 0 to ensure that
4697 * no overreading happens for damaged MPEG streams.
4699 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4700 * between input and output, these need to be fed with avpkt->data=NULL,
4701 * avpkt->size=0 at the end to return the remaining frames.
4703 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4704 * before packets may be fed to the decoder.
4706 * @param avctx the codec context
4707 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4708 * Use av_frame_alloc() to get an AVFrame. The codec will
4709 * allocate memory for the actual bitmap by calling the
4710 * AVCodecContext.get_buffer2() callback.
4711 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4712 * reference counted and the returned reference belongs to the
4713 * caller. The caller must release the frame using av_frame_unref()
4714 * when the frame is no longer needed. The caller may safely write
4715 * to the frame if av_frame_is_writable() returns 1.
4716 * When AVCodecContext.refcounted_frames is set to 0, the returned
4717 * reference belongs to the decoder and is valid only until the
4718 * next call to this function or until closing or flushing the
4719 * decoder. The caller may not write to it.
4721 * @param[in] avpkt The input AVPacket containing the input buffer.
4722 * You can create such packet with av_init_packet() and by then setting
4723 * data and size, some decoders might in addition need other fields like
4724 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4726 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4727 * @return On error a negative value is returned, otherwise the number of bytes
4728 * used or zero if no frame could be decompressed.
4730 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4732 attribute_deprecated
4733 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4734 int *got_picture_ptr,
4735 const AVPacket *avpkt);
4738 * Decode a subtitle message.
4739 * Return a negative value on error, otherwise return the number of bytes used.
4740 * If no subtitle could be decompressed, got_sub_ptr is zero.
4741 * Otherwise, the subtitle is stored in *sub.
4742 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4743 * simplicity, because the performance difference is expect to be negligible
4744 * and reusing a get_buffer written for video codecs would probably perform badly
4745 * due to a potentially very different allocation pattern.
4747 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4748 * and output. This means that for some packets they will not immediately
4749 * produce decoded output and need to be flushed at the end of decoding to get
4750 * all the decoded data. Flushing is done by calling this function with packets
4751 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4752 * returning subtitles. It is safe to flush even those decoders that are not
4753 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4755 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4756 * before packets may be fed to the decoder.
4758 * @param avctx the codec context
4759 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4760 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4761 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4762 * @param[in] avpkt The input AVPacket containing the input buffer.
4764 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4769 * Supply raw packet data as input to a decoder.
4771 * Internally, this call will copy relevant AVCodecContext fields, which can
4772 * influence decoding per-packet, and apply them when the packet is actually
4773 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4774 * decoder to drop the frame contained by the packet sent with this function.)
4776 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4777 * larger than the actual read bytes because some optimized bitstream
4778 * readers read 32 or 64 bits at once and could read over the end.
4780 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4781 * on the same AVCodecContext. It will return unexpected results now
4782 * or in future libavcodec versions.
4784 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4785 * before packets may be fed to the decoder.
4787 * @param avctx codec context
4788 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4789 * frame, or several complete audio frames.
4790 * Ownership of the packet remains with the caller, and the
4791 * decoder will not write to the packet. The decoder may create
4792 * a reference to the packet data (or copy it if the packet is
4793 * not reference-counted).
4794 * Unlike with older APIs, the packet is always fully consumed,
4795 * and if it contains multiple frames (e.g. some audio codecs),
4796 * will require you to call avcodec_receive_frame() multiple
4797 * times afterwards before you can send a new packet.
4798 * It can be NULL (or an AVPacket with data set to NULL and
4799 * size set to 0); in this case, it is considered a flush
4800 * packet, which signals the end of the stream. Sending the
4801 * first flush packet will return success. Subsequent ones are
4802 * unnecessary and will return AVERROR_EOF. If the decoder
4803 * still has frames buffered, it will return them after sending
4806 * @return 0 on success, otherwise negative error code:
4807 * AVERROR(EAGAIN): input is not accepted right now - the packet must be
4808 * resent after trying to read output
4809 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4810 * be sent to it (also returned if more than 1 flush
4812 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4813 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4814 * other errors: legitimate decoding errors
4816 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4819 * Return decoded output data from a decoder.
4821 * @param avctx codec context
4822 * @param frame This will be set to a reference-counted video or audio
4823 * frame (depending on the decoder type) allocated by the
4824 * decoder. Note that the function will always call
4825 * av_frame_unref(frame) before doing anything else.
4828 * 0: success, a frame was returned
4829 * AVERROR(EAGAIN): output is not available right now - user must try
4831 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4832 * no more output frames
4833 * AVERROR(EINVAL): codec not opened, or it is an encoder
4834 * other negative values: legitimate decoding errors
4836 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4839 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4840 * to retrieve buffered output packets.
4842 * @param avctx codec context
4843 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4844 * Ownership of the frame remains with the caller, and the
4845 * encoder will not write to the frame. The encoder may create
4846 * a reference to the frame data (or copy it if the frame is
4847 * not reference-counted).
4848 * It can be NULL, in which case it is considered a flush
4849 * packet. This signals the end of the stream. If the encoder
4850 * still has packets buffered, it will return them after this
4851 * call. Once flushing mode has been entered, additional flush
4852 * packets are ignored, and sending frames will return
4856 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4857 * can have any number of samples.
4858 * If it is not set, frame->nb_samples must be equal to
4859 * avctx->frame_size for all frames except the last.
4860 * The final frame may be smaller than avctx->frame_size.
4861 * @return 0 on success, otherwise negative error code:
4862 * AVERROR(EAGAIN): input is not accepted right now - the frame must be
4863 * resent after trying to read output packets
4864 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4866 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4867 * decoder, or requires flush
4868 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4869 * other errors: legitimate decoding errors
4871 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4874 * Read encoded data from the encoder.
4876 * @param avctx codec context
4877 * @param avpkt This will be set to a reference-counted packet allocated by the
4878 * encoder. Note that the function will always call
4879 * av_frame_unref(frame) before doing anything else.
4880 * @return 0 on success, otherwise negative error code:
4881 * AVERROR(EAGAIN): output is not available right now - user must try
4883 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4884 * no more output packets
4885 * AVERROR(EINVAL): codec not opened, or it is an encoder
4886 * other errors: legitimate decoding errors
4888 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4892 * @defgroup lavc_parsing Frame parsing
4896 enum AVPictureStructure {
4897 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4898 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4899 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4900 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4903 typedef struct AVCodecParserContext {
4905 struct AVCodecParser *parser;
4906 int64_t frame_offset; /* offset of the current frame */
4907 int64_t cur_offset; /* current offset
4908 (incremented by each av_parser_parse()) */
4909 int64_t next_frame_offset; /* offset of the next frame */
4911 int pict_type; /* XXX: Put it back in AVCodecContext. */
4913 * This field is used for proper frame duration computation in lavf.
4914 * It signals, how much longer the frame duration of the current frame
4915 * is compared to normal frame duration.
4917 * frame_duration = (1 + repeat_pict) * time_base
4919 * It is used by codecs like H.264 to display telecined material.
4921 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4922 int64_t pts; /* pts of the current frame */
4923 int64_t dts; /* dts of the current frame */
4928 int fetch_timestamp;
4930 #define AV_PARSER_PTS_NB 4
4931 int cur_frame_start_index;
4932 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4933 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4934 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4937 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4938 #define PARSER_FLAG_ONCE 0x0002
4939 /// Set if the parser has a valid file offset
4940 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4941 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4943 int64_t offset; ///< byte offset from starting packet start
4944 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4947 * Set by parser to 1 for key frames and 0 for non-key frames.
4948 * It is initialized to -1, so if the parser doesn't set this flag,
4949 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4954 #if FF_API_CONVERGENCE_DURATION
4956 * @deprecated unused
4958 attribute_deprecated
4959 int64_t convergence_duration;
4962 // Timestamp generation support:
4964 * Synchronization point for start of timestamp generation.
4966 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4969 * For example, this corresponds to presence of H.264 buffering period
4975 * Offset of the current timestamp against last timestamp sync point in
4976 * units of AVCodecContext.time_base.
4978 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4979 * contain a valid timestamp offset.
4981 * Note that the timestamp of sync point has usually a nonzero
4982 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4983 * the next frame after timestamp sync point will be usually 1.
4985 * For example, this corresponds to H.264 cpb_removal_delay.
4987 int dts_ref_dts_delta;
4990 * Presentation delay of current frame in units of AVCodecContext.time_base.
4992 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4993 * contain valid non-negative timestamp delta (presentation time of a frame
4994 * must not lie in the past).
4996 * This delay represents the difference between decoding and presentation
4997 * time of the frame.
4999 * For example, this corresponds to H.264 dpb_output_delay.
5004 * Position of the packet in file.
5006 * Analogous to cur_frame_pts/dts
5008 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5011 * Byte position of currently parsed frame in stream.
5016 * Previous frame byte position.
5021 * Duration of the current frame.
5022 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5023 * For all other types, this is in units of AVCodecContext.time_base.
5027 enum AVFieldOrder field_order;
5030 * Indicate whether a picture is coded as a frame, top field or bottom field.
5032 * For example, H.264 field_pic_flag equal to 0 corresponds to
5033 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5034 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5035 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5037 enum AVPictureStructure picture_structure;
5040 * Picture number incremented in presentation or output order.
5041 * This field may be reinitialized at the first picture of a new sequence.
5043 * For example, this corresponds to H.264 PicOrderCnt.
5045 int output_picture_number;
5048 * Dimensions of the decoded video intended for presentation.
5054 * Dimensions of the coded video.
5060 * The format of the coded data, corresponds to enum AVPixelFormat for video
5061 * and for enum AVSampleFormat for audio.
5063 * Note that a decoder can have considerable freedom in how exactly it
5064 * decodes the data, so the format reported here might be different from the
5065 * one returned by a decoder.
5068 } AVCodecParserContext;
5070 typedef struct AVCodecParser {
5071 int codec_ids[5]; /* several codec IDs are permitted */
5073 int (*parser_init)(AVCodecParserContext *s);
5074 /* This callback never returns an error, a negative value means that
5075 * the frame start was in a previous packet. */
5076 int (*parser_parse)(AVCodecParserContext *s,
5077 AVCodecContext *avctx,
5078 const uint8_t **poutbuf, int *poutbuf_size,
5079 const uint8_t *buf, int buf_size);
5080 void (*parser_close)(AVCodecParserContext *s);
5081 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5082 struct AVCodecParser *next;
5085 AVCodecParser *av_parser_next(const AVCodecParser *c);
5087 void av_register_codec_parser(AVCodecParser *parser);
5088 AVCodecParserContext *av_parser_init(int codec_id);
5093 * @param s parser context.
5094 * @param avctx codec context.
5095 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5096 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5097 * @param buf input buffer.
5098 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
5099 * @param pts input presentation timestamp.
5100 * @param dts input decoding timestamp.
5101 * @param pos input byte position in stream.
5102 * @return the number of bytes of the input bitstream used.
5107 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5114 * decode_frame(data, size);
5118 int av_parser_parse2(AVCodecParserContext *s,
5119 AVCodecContext *avctx,
5120 uint8_t **poutbuf, int *poutbuf_size,
5121 const uint8_t *buf, int buf_size,
5122 int64_t pts, int64_t dts,
5126 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5127 * @deprecated use AVBitStreamFilter
5129 int av_parser_change(AVCodecParserContext *s,
5130 AVCodecContext *avctx,
5131 uint8_t **poutbuf, int *poutbuf_size,
5132 const uint8_t *buf, int buf_size, int keyframe);
5133 void av_parser_close(AVCodecParserContext *s);
5141 * @addtogroup lavc_encoding
5146 * Find a registered encoder with a matching codec ID.
5148 * @param id AVCodecID of the requested encoder
5149 * @return An encoder if one was found, NULL otherwise.
5151 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5154 * Find a registered encoder with the specified name.
5156 * @param name name of the requested encoder
5157 * @return An encoder if one was found, NULL otherwise.
5159 AVCodec *avcodec_find_encoder_by_name(const char *name);
5162 * Encode a frame of audio.
5164 * Takes input samples from frame and writes the next output packet, if
5165 * available, to avpkt. The output packet does not necessarily contain data for
5166 * the most recent frame, as encoders can delay, split, and combine input frames
5167 * internally as needed.
5169 * @param avctx codec context
5170 * @param avpkt output AVPacket.
5171 * The user can supply an output buffer by setting
5172 * avpkt->data and avpkt->size prior to calling the
5173 * function, but if the size of the user-provided data is not
5174 * large enough, encoding will fail. If avpkt->data and
5175 * avpkt->size are set, avpkt->destruct must also be set. All
5176 * other AVPacket fields will be reset by the encoder using
5177 * av_init_packet(). If avpkt->data is NULL, the encoder will
5178 * allocate it. The encoder will set avpkt->size to the size
5179 * of the output packet.
5181 * If this function fails or produces no output, avpkt will be
5182 * freed using av_packet_unref().
5183 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5184 * May be NULL when flushing an encoder that has the
5185 * AV_CODEC_CAP_DELAY capability set.
5186 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5187 * can have any number of samples.
5188 * If it is not set, frame->nb_samples must be equal to
5189 * avctx->frame_size for all frames except the last.
5190 * The final frame may be smaller than avctx->frame_size.
5191 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5192 * output packet is non-empty, and to 0 if it is
5193 * empty. If the function returns an error, the
5194 * packet can be assumed to be invalid, and the
5195 * value of got_packet_ptr is undefined and should
5197 * @return 0 on success, negative error code on failure
5199 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5200 const AVFrame *frame, int *got_packet_ptr);
5203 * Encode a frame of video.
5205 * Takes input raw video data from frame and writes the next output packet, if
5206 * available, to avpkt. The output packet does not necessarily contain data for
5207 * the most recent frame, as encoders can delay and reorder input frames
5208 * internally as needed.
5210 * @param avctx codec context
5211 * @param avpkt output AVPacket.
5212 * The user can supply an output buffer by setting
5213 * avpkt->data and avpkt->size prior to calling the
5214 * function, but if the size of the user-provided data is not
5215 * large enough, encoding will fail. All other AVPacket fields
5216 * will be reset by the encoder using av_init_packet(). If
5217 * avpkt->data is NULL, the encoder will allocate it.
5218 * The encoder will set avpkt->size to the size of the
5219 * output packet. The returned data (if any) belongs to the
5220 * caller, he is responsible for freeing it.
5222 * If this function fails or produces no output, avpkt will be
5223 * freed using av_packet_unref().
5224 * @param[in] frame AVFrame containing the raw video data to be encoded.
5225 * May be NULL when flushing an encoder that has the
5226 * AV_CODEC_CAP_DELAY capability set.
5227 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5228 * output packet is non-empty, and to 0 if it is
5229 * empty. If the function returns an error, the
5230 * packet can be assumed to be invalid, and the
5231 * value of got_packet_ptr is undefined and should
5233 * @return 0 on success, negative error code on failure
5235 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5236 const AVFrame *frame, int *got_packet_ptr);
5238 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5239 const AVSubtitle *sub);
5246 #if FF_API_AVCODEC_RESAMPLE
5248 * @defgroup lavc_resample Audio resampling
5250 * @deprecated use libswresample instead
5254 struct ReSampleContext;
5255 struct AVResampleContext;
5257 typedef struct ReSampleContext ReSampleContext;
5260 * Initialize audio resampling context.
5262 * @param output_channels number of output channels
5263 * @param input_channels number of input channels
5264 * @param output_rate output sample rate
5265 * @param input_rate input sample rate
5266 * @param sample_fmt_out requested output sample format
5267 * @param sample_fmt_in input sample format
5268 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5269 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5270 * @param linear if 1 then the used FIR filter will be linearly interpolated
5271 between the 2 closest, if 0 the closest will be used
5272 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5273 * @return allocated ReSampleContext, NULL if error occurred
5275 attribute_deprecated
5276 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5277 int output_rate, int input_rate,
5278 enum AVSampleFormat sample_fmt_out,
5279 enum AVSampleFormat sample_fmt_in,
5280 int filter_length, int log2_phase_count,
5281 int linear, double cutoff);
5283 attribute_deprecated
5284 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5287 * Free resample context.
5289 * @param s a non-NULL pointer to a resample context previously
5290 * created with av_audio_resample_init()
5292 attribute_deprecated
5293 void audio_resample_close(ReSampleContext *s);
5297 * Initialize an audio resampler.
5298 * Note, if either rate is not an integer then simply scale both rates up so they are.
5299 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5300 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5301 * @param linear If 1 then the used FIR filter will be linearly interpolated
5302 between the 2 closest, if 0 the closest will be used
5303 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5305 attribute_deprecated
5306 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5309 * Resample an array of samples using a previously configured context.
5310 * @param src an array of unconsumed samples
5311 * @param consumed the number of samples of src which have been consumed are returned here
5312 * @param src_size the number of unconsumed samples available
5313 * @param dst_size the amount of space in samples available in dst
5314 * @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.
5315 * @return the number of samples written in dst or -1 if an error occurred
5317 attribute_deprecated
5318 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5322 * Compensate samplerate/timestamp drift. The compensation is done by changing
5323 * the resampler parameters, so no audible clicks or similar distortions occur
5324 * @param compensation_distance distance in output samples over which the compensation should be performed
5325 * @param sample_delta number of output samples which should be output less
5327 * example: av_resample_compensate(c, 10, 500)
5328 * here instead of 510 samples only 500 samples would be output
5330 * note, due to rounding the actual compensation might be slightly different,
5331 * especially if the compensation_distance is large and the in_rate used during init is small
5333 attribute_deprecated
5334 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5335 attribute_deprecated
5336 void av_resample_close(struct AVResampleContext *c);
5343 #if FF_API_AVPICTURE
5345 * @addtogroup lavc_picture
5350 * @deprecated unused
5352 attribute_deprecated
5353 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5356 * @deprecated unused
5358 attribute_deprecated
5359 void avpicture_free(AVPicture *picture);
5362 * @deprecated use av_image_fill_arrays() instead.
5364 attribute_deprecated
5365 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5366 enum AVPixelFormat pix_fmt, int width, int height);
5369 * @deprecated use av_image_copy_to_buffer() instead.
5371 attribute_deprecated
5372 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5373 int width, int height,
5374 unsigned char *dest, int dest_size);
5377 * @deprecated use av_image_get_buffer_size() instead.
5379 attribute_deprecated
5380 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5383 * @deprecated av_image_copy() instead.
5385 attribute_deprecated
5386 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5387 enum AVPixelFormat pix_fmt, int width, int height);
5390 * @deprecated unused
5392 attribute_deprecated
5393 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5394 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5397 * @deprecated unused
5399 attribute_deprecated
5400 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5401 int padtop, int padbottom, int padleft, int padright, int *color);
5409 * @defgroup lavc_misc Utility functions
5412 * Miscellaneous utility functions related to both encoding and decoding
5418 * @defgroup lavc_misc_pixfmt Pixel formats
5420 * Functions for working with pixel formats.
5425 * Utility function to access log2_chroma_w log2_chroma_h from
5426 * the pixel format AVPixFmtDescriptor.
5428 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5429 * for one that returns a failure code and continues in case of invalid
5432 * @param[in] pix_fmt the pixel format
5433 * @param[out] h_shift store log2_chroma_w
5434 * @param[out] v_shift store log2_chroma_h
5436 * @see av_pix_fmt_get_chroma_sub_sample
5439 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5442 * Return a value representing the fourCC code associated to the
5443 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5446 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5449 * @deprecated see av_get_pix_fmt_loss()
5451 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5455 * Find the best pixel format to convert to given a certain source pixel
5456 * format. When converting from one pixel format to another, information loss
5457 * may occur. For example, when converting from RGB24 to GRAY, the color
5458 * information will be lost. Similarly, other losses occur when converting from
5459 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5460 * the given pixel formats should be used to suffer the least amount of loss.
5461 * The pixel formats from which it chooses one, are determined by the
5462 * pix_fmt_list parameter.
5465 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5466 * @param[in] src_pix_fmt source pixel format
5467 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5468 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5469 * @return The best pixel format to convert to or -1 if none was found.
5471 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5472 enum AVPixelFormat src_pix_fmt,
5473 int has_alpha, int *loss_ptr);
5476 * @deprecated see av_find_best_pix_fmt_of_2()
5478 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5479 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5481 attribute_deprecated
5482 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
5483 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
5484 enum AVPixelFormat src_pix_fmt,
5485 int has_alpha, int *loss_ptr);
5487 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5488 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5492 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5498 #if FF_API_SET_DIMENSIONS
5500 * @deprecated this function is not supposed to be used from outside of lavc
5502 attribute_deprecated
5503 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5507 * Put a string representing the codec tag codec_tag in buf.
5509 * @param buf buffer to place codec tag in
5510 * @param buf_size size in bytes of buf
5511 * @param codec_tag codec tag to assign
5512 * @return the length of the string that would have been generated if
5513 * enough space had been available, excluding the trailing null
5515 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5517 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5520 * Return a name for the specified profile, if available.
5522 * @param codec the codec that is searched for the given profile
5523 * @param profile the profile value for which a name is requested
5524 * @return A name for the profile if found, NULL otherwise.
5526 const char *av_get_profile_name(const AVCodec *codec, int profile);
5529 * Return a name for the specified profile, if available.
5531 * @param codec_id the ID of the codec to which the requested profile belongs
5532 * @param profile the profile value for which a name is requested
5533 * @return A name for the profile if found, NULL otherwise.
5535 * @note unlike av_get_profile_name(), which searches a list of profiles
5536 * supported by a specific decoder or encoder implementation, this
5537 * function searches the list of profiles from the AVCodecDescriptor
5539 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5541 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5542 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5543 //FIXME func typedef
5546 * Fill AVFrame audio data and linesize pointers.
5548 * The buffer buf must be a preallocated buffer with a size big enough
5549 * to contain the specified samples amount. The filled AVFrame data
5550 * pointers will point to this buffer.
5552 * AVFrame extended_data channel pointers are allocated if necessary for
5555 * @param frame the AVFrame
5556 * frame->nb_samples must be set prior to calling the
5557 * function. This function fills in frame->data,
5558 * frame->extended_data, frame->linesize[0].
5559 * @param nb_channels channel count
5560 * @param sample_fmt sample format
5561 * @param buf buffer to use for frame data
5562 * @param buf_size size of buffer
5563 * @param align plane size sample alignment (0 = default)
5564 * @return >=0 on success, negative error code on failure
5565 * @todo return the size in bytes required to store the samples in
5566 * case of success, at the next libavutil bump
5568 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5569 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5570 int buf_size, int align);
5573 * Reset the internal decoder state / flush internal buffers. Should be called
5574 * e.g. when seeking or when switching to a different stream.
5576 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5577 * this invalidates the frames previously returned from the decoder. When
5578 * refcounted frames are used, the decoder just releases any references it might
5579 * keep internally, but the caller's reference remains valid.
5581 void avcodec_flush_buffers(AVCodecContext *avctx);
5584 * Return codec bits per sample.
5586 * @param[in] codec_id the codec
5587 * @return Number of bits per sample or zero if unknown for the given codec.
5589 int av_get_bits_per_sample(enum AVCodecID codec_id);
5592 * Return the PCM codec associated with a sample format.
5593 * @param be endianness, 0 for little, 1 for big,
5594 * -1 (or anything else) for native
5595 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5597 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5600 * Return codec bits per sample.
5601 * Only return non-zero if the bits per sample is exactly correct, not an
5604 * @param[in] codec_id the codec
5605 * @return Number of bits per sample or zero if unknown for the given codec.
5607 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5610 * Return audio frame duration.
5612 * @param avctx codec context
5613 * @param frame_bytes size of the frame, or 0 if unknown
5614 * @return frame duration, in samples, if known. 0 if not able to
5617 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5620 * This function is the same as av_get_audio_frame_duration(), except it works
5621 * with AVCodecParameters instead of an AVCodecContext.
5623 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5626 typedef struct AVBitStreamFilterContext {
5628 struct AVBitStreamFilter *filter;
5629 AVCodecParserContext *parser;
5630 struct AVBitStreamFilterContext *next;
5632 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5633 * Not for access by library users.
5636 } AVBitStreamFilterContext;
5639 typedef struct AVBSFInternal AVBSFInternal;
5642 * The bitstream filter state.
5644 * This struct must be allocated with av_bsf_alloc() and freed with
5647 * The fields in the struct will only be changed (by the caller or by the
5648 * filter) as described in their documentation, and are to be considered
5649 * immutable otherwise.
5651 typedef struct AVBSFContext {
5653 * A class for logging and AVOptions
5655 const AVClass *av_class;
5658 * The bitstream filter this context is an instance of.
5660 const struct AVBitStreamFilter *filter;
5663 * Opaque libavcodec internal data. Must not be touched by the caller in any
5666 AVBSFInternal *internal;
5669 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5670 * this is an AVOptions-enabled struct.
5675 * Parameters of the input stream. Set by the caller before av_bsf_init().
5677 AVCodecParameters *par_in;
5680 * Parameters of the output stream. Set by the filter in av_bsf_init().
5682 AVCodecParameters *par_out;
5685 * The timebase used for the timestamps of the input packets. Set by the
5686 * caller before av_bsf_init().
5688 AVRational time_base_in;
5691 * The timebase used for the timestamps of the output packets. Set by the
5692 * filter in av_bsf_init().
5694 AVRational time_base_out;
5697 typedef struct AVBitStreamFilter {
5701 * A list of codec ids supported by the filter, terminated by
5703 * May be NULL, in that case the bitstream filter works with any codec id.
5705 const enum AVCodecID *codec_ids;
5708 * A class for the private data, used to declare bitstream filter private
5709 * AVOptions. This field is NULL for bitstream filters that do not declare
5712 * If this field is non-NULL, the first member of the filter private data
5713 * must be a pointer to AVClass, which will be set by libavcodec generic
5714 * code to this class.
5716 const AVClass *priv_class;
5718 /*****************************************************************
5719 * No fields below this line are part of the public API. They
5720 * may not be used outside of libavcodec and can be changed and
5722 * New public fields should be added right above.
5723 *****************************************************************
5727 int (*init)(AVBSFContext *ctx);
5728 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5729 void (*close)(AVBSFContext *ctx);
5730 } AVBitStreamFilter;
5734 * Register a bitstream filter.
5736 * The filter will be accessible to the application code through
5737 * av_bitstream_filter_next() or can be directly initialized with
5738 * av_bitstream_filter_init().
5740 * @see avcodec_register_all()
5742 attribute_deprecated
5743 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5746 * Create and initialize a bitstream filter context given a bitstream
5749 * The returned context must be freed with av_bitstream_filter_close().
5751 * @param name the name of the bitstream filter
5752 * @return a bitstream filter context if a matching filter was found
5753 * and successfully initialized, NULL otherwise
5755 attribute_deprecated
5756 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5761 * This function filters the buffer buf with size buf_size, and places the
5762 * filtered buffer in the buffer pointed to by poutbuf.
5764 * The output buffer must be freed by the caller.
5766 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5767 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5768 * If specified, this must point to the encoder context of the
5769 * output stream the packet is sent to.
5770 * @param args arguments which specify the filter configuration, may be NULL
5771 * @param poutbuf pointer which is updated to point to the filtered buffer
5772 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5773 * @param buf buffer containing the data to filter
5774 * @param buf_size size in bytes of buf
5775 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5776 * @return >= 0 in case of success, or a negative error code in case of failure
5778 * If the return value is positive, an output buffer is allocated and
5779 * is available in *poutbuf, and is distinct from the input buffer.
5781 * If the return value is 0, the output buffer is not allocated and
5782 * should be considered identical to the input buffer, or in case
5783 * *poutbuf was set it points to the input buffer (not necessarily to
5784 * its starting address). A special case is if *poutbuf was set to NULL and
5785 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5787 attribute_deprecated
5788 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5789 AVCodecContext *avctx, const char *args,
5790 uint8_t **poutbuf, int *poutbuf_size,
5791 const uint8_t *buf, int buf_size, int keyframe);
5794 * Release bitstream filter context.
5796 * @param bsf the bitstream filter context created with
5797 * av_bitstream_filter_init(), can be NULL
5799 attribute_deprecated
5800 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5803 * If f is NULL, return the first registered bitstream filter,
5804 * if f is non-NULL, return the next registered bitstream filter
5805 * after f, or NULL if f is the last one.
5807 * This function can be used to iterate over all registered bitstream
5810 attribute_deprecated
5811 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5815 * @return a bitstream filter with the specified name or NULL if no such
5816 * bitstream filter exists.
5818 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5821 * Iterate over all registered bitstream filters.
5823 * @param opaque a pointer where libavcodec will store the iteration state. Must
5824 * point to NULL to start the iteration.
5826 * @return the next registered bitstream filter or NULL when the iteration is
5829 const AVBitStreamFilter *av_bsf_next(void **opaque);
5832 * Allocate a context for a given bitstream filter. The caller must fill in the
5833 * context parameters as described in the documentation and then call
5834 * av_bsf_init() before sending any data to the filter.
5836 * @param filter the filter for which to allocate an instance.
5837 * @param ctx a pointer into which the pointer to the newly-allocated context
5838 * will be written. It must be freed with av_bsf_free() after the
5839 * filtering is done.
5841 * @return 0 on success, a negative AVERROR code on failure
5843 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5846 * Prepare the filter for use, after all the parameters and options have been
5849 int av_bsf_init(AVBSFContext *ctx);
5852 * Submit a packet for filtering.
5854 * After sending each packet, the filter must be completely drained by calling
5855 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5858 * @param pkt the packet to filter. The bitstream filter will take ownership of
5859 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5860 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5861 * packets will be sent). That will cause the filter to output any packets it
5862 * may have buffered internally.
5864 * @return 0 on success, a negative AVERROR on error.
5866 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5869 * Retrieve a filtered packet.
5871 * @param[out] pkt this struct will be filled with the contents of the filtered
5872 * packet. It is owned by the caller and must be freed using
5873 * av_packet_unref() when it is no longer needed.
5874 * This parameter should be "clean" (i.e. freshly allocated
5875 * with av_packet_alloc() or unreffed with av_packet_unref())
5876 * when this function is called. If this function returns
5877 * successfully, the contents of pkt will be completely
5878 * overwritten by the returned data. On failure, pkt is not
5881 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5882 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5883 * will be no further output from the filter. Another negative AVERROR value if
5886 * @note one input packet may result in several output packets, so after sending
5887 * a packet with av_bsf_send_packet(), this function needs to be called
5888 * repeatedly until it stops returning 0. It is also possible for a filter to
5889 * output fewer packets than were sent to it, so this function may return
5890 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5892 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5895 * Free a bitstream filter context and everything associated with it; write NULL
5896 * into the supplied pointer.
5898 void av_bsf_free(AVBSFContext **ctx);
5901 * Get the AVClass for AVBSFContext. It can be used in combination with
5902 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5904 * @see av_opt_find().
5906 const AVClass *av_bsf_get_class(void);
5911 * Same behaviour av_fast_malloc but the buffer has additional
5912 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5914 * In addition the whole buffer will initially and after resizes
5915 * be 0-initialized so that no uninitialized data will ever appear.
5917 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5920 * Same behaviour av_fast_padded_malloc except that buffer will always
5921 * be 0-initialized after call.
5923 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5926 * Encode extradata length to a buffer. Used by xiph codecs.
5928 * @param s buffer to write to; must be at least (v/255+1) bytes long
5929 * @param v size of extradata in bytes
5930 * @return number of bytes written to the buffer.
5932 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5934 #if FF_API_MISSING_SAMPLE
5936 * Log a generic warning message about a missing feature. This function is
5937 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5938 * only, and would normally not be used by applications.
5939 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5940 * a pointer to an AVClass struct
5941 * @param[in] feature string containing the name of the missing feature
5942 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5943 * If want_sample is non-zero, additional verbage will be added to the log
5944 * message which tells the user how to report samples to the development
5946 * @deprecated Use avpriv_report_missing_feature() instead.
5948 attribute_deprecated
5949 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5952 * Log a generic warning message asking for a sample. This function is
5953 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5954 * only, and would normally not be used by applications.
5955 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5956 * a pointer to an AVClass struct
5957 * @param[in] msg string containing an optional message, or NULL if no message
5958 * @deprecated Use avpriv_request_sample() instead.
5960 attribute_deprecated
5961 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5962 #endif /* FF_API_MISSING_SAMPLE */
5965 * Register the hardware accelerator hwaccel.
5967 void av_register_hwaccel(AVHWAccel *hwaccel);
5970 * If hwaccel is NULL, returns the first registered hardware accelerator,
5971 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5972 * after hwaccel, or NULL if hwaccel is the last one.
5974 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5978 * Lock operation used by lockmgr
5981 AV_LOCK_CREATE, ///< Create a mutex
5982 AV_LOCK_OBTAIN, ///< Lock the mutex
5983 AV_LOCK_RELEASE, ///< Unlock the mutex
5984 AV_LOCK_DESTROY, ///< Free mutex resources
5988 * Register a user provided lock manager supporting the operations
5989 * specified by AVLockOp. The "mutex" argument to the function points
5990 * to a (void *) where the lockmgr should store/get a pointer to a user
5991 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5992 * value left by the last call for all other ops. If the lock manager is
5993 * unable to perform the op then it should leave the mutex in the same
5994 * state as when it was called and return a non-zero value. However,
5995 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5996 * have been successfully destroyed. If av_lockmgr_register succeeds
5997 * it will return a non-negative value, if it fails it will return a
5998 * negative value and destroy all mutex and unregister all callbacks.
5999 * av_lockmgr_register is not thread-safe, it must be called from a
6000 * single thread before any calls which make use of locking are used.
6002 * @param cb User defined callback. av_lockmgr_register invokes calls
6003 * to this callback and the previously registered callback.
6004 * The callback will be used to create more than one mutex
6005 * each of which must be backed by its own underlying locking
6006 * mechanism (i.e. do not use a single static object to
6007 * implement your lock manager). If cb is set to NULL the
6008 * lockmgr will be unregistered.
6010 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6013 * Get the type of the given codec.
6015 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6018 * Get the name of a codec.
6019 * @return a static string identifying the codec; never NULL
6021 const char *avcodec_get_name(enum AVCodecID id);
6024 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6025 * with no corresponding avcodec_close()), 0 otherwise.
6027 int avcodec_is_open(AVCodecContext *s);
6030 * @return a non-zero number if codec is an encoder, zero otherwise
6032 int av_codec_is_encoder(const AVCodec *codec);
6035 * @return a non-zero number if codec is a decoder, zero otherwise
6037 int av_codec_is_decoder(const AVCodec *codec);
6040 * @return descriptor for given codec ID or NULL if no descriptor exists.
6042 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6045 * Iterate over all codec descriptors known to libavcodec.
6047 * @param prev previous descriptor. NULL to get the first descriptor.
6049 * @return next descriptor or NULL after the last descriptor
6051 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6054 * @return codec descriptor with the given name or NULL if no such descriptor
6057 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6060 * Allocate a CPB properties structure and initialize its fields to default
6063 * @param size if non-NULL, the size of the allocated struct will be written
6064 * here. This is useful for embedding it in side data.
6066 * @return the newly allocated struct or NULL on failure
6068 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6074 #endif /* AVCODEC_AVCODEC_H */