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 libavcodec
47 * Encoding/Decoding Library
51 * @defgroup lavc_decoding Decoding
55 * @defgroup lavc_encoding Encoding
59 * @defgroup lavc_codec Codecs
61 * @defgroup lavc_codec_native Native Codecs
64 * @defgroup lavc_codec_wrappers External library wrappers
67 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
71 * @defgroup lavc_internal Internal
79 * @defgroup lavc_encdec send/receive encoding and decoding API overview
82 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
83 * avcodec_receive_packet() functions provide an encode/decode API, which
84 * decouples input and output.
86 * The API is very similar for encoding/decoding and audio/video, and works as
88 * - Set up and open the AVCodecContext as usual.
90 * - For decoding, call avcodec_send_packet() to give the decoder raw
91 * compressed data in an AVPacket.
92 * - For encoding, call avcodec_send_frame() to give the decoder an AVFrame
93 * containing uncompressed audio or video.
94 * In both cases, it is recommended that AVPackets and AVFrames are
95 * refcounted, or libavcodec might have to copy the input data. (libavformat
96 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
97 * refcounted AVFrames.)
98 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
99 * functions and process their output:
100 * - For decoding, call avcodec_receive_frame(). On success, it will return
101 * an AVFrame containing uncompressed audio or video data.
102 * - For encoding, call avcodec_receive_packet(). On success, it will return
103 * an AVPacket with a compressed frame.
104 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
105 * AVERROR(EAGAIN) return value means that new input data is required to
106 * return new output. In this case, continue with sending input. For each
107 * input frame/packet, the codec will typically return 1 output frame/packet,
108 * but it can also be 0 or more than 1.
110 * At the beginning of decoding or encoding, the codec might accept multiple
111 * input frames/packets without returning a frame, until its internal buffers
112 * are filled. This situation is handled transparently if you follow the steps
115 * End of stream situations. These require "flushing" (aka draining) the codec,
116 * as the codec might buffer multiple frames or packets internally for
117 * performance or out of necessity (consider B-frames).
118 * This is handled as follows:
119 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
120 * or avcodec_send_frame() (encoding) functions. This will enter draining
122 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
123 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
124 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
125 * - Before decoding can be resumed again, the codec has to be reset with
126 * avcodec_flush_buffers().
128 * Using the API as outlined above is highly recommended. But it is also
129 * possible to call functions outside of this rigid schema. For example, you can
130 * call avcodec_send_packet() repeatedly without calling
131 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
132 * until the codec's internal buffer has been filled up (which is typically of
133 * size 1 per output frame, after initial input), and then reject input with
134 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
135 * read at least some output.
137 * Not all codecs will follow a rigid and predictable dataflow; the only
138 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
139 * one end implies that a receive/send call on the other end will succeed. In
140 * general, no codec will permit unlimited buffering of input or output.
142 * This API replaces the following legacy functions:
143 * - avcodec_decode_video2() and avcodec_decode_audio4():
144 * Use avcodec_send_packet() to feed input to the decoder, then use
145 * avcodec_receive_frame() to receive decoded frames after each packet.
146 * Unlike with the old video decoding API, multiple frames might result from
147 * a packet. For audio, splitting the input packet into frames by partially
148 * decoding packets becomes transparent to the API user. You never need to
149 * feed an AVPacket to the API twice.
150 * Additionally, sending a flush/draining packet is required only once.
151 * - avcodec_encode_video2()/avcodec_encode_audio2():
152 * Use avcodec_send_frame() to feed input to the encoder, then use
153 * avcodec_receive_packet() to receive encoded packets.
154 * Providing user-allocated buffers for avcodec_receive_packet() is not
156 * - The new API does not handle subtitles yet.
158 * Mixing new and old function calls on the same AVCodecContext is not allowed,
159 * and will result in undefined behavior.
161 * Some codecs might require using the new API; using the old API will return
162 * an error when calling it.
167 * @defgroup lavc_core Core functions/structures.
170 * Basic definitions, functions for querying libavcodec capabilities,
171 * allocating core structures, etc.
177 * Identify the syntax and semantics of the bitstream.
178 * The principle is roughly:
179 * Two decoders with the same ID can decode the same streams.
180 * Two encoders with the same ID can encode compatible streams.
181 * There may be slight deviations from the principle due to implementation
184 * If you add a codec ID to this list, add it so that
185 * 1. no value of an existing codec ID changes (that would break ABI),
186 * 2. it is as close as possible to similar codecs
188 * After adding new codec IDs, do not forget to add an entry to the codec
189 * descriptor list and bump libavcodec minor version.
195 AV_CODEC_ID_MPEG1VIDEO,
196 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
198 AV_CODEC_ID_MPEG2VIDEO_XVMC,
199 #endif /* FF_API_XVMC */
210 AV_CODEC_ID_RAWVIDEO,
211 AV_CODEC_ID_MSMPEG4V1,
212 AV_CODEC_ID_MSMPEG4V2,
213 AV_CODEC_ID_MSMPEG4V3,
236 AV_CODEC_ID_INTERPLAY_VIDEO,
243 AV_CODEC_ID_MSVIDEO1,
248 AV_CODEC_ID_TRUEMOTION1,
249 AV_CODEC_ID_VMDVIDEO,
274 AV_CODEC_ID_TRUEMOTION2,
280 AV_CODEC_ID_SMACKVIDEO,
285 AV_CODEC_ID_JPEG2000,
291 AV_CODEC_ID_DSICINVIDEO,
292 AV_CODEC_ID_TIERTEXSEQVIDEO,
300 AV_CODEC_ID_BETHSOFTVID,
312 AV_CODEC_ID_ESCAPE124,
316 AV_CODEC_ID_MOTIONPIXELS,
328 AV_CODEC_ID_FLASHSV2,
329 AV_CODEC_ID_CDGRAPHICS,
332 AV_CODEC_ID_BINKVIDEO,
333 AV_CODEC_ID_IFF_ILBM,
334 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
340 AV_CODEC_ID_A64_MULTI,
341 AV_CODEC_ID_A64_MULTI5,
344 AV_CODEC_ID_LAGARITH,
348 AV_CODEC_ID_WMV3IMAGE,
349 AV_CODEC_ID_VC1IMAGE,
351 AV_CODEC_ID_BMV_VIDEO,
358 AV_CODEC_ID_ZEROCODEC,
367 AV_CODEC_ID_ESCAPE130,
370 AV_CODEC_ID_HNM4_VIDEO,
372 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
374 AV_CODEC_ID_ALIAS_PIX,
375 AV_CODEC_ID_BRENDER_PIX,
376 AV_CODEC_ID_PAF_VIDEO,
389 AV_CODEC_ID_SCREENPRESSO,
392 AV_CODEC_ID_Y41P = 0x8000,
397 AV_CODEC_ID_TARGA_Y216,
409 AV_CODEC_ID_TRUEMOTION2RT,
411 AV_CODEC_ID_MAGICYUV,
412 AV_CODEC_ID_SHEERVIDEO,
415 /* various PCM "codecs" */
416 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
417 AV_CODEC_ID_PCM_S16LE = 0x10000,
418 AV_CODEC_ID_PCM_S16BE,
419 AV_CODEC_ID_PCM_U16LE,
420 AV_CODEC_ID_PCM_U16BE,
423 AV_CODEC_ID_PCM_MULAW,
424 AV_CODEC_ID_PCM_ALAW,
425 AV_CODEC_ID_PCM_S32LE,
426 AV_CODEC_ID_PCM_S32BE,
427 AV_CODEC_ID_PCM_U32LE,
428 AV_CODEC_ID_PCM_U32BE,
429 AV_CODEC_ID_PCM_S24LE,
430 AV_CODEC_ID_PCM_S24BE,
431 AV_CODEC_ID_PCM_U24LE,
432 AV_CODEC_ID_PCM_U24BE,
433 AV_CODEC_ID_PCM_S24DAUD,
434 AV_CODEC_ID_PCM_ZORK,
435 AV_CODEC_ID_PCM_S16LE_PLANAR,
437 AV_CODEC_ID_PCM_F32BE,
438 AV_CODEC_ID_PCM_F32LE,
439 AV_CODEC_ID_PCM_F64BE,
440 AV_CODEC_ID_PCM_F64LE,
441 AV_CODEC_ID_PCM_BLURAY,
444 AV_CODEC_ID_PCM_S8_PLANAR,
445 AV_CODEC_ID_PCM_S24LE_PLANAR,
446 AV_CODEC_ID_PCM_S32LE_PLANAR,
447 AV_CODEC_ID_PCM_S16BE_PLANAR,
448 /* new PCM "codecs" should be added right below this line starting with
449 * an explicit value of for example 0x10800
452 /* various ADPCM codecs */
453 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
454 AV_CODEC_ID_ADPCM_IMA_WAV,
455 AV_CODEC_ID_ADPCM_IMA_DK3,
456 AV_CODEC_ID_ADPCM_IMA_DK4,
457 AV_CODEC_ID_ADPCM_IMA_WS,
458 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
459 AV_CODEC_ID_ADPCM_MS,
460 AV_CODEC_ID_ADPCM_4XM,
461 AV_CODEC_ID_ADPCM_XA,
462 AV_CODEC_ID_ADPCM_ADX,
463 AV_CODEC_ID_ADPCM_EA,
464 AV_CODEC_ID_ADPCM_G726,
465 AV_CODEC_ID_ADPCM_CT,
466 AV_CODEC_ID_ADPCM_SWF,
467 AV_CODEC_ID_ADPCM_YAMAHA,
468 AV_CODEC_ID_ADPCM_SBPRO_4,
469 AV_CODEC_ID_ADPCM_SBPRO_3,
470 AV_CODEC_ID_ADPCM_SBPRO_2,
471 AV_CODEC_ID_ADPCM_THP,
472 AV_CODEC_ID_ADPCM_IMA_AMV,
473 AV_CODEC_ID_ADPCM_EA_R1,
474 AV_CODEC_ID_ADPCM_EA_R3,
475 AV_CODEC_ID_ADPCM_EA_R2,
476 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
477 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
478 AV_CODEC_ID_ADPCM_EA_XAS,
479 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
480 AV_CODEC_ID_ADPCM_IMA_ISS,
481 AV_CODEC_ID_ADPCM_G722,
482 AV_CODEC_ID_ADPCM_IMA_APC,
483 AV_CODEC_ID_ADPCM_VIMA,
484 #if FF_API_VIMA_DECODER
485 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
488 AV_CODEC_ID_ADPCM_AFC = 0x11800,
489 AV_CODEC_ID_ADPCM_IMA_OKI,
490 AV_CODEC_ID_ADPCM_DTK,
491 AV_CODEC_ID_ADPCM_IMA_RAD,
492 AV_CODEC_ID_ADPCM_G726LE,
493 AV_CODEC_ID_ADPCM_THP_LE,
494 AV_CODEC_ID_ADPCM_PSX,
495 AV_CODEC_ID_ADPCM_AICA,
496 AV_CODEC_ID_ADPCM_IMA_DAT4,
497 AV_CODEC_ID_ADPCM_MTAF,
500 AV_CODEC_ID_AMR_NB = 0x12000,
503 /* RealAudio codecs*/
504 AV_CODEC_ID_RA_144 = 0x13000,
507 /* various DPCM codecs */
508 AV_CODEC_ID_ROQ_DPCM = 0x14000,
509 AV_CODEC_ID_INTERPLAY_DPCM,
510 AV_CODEC_ID_XAN_DPCM,
511 AV_CODEC_ID_SOL_DPCM,
513 AV_CODEC_ID_SDX2_DPCM = 0x14800,
516 AV_CODEC_ID_MP2 = 0x15000,
517 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
527 AV_CODEC_ID_VMDAUDIO,
533 AV_CODEC_ID_WESTWOOD_SND1,
534 AV_CODEC_ID_GSM, ///< as in Berlin toast format
537 AV_CODEC_ID_TRUESPEECH,
539 AV_CODEC_ID_SMACKAUDIO,
542 AV_CODEC_ID_DSICINAUDIO,
544 AV_CODEC_ID_MUSEPACK7,
546 AV_CODEC_ID_GSM_MS, /* as found in WAV */
552 AV_CODEC_ID_NELLYMOSER,
553 AV_CODEC_ID_MUSEPACK8,
555 AV_CODEC_ID_WMAVOICE,
557 AV_CODEC_ID_WMALOSSLESS,
566 AV_CODEC_ID_BINKAUDIO_RDFT,
567 AV_CODEC_ID_BINKAUDIO_DCT,
568 AV_CODEC_ID_AAC_LATM,
573 AV_CODEC_ID_8SVX_EXP,
574 AV_CODEC_ID_8SVX_FIB,
575 AV_CODEC_ID_BMV_AUDIO,
580 AV_CODEC_ID_COMFORT_NOISE,
582 AV_CODEC_ID_METASOUND,
583 AV_CODEC_ID_PAF_AUDIO,
587 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
589 AV_CODEC_ID_SONIC_LS,
592 AV_CODEC_ID_DSD_LSBF,
593 AV_CODEC_ID_DSD_MSBF,
594 AV_CODEC_ID_DSD_LSBF_PLANAR,
595 AV_CODEC_ID_DSD_MSBF_PLANAR,
597 AV_CODEC_ID_INTERPLAY_ACM,
602 /* subtitle codecs */
603 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
604 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
605 AV_CODEC_ID_DVB_SUBTITLE,
606 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
609 AV_CODEC_ID_MOV_TEXT,
610 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
611 AV_CODEC_ID_DVB_TELETEXT,
614 AV_CODEC_ID_MICRODVD = 0x17800,
618 AV_CODEC_ID_REALTEXT,
620 AV_CODEC_ID_SUBVIEWER1,
621 AV_CODEC_ID_SUBVIEWER,
628 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
630 /* other specific kind of codecs (generally used for attachments) */
631 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
632 AV_CODEC_ID_TTF = 0x18000,
634 AV_CODEC_ID_BINTEXT = 0x18800,
638 AV_CODEC_ID_SMPTE_KLV,
640 AV_CODEC_ID_TIMED_ID3,
641 AV_CODEC_ID_BIN_DATA,
644 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
646 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
647 * stream (only used by libavformat) */
648 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
649 * stream (only used by libavformat) */
650 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
651 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
655 * This struct describes the properties of a single codec described by an
657 * @see avcodec_descriptor_get()
659 typedef struct AVCodecDescriptor {
661 enum AVMediaType type;
663 * Name of the codec described by this descriptor. It is non-empty and
664 * unique for each codec descriptor. It should contain alphanumeric
665 * characters and '_' only.
669 * A more descriptive name for this codec. May be NULL.
671 const char *long_name;
673 * Codec properties, a combination of AV_CODEC_PROP_* flags.
677 * MIME type(s) associated with the codec.
678 * May be NULL; if not, a NULL-terminated array of MIME types.
679 * The first item is always non-NULL and is the preferred MIME type.
681 const char *const *mime_types;
683 * If non-NULL, an array of profiles recognized for this codec.
684 * Terminated with FF_PROFILE_UNKNOWN.
686 const struct AVProfile *profiles;
690 * Codec uses only intra compression.
693 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
695 * Codec supports lossy compression. Audio and video codecs only.
696 * @note a codec may support both lossy and lossless
699 #define AV_CODEC_PROP_LOSSY (1 << 1)
701 * Codec supports lossless compression. Audio and video codecs only.
703 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
705 * Codec supports frame reordering. That is, the coded order (the order in which
706 * the encoded packets are output by the encoders / stored / input to the
707 * decoders) may be different from the presentation order of the corresponding
710 * For codecs that do not have this property set, PTS and DTS should always be
713 #define AV_CODEC_PROP_REORDER (1 << 3)
715 * Subtitle codec is bitmap based
716 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
718 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
720 * Subtitle codec is text based.
721 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
723 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
726 * @ingroup lavc_decoding
727 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
728 * This is mainly needed because some optimized bitstream readers read
729 * 32 or 64 bit at once and could read over the end.<br>
730 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
731 * MPEG bitstreams could cause overread and segfault.
733 #define AV_INPUT_BUFFER_PADDING_SIZE 32
736 * @ingroup lavc_encoding
737 * minimum encoding buffer size
738 * Used to avoid some checks during header writing.
740 #define AV_INPUT_BUFFER_MIN_SIZE 16384
742 #if FF_API_WITHOUT_PREFIX
744 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
746 #define FF_INPUT_BUFFER_PADDING_SIZE 32
749 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
751 #define FF_MIN_BUFFER_SIZE 16384
752 #endif /* FF_API_WITHOUT_PREFIX */
755 * @ingroup lavc_encoding
756 * motion estimation type.
757 * @deprecated use codec private option instead
759 #if FF_API_MOTION_EST
761 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
765 ME_EPZS, ///< enhanced predictive zonal search
766 ME_X1, ///< reserved for experiments
767 ME_HEX, ///< hexagon based search
768 ME_UMH, ///< uneven multi-hexagon search
769 ME_TESA, ///< transformed exhaustive search algorithm
770 ME_ITER=50, ///< iterative search
775 * @ingroup lavc_decoding
778 /* We leave some space between them for extensions (drop some
779 * keyframes for intra-only or drop just some bidir frames). */
780 AVDISCARD_NONE =-16, ///< discard nothing
781 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
782 AVDISCARD_NONREF = 8, ///< discard all non reference
783 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
784 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
785 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
786 AVDISCARD_ALL = 48, ///< discard all
789 enum AVAudioServiceType {
790 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
791 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
792 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
793 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
794 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
795 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
796 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
797 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
798 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
799 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
803 * @ingroup lavc_encoding
805 typedef struct RcOverride{
808 int qscale; // If this is 0 then quality_factor will be used instead.
809 float quality_factor;
812 #if FF_API_MAX_BFRAMES
814 * @deprecated there is no libavcodec-wide limit on the number of B-frames
816 #define FF_MAX_B_FRAMES 16
820 These flags can be passed in AVCodecContext.flags before initialization.
821 Note: Not everything is supported yet.
825 * Allow decoders to produce frames with data planes that are not aligned
826 * to CPU requirements (e.g. due to cropping).
828 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
832 #define AV_CODEC_FLAG_QSCALE (1 << 1)
834 * 4 MV per MB allowed / advanced prediction for H.263.
836 #define AV_CODEC_FLAG_4MV (1 << 2)
838 * Output even those frames that might be corrupted.
840 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
844 #define AV_CODEC_FLAG_QPEL (1 << 4)
846 * Use internal 2pass ratecontrol in first pass mode.
848 #define AV_CODEC_FLAG_PASS1 (1 << 9)
850 * Use internal 2pass ratecontrol in second pass mode.
852 #define AV_CODEC_FLAG_PASS2 (1 << 10)
856 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
858 * Only decode/encode grayscale.
860 #define AV_CODEC_FLAG_GRAY (1 << 13)
862 * error[?] variables will be set during encoding.
864 #define AV_CODEC_FLAG_PSNR (1 << 15)
866 * Input bitstream might be truncated at a random location
867 * instead of only at frame boundaries.
869 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
871 * Use interlaced DCT.
873 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
877 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
879 * Place global headers in extradata instead of every keyframe.
881 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
883 * Use only bitexact stuff (except (I)DCT).
885 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
886 /* Fx : Flag for H.263+ extra options */
888 * H.263 advanced intra coding / MPEG-4 AC prediction
890 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
892 * interlaced motion estimation
894 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
895 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
898 * Allow non spec compliant speedup tricks.
900 #define AV_CODEC_FLAG2_FAST (1 << 0)
902 * Skip bitstream encoding.
904 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
906 * Place global headers at every keyframe instead of in extradata.
908 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
911 * timecode is in drop frame format. DEPRECATED!!!!
913 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
916 * Input bitstream might be truncated at a packet boundaries
917 * instead of only at frame boundaries.
919 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
921 * Discard cropping information from SPS.
923 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
926 * Show all frames before the first keyframe
928 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
930 * Export motion vectors through frame side data
932 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
934 * Do not skip samples and export skip information as frame side data
936 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
938 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
940 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
942 /* Unsupported options :
943 * Syntax Arithmetic coding (SAC)
944 * Reference Picture Selection
945 * Independent Segment Decoding */
947 /* codec capabilities */
950 * Decoder can use draw_horiz_band callback.
952 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
954 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
955 * If not set, it might not use get_buffer() at all or use operations that
956 * assume the buffer was allocated by avcodec_default_get_buffer.
958 #define AV_CODEC_CAP_DR1 (1 << 1)
959 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
961 * Encoder or decoder requires flushing with NULL input at the end in order to
962 * give the complete and correct output.
964 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
965 * with NULL data. The user can still send NULL data to the public encode
966 * or decode function, but libavcodec will not pass it along to the codec
967 * unless this flag is set.
970 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
971 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
975 * The encoder needs to be fed with NULL data at the end of encoding until the
976 * encoder no longer returns data.
978 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
979 * flag also means that the encoder must set the pts and duration for
980 * each output packet. If this flag is not set, the pts and duration will
981 * be determined by libavcodec from the input frame.
983 #define AV_CODEC_CAP_DELAY (1 << 5)
985 * Codec can be fed a final frame with a smaller size.
986 * This can be used to prevent truncation of the last audio samples.
988 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
992 * Codec can export data for HW decoding (VDPAU).
994 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
998 * Codec can output multiple frames per AVPacket
999 * Normally demuxers return one frame at a time, demuxers which do not do
1000 * are connected to a parser to split what they return into proper frames.
1001 * This flag is reserved to the very rare category of codecs which have a
1002 * bitstream that cannot be split into frames without timeconsuming
1003 * operations like full decoding. Demuxers carrying such bitstreams thus
1004 * may return multiple frames in a packet. This has many disadvantages like
1005 * prohibiting stream copy in many cases thus it should only be considered
1008 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1010 * Codec is experimental and is thus avoided in favor of non experimental
1013 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1015 * Codec should fill in channel configuration and samplerate instead of container
1017 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1019 * Codec supports frame-level multithreading.
1021 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1023 * Codec supports slice-based (or partition-based) multithreading.
1025 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1027 * Codec supports changed parameters at any point.
1029 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1031 * Codec supports avctx->thread_count == 0 (auto).
1033 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1035 * Audio encoder supports receiving a different number of samples in each call.
1037 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1039 * Codec is intra only.
1041 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1043 * Codec is lossless.
1045 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1048 #if FF_API_WITHOUT_PREFIX
1050 * Allow decoders to produce frames with data planes that are not aligned
1051 * to CPU requirements (e.g. due to cropping).
1053 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1054 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1055 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1056 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1057 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1060 * @deprecated use the "gmc" private option of the libxvid encoder
1062 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1066 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1067 * mpegvideo encoders
1069 #define CODEC_FLAG_MV0 0x0040
1071 #if FF_API_INPUT_PRESERVED
1073 * @deprecated passing reference-counted frames to the encoders replaces this
1076 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1078 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1079 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1080 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1083 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1086 #define CODEC_FLAG_EMU_EDGE 0x4000
1088 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1089 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1091 #if FF_API_NORMALIZE_AQP
1093 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1094 * mpegvideo encoders
1096 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1098 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1099 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1100 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1101 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1102 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1103 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1104 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1105 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1106 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1107 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1108 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1109 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1110 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1112 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1113 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1114 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1115 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1117 /* Unsupported options :
1118 * Syntax Arithmetic coding (SAC)
1119 * Reference Picture Selection
1120 * Independent Segment Decoding */
1122 /* codec capabilities */
1124 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1126 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1127 * If not set, it might not use get_buffer() at all or use operations that
1128 * assume the buffer was allocated by avcodec_default_get_buffer.
1130 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1131 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1133 /* Codec can export data for HW decoding. This flag indicates that
1134 * the codec would call get_format() with list that might contain HW accelerated
1135 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1136 * including raw image format.
1137 * The application can use the passed context to determine bitstream version,
1138 * chroma format, resolution etc.
1140 #define CODEC_CAP_HWACCEL 0x0010
1141 #endif /* FF_API_XVMC */
1143 * Encoder or decoder requires flushing with NULL input at the end in order to
1144 * give the complete and correct output.
1146 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1147 * with NULL data. The user can still send NULL data to the public encode
1148 * or decode function, but libavcodec will not pass it along to the codec
1149 * unless this flag is set.
1152 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1153 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1157 * The encoder needs to be fed with NULL data at the end of encoding until the
1158 * encoder no longer returns data.
1160 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1161 * flag also means that the encoder must set the pts and duration for
1162 * each output packet. If this flag is not set, the pts and duration will
1163 * be determined by libavcodec from the input frame.
1165 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1167 * Codec can be fed a final frame with a smaller size.
1168 * This can be used to prevent truncation of the last audio samples.
1170 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1171 #if FF_API_CAP_VDPAU
1173 * Codec can export data for HW decoding (VDPAU).
1175 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1178 * Codec can output multiple frames per AVPacket
1179 * Normally demuxers return one frame at a time, demuxers which do not do
1180 * are connected to a parser to split what they return into proper frames.
1181 * This flag is reserved to the very rare category of codecs which have a
1182 * bitstream that cannot be split into frames without timeconsuming
1183 * operations like full decoding. Demuxers carrying such bitstreams thus
1184 * may return multiple frames in a packet. This has many disadvantages like
1185 * prohibiting stream copy in many cases thus it should only be considered
1188 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1190 * Codec is experimental and is thus avoided in favor of non experimental
1193 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1195 * Codec should fill in channel configuration and samplerate instead of container
1197 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1198 #if FF_API_NEG_LINESIZES
1200 * @deprecated no codecs use this capability
1202 #define CODEC_CAP_NEG_LINESIZES 0x0800
1205 * Codec supports frame-level multithreading.
1207 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1209 * Codec supports slice-based (or partition-based) multithreading.
1211 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1213 * Codec supports changed parameters at any point.
1215 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1217 * Codec supports avctx->thread_count == 0 (auto).
1219 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1221 * Audio encoder supports receiving a different number of samples in each call.
1223 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1225 * Codec is intra only.
1227 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1229 * Codec is lossless.
1231 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1234 * HWAccel is experimental and is thus avoided in favor of non experimental
1237 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1238 #endif /* FF_API_WITHOUT_PREFIX */
1241 //The following defines may change, don't expect compatibility if you use them.
1242 #define MB_TYPE_INTRA4x4 0x0001
1243 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1244 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1245 #define MB_TYPE_16x16 0x0008
1246 #define MB_TYPE_16x8 0x0010
1247 #define MB_TYPE_8x16 0x0020
1248 #define MB_TYPE_8x8 0x0040
1249 #define MB_TYPE_INTERLACED 0x0080
1250 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1251 #define MB_TYPE_ACPRED 0x0200
1252 #define MB_TYPE_GMC 0x0400
1253 #define MB_TYPE_SKIP 0x0800
1254 #define MB_TYPE_P0L0 0x1000
1255 #define MB_TYPE_P1L0 0x2000
1256 #define MB_TYPE_P0L1 0x4000
1257 #define MB_TYPE_P1L1 0x8000
1258 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1259 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1260 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1261 #define MB_TYPE_QUANT 0x00010000
1262 #define MB_TYPE_CBP 0x00020000
1263 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1268 * This specifies the area which should be displayed.
1269 * Note there may be multiple such areas for one frame.
1271 typedef struct AVPanScan{
1274 * - encoding: Set by user.
1275 * - decoding: Set by libavcodec.
1280 * width and height in 1/16 pel
1281 * - encoding: Set by user.
1282 * - decoding: Set by libavcodec.
1288 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1289 * - encoding: Set by user.
1290 * - decoding: Set by libavcodec.
1292 int16_t position[3][2];
1296 * This structure describes the bitrate properties of an encoded bitstream. It
1297 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1298 * parameters for H.264/HEVC.
1300 typedef struct AVCPBProperties {
1302 * Maximum bitrate of the stream, in bits per second.
1303 * Zero if unknown or unspecified.
1307 * Minimum bitrate of the stream, in bits per second.
1308 * Zero if unknown or unspecified.
1312 * Average bitrate of the stream, in bits per second.
1313 * Zero if unknown or unspecified.
1318 * The size of the buffer to which the ratecontrol is applied, in bits.
1319 * Zero if unknown or unspecified.
1324 * The delay between the time the packet this structure is associated with
1325 * is received and the time when it should be decoded, in periods of a 27MHz
1328 * UINT64_MAX when unknown or unspecified.
1333 #if FF_API_QSCALE_TYPE
1334 #define FF_QSCALE_TYPE_MPEG1 0
1335 #define FF_QSCALE_TYPE_MPEG2 1
1336 #define FF_QSCALE_TYPE_H264 2
1337 #define FF_QSCALE_TYPE_VP56 3
1341 * The decoder will keep a reference to the frame and may reuse it later.
1343 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1346 * @defgroup lavc_packet AVPacket
1348 * Types and functions for working with AVPacket.
1351 enum AVPacketSideDataType {
1352 AV_PKT_DATA_PALETTE,
1355 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1356 * that the extradata buffer was changed and the receiving side should
1357 * act upon it appropriately. The new extradata is embedded in the side
1358 * data buffer and should be immediately used for processing the current
1361 AV_PKT_DATA_NEW_EXTRADATA,
1364 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1367 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1368 * s32le channel_count
1369 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1370 * u64le channel_layout
1371 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1373 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1378 AV_PKT_DATA_PARAM_CHANGE,
1381 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1382 * structures with info about macroblocks relevant to splitting the
1383 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1384 * That is, it does not necessarily contain info about all macroblocks,
1385 * as long as the distance between macroblocks in the info is smaller
1386 * than the target payload size.
1387 * Each MB info structure is 12 bytes, and is laid out as follows:
1389 * u32le bit offset from the start of the packet
1390 * u8 current quantizer at the start of the macroblock
1392 * u16le macroblock address within the GOB
1393 * u8 horizontal MV predictor
1394 * u8 vertical MV predictor
1395 * u8 horizontal MV predictor for block number 3
1396 * u8 vertical MV predictor for block number 3
1399 AV_PKT_DATA_H263_MB_INFO,
1402 * This side data should be associated with an audio stream and contains
1403 * ReplayGain information in form of the AVReplayGain struct.
1405 AV_PKT_DATA_REPLAYGAIN,
1408 * This side data contains a 3x3 transformation matrix describing an affine
1409 * transformation that needs to be applied to the decoded video frames for
1410 * correct presentation.
1412 * See libavutil/display.h for a detailed description of the data.
1414 AV_PKT_DATA_DISPLAYMATRIX,
1417 * This side data should be associated with a video stream and contains
1418 * Stereoscopic 3D information in form of the AVStereo3D struct.
1420 AV_PKT_DATA_STEREO3D,
1423 * This side data should be associated with an audio stream and corresponds
1424 * to enum AVAudioServiceType.
1426 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1429 * This side data contains quality related information from the encoder.
1431 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1435 * u64le[error count] sum of squared differences between encoder in and output
1438 AV_PKT_DATA_QUALITY_STATS,
1441 * This side data contains an integer value representing the stream index
1442 * of a "fallback" track. A fallback track indicates an alternate
1443 * track to use when the current track can not be decoded for some reason.
1444 * e.g. no decoder available for codec.
1446 AV_PKT_DATA_FALLBACK_TRACK,
1449 * This side data corresponds to the AVCPBProperties struct.
1451 AV_PKT_DATA_CPB_PROPERTIES,
1454 * Recommmends skipping the specified number of samples
1456 * u32le number of samples to skip from start of this packet
1457 * u32le number of samples to skip from end of this packet
1458 * u8 reason for start skip
1459 * u8 reason for end skip (0=padding silence, 1=convergence)
1462 AV_PKT_DATA_SKIP_SAMPLES=70,
1465 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1466 * the packet may contain "dual mono" audio specific to Japanese DTV
1467 * and if it is true, recommends only the selected channel to be used.
1469 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1472 AV_PKT_DATA_JP_DUALMONO,
1475 * A list of zero terminated key/value strings. There is no end marker for
1476 * the list, so it is required to rely on the side data size to stop.
1478 AV_PKT_DATA_STRINGS_METADATA,
1481 * Subtitle event position
1489 AV_PKT_DATA_SUBTITLE_POSITION,
1492 * Data found in BlockAdditional element of matroska container. There is
1493 * no end marker for the data, so it is required to rely on the side data
1494 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1497 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1500 * The optional first identifier line of a WebVTT cue.
1502 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1505 * The optional settings (rendering instructions) that immediately
1506 * follow the timestamp specifier of a WebVTT cue.
1508 AV_PKT_DATA_WEBVTT_SETTINGS,
1511 * A list of zero terminated key/value strings. There is no end marker for
1512 * the list, so it is required to rely on the side data size to stop. This
1513 * side data includes updated metadata which appeared in the stream.
1515 AV_PKT_DATA_METADATA_UPDATE,
1518 * MPEGTS stream ID, this is required to pass the stream ID
1519 * information from the demuxer to the corresponding muxer.
1521 AV_PKT_DATA_MPEGTS_STREAM_ID,
1524 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1525 * should be associated with a video stream and containts data in the form
1526 * of the AVMasteringDisplayMetadata struct.
1528 AV_PKT_DATA_MASTERING_DISPLAY_METADATA
1531 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1533 typedef struct AVPacketSideData {
1536 enum AVPacketSideDataType type;
1540 * This structure stores compressed data. It is typically exported by demuxers
1541 * and then passed as input to decoders, or received as output from encoders and
1542 * then passed to muxers.
1544 * For video, it should typically contain one compressed frame. For audio it may
1545 * contain several compressed frames. Encoders are allowed to output empty
1546 * packets, with no compressed data, containing only side data
1547 * (e.g. to update some stream parameters at the end of encoding).
1549 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1550 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1551 * without libavcodec and libavformat major bump.
1553 * The semantics of data ownership depends on the buf field.
1554 * If it is set, the packet data is dynamically allocated and is
1555 * valid indefinitely until a call to av_packet_unref() reduces the
1556 * reference count to 0.
1558 * If the buf field is not set av_packet_ref() would make a copy instead
1559 * of increasing the reference count.
1561 * The side data is always allocated with av_malloc(), copied by
1562 * av_packet_ref() and freed by av_packet_unref().
1564 * @see av_packet_ref
1565 * @see av_packet_unref
1567 typedef struct AVPacket {
1569 * A reference to the reference-counted buffer where the packet data is
1571 * May be NULL, then the packet data is not reference-counted.
1575 * Presentation timestamp in AVStream->time_base units; the time at which
1576 * the decompressed packet will be presented to the user.
1577 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1578 * pts MUST be larger or equal to dts as presentation cannot happen before
1579 * decompression, unless one wants to view hex dumps. Some formats misuse
1580 * the terms dts and pts/cts to mean something different. Such timestamps
1581 * must be converted to true pts/dts before they are stored in AVPacket.
1585 * Decompression timestamp in AVStream->time_base units; the time at which
1586 * the packet is decompressed.
1587 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1594 * A combination of AV_PKT_FLAG values
1598 * Additional packet data that can be provided by the container.
1599 * Packet can contain several types of side information.
1601 AVPacketSideData *side_data;
1602 int side_data_elems;
1605 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1606 * Equals next_pts - this_pts in presentation order.
1610 int64_t pos; ///< byte position in stream, -1 if unknown
1612 #if FF_API_CONVERGENCE_DURATION
1614 * @deprecated Same as the duration field, but as int64_t. This was required
1615 * for Matroska subtitles, whose duration values could overflow when the
1616 * duration field was still an int.
1618 attribute_deprecated
1619 int64_t convergence_duration;
1622 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1623 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1625 enum AVSideDataParamChangeFlags {
1626 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1627 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1628 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1629 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1635 struct AVCodecInternal;
1639 AV_FIELD_PROGRESSIVE,
1640 AV_FIELD_TT, //< Top coded_first, top displayed first
1641 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1642 AV_FIELD_TB, //< Top coded first, bottom displayed first
1643 AV_FIELD_BT, //< Bottom coded first, top displayed first
1647 * main external API structure.
1648 * New fields can be added to the end with minor version bumps.
1649 * Removal, reordering and changes to existing fields require a major
1651 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1653 * The name string for AVOptions options matches the associated command line
1654 * parameter name and can be found in libavcodec/options_table.h
1655 * The AVOption/command line parameter names differ in some cases from the C
1656 * structure field names for historic reasons or brevity.
1657 * sizeof(AVCodecContext) must not be used outside libav*.
1659 typedef struct AVCodecContext {
1661 * information on struct for av_log
1662 * - set by avcodec_alloc_context3
1664 const AVClass *av_class;
1665 int log_level_offset;
1667 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1668 const struct AVCodec *codec;
1669 #if FF_API_CODEC_NAME
1671 * @deprecated this field is not used for anything in libavcodec
1673 attribute_deprecated
1674 char codec_name[32];
1676 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1679 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1680 * This is used to work around some encoder bugs.
1681 * A demuxer should set this to what is stored in the field used to identify the codec.
1682 * If there are multiple such fields in a container then the demuxer should choose the one
1683 * which maximizes the information about the used codec.
1684 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1685 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1686 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1688 * - encoding: Set by user, if not then the default based on codec_id will be used.
1689 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1691 unsigned int codec_tag;
1693 #if FF_API_STREAM_CODEC_TAG
1695 * @deprecated this field is unused
1697 attribute_deprecated
1698 unsigned int stream_codec_tag;
1704 * Private context used for internal data.
1706 * Unlike priv_data, this is not codec-specific. It is used in general
1707 * libavcodec functions.
1709 struct AVCodecInternal *internal;
1712 * Private data of the user, can be used to carry app specific stuff.
1713 * - encoding: Set by user.
1714 * - decoding: Set by user.
1719 * the average bitrate
1720 * - encoding: Set by user; unused for constant quantizer encoding.
1721 * - decoding: Set by user, may be overwritten by libavcodec
1722 * if this info is available in the stream
1727 * number of bits the bitstream is allowed to diverge from the reference.
1728 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1729 * - encoding: Set by user; unused for constant quantizer encoding.
1730 * - decoding: unused
1732 int bit_rate_tolerance;
1735 * Global quality for codecs which cannot change it per frame.
1736 * This should be proportional to MPEG-1/2/4 qscale.
1737 * - encoding: Set by user.
1738 * - decoding: unused
1743 * - encoding: Set by user.
1744 * - decoding: unused
1746 int compression_level;
1747 #define FF_COMPRESSION_DEFAULT -1
1751 * - encoding: Set by user.
1752 * - decoding: Set by user.
1758 * - encoding: Set by user.
1759 * - decoding: Set by user.
1764 * some codecs need / can use extradata like Huffman tables.
1765 * MJPEG: Huffman tables
1766 * rv10: additional flags
1767 * MPEG-4: global headers (they can be in the bitstream or here)
1768 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1769 * than extradata_size to avoid problems if it is read with the bitstream reader.
1770 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1771 * - encoding: Set/allocated/freed by libavcodec.
1772 * - decoding: Set/allocated/freed by user.
1778 * This is the fundamental unit of time (in seconds) in terms
1779 * of which frame timestamps are represented. For fixed-fps content,
1780 * timebase should be 1/framerate and timestamp increments should be
1782 * This often, but not always is the inverse of the frame rate or field rate
1783 * for video. 1/time_base is not the average frame rate if the frame rate is not
1786 * Like containers, elementary streams also can store timestamps, 1/time_base
1787 * is the unit in which these timestamps are specified.
1788 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1789 * vop_time_increment_resolution and fixed_vop_rate
1790 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1792 * - encoding: MUST be set by user.
1793 * - decoding: the use of this field for decoding is deprecated.
1794 * Use framerate instead.
1796 AVRational time_base;
1799 * For some codecs, the time base is closer to the field rate than the frame rate.
1800 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1801 * if no telecine is used ...
1803 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1805 int ticks_per_frame;
1810 * Encoding: Number of frames delay there will be from the encoder input to
1811 * the decoder output. (we assume the decoder matches the spec)
1812 * Decoding: Number of frames delay in addition to what a standard decoder
1813 * as specified in the spec would produce.
1816 * Number of frames the decoded output will be delayed relative to the
1820 * For encoding, this field is unused (see initial_padding).
1822 * For decoding, this is the number of samples the decoder needs to
1823 * output before the decoder's output is valid. When seeking, you should
1824 * start decoding this many samples prior to your desired seek point.
1826 * - encoding: Set by libavcodec.
1827 * - decoding: Set by libavcodec.
1834 * picture width / height.
1836 * @note Those fields may not match the values of the last
1837 * AVFrame output by avcodec_decode_video2 due frame
1840 * - encoding: MUST be set by user.
1841 * - decoding: May be set by the user before opening the decoder if known e.g.
1842 * from the container. Some decoders will require the dimensions
1843 * to be set by the caller. During decoding, the decoder may
1844 * overwrite those values as required while parsing the data.
1849 * Bitstream width / height, may be different from width/height e.g. when
1850 * the decoded frame is cropped before being output or lowres is enabled.
1852 * @note Those field may not match the value of the last
1853 * AVFrame output by avcodec_receive_frame() due frame
1856 * - encoding: unused
1857 * - decoding: May be set by the user before opening the decoder if known
1858 * e.g. from the container. During decoding, the decoder may
1859 * overwrite those values as required while parsing the data.
1861 int coded_width, coded_height;
1863 #if FF_API_ASPECT_EXTENDED
1864 #define FF_ASPECT_EXTENDED 15
1868 * the number of pictures in a group of pictures, or 0 for intra_only
1869 * - encoding: Set by user.
1870 * - decoding: unused
1875 * Pixel format, see AV_PIX_FMT_xxx.
1876 * May be set by the demuxer if known from headers.
1877 * May be overridden by the decoder if it knows better.
1879 * @note This field may not match the value of the last
1880 * AVFrame output by avcodec_receive_frame() due frame
1883 * - encoding: Set by user.
1884 * - decoding: Set by user if known, overridden by libavcodec while
1887 enum AVPixelFormat pix_fmt;
1889 #if FF_API_MOTION_EST
1891 * This option does nothing
1892 * @deprecated use codec private options instead
1894 attribute_deprecated int me_method;
1898 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1899 * decoder to draw a horizontal band. It improves cache usage. Not
1900 * all codecs can do that. You must check the codec capabilities
1902 * When multithreading is used, it may be called from multiple threads
1903 * at the same time; threads might draw different parts of the same AVFrame,
1904 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1906 * The function is also used by hardware acceleration APIs.
1907 * It is called at least once during frame decoding to pass
1908 * the data needed for hardware render.
1909 * In that mode instead of pixel data, AVFrame points to
1910 * a structure specific to the acceleration API. The application
1911 * reads the structure and can change some fields to indicate progress
1913 * - encoding: unused
1914 * - decoding: Set by user.
1915 * @param height the height of the slice
1916 * @param y the y position of the slice
1917 * @param type 1->top field, 2->bottom field, 3->frame
1918 * @param offset offset into the AVFrame.data from which the slice should be read
1920 void (*draw_horiz_band)(struct AVCodecContext *s,
1921 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1922 int y, int type, int height);
1925 * callback to negotiate the pixelFormat
1926 * @param fmt is the list of formats which are supported by the codec,
1927 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1928 * The first is always the native one.
1929 * @note The callback may be called again immediately if initialization for
1930 * the selected (hardware-accelerated) pixel format failed.
1931 * @warning Behavior is undefined if the callback returns a value not
1932 * in the fmt list of formats.
1933 * @return the chosen format
1934 * - encoding: unused
1935 * - decoding: Set by user, if not set the native format will be chosen.
1937 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1940 * maximum number of B-frames between non-B-frames
1941 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1942 * - encoding: Set by user.
1943 * - decoding: unused
1948 * qscale factor between IP and B-frames
1949 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1950 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1951 * - encoding: Set by user.
1952 * - decoding: unused
1954 float b_quant_factor;
1956 #if FF_API_RC_STRATEGY
1957 /** @deprecated use codec private option instead */
1958 attribute_deprecated int rc_strategy;
1959 #define FF_RC_STRATEGY_XVID 1
1962 #if FF_API_PRIVATE_OPT
1963 /** @deprecated use encoder private options instead */
1964 attribute_deprecated
1965 int b_frame_strategy;
1969 * qscale offset between IP and B-frames
1970 * - encoding: Set by user.
1971 * - decoding: unused
1973 float b_quant_offset;
1976 * Size of the frame reordering buffer in the decoder.
1977 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1978 * - encoding: Set by libavcodec.
1979 * - decoding: Set by libavcodec.
1983 #if FF_API_PRIVATE_OPT
1984 /** @deprecated use encoder private options instead */
1985 attribute_deprecated
1990 * qscale factor between P- and I-frames
1991 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1992 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1993 * - encoding: Set by user.
1994 * - decoding: unused
1996 float i_quant_factor;
1999 * qscale offset between P and I-frames
2000 * - encoding: Set by user.
2001 * - decoding: unused
2003 float i_quant_offset;
2006 * luminance masking (0-> disabled)
2007 * - encoding: Set by user.
2008 * - decoding: unused
2013 * temporary complexity masking (0-> disabled)
2014 * - encoding: Set by user.
2015 * - decoding: unused
2017 float temporal_cplx_masking;
2020 * spatial complexity masking (0-> disabled)
2021 * - encoding: Set by user.
2022 * - decoding: unused
2024 float spatial_cplx_masking;
2027 * p block masking (0-> disabled)
2028 * - encoding: Set by user.
2029 * - decoding: unused
2034 * darkness masking (0-> disabled)
2035 * - encoding: Set by user.
2036 * - decoding: unused
2042 * - encoding: Set by libavcodec.
2043 * - decoding: Set by user (or 0).
2047 #if FF_API_PRIVATE_OPT
2048 /** @deprecated use encoder private options instead */
2049 attribute_deprecated
2050 int prediction_method;
2051 #define FF_PRED_LEFT 0
2052 #define FF_PRED_PLANE 1
2053 #define FF_PRED_MEDIAN 2
2057 * slice offsets in the frame in bytes
2058 * - encoding: Set/allocated by libavcodec.
2059 * - decoding: Set/allocated by user (or NULL).
2064 * sample aspect ratio (0 if unknown)
2065 * That is the width of a pixel divided by the height of the pixel.
2066 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2067 * - encoding: Set by user.
2068 * - decoding: Set by libavcodec.
2070 AVRational sample_aspect_ratio;
2073 * motion estimation comparison function
2074 * - encoding: Set by user.
2075 * - decoding: unused
2079 * subpixel motion estimation comparison function
2080 * - encoding: Set by user.
2081 * - decoding: unused
2085 * macroblock comparison function (not supported yet)
2086 * - encoding: Set by user.
2087 * - decoding: unused
2091 * interlaced DCT comparison function
2092 * - encoding: Set by user.
2093 * - decoding: unused
2096 #define FF_CMP_SAD 0
2097 #define FF_CMP_SSE 1
2098 #define FF_CMP_SATD 2
2099 #define FF_CMP_DCT 3
2100 #define FF_CMP_PSNR 4
2101 #define FF_CMP_BIT 5
2103 #define FF_CMP_ZERO 7
2104 #define FF_CMP_VSAD 8
2105 #define FF_CMP_VSSE 9
2106 #define FF_CMP_NSSE 10
2107 #define FF_CMP_W53 11
2108 #define FF_CMP_W97 12
2109 #define FF_CMP_DCTMAX 13
2110 #define FF_CMP_DCT264 14
2111 #define FF_CMP_CHROMA 256
2114 * ME diamond size & shape
2115 * - encoding: Set by user.
2116 * - decoding: unused
2121 * amount of previous MV predictors (2a+1 x 2a+1 square)
2122 * - encoding: Set by user.
2123 * - decoding: unused
2125 int last_predictor_count;
2127 #if FF_API_PRIVATE_OPT
2128 /** @deprecated use encoder private options instead */
2129 attribute_deprecated
2134 * motion estimation prepass comparison function
2135 * - encoding: Set by user.
2136 * - decoding: unused
2141 * ME prepass diamond size & shape
2142 * - encoding: Set by user.
2143 * - decoding: unused
2149 * - encoding: Set by user.
2150 * - decoding: unused
2152 int me_subpel_quality;
2156 * DTG active format information (additional aspect ratio
2157 * information only used in DVB MPEG-2 transport streams)
2160 * - encoding: unused
2161 * - decoding: Set by decoder.
2162 * @deprecated Deprecated in favor of AVSideData
2164 attribute_deprecated int dtg_active_format;
2165 #define FF_DTG_AFD_SAME 8
2166 #define FF_DTG_AFD_4_3 9
2167 #define FF_DTG_AFD_16_9 10
2168 #define FF_DTG_AFD_14_9 11
2169 #define FF_DTG_AFD_4_3_SP_14_9 13
2170 #define FF_DTG_AFD_16_9_SP_14_9 14
2171 #define FF_DTG_AFD_SP_4_3 15
2172 #endif /* FF_API_AFD */
2175 * maximum motion estimation search range in subpel units
2176 * If 0 then no limit.
2178 * - encoding: Set by user.
2179 * - decoding: unused
2183 #if FF_API_QUANT_BIAS
2185 * @deprecated use encoder private option instead
2187 attribute_deprecated int intra_quant_bias;
2188 #define FF_DEFAULT_QUANT_BIAS 999999
2191 * @deprecated use encoder private option instead
2193 attribute_deprecated int inter_quant_bias;
2198 * - encoding: unused
2199 * - decoding: Set by user.
2202 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2203 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2204 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2208 * XVideo Motion Acceleration
2209 * - encoding: forbidden
2210 * - decoding: set by decoder
2211 * @deprecated XvMC doesn't need it anymore.
2213 attribute_deprecated int xvmc_acceleration;
2214 #endif /* FF_API_XVMC */
2217 * macroblock decision mode
2218 * - encoding: Set by user.
2219 * - decoding: unused
2222 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2223 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2224 #define FF_MB_DECISION_RD 2 ///< rate distortion
2227 * custom intra quantization matrix
2228 * - encoding: Set by user, can be NULL.
2229 * - decoding: Set by libavcodec.
2231 uint16_t *intra_matrix;
2234 * custom inter quantization matrix
2235 * - encoding: Set by user, can be NULL.
2236 * - decoding: Set by libavcodec.
2238 uint16_t *inter_matrix;
2240 #if FF_API_PRIVATE_OPT
2241 /** @deprecated use encoder private options instead */
2242 attribute_deprecated
2243 int scenechange_threshold;
2245 /** @deprecated use encoder private options instead */
2246 attribute_deprecated
2247 int noise_reduction;
2252 * @deprecated this field is unused
2254 attribute_deprecated
2258 * @deprecated this field is unused
2260 attribute_deprecated
2265 * precision of the intra DC coefficient - 8
2266 * - encoding: Set by user.
2267 * - decoding: Set by libavcodec
2269 int intra_dc_precision;
2272 * Number of macroblock rows at the top which are skipped.
2273 * - encoding: unused
2274 * - decoding: Set by user.
2279 * Number of macroblock rows at the bottom which are skipped.
2280 * - encoding: unused
2281 * - decoding: Set by user.
2287 * @deprecated use encoder private options instead
2289 attribute_deprecated
2290 float border_masking;
2294 * minimum MB Lagrange multiplier
2295 * - encoding: Set by user.
2296 * - decoding: unused
2301 * maximum MB Lagrange multiplier
2302 * - encoding: Set by user.
2303 * - decoding: unused
2307 #if FF_API_PRIVATE_OPT
2309 * @deprecated use encoder private options instead
2311 attribute_deprecated
2312 int me_penalty_compensation;
2316 * - encoding: Set by user.
2317 * - decoding: unused
2321 #if FF_API_PRIVATE_OPT
2322 /** @deprecated use encoder private options instead */
2323 attribute_deprecated
2329 * - encoding: Set by user.
2330 * - decoding: unused
2335 * number of reference frames
2336 * - encoding: Set by user.
2337 * - decoding: Set by lavc.
2341 #if FF_API_PRIVATE_OPT
2342 /** @deprecated use encoder private options instead */
2343 attribute_deprecated
2347 #if FF_API_UNUSED_MEMBERS
2349 * Multiplied by qscale for each frame and added to scene_change_score.
2350 * - encoding: Set by user.
2351 * - decoding: unused
2353 attribute_deprecated int scenechange_factor;
2357 * Note: Value depends upon the compare function used for fullpel ME.
2358 * - encoding: Set by user.
2359 * - decoding: unused
2363 #if FF_API_PRIVATE_OPT
2364 /** @deprecated use encoder private options instead */
2365 attribute_deprecated
2370 * Chromaticity coordinates of the source primaries.
2371 * - encoding: Set by user
2372 * - decoding: Set by libavcodec
2374 enum AVColorPrimaries color_primaries;
2377 * Color Transfer Characteristic.
2378 * - encoding: Set by user
2379 * - decoding: Set by libavcodec
2381 enum AVColorTransferCharacteristic color_trc;
2384 * YUV colorspace type.
2385 * - encoding: Set by user
2386 * - decoding: Set by libavcodec
2388 enum AVColorSpace colorspace;
2391 * MPEG vs JPEG YUV range.
2392 * - encoding: Set by user
2393 * - decoding: Set by libavcodec
2395 enum AVColorRange color_range;
2398 * This defines the location of chroma samples.
2399 * - encoding: Set by user
2400 * - decoding: Set by libavcodec
2402 enum AVChromaLocation chroma_sample_location;
2406 * Indicates number of picture subdivisions. Used for parallelized
2408 * - encoding: Set by user
2409 * - decoding: unused
2414 * - encoding: set by libavcodec
2415 * - decoding: Set by user.
2417 enum AVFieldOrder field_order;
2420 int sample_rate; ///< samples per second
2421 int channels; ///< number of audio channels
2424 * audio sample format
2425 * - encoding: Set by user.
2426 * - decoding: Set by libavcodec.
2428 enum AVSampleFormat sample_fmt; ///< sample format
2430 /* The following data should not be initialized. */
2432 * Number of samples per channel in an audio frame.
2434 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2435 * except the last must contain exactly frame_size samples per channel.
2436 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2437 * frame size is not restricted.
2438 * - decoding: may be set by some decoders to indicate constant frame size
2443 * Frame counter, set by libavcodec.
2445 * - decoding: total number of frames returned from the decoder so far.
2446 * - encoding: total number of frames passed to the encoder so far.
2448 * @note the counter is not incremented if encoding/decoding resulted in
2454 * number of bytes per packet if constant and known or 0
2455 * Used by some WAV based audio codecs.
2460 * Audio cutoff bandwidth (0 means "automatic")
2461 * - encoding: Set by user.
2462 * - decoding: unused
2467 * Audio channel layout.
2468 * - encoding: set by user.
2469 * - decoding: set by user, may be overwritten by libavcodec.
2471 uint64_t channel_layout;
2474 * Request decoder to use this channel layout if it can (0 for default)
2475 * - encoding: unused
2476 * - decoding: Set by user.
2478 uint64_t request_channel_layout;
2481 * Type of service that the audio stream conveys.
2482 * - encoding: Set by user.
2483 * - decoding: Set by libavcodec.
2485 enum AVAudioServiceType audio_service_type;
2488 * desired sample format
2489 * - encoding: Not used.
2490 * - decoding: Set by user.
2491 * Decoder will decode to this format if it can.
2493 enum AVSampleFormat request_sample_fmt;
2496 * This callback is called at the beginning of each frame to get data
2497 * buffer(s) for it. There may be one contiguous buffer for all the data or
2498 * there may be a buffer per each data plane or anything in between. What
2499 * this means is, you may set however many entries in buf[] you feel necessary.
2500 * Each buffer must be reference-counted using the AVBuffer API (see description
2503 * The following fields will be set in the frame before this callback is
2506 * - width, height (video only)
2507 * - sample_rate, channel_layout, nb_samples (audio only)
2508 * Their values may differ from the corresponding values in
2509 * AVCodecContext. This callback must use the frame values, not the codec
2510 * context values, to calculate the required buffer size.
2512 * This callback must fill the following fields in the frame:
2516 * * if the data is planar audio with more than 8 channels, then this
2517 * callback must allocate and fill extended_data to contain all pointers
2518 * to all data planes. data[] must hold as many pointers as it can.
2519 * extended_data must be allocated with av_malloc() and will be freed in
2521 * * otherwise extended_data must point to data
2522 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2523 * the frame's data and extended_data pointers must be contained in these. That
2524 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2525 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2526 * and av_buffer_ref().
2527 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2528 * this callback and filled with the extra buffers if there are more
2529 * buffers than buf[] can hold. extended_buf will be freed in
2532 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2533 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2536 * Each data plane must be aligned to the maximum required by the target
2539 * @see avcodec_default_get_buffer2()
2543 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2544 * (read and/or written to if it is writable) later by libavcodec.
2546 * avcodec_align_dimensions2() should be used to find the required width and
2547 * height, as they normally need to be rounded up to the next multiple of 16.
2549 * Some decoders do not support linesizes changing between frames.
2551 * If frame multithreading is used and thread_safe_callbacks is set,
2552 * this callback may be called from a different thread, but not from more
2553 * than one at once. Does not need to be reentrant.
2555 * @see avcodec_align_dimensions2()
2559 * Decoders request a buffer of a particular size by setting
2560 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2561 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2562 * to a smaller value in the output frame.
2564 * As a convenience, av_samples_get_buffer_size() and
2565 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2566 * functions to find the required data size and to fill data pointers and
2567 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2568 * since all planes must be the same size.
2570 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2572 * - encoding: unused
2573 * - decoding: Set by libavcodec, user can override.
2575 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2578 * If non-zero, the decoded audio and video frames returned from
2579 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2580 * and are valid indefinitely. The caller must free them with
2581 * av_frame_unref() when they are not needed anymore.
2582 * Otherwise, the decoded frames must not be freed by the caller and are
2583 * only valid until the next decode call.
2585 * This is always automatically enabled if avcodec_receive_frame() is used.
2587 * - encoding: unused
2588 * - decoding: set by the caller before avcodec_open2().
2590 int refcounted_frames;
2592 /* - encoding parameters */
2593 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2594 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2598 * - encoding: Set by user.
2599 * - decoding: unused
2605 * - encoding: Set by user.
2606 * - decoding: unused
2611 * maximum quantizer difference between frames
2612 * - encoding: Set by user.
2613 * - decoding: unused
2619 * @deprecated use encoder private options instead
2621 attribute_deprecated
2624 attribute_deprecated
2626 attribute_deprecated
2631 * decoder bitstream buffer size
2632 * - encoding: Set by user.
2633 * - decoding: unused
2638 * ratecontrol override, see RcOverride
2639 * - encoding: Allocated/set/freed by user.
2640 * - decoding: unused
2642 int rc_override_count;
2643 RcOverride *rc_override;
2647 * @deprecated use encoder private options instead
2649 attribute_deprecated
2655 * - encoding: Set by user.
2656 * - decoding: Set by user, may be overwritten by libavcodec.
2658 int64_t rc_max_rate;
2662 * - encoding: Set by user.
2663 * - decoding: unused
2665 int64_t rc_min_rate;
2669 * @deprecated use encoder private options instead
2671 attribute_deprecated
2672 float rc_buffer_aggressivity;
2674 attribute_deprecated
2675 float rc_initial_cplx;
2679 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2680 * - encoding: Set by user.
2681 * - decoding: unused.
2683 float rc_max_available_vbv_use;
2686 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2687 * - encoding: Set by user.
2688 * - decoding: unused.
2690 float rc_min_vbv_overflow_use;
2693 * Number of bits which should be loaded into the rc buffer before decoding starts.
2694 * - encoding: Set by user.
2695 * - decoding: unused
2697 int rc_initial_buffer_occupancy;
2699 #if FF_API_CODER_TYPE
2700 #define FF_CODER_TYPE_VLC 0
2701 #define FF_CODER_TYPE_AC 1
2702 #define FF_CODER_TYPE_RAW 2
2703 #define FF_CODER_TYPE_RLE 3
2704 #if FF_API_UNUSED_MEMBERS
2705 #define FF_CODER_TYPE_DEFLATE 4
2706 #endif /* FF_API_UNUSED_MEMBERS */
2708 * @deprecated use encoder private options instead
2710 attribute_deprecated
2712 #endif /* FF_API_CODER_TYPE */
2714 #if FF_API_PRIVATE_OPT
2715 /** @deprecated use encoder private options instead */
2716 attribute_deprecated
2722 * @deprecated use encoder private options instead
2724 attribute_deprecated
2728 * @deprecated use encoder private options instead
2730 attribute_deprecated
2734 #if FF_API_PRIVATE_OPT
2735 /** @deprecated use encoder private options instead */
2736 attribute_deprecated
2737 int frame_skip_threshold;
2739 /** @deprecated use encoder private options instead */
2740 attribute_deprecated
2741 int frame_skip_factor;
2743 /** @deprecated use encoder private options instead */
2744 attribute_deprecated
2747 /** @deprecated use encoder private options instead */
2748 attribute_deprecated
2750 #endif /* FF_API_PRIVATE_OPT */
2753 * trellis RD quantization
2754 * - encoding: Set by user.
2755 * - decoding: unused
2759 #if FF_API_PRIVATE_OPT
2760 /** @deprecated use encoder private options instead */
2761 attribute_deprecated
2762 int min_prediction_order;
2764 /** @deprecated use encoder private options instead */
2765 attribute_deprecated
2766 int max_prediction_order;
2768 /** @deprecated use encoder private options instead */
2769 attribute_deprecated
2770 int64_t timecode_frame_start;
2773 #if FF_API_RTP_CALLBACK
2775 * @deprecated unused
2777 /* The RTP callback: This function is called */
2778 /* every time the encoder has a packet to send. */
2779 /* It depends on the encoder if the data starts */
2780 /* with a Start Code (it should). H.263 does. */
2781 /* mb_nb contains the number of macroblocks */
2782 /* encoded in the RTP payload. */
2783 attribute_deprecated
2784 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2787 #if FF_API_PRIVATE_OPT
2788 /** @deprecated use encoder private options instead */
2789 attribute_deprecated
2790 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2791 /* do its best to deliver a chunk with size */
2792 /* below rtp_payload_size, the chunk will start */
2793 /* with a start code on some codecs like H.263. */
2794 /* This doesn't take account of any particular */
2795 /* headers inside the transmitted RTP payload. */
2798 #if FF_API_STAT_BITS
2799 /* statistics, used for 2-pass encoding */
2800 attribute_deprecated
2802 attribute_deprecated
2804 attribute_deprecated
2806 attribute_deprecated
2808 attribute_deprecated
2810 attribute_deprecated
2812 attribute_deprecated
2814 attribute_deprecated
2817 /** @deprecated this field is unused */
2818 attribute_deprecated
2823 * pass1 encoding statistics output buffer
2824 * - encoding: Set by libavcodec.
2825 * - decoding: unused
2830 * pass2 encoding statistics input buffer
2831 * Concatenated stuff from stats_out of pass1 should be placed here.
2832 * - encoding: Allocated/set/freed by user.
2833 * - decoding: unused
2838 * Work around bugs in encoders which sometimes cannot be detected automatically.
2839 * - encoding: Set by user
2840 * - decoding: Set by user
2842 int workaround_bugs;
2843 #define FF_BUG_AUTODETECT 1 ///< autodetection
2844 #if FF_API_OLD_MSMPEG4
2845 #define FF_BUG_OLD_MSMPEG4 2
2847 #define FF_BUG_XVID_ILACE 4
2848 #define FF_BUG_UMP4 8
2849 #define FF_BUG_NO_PADDING 16
2850 #define FF_BUG_AMV 32
2852 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2854 #define FF_BUG_QPEL_CHROMA 64
2855 #define FF_BUG_STD_QPEL 128
2856 #define FF_BUG_QPEL_CHROMA2 256
2857 #define FF_BUG_DIRECT_BLOCKSIZE 512
2858 #define FF_BUG_EDGE 1024
2859 #define FF_BUG_HPEL_CHROMA 2048
2860 #define FF_BUG_DC_CLIP 4096
2861 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2862 #define FF_BUG_TRUNCATED 16384
2865 * strictly follow the standard (MPEG-4, ...).
2866 * - encoding: Set by user.
2867 * - decoding: Set by user.
2868 * Setting this to STRICT or higher means the encoder and decoder will
2869 * generally do stupid things, whereas setting it to unofficial or lower
2870 * will mean the encoder might produce output that is not supported by all
2871 * spec-compliant decoders. Decoders don't differentiate between normal,
2872 * unofficial and experimental (that is, they always try to decode things
2873 * when they can) unless they are explicitly asked to behave stupidly
2874 * (=strictly conform to the specs)
2876 int strict_std_compliance;
2877 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2878 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2879 #define FF_COMPLIANCE_NORMAL 0
2880 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2881 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2884 * error concealment flags
2885 * - encoding: unused
2886 * - decoding: Set by user.
2888 int error_concealment;
2889 #define FF_EC_GUESS_MVS 1
2890 #define FF_EC_DEBLOCK 2
2891 #define FF_EC_FAVOR_INTER 256
2895 * - encoding: Set by user.
2896 * - decoding: Set by user.
2899 #define FF_DEBUG_PICT_INFO 1
2900 #define FF_DEBUG_RC 2
2901 #define FF_DEBUG_BITSTREAM 4
2902 #define FF_DEBUG_MB_TYPE 8
2903 #define FF_DEBUG_QP 16
2906 * @deprecated this option does nothing
2908 #define FF_DEBUG_MV 32
2910 #define FF_DEBUG_DCT_COEFF 0x00000040
2911 #define FF_DEBUG_SKIP 0x00000080
2912 #define FF_DEBUG_STARTCODE 0x00000100
2913 #if FF_API_UNUSED_MEMBERS
2914 #define FF_DEBUG_PTS 0x00000200
2915 #endif /* FF_API_UNUSED_MEMBERS */
2916 #define FF_DEBUG_ER 0x00000400
2917 #define FF_DEBUG_MMCO 0x00000800
2918 #define FF_DEBUG_BUGS 0x00001000
2920 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2921 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2923 #define FF_DEBUG_BUFFERS 0x00008000
2924 #define FF_DEBUG_THREADS 0x00010000
2925 #define FF_DEBUG_GREEN_MD 0x00800000
2926 #define FF_DEBUG_NOMC 0x01000000
2931 * Code outside libavcodec should access this field using AVOptions
2932 * - encoding: Set by user.
2933 * - decoding: Set by user.
2936 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2937 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2938 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2942 * Error recognition; may misdetect some more or less valid parts as errors.
2943 * - encoding: unused
2944 * - decoding: Set by user.
2946 int err_recognition;
2949 * Verify checksums embedded in the bitstream (could be of either encoded or
2950 * decoded data, depending on the codec) and print an error message on mismatch.
2951 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2952 * decoder returning an error.
2954 #define AV_EF_CRCCHECK (1<<0)
2955 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2956 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2957 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2959 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2960 #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
2961 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2962 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2966 * opaque 64-bit number (generally a PTS) that will be reordered and
2967 * output in AVFrame.reordered_opaque
2968 * - encoding: unused
2969 * - decoding: Set by user.
2971 int64_t reordered_opaque;
2974 * Hardware accelerator in use
2975 * - encoding: unused.
2976 * - decoding: Set by libavcodec
2978 struct AVHWAccel *hwaccel;
2981 * Hardware accelerator context.
2982 * For some hardware accelerators, a global context needs to be
2983 * provided by the user. In that case, this holds display-dependent
2984 * data FFmpeg cannot instantiate itself. Please refer to the
2985 * FFmpeg HW accelerator documentation to know how to fill this
2986 * is. e.g. for VA API, this is a struct vaapi_context.
2987 * - encoding: unused
2988 * - decoding: Set by user
2990 void *hwaccel_context;
2994 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2995 * - decoding: unused
2997 uint64_t error[AV_NUM_DATA_POINTERS];
3000 * DCT algorithm, see FF_DCT_* below
3001 * - encoding: Set by user.
3002 * - decoding: unused
3005 #define FF_DCT_AUTO 0
3006 #define FF_DCT_FASTINT 1
3007 #define FF_DCT_INT 2
3008 #define FF_DCT_MMX 3
3009 #define FF_DCT_ALTIVEC 5
3010 #define FF_DCT_FAAN 6
3013 * IDCT algorithm, see FF_IDCT_* below.
3014 * - encoding: Set by user.
3015 * - decoding: Set by user.
3018 #define FF_IDCT_AUTO 0
3019 #define FF_IDCT_INT 1
3020 #define FF_IDCT_SIMPLE 2
3021 #define FF_IDCT_SIMPLEMMX 3
3022 #define FF_IDCT_ARM 7
3023 #define FF_IDCT_ALTIVEC 8
3025 #define FF_IDCT_SH4 9
3027 #define FF_IDCT_SIMPLEARM 10
3028 #if FF_API_UNUSED_MEMBERS
3029 #define FF_IDCT_IPP 13
3030 #endif /* FF_API_UNUSED_MEMBERS */
3031 #define FF_IDCT_XVID 14
3032 #if FF_API_IDCT_XVIDMMX
3033 #define FF_IDCT_XVIDMMX 14
3034 #endif /* FF_API_IDCT_XVIDMMX */
3035 #define FF_IDCT_SIMPLEARMV5TE 16
3036 #define FF_IDCT_SIMPLEARMV6 17
3037 #if FF_API_ARCH_SPARC
3038 #define FF_IDCT_SIMPLEVIS 18
3040 #define FF_IDCT_FAAN 20
3041 #define FF_IDCT_SIMPLENEON 22
3042 #if FF_API_ARCH_ALPHA
3043 #define FF_IDCT_SIMPLEALPHA 23
3045 #define FF_IDCT_SIMPLEAUTO 128
3048 * bits per sample/pixel from the demuxer (needed for huffyuv).
3049 * - encoding: Set by libavcodec.
3050 * - decoding: Set by user.
3052 int bits_per_coded_sample;
3055 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3056 * - encoding: set by user.
3057 * - decoding: set by libavcodec.
3059 int bits_per_raw_sample;
3063 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3064 * - encoding: unused
3065 * - decoding: Set by user.
3066 * Code outside libavcodec should access this field using:
3067 * av_codec_{get,set}_lowres(avctx)
3072 #if FF_API_CODED_FRAME
3074 * the picture in the bitstream
3075 * - encoding: Set by libavcodec.
3076 * - decoding: unused
3078 * @deprecated use the quality factor packet side data instead
3080 attribute_deprecated AVFrame *coded_frame;
3085 * is used to decide how many independent tasks should be passed to execute()
3086 * - encoding: Set by user.
3087 * - decoding: Set by user.
3092 * Which multithreading methods to use.
3093 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3094 * so clients which cannot provide future frames should not use it.
3096 * - encoding: Set by user, otherwise the default is used.
3097 * - decoding: Set by user, otherwise the default is used.
3100 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3101 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3104 * Which multithreading methods are in use by the codec.
3105 * - encoding: Set by libavcodec.
3106 * - decoding: Set by libavcodec.
3108 int active_thread_type;
3111 * Set by the client if its custom get_buffer() callback can be called
3112 * synchronously from another thread, which allows faster multithreaded decoding.
3113 * draw_horiz_band() will be called from other threads regardless of this setting.
3114 * Ignored if the default get_buffer() is used.
3115 * - encoding: Set by user.
3116 * - decoding: Set by user.
3118 int thread_safe_callbacks;
3121 * The codec may call this to execute several independent things.
3122 * It will return only after finishing all tasks.
3123 * The user may replace this with some multithreaded implementation,
3124 * the default implementation will execute the parts serially.
3125 * @param count the number of things to execute
3126 * - encoding: Set by libavcodec, user can override.
3127 * - decoding: Set by libavcodec, user can override.
3129 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3132 * The codec may call this to execute several independent things.
3133 * It will return only after finishing all tasks.
3134 * The user may replace this with some multithreaded implementation,
3135 * the default implementation will execute the parts serially.
3136 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3137 * @param c context passed also to func
3138 * @param count the number of things to execute
3139 * @param arg2 argument passed unchanged to func
3140 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3141 * @param func function that will be called count times, with jobnr from 0 to count-1.
3142 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3143 * two instances of func executing at the same time will have the same threadnr.
3144 * @return always 0 currently, but code should handle a future improvement where when any call to func
3145 * returns < 0 no further calls to func may be done and < 0 is returned.
3146 * - encoding: Set by libavcodec, user can override.
3147 * - decoding: Set by libavcodec, user can override.
3149 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3152 * noise vs. sse weight for the nsse comparison function
3153 * - encoding: Set by user.
3154 * - decoding: unused
3160 * - encoding: Set by user.
3161 * - decoding: Set by libavcodec.
3164 #define FF_PROFILE_UNKNOWN -99
3165 #define FF_PROFILE_RESERVED -100
3167 #define FF_PROFILE_AAC_MAIN 0
3168 #define FF_PROFILE_AAC_LOW 1
3169 #define FF_PROFILE_AAC_SSR 2
3170 #define FF_PROFILE_AAC_LTP 3
3171 #define FF_PROFILE_AAC_HE 4
3172 #define FF_PROFILE_AAC_HE_V2 28
3173 #define FF_PROFILE_AAC_LD 22
3174 #define FF_PROFILE_AAC_ELD 38
3175 #define FF_PROFILE_MPEG2_AAC_LOW 128
3176 #define FF_PROFILE_MPEG2_AAC_HE 131
3178 #define FF_PROFILE_DNXHD 0
3179 #define FF_PROFILE_DNXHR_LB 1
3180 #define FF_PROFILE_DNXHR_SQ 2
3181 #define FF_PROFILE_DNXHR_HQ 3
3182 #define FF_PROFILE_DNXHR_HQX 4
3183 #define FF_PROFILE_DNXHR_444 5
3185 #define FF_PROFILE_DTS 20
3186 #define FF_PROFILE_DTS_ES 30
3187 #define FF_PROFILE_DTS_96_24 40
3188 #define FF_PROFILE_DTS_HD_HRA 50
3189 #define FF_PROFILE_DTS_HD_MA 60
3190 #define FF_PROFILE_DTS_EXPRESS 70
3192 #define FF_PROFILE_MPEG2_422 0
3193 #define FF_PROFILE_MPEG2_HIGH 1
3194 #define FF_PROFILE_MPEG2_SS 2
3195 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3196 #define FF_PROFILE_MPEG2_MAIN 4
3197 #define FF_PROFILE_MPEG2_SIMPLE 5
3199 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3200 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3202 #define FF_PROFILE_H264_BASELINE 66
3203 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3204 #define FF_PROFILE_H264_MAIN 77
3205 #define FF_PROFILE_H264_EXTENDED 88
3206 #define FF_PROFILE_H264_HIGH 100
3207 #define FF_PROFILE_H264_HIGH_10 110
3208 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3209 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3210 #define FF_PROFILE_H264_HIGH_422 122
3211 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3212 #define FF_PROFILE_H264_STEREO_HIGH 128
3213 #define FF_PROFILE_H264_HIGH_444 144
3214 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3215 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3216 #define FF_PROFILE_H264_CAVLC_444 44
3218 #define FF_PROFILE_VC1_SIMPLE 0
3219 #define FF_PROFILE_VC1_MAIN 1
3220 #define FF_PROFILE_VC1_COMPLEX 2
3221 #define FF_PROFILE_VC1_ADVANCED 3
3223 #define FF_PROFILE_MPEG4_SIMPLE 0
3224 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3225 #define FF_PROFILE_MPEG4_CORE 2
3226 #define FF_PROFILE_MPEG4_MAIN 3
3227 #define FF_PROFILE_MPEG4_N_BIT 4
3228 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3229 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3230 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3231 #define FF_PROFILE_MPEG4_HYBRID 8
3232 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3233 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3234 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3235 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3236 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3237 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3238 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3240 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3241 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3242 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3243 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3244 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3246 #define FF_PROFILE_VP9_0 0
3247 #define FF_PROFILE_VP9_1 1
3248 #define FF_PROFILE_VP9_2 2
3249 #define FF_PROFILE_VP9_3 3
3251 #define FF_PROFILE_HEVC_MAIN 1
3252 #define FF_PROFILE_HEVC_MAIN_10 2
3253 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3254 #define FF_PROFILE_HEVC_REXT 4
3258 * - encoding: Set by user.
3259 * - decoding: Set by libavcodec.
3262 #define FF_LEVEL_UNKNOWN -99
3265 * Skip loop filtering for selected frames.
3266 * - encoding: unused
3267 * - decoding: Set by user.
3269 enum AVDiscard skip_loop_filter;
3272 * Skip IDCT/dequantization for selected frames.
3273 * - encoding: unused
3274 * - decoding: Set by user.
3276 enum AVDiscard skip_idct;
3279 * Skip decoding for selected frames.
3280 * - encoding: unused
3281 * - decoding: Set by user.
3283 enum AVDiscard skip_frame;
3286 * Header containing style information for text subtitles.
3287 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3288 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3289 * the Format line following. It shouldn't include any Dialogue line.
3290 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3291 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3293 uint8_t *subtitle_header;
3294 int subtitle_header_size;
3296 #if FF_API_ERROR_RATE
3298 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3301 attribute_deprecated
3305 #if FF_API_VBV_DELAY
3307 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3308 * Used for compliant TS muxing.
3309 * - encoding: Set by libavcodec.
3310 * - decoding: unused.
3311 * @deprecated this value is now exported as a part of
3312 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3314 attribute_deprecated
3318 #if FF_API_SIDEDATA_ONLY_PKT
3320 * Encoding only and set by default. Allow encoders to output packets
3321 * that do not contain any encoded data, only side data.
3323 * Some encoders need to output such packets, e.g. to update some stream
3324 * parameters at the end of encoding.
3326 * @deprecated this field disables the default behaviour and
3327 * it is kept only for compatibility.
3329 attribute_deprecated
3330 int side_data_only_packets;
3334 * Audio only. The number of "priming" samples (padding) inserted by the
3335 * encoder at the beginning of the audio. I.e. this number of leading
3336 * decoded samples must be discarded by the caller to get the original audio
3337 * without leading padding.
3339 * - decoding: unused
3340 * - encoding: Set by libavcodec. The timestamps on the output packets are
3341 * adjusted by the encoder so that they always refer to the
3342 * first sample of the data actually contained in the packet,
3343 * including any added padding. E.g. if the timebase is
3344 * 1/samplerate and the timestamp of the first input sample is
3345 * 0, the timestamp of the first output packet will be
3348 int initial_padding;
3351 * - decoding: For codecs that store a framerate value in the compressed
3352 * bitstream, the decoder may export it here. { 0, 1} when
3354 * - encoding: May be used to signal the framerate of CFR content to an
3357 AVRational framerate;
3360 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3361 * - encoding: unused.
3362 * - decoding: Set by libavcodec before calling get_format()
3364 enum AVPixelFormat sw_pix_fmt;
3367 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3368 * Code outside libavcodec should access this field using:
3369 * av_codec_{get,set}_pkt_timebase(avctx)
3370 * - encoding unused.
3371 * - decoding set by user.
3373 AVRational pkt_timebase;
3377 * Code outside libavcodec should access this field using:
3378 * av_codec_{get,set}_codec_descriptor(avctx)
3379 * - encoding: unused.
3380 * - decoding: set by libavcodec.
3382 const AVCodecDescriptor *codec_descriptor;
3386 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3387 * - encoding: unused
3388 * - decoding: Set by user.
3389 * Code outside libavcodec should access this field using:
3390 * av_codec_{get,set}_lowres(avctx)
3396 * Current statistics for PTS correction.
3397 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3398 * - encoding: unused
3400 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3401 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3402 int64_t pts_correction_last_pts; /// PTS of the last frame
3403 int64_t pts_correction_last_dts; /// DTS of the last frame
3406 * Character encoding of the input subtitles file.
3407 * - decoding: set by user
3408 * - encoding: unused
3413 * Subtitles character encoding mode. Formats or codecs might be adjusting
3414 * this setting (if they are doing the conversion themselves for instance).
3415 * - decoding: set by libavcodec
3416 * - encoding: unused
3418 int sub_charenc_mode;
3419 #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)
3420 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3421 #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
3424 * Skip processing alpha if supported by codec.
3425 * Note that if the format uses pre-multiplied alpha (common with VP6,
3426 * and recommended due to better video quality/compression)
3427 * the image will look as if alpha-blended onto a black background.
3428 * However for formats that do not use pre-multiplied alpha
3429 * there might be serious artefacts (though e.g. libswscale currently
3430 * assumes pre-multiplied alpha anyway).
3431 * Code outside libavcodec should access this field using AVOptions
3433 * - decoding: set by user
3434 * - encoding: unused
3439 * Number of samples to skip after a discontinuity
3440 * - decoding: unused
3441 * - encoding: set by libavcodec
3445 #if !FF_API_DEBUG_MV
3447 * debug motion vectors
3448 * Code outside libavcodec should access this field using AVOptions
3449 * - encoding: Set by user.
3450 * - decoding: Set by user.
3453 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3454 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3455 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3459 * custom intra quantization matrix
3460 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3461 * - encoding: Set by user, can be NULL.
3462 * - decoding: unused.
3464 uint16_t *chroma_intra_matrix;
3467 * dump format separator.
3468 * can be ", " or "\n " or anything else
3469 * Code outside libavcodec should access this field using AVOptions
3470 * (NO direct access).
3471 * - encoding: Set by user.
3472 * - decoding: Set by user.
3474 uint8_t *dump_separator;
3477 * ',' separated list of allowed decoders.
3478 * If NULL then all are allowed
3479 * - encoding: unused
3480 * - decoding: set by user through AVOPtions (NO direct access)
3482 char *codec_whitelist;
3485 * Properties of the stream that gets decoded
3486 * To be accessed through av_codec_get_properties() (NO direct access)
3487 * - encoding: unused
3488 * - decoding: set by libavcodec
3490 unsigned properties;
3491 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3492 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3495 * Additional data associated with the entire coded stream.
3497 * - decoding: unused
3498 * - encoding: may be set by libavcodec after avcodec_open2().
3500 AVPacketSideData *coded_side_data;
3501 int nb_coded_side_data;
3506 * For hardware encoders configured to use a hwaccel pixel format, this
3507 * field should be set by the caller to a reference to the AVHWFramesContext
3508 * describing input frames. AVHWFramesContext.format must be equal to
3509 * AVCodecContext.pix_fmt.
3511 * This field should be set before avcodec_open2() is called and is
3512 * afterwards owned and managed by libavcodec.
3514 AVBufferRef *hw_frames_ctx;
3517 * Control the form of AVSubtitle.rects[N]->ass
3518 * - decoding: set by user
3519 * - encoding: unused
3521 int sub_text_format;
3522 #define FF_SUB_TEXT_FMT_ASS 0
3523 #if FF_API_ASS_TIMING
3524 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3529 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3530 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3532 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3533 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3535 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3537 int av_codec_get_lowres(const AVCodecContext *avctx);
3538 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3540 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3541 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3543 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3544 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3549 typedef struct AVProfile {
3551 const char *name; ///< short name for the profile
3554 typedef struct AVCodecDefault AVCodecDefault;
3561 typedef struct AVCodec {
3563 * Name of the codec implementation.
3564 * The name is globally unique among encoders and among decoders (but an
3565 * encoder and a decoder can share the same name).
3566 * This is the primary way to find a codec from the user perspective.
3570 * Descriptive name for the codec, meant to be more human readable than name.
3571 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3573 const char *long_name;
3574 enum AVMediaType type;
3577 * Codec capabilities.
3578 * see AV_CODEC_CAP_*
3581 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3582 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3583 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3584 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3585 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3586 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3587 const AVClass *priv_class; ///< AVClass for the private context
3588 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3590 /*****************************************************************
3591 * No fields below this line are part of the public API. They
3592 * may not be used outside of libavcodec and can be changed and
3594 * New public fields should be added right above.
3595 *****************************************************************
3598 struct AVCodec *next;
3600 * @name Frame-level threading support functions
3604 * If defined, called on thread contexts when they are created.
3605 * If the codec allocates writable tables in init(), re-allocate them here.
3606 * priv_data will be set to a copy of the original.
3608 int (*init_thread_copy)(AVCodecContext *);
3610 * Copy necessary context variables from a previous thread context to the current one.
3611 * If not defined, the next thread will start automatically; otherwise, the codec
3612 * must call ff_thread_finish_setup().
3614 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3616 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3620 * Private codec-specific defaults.
3622 const AVCodecDefault *defaults;
3625 * Initialize codec static data, called from avcodec_register().
3627 void (*init_static_data)(struct AVCodec *codec);
3629 int (*init)(AVCodecContext *);
3630 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3631 const struct AVSubtitle *sub);
3633 * Encode data to an AVPacket.
3635 * @param avctx codec context
3636 * @param avpkt output AVPacket (may contain a user-provided buffer)
3637 * @param[in] frame AVFrame containing the raw data to be encoded
3638 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3639 * non-empty packet was returned in avpkt.
3640 * @return 0 on success, negative error code on failure
3642 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3643 int *got_packet_ptr);
3644 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3645 int (*close)(AVCodecContext *);
3647 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3648 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3650 * - never called if the codec is closed or the wrong type,
3651 * - AVPacket parameter change side data is applied right before calling
3652 * AVCodec->send_packet,
3653 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3654 * - only one drain packet is ever passed down (until the next flush()),
3655 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3657 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3658 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3659 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3660 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3663 * Will be called when seeking
3665 void (*flush)(AVCodecContext *);
3667 * Internal codec capabilities.
3668 * See FF_CODEC_CAP_* in internal.h
3673 int av_codec_get_max_lowres(const AVCodec *codec);
3675 struct MpegEncContext;
3678 * @defgroup lavc_hwaccel AVHWAccel
3681 typedef struct AVHWAccel {
3683 * Name of the hardware accelerated codec.
3684 * The name is globally unique among encoders and among decoders (but an
3685 * encoder and a decoder can share the same name).
3690 * Type of codec implemented by the hardware accelerator.
3692 * See AVMEDIA_TYPE_xxx
3694 enum AVMediaType type;
3697 * Codec implemented by the hardware accelerator.
3699 * See AV_CODEC_ID_xxx
3704 * Supported pixel format.
3706 * Only hardware accelerated formats are supported here.
3708 enum AVPixelFormat pix_fmt;
3711 * Hardware accelerated codec capabilities.
3712 * see HWACCEL_CODEC_CAP_*
3716 /*****************************************************************
3717 * No fields below this line are part of the public API. They
3718 * may not be used outside of libavcodec and can be changed and
3720 * New public fields should be added right above.
3721 *****************************************************************
3723 struct AVHWAccel *next;
3726 * Allocate a custom buffer
3728 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3731 * Called at the beginning of each frame or field picture.
3733 * Meaningful frame information (codec specific) is guaranteed to
3734 * be parsed at this point. This function is mandatory.
3736 * Note that buf can be NULL along with buf_size set to 0.
3737 * Otherwise, this means the whole frame is available at this point.
3739 * @param avctx the codec context
3740 * @param buf the frame data buffer base
3741 * @param buf_size the size of the frame in bytes
3742 * @return zero if successful, a negative value otherwise
3744 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3747 * Callback for each slice.
3749 * Meaningful slice information (codec specific) is guaranteed to
3750 * be parsed at this point. This function is mandatory.
3751 * The only exception is XvMC, that works on MB level.
3753 * @param avctx the codec context
3754 * @param buf the slice data buffer base
3755 * @param buf_size the size of the slice in bytes
3756 * @return zero if successful, a negative value otherwise
3758 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3761 * Called at the end of each frame or field picture.
3763 * The whole picture is parsed at this point and can now be sent
3764 * to the hardware accelerator. This function is mandatory.
3766 * @param avctx the codec context
3767 * @return zero if successful, a negative value otherwise
3769 int (*end_frame)(AVCodecContext *avctx);
3772 * Size of per-frame hardware accelerator private data.
3774 * Private data is allocated with av_mallocz() before
3775 * AVCodecContext.get_buffer() and deallocated after
3776 * AVCodecContext.release_buffer().
3778 int frame_priv_data_size;
3781 * Called for every Macroblock in a slice.
3783 * XvMC uses it to replace the ff_mpv_decode_mb().
3784 * Instead of decoding to raw picture, MB parameters are
3785 * stored in an array provided by the video driver.
3787 * @param s the mpeg context
3789 void (*decode_mb)(struct MpegEncContext *s);
3792 * Initialize the hwaccel private data.
3794 * This will be called from ff_get_format(), after hwaccel and
3795 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3798 int (*init)(AVCodecContext *avctx);
3801 * Uninitialize the hwaccel private data.
3803 * This will be called from get_format() or avcodec_close(), after hwaccel
3804 * and hwaccel_context are already uninitialized.
3806 int (*uninit)(AVCodecContext *avctx);
3809 * Size of the private data to allocate in
3810 * AVCodecInternal.hwaccel_priv_data.
3816 * Hardware acceleration should be used for decoding even if the codec level
3817 * used is unknown or higher than the maximum supported level reported by the
3820 * It's generally a good idea to pass this flag unless you have a specific
3821 * reason not to, as hardware tends to under-report supported levels.
3823 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3826 * Hardware acceleration can output YUV pixel formats with a different chroma
3827 * sampling than 4:2:0 and/or other than 8 bits per component.
3829 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3835 #if FF_API_AVPICTURE
3837 * @defgroup lavc_picture AVPicture
3839 * Functions for working with AVPicture
3844 * Picture data structure.
3846 * Up to four components can be stored into it, the last component is
3848 * @deprecated use AVFrame or imgutils functions instead
3850 typedef struct AVPicture {
3851 attribute_deprecated
3852 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3853 attribute_deprecated
3854 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3862 enum AVSubtitleType {
3865 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3868 * Plain text, the text field must be set by the decoder and is
3869 * authoritative. ass and pict fields may contain approximations.
3874 * Formatted text, the ass field must be set by the decoder and is
3875 * authoritative. pict and text fields may contain approximations.
3880 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3882 typedef struct AVSubtitleRect {
3883 int x; ///< top left corner of pict, undefined when pict is not set
3884 int y; ///< top left corner of pict, undefined when pict is not set
3885 int w; ///< width of pict, undefined when pict is not set
3886 int h; ///< height of pict, undefined when pict is not set
3887 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3889 #if FF_API_AVPICTURE
3891 * @deprecated unused
3893 attribute_deprecated
3897 * data+linesize for the bitmap of this subtitle.
3898 * Can be set for text/ass as well once they are rendered.
3903 enum AVSubtitleType type;
3905 char *text; ///< 0 terminated plain UTF-8 text
3908 * 0 terminated ASS/SSA compatible event line.
3909 * The presentation of this is unaffected by the other values in this
3917 typedef struct AVSubtitle {
3918 uint16_t format; /* 0 = graphics */
3919 uint32_t start_display_time; /* relative to packet pts, in ms */
3920 uint32_t end_display_time; /* relative to packet pts, in ms */
3922 AVSubtitleRect **rects;
3923 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3927 * This struct describes the properties of an encoded stream.
3929 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3930 * be allocated with avcodec_parameters_alloc() and freed with
3931 * avcodec_parameters_free().
3933 typedef struct AVCodecParameters {
3935 * General type of the encoded data.
3937 enum AVMediaType codec_type;
3939 * Specific type of the encoded data (the codec used).
3941 enum AVCodecID codec_id;
3943 * Additional information about the codec (corresponds to the AVI FOURCC).
3948 * Extra binary data needed for initializing the decoder, codec-dependent.
3950 * Must be allocated with av_malloc() and will be freed by
3951 * avcodec_parameters_free(). The allocated size of extradata must be at
3952 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3957 * Size of the extradata content in bytes.
3962 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3963 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3968 * The average bitrate of the encoded data (in bits per second).
3973 * The number of bits per sample in the codedwords.
3975 * This is basically the bitrate per sample. It is mandatory for a bunch of
3976 * formats to actually decode them. It's the number of bits for one sample in
3977 * the actual coded bitstream.
3979 * This could be for example 4 for ADPCM
3980 * For PCM formats this matches bits_per_raw_sample
3983 int bits_per_coded_sample;
3986 * This is the number of valid bits in each output sample. If the
3987 * sample format has more bits, the least significant bits are additional
3988 * padding bits, which are always 0. Use right shifts to reduce the sample
3989 * to its actual size. For example, audio formats with 24 bit samples will
3990 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3991 * To get the original sample use "(int32_t)sample >> 8"."
3993 * For ADPCM this might be 12 or 16 or similar
3996 int bits_per_raw_sample;
3999 * Codec-specific bitstream restrictions that the stream conforms to.
4005 * Video only. The dimensions of the video frame in pixels.
4011 * Video only. The aspect ratio (width / height) which a single pixel
4012 * should have when displayed.
4014 * When the aspect ratio is unknown / undefined, the numerator should be
4015 * set to 0 (the denominator may have any value).
4017 AVRational sample_aspect_ratio;
4020 * Video only. The order of the fields in interlaced video.
4022 enum AVFieldOrder field_order;
4025 * Video only. Additional colorspace characteristics.
4027 enum AVColorRange color_range;
4028 enum AVColorPrimaries color_primaries;
4029 enum AVColorTransferCharacteristic color_trc;
4030 enum AVColorSpace color_space;
4031 enum AVChromaLocation chroma_location;
4034 * Video only. Number of delayed frames.
4039 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4040 * unknown or unspecified, otherwise the number of bits set must be equal to
4041 * the channels field.
4043 uint64_t channel_layout;
4045 * Audio only. The number of audio channels.
4049 * Audio only. The number of audio samples per second.
4053 * Audio only. The number of bytes per coded audio frame, required by some
4056 * Corresponds to nBlockAlign in WAVEFORMATEX.
4060 * Audio only. Audio frame size, if known. Required by some formats to be static.
4065 * Audio only. The amount of padding (in samples) inserted by the encoder at
4066 * the beginning of the audio. I.e. this number of leading decoded samples
4067 * must be discarded by the caller to get the original audio without leading
4070 int initial_padding;
4072 * Audio only. The amount of padding (in samples) appended by the encoder to
4073 * the end of the audio. I.e. this number of decoded samples must be
4074 * discarded by the caller from the end of the stream to get the original
4075 * audio without any trailing padding.
4077 int trailing_padding;
4079 * Audio only. Number of samples to skip after a discontinuity.
4082 } AVCodecParameters;
4085 * If c is NULL, returns the first registered codec,
4086 * if c is non-NULL, returns the next registered codec after c,
4087 * or NULL if c is the last one.
4089 AVCodec *av_codec_next(const AVCodec *c);
4092 * Return the LIBAVCODEC_VERSION_INT constant.
4094 unsigned avcodec_version(void);
4097 * Return the libavcodec build-time configuration.
4099 const char *avcodec_configuration(void);
4102 * Return the libavcodec license.
4104 const char *avcodec_license(void);
4107 * Register the codec codec and initialize libavcodec.
4109 * @warning either this function or avcodec_register_all() must be called
4110 * before any other libavcodec functions.
4112 * @see avcodec_register_all()
4114 void avcodec_register(AVCodec *codec);
4117 * Register all the codecs, parsers and bitstream filters which were enabled at
4118 * configuration time. If you do not call this function you can select exactly
4119 * which formats you want to support, by using the individual registration
4122 * @see avcodec_register
4123 * @see av_register_codec_parser
4124 * @see av_register_bitstream_filter
4126 void avcodec_register_all(void);
4129 * Allocate an AVCodecContext and set its fields to default values. The
4130 * resulting struct should be freed with avcodec_free_context().
4132 * @param codec if non-NULL, allocate private data and initialize defaults
4133 * for the given codec. It is illegal to then call avcodec_open2()
4134 * with a different codec.
4135 * If NULL, then the codec-specific defaults won't be initialized,
4136 * which may result in suboptimal default settings (this is
4137 * important mainly for encoders, e.g. libx264).
4139 * @return An AVCodecContext filled with default values or NULL on failure.
4141 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4144 * Free the codec context and everything associated with it and write NULL to
4145 * the provided pointer.
4147 void avcodec_free_context(AVCodecContext **avctx);
4149 #if FF_API_GET_CONTEXT_DEFAULTS
4151 * @deprecated This function should not be used, as closing and opening a codec
4152 * context multiple time is not supported. A new codec context should be
4153 * allocated for each new use.
4155 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4159 * Get the AVClass for AVCodecContext. It can be used in combination with
4160 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4162 * @see av_opt_find().
4164 const AVClass *avcodec_get_class(void);
4166 #if FF_API_COPY_CONTEXT
4168 * Get the AVClass for AVFrame. It can be used in combination with
4169 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4171 * @see av_opt_find().
4173 const AVClass *avcodec_get_frame_class(void);
4176 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4177 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4179 * @see av_opt_find().
4181 const AVClass *avcodec_get_subtitle_rect_class(void);
4184 * Copy the settings of the source AVCodecContext into the destination
4185 * AVCodecContext. The resulting destination codec context will be
4186 * unopened, i.e. you are required to call avcodec_open2() before you
4187 * can use this AVCodecContext to decode/encode video/audio data.
4189 * @param dest target codec context, should be initialized with
4190 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4191 * @param src source codec context
4192 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4194 * @deprecated The semantics of this function are ill-defined and it should not
4195 * be used. If you need to transfer the stream parameters from one codec context
4196 * to another, use an intermediate AVCodecParameters instance and the
4197 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4200 attribute_deprecated
4201 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4205 * Allocate a new AVCodecParameters and set its fields to default values
4206 * (unknown/invalid/0). The returned struct must be freed with
4207 * avcodec_parameters_free().
4209 AVCodecParameters *avcodec_parameters_alloc(void);
4212 * Free an AVCodecParameters instance and everything associated with it and
4213 * write NULL to the supplied pointer.
4215 void avcodec_parameters_free(AVCodecParameters **par);
4218 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4219 * replaced with newly allocated duplicates of the corresponding fields in src.
4221 * @return >= 0 on success, a negative AVERROR code on failure.
4223 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4226 * Fill the parameters struct based on the values from the supplied codec
4227 * context. Any allocated fields in par are freed and replaced with duplicates
4228 * of the corresponding fields in codec.
4230 * @return >= 0 on success, a negative AVERROR code on failure
4232 int avcodec_parameters_from_context(AVCodecParameters *par,
4233 const AVCodecContext *codec);
4236 * Fill the codec context based on the values from the supplied codec
4237 * parameters. Any allocated fields in codec that have a corresponding field in
4238 * par are freed and replaced with duplicates of the corresponding field in par.
4239 * Fields in codec that do not have a counterpart in par are not touched.
4241 * @return >= 0 on success, a negative AVERROR code on failure.
4243 int avcodec_parameters_to_context(AVCodecContext *codec,
4244 const AVCodecParameters *par);
4247 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4248 * function the context has to be allocated with avcodec_alloc_context3().
4250 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4251 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4252 * retrieving a codec.
4254 * @warning This function is not thread safe!
4256 * @note Always call this function before using decoding routines (such as
4257 * @ref avcodec_receive_frame()).
4260 * avcodec_register_all();
4261 * av_dict_set(&opts, "b", "2.5M", 0);
4262 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4266 * context = avcodec_alloc_context3(codec);
4268 * if (avcodec_open2(context, codec, opts) < 0)
4272 * @param avctx The context to initialize.
4273 * @param codec The codec to open this context for. If a non-NULL codec has been
4274 * previously passed to avcodec_alloc_context3() or
4275 * for this context, then this parameter MUST be either NULL or
4276 * equal to the previously passed codec.
4277 * @param options A dictionary filled with AVCodecContext and codec-private options.
4278 * On return this object will be filled with options that were not found.
4280 * @return zero on success, a negative value on error
4281 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4282 * av_dict_set(), av_opt_find().
4284 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4287 * Close a given AVCodecContext and free all the data associated with it
4288 * (but not the AVCodecContext itself).
4290 * Calling this function on an AVCodecContext that hasn't been opened will free
4291 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4292 * codec. Subsequent calls will do nothing.
4294 * @note Do not use this function. Use avcodec_free_context() to destroy a
4295 * codec context (either open or closed). Opening and closing a codec context
4296 * multiple times is not supported anymore -- use multiple codec contexts
4299 int avcodec_close(AVCodecContext *avctx);
4302 * Free all allocated data in the given subtitle struct.
4304 * @param sub AVSubtitle to free.
4306 void avsubtitle_free(AVSubtitle *sub);
4313 * @addtogroup lavc_packet
4318 * Allocate an AVPacket and set its fields to default values. The resulting
4319 * struct must be freed using av_packet_free().
4321 * @return An AVPacket filled with default values or NULL on failure.
4323 * @note this only allocates the AVPacket itself, not the data buffers. Those
4324 * must be allocated through other means such as av_new_packet.
4326 * @see av_new_packet
4328 AVPacket *av_packet_alloc(void);
4331 * Create a new packet that references the same data as src.
4333 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4335 * @return newly created AVPacket on success, NULL on error.
4337 * @see av_packet_alloc
4338 * @see av_packet_ref
4340 AVPacket *av_packet_clone(AVPacket *src);
4343 * Free the packet, if the packet is reference counted, it will be
4344 * unreferenced first.
4346 * @param packet packet to be freed. The pointer will be set to NULL.
4347 * @note passing NULL is a no-op.
4349 void av_packet_free(AVPacket **pkt);
4352 * Initialize optional fields of a packet with default values.
4354 * Note, this does not touch the data and size members, which have to be
4355 * initialized separately.
4359 void av_init_packet(AVPacket *pkt);
4362 * Allocate the payload of a packet and initialize its fields with
4366 * @param size wanted payload size
4367 * @return 0 if OK, AVERROR_xxx otherwise
4369 int av_new_packet(AVPacket *pkt, int size);
4372 * Reduce packet size, correctly zeroing padding
4375 * @param size new size
4377 void av_shrink_packet(AVPacket *pkt, int size);
4380 * Increase packet size, correctly zeroing padding
4383 * @param grow_by number of bytes by which to increase the size of the packet
4385 int av_grow_packet(AVPacket *pkt, int grow_by);
4388 * Initialize a reference-counted packet from av_malloc()ed data.
4390 * @param pkt packet to be initialized. This function will set the data, size,
4391 * buf and destruct fields, all others are left untouched.
4392 * @param data Data allocated by av_malloc() to be used as packet data. If this
4393 * function returns successfully, the data is owned by the underlying AVBuffer.
4394 * The caller may not access the data through other means.
4395 * @param size size of data in bytes, without the padding. I.e. the full buffer
4396 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4398 * @return 0 on success, a negative AVERROR on error
4400 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4402 #if FF_API_AVPACKET_OLD_API
4404 * @warning This is a hack - the packet memory allocation stuff is broken. The
4405 * packet is allocated if it was not really allocated.
4407 * @deprecated Use av_packet_ref
4409 attribute_deprecated
4410 int av_dup_packet(AVPacket *pkt);
4412 * Copy packet, including contents
4414 * @return 0 on success, negative AVERROR on fail
4416 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4419 * Copy packet side data
4421 * @return 0 on success, negative AVERROR on fail
4423 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4428 * @deprecated Use av_packet_unref
4430 * @param pkt packet to free
4432 attribute_deprecated
4433 void av_free_packet(AVPacket *pkt);
4436 * Allocate new information of a packet.
4439 * @param type side information type
4440 * @param size side information size
4441 * @return pointer to fresh allocated data or NULL otherwise
4443 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4447 * Wrap an existing array as a packet side data.
4450 * @param type side information type
4451 * @param data the side data array. It must be allocated with the av_malloc()
4452 * family of functions. The ownership of the data is transferred to
4454 * @param size side information size
4455 * @return a non-negative number on success, a negative AVERROR code on
4456 * failure. On failure, the packet is unchanged and the data remains
4457 * owned by the caller.
4459 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4460 uint8_t *data, size_t size);
4463 * Shrink the already allocated side data buffer
4466 * @param type side information type
4467 * @param size new side information size
4468 * @return 0 on success, < 0 on failure
4470 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4474 * Get side information from packet.
4477 * @param type desired side information type
4478 * @param size pointer for side information size to store (optional)
4479 * @return pointer to data if present or NULL otherwise
4481 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4484 int av_packet_merge_side_data(AVPacket *pkt);
4486 int av_packet_split_side_data(AVPacket *pkt);
4488 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4491 * Pack a dictionary for use in side_data.
4493 * @param dict The dictionary to pack.
4494 * @param size pointer to store the size of the returned data
4495 * @return pointer to data if successful, NULL otherwise
4497 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4499 * Unpack a dictionary from side_data.
4501 * @param data data from side_data
4502 * @param size size of the data
4503 * @param dict the metadata storage dictionary
4504 * @return 0 on success, < 0 on failure
4506 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4510 * Convenience function to free all the side data stored.
4511 * All the other fields stay untouched.
4515 void av_packet_free_side_data(AVPacket *pkt);
4518 * Setup a new reference to the data described by a given packet
4520 * If src is reference-counted, setup dst as a new reference to the
4521 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4522 * data from src into it.
4524 * All the other fields are copied from src.
4526 * @see av_packet_unref
4528 * @param dst Destination packet
4529 * @param src Source packet
4531 * @return 0 on success, a negative AVERROR on error.
4533 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4538 * Unreference the buffer referenced by the packet and reset the
4539 * remaining packet fields to their default values.
4541 * @param pkt The packet to be unreferenced.
4543 void av_packet_unref(AVPacket *pkt);
4546 * Move every field in src to dst and reset src.
4548 * @see av_packet_unref
4550 * @param src Source packet, will be reset
4551 * @param dst Destination packet
4553 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4556 * Copy only "properties" fields from src to dst.
4558 * Properties for the purpose of this function are all the fields
4559 * beside those related to the packet data (buf, data, size)
4561 * @param dst Destination packet
4562 * @param src Source packet
4564 * @return 0 on success AVERROR on failure.
4566 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4569 * Convert valid timing fields (timestamps / durations) in a packet from one
4570 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4573 * @param pkt packet on which the conversion will be performed
4574 * @param tb_src source timebase, in which the timing fields in pkt are
4576 * @param tb_dst destination timebase, to which the timing fields will be
4579 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4586 * @addtogroup lavc_decoding
4591 * Find a registered decoder with a matching codec ID.
4593 * @param id AVCodecID of the requested decoder
4594 * @return A decoder if one was found, NULL otherwise.
4596 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4599 * Find a registered decoder with the specified name.
4601 * @param name name of the requested decoder
4602 * @return A decoder if one was found, NULL otherwise.
4604 AVCodec *avcodec_find_decoder_by_name(const char *name);
4607 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4608 * it can be called by custom get_buffer2() implementations for decoders without
4609 * AV_CODEC_CAP_DR1 set.
4611 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4615 * Return the amount of padding in pixels which the get_buffer callback must
4616 * provide around the edge of the image for codecs which do not have the
4617 * CODEC_FLAG_EMU_EDGE flag.
4619 * @return Required padding in pixels.
4621 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4624 attribute_deprecated
4625 unsigned avcodec_get_edge_width(void);
4629 * Modify width and height values so that they will result in a memory
4630 * buffer that is acceptable for the codec if you do not use any horizontal
4633 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4635 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4638 * Modify width and height values so that they will result in a memory
4639 * buffer that is acceptable for the codec if you also ensure that all
4640 * line sizes are a multiple of the respective linesize_align[i].
4642 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4644 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4645 int linesize_align[AV_NUM_DATA_POINTERS]);
4648 * Converts AVChromaLocation to swscale x/y chroma position.
4650 * The positions represent the chroma (0,0) position in a coordinates system
4651 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4653 * @param xpos horizontal chroma sample position
4654 * @param ypos vertical chroma sample position
4656 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4659 * Converts swscale x/y chroma position to AVChromaLocation.
4661 * The positions represent the chroma (0,0) position in a coordinates system
4662 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4664 * @param xpos horizontal chroma sample position
4665 * @param ypos vertical chroma sample position
4667 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4670 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4672 * Some decoders may support multiple frames in a single AVPacket. Such
4673 * decoders would then just decode the first frame and the return value would be
4674 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4675 * called again with an AVPacket containing the remaining data in order to
4676 * decode the second frame, etc... Even if no frames are returned, the packet
4677 * needs to be fed to the decoder with remaining data until it is completely
4678 * consumed or an error occurs.
4680 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4681 * and output. This means that for some packets they will not immediately
4682 * produce decoded output and need to be flushed at the end of decoding to get
4683 * all the decoded data. Flushing is done by calling this function with packets
4684 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4685 * returning samples. It is safe to flush even those decoders that are not
4686 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4688 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4689 * larger than the actual read bytes because some optimized bitstream
4690 * readers read 32 or 64 bits at once and could read over the end.
4692 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4693 * before packets may be fed to the decoder.
4695 * @param avctx the codec context
4696 * @param[out] frame The AVFrame in which to store decoded audio samples.
4697 * The decoder will allocate a buffer for the decoded frame by
4698 * calling the AVCodecContext.get_buffer2() callback.
4699 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4700 * reference counted and the returned reference belongs to the
4701 * caller. The caller must release the frame using av_frame_unref()
4702 * when the frame is no longer needed. The caller may safely write
4703 * to the frame if av_frame_is_writable() returns 1.
4704 * When AVCodecContext.refcounted_frames is set to 0, the returned
4705 * reference belongs to the decoder and is valid only until the
4706 * next call to this function or until closing or flushing the
4707 * decoder. The caller may not write to it.
4708 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4709 * non-zero. Note that this field being set to zero
4710 * does not mean that an error has occurred. For
4711 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4712 * call is guaranteed to produce a frame.
4713 * @param[in] avpkt The input AVPacket containing the input buffer.
4714 * At least avpkt->data and avpkt->size should be set. Some
4715 * decoders might also require additional fields to be set.
4716 * @return A negative error code is returned if an error occurred during
4717 * decoding, otherwise the number of bytes consumed from the input
4718 * AVPacket is returned.
4720 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4722 attribute_deprecated
4723 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4724 int *got_frame_ptr, const AVPacket *avpkt);
4727 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4728 * Some decoders may support multiple frames in a single AVPacket, such
4729 * decoders would then just decode the first frame.
4731 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4732 * the actual read bytes because some optimized bitstream readers read 32 or 64
4733 * bits at once and could read over the end.
4735 * @warning The end of the input buffer buf should be set to 0 to ensure that
4736 * no overreading happens for damaged MPEG streams.
4738 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4739 * between input and output, these need to be fed with avpkt->data=NULL,
4740 * avpkt->size=0 at the end to return the remaining frames.
4742 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4743 * before packets may be fed to the decoder.
4745 * @param avctx the codec context
4746 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4747 * Use av_frame_alloc() to get an AVFrame. The codec will
4748 * allocate memory for the actual bitmap by calling the
4749 * AVCodecContext.get_buffer2() callback.
4750 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4751 * reference counted and the returned reference belongs to the
4752 * caller. The caller must release the frame using av_frame_unref()
4753 * when the frame is no longer needed. The caller may safely write
4754 * to the frame if av_frame_is_writable() returns 1.
4755 * When AVCodecContext.refcounted_frames is set to 0, the returned
4756 * reference belongs to the decoder and is valid only until the
4757 * next call to this function or until closing or flushing the
4758 * decoder. The caller may not write to it.
4760 * @param[in] avpkt The input AVPacket containing the input buffer.
4761 * You can create such packet with av_init_packet() and by then setting
4762 * data and size, some decoders might in addition need other fields like
4763 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4765 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4766 * @return On error a negative value is returned, otherwise the number of bytes
4767 * used or zero if no frame could be decompressed.
4769 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4771 attribute_deprecated
4772 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4773 int *got_picture_ptr,
4774 const AVPacket *avpkt);
4777 * Decode a subtitle message.
4778 * Return a negative value on error, otherwise return the number of bytes used.
4779 * If no subtitle could be decompressed, got_sub_ptr is zero.
4780 * Otherwise, the subtitle is stored in *sub.
4781 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4782 * simplicity, because the performance difference is expect to be negligible
4783 * and reusing a get_buffer written for video codecs would probably perform badly
4784 * due to a potentially very different allocation pattern.
4786 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4787 * and output. This means that for some packets they will not immediately
4788 * produce decoded output and need to be flushed at the end of decoding to get
4789 * all the decoded data. Flushing is done by calling this function with packets
4790 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4791 * returning subtitles. It is safe to flush even those decoders that are not
4792 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4794 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4795 * before packets may be fed to the decoder.
4797 * @param avctx the codec context
4798 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4799 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4800 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4801 * @param[in] avpkt The input AVPacket containing the input buffer.
4803 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4808 * Supply raw packet data as input to a decoder.
4810 * Internally, this call will copy relevant AVCodecContext fields, which can
4811 * influence decoding per-packet, and apply them when the packet is actually
4812 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4813 * decoder to drop the frame contained by the packet sent with this function.)
4815 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4816 * larger than the actual read bytes because some optimized bitstream
4817 * readers read 32 or 64 bits at once and could read over the end.
4819 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4820 * on the same AVCodecContext. It will return unexpected results now
4821 * or in future libavcodec versions.
4823 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4824 * before packets may be fed to the decoder.
4826 * @param avctx codec context
4827 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4828 * frame, or several complete audio frames.
4829 * Ownership of the packet remains with the caller, and the
4830 * decoder will not write to the packet. The decoder may create
4831 * a reference to the packet data (or copy it if the packet is
4832 * not reference-counted).
4833 * Unlike with older APIs, the packet is always fully consumed,
4834 * and if it contains multiple frames (e.g. some audio codecs),
4835 * will require you to call avcodec_receive_frame() multiple
4836 * times afterwards before you can send a new packet.
4837 * It can be NULL (or an AVPacket with data set to NULL and
4838 * size set to 0); in this case, it is considered a flush
4839 * packet, which signals the end of the stream. Sending the
4840 * first flush packet will return success. Subsequent ones are
4841 * unnecessary and will return AVERROR_EOF. If the decoder
4842 * still has frames buffered, it will return them after sending
4845 * @return 0 on success, otherwise negative error code:
4846 * AVERROR(EAGAIN): input is not accepted right now - the packet must be
4847 * resent after trying to read output
4848 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4849 * be sent to it (also returned if more than 1 flush
4851 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4852 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4853 * other errors: legitimate decoding errors
4855 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4858 * Return decoded output data from a decoder.
4860 * @param avctx codec context
4861 * @param frame This will be set to a reference-counted video or audio
4862 * frame (depending on the decoder type) allocated by the
4863 * decoder. Note that the function will always call
4864 * av_frame_unref(frame) before doing anything else.
4867 * 0: success, a frame was returned
4868 * AVERROR(EAGAIN): output is not available right now - user must try
4870 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4871 * no more output frames
4872 * AVERROR(EINVAL): codec not opened, or it is an encoder
4873 * other negative values: legitimate decoding errors
4875 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4878 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4879 * to retrieve buffered output packets.
4881 * @param avctx codec context
4882 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4883 * Ownership of the frame remains with the caller, and the
4884 * encoder will not write to the frame. The encoder may create
4885 * a reference to the frame data (or copy it if the frame is
4886 * not reference-counted).
4887 * It can be NULL, in which case it is considered a flush
4888 * packet. This signals the end of the stream. If the encoder
4889 * still has packets buffered, it will return them after this
4890 * call. Once flushing mode has been entered, additional flush
4891 * packets are ignored, and sending frames will return
4895 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4896 * can have any number of samples.
4897 * If it is not set, frame->nb_samples must be equal to
4898 * avctx->frame_size for all frames except the last.
4899 * The final frame may be smaller than avctx->frame_size.
4900 * @return 0 on success, otherwise negative error code:
4901 * AVERROR(EAGAIN): input is not accepted right now - the frame must be
4902 * resent after trying to read output packets
4903 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4905 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4906 * decoder, or requires flush
4907 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4908 * other errors: legitimate decoding errors
4910 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4913 * Read encoded data from the encoder.
4915 * @param avctx codec context
4916 * @param avpkt This will be set to a reference-counted packet allocated by the
4917 * encoder. Note that the function will always call
4918 * av_frame_unref(frame) before doing anything else.
4919 * @return 0 on success, otherwise negative error code:
4920 * AVERROR(EAGAIN): output is not available right now - user must try
4922 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4923 * no more output packets
4924 * AVERROR(EINVAL): codec not opened, or it is an encoder
4925 * other errors: legitimate decoding errors
4927 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4931 * @defgroup lavc_parsing Frame parsing
4935 enum AVPictureStructure {
4936 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4937 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4938 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4939 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4942 typedef struct AVCodecParserContext {
4944 struct AVCodecParser *parser;
4945 int64_t frame_offset; /* offset of the current frame */
4946 int64_t cur_offset; /* current offset
4947 (incremented by each av_parser_parse()) */
4948 int64_t next_frame_offset; /* offset of the next frame */
4950 int pict_type; /* XXX: Put it back in AVCodecContext. */
4952 * This field is used for proper frame duration computation in lavf.
4953 * It signals, how much longer the frame duration of the current frame
4954 * is compared to normal frame duration.
4956 * frame_duration = (1 + repeat_pict) * time_base
4958 * It is used by codecs like H.264 to display telecined material.
4960 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4961 int64_t pts; /* pts of the current frame */
4962 int64_t dts; /* dts of the current frame */
4967 int fetch_timestamp;
4969 #define AV_PARSER_PTS_NB 4
4970 int cur_frame_start_index;
4971 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4972 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4973 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4976 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4977 #define PARSER_FLAG_ONCE 0x0002
4978 /// Set if the parser has a valid file offset
4979 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4980 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4982 int64_t offset; ///< byte offset from starting packet start
4983 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4986 * Set by parser to 1 for key frames and 0 for non-key frames.
4987 * It is initialized to -1, so if the parser doesn't set this flag,
4988 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4993 #if FF_API_CONVERGENCE_DURATION
4995 * @deprecated unused
4997 attribute_deprecated
4998 int64_t convergence_duration;
5001 // Timestamp generation support:
5003 * Synchronization point for start of timestamp generation.
5005 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5008 * For example, this corresponds to presence of H.264 buffering period
5014 * Offset of the current timestamp against last timestamp sync point in
5015 * units of AVCodecContext.time_base.
5017 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5018 * contain a valid timestamp offset.
5020 * Note that the timestamp of sync point has usually a nonzero
5021 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5022 * the next frame after timestamp sync point will be usually 1.
5024 * For example, this corresponds to H.264 cpb_removal_delay.
5026 int dts_ref_dts_delta;
5029 * Presentation delay of current frame in units of AVCodecContext.time_base.
5031 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5032 * contain valid non-negative timestamp delta (presentation time of a frame
5033 * must not lie in the past).
5035 * This delay represents the difference between decoding and presentation
5036 * time of the frame.
5038 * For example, this corresponds to H.264 dpb_output_delay.
5043 * Position of the packet in file.
5045 * Analogous to cur_frame_pts/dts
5047 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5050 * Byte position of currently parsed frame in stream.
5055 * Previous frame byte position.
5060 * Duration of the current frame.
5061 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5062 * For all other types, this is in units of AVCodecContext.time_base.
5066 enum AVFieldOrder field_order;
5069 * Indicate whether a picture is coded as a frame, top field or bottom field.
5071 * For example, H.264 field_pic_flag equal to 0 corresponds to
5072 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5073 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5074 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5076 enum AVPictureStructure picture_structure;
5079 * Picture number incremented in presentation or output order.
5080 * This field may be reinitialized at the first picture of a new sequence.
5082 * For example, this corresponds to H.264 PicOrderCnt.
5084 int output_picture_number;
5087 * Dimensions of the decoded video intended for presentation.
5093 * Dimensions of the coded video.
5099 * The format of the coded data, corresponds to enum AVPixelFormat for video
5100 * and for enum AVSampleFormat for audio.
5102 * Note that a decoder can have considerable freedom in how exactly it
5103 * decodes the data, so the format reported here might be different from the
5104 * one returned by a decoder.
5107 } AVCodecParserContext;
5109 typedef struct AVCodecParser {
5110 int codec_ids[5]; /* several codec IDs are permitted */
5112 int (*parser_init)(AVCodecParserContext *s);
5113 /* This callback never returns an error, a negative value means that
5114 * the frame start was in a previous packet. */
5115 int (*parser_parse)(AVCodecParserContext *s,
5116 AVCodecContext *avctx,
5117 const uint8_t **poutbuf, int *poutbuf_size,
5118 const uint8_t *buf, int buf_size);
5119 void (*parser_close)(AVCodecParserContext *s);
5120 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5121 struct AVCodecParser *next;
5124 AVCodecParser *av_parser_next(const AVCodecParser *c);
5126 void av_register_codec_parser(AVCodecParser *parser);
5127 AVCodecParserContext *av_parser_init(int codec_id);
5132 * @param s parser context.
5133 * @param avctx codec context.
5134 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5135 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5136 * @param buf input buffer.
5137 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
5138 * @param pts input presentation timestamp.
5139 * @param dts input decoding timestamp.
5140 * @param pos input byte position in stream.
5141 * @return the number of bytes of the input bitstream used.
5146 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5153 * decode_frame(data, size);
5157 int av_parser_parse2(AVCodecParserContext *s,
5158 AVCodecContext *avctx,
5159 uint8_t **poutbuf, int *poutbuf_size,
5160 const uint8_t *buf, int buf_size,
5161 int64_t pts, int64_t dts,
5165 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5166 * @deprecated use AVBitStreamFilter
5168 int av_parser_change(AVCodecParserContext *s,
5169 AVCodecContext *avctx,
5170 uint8_t **poutbuf, int *poutbuf_size,
5171 const uint8_t *buf, int buf_size, int keyframe);
5172 void av_parser_close(AVCodecParserContext *s);
5180 * @addtogroup lavc_encoding
5185 * Find a registered encoder with a matching codec ID.
5187 * @param id AVCodecID of the requested encoder
5188 * @return An encoder if one was found, NULL otherwise.
5190 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5193 * Find a registered encoder with the specified name.
5195 * @param name name of the requested encoder
5196 * @return An encoder if one was found, NULL otherwise.
5198 AVCodec *avcodec_find_encoder_by_name(const char *name);
5201 * Encode a frame of audio.
5203 * Takes input samples from frame and writes the next output packet, if
5204 * available, to avpkt. The output packet does not necessarily contain data for
5205 * the most recent frame, as encoders can delay, split, and combine input frames
5206 * internally as needed.
5208 * @param avctx codec context
5209 * @param avpkt output AVPacket.
5210 * The user can supply an output buffer by setting
5211 * avpkt->data and avpkt->size prior to calling the
5212 * function, but if the size of the user-provided data is not
5213 * large enough, encoding will fail. If avpkt->data and
5214 * avpkt->size are set, avpkt->destruct must also be set. All
5215 * other AVPacket fields will be reset by the encoder using
5216 * av_init_packet(). If avpkt->data is NULL, the encoder will
5217 * allocate it. The encoder will set avpkt->size to the size
5218 * of the output packet.
5220 * If this function fails or produces no output, avpkt will be
5221 * freed using av_packet_unref().
5222 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5223 * May be NULL when flushing an encoder that has the
5224 * AV_CODEC_CAP_DELAY capability set.
5225 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5226 * can have any number of samples.
5227 * If it is not set, frame->nb_samples must be equal to
5228 * avctx->frame_size for all frames except the last.
5229 * The final frame may be smaller than avctx->frame_size.
5230 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5231 * output packet is non-empty, and to 0 if it is
5232 * empty. If the function returns an error, the
5233 * packet can be assumed to be invalid, and the
5234 * value of got_packet_ptr is undefined and should
5236 * @return 0 on success, negative error code on failure
5238 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5240 attribute_deprecated
5241 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5242 const AVFrame *frame, int *got_packet_ptr);
5245 * Encode a frame of video.
5247 * Takes input raw video data from frame and writes the next output packet, if
5248 * available, to avpkt. The output packet does not necessarily contain data for
5249 * the most recent frame, as encoders can delay and reorder input frames
5250 * internally as needed.
5252 * @param avctx codec context
5253 * @param avpkt output AVPacket.
5254 * The user can supply an output buffer by setting
5255 * avpkt->data and avpkt->size prior to calling the
5256 * function, but if the size of the user-provided data is not
5257 * large enough, encoding will fail. All other AVPacket fields
5258 * will be reset by the encoder using av_init_packet(). If
5259 * avpkt->data is NULL, the encoder will allocate it.
5260 * The encoder will set avpkt->size to the size of the
5261 * output packet. The returned data (if any) belongs to the
5262 * caller, he is responsible for freeing it.
5264 * If this function fails or produces no output, avpkt will be
5265 * freed using av_packet_unref().
5266 * @param[in] frame AVFrame containing the raw video data to be encoded.
5267 * May be NULL when flushing an encoder that has the
5268 * AV_CODEC_CAP_DELAY capability set.
5269 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5270 * output packet is non-empty, and to 0 if it is
5271 * empty. If the function returns an error, the
5272 * packet can be assumed to be invalid, and the
5273 * value of got_packet_ptr is undefined and should
5275 * @return 0 on success, negative error code on failure
5277 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5279 attribute_deprecated
5280 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5281 const AVFrame *frame, int *got_packet_ptr);
5283 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5284 const AVSubtitle *sub);
5291 #if FF_API_AVCODEC_RESAMPLE
5293 * @defgroup lavc_resample Audio resampling
5295 * @deprecated use libswresample instead
5299 struct ReSampleContext;
5300 struct AVResampleContext;
5302 typedef struct ReSampleContext ReSampleContext;
5305 * Initialize audio resampling context.
5307 * @param output_channels number of output channels
5308 * @param input_channels number of input channels
5309 * @param output_rate output sample rate
5310 * @param input_rate input sample rate
5311 * @param sample_fmt_out requested output sample format
5312 * @param sample_fmt_in input sample format
5313 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5314 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5315 * @param linear if 1 then the used FIR filter will be linearly interpolated
5316 between the 2 closest, if 0 the closest will be used
5317 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5318 * @return allocated ReSampleContext, NULL if error occurred
5320 attribute_deprecated
5321 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5322 int output_rate, int input_rate,
5323 enum AVSampleFormat sample_fmt_out,
5324 enum AVSampleFormat sample_fmt_in,
5325 int filter_length, int log2_phase_count,
5326 int linear, double cutoff);
5328 attribute_deprecated
5329 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5332 * Free resample context.
5334 * @param s a non-NULL pointer to a resample context previously
5335 * created with av_audio_resample_init()
5337 attribute_deprecated
5338 void audio_resample_close(ReSampleContext *s);
5342 * Initialize an audio resampler.
5343 * Note, if either rate is not an integer then simply scale both rates up so they are.
5344 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5345 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5346 * @param linear If 1 then the used FIR filter will be linearly interpolated
5347 between the 2 closest, if 0 the closest will be used
5348 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5350 attribute_deprecated
5351 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5354 * Resample an array of samples using a previously configured context.
5355 * @param src an array of unconsumed samples
5356 * @param consumed the number of samples of src which have been consumed are returned here
5357 * @param src_size the number of unconsumed samples available
5358 * @param dst_size the amount of space in samples available in dst
5359 * @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.
5360 * @return the number of samples written in dst or -1 if an error occurred
5362 attribute_deprecated
5363 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5367 * Compensate samplerate/timestamp drift. The compensation is done by changing
5368 * the resampler parameters, so no audible clicks or similar distortions occur
5369 * @param compensation_distance distance in output samples over which the compensation should be performed
5370 * @param sample_delta number of output samples which should be output less
5372 * example: av_resample_compensate(c, 10, 500)
5373 * here instead of 510 samples only 500 samples would be output
5375 * note, due to rounding the actual compensation might be slightly different,
5376 * especially if the compensation_distance is large and the in_rate used during init is small
5378 attribute_deprecated
5379 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5380 attribute_deprecated
5381 void av_resample_close(struct AVResampleContext *c);
5388 #if FF_API_AVPICTURE
5390 * @addtogroup lavc_picture
5395 * @deprecated unused
5397 attribute_deprecated
5398 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5401 * @deprecated unused
5403 attribute_deprecated
5404 void avpicture_free(AVPicture *picture);
5407 * @deprecated use av_image_fill_arrays() instead.
5409 attribute_deprecated
5410 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5411 enum AVPixelFormat pix_fmt, int width, int height);
5414 * @deprecated use av_image_copy_to_buffer() instead.
5416 attribute_deprecated
5417 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5418 int width, int height,
5419 unsigned char *dest, int dest_size);
5422 * @deprecated use av_image_get_buffer_size() instead.
5424 attribute_deprecated
5425 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5428 * @deprecated av_image_copy() instead.
5430 attribute_deprecated
5431 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5432 enum AVPixelFormat pix_fmt, int width, int height);
5435 * @deprecated unused
5437 attribute_deprecated
5438 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5439 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5442 * @deprecated unused
5444 attribute_deprecated
5445 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5446 int padtop, int padbottom, int padleft, int padright, int *color);
5454 * @defgroup lavc_misc Utility functions
5457 * Miscellaneous utility functions related to both encoding and decoding
5463 * @defgroup lavc_misc_pixfmt Pixel formats
5465 * Functions for working with pixel formats.
5470 * Utility function to access log2_chroma_w log2_chroma_h from
5471 * the pixel format AVPixFmtDescriptor.
5473 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5474 * for one that returns a failure code and continues in case of invalid
5477 * @param[in] pix_fmt the pixel format
5478 * @param[out] h_shift store log2_chroma_w
5479 * @param[out] v_shift store log2_chroma_h
5481 * @see av_pix_fmt_get_chroma_sub_sample
5484 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5487 * Return a value representing the fourCC code associated to the
5488 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5491 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5494 * @deprecated see av_get_pix_fmt_loss()
5496 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5500 * Find the best pixel format to convert to given a certain source pixel
5501 * format. When converting from one pixel format to another, information loss
5502 * may occur. For example, when converting from RGB24 to GRAY, the color
5503 * information will be lost. Similarly, other losses occur when converting from
5504 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5505 * the given pixel formats should be used to suffer the least amount of loss.
5506 * The pixel formats from which it chooses one, are determined by the
5507 * pix_fmt_list parameter.
5510 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5511 * @param[in] src_pix_fmt source pixel format
5512 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5513 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5514 * @return The best pixel format to convert to or -1 if none was found.
5516 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5517 enum AVPixelFormat src_pix_fmt,
5518 int has_alpha, int *loss_ptr);
5521 * @deprecated see av_find_best_pix_fmt_of_2()
5523 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5524 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5526 attribute_deprecated
5527 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
5528 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
5529 enum AVPixelFormat src_pix_fmt,
5530 int has_alpha, int *loss_ptr);
5532 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5533 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5537 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5543 #if FF_API_SET_DIMENSIONS
5545 * @deprecated this function is not supposed to be used from outside of lavc
5547 attribute_deprecated
5548 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5552 * Put a string representing the codec tag codec_tag in buf.
5554 * @param buf buffer to place codec tag in
5555 * @param buf_size size in bytes of buf
5556 * @param codec_tag codec tag to assign
5557 * @return the length of the string that would have been generated if
5558 * enough space had been available, excluding the trailing null
5560 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5562 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5565 * Return a name for the specified profile, if available.
5567 * @param codec the codec that is searched for the given profile
5568 * @param profile the profile value for which a name is requested
5569 * @return A name for the profile if found, NULL otherwise.
5571 const char *av_get_profile_name(const AVCodec *codec, int profile);
5574 * Return a name for the specified profile, if available.
5576 * @param codec_id the ID of the codec to which the requested profile belongs
5577 * @param profile the profile value for which a name is requested
5578 * @return A name for the profile if found, NULL otherwise.
5580 * @note unlike av_get_profile_name(), which searches a list of profiles
5581 * supported by a specific decoder or encoder implementation, this
5582 * function searches the list of profiles from the AVCodecDescriptor
5584 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5586 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5587 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5588 //FIXME func typedef
5591 * Fill AVFrame audio data and linesize pointers.
5593 * The buffer buf must be a preallocated buffer with a size big enough
5594 * to contain the specified samples amount. The filled AVFrame data
5595 * pointers will point to this buffer.
5597 * AVFrame extended_data channel pointers are allocated if necessary for
5600 * @param frame the AVFrame
5601 * frame->nb_samples must be set prior to calling the
5602 * function. This function fills in frame->data,
5603 * frame->extended_data, frame->linesize[0].
5604 * @param nb_channels channel count
5605 * @param sample_fmt sample format
5606 * @param buf buffer to use for frame data
5607 * @param buf_size size of buffer
5608 * @param align plane size sample alignment (0 = default)
5609 * @return >=0 on success, negative error code on failure
5610 * @todo return the size in bytes required to store the samples in
5611 * case of success, at the next libavutil bump
5613 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5614 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5615 int buf_size, int align);
5618 * Reset the internal decoder state / flush internal buffers. Should be called
5619 * e.g. when seeking or when switching to a different stream.
5621 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5622 * this invalidates the frames previously returned from the decoder. When
5623 * refcounted frames are used, the decoder just releases any references it might
5624 * keep internally, but the caller's reference remains valid.
5626 void avcodec_flush_buffers(AVCodecContext *avctx);
5629 * Return codec bits per sample.
5631 * @param[in] codec_id the codec
5632 * @return Number of bits per sample or zero if unknown for the given codec.
5634 int av_get_bits_per_sample(enum AVCodecID codec_id);
5637 * Return the PCM codec associated with a sample format.
5638 * @param be endianness, 0 for little, 1 for big,
5639 * -1 (or anything else) for native
5640 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5642 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5645 * Return codec bits per sample.
5646 * Only return non-zero if the bits per sample is exactly correct, not an
5649 * @param[in] codec_id the codec
5650 * @return Number of bits per sample or zero if unknown for the given codec.
5652 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5655 * Return audio frame duration.
5657 * @param avctx codec context
5658 * @param frame_bytes size of the frame, or 0 if unknown
5659 * @return frame duration, in samples, if known. 0 if not able to
5662 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5665 * This function is the same as av_get_audio_frame_duration(), except it works
5666 * with AVCodecParameters instead of an AVCodecContext.
5668 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5671 typedef struct AVBitStreamFilterContext {
5673 struct AVBitStreamFilter *filter;
5674 AVCodecParserContext *parser;
5675 struct AVBitStreamFilterContext *next;
5677 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5678 * Not for access by library users.
5681 } AVBitStreamFilterContext;
5684 typedef struct AVBSFInternal AVBSFInternal;
5687 * The bitstream filter state.
5689 * This struct must be allocated with av_bsf_alloc() and freed with
5692 * The fields in the struct will only be changed (by the caller or by the
5693 * filter) as described in their documentation, and are to be considered
5694 * immutable otherwise.
5696 typedef struct AVBSFContext {
5698 * A class for logging and AVOptions
5700 const AVClass *av_class;
5703 * The bitstream filter this context is an instance of.
5705 const struct AVBitStreamFilter *filter;
5708 * Opaque libavcodec internal data. Must not be touched by the caller in any
5711 AVBSFInternal *internal;
5714 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5715 * this is an AVOptions-enabled struct.
5720 * Parameters of the input stream. Set by the caller before av_bsf_init().
5722 AVCodecParameters *par_in;
5725 * Parameters of the output stream. Set by the filter in av_bsf_init().
5727 AVCodecParameters *par_out;
5730 * The timebase used for the timestamps of the input packets. Set by the
5731 * caller before av_bsf_init().
5733 AVRational time_base_in;
5736 * The timebase used for the timestamps of the output packets. Set by the
5737 * filter in av_bsf_init().
5739 AVRational time_base_out;
5742 typedef struct AVBitStreamFilter {
5746 * A list of codec ids supported by the filter, terminated by
5748 * May be NULL, in that case the bitstream filter works with any codec id.
5750 const enum AVCodecID *codec_ids;
5753 * A class for the private data, used to declare bitstream filter private
5754 * AVOptions. This field is NULL for bitstream filters that do not declare
5757 * If this field is non-NULL, the first member of the filter private data
5758 * must be a pointer to AVClass, which will be set by libavcodec generic
5759 * code to this class.
5761 const AVClass *priv_class;
5763 /*****************************************************************
5764 * No fields below this line are part of the public API. They
5765 * may not be used outside of libavcodec and can be changed and
5767 * New public fields should be added right above.
5768 *****************************************************************
5772 int (*init)(AVBSFContext *ctx);
5773 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5774 void (*close)(AVBSFContext *ctx);
5775 } AVBitStreamFilter;
5779 * Register a bitstream filter.
5781 * The filter will be accessible to the application code through
5782 * av_bitstream_filter_next() or can be directly initialized with
5783 * av_bitstream_filter_init().
5785 * @see avcodec_register_all()
5787 attribute_deprecated
5788 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5791 * Create and initialize a bitstream filter context given a bitstream
5794 * The returned context must be freed with av_bitstream_filter_close().
5796 * @param name the name of the bitstream filter
5797 * @return a bitstream filter context if a matching filter was found
5798 * and successfully initialized, NULL otherwise
5800 attribute_deprecated
5801 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5806 * This function filters the buffer buf with size buf_size, and places the
5807 * filtered buffer in the buffer pointed to by poutbuf.
5809 * The output buffer must be freed by the caller.
5811 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5812 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5813 * If specified, this must point to the encoder context of the
5814 * output stream the packet is sent to.
5815 * @param args arguments which specify the filter configuration, may be NULL
5816 * @param poutbuf pointer which is updated to point to the filtered buffer
5817 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5818 * @param buf buffer containing the data to filter
5819 * @param buf_size size in bytes of buf
5820 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5821 * @return >= 0 in case of success, or a negative error code in case of failure
5823 * If the return value is positive, an output buffer is allocated and
5824 * is available in *poutbuf, and is distinct from the input buffer.
5826 * If the return value is 0, the output buffer is not allocated and
5827 * should be considered identical to the input buffer, or in case
5828 * *poutbuf was set it points to the input buffer (not necessarily to
5829 * its starting address). A special case is if *poutbuf was set to NULL and
5830 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5832 attribute_deprecated
5833 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5834 AVCodecContext *avctx, const char *args,
5835 uint8_t **poutbuf, int *poutbuf_size,
5836 const uint8_t *buf, int buf_size, int keyframe);
5839 * Release bitstream filter context.
5841 * @param bsf the bitstream filter context created with
5842 * av_bitstream_filter_init(), can be NULL
5844 attribute_deprecated
5845 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5848 * If f is NULL, return the first registered bitstream filter,
5849 * if f is non-NULL, return the next registered bitstream filter
5850 * after f, or NULL if f is the last one.
5852 * This function can be used to iterate over all registered bitstream
5855 attribute_deprecated
5856 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5860 * @return a bitstream filter with the specified name or NULL if no such
5861 * bitstream filter exists.
5863 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5866 * Iterate over all registered bitstream filters.
5868 * @param opaque a pointer where libavcodec will store the iteration state. Must
5869 * point to NULL to start the iteration.
5871 * @return the next registered bitstream filter or NULL when the iteration is
5874 const AVBitStreamFilter *av_bsf_next(void **opaque);
5877 * Allocate a context for a given bitstream filter. The caller must fill in the
5878 * context parameters as described in the documentation and then call
5879 * av_bsf_init() before sending any data to the filter.
5881 * @param filter the filter for which to allocate an instance.
5882 * @param ctx a pointer into which the pointer to the newly-allocated context
5883 * will be written. It must be freed with av_bsf_free() after the
5884 * filtering is done.
5886 * @return 0 on success, a negative AVERROR code on failure
5888 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5891 * Prepare the filter for use, after all the parameters and options have been
5894 int av_bsf_init(AVBSFContext *ctx);
5897 * Submit a packet for filtering.
5899 * After sending each packet, the filter must be completely drained by calling
5900 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5903 * @param pkt the packet to filter. The bitstream filter will take ownership of
5904 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5905 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5906 * packets will be sent). That will cause the filter to output any packets it
5907 * may have buffered internally.
5909 * @return 0 on success, a negative AVERROR on error.
5911 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5914 * Retrieve a filtered packet.
5916 * @param[out] pkt this struct will be filled with the contents of the filtered
5917 * packet. It is owned by the caller and must be freed using
5918 * av_packet_unref() when it is no longer needed.
5919 * This parameter should be "clean" (i.e. freshly allocated
5920 * with av_packet_alloc() or unreffed with av_packet_unref())
5921 * when this function is called. If this function returns
5922 * successfully, the contents of pkt will be completely
5923 * overwritten by the returned data. On failure, pkt is not
5926 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5927 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5928 * will be no further output from the filter. Another negative AVERROR value if
5931 * @note one input packet may result in several output packets, so after sending
5932 * a packet with av_bsf_send_packet(), this function needs to be called
5933 * repeatedly until it stops returning 0. It is also possible for a filter to
5934 * output fewer packets than were sent to it, so this function may return
5935 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5937 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5940 * Free a bitstream filter context and everything associated with it; write NULL
5941 * into the supplied pointer.
5943 void av_bsf_free(AVBSFContext **ctx);
5946 * Get the AVClass for AVBSFContext. It can be used in combination with
5947 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5949 * @see av_opt_find().
5951 const AVClass *av_bsf_get_class(void);
5956 * Same behaviour av_fast_malloc but the buffer has additional
5957 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5959 * In addition the whole buffer will initially and after resizes
5960 * be 0-initialized so that no uninitialized data will ever appear.
5962 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5965 * Same behaviour av_fast_padded_malloc except that buffer will always
5966 * be 0-initialized after call.
5968 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5971 * Encode extradata length to a buffer. Used by xiph codecs.
5973 * @param s buffer to write to; must be at least (v/255+1) bytes long
5974 * @param v size of extradata in bytes
5975 * @return number of bytes written to the buffer.
5977 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5979 #if FF_API_MISSING_SAMPLE
5981 * Log a generic warning message about a missing feature. This function is
5982 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5983 * only, and would normally not be used by applications.
5984 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5985 * a pointer to an AVClass struct
5986 * @param[in] feature string containing the name of the missing feature
5987 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5988 * If want_sample is non-zero, additional verbiage will be added to the log
5989 * message which tells the user how to report samples to the development
5991 * @deprecated Use avpriv_report_missing_feature() instead.
5993 attribute_deprecated
5994 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5997 * Log a generic warning message asking for a sample. This function is
5998 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5999 * only, and would normally not be used by applications.
6000 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6001 * a pointer to an AVClass struct
6002 * @param[in] msg string containing an optional message, or NULL if no message
6003 * @deprecated Use avpriv_request_sample() instead.
6005 attribute_deprecated
6006 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
6007 #endif /* FF_API_MISSING_SAMPLE */
6010 * Register the hardware accelerator hwaccel.
6012 void av_register_hwaccel(AVHWAccel *hwaccel);
6015 * If hwaccel is NULL, returns the first registered hardware accelerator,
6016 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6017 * after hwaccel, or NULL if hwaccel is the last one.
6019 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6023 * Lock operation used by lockmgr
6026 AV_LOCK_CREATE, ///< Create a mutex
6027 AV_LOCK_OBTAIN, ///< Lock the mutex
6028 AV_LOCK_RELEASE, ///< Unlock the mutex
6029 AV_LOCK_DESTROY, ///< Free mutex resources
6033 * Register a user provided lock manager supporting the operations
6034 * specified by AVLockOp. The "mutex" argument to the function points
6035 * to a (void *) where the lockmgr should store/get a pointer to a user
6036 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6037 * value left by the last call for all other ops. If the lock manager is
6038 * unable to perform the op then it should leave the mutex in the same
6039 * state as when it was called and return a non-zero value. However,
6040 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6041 * have been successfully destroyed. If av_lockmgr_register succeeds
6042 * it will return a non-negative value, if it fails it will return a
6043 * negative value and destroy all mutex and unregister all callbacks.
6044 * av_lockmgr_register is not thread-safe, it must be called from a
6045 * single thread before any calls which make use of locking are used.
6047 * @param cb User defined callback. av_lockmgr_register invokes calls
6048 * to this callback and the previously registered callback.
6049 * The callback will be used to create more than one mutex
6050 * each of which must be backed by its own underlying locking
6051 * mechanism (i.e. do not use a single static object to
6052 * implement your lock manager). If cb is set to NULL the
6053 * lockmgr will be unregistered.
6055 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6058 * Get the type of the given codec.
6060 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6063 * Get the name of a codec.
6064 * @return a static string identifying the codec; never NULL
6066 const char *avcodec_get_name(enum AVCodecID id);
6069 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6070 * with no corresponding avcodec_close()), 0 otherwise.
6072 int avcodec_is_open(AVCodecContext *s);
6075 * @return a non-zero number if codec is an encoder, zero otherwise
6077 int av_codec_is_encoder(const AVCodec *codec);
6080 * @return a non-zero number if codec is a decoder, zero otherwise
6082 int av_codec_is_decoder(const AVCodec *codec);
6085 * @return descriptor for given codec ID or NULL if no descriptor exists.
6087 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6090 * Iterate over all codec descriptors known to libavcodec.
6092 * @param prev previous descriptor. NULL to get the first descriptor.
6094 * @return next descriptor or NULL after the last descriptor
6096 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6099 * @return codec descriptor with the given name or NULL if no such descriptor
6102 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6105 * Allocate a CPB properties structure and initialize its fields to default
6108 * @param size if non-NULL, the size of the allocated struct will be written
6109 * here. This is useful for embedding it in side data.
6111 * @return the newly allocated struct or NULL on failure
6113 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6119 #endif /* AVCODEC_AVCODEC_H */