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 encoder 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 * In theory, sending input can result in EAGAIN - this should happen only if
116 * not all output was received. You can use this to structure alternative decode
117 * or encode loops other than the one suggested above. For example, you could
118 * try sending new input on each iteration, and try to receive output if that
121 * End of stream situations. These require "flushing" (aka draining) the codec,
122 * as the codec might buffer multiple frames or packets internally for
123 * performance or out of necessity (consider B-frames).
124 * This is handled as follows:
125 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
126 * or avcodec_send_frame() (encoding) functions. This will enter draining
128 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
129 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
130 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
131 * - Before decoding can be resumed again, the codec has to be reset with
132 * avcodec_flush_buffers().
134 * Using the API as outlined above is highly recommended. But it is also
135 * possible to call functions outside of this rigid schema. For example, you can
136 * call avcodec_send_packet() repeatedly without calling
137 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
138 * until the codec's internal buffer has been filled up (which is typically of
139 * size 1 per output frame, after initial input), and then reject input with
140 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
141 * read at least some output.
143 * Not all codecs will follow a rigid and predictable dataflow; the only
144 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
145 * one end implies that a receive/send call on the other end will succeed. In
146 * general, no codec will permit unlimited buffering of input or output.
148 * This API replaces the following legacy functions:
149 * - avcodec_decode_video2() and avcodec_decode_audio4():
150 * Use avcodec_send_packet() to feed input to the decoder, then use
151 * avcodec_receive_frame() to receive decoded frames after each packet.
152 * Unlike with the old video decoding API, multiple frames might result from
153 * a packet. For audio, splitting the input packet into frames by partially
154 * decoding packets becomes transparent to the API user. You never need to
155 * feed an AVPacket to the API twice (unless it is rejected with EAGAIN - then
156 * no data was read from the packet).
157 * Additionally, sending a flush/draining packet is required only once.
158 * - avcodec_encode_video2()/avcodec_encode_audio2():
159 * Use avcodec_send_frame() to feed input to the encoder, then use
160 * avcodec_receive_packet() to receive encoded packets.
161 * Providing user-allocated buffers for avcodec_receive_packet() is not
163 * - The new API does not handle subtitles yet.
165 * Mixing new and old function calls on the same AVCodecContext is not allowed,
166 * and will result in undefined behavior.
168 * Some codecs might require using the new API; using the old API will return
169 * an error when calling it. All codecs support the new API.
171 * A codec is not allowed to return EAGAIN for both sending and receiving. This
172 * would be an invalid state, which could put the codec user into an endless
173 * loop. The API has no concept of time either: it cannot happen that trying to
174 * do avcodec_send_packet() results in EAGAIN, but a repeated call 1 second
175 * later accepts the packet (with no other receive/flush API calls involved).
176 * The API is a strict state machine, and the passage of time is not supposed
177 * to influence it. Some timing-dependent behavior might still be deemed
178 * acceptable in certain cases. But it must never result in both send/receive
179 * returning EAGAIN at the same time at any point. It must also absolutely be
180 * avoided that the current state is "unstable" and can "flip-flop" between
181 * the send/receive APIs allowing progress. For example, it's not allowed that
182 * the codec randomly decides that it actually wants to consume a packet now
183 * instead of returning a frame, after it just returned EAGAIN on an
184 * avcodec_send_packet() call.
189 * @defgroup lavc_core Core functions/structures.
192 * Basic definitions, functions for querying libavcodec capabilities,
193 * allocating core structures, etc.
199 * Identify the syntax and semantics of the bitstream.
200 * The principle is roughly:
201 * Two decoders with the same ID can decode the same streams.
202 * Two encoders with the same ID can encode compatible streams.
203 * There may be slight deviations from the principle due to implementation
206 * If you add a codec ID to this list, add it so that
207 * 1. no value of an existing codec ID changes (that would break ABI),
208 * 2. it is as close as possible to similar codecs
210 * After adding new codec IDs, do not forget to add an entry to the codec
211 * descriptor list and bump libavcodec minor version.
217 AV_CODEC_ID_MPEG1VIDEO,
218 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
220 AV_CODEC_ID_MPEG2VIDEO_XVMC,
221 #endif /* FF_API_XVMC */
232 AV_CODEC_ID_RAWVIDEO,
233 AV_CODEC_ID_MSMPEG4V1,
234 AV_CODEC_ID_MSMPEG4V2,
235 AV_CODEC_ID_MSMPEG4V3,
258 AV_CODEC_ID_INTERPLAY_VIDEO,
265 AV_CODEC_ID_MSVIDEO1,
270 AV_CODEC_ID_TRUEMOTION1,
271 AV_CODEC_ID_VMDVIDEO,
296 AV_CODEC_ID_TRUEMOTION2,
302 AV_CODEC_ID_SMACKVIDEO,
307 AV_CODEC_ID_JPEG2000,
313 AV_CODEC_ID_DSICINVIDEO,
314 AV_CODEC_ID_TIERTEXSEQVIDEO,
322 AV_CODEC_ID_BETHSOFTVID,
334 AV_CODEC_ID_ESCAPE124,
338 AV_CODEC_ID_MOTIONPIXELS,
350 AV_CODEC_ID_FLASHSV2,
351 AV_CODEC_ID_CDGRAPHICS,
354 AV_CODEC_ID_BINKVIDEO,
355 AV_CODEC_ID_IFF_ILBM,
356 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
362 AV_CODEC_ID_A64_MULTI,
363 AV_CODEC_ID_A64_MULTI5,
366 AV_CODEC_ID_LAGARITH,
370 AV_CODEC_ID_WMV3IMAGE,
371 AV_CODEC_ID_VC1IMAGE,
373 AV_CODEC_ID_BMV_VIDEO,
380 AV_CODEC_ID_ZEROCODEC,
389 AV_CODEC_ID_ESCAPE130,
392 AV_CODEC_ID_HNM4_VIDEO,
394 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
396 AV_CODEC_ID_ALIAS_PIX,
397 AV_CODEC_ID_BRENDER_PIX,
398 AV_CODEC_ID_PAF_VIDEO,
411 AV_CODEC_ID_SCREENPRESSO,
414 AV_CODEC_ID_Y41P = 0x8000,
419 AV_CODEC_ID_TARGA_Y216,
431 AV_CODEC_ID_TRUEMOTION2RT,
433 AV_CODEC_ID_MAGICYUV,
434 AV_CODEC_ID_SHEERVIDEO,
441 AV_CODEC_ID_CLEARVIDEO,
445 /* various PCM "codecs" */
446 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
447 AV_CODEC_ID_PCM_S16LE = 0x10000,
448 AV_CODEC_ID_PCM_S16BE,
449 AV_CODEC_ID_PCM_U16LE,
450 AV_CODEC_ID_PCM_U16BE,
453 AV_CODEC_ID_PCM_MULAW,
454 AV_CODEC_ID_PCM_ALAW,
455 AV_CODEC_ID_PCM_S32LE,
456 AV_CODEC_ID_PCM_S32BE,
457 AV_CODEC_ID_PCM_U32LE,
458 AV_CODEC_ID_PCM_U32BE,
459 AV_CODEC_ID_PCM_S24LE,
460 AV_CODEC_ID_PCM_S24BE,
461 AV_CODEC_ID_PCM_U24LE,
462 AV_CODEC_ID_PCM_U24BE,
463 AV_CODEC_ID_PCM_S24DAUD,
464 AV_CODEC_ID_PCM_ZORK,
465 AV_CODEC_ID_PCM_S16LE_PLANAR,
467 AV_CODEC_ID_PCM_F32BE,
468 AV_CODEC_ID_PCM_F32LE,
469 AV_CODEC_ID_PCM_F64BE,
470 AV_CODEC_ID_PCM_F64LE,
471 AV_CODEC_ID_PCM_BLURAY,
474 AV_CODEC_ID_PCM_S8_PLANAR,
475 AV_CODEC_ID_PCM_S24LE_PLANAR,
476 AV_CODEC_ID_PCM_S32LE_PLANAR,
477 AV_CODEC_ID_PCM_S16BE_PLANAR,
479 AV_CODEC_ID_PCM_S64LE = 0x10800,
480 AV_CODEC_ID_PCM_S64BE,
481 AV_CODEC_ID_PCM_F16LE,
482 AV_CODEC_ID_PCM_F24LE,
484 /* various ADPCM codecs */
485 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
486 AV_CODEC_ID_ADPCM_IMA_WAV,
487 AV_CODEC_ID_ADPCM_IMA_DK3,
488 AV_CODEC_ID_ADPCM_IMA_DK4,
489 AV_CODEC_ID_ADPCM_IMA_WS,
490 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
491 AV_CODEC_ID_ADPCM_MS,
492 AV_CODEC_ID_ADPCM_4XM,
493 AV_CODEC_ID_ADPCM_XA,
494 AV_CODEC_ID_ADPCM_ADX,
495 AV_CODEC_ID_ADPCM_EA,
496 AV_CODEC_ID_ADPCM_G726,
497 AV_CODEC_ID_ADPCM_CT,
498 AV_CODEC_ID_ADPCM_SWF,
499 AV_CODEC_ID_ADPCM_YAMAHA,
500 AV_CODEC_ID_ADPCM_SBPRO_4,
501 AV_CODEC_ID_ADPCM_SBPRO_3,
502 AV_CODEC_ID_ADPCM_SBPRO_2,
503 AV_CODEC_ID_ADPCM_THP,
504 AV_CODEC_ID_ADPCM_IMA_AMV,
505 AV_CODEC_ID_ADPCM_EA_R1,
506 AV_CODEC_ID_ADPCM_EA_R3,
507 AV_CODEC_ID_ADPCM_EA_R2,
508 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
509 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
510 AV_CODEC_ID_ADPCM_EA_XAS,
511 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
512 AV_CODEC_ID_ADPCM_IMA_ISS,
513 AV_CODEC_ID_ADPCM_G722,
514 AV_CODEC_ID_ADPCM_IMA_APC,
515 AV_CODEC_ID_ADPCM_VIMA,
516 #if FF_API_VIMA_DECODER
517 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
520 AV_CODEC_ID_ADPCM_AFC = 0x11800,
521 AV_CODEC_ID_ADPCM_IMA_OKI,
522 AV_CODEC_ID_ADPCM_DTK,
523 AV_CODEC_ID_ADPCM_IMA_RAD,
524 AV_CODEC_ID_ADPCM_G726LE,
525 AV_CODEC_ID_ADPCM_THP_LE,
526 AV_CODEC_ID_ADPCM_PSX,
527 AV_CODEC_ID_ADPCM_AICA,
528 AV_CODEC_ID_ADPCM_IMA_DAT4,
529 AV_CODEC_ID_ADPCM_MTAF,
532 AV_CODEC_ID_AMR_NB = 0x12000,
535 /* RealAudio codecs*/
536 AV_CODEC_ID_RA_144 = 0x13000,
539 /* various DPCM codecs */
540 AV_CODEC_ID_ROQ_DPCM = 0x14000,
541 AV_CODEC_ID_INTERPLAY_DPCM,
542 AV_CODEC_ID_XAN_DPCM,
543 AV_CODEC_ID_SOL_DPCM,
545 AV_CODEC_ID_SDX2_DPCM = 0x14800,
548 AV_CODEC_ID_MP2 = 0x15000,
549 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
559 AV_CODEC_ID_VMDAUDIO,
565 AV_CODEC_ID_WESTWOOD_SND1,
566 AV_CODEC_ID_GSM, ///< as in Berlin toast format
569 AV_CODEC_ID_TRUESPEECH,
571 AV_CODEC_ID_SMACKAUDIO,
574 AV_CODEC_ID_DSICINAUDIO,
576 AV_CODEC_ID_MUSEPACK7,
578 AV_CODEC_ID_GSM_MS, /* as found in WAV */
584 AV_CODEC_ID_NELLYMOSER,
585 AV_CODEC_ID_MUSEPACK8,
587 AV_CODEC_ID_WMAVOICE,
589 AV_CODEC_ID_WMALOSSLESS,
598 AV_CODEC_ID_BINKAUDIO_RDFT,
599 AV_CODEC_ID_BINKAUDIO_DCT,
600 AV_CODEC_ID_AAC_LATM,
605 AV_CODEC_ID_8SVX_EXP,
606 AV_CODEC_ID_8SVX_FIB,
607 AV_CODEC_ID_BMV_AUDIO,
612 AV_CODEC_ID_COMFORT_NOISE,
614 AV_CODEC_ID_METASOUND,
615 AV_CODEC_ID_PAF_AUDIO,
619 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
621 AV_CODEC_ID_SONIC_LS,
624 AV_CODEC_ID_DSD_LSBF,
625 AV_CODEC_ID_DSD_MSBF,
626 AV_CODEC_ID_DSD_LSBF_PLANAR,
627 AV_CODEC_ID_DSD_MSBF_PLANAR,
629 AV_CODEC_ID_INTERPLAY_ACM,
633 AV_CODEC_ID_ATRAC3AL,
634 AV_CODEC_ID_ATRAC3PAL,
636 /* subtitle codecs */
637 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
638 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
639 AV_CODEC_ID_DVB_SUBTITLE,
640 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
643 AV_CODEC_ID_MOV_TEXT,
644 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
645 AV_CODEC_ID_DVB_TELETEXT,
648 AV_CODEC_ID_MICRODVD = 0x17800,
652 AV_CODEC_ID_REALTEXT,
654 AV_CODEC_ID_SUBVIEWER1,
655 AV_CODEC_ID_SUBVIEWER,
662 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
664 /* other specific kind of codecs (generally used for attachments) */
665 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
666 AV_CODEC_ID_TTF = 0x18000,
668 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
669 AV_CODEC_ID_BINTEXT = 0x18800,
673 AV_CODEC_ID_SMPTE_KLV,
675 AV_CODEC_ID_TIMED_ID3,
676 AV_CODEC_ID_BIN_DATA,
679 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
681 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
682 * stream (only used by libavformat) */
683 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
684 * stream (only used by libavformat) */
685 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
686 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
690 * This struct describes the properties of a single codec described by an
692 * @see avcodec_descriptor_get()
694 typedef struct AVCodecDescriptor {
696 enum AVMediaType type;
698 * Name of the codec described by this descriptor. It is non-empty and
699 * unique for each codec descriptor. It should contain alphanumeric
700 * characters and '_' only.
704 * A more descriptive name for this codec. May be NULL.
706 const char *long_name;
708 * Codec properties, a combination of AV_CODEC_PROP_* flags.
712 * MIME type(s) associated with the codec.
713 * May be NULL; if not, a NULL-terminated array of MIME types.
714 * The first item is always non-NULL and is the preferred MIME type.
716 const char *const *mime_types;
718 * If non-NULL, an array of profiles recognized for this codec.
719 * Terminated with FF_PROFILE_UNKNOWN.
721 const struct AVProfile *profiles;
725 * Codec uses only intra compression.
728 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
730 * Codec supports lossy compression. Audio and video codecs only.
731 * @note a codec may support both lossy and lossless
734 #define AV_CODEC_PROP_LOSSY (1 << 1)
736 * Codec supports lossless compression. Audio and video codecs only.
738 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
740 * Codec supports frame reordering. That is, the coded order (the order in which
741 * the encoded packets are output by the encoders / stored / input to the
742 * decoders) may be different from the presentation order of the corresponding
745 * For codecs that do not have this property set, PTS and DTS should always be
748 #define AV_CODEC_PROP_REORDER (1 << 3)
750 * Subtitle codec is bitmap based
751 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
753 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
755 * Subtitle codec is text based.
756 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
758 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
761 * @ingroup lavc_decoding
762 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
763 * This is mainly needed because some optimized bitstream readers read
764 * 32 or 64 bit at once and could read over the end.<br>
765 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
766 * MPEG bitstreams could cause overread and segfault.
768 #define AV_INPUT_BUFFER_PADDING_SIZE 32
771 * @ingroup lavc_encoding
772 * minimum encoding buffer size
773 * Used to avoid some checks during header writing.
775 #define AV_INPUT_BUFFER_MIN_SIZE 16384
777 #if FF_API_WITHOUT_PREFIX
779 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
781 #define FF_INPUT_BUFFER_PADDING_SIZE 32
784 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
786 #define FF_MIN_BUFFER_SIZE 16384
787 #endif /* FF_API_WITHOUT_PREFIX */
790 * @ingroup lavc_encoding
791 * motion estimation type.
792 * @deprecated use codec private option instead
794 #if FF_API_MOTION_EST
796 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
800 ME_EPZS, ///< enhanced predictive zonal search
801 ME_X1, ///< reserved for experiments
802 ME_HEX, ///< hexagon based search
803 ME_UMH, ///< uneven multi-hexagon search
804 ME_TESA, ///< transformed exhaustive search algorithm
805 ME_ITER=50, ///< iterative search
810 * @ingroup lavc_decoding
813 /* We leave some space between them for extensions (drop some
814 * keyframes for intra-only or drop just some bidir frames). */
815 AVDISCARD_NONE =-16, ///< discard nothing
816 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
817 AVDISCARD_NONREF = 8, ///< discard all non reference
818 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
819 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
820 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
821 AVDISCARD_ALL = 48, ///< discard all
824 enum AVAudioServiceType {
825 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
826 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
827 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
828 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
829 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
830 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
831 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
832 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
833 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
834 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
838 * @ingroup lavc_encoding
840 typedef struct RcOverride{
843 int qscale; // If this is 0 then quality_factor will be used instead.
844 float quality_factor;
847 #if FF_API_MAX_BFRAMES
849 * @deprecated there is no libavcodec-wide limit on the number of B-frames
851 #define FF_MAX_B_FRAMES 16
855 These flags can be passed in AVCodecContext.flags before initialization.
856 Note: Not everything is supported yet.
860 * Allow decoders to produce frames with data planes that are not aligned
861 * to CPU requirements (e.g. due to cropping).
863 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
867 #define AV_CODEC_FLAG_QSCALE (1 << 1)
869 * 4 MV per MB allowed / advanced prediction for H.263.
871 #define AV_CODEC_FLAG_4MV (1 << 2)
873 * Output even those frames that might be corrupted.
875 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
879 #define AV_CODEC_FLAG_QPEL (1 << 4)
881 * Use internal 2pass ratecontrol in first pass mode.
883 #define AV_CODEC_FLAG_PASS1 (1 << 9)
885 * Use internal 2pass ratecontrol in second pass mode.
887 #define AV_CODEC_FLAG_PASS2 (1 << 10)
891 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
893 * Only decode/encode grayscale.
895 #define AV_CODEC_FLAG_GRAY (1 << 13)
897 * error[?] variables will be set during encoding.
899 #define AV_CODEC_FLAG_PSNR (1 << 15)
901 * Input bitstream might be truncated at a random location
902 * instead of only at frame boundaries.
904 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
906 * Use interlaced DCT.
908 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
912 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
914 * Place global headers in extradata instead of every keyframe.
916 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
918 * Use only bitexact stuff (except (I)DCT).
920 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
921 /* Fx : Flag for H.263+ extra options */
923 * H.263 advanced intra coding / MPEG-4 AC prediction
925 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
927 * interlaced motion estimation
929 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
930 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
933 * Allow non spec compliant speedup tricks.
935 #define AV_CODEC_FLAG2_FAST (1 << 0)
937 * Skip bitstream encoding.
939 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
941 * Place global headers at every keyframe instead of in extradata.
943 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
946 * timecode is in drop frame format. DEPRECATED!!!!
948 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
951 * Input bitstream might be truncated at a packet boundaries
952 * instead of only at frame boundaries.
954 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
956 * Discard cropping information from SPS.
958 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
961 * Show all frames before the first keyframe
963 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
965 * Export motion vectors through frame side data
967 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
969 * Do not skip samples and export skip information as frame side data
971 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
973 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
975 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
977 /* Unsupported options :
978 * Syntax Arithmetic coding (SAC)
979 * Reference Picture Selection
980 * Independent Segment Decoding */
982 /* codec capabilities */
985 * Decoder can use draw_horiz_band callback.
987 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
989 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
990 * If not set, it might not use get_buffer() at all or use operations that
991 * assume the buffer was allocated by avcodec_default_get_buffer.
993 #define AV_CODEC_CAP_DR1 (1 << 1)
994 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
996 * Encoder or decoder requires flushing with NULL input at the end in order to
997 * give the complete and correct output.
999 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1000 * with NULL data. The user can still send NULL data to the public encode
1001 * or decode function, but libavcodec will not pass it along to the codec
1002 * unless this flag is set.
1005 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1006 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1010 * The encoder needs to be fed with NULL data at the end of encoding until the
1011 * encoder no longer returns data.
1013 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1014 * flag also means that the encoder must set the pts and duration for
1015 * each output packet. If this flag is not set, the pts and duration will
1016 * be determined by libavcodec from the input frame.
1018 #define AV_CODEC_CAP_DELAY (1 << 5)
1020 * Codec can be fed a final frame with a smaller size.
1021 * This can be used to prevent truncation of the last audio samples.
1023 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1025 #if FF_API_CAP_VDPAU
1027 * Codec can export data for HW decoding (VDPAU).
1029 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
1033 * Codec can output multiple frames per AVPacket
1034 * Normally demuxers return one frame at a time, demuxers which do not do
1035 * are connected to a parser to split what they return into proper frames.
1036 * This flag is reserved to the very rare category of codecs which have a
1037 * bitstream that cannot be split into frames without timeconsuming
1038 * operations like full decoding. Demuxers carrying such bitstreams thus
1039 * may return multiple frames in a packet. This has many disadvantages like
1040 * prohibiting stream copy in many cases thus it should only be considered
1043 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1045 * Codec is experimental and is thus avoided in favor of non experimental
1048 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1050 * Codec should fill in channel configuration and samplerate instead of container
1052 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1054 * Codec supports frame-level multithreading.
1056 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1058 * Codec supports slice-based (or partition-based) multithreading.
1060 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1062 * Codec supports changed parameters at any point.
1064 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1066 * Codec supports avctx->thread_count == 0 (auto).
1068 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1070 * Audio encoder supports receiving a different number of samples in each call.
1072 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1074 * Decoder is not a preferred choice for probing.
1075 * This indicates that the decoder is not a good choice for probing.
1076 * It could for example be an expensive to spin up hardware decoder,
1077 * or it could simply not provide a lot of useful information about
1079 * A decoder marked with this flag should only be used as last resort
1080 * choice for probing.
1082 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1084 * Codec is intra only.
1086 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1088 * Codec is lossless.
1090 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1093 #if FF_API_WITHOUT_PREFIX
1095 * Allow decoders to produce frames with data planes that are not aligned
1096 * to CPU requirements (e.g. due to cropping).
1098 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1099 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1100 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1101 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1102 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1105 * @deprecated use the "gmc" private option of the libxvid encoder
1107 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1111 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1112 * mpegvideo encoders
1114 #define CODEC_FLAG_MV0 0x0040
1116 #if FF_API_INPUT_PRESERVED
1118 * @deprecated passing reference-counted frames to the encoders replaces this
1121 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1123 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1124 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1125 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1128 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1131 #define CODEC_FLAG_EMU_EDGE 0x4000
1133 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1134 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1136 #if FF_API_NORMALIZE_AQP
1138 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1139 * mpegvideo encoders
1141 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1143 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1144 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1145 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1146 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1147 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1148 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1149 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1150 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1151 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1152 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1153 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1154 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1155 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1157 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1158 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1159 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1160 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1162 /* Unsupported options :
1163 * Syntax Arithmetic coding (SAC)
1164 * Reference Picture Selection
1165 * Independent Segment Decoding */
1167 /* codec capabilities */
1169 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1171 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1172 * If not set, it might not use get_buffer() at all or use operations that
1173 * assume the buffer was allocated by avcodec_default_get_buffer.
1175 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1176 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1178 /* Codec can export data for HW decoding. This flag indicates that
1179 * the codec would call get_format() with list that might contain HW accelerated
1180 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1181 * including raw image format.
1182 * The application can use the passed context to determine bitstream version,
1183 * chroma format, resolution etc.
1185 #define CODEC_CAP_HWACCEL 0x0010
1186 #endif /* FF_API_XVMC */
1188 * Encoder or decoder requires flushing with NULL input at the end in order to
1189 * give the complete and correct output.
1191 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1192 * with NULL data. The user can still send NULL data to the public encode
1193 * or decode function, but libavcodec will not pass it along to the codec
1194 * unless this flag is set.
1197 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1198 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1202 * The encoder needs to be fed with NULL data at the end of encoding until the
1203 * encoder no longer returns data.
1205 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1206 * flag also means that the encoder must set the pts and duration for
1207 * each output packet. If this flag is not set, the pts and duration will
1208 * be determined by libavcodec from the input frame.
1210 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1212 * Codec can be fed a final frame with a smaller size.
1213 * This can be used to prevent truncation of the last audio samples.
1215 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1216 #if FF_API_CAP_VDPAU
1218 * Codec can export data for HW decoding (VDPAU).
1220 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1223 * Codec can output multiple frames per AVPacket
1224 * Normally demuxers return one frame at a time, demuxers which do not do
1225 * are connected to a parser to split what they return into proper frames.
1226 * This flag is reserved to the very rare category of codecs which have a
1227 * bitstream that cannot be split into frames without timeconsuming
1228 * operations like full decoding. Demuxers carrying such bitstreams thus
1229 * may return multiple frames in a packet. This has many disadvantages like
1230 * prohibiting stream copy in many cases thus it should only be considered
1233 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1235 * Codec is experimental and is thus avoided in favor of non experimental
1238 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1240 * Codec should fill in channel configuration and samplerate instead of container
1242 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1243 #if FF_API_NEG_LINESIZES
1245 * @deprecated no codecs use this capability
1247 #define CODEC_CAP_NEG_LINESIZES 0x0800
1250 * Codec supports frame-level multithreading.
1252 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1254 * Codec supports slice-based (or partition-based) multithreading.
1256 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1258 * Codec supports changed parameters at any point.
1260 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1262 * Codec supports avctx->thread_count == 0 (auto).
1264 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1266 * Audio encoder supports receiving a different number of samples in each call.
1268 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1270 * Codec is intra only.
1272 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1274 * Codec is lossless.
1276 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1279 * HWAccel is experimental and is thus avoided in favor of non experimental
1282 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1283 #endif /* FF_API_WITHOUT_PREFIX */
1286 //The following defines may change, don't expect compatibility if you use them.
1287 #define MB_TYPE_INTRA4x4 0x0001
1288 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1289 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1290 #define MB_TYPE_16x16 0x0008
1291 #define MB_TYPE_16x8 0x0010
1292 #define MB_TYPE_8x16 0x0020
1293 #define MB_TYPE_8x8 0x0040
1294 #define MB_TYPE_INTERLACED 0x0080
1295 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1296 #define MB_TYPE_ACPRED 0x0200
1297 #define MB_TYPE_GMC 0x0400
1298 #define MB_TYPE_SKIP 0x0800
1299 #define MB_TYPE_P0L0 0x1000
1300 #define MB_TYPE_P1L0 0x2000
1301 #define MB_TYPE_P0L1 0x4000
1302 #define MB_TYPE_P1L1 0x8000
1303 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1304 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1305 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1306 #define MB_TYPE_QUANT 0x00010000
1307 #define MB_TYPE_CBP 0x00020000
1308 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1313 * This specifies the area which should be displayed.
1314 * Note there may be multiple such areas for one frame.
1316 typedef struct AVPanScan{
1319 * - encoding: Set by user.
1320 * - decoding: Set by libavcodec.
1325 * width and height in 1/16 pel
1326 * - encoding: Set by user.
1327 * - decoding: Set by libavcodec.
1333 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1334 * - encoding: Set by user.
1335 * - decoding: Set by libavcodec.
1337 int16_t position[3][2];
1341 * This structure describes the bitrate properties of an encoded bitstream. It
1342 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1343 * parameters for H.264/HEVC.
1345 typedef struct AVCPBProperties {
1347 * Maximum bitrate of the stream, in bits per second.
1348 * Zero if unknown or unspecified.
1352 * Minimum bitrate of the stream, in bits per second.
1353 * Zero if unknown or unspecified.
1357 * Average bitrate of the stream, in bits per second.
1358 * Zero if unknown or unspecified.
1363 * The size of the buffer to which the ratecontrol is applied, in bits.
1364 * Zero if unknown or unspecified.
1369 * The delay between the time the packet this structure is associated with
1370 * is received and the time when it should be decoded, in periods of a 27MHz
1373 * UINT64_MAX when unknown or unspecified.
1378 #if FF_API_QSCALE_TYPE
1379 #define FF_QSCALE_TYPE_MPEG1 0
1380 #define FF_QSCALE_TYPE_MPEG2 1
1381 #define FF_QSCALE_TYPE_H264 2
1382 #define FF_QSCALE_TYPE_VP56 3
1386 * The decoder will keep a reference to the frame and may reuse it later.
1388 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1391 * @defgroup lavc_packet AVPacket
1393 * Types and functions for working with AVPacket.
1396 enum AVPacketSideDataType {
1397 AV_PKT_DATA_PALETTE,
1400 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1401 * that the extradata buffer was changed and the receiving side should
1402 * act upon it appropriately. The new extradata is embedded in the side
1403 * data buffer and should be immediately used for processing the current
1406 AV_PKT_DATA_NEW_EXTRADATA,
1409 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1412 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1413 * s32le channel_count
1414 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1415 * u64le channel_layout
1416 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1418 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1423 AV_PKT_DATA_PARAM_CHANGE,
1426 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1427 * structures with info about macroblocks relevant to splitting the
1428 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1429 * That is, it does not necessarily contain info about all macroblocks,
1430 * as long as the distance between macroblocks in the info is smaller
1431 * than the target payload size.
1432 * Each MB info structure is 12 bytes, and is laid out as follows:
1434 * u32le bit offset from the start of the packet
1435 * u8 current quantizer at the start of the macroblock
1437 * u16le macroblock address within the GOB
1438 * u8 horizontal MV predictor
1439 * u8 vertical MV predictor
1440 * u8 horizontal MV predictor for block number 3
1441 * u8 vertical MV predictor for block number 3
1444 AV_PKT_DATA_H263_MB_INFO,
1447 * This side data should be associated with an audio stream and contains
1448 * ReplayGain information in form of the AVReplayGain struct.
1450 AV_PKT_DATA_REPLAYGAIN,
1453 * This side data contains a 3x3 transformation matrix describing an affine
1454 * transformation that needs to be applied to the decoded video frames for
1455 * correct presentation.
1457 * See libavutil/display.h for a detailed description of the data.
1459 AV_PKT_DATA_DISPLAYMATRIX,
1462 * This side data should be associated with a video stream and contains
1463 * Stereoscopic 3D information in form of the AVStereo3D struct.
1465 AV_PKT_DATA_STEREO3D,
1468 * This side data should be associated with an audio stream and corresponds
1469 * to enum AVAudioServiceType.
1471 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1474 * This side data contains quality related information from the encoder.
1476 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1480 * u64le[error count] sum of squared differences between encoder in and output
1483 AV_PKT_DATA_QUALITY_STATS,
1486 * This side data contains an integer value representing the stream index
1487 * of a "fallback" track. A fallback track indicates an alternate
1488 * track to use when the current track can not be decoded for some reason.
1489 * e.g. no decoder available for codec.
1491 AV_PKT_DATA_FALLBACK_TRACK,
1494 * This side data corresponds to the AVCPBProperties struct.
1496 AV_PKT_DATA_CPB_PROPERTIES,
1499 * Recommmends skipping the specified number of samples
1501 * u32le number of samples to skip from start of this packet
1502 * u32le number of samples to skip from end of this packet
1503 * u8 reason for start skip
1504 * u8 reason for end skip (0=padding silence, 1=convergence)
1507 AV_PKT_DATA_SKIP_SAMPLES=70,
1510 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1511 * the packet may contain "dual mono" audio specific to Japanese DTV
1512 * and if it is true, recommends only the selected channel to be used.
1514 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1517 AV_PKT_DATA_JP_DUALMONO,
1520 * A list of zero terminated key/value strings. There is no end marker for
1521 * the list, so it is required to rely on the side data size to stop.
1523 AV_PKT_DATA_STRINGS_METADATA,
1526 * Subtitle event position
1534 AV_PKT_DATA_SUBTITLE_POSITION,
1537 * Data found in BlockAdditional element of matroska container. There is
1538 * no end marker for the data, so it is required to rely on the side data
1539 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1542 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1545 * The optional first identifier line of a WebVTT cue.
1547 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1550 * The optional settings (rendering instructions) that immediately
1551 * follow the timestamp specifier of a WebVTT cue.
1553 AV_PKT_DATA_WEBVTT_SETTINGS,
1556 * A list of zero terminated key/value strings. There is no end marker for
1557 * the list, so it is required to rely on the side data size to stop. This
1558 * side data includes updated metadata which appeared in the stream.
1560 AV_PKT_DATA_METADATA_UPDATE,
1563 * MPEGTS stream ID, this is required to pass the stream ID
1564 * information from the demuxer to the corresponding muxer.
1566 AV_PKT_DATA_MPEGTS_STREAM_ID,
1569 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1570 * should be associated with a video stream and containts data in the form
1571 * of the AVMasteringDisplayMetadata struct.
1573 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1576 * This side data should be associated with a video stream and corresponds
1577 * to the AVSphericalMapping structure.
1579 AV_PKT_DATA_SPHERICAL,
1582 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1584 typedef struct AVPacketSideData {
1587 enum AVPacketSideDataType type;
1591 * This structure stores compressed data. It is typically exported by demuxers
1592 * and then passed as input to decoders, or received as output from encoders and
1593 * then passed to muxers.
1595 * For video, it should typically contain one compressed frame. For audio it may
1596 * contain several compressed frames. Encoders are allowed to output empty
1597 * packets, with no compressed data, containing only side data
1598 * (e.g. to update some stream parameters at the end of encoding).
1600 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1601 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1602 * without libavcodec and libavformat major bump.
1604 * The semantics of data ownership depends on the buf field.
1605 * If it is set, the packet data is dynamically allocated and is
1606 * valid indefinitely until a call to av_packet_unref() reduces the
1607 * reference count to 0.
1609 * If the buf field is not set av_packet_ref() would make a copy instead
1610 * of increasing the reference count.
1612 * The side data is always allocated with av_malloc(), copied by
1613 * av_packet_ref() and freed by av_packet_unref().
1615 * @see av_packet_ref
1616 * @see av_packet_unref
1618 typedef struct AVPacket {
1620 * A reference to the reference-counted buffer where the packet data is
1622 * May be NULL, then the packet data is not reference-counted.
1626 * Presentation timestamp in AVStream->time_base units; the time at which
1627 * the decompressed packet will be presented to the user.
1628 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1629 * pts MUST be larger or equal to dts as presentation cannot happen before
1630 * decompression, unless one wants to view hex dumps. Some formats misuse
1631 * the terms dts and pts/cts to mean something different. Such timestamps
1632 * must be converted to true pts/dts before they are stored in AVPacket.
1636 * Decompression timestamp in AVStream->time_base units; the time at which
1637 * the packet is decompressed.
1638 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1645 * A combination of AV_PKT_FLAG values
1649 * Additional packet data that can be provided by the container.
1650 * Packet can contain several types of side information.
1652 AVPacketSideData *side_data;
1653 int side_data_elems;
1656 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1657 * Equals next_pts - this_pts in presentation order.
1661 int64_t pos; ///< byte position in stream, -1 if unknown
1663 #if FF_API_CONVERGENCE_DURATION
1665 * @deprecated Same as the duration field, but as int64_t. This was required
1666 * for Matroska subtitles, whose duration values could overflow when the
1667 * duration field was still an int.
1669 attribute_deprecated
1670 int64_t convergence_duration;
1673 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1674 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1676 * Flag is used to discard packets which are required to maintain valid
1677 * decoder state but are not required for output and should be dropped
1680 #define AV_PKT_FLAG_DISCARD 0x0004
1682 enum AVSideDataParamChangeFlags {
1683 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1684 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1685 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1686 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1692 struct AVCodecInternal;
1696 AV_FIELD_PROGRESSIVE,
1697 AV_FIELD_TT, //< Top coded_first, top displayed first
1698 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1699 AV_FIELD_TB, //< Top coded first, bottom displayed first
1700 AV_FIELD_BT, //< Bottom coded first, top displayed first
1704 * main external API structure.
1705 * New fields can be added to the end with minor version bumps.
1706 * Removal, reordering and changes to existing fields require a major
1708 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1710 * The name string for AVOptions options matches the associated command line
1711 * parameter name and can be found in libavcodec/options_table.h
1712 * The AVOption/command line parameter names differ in some cases from the C
1713 * structure field names for historic reasons or brevity.
1714 * sizeof(AVCodecContext) must not be used outside libav*.
1716 typedef struct AVCodecContext {
1718 * information on struct for av_log
1719 * - set by avcodec_alloc_context3
1721 const AVClass *av_class;
1722 int log_level_offset;
1724 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1725 const struct AVCodec *codec;
1726 #if FF_API_CODEC_NAME
1728 * @deprecated this field is not used for anything in libavcodec
1730 attribute_deprecated
1731 char codec_name[32];
1733 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1736 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1737 * This is used to work around some encoder bugs.
1738 * A demuxer should set this to what is stored in the field used to identify the codec.
1739 * If there are multiple such fields in a container then the demuxer should choose the one
1740 * which maximizes the information about the used codec.
1741 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1742 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1743 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1745 * - encoding: Set by user, if not then the default based on codec_id will be used.
1746 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1748 unsigned int codec_tag;
1750 #if FF_API_STREAM_CODEC_TAG
1752 * @deprecated this field is unused
1754 attribute_deprecated
1755 unsigned int stream_codec_tag;
1761 * Private context used for internal data.
1763 * Unlike priv_data, this is not codec-specific. It is used in general
1764 * libavcodec functions.
1766 struct AVCodecInternal *internal;
1769 * Private data of the user, can be used to carry app specific stuff.
1770 * - encoding: Set by user.
1771 * - decoding: Set by user.
1776 * the average bitrate
1777 * - encoding: Set by user; unused for constant quantizer encoding.
1778 * - decoding: Set by user, may be overwritten by libavcodec
1779 * if this info is available in the stream
1784 * number of bits the bitstream is allowed to diverge from the reference.
1785 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1786 * - encoding: Set by user; unused for constant quantizer encoding.
1787 * - decoding: unused
1789 int bit_rate_tolerance;
1792 * Global quality for codecs which cannot change it per frame.
1793 * This should be proportional to MPEG-1/2/4 qscale.
1794 * - encoding: Set by user.
1795 * - decoding: unused
1800 * - encoding: Set by user.
1801 * - decoding: unused
1803 int compression_level;
1804 #define FF_COMPRESSION_DEFAULT -1
1808 * - encoding: Set by user.
1809 * - decoding: Set by user.
1815 * - encoding: Set by user.
1816 * - decoding: Set by user.
1821 * some codecs need / can use extradata like Huffman tables.
1822 * MJPEG: Huffman tables
1823 * rv10: additional flags
1824 * MPEG-4: global headers (they can be in the bitstream or here)
1825 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1826 * than extradata_size to avoid problems if it is read with the bitstream reader.
1827 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1828 * - encoding: Set/allocated/freed by libavcodec.
1829 * - decoding: Set/allocated/freed by user.
1835 * This is the fundamental unit of time (in seconds) in terms
1836 * of which frame timestamps are represented. For fixed-fps content,
1837 * timebase should be 1/framerate and timestamp increments should be
1839 * This often, but not always is the inverse of the frame rate or field rate
1840 * for video. 1/time_base is not the average frame rate if the frame rate is not
1843 * Like containers, elementary streams also can store timestamps, 1/time_base
1844 * is the unit in which these timestamps are specified.
1845 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1846 * vop_time_increment_resolution and fixed_vop_rate
1847 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1849 * - encoding: MUST be set by user.
1850 * - decoding: the use of this field for decoding is deprecated.
1851 * Use framerate instead.
1853 AVRational time_base;
1856 * For some codecs, the time base is closer to the field rate than the frame rate.
1857 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1858 * if no telecine is used ...
1860 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1862 int ticks_per_frame;
1867 * Encoding: Number of frames delay there will be from the encoder input to
1868 * the decoder output. (we assume the decoder matches the spec)
1869 * Decoding: Number of frames delay in addition to what a standard decoder
1870 * as specified in the spec would produce.
1873 * Number of frames the decoded output will be delayed relative to the
1877 * For encoding, this field is unused (see initial_padding).
1879 * For decoding, this is the number of samples the decoder needs to
1880 * output before the decoder's output is valid. When seeking, you should
1881 * start decoding this many samples prior to your desired seek point.
1883 * - encoding: Set by libavcodec.
1884 * - decoding: Set by libavcodec.
1891 * picture width / height.
1893 * @note Those fields may not match the values of the last
1894 * AVFrame output by avcodec_decode_video2 due frame
1897 * - encoding: MUST be set by user.
1898 * - decoding: May be set by the user before opening the decoder if known e.g.
1899 * from the container. Some decoders will require the dimensions
1900 * to be set by the caller. During decoding, the decoder may
1901 * overwrite those values as required while parsing the data.
1906 * Bitstream width / height, may be different from width/height e.g. when
1907 * the decoded frame is cropped before being output or lowres is enabled.
1909 * @note Those field may not match the value of the last
1910 * AVFrame output by avcodec_receive_frame() due frame
1913 * - encoding: unused
1914 * - decoding: May be set by the user before opening the decoder if known
1915 * e.g. from the container. During decoding, the decoder may
1916 * overwrite those values as required while parsing the data.
1918 int coded_width, coded_height;
1920 #if FF_API_ASPECT_EXTENDED
1921 #define FF_ASPECT_EXTENDED 15
1925 * the number of pictures in a group of pictures, or 0 for intra_only
1926 * - encoding: Set by user.
1927 * - decoding: unused
1932 * Pixel format, see AV_PIX_FMT_xxx.
1933 * May be set by the demuxer if known from headers.
1934 * May be overridden by the decoder if it knows better.
1936 * @note This field may not match the value of the last
1937 * AVFrame output by avcodec_receive_frame() due frame
1940 * - encoding: Set by user.
1941 * - decoding: Set by user if known, overridden by libavcodec while
1944 enum AVPixelFormat pix_fmt;
1946 #if FF_API_MOTION_EST
1948 * This option does nothing
1949 * @deprecated use codec private options instead
1951 attribute_deprecated int me_method;
1955 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1956 * decoder to draw a horizontal band. It improves cache usage. Not
1957 * all codecs can do that. You must check the codec capabilities
1959 * When multithreading is used, it may be called from multiple threads
1960 * at the same time; threads might draw different parts of the same AVFrame,
1961 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1963 * The function is also used by hardware acceleration APIs.
1964 * It is called at least once during frame decoding to pass
1965 * the data needed for hardware render.
1966 * In that mode instead of pixel data, AVFrame points to
1967 * a structure specific to the acceleration API. The application
1968 * reads the structure and can change some fields to indicate progress
1970 * - encoding: unused
1971 * - decoding: Set by user.
1972 * @param height the height of the slice
1973 * @param y the y position of the slice
1974 * @param type 1->top field, 2->bottom field, 3->frame
1975 * @param offset offset into the AVFrame.data from which the slice should be read
1977 void (*draw_horiz_band)(struct AVCodecContext *s,
1978 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1979 int y, int type, int height);
1982 * callback to negotiate the pixelFormat
1983 * @param fmt is the list of formats which are supported by the codec,
1984 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1985 * The first is always the native one.
1986 * @note The callback may be called again immediately if initialization for
1987 * the selected (hardware-accelerated) pixel format failed.
1988 * @warning Behavior is undefined if the callback returns a value not
1989 * in the fmt list of formats.
1990 * @return the chosen format
1991 * - encoding: unused
1992 * - decoding: Set by user, if not set the native format will be chosen.
1994 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1997 * maximum number of B-frames between non-B-frames
1998 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1999 * - encoding: Set by user.
2000 * - decoding: unused
2005 * qscale factor between IP and B-frames
2006 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
2007 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2008 * - encoding: Set by user.
2009 * - decoding: unused
2011 float b_quant_factor;
2013 #if FF_API_RC_STRATEGY
2014 /** @deprecated use codec private option instead */
2015 attribute_deprecated int rc_strategy;
2016 #define FF_RC_STRATEGY_XVID 1
2019 #if FF_API_PRIVATE_OPT
2020 /** @deprecated use encoder private options instead */
2021 attribute_deprecated
2022 int b_frame_strategy;
2026 * qscale offset between IP and B-frames
2027 * - encoding: Set by user.
2028 * - decoding: unused
2030 float b_quant_offset;
2033 * Size of the frame reordering buffer in the decoder.
2034 * For MPEG-2 it is 1 IPB or 0 low delay IP.
2035 * - encoding: Set by libavcodec.
2036 * - decoding: Set by libavcodec.
2040 #if FF_API_PRIVATE_OPT
2041 /** @deprecated use encoder private options instead */
2042 attribute_deprecated
2047 * qscale factor between P- and I-frames
2048 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2049 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2050 * - encoding: Set by user.
2051 * - decoding: unused
2053 float i_quant_factor;
2056 * qscale offset between P and I-frames
2057 * - encoding: Set by user.
2058 * - decoding: unused
2060 float i_quant_offset;
2063 * luminance masking (0-> disabled)
2064 * - encoding: Set by user.
2065 * - decoding: unused
2070 * temporary complexity masking (0-> disabled)
2071 * - encoding: Set by user.
2072 * - decoding: unused
2074 float temporal_cplx_masking;
2077 * spatial complexity masking (0-> disabled)
2078 * - encoding: Set by user.
2079 * - decoding: unused
2081 float spatial_cplx_masking;
2084 * p block masking (0-> disabled)
2085 * - encoding: Set by user.
2086 * - decoding: unused
2091 * darkness masking (0-> disabled)
2092 * - encoding: Set by user.
2093 * - decoding: unused
2099 * - encoding: Set by libavcodec.
2100 * - decoding: Set by user (or 0).
2104 #if FF_API_PRIVATE_OPT
2105 /** @deprecated use encoder private options instead */
2106 attribute_deprecated
2107 int prediction_method;
2108 #define FF_PRED_LEFT 0
2109 #define FF_PRED_PLANE 1
2110 #define FF_PRED_MEDIAN 2
2114 * slice offsets in the frame in bytes
2115 * - encoding: Set/allocated by libavcodec.
2116 * - decoding: Set/allocated by user (or NULL).
2121 * sample aspect ratio (0 if unknown)
2122 * That is the width of a pixel divided by the height of the pixel.
2123 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2124 * - encoding: Set by user.
2125 * - decoding: Set by libavcodec.
2127 AVRational sample_aspect_ratio;
2130 * motion estimation comparison function
2131 * - encoding: Set by user.
2132 * - decoding: unused
2136 * subpixel motion estimation comparison function
2137 * - encoding: Set by user.
2138 * - decoding: unused
2142 * macroblock comparison function (not supported yet)
2143 * - encoding: Set by user.
2144 * - decoding: unused
2148 * interlaced DCT comparison function
2149 * - encoding: Set by user.
2150 * - decoding: unused
2153 #define FF_CMP_SAD 0
2154 #define FF_CMP_SSE 1
2155 #define FF_CMP_SATD 2
2156 #define FF_CMP_DCT 3
2157 #define FF_CMP_PSNR 4
2158 #define FF_CMP_BIT 5
2160 #define FF_CMP_ZERO 7
2161 #define FF_CMP_VSAD 8
2162 #define FF_CMP_VSSE 9
2163 #define FF_CMP_NSSE 10
2164 #define FF_CMP_W53 11
2165 #define FF_CMP_W97 12
2166 #define FF_CMP_DCTMAX 13
2167 #define FF_CMP_DCT264 14
2168 #define FF_CMP_MEDIAN_SAD 15
2169 #define FF_CMP_CHROMA 256
2172 * ME diamond size & shape
2173 * - encoding: Set by user.
2174 * - decoding: unused
2179 * amount of previous MV predictors (2a+1 x 2a+1 square)
2180 * - encoding: Set by user.
2181 * - decoding: unused
2183 int last_predictor_count;
2185 #if FF_API_PRIVATE_OPT
2186 /** @deprecated use encoder private options instead */
2187 attribute_deprecated
2192 * motion estimation prepass comparison function
2193 * - encoding: Set by user.
2194 * - decoding: unused
2199 * ME prepass diamond size & shape
2200 * - encoding: Set by user.
2201 * - decoding: unused
2207 * - encoding: Set by user.
2208 * - decoding: unused
2210 int me_subpel_quality;
2214 * DTG active format information (additional aspect ratio
2215 * information only used in DVB MPEG-2 transport streams)
2218 * - encoding: unused
2219 * - decoding: Set by decoder.
2220 * @deprecated Deprecated in favor of AVSideData
2222 attribute_deprecated int dtg_active_format;
2223 #define FF_DTG_AFD_SAME 8
2224 #define FF_DTG_AFD_4_3 9
2225 #define FF_DTG_AFD_16_9 10
2226 #define FF_DTG_AFD_14_9 11
2227 #define FF_DTG_AFD_4_3_SP_14_9 13
2228 #define FF_DTG_AFD_16_9_SP_14_9 14
2229 #define FF_DTG_AFD_SP_4_3 15
2230 #endif /* FF_API_AFD */
2233 * maximum motion estimation search range in subpel units
2234 * If 0 then no limit.
2236 * - encoding: Set by user.
2237 * - decoding: unused
2241 #if FF_API_QUANT_BIAS
2243 * @deprecated use encoder private option instead
2245 attribute_deprecated int intra_quant_bias;
2246 #define FF_DEFAULT_QUANT_BIAS 999999
2249 * @deprecated use encoder private option instead
2251 attribute_deprecated int inter_quant_bias;
2256 * - encoding: unused
2257 * - decoding: Set by user.
2260 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2261 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2262 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2266 * XVideo Motion Acceleration
2267 * - encoding: forbidden
2268 * - decoding: set by decoder
2269 * @deprecated XvMC doesn't need it anymore.
2271 attribute_deprecated int xvmc_acceleration;
2272 #endif /* FF_API_XVMC */
2275 * macroblock decision mode
2276 * - encoding: Set by user.
2277 * - decoding: unused
2280 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2281 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2282 #define FF_MB_DECISION_RD 2 ///< rate distortion
2285 * custom intra quantization matrix
2286 * - encoding: Set by user, can be NULL.
2287 * - decoding: Set by libavcodec.
2289 uint16_t *intra_matrix;
2292 * custom inter quantization matrix
2293 * - encoding: Set by user, can be NULL.
2294 * - decoding: Set by libavcodec.
2296 uint16_t *inter_matrix;
2298 #if FF_API_PRIVATE_OPT
2299 /** @deprecated use encoder private options instead */
2300 attribute_deprecated
2301 int scenechange_threshold;
2303 /** @deprecated use encoder private options instead */
2304 attribute_deprecated
2305 int noise_reduction;
2310 * @deprecated this field is unused
2312 attribute_deprecated
2316 * @deprecated this field is unused
2318 attribute_deprecated
2323 * precision of the intra DC coefficient - 8
2324 * - encoding: Set by user.
2325 * - decoding: Set by libavcodec
2327 int intra_dc_precision;
2330 * Number of macroblock rows at the top which are skipped.
2331 * - encoding: unused
2332 * - decoding: Set by user.
2337 * Number of macroblock rows at the bottom which are skipped.
2338 * - encoding: unused
2339 * - decoding: Set by user.
2345 * @deprecated use encoder private options instead
2347 attribute_deprecated
2348 float border_masking;
2352 * minimum MB Lagrange multiplier
2353 * - encoding: Set by user.
2354 * - decoding: unused
2359 * maximum MB Lagrange multiplier
2360 * - encoding: Set by user.
2361 * - decoding: unused
2365 #if FF_API_PRIVATE_OPT
2367 * @deprecated use encoder private options instead
2369 attribute_deprecated
2370 int me_penalty_compensation;
2374 * - encoding: Set by user.
2375 * - decoding: unused
2379 #if FF_API_PRIVATE_OPT
2380 /** @deprecated use encoder private options instead */
2381 attribute_deprecated
2387 * - encoding: Set by user.
2388 * - decoding: unused
2393 * number of reference frames
2394 * - encoding: Set by user.
2395 * - decoding: Set by lavc.
2399 #if FF_API_PRIVATE_OPT
2400 /** @deprecated use encoder private options instead */
2401 attribute_deprecated
2405 #if FF_API_UNUSED_MEMBERS
2407 * Multiplied by qscale for each frame and added to scene_change_score.
2408 * - encoding: Set by user.
2409 * - decoding: unused
2411 attribute_deprecated int scenechange_factor;
2415 * Note: Value depends upon the compare function used for fullpel ME.
2416 * - encoding: Set by user.
2417 * - decoding: unused
2421 #if FF_API_PRIVATE_OPT
2422 /** @deprecated use encoder private options instead */
2423 attribute_deprecated
2428 * Chromaticity coordinates of the source primaries.
2429 * - encoding: Set by user
2430 * - decoding: Set by libavcodec
2432 enum AVColorPrimaries color_primaries;
2435 * Color Transfer Characteristic.
2436 * - encoding: Set by user
2437 * - decoding: Set by libavcodec
2439 enum AVColorTransferCharacteristic color_trc;
2442 * YUV colorspace type.
2443 * - encoding: Set by user
2444 * - decoding: Set by libavcodec
2446 enum AVColorSpace colorspace;
2449 * MPEG vs JPEG YUV range.
2450 * - encoding: Set by user
2451 * - decoding: Set by libavcodec
2453 enum AVColorRange color_range;
2456 * This defines the location of chroma samples.
2457 * - encoding: Set by user
2458 * - decoding: Set by libavcodec
2460 enum AVChromaLocation chroma_sample_location;
2464 * Indicates number of picture subdivisions. Used for parallelized
2466 * - encoding: Set by user
2467 * - decoding: unused
2472 * - encoding: set by libavcodec
2473 * - decoding: Set by user.
2475 enum AVFieldOrder field_order;
2478 int sample_rate; ///< samples per second
2479 int channels; ///< number of audio channels
2482 * audio sample format
2483 * - encoding: Set by user.
2484 * - decoding: Set by libavcodec.
2486 enum AVSampleFormat sample_fmt; ///< sample format
2488 /* The following data should not be initialized. */
2490 * Number of samples per channel in an audio frame.
2492 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2493 * except the last must contain exactly frame_size samples per channel.
2494 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2495 * frame size is not restricted.
2496 * - decoding: may be set by some decoders to indicate constant frame size
2501 * Frame counter, set by libavcodec.
2503 * - decoding: total number of frames returned from the decoder so far.
2504 * - encoding: total number of frames passed to the encoder so far.
2506 * @note the counter is not incremented if encoding/decoding resulted in
2512 * number of bytes per packet if constant and known or 0
2513 * Used by some WAV based audio codecs.
2518 * Audio cutoff bandwidth (0 means "automatic")
2519 * - encoding: Set by user.
2520 * - decoding: unused
2525 * Audio channel layout.
2526 * - encoding: set by user.
2527 * - decoding: set by user, may be overwritten by libavcodec.
2529 uint64_t channel_layout;
2532 * Request decoder to use this channel layout if it can (0 for default)
2533 * - encoding: unused
2534 * - decoding: Set by user.
2536 uint64_t request_channel_layout;
2539 * Type of service that the audio stream conveys.
2540 * - encoding: Set by user.
2541 * - decoding: Set by libavcodec.
2543 enum AVAudioServiceType audio_service_type;
2546 * desired sample format
2547 * - encoding: Not used.
2548 * - decoding: Set by user.
2549 * Decoder will decode to this format if it can.
2551 enum AVSampleFormat request_sample_fmt;
2554 * This callback is called at the beginning of each frame to get data
2555 * buffer(s) for it. There may be one contiguous buffer for all the data or
2556 * there may be a buffer per each data plane or anything in between. What
2557 * this means is, you may set however many entries in buf[] you feel necessary.
2558 * Each buffer must be reference-counted using the AVBuffer API (see description
2561 * The following fields will be set in the frame before this callback is
2564 * - width, height (video only)
2565 * - sample_rate, channel_layout, nb_samples (audio only)
2566 * Their values may differ from the corresponding values in
2567 * AVCodecContext. This callback must use the frame values, not the codec
2568 * context values, to calculate the required buffer size.
2570 * This callback must fill the following fields in the frame:
2574 * * if the data is planar audio with more than 8 channels, then this
2575 * callback must allocate and fill extended_data to contain all pointers
2576 * to all data planes. data[] must hold as many pointers as it can.
2577 * extended_data must be allocated with av_malloc() and will be freed in
2579 * * otherwise extended_data must point to data
2580 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2581 * the frame's data and extended_data pointers must be contained in these. That
2582 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2583 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2584 * and av_buffer_ref().
2585 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2586 * this callback and filled with the extra buffers if there are more
2587 * buffers than buf[] can hold. extended_buf will be freed in
2590 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2591 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2594 * Each data plane must be aligned to the maximum required by the target
2597 * @see avcodec_default_get_buffer2()
2601 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2602 * (read and/or written to if it is writable) later by libavcodec.
2604 * avcodec_align_dimensions2() should be used to find the required width and
2605 * height, as they normally need to be rounded up to the next multiple of 16.
2607 * Some decoders do not support linesizes changing between frames.
2609 * If frame multithreading is used and thread_safe_callbacks is set,
2610 * this callback may be called from a different thread, but not from more
2611 * than one at once. Does not need to be reentrant.
2613 * @see avcodec_align_dimensions2()
2617 * Decoders request a buffer of a particular size by setting
2618 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2619 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2620 * to a smaller value in the output frame.
2622 * As a convenience, av_samples_get_buffer_size() and
2623 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2624 * functions to find the required data size and to fill data pointers and
2625 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2626 * since all planes must be the same size.
2628 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2630 * - encoding: unused
2631 * - decoding: Set by libavcodec, user can override.
2633 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2636 * If non-zero, the decoded audio and video frames returned from
2637 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2638 * and are valid indefinitely. The caller must free them with
2639 * av_frame_unref() when they are not needed anymore.
2640 * Otherwise, the decoded frames must not be freed by the caller and are
2641 * only valid until the next decode call.
2643 * This is always automatically enabled if avcodec_receive_frame() is used.
2645 * - encoding: unused
2646 * - decoding: set by the caller before avcodec_open2().
2648 int refcounted_frames;
2650 /* - encoding parameters */
2651 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2652 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2656 * - encoding: Set by user.
2657 * - decoding: unused
2663 * - encoding: Set by user.
2664 * - decoding: unused
2669 * maximum quantizer difference between frames
2670 * - encoding: Set by user.
2671 * - decoding: unused
2677 * @deprecated use encoder private options instead
2679 attribute_deprecated
2682 attribute_deprecated
2684 attribute_deprecated
2689 * decoder bitstream buffer size
2690 * - encoding: Set by user.
2691 * - decoding: unused
2696 * ratecontrol override, see RcOverride
2697 * - encoding: Allocated/set/freed by user.
2698 * - decoding: unused
2700 int rc_override_count;
2701 RcOverride *rc_override;
2705 * @deprecated use encoder private options instead
2707 attribute_deprecated
2713 * - encoding: Set by user.
2714 * - decoding: Set by user, may be overwritten by libavcodec.
2716 int64_t rc_max_rate;
2720 * - encoding: Set by user.
2721 * - decoding: unused
2723 int64_t rc_min_rate;
2727 * @deprecated use encoder private options instead
2729 attribute_deprecated
2730 float rc_buffer_aggressivity;
2732 attribute_deprecated
2733 float rc_initial_cplx;
2737 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2738 * - encoding: Set by user.
2739 * - decoding: unused.
2741 float rc_max_available_vbv_use;
2744 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2745 * - encoding: Set by user.
2746 * - decoding: unused.
2748 float rc_min_vbv_overflow_use;
2751 * Number of bits which should be loaded into the rc buffer before decoding starts.
2752 * - encoding: Set by user.
2753 * - decoding: unused
2755 int rc_initial_buffer_occupancy;
2757 #if FF_API_CODER_TYPE
2758 #define FF_CODER_TYPE_VLC 0
2759 #define FF_CODER_TYPE_AC 1
2760 #define FF_CODER_TYPE_RAW 2
2761 #define FF_CODER_TYPE_RLE 3
2762 #if FF_API_UNUSED_MEMBERS
2763 #define FF_CODER_TYPE_DEFLATE 4
2764 #endif /* FF_API_UNUSED_MEMBERS */
2766 * @deprecated use encoder private options instead
2768 attribute_deprecated
2770 #endif /* FF_API_CODER_TYPE */
2772 #if FF_API_PRIVATE_OPT
2773 /** @deprecated use encoder private options instead */
2774 attribute_deprecated
2780 * @deprecated use encoder private options instead
2782 attribute_deprecated
2786 * @deprecated use encoder private options instead
2788 attribute_deprecated
2792 #if FF_API_PRIVATE_OPT
2793 /** @deprecated use encoder private options instead */
2794 attribute_deprecated
2795 int frame_skip_threshold;
2797 /** @deprecated use encoder private options instead */
2798 attribute_deprecated
2799 int frame_skip_factor;
2801 /** @deprecated use encoder private options instead */
2802 attribute_deprecated
2805 /** @deprecated use encoder private options instead */
2806 attribute_deprecated
2808 #endif /* FF_API_PRIVATE_OPT */
2811 * trellis RD quantization
2812 * - encoding: Set by user.
2813 * - decoding: unused
2817 #if FF_API_PRIVATE_OPT
2818 /** @deprecated use encoder private options instead */
2819 attribute_deprecated
2820 int min_prediction_order;
2822 /** @deprecated use encoder private options instead */
2823 attribute_deprecated
2824 int max_prediction_order;
2826 /** @deprecated use encoder private options instead */
2827 attribute_deprecated
2828 int64_t timecode_frame_start;
2831 #if FF_API_RTP_CALLBACK
2833 * @deprecated unused
2835 /* The RTP callback: This function is called */
2836 /* every time the encoder has a packet to send. */
2837 /* It depends on the encoder if the data starts */
2838 /* with a Start Code (it should). H.263 does. */
2839 /* mb_nb contains the number of macroblocks */
2840 /* encoded in the RTP payload. */
2841 attribute_deprecated
2842 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2845 #if FF_API_PRIVATE_OPT
2846 /** @deprecated use encoder private options instead */
2847 attribute_deprecated
2848 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2849 /* do its best to deliver a chunk with size */
2850 /* below rtp_payload_size, the chunk will start */
2851 /* with a start code on some codecs like H.263. */
2852 /* This doesn't take account of any particular */
2853 /* headers inside the transmitted RTP payload. */
2856 #if FF_API_STAT_BITS
2857 /* statistics, used for 2-pass encoding */
2858 attribute_deprecated
2860 attribute_deprecated
2862 attribute_deprecated
2864 attribute_deprecated
2866 attribute_deprecated
2868 attribute_deprecated
2870 attribute_deprecated
2872 attribute_deprecated
2875 /** @deprecated this field is unused */
2876 attribute_deprecated
2881 * pass1 encoding statistics output buffer
2882 * - encoding: Set by libavcodec.
2883 * - decoding: unused
2888 * pass2 encoding statistics input buffer
2889 * Concatenated stuff from stats_out of pass1 should be placed here.
2890 * - encoding: Allocated/set/freed by user.
2891 * - decoding: unused
2896 * Work around bugs in encoders which sometimes cannot be detected automatically.
2897 * - encoding: Set by user
2898 * - decoding: Set by user
2900 int workaround_bugs;
2901 #define FF_BUG_AUTODETECT 1 ///< autodetection
2902 #if FF_API_OLD_MSMPEG4
2903 #define FF_BUG_OLD_MSMPEG4 2
2905 #define FF_BUG_XVID_ILACE 4
2906 #define FF_BUG_UMP4 8
2907 #define FF_BUG_NO_PADDING 16
2908 #define FF_BUG_AMV 32
2910 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2912 #define FF_BUG_QPEL_CHROMA 64
2913 #define FF_BUG_STD_QPEL 128
2914 #define FF_BUG_QPEL_CHROMA2 256
2915 #define FF_BUG_DIRECT_BLOCKSIZE 512
2916 #define FF_BUG_EDGE 1024
2917 #define FF_BUG_HPEL_CHROMA 2048
2918 #define FF_BUG_DC_CLIP 4096
2919 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2920 #define FF_BUG_TRUNCATED 16384
2921 #define FF_BUG_IEDGE 32768
2924 * strictly follow the standard (MPEG-4, ...).
2925 * - encoding: Set by user.
2926 * - decoding: Set by user.
2927 * Setting this to STRICT or higher means the encoder and decoder will
2928 * generally do stupid things, whereas setting it to unofficial or lower
2929 * will mean the encoder might produce output that is not supported by all
2930 * spec-compliant decoders. Decoders don't differentiate between normal,
2931 * unofficial and experimental (that is, they always try to decode things
2932 * when they can) unless they are explicitly asked to behave stupidly
2933 * (=strictly conform to the specs)
2935 int strict_std_compliance;
2936 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2937 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2938 #define FF_COMPLIANCE_NORMAL 0
2939 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2940 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2943 * error concealment flags
2944 * - encoding: unused
2945 * - decoding: Set by user.
2947 int error_concealment;
2948 #define FF_EC_GUESS_MVS 1
2949 #define FF_EC_DEBLOCK 2
2950 #define FF_EC_FAVOR_INTER 256
2954 * - encoding: Set by user.
2955 * - decoding: Set by user.
2958 #define FF_DEBUG_PICT_INFO 1
2959 #define FF_DEBUG_RC 2
2960 #define FF_DEBUG_BITSTREAM 4
2961 #define FF_DEBUG_MB_TYPE 8
2962 #define FF_DEBUG_QP 16
2965 * @deprecated this option does nothing
2967 #define FF_DEBUG_MV 32
2969 #define FF_DEBUG_DCT_COEFF 0x00000040
2970 #define FF_DEBUG_SKIP 0x00000080
2971 #define FF_DEBUG_STARTCODE 0x00000100
2972 #if FF_API_UNUSED_MEMBERS
2973 #define FF_DEBUG_PTS 0x00000200
2974 #endif /* FF_API_UNUSED_MEMBERS */
2975 #define FF_DEBUG_ER 0x00000400
2976 #define FF_DEBUG_MMCO 0x00000800
2977 #define FF_DEBUG_BUGS 0x00001000
2979 #define FF_DEBUG_VIS_QP 0x00002000
2980 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2982 #define FF_DEBUG_BUFFERS 0x00008000
2983 #define FF_DEBUG_THREADS 0x00010000
2984 #define FF_DEBUG_GREEN_MD 0x00800000
2985 #define FF_DEBUG_NOMC 0x01000000
2990 * - encoding: Set by user.
2991 * - decoding: Set by user.
2994 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2995 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2996 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
3000 * Error recognition; may misdetect some more or less valid parts as errors.
3001 * - encoding: unused
3002 * - decoding: Set by user.
3004 int err_recognition;
3007 * Verify checksums embedded in the bitstream (could be of either encoded or
3008 * decoded data, depending on the codec) and print an error message on mismatch.
3009 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
3010 * decoder returning an error.
3012 #define AV_EF_CRCCHECK (1<<0)
3013 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
3014 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
3015 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
3017 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
3018 #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
3019 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
3020 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
3024 * opaque 64-bit number (generally a PTS) that will be reordered and
3025 * output in AVFrame.reordered_opaque
3026 * - encoding: unused
3027 * - decoding: Set by user.
3029 int64_t reordered_opaque;
3032 * Hardware accelerator in use
3033 * - encoding: unused.
3034 * - decoding: Set by libavcodec
3036 struct AVHWAccel *hwaccel;
3039 * Hardware accelerator context.
3040 * For some hardware accelerators, a global context needs to be
3041 * provided by the user. In that case, this holds display-dependent
3042 * data FFmpeg cannot instantiate itself. Please refer to the
3043 * FFmpeg HW accelerator documentation to know how to fill this
3044 * is. e.g. for VA API, this is a struct vaapi_context.
3045 * - encoding: unused
3046 * - decoding: Set by user
3048 void *hwaccel_context;
3052 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3053 * - decoding: unused
3055 uint64_t error[AV_NUM_DATA_POINTERS];
3058 * DCT algorithm, see FF_DCT_* below
3059 * - encoding: Set by user.
3060 * - decoding: unused
3063 #define FF_DCT_AUTO 0
3064 #define FF_DCT_FASTINT 1
3065 #define FF_DCT_INT 2
3066 #define FF_DCT_MMX 3
3067 #define FF_DCT_ALTIVEC 5
3068 #define FF_DCT_FAAN 6
3071 * IDCT algorithm, see FF_IDCT_* below.
3072 * - encoding: Set by user.
3073 * - decoding: Set by user.
3076 #define FF_IDCT_AUTO 0
3077 #define FF_IDCT_INT 1
3078 #define FF_IDCT_SIMPLE 2
3079 #define FF_IDCT_SIMPLEMMX 3
3080 #define FF_IDCT_ARM 7
3081 #define FF_IDCT_ALTIVEC 8
3083 #define FF_IDCT_SH4 9
3085 #define FF_IDCT_SIMPLEARM 10
3086 #if FF_API_UNUSED_MEMBERS
3087 #define FF_IDCT_IPP 13
3088 #endif /* FF_API_UNUSED_MEMBERS */
3089 #define FF_IDCT_XVID 14
3090 #if FF_API_IDCT_XVIDMMX
3091 #define FF_IDCT_XVIDMMX 14
3092 #endif /* FF_API_IDCT_XVIDMMX */
3093 #define FF_IDCT_SIMPLEARMV5TE 16
3094 #define FF_IDCT_SIMPLEARMV6 17
3095 #if FF_API_ARCH_SPARC
3096 #define FF_IDCT_SIMPLEVIS 18
3098 #define FF_IDCT_FAAN 20
3099 #define FF_IDCT_SIMPLENEON 22
3100 #if FF_API_ARCH_ALPHA
3101 #define FF_IDCT_SIMPLEALPHA 23
3103 #define FF_IDCT_SIMPLEAUTO 128
3106 * bits per sample/pixel from the demuxer (needed for huffyuv).
3107 * - encoding: Set by libavcodec.
3108 * - decoding: Set by user.
3110 int bits_per_coded_sample;
3113 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3114 * - encoding: set by user.
3115 * - decoding: set by libavcodec.
3117 int bits_per_raw_sample;
3121 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3122 * - encoding: unused
3123 * - decoding: Set by user.
3128 #if FF_API_CODED_FRAME
3130 * the picture in the bitstream
3131 * - encoding: Set by libavcodec.
3132 * - decoding: unused
3134 * @deprecated use the quality factor packet side data instead
3136 attribute_deprecated AVFrame *coded_frame;
3141 * is used to decide how many independent tasks should be passed to execute()
3142 * - encoding: Set by user.
3143 * - decoding: Set by user.
3148 * Which multithreading methods to use.
3149 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3150 * so clients which cannot provide future frames should not use it.
3152 * - encoding: Set by user, otherwise the default is used.
3153 * - decoding: Set by user, otherwise the default is used.
3156 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3157 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3160 * Which multithreading methods are in use by the codec.
3161 * - encoding: Set by libavcodec.
3162 * - decoding: Set by libavcodec.
3164 int active_thread_type;
3167 * Set by the client if its custom get_buffer() callback can be called
3168 * synchronously from another thread, which allows faster multithreaded decoding.
3169 * draw_horiz_band() will be called from other threads regardless of this setting.
3170 * Ignored if the default get_buffer() is used.
3171 * - encoding: Set by user.
3172 * - decoding: Set by user.
3174 int thread_safe_callbacks;
3177 * The codec may call this to execute several independent things.
3178 * It will return only after finishing all tasks.
3179 * The user may replace this with some multithreaded implementation,
3180 * the default implementation will execute the parts serially.
3181 * @param count the number of things to execute
3182 * - encoding: Set by libavcodec, user can override.
3183 * - decoding: Set by libavcodec, user can override.
3185 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3188 * The codec may call this to execute several independent things.
3189 * It will return only after finishing all tasks.
3190 * The user may replace this with some multithreaded implementation,
3191 * the default implementation will execute the parts serially.
3192 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3193 * @param c context passed also to func
3194 * @param count the number of things to execute
3195 * @param arg2 argument passed unchanged to func
3196 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3197 * @param func function that will be called count times, with jobnr from 0 to count-1.
3198 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3199 * two instances of func executing at the same time will have the same threadnr.
3200 * @return always 0 currently, but code should handle a future improvement where when any call to func
3201 * returns < 0 no further calls to func may be done and < 0 is returned.
3202 * - encoding: Set by libavcodec, user can override.
3203 * - decoding: Set by libavcodec, user can override.
3205 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3208 * noise vs. sse weight for the nsse comparison function
3209 * - encoding: Set by user.
3210 * - decoding: unused
3216 * - encoding: Set by user.
3217 * - decoding: Set by libavcodec.
3220 #define FF_PROFILE_UNKNOWN -99
3221 #define FF_PROFILE_RESERVED -100
3223 #define FF_PROFILE_AAC_MAIN 0
3224 #define FF_PROFILE_AAC_LOW 1
3225 #define FF_PROFILE_AAC_SSR 2
3226 #define FF_PROFILE_AAC_LTP 3
3227 #define FF_PROFILE_AAC_HE 4
3228 #define FF_PROFILE_AAC_HE_V2 28
3229 #define FF_PROFILE_AAC_LD 22
3230 #define FF_PROFILE_AAC_ELD 38
3231 #define FF_PROFILE_MPEG2_AAC_LOW 128
3232 #define FF_PROFILE_MPEG2_AAC_HE 131
3234 #define FF_PROFILE_DNXHD 0
3235 #define FF_PROFILE_DNXHR_LB 1
3236 #define FF_PROFILE_DNXHR_SQ 2
3237 #define FF_PROFILE_DNXHR_HQ 3
3238 #define FF_PROFILE_DNXHR_HQX 4
3239 #define FF_PROFILE_DNXHR_444 5
3241 #define FF_PROFILE_DTS 20
3242 #define FF_PROFILE_DTS_ES 30
3243 #define FF_PROFILE_DTS_96_24 40
3244 #define FF_PROFILE_DTS_HD_HRA 50
3245 #define FF_PROFILE_DTS_HD_MA 60
3246 #define FF_PROFILE_DTS_EXPRESS 70
3248 #define FF_PROFILE_MPEG2_422 0
3249 #define FF_PROFILE_MPEG2_HIGH 1
3250 #define FF_PROFILE_MPEG2_SS 2
3251 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3252 #define FF_PROFILE_MPEG2_MAIN 4
3253 #define FF_PROFILE_MPEG2_SIMPLE 5
3255 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3256 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3258 #define FF_PROFILE_H264_BASELINE 66
3259 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3260 #define FF_PROFILE_H264_MAIN 77
3261 #define FF_PROFILE_H264_EXTENDED 88
3262 #define FF_PROFILE_H264_HIGH 100
3263 #define FF_PROFILE_H264_HIGH_10 110
3264 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3265 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3266 #define FF_PROFILE_H264_HIGH_422 122
3267 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3268 #define FF_PROFILE_H264_STEREO_HIGH 128
3269 #define FF_PROFILE_H264_HIGH_444 144
3270 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3271 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3272 #define FF_PROFILE_H264_CAVLC_444 44
3274 #define FF_PROFILE_VC1_SIMPLE 0
3275 #define FF_PROFILE_VC1_MAIN 1
3276 #define FF_PROFILE_VC1_COMPLEX 2
3277 #define FF_PROFILE_VC1_ADVANCED 3
3279 #define FF_PROFILE_MPEG4_SIMPLE 0
3280 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3281 #define FF_PROFILE_MPEG4_CORE 2
3282 #define FF_PROFILE_MPEG4_MAIN 3
3283 #define FF_PROFILE_MPEG4_N_BIT 4
3284 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3285 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3286 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3287 #define FF_PROFILE_MPEG4_HYBRID 8
3288 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3289 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3290 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3291 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3292 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3293 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3294 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3296 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3297 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3298 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3299 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3300 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3302 #define FF_PROFILE_VP9_0 0
3303 #define FF_PROFILE_VP9_1 1
3304 #define FF_PROFILE_VP9_2 2
3305 #define FF_PROFILE_VP9_3 3
3307 #define FF_PROFILE_HEVC_MAIN 1
3308 #define FF_PROFILE_HEVC_MAIN_10 2
3309 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3310 #define FF_PROFILE_HEVC_REXT 4
3314 * - encoding: Set by user.
3315 * - decoding: Set by libavcodec.
3318 #define FF_LEVEL_UNKNOWN -99
3321 * Skip loop filtering for selected frames.
3322 * - encoding: unused
3323 * - decoding: Set by user.
3325 enum AVDiscard skip_loop_filter;
3328 * Skip IDCT/dequantization for selected frames.
3329 * - encoding: unused
3330 * - decoding: Set by user.
3332 enum AVDiscard skip_idct;
3335 * Skip decoding for selected frames.
3336 * - encoding: unused
3337 * - decoding: Set by user.
3339 enum AVDiscard skip_frame;
3342 * Header containing style information for text subtitles.
3343 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3344 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3345 * the Format line following. It shouldn't include any Dialogue line.
3346 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3347 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3349 uint8_t *subtitle_header;
3350 int subtitle_header_size;
3352 #if FF_API_ERROR_RATE
3354 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3357 attribute_deprecated
3361 #if FF_API_VBV_DELAY
3363 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3364 * Used for compliant TS muxing.
3365 * - encoding: Set by libavcodec.
3366 * - decoding: unused.
3367 * @deprecated this value is now exported as a part of
3368 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3370 attribute_deprecated
3374 #if FF_API_SIDEDATA_ONLY_PKT
3376 * Encoding only and set by default. Allow encoders to output packets
3377 * that do not contain any encoded data, only side data.
3379 * Some encoders need to output such packets, e.g. to update some stream
3380 * parameters at the end of encoding.
3382 * @deprecated this field disables the default behaviour and
3383 * it is kept only for compatibility.
3385 attribute_deprecated
3386 int side_data_only_packets;
3390 * Audio only. The number of "priming" samples (padding) inserted by the
3391 * encoder at the beginning of the audio. I.e. this number of leading
3392 * decoded samples must be discarded by the caller to get the original audio
3393 * without leading padding.
3395 * - decoding: unused
3396 * - encoding: Set by libavcodec. The timestamps on the output packets are
3397 * adjusted by the encoder so that they always refer to the
3398 * first sample of the data actually contained in the packet,
3399 * including any added padding. E.g. if the timebase is
3400 * 1/samplerate and the timestamp of the first input sample is
3401 * 0, the timestamp of the first output packet will be
3404 int initial_padding;
3407 * - decoding: For codecs that store a framerate value in the compressed
3408 * bitstream, the decoder may export it here. { 0, 1} when
3410 * - encoding: May be used to signal the framerate of CFR content to an
3413 AVRational framerate;
3416 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3417 * - encoding: unused.
3418 * - decoding: Set by libavcodec before calling get_format()
3420 enum AVPixelFormat sw_pix_fmt;
3423 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3424 * - encoding unused.
3425 * - decoding set by user.
3427 AVRational pkt_timebase;
3431 * - encoding: unused.
3432 * - decoding: set by libavcodec.
3434 const AVCodecDescriptor *codec_descriptor;
3438 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3439 * - encoding: unused
3440 * - decoding: Set by user.
3446 * Current statistics for PTS correction.
3447 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3448 * - encoding: unused
3450 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3451 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3452 int64_t pts_correction_last_pts; /// PTS of the last frame
3453 int64_t pts_correction_last_dts; /// DTS of the last frame
3456 * Character encoding of the input subtitles file.
3457 * - decoding: set by user
3458 * - encoding: unused
3463 * Subtitles character encoding mode. Formats or codecs might be adjusting
3464 * this setting (if they are doing the conversion themselves for instance).
3465 * - decoding: set by libavcodec
3466 * - encoding: unused
3468 int sub_charenc_mode;
3469 #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)
3470 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3471 #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
3474 * Skip processing alpha if supported by codec.
3475 * Note that if the format uses pre-multiplied alpha (common with VP6,
3476 * and recommended due to better video quality/compression)
3477 * the image will look as if alpha-blended onto a black background.
3478 * However for formats that do not use pre-multiplied alpha
3479 * there might be serious artefacts (though e.g. libswscale currently
3480 * assumes pre-multiplied alpha anyway).
3482 * - decoding: set by user
3483 * - encoding: unused
3488 * Number of samples to skip after a discontinuity
3489 * - decoding: unused
3490 * - encoding: set by libavcodec
3494 #if !FF_API_DEBUG_MV
3496 * debug motion vectors
3497 * - encoding: Set by user.
3498 * - decoding: Set by user.
3501 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3502 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3503 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3507 * custom intra quantization matrix
3508 * - encoding: Set by user, can be NULL.
3509 * - decoding: unused.
3511 uint16_t *chroma_intra_matrix;
3514 * dump format separator.
3515 * can be ", " or "\n " or anything else
3516 * - encoding: Set by user.
3517 * - decoding: Set by user.
3519 uint8_t *dump_separator;
3522 * ',' separated list of allowed decoders.
3523 * If NULL then all are allowed
3524 * - encoding: unused
3525 * - decoding: set by user
3527 char *codec_whitelist;
3530 * Properties of the stream that gets decoded
3531 * - encoding: unused
3532 * - decoding: set by libavcodec
3534 unsigned properties;
3535 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3536 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3539 * Additional data associated with the entire coded stream.
3541 * - decoding: unused
3542 * - encoding: may be set by libavcodec after avcodec_open2().
3544 AVPacketSideData *coded_side_data;
3545 int nb_coded_side_data;
3548 * A reference to the AVHWFramesContext describing the input (for encoding)
3549 * or output (decoding) frames. The reference is set by the caller and
3550 * afterwards owned (and freed) by libavcodec - it should never be read by
3551 * the caller after being set.
3553 * - decoding: This field should be set by the caller from the get_format()
3554 * callback. The previous reference (if any) will always be
3555 * unreffed by libavcodec before the get_format() call.
3557 * If the default get_buffer2() is used with a hwaccel pixel
3558 * format, then this AVHWFramesContext will be used for
3559 * allocating the frame buffers.
3561 * - encoding: For hardware encoders configured to use a hwaccel pixel
3562 * format, this field should be set by the caller to a reference
3563 * to the AVHWFramesContext describing input frames.
3564 * AVHWFramesContext.format must be equal to
3565 * AVCodecContext.pix_fmt.
3567 * This field should be set before avcodec_open2() is called.
3569 AVBufferRef *hw_frames_ctx;
3572 * Control the form of AVSubtitle.rects[N]->ass
3573 * - decoding: set by user
3574 * - encoding: unused
3576 int sub_text_format;
3577 #define FF_SUB_TEXT_FMT_ASS 0
3578 #if FF_API_ASS_TIMING
3579 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3583 * Audio only. The amount of padding (in samples) appended by the encoder to
3584 * the end of the audio. I.e. this number of decoded samples must be
3585 * discarded by the caller from the end of the stream to get the original
3586 * audio without any trailing padding.
3588 * - decoding: unused
3589 * - encoding: unused
3591 int trailing_padding;
3594 * The number of pixels per image to maximally accept.
3596 * - decoding: set by user
3597 * - encoding: set by user
3602 * A reference to the AVHWDeviceContext describing the device which will
3603 * be used by a hardware encoder/decoder. The reference is set by the
3604 * caller and afterwards owned (and freed) by libavcodec.
3606 * This should be used if either the codec device does not require
3607 * hardware frames or any that are used are to be allocated internally by
3608 * libavcodec. If the user wishes to supply any of the frames used as
3609 * encoder input or decoder output then hw_frames_ctx should be used
3610 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3611 * field will be ignored while decoding the associated stream segment, but
3612 * may again be used on a following one after another get_format() call.
3614 * For both encoders and decoders this field should be set before
3615 * avcodec_open2() is called and must not be written to thereafter.
3617 * Note that some decoders may require this field to be set initially in
3618 * order to support hw_frames_ctx at all - in that case, all frames
3619 * contexts used must be created on the same device.
3621 AVBufferRef *hw_device_ctx;
3624 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3625 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3627 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3628 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3630 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3632 int av_codec_get_lowres(const AVCodecContext *avctx);
3633 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3635 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3636 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3638 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3639 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3644 typedef struct AVProfile {
3646 const char *name; ///< short name for the profile
3649 typedef struct AVCodecDefault AVCodecDefault;
3656 typedef struct AVCodec {
3658 * Name of the codec implementation.
3659 * The name is globally unique among encoders and among decoders (but an
3660 * encoder and a decoder can share the same name).
3661 * This is the primary way to find a codec from the user perspective.
3665 * Descriptive name for the codec, meant to be more human readable than name.
3666 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3668 const char *long_name;
3669 enum AVMediaType type;
3672 * Codec capabilities.
3673 * see AV_CODEC_CAP_*
3676 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3677 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3678 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3679 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3680 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3681 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3682 const AVClass *priv_class; ///< AVClass for the private context
3683 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3685 /*****************************************************************
3686 * No fields below this line are part of the public API. They
3687 * may not be used outside of libavcodec and can be changed and
3689 * New public fields should be added right above.
3690 *****************************************************************
3693 struct AVCodec *next;
3695 * @name Frame-level threading support functions
3699 * If defined, called on thread contexts when they are created.
3700 * If the codec allocates writable tables in init(), re-allocate them here.
3701 * priv_data will be set to a copy of the original.
3703 int (*init_thread_copy)(AVCodecContext *);
3705 * Copy necessary context variables from a previous thread context to the current one.
3706 * If not defined, the next thread will start automatically; otherwise, the codec
3707 * must call ff_thread_finish_setup().
3709 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3711 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3715 * Private codec-specific defaults.
3717 const AVCodecDefault *defaults;
3720 * Initialize codec static data, called from avcodec_register().
3722 void (*init_static_data)(struct AVCodec *codec);
3724 int (*init)(AVCodecContext *);
3725 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3726 const struct AVSubtitle *sub);
3728 * Encode data to an AVPacket.
3730 * @param avctx codec context
3731 * @param avpkt output AVPacket (may contain a user-provided buffer)
3732 * @param[in] frame AVFrame containing the raw data to be encoded
3733 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3734 * non-empty packet was returned in avpkt.
3735 * @return 0 on success, negative error code on failure
3737 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3738 int *got_packet_ptr);
3739 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3740 int (*close)(AVCodecContext *);
3742 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3743 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3745 * - never called if the codec is closed or the wrong type,
3746 * - AVPacket parameter change side data is applied right before calling
3747 * AVCodec->send_packet,
3748 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3749 * - only one drain packet is ever passed down (until the next flush()),
3750 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3752 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3753 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3754 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3755 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3758 * Will be called when seeking
3760 void (*flush)(AVCodecContext *);
3762 * Internal codec capabilities.
3763 * See FF_CODEC_CAP_* in internal.h
3768 int av_codec_get_max_lowres(const AVCodec *codec);
3770 struct MpegEncContext;
3773 * @defgroup lavc_hwaccel AVHWAccel
3776 typedef struct AVHWAccel {
3778 * Name of the hardware accelerated codec.
3779 * The name is globally unique among encoders and among decoders (but an
3780 * encoder and a decoder can share the same name).
3785 * Type of codec implemented by the hardware accelerator.
3787 * See AVMEDIA_TYPE_xxx
3789 enum AVMediaType type;
3792 * Codec implemented by the hardware accelerator.
3794 * See AV_CODEC_ID_xxx
3799 * Supported pixel format.
3801 * Only hardware accelerated formats are supported here.
3803 enum AVPixelFormat pix_fmt;
3806 * Hardware accelerated codec capabilities.
3807 * see HWACCEL_CODEC_CAP_*
3811 /*****************************************************************
3812 * No fields below this line are part of the public API. They
3813 * may not be used outside of libavcodec and can be changed and
3815 * New public fields should be added right above.
3816 *****************************************************************
3818 struct AVHWAccel *next;
3821 * Allocate a custom buffer
3823 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3826 * Called at the beginning of each frame or field picture.
3828 * Meaningful frame information (codec specific) is guaranteed to
3829 * be parsed at this point. This function is mandatory.
3831 * Note that buf can be NULL along with buf_size set to 0.
3832 * Otherwise, this means the whole frame is available at this point.
3834 * @param avctx the codec context
3835 * @param buf the frame data buffer base
3836 * @param buf_size the size of the frame in bytes
3837 * @return zero if successful, a negative value otherwise
3839 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3842 * Callback for each slice.
3844 * Meaningful slice information (codec specific) is guaranteed to
3845 * be parsed at this point. This function is mandatory.
3846 * The only exception is XvMC, that works on MB level.
3848 * @param avctx the codec context
3849 * @param buf the slice data buffer base
3850 * @param buf_size the size of the slice in bytes
3851 * @return zero if successful, a negative value otherwise
3853 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3856 * Called at the end of each frame or field picture.
3858 * The whole picture is parsed at this point and can now be sent
3859 * to the hardware accelerator. This function is mandatory.
3861 * @param avctx the codec context
3862 * @return zero if successful, a negative value otherwise
3864 int (*end_frame)(AVCodecContext *avctx);
3867 * Size of per-frame hardware accelerator private data.
3869 * Private data is allocated with av_mallocz() before
3870 * AVCodecContext.get_buffer() and deallocated after
3871 * AVCodecContext.release_buffer().
3873 int frame_priv_data_size;
3876 * Called for every Macroblock in a slice.
3878 * XvMC uses it to replace the ff_mpv_decode_mb().
3879 * Instead of decoding to raw picture, MB parameters are
3880 * stored in an array provided by the video driver.
3882 * @param s the mpeg context
3884 void (*decode_mb)(struct MpegEncContext *s);
3887 * Initialize the hwaccel private data.
3889 * This will be called from ff_get_format(), after hwaccel and
3890 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3893 int (*init)(AVCodecContext *avctx);
3896 * Uninitialize the hwaccel private data.
3898 * This will be called from get_format() or avcodec_close(), after hwaccel
3899 * and hwaccel_context are already uninitialized.
3901 int (*uninit)(AVCodecContext *avctx);
3904 * Size of the private data to allocate in
3905 * AVCodecInternal.hwaccel_priv_data.
3911 * Hardware acceleration should be used for decoding even if the codec level
3912 * used is unknown or higher than the maximum supported level reported by the
3915 * It's generally a good idea to pass this flag unless you have a specific
3916 * reason not to, as hardware tends to under-report supported levels.
3918 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3921 * Hardware acceleration can output YUV pixel formats with a different chroma
3922 * sampling than 4:2:0 and/or other than 8 bits per component.
3924 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3930 #if FF_API_AVPICTURE
3932 * @defgroup lavc_picture AVPicture
3934 * Functions for working with AVPicture
3939 * Picture data structure.
3941 * Up to four components can be stored into it, the last component is
3943 * @deprecated use AVFrame or imgutils functions instead
3945 typedef struct AVPicture {
3946 attribute_deprecated
3947 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3948 attribute_deprecated
3949 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3957 enum AVSubtitleType {
3960 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3963 * Plain text, the text field must be set by the decoder and is
3964 * authoritative. ass and pict fields may contain approximations.
3969 * Formatted text, the ass field must be set by the decoder and is
3970 * authoritative. pict and text fields may contain approximations.
3975 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3977 typedef struct AVSubtitleRect {
3978 int x; ///< top left corner of pict, undefined when pict is not set
3979 int y; ///< top left corner of pict, undefined when pict is not set
3980 int w; ///< width of pict, undefined when pict is not set
3981 int h; ///< height of pict, undefined when pict is not set
3982 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3984 #if FF_API_AVPICTURE
3986 * @deprecated unused
3988 attribute_deprecated
3992 * data+linesize for the bitmap of this subtitle.
3993 * Can be set for text/ass as well once they are rendered.
3998 enum AVSubtitleType type;
4000 char *text; ///< 0 terminated plain UTF-8 text
4003 * 0 terminated ASS/SSA compatible event line.
4004 * The presentation of this is unaffected by the other values in this
4012 typedef struct AVSubtitle {
4013 uint16_t format; /* 0 = graphics */
4014 uint32_t start_display_time; /* relative to packet pts, in ms */
4015 uint32_t end_display_time; /* relative to packet pts, in ms */
4017 AVSubtitleRect **rects;
4018 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
4022 * This struct describes the properties of an encoded stream.
4024 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4025 * be allocated with avcodec_parameters_alloc() and freed with
4026 * avcodec_parameters_free().
4028 typedef struct AVCodecParameters {
4030 * General type of the encoded data.
4032 enum AVMediaType codec_type;
4034 * Specific type of the encoded data (the codec used).
4036 enum AVCodecID codec_id;
4038 * Additional information about the codec (corresponds to the AVI FOURCC).
4043 * Extra binary data needed for initializing the decoder, codec-dependent.
4045 * Must be allocated with av_malloc() and will be freed by
4046 * avcodec_parameters_free(). The allocated size of extradata must be at
4047 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4052 * Size of the extradata content in bytes.
4057 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4058 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4063 * The average bitrate of the encoded data (in bits per second).
4068 * The number of bits per sample in the codedwords.
4070 * This is basically the bitrate per sample. It is mandatory for a bunch of
4071 * formats to actually decode them. It's the number of bits for one sample in
4072 * the actual coded bitstream.
4074 * This could be for example 4 for ADPCM
4075 * For PCM formats this matches bits_per_raw_sample
4078 int bits_per_coded_sample;
4081 * This is the number of valid bits in each output sample. If the
4082 * sample format has more bits, the least significant bits are additional
4083 * padding bits, which are always 0. Use right shifts to reduce the sample
4084 * to its actual size. For example, audio formats with 24 bit samples will
4085 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4086 * To get the original sample use "(int32_t)sample >> 8"."
4088 * For ADPCM this might be 12 or 16 or similar
4091 int bits_per_raw_sample;
4094 * Codec-specific bitstream restrictions that the stream conforms to.
4100 * Video only. The dimensions of the video frame in pixels.
4106 * Video only. The aspect ratio (width / height) which a single pixel
4107 * should have when displayed.
4109 * When the aspect ratio is unknown / undefined, the numerator should be
4110 * set to 0 (the denominator may have any value).
4112 AVRational sample_aspect_ratio;
4115 * Video only. The order of the fields in interlaced video.
4117 enum AVFieldOrder field_order;
4120 * Video only. Additional colorspace characteristics.
4122 enum AVColorRange color_range;
4123 enum AVColorPrimaries color_primaries;
4124 enum AVColorTransferCharacteristic color_trc;
4125 enum AVColorSpace color_space;
4126 enum AVChromaLocation chroma_location;
4129 * Video only. Number of delayed frames.
4134 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4135 * unknown or unspecified, otherwise the number of bits set must be equal to
4136 * the channels field.
4138 uint64_t channel_layout;
4140 * Audio only. The number of audio channels.
4144 * Audio only. The number of audio samples per second.
4148 * Audio only. The number of bytes per coded audio frame, required by some
4151 * Corresponds to nBlockAlign in WAVEFORMATEX.
4155 * Audio only. Audio frame size, if known. Required by some formats to be static.
4160 * Audio only. The amount of padding (in samples) inserted by the encoder at
4161 * the beginning of the audio. I.e. this number of leading decoded samples
4162 * must be discarded by the caller to get the original audio without leading
4165 int initial_padding;
4167 * Audio only. The amount of padding (in samples) appended by the encoder to
4168 * the end of the audio. I.e. this number of decoded samples must be
4169 * discarded by the caller from the end of the stream to get the original
4170 * audio without any trailing padding.
4172 int trailing_padding;
4174 * Audio only. Number of samples to skip after a discontinuity.
4177 } AVCodecParameters;
4180 * If c is NULL, returns the first registered codec,
4181 * if c is non-NULL, returns the next registered codec after c,
4182 * or NULL if c is the last one.
4184 AVCodec *av_codec_next(const AVCodec *c);
4187 * Return the LIBAVCODEC_VERSION_INT constant.
4189 unsigned avcodec_version(void);
4192 * Return the libavcodec build-time configuration.
4194 const char *avcodec_configuration(void);
4197 * Return the libavcodec license.
4199 const char *avcodec_license(void);
4202 * Register the codec codec and initialize libavcodec.
4204 * @warning either this function or avcodec_register_all() must be called
4205 * before any other libavcodec functions.
4207 * @see avcodec_register_all()
4209 void avcodec_register(AVCodec *codec);
4212 * Register all the codecs, parsers and bitstream filters which were enabled at
4213 * configuration time. If you do not call this function you can select exactly
4214 * which formats you want to support, by using the individual registration
4217 * @see avcodec_register
4218 * @see av_register_codec_parser
4219 * @see av_register_bitstream_filter
4221 void avcodec_register_all(void);
4224 * Allocate an AVCodecContext and set its fields to default values. The
4225 * resulting struct should be freed with avcodec_free_context().
4227 * @param codec if non-NULL, allocate private data and initialize defaults
4228 * for the given codec. It is illegal to then call avcodec_open2()
4229 * with a different codec.
4230 * If NULL, then the codec-specific defaults won't be initialized,
4231 * which may result in suboptimal default settings (this is
4232 * important mainly for encoders, e.g. libx264).
4234 * @return An AVCodecContext filled with default values or NULL on failure.
4236 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4239 * Free the codec context and everything associated with it and write NULL to
4240 * the provided pointer.
4242 void avcodec_free_context(AVCodecContext **avctx);
4244 #if FF_API_GET_CONTEXT_DEFAULTS
4246 * @deprecated This function should not be used, as closing and opening a codec
4247 * context multiple time is not supported. A new codec context should be
4248 * allocated for each new use.
4250 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4254 * Get the AVClass for AVCodecContext. It can be used in combination with
4255 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4257 * @see av_opt_find().
4259 const AVClass *avcodec_get_class(void);
4261 #if FF_API_COPY_CONTEXT
4263 * Get the AVClass for AVFrame. It can be used in combination with
4264 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4266 * @see av_opt_find().
4268 const AVClass *avcodec_get_frame_class(void);
4271 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4272 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4274 * @see av_opt_find().
4276 const AVClass *avcodec_get_subtitle_rect_class(void);
4279 * Copy the settings of the source AVCodecContext into the destination
4280 * AVCodecContext. The resulting destination codec context will be
4281 * unopened, i.e. you are required to call avcodec_open2() before you
4282 * can use this AVCodecContext to decode/encode video/audio data.
4284 * @param dest target codec context, should be initialized with
4285 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4286 * @param src source codec context
4287 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4289 * @deprecated The semantics of this function are ill-defined and it should not
4290 * be used. If you need to transfer the stream parameters from one codec context
4291 * to another, use an intermediate AVCodecParameters instance and the
4292 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4295 attribute_deprecated
4296 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4300 * Allocate a new AVCodecParameters and set its fields to default values
4301 * (unknown/invalid/0). The returned struct must be freed with
4302 * avcodec_parameters_free().
4304 AVCodecParameters *avcodec_parameters_alloc(void);
4307 * Free an AVCodecParameters instance and everything associated with it and
4308 * write NULL to the supplied pointer.
4310 void avcodec_parameters_free(AVCodecParameters **par);
4313 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4314 * replaced with newly allocated duplicates of the corresponding fields in src.
4316 * @return >= 0 on success, a negative AVERROR code on failure.
4318 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4321 * Fill the parameters struct based on the values from the supplied codec
4322 * context. Any allocated fields in par are freed and replaced with duplicates
4323 * of the corresponding fields in codec.
4325 * @return >= 0 on success, a negative AVERROR code on failure
4327 int avcodec_parameters_from_context(AVCodecParameters *par,
4328 const AVCodecContext *codec);
4331 * Fill the codec context based on the values from the supplied codec
4332 * parameters. Any allocated fields in codec that have a corresponding field in
4333 * par are freed and replaced with duplicates of the corresponding field in par.
4334 * Fields in codec that do not have a counterpart in par are not touched.
4336 * @return >= 0 on success, a negative AVERROR code on failure.
4338 int avcodec_parameters_to_context(AVCodecContext *codec,
4339 const AVCodecParameters *par);
4342 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4343 * function the context has to be allocated with avcodec_alloc_context3().
4345 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4346 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4347 * retrieving a codec.
4349 * @warning This function is not thread safe!
4351 * @note Always call this function before using decoding routines (such as
4352 * @ref avcodec_receive_frame()).
4355 * avcodec_register_all();
4356 * av_dict_set(&opts, "b", "2.5M", 0);
4357 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4361 * context = avcodec_alloc_context3(codec);
4363 * if (avcodec_open2(context, codec, opts) < 0)
4367 * @param avctx The context to initialize.
4368 * @param codec The codec to open this context for. If a non-NULL codec has been
4369 * previously passed to avcodec_alloc_context3() or
4370 * for this context, then this parameter MUST be either NULL or
4371 * equal to the previously passed codec.
4372 * @param options A dictionary filled with AVCodecContext and codec-private options.
4373 * On return this object will be filled with options that were not found.
4375 * @return zero on success, a negative value on error
4376 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4377 * av_dict_set(), av_opt_find().
4379 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4382 * Close a given AVCodecContext and free all the data associated with it
4383 * (but not the AVCodecContext itself).
4385 * Calling this function on an AVCodecContext that hasn't been opened will free
4386 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4387 * codec. Subsequent calls will do nothing.
4389 * @note Do not use this function. Use avcodec_free_context() to destroy a
4390 * codec context (either open or closed). Opening and closing a codec context
4391 * multiple times is not supported anymore -- use multiple codec contexts
4394 int avcodec_close(AVCodecContext *avctx);
4397 * Free all allocated data in the given subtitle struct.
4399 * @param sub AVSubtitle to free.
4401 void avsubtitle_free(AVSubtitle *sub);
4408 * @addtogroup lavc_packet
4413 * Allocate an AVPacket and set its fields to default values. The resulting
4414 * struct must be freed using av_packet_free().
4416 * @return An AVPacket filled with default values or NULL on failure.
4418 * @note this only allocates the AVPacket itself, not the data buffers. Those
4419 * must be allocated through other means such as av_new_packet.
4421 * @see av_new_packet
4423 AVPacket *av_packet_alloc(void);
4426 * Create a new packet that references the same data as src.
4428 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4430 * @return newly created AVPacket on success, NULL on error.
4432 * @see av_packet_alloc
4433 * @see av_packet_ref
4435 AVPacket *av_packet_clone(AVPacket *src);
4438 * Free the packet, if the packet is reference counted, it will be
4439 * unreferenced first.
4441 * @param packet packet to be freed. The pointer will be set to NULL.
4442 * @note passing NULL is a no-op.
4444 void av_packet_free(AVPacket **pkt);
4447 * Initialize optional fields of a packet with default values.
4449 * Note, this does not touch the data and size members, which have to be
4450 * initialized separately.
4454 void av_init_packet(AVPacket *pkt);
4457 * Allocate the payload of a packet and initialize its fields with
4461 * @param size wanted payload size
4462 * @return 0 if OK, AVERROR_xxx otherwise
4464 int av_new_packet(AVPacket *pkt, int size);
4467 * Reduce packet size, correctly zeroing padding
4470 * @param size new size
4472 void av_shrink_packet(AVPacket *pkt, int size);
4475 * Increase packet size, correctly zeroing padding
4478 * @param grow_by number of bytes by which to increase the size of the packet
4480 int av_grow_packet(AVPacket *pkt, int grow_by);
4483 * Initialize a reference-counted packet from av_malloc()ed data.
4485 * @param pkt packet to be initialized. This function will set the data, size,
4486 * buf and destruct fields, all others are left untouched.
4487 * @param data Data allocated by av_malloc() to be used as packet data. If this
4488 * function returns successfully, the data is owned by the underlying AVBuffer.
4489 * The caller may not access the data through other means.
4490 * @param size size of data in bytes, without the padding. I.e. the full buffer
4491 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4493 * @return 0 on success, a negative AVERROR on error
4495 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4497 #if FF_API_AVPACKET_OLD_API
4499 * @warning This is a hack - the packet memory allocation stuff is broken. The
4500 * packet is allocated if it was not really allocated.
4502 * @deprecated Use av_packet_ref
4504 attribute_deprecated
4505 int av_dup_packet(AVPacket *pkt);
4507 * Copy packet, including contents
4509 * @return 0 on success, negative AVERROR on fail
4511 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4514 * Copy packet side data
4516 * @return 0 on success, negative AVERROR on fail
4518 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4523 * @deprecated Use av_packet_unref
4525 * @param pkt packet to free
4527 attribute_deprecated
4528 void av_free_packet(AVPacket *pkt);
4531 * Allocate new information of a packet.
4534 * @param type side information type
4535 * @param size side information size
4536 * @return pointer to fresh allocated data or NULL otherwise
4538 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4542 * Wrap an existing array as a packet side data.
4545 * @param type side information type
4546 * @param data the side data array. It must be allocated with the av_malloc()
4547 * family of functions. The ownership of the data is transferred to
4549 * @param size side information size
4550 * @return a non-negative number on success, a negative AVERROR code on
4551 * failure. On failure, the packet is unchanged and the data remains
4552 * owned by the caller.
4554 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4555 uint8_t *data, size_t size);
4558 * Shrink the already allocated side data buffer
4561 * @param type side information type
4562 * @param size new side information size
4563 * @return 0 on success, < 0 on failure
4565 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4569 * Get side information from packet.
4572 * @param type desired side information type
4573 * @param size pointer for side information size to store (optional)
4574 * @return pointer to data if present or NULL otherwise
4576 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4579 #if FF_API_MERGE_SD_API
4580 attribute_deprecated
4581 int av_packet_merge_side_data(AVPacket *pkt);
4583 attribute_deprecated
4584 int av_packet_split_side_data(AVPacket *pkt);
4587 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4590 * Pack a dictionary for use in side_data.
4592 * @param dict The dictionary to pack.
4593 * @param size pointer to store the size of the returned data
4594 * @return pointer to data if successful, NULL otherwise
4596 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4598 * Unpack a dictionary from side_data.
4600 * @param data data from side_data
4601 * @param size size of the data
4602 * @param dict the metadata storage dictionary
4603 * @return 0 on success, < 0 on failure
4605 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4609 * Convenience function to free all the side data stored.
4610 * All the other fields stay untouched.
4614 void av_packet_free_side_data(AVPacket *pkt);
4617 * Setup a new reference to the data described by a given packet
4619 * If src is reference-counted, setup dst as a new reference to the
4620 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4621 * data from src into it.
4623 * All the other fields are copied from src.
4625 * @see av_packet_unref
4627 * @param dst Destination packet
4628 * @param src Source packet
4630 * @return 0 on success, a negative AVERROR on error.
4632 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4637 * Unreference the buffer referenced by the packet and reset the
4638 * remaining packet fields to their default values.
4640 * @param pkt The packet to be unreferenced.
4642 void av_packet_unref(AVPacket *pkt);
4645 * Move every field in src to dst and reset src.
4647 * @see av_packet_unref
4649 * @param src Source packet, will be reset
4650 * @param dst Destination packet
4652 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4655 * Copy only "properties" fields from src to dst.
4657 * Properties for the purpose of this function are all the fields
4658 * beside those related to the packet data (buf, data, size)
4660 * @param dst Destination packet
4661 * @param src Source packet
4663 * @return 0 on success AVERROR on failure.
4665 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4668 * Convert valid timing fields (timestamps / durations) in a packet from one
4669 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4672 * @param pkt packet on which the conversion will be performed
4673 * @param tb_src source timebase, in which the timing fields in pkt are
4675 * @param tb_dst destination timebase, to which the timing fields will be
4678 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4685 * @addtogroup lavc_decoding
4690 * Find a registered decoder with a matching codec ID.
4692 * @param id AVCodecID of the requested decoder
4693 * @return A decoder if one was found, NULL otherwise.
4695 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4698 * Find a registered decoder with the specified name.
4700 * @param name name of the requested decoder
4701 * @return A decoder if one was found, NULL otherwise.
4703 AVCodec *avcodec_find_decoder_by_name(const char *name);
4706 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4707 * it can be called by custom get_buffer2() implementations for decoders without
4708 * AV_CODEC_CAP_DR1 set.
4710 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4714 * Return the amount of padding in pixels which the get_buffer callback must
4715 * provide around the edge of the image for codecs which do not have the
4716 * CODEC_FLAG_EMU_EDGE flag.
4718 * @return Required padding in pixels.
4720 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4723 attribute_deprecated
4724 unsigned avcodec_get_edge_width(void);
4728 * Modify width and height values so that they will result in a memory
4729 * buffer that is acceptable for the codec if you do not use any horizontal
4732 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4734 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4737 * Modify width and height values so that they will result in a memory
4738 * buffer that is acceptable for the codec if you also ensure that all
4739 * line sizes are a multiple of the respective linesize_align[i].
4741 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4743 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4744 int linesize_align[AV_NUM_DATA_POINTERS]);
4747 * Converts AVChromaLocation to swscale x/y chroma position.
4749 * The positions represent the chroma (0,0) position in a coordinates system
4750 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4752 * @param xpos horizontal chroma sample position
4753 * @param ypos vertical chroma sample position
4755 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4758 * Converts swscale x/y chroma position to AVChromaLocation.
4760 * The positions represent the chroma (0,0) position in a coordinates system
4761 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4763 * @param xpos horizontal chroma sample position
4764 * @param ypos vertical chroma sample position
4766 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4769 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4771 * Some decoders may support multiple frames in a single AVPacket. Such
4772 * decoders would then just decode the first frame and the return value would be
4773 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4774 * called again with an AVPacket containing the remaining data in order to
4775 * decode the second frame, etc... Even if no frames are returned, the packet
4776 * needs to be fed to the decoder with remaining data until it is completely
4777 * consumed or an error occurs.
4779 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4780 * and output. This means that for some packets they will not immediately
4781 * produce decoded output and need to be flushed at the end of decoding to get
4782 * all the decoded data. Flushing is done by calling this function with packets
4783 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4784 * returning samples. It is safe to flush even those decoders that are not
4785 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4787 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4788 * larger than the actual read bytes because some optimized bitstream
4789 * readers read 32 or 64 bits at once and could read over the end.
4791 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4792 * before packets may be fed to the decoder.
4794 * @param avctx the codec context
4795 * @param[out] frame The AVFrame in which to store decoded audio samples.
4796 * The decoder will allocate a buffer for the decoded frame by
4797 * calling the AVCodecContext.get_buffer2() callback.
4798 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4799 * reference counted and the returned reference belongs to the
4800 * caller. The caller must release the frame using av_frame_unref()
4801 * when the frame is no longer needed. The caller may safely write
4802 * to the frame if av_frame_is_writable() returns 1.
4803 * When AVCodecContext.refcounted_frames is set to 0, the returned
4804 * reference belongs to the decoder and is valid only until the
4805 * next call to this function or until closing or flushing the
4806 * decoder. The caller may not write to it.
4807 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4808 * non-zero. Note that this field being set to zero
4809 * does not mean that an error has occurred. For
4810 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4811 * call is guaranteed to produce a frame.
4812 * @param[in] avpkt The input AVPacket containing the input buffer.
4813 * At least avpkt->data and avpkt->size should be set. Some
4814 * decoders might also require additional fields to be set.
4815 * @return A negative error code is returned if an error occurred during
4816 * decoding, otherwise the number of bytes consumed from the input
4817 * AVPacket is returned.
4819 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4821 attribute_deprecated
4822 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4823 int *got_frame_ptr, const AVPacket *avpkt);
4826 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4827 * Some decoders may support multiple frames in a single AVPacket, such
4828 * decoders would then just decode the first frame.
4830 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4831 * the actual read bytes because some optimized bitstream readers read 32 or 64
4832 * bits at once and could read over the end.
4834 * @warning The end of the input buffer buf should be set to 0 to ensure that
4835 * no overreading happens for damaged MPEG streams.
4837 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4838 * between input and output, these need to be fed with avpkt->data=NULL,
4839 * avpkt->size=0 at the end to return the remaining frames.
4841 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4842 * before packets may be fed to the decoder.
4844 * @param avctx the codec context
4845 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4846 * Use av_frame_alloc() to get an AVFrame. The codec will
4847 * allocate memory for the actual bitmap by calling the
4848 * AVCodecContext.get_buffer2() callback.
4849 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4850 * reference counted and the returned reference belongs to the
4851 * caller. The caller must release the frame using av_frame_unref()
4852 * when the frame is no longer needed. The caller may safely write
4853 * to the frame if av_frame_is_writable() returns 1.
4854 * When AVCodecContext.refcounted_frames is set to 0, the returned
4855 * reference belongs to the decoder and is valid only until the
4856 * next call to this function or until closing or flushing the
4857 * decoder. The caller may not write to it.
4859 * @param[in] avpkt The input AVPacket containing the input buffer.
4860 * You can create such packet with av_init_packet() and by then setting
4861 * data and size, some decoders might in addition need other fields like
4862 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4864 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4865 * @return On error a negative value is returned, otherwise the number of bytes
4866 * used or zero if no frame could be decompressed.
4868 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4870 attribute_deprecated
4871 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4872 int *got_picture_ptr,
4873 const AVPacket *avpkt);
4876 * Decode a subtitle message.
4877 * Return a negative value on error, otherwise return the number of bytes used.
4878 * If no subtitle could be decompressed, got_sub_ptr is zero.
4879 * Otherwise, the subtitle is stored in *sub.
4880 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4881 * simplicity, because the performance difference is expect to be negligible
4882 * and reusing a get_buffer written for video codecs would probably perform badly
4883 * due to a potentially very different allocation pattern.
4885 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4886 * and output. This means that for some packets they will not immediately
4887 * produce decoded output and need to be flushed at the end of decoding to get
4888 * all the decoded data. Flushing is done by calling this function with packets
4889 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4890 * returning subtitles. It is safe to flush even those decoders that are not
4891 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4893 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4894 * before packets may be fed to the decoder.
4896 * @param avctx the codec context
4897 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4898 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4899 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4900 * @param[in] avpkt The input AVPacket containing the input buffer.
4902 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4907 * Supply raw packet data as input to a decoder.
4909 * Internally, this call will copy relevant AVCodecContext fields, which can
4910 * influence decoding per-packet, and apply them when the packet is actually
4911 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4912 * decoder to drop the frame contained by the packet sent with this function.)
4914 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4915 * larger than the actual read bytes because some optimized bitstream
4916 * readers read 32 or 64 bits at once and could read over the end.
4918 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4919 * on the same AVCodecContext. It will return unexpected results now
4920 * or in future libavcodec versions.
4922 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4923 * before packets may be fed to the decoder.
4925 * @param avctx codec context
4926 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4927 * frame, or several complete audio frames.
4928 * Ownership of the packet remains with the caller, and the
4929 * decoder will not write to the packet. The decoder may create
4930 * a reference to the packet data (or copy it if the packet is
4931 * not reference-counted).
4932 * Unlike with older APIs, the packet is always fully consumed,
4933 * and if it contains multiple frames (e.g. some audio codecs),
4934 * will require you to call avcodec_receive_frame() multiple
4935 * times afterwards before you can send a new packet.
4936 * It can be NULL (or an AVPacket with data set to NULL and
4937 * size set to 0); in this case, it is considered a flush
4938 * packet, which signals the end of the stream. Sending the
4939 * first flush packet will return success. Subsequent ones are
4940 * unnecessary and will return AVERROR_EOF. If the decoder
4941 * still has frames buffered, it will return them after sending
4944 * @return 0 on success, otherwise negative error code:
4945 * AVERROR(EAGAIN): input is not accepted in the current state - user
4946 * must read output with avcodec_receive_frame() (once
4947 * all output is read, the packet should be resent, and
4948 * the call will not fail with EAGAIN).
4949 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4950 * be sent to it (also returned if more than 1 flush
4952 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4953 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4954 * other errors: legitimate decoding errors
4956 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4959 * Return decoded output data from a decoder.
4961 * @param avctx codec context
4962 * @param frame This will be set to a reference-counted video or audio
4963 * frame (depending on the decoder type) allocated by the
4964 * decoder. Note that the function will always call
4965 * av_frame_unref(frame) before doing anything else.
4968 * 0: success, a frame was returned
4969 * AVERROR(EAGAIN): output is not available in this state - user must try
4971 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4972 * no more output frames
4973 * AVERROR(EINVAL): codec not opened, or it is an encoder
4974 * other negative values: legitimate decoding errors
4976 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4979 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4980 * to retrieve buffered output packets.
4982 * @param avctx codec context
4983 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4984 * Ownership of the frame remains with the caller, and the
4985 * encoder will not write to the frame. The encoder may create
4986 * a reference to the frame data (or copy it if the frame is
4987 * not reference-counted).
4988 * It can be NULL, in which case it is considered a flush
4989 * packet. This signals the end of the stream. If the encoder
4990 * still has packets buffered, it will return them after this
4991 * call. Once flushing mode has been entered, additional flush
4992 * packets are ignored, and sending frames will return
4996 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4997 * can have any number of samples.
4998 * If it is not set, frame->nb_samples must be equal to
4999 * avctx->frame_size for all frames except the last.
5000 * The final frame may be smaller than avctx->frame_size.
5001 * @return 0 on success, otherwise negative error code:
5002 * AVERROR(EAGAIN): input is not accepted in the current state - user
5003 * must read output with avcodec_receive_packet() (once
5004 * all output is read, the packet should be resent, and
5005 * the call will not fail with EAGAIN).
5006 * AVERROR_EOF: the encoder has been flushed, and no new frames can
5008 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
5009 * decoder, or requires flush
5010 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5011 * other errors: legitimate decoding errors
5013 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5016 * Read encoded data from the encoder.
5018 * @param avctx codec context
5019 * @param avpkt This will be set to a reference-counted packet allocated by the
5020 * encoder. Note that the function will always call
5021 * av_frame_unref(frame) before doing anything else.
5022 * @return 0 on success, otherwise negative error code:
5023 * AVERROR(EAGAIN): output is not available in the current state - user
5024 * must try to send input
5025 * AVERROR_EOF: the encoder has been fully flushed, and there will be
5026 * no more output packets
5027 * AVERROR(EINVAL): codec not opened, or it is an encoder
5028 * other errors: legitimate decoding errors
5030 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5034 * @defgroup lavc_parsing Frame parsing
5038 enum AVPictureStructure {
5039 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5040 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5041 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5042 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5045 typedef struct AVCodecParserContext {
5047 struct AVCodecParser *parser;
5048 int64_t frame_offset; /* offset of the current frame */
5049 int64_t cur_offset; /* current offset
5050 (incremented by each av_parser_parse()) */
5051 int64_t next_frame_offset; /* offset of the next frame */
5053 int pict_type; /* XXX: Put it back in AVCodecContext. */
5055 * This field is used for proper frame duration computation in lavf.
5056 * It signals, how much longer the frame duration of the current frame
5057 * is compared to normal frame duration.
5059 * frame_duration = (1 + repeat_pict) * time_base
5061 * It is used by codecs like H.264 to display telecined material.
5063 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5064 int64_t pts; /* pts of the current frame */
5065 int64_t dts; /* dts of the current frame */
5070 int fetch_timestamp;
5072 #define AV_PARSER_PTS_NB 4
5073 int cur_frame_start_index;
5074 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5075 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5076 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5079 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5080 #define PARSER_FLAG_ONCE 0x0002
5081 /// Set if the parser has a valid file offset
5082 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5083 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5085 int64_t offset; ///< byte offset from starting packet start
5086 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5089 * Set by parser to 1 for key frames and 0 for non-key frames.
5090 * It is initialized to -1, so if the parser doesn't set this flag,
5091 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5096 #if FF_API_CONVERGENCE_DURATION
5098 * @deprecated unused
5100 attribute_deprecated
5101 int64_t convergence_duration;
5104 // Timestamp generation support:
5106 * Synchronization point for start of timestamp generation.
5108 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5111 * For example, this corresponds to presence of H.264 buffering period
5117 * Offset of the current timestamp against last timestamp sync point in
5118 * units of AVCodecContext.time_base.
5120 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5121 * contain a valid timestamp offset.
5123 * Note that the timestamp of sync point has usually a nonzero
5124 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5125 * the next frame after timestamp sync point will be usually 1.
5127 * For example, this corresponds to H.264 cpb_removal_delay.
5129 int dts_ref_dts_delta;
5132 * Presentation delay of current frame in units of AVCodecContext.time_base.
5134 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5135 * contain valid non-negative timestamp delta (presentation time of a frame
5136 * must not lie in the past).
5138 * This delay represents the difference between decoding and presentation
5139 * time of the frame.
5141 * For example, this corresponds to H.264 dpb_output_delay.
5146 * Position of the packet in file.
5148 * Analogous to cur_frame_pts/dts
5150 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5153 * Byte position of currently parsed frame in stream.
5158 * Previous frame byte position.
5163 * Duration of the current frame.
5164 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5165 * For all other types, this is in units of AVCodecContext.time_base.
5169 enum AVFieldOrder field_order;
5172 * Indicate whether a picture is coded as a frame, top field or bottom field.
5174 * For example, H.264 field_pic_flag equal to 0 corresponds to
5175 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5176 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5177 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5179 enum AVPictureStructure picture_structure;
5182 * Picture number incremented in presentation or output order.
5183 * This field may be reinitialized at the first picture of a new sequence.
5185 * For example, this corresponds to H.264 PicOrderCnt.
5187 int output_picture_number;
5190 * Dimensions of the decoded video intended for presentation.
5196 * Dimensions of the coded video.
5202 * The format of the coded data, corresponds to enum AVPixelFormat for video
5203 * and for enum AVSampleFormat for audio.
5205 * Note that a decoder can have considerable freedom in how exactly it
5206 * decodes the data, so the format reported here might be different from the
5207 * one returned by a decoder.
5210 } AVCodecParserContext;
5212 typedef struct AVCodecParser {
5213 int codec_ids[5]; /* several codec IDs are permitted */
5215 int (*parser_init)(AVCodecParserContext *s);
5216 /* This callback never returns an error, a negative value means that
5217 * the frame start was in a previous packet. */
5218 int (*parser_parse)(AVCodecParserContext *s,
5219 AVCodecContext *avctx,
5220 const uint8_t **poutbuf, int *poutbuf_size,
5221 const uint8_t *buf, int buf_size);
5222 void (*parser_close)(AVCodecParserContext *s);
5223 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5224 struct AVCodecParser *next;
5227 AVCodecParser *av_parser_next(const AVCodecParser *c);
5229 void av_register_codec_parser(AVCodecParser *parser);
5230 AVCodecParserContext *av_parser_init(int codec_id);
5235 * @param s parser context.
5236 * @param avctx codec context.
5237 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5238 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5239 * @param buf input buffer.
5240 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5241 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5242 To signal EOF, this should be 0 (so that the last frame
5244 * @param pts input presentation timestamp.
5245 * @param dts input decoding timestamp.
5246 * @param pos input byte position in stream.
5247 * @return the number of bytes of the input bitstream used.
5252 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5259 * decode_frame(data, size);
5263 int av_parser_parse2(AVCodecParserContext *s,
5264 AVCodecContext *avctx,
5265 uint8_t **poutbuf, int *poutbuf_size,
5266 const uint8_t *buf, int buf_size,
5267 int64_t pts, int64_t dts,
5271 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5272 * @deprecated use AVBitStreamFilter
5274 int av_parser_change(AVCodecParserContext *s,
5275 AVCodecContext *avctx,
5276 uint8_t **poutbuf, int *poutbuf_size,
5277 const uint8_t *buf, int buf_size, int keyframe);
5278 void av_parser_close(AVCodecParserContext *s);
5286 * @addtogroup lavc_encoding
5291 * Find a registered encoder with a matching codec ID.
5293 * @param id AVCodecID of the requested encoder
5294 * @return An encoder if one was found, NULL otherwise.
5296 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5299 * Find a registered encoder with the specified name.
5301 * @param name name of the requested encoder
5302 * @return An encoder if one was found, NULL otherwise.
5304 AVCodec *avcodec_find_encoder_by_name(const char *name);
5307 * Encode a frame of audio.
5309 * Takes input samples from frame and writes the next output packet, if
5310 * available, to avpkt. The output packet does not necessarily contain data for
5311 * the most recent frame, as encoders can delay, split, and combine input frames
5312 * internally as needed.
5314 * @param avctx codec context
5315 * @param avpkt output AVPacket.
5316 * The user can supply an output buffer by setting
5317 * avpkt->data and avpkt->size prior to calling the
5318 * function, but if the size of the user-provided data is not
5319 * large enough, encoding will fail. If avpkt->data and
5320 * avpkt->size are set, avpkt->destruct must also be set. All
5321 * other AVPacket fields will be reset by the encoder using
5322 * av_init_packet(). If avpkt->data is NULL, the encoder will
5323 * allocate it. The encoder will set avpkt->size to the size
5324 * of the output packet.
5326 * If this function fails or produces no output, avpkt will be
5327 * freed using av_packet_unref().
5328 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5329 * May be NULL when flushing an encoder that has the
5330 * AV_CODEC_CAP_DELAY capability set.
5331 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5332 * can have any number of samples.
5333 * If it is not set, frame->nb_samples must be equal to
5334 * avctx->frame_size for all frames except the last.
5335 * The final frame may be smaller than avctx->frame_size.
5336 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5337 * output packet is non-empty, and to 0 if it is
5338 * empty. If the function returns an error, the
5339 * packet can be assumed to be invalid, and the
5340 * value of got_packet_ptr is undefined and should
5342 * @return 0 on success, negative error code on failure
5344 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5346 attribute_deprecated
5347 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5348 const AVFrame *frame, int *got_packet_ptr);
5351 * Encode a frame of video.
5353 * Takes input raw video data from frame and writes the next output packet, if
5354 * available, to avpkt. The output packet does not necessarily contain data for
5355 * the most recent frame, as encoders can delay and reorder input frames
5356 * internally as needed.
5358 * @param avctx codec context
5359 * @param avpkt output AVPacket.
5360 * The user can supply an output buffer by setting
5361 * avpkt->data and avpkt->size prior to calling the
5362 * function, but if the size of the user-provided data is not
5363 * large enough, encoding will fail. All other AVPacket fields
5364 * will be reset by the encoder using av_init_packet(). If
5365 * avpkt->data is NULL, the encoder will allocate it.
5366 * The encoder will set avpkt->size to the size of the
5367 * output packet. The returned data (if any) belongs to the
5368 * caller, he is responsible for freeing it.
5370 * If this function fails or produces no output, avpkt will be
5371 * freed using av_packet_unref().
5372 * @param[in] frame AVFrame containing the raw video data to be encoded.
5373 * May be NULL when flushing an encoder that has the
5374 * AV_CODEC_CAP_DELAY capability set.
5375 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5376 * output packet is non-empty, and to 0 if it is
5377 * empty. If the function returns an error, the
5378 * packet can be assumed to be invalid, and the
5379 * value of got_packet_ptr is undefined and should
5381 * @return 0 on success, negative error code on failure
5383 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5385 attribute_deprecated
5386 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5387 const AVFrame *frame, int *got_packet_ptr);
5389 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5390 const AVSubtitle *sub);
5397 #if FF_API_AVCODEC_RESAMPLE
5399 * @defgroup lavc_resample Audio resampling
5401 * @deprecated use libswresample instead
5405 struct ReSampleContext;
5406 struct AVResampleContext;
5408 typedef struct ReSampleContext ReSampleContext;
5411 * Initialize audio resampling context.
5413 * @param output_channels number of output channels
5414 * @param input_channels number of input channels
5415 * @param output_rate output sample rate
5416 * @param input_rate input sample rate
5417 * @param sample_fmt_out requested output sample format
5418 * @param sample_fmt_in input sample format
5419 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5420 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5421 * @param linear if 1 then the used FIR filter will be linearly interpolated
5422 between the 2 closest, if 0 the closest will be used
5423 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5424 * @return allocated ReSampleContext, NULL if error occurred
5426 attribute_deprecated
5427 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5428 int output_rate, int input_rate,
5429 enum AVSampleFormat sample_fmt_out,
5430 enum AVSampleFormat sample_fmt_in,
5431 int filter_length, int log2_phase_count,
5432 int linear, double cutoff);
5434 attribute_deprecated
5435 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5438 * Free resample context.
5440 * @param s a non-NULL pointer to a resample context previously
5441 * created with av_audio_resample_init()
5443 attribute_deprecated
5444 void audio_resample_close(ReSampleContext *s);
5448 * Initialize an audio resampler.
5449 * Note, if either rate is not an integer then simply scale both rates up so they are.
5450 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5451 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5452 * @param linear If 1 then the used FIR filter will be linearly interpolated
5453 between the 2 closest, if 0 the closest will be used
5454 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5456 attribute_deprecated
5457 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5460 * Resample an array of samples using a previously configured context.
5461 * @param src an array of unconsumed samples
5462 * @param consumed the number of samples of src which have been consumed are returned here
5463 * @param src_size the number of unconsumed samples available
5464 * @param dst_size the amount of space in samples available in dst
5465 * @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.
5466 * @return the number of samples written in dst or -1 if an error occurred
5468 attribute_deprecated
5469 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5473 * Compensate samplerate/timestamp drift. The compensation is done by changing
5474 * the resampler parameters, so no audible clicks or similar distortions occur
5475 * @param compensation_distance distance in output samples over which the compensation should be performed
5476 * @param sample_delta number of output samples which should be output less
5478 * example: av_resample_compensate(c, 10, 500)
5479 * here instead of 510 samples only 500 samples would be output
5481 * note, due to rounding the actual compensation might be slightly different,
5482 * especially if the compensation_distance is large and the in_rate used during init is small
5484 attribute_deprecated
5485 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5486 attribute_deprecated
5487 void av_resample_close(struct AVResampleContext *c);
5494 #if FF_API_AVPICTURE
5496 * @addtogroup lavc_picture
5501 * @deprecated unused
5503 attribute_deprecated
5504 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5507 * @deprecated unused
5509 attribute_deprecated
5510 void avpicture_free(AVPicture *picture);
5513 * @deprecated use av_image_fill_arrays() instead.
5515 attribute_deprecated
5516 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5517 enum AVPixelFormat pix_fmt, int width, int height);
5520 * @deprecated use av_image_copy_to_buffer() instead.
5522 attribute_deprecated
5523 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5524 int width, int height,
5525 unsigned char *dest, int dest_size);
5528 * @deprecated use av_image_get_buffer_size() instead.
5530 attribute_deprecated
5531 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5534 * @deprecated av_image_copy() instead.
5536 attribute_deprecated
5537 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5538 enum AVPixelFormat pix_fmt, int width, int height);
5541 * @deprecated unused
5543 attribute_deprecated
5544 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5545 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5548 * @deprecated unused
5550 attribute_deprecated
5551 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5552 int padtop, int padbottom, int padleft, int padright, int *color);
5560 * @defgroup lavc_misc Utility functions
5563 * Miscellaneous utility functions related to both encoding and decoding
5569 * @defgroup lavc_misc_pixfmt Pixel formats
5571 * Functions for working with pixel formats.
5576 * Utility function to access log2_chroma_w log2_chroma_h from
5577 * the pixel format AVPixFmtDescriptor.
5579 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5580 * for one that returns a failure code and continues in case of invalid
5583 * @param[in] pix_fmt the pixel format
5584 * @param[out] h_shift store log2_chroma_w
5585 * @param[out] v_shift store log2_chroma_h
5587 * @see av_pix_fmt_get_chroma_sub_sample
5590 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5593 * Return a value representing the fourCC code associated to the
5594 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5597 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5600 * @deprecated see av_get_pix_fmt_loss()
5602 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5606 * Find the best pixel format to convert to given a certain source pixel
5607 * format. When converting from one pixel format to another, information loss
5608 * may occur. For example, when converting from RGB24 to GRAY, the color
5609 * information will be lost. Similarly, other losses occur when converting from
5610 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5611 * the given pixel formats should be used to suffer the least amount of loss.
5612 * The pixel formats from which it chooses one, are determined by the
5613 * pix_fmt_list parameter.
5616 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5617 * @param[in] src_pix_fmt source pixel format
5618 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5619 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5620 * @return The best pixel format to convert to or -1 if none was found.
5622 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5623 enum AVPixelFormat src_pix_fmt,
5624 int has_alpha, int *loss_ptr);
5627 * @deprecated see av_find_best_pix_fmt_of_2()
5629 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5630 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5632 attribute_deprecated
5633 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5634 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5636 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5642 #if FF_API_SET_DIMENSIONS
5644 * @deprecated this function is not supposed to be used from outside of lavc
5646 attribute_deprecated
5647 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5651 * Put a string representing the codec tag codec_tag in buf.
5653 * @param buf buffer to place codec tag in
5654 * @param buf_size size in bytes of buf
5655 * @param codec_tag codec tag to assign
5656 * @return the length of the string that would have been generated if
5657 * enough space had been available, excluding the trailing null
5659 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5661 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5664 * Return a name for the specified profile, if available.
5666 * @param codec the codec that is searched for the given profile
5667 * @param profile the profile value for which a name is requested
5668 * @return A name for the profile if found, NULL otherwise.
5670 const char *av_get_profile_name(const AVCodec *codec, int profile);
5673 * Return a name for the specified profile, if available.
5675 * @param codec_id the ID of the codec to which the requested profile belongs
5676 * @param profile the profile value for which a name is requested
5677 * @return A name for the profile if found, NULL otherwise.
5679 * @note unlike av_get_profile_name(), which searches a list of profiles
5680 * supported by a specific decoder or encoder implementation, this
5681 * function searches the list of profiles from the AVCodecDescriptor
5683 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5685 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5686 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5687 //FIXME func typedef
5690 * Fill AVFrame audio data and linesize pointers.
5692 * The buffer buf must be a preallocated buffer with a size big enough
5693 * to contain the specified samples amount. The filled AVFrame data
5694 * pointers will point to this buffer.
5696 * AVFrame extended_data channel pointers are allocated if necessary for
5699 * @param frame the AVFrame
5700 * frame->nb_samples must be set prior to calling the
5701 * function. This function fills in frame->data,
5702 * frame->extended_data, frame->linesize[0].
5703 * @param nb_channels channel count
5704 * @param sample_fmt sample format
5705 * @param buf buffer to use for frame data
5706 * @param buf_size size of buffer
5707 * @param align plane size sample alignment (0 = default)
5708 * @return >=0 on success, negative error code on failure
5709 * @todo return the size in bytes required to store the samples in
5710 * case of success, at the next libavutil bump
5712 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5713 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5714 int buf_size, int align);
5717 * Reset the internal decoder state / flush internal buffers. Should be called
5718 * e.g. when seeking or when switching to a different stream.
5720 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5721 * this invalidates the frames previously returned from the decoder. When
5722 * refcounted frames are used, the decoder just releases any references it might
5723 * keep internally, but the caller's reference remains valid.
5725 void avcodec_flush_buffers(AVCodecContext *avctx);
5728 * Return codec bits per sample.
5730 * @param[in] codec_id the codec
5731 * @return Number of bits per sample or zero if unknown for the given codec.
5733 int av_get_bits_per_sample(enum AVCodecID codec_id);
5736 * Return the PCM codec associated with a sample format.
5737 * @param be endianness, 0 for little, 1 for big,
5738 * -1 (or anything else) for native
5739 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5741 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5744 * Return codec bits per sample.
5745 * Only return non-zero if the bits per sample is exactly correct, not an
5748 * @param[in] codec_id the codec
5749 * @return Number of bits per sample or zero if unknown for the given codec.
5751 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5754 * Return audio frame duration.
5756 * @param avctx codec context
5757 * @param frame_bytes size of the frame, or 0 if unknown
5758 * @return frame duration, in samples, if known. 0 if not able to
5761 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5764 * This function is the same as av_get_audio_frame_duration(), except it works
5765 * with AVCodecParameters instead of an AVCodecContext.
5767 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5770 typedef struct AVBitStreamFilterContext {
5772 const struct AVBitStreamFilter *filter;
5773 AVCodecParserContext *parser;
5774 struct AVBitStreamFilterContext *next;
5776 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5777 * Not for access by library users.
5780 } AVBitStreamFilterContext;
5783 typedef struct AVBSFInternal AVBSFInternal;
5786 * The bitstream filter state.
5788 * This struct must be allocated with av_bsf_alloc() and freed with
5791 * The fields in the struct will only be changed (by the caller or by the
5792 * filter) as described in their documentation, and are to be considered
5793 * immutable otherwise.
5795 typedef struct AVBSFContext {
5797 * A class for logging and AVOptions
5799 const AVClass *av_class;
5802 * The bitstream filter this context is an instance of.
5804 const struct AVBitStreamFilter *filter;
5807 * Opaque libavcodec internal data. Must not be touched by the caller in any
5810 AVBSFInternal *internal;
5813 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5814 * this is an AVOptions-enabled struct.
5819 * Parameters of the input stream. Set by the caller before av_bsf_init().
5821 AVCodecParameters *par_in;
5824 * Parameters of the output stream. Set by the filter in av_bsf_init().
5826 AVCodecParameters *par_out;
5829 * The timebase used for the timestamps of the input packets. Set by the
5830 * caller before av_bsf_init().
5832 AVRational time_base_in;
5835 * The timebase used for the timestamps of the output packets. Set by the
5836 * filter in av_bsf_init().
5838 AVRational time_base_out;
5841 typedef struct AVBitStreamFilter {
5845 * A list of codec ids supported by the filter, terminated by
5847 * May be NULL, in that case the bitstream filter works with any codec id.
5849 const enum AVCodecID *codec_ids;
5852 * A class for the private data, used to declare bitstream filter private
5853 * AVOptions. This field is NULL for bitstream filters that do not declare
5856 * If this field is non-NULL, the first member of the filter private data
5857 * must be a pointer to AVClass, which will be set by libavcodec generic
5858 * code to this class.
5860 const AVClass *priv_class;
5862 /*****************************************************************
5863 * No fields below this line are part of the public API. They
5864 * may not be used outside of libavcodec and can be changed and
5866 * New public fields should be added right above.
5867 *****************************************************************
5871 int (*init)(AVBSFContext *ctx);
5872 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5873 void (*close)(AVBSFContext *ctx);
5874 } AVBitStreamFilter;
5878 * Register a bitstream filter.
5880 * The filter will be accessible to the application code through
5881 * av_bitstream_filter_next() or can be directly initialized with
5882 * av_bitstream_filter_init().
5884 * @see avcodec_register_all()
5886 attribute_deprecated
5887 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5890 * Create and initialize a bitstream filter context given a bitstream
5893 * The returned context must be freed with av_bitstream_filter_close().
5895 * @param name the name of the bitstream filter
5896 * @return a bitstream filter context if a matching filter was found
5897 * and successfully initialized, NULL otherwise
5899 attribute_deprecated
5900 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5905 * This function filters the buffer buf with size buf_size, and places the
5906 * filtered buffer in the buffer pointed to by poutbuf.
5908 * The output buffer must be freed by the caller.
5910 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5911 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5912 * If specified, this must point to the encoder context of the
5913 * output stream the packet is sent to.
5914 * @param args arguments which specify the filter configuration, may be NULL
5915 * @param poutbuf pointer which is updated to point to the filtered buffer
5916 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5917 * @param buf buffer containing the data to filter
5918 * @param buf_size size in bytes of buf
5919 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5920 * @return >= 0 in case of success, or a negative error code in case of failure
5922 * If the return value is positive, an output buffer is allocated and
5923 * is available in *poutbuf, and is distinct from the input buffer.
5925 * If the return value is 0, the output buffer is not allocated and
5926 * should be considered identical to the input buffer, or in case
5927 * *poutbuf was set it points to the input buffer (not necessarily to
5928 * its starting address). A special case is if *poutbuf was set to NULL and
5929 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5931 attribute_deprecated
5932 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5933 AVCodecContext *avctx, const char *args,
5934 uint8_t **poutbuf, int *poutbuf_size,
5935 const uint8_t *buf, int buf_size, int keyframe);
5938 * Release bitstream filter context.
5940 * @param bsf the bitstream filter context created with
5941 * av_bitstream_filter_init(), can be NULL
5943 attribute_deprecated
5944 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5947 * If f is NULL, return the first registered bitstream filter,
5948 * if f is non-NULL, return the next registered bitstream filter
5949 * after f, or NULL if f is the last one.
5951 * This function can be used to iterate over all registered bitstream
5954 attribute_deprecated
5955 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5959 * @return a bitstream filter with the specified name or NULL if no such
5960 * bitstream filter exists.
5962 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5965 * Iterate over all registered bitstream filters.
5967 * @param opaque a pointer where libavcodec will store the iteration state. Must
5968 * point to NULL to start the iteration.
5970 * @return the next registered bitstream filter or NULL when the iteration is
5973 const AVBitStreamFilter *av_bsf_next(void **opaque);
5976 * Allocate a context for a given bitstream filter. The caller must fill in the
5977 * context parameters as described in the documentation and then call
5978 * av_bsf_init() before sending any data to the filter.
5980 * @param filter the filter for which to allocate an instance.
5981 * @param ctx a pointer into which the pointer to the newly-allocated context
5982 * will be written. It must be freed with av_bsf_free() after the
5983 * filtering is done.
5985 * @return 0 on success, a negative AVERROR code on failure
5987 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5990 * Prepare the filter for use, after all the parameters and options have been
5993 int av_bsf_init(AVBSFContext *ctx);
5996 * Submit a packet for filtering.
5998 * After sending each packet, the filter must be completely drained by calling
5999 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
6002 * @param pkt the packet to filter. pkt must contain some payload (i.e data or
6003 * side data must be present in pkt). The bitstream filter will take ownership of
6004 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
6005 * This parameter may be NULL, which signals the end of the stream (i.e. no more
6006 * packets will be sent). That will cause the filter to output any packets it
6007 * may have buffered internally.
6009 * @return 0 on success, a negative AVERROR on error.
6011 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
6014 * Retrieve a filtered packet.
6016 * @param[out] pkt this struct will be filled with the contents of the filtered
6017 * packet. It is owned by the caller and must be freed using
6018 * av_packet_unref() when it is no longer needed.
6019 * This parameter should be "clean" (i.e. freshly allocated
6020 * with av_packet_alloc() or unreffed with av_packet_unref())
6021 * when this function is called. If this function returns
6022 * successfully, the contents of pkt will be completely
6023 * overwritten by the returned data. On failure, pkt is not
6026 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
6027 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
6028 * will be no further output from the filter. Another negative AVERROR value if
6031 * @note one input packet may result in several output packets, so after sending
6032 * a packet with av_bsf_send_packet(), this function needs to be called
6033 * repeatedly until it stops returning 0. It is also possible for a filter to
6034 * output fewer packets than were sent to it, so this function may return
6035 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6037 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6040 * Free a bitstream filter context and everything associated with it; write NULL
6041 * into the supplied pointer.
6043 void av_bsf_free(AVBSFContext **ctx);
6046 * Get the AVClass for AVBSFContext. It can be used in combination with
6047 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6049 * @see av_opt_find().
6051 const AVClass *av_bsf_get_class(void);
6054 * Structure for chain/list of bitstream filters.
6055 * Empty list can be allocated by av_bsf_list_alloc().
6057 typedef struct AVBSFList AVBSFList;
6060 * Allocate empty list of bitstream filters.
6061 * The list must be later freed by av_bsf_list_free()
6062 * or finalized by av_bsf_list_finalize().
6064 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6066 AVBSFList *av_bsf_list_alloc(void);
6069 * Free list of bitstream filters.
6071 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6073 void av_bsf_list_free(AVBSFList **lst);
6076 * Append bitstream filter to the list of bitstream filters.
6078 * @param lst List to append to
6079 * @param bsf Filter context to be appended
6081 * @return >=0 on success, negative AVERROR in case of failure
6083 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6086 * Construct new bitstream filter context given it's name and options
6087 * and append it to the list of bitstream filters.
6089 * @param lst List to append to
6090 * @param bsf_name Name of the bitstream filter
6091 * @param options Options for the bitstream filter, can be set to NULL
6093 * @return >=0 on success, negative AVERROR in case of failure
6095 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6097 * Finalize list of bitstream filters.
6099 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6100 * so the whole chain of bitstream filters can be treated as single filter
6101 * freshly allocated by av_bsf_alloc().
6102 * If the call is successful, @ref AVBSFList structure is freed and lst
6103 * will be set to NULL. In case of failure, caller is responsible for
6104 * freeing the structure by av_bsf_list_free()
6106 * @param lst Filter list structure to be transformed
6107 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6108 * representing the chain of bitstream filters
6110 * @return >=0 on success, negative AVERROR in case of failure
6112 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6115 * Parse string describing list of bitstream filters and create single
6116 * @ref AVBSFContext describing the whole chain of bitstream filters.
6117 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6118 * allocated by av_bsf_alloc().
6120 * @param str String describing chain of bitstream filters in format
6121 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6122 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6123 * representing the chain of bitstream filters
6125 * @return >=0 on success, negative AVERROR in case of failure
6127 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6130 * Get null/pass-through bitstream filter.
6132 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6136 int av_bsf_get_null_filter(AVBSFContext **bsf);
6141 * Same behaviour av_fast_malloc but the buffer has additional
6142 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6144 * In addition the whole buffer will initially and after resizes
6145 * be 0-initialized so that no uninitialized data will ever appear.
6147 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6150 * Same behaviour av_fast_padded_malloc except that buffer will always
6151 * be 0-initialized after call.
6153 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6156 * Encode extradata length to a buffer. Used by xiph codecs.
6158 * @param s buffer to write to; must be at least (v/255+1) bytes long
6159 * @param v size of extradata in bytes
6160 * @return number of bytes written to the buffer.
6162 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6164 #if FF_API_MISSING_SAMPLE
6166 * Log a generic warning message about a missing feature. This function is
6167 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6168 * only, and would normally not be used by applications.
6169 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6170 * a pointer to an AVClass struct
6171 * @param[in] feature string containing the name of the missing feature
6172 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
6173 * If want_sample is non-zero, additional verbiage will be added to the log
6174 * message which tells the user how to report samples to the development
6176 * @deprecated Use avpriv_report_missing_feature() instead.
6178 attribute_deprecated
6179 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
6182 * Log a generic warning message asking for a sample. This function is
6183 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6184 * only, and would normally not be used by applications.
6185 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6186 * a pointer to an AVClass struct
6187 * @param[in] msg string containing an optional message, or NULL if no message
6188 * @deprecated Use avpriv_request_sample() instead.
6190 attribute_deprecated
6191 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
6192 #endif /* FF_API_MISSING_SAMPLE */
6195 * Register the hardware accelerator hwaccel.
6197 void av_register_hwaccel(AVHWAccel *hwaccel);
6200 * If hwaccel is NULL, returns the first registered hardware accelerator,
6201 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6202 * after hwaccel, or NULL if hwaccel is the last one.
6204 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6208 * Lock operation used by lockmgr
6211 AV_LOCK_CREATE, ///< Create a mutex
6212 AV_LOCK_OBTAIN, ///< Lock the mutex
6213 AV_LOCK_RELEASE, ///< Unlock the mutex
6214 AV_LOCK_DESTROY, ///< Free mutex resources
6218 * Register a user provided lock manager supporting the operations
6219 * specified by AVLockOp. The "mutex" argument to the function points
6220 * to a (void *) where the lockmgr should store/get a pointer to a user
6221 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6222 * value left by the last call for all other ops. If the lock manager is
6223 * unable to perform the op then it should leave the mutex in the same
6224 * state as when it was called and return a non-zero value. However,
6225 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6226 * have been successfully destroyed. If av_lockmgr_register succeeds
6227 * it will return a non-negative value, if it fails it will return a
6228 * negative value and destroy all mutex and unregister all callbacks.
6229 * av_lockmgr_register is not thread-safe, it must be called from a
6230 * single thread before any calls which make use of locking are used.
6232 * @param cb User defined callback. av_lockmgr_register invokes calls
6233 * to this callback and the previously registered callback.
6234 * The callback will be used to create more than one mutex
6235 * each of which must be backed by its own underlying locking
6236 * mechanism (i.e. do not use a single static object to
6237 * implement your lock manager). If cb is set to NULL the
6238 * lockmgr will be unregistered.
6240 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6243 * Get the type of the given codec.
6245 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6248 * Get the name of a codec.
6249 * @return a static string identifying the codec; never NULL
6251 const char *avcodec_get_name(enum AVCodecID id);
6254 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6255 * with no corresponding avcodec_close()), 0 otherwise.
6257 int avcodec_is_open(AVCodecContext *s);
6260 * @return a non-zero number if codec is an encoder, zero otherwise
6262 int av_codec_is_encoder(const AVCodec *codec);
6265 * @return a non-zero number if codec is a decoder, zero otherwise
6267 int av_codec_is_decoder(const AVCodec *codec);
6270 * @return descriptor for given codec ID or NULL if no descriptor exists.
6272 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6275 * Iterate over all codec descriptors known to libavcodec.
6277 * @param prev previous descriptor. NULL to get the first descriptor.
6279 * @return next descriptor or NULL after the last descriptor
6281 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6284 * @return codec descriptor with the given name or NULL if no such descriptor
6287 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6290 * Allocate a CPB properties structure and initialize its fields to default
6293 * @param size if non-NULL, the size of the allocated struct will be written
6294 * here. This is useful for embedding it in side data.
6296 * @return the newly allocated struct or NULL on failure
6298 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6304 #endif /* AVCODEC_AVCODEC_H */