2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/log.h"
40 #include "libavutil/pixfmt.h"
41 #include "libavutil/rational.h"
46 * @defgroup libavc libavcodec
47 * Encoding/Decoding Library
51 * @defgroup lavc_decoding Decoding
55 * @defgroup lavc_encoding Encoding
59 * @defgroup lavc_codec Codecs
61 * @defgroup lavc_codec_native Native Codecs
64 * @defgroup lavc_codec_wrappers External library wrappers
67 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
71 * @defgroup lavc_internal Internal
79 * @defgroup lavc_encdec send/receive encoding and decoding API overview
82 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
83 * avcodec_receive_packet() functions provide an encode/decode API, which
84 * decouples input and output.
86 * The API is very similar for encoding/decoding and audio/video, and works as
88 * - Set up and open the AVCodecContext as usual.
90 * - For decoding, call avcodec_send_packet() to give the decoder raw
91 * compressed data in an AVPacket.
92 * - For encoding, call avcodec_send_frame() to give the decoder an AVFrame
93 * containing uncompressed audio or video.
94 * In both cases, it is recommended that AVPackets and AVFrames are
95 * refcounted, or libavcodec might have to copy the input data. (libavformat
96 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
97 * refcounted AVFrames.)
98 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
99 * functions and process their output:
100 * - For decoding, call avcodec_receive_frame(). On success, it will return
101 * an AVFrame containing uncompressed audio or video data.
102 * - For encoding, call avcodec_receive_packet(). On success, it will return
103 * an AVPacket with a compressed frame.
104 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
105 * AVERROR(EAGAIN) return value means that new input data is required to
106 * return new output. In this case, continue with sending input. For each
107 * input frame/packet, the codec will typically return 1 output frame/packet,
108 * but it can also be 0 or more than 1.
110 * At the beginning of decoding or encoding, the codec might accept multiple
111 * input frames/packets without returning a frame, until its internal buffers
112 * are filled. This situation is handled transparently if you follow the steps
115 * End of stream situations. These require "flushing" (aka draining) the codec,
116 * as the codec might buffer multiple frames or packets internally for
117 * performance or out of necessity (consider B-frames).
118 * This is handled as follows:
119 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
120 * or avcodec_send_frame() (encoding) functions. This will enter draining
122 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
123 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
124 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
125 * - Before decoding can be resumed again, the codec has to be reset with
126 * avcodec_flush_buffers().
128 * Using the API as outlined above is highly recommended. But it is also
129 * possible to call functions outside of this rigid schema. For example, you can
130 * call avcodec_send_packet() repeatedly without calling
131 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
132 * until the codec's internal buffer has been filled up (which is typically of
133 * size 1 per output frame, after initial input), and then reject input with
134 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
135 * read at least some output.
137 * Not all codecs will follow a rigid and predictable dataflow; the only
138 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
139 * one end implies that a receive/send call on the other end will succeed. In
140 * general, no codec will permit unlimited buffering of input or output.
142 * This API replaces the following legacy functions:
143 * - avcodec_decode_video2() and avcodec_decode_audio4():
144 * Use avcodec_send_packet() to feed input to the decoder, then use
145 * avcodec_receive_frame() to receive decoded frames after each packet.
146 * Unlike with the old video decoding API, multiple frames might result from
147 * a packet. For audio, splitting the input packet into frames by partially
148 * decoding packets becomes transparent to the API user. You never need to
149 * feed an AVPacket to the API twice.
150 * Additionally, sending a flush/draining packet is required only once.
151 * - avcodec_encode_video2()/avcodec_encode_audio2():
152 * Use avcodec_send_frame() to feed input to the encoder, then use
153 * avcodec_receive_packet() to receive encoded packets.
154 * Providing user-allocated buffers for avcodec_receive_packet() is not
156 * - The new API does not handle subtitles yet.
158 * Mixing new and old function calls on the same AVCodecContext is not allowed,
159 * and will result in undefined behavior.
161 * Some codecs might require using the new API; using the old API will return
162 * an error when calling it.
167 * @defgroup lavc_core Core functions/structures.
170 * Basic definitions, functions for querying libavcodec capabilities,
171 * allocating core structures, etc.
177 * Identify the syntax and semantics of the bitstream.
178 * The principle is roughly:
179 * Two decoders with the same ID can decode the same streams.
180 * Two encoders with the same ID can encode compatible streams.
181 * There may be slight deviations from the principle due to implementation
184 * If you add a codec ID to this list, add it so that
185 * 1. no value of an existing codec ID changes (that would break ABI),
186 * 2. it is as close as possible to similar codecs
188 * After adding new codec IDs, do not forget to add an entry to the codec
189 * descriptor list and bump libavcodec minor version.
195 AV_CODEC_ID_MPEG1VIDEO,
196 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
198 AV_CODEC_ID_MPEG2VIDEO_XVMC,
199 #endif /* FF_API_XVMC */
210 AV_CODEC_ID_RAWVIDEO,
211 AV_CODEC_ID_MSMPEG4V1,
212 AV_CODEC_ID_MSMPEG4V2,
213 AV_CODEC_ID_MSMPEG4V3,
236 AV_CODEC_ID_INTERPLAY_VIDEO,
243 AV_CODEC_ID_MSVIDEO1,
248 AV_CODEC_ID_TRUEMOTION1,
249 AV_CODEC_ID_VMDVIDEO,
274 AV_CODEC_ID_TRUEMOTION2,
280 AV_CODEC_ID_SMACKVIDEO,
285 AV_CODEC_ID_JPEG2000,
291 AV_CODEC_ID_DSICINVIDEO,
292 AV_CODEC_ID_TIERTEXSEQVIDEO,
300 AV_CODEC_ID_BETHSOFTVID,
312 AV_CODEC_ID_ESCAPE124,
316 AV_CODEC_ID_MOTIONPIXELS,
328 AV_CODEC_ID_FLASHSV2,
329 AV_CODEC_ID_CDGRAPHICS,
332 AV_CODEC_ID_BINKVIDEO,
333 AV_CODEC_ID_IFF_ILBM,
334 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
340 AV_CODEC_ID_A64_MULTI,
341 AV_CODEC_ID_A64_MULTI5,
344 AV_CODEC_ID_LAGARITH,
348 AV_CODEC_ID_WMV3IMAGE,
349 AV_CODEC_ID_VC1IMAGE,
351 AV_CODEC_ID_BMV_VIDEO,
358 AV_CODEC_ID_ZEROCODEC,
367 AV_CODEC_ID_ESCAPE130,
370 AV_CODEC_ID_HNM4_VIDEO,
372 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
374 AV_CODEC_ID_ALIAS_PIX,
375 AV_CODEC_ID_BRENDER_PIX,
376 AV_CODEC_ID_PAF_VIDEO,
389 AV_CODEC_ID_SCREENPRESSO,
392 AV_CODEC_ID_Y41P = 0x8000,
397 AV_CODEC_ID_TARGA_Y216,
409 AV_CODEC_ID_TRUEMOTION2RT,
411 AV_CODEC_ID_MAGICYUV,
412 AV_CODEC_ID_SHEERVIDEO,
415 /* various PCM "codecs" */
416 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
417 AV_CODEC_ID_PCM_S16LE = 0x10000,
418 AV_CODEC_ID_PCM_S16BE,
419 AV_CODEC_ID_PCM_U16LE,
420 AV_CODEC_ID_PCM_U16BE,
423 AV_CODEC_ID_PCM_MULAW,
424 AV_CODEC_ID_PCM_ALAW,
425 AV_CODEC_ID_PCM_S32LE,
426 AV_CODEC_ID_PCM_S32BE,
427 AV_CODEC_ID_PCM_U32LE,
428 AV_CODEC_ID_PCM_U32BE,
429 AV_CODEC_ID_PCM_S24LE,
430 AV_CODEC_ID_PCM_S24BE,
431 AV_CODEC_ID_PCM_U24LE,
432 AV_CODEC_ID_PCM_U24BE,
433 AV_CODEC_ID_PCM_S24DAUD,
434 AV_CODEC_ID_PCM_ZORK,
435 AV_CODEC_ID_PCM_S16LE_PLANAR,
437 AV_CODEC_ID_PCM_F32BE,
438 AV_CODEC_ID_PCM_F32LE,
439 AV_CODEC_ID_PCM_F64BE,
440 AV_CODEC_ID_PCM_F64LE,
441 AV_CODEC_ID_PCM_BLURAY,
444 AV_CODEC_ID_PCM_S8_PLANAR,
445 AV_CODEC_ID_PCM_S24LE_PLANAR,
446 AV_CODEC_ID_PCM_S32LE_PLANAR,
447 AV_CODEC_ID_PCM_S16BE_PLANAR,
449 AV_CODEC_ID_PCM_S64LE = 0x10800,
450 AV_CODEC_ID_PCM_S64BE,
452 /* various ADPCM codecs */
453 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
454 AV_CODEC_ID_ADPCM_IMA_WAV,
455 AV_CODEC_ID_ADPCM_IMA_DK3,
456 AV_CODEC_ID_ADPCM_IMA_DK4,
457 AV_CODEC_ID_ADPCM_IMA_WS,
458 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
459 AV_CODEC_ID_ADPCM_MS,
460 AV_CODEC_ID_ADPCM_4XM,
461 AV_CODEC_ID_ADPCM_XA,
462 AV_CODEC_ID_ADPCM_ADX,
463 AV_CODEC_ID_ADPCM_EA,
464 AV_CODEC_ID_ADPCM_G726,
465 AV_CODEC_ID_ADPCM_CT,
466 AV_CODEC_ID_ADPCM_SWF,
467 AV_CODEC_ID_ADPCM_YAMAHA,
468 AV_CODEC_ID_ADPCM_SBPRO_4,
469 AV_CODEC_ID_ADPCM_SBPRO_3,
470 AV_CODEC_ID_ADPCM_SBPRO_2,
471 AV_CODEC_ID_ADPCM_THP,
472 AV_CODEC_ID_ADPCM_IMA_AMV,
473 AV_CODEC_ID_ADPCM_EA_R1,
474 AV_CODEC_ID_ADPCM_EA_R3,
475 AV_CODEC_ID_ADPCM_EA_R2,
476 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
477 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
478 AV_CODEC_ID_ADPCM_EA_XAS,
479 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
480 AV_CODEC_ID_ADPCM_IMA_ISS,
481 AV_CODEC_ID_ADPCM_G722,
482 AV_CODEC_ID_ADPCM_IMA_APC,
483 AV_CODEC_ID_ADPCM_VIMA,
484 #if FF_API_VIMA_DECODER
485 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
488 AV_CODEC_ID_ADPCM_AFC = 0x11800,
489 AV_CODEC_ID_ADPCM_IMA_OKI,
490 AV_CODEC_ID_ADPCM_DTK,
491 AV_CODEC_ID_ADPCM_IMA_RAD,
492 AV_CODEC_ID_ADPCM_G726LE,
493 AV_CODEC_ID_ADPCM_THP_LE,
494 AV_CODEC_ID_ADPCM_PSX,
495 AV_CODEC_ID_ADPCM_AICA,
496 AV_CODEC_ID_ADPCM_IMA_DAT4,
497 AV_CODEC_ID_ADPCM_MTAF,
500 AV_CODEC_ID_AMR_NB = 0x12000,
503 /* RealAudio codecs*/
504 AV_CODEC_ID_RA_144 = 0x13000,
507 /* various DPCM codecs */
508 AV_CODEC_ID_ROQ_DPCM = 0x14000,
509 AV_CODEC_ID_INTERPLAY_DPCM,
510 AV_CODEC_ID_XAN_DPCM,
511 AV_CODEC_ID_SOL_DPCM,
513 AV_CODEC_ID_SDX2_DPCM = 0x14800,
516 AV_CODEC_ID_MP2 = 0x15000,
517 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
527 AV_CODEC_ID_VMDAUDIO,
533 AV_CODEC_ID_WESTWOOD_SND1,
534 AV_CODEC_ID_GSM, ///< as in Berlin toast format
537 AV_CODEC_ID_TRUESPEECH,
539 AV_CODEC_ID_SMACKAUDIO,
542 AV_CODEC_ID_DSICINAUDIO,
544 AV_CODEC_ID_MUSEPACK7,
546 AV_CODEC_ID_GSM_MS, /* as found in WAV */
552 AV_CODEC_ID_NELLYMOSER,
553 AV_CODEC_ID_MUSEPACK8,
555 AV_CODEC_ID_WMAVOICE,
557 AV_CODEC_ID_WMALOSSLESS,
566 AV_CODEC_ID_BINKAUDIO_RDFT,
567 AV_CODEC_ID_BINKAUDIO_DCT,
568 AV_CODEC_ID_AAC_LATM,
573 AV_CODEC_ID_8SVX_EXP,
574 AV_CODEC_ID_8SVX_FIB,
575 AV_CODEC_ID_BMV_AUDIO,
580 AV_CODEC_ID_COMFORT_NOISE,
582 AV_CODEC_ID_METASOUND,
583 AV_CODEC_ID_PAF_AUDIO,
587 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
589 AV_CODEC_ID_SONIC_LS,
592 AV_CODEC_ID_DSD_LSBF,
593 AV_CODEC_ID_DSD_MSBF,
594 AV_CODEC_ID_DSD_LSBF_PLANAR,
595 AV_CODEC_ID_DSD_MSBF_PLANAR,
597 AV_CODEC_ID_INTERPLAY_ACM,
602 /* subtitle codecs */
603 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
604 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
605 AV_CODEC_ID_DVB_SUBTITLE,
606 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
609 AV_CODEC_ID_MOV_TEXT,
610 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
611 AV_CODEC_ID_DVB_TELETEXT,
614 AV_CODEC_ID_MICRODVD = 0x17800,
618 AV_CODEC_ID_REALTEXT,
620 AV_CODEC_ID_SUBVIEWER1,
621 AV_CODEC_ID_SUBVIEWER,
628 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
630 /* other specific kind of codecs (generally used for attachments) */
631 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
632 AV_CODEC_ID_TTF = 0x18000,
634 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
635 AV_CODEC_ID_BINTEXT = 0x18800,
639 AV_CODEC_ID_SMPTE_KLV,
641 AV_CODEC_ID_TIMED_ID3,
642 AV_CODEC_ID_BIN_DATA,
645 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
647 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
648 * stream (only used by libavformat) */
649 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
650 * stream (only used by libavformat) */
651 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
652 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
656 * This struct describes the properties of a single codec described by an
658 * @see avcodec_descriptor_get()
660 typedef struct AVCodecDescriptor {
662 enum AVMediaType type;
664 * Name of the codec described by this descriptor. It is non-empty and
665 * unique for each codec descriptor. It should contain alphanumeric
666 * characters and '_' only.
670 * A more descriptive name for this codec. May be NULL.
672 const char *long_name;
674 * Codec properties, a combination of AV_CODEC_PROP_* flags.
678 * MIME type(s) associated with the codec.
679 * May be NULL; if not, a NULL-terminated array of MIME types.
680 * The first item is always non-NULL and is the preferred MIME type.
682 const char *const *mime_types;
684 * If non-NULL, an array of profiles recognized for this codec.
685 * Terminated with FF_PROFILE_UNKNOWN.
687 const struct AVProfile *profiles;
691 * Codec uses only intra compression.
694 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
696 * Codec supports lossy compression. Audio and video codecs only.
697 * @note a codec may support both lossy and lossless
700 #define AV_CODEC_PROP_LOSSY (1 << 1)
702 * Codec supports lossless compression. Audio and video codecs only.
704 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
706 * Codec supports frame reordering. That is, the coded order (the order in which
707 * the encoded packets are output by the encoders / stored / input to the
708 * decoders) may be different from the presentation order of the corresponding
711 * For codecs that do not have this property set, PTS and DTS should always be
714 #define AV_CODEC_PROP_REORDER (1 << 3)
716 * Subtitle codec is bitmap based
717 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
719 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
721 * Subtitle codec is text based.
722 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
724 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
727 * @ingroup lavc_decoding
728 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
729 * This is mainly needed because some optimized bitstream readers read
730 * 32 or 64 bit at once and could read over the end.<br>
731 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
732 * MPEG bitstreams could cause overread and segfault.
734 #define AV_INPUT_BUFFER_PADDING_SIZE 32
737 * @ingroup lavc_encoding
738 * minimum encoding buffer size
739 * Used to avoid some checks during header writing.
741 #define AV_INPUT_BUFFER_MIN_SIZE 16384
743 #if FF_API_WITHOUT_PREFIX
745 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
747 #define FF_INPUT_BUFFER_PADDING_SIZE 32
750 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
752 #define FF_MIN_BUFFER_SIZE 16384
753 #endif /* FF_API_WITHOUT_PREFIX */
756 * @ingroup lavc_encoding
757 * motion estimation type.
758 * @deprecated use codec private option instead
760 #if FF_API_MOTION_EST
762 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
766 ME_EPZS, ///< enhanced predictive zonal search
767 ME_X1, ///< reserved for experiments
768 ME_HEX, ///< hexagon based search
769 ME_UMH, ///< uneven multi-hexagon search
770 ME_TESA, ///< transformed exhaustive search algorithm
771 ME_ITER=50, ///< iterative search
776 * @ingroup lavc_decoding
779 /* We leave some space between them for extensions (drop some
780 * keyframes for intra-only or drop just some bidir frames). */
781 AVDISCARD_NONE =-16, ///< discard nothing
782 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
783 AVDISCARD_NONREF = 8, ///< discard all non reference
784 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
785 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
786 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
787 AVDISCARD_ALL = 48, ///< discard all
790 enum AVAudioServiceType {
791 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
792 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
793 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
794 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
795 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
796 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
797 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
798 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
799 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
800 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
804 * @ingroup lavc_encoding
806 typedef struct RcOverride{
809 int qscale; // If this is 0 then quality_factor will be used instead.
810 float quality_factor;
813 #if FF_API_MAX_BFRAMES
815 * @deprecated there is no libavcodec-wide limit on the number of B-frames
817 #define FF_MAX_B_FRAMES 16
821 These flags can be passed in AVCodecContext.flags before initialization.
822 Note: Not everything is supported yet.
826 * Allow decoders to produce frames with data planes that are not aligned
827 * to CPU requirements (e.g. due to cropping).
829 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
833 #define AV_CODEC_FLAG_QSCALE (1 << 1)
835 * 4 MV per MB allowed / advanced prediction for H.263.
837 #define AV_CODEC_FLAG_4MV (1 << 2)
839 * Output even those frames that might be corrupted.
841 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
845 #define AV_CODEC_FLAG_QPEL (1 << 4)
847 * Use internal 2pass ratecontrol in first pass mode.
849 #define AV_CODEC_FLAG_PASS1 (1 << 9)
851 * Use internal 2pass ratecontrol in second pass mode.
853 #define AV_CODEC_FLAG_PASS2 (1 << 10)
857 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
859 * Only decode/encode grayscale.
861 #define AV_CODEC_FLAG_GRAY (1 << 13)
863 * error[?] variables will be set during encoding.
865 #define AV_CODEC_FLAG_PSNR (1 << 15)
867 * Input bitstream might be truncated at a random location
868 * instead of only at frame boundaries.
870 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
872 * Use interlaced DCT.
874 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
878 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
880 * Place global headers in extradata instead of every keyframe.
882 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
884 * Use only bitexact stuff (except (I)DCT).
886 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
887 /* Fx : Flag for H.263+ extra options */
889 * H.263 advanced intra coding / MPEG-4 AC prediction
891 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
893 * interlaced motion estimation
895 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
896 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
899 * Allow non spec compliant speedup tricks.
901 #define AV_CODEC_FLAG2_FAST (1 << 0)
903 * Skip bitstream encoding.
905 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
907 * Place global headers at every keyframe instead of in extradata.
909 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
912 * timecode is in drop frame format. DEPRECATED!!!!
914 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
917 * Input bitstream might be truncated at a packet boundaries
918 * instead of only at frame boundaries.
920 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
922 * Discard cropping information from SPS.
924 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
927 * Show all frames before the first keyframe
929 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
931 * Export motion vectors through frame side data
933 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
935 * Do not skip samples and export skip information as frame side data
937 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
939 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
941 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
943 /* Unsupported options :
944 * Syntax Arithmetic coding (SAC)
945 * Reference Picture Selection
946 * Independent Segment Decoding */
948 /* codec capabilities */
951 * Decoder can use draw_horiz_band callback.
953 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
955 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
956 * If not set, it might not use get_buffer() at all or use operations that
957 * assume the buffer was allocated by avcodec_default_get_buffer.
959 #define AV_CODEC_CAP_DR1 (1 << 1)
960 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
962 * Encoder or decoder requires flushing with NULL input at the end in order to
963 * give the complete and correct output.
965 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
966 * with NULL data. The user can still send NULL data to the public encode
967 * or decode function, but libavcodec will not pass it along to the codec
968 * unless this flag is set.
971 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
972 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
976 * The encoder needs to be fed with NULL data at the end of encoding until the
977 * encoder no longer returns data.
979 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
980 * flag also means that the encoder must set the pts and duration for
981 * each output packet. If this flag is not set, the pts and duration will
982 * be determined by libavcodec from the input frame.
984 #define AV_CODEC_CAP_DELAY (1 << 5)
986 * Codec can be fed a final frame with a smaller size.
987 * This can be used to prevent truncation of the last audio samples.
989 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
993 * Codec can export data for HW decoding (VDPAU).
995 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
999 * Codec can output multiple frames per AVPacket
1000 * Normally demuxers return one frame at a time, demuxers which do not do
1001 * are connected to a parser to split what they return into proper frames.
1002 * This flag is reserved to the very rare category of codecs which have a
1003 * bitstream that cannot be split into frames without timeconsuming
1004 * operations like full decoding. Demuxers carrying such bitstreams thus
1005 * may return multiple frames in a packet. This has many disadvantages like
1006 * prohibiting stream copy in many cases thus it should only be considered
1009 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1011 * Codec is experimental and is thus avoided in favor of non experimental
1014 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1016 * Codec should fill in channel configuration and samplerate instead of container
1018 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1020 * Codec supports frame-level multithreading.
1022 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1024 * Codec supports slice-based (or partition-based) multithreading.
1026 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1028 * Codec supports changed parameters at any point.
1030 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1032 * Codec supports avctx->thread_count == 0 (auto).
1034 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1036 * Audio encoder supports receiving a different number of samples in each call.
1038 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1040 * Decoder is not a preferred choice for probing.
1041 * This indicates that the decoder is not a good choice for probing.
1042 * It could for example be an expensive to spin up hardware decoder,
1043 * or it could simply not provide a lot of useful information about
1045 * A decoder marked with this flag should only be used as last resort
1046 * choice for probing.
1048 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1050 * Codec is intra only.
1052 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1054 * Codec is lossless.
1056 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1059 #if FF_API_WITHOUT_PREFIX
1061 * Allow decoders to produce frames with data planes that are not aligned
1062 * to CPU requirements (e.g. due to cropping).
1064 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1065 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1066 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1067 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1068 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1071 * @deprecated use the "gmc" private option of the libxvid encoder
1073 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1077 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1078 * mpegvideo encoders
1080 #define CODEC_FLAG_MV0 0x0040
1082 #if FF_API_INPUT_PRESERVED
1084 * @deprecated passing reference-counted frames to the encoders replaces this
1087 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1089 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1090 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1091 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1094 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1097 #define CODEC_FLAG_EMU_EDGE 0x4000
1099 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1100 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1102 #if FF_API_NORMALIZE_AQP
1104 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1105 * mpegvideo encoders
1107 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1109 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1110 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1111 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1112 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1113 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1114 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1115 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1116 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1117 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1118 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1119 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1120 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1121 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1123 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1124 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1125 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1126 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1128 /* Unsupported options :
1129 * Syntax Arithmetic coding (SAC)
1130 * Reference Picture Selection
1131 * Independent Segment Decoding */
1133 /* codec capabilities */
1135 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1137 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1138 * If not set, it might not use get_buffer() at all or use operations that
1139 * assume the buffer was allocated by avcodec_default_get_buffer.
1141 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1142 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1144 /* Codec can export data for HW decoding. This flag indicates that
1145 * the codec would call get_format() with list that might contain HW accelerated
1146 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1147 * including raw image format.
1148 * The application can use the passed context to determine bitstream version,
1149 * chroma format, resolution etc.
1151 #define CODEC_CAP_HWACCEL 0x0010
1152 #endif /* FF_API_XVMC */
1154 * Encoder or decoder requires flushing with NULL input at the end in order to
1155 * give the complete and correct output.
1157 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1158 * with NULL data. The user can still send NULL data to the public encode
1159 * or decode function, but libavcodec will not pass it along to the codec
1160 * unless this flag is set.
1163 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1164 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1168 * The encoder needs to be fed with NULL data at the end of encoding until the
1169 * encoder no longer returns data.
1171 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1172 * flag also means that the encoder must set the pts and duration for
1173 * each output packet. If this flag is not set, the pts and duration will
1174 * be determined by libavcodec from the input frame.
1176 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1178 * Codec can be fed a final frame with a smaller size.
1179 * This can be used to prevent truncation of the last audio samples.
1181 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1182 #if FF_API_CAP_VDPAU
1184 * Codec can export data for HW decoding (VDPAU).
1186 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1189 * Codec can output multiple frames per AVPacket
1190 * Normally demuxers return one frame at a time, demuxers which do not do
1191 * are connected to a parser to split what they return into proper frames.
1192 * This flag is reserved to the very rare category of codecs which have a
1193 * bitstream that cannot be split into frames without timeconsuming
1194 * operations like full decoding. Demuxers carrying such bitstreams thus
1195 * may return multiple frames in a packet. This has many disadvantages like
1196 * prohibiting stream copy in many cases thus it should only be considered
1199 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1201 * Codec is experimental and is thus avoided in favor of non experimental
1204 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1206 * Codec should fill in channel configuration and samplerate instead of container
1208 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1209 #if FF_API_NEG_LINESIZES
1211 * @deprecated no codecs use this capability
1213 #define CODEC_CAP_NEG_LINESIZES 0x0800
1216 * Codec supports frame-level multithreading.
1218 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1220 * Codec supports slice-based (or partition-based) multithreading.
1222 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1224 * Codec supports changed parameters at any point.
1226 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1228 * Codec supports avctx->thread_count == 0 (auto).
1230 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1232 * Audio encoder supports receiving a different number of samples in each call.
1234 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1236 * Codec is intra only.
1238 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1240 * Codec is lossless.
1242 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1245 * HWAccel is experimental and is thus avoided in favor of non experimental
1248 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1249 #endif /* FF_API_WITHOUT_PREFIX */
1252 //The following defines may change, don't expect compatibility if you use them.
1253 #define MB_TYPE_INTRA4x4 0x0001
1254 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1255 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1256 #define MB_TYPE_16x16 0x0008
1257 #define MB_TYPE_16x8 0x0010
1258 #define MB_TYPE_8x16 0x0020
1259 #define MB_TYPE_8x8 0x0040
1260 #define MB_TYPE_INTERLACED 0x0080
1261 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1262 #define MB_TYPE_ACPRED 0x0200
1263 #define MB_TYPE_GMC 0x0400
1264 #define MB_TYPE_SKIP 0x0800
1265 #define MB_TYPE_P0L0 0x1000
1266 #define MB_TYPE_P1L0 0x2000
1267 #define MB_TYPE_P0L1 0x4000
1268 #define MB_TYPE_P1L1 0x8000
1269 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1270 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1271 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1272 #define MB_TYPE_QUANT 0x00010000
1273 #define MB_TYPE_CBP 0x00020000
1274 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1279 * This specifies the area which should be displayed.
1280 * Note there may be multiple such areas for one frame.
1282 typedef struct AVPanScan{
1285 * - encoding: Set by user.
1286 * - decoding: Set by libavcodec.
1291 * width and height in 1/16 pel
1292 * - encoding: Set by user.
1293 * - decoding: Set by libavcodec.
1299 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1300 * - encoding: Set by user.
1301 * - decoding: Set by libavcodec.
1303 int16_t position[3][2];
1307 * This structure describes the bitrate properties of an encoded bitstream. It
1308 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1309 * parameters for H.264/HEVC.
1311 typedef struct AVCPBProperties {
1313 * Maximum bitrate of the stream, in bits per second.
1314 * Zero if unknown or unspecified.
1318 * Minimum bitrate of the stream, in bits per second.
1319 * Zero if unknown or unspecified.
1323 * Average bitrate of the stream, in bits per second.
1324 * Zero if unknown or unspecified.
1329 * The size of the buffer to which the ratecontrol is applied, in bits.
1330 * Zero if unknown or unspecified.
1335 * The delay between the time the packet this structure is associated with
1336 * is received and the time when it should be decoded, in periods of a 27MHz
1339 * UINT64_MAX when unknown or unspecified.
1344 #if FF_API_QSCALE_TYPE
1345 #define FF_QSCALE_TYPE_MPEG1 0
1346 #define FF_QSCALE_TYPE_MPEG2 1
1347 #define FF_QSCALE_TYPE_H264 2
1348 #define FF_QSCALE_TYPE_VP56 3
1352 * The decoder will keep a reference to the frame and may reuse it later.
1354 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1357 * @defgroup lavc_packet AVPacket
1359 * Types and functions for working with AVPacket.
1362 enum AVPacketSideDataType {
1363 AV_PKT_DATA_PALETTE,
1366 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1367 * that the extradata buffer was changed and the receiving side should
1368 * act upon it appropriately. The new extradata is embedded in the side
1369 * data buffer and should be immediately used for processing the current
1372 AV_PKT_DATA_NEW_EXTRADATA,
1375 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1378 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1379 * s32le channel_count
1380 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1381 * u64le channel_layout
1382 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1384 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1389 AV_PKT_DATA_PARAM_CHANGE,
1392 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1393 * structures with info about macroblocks relevant to splitting the
1394 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1395 * That is, it does not necessarily contain info about all macroblocks,
1396 * as long as the distance between macroblocks in the info is smaller
1397 * than the target payload size.
1398 * Each MB info structure is 12 bytes, and is laid out as follows:
1400 * u32le bit offset from the start of the packet
1401 * u8 current quantizer at the start of the macroblock
1403 * u16le macroblock address within the GOB
1404 * u8 horizontal MV predictor
1405 * u8 vertical MV predictor
1406 * u8 horizontal MV predictor for block number 3
1407 * u8 vertical MV predictor for block number 3
1410 AV_PKT_DATA_H263_MB_INFO,
1413 * This side data should be associated with an audio stream and contains
1414 * ReplayGain information in form of the AVReplayGain struct.
1416 AV_PKT_DATA_REPLAYGAIN,
1419 * This side data contains a 3x3 transformation matrix describing an affine
1420 * transformation that needs to be applied to the decoded video frames for
1421 * correct presentation.
1423 * See libavutil/display.h for a detailed description of the data.
1425 AV_PKT_DATA_DISPLAYMATRIX,
1428 * This side data should be associated with a video stream and contains
1429 * Stereoscopic 3D information in form of the AVStereo3D struct.
1431 AV_PKT_DATA_STEREO3D,
1434 * This side data should be associated with an audio stream and corresponds
1435 * to enum AVAudioServiceType.
1437 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1440 * This side data contains quality related information from the encoder.
1442 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1446 * u64le[error count] sum of squared differences between encoder in and output
1449 AV_PKT_DATA_QUALITY_STATS,
1452 * This side data contains an integer value representing the stream index
1453 * of a "fallback" track. A fallback track indicates an alternate
1454 * track to use when the current track can not be decoded for some reason.
1455 * e.g. no decoder available for codec.
1457 AV_PKT_DATA_FALLBACK_TRACK,
1460 * This side data corresponds to the AVCPBProperties struct.
1462 AV_PKT_DATA_CPB_PROPERTIES,
1465 * Recommmends skipping the specified number of samples
1467 * u32le number of samples to skip from start of this packet
1468 * u32le number of samples to skip from end of this packet
1469 * u8 reason for start skip
1470 * u8 reason for end skip (0=padding silence, 1=convergence)
1473 AV_PKT_DATA_SKIP_SAMPLES=70,
1476 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1477 * the packet may contain "dual mono" audio specific to Japanese DTV
1478 * and if it is true, recommends only the selected channel to be used.
1480 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1483 AV_PKT_DATA_JP_DUALMONO,
1486 * A list of zero terminated key/value strings. There is no end marker for
1487 * the list, so it is required to rely on the side data size to stop.
1489 AV_PKT_DATA_STRINGS_METADATA,
1492 * Subtitle event position
1500 AV_PKT_DATA_SUBTITLE_POSITION,
1503 * Data found in BlockAdditional element of matroska container. There is
1504 * no end marker for the data, so it is required to rely on the side data
1505 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1508 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1511 * The optional first identifier line of a WebVTT cue.
1513 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1516 * The optional settings (rendering instructions) that immediately
1517 * follow the timestamp specifier of a WebVTT cue.
1519 AV_PKT_DATA_WEBVTT_SETTINGS,
1522 * A list of zero terminated key/value strings. There is no end marker for
1523 * the list, so it is required to rely on the side data size to stop. This
1524 * side data includes updated metadata which appeared in the stream.
1526 AV_PKT_DATA_METADATA_UPDATE,
1529 * MPEGTS stream ID, this is required to pass the stream ID
1530 * information from the demuxer to the corresponding muxer.
1532 AV_PKT_DATA_MPEGTS_STREAM_ID,
1535 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1536 * should be associated with a video stream and containts data in the form
1537 * of the AVMasteringDisplayMetadata struct.
1539 AV_PKT_DATA_MASTERING_DISPLAY_METADATA
1542 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1544 typedef struct AVPacketSideData {
1547 enum AVPacketSideDataType type;
1551 * This structure stores compressed data. It is typically exported by demuxers
1552 * and then passed as input to decoders, or received as output from encoders and
1553 * then passed to muxers.
1555 * For video, it should typically contain one compressed frame. For audio it may
1556 * contain several compressed frames. Encoders are allowed to output empty
1557 * packets, with no compressed data, containing only side data
1558 * (e.g. to update some stream parameters at the end of encoding).
1560 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1561 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1562 * without libavcodec and libavformat major bump.
1564 * The semantics of data ownership depends on the buf field.
1565 * If it is set, the packet data is dynamically allocated and is
1566 * valid indefinitely until a call to av_packet_unref() reduces the
1567 * reference count to 0.
1569 * If the buf field is not set av_packet_ref() would make a copy instead
1570 * of increasing the reference count.
1572 * The side data is always allocated with av_malloc(), copied by
1573 * av_packet_ref() and freed by av_packet_unref().
1575 * @see av_packet_ref
1576 * @see av_packet_unref
1578 typedef struct AVPacket {
1580 * A reference to the reference-counted buffer where the packet data is
1582 * May be NULL, then the packet data is not reference-counted.
1586 * Presentation timestamp in AVStream->time_base units; the time at which
1587 * the decompressed packet will be presented to the user.
1588 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1589 * pts MUST be larger or equal to dts as presentation cannot happen before
1590 * decompression, unless one wants to view hex dumps. Some formats misuse
1591 * the terms dts and pts/cts to mean something different. Such timestamps
1592 * must be converted to true pts/dts before they are stored in AVPacket.
1596 * Decompression timestamp in AVStream->time_base units; the time at which
1597 * the packet is decompressed.
1598 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1605 * A combination of AV_PKT_FLAG values
1609 * Additional packet data that can be provided by the container.
1610 * Packet can contain several types of side information.
1612 AVPacketSideData *side_data;
1613 int side_data_elems;
1616 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1617 * Equals next_pts - this_pts in presentation order.
1621 int64_t pos; ///< byte position in stream, -1 if unknown
1623 #if FF_API_CONVERGENCE_DURATION
1625 * @deprecated Same as the duration field, but as int64_t. This was required
1626 * for Matroska subtitles, whose duration values could overflow when the
1627 * duration field was still an int.
1629 attribute_deprecated
1630 int64_t convergence_duration;
1633 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1634 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1636 * Flag is used to discard packets which are required to maintain valid
1637 * decoder state but are not required for output and should be dropped
1640 #define AV_PKT_FLAG_DISCARD 0x0004
1642 enum AVSideDataParamChangeFlags {
1643 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1644 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1645 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1646 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1652 struct AVCodecInternal;
1656 AV_FIELD_PROGRESSIVE,
1657 AV_FIELD_TT, //< Top coded_first, top displayed first
1658 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1659 AV_FIELD_TB, //< Top coded first, bottom displayed first
1660 AV_FIELD_BT, //< Bottom coded first, top displayed first
1664 * main external API structure.
1665 * New fields can be added to the end with minor version bumps.
1666 * Removal, reordering and changes to existing fields require a major
1668 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1670 * The name string for AVOptions options matches the associated command line
1671 * parameter name and can be found in libavcodec/options_table.h
1672 * The AVOption/command line parameter names differ in some cases from the C
1673 * structure field names for historic reasons or brevity.
1674 * sizeof(AVCodecContext) must not be used outside libav*.
1676 typedef struct AVCodecContext {
1678 * information on struct for av_log
1679 * - set by avcodec_alloc_context3
1681 const AVClass *av_class;
1682 int log_level_offset;
1684 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1685 const struct AVCodec *codec;
1686 #if FF_API_CODEC_NAME
1688 * @deprecated this field is not used for anything in libavcodec
1690 attribute_deprecated
1691 char codec_name[32];
1693 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1696 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1697 * This is used to work around some encoder bugs.
1698 * A demuxer should set this to what is stored in the field used to identify the codec.
1699 * If there are multiple such fields in a container then the demuxer should choose the one
1700 * which maximizes the information about the used codec.
1701 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1702 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1703 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1705 * - encoding: Set by user, if not then the default based on codec_id will be used.
1706 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1708 unsigned int codec_tag;
1710 #if FF_API_STREAM_CODEC_TAG
1712 * @deprecated this field is unused
1714 attribute_deprecated
1715 unsigned int stream_codec_tag;
1721 * Private context used for internal data.
1723 * Unlike priv_data, this is not codec-specific. It is used in general
1724 * libavcodec functions.
1726 struct AVCodecInternal *internal;
1729 * Private data of the user, can be used to carry app specific stuff.
1730 * - encoding: Set by user.
1731 * - decoding: Set by user.
1736 * the average bitrate
1737 * - encoding: Set by user; unused for constant quantizer encoding.
1738 * - decoding: Set by user, may be overwritten by libavcodec
1739 * if this info is available in the stream
1744 * number of bits the bitstream is allowed to diverge from the reference.
1745 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1746 * - encoding: Set by user; unused for constant quantizer encoding.
1747 * - decoding: unused
1749 int bit_rate_tolerance;
1752 * Global quality for codecs which cannot change it per frame.
1753 * This should be proportional to MPEG-1/2/4 qscale.
1754 * - encoding: Set by user.
1755 * - decoding: unused
1760 * - encoding: Set by user.
1761 * - decoding: unused
1763 int compression_level;
1764 #define FF_COMPRESSION_DEFAULT -1
1768 * - encoding: Set by user.
1769 * - decoding: Set by user.
1775 * - encoding: Set by user.
1776 * - decoding: Set by user.
1781 * some codecs need / can use extradata like Huffman tables.
1782 * MJPEG: Huffman tables
1783 * rv10: additional flags
1784 * MPEG-4: global headers (they can be in the bitstream or here)
1785 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1786 * than extradata_size to avoid problems if it is read with the bitstream reader.
1787 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1788 * - encoding: Set/allocated/freed by libavcodec.
1789 * - decoding: Set/allocated/freed by user.
1795 * This is the fundamental unit of time (in seconds) in terms
1796 * of which frame timestamps are represented. For fixed-fps content,
1797 * timebase should be 1/framerate and timestamp increments should be
1799 * This often, but not always is the inverse of the frame rate or field rate
1800 * for video. 1/time_base is not the average frame rate if the frame rate is not
1803 * Like containers, elementary streams also can store timestamps, 1/time_base
1804 * is the unit in which these timestamps are specified.
1805 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1806 * vop_time_increment_resolution and fixed_vop_rate
1807 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1809 * - encoding: MUST be set by user.
1810 * - decoding: the use of this field for decoding is deprecated.
1811 * Use framerate instead.
1813 AVRational time_base;
1816 * For some codecs, the time base is closer to the field rate than the frame rate.
1817 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1818 * if no telecine is used ...
1820 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1822 int ticks_per_frame;
1827 * Encoding: Number of frames delay there will be from the encoder input to
1828 * the decoder output. (we assume the decoder matches the spec)
1829 * Decoding: Number of frames delay in addition to what a standard decoder
1830 * as specified in the spec would produce.
1833 * Number of frames the decoded output will be delayed relative to the
1837 * For encoding, this field is unused (see initial_padding).
1839 * For decoding, this is the number of samples the decoder needs to
1840 * output before the decoder's output is valid. When seeking, you should
1841 * start decoding this many samples prior to your desired seek point.
1843 * - encoding: Set by libavcodec.
1844 * - decoding: Set by libavcodec.
1851 * picture width / height.
1853 * @note Those fields may not match the values of the last
1854 * AVFrame output by avcodec_decode_video2 due frame
1857 * - encoding: MUST be set by user.
1858 * - decoding: May be set by the user before opening the decoder if known e.g.
1859 * from the container. Some decoders will require the dimensions
1860 * to be set by the caller. During decoding, the decoder may
1861 * overwrite those values as required while parsing the data.
1866 * Bitstream width / height, may be different from width/height e.g. when
1867 * the decoded frame is cropped before being output or lowres is enabled.
1869 * @note Those field may not match the value of the last
1870 * AVFrame output by avcodec_receive_frame() due frame
1873 * - encoding: unused
1874 * - decoding: May be set by the user before opening the decoder if known
1875 * e.g. from the container. During decoding, the decoder may
1876 * overwrite those values as required while parsing the data.
1878 int coded_width, coded_height;
1880 #if FF_API_ASPECT_EXTENDED
1881 #define FF_ASPECT_EXTENDED 15
1885 * the number of pictures in a group of pictures, or 0 for intra_only
1886 * - encoding: Set by user.
1887 * - decoding: unused
1892 * Pixel format, see AV_PIX_FMT_xxx.
1893 * May be set by the demuxer if known from headers.
1894 * May be overridden by the decoder if it knows better.
1896 * @note This field may not match the value of the last
1897 * AVFrame output by avcodec_receive_frame() due frame
1900 * - encoding: Set by user.
1901 * - decoding: Set by user if known, overridden by libavcodec while
1904 enum AVPixelFormat pix_fmt;
1906 #if FF_API_MOTION_EST
1908 * This option does nothing
1909 * @deprecated use codec private options instead
1911 attribute_deprecated int me_method;
1915 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1916 * decoder to draw a horizontal band. It improves cache usage. Not
1917 * all codecs can do that. You must check the codec capabilities
1919 * When multithreading is used, it may be called from multiple threads
1920 * at the same time; threads might draw different parts of the same AVFrame,
1921 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1923 * The function is also used by hardware acceleration APIs.
1924 * It is called at least once during frame decoding to pass
1925 * the data needed for hardware render.
1926 * In that mode instead of pixel data, AVFrame points to
1927 * a structure specific to the acceleration API. The application
1928 * reads the structure and can change some fields to indicate progress
1930 * - encoding: unused
1931 * - decoding: Set by user.
1932 * @param height the height of the slice
1933 * @param y the y position of the slice
1934 * @param type 1->top field, 2->bottom field, 3->frame
1935 * @param offset offset into the AVFrame.data from which the slice should be read
1937 void (*draw_horiz_band)(struct AVCodecContext *s,
1938 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1939 int y, int type, int height);
1942 * callback to negotiate the pixelFormat
1943 * @param fmt is the list of formats which are supported by the codec,
1944 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1945 * The first is always the native one.
1946 * @note The callback may be called again immediately if initialization for
1947 * the selected (hardware-accelerated) pixel format failed.
1948 * @warning Behavior is undefined if the callback returns a value not
1949 * in the fmt list of formats.
1950 * @return the chosen format
1951 * - encoding: unused
1952 * - decoding: Set by user, if not set the native format will be chosen.
1954 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1957 * maximum number of B-frames between non-B-frames
1958 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1959 * - encoding: Set by user.
1960 * - decoding: unused
1965 * qscale factor between IP and B-frames
1966 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1967 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1968 * - encoding: Set by user.
1969 * - decoding: unused
1971 float b_quant_factor;
1973 #if FF_API_RC_STRATEGY
1974 /** @deprecated use codec private option instead */
1975 attribute_deprecated int rc_strategy;
1976 #define FF_RC_STRATEGY_XVID 1
1979 #if FF_API_PRIVATE_OPT
1980 /** @deprecated use encoder private options instead */
1981 attribute_deprecated
1982 int b_frame_strategy;
1986 * qscale offset between IP and B-frames
1987 * - encoding: Set by user.
1988 * - decoding: unused
1990 float b_quant_offset;
1993 * Size of the frame reordering buffer in the decoder.
1994 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1995 * - encoding: Set by libavcodec.
1996 * - decoding: Set by libavcodec.
2000 #if FF_API_PRIVATE_OPT
2001 /** @deprecated use encoder private options instead */
2002 attribute_deprecated
2007 * qscale factor between P- and I-frames
2008 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2009 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2010 * - encoding: Set by user.
2011 * - decoding: unused
2013 float i_quant_factor;
2016 * qscale offset between P and I-frames
2017 * - encoding: Set by user.
2018 * - decoding: unused
2020 float i_quant_offset;
2023 * luminance masking (0-> disabled)
2024 * - encoding: Set by user.
2025 * - decoding: unused
2030 * temporary complexity masking (0-> disabled)
2031 * - encoding: Set by user.
2032 * - decoding: unused
2034 float temporal_cplx_masking;
2037 * spatial complexity masking (0-> disabled)
2038 * - encoding: Set by user.
2039 * - decoding: unused
2041 float spatial_cplx_masking;
2044 * p block masking (0-> disabled)
2045 * - encoding: Set by user.
2046 * - decoding: unused
2051 * darkness masking (0-> disabled)
2052 * - encoding: Set by user.
2053 * - decoding: unused
2059 * - encoding: Set by libavcodec.
2060 * - decoding: Set by user (or 0).
2064 #if FF_API_PRIVATE_OPT
2065 /** @deprecated use encoder private options instead */
2066 attribute_deprecated
2067 int prediction_method;
2068 #define FF_PRED_LEFT 0
2069 #define FF_PRED_PLANE 1
2070 #define FF_PRED_MEDIAN 2
2074 * slice offsets in the frame in bytes
2075 * - encoding: Set/allocated by libavcodec.
2076 * - decoding: Set/allocated by user (or NULL).
2081 * sample aspect ratio (0 if unknown)
2082 * That is the width of a pixel divided by the height of the pixel.
2083 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2084 * - encoding: Set by user.
2085 * - decoding: Set by libavcodec.
2087 AVRational sample_aspect_ratio;
2090 * motion estimation comparison function
2091 * - encoding: Set by user.
2092 * - decoding: unused
2096 * subpixel motion estimation comparison function
2097 * - encoding: Set by user.
2098 * - decoding: unused
2102 * macroblock comparison function (not supported yet)
2103 * - encoding: Set by user.
2104 * - decoding: unused
2108 * interlaced DCT comparison function
2109 * - encoding: Set by user.
2110 * - decoding: unused
2113 #define FF_CMP_SAD 0
2114 #define FF_CMP_SSE 1
2115 #define FF_CMP_SATD 2
2116 #define FF_CMP_DCT 3
2117 #define FF_CMP_PSNR 4
2118 #define FF_CMP_BIT 5
2120 #define FF_CMP_ZERO 7
2121 #define FF_CMP_VSAD 8
2122 #define FF_CMP_VSSE 9
2123 #define FF_CMP_NSSE 10
2124 #define FF_CMP_W53 11
2125 #define FF_CMP_W97 12
2126 #define FF_CMP_DCTMAX 13
2127 #define FF_CMP_DCT264 14
2128 #define FF_CMP_MEDIAN_SAD 15
2129 #define FF_CMP_CHROMA 256
2132 * ME diamond size & shape
2133 * - encoding: Set by user.
2134 * - decoding: unused
2139 * amount of previous MV predictors (2a+1 x 2a+1 square)
2140 * - encoding: Set by user.
2141 * - decoding: unused
2143 int last_predictor_count;
2145 #if FF_API_PRIVATE_OPT
2146 /** @deprecated use encoder private options instead */
2147 attribute_deprecated
2152 * motion estimation prepass comparison function
2153 * - encoding: Set by user.
2154 * - decoding: unused
2159 * ME prepass diamond size & shape
2160 * - encoding: Set by user.
2161 * - decoding: unused
2167 * - encoding: Set by user.
2168 * - decoding: unused
2170 int me_subpel_quality;
2174 * DTG active format information (additional aspect ratio
2175 * information only used in DVB MPEG-2 transport streams)
2178 * - encoding: unused
2179 * - decoding: Set by decoder.
2180 * @deprecated Deprecated in favor of AVSideData
2182 attribute_deprecated int dtg_active_format;
2183 #define FF_DTG_AFD_SAME 8
2184 #define FF_DTG_AFD_4_3 9
2185 #define FF_DTG_AFD_16_9 10
2186 #define FF_DTG_AFD_14_9 11
2187 #define FF_DTG_AFD_4_3_SP_14_9 13
2188 #define FF_DTG_AFD_16_9_SP_14_9 14
2189 #define FF_DTG_AFD_SP_4_3 15
2190 #endif /* FF_API_AFD */
2193 * maximum motion estimation search range in subpel units
2194 * If 0 then no limit.
2196 * - encoding: Set by user.
2197 * - decoding: unused
2201 #if FF_API_QUANT_BIAS
2203 * @deprecated use encoder private option instead
2205 attribute_deprecated int intra_quant_bias;
2206 #define FF_DEFAULT_QUANT_BIAS 999999
2209 * @deprecated use encoder private option instead
2211 attribute_deprecated int inter_quant_bias;
2216 * - encoding: unused
2217 * - decoding: Set by user.
2220 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2221 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2222 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2226 * XVideo Motion Acceleration
2227 * - encoding: forbidden
2228 * - decoding: set by decoder
2229 * @deprecated XvMC doesn't need it anymore.
2231 attribute_deprecated int xvmc_acceleration;
2232 #endif /* FF_API_XVMC */
2235 * macroblock decision mode
2236 * - encoding: Set by user.
2237 * - decoding: unused
2240 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2241 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2242 #define FF_MB_DECISION_RD 2 ///< rate distortion
2245 * custom intra quantization matrix
2246 * - encoding: Set by user, can be NULL.
2247 * - decoding: Set by libavcodec.
2249 uint16_t *intra_matrix;
2252 * custom inter quantization matrix
2253 * - encoding: Set by user, can be NULL.
2254 * - decoding: Set by libavcodec.
2256 uint16_t *inter_matrix;
2258 #if FF_API_PRIVATE_OPT
2259 /** @deprecated use encoder private options instead */
2260 attribute_deprecated
2261 int scenechange_threshold;
2263 /** @deprecated use encoder private options instead */
2264 attribute_deprecated
2265 int noise_reduction;
2270 * @deprecated this field is unused
2272 attribute_deprecated
2276 * @deprecated this field is unused
2278 attribute_deprecated
2283 * precision of the intra DC coefficient - 8
2284 * - encoding: Set by user.
2285 * - decoding: Set by libavcodec
2287 int intra_dc_precision;
2290 * Number of macroblock rows at the top which are skipped.
2291 * - encoding: unused
2292 * - decoding: Set by user.
2297 * Number of macroblock rows at the bottom which are skipped.
2298 * - encoding: unused
2299 * - decoding: Set by user.
2305 * @deprecated use encoder private options instead
2307 attribute_deprecated
2308 float border_masking;
2312 * minimum MB Lagrange multiplier
2313 * - encoding: Set by user.
2314 * - decoding: unused
2319 * maximum MB Lagrange multiplier
2320 * - encoding: Set by user.
2321 * - decoding: unused
2325 #if FF_API_PRIVATE_OPT
2327 * @deprecated use encoder private options instead
2329 attribute_deprecated
2330 int me_penalty_compensation;
2334 * - encoding: Set by user.
2335 * - decoding: unused
2339 #if FF_API_PRIVATE_OPT
2340 /** @deprecated use encoder private options instead */
2341 attribute_deprecated
2347 * - encoding: Set by user.
2348 * - decoding: unused
2353 * number of reference frames
2354 * - encoding: Set by user.
2355 * - decoding: Set by lavc.
2359 #if FF_API_PRIVATE_OPT
2360 /** @deprecated use encoder private options instead */
2361 attribute_deprecated
2365 #if FF_API_UNUSED_MEMBERS
2367 * Multiplied by qscale for each frame and added to scene_change_score.
2368 * - encoding: Set by user.
2369 * - decoding: unused
2371 attribute_deprecated int scenechange_factor;
2375 * Note: Value depends upon the compare function used for fullpel ME.
2376 * - encoding: Set by user.
2377 * - decoding: unused
2381 #if FF_API_PRIVATE_OPT
2382 /** @deprecated use encoder private options instead */
2383 attribute_deprecated
2388 * Chromaticity coordinates of the source primaries.
2389 * - encoding: Set by user
2390 * - decoding: Set by libavcodec
2392 enum AVColorPrimaries color_primaries;
2395 * Color Transfer Characteristic.
2396 * - encoding: Set by user
2397 * - decoding: Set by libavcodec
2399 enum AVColorTransferCharacteristic color_trc;
2402 * YUV colorspace type.
2403 * - encoding: Set by user
2404 * - decoding: Set by libavcodec
2406 enum AVColorSpace colorspace;
2409 * MPEG vs JPEG YUV range.
2410 * - encoding: Set by user
2411 * - decoding: Set by libavcodec
2413 enum AVColorRange color_range;
2416 * This defines the location of chroma samples.
2417 * - encoding: Set by user
2418 * - decoding: Set by libavcodec
2420 enum AVChromaLocation chroma_sample_location;
2424 * Indicates number of picture subdivisions. Used for parallelized
2426 * - encoding: Set by user
2427 * - decoding: unused
2432 * - encoding: set by libavcodec
2433 * - decoding: Set by user.
2435 enum AVFieldOrder field_order;
2438 int sample_rate; ///< samples per second
2439 int channels; ///< number of audio channels
2442 * audio sample format
2443 * - encoding: Set by user.
2444 * - decoding: Set by libavcodec.
2446 enum AVSampleFormat sample_fmt; ///< sample format
2448 /* The following data should not be initialized. */
2450 * Number of samples per channel in an audio frame.
2452 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2453 * except the last must contain exactly frame_size samples per channel.
2454 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2455 * frame size is not restricted.
2456 * - decoding: may be set by some decoders to indicate constant frame size
2461 * Frame counter, set by libavcodec.
2463 * - decoding: total number of frames returned from the decoder so far.
2464 * - encoding: total number of frames passed to the encoder so far.
2466 * @note the counter is not incremented if encoding/decoding resulted in
2472 * number of bytes per packet if constant and known or 0
2473 * Used by some WAV based audio codecs.
2478 * Audio cutoff bandwidth (0 means "automatic")
2479 * - encoding: Set by user.
2480 * - decoding: unused
2485 * Audio channel layout.
2486 * - encoding: set by user.
2487 * - decoding: set by user, may be overwritten by libavcodec.
2489 uint64_t channel_layout;
2492 * Request decoder to use this channel layout if it can (0 for default)
2493 * - encoding: unused
2494 * - decoding: Set by user.
2496 uint64_t request_channel_layout;
2499 * Type of service that the audio stream conveys.
2500 * - encoding: Set by user.
2501 * - decoding: Set by libavcodec.
2503 enum AVAudioServiceType audio_service_type;
2506 * desired sample format
2507 * - encoding: Not used.
2508 * - decoding: Set by user.
2509 * Decoder will decode to this format if it can.
2511 enum AVSampleFormat request_sample_fmt;
2514 * This callback is called at the beginning of each frame to get data
2515 * buffer(s) for it. There may be one contiguous buffer for all the data or
2516 * there may be a buffer per each data plane or anything in between. What
2517 * this means is, you may set however many entries in buf[] you feel necessary.
2518 * Each buffer must be reference-counted using the AVBuffer API (see description
2521 * The following fields will be set in the frame before this callback is
2524 * - width, height (video only)
2525 * - sample_rate, channel_layout, nb_samples (audio only)
2526 * Their values may differ from the corresponding values in
2527 * AVCodecContext. This callback must use the frame values, not the codec
2528 * context values, to calculate the required buffer size.
2530 * This callback must fill the following fields in the frame:
2534 * * if the data is planar audio with more than 8 channels, then this
2535 * callback must allocate and fill extended_data to contain all pointers
2536 * to all data planes. data[] must hold as many pointers as it can.
2537 * extended_data must be allocated with av_malloc() and will be freed in
2539 * * otherwise extended_data must point to data
2540 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2541 * the frame's data and extended_data pointers must be contained in these. That
2542 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2543 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2544 * and av_buffer_ref().
2545 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2546 * this callback and filled with the extra buffers if there are more
2547 * buffers than buf[] can hold. extended_buf will be freed in
2550 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2551 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2554 * Each data plane must be aligned to the maximum required by the target
2557 * @see avcodec_default_get_buffer2()
2561 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2562 * (read and/or written to if it is writable) later by libavcodec.
2564 * avcodec_align_dimensions2() should be used to find the required width and
2565 * height, as they normally need to be rounded up to the next multiple of 16.
2567 * Some decoders do not support linesizes changing between frames.
2569 * If frame multithreading is used and thread_safe_callbacks is set,
2570 * this callback may be called from a different thread, but not from more
2571 * than one at once. Does not need to be reentrant.
2573 * @see avcodec_align_dimensions2()
2577 * Decoders request a buffer of a particular size by setting
2578 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2579 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2580 * to a smaller value in the output frame.
2582 * As a convenience, av_samples_get_buffer_size() and
2583 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2584 * functions to find the required data size and to fill data pointers and
2585 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2586 * since all planes must be the same size.
2588 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2590 * - encoding: unused
2591 * - decoding: Set by libavcodec, user can override.
2593 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2596 * If non-zero, the decoded audio and video frames returned from
2597 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2598 * and are valid indefinitely. The caller must free them with
2599 * av_frame_unref() when they are not needed anymore.
2600 * Otherwise, the decoded frames must not be freed by the caller and are
2601 * only valid until the next decode call.
2603 * This is always automatically enabled if avcodec_receive_frame() is used.
2605 * - encoding: unused
2606 * - decoding: set by the caller before avcodec_open2().
2608 int refcounted_frames;
2610 /* - encoding parameters */
2611 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2612 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2616 * - encoding: Set by user.
2617 * - decoding: unused
2623 * - encoding: Set by user.
2624 * - decoding: unused
2629 * maximum quantizer difference between frames
2630 * - encoding: Set by user.
2631 * - decoding: unused
2637 * @deprecated use encoder private options instead
2639 attribute_deprecated
2642 attribute_deprecated
2644 attribute_deprecated
2649 * decoder bitstream buffer size
2650 * - encoding: Set by user.
2651 * - decoding: unused
2656 * ratecontrol override, see RcOverride
2657 * - encoding: Allocated/set/freed by user.
2658 * - decoding: unused
2660 int rc_override_count;
2661 RcOverride *rc_override;
2665 * @deprecated use encoder private options instead
2667 attribute_deprecated
2673 * - encoding: Set by user.
2674 * - decoding: Set by user, may be overwritten by libavcodec.
2676 int64_t rc_max_rate;
2680 * - encoding: Set by user.
2681 * - decoding: unused
2683 int64_t rc_min_rate;
2687 * @deprecated use encoder private options instead
2689 attribute_deprecated
2690 float rc_buffer_aggressivity;
2692 attribute_deprecated
2693 float rc_initial_cplx;
2697 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2698 * - encoding: Set by user.
2699 * - decoding: unused.
2701 float rc_max_available_vbv_use;
2704 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2705 * - encoding: Set by user.
2706 * - decoding: unused.
2708 float rc_min_vbv_overflow_use;
2711 * Number of bits which should be loaded into the rc buffer before decoding starts.
2712 * - encoding: Set by user.
2713 * - decoding: unused
2715 int rc_initial_buffer_occupancy;
2717 #if FF_API_CODER_TYPE
2718 #define FF_CODER_TYPE_VLC 0
2719 #define FF_CODER_TYPE_AC 1
2720 #define FF_CODER_TYPE_RAW 2
2721 #define FF_CODER_TYPE_RLE 3
2722 #if FF_API_UNUSED_MEMBERS
2723 #define FF_CODER_TYPE_DEFLATE 4
2724 #endif /* FF_API_UNUSED_MEMBERS */
2726 * @deprecated use encoder private options instead
2728 attribute_deprecated
2730 #endif /* FF_API_CODER_TYPE */
2732 #if FF_API_PRIVATE_OPT
2733 /** @deprecated use encoder private options instead */
2734 attribute_deprecated
2740 * @deprecated use encoder private options instead
2742 attribute_deprecated
2746 * @deprecated use encoder private options instead
2748 attribute_deprecated
2752 #if FF_API_PRIVATE_OPT
2753 /** @deprecated use encoder private options instead */
2754 attribute_deprecated
2755 int frame_skip_threshold;
2757 /** @deprecated use encoder private options instead */
2758 attribute_deprecated
2759 int frame_skip_factor;
2761 /** @deprecated use encoder private options instead */
2762 attribute_deprecated
2765 /** @deprecated use encoder private options instead */
2766 attribute_deprecated
2768 #endif /* FF_API_PRIVATE_OPT */
2771 * trellis RD quantization
2772 * - encoding: Set by user.
2773 * - decoding: unused
2777 #if FF_API_PRIVATE_OPT
2778 /** @deprecated use encoder private options instead */
2779 attribute_deprecated
2780 int min_prediction_order;
2782 /** @deprecated use encoder private options instead */
2783 attribute_deprecated
2784 int max_prediction_order;
2786 /** @deprecated use encoder private options instead */
2787 attribute_deprecated
2788 int64_t timecode_frame_start;
2791 #if FF_API_RTP_CALLBACK
2793 * @deprecated unused
2795 /* The RTP callback: This function is called */
2796 /* every time the encoder has a packet to send. */
2797 /* It depends on the encoder if the data starts */
2798 /* with a Start Code (it should). H.263 does. */
2799 /* mb_nb contains the number of macroblocks */
2800 /* encoded in the RTP payload. */
2801 attribute_deprecated
2802 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2805 #if FF_API_PRIVATE_OPT
2806 /** @deprecated use encoder private options instead */
2807 attribute_deprecated
2808 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2809 /* do its best to deliver a chunk with size */
2810 /* below rtp_payload_size, the chunk will start */
2811 /* with a start code on some codecs like H.263. */
2812 /* This doesn't take account of any particular */
2813 /* headers inside the transmitted RTP payload. */
2816 #if FF_API_STAT_BITS
2817 /* statistics, used for 2-pass encoding */
2818 attribute_deprecated
2820 attribute_deprecated
2822 attribute_deprecated
2824 attribute_deprecated
2826 attribute_deprecated
2828 attribute_deprecated
2830 attribute_deprecated
2832 attribute_deprecated
2835 /** @deprecated this field is unused */
2836 attribute_deprecated
2841 * pass1 encoding statistics output buffer
2842 * - encoding: Set by libavcodec.
2843 * - decoding: unused
2848 * pass2 encoding statistics input buffer
2849 * Concatenated stuff from stats_out of pass1 should be placed here.
2850 * - encoding: Allocated/set/freed by user.
2851 * - decoding: unused
2856 * Work around bugs in encoders which sometimes cannot be detected automatically.
2857 * - encoding: Set by user
2858 * - decoding: Set by user
2860 int workaround_bugs;
2861 #define FF_BUG_AUTODETECT 1 ///< autodetection
2862 #if FF_API_OLD_MSMPEG4
2863 #define FF_BUG_OLD_MSMPEG4 2
2865 #define FF_BUG_XVID_ILACE 4
2866 #define FF_BUG_UMP4 8
2867 #define FF_BUG_NO_PADDING 16
2868 #define FF_BUG_AMV 32
2870 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2872 #define FF_BUG_QPEL_CHROMA 64
2873 #define FF_BUG_STD_QPEL 128
2874 #define FF_BUG_QPEL_CHROMA2 256
2875 #define FF_BUG_DIRECT_BLOCKSIZE 512
2876 #define FF_BUG_EDGE 1024
2877 #define FF_BUG_HPEL_CHROMA 2048
2878 #define FF_BUG_DC_CLIP 4096
2879 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2880 #define FF_BUG_TRUNCATED 16384
2883 * strictly follow the standard (MPEG-4, ...).
2884 * - encoding: Set by user.
2885 * - decoding: Set by user.
2886 * Setting this to STRICT or higher means the encoder and decoder will
2887 * generally do stupid things, whereas setting it to unofficial or lower
2888 * will mean the encoder might produce output that is not supported by all
2889 * spec-compliant decoders. Decoders don't differentiate between normal,
2890 * unofficial and experimental (that is, they always try to decode things
2891 * when they can) unless they are explicitly asked to behave stupidly
2892 * (=strictly conform to the specs)
2894 int strict_std_compliance;
2895 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2896 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2897 #define FF_COMPLIANCE_NORMAL 0
2898 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2899 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2902 * error concealment flags
2903 * - encoding: unused
2904 * - decoding: Set by user.
2906 int error_concealment;
2907 #define FF_EC_GUESS_MVS 1
2908 #define FF_EC_DEBLOCK 2
2909 #define FF_EC_FAVOR_INTER 256
2913 * - encoding: Set by user.
2914 * - decoding: Set by user.
2917 #define FF_DEBUG_PICT_INFO 1
2918 #define FF_DEBUG_RC 2
2919 #define FF_DEBUG_BITSTREAM 4
2920 #define FF_DEBUG_MB_TYPE 8
2921 #define FF_DEBUG_QP 16
2924 * @deprecated this option does nothing
2926 #define FF_DEBUG_MV 32
2928 #define FF_DEBUG_DCT_COEFF 0x00000040
2929 #define FF_DEBUG_SKIP 0x00000080
2930 #define FF_DEBUG_STARTCODE 0x00000100
2931 #if FF_API_UNUSED_MEMBERS
2932 #define FF_DEBUG_PTS 0x00000200
2933 #endif /* FF_API_UNUSED_MEMBERS */
2934 #define FF_DEBUG_ER 0x00000400
2935 #define FF_DEBUG_MMCO 0x00000800
2936 #define FF_DEBUG_BUGS 0x00001000
2938 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2939 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2941 #define FF_DEBUG_BUFFERS 0x00008000
2942 #define FF_DEBUG_THREADS 0x00010000
2943 #define FF_DEBUG_GREEN_MD 0x00800000
2944 #define FF_DEBUG_NOMC 0x01000000
2949 * Code outside libavcodec should access this field using AVOptions
2950 * - encoding: Set by user.
2951 * - decoding: Set by user.
2954 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2955 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2956 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2960 * Error recognition; may misdetect some more or less valid parts as errors.
2961 * - encoding: unused
2962 * - decoding: Set by user.
2964 int err_recognition;
2967 * Verify checksums embedded in the bitstream (could be of either encoded or
2968 * decoded data, depending on the codec) and print an error message on mismatch.
2969 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2970 * decoder returning an error.
2972 #define AV_EF_CRCCHECK (1<<0)
2973 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2974 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2975 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2977 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2978 #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
2979 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2980 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2984 * opaque 64-bit number (generally a PTS) that will be reordered and
2985 * output in AVFrame.reordered_opaque
2986 * - encoding: unused
2987 * - decoding: Set by user.
2989 int64_t reordered_opaque;
2992 * Hardware accelerator in use
2993 * - encoding: unused.
2994 * - decoding: Set by libavcodec
2996 struct AVHWAccel *hwaccel;
2999 * Hardware accelerator context.
3000 * For some hardware accelerators, a global context needs to be
3001 * provided by the user. In that case, this holds display-dependent
3002 * data FFmpeg cannot instantiate itself. Please refer to the
3003 * FFmpeg HW accelerator documentation to know how to fill this
3004 * is. e.g. for VA API, this is a struct vaapi_context.
3005 * - encoding: unused
3006 * - decoding: Set by user
3008 void *hwaccel_context;
3012 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3013 * - decoding: unused
3015 uint64_t error[AV_NUM_DATA_POINTERS];
3018 * DCT algorithm, see FF_DCT_* below
3019 * - encoding: Set by user.
3020 * - decoding: unused
3023 #define FF_DCT_AUTO 0
3024 #define FF_DCT_FASTINT 1
3025 #define FF_DCT_INT 2
3026 #define FF_DCT_MMX 3
3027 #define FF_DCT_ALTIVEC 5
3028 #define FF_DCT_FAAN 6
3031 * IDCT algorithm, see FF_IDCT_* below.
3032 * - encoding: Set by user.
3033 * - decoding: Set by user.
3036 #define FF_IDCT_AUTO 0
3037 #define FF_IDCT_INT 1
3038 #define FF_IDCT_SIMPLE 2
3039 #define FF_IDCT_SIMPLEMMX 3
3040 #define FF_IDCT_ARM 7
3041 #define FF_IDCT_ALTIVEC 8
3043 #define FF_IDCT_SH4 9
3045 #define FF_IDCT_SIMPLEARM 10
3046 #if FF_API_UNUSED_MEMBERS
3047 #define FF_IDCT_IPP 13
3048 #endif /* FF_API_UNUSED_MEMBERS */
3049 #define FF_IDCT_XVID 14
3050 #if FF_API_IDCT_XVIDMMX
3051 #define FF_IDCT_XVIDMMX 14
3052 #endif /* FF_API_IDCT_XVIDMMX */
3053 #define FF_IDCT_SIMPLEARMV5TE 16
3054 #define FF_IDCT_SIMPLEARMV6 17
3055 #if FF_API_ARCH_SPARC
3056 #define FF_IDCT_SIMPLEVIS 18
3058 #define FF_IDCT_FAAN 20
3059 #define FF_IDCT_SIMPLENEON 22
3060 #if FF_API_ARCH_ALPHA
3061 #define FF_IDCT_SIMPLEALPHA 23
3063 #define FF_IDCT_SIMPLEAUTO 128
3066 * bits per sample/pixel from the demuxer (needed for huffyuv).
3067 * - encoding: Set by libavcodec.
3068 * - decoding: Set by user.
3070 int bits_per_coded_sample;
3073 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3074 * - encoding: set by user.
3075 * - decoding: set by libavcodec.
3077 int bits_per_raw_sample;
3081 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3082 * - encoding: unused
3083 * - decoding: Set by user.
3084 * Code outside libavcodec should access this field using:
3085 * av_codec_{get,set}_lowres(avctx)
3090 #if FF_API_CODED_FRAME
3092 * the picture in the bitstream
3093 * - encoding: Set by libavcodec.
3094 * - decoding: unused
3096 * @deprecated use the quality factor packet side data instead
3098 attribute_deprecated AVFrame *coded_frame;
3103 * is used to decide how many independent tasks should be passed to execute()
3104 * - encoding: Set by user.
3105 * - decoding: Set by user.
3110 * Which multithreading methods to use.
3111 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3112 * so clients which cannot provide future frames should not use it.
3114 * - encoding: Set by user, otherwise the default is used.
3115 * - decoding: Set by user, otherwise the default is used.
3118 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3119 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3122 * Which multithreading methods are in use by the codec.
3123 * - encoding: Set by libavcodec.
3124 * - decoding: Set by libavcodec.
3126 int active_thread_type;
3129 * Set by the client if its custom get_buffer() callback can be called
3130 * synchronously from another thread, which allows faster multithreaded decoding.
3131 * draw_horiz_band() will be called from other threads regardless of this setting.
3132 * Ignored if the default get_buffer() is used.
3133 * - encoding: Set by user.
3134 * - decoding: Set by user.
3136 int thread_safe_callbacks;
3139 * The codec may call this to execute several independent things.
3140 * It will return only after finishing all tasks.
3141 * The user may replace this with some multithreaded implementation,
3142 * the default implementation will execute the parts serially.
3143 * @param count the number of things to execute
3144 * - encoding: Set by libavcodec, user can override.
3145 * - decoding: Set by libavcodec, user can override.
3147 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3150 * The codec may call this to execute several independent things.
3151 * It will return only after finishing all tasks.
3152 * The user may replace this with some multithreaded implementation,
3153 * the default implementation will execute the parts serially.
3154 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3155 * @param c context passed also to func
3156 * @param count the number of things to execute
3157 * @param arg2 argument passed unchanged to func
3158 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3159 * @param func function that will be called count times, with jobnr from 0 to count-1.
3160 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3161 * two instances of func executing at the same time will have the same threadnr.
3162 * @return always 0 currently, but code should handle a future improvement where when any call to func
3163 * returns < 0 no further calls to func may be done and < 0 is returned.
3164 * - encoding: Set by libavcodec, user can override.
3165 * - decoding: Set by libavcodec, user can override.
3167 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3170 * noise vs. sse weight for the nsse comparison function
3171 * - encoding: Set by user.
3172 * - decoding: unused
3178 * - encoding: Set by user.
3179 * - decoding: Set by libavcodec.
3182 #define FF_PROFILE_UNKNOWN -99
3183 #define FF_PROFILE_RESERVED -100
3185 #define FF_PROFILE_AAC_MAIN 0
3186 #define FF_PROFILE_AAC_LOW 1
3187 #define FF_PROFILE_AAC_SSR 2
3188 #define FF_PROFILE_AAC_LTP 3
3189 #define FF_PROFILE_AAC_HE 4
3190 #define FF_PROFILE_AAC_HE_V2 28
3191 #define FF_PROFILE_AAC_LD 22
3192 #define FF_PROFILE_AAC_ELD 38
3193 #define FF_PROFILE_MPEG2_AAC_LOW 128
3194 #define FF_PROFILE_MPEG2_AAC_HE 131
3196 #define FF_PROFILE_DNXHD 0
3197 #define FF_PROFILE_DNXHR_LB 1
3198 #define FF_PROFILE_DNXHR_SQ 2
3199 #define FF_PROFILE_DNXHR_HQ 3
3200 #define FF_PROFILE_DNXHR_HQX 4
3201 #define FF_PROFILE_DNXHR_444 5
3203 #define FF_PROFILE_DTS 20
3204 #define FF_PROFILE_DTS_ES 30
3205 #define FF_PROFILE_DTS_96_24 40
3206 #define FF_PROFILE_DTS_HD_HRA 50
3207 #define FF_PROFILE_DTS_HD_MA 60
3208 #define FF_PROFILE_DTS_EXPRESS 70
3210 #define FF_PROFILE_MPEG2_422 0
3211 #define FF_PROFILE_MPEG2_HIGH 1
3212 #define FF_PROFILE_MPEG2_SS 2
3213 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3214 #define FF_PROFILE_MPEG2_MAIN 4
3215 #define FF_PROFILE_MPEG2_SIMPLE 5
3217 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3218 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3220 #define FF_PROFILE_H264_BASELINE 66
3221 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3222 #define FF_PROFILE_H264_MAIN 77
3223 #define FF_PROFILE_H264_EXTENDED 88
3224 #define FF_PROFILE_H264_HIGH 100
3225 #define FF_PROFILE_H264_HIGH_10 110
3226 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3227 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3228 #define FF_PROFILE_H264_HIGH_422 122
3229 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3230 #define FF_PROFILE_H264_STEREO_HIGH 128
3231 #define FF_PROFILE_H264_HIGH_444 144
3232 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3233 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3234 #define FF_PROFILE_H264_CAVLC_444 44
3236 #define FF_PROFILE_VC1_SIMPLE 0
3237 #define FF_PROFILE_VC1_MAIN 1
3238 #define FF_PROFILE_VC1_COMPLEX 2
3239 #define FF_PROFILE_VC1_ADVANCED 3
3241 #define FF_PROFILE_MPEG4_SIMPLE 0
3242 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3243 #define FF_PROFILE_MPEG4_CORE 2
3244 #define FF_PROFILE_MPEG4_MAIN 3
3245 #define FF_PROFILE_MPEG4_N_BIT 4
3246 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3247 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3248 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3249 #define FF_PROFILE_MPEG4_HYBRID 8
3250 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3251 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3252 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3253 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3254 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3255 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3256 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3258 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3259 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3260 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3261 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3262 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3264 #define FF_PROFILE_VP9_0 0
3265 #define FF_PROFILE_VP9_1 1
3266 #define FF_PROFILE_VP9_2 2
3267 #define FF_PROFILE_VP9_3 3
3269 #define FF_PROFILE_HEVC_MAIN 1
3270 #define FF_PROFILE_HEVC_MAIN_10 2
3271 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3272 #define FF_PROFILE_HEVC_REXT 4
3276 * - encoding: Set by user.
3277 * - decoding: Set by libavcodec.
3280 #define FF_LEVEL_UNKNOWN -99
3283 * Skip loop filtering for selected frames.
3284 * - encoding: unused
3285 * - decoding: Set by user.
3287 enum AVDiscard skip_loop_filter;
3290 * Skip IDCT/dequantization for selected frames.
3291 * - encoding: unused
3292 * - decoding: Set by user.
3294 enum AVDiscard skip_idct;
3297 * Skip decoding for selected frames.
3298 * - encoding: unused
3299 * - decoding: Set by user.
3301 enum AVDiscard skip_frame;
3304 * Header containing style information for text subtitles.
3305 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3306 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3307 * the Format line following. It shouldn't include any Dialogue line.
3308 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3309 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3311 uint8_t *subtitle_header;
3312 int subtitle_header_size;
3314 #if FF_API_ERROR_RATE
3316 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3319 attribute_deprecated
3323 #if FF_API_VBV_DELAY
3325 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3326 * Used for compliant TS muxing.
3327 * - encoding: Set by libavcodec.
3328 * - decoding: unused.
3329 * @deprecated this value is now exported as a part of
3330 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3332 attribute_deprecated
3336 #if FF_API_SIDEDATA_ONLY_PKT
3338 * Encoding only and set by default. Allow encoders to output packets
3339 * that do not contain any encoded data, only side data.
3341 * Some encoders need to output such packets, e.g. to update some stream
3342 * parameters at the end of encoding.
3344 * @deprecated this field disables the default behaviour and
3345 * it is kept only for compatibility.
3347 attribute_deprecated
3348 int side_data_only_packets;
3352 * Audio only. The number of "priming" samples (padding) inserted by the
3353 * encoder at the beginning of the audio. I.e. this number of leading
3354 * decoded samples must be discarded by the caller to get the original audio
3355 * without leading padding.
3357 * - decoding: unused
3358 * - encoding: Set by libavcodec. The timestamps on the output packets are
3359 * adjusted by the encoder so that they always refer to the
3360 * first sample of the data actually contained in the packet,
3361 * including any added padding. E.g. if the timebase is
3362 * 1/samplerate and the timestamp of the first input sample is
3363 * 0, the timestamp of the first output packet will be
3366 int initial_padding;
3369 * - decoding: For codecs that store a framerate value in the compressed
3370 * bitstream, the decoder may export it here. { 0, 1} when
3372 * - encoding: May be used to signal the framerate of CFR content to an
3375 AVRational framerate;
3378 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3379 * - encoding: unused.
3380 * - decoding: Set by libavcodec before calling get_format()
3382 enum AVPixelFormat sw_pix_fmt;
3385 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3386 * Code outside libavcodec should access this field using:
3387 * av_codec_{get,set}_pkt_timebase(avctx)
3388 * - encoding unused.
3389 * - decoding set by user.
3391 AVRational pkt_timebase;
3395 * Code outside libavcodec should access this field using:
3396 * av_codec_{get,set}_codec_descriptor(avctx)
3397 * - encoding: unused.
3398 * - decoding: set by libavcodec.
3400 const AVCodecDescriptor *codec_descriptor;
3404 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3405 * - encoding: unused
3406 * - decoding: Set by user.
3407 * Code outside libavcodec should access this field using:
3408 * av_codec_{get,set}_lowres(avctx)
3414 * Current statistics for PTS correction.
3415 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3416 * - encoding: unused
3418 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3419 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3420 int64_t pts_correction_last_pts; /// PTS of the last frame
3421 int64_t pts_correction_last_dts; /// DTS of the last frame
3424 * Character encoding of the input subtitles file.
3425 * - decoding: set by user
3426 * - encoding: unused
3431 * Subtitles character encoding mode. Formats or codecs might be adjusting
3432 * this setting (if they are doing the conversion themselves for instance).
3433 * - decoding: set by libavcodec
3434 * - encoding: unused
3436 int sub_charenc_mode;
3437 #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)
3438 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3439 #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
3442 * Skip processing alpha if supported by codec.
3443 * Note that if the format uses pre-multiplied alpha (common with VP6,
3444 * and recommended due to better video quality/compression)
3445 * the image will look as if alpha-blended onto a black background.
3446 * However for formats that do not use pre-multiplied alpha
3447 * there might be serious artefacts (though e.g. libswscale currently
3448 * assumes pre-multiplied alpha anyway).
3449 * Code outside libavcodec should access this field using AVOptions
3451 * - decoding: set by user
3452 * - encoding: unused
3457 * Number of samples to skip after a discontinuity
3458 * - decoding: unused
3459 * - encoding: set by libavcodec
3463 #if !FF_API_DEBUG_MV
3465 * debug motion vectors
3466 * Code outside libavcodec should access this field using AVOptions
3467 * - encoding: Set by user.
3468 * - decoding: Set by user.
3471 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3472 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3473 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3477 * custom intra quantization matrix
3478 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3479 * - encoding: Set by user, can be NULL.
3480 * - decoding: unused.
3482 uint16_t *chroma_intra_matrix;
3485 * dump format separator.
3486 * can be ", " or "\n " or anything else
3487 * Code outside libavcodec should access this field using AVOptions
3488 * (NO direct access).
3489 * - encoding: Set by user.
3490 * - decoding: Set by user.
3492 uint8_t *dump_separator;
3495 * ',' separated list of allowed decoders.
3496 * If NULL then all are allowed
3497 * - encoding: unused
3498 * - decoding: set by user through AVOPtions (NO direct access)
3500 char *codec_whitelist;
3503 * Properties of the stream that gets decoded
3504 * To be accessed through av_codec_get_properties() (NO direct access)
3505 * - encoding: unused
3506 * - decoding: set by libavcodec
3508 unsigned properties;
3509 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3510 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3513 * Additional data associated with the entire coded stream.
3515 * - decoding: unused
3516 * - encoding: may be set by libavcodec after avcodec_open2().
3518 AVPacketSideData *coded_side_data;
3519 int nb_coded_side_data;
3522 * A reference to the AVHWFramesContext describing the input (for encoding)
3523 * or output (decoding) frames. The reference is set by the caller and
3524 * afterwards owned (and freed) by libavcodec.
3526 * - decoding: This field should be set by the caller from the get_format()
3527 * callback. The previous reference (if any) will always be
3528 * unreffed by libavcodec before the get_format() call.
3530 * If the default get_buffer2() is used with a hwaccel pixel
3531 * format, then this AVHWFramesContext will be used for
3532 * allocating the frame buffers.
3534 * - encoding: For hardware encoders configured to use a hwaccel pixel
3535 * format, this field should be set by the caller to a reference
3536 * to the AVHWFramesContext describing input frames.
3537 * AVHWFramesContext.format must be equal to
3538 * AVCodecContext.pix_fmt.
3540 * This field should be set before avcodec_open2() is called.
3542 AVBufferRef *hw_frames_ctx;
3545 * Control the form of AVSubtitle.rects[N]->ass
3546 * - decoding: set by user
3547 * - encoding: unused
3549 int sub_text_format;
3550 #define FF_SUB_TEXT_FMT_ASS 0
3551 #if FF_API_ASS_TIMING
3552 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3556 * Audio only. The amount of padding (in samples) appended by the encoder to
3557 * the end of the audio. I.e. this number of decoded samples must be
3558 * discarded by the caller from the end of the stream to get the original
3559 * audio without any trailing padding.
3561 * - decoding: unused
3562 * - encoding: unused
3564 int trailing_padding;
3568 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3569 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3571 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3572 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3574 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3576 int av_codec_get_lowres(const AVCodecContext *avctx);
3577 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3579 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3580 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3582 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3583 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3588 typedef struct AVProfile {
3590 const char *name; ///< short name for the profile
3593 typedef struct AVCodecDefault AVCodecDefault;
3600 typedef struct AVCodec {
3602 * Name of the codec implementation.
3603 * The name is globally unique among encoders and among decoders (but an
3604 * encoder and a decoder can share the same name).
3605 * This is the primary way to find a codec from the user perspective.
3609 * Descriptive name for the codec, meant to be more human readable than name.
3610 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3612 const char *long_name;
3613 enum AVMediaType type;
3616 * Codec capabilities.
3617 * see AV_CODEC_CAP_*
3620 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3621 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3622 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3623 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3624 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3625 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3626 const AVClass *priv_class; ///< AVClass for the private context
3627 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3629 /*****************************************************************
3630 * No fields below this line are part of the public API. They
3631 * may not be used outside of libavcodec and can be changed and
3633 * New public fields should be added right above.
3634 *****************************************************************
3637 struct AVCodec *next;
3639 * @name Frame-level threading support functions
3643 * If defined, called on thread contexts when they are created.
3644 * If the codec allocates writable tables in init(), re-allocate them here.
3645 * priv_data will be set to a copy of the original.
3647 int (*init_thread_copy)(AVCodecContext *);
3649 * Copy necessary context variables from a previous thread context to the current one.
3650 * If not defined, the next thread will start automatically; otherwise, the codec
3651 * must call ff_thread_finish_setup().
3653 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3655 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3659 * Private codec-specific defaults.
3661 const AVCodecDefault *defaults;
3664 * Initialize codec static data, called from avcodec_register().
3666 void (*init_static_data)(struct AVCodec *codec);
3668 int (*init)(AVCodecContext *);
3669 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3670 const struct AVSubtitle *sub);
3672 * Encode data to an AVPacket.
3674 * @param avctx codec context
3675 * @param avpkt output AVPacket (may contain a user-provided buffer)
3676 * @param[in] frame AVFrame containing the raw data to be encoded
3677 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3678 * non-empty packet was returned in avpkt.
3679 * @return 0 on success, negative error code on failure
3681 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3682 int *got_packet_ptr);
3683 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3684 int (*close)(AVCodecContext *);
3686 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3687 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3689 * - never called if the codec is closed or the wrong type,
3690 * - AVPacket parameter change side data is applied right before calling
3691 * AVCodec->send_packet,
3692 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3693 * - only one drain packet is ever passed down (until the next flush()),
3694 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3696 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3697 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3698 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3699 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3702 * Will be called when seeking
3704 void (*flush)(AVCodecContext *);
3706 * Internal codec capabilities.
3707 * See FF_CODEC_CAP_* in internal.h
3712 int av_codec_get_max_lowres(const AVCodec *codec);
3714 struct MpegEncContext;
3717 * @defgroup lavc_hwaccel AVHWAccel
3720 typedef struct AVHWAccel {
3722 * Name of the hardware accelerated codec.
3723 * The name is globally unique among encoders and among decoders (but an
3724 * encoder and a decoder can share the same name).
3729 * Type of codec implemented by the hardware accelerator.
3731 * See AVMEDIA_TYPE_xxx
3733 enum AVMediaType type;
3736 * Codec implemented by the hardware accelerator.
3738 * See AV_CODEC_ID_xxx
3743 * Supported pixel format.
3745 * Only hardware accelerated formats are supported here.
3747 enum AVPixelFormat pix_fmt;
3750 * Hardware accelerated codec capabilities.
3751 * see HWACCEL_CODEC_CAP_*
3755 /*****************************************************************
3756 * No fields below this line are part of the public API. They
3757 * may not be used outside of libavcodec and can be changed and
3759 * New public fields should be added right above.
3760 *****************************************************************
3762 struct AVHWAccel *next;
3765 * Allocate a custom buffer
3767 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3770 * Called at the beginning of each frame or field picture.
3772 * Meaningful frame information (codec specific) is guaranteed to
3773 * be parsed at this point. This function is mandatory.
3775 * Note that buf can be NULL along with buf_size set to 0.
3776 * Otherwise, this means the whole frame is available at this point.
3778 * @param avctx the codec context
3779 * @param buf the frame data buffer base
3780 * @param buf_size the size of the frame in bytes
3781 * @return zero if successful, a negative value otherwise
3783 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3786 * Callback for each slice.
3788 * Meaningful slice information (codec specific) is guaranteed to
3789 * be parsed at this point. This function is mandatory.
3790 * The only exception is XvMC, that works on MB level.
3792 * @param avctx the codec context
3793 * @param buf the slice data buffer base
3794 * @param buf_size the size of the slice in bytes
3795 * @return zero if successful, a negative value otherwise
3797 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3800 * Called at the end of each frame or field picture.
3802 * The whole picture is parsed at this point and can now be sent
3803 * to the hardware accelerator. This function is mandatory.
3805 * @param avctx the codec context
3806 * @return zero if successful, a negative value otherwise
3808 int (*end_frame)(AVCodecContext *avctx);
3811 * Size of per-frame hardware accelerator private data.
3813 * Private data is allocated with av_mallocz() before
3814 * AVCodecContext.get_buffer() and deallocated after
3815 * AVCodecContext.release_buffer().
3817 int frame_priv_data_size;
3820 * Called for every Macroblock in a slice.
3822 * XvMC uses it to replace the ff_mpv_decode_mb().
3823 * Instead of decoding to raw picture, MB parameters are
3824 * stored in an array provided by the video driver.
3826 * @param s the mpeg context
3828 void (*decode_mb)(struct MpegEncContext *s);
3831 * Initialize the hwaccel private data.
3833 * This will be called from ff_get_format(), after hwaccel and
3834 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3837 int (*init)(AVCodecContext *avctx);
3840 * Uninitialize the hwaccel private data.
3842 * This will be called from get_format() or avcodec_close(), after hwaccel
3843 * and hwaccel_context are already uninitialized.
3845 int (*uninit)(AVCodecContext *avctx);
3848 * Size of the private data to allocate in
3849 * AVCodecInternal.hwaccel_priv_data.
3855 * Hardware acceleration should be used for decoding even if the codec level
3856 * used is unknown or higher than the maximum supported level reported by the
3859 * It's generally a good idea to pass this flag unless you have a specific
3860 * reason not to, as hardware tends to under-report supported levels.
3862 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3865 * Hardware acceleration can output YUV pixel formats with a different chroma
3866 * sampling than 4:2:0 and/or other than 8 bits per component.
3868 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3874 #if FF_API_AVPICTURE
3876 * @defgroup lavc_picture AVPicture
3878 * Functions for working with AVPicture
3883 * Picture data structure.
3885 * Up to four components can be stored into it, the last component is
3887 * @deprecated use AVFrame or imgutils functions instead
3889 typedef struct AVPicture {
3890 attribute_deprecated
3891 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3892 attribute_deprecated
3893 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3901 enum AVSubtitleType {
3904 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3907 * Plain text, the text field must be set by the decoder and is
3908 * authoritative. ass and pict fields may contain approximations.
3913 * Formatted text, the ass field must be set by the decoder and is
3914 * authoritative. pict and text fields may contain approximations.
3919 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3921 typedef struct AVSubtitleRect {
3922 int x; ///< top left corner of pict, undefined when pict is not set
3923 int y; ///< top left corner of pict, undefined when pict is not set
3924 int w; ///< width of pict, undefined when pict is not set
3925 int h; ///< height of pict, undefined when pict is not set
3926 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3928 #if FF_API_AVPICTURE
3930 * @deprecated unused
3932 attribute_deprecated
3936 * data+linesize for the bitmap of this subtitle.
3937 * Can be set for text/ass as well once they are rendered.
3942 enum AVSubtitleType type;
3944 char *text; ///< 0 terminated plain UTF-8 text
3947 * 0 terminated ASS/SSA compatible event line.
3948 * The presentation of this is unaffected by the other values in this
3956 typedef struct AVSubtitle {
3957 uint16_t format; /* 0 = graphics */
3958 uint32_t start_display_time; /* relative to packet pts, in ms */
3959 uint32_t end_display_time; /* relative to packet pts, in ms */
3961 AVSubtitleRect **rects;
3962 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3966 * This struct describes the properties of an encoded stream.
3968 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3969 * be allocated with avcodec_parameters_alloc() and freed with
3970 * avcodec_parameters_free().
3972 typedef struct AVCodecParameters {
3974 * General type of the encoded data.
3976 enum AVMediaType codec_type;
3978 * Specific type of the encoded data (the codec used).
3980 enum AVCodecID codec_id;
3982 * Additional information about the codec (corresponds to the AVI FOURCC).
3987 * Extra binary data needed for initializing the decoder, codec-dependent.
3989 * Must be allocated with av_malloc() and will be freed by
3990 * avcodec_parameters_free(). The allocated size of extradata must be at
3991 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3996 * Size of the extradata content in bytes.
4001 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4002 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4007 * The average bitrate of the encoded data (in bits per second).
4012 * The number of bits per sample in the codedwords.
4014 * This is basically the bitrate per sample. It is mandatory for a bunch of
4015 * formats to actually decode them. It's the number of bits for one sample in
4016 * the actual coded bitstream.
4018 * This could be for example 4 for ADPCM
4019 * For PCM formats this matches bits_per_raw_sample
4022 int bits_per_coded_sample;
4025 * This is the number of valid bits in each output sample. If the
4026 * sample format has more bits, the least significant bits are additional
4027 * padding bits, which are always 0. Use right shifts to reduce the sample
4028 * to its actual size. For example, audio formats with 24 bit samples will
4029 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4030 * To get the original sample use "(int32_t)sample >> 8"."
4032 * For ADPCM this might be 12 or 16 or similar
4035 int bits_per_raw_sample;
4038 * Codec-specific bitstream restrictions that the stream conforms to.
4044 * Video only. The dimensions of the video frame in pixels.
4050 * Video only. The aspect ratio (width / height) which a single pixel
4051 * should have when displayed.
4053 * When the aspect ratio is unknown / undefined, the numerator should be
4054 * set to 0 (the denominator may have any value).
4056 AVRational sample_aspect_ratio;
4059 * Video only. The order of the fields in interlaced video.
4061 enum AVFieldOrder field_order;
4064 * Video only. Additional colorspace characteristics.
4066 enum AVColorRange color_range;
4067 enum AVColorPrimaries color_primaries;
4068 enum AVColorTransferCharacteristic color_trc;
4069 enum AVColorSpace color_space;
4070 enum AVChromaLocation chroma_location;
4073 * Video only. Number of delayed frames.
4078 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4079 * unknown or unspecified, otherwise the number of bits set must be equal to
4080 * the channels field.
4082 uint64_t channel_layout;
4084 * Audio only. The number of audio channels.
4088 * Audio only. The number of audio samples per second.
4092 * Audio only. The number of bytes per coded audio frame, required by some
4095 * Corresponds to nBlockAlign in WAVEFORMATEX.
4099 * Audio only. Audio frame size, if known. Required by some formats to be static.
4104 * Audio only. The amount of padding (in samples) inserted by the encoder at
4105 * the beginning of the audio. I.e. this number of leading decoded samples
4106 * must be discarded by the caller to get the original audio without leading
4109 int initial_padding;
4111 * Audio only. The amount of padding (in samples) appended by the encoder to
4112 * the end of the audio. I.e. this number of decoded samples must be
4113 * discarded by the caller from the end of the stream to get the original
4114 * audio without any trailing padding.
4116 int trailing_padding;
4118 * Audio only. Number of samples to skip after a discontinuity.
4121 } AVCodecParameters;
4124 * If c is NULL, returns the first registered codec,
4125 * if c is non-NULL, returns the next registered codec after c,
4126 * or NULL if c is the last one.
4128 AVCodec *av_codec_next(const AVCodec *c);
4131 * Return the LIBAVCODEC_VERSION_INT constant.
4133 unsigned avcodec_version(void);
4136 * Return the libavcodec build-time configuration.
4138 const char *avcodec_configuration(void);
4141 * Return the libavcodec license.
4143 const char *avcodec_license(void);
4146 * Register the codec codec and initialize libavcodec.
4148 * @warning either this function or avcodec_register_all() must be called
4149 * before any other libavcodec functions.
4151 * @see avcodec_register_all()
4153 void avcodec_register(AVCodec *codec);
4156 * Register all the codecs, parsers and bitstream filters which were enabled at
4157 * configuration time. If you do not call this function you can select exactly
4158 * which formats you want to support, by using the individual registration
4161 * @see avcodec_register
4162 * @see av_register_codec_parser
4163 * @see av_register_bitstream_filter
4165 void avcodec_register_all(void);
4168 * Allocate an AVCodecContext and set its fields to default values. The
4169 * resulting struct should be freed with avcodec_free_context().
4171 * @param codec if non-NULL, allocate private data and initialize defaults
4172 * for the given codec. It is illegal to then call avcodec_open2()
4173 * with a different codec.
4174 * If NULL, then the codec-specific defaults won't be initialized,
4175 * which may result in suboptimal default settings (this is
4176 * important mainly for encoders, e.g. libx264).
4178 * @return An AVCodecContext filled with default values or NULL on failure.
4180 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4183 * Free the codec context and everything associated with it and write NULL to
4184 * the provided pointer.
4186 void avcodec_free_context(AVCodecContext **avctx);
4188 #if FF_API_GET_CONTEXT_DEFAULTS
4190 * @deprecated This function should not be used, as closing and opening a codec
4191 * context multiple time is not supported. A new codec context should be
4192 * allocated for each new use.
4194 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4198 * Get the AVClass for AVCodecContext. It can be used in combination with
4199 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4201 * @see av_opt_find().
4203 const AVClass *avcodec_get_class(void);
4205 #if FF_API_COPY_CONTEXT
4207 * Get the AVClass for AVFrame. It can be used in combination with
4208 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4210 * @see av_opt_find().
4212 const AVClass *avcodec_get_frame_class(void);
4215 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4216 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4218 * @see av_opt_find().
4220 const AVClass *avcodec_get_subtitle_rect_class(void);
4223 * Copy the settings of the source AVCodecContext into the destination
4224 * AVCodecContext. The resulting destination codec context will be
4225 * unopened, i.e. you are required to call avcodec_open2() before you
4226 * can use this AVCodecContext to decode/encode video/audio data.
4228 * @param dest target codec context, should be initialized with
4229 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4230 * @param src source codec context
4231 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4233 * @deprecated The semantics of this function are ill-defined and it should not
4234 * be used. If you need to transfer the stream parameters from one codec context
4235 * to another, use an intermediate AVCodecParameters instance and the
4236 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4239 attribute_deprecated
4240 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4244 * Allocate a new AVCodecParameters and set its fields to default values
4245 * (unknown/invalid/0). The returned struct must be freed with
4246 * avcodec_parameters_free().
4248 AVCodecParameters *avcodec_parameters_alloc(void);
4251 * Free an AVCodecParameters instance and everything associated with it and
4252 * write NULL to the supplied pointer.
4254 void avcodec_parameters_free(AVCodecParameters **par);
4257 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4258 * replaced with newly allocated duplicates of the corresponding fields in src.
4260 * @return >= 0 on success, a negative AVERROR code on failure.
4262 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4265 * Fill the parameters struct based on the values from the supplied codec
4266 * context. Any allocated fields in par are freed and replaced with duplicates
4267 * of the corresponding fields in codec.
4269 * @return >= 0 on success, a negative AVERROR code on failure
4271 int avcodec_parameters_from_context(AVCodecParameters *par,
4272 const AVCodecContext *codec);
4275 * Fill the codec context based on the values from the supplied codec
4276 * parameters. Any allocated fields in codec that have a corresponding field in
4277 * par are freed and replaced with duplicates of the corresponding field in par.
4278 * Fields in codec that do not have a counterpart in par are not touched.
4280 * @return >= 0 on success, a negative AVERROR code on failure.
4282 int avcodec_parameters_to_context(AVCodecContext *codec,
4283 const AVCodecParameters *par);
4286 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4287 * function the context has to be allocated with avcodec_alloc_context3().
4289 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4290 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4291 * retrieving a codec.
4293 * @warning This function is not thread safe!
4295 * @note Always call this function before using decoding routines (such as
4296 * @ref avcodec_receive_frame()).
4299 * avcodec_register_all();
4300 * av_dict_set(&opts, "b", "2.5M", 0);
4301 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4305 * context = avcodec_alloc_context3(codec);
4307 * if (avcodec_open2(context, codec, opts) < 0)
4311 * @param avctx The context to initialize.
4312 * @param codec The codec to open this context for. If a non-NULL codec has been
4313 * previously passed to avcodec_alloc_context3() or
4314 * for this context, then this parameter MUST be either NULL or
4315 * equal to the previously passed codec.
4316 * @param options A dictionary filled with AVCodecContext and codec-private options.
4317 * On return this object will be filled with options that were not found.
4319 * @return zero on success, a negative value on error
4320 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4321 * av_dict_set(), av_opt_find().
4323 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4326 * Close a given AVCodecContext and free all the data associated with it
4327 * (but not the AVCodecContext itself).
4329 * Calling this function on an AVCodecContext that hasn't been opened will free
4330 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4331 * codec. Subsequent calls will do nothing.
4333 * @note Do not use this function. Use avcodec_free_context() to destroy a
4334 * codec context (either open or closed). Opening and closing a codec context
4335 * multiple times is not supported anymore -- use multiple codec contexts
4338 int avcodec_close(AVCodecContext *avctx);
4341 * Free all allocated data in the given subtitle struct.
4343 * @param sub AVSubtitle to free.
4345 void avsubtitle_free(AVSubtitle *sub);
4352 * @addtogroup lavc_packet
4357 * Allocate an AVPacket and set its fields to default values. The resulting
4358 * struct must be freed using av_packet_free().
4360 * @return An AVPacket filled with default values or NULL on failure.
4362 * @note this only allocates the AVPacket itself, not the data buffers. Those
4363 * must be allocated through other means such as av_new_packet.
4365 * @see av_new_packet
4367 AVPacket *av_packet_alloc(void);
4370 * Create a new packet that references the same data as src.
4372 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4374 * @return newly created AVPacket on success, NULL on error.
4376 * @see av_packet_alloc
4377 * @see av_packet_ref
4379 AVPacket *av_packet_clone(AVPacket *src);
4382 * Free the packet, if the packet is reference counted, it will be
4383 * unreferenced first.
4385 * @param packet packet to be freed. The pointer will be set to NULL.
4386 * @note passing NULL is a no-op.
4388 void av_packet_free(AVPacket **pkt);
4391 * Initialize optional fields of a packet with default values.
4393 * Note, this does not touch the data and size members, which have to be
4394 * initialized separately.
4398 void av_init_packet(AVPacket *pkt);
4401 * Allocate the payload of a packet and initialize its fields with
4405 * @param size wanted payload size
4406 * @return 0 if OK, AVERROR_xxx otherwise
4408 int av_new_packet(AVPacket *pkt, int size);
4411 * Reduce packet size, correctly zeroing padding
4414 * @param size new size
4416 void av_shrink_packet(AVPacket *pkt, int size);
4419 * Increase packet size, correctly zeroing padding
4422 * @param grow_by number of bytes by which to increase the size of the packet
4424 int av_grow_packet(AVPacket *pkt, int grow_by);
4427 * Initialize a reference-counted packet from av_malloc()ed data.
4429 * @param pkt packet to be initialized. This function will set the data, size,
4430 * buf and destruct fields, all others are left untouched.
4431 * @param data Data allocated by av_malloc() to be used as packet data. If this
4432 * function returns successfully, the data is owned by the underlying AVBuffer.
4433 * The caller may not access the data through other means.
4434 * @param size size of data in bytes, without the padding. I.e. the full buffer
4435 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4437 * @return 0 on success, a negative AVERROR on error
4439 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4441 #if FF_API_AVPACKET_OLD_API
4443 * @warning This is a hack - the packet memory allocation stuff is broken. The
4444 * packet is allocated if it was not really allocated.
4446 * @deprecated Use av_packet_ref
4448 attribute_deprecated
4449 int av_dup_packet(AVPacket *pkt);
4451 * Copy packet, including contents
4453 * @return 0 on success, negative AVERROR on fail
4455 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4458 * Copy packet side data
4460 * @return 0 on success, negative AVERROR on fail
4462 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4467 * @deprecated Use av_packet_unref
4469 * @param pkt packet to free
4471 attribute_deprecated
4472 void av_free_packet(AVPacket *pkt);
4475 * Allocate new information of a packet.
4478 * @param type side information type
4479 * @param size side information size
4480 * @return pointer to fresh allocated data or NULL otherwise
4482 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4486 * Wrap an existing array as a packet side data.
4489 * @param type side information type
4490 * @param data the side data array. It must be allocated with the av_malloc()
4491 * family of functions. The ownership of the data is transferred to
4493 * @param size side information size
4494 * @return a non-negative number on success, a negative AVERROR code on
4495 * failure. On failure, the packet is unchanged and the data remains
4496 * owned by the caller.
4498 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4499 uint8_t *data, size_t size);
4502 * Shrink the already allocated side data buffer
4505 * @param type side information type
4506 * @param size new side information size
4507 * @return 0 on success, < 0 on failure
4509 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4513 * Get side information from packet.
4516 * @param type desired side information type
4517 * @param size pointer for side information size to store (optional)
4518 * @return pointer to data if present or NULL otherwise
4520 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4523 int av_packet_merge_side_data(AVPacket *pkt);
4525 int av_packet_split_side_data(AVPacket *pkt);
4527 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4530 * Pack a dictionary for use in side_data.
4532 * @param dict The dictionary to pack.
4533 * @param size pointer to store the size of the returned data
4534 * @return pointer to data if successful, NULL otherwise
4536 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4538 * Unpack a dictionary from side_data.
4540 * @param data data from side_data
4541 * @param size size of the data
4542 * @param dict the metadata storage dictionary
4543 * @return 0 on success, < 0 on failure
4545 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4549 * Convenience function to free all the side data stored.
4550 * All the other fields stay untouched.
4554 void av_packet_free_side_data(AVPacket *pkt);
4557 * Setup a new reference to the data described by a given packet
4559 * If src is reference-counted, setup dst as a new reference to the
4560 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4561 * data from src into it.
4563 * All the other fields are copied from src.
4565 * @see av_packet_unref
4567 * @param dst Destination packet
4568 * @param src Source packet
4570 * @return 0 on success, a negative AVERROR on error.
4572 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4577 * Unreference the buffer referenced by the packet and reset the
4578 * remaining packet fields to their default values.
4580 * @param pkt The packet to be unreferenced.
4582 void av_packet_unref(AVPacket *pkt);
4585 * Move every field in src to dst and reset src.
4587 * @see av_packet_unref
4589 * @param src Source packet, will be reset
4590 * @param dst Destination packet
4592 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4595 * Copy only "properties" fields from src to dst.
4597 * Properties for the purpose of this function are all the fields
4598 * beside those related to the packet data (buf, data, size)
4600 * @param dst Destination packet
4601 * @param src Source packet
4603 * @return 0 on success AVERROR on failure.
4605 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4608 * Convert valid timing fields (timestamps / durations) in a packet from one
4609 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4612 * @param pkt packet on which the conversion will be performed
4613 * @param tb_src source timebase, in which the timing fields in pkt are
4615 * @param tb_dst destination timebase, to which the timing fields will be
4618 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4625 * @addtogroup lavc_decoding
4630 * Find a registered decoder with a matching codec ID.
4632 * @param id AVCodecID of the requested decoder
4633 * @return A decoder if one was found, NULL otherwise.
4635 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4638 * Find a registered decoder with the specified name.
4640 * @param name name of the requested decoder
4641 * @return A decoder if one was found, NULL otherwise.
4643 AVCodec *avcodec_find_decoder_by_name(const char *name);
4646 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4647 * it can be called by custom get_buffer2() implementations for decoders without
4648 * AV_CODEC_CAP_DR1 set.
4650 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4654 * Return the amount of padding in pixels which the get_buffer callback must
4655 * provide around the edge of the image for codecs which do not have the
4656 * CODEC_FLAG_EMU_EDGE flag.
4658 * @return Required padding in pixels.
4660 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4663 attribute_deprecated
4664 unsigned avcodec_get_edge_width(void);
4668 * Modify width and height values so that they will result in a memory
4669 * buffer that is acceptable for the codec if you do not use any horizontal
4672 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4674 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4677 * Modify width and height values so that they will result in a memory
4678 * buffer that is acceptable for the codec if you also ensure that all
4679 * line sizes are a multiple of the respective linesize_align[i].
4681 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4683 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4684 int linesize_align[AV_NUM_DATA_POINTERS]);
4687 * Converts AVChromaLocation to swscale x/y chroma position.
4689 * The positions represent the chroma (0,0) position in a coordinates system
4690 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4692 * @param xpos horizontal chroma sample position
4693 * @param ypos vertical chroma sample position
4695 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4698 * Converts swscale x/y chroma position to AVChromaLocation.
4700 * The positions represent the chroma (0,0) position in a coordinates system
4701 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4703 * @param xpos horizontal chroma sample position
4704 * @param ypos vertical chroma sample position
4706 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4709 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4711 * Some decoders may support multiple frames in a single AVPacket. Such
4712 * decoders would then just decode the first frame and the return value would be
4713 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4714 * called again with an AVPacket containing the remaining data in order to
4715 * decode the second frame, etc... Even if no frames are returned, the packet
4716 * needs to be fed to the decoder with remaining data until it is completely
4717 * consumed or an error occurs.
4719 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4720 * and output. This means that for some packets they will not immediately
4721 * produce decoded output and need to be flushed at the end of decoding to get
4722 * all the decoded data. Flushing is done by calling this function with packets
4723 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4724 * returning samples. It is safe to flush even those decoders that are not
4725 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4727 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4728 * larger than the actual read bytes because some optimized bitstream
4729 * readers read 32 or 64 bits at once and could read over the end.
4731 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4732 * before packets may be fed to the decoder.
4734 * @param avctx the codec context
4735 * @param[out] frame The AVFrame in which to store decoded audio samples.
4736 * The decoder will allocate a buffer for the decoded frame by
4737 * calling the AVCodecContext.get_buffer2() callback.
4738 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4739 * reference counted and the returned reference belongs to the
4740 * caller. The caller must release the frame using av_frame_unref()
4741 * when the frame is no longer needed. The caller may safely write
4742 * to the frame if av_frame_is_writable() returns 1.
4743 * When AVCodecContext.refcounted_frames is set to 0, the returned
4744 * reference belongs to the decoder and is valid only until the
4745 * next call to this function or until closing or flushing the
4746 * decoder. The caller may not write to it.
4747 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4748 * non-zero. Note that this field being set to zero
4749 * does not mean that an error has occurred. For
4750 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4751 * call is guaranteed to produce a frame.
4752 * @param[in] avpkt The input AVPacket containing the input buffer.
4753 * At least avpkt->data and avpkt->size should be set. Some
4754 * decoders might also require additional fields to be set.
4755 * @return A negative error code is returned if an error occurred during
4756 * decoding, otherwise the number of bytes consumed from the input
4757 * AVPacket is returned.
4759 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4761 attribute_deprecated
4762 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4763 int *got_frame_ptr, const AVPacket *avpkt);
4766 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4767 * Some decoders may support multiple frames in a single AVPacket, such
4768 * decoders would then just decode the first frame.
4770 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4771 * the actual read bytes because some optimized bitstream readers read 32 or 64
4772 * bits at once and could read over the end.
4774 * @warning The end of the input buffer buf should be set to 0 to ensure that
4775 * no overreading happens for damaged MPEG streams.
4777 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4778 * between input and output, these need to be fed with avpkt->data=NULL,
4779 * avpkt->size=0 at the end to return the remaining frames.
4781 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4782 * before packets may be fed to the decoder.
4784 * @param avctx the codec context
4785 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4786 * Use av_frame_alloc() to get an AVFrame. The codec will
4787 * allocate memory for the actual bitmap by calling the
4788 * AVCodecContext.get_buffer2() callback.
4789 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4790 * reference counted and the returned reference belongs to the
4791 * caller. The caller must release the frame using av_frame_unref()
4792 * when the frame is no longer needed. The caller may safely write
4793 * to the frame if av_frame_is_writable() returns 1.
4794 * When AVCodecContext.refcounted_frames is set to 0, the returned
4795 * reference belongs to the decoder and is valid only until the
4796 * next call to this function or until closing or flushing the
4797 * decoder. The caller may not write to it.
4799 * @param[in] avpkt The input AVPacket containing the input buffer.
4800 * You can create such packet with av_init_packet() and by then setting
4801 * data and size, some decoders might in addition need other fields like
4802 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4804 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4805 * @return On error a negative value is returned, otherwise the number of bytes
4806 * used or zero if no frame could be decompressed.
4808 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4810 attribute_deprecated
4811 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4812 int *got_picture_ptr,
4813 const AVPacket *avpkt);
4816 * Decode a subtitle message.
4817 * Return a negative value on error, otherwise return the number of bytes used.
4818 * If no subtitle could be decompressed, got_sub_ptr is zero.
4819 * Otherwise, the subtitle is stored in *sub.
4820 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4821 * simplicity, because the performance difference is expect to be negligible
4822 * and reusing a get_buffer written for video codecs would probably perform badly
4823 * due to a potentially very different allocation pattern.
4825 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4826 * and output. This means that for some packets they will not immediately
4827 * produce decoded output and need to be flushed at the end of decoding to get
4828 * all the decoded data. Flushing is done by calling this function with packets
4829 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4830 * returning subtitles. It is safe to flush even those decoders that are not
4831 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4833 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4834 * before packets may be fed to the decoder.
4836 * @param avctx the codec context
4837 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4838 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4839 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4840 * @param[in] avpkt The input AVPacket containing the input buffer.
4842 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4847 * Supply raw packet data as input to a decoder.
4849 * Internally, this call will copy relevant AVCodecContext fields, which can
4850 * influence decoding per-packet, and apply them when the packet is actually
4851 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4852 * decoder to drop the frame contained by the packet sent with this function.)
4854 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4855 * larger than the actual read bytes because some optimized bitstream
4856 * readers read 32 or 64 bits at once and could read over the end.
4858 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4859 * on the same AVCodecContext. It will return unexpected results now
4860 * or in future libavcodec versions.
4862 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4863 * before packets may be fed to the decoder.
4865 * @param avctx codec context
4866 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4867 * frame, or several complete audio frames.
4868 * Ownership of the packet remains with the caller, and the
4869 * decoder will not write to the packet. The decoder may create
4870 * a reference to the packet data (or copy it if the packet is
4871 * not reference-counted).
4872 * Unlike with older APIs, the packet is always fully consumed,
4873 * and if it contains multiple frames (e.g. some audio codecs),
4874 * will require you to call avcodec_receive_frame() multiple
4875 * times afterwards before you can send a new packet.
4876 * It can be NULL (or an AVPacket with data set to NULL and
4877 * size set to 0); in this case, it is considered a flush
4878 * packet, which signals the end of the stream. Sending the
4879 * first flush packet will return success. Subsequent ones are
4880 * unnecessary and will return AVERROR_EOF. If the decoder
4881 * still has frames buffered, it will return them after sending
4884 * @return 0 on success, otherwise negative error code:
4885 * AVERROR(EAGAIN): input is not accepted right now - the packet must be
4886 * resent after trying to read output
4887 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4888 * be sent to it (also returned if more than 1 flush
4890 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4891 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4892 * other errors: legitimate decoding errors
4894 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4897 * Return decoded output data from a decoder.
4899 * @param avctx codec context
4900 * @param frame This will be set to a reference-counted video or audio
4901 * frame (depending on the decoder type) allocated by the
4902 * decoder. Note that the function will always call
4903 * av_frame_unref(frame) before doing anything else.
4906 * 0: success, a frame was returned
4907 * AVERROR(EAGAIN): output is not available right now - user must try
4909 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4910 * no more output frames
4911 * AVERROR(EINVAL): codec not opened, or it is an encoder
4912 * other negative values: legitimate decoding errors
4914 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4917 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4918 * to retrieve buffered output packets.
4920 * @param avctx codec context
4921 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4922 * Ownership of the frame remains with the caller, and the
4923 * encoder will not write to the frame. The encoder may create
4924 * a reference to the frame data (or copy it if the frame is
4925 * not reference-counted).
4926 * It can be NULL, in which case it is considered a flush
4927 * packet. This signals the end of the stream. If the encoder
4928 * still has packets buffered, it will return them after this
4929 * call. Once flushing mode has been entered, additional flush
4930 * packets are ignored, and sending frames will return
4934 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4935 * can have any number of samples.
4936 * If it is not set, frame->nb_samples must be equal to
4937 * avctx->frame_size for all frames except the last.
4938 * The final frame may be smaller than avctx->frame_size.
4939 * @return 0 on success, otherwise negative error code:
4940 * AVERROR(EAGAIN): input is not accepted right now - the frame must be
4941 * resent after trying to read output packets
4942 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4944 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4945 * decoder, or requires flush
4946 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4947 * other errors: legitimate decoding errors
4949 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4952 * Read encoded data from the encoder.
4954 * @param avctx codec context
4955 * @param avpkt This will be set to a reference-counted packet allocated by the
4956 * encoder. Note that the function will always call
4957 * av_frame_unref(frame) before doing anything else.
4958 * @return 0 on success, otherwise negative error code:
4959 * AVERROR(EAGAIN): output is not available right now - user must try
4961 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4962 * no more output packets
4963 * AVERROR(EINVAL): codec not opened, or it is an encoder
4964 * other errors: legitimate decoding errors
4966 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4970 * @defgroup lavc_parsing Frame parsing
4974 enum AVPictureStructure {
4975 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4976 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4977 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4978 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4981 typedef struct AVCodecParserContext {
4983 struct AVCodecParser *parser;
4984 int64_t frame_offset; /* offset of the current frame */
4985 int64_t cur_offset; /* current offset
4986 (incremented by each av_parser_parse()) */
4987 int64_t next_frame_offset; /* offset of the next frame */
4989 int pict_type; /* XXX: Put it back in AVCodecContext. */
4991 * This field is used for proper frame duration computation in lavf.
4992 * It signals, how much longer the frame duration of the current frame
4993 * is compared to normal frame duration.
4995 * frame_duration = (1 + repeat_pict) * time_base
4997 * It is used by codecs like H.264 to display telecined material.
4999 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5000 int64_t pts; /* pts of the current frame */
5001 int64_t dts; /* dts of the current frame */
5006 int fetch_timestamp;
5008 #define AV_PARSER_PTS_NB 4
5009 int cur_frame_start_index;
5010 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5011 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5012 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5015 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5016 #define PARSER_FLAG_ONCE 0x0002
5017 /// Set if the parser has a valid file offset
5018 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5019 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5021 int64_t offset; ///< byte offset from starting packet start
5022 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5025 * Set by parser to 1 for key frames and 0 for non-key frames.
5026 * It is initialized to -1, so if the parser doesn't set this flag,
5027 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5032 #if FF_API_CONVERGENCE_DURATION
5034 * @deprecated unused
5036 attribute_deprecated
5037 int64_t convergence_duration;
5040 // Timestamp generation support:
5042 * Synchronization point for start of timestamp generation.
5044 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5047 * For example, this corresponds to presence of H.264 buffering period
5053 * Offset of the current timestamp against last timestamp sync point in
5054 * units of AVCodecContext.time_base.
5056 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5057 * contain a valid timestamp offset.
5059 * Note that the timestamp of sync point has usually a nonzero
5060 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5061 * the next frame after timestamp sync point will be usually 1.
5063 * For example, this corresponds to H.264 cpb_removal_delay.
5065 int dts_ref_dts_delta;
5068 * Presentation delay of current frame in units of AVCodecContext.time_base.
5070 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5071 * contain valid non-negative timestamp delta (presentation time of a frame
5072 * must not lie in the past).
5074 * This delay represents the difference between decoding and presentation
5075 * time of the frame.
5077 * For example, this corresponds to H.264 dpb_output_delay.
5082 * Position of the packet in file.
5084 * Analogous to cur_frame_pts/dts
5086 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5089 * Byte position of currently parsed frame in stream.
5094 * Previous frame byte position.
5099 * Duration of the current frame.
5100 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5101 * For all other types, this is in units of AVCodecContext.time_base.
5105 enum AVFieldOrder field_order;
5108 * Indicate whether a picture is coded as a frame, top field or bottom field.
5110 * For example, H.264 field_pic_flag equal to 0 corresponds to
5111 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5112 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5113 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5115 enum AVPictureStructure picture_structure;
5118 * Picture number incremented in presentation or output order.
5119 * This field may be reinitialized at the first picture of a new sequence.
5121 * For example, this corresponds to H.264 PicOrderCnt.
5123 int output_picture_number;
5126 * Dimensions of the decoded video intended for presentation.
5132 * Dimensions of the coded video.
5138 * The format of the coded data, corresponds to enum AVPixelFormat for video
5139 * and for enum AVSampleFormat for audio.
5141 * Note that a decoder can have considerable freedom in how exactly it
5142 * decodes the data, so the format reported here might be different from the
5143 * one returned by a decoder.
5146 } AVCodecParserContext;
5148 typedef struct AVCodecParser {
5149 int codec_ids[5]; /* several codec IDs are permitted */
5151 int (*parser_init)(AVCodecParserContext *s);
5152 /* This callback never returns an error, a negative value means that
5153 * the frame start was in a previous packet. */
5154 int (*parser_parse)(AVCodecParserContext *s,
5155 AVCodecContext *avctx,
5156 const uint8_t **poutbuf, int *poutbuf_size,
5157 const uint8_t *buf, int buf_size);
5158 void (*parser_close)(AVCodecParserContext *s);
5159 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5160 struct AVCodecParser *next;
5163 AVCodecParser *av_parser_next(const AVCodecParser *c);
5165 void av_register_codec_parser(AVCodecParser *parser);
5166 AVCodecParserContext *av_parser_init(int codec_id);
5171 * @param s parser context.
5172 * @param avctx codec context.
5173 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5174 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5175 * @param buf input buffer.
5176 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5177 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5178 To signal EOF, this should be 0 (so that the last frame
5180 * @param pts input presentation timestamp.
5181 * @param dts input decoding timestamp.
5182 * @param pos input byte position in stream.
5183 * @return the number of bytes of the input bitstream used.
5188 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5195 * decode_frame(data, size);
5199 int av_parser_parse2(AVCodecParserContext *s,
5200 AVCodecContext *avctx,
5201 uint8_t **poutbuf, int *poutbuf_size,
5202 const uint8_t *buf, int buf_size,
5203 int64_t pts, int64_t dts,
5207 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5208 * @deprecated use AVBitStreamFilter
5210 int av_parser_change(AVCodecParserContext *s,
5211 AVCodecContext *avctx,
5212 uint8_t **poutbuf, int *poutbuf_size,
5213 const uint8_t *buf, int buf_size, int keyframe);
5214 void av_parser_close(AVCodecParserContext *s);
5222 * @addtogroup lavc_encoding
5227 * Find a registered encoder with a matching codec ID.
5229 * @param id AVCodecID of the requested encoder
5230 * @return An encoder if one was found, NULL otherwise.
5232 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5235 * Find a registered encoder with the specified name.
5237 * @param name name of the requested encoder
5238 * @return An encoder if one was found, NULL otherwise.
5240 AVCodec *avcodec_find_encoder_by_name(const char *name);
5243 * Encode a frame of audio.
5245 * Takes input samples from frame and writes the next output packet, if
5246 * available, to avpkt. The output packet does not necessarily contain data for
5247 * the most recent frame, as encoders can delay, split, and combine input frames
5248 * internally as needed.
5250 * @param avctx codec context
5251 * @param avpkt output AVPacket.
5252 * The user can supply an output buffer by setting
5253 * avpkt->data and avpkt->size prior to calling the
5254 * function, but if the size of the user-provided data is not
5255 * large enough, encoding will fail. If avpkt->data and
5256 * avpkt->size are set, avpkt->destruct must also be set. All
5257 * other AVPacket fields will be reset by the encoder using
5258 * av_init_packet(). If avpkt->data is NULL, the encoder will
5259 * allocate it. The encoder will set avpkt->size to the size
5260 * of the output packet.
5262 * If this function fails or produces no output, avpkt will be
5263 * freed using av_packet_unref().
5264 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5265 * May be NULL when flushing an encoder that has the
5266 * AV_CODEC_CAP_DELAY capability set.
5267 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5268 * can have any number of samples.
5269 * If it is not set, frame->nb_samples must be equal to
5270 * avctx->frame_size for all frames except the last.
5271 * The final frame may be smaller than avctx->frame_size.
5272 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5273 * output packet is non-empty, and to 0 if it is
5274 * empty. If the function returns an error, the
5275 * packet can be assumed to be invalid, and the
5276 * value of got_packet_ptr is undefined and should
5278 * @return 0 on success, negative error code on failure
5280 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5282 attribute_deprecated
5283 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5284 const AVFrame *frame, int *got_packet_ptr);
5287 * Encode a frame of video.
5289 * Takes input raw video data from frame and writes the next output packet, if
5290 * available, to avpkt. The output packet does not necessarily contain data for
5291 * the most recent frame, as encoders can delay and reorder input frames
5292 * internally as needed.
5294 * @param avctx codec context
5295 * @param avpkt output AVPacket.
5296 * The user can supply an output buffer by setting
5297 * avpkt->data and avpkt->size prior to calling the
5298 * function, but if the size of the user-provided data is not
5299 * large enough, encoding will fail. All other AVPacket fields
5300 * will be reset by the encoder using av_init_packet(). If
5301 * avpkt->data is NULL, the encoder will allocate it.
5302 * The encoder will set avpkt->size to the size of the
5303 * output packet. The returned data (if any) belongs to the
5304 * caller, he is responsible for freeing it.
5306 * If this function fails or produces no output, avpkt will be
5307 * freed using av_packet_unref().
5308 * @param[in] frame AVFrame containing the raw video data to be encoded.
5309 * May be NULL when flushing an encoder that has the
5310 * AV_CODEC_CAP_DELAY capability set.
5311 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5312 * output packet is non-empty, and to 0 if it is
5313 * empty. If the function returns an error, the
5314 * packet can be assumed to be invalid, and the
5315 * value of got_packet_ptr is undefined and should
5317 * @return 0 on success, negative error code on failure
5319 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5321 attribute_deprecated
5322 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5323 const AVFrame *frame, int *got_packet_ptr);
5325 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5326 const AVSubtitle *sub);
5333 #if FF_API_AVCODEC_RESAMPLE
5335 * @defgroup lavc_resample Audio resampling
5337 * @deprecated use libswresample instead
5341 struct ReSampleContext;
5342 struct AVResampleContext;
5344 typedef struct ReSampleContext ReSampleContext;
5347 * Initialize audio resampling context.
5349 * @param output_channels number of output channels
5350 * @param input_channels number of input channels
5351 * @param output_rate output sample rate
5352 * @param input_rate input sample rate
5353 * @param sample_fmt_out requested output sample format
5354 * @param sample_fmt_in input sample format
5355 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5356 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5357 * @param linear if 1 then the used FIR filter will be linearly interpolated
5358 between the 2 closest, if 0 the closest will be used
5359 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5360 * @return allocated ReSampleContext, NULL if error occurred
5362 attribute_deprecated
5363 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5364 int output_rate, int input_rate,
5365 enum AVSampleFormat sample_fmt_out,
5366 enum AVSampleFormat sample_fmt_in,
5367 int filter_length, int log2_phase_count,
5368 int linear, double cutoff);
5370 attribute_deprecated
5371 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5374 * Free resample context.
5376 * @param s a non-NULL pointer to a resample context previously
5377 * created with av_audio_resample_init()
5379 attribute_deprecated
5380 void audio_resample_close(ReSampleContext *s);
5384 * Initialize an audio resampler.
5385 * Note, if either rate is not an integer then simply scale both rates up so they are.
5386 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5387 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5388 * @param linear If 1 then the used FIR filter will be linearly interpolated
5389 between the 2 closest, if 0 the closest will be used
5390 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5392 attribute_deprecated
5393 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5396 * Resample an array of samples using a previously configured context.
5397 * @param src an array of unconsumed samples
5398 * @param consumed the number of samples of src which have been consumed are returned here
5399 * @param src_size the number of unconsumed samples available
5400 * @param dst_size the amount of space in samples available in dst
5401 * @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.
5402 * @return the number of samples written in dst or -1 if an error occurred
5404 attribute_deprecated
5405 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5409 * Compensate samplerate/timestamp drift. The compensation is done by changing
5410 * the resampler parameters, so no audible clicks or similar distortions occur
5411 * @param compensation_distance distance in output samples over which the compensation should be performed
5412 * @param sample_delta number of output samples which should be output less
5414 * example: av_resample_compensate(c, 10, 500)
5415 * here instead of 510 samples only 500 samples would be output
5417 * note, due to rounding the actual compensation might be slightly different,
5418 * especially if the compensation_distance is large and the in_rate used during init is small
5420 attribute_deprecated
5421 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5422 attribute_deprecated
5423 void av_resample_close(struct AVResampleContext *c);
5430 #if FF_API_AVPICTURE
5432 * @addtogroup lavc_picture
5437 * @deprecated unused
5439 attribute_deprecated
5440 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5443 * @deprecated unused
5445 attribute_deprecated
5446 void avpicture_free(AVPicture *picture);
5449 * @deprecated use av_image_fill_arrays() instead.
5451 attribute_deprecated
5452 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5453 enum AVPixelFormat pix_fmt, int width, int height);
5456 * @deprecated use av_image_copy_to_buffer() instead.
5458 attribute_deprecated
5459 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5460 int width, int height,
5461 unsigned char *dest, int dest_size);
5464 * @deprecated use av_image_get_buffer_size() instead.
5466 attribute_deprecated
5467 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5470 * @deprecated av_image_copy() instead.
5472 attribute_deprecated
5473 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5474 enum AVPixelFormat pix_fmt, int width, int height);
5477 * @deprecated unused
5479 attribute_deprecated
5480 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5481 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5484 * @deprecated unused
5486 attribute_deprecated
5487 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5488 int padtop, int padbottom, int padleft, int padright, int *color);
5496 * @defgroup lavc_misc Utility functions
5499 * Miscellaneous utility functions related to both encoding and decoding
5505 * @defgroup lavc_misc_pixfmt Pixel formats
5507 * Functions for working with pixel formats.
5512 * Utility function to access log2_chroma_w log2_chroma_h from
5513 * the pixel format AVPixFmtDescriptor.
5515 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5516 * for one that returns a failure code and continues in case of invalid
5519 * @param[in] pix_fmt the pixel format
5520 * @param[out] h_shift store log2_chroma_w
5521 * @param[out] v_shift store log2_chroma_h
5523 * @see av_pix_fmt_get_chroma_sub_sample
5526 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5529 * Return a value representing the fourCC code associated to the
5530 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5533 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5536 * @deprecated see av_get_pix_fmt_loss()
5538 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5542 * Find the best pixel format to convert to given a certain source pixel
5543 * format. When converting from one pixel format to another, information loss
5544 * may occur. For example, when converting from RGB24 to GRAY, the color
5545 * information will be lost. Similarly, other losses occur when converting from
5546 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5547 * the given pixel formats should be used to suffer the least amount of loss.
5548 * The pixel formats from which it chooses one, are determined by the
5549 * pix_fmt_list parameter.
5552 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5553 * @param[in] src_pix_fmt source pixel format
5554 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5555 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5556 * @return The best pixel format to convert to or -1 if none was found.
5558 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5559 enum AVPixelFormat src_pix_fmt,
5560 int has_alpha, int *loss_ptr);
5563 * @deprecated see av_find_best_pix_fmt_of_2()
5565 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5566 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5568 attribute_deprecated
5569 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5570 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5572 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5578 #if FF_API_SET_DIMENSIONS
5580 * @deprecated this function is not supposed to be used from outside of lavc
5582 attribute_deprecated
5583 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5587 * Put a string representing the codec tag codec_tag in buf.
5589 * @param buf buffer to place codec tag in
5590 * @param buf_size size in bytes of buf
5591 * @param codec_tag codec tag to assign
5592 * @return the length of the string that would have been generated if
5593 * enough space had been available, excluding the trailing null
5595 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5597 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5600 * Return a name for the specified profile, if available.
5602 * @param codec the codec that is searched for the given profile
5603 * @param profile the profile value for which a name is requested
5604 * @return A name for the profile if found, NULL otherwise.
5606 const char *av_get_profile_name(const AVCodec *codec, int profile);
5609 * Return a name for the specified profile, if available.
5611 * @param codec_id the ID of the codec to which the requested profile belongs
5612 * @param profile the profile value for which a name is requested
5613 * @return A name for the profile if found, NULL otherwise.
5615 * @note unlike av_get_profile_name(), which searches a list of profiles
5616 * supported by a specific decoder or encoder implementation, this
5617 * function searches the list of profiles from the AVCodecDescriptor
5619 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5621 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5622 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5623 //FIXME func typedef
5626 * Fill AVFrame audio data and linesize pointers.
5628 * The buffer buf must be a preallocated buffer with a size big enough
5629 * to contain the specified samples amount. The filled AVFrame data
5630 * pointers will point to this buffer.
5632 * AVFrame extended_data channel pointers are allocated if necessary for
5635 * @param frame the AVFrame
5636 * frame->nb_samples must be set prior to calling the
5637 * function. This function fills in frame->data,
5638 * frame->extended_data, frame->linesize[0].
5639 * @param nb_channels channel count
5640 * @param sample_fmt sample format
5641 * @param buf buffer to use for frame data
5642 * @param buf_size size of buffer
5643 * @param align plane size sample alignment (0 = default)
5644 * @return >=0 on success, negative error code on failure
5645 * @todo return the size in bytes required to store the samples in
5646 * case of success, at the next libavutil bump
5648 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5649 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5650 int buf_size, int align);
5653 * Reset the internal decoder state / flush internal buffers. Should be called
5654 * e.g. when seeking or when switching to a different stream.
5656 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5657 * this invalidates the frames previously returned from the decoder. When
5658 * refcounted frames are used, the decoder just releases any references it might
5659 * keep internally, but the caller's reference remains valid.
5661 void avcodec_flush_buffers(AVCodecContext *avctx);
5664 * Return codec bits per sample.
5666 * @param[in] codec_id the codec
5667 * @return Number of bits per sample or zero if unknown for the given codec.
5669 int av_get_bits_per_sample(enum AVCodecID codec_id);
5672 * Return the PCM codec associated with a sample format.
5673 * @param be endianness, 0 for little, 1 for big,
5674 * -1 (or anything else) for native
5675 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5677 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5680 * Return codec bits per sample.
5681 * Only return non-zero if the bits per sample is exactly correct, not an
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_exact_bits_per_sample(enum AVCodecID codec_id);
5690 * Return audio frame duration.
5692 * @param avctx codec context
5693 * @param frame_bytes size of the frame, or 0 if unknown
5694 * @return frame duration, in samples, if known. 0 if not able to
5697 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5700 * This function is the same as av_get_audio_frame_duration(), except it works
5701 * with AVCodecParameters instead of an AVCodecContext.
5703 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5706 typedef struct AVBitStreamFilterContext {
5708 struct AVBitStreamFilter *filter;
5709 AVCodecParserContext *parser;
5710 struct AVBitStreamFilterContext *next;
5712 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5713 * Not for access by library users.
5716 } AVBitStreamFilterContext;
5719 typedef struct AVBSFInternal AVBSFInternal;
5722 * The bitstream filter state.
5724 * This struct must be allocated with av_bsf_alloc() and freed with
5727 * The fields in the struct will only be changed (by the caller or by the
5728 * filter) as described in their documentation, and are to be considered
5729 * immutable otherwise.
5731 typedef struct AVBSFContext {
5733 * A class for logging and AVOptions
5735 const AVClass *av_class;
5738 * The bitstream filter this context is an instance of.
5740 const struct AVBitStreamFilter *filter;
5743 * Opaque libavcodec internal data. Must not be touched by the caller in any
5746 AVBSFInternal *internal;
5749 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5750 * this is an AVOptions-enabled struct.
5755 * Parameters of the input stream. Set by the caller before av_bsf_init().
5757 AVCodecParameters *par_in;
5760 * Parameters of the output stream. Set by the filter in av_bsf_init().
5762 AVCodecParameters *par_out;
5765 * The timebase used for the timestamps of the input packets. Set by the
5766 * caller before av_bsf_init().
5768 AVRational time_base_in;
5771 * The timebase used for the timestamps of the output packets. Set by the
5772 * filter in av_bsf_init().
5774 AVRational time_base_out;
5777 typedef struct AVBitStreamFilter {
5781 * A list of codec ids supported by the filter, terminated by
5783 * May be NULL, in that case the bitstream filter works with any codec id.
5785 const enum AVCodecID *codec_ids;
5788 * A class for the private data, used to declare bitstream filter private
5789 * AVOptions. This field is NULL for bitstream filters that do not declare
5792 * If this field is non-NULL, the first member of the filter private data
5793 * must be a pointer to AVClass, which will be set by libavcodec generic
5794 * code to this class.
5796 const AVClass *priv_class;
5798 /*****************************************************************
5799 * No fields below this line are part of the public API. They
5800 * may not be used outside of libavcodec and can be changed and
5802 * New public fields should be added right above.
5803 *****************************************************************
5807 int (*init)(AVBSFContext *ctx);
5808 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5809 void (*close)(AVBSFContext *ctx);
5810 } AVBitStreamFilter;
5814 * Register a bitstream filter.
5816 * The filter will be accessible to the application code through
5817 * av_bitstream_filter_next() or can be directly initialized with
5818 * av_bitstream_filter_init().
5820 * @see avcodec_register_all()
5822 attribute_deprecated
5823 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5826 * Create and initialize a bitstream filter context given a bitstream
5829 * The returned context must be freed with av_bitstream_filter_close().
5831 * @param name the name of the bitstream filter
5832 * @return a bitstream filter context if a matching filter was found
5833 * and successfully initialized, NULL otherwise
5835 attribute_deprecated
5836 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5841 * This function filters the buffer buf with size buf_size, and places the
5842 * filtered buffer in the buffer pointed to by poutbuf.
5844 * The output buffer must be freed by the caller.
5846 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5847 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5848 * If specified, this must point to the encoder context of the
5849 * output stream the packet is sent to.
5850 * @param args arguments which specify the filter configuration, may be NULL
5851 * @param poutbuf pointer which is updated to point to the filtered buffer
5852 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5853 * @param buf buffer containing the data to filter
5854 * @param buf_size size in bytes of buf
5855 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5856 * @return >= 0 in case of success, or a negative error code in case of failure
5858 * If the return value is positive, an output buffer is allocated and
5859 * is available in *poutbuf, and is distinct from the input buffer.
5861 * If the return value is 0, the output buffer is not allocated and
5862 * should be considered identical to the input buffer, or in case
5863 * *poutbuf was set it points to the input buffer (not necessarily to
5864 * its starting address). A special case is if *poutbuf was set to NULL and
5865 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5867 attribute_deprecated
5868 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5869 AVCodecContext *avctx, const char *args,
5870 uint8_t **poutbuf, int *poutbuf_size,
5871 const uint8_t *buf, int buf_size, int keyframe);
5874 * Release bitstream filter context.
5876 * @param bsf the bitstream filter context created with
5877 * av_bitstream_filter_init(), can be NULL
5879 attribute_deprecated
5880 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5883 * If f is NULL, return the first registered bitstream filter,
5884 * if f is non-NULL, return the next registered bitstream filter
5885 * after f, or NULL if f is the last one.
5887 * This function can be used to iterate over all registered bitstream
5890 attribute_deprecated
5891 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5895 * @return a bitstream filter with the specified name or NULL if no such
5896 * bitstream filter exists.
5898 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5901 * Iterate over all registered bitstream filters.
5903 * @param opaque a pointer where libavcodec will store the iteration state. Must
5904 * point to NULL to start the iteration.
5906 * @return the next registered bitstream filter or NULL when the iteration is
5909 const AVBitStreamFilter *av_bsf_next(void **opaque);
5912 * Allocate a context for a given bitstream filter. The caller must fill in the
5913 * context parameters as described in the documentation and then call
5914 * av_bsf_init() before sending any data to the filter.
5916 * @param filter the filter for which to allocate an instance.
5917 * @param ctx a pointer into which the pointer to the newly-allocated context
5918 * will be written. It must be freed with av_bsf_free() after the
5919 * filtering is done.
5921 * @return 0 on success, a negative AVERROR code on failure
5923 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5926 * Prepare the filter for use, after all the parameters and options have been
5929 int av_bsf_init(AVBSFContext *ctx);
5932 * Submit a packet for filtering.
5934 * After sending each packet, the filter must be completely drained by calling
5935 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5938 * @param pkt the packet to filter. pkt must contain some payload (i.e data or
5939 * side data must be present in pkt). The bitstream filter will take ownership of
5940 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5941 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5942 * packets will be sent). That will cause the filter to output any packets it
5943 * may have buffered internally.
5945 * @return 0 on success, a negative AVERROR on error.
5947 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5950 * Retrieve a filtered packet.
5952 * @param[out] pkt this struct will be filled with the contents of the filtered
5953 * packet. It is owned by the caller and must be freed using
5954 * av_packet_unref() when it is no longer needed.
5955 * This parameter should be "clean" (i.e. freshly allocated
5956 * with av_packet_alloc() or unreffed with av_packet_unref())
5957 * when this function is called. If this function returns
5958 * successfully, the contents of pkt will be completely
5959 * overwritten by the returned data. On failure, pkt is not
5962 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5963 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5964 * will be no further output from the filter. Another negative AVERROR value if
5967 * @note one input packet may result in several output packets, so after sending
5968 * a packet with av_bsf_send_packet(), this function needs to be called
5969 * repeatedly until it stops returning 0. It is also possible for a filter to
5970 * output fewer packets than were sent to it, so this function may return
5971 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5973 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5976 * Free a bitstream filter context and everything associated with it; write NULL
5977 * into the supplied pointer.
5979 void av_bsf_free(AVBSFContext **ctx);
5982 * Get the AVClass for AVBSFContext. It can be used in combination with
5983 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5985 * @see av_opt_find().
5987 const AVClass *av_bsf_get_class(void);
5990 * Structure for chain/list of bitstream filters.
5991 * Empty list can be allocated by av_bsf_list_alloc().
5993 typedef struct AVBSFList AVBSFList;
5996 * Allocate empty list of bitstream filters.
5997 * The list must be later freed by av_bsf_list_free()
5998 * or finalized by av_bsf_list_finalize().
6000 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6002 AVBSFList *av_bsf_list_alloc(void);
6005 * Free list of bitstream filters.
6007 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6009 void av_bsf_list_free(AVBSFList **lst);
6012 * Append bitstream filter to the list of bitstream filters.
6014 * @param lst List to append to
6015 * @param bsf Filter context to be appended
6017 * @return >=0 on success, negative AVERROR in case of failure
6019 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6022 * Construct new bitstream filter context given it's name and options
6023 * and append it to the list of bitstream filters.
6025 * @param lst List to append to
6026 * @param bsf_name Name of the bitstream filter
6027 * @param options Options for the bitstream filter, can be set to NULL
6029 * @return >=0 on success, negative AVERROR in case of failure
6031 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6033 * Finalize list of bitstream filters.
6035 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6036 * so the whole chain of bitstream filters can be treated as single filter
6037 * freshly allocated by av_bsf_alloc().
6038 * If the call is successful, @ref AVBSFList structure is freed and lst
6039 * will be set to NULL. In case of failure, caller is responsible for
6040 * freeing the structure by av_bsf_list_free()
6042 * @param lst Filter list structure to be transformed
6043 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6044 * representing the chain of bitstream filters
6046 * @return >=0 on success, negative AVERROR in case of failure
6048 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6051 * Parse string describing list of bitstream filters and create single
6052 * @ref AVBSFContext describing the whole chain of bitstream filters.
6053 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6054 * allocated by av_bsf_alloc().
6056 * @param str String describing chain of bitstream filters in format
6057 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6058 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6059 * representing the chain of bitstream filters
6061 * @return >=0 on success, negative AVERROR in case of failure
6063 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6066 * Get null/pass-through bitstream filter.
6068 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6072 int av_bsf_get_null_filter(AVBSFContext **bsf);
6077 * Same behaviour av_fast_malloc but the buffer has additional
6078 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6080 * In addition the whole buffer will initially and after resizes
6081 * be 0-initialized so that no uninitialized data will ever appear.
6083 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6086 * Same behaviour av_fast_padded_malloc except that buffer will always
6087 * be 0-initialized after call.
6089 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6092 * Encode extradata length to a buffer. Used by xiph codecs.
6094 * @param s buffer to write to; must be at least (v/255+1) bytes long
6095 * @param v size of extradata in bytes
6096 * @return number of bytes written to the buffer.
6098 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6100 #if FF_API_MISSING_SAMPLE
6102 * Log a generic warning message about a missing feature. This function is
6103 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6104 * only, and would normally not be used by applications.
6105 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6106 * a pointer to an AVClass struct
6107 * @param[in] feature string containing the name of the missing feature
6108 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
6109 * If want_sample is non-zero, additional verbiage will be added to the log
6110 * message which tells the user how to report samples to the development
6112 * @deprecated Use avpriv_report_missing_feature() instead.
6114 attribute_deprecated
6115 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
6118 * Log a generic warning message asking for a sample. This function is
6119 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6120 * only, and would normally not be used by applications.
6121 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6122 * a pointer to an AVClass struct
6123 * @param[in] msg string containing an optional message, or NULL if no message
6124 * @deprecated Use avpriv_request_sample() instead.
6126 attribute_deprecated
6127 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
6128 #endif /* FF_API_MISSING_SAMPLE */
6131 * Register the hardware accelerator hwaccel.
6133 void av_register_hwaccel(AVHWAccel *hwaccel);
6136 * If hwaccel is NULL, returns the first registered hardware accelerator,
6137 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6138 * after hwaccel, or NULL if hwaccel is the last one.
6140 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6144 * Lock operation used by lockmgr
6147 AV_LOCK_CREATE, ///< Create a mutex
6148 AV_LOCK_OBTAIN, ///< Lock the mutex
6149 AV_LOCK_RELEASE, ///< Unlock the mutex
6150 AV_LOCK_DESTROY, ///< Free mutex resources
6154 * Register a user provided lock manager supporting the operations
6155 * specified by AVLockOp. The "mutex" argument to the function points
6156 * to a (void *) where the lockmgr should store/get a pointer to a user
6157 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6158 * value left by the last call for all other ops. If the lock manager is
6159 * unable to perform the op then it should leave the mutex in the same
6160 * state as when it was called and return a non-zero value. However,
6161 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6162 * have been successfully destroyed. If av_lockmgr_register succeeds
6163 * it will return a non-negative value, if it fails it will return a
6164 * negative value and destroy all mutex and unregister all callbacks.
6165 * av_lockmgr_register is not thread-safe, it must be called from a
6166 * single thread before any calls which make use of locking are used.
6168 * @param cb User defined callback. av_lockmgr_register invokes calls
6169 * to this callback and the previously registered callback.
6170 * The callback will be used to create more than one mutex
6171 * each of which must be backed by its own underlying locking
6172 * mechanism (i.e. do not use a single static object to
6173 * implement your lock manager). If cb is set to NULL the
6174 * lockmgr will be unregistered.
6176 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6179 * Get the type of the given codec.
6181 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6184 * Get the name of a codec.
6185 * @return a static string identifying the codec; never NULL
6187 const char *avcodec_get_name(enum AVCodecID id);
6190 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6191 * with no corresponding avcodec_close()), 0 otherwise.
6193 int avcodec_is_open(AVCodecContext *s);
6196 * @return a non-zero number if codec is an encoder, zero otherwise
6198 int av_codec_is_encoder(const AVCodec *codec);
6201 * @return a non-zero number if codec is a decoder, zero otherwise
6203 int av_codec_is_decoder(const AVCodec *codec);
6206 * @return descriptor for given codec ID or NULL if no descriptor exists.
6208 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6211 * Iterate over all codec descriptors known to libavcodec.
6213 * @param prev previous descriptor. NULL to get the first descriptor.
6215 * @return next descriptor or NULL after the last descriptor
6217 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6220 * @return codec descriptor with the given name or NULL if no such descriptor
6223 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6226 * Allocate a CPB properties structure and initialize its fields to default
6229 * @param size if non-NULL, the size of the allocated struct will be written
6230 * here. This is useful for embedding it in side data.
6232 * @return the newly allocated struct or NULL on failure
6234 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6240 #endif /* AVCODEC_AVCODEC_H */