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,
416 /* various PCM "codecs" */
417 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
418 AV_CODEC_ID_PCM_S16LE = 0x10000,
419 AV_CODEC_ID_PCM_S16BE,
420 AV_CODEC_ID_PCM_U16LE,
421 AV_CODEC_ID_PCM_U16BE,
424 AV_CODEC_ID_PCM_MULAW,
425 AV_CODEC_ID_PCM_ALAW,
426 AV_CODEC_ID_PCM_S32LE,
427 AV_CODEC_ID_PCM_S32BE,
428 AV_CODEC_ID_PCM_U32LE,
429 AV_CODEC_ID_PCM_U32BE,
430 AV_CODEC_ID_PCM_S24LE,
431 AV_CODEC_ID_PCM_S24BE,
432 AV_CODEC_ID_PCM_U24LE,
433 AV_CODEC_ID_PCM_U24BE,
434 AV_CODEC_ID_PCM_S24DAUD,
435 AV_CODEC_ID_PCM_ZORK,
436 AV_CODEC_ID_PCM_S16LE_PLANAR,
438 AV_CODEC_ID_PCM_F32BE,
439 AV_CODEC_ID_PCM_F32LE,
440 AV_CODEC_ID_PCM_F64BE,
441 AV_CODEC_ID_PCM_F64LE,
442 AV_CODEC_ID_PCM_BLURAY,
445 AV_CODEC_ID_PCM_S8_PLANAR,
446 AV_CODEC_ID_PCM_S24LE_PLANAR,
447 AV_CODEC_ID_PCM_S32LE_PLANAR,
448 AV_CODEC_ID_PCM_S16BE_PLANAR,
450 AV_CODEC_ID_PCM_S64LE = 0x10800,
451 AV_CODEC_ID_PCM_S64BE,
452 AV_CODEC_ID_PCM_F16LE,
453 AV_CODEC_ID_PCM_F24LE,
455 /* various ADPCM codecs */
456 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
457 AV_CODEC_ID_ADPCM_IMA_WAV,
458 AV_CODEC_ID_ADPCM_IMA_DK3,
459 AV_CODEC_ID_ADPCM_IMA_DK4,
460 AV_CODEC_ID_ADPCM_IMA_WS,
461 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
462 AV_CODEC_ID_ADPCM_MS,
463 AV_CODEC_ID_ADPCM_4XM,
464 AV_CODEC_ID_ADPCM_XA,
465 AV_CODEC_ID_ADPCM_ADX,
466 AV_CODEC_ID_ADPCM_EA,
467 AV_CODEC_ID_ADPCM_G726,
468 AV_CODEC_ID_ADPCM_CT,
469 AV_CODEC_ID_ADPCM_SWF,
470 AV_CODEC_ID_ADPCM_YAMAHA,
471 AV_CODEC_ID_ADPCM_SBPRO_4,
472 AV_CODEC_ID_ADPCM_SBPRO_3,
473 AV_CODEC_ID_ADPCM_SBPRO_2,
474 AV_CODEC_ID_ADPCM_THP,
475 AV_CODEC_ID_ADPCM_IMA_AMV,
476 AV_CODEC_ID_ADPCM_EA_R1,
477 AV_CODEC_ID_ADPCM_EA_R3,
478 AV_CODEC_ID_ADPCM_EA_R2,
479 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
480 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
481 AV_CODEC_ID_ADPCM_EA_XAS,
482 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
483 AV_CODEC_ID_ADPCM_IMA_ISS,
484 AV_CODEC_ID_ADPCM_G722,
485 AV_CODEC_ID_ADPCM_IMA_APC,
486 AV_CODEC_ID_ADPCM_VIMA,
487 #if FF_API_VIMA_DECODER
488 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
491 AV_CODEC_ID_ADPCM_AFC = 0x11800,
492 AV_CODEC_ID_ADPCM_IMA_OKI,
493 AV_CODEC_ID_ADPCM_DTK,
494 AV_CODEC_ID_ADPCM_IMA_RAD,
495 AV_CODEC_ID_ADPCM_G726LE,
496 AV_CODEC_ID_ADPCM_THP_LE,
497 AV_CODEC_ID_ADPCM_PSX,
498 AV_CODEC_ID_ADPCM_AICA,
499 AV_CODEC_ID_ADPCM_IMA_DAT4,
500 AV_CODEC_ID_ADPCM_MTAF,
503 AV_CODEC_ID_AMR_NB = 0x12000,
506 /* RealAudio codecs*/
507 AV_CODEC_ID_RA_144 = 0x13000,
510 /* various DPCM codecs */
511 AV_CODEC_ID_ROQ_DPCM = 0x14000,
512 AV_CODEC_ID_INTERPLAY_DPCM,
513 AV_CODEC_ID_XAN_DPCM,
514 AV_CODEC_ID_SOL_DPCM,
516 AV_CODEC_ID_SDX2_DPCM = 0x14800,
519 AV_CODEC_ID_MP2 = 0x15000,
520 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
530 AV_CODEC_ID_VMDAUDIO,
536 AV_CODEC_ID_WESTWOOD_SND1,
537 AV_CODEC_ID_GSM, ///< as in Berlin toast format
540 AV_CODEC_ID_TRUESPEECH,
542 AV_CODEC_ID_SMACKAUDIO,
545 AV_CODEC_ID_DSICINAUDIO,
547 AV_CODEC_ID_MUSEPACK7,
549 AV_CODEC_ID_GSM_MS, /* as found in WAV */
555 AV_CODEC_ID_NELLYMOSER,
556 AV_CODEC_ID_MUSEPACK8,
558 AV_CODEC_ID_WMAVOICE,
560 AV_CODEC_ID_WMALOSSLESS,
569 AV_CODEC_ID_BINKAUDIO_RDFT,
570 AV_CODEC_ID_BINKAUDIO_DCT,
571 AV_CODEC_ID_AAC_LATM,
576 AV_CODEC_ID_8SVX_EXP,
577 AV_CODEC_ID_8SVX_FIB,
578 AV_CODEC_ID_BMV_AUDIO,
583 AV_CODEC_ID_COMFORT_NOISE,
585 AV_CODEC_ID_METASOUND,
586 AV_CODEC_ID_PAF_AUDIO,
590 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
592 AV_CODEC_ID_SONIC_LS,
595 AV_CODEC_ID_DSD_LSBF,
596 AV_CODEC_ID_DSD_MSBF,
597 AV_CODEC_ID_DSD_LSBF_PLANAR,
598 AV_CODEC_ID_DSD_MSBF_PLANAR,
600 AV_CODEC_ID_INTERPLAY_ACM,
605 /* subtitle codecs */
606 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
607 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
608 AV_CODEC_ID_DVB_SUBTITLE,
609 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
612 AV_CODEC_ID_MOV_TEXT,
613 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
614 AV_CODEC_ID_DVB_TELETEXT,
617 AV_CODEC_ID_MICRODVD = 0x17800,
621 AV_CODEC_ID_REALTEXT,
623 AV_CODEC_ID_SUBVIEWER1,
624 AV_CODEC_ID_SUBVIEWER,
631 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
633 /* other specific kind of codecs (generally used for attachments) */
634 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
635 AV_CODEC_ID_TTF = 0x18000,
637 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
638 AV_CODEC_ID_BINTEXT = 0x18800,
642 AV_CODEC_ID_SMPTE_KLV,
644 AV_CODEC_ID_TIMED_ID3,
645 AV_CODEC_ID_BIN_DATA,
648 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
650 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
651 * stream (only used by libavformat) */
652 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
653 * stream (only used by libavformat) */
654 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
655 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
659 * This struct describes the properties of a single codec described by an
661 * @see avcodec_descriptor_get()
663 typedef struct AVCodecDescriptor {
665 enum AVMediaType type;
667 * Name of the codec described by this descriptor. It is non-empty and
668 * unique for each codec descriptor. It should contain alphanumeric
669 * characters and '_' only.
673 * A more descriptive name for this codec. May be NULL.
675 const char *long_name;
677 * Codec properties, a combination of AV_CODEC_PROP_* flags.
681 * MIME type(s) associated with the codec.
682 * May be NULL; if not, a NULL-terminated array of MIME types.
683 * The first item is always non-NULL and is the preferred MIME type.
685 const char *const *mime_types;
687 * If non-NULL, an array of profiles recognized for this codec.
688 * Terminated with FF_PROFILE_UNKNOWN.
690 const struct AVProfile *profiles;
694 * Codec uses only intra compression.
697 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
699 * Codec supports lossy compression. Audio and video codecs only.
700 * @note a codec may support both lossy and lossless
703 #define AV_CODEC_PROP_LOSSY (1 << 1)
705 * Codec supports lossless compression. Audio and video codecs only.
707 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
709 * Codec supports frame reordering. That is, the coded order (the order in which
710 * the encoded packets are output by the encoders / stored / input to the
711 * decoders) may be different from the presentation order of the corresponding
714 * For codecs that do not have this property set, PTS and DTS should always be
717 #define AV_CODEC_PROP_REORDER (1 << 3)
719 * Subtitle codec is bitmap based
720 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
722 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
724 * Subtitle codec is text based.
725 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
727 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
730 * @ingroup lavc_decoding
731 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
732 * This is mainly needed because some optimized bitstream readers read
733 * 32 or 64 bit at once and could read over the end.<br>
734 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
735 * MPEG bitstreams could cause overread and segfault.
737 #define AV_INPUT_BUFFER_PADDING_SIZE 32
740 * @ingroup lavc_encoding
741 * minimum encoding buffer size
742 * Used to avoid some checks during header writing.
744 #define AV_INPUT_BUFFER_MIN_SIZE 16384
746 #if FF_API_WITHOUT_PREFIX
748 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
750 #define FF_INPUT_BUFFER_PADDING_SIZE 32
753 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
755 #define FF_MIN_BUFFER_SIZE 16384
756 #endif /* FF_API_WITHOUT_PREFIX */
759 * @ingroup lavc_encoding
760 * motion estimation type.
761 * @deprecated use codec private option instead
763 #if FF_API_MOTION_EST
765 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
769 ME_EPZS, ///< enhanced predictive zonal search
770 ME_X1, ///< reserved for experiments
771 ME_HEX, ///< hexagon based search
772 ME_UMH, ///< uneven multi-hexagon search
773 ME_TESA, ///< transformed exhaustive search algorithm
774 ME_ITER=50, ///< iterative search
779 * @ingroup lavc_decoding
782 /* We leave some space between them for extensions (drop some
783 * keyframes for intra-only or drop just some bidir frames). */
784 AVDISCARD_NONE =-16, ///< discard nothing
785 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
786 AVDISCARD_NONREF = 8, ///< discard all non reference
787 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
788 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
789 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
790 AVDISCARD_ALL = 48, ///< discard all
793 enum AVAudioServiceType {
794 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
795 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
796 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
797 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
798 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
799 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
800 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
801 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
802 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
803 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
807 * @ingroup lavc_encoding
809 typedef struct RcOverride{
812 int qscale; // If this is 0 then quality_factor will be used instead.
813 float quality_factor;
816 #if FF_API_MAX_BFRAMES
818 * @deprecated there is no libavcodec-wide limit on the number of B-frames
820 #define FF_MAX_B_FRAMES 16
824 These flags can be passed in AVCodecContext.flags before initialization.
825 Note: Not everything is supported yet.
829 * Allow decoders to produce frames with data planes that are not aligned
830 * to CPU requirements (e.g. due to cropping).
832 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
836 #define AV_CODEC_FLAG_QSCALE (1 << 1)
838 * 4 MV per MB allowed / advanced prediction for H.263.
840 #define AV_CODEC_FLAG_4MV (1 << 2)
842 * Output even those frames that might be corrupted.
844 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
848 #define AV_CODEC_FLAG_QPEL (1 << 4)
850 * Use internal 2pass ratecontrol in first pass mode.
852 #define AV_CODEC_FLAG_PASS1 (1 << 9)
854 * Use internal 2pass ratecontrol in second pass mode.
856 #define AV_CODEC_FLAG_PASS2 (1 << 10)
860 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
862 * Only decode/encode grayscale.
864 #define AV_CODEC_FLAG_GRAY (1 << 13)
866 * error[?] variables will be set during encoding.
868 #define AV_CODEC_FLAG_PSNR (1 << 15)
870 * Input bitstream might be truncated at a random location
871 * instead of only at frame boundaries.
873 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
875 * Use interlaced DCT.
877 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
881 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
883 * Place global headers in extradata instead of every keyframe.
885 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
887 * Use only bitexact stuff (except (I)DCT).
889 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
890 /* Fx : Flag for H.263+ extra options */
892 * H.263 advanced intra coding / MPEG-4 AC prediction
894 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
896 * interlaced motion estimation
898 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
899 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
902 * Allow non spec compliant speedup tricks.
904 #define AV_CODEC_FLAG2_FAST (1 << 0)
906 * Skip bitstream encoding.
908 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
910 * Place global headers at every keyframe instead of in extradata.
912 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
915 * timecode is in drop frame format. DEPRECATED!!!!
917 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
920 * Input bitstream might be truncated at a packet boundaries
921 * instead of only at frame boundaries.
923 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
925 * Discard cropping information from SPS.
927 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
930 * Show all frames before the first keyframe
932 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
934 * Export motion vectors through frame side data
936 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
938 * Do not skip samples and export skip information as frame side data
940 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
942 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
944 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
946 /* Unsupported options :
947 * Syntax Arithmetic coding (SAC)
948 * Reference Picture Selection
949 * Independent Segment Decoding */
951 /* codec capabilities */
954 * Decoder can use draw_horiz_band callback.
956 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
958 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
959 * If not set, it might not use get_buffer() at all or use operations that
960 * assume the buffer was allocated by avcodec_default_get_buffer.
962 #define AV_CODEC_CAP_DR1 (1 << 1)
963 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
965 * Encoder or decoder requires flushing with NULL input at the end in order to
966 * give the complete and correct output.
968 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
969 * with NULL data. The user can still send NULL data to the public encode
970 * or decode function, but libavcodec will not pass it along to the codec
971 * unless this flag is set.
974 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
975 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
979 * The encoder needs to be fed with NULL data at the end of encoding until the
980 * encoder no longer returns data.
982 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
983 * flag also means that the encoder must set the pts and duration for
984 * each output packet. If this flag is not set, the pts and duration will
985 * be determined by libavcodec from the input frame.
987 #define AV_CODEC_CAP_DELAY (1 << 5)
989 * Codec can be fed a final frame with a smaller size.
990 * This can be used to prevent truncation of the last audio samples.
992 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
996 * Codec can export data for HW decoding (VDPAU).
998 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
1002 * Codec can output multiple frames per AVPacket
1003 * Normally demuxers return one frame at a time, demuxers which do not do
1004 * are connected to a parser to split what they return into proper frames.
1005 * This flag is reserved to the very rare category of codecs which have a
1006 * bitstream that cannot be split into frames without timeconsuming
1007 * operations like full decoding. Demuxers carrying such bitstreams thus
1008 * may return multiple frames in a packet. This has many disadvantages like
1009 * prohibiting stream copy in many cases thus it should only be considered
1012 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1014 * Codec is experimental and is thus avoided in favor of non experimental
1017 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1019 * Codec should fill in channel configuration and samplerate instead of container
1021 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1023 * Codec supports frame-level multithreading.
1025 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1027 * Codec supports slice-based (or partition-based) multithreading.
1029 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1031 * Codec supports changed parameters at any point.
1033 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1035 * Codec supports avctx->thread_count == 0 (auto).
1037 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1039 * Audio encoder supports receiving a different number of samples in each call.
1041 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1043 * Decoder is not a preferred choice for probing.
1044 * This indicates that the decoder is not a good choice for probing.
1045 * It could for example be an expensive to spin up hardware decoder,
1046 * or it could simply not provide a lot of useful information about
1048 * A decoder marked with this flag should only be used as last resort
1049 * choice for probing.
1051 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1053 * Codec is intra only.
1055 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1057 * Codec is lossless.
1059 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1062 #if FF_API_WITHOUT_PREFIX
1064 * Allow decoders to produce frames with data planes that are not aligned
1065 * to CPU requirements (e.g. due to cropping).
1067 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1068 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1069 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1070 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1071 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1074 * @deprecated use the "gmc" private option of the libxvid encoder
1076 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1080 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1081 * mpegvideo encoders
1083 #define CODEC_FLAG_MV0 0x0040
1085 #if FF_API_INPUT_PRESERVED
1087 * @deprecated passing reference-counted frames to the encoders replaces this
1090 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1092 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1093 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1094 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1097 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1100 #define CODEC_FLAG_EMU_EDGE 0x4000
1102 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1103 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1105 #if FF_API_NORMALIZE_AQP
1107 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1108 * mpegvideo encoders
1110 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1112 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1113 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1114 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1115 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1116 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1117 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1118 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1119 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1120 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1121 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1122 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1123 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1124 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1126 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1127 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1128 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1129 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1131 /* Unsupported options :
1132 * Syntax Arithmetic coding (SAC)
1133 * Reference Picture Selection
1134 * Independent Segment Decoding */
1136 /* codec capabilities */
1138 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1140 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1141 * If not set, it might not use get_buffer() at all or use operations that
1142 * assume the buffer was allocated by avcodec_default_get_buffer.
1144 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1145 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1147 /* Codec can export data for HW decoding. This flag indicates that
1148 * the codec would call get_format() with list that might contain HW accelerated
1149 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1150 * including raw image format.
1151 * The application can use the passed context to determine bitstream version,
1152 * chroma format, resolution etc.
1154 #define CODEC_CAP_HWACCEL 0x0010
1155 #endif /* FF_API_XVMC */
1157 * Encoder or decoder requires flushing with NULL input at the end in order to
1158 * give the complete and correct output.
1160 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1161 * with NULL data. The user can still send NULL data to the public encode
1162 * or decode function, but libavcodec will not pass it along to the codec
1163 * unless this flag is set.
1166 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1167 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1171 * The encoder needs to be fed with NULL data at the end of encoding until the
1172 * encoder no longer returns data.
1174 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1175 * flag also means that the encoder must set the pts and duration for
1176 * each output packet. If this flag is not set, the pts and duration will
1177 * be determined by libavcodec from the input frame.
1179 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1181 * Codec can be fed a final frame with a smaller size.
1182 * This can be used to prevent truncation of the last audio samples.
1184 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1185 #if FF_API_CAP_VDPAU
1187 * Codec can export data for HW decoding (VDPAU).
1189 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1192 * Codec can output multiple frames per AVPacket
1193 * Normally demuxers return one frame at a time, demuxers which do not do
1194 * are connected to a parser to split what they return into proper frames.
1195 * This flag is reserved to the very rare category of codecs which have a
1196 * bitstream that cannot be split into frames without timeconsuming
1197 * operations like full decoding. Demuxers carrying such bitstreams thus
1198 * may return multiple frames in a packet. This has many disadvantages like
1199 * prohibiting stream copy in many cases thus it should only be considered
1202 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1204 * Codec is experimental and is thus avoided in favor of non experimental
1207 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1209 * Codec should fill in channel configuration and samplerate instead of container
1211 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1212 #if FF_API_NEG_LINESIZES
1214 * @deprecated no codecs use this capability
1216 #define CODEC_CAP_NEG_LINESIZES 0x0800
1219 * Codec supports frame-level multithreading.
1221 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1223 * Codec supports slice-based (or partition-based) multithreading.
1225 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1227 * Codec supports changed parameters at any point.
1229 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1231 * Codec supports avctx->thread_count == 0 (auto).
1233 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1235 * Audio encoder supports receiving a different number of samples in each call.
1237 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1239 * Codec is intra only.
1241 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1243 * Codec is lossless.
1245 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1248 * HWAccel is experimental and is thus avoided in favor of non experimental
1251 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1252 #endif /* FF_API_WITHOUT_PREFIX */
1255 //The following defines may change, don't expect compatibility if you use them.
1256 #define MB_TYPE_INTRA4x4 0x0001
1257 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1258 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1259 #define MB_TYPE_16x16 0x0008
1260 #define MB_TYPE_16x8 0x0010
1261 #define MB_TYPE_8x16 0x0020
1262 #define MB_TYPE_8x8 0x0040
1263 #define MB_TYPE_INTERLACED 0x0080
1264 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1265 #define MB_TYPE_ACPRED 0x0200
1266 #define MB_TYPE_GMC 0x0400
1267 #define MB_TYPE_SKIP 0x0800
1268 #define MB_TYPE_P0L0 0x1000
1269 #define MB_TYPE_P1L0 0x2000
1270 #define MB_TYPE_P0L1 0x4000
1271 #define MB_TYPE_P1L1 0x8000
1272 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1273 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1274 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1275 #define MB_TYPE_QUANT 0x00010000
1276 #define MB_TYPE_CBP 0x00020000
1277 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1282 * This specifies the area which should be displayed.
1283 * Note there may be multiple such areas for one frame.
1285 typedef struct AVPanScan{
1288 * - encoding: Set by user.
1289 * - decoding: Set by libavcodec.
1294 * width and height in 1/16 pel
1295 * - encoding: Set by user.
1296 * - decoding: Set by libavcodec.
1302 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1303 * - encoding: Set by user.
1304 * - decoding: Set by libavcodec.
1306 int16_t position[3][2];
1310 * This structure describes the bitrate properties of an encoded bitstream. It
1311 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1312 * parameters for H.264/HEVC.
1314 typedef struct AVCPBProperties {
1316 * Maximum bitrate of the stream, in bits per second.
1317 * Zero if unknown or unspecified.
1321 * Minimum bitrate of the stream, in bits per second.
1322 * Zero if unknown or unspecified.
1326 * Average bitrate of the stream, in bits per second.
1327 * Zero if unknown or unspecified.
1332 * The size of the buffer to which the ratecontrol is applied, in bits.
1333 * Zero if unknown or unspecified.
1338 * The delay between the time the packet this structure is associated with
1339 * is received and the time when it should be decoded, in periods of a 27MHz
1342 * UINT64_MAX when unknown or unspecified.
1347 #if FF_API_QSCALE_TYPE
1348 #define FF_QSCALE_TYPE_MPEG1 0
1349 #define FF_QSCALE_TYPE_MPEG2 1
1350 #define FF_QSCALE_TYPE_H264 2
1351 #define FF_QSCALE_TYPE_VP56 3
1355 * The decoder will keep a reference to the frame and may reuse it later.
1357 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1360 * @defgroup lavc_packet AVPacket
1362 * Types and functions for working with AVPacket.
1365 enum AVPacketSideDataType {
1366 AV_PKT_DATA_PALETTE,
1369 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1370 * that the extradata buffer was changed and the receiving side should
1371 * act upon it appropriately. The new extradata is embedded in the side
1372 * data buffer and should be immediately used for processing the current
1375 AV_PKT_DATA_NEW_EXTRADATA,
1378 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1381 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1382 * s32le channel_count
1383 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1384 * u64le channel_layout
1385 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1387 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1392 AV_PKT_DATA_PARAM_CHANGE,
1395 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1396 * structures with info about macroblocks relevant to splitting the
1397 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1398 * That is, it does not necessarily contain info about all macroblocks,
1399 * as long as the distance between macroblocks in the info is smaller
1400 * than the target payload size.
1401 * Each MB info structure is 12 bytes, and is laid out as follows:
1403 * u32le bit offset from the start of the packet
1404 * u8 current quantizer at the start of the macroblock
1406 * u16le macroblock address within the GOB
1407 * u8 horizontal MV predictor
1408 * u8 vertical MV predictor
1409 * u8 horizontal MV predictor for block number 3
1410 * u8 vertical MV predictor for block number 3
1413 AV_PKT_DATA_H263_MB_INFO,
1416 * This side data should be associated with an audio stream and contains
1417 * ReplayGain information in form of the AVReplayGain struct.
1419 AV_PKT_DATA_REPLAYGAIN,
1422 * This side data contains a 3x3 transformation matrix describing an affine
1423 * transformation that needs to be applied to the decoded video frames for
1424 * correct presentation.
1426 * See libavutil/display.h for a detailed description of the data.
1428 AV_PKT_DATA_DISPLAYMATRIX,
1431 * This side data should be associated with a video stream and contains
1432 * Stereoscopic 3D information in form of the AVStereo3D struct.
1434 AV_PKT_DATA_STEREO3D,
1437 * This side data should be associated with an audio stream and corresponds
1438 * to enum AVAudioServiceType.
1440 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1443 * This side data contains quality related information from the encoder.
1445 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1449 * u64le[error count] sum of squared differences between encoder in and output
1452 AV_PKT_DATA_QUALITY_STATS,
1455 * This side data contains an integer value representing the stream index
1456 * of a "fallback" track. A fallback track indicates an alternate
1457 * track to use when the current track can not be decoded for some reason.
1458 * e.g. no decoder available for codec.
1460 AV_PKT_DATA_FALLBACK_TRACK,
1463 * This side data corresponds to the AVCPBProperties struct.
1465 AV_PKT_DATA_CPB_PROPERTIES,
1468 * Recommmends skipping the specified number of samples
1470 * u32le number of samples to skip from start of this packet
1471 * u32le number of samples to skip from end of this packet
1472 * u8 reason for start skip
1473 * u8 reason for end skip (0=padding silence, 1=convergence)
1476 AV_PKT_DATA_SKIP_SAMPLES=70,
1479 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1480 * the packet may contain "dual mono" audio specific to Japanese DTV
1481 * and if it is true, recommends only the selected channel to be used.
1483 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1486 AV_PKT_DATA_JP_DUALMONO,
1489 * A list of zero terminated key/value strings. There is no end marker for
1490 * the list, so it is required to rely on the side data size to stop.
1492 AV_PKT_DATA_STRINGS_METADATA,
1495 * Subtitle event position
1503 AV_PKT_DATA_SUBTITLE_POSITION,
1506 * Data found in BlockAdditional element of matroska container. There is
1507 * no end marker for the data, so it is required to rely on the side data
1508 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1511 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1514 * The optional first identifier line of a WebVTT cue.
1516 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1519 * The optional settings (rendering instructions) that immediately
1520 * follow the timestamp specifier of a WebVTT cue.
1522 AV_PKT_DATA_WEBVTT_SETTINGS,
1525 * A list of zero terminated key/value strings. There is no end marker for
1526 * the list, so it is required to rely on the side data size to stop. This
1527 * side data includes updated metadata which appeared in the stream.
1529 AV_PKT_DATA_METADATA_UPDATE,
1532 * MPEGTS stream ID, this is required to pass the stream ID
1533 * information from the demuxer to the corresponding muxer.
1535 AV_PKT_DATA_MPEGTS_STREAM_ID,
1538 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1539 * should be associated with a video stream and containts data in the form
1540 * of the AVMasteringDisplayMetadata struct.
1542 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1545 * This side data should be associated with a video stream and corresponds
1546 * to the AVSphericalMapping structure.
1548 AV_PKT_DATA_SPHERICAL,
1551 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1553 typedef struct AVPacketSideData {
1556 enum AVPacketSideDataType type;
1560 * This structure stores compressed data. It is typically exported by demuxers
1561 * and then passed as input to decoders, or received as output from encoders and
1562 * then passed to muxers.
1564 * For video, it should typically contain one compressed frame. For audio it may
1565 * contain several compressed frames. Encoders are allowed to output empty
1566 * packets, with no compressed data, containing only side data
1567 * (e.g. to update some stream parameters at the end of encoding).
1569 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1570 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1571 * without libavcodec and libavformat major bump.
1573 * The semantics of data ownership depends on the buf field.
1574 * If it is set, the packet data is dynamically allocated and is
1575 * valid indefinitely until a call to av_packet_unref() reduces the
1576 * reference count to 0.
1578 * If the buf field is not set av_packet_ref() would make a copy instead
1579 * of increasing the reference count.
1581 * The side data is always allocated with av_malloc(), copied by
1582 * av_packet_ref() and freed by av_packet_unref().
1584 * @see av_packet_ref
1585 * @see av_packet_unref
1587 typedef struct AVPacket {
1589 * A reference to the reference-counted buffer where the packet data is
1591 * May be NULL, then the packet data is not reference-counted.
1595 * Presentation timestamp in AVStream->time_base units; the time at which
1596 * the decompressed packet will be presented to the user.
1597 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1598 * pts MUST be larger or equal to dts as presentation cannot happen before
1599 * decompression, unless one wants to view hex dumps. Some formats misuse
1600 * the terms dts and pts/cts to mean something different. Such timestamps
1601 * must be converted to true pts/dts before they are stored in AVPacket.
1605 * Decompression timestamp in AVStream->time_base units; the time at which
1606 * the packet is decompressed.
1607 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1614 * A combination of AV_PKT_FLAG values
1618 * Additional packet data that can be provided by the container.
1619 * Packet can contain several types of side information.
1621 AVPacketSideData *side_data;
1622 int side_data_elems;
1625 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1626 * Equals next_pts - this_pts in presentation order.
1630 int64_t pos; ///< byte position in stream, -1 if unknown
1632 #if FF_API_CONVERGENCE_DURATION
1634 * @deprecated Same as the duration field, but as int64_t. This was required
1635 * for Matroska subtitles, whose duration values could overflow when the
1636 * duration field was still an int.
1638 attribute_deprecated
1639 int64_t convergence_duration;
1642 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1643 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1645 * Flag is used to discard packets which are required to maintain valid
1646 * decoder state but are not required for output and should be dropped
1649 #define AV_PKT_FLAG_DISCARD 0x0004
1651 enum AVSideDataParamChangeFlags {
1652 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1653 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1654 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1655 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1661 struct AVCodecInternal;
1665 AV_FIELD_PROGRESSIVE,
1666 AV_FIELD_TT, //< Top coded_first, top displayed first
1667 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1668 AV_FIELD_TB, //< Top coded first, bottom displayed first
1669 AV_FIELD_BT, //< Bottom coded first, top displayed first
1673 * main external API structure.
1674 * New fields can be added to the end with minor version bumps.
1675 * Removal, reordering and changes to existing fields require a major
1677 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1679 * The name string for AVOptions options matches the associated command line
1680 * parameter name and can be found in libavcodec/options_table.h
1681 * The AVOption/command line parameter names differ in some cases from the C
1682 * structure field names for historic reasons or brevity.
1683 * sizeof(AVCodecContext) must not be used outside libav*.
1685 typedef struct AVCodecContext {
1687 * information on struct for av_log
1688 * - set by avcodec_alloc_context3
1690 const AVClass *av_class;
1691 int log_level_offset;
1693 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1694 const struct AVCodec *codec;
1695 #if FF_API_CODEC_NAME
1697 * @deprecated this field is not used for anything in libavcodec
1699 attribute_deprecated
1700 char codec_name[32];
1702 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1705 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1706 * This is used to work around some encoder bugs.
1707 * A demuxer should set this to what is stored in the field used to identify the codec.
1708 * If there are multiple such fields in a container then the demuxer should choose the one
1709 * which maximizes the information about the used codec.
1710 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1711 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1712 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1714 * - encoding: Set by user, if not then the default based on codec_id will be used.
1715 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1717 unsigned int codec_tag;
1719 #if FF_API_STREAM_CODEC_TAG
1721 * @deprecated this field is unused
1723 attribute_deprecated
1724 unsigned int stream_codec_tag;
1730 * Private context used for internal data.
1732 * Unlike priv_data, this is not codec-specific. It is used in general
1733 * libavcodec functions.
1735 struct AVCodecInternal *internal;
1738 * Private data of the user, can be used to carry app specific stuff.
1739 * - encoding: Set by user.
1740 * - decoding: Set by user.
1745 * the average bitrate
1746 * - encoding: Set by user; unused for constant quantizer encoding.
1747 * - decoding: Set by user, may be overwritten by libavcodec
1748 * if this info is available in the stream
1753 * number of bits the bitstream is allowed to diverge from the reference.
1754 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1755 * - encoding: Set by user; unused for constant quantizer encoding.
1756 * - decoding: unused
1758 int bit_rate_tolerance;
1761 * Global quality for codecs which cannot change it per frame.
1762 * This should be proportional to MPEG-1/2/4 qscale.
1763 * - encoding: Set by user.
1764 * - decoding: unused
1769 * - encoding: Set by user.
1770 * - decoding: unused
1772 int compression_level;
1773 #define FF_COMPRESSION_DEFAULT -1
1777 * - encoding: Set by user.
1778 * - decoding: Set by user.
1784 * - encoding: Set by user.
1785 * - decoding: Set by user.
1790 * some codecs need / can use extradata like Huffman tables.
1791 * MJPEG: Huffman tables
1792 * rv10: additional flags
1793 * MPEG-4: global headers (they can be in the bitstream or here)
1794 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1795 * than extradata_size to avoid problems if it is read with the bitstream reader.
1796 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1797 * - encoding: Set/allocated/freed by libavcodec.
1798 * - decoding: Set/allocated/freed by user.
1804 * This is the fundamental unit of time (in seconds) in terms
1805 * of which frame timestamps are represented. For fixed-fps content,
1806 * timebase should be 1/framerate and timestamp increments should be
1808 * This often, but not always is the inverse of the frame rate or field rate
1809 * for video. 1/time_base is not the average frame rate if the frame rate is not
1812 * Like containers, elementary streams also can store timestamps, 1/time_base
1813 * is the unit in which these timestamps are specified.
1814 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1815 * vop_time_increment_resolution and fixed_vop_rate
1816 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1818 * - encoding: MUST be set by user.
1819 * - decoding: the use of this field for decoding is deprecated.
1820 * Use framerate instead.
1822 AVRational time_base;
1825 * For some codecs, the time base is closer to the field rate than the frame rate.
1826 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1827 * if no telecine is used ...
1829 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1831 int ticks_per_frame;
1836 * Encoding: Number of frames delay there will be from the encoder input to
1837 * the decoder output. (we assume the decoder matches the spec)
1838 * Decoding: Number of frames delay in addition to what a standard decoder
1839 * as specified in the spec would produce.
1842 * Number of frames the decoded output will be delayed relative to the
1846 * For encoding, this field is unused (see initial_padding).
1848 * For decoding, this is the number of samples the decoder needs to
1849 * output before the decoder's output is valid. When seeking, you should
1850 * start decoding this many samples prior to your desired seek point.
1852 * - encoding: Set by libavcodec.
1853 * - decoding: Set by libavcodec.
1860 * picture width / height.
1862 * @note Those fields may not match the values of the last
1863 * AVFrame output by avcodec_decode_video2 due frame
1866 * - encoding: MUST be set by user.
1867 * - decoding: May be set by the user before opening the decoder if known e.g.
1868 * from the container. Some decoders will require the dimensions
1869 * to be set by the caller. During decoding, the decoder may
1870 * overwrite those values as required while parsing the data.
1875 * Bitstream width / height, may be different from width/height e.g. when
1876 * the decoded frame is cropped before being output or lowres is enabled.
1878 * @note Those field may not match the value of the last
1879 * AVFrame output by avcodec_receive_frame() due frame
1882 * - encoding: unused
1883 * - decoding: May be set by the user before opening the decoder if known
1884 * e.g. from the container. During decoding, the decoder may
1885 * overwrite those values as required while parsing the data.
1887 int coded_width, coded_height;
1889 #if FF_API_ASPECT_EXTENDED
1890 #define FF_ASPECT_EXTENDED 15
1894 * the number of pictures in a group of pictures, or 0 for intra_only
1895 * - encoding: Set by user.
1896 * - decoding: unused
1901 * Pixel format, see AV_PIX_FMT_xxx.
1902 * May be set by the demuxer if known from headers.
1903 * May be overridden by the decoder if it knows better.
1905 * @note This field may not match the value of the last
1906 * AVFrame output by avcodec_receive_frame() due frame
1909 * - encoding: Set by user.
1910 * - decoding: Set by user if known, overridden by libavcodec while
1913 enum AVPixelFormat pix_fmt;
1915 #if FF_API_MOTION_EST
1917 * This option does nothing
1918 * @deprecated use codec private options instead
1920 attribute_deprecated int me_method;
1924 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1925 * decoder to draw a horizontal band. It improves cache usage. Not
1926 * all codecs can do that. You must check the codec capabilities
1928 * When multithreading is used, it may be called from multiple threads
1929 * at the same time; threads might draw different parts of the same AVFrame,
1930 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1932 * The function is also used by hardware acceleration APIs.
1933 * It is called at least once during frame decoding to pass
1934 * the data needed for hardware render.
1935 * In that mode instead of pixel data, AVFrame points to
1936 * a structure specific to the acceleration API. The application
1937 * reads the structure and can change some fields to indicate progress
1939 * - encoding: unused
1940 * - decoding: Set by user.
1941 * @param height the height of the slice
1942 * @param y the y position of the slice
1943 * @param type 1->top field, 2->bottom field, 3->frame
1944 * @param offset offset into the AVFrame.data from which the slice should be read
1946 void (*draw_horiz_band)(struct AVCodecContext *s,
1947 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1948 int y, int type, int height);
1951 * callback to negotiate the pixelFormat
1952 * @param fmt is the list of formats which are supported by the codec,
1953 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1954 * The first is always the native one.
1955 * @note The callback may be called again immediately if initialization for
1956 * the selected (hardware-accelerated) pixel format failed.
1957 * @warning Behavior is undefined if the callback returns a value not
1958 * in the fmt list of formats.
1959 * @return the chosen format
1960 * - encoding: unused
1961 * - decoding: Set by user, if not set the native format will be chosen.
1963 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1966 * maximum number of B-frames between non-B-frames
1967 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1968 * - encoding: Set by user.
1969 * - decoding: unused
1974 * qscale factor between IP and B-frames
1975 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1976 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1977 * - encoding: Set by user.
1978 * - decoding: unused
1980 float b_quant_factor;
1982 #if FF_API_RC_STRATEGY
1983 /** @deprecated use codec private option instead */
1984 attribute_deprecated int rc_strategy;
1985 #define FF_RC_STRATEGY_XVID 1
1988 #if FF_API_PRIVATE_OPT
1989 /** @deprecated use encoder private options instead */
1990 attribute_deprecated
1991 int b_frame_strategy;
1995 * qscale offset between IP and B-frames
1996 * - encoding: Set by user.
1997 * - decoding: unused
1999 float b_quant_offset;
2002 * Size of the frame reordering buffer in the decoder.
2003 * For MPEG-2 it is 1 IPB or 0 low delay IP.
2004 * - encoding: Set by libavcodec.
2005 * - decoding: Set by libavcodec.
2009 #if FF_API_PRIVATE_OPT
2010 /** @deprecated use encoder private options instead */
2011 attribute_deprecated
2016 * qscale factor between P- and I-frames
2017 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2018 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2019 * - encoding: Set by user.
2020 * - decoding: unused
2022 float i_quant_factor;
2025 * qscale offset between P and I-frames
2026 * - encoding: Set by user.
2027 * - decoding: unused
2029 float i_quant_offset;
2032 * luminance masking (0-> disabled)
2033 * - encoding: Set by user.
2034 * - decoding: unused
2039 * temporary complexity masking (0-> disabled)
2040 * - encoding: Set by user.
2041 * - decoding: unused
2043 float temporal_cplx_masking;
2046 * spatial complexity masking (0-> disabled)
2047 * - encoding: Set by user.
2048 * - decoding: unused
2050 float spatial_cplx_masking;
2053 * p block masking (0-> disabled)
2054 * - encoding: Set by user.
2055 * - decoding: unused
2060 * darkness masking (0-> disabled)
2061 * - encoding: Set by user.
2062 * - decoding: unused
2068 * - encoding: Set by libavcodec.
2069 * - decoding: Set by user (or 0).
2073 #if FF_API_PRIVATE_OPT
2074 /** @deprecated use encoder private options instead */
2075 attribute_deprecated
2076 int prediction_method;
2077 #define FF_PRED_LEFT 0
2078 #define FF_PRED_PLANE 1
2079 #define FF_PRED_MEDIAN 2
2083 * slice offsets in the frame in bytes
2084 * - encoding: Set/allocated by libavcodec.
2085 * - decoding: Set/allocated by user (or NULL).
2090 * sample aspect ratio (0 if unknown)
2091 * That is the width of a pixel divided by the height of the pixel.
2092 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2093 * - encoding: Set by user.
2094 * - decoding: Set by libavcodec.
2096 AVRational sample_aspect_ratio;
2099 * motion estimation comparison function
2100 * - encoding: Set by user.
2101 * - decoding: unused
2105 * subpixel motion estimation comparison function
2106 * - encoding: Set by user.
2107 * - decoding: unused
2111 * macroblock comparison function (not supported yet)
2112 * - encoding: Set by user.
2113 * - decoding: unused
2117 * interlaced DCT comparison function
2118 * - encoding: Set by user.
2119 * - decoding: unused
2122 #define FF_CMP_SAD 0
2123 #define FF_CMP_SSE 1
2124 #define FF_CMP_SATD 2
2125 #define FF_CMP_DCT 3
2126 #define FF_CMP_PSNR 4
2127 #define FF_CMP_BIT 5
2129 #define FF_CMP_ZERO 7
2130 #define FF_CMP_VSAD 8
2131 #define FF_CMP_VSSE 9
2132 #define FF_CMP_NSSE 10
2133 #define FF_CMP_W53 11
2134 #define FF_CMP_W97 12
2135 #define FF_CMP_DCTMAX 13
2136 #define FF_CMP_DCT264 14
2137 #define FF_CMP_MEDIAN_SAD 15
2138 #define FF_CMP_CHROMA 256
2141 * ME diamond size & shape
2142 * - encoding: Set by user.
2143 * - decoding: unused
2148 * amount of previous MV predictors (2a+1 x 2a+1 square)
2149 * - encoding: Set by user.
2150 * - decoding: unused
2152 int last_predictor_count;
2154 #if FF_API_PRIVATE_OPT
2155 /** @deprecated use encoder private options instead */
2156 attribute_deprecated
2161 * motion estimation prepass comparison function
2162 * - encoding: Set by user.
2163 * - decoding: unused
2168 * ME prepass diamond size & shape
2169 * - encoding: Set by user.
2170 * - decoding: unused
2176 * - encoding: Set by user.
2177 * - decoding: unused
2179 int me_subpel_quality;
2183 * DTG active format information (additional aspect ratio
2184 * information only used in DVB MPEG-2 transport streams)
2187 * - encoding: unused
2188 * - decoding: Set by decoder.
2189 * @deprecated Deprecated in favor of AVSideData
2191 attribute_deprecated int dtg_active_format;
2192 #define FF_DTG_AFD_SAME 8
2193 #define FF_DTG_AFD_4_3 9
2194 #define FF_DTG_AFD_16_9 10
2195 #define FF_DTG_AFD_14_9 11
2196 #define FF_DTG_AFD_4_3_SP_14_9 13
2197 #define FF_DTG_AFD_16_9_SP_14_9 14
2198 #define FF_DTG_AFD_SP_4_3 15
2199 #endif /* FF_API_AFD */
2202 * maximum motion estimation search range in subpel units
2203 * If 0 then no limit.
2205 * - encoding: Set by user.
2206 * - decoding: unused
2210 #if FF_API_QUANT_BIAS
2212 * @deprecated use encoder private option instead
2214 attribute_deprecated int intra_quant_bias;
2215 #define FF_DEFAULT_QUANT_BIAS 999999
2218 * @deprecated use encoder private option instead
2220 attribute_deprecated int inter_quant_bias;
2225 * - encoding: unused
2226 * - decoding: Set by user.
2229 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2230 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2231 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2235 * XVideo Motion Acceleration
2236 * - encoding: forbidden
2237 * - decoding: set by decoder
2238 * @deprecated XvMC doesn't need it anymore.
2240 attribute_deprecated int xvmc_acceleration;
2241 #endif /* FF_API_XVMC */
2244 * macroblock decision mode
2245 * - encoding: Set by user.
2246 * - decoding: unused
2249 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2250 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2251 #define FF_MB_DECISION_RD 2 ///< rate distortion
2254 * custom intra quantization matrix
2255 * - encoding: Set by user, can be NULL.
2256 * - decoding: Set by libavcodec.
2258 uint16_t *intra_matrix;
2261 * custom inter quantization matrix
2262 * - encoding: Set by user, can be NULL.
2263 * - decoding: Set by libavcodec.
2265 uint16_t *inter_matrix;
2267 #if FF_API_PRIVATE_OPT
2268 /** @deprecated use encoder private options instead */
2269 attribute_deprecated
2270 int scenechange_threshold;
2272 /** @deprecated use encoder private options instead */
2273 attribute_deprecated
2274 int noise_reduction;
2279 * @deprecated this field is unused
2281 attribute_deprecated
2285 * @deprecated this field is unused
2287 attribute_deprecated
2292 * precision of the intra DC coefficient - 8
2293 * - encoding: Set by user.
2294 * - decoding: Set by libavcodec
2296 int intra_dc_precision;
2299 * Number of macroblock rows at the top which are skipped.
2300 * - encoding: unused
2301 * - decoding: Set by user.
2306 * Number of macroblock rows at the bottom which are skipped.
2307 * - encoding: unused
2308 * - decoding: Set by user.
2314 * @deprecated use encoder private options instead
2316 attribute_deprecated
2317 float border_masking;
2321 * minimum MB Lagrange multiplier
2322 * - encoding: Set by user.
2323 * - decoding: unused
2328 * maximum MB Lagrange multiplier
2329 * - encoding: Set by user.
2330 * - decoding: unused
2334 #if FF_API_PRIVATE_OPT
2336 * @deprecated use encoder private options instead
2338 attribute_deprecated
2339 int me_penalty_compensation;
2343 * - encoding: Set by user.
2344 * - decoding: unused
2348 #if FF_API_PRIVATE_OPT
2349 /** @deprecated use encoder private options instead */
2350 attribute_deprecated
2356 * - encoding: Set by user.
2357 * - decoding: unused
2362 * number of reference frames
2363 * - encoding: Set by user.
2364 * - decoding: Set by lavc.
2368 #if FF_API_PRIVATE_OPT
2369 /** @deprecated use encoder private options instead */
2370 attribute_deprecated
2374 #if FF_API_UNUSED_MEMBERS
2376 * Multiplied by qscale for each frame and added to scene_change_score.
2377 * - encoding: Set by user.
2378 * - decoding: unused
2380 attribute_deprecated int scenechange_factor;
2384 * Note: Value depends upon the compare function used for fullpel ME.
2385 * - encoding: Set by user.
2386 * - decoding: unused
2390 #if FF_API_PRIVATE_OPT
2391 /** @deprecated use encoder private options instead */
2392 attribute_deprecated
2397 * Chromaticity coordinates of the source primaries.
2398 * - encoding: Set by user
2399 * - decoding: Set by libavcodec
2401 enum AVColorPrimaries color_primaries;
2404 * Color Transfer Characteristic.
2405 * - encoding: Set by user
2406 * - decoding: Set by libavcodec
2408 enum AVColorTransferCharacteristic color_trc;
2411 * YUV colorspace type.
2412 * - encoding: Set by user
2413 * - decoding: Set by libavcodec
2415 enum AVColorSpace colorspace;
2418 * MPEG vs JPEG YUV range.
2419 * - encoding: Set by user
2420 * - decoding: Set by libavcodec
2422 enum AVColorRange color_range;
2425 * This defines the location of chroma samples.
2426 * - encoding: Set by user
2427 * - decoding: Set by libavcodec
2429 enum AVChromaLocation chroma_sample_location;
2433 * Indicates number of picture subdivisions. Used for parallelized
2435 * - encoding: Set by user
2436 * - decoding: unused
2441 * - encoding: set by libavcodec
2442 * - decoding: Set by user.
2444 enum AVFieldOrder field_order;
2447 int sample_rate; ///< samples per second
2448 int channels; ///< number of audio channels
2451 * audio sample format
2452 * - encoding: Set by user.
2453 * - decoding: Set by libavcodec.
2455 enum AVSampleFormat sample_fmt; ///< sample format
2457 /* The following data should not be initialized. */
2459 * Number of samples per channel in an audio frame.
2461 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2462 * except the last must contain exactly frame_size samples per channel.
2463 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2464 * frame size is not restricted.
2465 * - decoding: may be set by some decoders to indicate constant frame size
2470 * Frame counter, set by libavcodec.
2472 * - decoding: total number of frames returned from the decoder so far.
2473 * - encoding: total number of frames passed to the encoder so far.
2475 * @note the counter is not incremented if encoding/decoding resulted in
2481 * number of bytes per packet if constant and known or 0
2482 * Used by some WAV based audio codecs.
2487 * Audio cutoff bandwidth (0 means "automatic")
2488 * - encoding: Set by user.
2489 * - decoding: unused
2494 * Audio channel layout.
2495 * - encoding: set by user.
2496 * - decoding: set by user, may be overwritten by libavcodec.
2498 uint64_t channel_layout;
2501 * Request decoder to use this channel layout if it can (0 for default)
2502 * - encoding: unused
2503 * - decoding: Set by user.
2505 uint64_t request_channel_layout;
2508 * Type of service that the audio stream conveys.
2509 * - encoding: Set by user.
2510 * - decoding: Set by libavcodec.
2512 enum AVAudioServiceType audio_service_type;
2515 * desired sample format
2516 * - encoding: Not used.
2517 * - decoding: Set by user.
2518 * Decoder will decode to this format if it can.
2520 enum AVSampleFormat request_sample_fmt;
2523 * This callback is called at the beginning of each frame to get data
2524 * buffer(s) for it. There may be one contiguous buffer for all the data or
2525 * there may be a buffer per each data plane or anything in between. What
2526 * this means is, you may set however many entries in buf[] you feel necessary.
2527 * Each buffer must be reference-counted using the AVBuffer API (see description
2530 * The following fields will be set in the frame before this callback is
2533 * - width, height (video only)
2534 * - sample_rate, channel_layout, nb_samples (audio only)
2535 * Their values may differ from the corresponding values in
2536 * AVCodecContext. This callback must use the frame values, not the codec
2537 * context values, to calculate the required buffer size.
2539 * This callback must fill the following fields in the frame:
2543 * * if the data is planar audio with more than 8 channels, then this
2544 * callback must allocate and fill extended_data to contain all pointers
2545 * to all data planes. data[] must hold as many pointers as it can.
2546 * extended_data must be allocated with av_malloc() and will be freed in
2548 * * otherwise extended_data must point to data
2549 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2550 * the frame's data and extended_data pointers must be contained in these. That
2551 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2552 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2553 * and av_buffer_ref().
2554 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2555 * this callback and filled with the extra buffers if there are more
2556 * buffers than buf[] can hold. extended_buf will be freed in
2559 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2560 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2563 * Each data plane must be aligned to the maximum required by the target
2566 * @see avcodec_default_get_buffer2()
2570 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2571 * (read and/or written to if it is writable) later by libavcodec.
2573 * avcodec_align_dimensions2() should be used to find the required width and
2574 * height, as they normally need to be rounded up to the next multiple of 16.
2576 * Some decoders do not support linesizes changing between frames.
2578 * If frame multithreading is used and thread_safe_callbacks is set,
2579 * this callback may be called from a different thread, but not from more
2580 * than one at once. Does not need to be reentrant.
2582 * @see avcodec_align_dimensions2()
2586 * Decoders request a buffer of a particular size by setting
2587 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2588 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2589 * to a smaller value in the output frame.
2591 * As a convenience, av_samples_get_buffer_size() and
2592 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2593 * functions to find the required data size and to fill data pointers and
2594 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2595 * since all planes must be the same size.
2597 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2599 * - encoding: unused
2600 * - decoding: Set by libavcodec, user can override.
2602 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2605 * If non-zero, the decoded audio and video frames returned from
2606 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2607 * and are valid indefinitely. The caller must free them with
2608 * av_frame_unref() when they are not needed anymore.
2609 * Otherwise, the decoded frames must not be freed by the caller and are
2610 * only valid until the next decode call.
2612 * This is always automatically enabled if avcodec_receive_frame() is used.
2614 * - encoding: unused
2615 * - decoding: set by the caller before avcodec_open2().
2617 int refcounted_frames;
2619 /* - encoding parameters */
2620 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2621 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2625 * - encoding: Set by user.
2626 * - decoding: unused
2632 * - encoding: Set by user.
2633 * - decoding: unused
2638 * maximum quantizer difference between frames
2639 * - encoding: Set by user.
2640 * - decoding: unused
2646 * @deprecated use encoder private options instead
2648 attribute_deprecated
2651 attribute_deprecated
2653 attribute_deprecated
2658 * decoder bitstream buffer size
2659 * - encoding: Set by user.
2660 * - decoding: unused
2665 * ratecontrol override, see RcOverride
2666 * - encoding: Allocated/set/freed by user.
2667 * - decoding: unused
2669 int rc_override_count;
2670 RcOverride *rc_override;
2674 * @deprecated use encoder private options instead
2676 attribute_deprecated
2682 * - encoding: Set by user.
2683 * - decoding: Set by user, may be overwritten by libavcodec.
2685 int64_t rc_max_rate;
2689 * - encoding: Set by user.
2690 * - decoding: unused
2692 int64_t rc_min_rate;
2696 * @deprecated use encoder private options instead
2698 attribute_deprecated
2699 float rc_buffer_aggressivity;
2701 attribute_deprecated
2702 float rc_initial_cplx;
2706 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2707 * - encoding: Set by user.
2708 * - decoding: unused.
2710 float rc_max_available_vbv_use;
2713 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2714 * - encoding: Set by user.
2715 * - decoding: unused.
2717 float rc_min_vbv_overflow_use;
2720 * Number of bits which should be loaded into the rc buffer before decoding starts.
2721 * - encoding: Set by user.
2722 * - decoding: unused
2724 int rc_initial_buffer_occupancy;
2726 #if FF_API_CODER_TYPE
2727 #define FF_CODER_TYPE_VLC 0
2728 #define FF_CODER_TYPE_AC 1
2729 #define FF_CODER_TYPE_RAW 2
2730 #define FF_CODER_TYPE_RLE 3
2731 #if FF_API_UNUSED_MEMBERS
2732 #define FF_CODER_TYPE_DEFLATE 4
2733 #endif /* FF_API_UNUSED_MEMBERS */
2735 * @deprecated use encoder private options instead
2737 attribute_deprecated
2739 #endif /* FF_API_CODER_TYPE */
2741 #if FF_API_PRIVATE_OPT
2742 /** @deprecated use encoder private options instead */
2743 attribute_deprecated
2749 * @deprecated use encoder private options instead
2751 attribute_deprecated
2755 * @deprecated use encoder private options instead
2757 attribute_deprecated
2761 #if FF_API_PRIVATE_OPT
2762 /** @deprecated use encoder private options instead */
2763 attribute_deprecated
2764 int frame_skip_threshold;
2766 /** @deprecated use encoder private options instead */
2767 attribute_deprecated
2768 int frame_skip_factor;
2770 /** @deprecated use encoder private options instead */
2771 attribute_deprecated
2774 /** @deprecated use encoder private options instead */
2775 attribute_deprecated
2777 #endif /* FF_API_PRIVATE_OPT */
2780 * trellis RD quantization
2781 * - encoding: Set by user.
2782 * - decoding: unused
2786 #if FF_API_PRIVATE_OPT
2787 /** @deprecated use encoder private options instead */
2788 attribute_deprecated
2789 int min_prediction_order;
2791 /** @deprecated use encoder private options instead */
2792 attribute_deprecated
2793 int max_prediction_order;
2795 /** @deprecated use encoder private options instead */
2796 attribute_deprecated
2797 int64_t timecode_frame_start;
2800 #if FF_API_RTP_CALLBACK
2802 * @deprecated unused
2804 /* The RTP callback: This function is called */
2805 /* every time the encoder has a packet to send. */
2806 /* It depends on the encoder if the data starts */
2807 /* with a Start Code (it should). H.263 does. */
2808 /* mb_nb contains the number of macroblocks */
2809 /* encoded in the RTP payload. */
2810 attribute_deprecated
2811 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2814 #if FF_API_PRIVATE_OPT
2815 /** @deprecated use encoder private options instead */
2816 attribute_deprecated
2817 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2818 /* do its best to deliver a chunk with size */
2819 /* below rtp_payload_size, the chunk will start */
2820 /* with a start code on some codecs like H.263. */
2821 /* This doesn't take account of any particular */
2822 /* headers inside the transmitted RTP payload. */
2825 #if FF_API_STAT_BITS
2826 /* statistics, used for 2-pass encoding */
2827 attribute_deprecated
2829 attribute_deprecated
2831 attribute_deprecated
2833 attribute_deprecated
2835 attribute_deprecated
2837 attribute_deprecated
2839 attribute_deprecated
2841 attribute_deprecated
2844 /** @deprecated this field is unused */
2845 attribute_deprecated
2850 * pass1 encoding statistics output buffer
2851 * - encoding: Set by libavcodec.
2852 * - decoding: unused
2857 * pass2 encoding statistics input buffer
2858 * Concatenated stuff from stats_out of pass1 should be placed here.
2859 * - encoding: Allocated/set/freed by user.
2860 * - decoding: unused
2865 * Work around bugs in encoders which sometimes cannot be detected automatically.
2866 * - encoding: Set by user
2867 * - decoding: Set by user
2869 int workaround_bugs;
2870 #define FF_BUG_AUTODETECT 1 ///< autodetection
2871 #if FF_API_OLD_MSMPEG4
2872 #define FF_BUG_OLD_MSMPEG4 2
2874 #define FF_BUG_XVID_ILACE 4
2875 #define FF_BUG_UMP4 8
2876 #define FF_BUG_NO_PADDING 16
2877 #define FF_BUG_AMV 32
2879 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2881 #define FF_BUG_QPEL_CHROMA 64
2882 #define FF_BUG_STD_QPEL 128
2883 #define FF_BUG_QPEL_CHROMA2 256
2884 #define FF_BUG_DIRECT_BLOCKSIZE 512
2885 #define FF_BUG_EDGE 1024
2886 #define FF_BUG_HPEL_CHROMA 2048
2887 #define FF_BUG_DC_CLIP 4096
2888 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2889 #define FF_BUG_TRUNCATED 16384
2890 #define FF_BUG_IEDGE 32768
2893 * strictly follow the standard (MPEG-4, ...).
2894 * - encoding: Set by user.
2895 * - decoding: Set by user.
2896 * Setting this to STRICT or higher means the encoder and decoder will
2897 * generally do stupid things, whereas setting it to unofficial or lower
2898 * will mean the encoder might produce output that is not supported by all
2899 * spec-compliant decoders. Decoders don't differentiate between normal,
2900 * unofficial and experimental (that is, they always try to decode things
2901 * when they can) unless they are explicitly asked to behave stupidly
2902 * (=strictly conform to the specs)
2904 int strict_std_compliance;
2905 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2906 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2907 #define FF_COMPLIANCE_NORMAL 0
2908 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2909 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2912 * error concealment flags
2913 * - encoding: unused
2914 * - decoding: Set by user.
2916 int error_concealment;
2917 #define FF_EC_GUESS_MVS 1
2918 #define FF_EC_DEBLOCK 2
2919 #define FF_EC_FAVOR_INTER 256
2923 * - encoding: Set by user.
2924 * - decoding: Set by user.
2927 #define FF_DEBUG_PICT_INFO 1
2928 #define FF_DEBUG_RC 2
2929 #define FF_DEBUG_BITSTREAM 4
2930 #define FF_DEBUG_MB_TYPE 8
2931 #define FF_DEBUG_QP 16
2934 * @deprecated this option does nothing
2936 #define FF_DEBUG_MV 32
2938 #define FF_DEBUG_DCT_COEFF 0x00000040
2939 #define FF_DEBUG_SKIP 0x00000080
2940 #define FF_DEBUG_STARTCODE 0x00000100
2941 #if FF_API_UNUSED_MEMBERS
2942 #define FF_DEBUG_PTS 0x00000200
2943 #endif /* FF_API_UNUSED_MEMBERS */
2944 #define FF_DEBUG_ER 0x00000400
2945 #define FF_DEBUG_MMCO 0x00000800
2946 #define FF_DEBUG_BUGS 0x00001000
2948 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2949 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2951 #define FF_DEBUG_BUFFERS 0x00008000
2952 #define FF_DEBUG_THREADS 0x00010000
2953 #define FF_DEBUG_GREEN_MD 0x00800000
2954 #define FF_DEBUG_NOMC 0x01000000
2959 * Code outside libavcodec should access this field using AVOptions
2960 * - encoding: Set by user.
2961 * - decoding: Set by user.
2964 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2965 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2966 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2970 * Error recognition; may misdetect some more or less valid parts as errors.
2971 * - encoding: unused
2972 * - decoding: Set by user.
2974 int err_recognition;
2977 * Verify checksums embedded in the bitstream (could be of either encoded or
2978 * decoded data, depending on the codec) and print an error message on mismatch.
2979 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2980 * decoder returning an error.
2982 #define AV_EF_CRCCHECK (1<<0)
2983 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2984 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2985 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2987 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2988 #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
2989 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2990 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2994 * opaque 64-bit number (generally a PTS) that will be reordered and
2995 * output in AVFrame.reordered_opaque
2996 * - encoding: unused
2997 * - decoding: Set by user.
2999 int64_t reordered_opaque;
3002 * Hardware accelerator in use
3003 * - encoding: unused.
3004 * - decoding: Set by libavcodec
3006 struct AVHWAccel *hwaccel;
3009 * Hardware accelerator context.
3010 * For some hardware accelerators, a global context needs to be
3011 * provided by the user. In that case, this holds display-dependent
3012 * data FFmpeg cannot instantiate itself. Please refer to the
3013 * FFmpeg HW accelerator documentation to know how to fill this
3014 * is. e.g. for VA API, this is a struct vaapi_context.
3015 * - encoding: unused
3016 * - decoding: Set by user
3018 void *hwaccel_context;
3022 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3023 * - decoding: unused
3025 uint64_t error[AV_NUM_DATA_POINTERS];
3028 * DCT algorithm, see FF_DCT_* below
3029 * - encoding: Set by user.
3030 * - decoding: unused
3033 #define FF_DCT_AUTO 0
3034 #define FF_DCT_FASTINT 1
3035 #define FF_DCT_INT 2
3036 #define FF_DCT_MMX 3
3037 #define FF_DCT_ALTIVEC 5
3038 #define FF_DCT_FAAN 6
3041 * IDCT algorithm, see FF_IDCT_* below.
3042 * - encoding: Set by user.
3043 * - decoding: Set by user.
3046 #define FF_IDCT_AUTO 0
3047 #define FF_IDCT_INT 1
3048 #define FF_IDCT_SIMPLE 2
3049 #define FF_IDCT_SIMPLEMMX 3
3050 #define FF_IDCT_ARM 7
3051 #define FF_IDCT_ALTIVEC 8
3053 #define FF_IDCT_SH4 9
3055 #define FF_IDCT_SIMPLEARM 10
3056 #if FF_API_UNUSED_MEMBERS
3057 #define FF_IDCT_IPP 13
3058 #endif /* FF_API_UNUSED_MEMBERS */
3059 #define FF_IDCT_XVID 14
3060 #if FF_API_IDCT_XVIDMMX
3061 #define FF_IDCT_XVIDMMX 14
3062 #endif /* FF_API_IDCT_XVIDMMX */
3063 #define FF_IDCT_SIMPLEARMV5TE 16
3064 #define FF_IDCT_SIMPLEARMV6 17
3065 #if FF_API_ARCH_SPARC
3066 #define FF_IDCT_SIMPLEVIS 18
3068 #define FF_IDCT_FAAN 20
3069 #define FF_IDCT_SIMPLENEON 22
3070 #if FF_API_ARCH_ALPHA
3071 #define FF_IDCT_SIMPLEALPHA 23
3073 #define FF_IDCT_SIMPLEAUTO 128
3076 * bits per sample/pixel from the demuxer (needed for huffyuv).
3077 * - encoding: Set by libavcodec.
3078 * - decoding: Set by user.
3080 int bits_per_coded_sample;
3083 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3084 * - encoding: set by user.
3085 * - decoding: set by libavcodec.
3087 int bits_per_raw_sample;
3091 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3092 * - encoding: unused
3093 * - decoding: Set by user.
3094 * Code outside libavcodec should access this field using:
3095 * av_codec_{get,set}_lowres(avctx)
3100 #if FF_API_CODED_FRAME
3102 * the picture in the bitstream
3103 * - encoding: Set by libavcodec.
3104 * - decoding: unused
3106 * @deprecated use the quality factor packet side data instead
3108 attribute_deprecated AVFrame *coded_frame;
3113 * is used to decide how many independent tasks should be passed to execute()
3114 * - encoding: Set by user.
3115 * - decoding: Set by user.
3120 * Which multithreading methods to use.
3121 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3122 * so clients which cannot provide future frames should not use it.
3124 * - encoding: Set by user, otherwise the default is used.
3125 * - decoding: Set by user, otherwise the default is used.
3128 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3129 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3132 * Which multithreading methods are in use by the codec.
3133 * - encoding: Set by libavcodec.
3134 * - decoding: Set by libavcodec.
3136 int active_thread_type;
3139 * Set by the client if its custom get_buffer() callback can be called
3140 * synchronously from another thread, which allows faster multithreaded decoding.
3141 * draw_horiz_band() will be called from other threads regardless of this setting.
3142 * Ignored if the default get_buffer() is used.
3143 * - encoding: Set by user.
3144 * - decoding: Set by user.
3146 int thread_safe_callbacks;
3149 * The codec may call this to execute several independent things.
3150 * It will return only after finishing all tasks.
3151 * The user may replace this with some multithreaded implementation,
3152 * the default implementation will execute the parts serially.
3153 * @param count the number of things to execute
3154 * - encoding: Set by libavcodec, user can override.
3155 * - decoding: Set by libavcodec, user can override.
3157 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3160 * The codec may call this to execute several independent things.
3161 * It will return only after finishing all tasks.
3162 * The user may replace this with some multithreaded implementation,
3163 * the default implementation will execute the parts serially.
3164 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3165 * @param c context passed also to func
3166 * @param count the number of things to execute
3167 * @param arg2 argument passed unchanged to func
3168 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3169 * @param func function that will be called count times, with jobnr from 0 to count-1.
3170 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3171 * two instances of func executing at the same time will have the same threadnr.
3172 * @return always 0 currently, but code should handle a future improvement where when any call to func
3173 * returns < 0 no further calls to func may be done and < 0 is returned.
3174 * - encoding: Set by libavcodec, user can override.
3175 * - decoding: Set by libavcodec, user can override.
3177 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3180 * noise vs. sse weight for the nsse comparison function
3181 * - encoding: Set by user.
3182 * - decoding: unused
3188 * - encoding: Set by user.
3189 * - decoding: Set by libavcodec.
3192 #define FF_PROFILE_UNKNOWN -99
3193 #define FF_PROFILE_RESERVED -100
3195 #define FF_PROFILE_AAC_MAIN 0
3196 #define FF_PROFILE_AAC_LOW 1
3197 #define FF_PROFILE_AAC_SSR 2
3198 #define FF_PROFILE_AAC_LTP 3
3199 #define FF_PROFILE_AAC_HE 4
3200 #define FF_PROFILE_AAC_HE_V2 28
3201 #define FF_PROFILE_AAC_LD 22
3202 #define FF_PROFILE_AAC_ELD 38
3203 #define FF_PROFILE_MPEG2_AAC_LOW 128
3204 #define FF_PROFILE_MPEG2_AAC_HE 131
3206 #define FF_PROFILE_DNXHD 0
3207 #define FF_PROFILE_DNXHR_LB 1
3208 #define FF_PROFILE_DNXHR_SQ 2
3209 #define FF_PROFILE_DNXHR_HQ 3
3210 #define FF_PROFILE_DNXHR_HQX 4
3211 #define FF_PROFILE_DNXHR_444 5
3213 #define FF_PROFILE_DTS 20
3214 #define FF_PROFILE_DTS_ES 30
3215 #define FF_PROFILE_DTS_96_24 40
3216 #define FF_PROFILE_DTS_HD_HRA 50
3217 #define FF_PROFILE_DTS_HD_MA 60
3218 #define FF_PROFILE_DTS_EXPRESS 70
3220 #define FF_PROFILE_MPEG2_422 0
3221 #define FF_PROFILE_MPEG2_HIGH 1
3222 #define FF_PROFILE_MPEG2_SS 2
3223 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3224 #define FF_PROFILE_MPEG2_MAIN 4
3225 #define FF_PROFILE_MPEG2_SIMPLE 5
3227 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3228 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3230 #define FF_PROFILE_H264_BASELINE 66
3231 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3232 #define FF_PROFILE_H264_MAIN 77
3233 #define FF_PROFILE_H264_EXTENDED 88
3234 #define FF_PROFILE_H264_HIGH 100
3235 #define FF_PROFILE_H264_HIGH_10 110
3236 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3237 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3238 #define FF_PROFILE_H264_HIGH_422 122
3239 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3240 #define FF_PROFILE_H264_STEREO_HIGH 128
3241 #define FF_PROFILE_H264_HIGH_444 144
3242 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3243 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3244 #define FF_PROFILE_H264_CAVLC_444 44
3246 #define FF_PROFILE_VC1_SIMPLE 0
3247 #define FF_PROFILE_VC1_MAIN 1
3248 #define FF_PROFILE_VC1_COMPLEX 2
3249 #define FF_PROFILE_VC1_ADVANCED 3
3251 #define FF_PROFILE_MPEG4_SIMPLE 0
3252 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3253 #define FF_PROFILE_MPEG4_CORE 2
3254 #define FF_PROFILE_MPEG4_MAIN 3
3255 #define FF_PROFILE_MPEG4_N_BIT 4
3256 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3257 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3258 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3259 #define FF_PROFILE_MPEG4_HYBRID 8
3260 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3261 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3262 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3263 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3264 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3265 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3266 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3268 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3269 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3270 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3271 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3272 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3274 #define FF_PROFILE_VP9_0 0
3275 #define FF_PROFILE_VP9_1 1
3276 #define FF_PROFILE_VP9_2 2
3277 #define FF_PROFILE_VP9_3 3
3279 #define FF_PROFILE_HEVC_MAIN 1
3280 #define FF_PROFILE_HEVC_MAIN_10 2
3281 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3282 #define FF_PROFILE_HEVC_REXT 4
3286 * - encoding: Set by user.
3287 * - decoding: Set by libavcodec.
3290 #define FF_LEVEL_UNKNOWN -99
3293 * Skip loop filtering for selected frames.
3294 * - encoding: unused
3295 * - decoding: Set by user.
3297 enum AVDiscard skip_loop_filter;
3300 * Skip IDCT/dequantization for selected frames.
3301 * - encoding: unused
3302 * - decoding: Set by user.
3304 enum AVDiscard skip_idct;
3307 * Skip decoding for selected frames.
3308 * - encoding: unused
3309 * - decoding: Set by user.
3311 enum AVDiscard skip_frame;
3314 * Header containing style information for text subtitles.
3315 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3316 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3317 * the Format line following. It shouldn't include any Dialogue line.
3318 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3319 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3321 uint8_t *subtitle_header;
3322 int subtitle_header_size;
3324 #if FF_API_ERROR_RATE
3326 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3329 attribute_deprecated
3333 #if FF_API_VBV_DELAY
3335 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3336 * Used for compliant TS muxing.
3337 * - encoding: Set by libavcodec.
3338 * - decoding: unused.
3339 * @deprecated this value is now exported as a part of
3340 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3342 attribute_deprecated
3346 #if FF_API_SIDEDATA_ONLY_PKT
3348 * Encoding only and set by default. Allow encoders to output packets
3349 * that do not contain any encoded data, only side data.
3351 * Some encoders need to output such packets, e.g. to update some stream
3352 * parameters at the end of encoding.
3354 * @deprecated this field disables the default behaviour and
3355 * it is kept only for compatibility.
3357 attribute_deprecated
3358 int side_data_only_packets;
3362 * Audio only. The number of "priming" samples (padding) inserted by the
3363 * encoder at the beginning of the audio. I.e. this number of leading
3364 * decoded samples must be discarded by the caller to get the original audio
3365 * without leading padding.
3367 * - decoding: unused
3368 * - encoding: Set by libavcodec. The timestamps on the output packets are
3369 * adjusted by the encoder so that they always refer to the
3370 * first sample of the data actually contained in the packet,
3371 * including any added padding. E.g. if the timebase is
3372 * 1/samplerate and the timestamp of the first input sample is
3373 * 0, the timestamp of the first output packet will be
3376 int initial_padding;
3379 * - decoding: For codecs that store a framerate value in the compressed
3380 * bitstream, the decoder may export it here. { 0, 1} when
3382 * - encoding: May be used to signal the framerate of CFR content to an
3385 AVRational framerate;
3388 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3389 * - encoding: unused.
3390 * - decoding: Set by libavcodec before calling get_format()
3392 enum AVPixelFormat sw_pix_fmt;
3395 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3396 * Code outside libavcodec should access this field using:
3397 * av_codec_{get,set}_pkt_timebase(avctx)
3398 * - encoding unused.
3399 * - decoding set by user.
3401 AVRational pkt_timebase;
3405 * Code outside libavcodec should access this field using:
3406 * av_codec_{get,set}_codec_descriptor(avctx)
3407 * - encoding: unused.
3408 * - decoding: set by libavcodec.
3410 const AVCodecDescriptor *codec_descriptor;
3414 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3415 * - encoding: unused
3416 * - decoding: Set by user.
3417 * Code outside libavcodec should access this field using:
3418 * av_codec_{get,set}_lowres(avctx)
3424 * Current statistics for PTS correction.
3425 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3426 * - encoding: unused
3428 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3429 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3430 int64_t pts_correction_last_pts; /// PTS of the last frame
3431 int64_t pts_correction_last_dts; /// DTS of the last frame
3434 * Character encoding of the input subtitles file.
3435 * - decoding: set by user
3436 * - encoding: unused
3441 * Subtitles character encoding mode. Formats or codecs might be adjusting
3442 * this setting (if they are doing the conversion themselves for instance).
3443 * - decoding: set by libavcodec
3444 * - encoding: unused
3446 int sub_charenc_mode;
3447 #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)
3448 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3449 #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
3452 * Skip processing alpha if supported by codec.
3453 * Note that if the format uses pre-multiplied alpha (common with VP6,
3454 * and recommended due to better video quality/compression)
3455 * the image will look as if alpha-blended onto a black background.
3456 * However for formats that do not use pre-multiplied alpha
3457 * there might be serious artefacts (though e.g. libswscale currently
3458 * assumes pre-multiplied alpha anyway).
3459 * Code outside libavcodec should access this field using AVOptions
3461 * - decoding: set by user
3462 * - encoding: unused
3467 * Number of samples to skip after a discontinuity
3468 * - decoding: unused
3469 * - encoding: set by libavcodec
3473 #if !FF_API_DEBUG_MV
3475 * debug motion vectors
3476 * Code outside libavcodec should access this field using AVOptions
3477 * - encoding: Set by user.
3478 * - decoding: Set by user.
3481 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3482 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3483 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3487 * custom intra quantization matrix
3488 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3489 * - encoding: Set by user, can be NULL.
3490 * - decoding: unused.
3492 uint16_t *chroma_intra_matrix;
3495 * dump format separator.
3496 * can be ", " or "\n " or anything else
3497 * Code outside libavcodec should access this field using AVOptions
3498 * (NO direct access).
3499 * - encoding: Set by user.
3500 * - decoding: Set by user.
3502 uint8_t *dump_separator;
3505 * ',' separated list of allowed decoders.
3506 * If NULL then all are allowed
3507 * - encoding: unused
3508 * - decoding: set by user through AVOPtions (NO direct access)
3510 char *codec_whitelist;
3513 * Properties of the stream that gets decoded
3514 * To be accessed through av_codec_get_properties() (NO direct access)
3515 * - encoding: unused
3516 * - decoding: set by libavcodec
3518 unsigned properties;
3519 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3520 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3523 * Additional data associated with the entire coded stream.
3525 * - decoding: unused
3526 * - encoding: may be set by libavcodec after avcodec_open2().
3528 AVPacketSideData *coded_side_data;
3529 int nb_coded_side_data;
3532 * A reference to the AVHWFramesContext describing the input (for encoding)
3533 * or output (decoding) frames. The reference is set by the caller and
3534 * afterwards owned (and freed) by libavcodec.
3536 * - decoding: This field should be set by the caller from the get_format()
3537 * callback. The previous reference (if any) will always be
3538 * unreffed by libavcodec before the get_format() call.
3540 * If the default get_buffer2() is used with a hwaccel pixel
3541 * format, then this AVHWFramesContext will be used for
3542 * allocating the frame buffers.
3544 * - encoding: For hardware encoders configured to use a hwaccel pixel
3545 * format, this field should be set by the caller to a reference
3546 * to the AVHWFramesContext describing input frames.
3547 * AVHWFramesContext.format must be equal to
3548 * AVCodecContext.pix_fmt.
3550 * This field should be set before avcodec_open2() is called.
3552 AVBufferRef *hw_frames_ctx;
3555 * Control the form of AVSubtitle.rects[N]->ass
3556 * - decoding: set by user
3557 * - encoding: unused
3559 int sub_text_format;
3560 #define FF_SUB_TEXT_FMT_ASS 0
3561 #if FF_API_ASS_TIMING
3562 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3566 * Audio only. The amount of padding (in samples) appended by the encoder to
3567 * the end of the audio. I.e. this number of decoded samples must be
3568 * discarded by the caller from the end of the stream to get the original
3569 * audio without any trailing padding.
3571 * - decoding: unused
3572 * - encoding: unused
3574 int trailing_padding;
3577 * The number of pixels per image to maximally accept.
3579 * - decoding: set by user
3580 * - encoding: set by user
3586 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3587 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3589 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3590 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3592 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3594 int av_codec_get_lowres(const AVCodecContext *avctx);
3595 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3597 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3598 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3600 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3601 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3606 typedef struct AVProfile {
3608 const char *name; ///< short name for the profile
3611 typedef struct AVCodecDefault AVCodecDefault;
3618 typedef struct AVCodec {
3620 * Name of the codec implementation.
3621 * The name is globally unique among encoders and among decoders (but an
3622 * encoder and a decoder can share the same name).
3623 * This is the primary way to find a codec from the user perspective.
3627 * Descriptive name for the codec, meant to be more human readable than name.
3628 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3630 const char *long_name;
3631 enum AVMediaType type;
3634 * Codec capabilities.
3635 * see AV_CODEC_CAP_*
3638 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3639 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3640 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3641 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3642 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3643 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3644 const AVClass *priv_class; ///< AVClass for the private context
3645 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3647 /*****************************************************************
3648 * No fields below this line are part of the public API. They
3649 * may not be used outside of libavcodec and can be changed and
3651 * New public fields should be added right above.
3652 *****************************************************************
3655 struct AVCodec *next;
3657 * @name Frame-level threading support functions
3661 * If defined, called on thread contexts when they are created.
3662 * If the codec allocates writable tables in init(), re-allocate them here.
3663 * priv_data will be set to a copy of the original.
3665 int (*init_thread_copy)(AVCodecContext *);
3667 * Copy necessary context variables from a previous thread context to the current one.
3668 * If not defined, the next thread will start automatically; otherwise, the codec
3669 * must call ff_thread_finish_setup().
3671 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3673 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3677 * Private codec-specific defaults.
3679 const AVCodecDefault *defaults;
3682 * Initialize codec static data, called from avcodec_register().
3684 void (*init_static_data)(struct AVCodec *codec);
3686 int (*init)(AVCodecContext *);
3687 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3688 const struct AVSubtitle *sub);
3690 * Encode data to an AVPacket.
3692 * @param avctx codec context
3693 * @param avpkt output AVPacket (may contain a user-provided buffer)
3694 * @param[in] frame AVFrame containing the raw data to be encoded
3695 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3696 * non-empty packet was returned in avpkt.
3697 * @return 0 on success, negative error code on failure
3699 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3700 int *got_packet_ptr);
3701 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3702 int (*close)(AVCodecContext *);
3704 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3705 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3707 * - never called if the codec is closed or the wrong type,
3708 * - AVPacket parameter change side data is applied right before calling
3709 * AVCodec->send_packet,
3710 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3711 * - only one drain packet is ever passed down (until the next flush()),
3712 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3714 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3715 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3716 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3717 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3720 * Will be called when seeking
3722 void (*flush)(AVCodecContext *);
3724 * Internal codec capabilities.
3725 * See FF_CODEC_CAP_* in internal.h
3730 int av_codec_get_max_lowres(const AVCodec *codec);
3732 struct MpegEncContext;
3735 * @defgroup lavc_hwaccel AVHWAccel
3738 typedef struct AVHWAccel {
3740 * Name of the hardware accelerated codec.
3741 * The name is globally unique among encoders and among decoders (but an
3742 * encoder and a decoder can share the same name).
3747 * Type of codec implemented by the hardware accelerator.
3749 * See AVMEDIA_TYPE_xxx
3751 enum AVMediaType type;
3754 * Codec implemented by the hardware accelerator.
3756 * See AV_CODEC_ID_xxx
3761 * Supported pixel format.
3763 * Only hardware accelerated formats are supported here.
3765 enum AVPixelFormat pix_fmt;
3768 * Hardware accelerated codec capabilities.
3769 * see HWACCEL_CODEC_CAP_*
3773 /*****************************************************************
3774 * No fields below this line are part of the public API. They
3775 * may not be used outside of libavcodec and can be changed and
3777 * New public fields should be added right above.
3778 *****************************************************************
3780 struct AVHWAccel *next;
3783 * Allocate a custom buffer
3785 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3788 * Called at the beginning of each frame or field picture.
3790 * Meaningful frame information (codec specific) is guaranteed to
3791 * be parsed at this point. This function is mandatory.
3793 * Note that buf can be NULL along with buf_size set to 0.
3794 * Otherwise, this means the whole frame is available at this point.
3796 * @param avctx the codec context
3797 * @param buf the frame data buffer base
3798 * @param buf_size the size of the frame in bytes
3799 * @return zero if successful, a negative value otherwise
3801 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3804 * Callback for each slice.
3806 * Meaningful slice information (codec specific) is guaranteed to
3807 * be parsed at this point. This function is mandatory.
3808 * The only exception is XvMC, that works on MB level.
3810 * @param avctx the codec context
3811 * @param buf the slice data buffer base
3812 * @param buf_size the size of the slice in bytes
3813 * @return zero if successful, a negative value otherwise
3815 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3818 * Called at the end of each frame or field picture.
3820 * The whole picture is parsed at this point and can now be sent
3821 * to the hardware accelerator. This function is mandatory.
3823 * @param avctx the codec context
3824 * @return zero if successful, a negative value otherwise
3826 int (*end_frame)(AVCodecContext *avctx);
3829 * Size of per-frame hardware accelerator private data.
3831 * Private data is allocated with av_mallocz() before
3832 * AVCodecContext.get_buffer() and deallocated after
3833 * AVCodecContext.release_buffer().
3835 int frame_priv_data_size;
3838 * Called for every Macroblock in a slice.
3840 * XvMC uses it to replace the ff_mpv_decode_mb().
3841 * Instead of decoding to raw picture, MB parameters are
3842 * stored in an array provided by the video driver.
3844 * @param s the mpeg context
3846 void (*decode_mb)(struct MpegEncContext *s);
3849 * Initialize the hwaccel private data.
3851 * This will be called from ff_get_format(), after hwaccel and
3852 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3855 int (*init)(AVCodecContext *avctx);
3858 * Uninitialize the hwaccel private data.
3860 * This will be called from get_format() or avcodec_close(), after hwaccel
3861 * and hwaccel_context are already uninitialized.
3863 int (*uninit)(AVCodecContext *avctx);
3866 * Size of the private data to allocate in
3867 * AVCodecInternal.hwaccel_priv_data.
3873 * Hardware acceleration should be used for decoding even if the codec level
3874 * used is unknown or higher than the maximum supported level reported by the
3877 * It's generally a good idea to pass this flag unless you have a specific
3878 * reason not to, as hardware tends to under-report supported levels.
3880 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3883 * Hardware acceleration can output YUV pixel formats with a different chroma
3884 * sampling than 4:2:0 and/or other than 8 bits per component.
3886 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3892 #if FF_API_AVPICTURE
3894 * @defgroup lavc_picture AVPicture
3896 * Functions for working with AVPicture
3901 * Picture data structure.
3903 * Up to four components can be stored into it, the last component is
3905 * @deprecated use AVFrame or imgutils functions instead
3907 typedef struct AVPicture {
3908 attribute_deprecated
3909 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3910 attribute_deprecated
3911 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3919 enum AVSubtitleType {
3922 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3925 * Plain text, the text field must be set by the decoder and is
3926 * authoritative. ass and pict fields may contain approximations.
3931 * Formatted text, the ass field must be set by the decoder and is
3932 * authoritative. pict and text fields may contain approximations.
3937 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3939 typedef struct AVSubtitleRect {
3940 int x; ///< top left corner of pict, undefined when pict is not set
3941 int y; ///< top left corner of pict, undefined when pict is not set
3942 int w; ///< width of pict, undefined when pict is not set
3943 int h; ///< height of pict, undefined when pict is not set
3944 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3946 #if FF_API_AVPICTURE
3948 * @deprecated unused
3950 attribute_deprecated
3954 * data+linesize for the bitmap of this subtitle.
3955 * Can be set for text/ass as well once they are rendered.
3960 enum AVSubtitleType type;
3962 char *text; ///< 0 terminated plain UTF-8 text
3965 * 0 terminated ASS/SSA compatible event line.
3966 * The presentation of this is unaffected by the other values in this
3974 typedef struct AVSubtitle {
3975 uint16_t format; /* 0 = graphics */
3976 uint32_t start_display_time; /* relative to packet pts, in ms */
3977 uint32_t end_display_time; /* relative to packet pts, in ms */
3979 AVSubtitleRect **rects;
3980 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3984 * This struct describes the properties of an encoded stream.
3986 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3987 * be allocated with avcodec_parameters_alloc() and freed with
3988 * avcodec_parameters_free().
3990 typedef struct AVCodecParameters {
3992 * General type of the encoded data.
3994 enum AVMediaType codec_type;
3996 * Specific type of the encoded data (the codec used).
3998 enum AVCodecID codec_id;
4000 * Additional information about the codec (corresponds to the AVI FOURCC).
4005 * Extra binary data needed for initializing the decoder, codec-dependent.
4007 * Must be allocated with av_malloc() and will be freed by
4008 * avcodec_parameters_free(). The allocated size of extradata must be at
4009 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4014 * Size of the extradata content in bytes.
4019 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4020 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4025 * The average bitrate of the encoded data (in bits per second).
4030 * The number of bits per sample in the codedwords.
4032 * This is basically the bitrate per sample. It is mandatory for a bunch of
4033 * formats to actually decode them. It's the number of bits for one sample in
4034 * the actual coded bitstream.
4036 * This could be for example 4 for ADPCM
4037 * For PCM formats this matches bits_per_raw_sample
4040 int bits_per_coded_sample;
4043 * This is the number of valid bits in each output sample. If the
4044 * sample format has more bits, the least significant bits are additional
4045 * padding bits, which are always 0. Use right shifts to reduce the sample
4046 * to its actual size. For example, audio formats with 24 bit samples will
4047 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4048 * To get the original sample use "(int32_t)sample >> 8"."
4050 * For ADPCM this might be 12 or 16 or similar
4053 int bits_per_raw_sample;
4056 * Codec-specific bitstream restrictions that the stream conforms to.
4062 * Video only. The dimensions of the video frame in pixels.
4068 * Video only. The aspect ratio (width / height) which a single pixel
4069 * should have when displayed.
4071 * When the aspect ratio is unknown / undefined, the numerator should be
4072 * set to 0 (the denominator may have any value).
4074 AVRational sample_aspect_ratio;
4077 * Video only. The order of the fields in interlaced video.
4079 enum AVFieldOrder field_order;
4082 * Video only. Additional colorspace characteristics.
4084 enum AVColorRange color_range;
4085 enum AVColorPrimaries color_primaries;
4086 enum AVColorTransferCharacteristic color_trc;
4087 enum AVColorSpace color_space;
4088 enum AVChromaLocation chroma_location;
4091 * Video only. Number of delayed frames.
4096 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4097 * unknown or unspecified, otherwise the number of bits set must be equal to
4098 * the channels field.
4100 uint64_t channel_layout;
4102 * Audio only. The number of audio channels.
4106 * Audio only. The number of audio samples per second.
4110 * Audio only. The number of bytes per coded audio frame, required by some
4113 * Corresponds to nBlockAlign in WAVEFORMATEX.
4117 * Audio only. Audio frame size, if known. Required by some formats to be static.
4122 * Audio only. The amount of padding (in samples) inserted by the encoder at
4123 * the beginning of the audio. I.e. this number of leading decoded samples
4124 * must be discarded by the caller to get the original audio without leading
4127 int initial_padding;
4129 * Audio only. The amount of padding (in samples) appended by the encoder to
4130 * the end of the audio. I.e. this number of decoded samples must be
4131 * discarded by the caller from the end of the stream to get the original
4132 * audio without any trailing padding.
4134 int trailing_padding;
4136 * Audio only. Number of samples to skip after a discontinuity.
4139 } AVCodecParameters;
4142 * If c is NULL, returns the first registered codec,
4143 * if c is non-NULL, returns the next registered codec after c,
4144 * or NULL if c is the last one.
4146 AVCodec *av_codec_next(const AVCodec *c);
4149 * Return the LIBAVCODEC_VERSION_INT constant.
4151 unsigned avcodec_version(void);
4154 * Return the libavcodec build-time configuration.
4156 const char *avcodec_configuration(void);
4159 * Return the libavcodec license.
4161 const char *avcodec_license(void);
4164 * Register the codec codec and initialize libavcodec.
4166 * @warning either this function or avcodec_register_all() must be called
4167 * before any other libavcodec functions.
4169 * @see avcodec_register_all()
4171 void avcodec_register(AVCodec *codec);
4174 * Register all the codecs, parsers and bitstream filters which were enabled at
4175 * configuration time. If you do not call this function you can select exactly
4176 * which formats you want to support, by using the individual registration
4179 * @see avcodec_register
4180 * @see av_register_codec_parser
4181 * @see av_register_bitstream_filter
4183 void avcodec_register_all(void);
4186 * Allocate an AVCodecContext and set its fields to default values. The
4187 * resulting struct should be freed with avcodec_free_context().
4189 * @param codec if non-NULL, allocate private data and initialize defaults
4190 * for the given codec. It is illegal to then call avcodec_open2()
4191 * with a different codec.
4192 * If NULL, then the codec-specific defaults won't be initialized,
4193 * which may result in suboptimal default settings (this is
4194 * important mainly for encoders, e.g. libx264).
4196 * @return An AVCodecContext filled with default values or NULL on failure.
4198 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4201 * Free the codec context and everything associated with it and write NULL to
4202 * the provided pointer.
4204 void avcodec_free_context(AVCodecContext **avctx);
4206 #if FF_API_GET_CONTEXT_DEFAULTS
4208 * @deprecated This function should not be used, as closing and opening a codec
4209 * context multiple time is not supported. A new codec context should be
4210 * allocated for each new use.
4212 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4216 * Get the AVClass for AVCodecContext. It can be used in combination with
4217 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4219 * @see av_opt_find().
4221 const AVClass *avcodec_get_class(void);
4223 #if FF_API_COPY_CONTEXT
4225 * Get the AVClass for AVFrame. It can be used in combination with
4226 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4228 * @see av_opt_find().
4230 const AVClass *avcodec_get_frame_class(void);
4233 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4234 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4236 * @see av_opt_find().
4238 const AVClass *avcodec_get_subtitle_rect_class(void);
4241 * Copy the settings of the source AVCodecContext into the destination
4242 * AVCodecContext. The resulting destination codec context will be
4243 * unopened, i.e. you are required to call avcodec_open2() before you
4244 * can use this AVCodecContext to decode/encode video/audio data.
4246 * @param dest target codec context, should be initialized with
4247 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4248 * @param src source codec context
4249 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4251 * @deprecated The semantics of this function are ill-defined and it should not
4252 * be used. If you need to transfer the stream parameters from one codec context
4253 * to another, use an intermediate AVCodecParameters instance and the
4254 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4257 attribute_deprecated
4258 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4262 * Allocate a new AVCodecParameters and set its fields to default values
4263 * (unknown/invalid/0). The returned struct must be freed with
4264 * avcodec_parameters_free().
4266 AVCodecParameters *avcodec_parameters_alloc(void);
4269 * Free an AVCodecParameters instance and everything associated with it and
4270 * write NULL to the supplied pointer.
4272 void avcodec_parameters_free(AVCodecParameters **par);
4275 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4276 * replaced with newly allocated duplicates of the corresponding fields in src.
4278 * @return >= 0 on success, a negative AVERROR code on failure.
4280 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4283 * Fill the parameters struct based on the values from the supplied codec
4284 * context. Any allocated fields in par are freed and replaced with duplicates
4285 * of the corresponding fields in codec.
4287 * @return >= 0 on success, a negative AVERROR code on failure
4289 int avcodec_parameters_from_context(AVCodecParameters *par,
4290 const AVCodecContext *codec);
4293 * Fill the codec context based on the values from the supplied codec
4294 * parameters. Any allocated fields in codec that have a corresponding field in
4295 * par are freed and replaced with duplicates of the corresponding field in par.
4296 * Fields in codec that do not have a counterpart in par are not touched.
4298 * @return >= 0 on success, a negative AVERROR code on failure.
4300 int avcodec_parameters_to_context(AVCodecContext *codec,
4301 const AVCodecParameters *par);
4304 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4305 * function the context has to be allocated with avcodec_alloc_context3().
4307 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4308 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4309 * retrieving a codec.
4311 * @warning This function is not thread safe!
4313 * @note Always call this function before using decoding routines (such as
4314 * @ref avcodec_receive_frame()).
4317 * avcodec_register_all();
4318 * av_dict_set(&opts, "b", "2.5M", 0);
4319 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4323 * context = avcodec_alloc_context3(codec);
4325 * if (avcodec_open2(context, codec, opts) < 0)
4329 * @param avctx The context to initialize.
4330 * @param codec The codec to open this context for. If a non-NULL codec has been
4331 * previously passed to avcodec_alloc_context3() or
4332 * for this context, then this parameter MUST be either NULL or
4333 * equal to the previously passed codec.
4334 * @param options A dictionary filled with AVCodecContext and codec-private options.
4335 * On return this object will be filled with options that were not found.
4337 * @return zero on success, a negative value on error
4338 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4339 * av_dict_set(), av_opt_find().
4341 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4344 * Close a given AVCodecContext and free all the data associated with it
4345 * (but not the AVCodecContext itself).
4347 * Calling this function on an AVCodecContext that hasn't been opened will free
4348 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4349 * codec. Subsequent calls will do nothing.
4351 * @note Do not use this function. Use avcodec_free_context() to destroy a
4352 * codec context (either open or closed). Opening and closing a codec context
4353 * multiple times is not supported anymore -- use multiple codec contexts
4356 int avcodec_close(AVCodecContext *avctx);
4359 * Free all allocated data in the given subtitle struct.
4361 * @param sub AVSubtitle to free.
4363 void avsubtitle_free(AVSubtitle *sub);
4370 * @addtogroup lavc_packet
4375 * Allocate an AVPacket and set its fields to default values. The resulting
4376 * struct must be freed using av_packet_free().
4378 * @return An AVPacket filled with default values or NULL on failure.
4380 * @note this only allocates the AVPacket itself, not the data buffers. Those
4381 * must be allocated through other means such as av_new_packet.
4383 * @see av_new_packet
4385 AVPacket *av_packet_alloc(void);
4388 * Create a new packet that references the same data as src.
4390 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4392 * @return newly created AVPacket on success, NULL on error.
4394 * @see av_packet_alloc
4395 * @see av_packet_ref
4397 AVPacket *av_packet_clone(AVPacket *src);
4400 * Free the packet, if the packet is reference counted, it will be
4401 * unreferenced first.
4403 * @param packet packet to be freed. The pointer will be set to NULL.
4404 * @note passing NULL is a no-op.
4406 void av_packet_free(AVPacket **pkt);
4409 * Initialize optional fields of a packet with default values.
4411 * Note, this does not touch the data and size members, which have to be
4412 * initialized separately.
4416 void av_init_packet(AVPacket *pkt);
4419 * Allocate the payload of a packet and initialize its fields with
4423 * @param size wanted payload size
4424 * @return 0 if OK, AVERROR_xxx otherwise
4426 int av_new_packet(AVPacket *pkt, int size);
4429 * Reduce packet size, correctly zeroing padding
4432 * @param size new size
4434 void av_shrink_packet(AVPacket *pkt, int size);
4437 * Increase packet size, correctly zeroing padding
4440 * @param grow_by number of bytes by which to increase the size of the packet
4442 int av_grow_packet(AVPacket *pkt, int grow_by);
4445 * Initialize a reference-counted packet from av_malloc()ed data.
4447 * @param pkt packet to be initialized. This function will set the data, size,
4448 * buf and destruct fields, all others are left untouched.
4449 * @param data Data allocated by av_malloc() to be used as packet data. If this
4450 * function returns successfully, the data is owned by the underlying AVBuffer.
4451 * The caller may not access the data through other means.
4452 * @param size size of data in bytes, without the padding. I.e. the full buffer
4453 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4455 * @return 0 on success, a negative AVERROR on error
4457 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4459 #if FF_API_AVPACKET_OLD_API
4461 * @warning This is a hack - the packet memory allocation stuff is broken. The
4462 * packet is allocated if it was not really allocated.
4464 * @deprecated Use av_packet_ref
4466 attribute_deprecated
4467 int av_dup_packet(AVPacket *pkt);
4469 * Copy packet, including contents
4471 * @return 0 on success, negative AVERROR on fail
4473 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4476 * Copy packet side data
4478 * @return 0 on success, negative AVERROR on fail
4480 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4485 * @deprecated Use av_packet_unref
4487 * @param pkt packet to free
4489 attribute_deprecated
4490 void av_free_packet(AVPacket *pkt);
4493 * Allocate new information of a packet.
4496 * @param type side information type
4497 * @param size side information size
4498 * @return pointer to fresh allocated data or NULL otherwise
4500 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4504 * Wrap an existing array as a packet side data.
4507 * @param type side information type
4508 * @param data the side data array. It must be allocated with the av_malloc()
4509 * family of functions. The ownership of the data is transferred to
4511 * @param size side information size
4512 * @return a non-negative number on success, a negative AVERROR code on
4513 * failure. On failure, the packet is unchanged and the data remains
4514 * owned by the caller.
4516 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4517 uint8_t *data, size_t size);
4520 * Shrink the already allocated side data buffer
4523 * @param type side information type
4524 * @param size new side information size
4525 * @return 0 on success, < 0 on failure
4527 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4531 * Get side information from packet.
4534 * @param type desired side information type
4535 * @param size pointer for side information size to store (optional)
4536 * @return pointer to data if present or NULL otherwise
4538 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4541 int av_packet_merge_side_data(AVPacket *pkt);
4543 int av_packet_split_side_data(AVPacket *pkt);
4545 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4548 * Pack a dictionary for use in side_data.
4550 * @param dict The dictionary to pack.
4551 * @param size pointer to store the size of the returned data
4552 * @return pointer to data if successful, NULL otherwise
4554 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4556 * Unpack a dictionary from side_data.
4558 * @param data data from side_data
4559 * @param size size of the data
4560 * @param dict the metadata storage dictionary
4561 * @return 0 on success, < 0 on failure
4563 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4567 * Convenience function to free all the side data stored.
4568 * All the other fields stay untouched.
4572 void av_packet_free_side_data(AVPacket *pkt);
4575 * Setup a new reference to the data described by a given packet
4577 * If src is reference-counted, setup dst as a new reference to the
4578 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4579 * data from src into it.
4581 * All the other fields are copied from src.
4583 * @see av_packet_unref
4585 * @param dst Destination packet
4586 * @param src Source packet
4588 * @return 0 on success, a negative AVERROR on error.
4590 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4595 * Unreference the buffer referenced by the packet and reset the
4596 * remaining packet fields to their default values.
4598 * @param pkt The packet to be unreferenced.
4600 void av_packet_unref(AVPacket *pkt);
4603 * Move every field in src to dst and reset src.
4605 * @see av_packet_unref
4607 * @param src Source packet, will be reset
4608 * @param dst Destination packet
4610 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4613 * Copy only "properties" fields from src to dst.
4615 * Properties for the purpose of this function are all the fields
4616 * beside those related to the packet data (buf, data, size)
4618 * @param dst Destination packet
4619 * @param src Source packet
4621 * @return 0 on success AVERROR on failure.
4623 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4626 * Convert valid timing fields (timestamps / durations) in a packet from one
4627 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4630 * @param pkt packet on which the conversion will be performed
4631 * @param tb_src source timebase, in which the timing fields in pkt are
4633 * @param tb_dst destination timebase, to which the timing fields will be
4636 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4643 * @addtogroup lavc_decoding
4648 * Find a registered decoder with a matching codec ID.
4650 * @param id AVCodecID of the requested decoder
4651 * @return A decoder if one was found, NULL otherwise.
4653 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4656 * Find a registered decoder with the specified name.
4658 * @param name name of the requested decoder
4659 * @return A decoder if one was found, NULL otherwise.
4661 AVCodec *avcodec_find_decoder_by_name(const char *name);
4664 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4665 * it can be called by custom get_buffer2() implementations for decoders without
4666 * AV_CODEC_CAP_DR1 set.
4668 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4672 * Return the amount of padding in pixels which the get_buffer callback must
4673 * provide around the edge of the image for codecs which do not have the
4674 * CODEC_FLAG_EMU_EDGE flag.
4676 * @return Required padding in pixels.
4678 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4681 attribute_deprecated
4682 unsigned avcodec_get_edge_width(void);
4686 * Modify width and height values so that they will result in a memory
4687 * buffer that is acceptable for the codec if you do not use any horizontal
4690 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4692 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4695 * Modify width and height values so that they will result in a memory
4696 * buffer that is acceptable for the codec if you also ensure that all
4697 * line sizes are a multiple of the respective linesize_align[i].
4699 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4701 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4702 int linesize_align[AV_NUM_DATA_POINTERS]);
4705 * Converts AVChromaLocation to swscale x/y chroma position.
4707 * The positions represent the chroma (0,0) position in a coordinates system
4708 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4710 * @param xpos horizontal chroma sample position
4711 * @param ypos vertical chroma sample position
4713 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4716 * Converts swscale x/y chroma position to AVChromaLocation.
4718 * The positions represent the chroma (0,0) position in a coordinates system
4719 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4721 * @param xpos horizontal chroma sample position
4722 * @param ypos vertical chroma sample position
4724 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4727 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4729 * Some decoders may support multiple frames in a single AVPacket. Such
4730 * decoders would then just decode the first frame and the return value would be
4731 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4732 * called again with an AVPacket containing the remaining data in order to
4733 * decode the second frame, etc... Even if no frames are returned, the packet
4734 * needs to be fed to the decoder with remaining data until it is completely
4735 * consumed or an error occurs.
4737 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4738 * and output. This means that for some packets they will not immediately
4739 * produce decoded output and need to be flushed at the end of decoding to get
4740 * all the decoded data. Flushing is done by calling this function with packets
4741 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4742 * returning samples. It is safe to flush even those decoders that are not
4743 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4745 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4746 * larger than the actual read bytes because some optimized bitstream
4747 * readers read 32 or 64 bits at once and could read over the end.
4749 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4750 * before packets may be fed to the decoder.
4752 * @param avctx the codec context
4753 * @param[out] frame The AVFrame in which to store decoded audio samples.
4754 * The decoder will allocate a buffer for the decoded frame by
4755 * calling the AVCodecContext.get_buffer2() callback.
4756 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4757 * reference counted and the returned reference belongs to the
4758 * caller. The caller must release the frame using av_frame_unref()
4759 * when the frame is no longer needed. The caller may safely write
4760 * to the frame if av_frame_is_writable() returns 1.
4761 * When AVCodecContext.refcounted_frames is set to 0, the returned
4762 * reference belongs to the decoder and is valid only until the
4763 * next call to this function or until closing or flushing the
4764 * decoder. The caller may not write to it.
4765 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4766 * non-zero. Note that this field being set to zero
4767 * does not mean that an error has occurred. For
4768 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4769 * call is guaranteed to produce a frame.
4770 * @param[in] avpkt The input AVPacket containing the input buffer.
4771 * At least avpkt->data and avpkt->size should be set. Some
4772 * decoders might also require additional fields to be set.
4773 * @return A negative error code is returned if an error occurred during
4774 * decoding, otherwise the number of bytes consumed from the input
4775 * AVPacket is returned.
4777 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4779 attribute_deprecated
4780 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4781 int *got_frame_ptr, const AVPacket *avpkt);
4784 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4785 * Some decoders may support multiple frames in a single AVPacket, such
4786 * decoders would then just decode the first frame.
4788 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4789 * the actual read bytes because some optimized bitstream readers read 32 or 64
4790 * bits at once and could read over the end.
4792 * @warning The end of the input buffer buf should be set to 0 to ensure that
4793 * no overreading happens for damaged MPEG streams.
4795 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4796 * between input and output, these need to be fed with avpkt->data=NULL,
4797 * avpkt->size=0 at the end to return the remaining frames.
4799 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4800 * before packets may be fed to the decoder.
4802 * @param avctx the codec context
4803 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4804 * Use av_frame_alloc() to get an AVFrame. The codec will
4805 * allocate memory for the actual bitmap by calling the
4806 * AVCodecContext.get_buffer2() callback.
4807 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4808 * reference counted and the returned reference belongs to the
4809 * caller. The caller must release the frame using av_frame_unref()
4810 * when the frame is no longer needed. The caller may safely write
4811 * to the frame if av_frame_is_writable() returns 1.
4812 * When AVCodecContext.refcounted_frames is set to 0, the returned
4813 * reference belongs to the decoder and is valid only until the
4814 * next call to this function or until closing or flushing the
4815 * decoder. The caller may not write to it.
4817 * @param[in] avpkt The input AVPacket containing the input buffer.
4818 * You can create such packet with av_init_packet() and by then setting
4819 * data and size, some decoders might in addition need other fields like
4820 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4822 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4823 * @return On error a negative value is returned, otherwise the number of bytes
4824 * used or zero if no frame could be decompressed.
4826 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4828 attribute_deprecated
4829 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4830 int *got_picture_ptr,
4831 const AVPacket *avpkt);
4834 * Decode a subtitle message.
4835 * Return a negative value on error, otherwise return the number of bytes used.
4836 * If no subtitle could be decompressed, got_sub_ptr is zero.
4837 * Otherwise, the subtitle is stored in *sub.
4838 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4839 * simplicity, because the performance difference is expect to be negligible
4840 * and reusing a get_buffer written for video codecs would probably perform badly
4841 * due to a potentially very different allocation pattern.
4843 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4844 * and output. This means that for some packets they will not immediately
4845 * produce decoded output and need to be flushed at the end of decoding to get
4846 * all the decoded data. Flushing is done by calling this function with packets
4847 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4848 * returning subtitles. It is safe to flush even those decoders that are not
4849 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4851 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4852 * before packets may be fed to the decoder.
4854 * @param avctx the codec context
4855 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4856 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4857 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4858 * @param[in] avpkt The input AVPacket containing the input buffer.
4860 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4865 * Supply raw packet data as input to a decoder.
4867 * Internally, this call will copy relevant AVCodecContext fields, which can
4868 * influence decoding per-packet, and apply them when the packet is actually
4869 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4870 * decoder to drop the frame contained by the packet sent with this function.)
4872 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4873 * larger than the actual read bytes because some optimized bitstream
4874 * readers read 32 or 64 bits at once and could read over the end.
4876 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4877 * on the same AVCodecContext. It will return unexpected results now
4878 * or in future libavcodec versions.
4880 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4881 * before packets may be fed to the decoder.
4883 * @param avctx codec context
4884 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4885 * frame, or several complete audio frames.
4886 * Ownership of the packet remains with the caller, and the
4887 * decoder will not write to the packet. The decoder may create
4888 * a reference to the packet data (or copy it if the packet is
4889 * not reference-counted).
4890 * Unlike with older APIs, the packet is always fully consumed,
4891 * and if it contains multiple frames (e.g. some audio codecs),
4892 * will require you to call avcodec_receive_frame() multiple
4893 * times afterwards before you can send a new packet.
4894 * It can be NULL (or an AVPacket with data set to NULL and
4895 * size set to 0); in this case, it is considered a flush
4896 * packet, which signals the end of the stream. Sending the
4897 * first flush packet will return success. Subsequent ones are
4898 * unnecessary and will return AVERROR_EOF. If the decoder
4899 * still has frames buffered, it will return them after sending
4902 * @return 0 on success, otherwise negative error code:
4903 * AVERROR(EAGAIN): input is not accepted right now - the packet must be
4904 * resent after trying to read output
4905 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4906 * be sent to it (also returned if more than 1 flush
4908 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4909 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4910 * other errors: legitimate decoding errors
4912 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4915 * Return decoded output data from a decoder.
4917 * @param avctx codec context
4918 * @param frame This will be set to a reference-counted video or audio
4919 * frame (depending on the decoder type) allocated by the
4920 * decoder. Note that the function will always call
4921 * av_frame_unref(frame) before doing anything else.
4924 * 0: success, a frame was returned
4925 * AVERROR(EAGAIN): output is not available right now - user must try
4927 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4928 * no more output frames
4929 * AVERROR(EINVAL): codec not opened, or it is an encoder
4930 * other negative values: legitimate decoding errors
4932 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4935 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4936 * to retrieve buffered output packets.
4938 * @param avctx codec context
4939 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4940 * Ownership of the frame remains with the caller, and the
4941 * encoder will not write to the frame. The encoder may create
4942 * a reference to the frame data (or copy it if the frame is
4943 * not reference-counted).
4944 * It can be NULL, in which case it is considered a flush
4945 * packet. This signals the end of the stream. If the encoder
4946 * still has packets buffered, it will return them after this
4947 * call. Once flushing mode has been entered, additional flush
4948 * packets are ignored, and sending frames will return
4952 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4953 * can have any number of samples.
4954 * If it is not set, frame->nb_samples must be equal to
4955 * avctx->frame_size for all frames except the last.
4956 * The final frame may be smaller than avctx->frame_size.
4957 * @return 0 on success, otherwise negative error code:
4958 * AVERROR(EAGAIN): input is not accepted right now - the frame must be
4959 * resent after trying to read output packets
4960 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4962 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4963 * decoder, or requires flush
4964 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4965 * other errors: legitimate decoding errors
4967 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4970 * Read encoded data from the encoder.
4972 * @param avctx codec context
4973 * @param avpkt This will be set to a reference-counted packet allocated by the
4974 * encoder. Note that the function will always call
4975 * av_frame_unref(frame) before doing anything else.
4976 * @return 0 on success, otherwise negative error code:
4977 * AVERROR(EAGAIN): output is not available right now - user must try
4979 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4980 * no more output packets
4981 * AVERROR(EINVAL): codec not opened, or it is an encoder
4982 * other errors: legitimate decoding errors
4984 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4988 * @defgroup lavc_parsing Frame parsing
4992 enum AVPictureStructure {
4993 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4994 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4995 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4996 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4999 typedef struct AVCodecParserContext {
5001 struct AVCodecParser *parser;
5002 int64_t frame_offset; /* offset of the current frame */
5003 int64_t cur_offset; /* current offset
5004 (incremented by each av_parser_parse()) */
5005 int64_t next_frame_offset; /* offset of the next frame */
5007 int pict_type; /* XXX: Put it back in AVCodecContext. */
5009 * This field is used for proper frame duration computation in lavf.
5010 * It signals, how much longer the frame duration of the current frame
5011 * is compared to normal frame duration.
5013 * frame_duration = (1 + repeat_pict) * time_base
5015 * It is used by codecs like H.264 to display telecined material.
5017 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5018 int64_t pts; /* pts of the current frame */
5019 int64_t dts; /* dts of the current frame */
5024 int fetch_timestamp;
5026 #define AV_PARSER_PTS_NB 4
5027 int cur_frame_start_index;
5028 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5029 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5030 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5033 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5034 #define PARSER_FLAG_ONCE 0x0002
5035 /// Set if the parser has a valid file offset
5036 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5037 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5039 int64_t offset; ///< byte offset from starting packet start
5040 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5043 * Set by parser to 1 for key frames and 0 for non-key frames.
5044 * It is initialized to -1, so if the parser doesn't set this flag,
5045 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5050 #if FF_API_CONVERGENCE_DURATION
5052 * @deprecated unused
5054 attribute_deprecated
5055 int64_t convergence_duration;
5058 // Timestamp generation support:
5060 * Synchronization point for start of timestamp generation.
5062 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5065 * For example, this corresponds to presence of H.264 buffering period
5071 * Offset of the current timestamp against last timestamp sync point in
5072 * units of AVCodecContext.time_base.
5074 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5075 * contain a valid timestamp offset.
5077 * Note that the timestamp of sync point has usually a nonzero
5078 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5079 * the next frame after timestamp sync point will be usually 1.
5081 * For example, this corresponds to H.264 cpb_removal_delay.
5083 int dts_ref_dts_delta;
5086 * Presentation delay of current frame in units of AVCodecContext.time_base.
5088 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5089 * contain valid non-negative timestamp delta (presentation time of a frame
5090 * must not lie in the past).
5092 * This delay represents the difference between decoding and presentation
5093 * time of the frame.
5095 * For example, this corresponds to H.264 dpb_output_delay.
5100 * Position of the packet in file.
5102 * Analogous to cur_frame_pts/dts
5104 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5107 * Byte position of currently parsed frame in stream.
5112 * Previous frame byte position.
5117 * Duration of the current frame.
5118 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5119 * For all other types, this is in units of AVCodecContext.time_base.
5123 enum AVFieldOrder field_order;
5126 * Indicate whether a picture is coded as a frame, top field or bottom field.
5128 * For example, H.264 field_pic_flag equal to 0 corresponds to
5129 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5130 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5131 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5133 enum AVPictureStructure picture_structure;
5136 * Picture number incremented in presentation or output order.
5137 * This field may be reinitialized at the first picture of a new sequence.
5139 * For example, this corresponds to H.264 PicOrderCnt.
5141 int output_picture_number;
5144 * Dimensions of the decoded video intended for presentation.
5150 * Dimensions of the coded video.
5156 * The format of the coded data, corresponds to enum AVPixelFormat for video
5157 * and for enum AVSampleFormat for audio.
5159 * Note that a decoder can have considerable freedom in how exactly it
5160 * decodes the data, so the format reported here might be different from the
5161 * one returned by a decoder.
5164 } AVCodecParserContext;
5166 typedef struct AVCodecParser {
5167 int codec_ids[5]; /* several codec IDs are permitted */
5169 int (*parser_init)(AVCodecParserContext *s);
5170 /* This callback never returns an error, a negative value means that
5171 * the frame start was in a previous packet. */
5172 int (*parser_parse)(AVCodecParserContext *s,
5173 AVCodecContext *avctx,
5174 const uint8_t **poutbuf, int *poutbuf_size,
5175 const uint8_t *buf, int buf_size);
5176 void (*parser_close)(AVCodecParserContext *s);
5177 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5178 struct AVCodecParser *next;
5181 AVCodecParser *av_parser_next(const AVCodecParser *c);
5183 void av_register_codec_parser(AVCodecParser *parser);
5184 AVCodecParserContext *av_parser_init(int codec_id);
5189 * @param s parser context.
5190 * @param avctx codec context.
5191 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5192 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5193 * @param buf input buffer.
5194 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5195 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5196 To signal EOF, this should be 0 (so that the last frame
5198 * @param pts input presentation timestamp.
5199 * @param dts input decoding timestamp.
5200 * @param pos input byte position in stream.
5201 * @return the number of bytes of the input bitstream used.
5206 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5213 * decode_frame(data, size);
5217 int av_parser_parse2(AVCodecParserContext *s,
5218 AVCodecContext *avctx,
5219 uint8_t **poutbuf, int *poutbuf_size,
5220 const uint8_t *buf, int buf_size,
5221 int64_t pts, int64_t dts,
5225 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5226 * @deprecated use AVBitStreamFilter
5228 int av_parser_change(AVCodecParserContext *s,
5229 AVCodecContext *avctx,
5230 uint8_t **poutbuf, int *poutbuf_size,
5231 const uint8_t *buf, int buf_size, int keyframe);
5232 void av_parser_close(AVCodecParserContext *s);
5240 * @addtogroup lavc_encoding
5245 * Find a registered encoder with a matching codec ID.
5247 * @param id AVCodecID of the requested encoder
5248 * @return An encoder if one was found, NULL otherwise.
5250 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5253 * Find a registered encoder with the specified name.
5255 * @param name name of the requested encoder
5256 * @return An encoder if one was found, NULL otherwise.
5258 AVCodec *avcodec_find_encoder_by_name(const char *name);
5261 * Encode a frame of audio.
5263 * Takes input samples from frame and writes the next output packet, if
5264 * available, to avpkt. The output packet does not necessarily contain data for
5265 * the most recent frame, as encoders can delay, split, and combine input frames
5266 * internally as needed.
5268 * @param avctx codec context
5269 * @param avpkt output AVPacket.
5270 * The user can supply an output buffer by setting
5271 * avpkt->data and avpkt->size prior to calling the
5272 * function, but if the size of the user-provided data is not
5273 * large enough, encoding will fail. If avpkt->data and
5274 * avpkt->size are set, avpkt->destruct must also be set. All
5275 * other AVPacket fields will be reset by the encoder using
5276 * av_init_packet(). If avpkt->data is NULL, the encoder will
5277 * allocate it. The encoder will set avpkt->size to the size
5278 * of the output packet.
5280 * If this function fails or produces no output, avpkt will be
5281 * freed using av_packet_unref().
5282 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5283 * May be NULL when flushing an encoder that has the
5284 * AV_CODEC_CAP_DELAY capability set.
5285 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5286 * can have any number of samples.
5287 * If it is not set, frame->nb_samples must be equal to
5288 * avctx->frame_size for all frames except the last.
5289 * The final frame may be smaller than avctx->frame_size.
5290 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5291 * output packet is non-empty, and to 0 if it is
5292 * empty. If the function returns an error, the
5293 * packet can be assumed to be invalid, and the
5294 * value of got_packet_ptr is undefined and should
5296 * @return 0 on success, negative error code on failure
5298 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5300 attribute_deprecated
5301 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5302 const AVFrame *frame, int *got_packet_ptr);
5305 * Encode a frame of video.
5307 * Takes input raw video data from frame and writes the next output packet, if
5308 * available, to avpkt. The output packet does not necessarily contain data for
5309 * the most recent frame, as encoders can delay and reorder input frames
5310 * internally as needed.
5312 * @param avctx codec context
5313 * @param avpkt output AVPacket.
5314 * The user can supply an output buffer by setting
5315 * avpkt->data and avpkt->size prior to calling the
5316 * function, but if the size of the user-provided data is not
5317 * large enough, encoding will fail. All other AVPacket fields
5318 * will be reset by the encoder using av_init_packet(). If
5319 * avpkt->data is NULL, the encoder will allocate it.
5320 * The encoder will set avpkt->size to the size of the
5321 * output packet. The returned data (if any) belongs to the
5322 * caller, he is responsible for freeing it.
5324 * If this function fails or produces no output, avpkt will be
5325 * freed using av_packet_unref().
5326 * @param[in] frame AVFrame containing the raw video data to be encoded.
5327 * May be NULL when flushing an encoder that has the
5328 * AV_CODEC_CAP_DELAY capability set.
5329 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5330 * output packet is non-empty, and to 0 if it is
5331 * empty. If the function returns an error, the
5332 * packet can be assumed to be invalid, and the
5333 * value of got_packet_ptr is undefined and should
5335 * @return 0 on success, negative error code on failure
5337 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5339 attribute_deprecated
5340 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5341 const AVFrame *frame, int *got_packet_ptr);
5343 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5344 const AVSubtitle *sub);
5351 #if FF_API_AVCODEC_RESAMPLE
5353 * @defgroup lavc_resample Audio resampling
5355 * @deprecated use libswresample instead
5359 struct ReSampleContext;
5360 struct AVResampleContext;
5362 typedef struct ReSampleContext ReSampleContext;
5365 * Initialize audio resampling context.
5367 * @param output_channels number of output channels
5368 * @param input_channels number of input channels
5369 * @param output_rate output sample rate
5370 * @param input_rate input sample rate
5371 * @param sample_fmt_out requested output sample format
5372 * @param sample_fmt_in input sample format
5373 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5374 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5375 * @param linear if 1 then the used FIR filter will be linearly interpolated
5376 between the 2 closest, if 0 the closest will be used
5377 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5378 * @return allocated ReSampleContext, NULL if error occurred
5380 attribute_deprecated
5381 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5382 int output_rate, int input_rate,
5383 enum AVSampleFormat sample_fmt_out,
5384 enum AVSampleFormat sample_fmt_in,
5385 int filter_length, int log2_phase_count,
5386 int linear, double cutoff);
5388 attribute_deprecated
5389 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5392 * Free resample context.
5394 * @param s a non-NULL pointer to a resample context previously
5395 * created with av_audio_resample_init()
5397 attribute_deprecated
5398 void audio_resample_close(ReSampleContext *s);
5402 * Initialize an audio resampler.
5403 * Note, if either rate is not an integer then simply scale both rates up so they are.
5404 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5405 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5406 * @param linear If 1 then the used FIR filter will be linearly interpolated
5407 between the 2 closest, if 0 the closest will be used
5408 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5410 attribute_deprecated
5411 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5414 * Resample an array of samples using a previously configured context.
5415 * @param src an array of unconsumed samples
5416 * @param consumed the number of samples of src which have been consumed are returned here
5417 * @param src_size the number of unconsumed samples available
5418 * @param dst_size the amount of space in samples available in dst
5419 * @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.
5420 * @return the number of samples written in dst or -1 if an error occurred
5422 attribute_deprecated
5423 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5427 * Compensate samplerate/timestamp drift. The compensation is done by changing
5428 * the resampler parameters, so no audible clicks or similar distortions occur
5429 * @param compensation_distance distance in output samples over which the compensation should be performed
5430 * @param sample_delta number of output samples which should be output less
5432 * example: av_resample_compensate(c, 10, 500)
5433 * here instead of 510 samples only 500 samples would be output
5435 * note, due to rounding the actual compensation might be slightly different,
5436 * especially if the compensation_distance is large and the in_rate used during init is small
5438 attribute_deprecated
5439 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5440 attribute_deprecated
5441 void av_resample_close(struct AVResampleContext *c);
5448 #if FF_API_AVPICTURE
5450 * @addtogroup lavc_picture
5455 * @deprecated unused
5457 attribute_deprecated
5458 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5461 * @deprecated unused
5463 attribute_deprecated
5464 void avpicture_free(AVPicture *picture);
5467 * @deprecated use av_image_fill_arrays() instead.
5469 attribute_deprecated
5470 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5471 enum AVPixelFormat pix_fmt, int width, int height);
5474 * @deprecated use av_image_copy_to_buffer() instead.
5476 attribute_deprecated
5477 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5478 int width, int height,
5479 unsigned char *dest, int dest_size);
5482 * @deprecated use av_image_get_buffer_size() instead.
5484 attribute_deprecated
5485 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5488 * @deprecated av_image_copy() instead.
5490 attribute_deprecated
5491 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5492 enum AVPixelFormat pix_fmt, int width, int height);
5495 * @deprecated unused
5497 attribute_deprecated
5498 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5499 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5502 * @deprecated unused
5504 attribute_deprecated
5505 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5506 int padtop, int padbottom, int padleft, int padright, int *color);
5514 * @defgroup lavc_misc Utility functions
5517 * Miscellaneous utility functions related to both encoding and decoding
5523 * @defgroup lavc_misc_pixfmt Pixel formats
5525 * Functions for working with pixel formats.
5530 * Utility function to access log2_chroma_w log2_chroma_h from
5531 * the pixel format AVPixFmtDescriptor.
5533 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5534 * for one that returns a failure code and continues in case of invalid
5537 * @param[in] pix_fmt the pixel format
5538 * @param[out] h_shift store log2_chroma_w
5539 * @param[out] v_shift store log2_chroma_h
5541 * @see av_pix_fmt_get_chroma_sub_sample
5544 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5547 * Return a value representing the fourCC code associated to the
5548 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5551 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5554 * @deprecated see av_get_pix_fmt_loss()
5556 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5560 * Find the best pixel format to convert to given a certain source pixel
5561 * format. When converting from one pixel format to another, information loss
5562 * may occur. For example, when converting from RGB24 to GRAY, the color
5563 * information will be lost. Similarly, other losses occur when converting from
5564 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5565 * the given pixel formats should be used to suffer the least amount of loss.
5566 * The pixel formats from which it chooses one, are determined by the
5567 * pix_fmt_list parameter.
5570 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5571 * @param[in] src_pix_fmt source pixel format
5572 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5573 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5574 * @return The best pixel format to convert to or -1 if none was found.
5576 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5577 enum AVPixelFormat src_pix_fmt,
5578 int has_alpha, int *loss_ptr);
5581 * @deprecated see av_find_best_pix_fmt_of_2()
5583 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5584 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5586 attribute_deprecated
5587 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5588 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5590 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5596 #if FF_API_SET_DIMENSIONS
5598 * @deprecated this function is not supposed to be used from outside of lavc
5600 attribute_deprecated
5601 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5605 * Put a string representing the codec tag codec_tag in buf.
5607 * @param buf buffer to place codec tag in
5608 * @param buf_size size in bytes of buf
5609 * @param codec_tag codec tag to assign
5610 * @return the length of the string that would have been generated if
5611 * enough space had been available, excluding the trailing null
5613 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5615 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5618 * Return a name for the specified profile, if available.
5620 * @param codec the codec that is searched for the given profile
5621 * @param profile the profile value for which a name is requested
5622 * @return A name for the profile if found, NULL otherwise.
5624 const char *av_get_profile_name(const AVCodec *codec, int profile);
5627 * Return a name for the specified profile, if available.
5629 * @param codec_id the ID of the codec to which the requested profile belongs
5630 * @param profile the profile value for which a name is requested
5631 * @return A name for the profile if found, NULL otherwise.
5633 * @note unlike av_get_profile_name(), which searches a list of profiles
5634 * supported by a specific decoder or encoder implementation, this
5635 * function searches the list of profiles from the AVCodecDescriptor
5637 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5639 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5640 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5641 //FIXME func typedef
5644 * Fill AVFrame audio data and linesize pointers.
5646 * The buffer buf must be a preallocated buffer with a size big enough
5647 * to contain the specified samples amount. The filled AVFrame data
5648 * pointers will point to this buffer.
5650 * AVFrame extended_data channel pointers are allocated if necessary for
5653 * @param frame the AVFrame
5654 * frame->nb_samples must be set prior to calling the
5655 * function. This function fills in frame->data,
5656 * frame->extended_data, frame->linesize[0].
5657 * @param nb_channels channel count
5658 * @param sample_fmt sample format
5659 * @param buf buffer to use for frame data
5660 * @param buf_size size of buffer
5661 * @param align plane size sample alignment (0 = default)
5662 * @return >=0 on success, negative error code on failure
5663 * @todo return the size in bytes required to store the samples in
5664 * case of success, at the next libavutil bump
5666 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5667 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5668 int buf_size, int align);
5671 * Reset the internal decoder state / flush internal buffers. Should be called
5672 * e.g. when seeking or when switching to a different stream.
5674 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5675 * this invalidates the frames previously returned from the decoder. When
5676 * refcounted frames are used, the decoder just releases any references it might
5677 * keep internally, but the caller's reference remains valid.
5679 void avcodec_flush_buffers(AVCodecContext *avctx);
5682 * Return codec bits per sample.
5684 * @param[in] codec_id the codec
5685 * @return Number of bits per sample or zero if unknown for the given codec.
5687 int av_get_bits_per_sample(enum AVCodecID codec_id);
5690 * Return the PCM codec associated with a sample format.
5691 * @param be endianness, 0 for little, 1 for big,
5692 * -1 (or anything else) for native
5693 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5695 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5698 * Return codec bits per sample.
5699 * Only return non-zero if the bits per sample is exactly correct, not an
5702 * @param[in] codec_id the codec
5703 * @return Number of bits per sample or zero if unknown for the given codec.
5705 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5708 * Return audio frame duration.
5710 * @param avctx codec context
5711 * @param frame_bytes size of the frame, or 0 if unknown
5712 * @return frame duration, in samples, if known. 0 if not able to
5715 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5718 * This function is the same as av_get_audio_frame_duration(), except it works
5719 * with AVCodecParameters instead of an AVCodecContext.
5721 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5724 typedef struct AVBitStreamFilterContext {
5726 struct AVBitStreamFilter *filter;
5727 AVCodecParserContext *parser;
5728 struct AVBitStreamFilterContext *next;
5730 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5731 * Not for access by library users.
5734 } AVBitStreamFilterContext;
5737 typedef struct AVBSFInternal AVBSFInternal;
5740 * The bitstream filter state.
5742 * This struct must be allocated with av_bsf_alloc() and freed with
5745 * The fields in the struct will only be changed (by the caller or by the
5746 * filter) as described in their documentation, and are to be considered
5747 * immutable otherwise.
5749 typedef struct AVBSFContext {
5751 * A class for logging and AVOptions
5753 const AVClass *av_class;
5756 * The bitstream filter this context is an instance of.
5758 const struct AVBitStreamFilter *filter;
5761 * Opaque libavcodec internal data. Must not be touched by the caller in any
5764 AVBSFInternal *internal;
5767 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5768 * this is an AVOptions-enabled struct.
5773 * Parameters of the input stream. Set by the caller before av_bsf_init().
5775 AVCodecParameters *par_in;
5778 * Parameters of the output stream. Set by the filter in av_bsf_init().
5780 AVCodecParameters *par_out;
5783 * The timebase used for the timestamps of the input packets. Set by the
5784 * caller before av_bsf_init().
5786 AVRational time_base_in;
5789 * The timebase used for the timestamps of the output packets. Set by the
5790 * filter in av_bsf_init().
5792 AVRational time_base_out;
5795 typedef struct AVBitStreamFilter {
5799 * A list of codec ids supported by the filter, terminated by
5801 * May be NULL, in that case the bitstream filter works with any codec id.
5803 const enum AVCodecID *codec_ids;
5806 * A class for the private data, used to declare bitstream filter private
5807 * AVOptions. This field is NULL for bitstream filters that do not declare
5810 * If this field is non-NULL, the first member of the filter private data
5811 * must be a pointer to AVClass, which will be set by libavcodec generic
5812 * code to this class.
5814 const AVClass *priv_class;
5816 /*****************************************************************
5817 * No fields below this line are part of the public API. They
5818 * may not be used outside of libavcodec and can be changed and
5820 * New public fields should be added right above.
5821 *****************************************************************
5825 int (*init)(AVBSFContext *ctx);
5826 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5827 void (*close)(AVBSFContext *ctx);
5828 } AVBitStreamFilter;
5832 * Register a bitstream filter.
5834 * The filter will be accessible to the application code through
5835 * av_bitstream_filter_next() or can be directly initialized with
5836 * av_bitstream_filter_init().
5838 * @see avcodec_register_all()
5840 attribute_deprecated
5841 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5844 * Create and initialize a bitstream filter context given a bitstream
5847 * The returned context must be freed with av_bitstream_filter_close().
5849 * @param name the name of the bitstream filter
5850 * @return a bitstream filter context if a matching filter was found
5851 * and successfully initialized, NULL otherwise
5853 attribute_deprecated
5854 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5859 * This function filters the buffer buf with size buf_size, and places the
5860 * filtered buffer in the buffer pointed to by poutbuf.
5862 * The output buffer must be freed by the caller.
5864 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5865 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5866 * If specified, this must point to the encoder context of the
5867 * output stream the packet is sent to.
5868 * @param args arguments which specify the filter configuration, may be NULL
5869 * @param poutbuf pointer which is updated to point to the filtered buffer
5870 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5871 * @param buf buffer containing the data to filter
5872 * @param buf_size size in bytes of buf
5873 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5874 * @return >= 0 in case of success, or a negative error code in case of failure
5876 * If the return value is positive, an output buffer is allocated and
5877 * is available in *poutbuf, and is distinct from the input buffer.
5879 * If the return value is 0, the output buffer is not allocated and
5880 * should be considered identical to the input buffer, or in case
5881 * *poutbuf was set it points to the input buffer (not necessarily to
5882 * its starting address). A special case is if *poutbuf was set to NULL and
5883 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5885 attribute_deprecated
5886 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5887 AVCodecContext *avctx, const char *args,
5888 uint8_t **poutbuf, int *poutbuf_size,
5889 const uint8_t *buf, int buf_size, int keyframe);
5892 * Release bitstream filter context.
5894 * @param bsf the bitstream filter context created with
5895 * av_bitstream_filter_init(), can be NULL
5897 attribute_deprecated
5898 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5901 * If f is NULL, return the first registered bitstream filter,
5902 * if f is non-NULL, return the next registered bitstream filter
5903 * after f, or NULL if f is the last one.
5905 * This function can be used to iterate over all registered bitstream
5908 attribute_deprecated
5909 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5913 * @return a bitstream filter with the specified name or NULL if no such
5914 * bitstream filter exists.
5916 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5919 * Iterate over all registered bitstream filters.
5921 * @param opaque a pointer where libavcodec will store the iteration state. Must
5922 * point to NULL to start the iteration.
5924 * @return the next registered bitstream filter or NULL when the iteration is
5927 const AVBitStreamFilter *av_bsf_next(void **opaque);
5930 * Allocate a context for a given bitstream filter. The caller must fill in the
5931 * context parameters as described in the documentation and then call
5932 * av_bsf_init() before sending any data to the filter.
5934 * @param filter the filter for which to allocate an instance.
5935 * @param ctx a pointer into which the pointer to the newly-allocated context
5936 * will be written. It must be freed with av_bsf_free() after the
5937 * filtering is done.
5939 * @return 0 on success, a negative AVERROR code on failure
5941 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5944 * Prepare the filter for use, after all the parameters and options have been
5947 int av_bsf_init(AVBSFContext *ctx);
5950 * Submit a packet for filtering.
5952 * After sending each packet, the filter must be completely drained by calling
5953 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5956 * @param pkt the packet to filter. pkt must contain some payload (i.e data or
5957 * side data must be present in pkt). The bitstream filter will take ownership of
5958 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5959 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5960 * packets will be sent). That will cause the filter to output any packets it
5961 * may have buffered internally.
5963 * @return 0 on success, a negative AVERROR on error.
5965 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5968 * Retrieve a filtered packet.
5970 * @param[out] pkt this struct will be filled with the contents of the filtered
5971 * packet. It is owned by the caller and must be freed using
5972 * av_packet_unref() when it is no longer needed.
5973 * This parameter should be "clean" (i.e. freshly allocated
5974 * with av_packet_alloc() or unreffed with av_packet_unref())
5975 * when this function is called. If this function returns
5976 * successfully, the contents of pkt will be completely
5977 * overwritten by the returned data. On failure, pkt is not
5980 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5981 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5982 * will be no further output from the filter. Another negative AVERROR value if
5985 * @note one input packet may result in several output packets, so after sending
5986 * a packet with av_bsf_send_packet(), this function needs to be called
5987 * repeatedly until it stops returning 0. It is also possible for a filter to
5988 * output fewer packets than were sent to it, so this function may return
5989 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5991 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5994 * Free a bitstream filter context and everything associated with it; write NULL
5995 * into the supplied pointer.
5997 void av_bsf_free(AVBSFContext **ctx);
6000 * Get the AVClass for AVBSFContext. It can be used in combination with
6001 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6003 * @see av_opt_find().
6005 const AVClass *av_bsf_get_class(void);
6008 * Structure for chain/list of bitstream filters.
6009 * Empty list can be allocated by av_bsf_list_alloc().
6011 typedef struct AVBSFList AVBSFList;
6014 * Allocate empty list of bitstream filters.
6015 * The list must be later freed by av_bsf_list_free()
6016 * or finalized by av_bsf_list_finalize().
6018 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6020 AVBSFList *av_bsf_list_alloc(void);
6023 * Free list of bitstream filters.
6025 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6027 void av_bsf_list_free(AVBSFList **lst);
6030 * Append bitstream filter to the list of bitstream filters.
6032 * @param lst List to append to
6033 * @param bsf Filter context to be appended
6035 * @return >=0 on success, negative AVERROR in case of failure
6037 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6040 * Construct new bitstream filter context given it's name and options
6041 * and append it to the list of bitstream filters.
6043 * @param lst List to append to
6044 * @param bsf_name Name of the bitstream filter
6045 * @param options Options for the bitstream filter, can be set to NULL
6047 * @return >=0 on success, negative AVERROR in case of failure
6049 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6051 * Finalize list of bitstream filters.
6053 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6054 * so the whole chain of bitstream filters can be treated as single filter
6055 * freshly allocated by av_bsf_alloc().
6056 * If the call is successful, @ref AVBSFList structure is freed and lst
6057 * will be set to NULL. In case of failure, caller is responsible for
6058 * freeing the structure by av_bsf_list_free()
6060 * @param lst Filter list structure to be transformed
6061 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6062 * representing the chain of bitstream filters
6064 * @return >=0 on success, negative AVERROR in case of failure
6066 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6069 * Parse string describing list of bitstream filters and create single
6070 * @ref AVBSFContext describing the whole chain of bitstream filters.
6071 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6072 * allocated by av_bsf_alloc().
6074 * @param str String describing chain of bitstream filters in format
6075 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6076 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6077 * representing the chain of bitstream filters
6079 * @return >=0 on success, negative AVERROR in case of failure
6081 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6084 * Get null/pass-through bitstream filter.
6086 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6090 int av_bsf_get_null_filter(AVBSFContext **bsf);
6095 * Same behaviour av_fast_malloc but the buffer has additional
6096 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6098 * In addition the whole buffer will initially and after resizes
6099 * be 0-initialized so that no uninitialized data will ever appear.
6101 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6104 * Same behaviour av_fast_padded_malloc except that buffer will always
6105 * be 0-initialized after call.
6107 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6110 * Encode extradata length to a buffer. Used by xiph codecs.
6112 * @param s buffer to write to; must be at least (v/255+1) bytes long
6113 * @param v size of extradata in bytes
6114 * @return number of bytes written to the buffer.
6116 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6118 #if FF_API_MISSING_SAMPLE
6120 * Log a generic warning message about a missing feature. This function is
6121 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6122 * only, and would normally not be used by applications.
6123 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6124 * a pointer to an AVClass struct
6125 * @param[in] feature string containing the name of the missing feature
6126 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
6127 * If want_sample is non-zero, additional verbiage will be added to the log
6128 * message which tells the user how to report samples to the development
6130 * @deprecated Use avpriv_report_missing_feature() instead.
6132 attribute_deprecated
6133 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
6136 * Log a generic warning message asking for a sample. This function is
6137 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6138 * only, and would normally not be used by applications.
6139 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6140 * a pointer to an AVClass struct
6141 * @param[in] msg string containing an optional message, or NULL if no message
6142 * @deprecated Use avpriv_request_sample() instead.
6144 attribute_deprecated
6145 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
6146 #endif /* FF_API_MISSING_SAMPLE */
6149 * Register the hardware accelerator hwaccel.
6151 void av_register_hwaccel(AVHWAccel *hwaccel);
6154 * If hwaccel is NULL, returns the first registered hardware accelerator,
6155 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6156 * after hwaccel, or NULL if hwaccel is the last one.
6158 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6162 * Lock operation used by lockmgr
6165 AV_LOCK_CREATE, ///< Create a mutex
6166 AV_LOCK_OBTAIN, ///< Lock the mutex
6167 AV_LOCK_RELEASE, ///< Unlock the mutex
6168 AV_LOCK_DESTROY, ///< Free mutex resources
6172 * Register a user provided lock manager supporting the operations
6173 * specified by AVLockOp. The "mutex" argument to the function points
6174 * to a (void *) where the lockmgr should store/get a pointer to a user
6175 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6176 * value left by the last call for all other ops. If the lock manager is
6177 * unable to perform the op then it should leave the mutex in the same
6178 * state as when it was called and return a non-zero value. However,
6179 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6180 * have been successfully destroyed. If av_lockmgr_register succeeds
6181 * it will return a non-negative value, if it fails it will return a
6182 * negative value and destroy all mutex and unregister all callbacks.
6183 * av_lockmgr_register is not thread-safe, it must be called from a
6184 * single thread before any calls which make use of locking are used.
6186 * @param cb User defined callback. av_lockmgr_register invokes calls
6187 * to this callback and the previously registered callback.
6188 * The callback will be used to create more than one mutex
6189 * each of which must be backed by its own underlying locking
6190 * mechanism (i.e. do not use a single static object to
6191 * implement your lock manager). If cb is set to NULL the
6192 * lockmgr will be unregistered.
6194 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6197 * Get the type of the given codec.
6199 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6202 * Get the name of a codec.
6203 * @return a static string identifying the codec; never NULL
6205 const char *avcodec_get_name(enum AVCodecID id);
6208 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6209 * with no corresponding avcodec_close()), 0 otherwise.
6211 int avcodec_is_open(AVCodecContext *s);
6214 * @return a non-zero number if codec is an encoder, zero otherwise
6216 int av_codec_is_encoder(const AVCodec *codec);
6219 * @return a non-zero number if codec is a decoder, zero otherwise
6221 int av_codec_is_decoder(const AVCodec *codec);
6224 * @return descriptor for given codec ID or NULL if no descriptor exists.
6226 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6229 * Iterate over all codec descriptors known to libavcodec.
6231 * @param prev previous descriptor. NULL to get the first descriptor.
6233 * @return next descriptor or NULL after the last descriptor
6235 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6238 * @return codec descriptor with the given name or NULL if no such descriptor
6241 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6244 * Allocate a CPB properties structure and initialize its fields to default
6247 * @param size if non-NULL, the size of the allocated struct will be written
6248 * here. This is useful for embedding it in side data.
6250 * @return the newly allocated struct or NULL on failure
6252 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6258 #endif /* AVCODEC_AVCODEC_H */