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,
408 /* various PCM "codecs" */
409 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
410 AV_CODEC_ID_PCM_S16LE = 0x10000,
411 AV_CODEC_ID_PCM_S16BE,
412 AV_CODEC_ID_PCM_U16LE,
413 AV_CODEC_ID_PCM_U16BE,
416 AV_CODEC_ID_PCM_MULAW,
417 AV_CODEC_ID_PCM_ALAW,
418 AV_CODEC_ID_PCM_S32LE,
419 AV_CODEC_ID_PCM_S32BE,
420 AV_CODEC_ID_PCM_U32LE,
421 AV_CODEC_ID_PCM_U32BE,
422 AV_CODEC_ID_PCM_S24LE,
423 AV_CODEC_ID_PCM_S24BE,
424 AV_CODEC_ID_PCM_U24LE,
425 AV_CODEC_ID_PCM_U24BE,
426 AV_CODEC_ID_PCM_S24DAUD,
427 AV_CODEC_ID_PCM_ZORK,
428 AV_CODEC_ID_PCM_S16LE_PLANAR,
430 AV_CODEC_ID_PCM_F32BE,
431 AV_CODEC_ID_PCM_F32LE,
432 AV_CODEC_ID_PCM_F64BE,
433 AV_CODEC_ID_PCM_F64LE,
434 AV_CODEC_ID_PCM_BLURAY,
437 AV_CODEC_ID_PCM_S8_PLANAR,
438 AV_CODEC_ID_PCM_S24LE_PLANAR,
439 AV_CODEC_ID_PCM_S32LE_PLANAR,
440 AV_CODEC_ID_PCM_S16BE_PLANAR,
441 /* new PCM "codecs" should be added right below this line starting with
442 * an explicit value of for example 0x10800
445 /* various ADPCM codecs */
446 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
447 AV_CODEC_ID_ADPCM_IMA_WAV,
448 AV_CODEC_ID_ADPCM_IMA_DK3,
449 AV_CODEC_ID_ADPCM_IMA_DK4,
450 AV_CODEC_ID_ADPCM_IMA_WS,
451 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
452 AV_CODEC_ID_ADPCM_MS,
453 AV_CODEC_ID_ADPCM_4XM,
454 AV_CODEC_ID_ADPCM_XA,
455 AV_CODEC_ID_ADPCM_ADX,
456 AV_CODEC_ID_ADPCM_EA,
457 AV_CODEC_ID_ADPCM_G726,
458 AV_CODEC_ID_ADPCM_CT,
459 AV_CODEC_ID_ADPCM_SWF,
460 AV_CODEC_ID_ADPCM_YAMAHA,
461 AV_CODEC_ID_ADPCM_SBPRO_4,
462 AV_CODEC_ID_ADPCM_SBPRO_3,
463 AV_CODEC_ID_ADPCM_SBPRO_2,
464 AV_CODEC_ID_ADPCM_THP,
465 AV_CODEC_ID_ADPCM_IMA_AMV,
466 AV_CODEC_ID_ADPCM_EA_R1,
467 AV_CODEC_ID_ADPCM_EA_R3,
468 AV_CODEC_ID_ADPCM_EA_R2,
469 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
470 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
471 AV_CODEC_ID_ADPCM_EA_XAS,
472 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
473 AV_CODEC_ID_ADPCM_IMA_ISS,
474 AV_CODEC_ID_ADPCM_G722,
475 AV_CODEC_ID_ADPCM_IMA_APC,
476 AV_CODEC_ID_ADPCM_VIMA,
477 #if FF_API_VIMA_DECODER
478 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
481 AV_CODEC_ID_ADPCM_AFC = 0x11800,
482 AV_CODEC_ID_ADPCM_IMA_OKI,
483 AV_CODEC_ID_ADPCM_DTK,
484 AV_CODEC_ID_ADPCM_IMA_RAD,
485 AV_CODEC_ID_ADPCM_G726LE,
486 AV_CODEC_ID_ADPCM_THP_LE,
487 AV_CODEC_ID_ADPCM_PSX,
488 AV_CODEC_ID_ADPCM_AICA,
489 AV_CODEC_ID_ADPCM_IMA_DAT4,
492 AV_CODEC_ID_AMR_NB = 0x12000,
495 /* RealAudio codecs*/
496 AV_CODEC_ID_RA_144 = 0x13000,
499 /* various DPCM codecs */
500 AV_CODEC_ID_ROQ_DPCM = 0x14000,
501 AV_CODEC_ID_INTERPLAY_DPCM,
502 AV_CODEC_ID_XAN_DPCM,
503 AV_CODEC_ID_SOL_DPCM,
505 AV_CODEC_ID_SDX2_DPCM = 0x14800,
508 AV_CODEC_ID_MP2 = 0x15000,
509 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
519 AV_CODEC_ID_VMDAUDIO,
525 AV_CODEC_ID_WESTWOOD_SND1,
526 AV_CODEC_ID_GSM, ///< as in Berlin toast format
529 AV_CODEC_ID_TRUESPEECH,
531 AV_CODEC_ID_SMACKAUDIO,
534 AV_CODEC_ID_DSICINAUDIO,
536 AV_CODEC_ID_MUSEPACK7,
538 AV_CODEC_ID_GSM_MS, /* as found in WAV */
544 AV_CODEC_ID_NELLYMOSER,
545 AV_CODEC_ID_MUSEPACK8,
547 AV_CODEC_ID_WMAVOICE,
549 AV_CODEC_ID_WMALOSSLESS,
558 AV_CODEC_ID_BINKAUDIO_RDFT,
559 AV_CODEC_ID_BINKAUDIO_DCT,
560 AV_CODEC_ID_AAC_LATM,
565 AV_CODEC_ID_8SVX_EXP,
566 AV_CODEC_ID_8SVX_FIB,
567 AV_CODEC_ID_BMV_AUDIO,
572 AV_CODEC_ID_COMFORT_NOISE,
574 AV_CODEC_ID_METASOUND,
575 AV_CODEC_ID_PAF_AUDIO,
579 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
581 AV_CODEC_ID_SONIC_LS,
584 AV_CODEC_ID_DSD_LSBF,
585 AV_CODEC_ID_DSD_MSBF,
586 AV_CODEC_ID_DSD_LSBF_PLANAR,
587 AV_CODEC_ID_DSD_MSBF_PLANAR,
589 AV_CODEC_ID_INTERPLAY_ACM,
593 /* subtitle codecs */
594 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
595 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
596 AV_CODEC_ID_DVB_SUBTITLE,
597 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
600 AV_CODEC_ID_MOV_TEXT,
601 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
602 AV_CODEC_ID_DVB_TELETEXT,
605 AV_CODEC_ID_MICRODVD = 0x17800,
609 AV_CODEC_ID_REALTEXT,
611 AV_CODEC_ID_SUBVIEWER1,
612 AV_CODEC_ID_SUBVIEWER,
619 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
621 /* other specific kind of codecs (generally used for attachments) */
622 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
623 AV_CODEC_ID_TTF = 0x18000,
625 AV_CODEC_ID_BINTEXT = 0x18800,
629 AV_CODEC_ID_SMPTE_KLV,
631 AV_CODEC_ID_TIMED_ID3,
632 AV_CODEC_ID_BIN_DATA,
635 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
637 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
638 * stream (only used by libavformat) */
639 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
640 * stream (only used by libavformat) */
641 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
642 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
646 * This struct describes the properties of a single codec described by an
648 * @see avcodec_descriptor_get()
650 typedef struct AVCodecDescriptor {
652 enum AVMediaType type;
654 * Name of the codec described by this descriptor. It is non-empty and
655 * unique for each codec descriptor. It should contain alphanumeric
656 * characters and '_' only.
660 * A more descriptive name for this codec. May be NULL.
662 const char *long_name;
664 * Codec properties, a combination of AV_CODEC_PROP_* flags.
668 * MIME type(s) associated with the codec.
669 * May be NULL; if not, a NULL-terminated array of MIME types.
670 * The first item is always non-NULL and is the preferred MIME type.
672 const char *const *mime_types;
674 * If non-NULL, an array of profiles recognized for this codec.
675 * Terminated with FF_PROFILE_UNKNOWN.
677 const struct AVProfile *profiles;
681 * Codec uses only intra compression.
684 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
686 * Codec supports lossy compression. Audio and video codecs only.
687 * @note a codec may support both lossy and lossless
690 #define AV_CODEC_PROP_LOSSY (1 << 1)
692 * Codec supports lossless compression. Audio and video codecs only.
694 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
696 * Codec supports frame reordering. That is, the coded order (the order in which
697 * the encoded packets are output by the encoders / stored / input to the
698 * decoders) may be different from the presentation order of the corresponding
701 * For codecs that do not have this property set, PTS and DTS should always be
704 #define AV_CODEC_PROP_REORDER (1 << 3)
706 * Subtitle codec is bitmap based
707 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
709 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
711 * Subtitle codec is text based.
712 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
714 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
717 * @ingroup lavc_decoding
718 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
719 * This is mainly needed because some optimized bitstream readers read
720 * 32 or 64 bit at once and could read over the end.<br>
721 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
722 * MPEG bitstreams could cause overread and segfault.
724 #define AV_INPUT_BUFFER_PADDING_SIZE 32
727 * @ingroup lavc_encoding
728 * minimum encoding buffer size
729 * Used to avoid some checks during header writing.
731 #define AV_INPUT_BUFFER_MIN_SIZE 16384
733 #if FF_API_WITHOUT_PREFIX
735 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
737 #define FF_INPUT_BUFFER_PADDING_SIZE 32
740 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
742 #define FF_MIN_BUFFER_SIZE 16384
743 #endif /* FF_API_WITHOUT_PREFIX */
746 * @ingroup lavc_encoding
747 * motion estimation type.
748 * @deprecated use codec private option instead
750 #if FF_API_MOTION_EST
752 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
756 ME_EPZS, ///< enhanced predictive zonal search
757 ME_X1, ///< reserved for experiments
758 ME_HEX, ///< hexagon based search
759 ME_UMH, ///< uneven multi-hexagon search
760 ME_TESA, ///< transformed exhaustive search algorithm
761 ME_ITER=50, ///< iterative search
766 * @ingroup lavc_decoding
769 /* We leave some space between them for extensions (drop some
770 * keyframes for intra-only or drop just some bidir frames). */
771 AVDISCARD_NONE =-16, ///< discard nothing
772 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
773 AVDISCARD_NONREF = 8, ///< discard all non reference
774 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
775 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
776 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
777 AVDISCARD_ALL = 48, ///< discard all
780 enum AVAudioServiceType {
781 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
782 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
783 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
784 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
785 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
786 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
787 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
788 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
789 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
790 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
794 * @ingroup lavc_encoding
796 typedef struct RcOverride{
799 int qscale; // If this is 0 then quality_factor will be used instead.
800 float quality_factor;
803 #if FF_API_MAX_BFRAMES
805 * @deprecated there is no libavcodec-wide limit on the number of B-frames
807 #define FF_MAX_B_FRAMES 16
811 These flags can be passed in AVCodecContext.flags before initialization.
812 Note: Not everything is supported yet.
816 * Allow decoders to produce frames with data planes that are not aligned
817 * to CPU requirements (e.g. due to cropping).
819 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
823 #define AV_CODEC_FLAG_QSCALE (1 << 1)
825 * 4 MV per MB allowed / advanced prediction for H.263.
827 #define AV_CODEC_FLAG_4MV (1 << 2)
829 * Output even those frames that might be corrupted.
831 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
835 #define AV_CODEC_FLAG_QPEL (1 << 4)
837 * Use internal 2pass ratecontrol in first pass mode.
839 #define AV_CODEC_FLAG_PASS1 (1 << 9)
841 * Use internal 2pass ratecontrol in second pass mode.
843 #define AV_CODEC_FLAG_PASS2 (1 << 10)
847 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
849 * Only decode/encode grayscale.
851 #define AV_CODEC_FLAG_GRAY (1 << 13)
853 * error[?] variables will be set during encoding.
855 #define AV_CODEC_FLAG_PSNR (1 << 15)
857 * Input bitstream might be truncated at a random location
858 * instead of only at frame boundaries.
860 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
862 * Use interlaced DCT.
864 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
868 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
870 * Place global headers in extradata instead of every keyframe.
872 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
874 * Use only bitexact stuff (except (I)DCT).
876 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
877 /* Fx : Flag for h263+ extra options */
879 * H.263 advanced intra coding / MPEG-4 AC prediction
881 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
883 * interlaced motion estimation
885 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
886 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
889 * Allow non spec compliant speedup tricks.
891 #define AV_CODEC_FLAG2_FAST (1 << 0)
893 * Skip bitstream encoding.
895 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
897 * Place global headers at every keyframe instead of in extradata.
899 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
902 * timecode is in drop frame format. DEPRECATED!!!!
904 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
907 * Input bitstream might be truncated at a packet boundaries
908 * instead of only at frame boundaries.
910 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
912 * Discard cropping information from SPS.
914 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
917 * Show all frames before the first keyframe
919 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
921 * Export motion vectors through frame side data
923 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
925 * Do not skip samples and export skip information as frame side data
927 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
929 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
931 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
933 /* Unsupported options :
934 * Syntax Arithmetic coding (SAC)
935 * Reference Picture Selection
936 * Independent Segment Decoding */
938 /* codec capabilities */
941 * Decoder can use draw_horiz_band callback.
943 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
945 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
946 * If not set, it might not use get_buffer() at all or use operations that
947 * assume the buffer was allocated by avcodec_default_get_buffer.
949 #define AV_CODEC_CAP_DR1 (1 << 1)
950 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
952 * Encoder or decoder requires flushing with NULL input at the end in order to
953 * give the complete and correct output.
955 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
956 * with NULL data. The user can still send NULL data to the public encode
957 * or decode function, but libavcodec will not pass it along to the codec
958 * unless this flag is set.
961 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
962 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
966 * The encoder needs to be fed with NULL data at the end of encoding until the
967 * encoder no longer returns data.
969 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
970 * flag also means that the encoder must set the pts and duration for
971 * each output packet. If this flag is not set, the pts and duration will
972 * be determined by libavcodec from the input frame.
974 #define AV_CODEC_CAP_DELAY (1 << 5)
976 * Codec can be fed a final frame with a smaller size.
977 * This can be used to prevent truncation of the last audio samples.
979 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
983 * Codec can export data for HW decoding (VDPAU).
985 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
989 * Codec can output multiple frames per AVPacket
990 * Normally demuxers return one frame at a time, demuxers which do not do
991 * are connected to a parser to split what they return into proper frames.
992 * This flag is reserved to the very rare category of codecs which have a
993 * bitstream that cannot be split into frames without timeconsuming
994 * operations like full decoding. Demuxers carring such bitstreams thus
995 * may return multiple frames in a packet. This has many disadvantages like
996 * prohibiting stream copy in many cases thus it should only be considered
999 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1001 * Codec is experimental and is thus avoided in favor of non experimental
1004 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1006 * Codec should fill in channel configuration and samplerate instead of container
1008 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1010 * Codec supports frame-level multithreading.
1012 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1014 * Codec supports slice-based (or partition-based) multithreading.
1016 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1018 * Codec supports changed parameters at any point.
1020 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1022 * Codec supports avctx->thread_count == 0 (auto).
1024 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1026 * Audio encoder supports receiving a different number of samples in each call.
1028 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1030 * Codec is intra only.
1032 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1034 * Codec is lossless.
1036 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1039 #if FF_API_WITHOUT_PREFIX
1041 * Allow decoders to produce frames with data planes that are not aligned
1042 * to CPU requirements (e.g. due to cropping).
1044 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1045 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1046 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1047 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1048 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1051 * @deprecated use the "gmc" private option of the libxvid encoder
1053 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1057 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1058 * mpegvideo encoders
1060 #define CODEC_FLAG_MV0 0x0040
1062 #if FF_API_INPUT_PRESERVED
1064 * @deprecated passing reference-counted frames to the encoders replaces this
1067 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1069 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1070 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1071 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1074 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1077 #define CODEC_FLAG_EMU_EDGE 0x4000
1079 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1080 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1082 #if FF_API_NORMALIZE_AQP
1084 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1085 * mpegvideo encoders
1087 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1089 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1090 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1091 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1092 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1093 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1094 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1095 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1096 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1097 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1098 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1099 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1100 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1101 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1103 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1104 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1105 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1106 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1108 /* Unsupported options :
1109 * Syntax Arithmetic coding (SAC)
1110 * Reference Picture Selection
1111 * Independent Segment Decoding */
1113 /* codec capabilities */
1115 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1117 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1118 * If not set, it might not use get_buffer() at all or use operations that
1119 * assume the buffer was allocated by avcodec_default_get_buffer.
1121 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1122 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1124 /* Codec can export data for HW decoding. This flag indicates that
1125 * the codec would call get_format() with list that might contain HW accelerated
1126 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1127 * including raw image format.
1128 * The application can use the passed context to determine bitstream version,
1129 * chroma format, resolution etc.
1131 #define CODEC_CAP_HWACCEL 0x0010
1132 #endif /* FF_API_XVMC */
1134 * Encoder or decoder requires flushing with NULL input at the end in order to
1135 * give the complete and correct output.
1137 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1138 * with NULL data. The user can still send NULL data to the public encode
1139 * or decode function, but libavcodec will not pass it along to the codec
1140 * unless this flag is set.
1143 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1144 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1148 * The encoder needs to be fed with NULL data at the end of encoding until the
1149 * encoder no longer returns data.
1151 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1152 * flag also means that the encoder must set the pts and duration for
1153 * each output packet. If this flag is not set, the pts and duration will
1154 * be determined by libavcodec from the input frame.
1156 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1158 * Codec can be fed a final frame with a smaller size.
1159 * This can be used to prevent truncation of the last audio samples.
1161 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1162 #if FF_API_CAP_VDPAU
1164 * Codec can export data for HW decoding (VDPAU).
1166 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1169 * Codec can output multiple frames per AVPacket
1170 * Normally demuxers return one frame at a time, demuxers which do not do
1171 * are connected to a parser to split what they return into proper frames.
1172 * This flag is reserved to the very rare category of codecs which have a
1173 * bitstream that cannot be split into frames without timeconsuming
1174 * operations like full decoding. Demuxers carring such bitstreams thus
1175 * may return multiple frames in a packet. This has many disadvantages like
1176 * prohibiting stream copy in many cases thus it should only be considered
1179 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1181 * Codec is experimental and is thus avoided in favor of non experimental
1184 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1186 * Codec should fill in channel configuration and samplerate instead of container
1188 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1189 #if FF_API_NEG_LINESIZES
1191 * @deprecated no codecs use this capability
1193 #define CODEC_CAP_NEG_LINESIZES 0x0800
1196 * Codec supports frame-level multithreading.
1198 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1200 * Codec supports slice-based (or partition-based) multithreading.
1202 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1204 * Codec supports changed parameters at any point.
1206 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1208 * Codec supports avctx->thread_count == 0 (auto).
1210 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1212 * Audio encoder supports receiving a different number of samples in each call.
1214 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1216 * Codec is intra only.
1218 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1220 * Codec is lossless.
1222 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1225 * HWAccel is experimental and is thus avoided in favor of non experimental
1228 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1229 #endif /* FF_API_WITHOUT_PREFIX */
1232 //The following defines may change, don't expect compatibility if you use them.
1233 #define MB_TYPE_INTRA4x4 0x0001
1234 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1235 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1236 #define MB_TYPE_16x16 0x0008
1237 #define MB_TYPE_16x8 0x0010
1238 #define MB_TYPE_8x16 0x0020
1239 #define MB_TYPE_8x8 0x0040
1240 #define MB_TYPE_INTERLACED 0x0080
1241 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1242 #define MB_TYPE_ACPRED 0x0200
1243 #define MB_TYPE_GMC 0x0400
1244 #define MB_TYPE_SKIP 0x0800
1245 #define MB_TYPE_P0L0 0x1000
1246 #define MB_TYPE_P1L0 0x2000
1247 #define MB_TYPE_P0L1 0x4000
1248 #define MB_TYPE_P1L1 0x8000
1249 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1250 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1251 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1252 #define MB_TYPE_QUANT 0x00010000
1253 #define MB_TYPE_CBP 0x00020000
1254 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
1259 * This specifies the area which should be displayed.
1260 * Note there may be multiple such areas for one frame.
1262 typedef struct AVPanScan{
1265 * - encoding: Set by user.
1266 * - decoding: Set by libavcodec.
1271 * width and height in 1/16 pel
1272 * - encoding: Set by user.
1273 * - decoding: Set by libavcodec.
1279 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1280 * - encoding: Set by user.
1281 * - decoding: Set by libavcodec.
1283 int16_t position[3][2];
1287 * This structure describes the bitrate properties of an encoded bitstream. It
1288 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1289 * parameters for H.264/HEVC.
1291 typedef struct AVCPBProperties {
1293 * Maximum bitrate of the stream, in bits per second.
1294 * Zero if unknown or unspecified.
1298 * Minimum bitrate of the stream, in bits per second.
1299 * Zero if unknown or unspecified.
1303 * Average bitrate of the stream, in bits per second.
1304 * Zero if unknown or unspecified.
1309 * The size of the buffer to which the ratecontrol is applied, in bits.
1310 * Zero if unknown or unspecified.
1315 * The delay between the time the packet this structure is associated with
1316 * is received and the time when it should be decoded, in periods of a 27MHz
1319 * UINT64_MAX when unknown or unspecified.
1324 #if FF_API_QSCALE_TYPE
1325 #define FF_QSCALE_TYPE_MPEG1 0
1326 #define FF_QSCALE_TYPE_MPEG2 1
1327 #define FF_QSCALE_TYPE_H264 2
1328 #define FF_QSCALE_TYPE_VP56 3
1332 * The decoder will keep a reference to the frame and may reuse it later.
1334 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1337 * @defgroup lavc_packet AVPacket
1339 * Types and functions for working with AVPacket.
1342 enum AVPacketSideDataType {
1343 AV_PKT_DATA_PALETTE,
1344 AV_PKT_DATA_NEW_EXTRADATA,
1347 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1350 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1351 * s32le channel_count
1352 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1353 * u64le channel_layout
1354 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1356 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1361 AV_PKT_DATA_PARAM_CHANGE,
1364 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1365 * structures with info about macroblocks relevant to splitting the
1366 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1367 * That is, it does not necessarily contain info about all macroblocks,
1368 * as long as the distance between macroblocks in the info is smaller
1369 * than the target payload size.
1370 * Each MB info structure is 12 bytes, and is laid out as follows:
1372 * u32le bit offset from the start of the packet
1373 * u8 current quantizer at the start of the macroblock
1375 * u16le macroblock address within the GOB
1376 * u8 horizontal MV predictor
1377 * u8 vertical MV predictor
1378 * u8 horizontal MV predictor for block number 3
1379 * u8 vertical MV predictor for block number 3
1382 AV_PKT_DATA_H263_MB_INFO,
1385 * This side data should be associated with an audio stream and contains
1386 * ReplayGain information in form of the AVReplayGain struct.
1388 AV_PKT_DATA_REPLAYGAIN,
1391 * This side data contains a 3x3 transformation matrix describing an affine
1392 * transformation that needs to be applied to the decoded video frames for
1393 * correct presentation.
1395 * See libavutil/display.h for a detailed description of the data.
1397 AV_PKT_DATA_DISPLAYMATRIX,
1400 * This side data should be associated with a video stream and contains
1401 * Stereoscopic 3D information in form of the AVStereo3D struct.
1403 AV_PKT_DATA_STEREO3D,
1406 * This side data should be associated with an audio stream and corresponds
1407 * to enum AVAudioServiceType.
1409 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1412 * This side data contains quality related information from the encoder.
1414 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1418 * u64le[error count] sum of squared differences between encoder in and output
1421 AV_PKT_DATA_QUALITY_STATS,
1424 * This side data contains an integer value representing the stream index
1425 * of a "fallback" track. A fallback track indicates an alternate
1426 * track to use when the current track can not be decoded for some reason.
1427 * e.g. no decoder available for codec.
1429 AV_PKT_DATA_FALLBACK_TRACK,
1432 * This side data corresponds to the AVCPBProperties struct.
1434 AV_PKT_DATA_CPB_PROPERTIES,
1437 * Recommmends skipping the specified number of samples
1439 * u32le number of samples to skip from start of this packet
1440 * u32le number of samples to skip from end of this packet
1441 * u8 reason for start skip
1442 * u8 reason for end skip (0=padding silence, 1=convergence)
1445 AV_PKT_DATA_SKIP_SAMPLES=70,
1448 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1449 * the packet may contain "dual mono" audio specific to Japanese DTV
1450 * and if it is true, recommends only the selected channel to be used.
1452 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1455 AV_PKT_DATA_JP_DUALMONO,
1458 * A list of zero terminated key/value strings. There is no end marker for
1459 * the list, so it is required to rely on the side data size to stop.
1461 AV_PKT_DATA_STRINGS_METADATA,
1464 * Subtitle event position
1472 AV_PKT_DATA_SUBTITLE_POSITION,
1475 * Data found in BlockAdditional element of matroska container. There is
1476 * no end marker for the data, so it is required to rely on the side data
1477 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1480 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1483 * The optional first identifier line of a WebVTT cue.
1485 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1488 * The optional settings (rendering instructions) that immediately
1489 * follow the timestamp specifier of a WebVTT cue.
1491 AV_PKT_DATA_WEBVTT_SETTINGS,
1494 * A list of zero terminated key/value strings. There is no end marker for
1495 * the list, so it is required to rely on the side data size to stop. This
1496 * side data includes updated metadata which appeared in the stream.
1498 AV_PKT_DATA_METADATA_UPDATE,
1501 * MPEGTS stream ID, this is required to pass the stream ID
1502 * information from the demuxer to the corresponding muxer.
1504 AV_PKT_DATA_MPEGTS_STREAM_ID,
1507 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1508 * should be associated with a video stream and containts data in the form
1509 * of the AVMasteringDisplayMetadata struct.
1511 AV_PKT_DATA_MASTERING_DISPLAY_METADATA
1514 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1516 typedef struct AVPacketSideData {
1519 enum AVPacketSideDataType type;
1523 * This structure stores compressed data. It is typically exported by demuxers
1524 * and then passed as input to decoders, or received as output from encoders and
1525 * then passed to muxers.
1527 * For video, it should typically contain one compressed frame. For audio it may
1528 * contain several compressed frames. Encoders are allowed to output empty
1529 * packets, with no compressed data, containing only side data
1530 * (e.g. to update some stream parameters at the end of encoding).
1532 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1533 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1534 * without libavcodec and libavformat major bump.
1536 * The semantics of data ownership depends on the buf field.
1537 * If it is set, the packet data is dynamically allocated and is
1538 * valid indefinitely until a call to av_packet_unref() reduces the
1539 * reference count to 0.
1541 * If the buf field is not set av_packet_ref() would make a copy instead
1542 * of increasing the reference count.
1544 * The side data is always allocated with av_malloc(), copied by
1545 * av_packet_ref() and freed by av_packet_unref().
1547 * @see av_packet_ref
1548 * @see av_packet_unref
1550 typedef struct AVPacket {
1552 * A reference to the reference-counted buffer where the packet data is
1554 * May be NULL, then the packet data is not reference-counted.
1558 * Presentation timestamp in AVStream->time_base units; the time at which
1559 * the decompressed packet will be presented to the user.
1560 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1561 * pts MUST be larger or equal to dts as presentation cannot happen before
1562 * decompression, unless one wants to view hex dumps. Some formats misuse
1563 * the terms dts and pts/cts to mean something different. Such timestamps
1564 * must be converted to true pts/dts before they are stored in AVPacket.
1568 * Decompression timestamp in AVStream->time_base units; the time at which
1569 * the packet is decompressed.
1570 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1577 * A combination of AV_PKT_FLAG values
1581 * Additional packet data that can be provided by the container.
1582 * Packet can contain several types of side information.
1584 AVPacketSideData *side_data;
1585 int side_data_elems;
1588 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1589 * Equals next_pts - this_pts in presentation order.
1593 int64_t pos; ///< byte position in stream, -1 if unknown
1595 #if FF_API_CONVERGENCE_DURATION
1597 * @deprecated Same as the duration field, but as int64_t. This was required
1598 * for Matroska subtitles, whose duration values could overflow when the
1599 * duration field was still an int.
1601 attribute_deprecated
1602 int64_t convergence_duration;
1605 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1606 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1608 enum AVSideDataParamChangeFlags {
1609 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1610 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1611 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1612 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1618 struct AVCodecInternal;
1622 AV_FIELD_PROGRESSIVE,
1623 AV_FIELD_TT, //< Top coded_first, top displayed first
1624 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1625 AV_FIELD_TB, //< Top coded first, bottom displayed first
1626 AV_FIELD_BT, //< Bottom coded first, top displayed first
1630 * main external API structure.
1631 * New fields can be added to the end with minor version bumps.
1632 * Removal, reordering and changes to existing fields require a major
1634 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1636 * sizeof(AVCodecContext) must not be used outside libav*.
1638 typedef struct AVCodecContext {
1640 * information on struct for av_log
1641 * - set by avcodec_alloc_context3
1643 const AVClass *av_class;
1644 int log_level_offset;
1646 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1647 const struct AVCodec *codec;
1648 #if FF_API_CODEC_NAME
1650 * @deprecated this field is not used for anything in libavcodec
1652 attribute_deprecated
1653 char codec_name[32];
1655 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1658 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1659 * This is used to work around some encoder bugs.
1660 * A demuxer should set this to what is stored in the field used to identify the codec.
1661 * If there are multiple such fields in a container then the demuxer should choose the one
1662 * which maximizes the information about the used codec.
1663 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1664 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1665 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1667 * - encoding: Set by user, if not then the default based on codec_id will be used.
1668 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1670 unsigned int codec_tag;
1672 #if FF_API_STREAM_CODEC_TAG
1674 * @deprecated this field is unused
1676 attribute_deprecated
1677 unsigned int stream_codec_tag;
1683 * Private context used for internal data.
1685 * Unlike priv_data, this is not codec-specific. It is used in general
1686 * libavcodec functions.
1688 struct AVCodecInternal *internal;
1691 * Private data of the user, can be used to carry app specific stuff.
1692 * - encoding: Set by user.
1693 * - decoding: Set by user.
1698 * the average bitrate
1699 * - encoding: Set by user; unused for constant quantizer encoding.
1700 * - decoding: Set by user, may be overwritten by libavcodec
1701 * if this info is available in the stream
1706 * number of bits the bitstream is allowed to diverge from the reference.
1707 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1708 * - encoding: Set by user; unused for constant quantizer encoding.
1709 * - decoding: unused
1711 int bit_rate_tolerance;
1714 * Global quality for codecs which cannot change it per frame.
1715 * This should be proportional to MPEG-1/2/4 qscale.
1716 * - encoding: Set by user.
1717 * - decoding: unused
1722 * - encoding: Set by user.
1723 * - decoding: unused
1725 int compression_level;
1726 #define FF_COMPRESSION_DEFAULT -1
1730 * - encoding: Set by user.
1731 * - decoding: Set by user.
1737 * - encoding: Set by user.
1738 * - decoding: Set by user.
1743 * some codecs need / can use extradata like Huffman tables.
1744 * mjpeg: Huffman tables
1745 * rv10: additional flags
1746 * mpeg4: global headers (they can be in the bitstream or here)
1747 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1748 * than extradata_size to avoid problems if it is read with the bitstream reader.
1749 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1750 * - encoding: Set/allocated/freed by libavcodec.
1751 * - decoding: Set/allocated/freed by user.
1757 * This is the fundamental unit of time (in seconds) in terms
1758 * of which frame timestamps are represented. For fixed-fps content,
1759 * timebase should be 1/framerate and timestamp increments should be
1761 * This often, but not always is the inverse of the frame rate or field rate
1762 * for video. 1/time_base is not the average frame rate if the frame rate is not
1765 * Like containers, elementary streams also can store timestamps, 1/time_base
1766 * is the unit in which these timestamps are specified.
1767 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1768 * vop_time_increment_resolution and fixed_vop_rate
1769 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1771 * - encoding: MUST be set by user.
1772 * - decoding: the use of this field for decoding is deprecated.
1773 * Use framerate instead.
1775 AVRational time_base;
1778 * For some codecs, the time base is closer to the field rate than the frame rate.
1779 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1780 * if no telecine is used ...
1782 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1784 int ticks_per_frame;
1789 * Encoding: Number of frames delay there will be from the encoder input to
1790 * the decoder output. (we assume the decoder matches the spec)
1791 * Decoding: Number of frames delay in addition to what a standard decoder
1792 * as specified in the spec would produce.
1795 * Number of frames the decoded output will be delayed relative to the
1799 * For encoding, this field is unused (see initial_padding).
1801 * For decoding, this is the number of samples the decoder needs to
1802 * output before the decoder's output is valid. When seeking, you should
1803 * start decoding this many samples prior to your desired seek point.
1805 * - encoding: Set by libavcodec.
1806 * - decoding: Set by libavcodec.
1813 * picture width / height.
1815 * @note Those fields may not match the values of the last
1816 * AVFrame outputted by avcodec_decode_video2 due frame
1819 * - encoding: MUST be set by user.
1820 * - decoding: May be set by the user before opening the decoder if known e.g.
1821 * from the container. Some decoders will require the dimensions
1822 * to be set by the caller. During decoding, the decoder may
1823 * overwrite those values as required while parsing the data.
1828 * Bitstream width / height, may be different from width/height e.g. when
1829 * the decoded frame is cropped before being output or lowres is enabled.
1831 * @note Those field may not match the value of the last
1832 * AVFrame outputted by avcodec_receive_frame() due frame
1835 * - encoding: unused
1836 * - decoding: May be set by the user before opening the decoder if known
1837 * e.g. from the container. During decoding, the decoder may
1838 * overwrite those values as required while parsing the data.
1840 int coded_width, coded_height;
1842 #if FF_API_ASPECT_EXTENDED
1843 #define FF_ASPECT_EXTENDED 15
1847 * the number of pictures in a group of pictures, or 0 for intra_only
1848 * - encoding: Set by user.
1849 * - decoding: unused
1854 * Pixel format, see AV_PIX_FMT_xxx.
1855 * May be set by the demuxer if known from headers.
1856 * May be overridden by the decoder if it knows better.
1858 * @note This field may not match the value of the last
1859 * AVFrame outputted by avcodec_receive_frame() due frame
1862 * - encoding: Set by user.
1863 * - decoding: Set by user if known, overridden by libavcodec while
1866 enum AVPixelFormat pix_fmt;
1868 #if FF_API_MOTION_EST
1870 * This option does nothing
1871 * @deprecated use codec private options instead
1873 attribute_deprecated int me_method;
1877 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1878 * decoder to draw a horizontal band. It improves cache usage. Not
1879 * all codecs can do that. You must check the codec capabilities
1881 * When multithreading is used, it may be called from multiple threads
1882 * at the same time; threads might draw different parts of the same AVFrame,
1883 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1885 * The function is also used by hardware acceleration APIs.
1886 * It is called at least once during frame decoding to pass
1887 * the data needed for hardware render.
1888 * In that mode instead of pixel data, AVFrame points to
1889 * a structure specific to the acceleration API. The application
1890 * reads the structure and can change some fields to indicate progress
1892 * - encoding: unused
1893 * - decoding: Set by user.
1894 * @param height the height of the slice
1895 * @param y the y position of the slice
1896 * @param type 1->top field, 2->bottom field, 3->frame
1897 * @param offset offset into the AVFrame.data from which the slice should be read
1899 void (*draw_horiz_band)(struct AVCodecContext *s,
1900 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1901 int y, int type, int height);
1904 * callback to negotiate the pixelFormat
1905 * @param fmt is the list of formats which are supported by the codec,
1906 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1907 * The first is always the native one.
1908 * @note The callback may be called again immediately if initialization for
1909 * the selected (hardware-accelerated) pixel format failed.
1910 * @warning Behavior is undefined if the callback returns a value not
1911 * in the fmt list of formats.
1912 * @return the chosen format
1913 * - encoding: unused
1914 * - decoding: Set by user, if not set the native format will be chosen.
1916 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1919 * maximum number of B-frames between non-B-frames
1920 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1921 * - encoding: Set by user.
1922 * - decoding: unused
1927 * qscale factor between IP and B-frames
1928 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1929 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1930 * - encoding: Set by user.
1931 * - decoding: unused
1933 float b_quant_factor;
1935 #if FF_API_RC_STRATEGY
1936 /** @deprecated use codec private option instead */
1937 attribute_deprecated int rc_strategy;
1938 #define FF_RC_STRATEGY_XVID 1
1941 #if FF_API_PRIVATE_OPT
1942 /** @deprecated use encoder private options instead */
1943 attribute_deprecated
1944 int b_frame_strategy;
1948 * qscale offset between IP and B-frames
1949 * - encoding: Set by user.
1950 * - decoding: unused
1952 float b_quant_offset;
1955 * Size of the frame reordering buffer in the decoder.
1956 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1957 * - encoding: Set by libavcodec.
1958 * - decoding: Set by libavcodec.
1962 #if FF_API_PRIVATE_OPT
1963 /** @deprecated use encoder private options instead */
1964 attribute_deprecated
1969 * qscale factor between P and I-frames
1970 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1971 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1972 * - encoding: Set by user.
1973 * - decoding: unused
1975 float i_quant_factor;
1978 * qscale offset between P and I-frames
1979 * - encoding: Set by user.
1980 * - decoding: unused
1982 float i_quant_offset;
1985 * luminance masking (0-> disabled)
1986 * - encoding: Set by user.
1987 * - decoding: unused
1992 * temporary complexity masking (0-> disabled)
1993 * - encoding: Set by user.
1994 * - decoding: unused
1996 float temporal_cplx_masking;
1999 * spatial complexity masking (0-> disabled)
2000 * - encoding: Set by user.
2001 * - decoding: unused
2003 float spatial_cplx_masking;
2006 * p block masking (0-> disabled)
2007 * - encoding: Set by user.
2008 * - decoding: unused
2013 * darkness masking (0-> disabled)
2014 * - encoding: Set by user.
2015 * - decoding: unused
2021 * - encoding: Set by libavcodec.
2022 * - decoding: Set by user (or 0).
2026 #if FF_API_PRIVATE_OPT
2027 /** @deprecated use encoder private options instead */
2028 attribute_deprecated
2029 int prediction_method;
2030 #define FF_PRED_LEFT 0
2031 #define FF_PRED_PLANE 1
2032 #define FF_PRED_MEDIAN 2
2036 * slice offsets in the frame in bytes
2037 * - encoding: Set/allocated by libavcodec.
2038 * - decoding: Set/allocated by user (or NULL).
2043 * sample aspect ratio (0 if unknown)
2044 * That is the width of a pixel divided by the height of the pixel.
2045 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2046 * - encoding: Set by user.
2047 * - decoding: Set by libavcodec.
2049 AVRational sample_aspect_ratio;
2052 * motion estimation comparison function
2053 * - encoding: Set by user.
2054 * - decoding: unused
2058 * subpixel motion estimation comparison function
2059 * - encoding: Set by user.
2060 * - decoding: unused
2064 * macroblock comparison function (not supported yet)
2065 * - encoding: Set by user.
2066 * - decoding: unused
2070 * interlaced DCT comparison function
2071 * - encoding: Set by user.
2072 * - decoding: unused
2075 #define FF_CMP_SAD 0
2076 #define FF_CMP_SSE 1
2077 #define FF_CMP_SATD 2
2078 #define FF_CMP_DCT 3
2079 #define FF_CMP_PSNR 4
2080 #define FF_CMP_BIT 5
2082 #define FF_CMP_ZERO 7
2083 #define FF_CMP_VSAD 8
2084 #define FF_CMP_VSSE 9
2085 #define FF_CMP_NSSE 10
2086 #define FF_CMP_W53 11
2087 #define FF_CMP_W97 12
2088 #define FF_CMP_DCTMAX 13
2089 #define FF_CMP_DCT264 14
2090 #define FF_CMP_CHROMA 256
2093 * ME diamond size & shape
2094 * - encoding: Set by user.
2095 * - decoding: unused
2100 * amount of previous MV predictors (2a+1 x 2a+1 square)
2101 * - encoding: Set by user.
2102 * - decoding: unused
2104 int last_predictor_count;
2106 #if FF_API_PRIVATE_OPT
2107 /** @deprecated use encoder private options instead */
2108 attribute_deprecated
2113 * motion estimation prepass comparison function
2114 * - encoding: Set by user.
2115 * - decoding: unused
2120 * ME prepass diamond size & shape
2121 * - encoding: Set by user.
2122 * - decoding: unused
2128 * - encoding: Set by user.
2129 * - decoding: unused
2131 int me_subpel_quality;
2135 * DTG active format information (additional aspect ratio
2136 * information only used in DVB MPEG-2 transport streams)
2139 * - encoding: unused
2140 * - decoding: Set by decoder.
2141 * @deprecated Deprecated in favor of AVSideData
2143 attribute_deprecated int dtg_active_format;
2144 #define FF_DTG_AFD_SAME 8
2145 #define FF_DTG_AFD_4_3 9
2146 #define FF_DTG_AFD_16_9 10
2147 #define FF_DTG_AFD_14_9 11
2148 #define FF_DTG_AFD_4_3_SP_14_9 13
2149 #define FF_DTG_AFD_16_9_SP_14_9 14
2150 #define FF_DTG_AFD_SP_4_3 15
2151 #endif /* FF_API_AFD */
2154 * maximum motion estimation search range in subpel units
2155 * If 0 then no limit.
2157 * - encoding: Set by user.
2158 * - decoding: unused
2162 #if FF_API_QUANT_BIAS
2164 * @deprecated use encoder private option instead
2166 attribute_deprecated int intra_quant_bias;
2167 #define FF_DEFAULT_QUANT_BIAS 999999
2170 * @deprecated use encoder private option instead
2172 attribute_deprecated int inter_quant_bias;
2177 * - encoding: unused
2178 * - decoding: Set by user.
2181 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2182 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2183 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2187 * XVideo Motion Acceleration
2188 * - encoding: forbidden
2189 * - decoding: set by decoder
2190 * @deprecated XvMC doesn't need it anymore.
2192 attribute_deprecated int xvmc_acceleration;
2193 #endif /* FF_API_XVMC */
2196 * macroblock decision mode
2197 * - encoding: Set by user.
2198 * - decoding: unused
2201 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2202 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2203 #define FF_MB_DECISION_RD 2 ///< rate distortion
2206 * custom intra quantization matrix
2207 * - encoding: Set by user, can be NULL.
2208 * - decoding: Set by libavcodec.
2210 uint16_t *intra_matrix;
2213 * custom inter quantization matrix
2214 * - encoding: Set by user, can be NULL.
2215 * - decoding: Set by libavcodec.
2217 uint16_t *inter_matrix;
2219 #if FF_API_PRIVATE_OPT
2220 /** @deprecated use encoder private options instead */
2221 attribute_deprecated
2222 int scenechange_threshold;
2224 /** @deprecated use encoder private options instead */
2225 attribute_deprecated
2226 int noise_reduction;
2231 * @deprecated this field is unused
2233 attribute_deprecated
2237 * @deprecated this field is unused
2239 attribute_deprecated
2244 * precision of the intra DC coefficient - 8
2245 * - encoding: Set by user.
2246 * - decoding: Set by libavcodec
2248 int intra_dc_precision;
2251 * Number of macroblock rows at the top which are skipped.
2252 * - encoding: unused
2253 * - decoding: Set by user.
2258 * Number of macroblock rows at the bottom which are skipped.
2259 * - encoding: unused
2260 * - decoding: Set by user.
2266 * @deprecated use encoder private options instead
2268 attribute_deprecated
2269 float border_masking;
2273 * minimum MB lagrange multipler
2274 * - encoding: Set by user.
2275 * - decoding: unused
2280 * maximum MB lagrange multipler
2281 * - encoding: Set by user.
2282 * - decoding: unused
2286 #if FF_API_PRIVATE_OPT
2288 * @deprecated use encoder private options instead
2290 attribute_deprecated
2291 int me_penalty_compensation;
2295 * - encoding: Set by user.
2296 * - decoding: unused
2300 #if FF_API_PRIVATE_OPT
2301 /** @deprecated use encoder private options instead */
2302 attribute_deprecated
2308 * - encoding: Set by user.
2309 * - decoding: unused
2314 * number of reference frames
2315 * - encoding: Set by user.
2316 * - decoding: Set by lavc.
2320 #if FF_API_PRIVATE_OPT
2321 /** @deprecated use encoder private options instead */
2322 attribute_deprecated
2326 #if FF_API_UNUSED_MEMBERS
2328 * Multiplied by qscale for each frame and added to scene_change_score.
2329 * - encoding: Set by user.
2330 * - decoding: unused
2332 attribute_deprecated int scenechange_factor;
2336 * Note: Value depends upon the compare function used for fullpel ME.
2337 * - encoding: Set by user.
2338 * - decoding: unused
2342 #if FF_API_PRIVATE_OPT
2343 /** @deprecated use encoder private options instead */
2344 attribute_deprecated
2349 * Chromaticity coordinates of the source primaries.
2350 * - encoding: Set by user
2351 * - decoding: Set by libavcodec
2353 enum AVColorPrimaries color_primaries;
2356 * Color Transfer Characteristic.
2357 * - encoding: Set by user
2358 * - decoding: Set by libavcodec
2360 enum AVColorTransferCharacteristic color_trc;
2363 * YUV colorspace type.
2364 * - encoding: Set by user
2365 * - decoding: Set by libavcodec
2367 enum AVColorSpace colorspace;
2370 * MPEG vs JPEG YUV range.
2371 * - encoding: Set by user
2372 * - decoding: Set by libavcodec
2374 enum AVColorRange color_range;
2377 * This defines the location of chroma samples.
2378 * - encoding: Set by user
2379 * - decoding: Set by libavcodec
2381 enum AVChromaLocation chroma_sample_location;
2385 * Indicates number of picture subdivisions. Used for parallelized
2387 * - encoding: Set by user
2388 * - decoding: unused
2393 * - encoding: set by libavcodec
2394 * - decoding: Set by user.
2396 enum AVFieldOrder field_order;
2399 int sample_rate; ///< samples per second
2400 int channels; ///< number of audio channels
2403 * audio sample format
2404 * - encoding: Set by user.
2405 * - decoding: Set by libavcodec.
2407 enum AVSampleFormat sample_fmt; ///< sample format
2409 /* The following data should not be initialized. */
2411 * Number of samples per channel in an audio frame.
2413 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2414 * except the last must contain exactly frame_size samples per channel.
2415 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2416 * frame size is not restricted.
2417 * - decoding: may be set by some decoders to indicate constant frame size
2422 * Frame counter, set by libavcodec.
2424 * - decoding: total number of frames returned from the decoder so far.
2425 * - encoding: total number of frames passed to the encoder so far.
2427 * @note the counter is not incremented if encoding/decoding resulted in
2433 * number of bytes per packet if constant and known or 0
2434 * Used by some WAV based audio codecs.
2439 * Audio cutoff bandwidth (0 means "automatic")
2440 * - encoding: Set by user.
2441 * - decoding: unused
2446 * Audio channel layout.
2447 * - encoding: set by user.
2448 * - decoding: set by user, may be overwritten by libavcodec.
2450 uint64_t channel_layout;
2453 * Request decoder to use this channel layout if it can (0 for default)
2454 * - encoding: unused
2455 * - decoding: Set by user.
2457 uint64_t request_channel_layout;
2460 * Type of service that the audio stream conveys.
2461 * - encoding: Set by user.
2462 * - decoding: Set by libavcodec.
2464 enum AVAudioServiceType audio_service_type;
2467 * desired sample format
2468 * - encoding: Not used.
2469 * - decoding: Set by user.
2470 * Decoder will decode to this format if it can.
2472 enum AVSampleFormat request_sample_fmt;
2475 * This callback is called at the beginning of each frame to get data
2476 * buffer(s) for it. There may be one contiguous buffer for all the data or
2477 * there may be a buffer per each data plane or anything in between. What
2478 * this means is, you may set however many entries in buf[] you feel necessary.
2479 * Each buffer must be reference-counted using the AVBuffer API (see description
2482 * The following fields will be set in the frame before this callback is
2485 * - width, height (video only)
2486 * - sample_rate, channel_layout, nb_samples (audio only)
2487 * Their values may differ from the corresponding values in
2488 * AVCodecContext. This callback must use the frame values, not the codec
2489 * context values, to calculate the required buffer size.
2491 * This callback must fill the following fields in the frame:
2495 * * if the data is planar audio with more than 8 channels, then this
2496 * callback must allocate and fill extended_data to contain all pointers
2497 * to all data planes. data[] must hold as many pointers as it can.
2498 * extended_data must be allocated with av_malloc() and will be freed in
2500 * * otherwise exended_data must point to data
2501 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2502 * the frame's data and extended_data pointers must be contained in these. That
2503 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2504 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2505 * and av_buffer_ref().
2506 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2507 * this callback and filled with the extra buffers if there are more
2508 * buffers than buf[] can hold. extended_buf will be freed in
2511 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2512 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2515 * Each data plane must be aligned to the maximum required by the target
2518 * @see avcodec_default_get_buffer2()
2522 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2523 * (read and/or written to if it is writable) later by libavcodec.
2525 * avcodec_align_dimensions2() should be used to find the required width and
2526 * height, as they normally need to be rounded up to the next multiple of 16.
2528 * Some decoders do not support linesizes changing between frames.
2530 * If frame multithreading is used and thread_safe_callbacks is set,
2531 * this callback may be called from a different thread, but not from more
2532 * than one at once. Does not need to be reentrant.
2534 * @see avcodec_align_dimensions2()
2538 * Decoders request a buffer of a particular size by setting
2539 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2540 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2541 * to a smaller value in the output frame.
2543 * As a convenience, av_samples_get_buffer_size() and
2544 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2545 * functions to find the required data size and to fill data pointers and
2546 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2547 * since all planes must be the same size.
2549 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2551 * - encoding: unused
2552 * - decoding: Set by libavcodec, user can override.
2554 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2557 * If non-zero, the decoded audio and video frames returned from
2558 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2559 * and are valid indefinitely. The caller must free them with
2560 * av_frame_unref() when they are not needed anymore.
2561 * Otherwise, the decoded frames must not be freed by the caller and are
2562 * only valid until the next decode call.
2564 * This is always automatically enabled if avcodec_receive_frame() is used.
2566 * - encoding: unused
2567 * - decoding: set by the caller before avcodec_open2().
2569 int refcounted_frames;
2571 /* - encoding parameters */
2572 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2573 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2577 * - encoding: Set by user.
2578 * - decoding: unused
2584 * - encoding: Set by user.
2585 * - decoding: unused
2590 * maximum quantizer difference between frames
2591 * - encoding: Set by user.
2592 * - decoding: unused
2598 * @deprecated use encoder private options instead
2600 attribute_deprecated
2603 attribute_deprecated
2605 attribute_deprecated
2610 * decoder bitstream buffer size
2611 * - encoding: Set by user.
2612 * - decoding: unused
2617 * ratecontrol override, see RcOverride
2618 * - encoding: Allocated/set/freed by user.
2619 * - decoding: unused
2621 int rc_override_count;
2622 RcOverride *rc_override;
2626 * @deprecated use encoder private options instead
2628 attribute_deprecated
2634 * - encoding: Set by user.
2635 * - decoding: Set by user, may be overwritten by libavcodec.
2637 int64_t rc_max_rate;
2641 * - encoding: Set by user.
2642 * - decoding: unused
2644 int64_t rc_min_rate;
2648 * @deprecated use encoder private options instead
2650 attribute_deprecated
2651 float rc_buffer_aggressivity;
2653 attribute_deprecated
2654 float rc_initial_cplx;
2658 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2659 * - encoding: Set by user.
2660 * - decoding: unused.
2662 float rc_max_available_vbv_use;
2665 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2666 * - encoding: Set by user.
2667 * - decoding: unused.
2669 float rc_min_vbv_overflow_use;
2672 * Number of bits which should be loaded into the rc buffer before decoding starts.
2673 * - encoding: Set by user.
2674 * - decoding: unused
2676 int rc_initial_buffer_occupancy;
2678 #if FF_API_CODER_TYPE
2679 #define FF_CODER_TYPE_VLC 0
2680 #define FF_CODER_TYPE_AC 1
2681 #define FF_CODER_TYPE_RAW 2
2682 #define FF_CODER_TYPE_RLE 3
2683 #if FF_API_UNUSED_MEMBERS
2684 #define FF_CODER_TYPE_DEFLATE 4
2685 #endif /* FF_API_UNUSED_MEMBERS */
2687 * @deprecated use encoder private options instead
2689 attribute_deprecated
2691 #endif /* FF_API_CODER_TYPE */
2693 #if FF_API_PRIVATE_OPT
2694 /** @deprecated use encoder private options instead */
2695 attribute_deprecated
2701 * @deprecated use encoder private options instead
2703 attribute_deprecated
2707 * @deprecated use encoder private options instead
2709 attribute_deprecated
2713 #if FF_API_PRIVATE_OPT
2714 /** @deprecated use encoder private options instead */
2715 attribute_deprecated
2716 int frame_skip_threshold;
2718 /** @deprecated use encoder private options instead */
2719 attribute_deprecated
2720 int frame_skip_factor;
2722 /** @deprecated use encoder private options instead */
2723 attribute_deprecated
2726 /** @deprecated use encoder private options instead */
2727 attribute_deprecated
2729 #endif /* FF_API_PRIVATE_OPT */
2732 * trellis RD quantization
2733 * - encoding: Set by user.
2734 * - decoding: unused
2738 #if FF_API_PRIVATE_OPT
2739 /** @deprecated use encoder private options instead */
2740 attribute_deprecated
2741 int min_prediction_order;
2743 /** @deprecated use encoder private options instead */
2744 attribute_deprecated
2745 int max_prediction_order;
2747 /** @deprecated use encoder private options instead */
2748 attribute_deprecated
2749 int64_t timecode_frame_start;
2752 #if FF_API_RTP_CALLBACK
2754 * @deprecated unused
2756 /* The RTP callback: This function is called */
2757 /* every time the encoder has a packet to send. */
2758 /* It depends on the encoder if the data starts */
2759 /* with a Start Code (it should). H.263 does. */
2760 /* mb_nb contains the number of macroblocks */
2761 /* encoded in the RTP payload. */
2762 attribute_deprecated
2763 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2766 #if FF_API_PRIVATE_OPT
2767 /** @deprecated use encoder private options instead */
2768 attribute_deprecated
2769 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2770 /* do its best to deliver a chunk with size */
2771 /* below rtp_payload_size, the chunk will start */
2772 /* with a start code on some codecs like H.263. */
2773 /* This doesn't take account of any particular */
2774 /* headers inside the transmitted RTP payload. */
2777 #if FF_API_STAT_BITS
2778 /* statistics, used for 2-pass encoding */
2779 attribute_deprecated
2781 attribute_deprecated
2783 attribute_deprecated
2785 attribute_deprecated
2787 attribute_deprecated
2789 attribute_deprecated
2791 attribute_deprecated
2793 attribute_deprecated
2796 /** @deprecated this field is unused */
2797 attribute_deprecated
2802 * pass1 encoding statistics output buffer
2803 * - encoding: Set by libavcodec.
2804 * - decoding: unused
2809 * pass2 encoding statistics input buffer
2810 * Concatenated stuff from stats_out of pass1 should be placed here.
2811 * - encoding: Allocated/set/freed by user.
2812 * - decoding: unused
2817 * Work around bugs in encoders which sometimes cannot be detected automatically.
2818 * - encoding: Set by user
2819 * - decoding: Set by user
2821 int workaround_bugs;
2822 #define FF_BUG_AUTODETECT 1 ///< autodetection
2823 #if FF_API_OLD_MSMPEG4
2824 #define FF_BUG_OLD_MSMPEG4 2
2826 #define FF_BUG_XVID_ILACE 4
2827 #define FF_BUG_UMP4 8
2828 #define FF_BUG_NO_PADDING 16
2829 #define FF_BUG_AMV 32
2831 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2833 #define FF_BUG_QPEL_CHROMA 64
2834 #define FF_BUG_STD_QPEL 128
2835 #define FF_BUG_QPEL_CHROMA2 256
2836 #define FF_BUG_DIRECT_BLOCKSIZE 512
2837 #define FF_BUG_EDGE 1024
2838 #define FF_BUG_HPEL_CHROMA 2048
2839 #define FF_BUG_DC_CLIP 4096
2840 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2841 #define FF_BUG_TRUNCATED 16384
2844 * strictly follow the standard (MPEG4, ...).
2845 * - encoding: Set by user.
2846 * - decoding: Set by user.
2847 * Setting this to STRICT or higher means the encoder and decoder will
2848 * generally do stupid things, whereas setting it to unofficial or lower
2849 * will mean the encoder might produce output that is not supported by all
2850 * spec-compliant decoders. Decoders don't differentiate between normal,
2851 * unofficial and experimental (that is, they always try to decode things
2852 * when they can) unless they are explicitly asked to behave stupidly
2853 * (=strictly conform to the specs)
2855 int strict_std_compliance;
2856 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2857 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2858 #define FF_COMPLIANCE_NORMAL 0
2859 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2860 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2863 * error concealment flags
2864 * - encoding: unused
2865 * - decoding: Set by user.
2867 int error_concealment;
2868 #define FF_EC_GUESS_MVS 1
2869 #define FF_EC_DEBLOCK 2
2870 #define FF_EC_FAVOR_INTER 256
2874 * - encoding: Set by user.
2875 * - decoding: Set by user.
2878 #define FF_DEBUG_PICT_INFO 1
2879 #define FF_DEBUG_RC 2
2880 #define FF_DEBUG_BITSTREAM 4
2881 #define FF_DEBUG_MB_TYPE 8
2882 #define FF_DEBUG_QP 16
2885 * @deprecated this option does nothing
2887 #define FF_DEBUG_MV 32
2889 #define FF_DEBUG_DCT_COEFF 0x00000040
2890 #define FF_DEBUG_SKIP 0x00000080
2891 #define FF_DEBUG_STARTCODE 0x00000100
2892 #if FF_API_UNUSED_MEMBERS
2893 #define FF_DEBUG_PTS 0x00000200
2894 #endif /* FF_API_UNUSED_MEMBERS */
2895 #define FF_DEBUG_ER 0x00000400
2896 #define FF_DEBUG_MMCO 0x00000800
2897 #define FF_DEBUG_BUGS 0x00001000
2899 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2900 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2902 #define FF_DEBUG_BUFFERS 0x00008000
2903 #define FF_DEBUG_THREADS 0x00010000
2904 #define FF_DEBUG_GREEN_MD 0x00800000
2905 #define FF_DEBUG_NOMC 0x01000000
2910 * Code outside libavcodec should access this field using AVOptions
2911 * - encoding: Set by user.
2912 * - decoding: Set by user.
2915 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2916 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2917 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2921 * Error recognition; may misdetect some more or less valid parts as errors.
2922 * - encoding: unused
2923 * - decoding: Set by user.
2925 int err_recognition;
2928 * Verify checksums embedded in the bitstream (could be of either encoded or
2929 * decoded data, depending on the codec) and print an error message on mismatch.
2930 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2931 * decoder returning an error.
2933 #define AV_EF_CRCCHECK (1<<0)
2934 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2935 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2936 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2938 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2939 #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
2940 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2941 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2945 * opaque 64bit number (generally a PTS) that will be reordered and
2946 * output in AVFrame.reordered_opaque
2947 * - encoding: unused
2948 * - decoding: Set by user.
2950 int64_t reordered_opaque;
2953 * Hardware accelerator in use
2954 * - encoding: unused.
2955 * - decoding: Set by libavcodec
2957 struct AVHWAccel *hwaccel;
2960 * Hardware accelerator context.
2961 * For some hardware accelerators, a global context needs to be
2962 * provided by the user. In that case, this holds display-dependent
2963 * data FFmpeg cannot instantiate itself. Please refer to the
2964 * FFmpeg HW accelerator documentation to know how to fill this
2965 * is. e.g. for VA API, this is a struct vaapi_context.
2966 * - encoding: unused
2967 * - decoding: Set by user
2969 void *hwaccel_context;
2973 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2974 * - decoding: unused
2976 uint64_t error[AV_NUM_DATA_POINTERS];
2979 * DCT algorithm, see FF_DCT_* below
2980 * - encoding: Set by user.
2981 * - decoding: unused
2984 #define FF_DCT_AUTO 0
2985 #define FF_DCT_FASTINT 1
2986 #define FF_DCT_INT 2
2987 #define FF_DCT_MMX 3
2988 #define FF_DCT_ALTIVEC 5
2989 #define FF_DCT_FAAN 6
2992 * IDCT algorithm, see FF_IDCT_* below.
2993 * - encoding: Set by user.
2994 * - decoding: Set by user.
2997 #define FF_IDCT_AUTO 0
2998 #define FF_IDCT_INT 1
2999 #define FF_IDCT_SIMPLE 2
3000 #define FF_IDCT_SIMPLEMMX 3
3001 #define FF_IDCT_ARM 7
3002 #define FF_IDCT_ALTIVEC 8
3004 #define FF_IDCT_SH4 9
3006 #define FF_IDCT_SIMPLEARM 10
3007 #if FF_API_UNUSED_MEMBERS
3008 #define FF_IDCT_IPP 13
3009 #endif /* FF_API_UNUSED_MEMBERS */
3010 #define FF_IDCT_XVID 14
3011 #if FF_API_IDCT_XVIDMMX
3012 #define FF_IDCT_XVIDMMX 14
3013 #endif /* FF_API_IDCT_XVIDMMX */
3014 #define FF_IDCT_SIMPLEARMV5TE 16
3015 #define FF_IDCT_SIMPLEARMV6 17
3016 #if FF_API_ARCH_SPARC
3017 #define FF_IDCT_SIMPLEVIS 18
3019 #define FF_IDCT_FAAN 20
3020 #define FF_IDCT_SIMPLENEON 22
3021 #if FF_API_ARCH_ALPHA
3022 #define FF_IDCT_SIMPLEALPHA 23
3024 #define FF_IDCT_SIMPLEAUTO 128
3027 * bits per sample/pixel from the demuxer (needed for huffyuv).
3028 * - encoding: Set by libavcodec.
3029 * - decoding: Set by user.
3031 int bits_per_coded_sample;
3034 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3035 * - encoding: set by user.
3036 * - decoding: set by libavcodec.
3038 int bits_per_raw_sample;
3042 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3043 * - encoding: unused
3044 * - decoding: Set by user.
3045 * Code outside libavcodec should access this field using:
3046 * av_codec_{get,set}_lowres(avctx)
3051 #if FF_API_CODED_FRAME
3053 * the picture in the bitstream
3054 * - encoding: Set by libavcodec.
3055 * - decoding: unused
3057 * @deprecated use the quality factor packet side data instead
3059 attribute_deprecated AVFrame *coded_frame;
3064 * is used to decide how many independent tasks should be passed to execute()
3065 * - encoding: Set by user.
3066 * - decoding: Set by user.
3071 * Which multithreading methods to use.
3072 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3073 * so clients which cannot provide future frames should not use it.
3075 * - encoding: Set by user, otherwise the default is used.
3076 * - decoding: Set by user, otherwise the default is used.
3079 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3080 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3083 * Which multithreading methods are in use by the codec.
3084 * - encoding: Set by libavcodec.
3085 * - decoding: Set by libavcodec.
3087 int active_thread_type;
3090 * Set by the client if its custom get_buffer() callback can be called
3091 * synchronously from another thread, which allows faster multithreaded decoding.
3092 * draw_horiz_band() will be called from other threads regardless of this setting.
3093 * Ignored if the default get_buffer() is used.
3094 * - encoding: Set by user.
3095 * - decoding: Set by user.
3097 int thread_safe_callbacks;
3100 * The codec may call this to execute several independent things.
3101 * It will return only after finishing all tasks.
3102 * The user may replace this with some multithreaded implementation,
3103 * the default implementation will execute the parts serially.
3104 * @param count the number of things to execute
3105 * - encoding: Set by libavcodec, user can override.
3106 * - decoding: Set by libavcodec, user can override.
3108 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3111 * The codec may call this to execute several independent things.
3112 * It will return only after finishing all tasks.
3113 * The user may replace this with some multithreaded implementation,
3114 * the default implementation will execute the parts serially.
3115 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3116 * @param c context passed also to func
3117 * @param count the number of things to execute
3118 * @param arg2 argument passed unchanged to func
3119 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3120 * @param func function that will be called count times, with jobnr from 0 to count-1.
3121 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3122 * two instances of func executing at the same time will have the same threadnr.
3123 * @return always 0 currently, but code should handle a future improvement where when any call to func
3124 * returns < 0 no further calls to func may be done and < 0 is returned.
3125 * - encoding: Set by libavcodec, user can override.
3126 * - decoding: Set by libavcodec, user can override.
3128 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3131 * noise vs. sse weight for the nsse comparison function
3132 * - encoding: Set by user.
3133 * - decoding: unused
3139 * - encoding: Set by user.
3140 * - decoding: Set by libavcodec.
3143 #define FF_PROFILE_UNKNOWN -99
3144 #define FF_PROFILE_RESERVED -100
3146 #define FF_PROFILE_AAC_MAIN 0
3147 #define FF_PROFILE_AAC_LOW 1
3148 #define FF_PROFILE_AAC_SSR 2
3149 #define FF_PROFILE_AAC_LTP 3
3150 #define FF_PROFILE_AAC_HE 4
3151 #define FF_PROFILE_AAC_HE_V2 28
3152 #define FF_PROFILE_AAC_LD 22
3153 #define FF_PROFILE_AAC_ELD 38
3154 #define FF_PROFILE_MPEG2_AAC_LOW 128
3155 #define FF_PROFILE_MPEG2_AAC_HE 131
3157 #define FF_PROFILE_DTS 20
3158 #define FF_PROFILE_DTS_ES 30
3159 #define FF_PROFILE_DTS_96_24 40
3160 #define FF_PROFILE_DTS_HD_HRA 50
3161 #define FF_PROFILE_DTS_HD_MA 60
3162 #define FF_PROFILE_DTS_EXPRESS 70
3164 #define FF_PROFILE_MPEG2_422 0
3165 #define FF_PROFILE_MPEG2_HIGH 1
3166 #define FF_PROFILE_MPEG2_SS 2
3167 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3168 #define FF_PROFILE_MPEG2_MAIN 4
3169 #define FF_PROFILE_MPEG2_SIMPLE 5
3171 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3172 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3174 #define FF_PROFILE_H264_BASELINE 66
3175 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3176 #define FF_PROFILE_H264_MAIN 77
3177 #define FF_PROFILE_H264_EXTENDED 88
3178 #define FF_PROFILE_H264_HIGH 100
3179 #define FF_PROFILE_H264_HIGH_10 110
3180 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3181 #define FF_PROFILE_H264_HIGH_422 122
3182 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3183 #define FF_PROFILE_H264_HIGH_444 144
3184 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3185 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3186 #define FF_PROFILE_H264_CAVLC_444 44
3188 #define FF_PROFILE_VC1_SIMPLE 0
3189 #define FF_PROFILE_VC1_MAIN 1
3190 #define FF_PROFILE_VC1_COMPLEX 2
3191 #define FF_PROFILE_VC1_ADVANCED 3
3193 #define FF_PROFILE_MPEG4_SIMPLE 0
3194 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3195 #define FF_PROFILE_MPEG4_CORE 2
3196 #define FF_PROFILE_MPEG4_MAIN 3
3197 #define FF_PROFILE_MPEG4_N_BIT 4
3198 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3199 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3200 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3201 #define FF_PROFILE_MPEG4_HYBRID 8
3202 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3203 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3204 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3205 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3206 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3207 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3208 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3210 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
3211 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
3212 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
3213 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3214 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3216 #define FF_PROFILE_VP9_0 0
3217 #define FF_PROFILE_VP9_1 1
3218 #define FF_PROFILE_VP9_2 2
3219 #define FF_PROFILE_VP9_3 3
3221 #define FF_PROFILE_HEVC_MAIN 1
3222 #define FF_PROFILE_HEVC_MAIN_10 2
3223 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3224 #define FF_PROFILE_HEVC_REXT 4
3228 * - encoding: Set by user.
3229 * - decoding: Set by libavcodec.
3232 #define FF_LEVEL_UNKNOWN -99
3235 * Skip loop filtering for selected frames.
3236 * - encoding: unused
3237 * - decoding: Set by user.
3239 enum AVDiscard skip_loop_filter;
3242 * Skip IDCT/dequantization for selected frames.
3243 * - encoding: unused
3244 * - decoding: Set by user.
3246 enum AVDiscard skip_idct;
3249 * Skip decoding for selected frames.
3250 * - encoding: unused
3251 * - decoding: Set by user.
3253 enum AVDiscard skip_frame;
3256 * Header containing style information for text subtitles.
3257 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3258 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3259 * the Format line following. It shouldn't include any Dialogue line.
3260 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3261 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3263 uint8_t *subtitle_header;
3264 int subtitle_header_size;
3266 #if FF_API_ERROR_RATE
3268 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3271 attribute_deprecated
3275 #if FF_API_VBV_DELAY
3277 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3278 * Used for compliant TS muxing.
3279 * - encoding: Set by libavcodec.
3280 * - decoding: unused.
3281 * @deprecated this value is now exported as a part of
3282 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3284 attribute_deprecated
3288 #if FF_API_SIDEDATA_ONLY_PKT
3290 * Encoding only and set by default. Allow encoders to output packets
3291 * that do not contain any encoded data, only side data.
3293 * Some encoders need to output such packets, e.g. to update some stream
3294 * parameters at the end of encoding.
3296 * @deprecated this field disables the default behaviour and
3297 * it is kept only for compatibility.
3299 attribute_deprecated
3300 int side_data_only_packets;
3304 * Audio only. The number of "priming" samples (padding) inserted by the
3305 * encoder at the beginning of the audio. I.e. this number of leading
3306 * decoded samples must be discarded by the caller to get the original audio
3307 * without leading padding.
3309 * - decoding: unused
3310 * - encoding: Set by libavcodec. The timestamps on the output packets are
3311 * adjusted by the encoder so that they always refer to the
3312 * first sample of the data actually contained in the packet,
3313 * including any added padding. E.g. if the timebase is
3314 * 1/samplerate and the timestamp of the first input sample is
3315 * 0, the timestamp of the first output packet will be
3318 int initial_padding;
3321 * - decoding: For codecs that store a framerate value in the compressed
3322 * bitstream, the decoder may export it here. { 0, 1} when
3324 * - encoding: unused
3326 AVRational framerate;
3329 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3330 * - encoding: unused.
3331 * - decoding: Set by libavcodec before calling get_format()
3333 enum AVPixelFormat sw_pix_fmt;
3336 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3337 * Code outside libavcodec should access this field using:
3338 * av_codec_{get,set}_pkt_timebase(avctx)
3339 * - encoding unused.
3340 * - decoding set by user.
3342 AVRational pkt_timebase;
3346 * Code outside libavcodec should access this field using:
3347 * av_codec_{get,set}_codec_descriptor(avctx)
3348 * - encoding: unused.
3349 * - decoding: set by libavcodec.
3351 const AVCodecDescriptor *codec_descriptor;
3355 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3356 * - encoding: unused
3357 * - decoding: Set by user.
3358 * Code outside libavcodec should access this field using:
3359 * av_codec_{get,set}_lowres(avctx)
3365 * Current statistics for PTS correction.
3366 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3367 * - encoding: unused
3369 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3370 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3371 int64_t pts_correction_last_pts; /// PTS of the last frame
3372 int64_t pts_correction_last_dts; /// DTS of the last frame
3375 * Character encoding of the input subtitles file.
3376 * - decoding: set by user
3377 * - encoding: unused
3382 * Subtitles character encoding mode. Formats or codecs might be adjusting
3383 * this setting (if they are doing the conversion themselves for instance).
3384 * - decoding: set by libavcodec
3385 * - encoding: unused
3387 int sub_charenc_mode;
3388 #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)
3389 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3390 #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
3393 * Skip processing alpha if supported by codec.
3394 * Note that if the format uses pre-multiplied alpha (common with VP6,
3395 * and recommended due to better video quality/compression)
3396 * the image will look as if alpha-blended onto a black background.
3397 * However for formats that do not use pre-multiplied alpha
3398 * there might be serious artefacts (though e.g. libswscale currently
3399 * assumes pre-multiplied alpha anyway).
3400 * Code outside libavcodec should access this field using AVOptions
3402 * - decoding: set by user
3403 * - encoding: unused
3408 * Number of samples to skip after a discontinuity
3409 * - decoding: unused
3410 * - encoding: set by libavcodec
3414 #if !FF_API_DEBUG_MV
3416 * debug motion vectors
3417 * Code outside libavcodec should access this field using AVOptions
3418 * - encoding: Set by user.
3419 * - decoding: Set by user.
3422 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3423 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3424 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3428 * custom intra quantization matrix
3429 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3430 * - encoding: Set by user, can be NULL.
3431 * - decoding: unused.
3433 uint16_t *chroma_intra_matrix;
3436 * dump format separator.
3437 * can be ", " or "\n " or anything else
3438 * Code outside libavcodec should access this field using AVOptions
3439 * (NO direct access).
3440 * - encoding: Set by user.
3441 * - decoding: Set by user.
3443 uint8_t *dump_separator;
3446 * ',' separated list of allowed decoders.
3447 * If NULL then all are allowed
3448 * - encoding: unused
3449 * - decoding: set by user through AVOPtions (NO direct access)
3451 char *codec_whitelist;
3454 * Properties of the stream that gets decoded
3455 * To be accessed through av_codec_get_properties() (NO direct access)
3456 * - encoding: unused
3457 * - decoding: set by libavcodec
3459 unsigned properties;
3460 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3461 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3464 * Additional data associated with the entire coded stream.
3466 * - decoding: unused
3467 * - encoding: may be set by libavcodec after avcodec_open2().
3469 AVPacketSideData *coded_side_data;
3470 int nb_coded_side_data;
3475 * For hardware encoders configured to use a hwaccel pixel format, this
3476 * field should be set by the caller to a reference to the AVHWFramesContext
3477 * describing input frames. AVHWFramesContext.format must be equal to
3478 * AVCodecContext.pix_fmt.
3480 * This field should be set before avcodec_open2() is called and is
3481 * afterwards owned and managed by libavcodec.
3483 AVBufferRef *hw_frames_ctx;
3486 * Control the form of AVSubtitle.rects[N]->ass
3487 * - decoding: set by user
3488 * - encoding: unused
3490 int sub_text_format;
3491 #define FF_SUB_TEXT_FMT_ASS 0
3492 #if FF_API_ASS_TIMING
3493 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3498 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3499 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3501 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3502 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3504 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3506 int av_codec_get_lowres(const AVCodecContext *avctx);
3507 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3509 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3510 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3512 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3513 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3518 typedef struct AVProfile {
3520 const char *name; ///< short name for the profile
3523 typedef struct AVCodecDefault AVCodecDefault;
3530 typedef struct AVCodec {
3532 * Name of the codec implementation.
3533 * The name is globally unique among encoders and among decoders (but an
3534 * encoder and a decoder can share the same name).
3535 * This is the primary way to find a codec from the user perspective.
3539 * Descriptive name for the codec, meant to be more human readable than name.
3540 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3542 const char *long_name;
3543 enum AVMediaType type;
3546 * Codec capabilities.
3547 * see AV_CODEC_CAP_*
3550 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3551 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3552 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3553 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3554 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3555 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3556 const AVClass *priv_class; ///< AVClass for the private context
3557 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3559 /*****************************************************************
3560 * No fields below this line are part of the public API. They
3561 * may not be used outside of libavcodec and can be changed and
3563 * New public fields should be added right above.
3564 *****************************************************************
3567 struct AVCodec *next;
3569 * @name Frame-level threading support functions
3573 * If defined, called on thread contexts when they are created.
3574 * If the codec allocates writable tables in init(), re-allocate them here.
3575 * priv_data will be set to a copy of the original.
3577 int (*init_thread_copy)(AVCodecContext *);
3579 * Copy necessary context variables from a previous thread context to the current one.
3580 * If not defined, the next thread will start automatically; otherwise, the codec
3581 * must call ff_thread_finish_setup().
3583 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3585 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3589 * Private codec-specific defaults.
3591 const AVCodecDefault *defaults;
3594 * Initialize codec static data, called from avcodec_register().
3596 void (*init_static_data)(struct AVCodec *codec);
3598 int (*init)(AVCodecContext *);
3599 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3600 const struct AVSubtitle *sub);
3602 * Encode data to an AVPacket.
3604 * @param avctx codec context
3605 * @param avpkt output AVPacket (may contain a user-provided buffer)
3606 * @param[in] frame AVFrame containing the raw data to be encoded
3607 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3608 * non-empty packet was returned in avpkt.
3609 * @return 0 on success, negative error code on failure
3611 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3612 int *got_packet_ptr);
3613 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3614 int (*close)(AVCodecContext *);
3616 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3617 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3619 * - never called if the codec is closed or the wrong type,
3620 * - AVPacket parameter change side data is applied right before calling
3621 * AVCodec->send_packet,
3622 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3623 * - only one drain packet is ever passed down (until the next flush()),
3624 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3626 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3627 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3628 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3629 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3632 * Will be called when seeking
3634 void (*flush)(AVCodecContext *);
3636 * Internal codec capabilities.
3637 * See FF_CODEC_CAP_* in internal.h
3642 int av_codec_get_max_lowres(const AVCodec *codec);
3644 struct MpegEncContext;
3647 * @defgroup lavc_hwaccel AVHWAccel
3650 typedef struct AVHWAccel {
3652 * Name of the hardware accelerated codec.
3653 * The name is globally unique among encoders and among decoders (but an
3654 * encoder and a decoder can share the same name).
3659 * Type of codec implemented by the hardware accelerator.
3661 * See AVMEDIA_TYPE_xxx
3663 enum AVMediaType type;
3666 * Codec implemented by the hardware accelerator.
3668 * See AV_CODEC_ID_xxx
3673 * Supported pixel format.
3675 * Only hardware accelerated formats are supported here.
3677 enum AVPixelFormat pix_fmt;
3680 * Hardware accelerated codec capabilities.
3681 * see HWACCEL_CODEC_CAP_*
3685 /*****************************************************************
3686 * No fields below this line are part of the public API. They
3687 * may not be used outside of libavcodec and can be changed and
3689 * New public fields should be added right above.
3690 *****************************************************************
3692 struct AVHWAccel *next;
3695 * Allocate a custom buffer
3697 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3700 * Called at the beginning of each frame or field picture.
3702 * Meaningful frame information (codec specific) is guaranteed to
3703 * be parsed at this point. This function is mandatory.
3705 * Note that buf can be NULL along with buf_size set to 0.
3706 * Otherwise, this means the whole frame is available at this point.
3708 * @param avctx the codec context
3709 * @param buf the frame data buffer base
3710 * @param buf_size the size of the frame in bytes
3711 * @return zero if successful, a negative value otherwise
3713 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3716 * Callback for each slice.
3718 * Meaningful slice information (codec specific) is guaranteed to
3719 * be parsed at this point. This function is mandatory.
3720 * The only exception is XvMC, that works on MB level.
3722 * @param avctx the codec context
3723 * @param buf the slice data buffer base
3724 * @param buf_size the size of the slice in bytes
3725 * @return zero if successful, a negative value otherwise
3727 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3730 * Called at the end of each frame or field picture.
3732 * The whole picture is parsed at this point and can now be sent
3733 * to the hardware accelerator. This function is mandatory.
3735 * @param avctx the codec context
3736 * @return zero if successful, a negative value otherwise
3738 int (*end_frame)(AVCodecContext *avctx);
3741 * Size of per-frame hardware accelerator private data.
3743 * Private data is allocated with av_mallocz() before
3744 * AVCodecContext.get_buffer() and deallocated after
3745 * AVCodecContext.release_buffer().
3747 int frame_priv_data_size;
3750 * Called for every Macroblock in a slice.
3752 * XvMC uses it to replace the ff_mpv_decode_mb().
3753 * Instead of decoding to raw picture, MB parameters are
3754 * stored in an array provided by the video driver.
3756 * @param s the mpeg context
3758 void (*decode_mb)(struct MpegEncContext *s);
3761 * Initialize the hwaccel private data.
3763 * This will be called from ff_get_format(), after hwaccel and
3764 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3767 int (*init)(AVCodecContext *avctx);
3770 * Uninitialize the hwaccel private data.
3772 * This will be called from get_format() or avcodec_close(), after hwaccel
3773 * and hwaccel_context are already uninitialized.
3775 int (*uninit)(AVCodecContext *avctx);
3778 * Size of the private data to allocate in
3779 * AVCodecInternal.hwaccel_priv_data.
3785 * Hardware acceleration should be used for decoding even if the codec level
3786 * used is unknown or higher than the maximum supported level reported by the
3789 * It's generally a good idea to pass this flag unless you have a specific
3790 * reason not to, as hardware tends to under-report supported levels.
3792 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3795 * Hardware acceleration can output YUV pixel formats with a different chroma
3796 * sampling than 4:2:0 and/or other than 8 bits per component.
3798 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3804 #if FF_API_AVPICTURE
3806 * @defgroup lavc_picture AVPicture
3808 * Functions for working with AVPicture
3813 * Picture data structure.
3815 * Up to four components can be stored into it, the last component is
3817 * @deprecated use AVFrame or imgutils functions instead
3819 typedef struct AVPicture {
3820 attribute_deprecated
3821 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3822 attribute_deprecated
3823 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3831 enum AVSubtitleType {
3834 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3837 * Plain text, the text field must be set by the decoder and is
3838 * authoritative. ass and pict fields may contain approximations.
3843 * Formatted text, the ass field must be set by the decoder and is
3844 * authoritative. pict and text fields may contain approximations.
3849 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3851 typedef struct AVSubtitleRect {
3852 int x; ///< top left corner of pict, undefined when pict is not set
3853 int y; ///< top left corner of pict, undefined when pict is not set
3854 int w; ///< width of pict, undefined when pict is not set
3855 int h; ///< height of pict, undefined when pict is not set
3856 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3858 #if FF_API_AVPICTURE
3860 * @deprecated unused
3862 attribute_deprecated
3866 * data+linesize for the bitmap of this subtitle.
3867 * Can be set for text/ass as well once they are rendered.
3872 enum AVSubtitleType type;
3874 char *text; ///< 0 terminated plain UTF-8 text
3877 * 0 terminated ASS/SSA compatible event line.
3878 * The presentation of this is unaffected by the other values in this
3886 typedef struct AVSubtitle {
3887 uint16_t format; /* 0 = graphics */
3888 uint32_t start_display_time; /* relative to packet pts, in ms */
3889 uint32_t end_display_time; /* relative to packet pts, in ms */
3891 AVSubtitleRect **rects;
3892 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3896 * This struct describes the properties of an encoded stream.
3898 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3899 * be allocated with avcodec_parameters_alloc() and freed with
3900 * avcodec_parameters_free().
3902 typedef struct AVCodecParameters {
3904 * General type of the encoded data.
3906 enum AVMediaType codec_type;
3908 * Specific type of the encoded data (the codec used).
3910 enum AVCodecID codec_id;
3912 * Additional information about the codec (corresponds to the AVI FOURCC).
3917 * Extra binary data needed for initializing the decoder, codec-dependent.
3919 * Must be allocated with av_malloc() and will be freed by
3920 * avcodec_parameters_free(). The allocated size of extradata must be at
3921 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3926 * Size of the extradata content in bytes.
3931 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3932 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3937 * The average bitrate of the encoded data (in bits per second).
3942 * The number of bits per sample in the codedwords.
3944 * This is basically the bitrate per sample. It is mandatory for a bunch of
3945 * formats to actually decode them. It's the number of bits for one sample in
3946 * the actual coded bitstream.
3948 * This could be for example 4 for ADPCM
3949 * For PCM formats this matches bits_per_raw_sample
3952 int bits_per_coded_sample;
3955 * This is the number of valid bits in each output sample. If the
3956 * sample format has more bits, the least significant bits are additional
3957 * padding bits, which are always 0. Use right shifts to reduce the sample
3958 * to its actual size. For example, audio formats with 24 bit samples will
3959 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3960 * To get the original sample use "(int32_t)sample >> 8"."
3962 * For ADPCM this might be 12 or 16 or similar
3965 int bits_per_raw_sample;
3968 * Codec-specific bitstream restrictions that the stream conforms to.
3974 * Video only. The dimensions of the video frame in pixels.
3980 * Video only. The aspect ratio (width / height) which a single pixel
3981 * should have when displayed.
3983 * When the aspect ratio is unknown / undefined, the numerator should be
3984 * set to 0 (the denominator may have any value).
3986 AVRational sample_aspect_ratio;
3989 * Video only. The order of the fields in interlaced video.
3991 enum AVFieldOrder field_order;
3994 * Video only. Additional colorspace characteristics.
3996 enum AVColorRange color_range;
3997 enum AVColorPrimaries color_primaries;
3998 enum AVColorTransferCharacteristic color_trc;
3999 enum AVColorSpace color_space;
4000 enum AVChromaLocation chroma_location;
4003 * Video only. Number of delayed frames.
4008 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4009 * unknown or unspecified, otherwise the number of bits set must be equal to
4010 * the channels field.
4012 uint64_t channel_layout;
4014 * Audio only. The number of audio channels.
4018 * Audio only. The number of audio samples per second.
4022 * Audio only. The number of bytes per coded audio frame, required by some
4025 * Corresponds to nBlockAlign in WAVEFORMATEX.
4029 * Audio only. Audio frame size, if known. Required by some formats to be static.
4034 * Audio only. The amount of padding (in samples) inserted by the encoder at
4035 * the beginning of the audio. I.e. this number of leading decoded samples
4036 * must be discarded by the caller to get the original audio without leading
4039 int initial_padding;
4041 * Audio only. The amount of padding (in samples) appended by the encoder to
4042 * the end of the audio. I.e. this number of decoded samples must be
4043 * discarded by the caller from the end of the stream to get the original
4044 * audio without any trailing padding.
4046 int trailing_padding;
4048 * Audio only. Number of samples to skip after a discontinuity.
4051 } AVCodecParameters;
4054 * If c is NULL, returns the first registered codec,
4055 * if c is non-NULL, returns the next registered codec after c,
4056 * or NULL if c is the last one.
4058 AVCodec *av_codec_next(const AVCodec *c);
4061 * Return the LIBAVCODEC_VERSION_INT constant.
4063 unsigned avcodec_version(void);
4066 * Return the libavcodec build-time configuration.
4068 const char *avcodec_configuration(void);
4071 * Return the libavcodec license.
4073 const char *avcodec_license(void);
4076 * Register the codec codec and initialize libavcodec.
4078 * @warning either this function or avcodec_register_all() must be called
4079 * before any other libavcodec functions.
4081 * @see avcodec_register_all()
4083 void avcodec_register(AVCodec *codec);
4086 * Register all the codecs, parsers and bitstream filters which were enabled at
4087 * configuration time. If you do not call this function you can select exactly
4088 * which formats you want to support, by using the individual registration
4091 * @see avcodec_register
4092 * @see av_register_codec_parser
4093 * @see av_register_bitstream_filter
4095 void avcodec_register_all(void);
4098 * Allocate an AVCodecContext and set its fields to default values. The
4099 * resulting struct should be freed with avcodec_free_context().
4101 * @param codec if non-NULL, allocate private data and initialize defaults
4102 * for the given codec. It is illegal to then call avcodec_open2()
4103 * with a different codec.
4104 * If NULL, then the codec-specific defaults won't be initialized,
4105 * which may result in suboptimal default settings (this is
4106 * important mainly for encoders, e.g. libx264).
4108 * @return An AVCodecContext filled with default values or NULL on failure.
4109 * @see avcodec_get_context_defaults
4111 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4114 * Free the codec context and everything associated with it and write NULL to
4115 * the provided pointer.
4117 void avcodec_free_context(AVCodecContext **avctx);
4120 * Set the fields of the given AVCodecContext to default values corresponding
4121 * to the given codec (defaults may be codec-dependent).
4123 * Do not call this function if a non-NULL codec has been passed
4124 * to avcodec_alloc_context3() that allocated this AVCodecContext.
4125 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
4126 * different codec on this AVCodecContext.
4128 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4131 * Get the AVClass for AVCodecContext. It can be used in combination with
4132 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4134 * @see av_opt_find().
4136 const AVClass *avcodec_get_class(void);
4139 * Get the AVClass for AVFrame. It can be used in combination with
4140 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4142 * @see av_opt_find().
4144 const AVClass *avcodec_get_frame_class(void);
4147 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4148 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4150 * @see av_opt_find().
4152 const AVClass *avcodec_get_subtitle_rect_class(void);
4155 * Copy the settings of the source AVCodecContext into the destination
4156 * AVCodecContext. The resulting destination codec context will be
4157 * unopened, i.e. you are required to call avcodec_open2() before you
4158 * can use this AVCodecContext to decode/encode video/audio data.
4160 * @param dest target codec context, should be initialized with
4161 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4162 * @param src source codec context
4163 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4165 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4168 * Allocate a new AVCodecParameters and set its fields to default values
4169 * (unknown/invalid/0). The returned struct must be freed with
4170 * avcodec_parameters_free().
4172 AVCodecParameters *avcodec_parameters_alloc(void);
4175 * Free an AVCodecParameters instance and everything associated with it and
4176 * write NULL to the supplied pointer.
4178 void avcodec_parameters_free(AVCodecParameters **par);
4181 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4182 * replaced with newly allocated duplicates of the corresponding fields in src.
4184 * @return >= 0 on success, a negative AVERROR code on failure.
4186 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4189 * Fill the parameters struct based on the values from the supplied codec
4190 * context. Any allocated fields in par are freed and replaced with duplicates
4191 * of the corresponding fields in codec.
4193 * @return >= 0 on success, a negative AVERROR code on failure
4195 int avcodec_parameters_from_context(AVCodecParameters *par,
4196 const AVCodecContext *codec);
4199 * Fill the codec context based on the values from the supplied codec
4200 * parameters. Any allocated fields in codec that have a corresponding field in
4201 * par are freed and replaced with duplicates of the corresponding field in par.
4202 * Fields in codec that do not have a counterpart in par are not touched.
4204 * @return >= 0 on success, a negative AVERROR code on failure.
4206 int avcodec_parameters_to_context(AVCodecContext *codec,
4207 const AVCodecParameters *par);
4210 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4211 * function the context has to be allocated with avcodec_alloc_context3().
4213 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4214 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4215 * retrieving a codec.
4217 * @warning This function is not thread safe!
4219 * @note Always call this function before using decoding routines (such as
4220 * @ref avcodec_receive_frame()).
4223 * avcodec_register_all();
4224 * av_dict_set(&opts, "b", "2.5M", 0);
4225 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4229 * context = avcodec_alloc_context3(codec);
4231 * if (avcodec_open2(context, codec, opts) < 0)
4235 * @param avctx The context to initialize.
4236 * @param codec The codec to open this context for. If a non-NULL codec has been
4237 * previously passed to avcodec_alloc_context3() or
4238 * avcodec_get_context_defaults3() for this context, then this
4239 * parameter MUST be either NULL or equal to the previously passed
4241 * @param options A dictionary filled with AVCodecContext and codec-private options.
4242 * On return this object will be filled with options that were not found.
4244 * @return zero on success, a negative value on error
4245 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4246 * av_dict_set(), av_opt_find().
4248 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4251 * Close a given AVCodecContext and free all the data associated with it
4252 * (but not the AVCodecContext itself).
4254 * Calling this function on an AVCodecContext that hasn't been opened will free
4255 * the codec-specific data allocated in avcodec_alloc_context3() /
4256 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
4259 int avcodec_close(AVCodecContext *avctx);
4262 * Free all allocated data in the given subtitle struct.
4264 * @param sub AVSubtitle to free.
4266 void avsubtitle_free(AVSubtitle *sub);
4273 * @addtogroup lavc_packet
4278 * Allocate an AVPacket and set its fields to default values. The resulting
4279 * struct must be freed using av_packet_free().
4281 * @return An AVPacket filled with default values or NULL on failure.
4283 * @note this only allocates the AVPacket itself, not the data buffers. Those
4284 * must be allocated through other means such as av_new_packet.
4286 * @see av_new_packet
4288 AVPacket *av_packet_alloc(void);
4291 * Create a new packet that references the same data as src.
4293 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4295 * @return newly created AVPacket on success, NULL on error.
4297 * @see av_packet_alloc
4298 * @see av_packet_ref
4300 AVPacket *av_packet_clone(AVPacket *src);
4303 * Free the packet, if the packet is reference counted, it will be
4304 * unreferenced first.
4306 * @param packet packet to be freed. The pointer will be set to NULL.
4307 * @note passing NULL is a no-op.
4309 void av_packet_free(AVPacket **pkt);
4312 * Initialize optional fields of a packet with default values.
4314 * Note, this does not touch the data and size members, which have to be
4315 * initialized separately.
4319 void av_init_packet(AVPacket *pkt);
4322 * Allocate the payload of a packet and initialize its fields with
4326 * @param size wanted payload size
4327 * @return 0 if OK, AVERROR_xxx otherwise
4329 int av_new_packet(AVPacket *pkt, int size);
4332 * Reduce packet size, correctly zeroing padding
4335 * @param size new size
4337 void av_shrink_packet(AVPacket *pkt, int size);
4340 * Increase packet size, correctly zeroing padding
4343 * @param grow_by number of bytes by which to increase the size of the packet
4345 int av_grow_packet(AVPacket *pkt, int grow_by);
4348 * Initialize a reference-counted packet from av_malloc()ed data.
4350 * @param pkt packet to be initialized. This function will set the data, size,
4351 * buf and destruct fields, all others are left untouched.
4352 * @param data Data allocated by av_malloc() to be used as packet data. If this
4353 * function returns successfully, the data is owned by the underlying AVBuffer.
4354 * The caller may not access the data through other means.
4355 * @param size size of data in bytes, without the padding. I.e. the full buffer
4356 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4358 * @return 0 on success, a negative AVERROR on error
4360 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4362 #if FF_API_AVPACKET_OLD_API
4364 * @warning This is a hack - the packet memory allocation stuff is broken. The
4365 * packet is allocated if it was not really allocated.
4367 * @deprecated Use av_packet_ref
4369 attribute_deprecated
4370 int av_dup_packet(AVPacket *pkt);
4372 * Copy packet, including contents
4374 * @return 0 on success, negative AVERROR on fail
4376 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4379 * Copy packet side data
4381 * @return 0 on success, negative AVERROR on fail
4383 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4388 * @deprecated Use av_packet_unref
4390 * @param pkt packet to free
4392 attribute_deprecated
4393 void av_free_packet(AVPacket *pkt);
4396 * Allocate new information of a packet.
4399 * @param type side information type
4400 * @param size side information size
4401 * @return pointer to fresh allocated data or NULL otherwise
4403 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4407 * Wrap an existing array as a packet side data.
4410 * @param type side information type
4411 * @param data the side data array. It must be allocated with the av_malloc()
4412 * family of functions. The ownership of the data is transferred to
4414 * @param size side information size
4415 * @return a non-negative number on success, a negative AVERROR code on
4416 * failure. On failure, the packet is unchanged and the data remains
4417 * owned by the caller.
4419 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4420 uint8_t *data, size_t size);
4423 * Shrink the already allocated side data buffer
4426 * @param type side information type
4427 * @param size new side information size
4428 * @return 0 on success, < 0 on failure
4430 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4434 * Get side information from packet.
4437 * @param type desired side information type
4438 * @param size pointer for side information size to store (optional)
4439 * @return pointer to data if present or NULL otherwise
4441 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4444 int av_packet_merge_side_data(AVPacket *pkt);
4446 int av_packet_split_side_data(AVPacket *pkt);
4448 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4451 * Pack a dictionary for use in side_data.
4453 * @param dict The dictionary to pack.
4454 * @param size pointer to store the size of the returned data
4455 * @return pointer to data if successful, NULL otherwise
4457 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4459 * Unpack a dictionary from side_data.
4461 * @param data data from side_data
4462 * @param size size of the data
4463 * @param dict the metadata storage dictionary
4464 * @return 0 on success, < 0 on failure
4466 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4470 * Convenience function to free all the side data stored.
4471 * All the other fields stay untouched.
4475 void av_packet_free_side_data(AVPacket *pkt);
4478 * Setup a new reference to the data described by a given packet
4480 * If src is reference-counted, setup dst as a new reference to the
4481 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4482 * data from src into it.
4484 * All the other fields are copied from src.
4486 * @see av_packet_unref
4488 * @param dst Destination packet
4489 * @param src Source packet
4491 * @return 0 on success, a negative AVERROR on error.
4493 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4498 * Unreference the buffer referenced by the packet and reset the
4499 * remaining packet fields to their default values.
4501 * @param pkt The packet to be unreferenced.
4503 void av_packet_unref(AVPacket *pkt);
4506 * Move every field in src to dst and reset src.
4508 * @see av_packet_unref
4510 * @param src Source packet, will be reset
4511 * @param dst Destination packet
4513 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4516 * Copy only "properties" fields from src to dst.
4518 * Properties for the purpose of this function are all the fields
4519 * beside those related to the packet data (buf, data, size)
4521 * @param dst Destination packet
4522 * @param src Source packet
4524 * @return 0 on success AVERROR on failure.
4526 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4529 * Convert valid timing fields (timestamps / durations) in a packet from one
4530 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4533 * @param pkt packet on which the conversion will be performed
4534 * @param tb_src source timebase, in which the timing fields in pkt are
4536 * @param tb_dst destination timebase, to which the timing fields will be
4539 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4546 * @addtogroup lavc_decoding
4551 * Find a registered decoder with a matching codec ID.
4553 * @param id AVCodecID of the requested decoder
4554 * @return A decoder if one was found, NULL otherwise.
4556 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4559 * Find a registered decoder with the specified name.
4561 * @param name name of the requested decoder
4562 * @return A decoder if one was found, NULL otherwise.
4564 AVCodec *avcodec_find_decoder_by_name(const char *name);
4567 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4568 * it can be called by custom get_buffer2() implementations for decoders without
4569 * AV_CODEC_CAP_DR1 set.
4571 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4575 * Return the amount of padding in pixels which the get_buffer callback must
4576 * provide around the edge of the image for codecs which do not have the
4577 * CODEC_FLAG_EMU_EDGE flag.
4579 * @return Required padding in pixels.
4581 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4584 attribute_deprecated
4585 unsigned avcodec_get_edge_width(void);
4589 * Modify width and height values so that they will result in a memory
4590 * buffer that is acceptable for the codec if you do not use any horizontal
4593 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4595 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4598 * Modify width and height values so that they will result in a memory
4599 * buffer that is acceptable for the codec if you also ensure that all
4600 * line sizes are a multiple of the respective linesize_align[i].
4602 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4604 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4605 int linesize_align[AV_NUM_DATA_POINTERS]);
4608 * Converts AVChromaLocation to swscale x/y chroma position.
4610 * The positions represent the chroma (0,0) position in a coordinates system
4611 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4613 * @param xpos horizontal chroma sample position
4614 * @param ypos vertical chroma sample position
4616 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4619 * Converts swscale x/y chroma position to AVChromaLocation.
4621 * The positions represent the chroma (0,0) position in a coordinates system
4622 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4624 * @param xpos horizontal chroma sample position
4625 * @param ypos vertical chroma sample position
4627 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4630 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4632 * Some decoders may support multiple frames in a single AVPacket. Such
4633 * decoders would then just decode the first frame and the return value would be
4634 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4635 * called again with an AVPacket containing the remaining data in order to
4636 * decode the second frame, etc... Even if no frames are returned, the packet
4637 * needs to be fed to the decoder with remaining data until it is completely
4638 * consumed or an error occurs.
4640 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4641 * and output. This means that for some packets they will not immediately
4642 * produce decoded output and need to be flushed at the end of decoding to get
4643 * all the decoded data. Flushing is done by calling this function with packets
4644 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4645 * returning samples. It is safe to flush even those decoders that are not
4646 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4648 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4649 * larger than the actual read bytes because some optimized bitstream
4650 * readers read 32 or 64 bits at once and could read over the end.
4652 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4653 * before packets may be fed to the decoder.
4655 * @param avctx the codec context
4656 * @param[out] frame The AVFrame in which to store decoded audio samples.
4657 * The decoder will allocate a buffer for the decoded frame by
4658 * calling the AVCodecContext.get_buffer2() callback.
4659 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4660 * reference counted and the returned reference belongs to the
4661 * caller. The caller must release the frame using av_frame_unref()
4662 * when the frame is no longer needed. The caller may safely write
4663 * to the frame if av_frame_is_writable() returns 1.
4664 * When AVCodecContext.refcounted_frames is set to 0, the returned
4665 * reference belongs to the decoder and is valid only until the
4666 * next call to this function or until closing or flushing the
4667 * decoder. The caller may not write to it.
4668 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4669 * non-zero. Note that this field being set to zero
4670 * does not mean that an error has occurred. For
4671 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4672 * call is guaranteed to produce a frame.
4673 * @param[in] avpkt The input AVPacket containing the input buffer.
4674 * At least avpkt->data and avpkt->size should be set. Some
4675 * decoders might also require additional fields to be set.
4676 * @return A negative error code is returned if an error occurred during
4677 * decoding, otherwise the number of bytes consumed from the input
4678 * AVPacket is returned.
4680 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4682 attribute_deprecated
4683 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4684 int *got_frame_ptr, const AVPacket *avpkt);
4687 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4688 * Some decoders may support multiple frames in a single AVPacket, such
4689 * decoders would then just decode the first frame.
4691 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4692 * the actual read bytes because some optimized bitstream readers read 32 or 64
4693 * bits at once and could read over the end.
4695 * @warning The end of the input buffer buf should be set to 0 to ensure that
4696 * no overreading happens for damaged MPEG streams.
4698 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4699 * between input and output, these need to be fed with avpkt->data=NULL,
4700 * avpkt->size=0 at the end to return the remaining frames.
4702 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4703 * before packets may be fed to the decoder.
4705 * @param avctx the codec context
4706 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4707 * Use av_frame_alloc() to get an AVFrame. The codec will
4708 * allocate memory for the actual bitmap by calling the
4709 * AVCodecContext.get_buffer2() callback.
4710 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4711 * reference counted and the returned reference belongs to the
4712 * caller. The caller must release the frame using av_frame_unref()
4713 * when the frame is no longer needed. The caller may safely write
4714 * to the frame if av_frame_is_writable() returns 1.
4715 * When AVCodecContext.refcounted_frames is set to 0, the returned
4716 * reference belongs to the decoder and is valid only until the
4717 * next call to this function or until closing or flushing the
4718 * decoder. The caller may not write to it.
4720 * @param[in] avpkt The input AVPacket containing the input buffer.
4721 * You can create such packet with av_init_packet() and by then setting
4722 * data and size, some decoders might in addition need other fields like
4723 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4725 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4726 * @return On error a negative value is returned, otherwise the number of bytes
4727 * used or zero if no frame could be decompressed.
4729 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4731 attribute_deprecated
4732 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4733 int *got_picture_ptr,
4734 const AVPacket *avpkt);
4737 * Decode a subtitle message.
4738 * Return a negative value on error, otherwise return the number of bytes used.
4739 * If no subtitle could be decompressed, got_sub_ptr is zero.
4740 * Otherwise, the subtitle is stored in *sub.
4741 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4742 * simplicity, because the performance difference is expect to be negligible
4743 * and reusing a get_buffer written for video codecs would probably perform badly
4744 * due to a potentially very different allocation pattern.
4746 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4747 * and output. This means that for some packets they will not immediately
4748 * produce decoded output and need to be flushed at the end of decoding to get
4749 * all the decoded data. Flushing is done by calling this function with packets
4750 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4751 * returning subtitles. It is safe to flush even those decoders that are not
4752 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4754 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4755 * before packets may be fed to the decoder.
4757 * @param avctx the codec context
4758 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4759 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4760 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4761 * @param[in] avpkt The input AVPacket containing the input buffer.
4763 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4768 * Supply raw packet data as input to a decoder.
4770 * Internally, this call will copy relevant AVCodecContext fields, which can
4771 * influence decoding per-packet, and apply them when the packet is actually
4772 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4773 * decoder to drop the frame contained by the packet sent with this function.)
4775 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4776 * larger than the actual read bytes because some optimized bitstream
4777 * readers read 32 or 64 bits at once and could read over the end.
4779 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4780 * on the same AVCodecContext. It will return unexpected results now
4781 * or in future libavcodec versions.
4783 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4784 * before packets may be fed to the decoder.
4786 * @param avctx codec context
4787 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4788 * frame, or several complete audio frames.
4789 * Ownership of the packet remains with the caller, and the
4790 * decoder will not write to the packet. The decoder may create
4791 * a reference to the packet data (or copy it if the packet is
4792 * not reference-counted).
4793 * Unlike with older APIs, the packet is always fully consumed,
4794 * and if it contains multiple frames (e.g. some audio codecs),
4795 * will require you to call avcodec_receive_frame() multiple
4796 * times afterwards before you can send a new packet.
4797 * It can be NULL (or an AVPacket with data set to NULL and
4798 * size set to 0); in this case, it is considered a flush
4799 * packet, which signals the end of the stream. Sending the
4800 * first flush packet will return success. Subsequent ones are
4801 * unnecessary and will return AVERROR_EOF. If the decoder
4802 * still has frames buffered, it will return them after sending
4805 * @return 0 on success, otherwise negative error code:
4806 * AVERROR(EAGAIN): input is not accepted right now - the packet must be
4807 * resent after trying to read output
4808 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4809 * be sent to it (also returned if more than 1 flush
4811 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4812 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4813 * other errors: legitimate decoding errors
4815 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4818 * Return decoded output data from a decoder.
4820 * @param avctx codec context
4821 * @param frame This will be set to a reference-counted video or audio
4822 * frame (depending on the decoder type) allocated by the
4823 * decoder. Note that the function will always call
4824 * av_frame_unref(frame) before doing anything else.
4827 * 0: success, a frame was returned
4828 * AVERROR(EAGAIN): output is not available right now - user must try
4830 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4831 * no more output frames
4832 * AVERROR(EINVAL): codec not opened, or it is an encoder
4833 * other negative values: legitimate decoding errors
4835 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4838 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4839 * to retrieve buffered output packets.
4841 * @param avctx codec context
4842 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4843 * Ownership of the frame remains with the caller, and the
4844 * encoder will not write to the frame. The encoder may create
4845 * a reference to the frame data (or copy it if the frame is
4846 * not reference-counted).
4847 * It can be NULL, in which case it is considered a flush
4848 * packet. This signals the end of the stream. If the encoder
4849 * still has packets buffered, it will return them after this
4850 * call. Once flushing mode has been entered, additional flush
4851 * packets are ignored, and sending frames will return
4855 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4856 * can have any number of samples.
4857 * If it is not set, frame->nb_samples must be equal to
4858 * avctx->frame_size for all frames except the last.
4859 * The final frame may be smaller than avctx->frame_size.
4860 * @return 0 on success, otherwise negative error code:
4861 * AVERROR(EAGAIN): input is not accepted right now - the frame must be
4862 * resent after trying to read output packets
4863 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4865 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4866 * decoder, or requires flush
4867 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4868 * other errors: legitimate decoding errors
4870 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4873 * Read encoded data from the encoder.
4875 * @param avctx codec context
4876 * @param avpkt This will be set to a reference-counted packet allocated by the
4877 * encoder. Note that the function will always call
4878 * av_frame_unref(frame) before doing anything else.
4879 * @return 0 on success, otherwise negative error code:
4880 * AVERROR(EAGAIN): output is not available right now - user must try
4882 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4883 * no more output packets
4884 * AVERROR(EINVAL): codec not opened, or it is an encoder
4885 * other errors: legitimate decoding errors
4887 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4891 * @defgroup lavc_parsing Frame parsing
4895 enum AVPictureStructure {
4896 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4897 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4898 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4899 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4902 typedef struct AVCodecParserContext {
4904 struct AVCodecParser *parser;
4905 int64_t frame_offset; /* offset of the current frame */
4906 int64_t cur_offset; /* current offset
4907 (incremented by each av_parser_parse()) */
4908 int64_t next_frame_offset; /* offset of the next frame */
4910 int pict_type; /* XXX: Put it back in AVCodecContext. */
4912 * This field is used for proper frame duration computation in lavf.
4913 * It signals, how much longer the frame duration of the current frame
4914 * is compared to normal frame duration.
4916 * frame_duration = (1 + repeat_pict) * time_base
4918 * It is used by codecs like H.264 to display telecined material.
4920 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4921 int64_t pts; /* pts of the current frame */
4922 int64_t dts; /* dts of the current frame */
4927 int fetch_timestamp;
4929 #define AV_PARSER_PTS_NB 4
4930 int cur_frame_start_index;
4931 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4932 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4933 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4936 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4937 #define PARSER_FLAG_ONCE 0x0002
4938 /// Set if the parser has a valid file offset
4939 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4940 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4942 int64_t offset; ///< byte offset from starting packet start
4943 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4946 * Set by parser to 1 for key frames and 0 for non-key frames.
4947 * It is initialized to -1, so if the parser doesn't set this flag,
4948 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4953 #if FF_API_CONVERGENCE_DURATION
4955 * @deprecated unused
4957 attribute_deprecated
4958 int64_t convergence_duration;
4961 // Timestamp generation support:
4963 * Synchronization point for start of timestamp generation.
4965 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4968 * For example, this corresponds to presence of H.264 buffering period
4974 * Offset of the current timestamp against last timestamp sync point in
4975 * units of AVCodecContext.time_base.
4977 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4978 * contain a valid timestamp offset.
4980 * Note that the timestamp of sync point has usually a nonzero
4981 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4982 * the next frame after timestamp sync point will be usually 1.
4984 * For example, this corresponds to H.264 cpb_removal_delay.
4986 int dts_ref_dts_delta;
4989 * Presentation delay of current frame in units of AVCodecContext.time_base.
4991 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4992 * contain valid non-negative timestamp delta (presentation time of a frame
4993 * must not lie in the past).
4995 * This delay represents the difference between decoding and presentation
4996 * time of the frame.
4998 * For example, this corresponds to H.264 dpb_output_delay.
5003 * Position of the packet in file.
5005 * Analogous to cur_frame_pts/dts
5007 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5010 * Byte position of currently parsed frame in stream.
5015 * Previous frame byte position.
5020 * Duration of the current frame.
5021 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5022 * For all other types, this is in units of AVCodecContext.time_base.
5026 enum AVFieldOrder field_order;
5029 * Indicate whether a picture is coded as a frame, top field or bottom field.
5031 * For example, H.264 field_pic_flag equal to 0 corresponds to
5032 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5033 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5034 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5036 enum AVPictureStructure picture_structure;
5039 * Picture number incremented in presentation or output order.
5040 * This field may be reinitialized at the first picture of a new sequence.
5042 * For example, this corresponds to H.264 PicOrderCnt.
5044 int output_picture_number;
5047 * Dimensions of the decoded video intended for presentation.
5053 * Dimensions of the coded video.
5059 * The format of the coded data, corresponds to enum AVPixelFormat for video
5060 * and for enum AVSampleFormat for audio.
5062 * Note that a decoder can have considerable freedom in how exactly it
5063 * decodes the data, so the format reported here might be different from the
5064 * one returned by a decoder.
5067 } AVCodecParserContext;
5069 typedef struct AVCodecParser {
5070 int codec_ids[5]; /* several codec IDs are permitted */
5072 int (*parser_init)(AVCodecParserContext *s);
5073 /* This callback never returns an error, a negative value means that
5074 * the frame start was in a previous packet. */
5075 int (*parser_parse)(AVCodecParserContext *s,
5076 AVCodecContext *avctx,
5077 const uint8_t **poutbuf, int *poutbuf_size,
5078 const uint8_t *buf, int buf_size);
5079 void (*parser_close)(AVCodecParserContext *s);
5080 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5081 struct AVCodecParser *next;
5084 AVCodecParser *av_parser_next(const AVCodecParser *c);
5086 void av_register_codec_parser(AVCodecParser *parser);
5087 AVCodecParserContext *av_parser_init(int codec_id);
5092 * @param s parser context.
5093 * @param avctx codec context.
5094 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5095 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5096 * @param buf input buffer.
5097 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
5098 * @param pts input presentation timestamp.
5099 * @param dts input decoding timestamp.
5100 * @param pos input byte position in stream.
5101 * @return the number of bytes of the input bitstream used.
5106 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5113 * decode_frame(data, size);
5117 int av_parser_parse2(AVCodecParserContext *s,
5118 AVCodecContext *avctx,
5119 uint8_t **poutbuf, int *poutbuf_size,
5120 const uint8_t *buf, int buf_size,
5121 int64_t pts, int64_t dts,
5125 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5126 * @deprecated use AVBitStreamFilter
5128 int av_parser_change(AVCodecParserContext *s,
5129 AVCodecContext *avctx,
5130 uint8_t **poutbuf, int *poutbuf_size,
5131 const uint8_t *buf, int buf_size, int keyframe);
5132 void av_parser_close(AVCodecParserContext *s);
5140 * @addtogroup lavc_encoding
5145 * Find a registered encoder with a matching codec ID.
5147 * @param id AVCodecID of the requested encoder
5148 * @return An encoder if one was found, NULL otherwise.
5150 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5153 * Find a registered encoder with the specified name.
5155 * @param name name of the requested encoder
5156 * @return An encoder if one was found, NULL otherwise.
5158 AVCodec *avcodec_find_encoder_by_name(const char *name);
5161 * Encode a frame of audio.
5163 * Takes input samples from frame and writes the next output packet, if
5164 * available, to avpkt. The output packet does not necessarily contain data for
5165 * the most recent frame, as encoders can delay, split, and combine input frames
5166 * internally as needed.
5168 * @param avctx codec context
5169 * @param avpkt output AVPacket.
5170 * The user can supply an output buffer by setting
5171 * avpkt->data and avpkt->size prior to calling the
5172 * function, but if the size of the user-provided data is not
5173 * large enough, encoding will fail. If avpkt->data and
5174 * avpkt->size are set, avpkt->destruct must also be set. All
5175 * other AVPacket fields will be reset by the encoder using
5176 * av_init_packet(). If avpkt->data is NULL, the encoder will
5177 * allocate it. The encoder will set avpkt->size to the size
5178 * of the output packet.
5180 * If this function fails or produces no output, avpkt will be
5181 * freed using av_packet_unref().
5182 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5183 * May be NULL when flushing an encoder that has the
5184 * AV_CODEC_CAP_DELAY capability set.
5185 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5186 * can have any number of samples.
5187 * If it is not set, frame->nb_samples must be equal to
5188 * avctx->frame_size for all frames except the last.
5189 * The final frame may be smaller than avctx->frame_size.
5190 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5191 * output packet is non-empty, and to 0 if it is
5192 * empty. If the function returns an error, the
5193 * packet can be assumed to be invalid, and the
5194 * value of got_packet_ptr is undefined and should
5196 * @return 0 on success, negative error code on failure
5198 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5199 const AVFrame *frame, int *got_packet_ptr);
5202 * Encode a frame of video.
5204 * Takes input raw video data from frame and writes the next output packet, if
5205 * available, to avpkt. The output packet does not necessarily contain data for
5206 * the most recent frame, as encoders can delay and reorder input frames
5207 * internally as needed.
5209 * @param avctx codec context
5210 * @param avpkt output AVPacket.
5211 * The user can supply an output buffer by setting
5212 * avpkt->data and avpkt->size prior to calling the
5213 * function, but if the size of the user-provided data is not
5214 * large enough, encoding will fail. All other AVPacket fields
5215 * will be reset by the encoder using av_init_packet(). If
5216 * avpkt->data is NULL, the encoder will allocate it.
5217 * The encoder will set avpkt->size to the size of the
5218 * output packet. The returned data (if any) belongs to the
5219 * caller, he is responsible for freeing it.
5221 * If this function fails or produces no output, avpkt will be
5222 * freed using av_packet_unref().
5223 * @param[in] frame AVFrame containing the raw video data to be encoded.
5224 * May be NULL when flushing an encoder that has the
5225 * AV_CODEC_CAP_DELAY capability set.
5226 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5227 * output packet is non-empty, and to 0 if it is
5228 * empty. If the function returns an error, the
5229 * packet can be assumed to be invalid, and the
5230 * value of got_packet_ptr is undefined and should
5232 * @return 0 on success, negative error code on failure
5234 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5235 const AVFrame *frame, int *got_packet_ptr);
5237 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5238 const AVSubtitle *sub);
5245 #if FF_API_AVCODEC_RESAMPLE
5247 * @defgroup lavc_resample Audio resampling
5249 * @deprecated use libswresample instead
5253 struct ReSampleContext;
5254 struct AVResampleContext;
5256 typedef struct ReSampleContext ReSampleContext;
5259 * Initialize audio resampling context.
5261 * @param output_channels number of output channels
5262 * @param input_channels number of input channels
5263 * @param output_rate output sample rate
5264 * @param input_rate input sample rate
5265 * @param sample_fmt_out requested output sample format
5266 * @param sample_fmt_in input sample format
5267 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5268 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5269 * @param linear if 1 then the used FIR filter will be linearly interpolated
5270 between the 2 closest, if 0 the closest will be used
5271 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5272 * @return allocated ReSampleContext, NULL if error occurred
5274 attribute_deprecated
5275 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5276 int output_rate, int input_rate,
5277 enum AVSampleFormat sample_fmt_out,
5278 enum AVSampleFormat sample_fmt_in,
5279 int filter_length, int log2_phase_count,
5280 int linear, double cutoff);
5282 attribute_deprecated
5283 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5286 * Free resample context.
5288 * @param s a non-NULL pointer to a resample context previously
5289 * created with av_audio_resample_init()
5291 attribute_deprecated
5292 void audio_resample_close(ReSampleContext *s);
5296 * Initialize an audio resampler.
5297 * Note, if either rate is not an integer then simply scale both rates up so they are.
5298 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5299 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5300 * @param linear If 1 then the used FIR filter will be linearly interpolated
5301 between the 2 closest, if 0 the closest will be used
5302 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5304 attribute_deprecated
5305 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5308 * Resample an array of samples using a previously configured context.
5309 * @param src an array of unconsumed samples
5310 * @param consumed the number of samples of src which have been consumed are returned here
5311 * @param src_size the number of unconsumed samples available
5312 * @param dst_size the amount of space in samples available in dst
5313 * @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.
5314 * @return the number of samples written in dst or -1 if an error occurred
5316 attribute_deprecated
5317 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5321 * Compensate samplerate/timestamp drift. The compensation is done by changing
5322 * the resampler parameters, so no audible clicks or similar distortions occur
5323 * @param compensation_distance distance in output samples over which the compensation should be performed
5324 * @param sample_delta number of output samples which should be output less
5326 * example: av_resample_compensate(c, 10, 500)
5327 * here instead of 510 samples only 500 samples would be output
5329 * note, due to rounding the actual compensation might be slightly different,
5330 * especially if the compensation_distance is large and the in_rate used during init is small
5332 attribute_deprecated
5333 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5334 attribute_deprecated
5335 void av_resample_close(struct AVResampleContext *c);
5342 #if FF_API_AVPICTURE
5344 * @addtogroup lavc_picture
5349 * @deprecated unused
5351 attribute_deprecated
5352 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5355 * @deprecated unused
5357 attribute_deprecated
5358 void avpicture_free(AVPicture *picture);
5361 * @deprecated use av_image_fill_arrays() instead.
5363 attribute_deprecated
5364 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5365 enum AVPixelFormat pix_fmt, int width, int height);
5368 * @deprecated use av_image_copy_to_buffer() instead.
5370 attribute_deprecated
5371 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5372 int width, int height,
5373 unsigned char *dest, int dest_size);
5376 * @deprecated use av_image_get_buffer_size() instead.
5378 attribute_deprecated
5379 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5382 * @deprecated av_image_copy() instead.
5384 attribute_deprecated
5385 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5386 enum AVPixelFormat pix_fmt, int width, int height);
5389 * @deprecated unused
5391 attribute_deprecated
5392 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5393 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5396 * @deprecated unused
5398 attribute_deprecated
5399 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5400 int padtop, int padbottom, int padleft, int padright, int *color);
5408 * @defgroup lavc_misc Utility functions
5411 * Miscellaneous utility functions related to both encoding and decoding
5417 * @defgroup lavc_misc_pixfmt Pixel formats
5419 * Functions for working with pixel formats.
5424 * Utility function to access log2_chroma_w log2_chroma_h from
5425 * the pixel format AVPixFmtDescriptor.
5427 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5428 * for one that returns a failure code and continues in case of invalid
5431 * @param[in] pix_fmt the pixel format
5432 * @param[out] h_shift store log2_chroma_w
5433 * @param[out] v_shift store log2_chroma_h
5435 * @see av_pix_fmt_get_chroma_sub_sample
5438 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5441 * Return a value representing the fourCC code associated to the
5442 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5445 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5448 * @deprecated see av_get_pix_fmt_loss()
5450 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5454 * Find the best pixel format to convert to given a certain source pixel
5455 * format. When converting from one pixel format to another, information loss
5456 * may occur. For example, when converting from RGB24 to GRAY, the color
5457 * information will be lost. Similarly, other losses occur when converting from
5458 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5459 * the given pixel formats should be used to suffer the least amount of loss.
5460 * The pixel formats from which it chooses one, are determined by the
5461 * pix_fmt_list parameter.
5464 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5465 * @param[in] src_pix_fmt source pixel format
5466 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5467 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5468 * @return The best pixel format to convert to or -1 if none was found.
5470 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5471 enum AVPixelFormat src_pix_fmt,
5472 int has_alpha, int *loss_ptr);
5475 * @deprecated see av_find_best_pix_fmt_of_2()
5477 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5478 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5480 attribute_deprecated
5481 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
5482 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
5483 enum AVPixelFormat src_pix_fmt,
5484 int has_alpha, int *loss_ptr);
5486 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5487 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5491 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5497 #if FF_API_SET_DIMENSIONS
5499 * @deprecated this function is not supposed to be used from outside of lavc
5501 attribute_deprecated
5502 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5506 * Put a string representing the codec tag codec_tag in buf.
5508 * @param buf buffer to place codec tag in
5509 * @param buf_size size in bytes of buf
5510 * @param codec_tag codec tag to assign
5511 * @return the length of the string that would have been generated if
5512 * enough space had been available, excluding the trailing null
5514 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5516 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5519 * Return a name for the specified profile, if available.
5521 * @param codec the codec that is searched for the given profile
5522 * @param profile the profile value for which a name is requested
5523 * @return A name for the profile if found, NULL otherwise.
5525 const char *av_get_profile_name(const AVCodec *codec, int profile);
5528 * Return a name for the specified profile, if available.
5530 * @param codec_id the ID of the codec to which the requested profile belongs
5531 * @param profile the profile value for which a name is requested
5532 * @return A name for the profile if found, NULL otherwise.
5534 * @note unlike av_get_profile_name(), which searches a list of profiles
5535 * supported by a specific decoder or encoder implementation, this
5536 * function searches the list of profiles from the AVCodecDescriptor
5538 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5540 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5541 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5542 //FIXME func typedef
5545 * Fill AVFrame audio data and linesize pointers.
5547 * The buffer buf must be a preallocated buffer with a size big enough
5548 * to contain the specified samples amount. The filled AVFrame data
5549 * pointers will point to this buffer.
5551 * AVFrame extended_data channel pointers are allocated if necessary for
5554 * @param frame the AVFrame
5555 * frame->nb_samples must be set prior to calling the
5556 * function. This function fills in frame->data,
5557 * frame->extended_data, frame->linesize[0].
5558 * @param nb_channels channel count
5559 * @param sample_fmt sample format
5560 * @param buf buffer to use for frame data
5561 * @param buf_size size of buffer
5562 * @param align plane size sample alignment (0 = default)
5563 * @return >=0 on success, negative error code on failure
5564 * @todo return the size in bytes required to store the samples in
5565 * case of success, at the next libavutil bump
5567 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5568 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5569 int buf_size, int align);
5572 * Reset the internal decoder state / flush internal buffers. Should be called
5573 * e.g. when seeking or when switching to a different stream.
5575 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5576 * this invalidates the frames previously returned from the decoder. When
5577 * refcounted frames are used, the decoder just releases any references it might
5578 * keep internally, but the caller's reference remains valid.
5580 void avcodec_flush_buffers(AVCodecContext *avctx);
5583 * Return codec bits per sample.
5585 * @param[in] codec_id the codec
5586 * @return Number of bits per sample or zero if unknown for the given codec.
5588 int av_get_bits_per_sample(enum AVCodecID codec_id);
5591 * Return the PCM codec associated with a sample format.
5592 * @param be endianness, 0 for little, 1 for big,
5593 * -1 (or anything else) for native
5594 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5596 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5599 * Return codec bits per sample.
5600 * Only return non-zero if the bits per sample is exactly correct, not an
5603 * @param[in] codec_id the codec
5604 * @return Number of bits per sample or zero if unknown for the given codec.
5606 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5609 * Return audio frame duration.
5611 * @param avctx codec context
5612 * @param frame_bytes size of the frame, or 0 if unknown
5613 * @return frame duration, in samples, if known. 0 if not able to
5616 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5619 * This function is the same as av_get_audio_frame_duration(), except it works
5620 * with AVCodecParameters instead of an AVCodecContext.
5622 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5625 typedef struct AVBitStreamFilterContext {
5627 struct AVBitStreamFilter *filter;
5628 AVCodecParserContext *parser;
5629 struct AVBitStreamFilterContext *next;
5631 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5632 * Not for access by library users.
5635 } AVBitStreamFilterContext;
5638 typedef struct AVBSFInternal AVBSFInternal;
5641 * The bitstream filter state.
5643 * This struct must be allocated with av_bsf_alloc() and freed with
5646 * The fields in the struct will only be changed (by the caller or by the
5647 * filter) as described in their documentation, and are to be considered
5648 * immutable otherwise.
5650 typedef struct AVBSFContext {
5652 * A class for logging and AVOptions
5654 const AVClass *av_class;
5657 * The bitstream filter this context is an instance of.
5659 const struct AVBitStreamFilter *filter;
5662 * Opaque libavcodec internal data. Must not be touched by the caller in any
5665 AVBSFInternal *internal;
5668 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5669 * this is an AVOptions-enabled struct.
5674 * Parameters of the input stream. Set by the caller before av_bsf_init().
5676 AVCodecParameters *par_in;
5679 * Parameters of the output stream. Set by the filter in av_bsf_init().
5681 AVCodecParameters *par_out;
5684 * The timebase used for the timestamps of the input packets. Set by the
5685 * caller before av_bsf_init().
5687 AVRational time_base_in;
5690 * The timebase used for the timestamps of the output packets. Set by the
5691 * filter in av_bsf_init().
5693 AVRational time_base_out;
5696 typedef struct AVBitStreamFilter {
5700 * A list of codec ids supported by the filter, terminated by
5702 * May be NULL, in that case the bitstream filter works with any codec id.
5704 const enum AVCodecID *codec_ids;
5707 * A class for the private data, used to declare bitstream filter private
5708 * AVOptions. This field is NULL for bitstream filters that do not declare
5711 * If this field is non-NULL, the first member of the filter private data
5712 * must be a pointer to AVClass, which will be set by libavcodec generic
5713 * code to this class.
5715 const AVClass *priv_class;
5717 /*****************************************************************
5718 * No fields below this line are part of the public API. They
5719 * may not be used outside of libavcodec and can be changed and
5721 * New public fields should be added right above.
5722 *****************************************************************
5726 int (*init)(AVBSFContext *ctx);
5727 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5728 void (*close)(AVBSFContext *ctx);
5729 } AVBitStreamFilter;
5733 * Register a bitstream filter.
5735 * The filter will be accessible to the application code through
5736 * av_bitstream_filter_next() or can be directly initialized with
5737 * av_bitstream_filter_init().
5739 * @see avcodec_register_all()
5741 attribute_deprecated
5742 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5745 * Create and initialize a bitstream filter context given a bitstream
5748 * The returned context must be freed with av_bitstream_filter_close().
5750 * @param name the name of the bitstream filter
5751 * @return a bitstream filter context if a matching filter was found
5752 * and successfully initialized, NULL otherwise
5754 attribute_deprecated
5755 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5760 * This function filters the buffer buf with size buf_size, and places the
5761 * filtered buffer in the buffer pointed to by poutbuf.
5763 * The output buffer must be freed by the caller.
5765 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5766 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5767 * If specified, this must point to the encoder context of the
5768 * output stream the packet is sent to.
5769 * @param args arguments which specify the filter configuration, may be NULL
5770 * @param poutbuf pointer which is updated to point to the filtered buffer
5771 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5772 * @param buf buffer containing the data to filter
5773 * @param buf_size size in bytes of buf
5774 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5775 * @return >= 0 in case of success, or a negative error code in case of failure
5777 * If the return value is positive, an output buffer is allocated and
5778 * is available in *poutbuf, and is distinct from the input buffer.
5780 * If the return value is 0, the output buffer is not allocated and
5781 * should be considered identical to the input buffer, or in case
5782 * *poutbuf was set it points to the input buffer (not necessarily to
5783 * its starting address). A special case is if *poutbuf was set to NULL and
5784 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5786 attribute_deprecated
5787 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5788 AVCodecContext *avctx, const char *args,
5789 uint8_t **poutbuf, int *poutbuf_size,
5790 const uint8_t *buf, int buf_size, int keyframe);
5793 * Release bitstream filter context.
5795 * @param bsf the bitstream filter context created with
5796 * av_bitstream_filter_init(), can be NULL
5798 attribute_deprecated
5799 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5802 * If f is NULL, return the first registered bitstream filter,
5803 * if f is non-NULL, return the next registered bitstream filter
5804 * after f, or NULL if f is the last one.
5806 * This function can be used to iterate over all registered bitstream
5809 attribute_deprecated
5810 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5814 * @return a bitstream filter with the specified name or NULL if no such
5815 * bitstream filter exists.
5817 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5820 * Iterate over all registered bitstream filters.
5822 * @param opaque a pointer where libavcodec will store the iteration state. Must
5823 * point to NULL to start the iteration.
5825 * @return the next registered bitstream filter or NULL when the iteration is
5828 const AVBitStreamFilter *av_bsf_next(void **opaque);
5831 * Allocate a context for a given bitstream filter. The caller must fill in the
5832 * context parameters as described in the documentation and then call
5833 * av_bsf_init() before sending any data to the filter.
5835 * @param filter the filter for which to allocate an instance.
5836 * @param ctx a pointer into which the pointer to the newly-allocated context
5837 * will be written. It must be freed with av_bsf_free() after the
5838 * filtering is done.
5840 * @return 0 on success, a negative AVERROR code on failure
5842 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5845 * Prepare the filter for use, after all the parameters and options have been
5848 int av_bsf_init(AVBSFContext *ctx);
5851 * Submit a packet for filtering.
5853 * After sending each packet, the filter must be completely drained by calling
5854 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5857 * @param pkt the packet to filter. The bitstream filter will take ownership of
5858 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5859 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5860 * packets will be sent). That will cause the filter to output any packets it
5861 * may have buffered internally.
5863 * @return 0 on success, a negative AVERROR on error.
5865 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5868 * Retrieve a filtered packet.
5870 * @param[out] pkt this struct will be filled with the contents of the filtered
5871 * packet. It is owned by the caller and must be freed using
5872 * av_packet_unref() when it is no longer needed.
5873 * This parameter should be "clean" (i.e. freshly allocated
5874 * with av_packet_alloc() or unreffed with av_packet_unref())
5875 * when this function is called. If this function returns
5876 * successfully, the contents of pkt will be completely
5877 * overwritten by the returned data. On failure, pkt is not
5880 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5881 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5882 * will be no further output from the filter. Another negative AVERROR value if
5885 * @note one input packet may result in several output packets, so after sending
5886 * a packet with av_bsf_send_packet(), this function needs to be called
5887 * repeatedly until it stops returning 0. It is also possible for a filter to
5888 * output fewer packets than were sent to it, so this function may return
5889 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5891 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5894 * Free a bitstream filter context and everything associated with it; write NULL
5895 * into the supplied pointer.
5897 void av_bsf_free(AVBSFContext **ctx);
5900 * Get the AVClass for AVBSFContext. It can be used in combination with
5901 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5903 * @see av_opt_find().
5905 const AVClass *av_bsf_get_class(void);
5910 * Same behaviour av_fast_malloc but the buffer has additional
5911 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5913 * In addition the whole buffer will initially and after resizes
5914 * be 0-initialized so that no uninitialized data will ever appear.
5916 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5919 * Same behaviour av_fast_padded_malloc except that buffer will always
5920 * be 0-initialized after call.
5922 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5925 * Encode extradata length to a buffer. Used by xiph codecs.
5927 * @param s buffer to write to; must be at least (v/255+1) bytes long
5928 * @param v size of extradata in bytes
5929 * @return number of bytes written to the buffer.
5931 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5933 #if FF_API_MISSING_SAMPLE
5935 * Log a generic warning message about a missing feature. This function is
5936 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5937 * only, and would normally not be used by applications.
5938 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5939 * a pointer to an AVClass struct
5940 * @param[in] feature string containing the name of the missing feature
5941 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5942 * If want_sample is non-zero, additional verbage will be added to the log
5943 * message which tells the user how to report samples to the development
5945 * @deprecated Use avpriv_report_missing_feature() instead.
5947 attribute_deprecated
5948 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5951 * Log a generic warning message asking for a sample. This function is
5952 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5953 * only, and would normally not be used by applications.
5954 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5955 * a pointer to an AVClass struct
5956 * @param[in] msg string containing an optional message, or NULL if no message
5957 * @deprecated Use avpriv_request_sample() instead.
5959 attribute_deprecated
5960 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5961 #endif /* FF_API_MISSING_SAMPLE */
5964 * Register the hardware accelerator hwaccel.
5966 void av_register_hwaccel(AVHWAccel *hwaccel);
5969 * If hwaccel is NULL, returns the first registered hardware accelerator,
5970 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5971 * after hwaccel, or NULL if hwaccel is the last one.
5973 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5977 * Lock operation used by lockmgr
5980 AV_LOCK_CREATE, ///< Create a mutex
5981 AV_LOCK_OBTAIN, ///< Lock the mutex
5982 AV_LOCK_RELEASE, ///< Unlock the mutex
5983 AV_LOCK_DESTROY, ///< Free mutex resources
5987 * Register a user provided lock manager supporting the operations
5988 * specified by AVLockOp. The "mutex" argument to the function points
5989 * to a (void *) where the lockmgr should store/get a pointer to a user
5990 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5991 * value left by the last call for all other ops. If the lock manager is
5992 * unable to perform the op then it should leave the mutex in the same
5993 * state as when it was called and return a non-zero value. However,
5994 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5995 * have been successfully destroyed. If av_lockmgr_register succeeds
5996 * it will return a non-negative value, if it fails it will return a
5997 * negative value and destroy all mutex and unregister all callbacks.
5998 * av_lockmgr_register is not thread-safe, it must be called from a
5999 * single thread before any calls which make use of locking are used.
6001 * @param cb User defined callback. av_lockmgr_register invokes calls
6002 * to this callback and the previously registered callback.
6003 * The callback will be used to create more than one mutex
6004 * each of which must be backed by its own underlying locking
6005 * mechanism (i.e. do not use a single static object to
6006 * implement your lock manager). If cb is set to NULL the
6007 * lockmgr will be unregistered.
6009 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6012 * Get the type of the given codec.
6014 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6017 * Get the name of a codec.
6018 * @return a static string identifying the codec; never NULL
6020 const char *avcodec_get_name(enum AVCodecID id);
6023 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6024 * with no corresponding avcodec_close()), 0 otherwise.
6026 int avcodec_is_open(AVCodecContext *s);
6029 * @return a non-zero number if codec is an encoder, zero otherwise
6031 int av_codec_is_encoder(const AVCodec *codec);
6034 * @return a non-zero number if codec is a decoder, zero otherwise
6036 int av_codec_is_decoder(const AVCodec *codec);
6039 * @return descriptor for given codec ID or NULL if no descriptor exists.
6041 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6044 * Iterate over all codec descriptors known to libavcodec.
6046 * @param prev previous descriptor. NULL to get the first descriptor.
6048 * @return next descriptor or NULL after the last descriptor
6050 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6053 * @return codec descriptor with the given name or NULL if no such descriptor
6056 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6059 * Allocate a CPB properties structure and initialize its fields to default
6062 * @param size if non-NULL, the size of the allocated struct will be written
6063 * here. This is useful for embedding it in side data.
6065 * @return the newly allocated struct or NULL on failure
6067 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6073 #endif /* AVCODEC_AVCODEC_H */