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_BINTEXT = 0x18800,
638 AV_CODEC_ID_SMPTE_KLV,
640 AV_CODEC_ID_TIMED_ID3,
641 AV_CODEC_ID_BIN_DATA,
644 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
646 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
647 * stream (only used by libavformat) */
648 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
649 * stream (only used by libavformat) */
650 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
651 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
655 * This struct describes the properties of a single codec described by an
657 * @see avcodec_descriptor_get()
659 typedef struct AVCodecDescriptor {
661 enum AVMediaType type;
663 * Name of the codec described by this descriptor. It is non-empty and
664 * unique for each codec descriptor. It should contain alphanumeric
665 * characters and '_' only.
669 * A more descriptive name for this codec. May be NULL.
671 const char *long_name;
673 * Codec properties, a combination of AV_CODEC_PROP_* flags.
677 * MIME type(s) associated with the codec.
678 * May be NULL; if not, a NULL-terminated array of MIME types.
679 * The first item is always non-NULL and is the preferred MIME type.
681 const char *const *mime_types;
683 * If non-NULL, an array of profiles recognized for this codec.
684 * Terminated with FF_PROFILE_UNKNOWN.
686 const struct AVProfile *profiles;
690 * Codec uses only intra compression.
693 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
695 * Codec supports lossy compression. Audio and video codecs only.
696 * @note a codec may support both lossy and lossless
699 #define AV_CODEC_PROP_LOSSY (1 << 1)
701 * Codec supports lossless compression. Audio and video codecs only.
703 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
705 * Codec supports frame reordering. That is, the coded order (the order in which
706 * the encoded packets are output by the encoders / stored / input to the
707 * decoders) may be different from the presentation order of the corresponding
710 * For codecs that do not have this property set, PTS and DTS should always be
713 #define AV_CODEC_PROP_REORDER (1 << 3)
715 * Subtitle codec is bitmap based
716 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
718 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
720 * Subtitle codec is text based.
721 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
723 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
726 * @ingroup lavc_decoding
727 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
728 * This is mainly needed because some optimized bitstream readers read
729 * 32 or 64 bit at once and could read over the end.<br>
730 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
731 * MPEG bitstreams could cause overread and segfault.
733 #define AV_INPUT_BUFFER_PADDING_SIZE 32
736 * @ingroup lavc_encoding
737 * minimum encoding buffer size
738 * Used to avoid some checks during header writing.
740 #define AV_INPUT_BUFFER_MIN_SIZE 16384
742 #if FF_API_WITHOUT_PREFIX
744 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
746 #define FF_INPUT_BUFFER_PADDING_SIZE 32
749 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
751 #define FF_MIN_BUFFER_SIZE 16384
752 #endif /* FF_API_WITHOUT_PREFIX */
755 * @ingroup lavc_encoding
756 * motion estimation type.
757 * @deprecated use codec private option instead
759 #if FF_API_MOTION_EST
761 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
765 ME_EPZS, ///< enhanced predictive zonal search
766 ME_X1, ///< reserved for experiments
767 ME_HEX, ///< hexagon based search
768 ME_UMH, ///< uneven multi-hexagon search
769 ME_TESA, ///< transformed exhaustive search algorithm
770 ME_ITER=50, ///< iterative search
775 * @ingroup lavc_decoding
778 /* We leave some space between them for extensions (drop some
779 * keyframes for intra-only or drop just some bidir frames). */
780 AVDISCARD_NONE =-16, ///< discard nothing
781 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
782 AVDISCARD_NONREF = 8, ///< discard all non reference
783 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
784 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
785 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
786 AVDISCARD_ALL = 48, ///< discard all
789 enum AVAudioServiceType {
790 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
791 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
792 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
793 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
794 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
795 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
796 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
797 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
798 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
799 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
803 * @ingroup lavc_encoding
805 typedef struct RcOverride{
808 int qscale; // If this is 0 then quality_factor will be used instead.
809 float quality_factor;
812 #if FF_API_MAX_BFRAMES
814 * @deprecated there is no libavcodec-wide limit on the number of B-frames
816 #define FF_MAX_B_FRAMES 16
820 These flags can be passed in AVCodecContext.flags before initialization.
821 Note: Not everything is supported yet.
825 * Allow decoders to produce frames with data planes that are not aligned
826 * to CPU requirements (e.g. due to cropping).
828 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
832 #define AV_CODEC_FLAG_QSCALE (1 << 1)
834 * 4 MV per MB allowed / advanced prediction for H.263.
836 #define AV_CODEC_FLAG_4MV (1 << 2)
838 * Output even those frames that might be corrupted.
840 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
844 #define AV_CODEC_FLAG_QPEL (1 << 4)
846 * Use internal 2pass ratecontrol in first pass mode.
848 #define AV_CODEC_FLAG_PASS1 (1 << 9)
850 * Use internal 2pass ratecontrol in second pass mode.
852 #define AV_CODEC_FLAG_PASS2 (1 << 10)
856 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
858 * Only decode/encode grayscale.
860 #define AV_CODEC_FLAG_GRAY (1 << 13)
862 * error[?] variables will be set during encoding.
864 #define AV_CODEC_FLAG_PSNR (1 << 15)
866 * Input bitstream might be truncated at a random location
867 * instead of only at frame boundaries.
869 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
871 * Use interlaced DCT.
873 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
877 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
879 * Place global headers in extradata instead of every keyframe.
881 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
883 * Use only bitexact stuff (except (I)DCT).
885 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
886 /* Fx : Flag for H.263+ extra options */
888 * H.263 advanced intra coding / MPEG-4 AC prediction
890 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
892 * interlaced motion estimation
894 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
895 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
898 * Allow non spec compliant speedup tricks.
900 #define AV_CODEC_FLAG2_FAST (1 << 0)
902 * Skip bitstream encoding.
904 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
906 * Place global headers at every keyframe instead of in extradata.
908 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
911 * timecode is in drop frame format. DEPRECATED!!!!
913 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
916 * Input bitstream might be truncated at a packet boundaries
917 * instead of only at frame boundaries.
919 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
921 * Discard cropping information from SPS.
923 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
926 * Show all frames before the first keyframe
928 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
930 * Export motion vectors through frame side data
932 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
934 * Do not skip samples and export skip information as frame side data
936 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
938 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
940 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
942 /* Unsupported options :
943 * Syntax Arithmetic coding (SAC)
944 * Reference Picture Selection
945 * Independent Segment Decoding */
947 /* codec capabilities */
950 * Decoder can use draw_horiz_band callback.
952 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
954 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
955 * If not set, it might not use get_buffer() at all or use operations that
956 * assume the buffer was allocated by avcodec_default_get_buffer.
958 #define AV_CODEC_CAP_DR1 (1 << 1)
959 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
961 * Encoder or decoder requires flushing with NULL input at the end in order to
962 * give the complete and correct output.
964 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
965 * with NULL data. The user can still send NULL data to the public encode
966 * or decode function, but libavcodec will not pass it along to the codec
967 * unless this flag is set.
970 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
971 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
975 * The encoder needs to be fed with NULL data at the end of encoding until the
976 * encoder no longer returns data.
978 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
979 * flag also means that the encoder must set the pts and duration for
980 * each output packet. If this flag is not set, the pts and duration will
981 * be determined by libavcodec from the input frame.
983 #define AV_CODEC_CAP_DELAY (1 << 5)
985 * Codec can be fed a final frame with a smaller size.
986 * This can be used to prevent truncation of the last audio samples.
988 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
992 * Codec can export data for HW decoding (VDPAU).
994 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
998 * Codec can output multiple frames per AVPacket
999 * Normally demuxers return one frame at a time, demuxers which do not do
1000 * are connected to a parser to split what they return into proper frames.
1001 * This flag is reserved to the very rare category of codecs which have a
1002 * bitstream that cannot be split into frames without timeconsuming
1003 * operations like full decoding. Demuxers carrying such bitstreams thus
1004 * may return multiple frames in a packet. This has many disadvantages like
1005 * prohibiting stream copy in many cases thus it should only be considered
1008 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1010 * Codec is experimental and is thus avoided in favor of non experimental
1013 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1015 * Codec should fill in channel configuration and samplerate instead of container
1017 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1019 * Codec supports frame-level multithreading.
1021 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1023 * Codec supports slice-based (or partition-based) multithreading.
1025 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1027 * Codec supports changed parameters at any point.
1029 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1031 * Codec supports avctx->thread_count == 0 (auto).
1033 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1035 * Audio encoder supports receiving a different number of samples in each call.
1037 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1039 * Decoder is not a preferred choice for probing.
1040 * This indicates that the decoder is not a good choice for probing.
1041 * It could for example be an expensive to spin up hardware decoder,
1042 * or it could simply not provide a lot of useful information about
1044 * A decoder marked with this flag should only be used as last resort
1045 * choice for probing.
1047 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1049 * Codec is intra only.
1051 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1053 * Codec is lossless.
1055 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1058 #if FF_API_WITHOUT_PREFIX
1060 * Allow decoders to produce frames with data planes that are not aligned
1061 * to CPU requirements (e.g. due to cropping).
1063 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1064 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1065 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1066 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1067 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1070 * @deprecated use the "gmc" private option of the libxvid encoder
1072 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1076 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1077 * mpegvideo encoders
1079 #define CODEC_FLAG_MV0 0x0040
1081 #if FF_API_INPUT_PRESERVED
1083 * @deprecated passing reference-counted frames to the encoders replaces this
1086 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1088 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1089 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1090 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1093 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1096 #define CODEC_FLAG_EMU_EDGE 0x4000
1098 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1099 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1101 #if FF_API_NORMALIZE_AQP
1103 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1104 * mpegvideo encoders
1106 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1108 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1109 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1110 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1111 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1112 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1113 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1114 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1115 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1116 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1117 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1118 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1119 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1120 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1122 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1123 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1124 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1125 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1127 /* Unsupported options :
1128 * Syntax Arithmetic coding (SAC)
1129 * Reference Picture Selection
1130 * Independent Segment Decoding */
1132 /* codec capabilities */
1134 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1136 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1137 * If not set, it might not use get_buffer() at all or use operations that
1138 * assume the buffer was allocated by avcodec_default_get_buffer.
1140 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1141 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1143 /* Codec can export data for HW decoding. This flag indicates that
1144 * the codec would call get_format() with list that might contain HW accelerated
1145 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1146 * including raw image format.
1147 * The application can use the passed context to determine bitstream version,
1148 * chroma format, resolution etc.
1150 #define CODEC_CAP_HWACCEL 0x0010
1151 #endif /* FF_API_XVMC */
1153 * Encoder or decoder requires flushing with NULL input at the end in order to
1154 * give the complete and correct output.
1156 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1157 * with NULL data. The user can still send NULL data to the public encode
1158 * or decode function, but libavcodec will not pass it along to the codec
1159 * unless this flag is set.
1162 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1163 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1167 * The encoder needs to be fed with NULL data at the end of encoding until the
1168 * encoder no longer returns data.
1170 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1171 * flag also means that the encoder must set the pts and duration for
1172 * each output packet. If this flag is not set, the pts and duration will
1173 * be determined by libavcodec from the input frame.
1175 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1177 * Codec can be fed a final frame with a smaller size.
1178 * This can be used to prevent truncation of the last audio samples.
1180 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1181 #if FF_API_CAP_VDPAU
1183 * Codec can export data for HW decoding (VDPAU).
1185 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1188 * Codec can output multiple frames per AVPacket
1189 * Normally demuxers return one frame at a time, demuxers which do not do
1190 * are connected to a parser to split what they return into proper frames.
1191 * This flag is reserved to the very rare category of codecs which have a
1192 * bitstream that cannot be split into frames without timeconsuming
1193 * operations like full decoding. Demuxers carrying such bitstreams thus
1194 * may return multiple frames in a packet. This has many disadvantages like
1195 * prohibiting stream copy in many cases thus it should only be considered
1198 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1200 * Codec is experimental and is thus avoided in favor of non experimental
1203 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1205 * Codec should fill in channel configuration and samplerate instead of container
1207 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1208 #if FF_API_NEG_LINESIZES
1210 * @deprecated no codecs use this capability
1212 #define CODEC_CAP_NEG_LINESIZES 0x0800
1215 * Codec supports frame-level multithreading.
1217 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1219 * Codec supports slice-based (or partition-based) multithreading.
1221 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1223 * Codec supports changed parameters at any point.
1225 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1227 * Codec supports avctx->thread_count == 0 (auto).
1229 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1231 * Audio encoder supports receiving a different number of samples in each call.
1233 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1235 * Codec is intra only.
1237 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1239 * Codec is lossless.
1241 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1244 * HWAccel is experimental and is thus avoided in favor of non experimental
1247 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1248 #endif /* FF_API_WITHOUT_PREFIX */
1251 //The following defines may change, don't expect compatibility if you use them.
1252 #define MB_TYPE_INTRA4x4 0x0001
1253 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1254 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1255 #define MB_TYPE_16x16 0x0008
1256 #define MB_TYPE_16x8 0x0010
1257 #define MB_TYPE_8x16 0x0020
1258 #define MB_TYPE_8x8 0x0040
1259 #define MB_TYPE_INTERLACED 0x0080
1260 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1261 #define MB_TYPE_ACPRED 0x0200
1262 #define MB_TYPE_GMC 0x0400
1263 #define MB_TYPE_SKIP 0x0800
1264 #define MB_TYPE_P0L0 0x1000
1265 #define MB_TYPE_P1L0 0x2000
1266 #define MB_TYPE_P0L1 0x4000
1267 #define MB_TYPE_P1L1 0x8000
1268 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1269 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1270 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1271 #define MB_TYPE_QUANT 0x00010000
1272 #define MB_TYPE_CBP 0x00020000
1273 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1278 * This specifies the area which should be displayed.
1279 * Note there may be multiple such areas for one frame.
1281 typedef struct AVPanScan{
1284 * - encoding: Set by user.
1285 * - decoding: Set by libavcodec.
1290 * width and height in 1/16 pel
1291 * - encoding: Set by user.
1292 * - decoding: Set by libavcodec.
1298 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1299 * - encoding: Set by user.
1300 * - decoding: Set by libavcodec.
1302 int16_t position[3][2];
1306 * This structure describes the bitrate properties of an encoded bitstream. It
1307 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1308 * parameters for H.264/HEVC.
1310 typedef struct AVCPBProperties {
1312 * Maximum bitrate of the stream, in bits per second.
1313 * Zero if unknown or unspecified.
1317 * Minimum bitrate of the stream, in bits per second.
1318 * Zero if unknown or unspecified.
1322 * Average bitrate of the stream, in bits per second.
1323 * Zero if unknown or unspecified.
1328 * The size of the buffer to which the ratecontrol is applied, in bits.
1329 * Zero if unknown or unspecified.
1334 * The delay between the time the packet this structure is associated with
1335 * is received and the time when it should be decoded, in periods of a 27MHz
1338 * UINT64_MAX when unknown or unspecified.
1343 #if FF_API_QSCALE_TYPE
1344 #define FF_QSCALE_TYPE_MPEG1 0
1345 #define FF_QSCALE_TYPE_MPEG2 1
1346 #define FF_QSCALE_TYPE_H264 2
1347 #define FF_QSCALE_TYPE_VP56 3
1351 * The decoder will keep a reference to the frame and may reuse it later.
1353 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1356 * @defgroup lavc_packet AVPacket
1358 * Types and functions for working with AVPacket.
1361 enum AVPacketSideDataType {
1362 AV_PKT_DATA_PALETTE,
1365 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1366 * that the extradata buffer was changed and the receiving side should
1367 * act upon it appropriately. The new extradata is embedded in the side
1368 * data buffer and should be immediately used for processing the current
1371 AV_PKT_DATA_NEW_EXTRADATA,
1374 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1377 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1378 * s32le channel_count
1379 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1380 * u64le channel_layout
1381 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1383 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1388 AV_PKT_DATA_PARAM_CHANGE,
1391 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1392 * structures with info about macroblocks relevant to splitting the
1393 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1394 * That is, it does not necessarily contain info about all macroblocks,
1395 * as long as the distance between macroblocks in the info is smaller
1396 * than the target payload size.
1397 * Each MB info structure is 12 bytes, and is laid out as follows:
1399 * u32le bit offset from the start of the packet
1400 * u8 current quantizer at the start of the macroblock
1402 * u16le macroblock address within the GOB
1403 * u8 horizontal MV predictor
1404 * u8 vertical MV predictor
1405 * u8 horizontal MV predictor for block number 3
1406 * u8 vertical MV predictor for block number 3
1409 AV_PKT_DATA_H263_MB_INFO,
1412 * This side data should be associated with an audio stream and contains
1413 * ReplayGain information in form of the AVReplayGain struct.
1415 AV_PKT_DATA_REPLAYGAIN,
1418 * This side data contains a 3x3 transformation matrix describing an affine
1419 * transformation that needs to be applied to the decoded video frames for
1420 * correct presentation.
1422 * See libavutil/display.h for a detailed description of the data.
1424 AV_PKT_DATA_DISPLAYMATRIX,
1427 * This side data should be associated with a video stream and contains
1428 * Stereoscopic 3D information in form of the AVStereo3D struct.
1430 AV_PKT_DATA_STEREO3D,
1433 * This side data should be associated with an audio stream and corresponds
1434 * to enum AVAudioServiceType.
1436 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1439 * This side data contains quality related information from the encoder.
1441 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1445 * u64le[error count] sum of squared differences between encoder in and output
1448 AV_PKT_DATA_QUALITY_STATS,
1451 * This side data contains an integer value representing the stream index
1452 * of a "fallback" track. A fallback track indicates an alternate
1453 * track to use when the current track can not be decoded for some reason.
1454 * e.g. no decoder available for codec.
1456 AV_PKT_DATA_FALLBACK_TRACK,
1459 * This side data corresponds to the AVCPBProperties struct.
1461 AV_PKT_DATA_CPB_PROPERTIES,
1464 * Recommmends skipping the specified number of samples
1466 * u32le number of samples to skip from start of this packet
1467 * u32le number of samples to skip from end of this packet
1468 * u8 reason for start skip
1469 * u8 reason for end skip (0=padding silence, 1=convergence)
1472 AV_PKT_DATA_SKIP_SAMPLES=70,
1475 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1476 * the packet may contain "dual mono" audio specific to Japanese DTV
1477 * and if it is true, recommends only the selected channel to be used.
1479 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1482 AV_PKT_DATA_JP_DUALMONO,
1485 * A list of zero terminated key/value strings. There is no end marker for
1486 * the list, so it is required to rely on the side data size to stop.
1488 AV_PKT_DATA_STRINGS_METADATA,
1491 * Subtitle event position
1499 AV_PKT_DATA_SUBTITLE_POSITION,
1502 * Data found in BlockAdditional element of matroska container. There is
1503 * no end marker for the data, so it is required to rely on the side data
1504 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1507 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1510 * The optional first identifier line of a WebVTT cue.
1512 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1515 * The optional settings (rendering instructions) that immediately
1516 * follow the timestamp specifier of a WebVTT cue.
1518 AV_PKT_DATA_WEBVTT_SETTINGS,
1521 * A list of zero terminated key/value strings. There is no end marker for
1522 * the list, so it is required to rely on the side data size to stop. This
1523 * side data includes updated metadata which appeared in the stream.
1525 AV_PKT_DATA_METADATA_UPDATE,
1528 * MPEGTS stream ID, this is required to pass the stream ID
1529 * information from the demuxer to the corresponding muxer.
1531 AV_PKT_DATA_MPEGTS_STREAM_ID,
1534 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1535 * should be associated with a video stream and containts data in the form
1536 * of the AVMasteringDisplayMetadata struct.
1538 AV_PKT_DATA_MASTERING_DISPLAY_METADATA
1541 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1543 typedef struct AVPacketSideData {
1546 enum AVPacketSideDataType type;
1550 * This structure stores compressed data. It is typically exported by demuxers
1551 * and then passed as input to decoders, or received as output from encoders and
1552 * then passed to muxers.
1554 * For video, it should typically contain one compressed frame. For audio it may
1555 * contain several compressed frames. Encoders are allowed to output empty
1556 * packets, with no compressed data, containing only side data
1557 * (e.g. to update some stream parameters at the end of encoding).
1559 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1560 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1561 * without libavcodec and libavformat major bump.
1563 * The semantics of data ownership depends on the buf field.
1564 * If it is set, the packet data is dynamically allocated and is
1565 * valid indefinitely until a call to av_packet_unref() reduces the
1566 * reference count to 0.
1568 * If the buf field is not set av_packet_ref() would make a copy instead
1569 * of increasing the reference count.
1571 * The side data is always allocated with av_malloc(), copied by
1572 * av_packet_ref() and freed by av_packet_unref().
1574 * @see av_packet_ref
1575 * @see av_packet_unref
1577 typedef struct AVPacket {
1579 * A reference to the reference-counted buffer where the packet data is
1581 * May be NULL, then the packet data is not reference-counted.
1585 * Presentation timestamp in AVStream->time_base units; the time at which
1586 * the decompressed packet will be presented to the user.
1587 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1588 * pts MUST be larger or equal to dts as presentation cannot happen before
1589 * decompression, unless one wants to view hex dumps. Some formats misuse
1590 * the terms dts and pts/cts to mean something different. Such timestamps
1591 * must be converted to true pts/dts before they are stored in AVPacket.
1595 * Decompression timestamp in AVStream->time_base units; the time at which
1596 * the packet is decompressed.
1597 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1604 * A combination of AV_PKT_FLAG values
1608 * Additional packet data that can be provided by the container.
1609 * Packet can contain several types of side information.
1611 AVPacketSideData *side_data;
1612 int side_data_elems;
1615 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1616 * Equals next_pts - this_pts in presentation order.
1620 int64_t pos; ///< byte position in stream, -1 if unknown
1622 #if FF_API_CONVERGENCE_DURATION
1624 * @deprecated Same as the duration field, but as int64_t. This was required
1625 * for Matroska subtitles, whose duration values could overflow when the
1626 * duration field was still an int.
1628 attribute_deprecated
1629 int64_t convergence_duration;
1632 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1633 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1635 * Flag is used to discard packets which are required to maintain valid
1636 * decoder state but are not required for output and should be dropped
1639 #define AV_PKT_FLAG_DISCARD 0x0004
1641 enum AVSideDataParamChangeFlags {
1642 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1643 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1644 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1645 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1651 struct AVCodecInternal;
1655 AV_FIELD_PROGRESSIVE,
1656 AV_FIELD_TT, //< Top coded_first, top displayed first
1657 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1658 AV_FIELD_TB, //< Top coded first, bottom displayed first
1659 AV_FIELD_BT, //< Bottom coded first, top displayed first
1663 * main external API structure.
1664 * New fields can be added to the end with minor version bumps.
1665 * Removal, reordering and changes to existing fields require a major
1667 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1669 * The name string for AVOptions options matches the associated command line
1670 * parameter name and can be found in libavcodec/options_table.h
1671 * The AVOption/command line parameter names differ in some cases from the C
1672 * structure field names for historic reasons or brevity.
1673 * sizeof(AVCodecContext) must not be used outside libav*.
1675 typedef struct AVCodecContext {
1677 * information on struct for av_log
1678 * - set by avcodec_alloc_context3
1680 const AVClass *av_class;
1681 int log_level_offset;
1683 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1684 const struct AVCodec *codec;
1685 #if FF_API_CODEC_NAME
1687 * @deprecated this field is not used for anything in libavcodec
1689 attribute_deprecated
1690 char codec_name[32];
1692 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1695 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1696 * This is used to work around some encoder bugs.
1697 * A demuxer should set this to what is stored in the field used to identify the codec.
1698 * If there are multiple such fields in a container then the demuxer should choose the one
1699 * which maximizes the information about the used codec.
1700 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1701 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1702 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1704 * - encoding: Set by user, if not then the default based on codec_id will be used.
1705 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1707 unsigned int codec_tag;
1709 #if FF_API_STREAM_CODEC_TAG
1711 * @deprecated this field is unused
1713 attribute_deprecated
1714 unsigned int stream_codec_tag;
1720 * Private context used for internal data.
1722 * Unlike priv_data, this is not codec-specific. It is used in general
1723 * libavcodec functions.
1725 struct AVCodecInternal *internal;
1728 * Private data of the user, can be used to carry app specific stuff.
1729 * - encoding: Set by user.
1730 * - decoding: Set by user.
1735 * the average bitrate
1736 * - encoding: Set by user; unused for constant quantizer encoding.
1737 * - decoding: Set by user, may be overwritten by libavcodec
1738 * if this info is available in the stream
1743 * number of bits the bitstream is allowed to diverge from the reference.
1744 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1745 * - encoding: Set by user; unused for constant quantizer encoding.
1746 * - decoding: unused
1748 int bit_rate_tolerance;
1751 * Global quality for codecs which cannot change it per frame.
1752 * This should be proportional to MPEG-1/2/4 qscale.
1753 * - encoding: Set by user.
1754 * - decoding: unused
1759 * - encoding: Set by user.
1760 * - decoding: unused
1762 int compression_level;
1763 #define FF_COMPRESSION_DEFAULT -1
1767 * - encoding: Set by user.
1768 * - decoding: Set by user.
1774 * - encoding: Set by user.
1775 * - decoding: Set by user.
1780 * some codecs need / can use extradata like Huffman tables.
1781 * MJPEG: Huffman tables
1782 * rv10: additional flags
1783 * MPEG-4: global headers (they can be in the bitstream or here)
1784 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1785 * than extradata_size to avoid problems if it is read with the bitstream reader.
1786 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1787 * - encoding: Set/allocated/freed by libavcodec.
1788 * - decoding: Set/allocated/freed by user.
1794 * This is the fundamental unit of time (in seconds) in terms
1795 * of which frame timestamps are represented. For fixed-fps content,
1796 * timebase should be 1/framerate and timestamp increments should be
1798 * This often, but not always is the inverse of the frame rate or field rate
1799 * for video. 1/time_base is not the average frame rate if the frame rate is not
1802 * Like containers, elementary streams also can store timestamps, 1/time_base
1803 * is the unit in which these timestamps are specified.
1804 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1805 * vop_time_increment_resolution and fixed_vop_rate
1806 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1808 * - encoding: MUST be set by user.
1809 * - decoding: the use of this field for decoding is deprecated.
1810 * Use framerate instead.
1812 AVRational time_base;
1815 * For some codecs, the time base is closer to the field rate than the frame rate.
1816 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1817 * if no telecine is used ...
1819 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1821 int ticks_per_frame;
1826 * Encoding: Number of frames delay there will be from the encoder input to
1827 * the decoder output. (we assume the decoder matches the spec)
1828 * Decoding: Number of frames delay in addition to what a standard decoder
1829 * as specified in the spec would produce.
1832 * Number of frames the decoded output will be delayed relative to the
1836 * For encoding, this field is unused (see initial_padding).
1838 * For decoding, this is the number of samples the decoder needs to
1839 * output before the decoder's output is valid. When seeking, you should
1840 * start decoding this many samples prior to your desired seek point.
1842 * - encoding: Set by libavcodec.
1843 * - decoding: Set by libavcodec.
1850 * picture width / height.
1852 * @note Those fields may not match the values of the last
1853 * AVFrame output by avcodec_decode_video2 due frame
1856 * - encoding: MUST be set by user.
1857 * - decoding: May be set by the user before opening the decoder if known e.g.
1858 * from the container. Some decoders will require the dimensions
1859 * to be set by the caller. During decoding, the decoder may
1860 * overwrite those values as required while parsing the data.
1865 * Bitstream width / height, may be different from width/height e.g. when
1866 * the decoded frame is cropped before being output or lowres is enabled.
1868 * @note Those field may not match the value of the last
1869 * AVFrame output by avcodec_receive_frame() due frame
1872 * - encoding: unused
1873 * - decoding: May be set by the user before opening the decoder if known
1874 * e.g. from the container. During decoding, the decoder may
1875 * overwrite those values as required while parsing the data.
1877 int coded_width, coded_height;
1879 #if FF_API_ASPECT_EXTENDED
1880 #define FF_ASPECT_EXTENDED 15
1884 * the number of pictures in a group of pictures, or 0 for intra_only
1885 * - encoding: Set by user.
1886 * - decoding: unused
1891 * Pixel format, see AV_PIX_FMT_xxx.
1892 * May be set by the demuxer if known from headers.
1893 * May be overridden by the decoder if it knows better.
1895 * @note This field may not match the value of the last
1896 * AVFrame output by avcodec_receive_frame() due frame
1899 * - encoding: Set by user.
1900 * - decoding: Set by user if known, overridden by libavcodec while
1903 enum AVPixelFormat pix_fmt;
1905 #if FF_API_MOTION_EST
1907 * This option does nothing
1908 * @deprecated use codec private options instead
1910 attribute_deprecated int me_method;
1914 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1915 * decoder to draw a horizontal band. It improves cache usage. Not
1916 * all codecs can do that. You must check the codec capabilities
1918 * When multithreading is used, it may be called from multiple threads
1919 * at the same time; threads might draw different parts of the same AVFrame,
1920 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1922 * The function is also used by hardware acceleration APIs.
1923 * It is called at least once during frame decoding to pass
1924 * the data needed for hardware render.
1925 * In that mode instead of pixel data, AVFrame points to
1926 * a structure specific to the acceleration API. The application
1927 * reads the structure and can change some fields to indicate progress
1929 * - encoding: unused
1930 * - decoding: Set by user.
1931 * @param height the height of the slice
1932 * @param y the y position of the slice
1933 * @param type 1->top field, 2->bottom field, 3->frame
1934 * @param offset offset into the AVFrame.data from which the slice should be read
1936 void (*draw_horiz_band)(struct AVCodecContext *s,
1937 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1938 int y, int type, int height);
1941 * callback to negotiate the pixelFormat
1942 * @param fmt is the list of formats which are supported by the codec,
1943 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1944 * The first is always the native one.
1945 * @note The callback may be called again immediately if initialization for
1946 * the selected (hardware-accelerated) pixel format failed.
1947 * @warning Behavior is undefined if the callback returns a value not
1948 * in the fmt list of formats.
1949 * @return the chosen format
1950 * - encoding: unused
1951 * - decoding: Set by user, if not set the native format will be chosen.
1953 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1956 * maximum number of B-frames between non-B-frames
1957 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1958 * - encoding: Set by user.
1959 * - decoding: unused
1964 * qscale factor between IP and B-frames
1965 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1966 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1967 * - encoding: Set by user.
1968 * - decoding: unused
1970 float b_quant_factor;
1972 #if FF_API_RC_STRATEGY
1973 /** @deprecated use codec private option instead */
1974 attribute_deprecated int rc_strategy;
1975 #define FF_RC_STRATEGY_XVID 1
1978 #if FF_API_PRIVATE_OPT
1979 /** @deprecated use encoder private options instead */
1980 attribute_deprecated
1981 int b_frame_strategy;
1985 * qscale offset between IP and B-frames
1986 * - encoding: Set by user.
1987 * - decoding: unused
1989 float b_quant_offset;
1992 * Size of the frame reordering buffer in the decoder.
1993 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1994 * - encoding: Set by libavcodec.
1995 * - decoding: Set by libavcodec.
1999 #if FF_API_PRIVATE_OPT
2000 /** @deprecated use encoder private options instead */
2001 attribute_deprecated
2006 * qscale factor between P- and I-frames
2007 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2008 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2009 * - encoding: Set by user.
2010 * - decoding: unused
2012 float i_quant_factor;
2015 * qscale offset between P and I-frames
2016 * - encoding: Set by user.
2017 * - decoding: unused
2019 float i_quant_offset;
2022 * luminance masking (0-> disabled)
2023 * - encoding: Set by user.
2024 * - decoding: unused
2029 * temporary complexity masking (0-> disabled)
2030 * - encoding: Set by user.
2031 * - decoding: unused
2033 float temporal_cplx_masking;
2036 * spatial complexity masking (0-> disabled)
2037 * - encoding: Set by user.
2038 * - decoding: unused
2040 float spatial_cplx_masking;
2043 * p block masking (0-> disabled)
2044 * - encoding: Set by user.
2045 * - decoding: unused
2050 * darkness masking (0-> disabled)
2051 * - encoding: Set by user.
2052 * - decoding: unused
2058 * - encoding: Set by libavcodec.
2059 * - decoding: Set by user (or 0).
2063 #if FF_API_PRIVATE_OPT
2064 /** @deprecated use encoder private options instead */
2065 attribute_deprecated
2066 int prediction_method;
2067 #define FF_PRED_LEFT 0
2068 #define FF_PRED_PLANE 1
2069 #define FF_PRED_MEDIAN 2
2073 * slice offsets in the frame in bytes
2074 * - encoding: Set/allocated by libavcodec.
2075 * - decoding: Set/allocated by user (or NULL).
2080 * sample aspect ratio (0 if unknown)
2081 * That is the width of a pixel divided by the height of the pixel.
2082 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2083 * - encoding: Set by user.
2084 * - decoding: Set by libavcodec.
2086 AVRational sample_aspect_ratio;
2089 * motion estimation comparison function
2090 * - encoding: Set by user.
2091 * - decoding: unused
2095 * subpixel motion estimation comparison function
2096 * - encoding: Set by user.
2097 * - decoding: unused
2101 * macroblock comparison function (not supported yet)
2102 * - encoding: Set by user.
2103 * - decoding: unused
2107 * interlaced DCT comparison function
2108 * - encoding: Set by user.
2109 * - decoding: unused
2112 #define FF_CMP_SAD 0
2113 #define FF_CMP_SSE 1
2114 #define FF_CMP_SATD 2
2115 #define FF_CMP_DCT 3
2116 #define FF_CMP_PSNR 4
2117 #define FF_CMP_BIT 5
2119 #define FF_CMP_ZERO 7
2120 #define FF_CMP_VSAD 8
2121 #define FF_CMP_VSSE 9
2122 #define FF_CMP_NSSE 10
2123 #define FF_CMP_W53 11
2124 #define FF_CMP_W97 12
2125 #define FF_CMP_DCTMAX 13
2126 #define FF_CMP_DCT264 14
2127 #define FF_CMP_MEDIAN_SAD 15
2128 #define FF_CMP_CHROMA 256
2131 * ME diamond size & shape
2132 * - encoding: Set by user.
2133 * - decoding: unused
2138 * amount of previous MV predictors (2a+1 x 2a+1 square)
2139 * - encoding: Set by user.
2140 * - decoding: unused
2142 int last_predictor_count;
2144 #if FF_API_PRIVATE_OPT
2145 /** @deprecated use encoder private options instead */
2146 attribute_deprecated
2151 * motion estimation prepass comparison function
2152 * - encoding: Set by user.
2153 * - decoding: unused
2158 * ME prepass diamond size & shape
2159 * - encoding: Set by user.
2160 * - decoding: unused
2166 * - encoding: Set by user.
2167 * - decoding: unused
2169 int me_subpel_quality;
2173 * DTG active format information (additional aspect ratio
2174 * information only used in DVB MPEG-2 transport streams)
2177 * - encoding: unused
2178 * - decoding: Set by decoder.
2179 * @deprecated Deprecated in favor of AVSideData
2181 attribute_deprecated int dtg_active_format;
2182 #define FF_DTG_AFD_SAME 8
2183 #define FF_DTG_AFD_4_3 9
2184 #define FF_DTG_AFD_16_9 10
2185 #define FF_DTG_AFD_14_9 11
2186 #define FF_DTG_AFD_4_3_SP_14_9 13
2187 #define FF_DTG_AFD_16_9_SP_14_9 14
2188 #define FF_DTG_AFD_SP_4_3 15
2189 #endif /* FF_API_AFD */
2192 * maximum motion estimation search range in subpel units
2193 * If 0 then no limit.
2195 * - encoding: Set by user.
2196 * - decoding: unused
2200 #if FF_API_QUANT_BIAS
2202 * @deprecated use encoder private option instead
2204 attribute_deprecated int intra_quant_bias;
2205 #define FF_DEFAULT_QUANT_BIAS 999999
2208 * @deprecated use encoder private option instead
2210 attribute_deprecated int inter_quant_bias;
2215 * - encoding: unused
2216 * - decoding: Set by user.
2219 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2220 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2221 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2225 * XVideo Motion Acceleration
2226 * - encoding: forbidden
2227 * - decoding: set by decoder
2228 * @deprecated XvMC doesn't need it anymore.
2230 attribute_deprecated int xvmc_acceleration;
2231 #endif /* FF_API_XVMC */
2234 * macroblock decision mode
2235 * - encoding: Set by user.
2236 * - decoding: unused
2239 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2240 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2241 #define FF_MB_DECISION_RD 2 ///< rate distortion
2244 * custom intra quantization matrix
2245 * - encoding: Set by user, can be NULL.
2246 * - decoding: Set by libavcodec.
2248 uint16_t *intra_matrix;
2251 * custom inter quantization matrix
2252 * - encoding: Set by user, can be NULL.
2253 * - decoding: Set by libavcodec.
2255 uint16_t *inter_matrix;
2257 #if FF_API_PRIVATE_OPT
2258 /** @deprecated use encoder private options instead */
2259 attribute_deprecated
2260 int scenechange_threshold;
2262 /** @deprecated use encoder private options instead */
2263 attribute_deprecated
2264 int noise_reduction;
2269 * @deprecated this field is unused
2271 attribute_deprecated
2275 * @deprecated this field is unused
2277 attribute_deprecated
2282 * precision of the intra DC coefficient - 8
2283 * - encoding: Set by user.
2284 * - decoding: Set by libavcodec
2286 int intra_dc_precision;
2289 * Number of macroblock rows at the top which are skipped.
2290 * - encoding: unused
2291 * - decoding: Set by user.
2296 * Number of macroblock rows at the bottom which are skipped.
2297 * - encoding: unused
2298 * - decoding: Set by user.
2304 * @deprecated use encoder private options instead
2306 attribute_deprecated
2307 float border_masking;
2311 * minimum MB Lagrange multiplier
2312 * - encoding: Set by user.
2313 * - decoding: unused
2318 * maximum MB Lagrange multiplier
2319 * - encoding: Set by user.
2320 * - decoding: unused
2324 #if FF_API_PRIVATE_OPT
2326 * @deprecated use encoder private options instead
2328 attribute_deprecated
2329 int me_penalty_compensation;
2333 * - encoding: Set by user.
2334 * - decoding: unused
2338 #if FF_API_PRIVATE_OPT
2339 /** @deprecated use encoder private options instead */
2340 attribute_deprecated
2346 * - encoding: Set by user.
2347 * - decoding: unused
2352 * number of reference frames
2353 * - encoding: Set by user.
2354 * - decoding: Set by lavc.
2358 #if FF_API_PRIVATE_OPT
2359 /** @deprecated use encoder private options instead */
2360 attribute_deprecated
2364 #if FF_API_UNUSED_MEMBERS
2366 * Multiplied by qscale for each frame and added to scene_change_score.
2367 * - encoding: Set by user.
2368 * - decoding: unused
2370 attribute_deprecated int scenechange_factor;
2374 * Note: Value depends upon the compare function used for fullpel ME.
2375 * - encoding: Set by user.
2376 * - decoding: unused
2380 #if FF_API_PRIVATE_OPT
2381 /** @deprecated use encoder private options instead */
2382 attribute_deprecated
2387 * Chromaticity coordinates of the source primaries.
2388 * - encoding: Set by user
2389 * - decoding: Set by libavcodec
2391 enum AVColorPrimaries color_primaries;
2394 * Color Transfer Characteristic.
2395 * - encoding: Set by user
2396 * - decoding: Set by libavcodec
2398 enum AVColorTransferCharacteristic color_trc;
2401 * YUV colorspace type.
2402 * - encoding: Set by user
2403 * - decoding: Set by libavcodec
2405 enum AVColorSpace colorspace;
2408 * MPEG vs JPEG YUV range.
2409 * - encoding: Set by user
2410 * - decoding: Set by libavcodec
2412 enum AVColorRange color_range;
2415 * This defines the location of chroma samples.
2416 * - encoding: Set by user
2417 * - decoding: Set by libavcodec
2419 enum AVChromaLocation chroma_sample_location;
2423 * Indicates number of picture subdivisions. Used for parallelized
2425 * - encoding: Set by user
2426 * - decoding: unused
2431 * - encoding: set by libavcodec
2432 * - decoding: Set by user.
2434 enum AVFieldOrder field_order;
2437 int sample_rate; ///< samples per second
2438 int channels; ///< number of audio channels
2441 * audio sample format
2442 * - encoding: Set by user.
2443 * - decoding: Set by libavcodec.
2445 enum AVSampleFormat sample_fmt; ///< sample format
2447 /* The following data should not be initialized. */
2449 * Number of samples per channel in an audio frame.
2451 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2452 * except the last must contain exactly frame_size samples per channel.
2453 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2454 * frame size is not restricted.
2455 * - decoding: may be set by some decoders to indicate constant frame size
2460 * Frame counter, set by libavcodec.
2462 * - decoding: total number of frames returned from the decoder so far.
2463 * - encoding: total number of frames passed to the encoder so far.
2465 * @note the counter is not incremented if encoding/decoding resulted in
2471 * number of bytes per packet if constant and known or 0
2472 * Used by some WAV based audio codecs.
2477 * Audio cutoff bandwidth (0 means "automatic")
2478 * - encoding: Set by user.
2479 * - decoding: unused
2484 * Audio channel layout.
2485 * - encoding: set by user.
2486 * - decoding: set by user, may be overwritten by libavcodec.
2488 uint64_t channel_layout;
2491 * Request decoder to use this channel layout if it can (0 for default)
2492 * - encoding: unused
2493 * - decoding: Set by user.
2495 uint64_t request_channel_layout;
2498 * Type of service that the audio stream conveys.
2499 * - encoding: Set by user.
2500 * - decoding: Set by libavcodec.
2502 enum AVAudioServiceType audio_service_type;
2505 * desired sample format
2506 * - encoding: Not used.
2507 * - decoding: Set by user.
2508 * Decoder will decode to this format if it can.
2510 enum AVSampleFormat request_sample_fmt;
2513 * This callback is called at the beginning of each frame to get data
2514 * buffer(s) for it. There may be one contiguous buffer for all the data or
2515 * there may be a buffer per each data plane or anything in between. What
2516 * this means is, you may set however many entries in buf[] you feel necessary.
2517 * Each buffer must be reference-counted using the AVBuffer API (see description
2520 * The following fields will be set in the frame before this callback is
2523 * - width, height (video only)
2524 * - sample_rate, channel_layout, nb_samples (audio only)
2525 * Their values may differ from the corresponding values in
2526 * AVCodecContext. This callback must use the frame values, not the codec
2527 * context values, to calculate the required buffer size.
2529 * This callback must fill the following fields in the frame:
2533 * * if the data is planar audio with more than 8 channels, then this
2534 * callback must allocate and fill extended_data to contain all pointers
2535 * to all data planes. data[] must hold as many pointers as it can.
2536 * extended_data must be allocated with av_malloc() and will be freed in
2538 * * otherwise extended_data must point to data
2539 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2540 * the frame's data and extended_data pointers must be contained in these. That
2541 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2542 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2543 * and av_buffer_ref().
2544 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2545 * this callback and filled with the extra buffers if there are more
2546 * buffers than buf[] can hold. extended_buf will be freed in
2549 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2550 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2553 * Each data plane must be aligned to the maximum required by the target
2556 * @see avcodec_default_get_buffer2()
2560 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2561 * (read and/or written to if it is writable) later by libavcodec.
2563 * avcodec_align_dimensions2() should be used to find the required width and
2564 * height, as they normally need to be rounded up to the next multiple of 16.
2566 * Some decoders do not support linesizes changing between frames.
2568 * If frame multithreading is used and thread_safe_callbacks is set,
2569 * this callback may be called from a different thread, but not from more
2570 * than one at once. Does not need to be reentrant.
2572 * @see avcodec_align_dimensions2()
2576 * Decoders request a buffer of a particular size by setting
2577 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2578 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2579 * to a smaller value in the output frame.
2581 * As a convenience, av_samples_get_buffer_size() and
2582 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2583 * functions to find the required data size and to fill data pointers and
2584 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2585 * since all planes must be the same size.
2587 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2589 * - encoding: unused
2590 * - decoding: Set by libavcodec, user can override.
2592 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2595 * If non-zero, the decoded audio and video frames returned from
2596 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2597 * and are valid indefinitely. The caller must free them with
2598 * av_frame_unref() when they are not needed anymore.
2599 * Otherwise, the decoded frames must not be freed by the caller and are
2600 * only valid until the next decode call.
2602 * This is always automatically enabled if avcodec_receive_frame() is used.
2604 * - encoding: unused
2605 * - decoding: set by the caller before avcodec_open2().
2607 int refcounted_frames;
2609 /* - encoding parameters */
2610 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2611 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2615 * - encoding: Set by user.
2616 * - decoding: unused
2622 * - encoding: Set by user.
2623 * - decoding: unused
2628 * maximum quantizer difference between frames
2629 * - encoding: Set by user.
2630 * - decoding: unused
2636 * @deprecated use encoder private options instead
2638 attribute_deprecated
2641 attribute_deprecated
2643 attribute_deprecated
2648 * decoder bitstream buffer size
2649 * - encoding: Set by user.
2650 * - decoding: unused
2655 * ratecontrol override, see RcOverride
2656 * - encoding: Allocated/set/freed by user.
2657 * - decoding: unused
2659 int rc_override_count;
2660 RcOverride *rc_override;
2664 * @deprecated use encoder private options instead
2666 attribute_deprecated
2672 * - encoding: Set by user.
2673 * - decoding: Set by user, may be overwritten by libavcodec.
2675 int64_t rc_max_rate;
2679 * - encoding: Set by user.
2680 * - decoding: unused
2682 int64_t rc_min_rate;
2686 * @deprecated use encoder private options instead
2688 attribute_deprecated
2689 float rc_buffer_aggressivity;
2691 attribute_deprecated
2692 float rc_initial_cplx;
2696 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2697 * - encoding: Set by user.
2698 * - decoding: unused.
2700 float rc_max_available_vbv_use;
2703 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2704 * - encoding: Set by user.
2705 * - decoding: unused.
2707 float rc_min_vbv_overflow_use;
2710 * Number of bits which should be loaded into the rc buffer before decoding starts.
2711 * - encoding: Set by user.
2712 * - decoding: unused
2714 int rc_initial_buffer_occupancy;
2716 #if FF_API_CODER_TYPE
2717 #define FF_CODER_TYPE_VLC 0
2718 #define FF_CODER_TYPE_AC 1
2719 #define FF_CODER_TYPE_RAW 2
2720 #define FF_CODER_TYPE_RLE 3
2721 #if FF_API_UNUSED_MEMBERS
2722 #define FF_CODER_TYPE_DEFLATE 4
2723 #endif /* FF_API_UNUSED_MEMBERS */
2725 * @deprecated use encoder private options instead
2727 attribute_deprecated
2729 #endif /* FF_API_CODER_TYPE */
2731 #if FF_API_PRIVATE_OPT
2732 /** @deprecated use encoder private options instead */
2733 attribute_deprecated
2739 * @deprecated use encoder private options instead
2741 attribute_deprecated
2745 * @deprecated use encoder private options instead
2747 attribute_deprecated
2751 #if FF_API_PRIVATE_OPT
2752 /** @deprecated use encoder private options instead */
2753 attribute_deprecated
2754 int frame_skip_threshold;
2756 /** @deprecated use encoder private options instead */
2757 attribute_deprecated
2758 int frame_skip_factor;
2760 /** @deprecated use encoder private options instead */
2761 attribute_deprecated
2764 /** @deprecated use encoder private options instead */
2765 attribute_deprecated
2767 #endif /* FF_API_PRIVATE_OPT */
2770 * trellis RD quantization
2771 * - encoding: Set by user.
2772 * - decoding: unused
2776 #if FF_API_PRIVATE_OPT
2777 /** @deprecated use encoder private options instead */
2778 attribute_deprecated
2779 int min_prediction_order;
2781 /** @deprecated use encoder private options instead */
2782 attribute_deprecated
2783 int max_prediction_order;
2785 /** @deprecated use encoder private options instead */
2786 attribute_deprecated
2787 int64_t timecode_frame_start;
2790 #if FF_API_RTP_CALLBACK
2792 * @deprecated unused
2794 /* The RTP callback: This function is called */
2795 /* every time the encoder has a packet to send. */
2796 /* It depends on the encoder if the data starts */
2797 /* with a Start Code (it should). H.263 does. */
2798 /* mb_nb contains the number of macroblocks */
2799 /* encoded in the RTP payload. */
2800 attribute_deprecated
2801 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2804 #if FF_API_PRIVATE_OPT
2805 /** @deprecated use encoder private options instead */
2806 attribute_deprecated
2807 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2808 /* do its best to deliver a chunk with size */
2809 /* below rtp_payload_size, the chunk will start */
2810 /* with a start code on some codecs like H.263. */
2811 /* This doesn't take account of any particular */
2812 /* headers inside the transmitted RTP payload. */
2815 #if FF_API_STAT_BITS
2816 /* statistics, used for 2-pass encoding */
2817 attribute_deprecated
2819 attribute_deprecated
2821 attribute_deprecated
2823 attribute_deprecated
2825 attribute_deprecated
2827 attribute_deprecated
2829 attribute_deprecated
2831 attribute_deprecated
2834 /** @deprecated this field is unused */
2835 attribute_deprecated
2840 * pass1 encoding statistics output buffer
2841 * - encoding: Set by libavcodec.
2842 * - decoding: unused
2847 * pass2 encoding statistics input buffer
2848 * Concatenated stuff from stats_out of pass1 should be placed here.
2849 * - encoding: Allocated/set/freed by user.
2850 * - decoding: unused
2855 * Work around bugs in encoders which sometimes cannot be detected automatically.
2856 * - encoding: Set by user
2857 * - decoding: Set by user
2859 int workaround_bugs;
2860 #define FF_BUG_AUTODETECT 1 ///< autodetection
2861 #if FF_API_OLD_MSMPEG4
2862 #define FF_BUG_OLD_MSMPEG4 2
2864 #define FF_BUG_XVID_ILACE 4
2865 #define FF_BUG_UMP4 8
2866 #define FF_BUG_NO_PADDING 16
2867 #define FF_BUG_AMV 32
2869 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2871 #define FF_BUG_QPEL_CHROMA 64
2872 #define FF_BUG_STD_QPEL 128
2873 #define FF_BUG_QPEL_CHROMA2 256
2874 #define FF_BUG_DIRECT_BLOCKSIZE 512
2875 #define FF_BUG_EDGE 1024
2876 #define FF_BUG_HPEL_CHROMA 2048
2877 #define FF_BUG_DC_CLIP 4096
2878 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2879 #define FF_BUG_TRUNCATED 16384
2882 * strictly follow the standard (MPEG-4, ...).
2883 * - encoding: Set by user.
2884 * - decoding: Set by user.
2885 * Setting this to STRICT or higher means the encoder and decoder will
2886 * generally do stupid things, whereas setting it to unofficial or lower
2887 * will mean the encoder might produce output that is not supported by all
2888 * spec-compliant decoders. Decoders don't differentiate between normal,
2889 * unofficial and experimental (that is, they always try to decode things
2890 * when they can) unless they are explicitly asked to behave stupidly
2891 * (=strictly conform to the specs)
2893 int strict_std_compliance;
2894 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2895 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2896 #define FF_COMPLIANCE_NORMAL 0
2897 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2898 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2901 * error concealment flags
2902 * - encoding: unused
2903 * - decoding: Set by user.
2905 int error_concealment;
2906 #define FF_EC_GUESS_MVS 1
2907 #define FF_EC_DEBLOCK 2
2908 #define FF_EC_FAVOR_INTER 256
2912 * - encoding: Set by user.
2913 * - decoding: Set by user.
2916 #define FF_DEBUG_PICT_INFO 1
2917 #define FF_DEBUG_RC 2
2918 #define FF_DEBUG_BITSTREAM 4
2919 #define FF_DEBUG_MB_TYPE 8
2920 #define FF_DEBUG_QP 16
2923 * @deprecated this option does nothing
2925 #define FF_DEBUG_MV 32
2927 #define FF_DEBUG_DCT_COEFF 0x00000040
2928 #define FF_DEBUG_SKIP 0x00000080
2929 #define FF_DEBUG_STARTCODE 0x00000100
2930 #if FF_API_UNUSED_MEMBERS
2931 #define FF_DEBUG_PTS 0x00000200
2932 #endif /* FF_API_UNUSED_MEMBERS */
2933 #define FF_DEBUG_ER 0x00000400
2934 #define FF_DEBUG_MMCO 0x00000800
2935 #define FF_DEBUG_BUGS 0x00001000
2937 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2938 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2940 #define FF_DEBUG_BUFFERS 0x00008000
2941 #define FF_DEBUG_THREADS 0x00010000
2942 #define FF_DEBUG_GREEN_MD 0x00800000
2943 #define FF_DEBUG_NOMC 0x01000000
2948 * Code outside libavcodec should access this field using AVOptions
2949 * - encoding: Set by user.
2950 * - decoding: Set by user.
2953 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2954 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2955 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2959 * Error recognition; may misdetect some more or less valid parts as errors.
2960 * - encoding: unused
2961 * - decoding: Set by user.
2963 int err_recognition;
2966 * Verify checksums embedded in the bitstream (could be of either encoded or
2967 * decoded data, depending on the codec) and print an error message on mismatch.
2968 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2969 * decoder returning an error.
2971 #define AV_EF_CRCCHECK (1<<0)
2972 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2973 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2974 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2976 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2977 #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
2978 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2979 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2983 * opaque 64-bit number (generally a PTS) that will be reordered and
2984 * output in AVFrame.reordered_opaque
2985 * - encoding: unused
2986 * - decoding: Set by user.
2988 int64_t reordered_opaque;
2991 * Hardware accelerator in use
2992 * - encoding: unused.
2993 * - decoding: Set by libavcodec
2995 struct AVHWAccel *hwaccel;
2998 * Hardware accelerator context.
2999 * For some hardware accelerators, a global context needs to be
3000 * provided by the user. In that case, this holds display-dependent
3001 * data FFmpeg cannot instantiate itself. Please refer to the
3002 * FFmpeg HW accelerator documentation to know how to fill this
3003 * is. e.g. for VA API, this is a struct vaapi_context.
3004 * - encoding: unused
3005 * - decoding: Set by user
3007 void *hwaccel_context;
3011 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3012 * - decoding: unused
3014 uint64_t error[AV_NUM_DATA_POINTERS];
3017 * DCT algorithm, see FF_DCT_* below
3018 * - encoding: Set by user.
3019 * - decoding: unused
3022 #define FF_DCT_AUTO 0
3023 #define FF_DCT_FASTINT 1
3024 #define FF_DCT_INT 2
3025 #define FF_DCT_MMX 3
3026 #define FF_DCT_ALTIVEC 5
3027 #define FF_DCT_FAAN 6
3030 * IDCT algorithm, see FF_IDCT_* below.
3031 * - encoding: Set by user.
3032 * - decoding: Set by user.
3035 #define FF_IDCT_AUTO 0
3036 #define FF_IDCT_INT 1
3037 #define FF_IDCT_SIMPLE 2
3038 #define FF_IDCT_SIMPLEMMX 3
3039 #define FF_IDCT_ARM 7
3040 #define FF_IDCT_ALTIVEC 8
3042 #define FF_IDCT_SH4 9
3044 #define FF_IDCT_SIMPLEARM 10
3045 #if FF_API_UNUSED_MEMBERS
3046 #define FF_IDCT_IPP 13
3047 #endif /* FF_API_UNUSED_MEMBERS */
3048 #define FF_IDCT_XVID 14
3049 #if FF_API_IDCT_XVIDMMX
3050 #define FF_IDCT_XVIDMMX 14
3051 #endif /* FF_API_IDCT_XVIDMMX */
3052 #define FF_IDCT_SIMPLEARMV5TE 16
3053 #define FF_IDCT_SIMPLEARMV6 17
3054 #if FF_API_ARCH_SPARC
3055 #define FF_IDCT_SIMPLEVIS 18
3057 #define FF_IDCT_FAAN 20
3058 #define FF_IDCT_SIMPLENEON 22
3059 #if FF_API_ARCH_ALPHA
3060 #define FF_IDCT_SIMPLEALPHA 23
3062 #define FF_IDCT_SIMPLEAUTO 128
3065 * bits per sample/pixel from the demuxer (needed for huffyuv).
3066 * - encoding: Set by libavcodec.
3067 * - decoding: Set by user.
3069 int bits_per_coded_sample;
3072 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3073 * - encoding: set by user.
3074 * - decoding: set by libavcodec.
3076 int bits_per_raw_sample;
3080 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3081 * - encoding: unused
3082 * - decoding: Set by user.
3083 * Code outside libavcodec should access this field using:
3084 * av_codec_{get,set}_lowres(avctx)
3089 #if FF_API_CODED_FRAME
3091 * the picture in the bitstream
3092 * - encoding: Set by libavcodec.
3093 * - decoding: unused
3095 * @deprecated use the quality factor packet side data instead
3097 attribute_deprecated AVFrame *coded_frame;
3102 * is used to decide how many independent tasks should be passed to execute()
3103 * - encoding: Set by user.
3104 * - decoding: Set by user.
3109 * Which multithreading methods to use.
3110 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3111 * so clients which cannot provide future frames should not use it.
3113 * - encoding: Set by user, otherwise the default is used.
3114 * - decoding: Set by user, otherwise the default is used.
3117 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3118 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3121 * Which multithreading methods are in use by the codec.
3122 * - encoding: Set by libavcodec.
3123 * - decoding: Set by libavcodec.
3125 int active_thread_type;
3128 * Set by the client if its custom get_buffer() callback can be called
3129 * synchronously from another thread, which allows faster multithreaded decoding.
3130 * draw_horiz_band() will be called from other threads regardless of this setting.
3131 * Ignored if the default get_buffer() is used.
3132 * - encoding: Set by user.
3133 * - decoding: Set by user.
3135 int thread_safe_callbacks;
3138 * The codec may call this to execute several independent things.
3139 * It will return only after finishing all tasks.
3140 * The user may replace this with some multithreaded implementation,
3141 * the default implementation will execute the parts serially.
3142 * @param count the number of things to execute
3143 * - encoding: Set by libavcodec, user can override.
3144 * - decoding: Set by libavcodec, user can override.
3146 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3149 * The codec may call this to execute several independent things.
3150 * It will return only after finishing all tasks.
3151 * The user may replace this with some multithreaded implementation,
3152 * the default implementation will execute the parts serially.
3153 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3154 * @param c context passed also to func
3155 * @param count the number of things to execute
3156 * @param arg2 argument passed unchanged to func
3157 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3158 * @param func function that will be called count times, with jobnr from 0 to count-1.
3159 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3160 * two instances of func executing at the same time will have the same threadnr.
3161 * @return always 0 currently, but code should handle a future improvement where when any call to func
3162 * returns < 0 no further calls to func may be done and < 0 is returned.
3163 * - encoding: Set by libavcodec, user can override.
3164 * - decoding: Set by libavcodec, user can override.
3166 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3169 * noise vs. sse weight for the nsse comparison function
3170 * - encoding: Set by user.
3171 * - decoding: unused
3177 * - encoding: Set by user.
3178 * - decoding: Set by libavcodec.
3181 #define FF_PROFILE_UNKNOWN -99
3182 #define FF_PROFILE_RESERVED -100
3184 #define FF_PROFILE_AAC_MAIN 0
3185 #define FF_PROFILE_AAC_LOW 1
3186 #define FF_PROFILE_AAC_SSR 2
3187 #define FF_PROFILE_AAC_LTP 3
3188 #define FF_PROFILE_AAC_HE 4
3189 #define FF_PROFILE_AAC_HE_V2 28
3190 #define FF_PROFILE_AAC_LD 22
3191 #define FF_PROFILE_AAC_ELD 38
3192 #define FF_PROFILE_MPEG2_AAC_LOW 128
3193 #define FF_PROFILE_MPEG2_AAC_HE 131
3195 #define FF_PROFILE_DNXHD 0
3196 #define FF_PROFILE_DNXHR_LB 1
3197 #define FF_PROFILE_DNXHR_SQ 2
3198 #define FF_PROFILE_DNXHR_HQ 3
3199 #define FF_PROFILE_DNXHR_HQX 4
3200 #define FF_PROFILE_DNXHR_444 5
3202 #define FF_PROFILE_DTS 20
3203 #define FF_PROFILE_DTS_ES 30
3204 #define FF_PROFILE_DTS_96_24 40
3205 #define FF_PROFILE_DTS_HD_HRA 50
3206 #define FF_PROFILE_DTS_HD_MA 60
3207 #define FF_PROFILE_DTS_EXPRESS 70
3209 #define FF_PROFILE_MPEG2_422 0
3210 #define FF_PROFILE_MPEG2_HIGH 1
3211 #define FF_PROFILE_MPEG2_SS 2
3212 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3213 #define FF_PROFILE_MPEG2_MAIN 4
3214 #define FF_PROFILE_MPEG2_SIMPLE 5
3216 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3217 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3219 #define FF_PROFILE_H264_BASELINE 66
3220 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3221 #define FF_PROFILE_H264_MAIN 77
3222 #define FF_PROFILE_H264_EXTENDED 88
3223 #define FF_PROFILE_H264_HIGH 100
3224 #define FF_PROFILE_H264_HIGH_10 110
3225 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3226 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3227 #define FF_PROFILE_H264_HIGH_422 122
3228 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3229 #define FF_PROFILE_H264_STEREO_HIGH 128
3230 #define FF_PROFILE_H264_HIGH_444 144
3231 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3232 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3233 #define FF_PROFILE_H264_CAVLC_444 44
3235 #define FF_PROFILE_VC1_SIMPLE 0
3236 #define FF_PROFILE_VC1_MAIN 1
3237 #define FF_PROFILE_VC1_COMPLEX 2
3238 #define FF_PROFILE_VC1_ADVANCED 3
3240 #define FF_PROFILE_MPEG4_SIMPLE 0
3241 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3242 #define FF_PROFILE_MPEG4_CORE 2
3243 #define FF_PROFILE_MPEG4_MAIN 3
3244 #define FF_PROFILE_MPEG4_N_BIT 4
3245 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3246 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3247 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3248 #define FF_PROFILE_MPEG4_HYBRID 8
3249 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3250 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3251 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3252 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3253 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3254 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3255 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3257 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3258 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3259 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3260 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3261 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3263 #define FF_PROFILE_VP9_0 0
3264 #define FF_PROFILE_VP9_1 1
3265 #define FF_PROFILE_VP9_2 2
3266 #define FF_PROFILE_VP9_3 3
3268 #define FF_PROFILE_HEVC_MAIN 1
3269 #define FF_PROFILE_HEVC_MAIN_10 2
3270 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3271 #define FF_PROFILE_HEVC_REXT 4
3275 * - encoding: Set by user.
3276 * - decoding: Set by libavcodec.
3279 #define FF_LEVEL_UNKNOWN -99
3282 * Skip loop filtering for selected frames.
3283 * - encoding: unused
3284 * - decoding: Set by user.
3286 enum AVDiscard skip_loop_filter;
3289 * Skip IDCT/dequantization for selected frames.
3290 * - encoding: unused
3291 * - decoding: Set by user.
3293 enum AVDiscard skip_idct;
3296 * Skip decoding for selected frames.
3297 * - encoding: unused
3298 * - decoding: Set by user.
3300 enum AVDiscard skip_frame;
3303 * Header containing style information for text subtitles.
3304 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3305 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3306 * the Format line following. It shouldn't include any Dialogue line.
3307 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3308 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3310 uint8_t *subtitle_header;
3311 int subtitle_header_size;
3313 #if FF_API_ERROR_RATE
3315 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3318 attribute_deprecated
3322 #if FF_API_VBV_DELAY
3324 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3325 * Used for compliant TS muxing.
3326 * - encoding: Set by libavcodec.
3327 * - decoding: unused.
3328 * @deprecated this value is now exported as a part of
3329 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3331 attribute_deprecated
3335 #if FF_API_SIDEDATA_ONLY_PKT
3337 * Encoding only and set by default. Allow encoders to output packets
3338 * that do not contain any encoded data, only side data.
3340 * Some encoders need to output such packets, e.g. to update some stream
3341 * parameters at the end of encoding.
3343 * @deprecated this field disables the default behaviour and
3344 * it is kept only for compatibility.
3346 attribute_deprecated
3347 int side_data_only_packets;
3351 * Audio only. The number of "priming" samples (padding) inserted by the
3352 * encoder at the beginning of the audio. I.e. this number of leading
3353 * decoded samples must be discarded by the caller to get the original audio
3354 * without leading padding.
3356 * - decoding: unused
3357 * - encoding: Set by libavcodec. The timestamps on the output packets are
3358 * adjusted by the encoder so that they always refer to the
3359 * first sample of the data actually contained in the packet,
3360 * including any added padding. E.g. if the timebase is
3361 * 1/samplerate and the timestamp of the first input sample is
3362 * 0, the timestamp of the first output packet will be
3365 int initial_padding;
3368 * - decoding: For codecs that store a framerate value in the compressed
3369 * bitstream, the decoder may export it here. { 0, 1} when
3371 * - encoding: May be used to signal the framerate of CFR content to an
3374 AVRational framerate;
3377 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3378 * - encoding: unused.
3379 * - decoding: Set by libavcodec before calling get_format()
3381 enum AVPixelFormat sw_pix_fmt;
3384 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3385 * Code outside libavcodec should access this field using:
3386 * av_codec_{get,set}_pkt_timebase(avctx)
3387 * - encoding unused.
3388 * - decoding set by user.
3390 AVRational pkt_timebase;
3394 * Code outside libavcodec should access this field using:
3395 * av_codec_{get,set}_codec_descriptor(avctx)
3396 * - encoding: unused.
3397 * - decoding: set by libavcodec.
3399 const AVCodecDescriptor *codec_descriptor;
3403 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3404 * - encoding: unused
3405 * - decoding: Set by user.
3406 * Code outside libavcodec should access this field using:
3407 * av_codec_{get,set}_lowres(avctx)
3413 * Current statistics for PTS correction.
3414 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3415 * - encoding: unused
3417 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3418 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3419 int64_t pts_correction_last_pts; /// PTS of the last frame
3420 int64_t pts_correction_last_dts; /// DTS of the last frame
3423 * Character encoding of the input subtitles file.
3424 * - decoding: set by user
3425 * - encoding: unused
3430 * Subtitles character encoding mode. Formats or codecs might be adjusting
3431 * this setting (if they are doing the conversion themselves for instance).
3432 * - decoding: set by libavcodec
3433 * - encoding: unused
3435 int sub_charenc_mode;
3436 #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)
3437 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3438 #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
3441 * Skip processing alpha if supported by codec.
3442 * Note that if the format uses pre-multiplied alpha (common with VP6,
3443 * and recommended due to better video quality/compression)
3444 * the image will look as if alpha-blended onto a black background.
3445 * However for formats that do not use pre-multiplied alpha
3446 * there might be serious artefacts (though e.g. libswscale currently
3447 * assumes pre-multiplied alpha anyway).
3448 * Code outside libavcodec should access this field using AVOptions
3450 * - decoding: set by user
3451 * - encoding: unused
3456 * Number of samples to skip after a discontinuity
3457 * - decoding: unused
3458 * - encoding: set by libavcodec
3462 #if !FF_API_DEBUG_MV
3464 * debug motion vectors
3465 * Code outside libavcodec should access this field using AVOptions
3466 * - encoding: Set by user.
3467 * - decoding: Set by user.
3470 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3471 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3472 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3476 * custom intra quantization matrix
3477 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3478 * - encoding: Set by user, can be NULL.
3479 * - decoding: unused.
3481 uint16_t *chroma_intra_matrix;
3484 * dump format separator.
3485 * can be ", " or "\n " or anything else
3486 * Code outside libavcodec should access this field using AVOptions
3487 * (NO direct access).
3488 * - encoding: Set by user.
3489 * - decoding: Set by user.
3491 uint8_t *dump_separator;
3494 * ',' separated list of allowed decoders.
3495 * If NULL then all are allowed
3496 * - encoding: unused
3497 * - decoding: set by user through AVOPtions (NO direct access)
3499 char *codec_whitelist;
3502 * Properties of the stream that gets decoded
3503 * To be accessed through av_codec_get_properties() (NO direct access)
3504 * - encoding: unused
3505 * - decoding: set by libavcodec
3507 unsigned properties;
3508 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3509 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3512 * Additional data associated with the entire coded stream.
3514 * - decoding: unused
3515 * - encoding: may be set by libavcodec after avcodec_open2().
3517 AVPacketSideData *coded_side_data;
3518 int nb_coded_side_data;
3521 * A reference to the AVHWFramesContext describing the input (for encoding)
3522 * or output (decoding) frames. The reference is set by the caller and
3523 * afterwards owned (and freed) by libavcodec.
3525 * - decoding: This field should be set by the caller from the get_format()
3526 * callback. The previous reference (if any) will always be
3527 * unreffed by libavcodec before the get_format() call.
3529 * If the default get_buffer2() is used with a hwaccel pixel
3530 * format, then this AVHWFramesContext will be used for
3531 * allocating the frame buffers.
3533 * - encoding: For hardware encoders configured to use a hwaccel pixel
3534 * format, this field should be set by the caller to a reference
3535 * to the AVHWFramesContext describing input frames.
3536 * AVHWFramesContext.format must be equal to
3537 * AVCodecContext.pix_fmt.
3539 * This field should be set before avcodec_open2() is called.
3541 AVBufferRef *hw_frames_ctx;
3544 * Control the form of AVSubtitle.rects[N]->ass
3545 * - decoding: set by user
3546 * - encoding: unused
3548 int sub_text_format;
3549 #define FF_SUB_TEXT_FMT_ASS 0
3550 #if FF_API_ASS_TIMING
3551 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3555 * Audio only. The amount of padding (in samples) appended by the encoder to
3556 * the end of the audio. I.e. this number of decoded samples must be
3557 * discarded by the caller from the end of the stream to get the original
3558 * audio without any trailing padding.
3560 * - decoding: unused
3561 * - encoding: unused
3563 int trailing_padding;
3567 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3568 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3570 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3571 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3573 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3575 int av_codec_get_lowres(const AVCodecContext *avctx);
3576 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3578 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3579 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3581 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3582 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3587 typedef struct AVProfile {
3589 const char *name; ///< short name for the profile
3592 typedef struct AVCodecDefault AVCodecDefault;
3599 typedef struct AVCodec {
3601 * Name of the codec implementation.
3602 * The name is globally unique among encoders and among decoders (but an
3603 * encoder and a decoder can share the same name).
3604 * This is the primary way to find a codec from the user perspective.
3608 * Descriptive name for the codec, meant to be more human readable than name.
3609 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3611 const char *long_name;
3612 enum AVMediaType type;
3615 * Codec capabilities.
3616 * see AV_CODEC_CAP_*
3619 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3620 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3621 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3622 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3623 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3624 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3625 const AVClass *priv_class; ///< AVClass for the private context
3626 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3628 /*****************************************************************
3629 * No fields below this line are part of the public API. They
3630 * may not be used outside of libavcodec and can be changed and
3632 * New public fields should be added right above.
3633 *****************************************************************
3636 struct AVCodec *next;
3638 * @name Frame-level threading support functions
3642 * If defined, called on thread contexts when they are created.
3643 * If the codec allocates writable tables in init(), re-allocate them here.
3644 * priv_data will be set to a copy of the original.
3646 int (*init_thread_copy)(AVCodecContext *);
3648 * Copy necessary context variables from a previous thread context to the current one.
3649 * If not defined, the next thread will start automatically; otherwise, the codec
3650 * must call ff_thread_finish_setup().
3652 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3654 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3658 * Private codec-specific defaults.
3660 const AVCodecDefault *defaults;
3663 * Initialize codec static data, called from avcodec_register().
3665 void (*init_static_data)(struct AVCodec *codec);
3667 int (*init)(AVCodecContext *);
3668 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3669 const struct AVSubtitle *sub);
3671 * Encode data to an AVPacket.
3673 * @param avctx codec context
3674 * @param avpkt output AVPacket (may contain a user-provided buffer)
3675 * @param[in] frame AVFrame containing the raw data to be encoded
3676 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3677 * non-empty packet was returned in avpkt.
3678 * @return 0 on success, negative error code on failure
3680 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3681 int *got_packet_ptr);
3682 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3683 int (*close)(AVCodecContext *);
3685 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3686 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3688 * - never called if the codec is closed or the wrong type,
3689 * - AVPacket parameter change side data is applied right before calling
3690 * AVCodec->send_packet,
3691 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3692 * - only one drain packet is ever passed down (until the next flush()),
3693 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3695 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3696 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3697 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3698 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3701 * Will be called when seeking
3703 void (*flush)(AVCodecContext *);
3705 * Internal codec capabilities.
3706 * See FF_CODEC_CAP_* in internal.h
3711 int av_codec_get_max_lowres(const AVCodec *codec);
3713 struct MpegEncContext;
3716 * @defgroup lavc_hwaccel AVHWAccel
3719 typedef struct AVHWAccel {
3721 * Name of the hardware accelerated codec.
3722 * The name is globally unique among encoders and among decoders (but an
3723 * encoder and a decoder can share the same name).
3728 * Type of codec implemented by the hardware accelerator.
3730 * See AVMEDIA_TYPE_xxx
3732 enum AVMediaType type;
3735 * Codec implemented by the hardware accelerator.
3737 * See AV_CODEC_ID_xxx
3742 * Supported pixel format.
3744 * Only hardware accelerated formats are supported here.
3746 enum AVPixelFormat pix_fmt;
3749 * Hardware accelerated codec capabilities.
3750 * see HWACCEL_CODEC_CAP_*
3754 /*****************************************************************
3755 * No fields below this line are part of the public API. They
3756 * may not be used outside of libavcodec and can be changed and
3758 * New public fields should be added right above.
3759 *****************************************************************
3761 struct AVHWAccel *next;
3764 * Allocate a custom buffer
3766 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3769 * Called at the beginning of each frame or field picture.
3771 * Meaningful frame information (codec specific) is guaranteed to
3772 * be parsed at this point. This function is mandatory.
3774 * Note that buf can be NULL along with buf_size set to 0.
3775 * Otherwise, this means the whole frame is available at this point.
3777 * @param avctx the codec context
3778 * @param buf the frame data buffer base
3779 * @param buf_size the size of the frame in bytes
3780 * @return zero if successful, a negative value otherwise
3782 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3785 * Callback for each slice.
3787 * Meaningful slice information (codec specific) is guaranteed to
3788 * be parsed at this point. This function is mandatory.
3789 * The only exception is XvMC, that works on MB level.
3791 * @param avctx the codec context
3792 * @param buf the slice data buffer base
3793 * @param buf_size the size of the slice in bytes
3794 * @return zero if successful, a negative value otherwise
3796 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3799 * Called at the end of each frame or field picture.
3801 * The whole picture is parsed at this point and can now be sent
3802 * to the hardware accelerator. This function is mandatory.
3804 * @param avctx the codec context
3805 * @return zero if successful, a negative value otherwise
3807 int (*end_frame)(AVCodecContext *avctx);
3810 * Size of per-frame hardware accelerator private data.
3812 * Private data is allocated with av_mallocz() before
3813 * AVCodecContext.get_buffer() and deallocated after
3814 * AVCodecContext.release_buffer().
3816 int frame_priv_data_size;
3819 * Called for every Macroblock in a slice.
3821 * XvMC uses it to replace the ff_mpv_decode_mb().
3822 * Instead of decoding to raw picture, MB parameters are
3823 * stored in an array provided by the video driver.
3825 * @param s the mpeg context
3827 void (*decode_mb)(struct MpegEncContext *s);
3830 * Initialize the hwaccel private data.
3832 * This will be called from ff_get_format(), after hwaccel and
3833 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3836 int (*init)(AVCodecContext *avctx);
3839 * Uninitialize the hwaccel private data.
3841 * This will be called from get_format() or avcodec_close(), after hwaccel
3842 * and hwaccel_context are already uninitialized.
3844 int (*uninit)(AVCodecContext *avctx);
3847 * Size of the private data to allocate in
3848 * AVCodecInternal.hwaccel_priv_data.
3854 * Hardware acceleration should be used for decoding even if the codec level
3855 * used is unknown or higher than the maximum supported level reported by the
3858 * It's generally a good idea to pass this flag unless you have a specific
3859 * reason not to, as hardware tends to under-report supported levels.
3861 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3864 * Hardware acceleration can output YUV pixel formats with a different chroma
3865 * sampling than 4:2:0 and/or other than 8 bits per component.
3867 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3873 #if FF_API_AVPICTURE
3875 * @defgroup lavc_picture AVPicture
3877 * Functions for working with AVPicture
3882 * Picture data structure.
3884 * Up to four components can be stored into it, the last component is
3886 * @deprecated use AVFrame or imgutils functions instead
3888 typedef struct AVPicture {
3889 attribute_deprecated
3890 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3891 attribute_deprecated
3892 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3900 enum AVSubtitleType {
3903 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3906 * Plain text, the text field must be set by the decoder and is
3907 * authoritative. ass and pict fields may contain approximations.
3912 * Formatted text, the ass field must be set by the decoder and is
3913 * authoritative. pict and text fields may contain approximations.
3918 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3920 typedef struct AVSubtitleRect {
3921 int x; ///< top left corner of pict, undefined when pict is not set
3922 int y; ///< top left corner of pict, undefined when pict is not set
3923 int w; ///< width of pict, undefined when pict is not set
3924 int h; ///< height of pict, undefined when pict is not set
3925 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3927 #if FF_API_AVPICTURE
3929 * @deprecated unused
3931 attribute_deprecated
3935 * data+linesize for the bitmap of this subtitle.
3936 * Can be set for text/ass as well once they are rendered.
3941 enum AVSubtitleType type;
3943 char *text; ///< 0 terminated plain UTF-8 text
3946 * 0 terminated ASS/SSA compatible event line.
3947 * The presentation of this is unaffected by the other values in this
3955 typedef struct AVSubtitle {
3956 uint16_t format; /* 0 = graphics */
3957 uint32_t start_display_time; /* relative to packet pts, in ms */
3958 uint32_t end_display_time; /* relative to packet pts, in ms */
3960 AVSubtitleRect **rects;
3961 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3965 * This struct describes the properties of an encoded stream.
3967 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3968 * be allocated with avcodec_parameters_alloc() and freed with
3969 * avcodec_parameters_free().
3971 typedef struct AVCodecParameters {
3973 * General type of the encoded data.
3975 enum AVMediaType codec_type;
3977 * Specific type of the encoded data (the codec used).
3979 enum AVCodecID codec_id;
3981 * Additional information about the codec (corresponds to the AVI FOURCC).
3986 * Extra binary data needed for initializing the decoder, codec-dependent.
3988 * Must be allocated with av_malloc() and will be freed by
3989 * avcodec_parameters_free(). The allocated size of extradata must be at
3990 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3995 * Size of the extradata content in bytes.
4000 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4001 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4006 * The average bitrate of the encoded data (in bits per second).
4011 * The number of bits per sample in the codedwords.
4013 * This is basically the bitrate per sample. It is mandatory for a bunch of
4014 * formats to actually decode them. It's the number of bits for one sample in
4015 * the actual coded bitstream.
4017 * This could be for example 4 for ADPCM
4018 * For PCM formats this matches bits_per_raw_sample
4021 int bits_per_coded_sample;
4024 * This is the number of valid bits in each output sample. If the
4025 * sample format has more bits, the least significant bits are additional
4026 * padding bits, which are always 0. Use right shifts to reduce the sample
4027 * to its actual size. For example, audio formats with 24 bit samples will
4028 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4029 * To get the original sample use "(int32_t)sample >> 8"."
4031 * For ADPCM this might be 12 or 16 or similar
4034 int bits_per_raw_sample;
4037 * Codec-specific bitstream restrictions that the stream conforms to.
4043 * Video only. The dimensions of the video frame in pixels.
4049 * Video only. The aspect ratio (width / height) which a single pixel
4050 * should have when displayed.
4052 * When the aspect ratio is unknown / undefined, the numerator should be
4053 * set to 0 (the denominator may have any value).
4055 AVRational sample_aspect_ratio;
4058 * Video only. The order of the fields in interlaced video.
4060 enum AVFieldOrder field_order;
4063 * Video only. Additional colorspace characteristics.
4065 enum AVColorRange color_range;
4066 enum AVColorPrimaries color_primaries;
4067 enum AVColorTransferCharacteristic color_trc;
4068 enum AVColorSpace color_space;
4069 enum AVChromaLocation chroma_location;
4072 * Video only. Number of delayed frames.
4077 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4078 * unknown or unspecified, otherwise the number of bits set must be equal to
4079 * the channels field.
4081 uint64_t channel_layout;
4083 * Audio only. The number of audio channels.
4087 * Audio only. The number of audio samples per second.
4091 * Audio only. The number of bytes per coded audio frame, required by some
4094 * Corresponds to nBlockAlign in WAVEFORMATEX.
4098 * Audio only. Audio frame size, if known. Required by some formats to be static.
4103 * Audio only. The amount of padding (in samples) inserted by the encoder at
4104 * the beginning of the audio. I.e. this number of leading decoded samples
4105 * must be discarded by the caller to get the original audio without leading
4108 int initial_padding;
4110 * Audio only. The amount of padding (in samples) appended by the encoder to
4111 * the end of the audio. I.e. this number of decoded samples must be
4112 * discarded by the caller from the end of the stream to get the original
4113 * audio without any trailing padding.
4115 int trailing_padding;
4117 * Audio only. Number of samples to skip after a discontinuity.
4120 } AVCodecParameters;
4123 * If c is NULL, returns the first registered codec,
4124 * if c is non-NULL, returns the next registered codec after c,
4125 * or NULL if c is the last one.
4127 AVCodec *av_codec_next(const AVCodec *c);
4130 * Return the LIBAVCODEC_VERSION_INT constant.
4132 unsigned avcodec_version(void);
4135 * Return the libavcodec build-time configuration.
4137 const char *avcodec_configuration(void);
4140 * Return the libavcodec license.
4142 const char *avcodec_license(void);
4145 * Register the codec codec and initialize libavcodec.
4147 * @warning either this function or avcodec_register_all() must be called
4148 * before any other libavcodec functions.
4150 * @see avcodec_register_all()
4152 void avcodec_register(AVCodec *codec);
4155 * Register all the codecs, parsers and bitstream filters which were enabled at
4156 * configuration time. If you do not call this function you can select exactly
4157 * which formats you want to support, by using the individual registration
4160 * @see avcodec_register
4161 * @see av_register_codec_parser
4162 * @see av_register_bitstream_filter
4164 void avcodec_register_all(void);
4167 * Allocate an AVCodecContext and set its fields to default values. The
4168 * resulting struct should be freed with avcodec_free_context().
4170 * @param codec if non-NULL, allocate private data and initialize defaults
4171 * for the given codec. It is illegal to then call avcodec_open2()
4172 * with a different codec.
4173 * If NULL, then the codec-specific defaults won't be initialized,
4174 * which may result in suboptimal default settings (this is
4175 * important mainly for encoders, e.g. libx264).
4177 * @return An AVCodecContext filled with default values or NULL on failure.
4179 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4182 * Free the codec context and everything associated with it and write NULL to
4183 * the provided pointer.
4185 void avcodec_free_context(AVCodecContext **avctx);
4187 #if FF_API_GET_CONTEXT_DEFAULTS
4189 * @deprecated This function should not be used, as closing and opening a codec
4190 * context multiple time is not supported. A new codec context should be
4191 * allocated for each new use.
4193 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4197 * Get the AVClass for AVCodecContext. It can be used in combination with
4198 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4200 * @see av_opt_find().
4202 const AVClass *avcodec_get_class(void);
4204 #if FF_API_COPY_CONTEXT
4206 * Get the AVClass for AVFrame. It can be used in combination with
4207 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4209 * @see av_opt_find().
4211 const AVClass *avcodec_get_frame_class(void);
4214 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4215 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4217 * @see av_opt_find().
4219 const AVClass *avcodec_get_subtitle_rect_class(void);
4222 * Copy the settings of the source AVCodecContext into the destination
4223 * AVCodecContext. The resulting destination codec context will be
4224 * unopened, i.e. you are required to call avcodec_open2() before you
4225 * can use this AVCodecContext to decode/encode video/audio data.
4227 * @param dest target codec context, should be initialized with
4228 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4229 * @param src source codec context
4230 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4232 * @deprecated The semantics of this function are ill-defined and it should not
4233 * be used. If you need to transfer the stream parameters from one codec context
4234 * to another, use an intermediate AVCodecParameters instance and the
4235 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4238 attribute_deprecated
4239 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4243 * Allocate a new AVCodecParameters and set its fields to default values
4244 * (unknown/invalid/0). The returned struct must be freed with
4245 * avcodec_parameters_free().
4247 AVCodecParameters *avcodec_parameters_alloc(void);
4250 * Free an AVCodecParameters instance and everything associated with it and
4251 * write NULL to the supplied pointer.
4253 void avcodec_parameters_free(AVCodecParameters **par);
4256 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4257 * replaced with newly allocated duplicates of the corresponding fields in src.
4259 * @return >= 0 on success, a negative AVERROR code on failure.
4261 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4264 * Fill the parameters struct based on the values from the supplied codec
4265 * context. Any allocated fields in par are freed and replaced with duplicates
4266 * of the corresponding fields in codec.
4268 * @return >= 0 on success, a negative AVERROR code on failure
4270 int avcodec_parameters_from_context(AVCodecParameters *par,
4271 const AVCodecContext *codec);
4274 * Fill the codec context based on the values from the supplied codec
4275 * parameters. Any allocated fields in codec that have a corresponding field in
4276 * par are freed and replaced with duplicates of the corresponding field in par.
4277 * Fields in codec that do not have a counterpart in par are not touched.
4279 * @return >= 0 on success, a negative AVERROR code on failure.
4281 int avcodec_parameters_to_context(AVCodecContext *codec,
4282 const AVCodecParameters *par);
4285 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4286 * function the context has to be allocated with avcodec_alloc_context3().
4288 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4289 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4290 * retrieving a codec.
4292 * @warning This function is not thread safe!
4294 * @note Always call this function before using decoding routines (such as
4295 * @ref avcodec_receive_frame()).
4298 * avcodec_register_all();
4299 * av_dict_set(&opts, "b", "2.5M", 0);
4300 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4304 * context = avcodec_alloc_context3(codec);
4306 * if (avcodec_open2(context, codec, opts) < 0)
4310 * @param avctx The context to initialize.
4311 * @param codec The codec to open this context for. If a non-NULL codec has been
4312 * previously passed to avcodec_alloc_context3() or
4313 * for this context, then this parameter MUST be either NULL or
4314 * equal to the previously passed codec.
4315 * @param options A dictionary filled with AVCodecContext and codec-private options.
4316 * On return this object will be filled with options that were not found.
4318 * @return zero on success, a negative value on error
4319 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4320 * av_dict_set(), av_opt_find().
4322 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4325 * Close a given AVCodecContext and free all the data associated with it
4326 * (but not the AVCodecContext itself).
4328 * Calling this function on an AVCodecContext that hasn't been opened will free
4329 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4330 * codec. Subsequent calls will do nothing.
4332 * @note Do not use this function. Use avcodec_free_context() to destroy a
4333 * codec context (either open or closed). Opening and closing a codec context
4334 * multiple times is not supported anymore -- use multiple codec contexts
4337 int avcodec_close(AVCodecContext *avctx);
4340 * Free all allocated data in the given subtitle struct.
4342 * @param sub AVSubtitle to free.
4344 void avsubtitle_free(AVSubtitle *sub);
4351 * @addtogroup lavc_packet
4356 * Allocate an AVPacket and set its fields to default values. The resulting
4357 * struct must be freed using av_packet_free().
4359 * @return An AVPacket filled with default values or NULL on failure.
4361 * @note this only allocates the AVPacket itself, not the data buffers. Those
4362 * must be allocated through other means such as av_new_packet.
4364 * @see av_new_packet
4366 AVPacket *av_packet_alloc(void);
4369 * Create a new packet that references the same data as src.
4371 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4373 * @return newly created AVPacket on success, NULL on error.
4375 * @see av_packet_alloc
4376 * @see av_packet_ref
4378 AVPacket *av_packet_clone(AVPacket *src);
4381 * Free the packet, if the packet is reference counted, it will be
4382 * unreferenced first.
4384 * @param packet packet to be freed. The pointer will be set to NULL.
4385 * @note passing NULL is a no-op.
4387 void av_packet_free(AVPacket **pkt);
4390 * Initialize optional fields of a packet with default values.
4392 * Note, this does not touch the data and size members, which have to be
4393 * initialized separately.
4397 void av_init_packet(AVPacket *pkt);
4400 * Allocate the payload of a packet and initialize its fields with
4404 * @param size wanted payload size
4405 * @return 0 if OK, AVERROR_xxx otherwise
4407 int av_new_packet(AVPacket *pkt, int size);
4410 * Reduce packet size, correctly zeroing padding
4413 * @param size new size
4415 void av_shrink_packet(AVPacket *pkt, int size);
4418 * Increase packet size, correctly zeroing padding
4421 * @param grow_by number of bytes by which to increase the size of the packet
4423 int av_grow_packet(AVPacket *pkt, int grow_by);
4426 * Initialize a reference-counted packet from av_malloc()ed data.
4428 * @param pkt packet to be initialized. This function will set the data, size,
4429 * buf and destruct fields, all others are left untouched.
4430 * @param data Data allocated by av_malloc() to be used as packet data. If this
4431 * function returns successfully, the data is owned by the underlying AVBuffer.
4432 * The caller may not access the data through other means.
4433 * @param size size of data in bytes, without the padding. I.e. the full buffer
4434 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4436 * @return 0 on success, a negative AVERROR on error
4438 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4440 #if FF_API_AVPACKET_OLD_API
4442 * @warning This is a hack - the packet memory allocation stuff is broken. The
4443 * packet is allocated if it was not really allocated.
4445 * @deprecated Use av_packet_ref
4447 attribute_deprecated
4448 int av_dup_packet(AVPacket *pkt);
4450 * Copy packet, including contents
4452 * @return 0 on success, negative AVERROR on fail
4454 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4457 * Copy packet side data
4459 * @return 0 on success, negative AVERROR on fail
4461 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4466 * @deprecated Use av_packet_unref
4468 * @param pkt packet to free
4470 attribute_deprecated
4471 void av_free_packet(AVPacket *pkt);
4474 * Allocate new information of a packet.
4477 * @param type side information type
4478 * @param size side information size
4479 * @return pointer to fresh allocated data or NULL otherwise
4481 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4485 * Wrap an existing array as a packet side data.
4488 * @param type side information type
4489 * @param data the side data array. It must be allocated with the av_malloc()
4490 * family of functions. The ownership of the data is transferred to
4492 * @param size side information size
4493 * @return a non-negative number on success, a negative AVERROR code on
4494 * failure. On failure, the packet is unchanged and the data remains
4495 * owned by the caller.
4497 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4498 uint8_t *data, size_t size);
4501 * Shrink the already allocated side data buffer
4504 * @param type side information type
4505 * @param size new side information size
4506 * @return 0 on success, < 0 on failure
4508 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4512 * Get side information from packet.
4515 * @param type desired side information type
4516 * @param size pointer for side information size to store (optional)
4517 * @return pointer to data if present or NULL otherwise
4519 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4522 int av_packet_merge_side_data(AVPacket *pkt);
4524 int av_packet_split_side_data(AVPacket *pkt);
4526 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4529 * Pack a dictionary for use in side_data.
4531 * @param dict The dictionary to pack.
4532 * @param size pointer to store the size of the returned data
4533 * @return pointer to data if successful, NULL otherwise
4535 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4537 * Unpack a dictionary from side_data.
4539 * @param data data from side_data
4540 * @param size size of the data
4541 * @param dict the metadata storage dictionary
4542 * @return 0 on success, < 0 on failure
4544 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4548 * Convenience function to free all the side data stored.
4549 * All the other fields stay untouched.
4553 void av_packet_free_side_data(AVPacket *pkt);
4556 * Setup a new reference to the data described by a given packet
4558 * If src is reference-counted, setup dst as a new reference to the
4559 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4560 * data from src into it.
4562 * All the other fields are copied from src.
4564 * @see av_packet_unref
4566 * @param dst Destination packet
4567 * @param src Source packet
4569 * @return 0 on success, a negative AVERROR on error.
4571 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4576 * Unreference the buffer referenced by the packet and reset the
4577 * remaining packet fields to their default values.
4579 * @param pkt The packet to be unreferenced.
4581 void av_packet_unref(AVPacket *pkt);
4584 * Move every field in src to dst and reset src.
4586 * @see av_packet_unref
4588 * @param src Source packet, will be reset
4589 * @param dst Destination packet
4591 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4594 * Copy only "properties" fields from src to dst.
4596 * Properties for the purpose of this function are all the fields
4597 * beside those related to the packet data (buf, data, size)
4599 * @param dst Destination packet
4600 * @param src Source packet
4602 * @return 0 on success AVERROR on failure.
4604 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4607 * Convert valid timing fields (timestamps / durations) in a packet from one
4608 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4611 * @param pkt packet on which the conversion will be performed
4612 * @param tb_src source timebase, in which the timing fields in pkt are
4614 * @param tb_dst destination timebase, to which the timing fields will be
4617 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4624 * @addtogroup lavc_decoding
4629 * Find a registered decoder with a matching codec ID.
4631 * @param id AVCodecID of the requested decoder
4632 * @return A decoder if one was found, NULL otherwise.
4634 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4637 * Find a registered decoder with the specified name.
4639 * @param name name of the requested decoder
4640 * @return A decoder if one was found, NULL otherwise.
4642 AVCodec *avcodec_find_decoder_by_name(const char *name);
4645 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4646 * it can be called by custom get_buffer2() implementations for decoders without
4647 * AV_CODEC_CAP_DR1 set.
4649 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4653 * Return the amount of padding in pixels which the get_buffer callback must
4654 * provide around the edge of the image for codecs which do not have the
4655 * CODEC_FLAG_EMU_EDGE flag.
4657 * @return Required padding in pixels.
4659 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4662 attribute_deprecated
4663 unsigned avcodec_get_edge_width(void);
4667 * Modify width and height values so that they will result in a memory
4668 * buffer that is acceptable for the codec if you do not use any horizontal
4671 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4673 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4676 * Modify width and height values so that they will result in a memory
4677 * buffer that is acceptable for the codec if you also ensure that all
4678 * line sizes are a multiple of the respective linesize_align[i].
4680 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4682 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4683 int linesize_align[AV_NUM_DATA_POINTERS]);
4686 * Converts AVChromaLocation to swscale x/y chroma position.
4688 * The positions represent the chroma (0,0) position in a coordinates system
4689 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4691 * @param xpos horizontal chroma sample position
4692 * @param ypos vertical chroma sample position
4694 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4697 * Converts swscale x/y chroma position to AVChromaLocation.
4699 * The positions represent the chroma (0,0) position in a coordinates system
4700 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4702 * @param xpos horizontal chroma sample position
4703 * @param ypos vertical chroma sample position
4705 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4708 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4710 * Some decoders may support multiple frames in a single AVPacket. Such
4711 * decoders would then just decode the first frame and the return value would be
4712 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4713 * called again with an AVPacket containing the remaining data in order to
4714 * decode the second frame, etc... Even if no frames are returned, the packet
4715 * needs to be fed to the decoder with remaining data until it is completely
4716 * consumed or an error occurs.
4718 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4719 * and output. This means that for some packets they will not immediately
4720 * produce decoded output and need to be flushed at the end of decoding to get
4721 * all the decoded data. Flushing is done by calling this function with packets
4722 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4723 * returning samples. It is safe to flush even those decoders that are not
4724 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4726 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4727 * larger than the actual read bytes because some optimized bitstream
4728 * readers read 32 or 64 bits at once and could read over the end.
4730 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4731 * before packets may be fed to the decoder.
4733 * @param avctx the codec context
4734 * @param[out] frame The AVFrame in which to store decoded audio samples.
4735 * The decoder will allocate a buffer for the decoded frame by
4736 * calling the AVCodecContext.get_buffer2() callback.
4737 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4738 * reference counted and the returned reference belongs to the
4739 * caller. The caller must release the frame using av_frame_unref()
4740 * when the frame is no longer needed. The caller may safely write
4741 * to the frame if av_frame_is_writable() returns 1.
4742 * When AVCodecContext.refcounted_frames is set to 0, the returned
4743 * reference belongs to the decoder and is valid only until the
4744 * next call to this function or until closing or flushing the
4745 * decoder. The caller may not write to it.
4746 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4747 * non-zero. Note that this field being set to zero
4748 * does not mean that an error has occurred. For
4749 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4750 * call is guaranteed to produce a frame.
4751 * @param[in] avpkt The input AVPacket containing the input buffer.
4752 * At least avpkt->data and avpkt->size should be set. Some
4753 * decoders might also require additional fields to be set.
4754 * @return A negative error code is returned if an error occurred during
4755 * decoding, otherwise the number of bytes consumed from the input
4756 * AVPacket is returned.
4758 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4760 attribute_deprecated
4761 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4762 int *got_frame_ptr, const AVPacket *avpkt);
4765 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4766 * Some decoders may support multiple frames in a single AVPacket, such
4767 * decoders would then just decode the first frame.
4769 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4770 * the actual read bytes because some optimized bitstream readers read 32 or 64
4771 * bits at once and could read over the end.
4773 * @warning The end of the input buffer buf should be set to 0 to ensure that
4774 * no overreading happens for damaged MPEG streams.
4776 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4777 * between input and output, these need to be fed with avpkt->data=NULL,
4778 * avpkt->size=0 at the end to return the remaining frames.
4780 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4781 * before packets may be fed to the decoder.
4783 * @param avctx the codec context
4784 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4785 * Use av_frame_alloc() to get an AVFrame. The codec will
4786 * allocate memory for the actual bitmap by calling the
4787 * AVCodecContext.get_buffer2() callback.
4788 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4789 * reference counted and the returned reference belongs to the
4790 * caller. The caller must release the frame using av_frame_unref()
4791 * when the frame is no longer needed. The caller may safely write
4792 * to the frame if av_frame_is_writable() returns 1.
4793 * When AVCodecContext.refcounted_frames is set to 0, the returned
4794 * reference belongs to the decoder and is valid only until the
4795 * next call to this function or until closing or flushing the
4796 * decoder. The caller may not write to it.
4798 * @param[in] avpkt The input AVPacket containing the input buffer.
4799 * You can create such packet with av_init_packet() and by then setting
4800 * data and size, some decoders might in addition need other fields like
4801 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4803 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4804 * @return On error a negative value is returned, otherwise the number of bytes
4805 * used or zero if no frame could be decompressed.
4807 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4809 attribute_deprecated
4810 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4811 int *got_picture_ptr,
4812 const AVPacket *avpkt);
4815 * Decode a subtitle message.
4816 * Return a negative value on error, otherwise return the number of bytes used.
4817 * If no subtitle could be decompressed, got_sub_ptr is zero.
4818 * Otherwise, the subtitle is stored in *sub.
4819 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4820 * simplicity, because the performance difference is expect to be negligible
4821 * and reusing a get_buffer written for video codecs would probably perform badly
4822 * due to a potentially very different allocation pattern.
4824 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4825 * and output. This means that for some packets they will not immediately
4826 * produce decoded output and need to be flushed at the end of decoding to get
4827 * all the decoded data. Flushing is done by calling this function with packets
4828 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4829 * returning subtitles. It is safe to flush even those decoders that are not
4830 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4832 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4833 * before packets may be fed to the decoder.
4835 * @param avctx the codec context
4836 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4837 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4838 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4839 * @param[in] avpkt The input AVPacket containing the input buffer.
4841 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4846 * Supply raw packet data as input to a decoder.
4848 * Internally, this call will copy relevant AVCodecContext fields, which can
4849 * influence decoding per-packet, and apply them when the packet is actually
4850 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4851 * decoder to drop the frame contained by the packet sent with this function.)
4853 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4854 * larger than the actual read bytes because some optimized bitstream
4855 * readers read 32 or 64 bits at once and could read over the end.
4857 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4858 * on the same AVCodecContext. It will return unexpected results now
4859 * or in future libavcodec versions.
4861 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4862 * before packets may be fed to the decoder.
4864 * @param avctx codec context
4865 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4866 * frame, or several complete audio frames.
4867 * Ownership of the packet remains with the caller, and the
4868 * decoder will not write to the packet. The decoder may create
4869 * a reference to the packet data (or copy it if the packet is
4870 * not reference-counted).
4871 * Unlike with older APIs, the packet is always fully consumed,
4872 * and if it contains multiple frames (e.g. some audio codecs),
4873 * will require you to call avcodec_receive_frame() multiple
4874 * times afterwards before you can send a new packet.
4875 * It can be NULL (or an AVPacket with data set to NULL and
4876 * size set to 0); in this case, it is considered a flush
4877 * packet, which signals the end of the stream. Sending the
4878 * first flush packet will return success. Subsequent ones are
4879 * unnecessary and will return AVERROR_EOF. If the decoder
4880 * still has frames buffered, it will return them after sending
4883 * @return 0 on success, otherwise negative error code:
4884 * AVERROR(EAGAIN): input is not accepted right now - the packet must be
4885 * resent after trying to read output
4886 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4887 * be sent to it (also returned if more than 1 flush
4889 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4890 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4891 * other errors: legitimate decoding errors
4893 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4896 * Return decoded output data from a decoder.
4898 * @param avctx codec context
4899 * @param frame This will be set to a reference-counted video or audio
4900 * frame (depending on the decoder type) allocated by the
4901 * decoder. Note that the function will always call
4902 * av_frame_unref(frame) before doing anything else.
4905 * 0: success, a frame was returned
4906 * AVERROR(EAGAIN): output is not available right now - user must try
4908 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4909 * no more output frames
4910 * AVERROR(EINVAL): codec not opened, or it is an encoder
4911 * other negative values: legitimate decoding errors
4913 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4916 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4917 * to retrieve buffered output packets.
4919 * @param avctx codec context
4920 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4921 * Ownership of the frame remains with the caller, and the
4922 * encoder will not write to the frame. The encoder may create
4923 * a reference to the frame data (or copy it if the frame is
4924 * not reference-counted).
4925 * It can be NULL, in which case it is considered a flush
4926 * packet. This signals the end of the stream. If the encoder
4927 * still has packets buffered, it will return them after this
4928 * call. Once flushing mode has been entered, additional flush
4929 * packets are ignored, and sending frames will return
4933 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4934 * can have any number of samples.
4935 * If it is not set, frame->nb_samples must be equal to
4936 * avctx->frame_size for all frames except the last.
4937 * The final frame may be smaller than avctx->frame_size.
4938 * @return 0 on success, otherwise negative error code:
4939 * AVERROR(EAGAIN): input is not accepted right now - the frame must be
4940 * resent after trying to read output packets
4941 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4943 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4944 * decoder, or requires flush
4945 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4946 * other errors: legitimate decoding errors
4948 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4951 * Read encoded data from the encoder.
4953 * @param avctx codec context
4954 * @param avpkt This will be set to a reference-counted packet allocated by the
4955 * encoder. Note that the function will always call
4956 * av_frame_unref(frame) before doing anything else.
4957 * @return 0 on success, otherwise negative error code:
4958 * AVERROR(EAGAIN): output is not available right now - user must try
4960 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4961 * no more output packets
4962 * AVERROR(EINVAL): codec not opened, or it is an encoder
4963 * other errors: legitimate decoding errors
4965 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4969 * @defgroup lavc_parsing Frame parsing
4973 enum AVPictureStructure {
4974 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4975 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4976 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4977 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4980 typedef struct AVCodecParserContext {
4982 struct AVCodecParser *parser;
4983 int64_t frame_offset; /* offset of the current frame */
4984 int64_t cur_offset; /* current offset
4985 (incremented by each av_parser_parse()) */
4986 int64_t next_frame_offset; /* offset of the next frame */
4988 int pict_type; /* XXX: Put it back in AVCodecContext. */
4990 * This field is used for proper frame duration computation in lavf.
4991 * It signals, how much longer the frame duration of the current frame
4992 * is compared to normal frame duration.
4994 * frame_duration = (1 + repeat_pict) * time_base
4996 * It is used by codecs like H.264 to display telecined material.
4998 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4999 int64_t pts; /* pts of the current frame */
5000 int64_t dts; /* dts of the current frame */
5005 int fetch_timestamp;
5007 #define AV_PARSER_PTS_NB 4
5008 int cur_frame_start_index;
5009 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5010 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5011 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5014 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5015 #define PARSER_FLAG_ONCE 0x0002
5016 /// Set if the parser has a valid file offset
5017 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5018 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5020 int64_t offset; ///< byte offset from starting packet start
5021 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5024 * Set by parser to 1 for key frames and 0 for non-key frames.
5025 * It is initialized to -1, so if the parser doesn't set this flag,
5026 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5031 #if FF_API_CONVERGENCE_DURATION
5033 * @deprecated unused
5035 attribute_deprecated
5036 int64_t convergence_duration;
5039 // Timestamp generation support:
5041 * Synchronization point for start of timestamp generation.
5043 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5046 * For example, this corresponds to presence of H.264 buffering period
5052 * Offset of the current timestamp against last timestamp sync point in
5053 * units of AVCodecContext.time_base.
5055 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5056 * contain a valid timestamp offset.
5058 * Note that the timestamp of sync point has usually a nonzero
5059 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5060 * the next frame after timestamp sync point will be usually 1.
5062 * For example, this corresponds to H.264 cpb_removal_delay.
5064 int dts_ref_dts_delta;
5067 * Presentation delay of current frame in units of AVCodecContext.time_base.
5069 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5070 * contain valid non-negative timestamp delta (presentation time of a frame
5071 * must not lie in the past).
5073 * This delay represents the difference between decoding and presentation
5074 * time of the frame.
5076 * For example, this corresponds to H.264 dpb_output_delay.
5081 * Position of the packet in file.
5083 * Analogous to cur_frame_pts/dts
5085 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5088 * Byte position of currently parsed frame in stream.
5093 * Previous frame byte position.
5098 * Duration of the current frame.
5099 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5100 * For all other types, this is in units of AVCodecContext.time_base.
5104 enum AVFieldOrder field_order;
5107 * Indicate whether a picture is coded as a frame, top field or bottom field.
5109 * For example, H.264 field_pic_flag equal to 0 corresponds to
5110 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5111 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5112 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5114 enum AVPictureStructure picture_structure;
5117 * Picture number incremented in presentation or output order.
5118 * This field may be reinitialized at the first picture of a new sequence.
5120 * For example, this corresponds to H.264 PicOrderCnt.
5122 int output_picture_number;
5125 * Dimensions of the decoded video intended for presentation.
5131 * Dimensions of the coded video.
5137 * The format of the coded data, corresponds to enum AVPixelFormat for video
5138 * and for enum AVSampleFormat for audio.
5140 * Note that a decoder can have considerable freedom in how exactly it
5141 * decodes the data, so the format reported here might be different from the
5142 * one returned by a decoder.
5145 } AVCodecParserContext;
5147 typedef struct AVCodecParser {
5148 int codec_ids[5]; /* several codec IDs are permitted */
5150 int (*parser_init)(AVCodecParserContext *s);
5151 /* This callback never returns an error, a negative value means that
5152 * the frame start was in a previous packet. */
5153 int (*parser_parse)(AVCodecParserContext *s,
5154 AVCodecContext *avctx,
5155 const uint8_t **poutbuf, int *poutbuf_size,
5156 const uint8_t *buf, int buf_size);
5157 void (*parser_close)(AVCodecParserContext *s);
5158 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5159 struct AVCodecParser *next;
5162 AVCodecParser *av_parser_next(const AVCodecParser *c);
5164 void av_register_codec_parser(AVCodecParser *parser);
5165 AVCodecParserContext *av_parser_init(int codec_id);
5170 * @param s parser context.
5171 * @param avctx codec context.
5172 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5173 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5174 * @param buf input buffer.
5175 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5176 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5177 To signal EOF, this should be 0 (so that the last frame
5179 * @param pts input presentation timestamp.
5180 * @param dts input decoding timestamp.
5181 * @param pos input byte position in stream.
5182 * @return the number of bytes of the input bitstream used.
5187 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5194 * decode_frame(data, size);
5198 int av_parser_parse2(AVCodecParserContext *s,
5199 AVCodecContext *avctx,
5200 uint8_t **poutbuf, int *poutbuf_size,
5201 const uint8_t *buf, int buf_size,
5202 int64_t pts, int64_t dts,
5206 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5207 * @deprecated use AVBitStreamFilter
5209 int av_parser_change(AVCodecParserContext *s,
5210 AVCodecContext *avctx,
5211 uint8_t **poutbuf, int *poutbuf_size,
5212 const uint8_t *buf, int buf_size, int keyframe);
5213 void av_parser_close(AVCodecParserContext *s);
5221 * @addtogroup lavc_encoding
5226 * Find a registered encoder with a matching codec ID.
5228 * @param id AVCodecID of the requested encoder
5229 * @return An encoder if one was found, NULL otherwise.
5231 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5234 * Find a registered encoder with the specified name.
5236 * @param name name of the requested encoder
5237 * @return An encoder if one was found, NULL otherwise.
5239 AVCodec *avcodec_find_encoder_by_name(const char *name);
5242 * Encode a frame of audio.
5244 * Takes input samples from frame and writes the next output packet, if
5245 * available, to avpkt. The output packet does not necessarily contain data for
5246 * the most recent frame, as encoders can delay, split, and combine input frames
5247 * internally as needed.
5249 * @param avctx codec context
5250 * @param avpkt output AVPacket.
5251 * The user can supply an output buffer by setting
5252 * avpkt->data and avpkt->size prior to calling the
5253 * function, but if the size of the user-provided data is not
5254 * large enough, encoding will fail. If avpkt->data and
5255 * avpkt->size are set, avpkt->destruct must also be set. All
5256 * other AVPacket fields will be reset by the encoder using
5257 * av_init_packet(). If avpkt->data is NULL, the encoder will
5258 * allocate it. The encoder will set avpkt->size to the size
5259 * of the output packet.
5261 * If this function fails or produces no output, avpkt will be
5262 * freed using av_packet_unref().
5263 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5264 * May be NULL when flushing an encoder that has the
5265 * AV_CODEC_CAP_DELAY capability set.
5266 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5267 * can have any number of samples.
5268 * If it is not set, frame->nb_samples must be equal to
5269 * avctx->frame_size for all frames except the last.
5270 * The final frame may be smaller than avctx->frame_size.
5271 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5272 * output packet is non-empty, and to 0 if it is
5273 * empty. If the function returns an error, the
5274 * packet can be assumed to be invalid, and the
5275 * value of got_packet_ptr is undefined and should
5277 * @return 0 on success, negative error code on failure
5279 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5281 attribute_deprecated
5282 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5283 const AVFrame *frame, int *got_packet_ptr);
5286 * Encode a frame of video.
5288 * Takes input raw video data from frame and writes the next output packet, if
5289 * available, to avpkt. The output packet does not necessarily contain data for
5290 * the most recent frame, as encoders can delay and reorder input frames
5291 * internally as needed.
5293 * @param avctx codec context
5294 * @param avpkt output AVPacket.
5295 * The user can supply an output buffer by setting
5296 * avpkt->data and avpkt->size prior to calling the
5297 * function, but if the size of the user-provided data is not
5298 * large enough, encoding will fail. All other AVPacket fields
5299 * will be reset by the encoder using av_init_packet(). If
5300 * avpkt->data is NULL, the encoder will allocate it.
5301 * The encoder will set avpkt->size to the size of the
5302 * output packet. The returned data (if any) belongs to the
5303 * caller, he is responsible for freeing it.
5305 * If this function fails or produces no output, avpkt will be
5306 * freed using av_packet_unref().
5307 * @param[in] frame AVFrame containing the raw video data to be encoded.
5308 * May be NULL when flushing an encoder that has the
5309 * AV_CODEC_CAP_DELAY capability set.
5310 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5311 * output packet is non-empty, and to 0 if it is
5312 * empty. If the function returns an error, the
5313 * packet can be assumed to be invalid, and the
5314 * value of got_packet_ptr is undefined and should
5316 * @return 0 on success, negative error code on failure
5318 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5320 attribute_deprecated
5321 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5322 const AVFrame *frame, int *got_packet_ptr);
5324 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5325 const AVSubtitle *sub);
5332 #if FF_API_AVCODEC_RESAMPLE
5334 * @defgroup lavc_resample Audio resampling
5336 * @deprecated use libswresample instead
5340 struct ReSampleContext;
5341 struct AVResampleContext;
5343 typedef struct ReSampleContext ReSampleContext;
5346 * Initialize audio resampling context.
5348 * @param output_channels number of output channels
5349 * @param input_channels number of input channels
5350 * @param output_rate output sample rate
5351 * @param input_rate input sample rate
5352 * @param sample_fmt_out requested output sample format
5353 * @param sample_fmt_in input sample format
5354 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5355 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5356 * @param linear if 1 then the used FIR filter will be linearly interpolated
5357 between the 2 closest, if 0 the closest will be used
5358 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5359 * @return allocated ReSampleContext, NULL if error occurred
5361 attribute_deprecated
5362 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5363 int output_rate, int input_rate,
5364 enum AVSampleFormat sample_fmt_out,
5365 enum AVSampleFormat sample_fmt_in,
5366 int filter_length, int log2_phase_count,
5367 int linear, double cutoff);
5369 attribute_deprecated
5370 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5373 * Free resample context.
5375 * @param s a non-NULL pointer to a resample context previously
5376 * created with av_audio_resample_init()
5378 attribute_deprecated
5379 void audio_resample_close(ReSampleContext *s);
5383 * Initialize an audio resampler.
5384 * Note, if either rate is not an integer then simply scale both rates up so they are.
5385 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5386 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5387 * @param linear If 1 then the used FIR filter will be linearly interpolated
5388 between the 2 closest, if 0 the closest will be used
5389 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5391 attribute_deprecated
5392 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5395 * Resample an array of samples using a previously configured context.
5396 * @param src an array of unconsumed samples
5397 * @param consumed the number of samples of src which have been consumed are returned here
5398 * @param src_size the number of unconsumed samples available
5399 * @param dst_size the amount of space in samples available in dst
5400 * @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.
5401 * @return the number of samples written in dst or -1 if an error occurred
5403 attribute_deprecated
5404 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5408 * Compensate samplerate/timestamp drift. The compensation is done by changing
5409 * the resampler parameters, so no audible clicks or similar distortions occur
5410 * @param compensation_distance distance in output samples over which the compensation should be performed
5411 * @param sample_delta number of output samples which should be output less
5413 * example: av_resample_compensate(c, 10, 500)
5414 * here instead of 510 samples only 500 samples would be output
5416 * note, due to rounding the actual compensation might be slightly different,
5417 * especially if the compensation_distance is large and the in_rate used during init is small
5419 attribute_deprecated
5420 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5421 attribute_deprecated
5422 void av_resample_close(struct AVResampleContext *c);
5429 #if FF_API_AVPICTURE
5431 * @addtogroup lavc_picture
5436 * @deprecated unused
5438 attribute_deprecated
5439 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5442 * @deprecated unused
5444 attribute_deprecated
5445 void avpicture_free(AVPicture *picture);
5448 * @deprecated use av_image_fill_arrays() instead.
5450 attribute_deprecated
5451 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5452 enum AVPixelFormat pix_fmt, int width, int height);
5455 * @deprecated use av_image_copy_to_buffer() instead.
5457 attribute_deprecated
5458 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5459 int width, int height,
5460 unsigned char *dest, int dest_size);
5463 * @deprecated use av_image_get_buffer_size() instead.
5465 attribute_deprecated
5466 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5469 * @deprecated av_image_copy() instead.
5471 attribute_deprecated
5472 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5473 enum AVPixelFormat pix_fmt, int width, int height);
5476 * @deprecated unused
5478 attribute_deprecated
5479 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5480 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5483 * @deprecated unused
5485 attribute_deprecated
5486 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5487 int padtop, int padbottom, int padleft, int padright, int *color);
5495 * @defgroup lavc_misc Utility functions
5498 * Miscellaneous utility functions related to both encoding and decoding
5504 * @defgroup lavc_misc_pixfmt Pixel formats
5506 * Functions for working with pixel formats.
5511 * Utility function to access log2_chroma_w log2_chroma_h from
5512 * the pixel format AVPixFmtDescriptor.
5514 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5515 * for one that returns a failure code and continues in case of invalid
5518 * @param[in] pix_fmt the pixel format
5519 * @param[out] h_shift store log2_chroma_w
5520 * @param[out] v_shift store log2_chroma_h
5522 * @see av_pix_fmt_get_chroma_sub_sample
5525 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5528 * Return a value representing the fourCC code associated to the
5529 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5532 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5535 * @deprecated see av_get_pix_fmt_loss()
5537 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5541 * Find the best pixel format to convert to given a certain source pixel
5542 * format. When converting from one pixel format to another, information loss
5543 * may occur. For example, when converting from RGB24 to GRAY, the color
5544 * information will be lost. Similarly, other losses occur when converting from
5545 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5546 * the given pixel formats should be used to suffer the least amount of loss.
5547 * The pixel formats from which it chooses one, are determined by the
5548 * pix_fmt_list parameter.
5551 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5552 * @param[in] src_pix_fmt source pixel format
5553 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5554 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5555 * @return The best pixel format to convert to or -1 if none was found.
5557 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5558 enum AVPixelFormat src_pix_fmt,
5559 int has_alpha, int *loss_ptr);
5562 * @deprecated see av_find_best_pix_fmt_of_2()
5564 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5565 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5567 attribute_deprecated
5568 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
5569 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
5570 enum AVPixelFormat src_pix_fmt,
5571 int has_alpha, int *loss_ptr);
5573 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5574 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5578 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5584 #if FF_API_SET_DIMENSIONS
5586 * @deprecated this function is not supposed to be used from outside of lavc
5588 attribute_deprecated
5589 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5593 * Put a string representing the codec tag codec_tag in buf.
5595 * @param buf buffer to place codec tag in
5596 * @param buf_size size in bytes of buf
5597 * @param codec_tag codec tag to assign
5598 * @return the length of the string that would have been generated if
5599 * enough space had been available, excluding the trailing null
5601 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5603 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5606 * Return a name for the specified profile, if available.
5608 * @param codec the codec that is searched for the given profile
5609 * @param profile the profile value for which a name is requested
5610 * @return A name for the profile if found, NULL otherwise.
5612 const char *av_get_profile_name(const AVCodec *codec, int profile);
5615 * Return a name for the specified profile, if available.
5617 * @param codec_id the ID of the codec to which the requested profile belongs
5618 * @param profile the profile value for which a name is requested
5619 * @return A name for the profile if found, NULL otherwise.
5621 * @note unlike av_get_profile_name(), which searches a list of profiles
5622 * supported by a specific decoder or encoder implementation, this
5623 * function searches the list of profiles from the AVCodecDescriptor
5625 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5627 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5628 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5629 //FIXME func typedef
5632 * Fill AVFrame audio data and linesize pointers.
5634 * The buffer buf must be a preallocated buffer with a size big enough
5635 * to contain the specified samples amount. The filled AVFrame data
5636 * pointers will point to this buffer.
5638 * AVFrame extended_data channel pointers are allocated if necessary for
5641 * @param frame the AVFrame
5642 * frame->nb_samples must be set prior to calling the
5643 * function. This function fills in frame->data,
5644 * frame->extended_data, frame->linesize[0].
5645 * @param nb_channels channel count
5646 * @param sample_fmt sample format
5647 * @param buf buffer to use for frame data
5648 * @param buf_size size of buffer
5649 * @param align plane size sample alignment (0 = default)
5650 * @return >=0 on success, negative error code on failure
5651 * @todo return the size in bytes required to store the samples in
5652 * case of success, at the next libavutil bump
5654 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5655 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5656 int buf_size, int align);
5659 * Reset the internal decoder state / flush internal buffers. Should be called
5660 * e.g. when seeking or when switching to a different stream.
5662 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5663 * this invalidates the frames previously returned from the decoder. When
5664 * refcounted frames are used, the decoder just releases any references it might
5665 * keep internally, but the caller's reference remains valid.
5667 void avcodec_flush_buffers(AVCodecContext *avctx);
5670 * Return codec bits per sample.
5672 * @param[in] codec_id the codec
5673 * @return Number of bits per sample or zero if unknown for the given codec.
5675 int av_get_bits_per_sample(enum AVCodecID codec_id);
5678 * Return the PCM codec associated with a sample format.
5679 * @param be endianness, 0 for little, 1 for big,
5680 * -1 (or anything else) for native
5681 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5683 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5686 * Return codec bits per sample.
5687 * Only return non-zero if the bits per sample is exactly correct, not an
5690 * @param[in] codec_id the codec
5691 * @return Number of bits per sample or zero if unknown for the given codec.
5693 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5696 * Return audio frame duration.
5698 * @param avctx codec context
5699 * @param frame_bytes size of the frame, or 0 if unknown
5700 * @return frame duration, in samples, if known. 0 if not able to
5703 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5706 * This function is the same as av_get_audio_frame_duration(), except it works
5707 * with AVCodecParameters instead of an AVCodecContext.
5709 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5712 typedef struct AVBitStreamFilterContext {
5714 struct AVBitStreamFilter *filter;
5715 AVCodecParserContext *parser;
5716 struct AVBitStreamFilterContext *next;
5718 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5719 * Not for access by library users.
5722 } AVBitStreamFilterContext;
5725 typedef struct AVBSFInternal AVBSFInternal;
5728 * The bitstream filter state.
5730 * This struct must be allocated with av_bsf_alloc() and freed with
5733 * The fields in the struct will only be changed (by the caller or by the
5734 * filter) as described in their documentation, and are to be considered
5735 * immutable otherwise.
5737 typedef struct AVBSFContext {
5739 * A class for logging and AVOptions
5741 const AVClass *av_class;
5744 * The bitstream filter this context is an instance of.
5746 const struct AVBitStreamFilter *filter;
5749 * Opaque libavcodec internal data. Must not be touched by the caller in any
5752 AVBSFInternal *internal;
5755 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5756 * this is an AVOptions-enabled struct.
5761 * Parameters of the input stream. Set by the caller before av_bsf_init().
5763 AVCodecParameters *par_in;
5766 * Parameters of the output stream. Set by the filter in av_bsf_init().
5768 AVCodecParameters *par_out;
5771 * The timebase used for the timestamps of the input packets. Set by the
5772 * caller before av_bsf_init().
5774 AVRational time_base_in;
5777 * The timebase used for the timestamps of the output packets. Set by the
5778 * filter in av_bsf_init().
5780 AVRational time_base_out;
5783 typedef struct AVBitStreamFilter {
5787 * A list of codec ids supported by the filter, terminated by
5789 * May be NULL, in that case the bitstream filter works with any codec id.
5791 const enum AVCodecID *codec_ids;
5794 * A class for the private data, used to declare bitstream filter private
5795 * AVOptions. This field is NULL for bitstream filters that do not declare
5798 * If this field is non-NULL, the first member of the filter private data
5799 * must be a pointer to AVClass, which will be set by libavcodec generic
5800 * code to this class.
5802 const AVClass *priv_class;
5804 /*****************************************************************
5805 * No fields below this line are part of the public API. They
5806 * may not be used outside of libavcodec and can be changed and
5808 * New public fields should be added right above.
5809 *****************************************************************
5813 int (*init)(AVBSFContext *ctx);
5814 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5815 void (*close)(AVBSFContext *ctx);
5816 } AVBitStreamFilter;
5820 * Register a bitstream filter.
5822 * The filter will be accessible to the application code through
5823 * av_bitstream_filter_next() or can be directly initialized with
5824 * av_bitstream_filter_init().
5826 * @see avcodec_register_all()
5828 attribute_deprecated
5829 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5832 * Create and initialize a bitstream filter context given a bitstream
5835 * The returned context must be freed with av_bitstream_filter_close().
5837 * @param name the name of the bitstream filter
5838 * @return a bitstream filter context if a matching filter was found
5839 * and successfully initialized, NULL otherwise
5841 attribute_deprecated
5842 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5847 * This function filters the buffer buf with size buf_size, and places the
5848 * filtered buffer in the buffer pointed to by poutbuf.
5850 * The output buffer must be freed by the caller.
5852 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5853 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5854 * If specified, this must point to the encoder context of the
5855 * output stream the packet is sent to.
5856 * @param args arguments which specify the filter configuration, may be NULL
5857 * @param poutbuf pointer which is updated to point to the filtered buffer
5858 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5859 * @param buf buffer containing the data to filter
5860 * @param buf_size size in bytes of buf
5861 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5862 * @return >= 0 in case of success, or a negative error code in case of failure
5864 * If the return value is positive, an output buffer is allocated and
5865 * is available in *poutbuf, and is distinct from the input buffer.
5867 * If the return value is 0, the output buffer is not allocated and
5868 * should be considered identical to the input buffer, or in case
5869 * *poutbuf was set it points to the input buffer (not necessarily to
5870 * its starting address). A special case is if *poutbuf was set to NULL and
5871 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5873 attribute_deprecated
5874 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5875 AVCodecContext *avctx, const char *args,
5876 uint8_t **poutbuf, int *poutbuf_size,
5877 const uint8_t *buf, int buf_size, int keyframe);
5880 * Release bitstream filter context.
5882 * @param bsf the bitstream filter context created with
5883 * av_bitstream_filter_init(), can be NULL
5885 attribute_deprecated
5886 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5889 * If f is NULL, return the first registered bitstream filter,
5890 * if f is non-NULL, return the next registered bitstream filter
5891 * after f, or NULL if f is the last one.
5893 * This function can be used to iterate over all registered bitstream
5896 attribute_deprecated
5897 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5901 * @return a bitstream filter with the specified name or NULL if no such
5902 * bitstream filter exists.
5904 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5907 * Iterate over all registered bitstream filters.
5909 * @param opaque a pointer where libavcodec will store the iteration state. Must
5910 * point to NULL to start the iteration.
5912 * @return the next registered bitstream filter or NULL when the iteration is
5915 const AVBitStreamFilter *av_bsf_next(void **opaque);
5918 * Allocate a context for a given bitstream filter. The caller must fill in the
5919 * context parameters as described in the documentation and then call
5920 * av_bsf_init() before sending any data to the filter.
5922 * @param filter the filter for which to allocate an instance.
5923 * @param ctx a pointer into which the pointer to the newly-allocated context
5924 * will be written. It must be freed with av_bsf_free() after the
5925 * filtering is done.
5927 * @return 0 on success, a negative AVERROR code on failure
5929 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5932 * Prepare the filter for use, after all the parameters and options have been
5935 int av_bsf_init(AVBSFContext *ctx);
5938 * Submit a packet for filtering.
5940 * After sending each packet, the filter must be completely drained by calling
5941 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5944 * @param pkt the packet to filter. pkt must contain some payload (i.e data or
5945 * side data must be present in pkt). The bitstream filter will take ownership of
5946 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5947 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5948 * packets will be sent). That will cause the filter to output any packets it
5949 * may have buffered internally.
5951 * @return 0 on success, a negative AVERROR on error.
5953 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5956 * Retrieve a filtered packet.
5958 * @param[out] pkt this struct will be filled with the contents of the filtered
5959 * packet. It is owned by the caller and must be freed using
5960 * av_packet_unref() when it is no longer needed.
5961 * This parameter should be "clean" (i.e. freshly allocated
5962 * with av_packet_alloc() or unreffed with av_packet_unref())
5963 * when this function is called. If this function returns
5964 * successfully, the contents of pkt will be completely
5965 * overwritten by the returned data. On failure, pkt is not
5968 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5969 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5970 * will be no further output from the filter. Another negative AVERROR value if
5973 * @note one input packet may result in several output packets, so after sending
5974 * a packet with av_bsf_send_packet(), this function needs to be called
5975 * repeatedly until it stops returning 0. It is also possible for a filter to
5976 * output fewer packets than were sent to it, so this function may return
5977 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5979 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5982 * Free a bitstream filter context and everything associated with it; write NULL
5983 * into the supplied pointer.
5985 void av_bsf_free(AVBSFContext **ctx);
5988 * Get the AVClass for AVBSFContext. It can be used in combination with
5989 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5991 * @see av_opt_find().
5993 const AVClass *av_bsf_get_class(void);
5996 * Structure for chain/list of bitstream filters.
5997 * Empty list can be allocated by av_bsf_list_alloc().
5999 typedef struct AVBSFList AVBSFList;
6002 * Allocate empty list of bitstream filters.
6003 * The list must be later freed by av_bsf_list_free()
6004 * or finalized by av_bsf_list_finalize().
6006 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6008 AVBSFList *av_bsf_list_alloc(void);
6011 * Free list of bitstream filters.
6013 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6015 void av_bsf_list_free(AVBSFList **lst);
6018 * Append bitstream filter to the list of bitstream filters.
6020 * @param lst List to append to
6021 * @param bsf Filter context to be appended
6023 * @return >=0 on success, negative AVERROR in case of failure
6025 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6028 * Construct new bitstream filter context given it's name and options
6029 * and append it to the list of bitstream filters.
6031 * @param lst List to append to
6032 * @param bsf_name Name of the bitstream filter
6033 * @param options Options for the bitstream filter, can be set to NULL
6035 * @return >=0 on success, negative AVERROR in case of failure
6037 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6039 * Finalize list of bitstream filters.
6041 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6042 * so the whole chain of bitstream filters can be treated as single filter
6043 * freshly allocated by av_bsf_alloc().
6044 * If the call is successful, @ref AVBSFList structure is freed and lst
6045 * will be set to NULL. In case of failure, caller is responsible for
6046 * freeing the structure by av_bsf_list_free()
6048 * @param lst Filter list structure to be transformed
6049 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6050 * representing the chain of bitstream filters
6052 * @return >=0 on success, negative AVERROR in case of failure
6054 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6057 * Parse string describing list of bitstream filters and create single
6058 * @ref AVBSFContext describing the whole chain of bitstream filters.
6059 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6060 * allocated by av_bsf_alloc().
6062 * @param str String describing chain of bitstream filters in format
6063 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6064 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6065 * representing the chain of bitstream filters
6067 * @return >=0 on success, negative AVERROR in case of failure
6069 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6072 * Get null/pass-through bitstream filter.
6074 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6078 int av_bsf_get_null_filter(AVBSFContext **bsf);
6083 * Same behaviour av_fast_malloc but the buffer has additional
6084 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6086 * In addition the whole buffer will initially and after resizes
6087 * be 0-initialized so that no uninitialized data will ever appear.
6089 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6092 * Same behaviour av_fast_padded_malloc except that buffer will always
6093 * be 0-initialized after call.
6095 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6098 * Encode extradata length to a buffer. Used by xiph codecs.
6100 * @param s buffer to write to; must be at least (v/255+1) bytes long
6101 * @param v size of extradata in bytes
6102 * @return number of bytes written to the buffer.
6104 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6106 #if FF_API_MISSING_SAMPLE
6108 * Log a generic warning message about a missing feature. This function is
6109 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6110 * only, and would normally not be used by applications.
6111 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6112 * a pointer to an AVClass struct
6113 * @param[in] feature string containing the name of the missing feature
6114 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
6115 * If want_sample is non-zero, additional verbiage will be added to the log
6116 * message which tells the user how to report samples to the development
6118 * @deprecated Use avpriv_report_missing_feature() instead.
6120 attribute_deprecated
6121 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
6124 * Log a generic warning message asking for a sample. This function is
6125 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6126 * only, and would normally not be used by applications.
6127 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6128 * a pointer to an AVClass struct
6129 * @param[in] msg string containing an optional message, or NULL if no message
6130 * @deprecated Use avpriv_request_sample() instead.
6132 attribute_deprecated
6133 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
6134 #endif /* FF_API_MISSING_SAMPLE */
6137 * Register the hardware accelerator hwaccel.
6139 void av_register_hwaccel(AVHWAccel *hwaccel);
6142 * If hwaccel is NULL, returns the first registered hardware accelerator,
6143 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6144 * after hwaccel, or NULL if hwaccel is the last one.
6146 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6150 * Lock operation used by lockmgr
6153 AV_LOCK_CREATE, ///< Create a mutex
6154 AV_LOCK_OBTAIN, ///< Lock the mutex
6155 AV_LOCK_RELEASE, ///< Unlock the mutex
6156 AV_LOCK_DESTROY, ///< Free mutex resources
6160 * Register a user provided lock manager supporting the operations
6161 * specified by AVLockOp. The "mutex" argument to the function points
6162 * to a (void *) where the lockmgr should store/get a pointer to a user
6163 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6164 * value left by the last call for all other ops. If the lock manager is
6165 * unable to perform the op then it should leave the mutex in the same
6166 * state as when it was called and return a non-zero value. However,
6167 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6168 * have been successfully destroyed. If av_lockmgr_register succeeds
6169 * it will return a non-negative value, if it fails it will return a
6170 * negative value and destroy all mutex and unregister all callbacks.
6171 * av_lockmgr_register is not thread-safe, it must be called from a
6172 * single thread before any calls which make use of locking are used.
6174 * @param cb User defined callback. av_lockmgr_register invokes calls
6175 * to this callback and the previously registered callback.
6176 * The callback will be used to create more than one mutex
6177 * each of which must be backed by its own underlying locking
6178 * mechanism (i.e. do not use a single static object to
6179 * implement your lock manager). If cb is set to NULL the
6180 * lockmgr will be unregistered.
6182 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6185 * Get the type of the given codec.
6187 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6190 * Get the name of a codec.
6191 * @return a static string identifying the codec; never NULL
6193 const char *avcodec_get_name(enum AVCodecID id);
6196 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6197 * with no corresponding avcodec_close()), 0 otherwise.
6199 int avcodec_is_open(AVCodecContext *s);
6202 * @return a non-zero number if codec is an encoder, zero otherwise
6204 int av_codec_is_encoder(const AVCodec *codec);
6207 * @return a non-zero number if codec is a decoder, zero otherwise
6209 int av_codec_is_decoder(const AVCodec *codec);
6212 * @return descriptor for given codec ID or NULL if no descriptor exists.
6214 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6217 * Iterate over all codec descriptors known to libavcodec.
6219 * @param prev previous descriptor. NULL to get the first descriptor.
6221 * @return next descriptor or NULL after the last descriptor
6223 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6226 * @return codec descriptor with the given name or NULL if no such descriptor
6229 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6232 * Allocate a CPB properties structure and initialize its fields to default
6235 * @param size if non-NULL, the size of the allocated struct will be written
6236 * here. This is useful for embedding it in side data.
6238 * @return the newly allocated struct or NULL on failure
6240 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6246 #endif /* AVCODEC_AVCODEC_H */