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, or
146 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
147 * permit unlimited buffering of input or output.
149 * This API replaces the following legacy functions:
150 * - avcodec_decode_video2() and avcodec_decode_audio4():
151 * Use avcodec_send_packet() to feed input to the decoder, then use
152 * avcodec_receive_frame() to receive decoded frames after each packet.
153 * Unlike with the old video decoding API, multiple frames might result from
154 * a packet. For audio, splitting the input packet into frames by partially
155 * decoding packets becomes transparent to the API user. You never need to
156 * feed an AVPacket to the API twice (unless it is rejected with EAGAIN - then
157 * no data was read from the packet).
158 * Additionally, sending a flush/draining packet is required only once.
159 * - avcodec_encode_video2()/avcodec_encode_audio2():
160 * Use avcodec_send_frame() to feed input to the encoder, then use
161 * avcodec_receive_packet() to receive encoded packets.
162 * Providing user-allocated buffers for avcodec_receive_packet() is not
164 * - The new API does not handle subtitles yet.
166 * Mixing new and old function calls on the same AVCodecContext is not allowed,
167 * and will result in undefined behavior.
169 * Some codecs might require using the new API; using the old API will return
170 * an error when calling it. All codecs support the new API.
172 * A codec is not allowed to return EAGAIN for both sending and receiving. This
173 * would be an invalid state, which could put the codec user into an endless
174 * loop. The API has no concept of time either: it cannot happen that trying to
175 * do avcodec_send_packet() results in EAGAIN, but a repeated call 1 second
176 * later accepts the packet (with no other receive/flush API calls involved).
177 * The API is a strict state machine, and the passage of time is not supposed
178 * to influence it. Some timing-dependent behavior might still be deemed
179 * acceptable in certain cases. But it must never result in both send/receive
180 * returning EAGAIN at the same time at any point. It must also absolutely be
181 * avoided that the current state is "unstable" and can "flip-flop" between
182 * the send/receive APIs allowing progress. For example, it's not allowed that
183 * the codec randomly decides that it actually wants to consume a packet now
184 * instead of returning a frame, after it just returned EAGAIN on an
185 * avcodec_send_packet() call.
190 * @defgroup lavc_core Core functions/structures.
193 * Basic definitions, functions for querying libavcodec capabilities,
194 * allocating core structures, etc.
200 * Identify the syntax and semantics of the bitstream.
201 * The principle is roughly:
202 * Two decoders with the same ID can decode the same streams.
203 * Two encoders with the same ID can encode compatible streams.
204 * There may be slight deviations from the principle due to implementation
207 * If you add a codec ID to this list, add it so that
208 * 1. no value of an existing codec ID changes (that would break ABI),
209 * 2. it is as close as possible to similar codecs
211 * After adding new codec IDs, do not forget to add an entry to the codec
212 * descriptor list and bump libavcodec minor version.
218 AV_CODEC_ID_MPEG1VIDEO,
219 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
221 AV_CODEC_ID_MPEG2VIDEO_XVMC,
222 #endif /* FF_API_XVMC */
233 AV_CODEC_ID_RAWVIDEO,
234 AV_CODEC_ID_MSMPEG4V1,
235 AV_CODEC_ID_MSMPEG4V2,
236 AV_CODEC_ID_MSMPEG4V3,
259 AV_CODEC_ID_INTERPLAY_VIDEO,
266 AV_CODEC_ID_MSVIDEO1,
271 AV_CODEC_ID_TRUEMOTION1,
272 AV_CODEC_ID_VMDVIDEO,
297 AV_CODEC_ID_TRUEMOTION2,
303 AV_CODEC_ID_SMACKVIDEO,
308 AV_CODEC_ID_JPEG2000,
314 AV_CODEC_ID_DSICINVIDEO,
315 AV_CODEC_ID_TIERTEXSEQVIDEO,
323 AV_CODEC_ID_BETHSOFTVID,
335 AV_CODEC_ID_ESCAPE124,
339 AV_CODEC_ID_MOTIONPIXELS,
351 AV_CODEC_ID_FLASHSV2,
352 AV_CODEC_ID_CDGRAPHICS,
355 AV_CODEC_ID_BINKVIDEO,
356 AV_CODEC_ID_IFF_ILBM,
357 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
363 AV_CODEC_ID_A64_MULTI,
364 AV_CODEC_ID_A64_MULTI5,
367 AV_CODEC_ID_LAGARITH,
371 AV_CODEC_ID_WMV3IMAGE,
372 AV_CODEC_ID_VC1IMAGE,
374 AV_CODEC_ID_BMV_VIDEO,
381 AV_CODEC_ID_ZEROCODEC,
390 AV_CODEC_ID_ESCAPE130,
393 AV_CODEC_ID_HNM4_VIDEO,
395 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
397 AV_CODEC_ID_ALIAS_PIX,
398 AV_CODEC_ID_BRENDER_PIX,
399 AV_CODEC_ID_PAF_VIDEO,
412 AV_CODEC_ID_SCREENPRESSO,
415 AV_CODEC_ID_Y41P = 0x8000,
420 AV_CODEC_ID_TARGA_Y216,
432 AV_CODEC_ID_TRUEMOTION2RT,
434 AV_CODEC_ID_MAGICYUV,
435 AV_CODEC_ID_SHEERVIDEO,
442 AV_CODEC_ID_CLEARVIDEO,
446 /* various PCM "codecs" */
447 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
448 AV_CODEC_ID_PCM_S16LE = 0x10000,
449 AV_CODEC_ID_PCM_S16BE,
450 AV_CODEC_ID_PCM_U16LE,
451 AV_CODEC_ID_PCM_U16BE,
454 AV_CODEC_ID_PCM_MULAW,
455 AV_CODEC_ID_PCM_ALAW,
456 AV_CODEC_ID_PCM_S32LE,
457 AV_CODEC_ID_PCM_S32BE,
458 AV_CODEC_ID_PCM_U32LE,
459 AV_CODEC_ID_PCM_U32BE,
460 AV_CODEC_ID_PCM_S24LE,
461 AV_CODEC_ID_PCM_S24BE,
462 AV_CODEC_ID_PCM_U24LE,
463 AV_CODEC_ID_PCM_U24BE,
464 AV_CODEC_ID_PCM_S24DAUD,
465 AV_CODEC_ID_PCM_ZORK,
466 AV_CODEC_ID_PCM_S16LE_PLANAR,
468 AV_CODEC_ID_PCM_F32BE,
469 AV_CODEC_ID_PCM_F32LE,
470 AV_CODEC_ID_PCM_F64BE,
471 AV_CODEC_ID_PCM_F64LE,
472 AV_CODEC_ID_PCM_BLURAY,
475 AV_CODEC_ID_PCM_S8_PLANAR,
476 AV_CODEC_ID_PCM_S24LE_PLANAR,
477 AV_CODEC_ID_PCM_S32LE_PLANAR,
478 AV_CODEC_ID_PCM_S16BE_PLANAR,
480 AV_CODEC_ID_PCM_S64LE = 0x10800,
481 AV_CODEC_ID_PCM_S64BE,
482 AV_CODEC_ID_PCM_F16LE,
483 AV_CODEC_ID_PCM_F24LE,
485 /* various ADPCM codecs */
486 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
487 AV_CODEC_ID_ADPCM_IMA_WAV,
488 AV_CODEC_ID_ADPCM_IMA_DK3,
489 AV_CODEC_ID_ADPCM_IMA_DK4,
490 AV_CODEC_ID_ADPCM_IMA_WS,
491 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
492 AV_CODEC_ID_ADPCM_MS,
493 AV_CODEC_ID_ADPCM_4XM,
494 AV_CODEC_ID_ADPCM_XA,
495 AV_CODEC_ID_ADPCM_ADX,
496 AV_CODEC_ID_ADPCM_EA,
497 AV_CODEC_ID_ADPCM_G726,
498 AV_CODEC_ID_ADPCM_CT,
499 AV_CODEC_ID_ADPCM_SWF,
500 AV_CODEC_ID_ADPCM_YAMAHA,
501 AV_CODEC_ID_ADPCM_SBPRO_4,
502 AV_CODEC_ID_ADPCM_SBPRO_3,
503 AV_CODEC_ID_ADPCM_SBPRO_2,
504 AV_CODEC_ID_ADPCM_THP,
505 AV_CODEC_ID_ADPCM_IMA_AMV,
506 AV_CODEC_ID_ADPCM_EA_R1,
507 AV_CODEC_ID_ADPCM_EA_R3,
508 AV_CODEC_ID_ADPCM_EA_R2,
509 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
510 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
511 AV_CODEC_ID_ADPCM_EA_XAS,
512 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
513 AV_CODEC_ID_ADPCM_IMA_ISS,
514 AV_CODEC_ID_ADPCM_G722,
515 AV_CODEC_ID_ADPCM_IMA_APC,
516 AV_CODEC_ID_ADPCM_VIMA,
517 #if FF_API_VIMA_DECODER
518 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
521 AV_CODEC_ID_ADPCM_AFC = 0x11800,
522 AV_CODEC_ID_ADPCM_IMA_OKI,
523 AV_CODEC_ID_ADPCM_DTK,
524 AV_CODEC_ID_ADPCM_IMA_RAD,
525 AV_CODEC_ID_ADPCM_G726LE,
526 AV_CODEC_ID_ADPCM_THP_LE,
527 AV_CODEC_ID_ADPCM_PSX,
528 AV_CODEC_ID_ADPCM_AICA,
529 AV_CODEC_ID_ADPCM_IMA_DAT4,
530 AV_CODEC_ID_ADPCM_MTAF,
533 AV_CODEC_ID_AMR_NB = 0x12000,
536 /* RealAudio codecs*/
537 AV_CODEC_ID_RA_144 = 0x13000,
540 /* various DPCM codecs */
541 AV_CODEC_ID_ROQ_DPCM = 0x14000,
542 AV_CODEC_ID_INTERPLAY_DPCM,
543 AV_CODEC_ID_XAN_DPCM,
544 AV_CODEC_ID_SOL_DPCM,
546 AV_CODEC_ID_SDX2_DPCM = 0x14800,
549 AV_CODEC_ID_MP2 = 0x15000,
550 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
560 AV_CODEC_ID_VMDAUDIO,
566 AV_CODEC_ID_WESTWOOD_SND1,
567 AV_CODEC_ID_GSM, ///< as in Berlin toast format
570 AV_CODEC_ID_TRUESPEECH,
572 AV_CODEC_ID_SMACKAUDIO,
575 AV_CODEC_ID_DSICINAUDIO,
577 AV_CODEC_ID_MUSEPACK7,
579 AV_CODEC_ID_GSM_MS, /* as found in WAV */
585 AV_CODEC_ID_NELLYMOSER,
586 AV_CODEC_ID_MUSEPACK8,
588 AV_CODEC_ID_WMAVOICE,
590 AV_CODEC_ID_WMALOSSLESS,
599 AV_CODEC_ID_BINKAUDIO_RDFT,
600 AV_CODEC_ID_BINKAUDIO_DCT,
601 AV_CODEC_ID_AAC_LATM,
606 AV_CODEC_ID_8SVX_EXP,
607 AV_CODEC_ID_8SVX_FIB,
608 AV_CODEC_ID_BMV_AUDIO,
613 AV_CODEC_ID_COMFORT_NOISE,
615 AV_CODEC_ID_METASOUND,
616 AV_CODEC_ID_PAF_AUDIO,
620 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
622 AV_CODEC_ID_SONIC_LS,
625 AV_CODEC_ID_DSD_LSBF,
626 AV_CODEC_ID_DSD_MSBF,
627 AV_CODEC_ID_DSD_LSBF_PLANAR,
628 AV_CODEC_ID_DSD_MSBF_PLANAR,
630 AV_CODEC_ID_INTERPLAY_ACM,
634 AV_CODEC_ID_ATRAC3AL,
635 AV_CODEC_ID_ATRAC3PAL,
637 /* subtitle codecs */
638 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
639 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
640 AV_CODEC_ID_DVB_SUBTITLE,
641 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
644 AV_CODEC_ID_MOV_TEXT,
645 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
646 AV_CODEC_ID_DVB_TELETEXT,
649 AV_CODEC_ID_MICRODVD = 0x17800,
653 AV_CODEC_ID_REALTEXT,
655 AV_CODEC_ID_SUBVIEWER1,
656 AV_CODEC_ID_SUBVIEWER,
663 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
665 /* other specific kind of codecs (generally used for attachments) */
666 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
667 AV_CODEC_ID_TTF = 0x18000,
669 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
670 AV_CODEC_ID_BINTEXT = 0x18800,
674 AV_CODEC_ID_SMPTE_KLV,
676 AV_CODEC_ID_TIMED_ID3,
677 AV_CODEC_ID_BIN_DATA,
680 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
682 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
683 * stream (only used by libavformat) */
684 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
685 * stream (only used by libavformat) */
686 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
687 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
691 * This struct describes the properties of a single codec described by an
693 * @see avcodec_descriptor_get()
695 typedef struct AVCodecDescriptor {
697 enum AVMediaType type;
699 * Name of the codec described by this descriptor. It is non-empty and
700 * unique for each codec descriptor. It should contain alphanumeric
701 * characters and '_' only.
705 * A more descriptive name for this codec. May be NULL.
707 const char *long_name;
709 * Codec properties, a combination of AV_CODEC_PROP_* flags.
713 * MIME type(s) associated with the codec.
714 * May be NULL; if not, a NULL-terminated array of MIME types.
715 * The first item is always non-NULL and is the preferred MIME type.
717 const char *const *mime_types;
719 * If non-NULL, an array of profiles recognized for this codec.
720 * Terminated with FF_PROFILE_UNKNOWN.
722 const struct AVProfile *profiles;
726 * Codec uses only intra compression.
729 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
731 * Codec supports lossy compression. Audio and video codecs only.
732 * @note a codec may support both lossy and lossless
735 #define AV_CODEC_PROP_LOSSY (1 << 1)
737 * Codec supports lossless compression. Audio and video codecs only.
739 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
741 * Codec supports frame reordering. That is, the coded order (the order in which
742 * the encoded packets are output by the encoders / stored / input to the
743 * decoders) may be different from the presentation order of the corresponding
746 * For codecs that do not have this property set, PTS and DTS should always be
749 #define AV_CODEC_PROP_REORDER (1 << 3)
751 * Subtitle codec is bitmap based
752 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
754 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
756 * Subtitle codec is text based.
757 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
759 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
762 * @ingroup lavc_decoding
763 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
764 * This is mainly needed because some optimized bitstream readers read
765 * 32 or 64 bit at once and could read over the end.<br>
766 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
767 * MPEG bitstreams could cause overread and segfault.
769 #define AV_INPUT_BUFFER_PADDING_SIZE 32
772 * @ingroup lavc_encoding
773 * minimum encoding buffer size
774 * Used to avoid some checks during header writing.
776 #define AV_INPUT_BUFFER_MIN_SIZE 16384
778 #if FF_API_WITHOUT_PREFIX
780 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
782 #define FF_INPUT_BUFFER_PADDING_SIZE 32
785 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
787 #define FF_MIN_BUFFER_SIZE 16384
788 #endif /* FF_API_WITHOUT_PREFIX */
791 * @ingroup lavc_encoding
792 * motion estimation type.
793 * @deprecated use codec private option instead
795 #if FF_API_MOTION_EST
797 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
801 ME_EPZS, ///< enhanced predictive zonal search
802 ME_X1, ///< reserved for experiments
803 ME_HEX, ///< hexagon based search
804 ME_UMH, ///< uneven multi-hexagon search
805 ME_TESA, ///< transformed exhaustive search algorithm
806 ME_ITER=50, ///< iterative search
811 * @ingroup lavc_decoding
814 /* We leave some space between them for extensions (drop some
815 * keyframes for intra-only or drop just some bidir frames). */
816 AVDISCARD_NONE =-16, ///< discard nothing
817 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
818 AVDISCARD_NONREF = 8, ///< discard all non reference
819 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
820 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
821 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
822 AVDISCARD_ALL = 48, ///< discard all
825 enum AVAudioServiceType {
826 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
827 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
828 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
829 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
830 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
831 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
832 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
833 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
834 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
835 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
839 * @ingroup lavc_encoding
841 typedef struct RcOverride{
844 int qscale; // If this is 0 then quality_factor will be used instead.
845 float quality_factor;
848 #if FF_API_MAX_BFRAMES
850 * @deprecated there is no libavcodec-wide limit on the number of B-frames
852 #define FF_MAX_B_FRAMES 16
856 These flags can be passed in AVCodecContext.flags before initialization.
857 Note: Not everything is supported yet.
861 * Allow decoders to produce frames with data planes that are not aligned
862 * to CPU requirements (e.g. due to cropping).
864 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
868 #define AV_CODEC_FLAG_QSCALE (1 << 1)
870 * 4 MV per MB allowed / advanced prediction for H.263.
872 #define AV_CODEC_FLAG_4MV (1 << 2)
874 * Output even those frames that might be corrupted.
876 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
880 #define AV_CODEC_FLAG_QPEL (1 << 4)
882 * Use internal 2pass ratecontrol in first pass mode.
884 #define AV_CODEC_FLAG_PASS1 (1 << 9)
886 * Use internal 2pass ratecontrol in second pass mode.
888 #define AV_CODEC_FLAG_PASS2 (1 << 10)
892 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
894 * Only decode/encode grayscale.
896 #define AV_CODEC_FLAG_GRAY (1 << 13)
898 * error[?] variables will be set during encoding.
900 #define AV_CODEC_FLAG_PSNR (1 << 15)
902 * Input bitstream might be truncated at a random location
903 * instead of only at frame boundaries.
905 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
907 * Use interlaced DCT.
909 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
913 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
915 * Place global headers in extradata instead of every keyframe.
917 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
919 * Use only bitexact stuff (except (I)DCT).
921 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
922 /* Fx : Flag for H.263+ extra options */
924 * H.263 advanced intra coding / MPEG-4 AC prediction
926 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
928 * interlaced motion estimation
930 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
931 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
934 * Allow non spec compliant speedup tricks.
936 #define AV_CODEC_FLAG2_FAST (1 << 0)
938 * Skip bitstream encoding.
940 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
942 * Place global headers at every keyframe instead of in extradata.
944 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
947 * timecode is in drop frame format. DEPRECATED!!!!
949 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
952 * Input bitstream might be truncated at a packet boundaries
953 * instead of only at frame boundaries.
955 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
957 * Discard cropping information from SPS.
959 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
962 * Show all frames before the first keyframe
964 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
966 * Export motion vectors through frame side data
968 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
970 * Do not skip samples and export skip information as frame side data
972 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
974 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
976 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
978 /* Unsupported options :
979 * Syntax Arithmetic coding (SAC)
980 * Reference Picture Selection
981 * Independent Segment Decoding */
983 /* codec capabilities */
986 * Decoder can use draw_horiz_band callback.
988 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
990 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
991 * If not set, it might not use get_buffer() at all or use operations that
992 * assume the buffer was allocated by avcodec_default_get_buffer.
994 #define AV_CODEC_CAP_DR1 (1 << 1)
995 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
997 * Encoder or decoder requires flushing with NULL input at the end in order to
998 * give the complete and correct output.
1000 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1001 * with NULL data. The user can still send NULL data to the public encode
1002 * or decode function, but libavcodec will not pass it along to the codec
1003 * unless this flag is set.
1006 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1007 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1011 * The encoder needs to be fed with NULL data at the end of encoding until the
1012 * encoder no longer returns data.
1014 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1015 * flag also means that the encoder must set the pts and duration for
1016 * each output packet. If this flag is not set, the pts and duration will
1017 * be determined by libavcodec from the input frame.
1019 #define AV_CODEC_CAP_DELAY (1 << 5)
1021 * Codec can be fed a final frame with a smaller size.
1022 * This can be used to prevent truncation of the last audio samples.
1024 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1026 #if FF_API_CAP_VDPAU
1028 * Codec can export data for HW decoding (VDPAU).
1030 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
1034 * Codec can output multiple frames per AVPacket
1035 * Normally demuxers return one frame at a time, demuxers which do not do
1036 * are connected to a parser to split what they return into proper frames.
1037 * This flag is reserved to the very rare category of codecs which have a
1038 * bitstream that cannot be split into frames without timeconsuming
1039 * operations like full decoding. Demuxers carrying such bitstreams thus
1040 * may return multiple frames in a packet. This has many disadvantages like
1041 * prohibiting stream copy in many cases thus it should only be considered
1044 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1046 * Codec is experimental and is thus avoided in favor of non experimental
1049 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1051 * Codec should fill in channel configuration and samplerate instead of container
1053 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1055 * Codec supports frame-level multithreading.
1057 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1059 * Codec supports slice-based (or partition-based) multithreading.
1061 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1063 * Codec supports changed parameters at any point.
1065 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1067 * Codec supports avctx->thread_count == 0 (auto).
1069 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1071 * Audio encoder supports receiving a different number of samples in each call.
1073 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1075 * Decoder is not a preferred choice for probing.
1076 * This indicates that the decoder is not a good choice for probing.
1077 * It could for example be an expensive to spin up hardware decoder,
1078 * or it could simply not provide a lot of useful information about
1080 * A decoder marked with this flag should only be used as last resort
1081 * choice for probing.
1083 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1085 * Codec is intra only.
1087 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1089 * Codec is lossless.
1091 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1094 #if FF_API_WITHOUT_PREFIX
1096 * Allow decoders to produce frames with data planes that are not aligned
1097 * to CPU requirements (e.g. due to cropping).
1099 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1100 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1101 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1102 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1103 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1106 * @deprecated use the "gmc" private option of the libxvid encoder
1108 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1112 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1113 * mpegvideo encoders
1115 #define CODEC_FLAG_MV0 0x0040
1117 #if FF_API_INPUT_PRESERVED
1119 * @deprecated passing reference-counted frames to the encoders replaces this
1122 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1124 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1125 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1126 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1129 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1132 #define CODEC_FLAG_EMU_EDGE 0x4000
1134 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1135 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1137 #if FF_API_NORMALIZE_AQP
1139 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1140 * mpegvideo encoders
1142 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1144 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1145 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1146 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1147 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1148 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1149 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1150 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1151 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1152 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1153 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1154 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1155 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1156 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1158 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1159 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1160 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1161 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1163 /* Unsupported options :
1164 * Syntax Arithmetic coding (SAC)
1165 * Reference Picture Selection
1166 * Independent Segment Decoding */
1168 /* codec capabilities */
1170 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1172 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1173 * If not set, it might not use get_buffer() at all or use operations that
1174 * assume the buffer was allocated by avcodec_default_get_buffer.
1176 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1177 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1179 /* Codec can export data for HW decoding. This flag indicates that
1180 * the codec would call get_format() with list that might contain HW accelerated
1181 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1182 * including raw image format.
1183 * The application can use the passed context to determine bitstream version,
1184 * chroma format, resolution etc.
1186 #define CODEC_CAP_HWACCEL 0x0010
1187 #endif /* FF_API_XVMC */
1189 * Encoder or decoder requires flushing with NULL input at the end in order to
1190 * give the complete and correct output.
1192 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1193 * with NULL data. The user can still send NULL data to the public encode
1194 * or decode function, but libavcodec will not pass it along to the codec
1195 * unless this flag is set.
1198 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1199 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1203 * The encoder needs to be fed with NULL data at the end of encoding until the
1204 * encoder no longer returns data.
1206 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1207 * flag also means that the encoder must set the pts and duration for
1208 * each output packet. If this flag is not set, the pts and duration will
1209 * be determined by libavcodec from the input frame.
1211 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1213 * Codec can be fed a final frame with a smaller size.
1214 * This can be used to prevent truncation of the last audio samples.
1216 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1217 #if FF_API_CAP_VDPAU
1219 * Codec can export data for HW decoding (VDPAU).
1221 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1224 * Codec can output multiple frames per AVPacket
1225 * Normally demuxers return one frame at a time, demuxers which do not do
1226 * are connected to a parser to split what they return into proper frames.
1227 * This flag is reserved to the very rare category of codecs which have a
1228 * bitstream that cannot be split into frames without timeconsuming
1229 * operations like full decoding. Demuxers carrying such bitstreams thus
1230 * may return multiple frames in a packet. This has many disadvantages like
1231 * prohibiting stream copy in many cases thus it should only be considered
1234 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1236 * Codec is experimental and is thus avoided in favor of non experimental
1239 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1241 * Codec should fill in channel configuration and samplerate instead of container
1243 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1244 #if FF_API_NEG_LINESIZES
1246 * @deprecated no codecs use this capability
1248 #define CODEC_CAP_NEG_LINESIZES 0x0800
1251 * Codec supports frame-level multithreading.
1253 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1255 * Codec supports slice-based (or partition-based) multithreading.
1257 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1259 * Codec supports changed parameters at any point.
1261 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1263 * Codec supports avctx->thread_count == 0 (auto).
1265 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1267 * Audio encoder supports receiving a different number of samples in each call.
1269 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1271 * Codec is intra only.
1273 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1275 * Codec is lossless.
1277 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1280 * HWAccel is experimental and is thus avoided in favor of non experimental
1283 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1284 #endif /* FF_API_WITHOUT_PREFIX */
1287 //The following defines may change, don't expect compatibility if you use them.
1288 #define MB_TYPE_INTRA4x4 0x0001
1289 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1290 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1291 #define MB_TYPE_16x16 0x0008
1292 #define MB_TYPE_16x8 0x0010
1293 #define MB_TYPE_8x16 0x0020
1294 #define MB_TYPE_8x8 0x0040
1295 #define MB_TYPE_INTERLACED 0x0080
1296 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1297 #define MB_TYPE_ACPRED 0x0200
1298 #define MB_TYPE_GMC 0x0400
1299 #define MB_TYPE_SKIP 0x0800
1300 #define MB_TYPE_P0L0 0x1000
1301 #define MB_TYPE_P1L0 0x2000
1302 #define MB_TYPE_P0L1 0x4000
1303 #define MB_TYPE_P1L1 0x8000
1304 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1305 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1306 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1307 #define MB_TYPE_QUANT 0x00010000
1308 #define MB_TYPE_CBP 0x00020000
1309 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1314 * This specifies the area which should be displayed.
1315 * Note there may be multiple such areas for one frame.
1317 typedef struct AVPanScan{
1320 * - encoding: Set by user.
1321 * - decoding: Set by libavcodec.
1326 * width and height in 1/16 pel
1327 * - encoding: Set by user.
1328 * - decoding: Set by libavcodec.
1334 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1335 * - encoding: Set by user.
1336 * - decoding: Set by libavcodec.
1338 int16_t position[3][2];
1342 * This structure describes the bitrate properties of an encoded bitstream. It
1343 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1344 * parameters for H.264/HEVC.
1346 typedef struct AVCPBProperties {
1348 * Maximum bitrate of the stream, in bits per second.
1349 * Zero if unknown or unspecified.
1353 * Minimum bitrate of the stream, in bits per second.
1354 * Zero if unknown or unspecified.
1358 * Average bitrate of the stream, in bits per second.
1359 * Zero if unknown or unspecified.
1364 * The size of the buffer to which the ratecontrol is applied, in bits.
1365 * Zero if unknown or unspecified.
1370 * The delay between the time the packet this structure is associated with
1371 * is received and the time when it should be decoded, in periods of a 27MHz
1374 * UINT64_MAX when unknown or unspecified.
1379 #if FF_API_QSCALE_TYPE
1380 #define FF_QSCALE_TYPE_MPEG1 0
1381 #define FF_QSCALE_TYPE_MPEG2 1
1382 #define FF_QSCALE_TYPE_H264 2
1383 #define FF_QSCALE_TYPE_VP56 3
1387 * The decoder will keep a reference to the frame and may reuse it later.
1389 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1392 * @defgroup lavc_packet AVPacket
1394 * Types and functions for working with AVPacket.
1397 enum AVPacketSideDataType {
1398 AV_PKT_DATA_PALETTE,
1401 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1402 * that the extradata buffer was changed and the receiving side should
1403 * act upon it appropriately. The new extradata is embedded in the side
1404 * data buffer and should be immediately used for processing the current
1407 AV_PKT_DATA_NEW_EXTRADATA,
1410 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1413 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1414 * s32le channel_count
1415 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1416 * u64le channel_layout
1417 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1419 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1424 AV_PKT_DATA_PARAM_CHANGE,
1427 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1428 * structures with info about macroblocks relevant to splitting the
1429 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1430 * That is, it does not necessarily contain info about all macroblocks,
1431 * as long as the distance between macroblocks in the info is smaller
1432 * than the target payload size.
1433 * Each MB info structure is 12 bytes, and is laid out as follows:
1435 * u32le bit offset from the start of the packet
1436 * u8 current quantizer at the start of the macroblock
1438 * u16le macroblock address within the GOB
1439 * u8 horizontal MV predictor
1440 * u8 vertical MV predictor
1441 * u8 horizontal MV predictor for block number 3
1442 * u8 vertical MV predictor for block number 3
1445 AV_PKT_DATA_H263_MB_INFO,
1448 * This side data should be associated with an audio stream and contains
1449 * ReplayGain information in form of the AVReplayGain struct.
1451 AV_PKT_DATA_REPLAYGAIN,
1454 * This side data contains a 3x3 transformation matrix describing an affine
1455 * transformation that needs to be applied to the decoded video frames for
1456 * correct presentation.
1458 * See libavutil/display.h for a detailed description of the data.
1460 AV_PKT_DATA_DISPLAYMATRIX,
1463 * This side data should be associated with a video stream and contains
1464 * Stereoscopic 3D information in form of the AVStereo3D struct.
1466 AV_PKT_DATA_STEREO3D,
1469 * This side data should be associated with an audio stream and corresponds
1470 * to enum AVAudioServiceType.
1472 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1475 * This side data contains quality related information from the encoder.
1477 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1481 * u64le[error count] sum of squared differences between encoder in and output
1484 AV_PKT_DATA_QUALITY_STATS,
1487 * This side data contains an integer value representing the stream index
1488 * of a "fallback" track. A fallback track indicates an alternate
1489 * track to use when the current track can not be decoded for some reason.
1490 * e.g. no decoder available for codec.
1492 AV_PKT_DATA_FALLBACK_TRACK,
1495 * This side data corresponds to the AVCPBProperties struct.
1497 AV_PKT_DATA_CPB_PROPERTIES,
1500 * Recommmends skipping the specified number of samples
1502 * u32le number of samples to skip from start of this packet
1503 * u32le number of samples to skip from end of this packet
1504 * u8 reason for start skip
1505 * u8 reason for end skip (0=padding silence, 1=convergence)
1508 AV_PKT_DATA_SKIP_SAMPLES=70,
1511 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1512 * the packet may contain "dual mono" audio specific to Japanese DTV
1513 * and if it is true, recommends only the selected channel to be used.
1515 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1518 AV_PKT_DATA_JP_DUALMONO,
1521 * A list of zero terminated key/value strings. There is no end marker for
1522 * the list, so it is required to rely on the side data size to stop.
1524 AV_PKT_DATA_STRINGS_METADATA,
1527 * Subtitle event position
1535 AV_PKT_DATA_SUBTITLE_POSITION,
1538 * Data found in BlockAdditional element of matroska container. There is
1539 * no end marker for the data, so it is required to rely on the side data
1540 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1543 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1546 * The optional first identifier line of a WebVTT cue.
1548 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1551 * The optional settings (rendering instructions) that immediately
1552 * follow the timestamp specifier of a WebVTT cue.
1554 AV_PKT_DATA_WEBVTT_SETTINGS,
1557 * A list of zero terminated key/value strings. There is no end marker for
1558 * the list, so it is required to rely on the side data size to stop. This
1559 * side data includes updated metadata which appeared in the stream.
1561 AV_PKT_DATA_METADATA_UPDATE,
1564 * MPEGTS stream ID, this is required to pass the stream ID
1565 * information from the demuxer to the corresponding muxer.
1567 AV_PKT_DATA_MPEGTS_STREAM_ID,
1570 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1571 * should be associated with a video stream and containts data in the form
1572 * of the AVMasteringDisplayMetadata struct.
1574 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1577 * This side data should be associated with a video stream and corresponds
1578 * to the AVSphericalMapping structure.
1580 AV_PKT_DATA_SPHERICAL,
1583 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1585 typedef struct AVPacketSideData {
1588 enum AVPacketSideDataType type;
1592 * This structure stores compressed data. It is typically exported by demuxers
1593 * and then passed as input to decoders, or received as output from encoders and
1594 * then passed to muxers.
1596 * For video, it should typically contain one compressed frame. For audio it may
1597 * contain several compressed frames. Encoders are allowed to output empty
1598 * packets, with no compressed data, containing only side data
1599 * (e.g. to update some stream parameters at the end of encoding).
1601 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1602 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1603 * without libavcodec and libavformat major bump.
1605 * The semantics of data ownership depends on the buf field.
1606 * If it is set, the packet data is dynamically allocated and is
1607 * valid indefinitely until a call to av_packet_unref() reduces the
1608 * reference count to 0.
1610 * If the buf field is not set av_packet_ref() would make a copy instead
1611 * of increasing the reference count.
1613 * The side data is always allocated with av_malloc(), copied by
1614 * av_packet_ref() and freed by av_packet_unref().
1616 * @see av_packet_ref
1617 * @see av_packet_unref
1619 typedef struct AVPacket {
1621 * A reference to the reference-counted buffer where the packet data is
1623 * May be NULL, then the packet data is not reference-counted.
1627 * Presentation timestamp in AVStream->time_base units; the time at which
1628 * the decompressed packet will be presented to the user.
1629 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1630 * pts MUST be larger or equal to dts as presentation cannot happen before
1631 * decompression, unless one wants to view hex dumps. Some formats misuse
1632 * the terms dts and pts/cts to mean something different. Such timestamps
1633 * must be converted to true pts/dts before they are stored in AVPacket.
1637 * Decompression timestamp in AVStream->time_base units; the time at which
1638 * the packet is decompressed.
1639 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1646 * A combination of AV_PKT_FLAG values
1650 * Additional packet data that can be provided by the container.
1651 * Packet can contain several types of side information.
1653 AVPacketSideData *side_data;
1654 int side_data_elems;
1657 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1658 * Equals next_pts - this_pts in presentation order.
1662 int64_t pos; ///< byte position in stream, -1 if unknown
1664 #if FF_API_CONVERGENCE_DURATION
1666 * @deprecated Same as the duration field, but as int64_t. This was required
1667 * for Matroska subtitles, whose duration values could overflow when the
1668 * duration field was still an int.
1670 attribute_deprecated
1671 int64_t convergence_duration;
1674 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1675 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1677 * Flag is used to discard packets which are required to maintain valid
1678 * decoder state but are not required for output and should be dropped
1681 #define AV_PKT_FLAG_DISCARD 0x0004
1683 enum AVSideDataParamChangeFlags {
1684 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1685 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1686 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1687 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1693 struct AVCodecInternal;
1697 AV_FIELD_PROGRESSIVE,
1698 AV_FIELD_TT, //< Top coded_first, top displayed first
1699 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1700 AV_FIELD_TB, //< Top coded first, bottom displayed first
1701 AV_FIELD_BT, //< Bottom coded first, top displayed first
1705 * main external API structure.
1706 * New fields can be added to the end with minor version bumps.
1707 * Removal, reordering and changes to existing fields require a major
1709 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1711 * The name string for AVOptions options matches the associated command line
1712 * parameter name and can be found in libavcodec/options_table.h
1713 * The AVOption/command line parameter names differ in some cases from the C
1714 * structure field names for historic reasons or brevity.
1715 * sizeof(AVCodecContext) must not be used outside libav*.
1717 typedef struct AVCodecContext {
1719 * information on struct for av_log
1720 * - set by avcodec_alloc_context3
1722 const AVClass *av_class;
1723 int log_level_offset;
1725 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1726 const struct AVCodec *codec;
1727 #if FF_API_CODEC_NAME
1729 * @deprecated this field is not used for anything in libavcodec
1731 attribute_deprecated
1732 char codec_name[32];
1734 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1737 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1738 * This is used to work around some encoder bugs.
1739 * A demuxer should set this to what is stored in the field used to identify the codec.
1740 * If there are multiple such fields in a container then the demuxer should choose the one
1741 * which maximizes the information about the used codec.
1742 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1743 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1744 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1746 * - encoding: Set by user, if not then the default based on codec_id will be used.
1747 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1749 unsigned int codec_tag;
1751 #if FF_API_STREAM_CODEC_TAG
1753 * @deprecated this field is unused
1755 attribute_deprecated
1756 unsigned int stream_codec_tag;
1762 * Private context used for internal data.
1764 * Unlike priv_data, this is not codec-specific. It is used in general
1765 * libavcodec functions.
1767 struct AVCodecInternal *internal;
1770 * Private data of the user, can be used to carry app specific stuff.
1771 * - encoding: Set by user.
1772 * - decoding: Set by user.
1777 * the average bitrate
1778 * - encoding: Set by user; unused for constant quantizer encoding.
1779 * - decoding: Set by user, may be overwritten by libavcodec
1780 * if this info is available in the stream
1785 * number of bits the bitstream is allowed to diverge from the reference.
1786 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1787 * - encoding: Set by user; unused for constant quantizer encoding.
1788 * - decoding: unused
1790 int bit_rate_tolerance;
1793 * Global quality for codecs which cannot change it per frame.
1794 * This should be proportional to MPEG-1/2/4 qscale.
1795 * - encoding: Set by user.
1796 * - decoding: unused
1801 * - encoding: Set by user.
1802 * - decoding: unused
1804 int compression_level;
1805 #define FF_COMPRESSION_DEFAULT -1
1809 * - encoding: Set by user.
1810 * - decoding: Set by user.
1816 * - encoding: Set by user.
1817 * - decoding: Set by user.
1822 * some codecs need / can use extradata like Huffman tables.
1823 * MJPEG: Huffman tables
1824 * rv10: additional flags
1825 * MPEG-4: global headers (they can be in the bitstream or here)
1826 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1827 * than extradata_size to avoid problems if it is read with the bitstream reader.
1828 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1829 * - encoding: Set/allocated/freed by libavcodec.
1830 * - decoding: Set/allocated/freed by user.
1836 * This is the fundamental unit of time (in seconds) in terms
1837 * of which frame timestamps are represented. For fixed-fps content,
1838 * timebase should be 1/framerate and timestamp increments should be
1840 * This often, but not always is the inverse of the frame rate or field rate
1841 * for video. 1/time_base is not the average frame rate if the frame rate is not
1844 * Like containers, elementary streams also can store timestamps, 1/time_base
1845 * is the unit in which these timestamps are specified.
1846 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1847 * vop_time_increment_resolution and fixed_vop_rate
1848 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1850 * - encoding: MUST be set by user.
1851 * - decoding: the use of this field for decoding is deprecated.
1852 * Use framerate instead.
1854 AVRational time_base;
1857 * For some codecs, the time base is closer to the field rate than the frame rate.
1858 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1859 * if no telecine is used ...
1861 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1863 int ticks_per_frame;
1868 * Encoding: Number of frames delay there will be from the encoder input to
1869 * the decoder output. (we assume the decoder matches the spec)
1870 * Decoding: Number of frames delay in addition to what a standard decoder
1871 * as specified in the spec would produce.
1874 * Number of frames the decoded output will be delayed relative to the
1878 * For encoding, this field is unused (see initial_padding).
1880 * For decoding, this is the number of samples the decoder needs to
1881 * output before the decoder's output is valid. When seeking, you should
1882 * start decoding this many samples prior to your desired seek point.
1884 * - encoding: Set by libavcodec.
1885 * - decoding: Set by libavcodec.
1892 * picture width / height.
1894 * @note Those fields may not match the values of the last
1895 * AVFrame output by avcodec_decode_video2 due frame
1898 * - encoding: MUST be set by user.
1899 * - decoding: May be set by the user before opening the decoder if known e.g.
1900 * from the container. Some decoders will require the dimensions
1901 * to be set by the caller. During decoding, the decoder may
1902 * overwrite those values as required while parsing the data.
1907 * Bitstream width / height, may be different from width/height e.g. when
1908 * the decoded frame is cropped before being output or lowres is enabled.
1910 * @note Those field may not match the value of the last
1911 * AVFrame output by avcodec_receive_frame() due frame
1914 * - encoding: unused
1915 * - decoding: May be set by the user before opening the decoder if known
1916 * e.g. from the container. During decoding, the decoder may
1917 * overwrite those values as required while parsing the data.
1919 int coded_width, coded_height;
1921 #if FF_API_ASPECT_EXTENDED
1922 #define FF_ASPECT_EXTENDED 15
1926 * the number of pictures in a group of pictures, or 0 for intra_only
1927 * - encoding: Set by user.
1928 * - decoding: unused
1933 * Pixel format, see AV_PIX_FMT_xxx.
1934 * May be set by the demuxer if known from headers.
1935 * May be overridden by the decoder if it knows better.
1937 * @note This field may not match the value of the last
1938 * AVFrame output by avcodec_receive_frame() due frame
1941 * - encoding: Set by user.
1942 * - decoding: Set by user if known, overridden by libavcodec while
1945 enum AVPixelFormat pix_fmt;
1947 #if FF_API_MOTION_EST
1949 * This option does nothing
1950 * @deprecated use codec private options instead
1952 attribute_deprecated int me_method;
1956 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1957 * decoder to draw a horizontal band. It improves cache usage. Not
1958 * all codecs can do that. You must check the codec capabilities
1960 * When multithreading is used, it may be called from multiple threads
1961 * at the same time; threads might draw different parts of the same AVFrame,
1962 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1964 * The function is also used by hardware acceleration APIs.
1965 * It is called at least once during frame decoding to pass
1966 * the data needed for hardware render.
1967 * In that mode instead of pixel data, AVFrame points to
1968 * a structure specific to the acceleration API. The application
1969 * reads the structure and can change some fields to indicate progress
1971 * - encoding: unused
1972 * - decoding: Set by user.
1973 * @param height the height of the slice
1974 * @param y the y position of the slice
1975 * @param type 1->top field, 2->bottom field, 3->frame
1976 * @param offset offset into the AVFrame.data from which the slice should be read
1978 void (*draw_horiz_band)(struct AVCodecContext *s,
1979 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1980 int y, int type, int height);
1983 * callback to negotiate the pixelFormat
1984 * @param fmt is the list of formats which are supported by the codec,
1985 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1986 * The first is always the native one.
1987 * @note The callback may be called again immediately if initialization for
1988 * the selected (hardware-accelerated) pixel format failed.
1989 * @warning Behavior is undefined if the callback returns a value not
1990 * in the fmt list of formats.
1991 * @return the chosen format
1992 * - encoding: unused
1993 * - decoding: Set by user, if not set the native format will be chosen.
1995 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1998 * maximum number of B-frames between non-B-frames
1999 * Note: The output will be delayed by max_b_frames+1 relative to the input.
2000 * - encoding: Set by user.
2001 * - decoding: unused
2006 * qscale factor between IP and B-frames
2007 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
2008 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2009 * - encoding: Set by user.
2010 * - decoding: unused
2012 float b_quant_factor;
2014 #if FF_API_RC_STRATEGY
2015 /** @deprecated use codec private option instead */
2016 attribute_deprecated int rc_strategy;
2017 #define FF_RC_STRATEGY_XVID 1
2020 #if FF_API_PRIVATE_OPT
2021 /** @deprecated use encoder private options instead */
2022 attribute_deprecated
2023 int b_frame_strategy;
2027 * qscale offset between IP and B-frames
2028 * - encoding: Set by user.
2029 * - decoding: unused
2031 float b_quant_offset;
2034 * Size of the frame reordering buffer in the decoder.
2035 * For MPEG-2 it is 1 IPB or 0 low delay IP.
2036 * - encoding: Set by libavcodec.
2037 * - decoding: Set by libavcodec.
2041 #if FF_API_PRIVATE_OPT
2042 /** @deprecated use encoder private options instead */
2043 attribute_deprecated
2048 * qscale factor between P- and I-frames
2049 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2050 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2051 * - encoding: Set by user.
2052 * - decoding: unused
2054 float i_quant_factor;
2057 * qscale offset between P and I-frames
2058 * - encoding: Set by user.
2059 * - decoding: unused
2061 float i_quant_offset;
2064 * luminance masking (0-> disabled)
2065 * - encoding: Set by user.
2066 * - decoding: unused
2071 * temporary complexity masking (0-> disabled)
2072 * - encoding: Set by user.
2073 * - decoding: unused
2075 float temporal_cplx_masking;
2078 * spatial complexity masking (0-> disabled)
2079 * - encoding: Set by user.
2080 * - decoding: unused
2082 float spatial_cplx_masking;
2085 * p block masking (0-> disabled)
2086 * - encoding: Set by user.
2087 * - decoding: unused
2092 * darkness masking (0-> disabled)
2093 * - encoding: Set by user.
2094 * - decoding: unused
2100 * - encoding: Set by libavcodec.
2101 * - decoding: Set by user (or 0).
2105 #if FF_API_PRIVATE_OPT
2106 /** @deprecated use encoder private options instead */
2107 attribute_deprecated
2108 int prediction_method;
2109 #define FF_PRED_LEFT 0
2110 #define FF_PRED_PLANE 1
2111 #define FF_PRED_MEDIAN 2
2115 * slice offsets in the frame in bytes
2116 * - encoding: Set/allocated by libavcodec.
2117 * - decoding: Set/allocated by user (or NULL).
2122 * sample aspect ratio (0 if unknown)
2123 * That is the width of a pixel divided by the height of the pixel.
2124 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2125 * - encoding: Set by user.
2126 * - decoding: Set by libavcodec.
2128 AVRational sample_aspect_ratio;
2131 * motion estimation comparison function
2132 * - encoding: Set by user.
2133 * - decoding: unused
2137 * subpixel motion estimation comparison function
2138 * - encoding: Set by user.
2139 * - decoding: unused
2143 * macroblock comparison function (not supported yet)
2144 * - encoding: Set by user.
2145 * - decoding: unused
2149 * interlaced DCT comparison function
2150 * - encoding: Set by user.
2151 * - decoding: unused
2154 #define FF_CMP_SAD 0
2155 #define FF_CMP_SSE 1
2156 #define FF_CMP_SATD 2
2157 #define FF_CMP_DCT 3
2158 #define FF_CMP_PSNR 4
2159 #define FF_CMP_BIT 5
2161 #define FF_CMP_ZERO 7
2162 #define FF_CMP_VSAD 8
2163 #define FF_CMP_VSSE 9
2164 #define FF_CMP_NSSE 10
2165 #define FF_CMP_W53 11
2166 #define FF_CMP_W97 12
2167 #define FF_CMP_DCTMAX 13
2168 #define FF_CMP_DCT264 14
2169 #define FF_CMP_MEDIAN_SAD 15
2170 #define FF_CMP_CHROMA 256
2173 * ME diamond size & shape
2174 * - encoding: Set by user.
2175 * - decoding: unused
2180 * amount of previous MV predictors (2a+1 x 2a+1 square)
2181 * - encoding: Set by user.
2182 * - decoding: unused
2184 int last_predictor_count;
2186 #if FF_API_PRIVATE_OPT
2187 /** @deprecated use encoder private options instead */
2188 attribute_deprecated
2193 * motion estimation prepass comparison function
2194 * - encoding: Set by user.
2195 * - decoding: unused
2200 * ME prepass diamond size & shape
2201 * - encoding: Set by user.
2202 * - decoding: unused
2208 * - encoding: Set by user.
2209 * - decoding: unused
2211 int me_subpel_quality;
2215 * DTG active format information (additional aspect ratio
2216 * information only used in DVB MPEG-2 transport streams)
2219 * - encoding: unused
2220 * - decoding: Set by decoder.
2221 * @deprecated Deprecated in favor of AVSideData
2223 attribute_deprecated int dtg_active_format;
2224 #define FF_DTG_AFD_SAME 8
2225 #define FF_DTG_AFD_4_3 9
2226 #define FF_DTG_AFD_16_9 10
2227 #define FF_DTG_AFD_14_9 11
2228 #define FF_DTG_AFD_4_3_SP_14_9 13
2229 #define FF_DTG_AFD_16_9_SP_14_9 14
2230 #define FF_DTG_AFD_SP_4_3 15
2231 #endif /* FF_API_AFD */
2234 * maximum motion estimation search range in subpel units
2235 * If 0 then no limit.
2237 * - encoding: Set by user.
2238 * - decoding: unused
2242 #if FF_API_QUANT_BIAS
2244 * @deprecated use encoder private option instead
2246 attribute_deprecated int intra_quant_bias;
2247 #define FF_DEFAULT_QUANT_BIAS 999999
2250 * @deprecated use encoder private option instead
2252 attribute_deprecated int inter_quant_bias;
2257 * - encoding: unused
2258 * - decoding: Set by user.
2261 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2262 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2263 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2267 * XVideo Motion Acceleration
2268 * - encoding: forbidden
2269 * - decoding: set by decoder
2270 * @deprecated XvMC doesn't need it anymore.
2272 attribute_deprecated int xvmc_acceleration;
2273 #endif /* FF_API_XVMC */
2276 * macroblock decision mode
2277 * - encoding: Set by user.
2278 * - decoding: unused
2281 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2282 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2283 #define FF_MB_DECISION_RD 2 ///< rate distortion
2286 * custom intra quantization matrix
2287 * - encoding: Set by user, can be NULL.
2288 * - decoding: Set by libavcodec.
2290 uint16_t *intra_matrix;
2293 * custom inter quantization matrix
2294 * - encoding: Set by user, can be NULL.
2295 * - decoding: Set by libavcodec.
2297 uint16_t *inter_matrix;
2299 #if FF_API_PRIVATE_OPT
2300 /** @deprecated use encoder private options instead */
2301 attribute_deprecated
2302 int scenechange_threshold;
2304 /** @deprecated use encoder private options instead */
2305 attribute_deprecated
2306 int noise_reduction;
2311 * @deprecated this field is unused
2313 attribute_deprecated
2317 * @deprecated this field is unused
2319 attribute_deprecated
2324 * precision of the intra DC coefficient - 8
2325 * - encoding: Set by user.
2326 * - decoding: Set by libavcodec
2328 int intra_dc_precision;
2331 * Number of macroblock rows at the top which are skipped.
2332 * - encoding: unused
2333 * - decoding: Set by user.
2338 * Number of macroblock rows at the bottom which are skipped.
2339 * - encoding: unused
2340 * - decoding: Set by user.
2346 * @deprecated use encoder private options instead
2348 attribute_deprecated
2349 float border_masking;
2353 * minimum MB Lagrange multiplier
2354 * - encoding: Set by user.
2355 * - decoding: unused
2360 * maximum MB Lagrange multiplier
2361 * - encoding: Set by user.
2362 * - decoding: unused
2366 #if FF_API_PRIVATE_OPT
2368 * @deprecated use encoder private options instead
2370 attribute_deprecated
2371 int me_penalty_compensation;
2375 * - encoding: Set by user.
2376 * - decoding: unused
2380 #if FF_API_PRIVATE_OPT
2381 /** @deprecated use encoder private options instead */
2382 attribute_deprecated
2388 * - encoding: Set by user.
2389 * - decoding: unused
2394 * number of reference frames
2395 * - encoding: Set by user.
2396 * - decoding: Set by lavc.
2400 #if FF_API_PRIVATE_OPT
2401 /** @deprecated use encoder private options instead */
2402 attribute_deprecated
2406 #if FF_API_UNUSED_MEMBERS
2408 * Multiplied by qscale for each frame and added to scene_change_score.
2409 * - encoding: Set by user.
2410 * - decoding: unused
2412 attribute_deprecated int scenechange_factor;
2416 * Note: Value depends upon the compare function used for fullpel ME.
2417 * - encoding: Set by user.
2418 * - decoding: unused
2422 #if FF_API_PRIVATE_OPT
2423 /** @deprecated use encoder private options instead */
2424 attribute_deprecated
2429 * Chromaticity coordinates of the source primaries.
2430 * - encoding: Set by user
2431 * - decoding: Set by libavcodec
2433 enum AVColorPrimaries color_primaries;
2436 * Color Transfer Characteristic.
2437 * - encoding: Set by user
2438 * - decoding: Set by libavcodec
2440 enum AVColorTransferCharacteristic color_trc;
2443 * YUV colorspace type.
2444 * - encoding: Set by user
2445 * - decoding: Set by libavcodec
2447 enum AVColorSpace colorspace;
2450 * MPEG vs JPEG YUV range.
2451 * - encoding: Set by user
2452 * - decoding: Set by libavcodec
2454 enum AVColorRange color_range;
2457 * This defines the location of chroma samples.
2458 * - encoding: Set by user
2459 * - decoding: Set by libavcodec
2461 enum AVChromaLocation chroma_sample_location;
2465 * Indicates number of picture subdivisions. Used for parallelized
2467 * - encoding: Set by user
2468 * - decoding: unused
2473 * - encoding: set by libavcodec
2474 * - decoding: Set by user.
2476 enum AVFieldOrder field_order;
2479 int sample_rate; ///< samples per second
2480 int channels; ///< number of audio channels
2483 * audio sample format
2484 * - encoding: Set by user.
2485 * - decoding: Set by libavcodec.
2487 enum AVSampleFormat sample_fmt; ///< sample format
2489 /* The following data should not be initialized. */
2491 * Number of samples per channel in an audio frame.
2493 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2494 * except the last must contain exactly frame_size samples per channel.
2495 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2496 * frame size is not restricted.
2497 * - decoding: may be set by some decoders to indicate constant frame size
2502 * Frame counter, set by libavcodec.
2504 * - decoding: total number of frames returned from the decoder so far.
2505 * - encoding: total number of frames passed to the encoder so far.
2507 * @note the counter is not incremented if encoding/decoding resulted in
2513 * number of bytes per packet if constant and known or 0
2514 * Used by some WAV based audio codecs.
2519 * Audio cutoff bandwidth (0 means "automatic")
2520 * - encoding: Set by user.
2521 * - decoding: unused
2526 * Audio channel layout.
2527 * - encoding: set by user.
2528 * - decoding: set by user, may be overwritten by libavcodec.
2530 uint64_t channel_layout;
2533 * Request decoder to use this channel layout if it can (0 for default)
2534 * - encoding: unused
2535 * - decoding: Set by user.
2537 uint64_t request_channel_layout;
2540 * Type of service that the audio stream conveys.
2541 * - encoding: Set by user.
2542 * - decoding: Set by libavcodec.
2544 enum AVAudioServiceType audio_service_type;
2547 * desired sample format
2548 * - encoding: Not used.
2549 * - decoding: Set by user.
2550 * Decoder will decode to this format if it can.
2552 enum AVSampleFormat request_sample_fmt;
2555 * This callback is called at the beginning of each frame to get data
2556 * buffer(s) for it. There may be one contiguous buffer for all the data or
2557 * there may be a buffer per each data plane or anything in between. What
2558 * this means is, you may set however many entries in buf[] you feel necessary.
2559 * Each buffer must be reference-counted using the AVBuffer API (see description
2562 * The following fields will be set in the frame before this callback is
2565 * - width, height (video only)
2566 * - sample_rate, channel_layout, nb_samples (audio only)
2567 * Their values may differ from the corresponding values in
2568 * AVCodecContext. This callback must use the frame values, not the codec
2569 * context values, to calculate the required buffer size.
2571 * This callback must fill the following fields in the frame:
2575 * * if the data is planar audio with more than 8 channels, then this
2576 * callback must allocate and fill extended_data to contain all pointers
2577 * to all data planes. data[] must hold as many pointers as it can.
2578 * extended_data must be allocated with av_malloc() and will be freed in
2580 * * otherwise extended_data must point to data
2581 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2582 * the frame's data and extended_data pointers must be contained in these. That
2583 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2584 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2585 * and av_buffer_ref().
2586 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2587 * this callback and filled with the extra buffers if there are more
2588 * buffers than buf[] can hold. extended_buf will be freed in
2591 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2592 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2595 * Each data plane must be aligned to the maximum required by the target
2598 * @see avcodec_default_get_buffer2()
2602 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2603 * (read and/or written to if it is writable) later by libavcodec.
2605 * avcodec_align_dimensions2() should be used to find the required width and
2606 * height, as they normally need to be rounded up to the next multiple of 16.
2608 * Some decoders do not support linesizes changing between frames.
2610 * If frame multithreading is used and thread_safe_callbacks is set,
2611 * this callback may be called from a different thread, but not from more
2612 * than one at once. Does not need to be reentrant.
2614 * @see avcodec_align_dimensions2()
2618 * Decoders request a buffer of a particular size by setting
2619 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2620 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2621 * to a smaller value in the output frame.
2623 * As a convenience, av_samples_get_buffer_size() and
2624 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2625 * functions to find the required data size and to fill data pointers and
2626 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2627 * since all planes must be the same size.
2629 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2631 * - encoding: unused
2632 * - decoding: Set by libavcodec, user can override.
2634 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2637 * If non-zero, the decoded audio and video frames returned from
2638 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2639 * and are valid indefinitely. The caller must free them with
2640 * av_frame_unref() when they are not needed anymore.
2641 * Otherwise, the decoded frames must not be freed by the caller and are
2642 * only valid until the next decode call.
2644 * This is always automatically enabled if avcodec_receive_frame() is used.
2646 * - encoding: unused
2647 * - decoding: set by the caller before avcodec_open2().
2649 int refcounted_frames;
2651 /* - encoding parameters */
2652 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2653 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2657 * - encoding: Set by user.
2658 * - decoding: unused
2664 * - encoding: Set by user.
2665 * - decoding: unused
2670 * maximum quantizer difference between frames
2671 * - encoding: Set by user.
2672 * - decoding: unused
2678 * @deprecated use encoder private options instead
2680 attribute_deprecated
2683 attribute_deprecated
2685 attribute_deprecated
2690 * decoder bitstream buffer size
2691 * - encoding: Set by user.
2692 * - decoding: unused
2697 * ratecontrol override, see RcOverride
2698 * - encoding: Allocated/set/freed by user.
2699 * - decoding: unused
2701 int rc_override_count;
2702 RcOverride *rc_override;
2706 * @deprecated use encoder private options instead
2708 attribute_deprecated
2714 * - encoding: Set by user.
2715 * - decoding: Set by user, may be overwritten by libavcodec.
2717 int64_t rc_max_rate;
2721 * - encoding: Set by user.
2722 * - decoding: unused
2724 int64_t rc_min_rate;
2728 * @deprecated use encoder private options instead
2730 attribute_deprecated
2731 float rc_buffer_aggressivity;
2733 attribute_deprecated
2734 float rc_initial_cplx;
2738 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2739 * - encoding: Set by user.
2740 * - decoding: unused.
2742 float rc_max_available_vbv_use;
2745 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2746 * - encoding: Set by user.
2747 * - decoding: unused.
2749 float rc_min_vbv_overflow_use;
2752 * Number of bits which should be loaded into the rc buffer before decoding starts.
2753 * - encoding: Set by user.
2754 * - decoding: unused
2756 int rc_initial_buffer_occupancy;
2758 #if FF_API_CODER_TYPE
2759 #define FF_CODER_TYPE_VLC 0
2760 #define FF_CODER_TYPE_AC 1
2761 #define FF_CODER_TYPE_RAW 2
2762 #define FF_CODER_TYPE_RLE 3
2763 #if FF_API_UNUSED_MEMBERS
2764 #define FF_CODER_TYPE_DEFLATE 4
2765 #endif /* FF_API_UNUSED_MEMBERS */
2767 * @deprecated use encoder private options instead
2769 attribute_deprecated
2771 #endif /* FF_API_CODER_TYPE */
2773 #if FF_API_PRIVATE_OPT
2774 /** @deprecated use encoder private options instead */
2775 attribute_deprecated
2781 * @deprecated use encoder private options instead
2783 attribute_deprecated
2787 * @deprecated use encoder private options instead
2789 attribute_deprecated
2793 #if FF_API_PRIVATE_OPT
2794 /** @deprecated use encoder private options instead */
2795 attribute_deprecated
2796 int frame_skip_threshold;
2798 /** @deprecated use encoder private options instead */
2799 attribute_deprecated
2800 int frame_skip_factor;
2802 /** @deprecated use encoder private options instead */
2803 attribute_deprecated
2806 /** @deprecated use encoder private options instead */
2807 attribute_deprecated
2809 #endif /* FF_API_PRIVATE_OPT */
2812 * trellis RD quantization
2813 * - encoding: Set by user.
2814 * - decoding: unused
2818 #if FF_API_PRIVATE_OPT
2819 /** @deprecated use encoder private options instead */
2820 attribute_deprecated
2821 int min_prediction_order;
2823 /** @deprecated use encoder private options instead */
2824 attribute_deprecated
2825 int max_prediction_order;
2827 /** @deprecated use encoder private options instead */
2828 attribute_deprecated
2829 int64_t timecode_frame_start;
2832 #if FF_API_RTP_CALLBACK
2834 * @deprecated unused
2836 /* The RTP callback: This function is called */
2837 /* every time the encoder has a packet to send. */
2838 /* It depends on the encoder if the data starts */
2839 /* with a Start Code (it should). H.263 does. */
2840 /* mb_nb contains the number of macroblocks */
2841 /* encoded in the RTP payload. */
2842 attribute_deprecated
2843 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2846 #if FF_API_PRIVATE_OPT
2847 /** @deprecated use encoder private options instead */
2848 attribute_deprecated
2849 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2850 /* do its best to deliver a chunk with size */
2851 /* below rtp_payload_size, the chunk will start */
2852 /* with a start code on some codecs like H.263. */
2853 /* This doesn't take account of any particular */
2854 /* headers inside the transmitted RTP payload. */
2857 #if FF_API_STAT_BITS
2858 /* statistics, used for 2-pass encoding */
2859 attribute_deprecated
2861 attribute_deprecated
2863 attribute_deprecated
2865 attribute_deprecated
2867 attribute_deprecated
2869 attribute_deprecated
2871 attribute_deprecated
2873 attribute_deprecated
2876 /** @deprecated this field is unused */
2877 attribute_deprecated
2882 * pass1 encoding statistics output buffer
2883 * - encoding: Set by libavcodec.
2884 * - decoding: unused
2889 * pass2 encoding statistics input buffer
2890 * Concatenated stuff from stats_out of pass1 should be placed here.
2891 * - encoding: Allocated/set/freed by user.
2892 * - decoding: unused
2897 * Work around bugs in encoders which sometimes cannot be detected automatically.
2898 * - encoding: Set by user
2899 * - decoding: Set by user
2901 int workaround_bugs;
2902 #define FF_BUG_AUTODETECT 1 ///< autodetection
2903 #if FF_API_OLD_MSMPEG4
2904 #define FF_BUG_OLD_MSMPEG4 2
2906 #define FF_BUG_XVID_ILACE 4
2907 #define FF_BUG_UMP4 8
2908 #define FF_BUG_NO_PADDING 16
2909 #define FF_BUG_AMV 32
2911 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2913 #define FF_BUG_QPEL_CHROMA 64
2914 #define FF_BUG_STD_QPEL 128
2915 #define FF_BUG_QPEL_CHROMA2 256
2916 #define FF_BUG_DIRECT_BLOCKSIZE 512
2917 #define FF_BUG_EDGE 1024
2918 #define FF_BUG_HPEL_CHROMA 2048
2919 #define FF_BUG_DC_CLIP 4096
2920 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2921 #define FF_BUG_TRUNCATED 16384
2922 #define FF_BUG_IEDGE 32768
2925 * strictly follow the standard (MPEG-4, ...).
2926 * - encoding: Set by user.
2927 * - decoding: Set by user.
2928 * Setting this to STRICT or higher means the encoder and decoder will
2929 * generally do stupid things, whereas setting it to unofficial or lower
2930 * will mean the encoder might produce output that is not supported by all
2931 * spec-compliant decoders. Decoders don't differentiate between normal,
2932 * unofficial and experimental (that is, they always try to decode things
2933 * when they can) unless they are explicitly asked to behave stupidly
2934 * (=strictly conform to the specs)
2936 int strict_std_compliance;
2937 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2938 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2939 #define FF_COMPLIANCE_NORMAL 0
2940 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2941 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2944 * error concealment flags
2945 * - encoding: unused
2946 * - decoding: Set by user.
2948 int error_concealment;
2949 #define FF_EC_GUESS_MVS 1
2950 #define FF_EC_DEBLOCK 2
2951 #define FF_EC_FAVOR_INTER 256
2955 * - encoding: Set by user.
2956 * - decoding: Set by user.
2959 #define FF_DEBUG_PICT_INFO 1
2960 #define FF_DEBUG_RC 2
2961 #define FF_DEBUG_BITSTREAM 4
2962 #define FF_DEBUG_MB_TYPE 8
2963 #define FF_DEBUG_QP 16
2966 * @deprecated this option does nothing
2968 #define FF_DEBUG_MV 32
2970 #define FF_DEBUG_DCT_COEFF 0x00000040
2971 #define FF_DEBUG_SKIP 0x00000080
2972 #define FF_DEBUG_STARTCODE 0x00000100
2973 #if FF_API_UNUSED_MEMBERS
2974 #define FF_DEBUG_PTS 0x00000200
2975 #endif /* FF_API_UNUSED_MEMBERS */
2976 #define FF_DEBUG_ER 0x00000400
2977 #define FF_DEBUG_MMCO 0x00000800
2978 #define FF_DEBUG_BUGS 0x00001000
2980 #define FF_DEBUG_VIS_QP 0x00002000
2981 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2983 #define FF_DEBUG_BUFFERS 0x00008000
2984 #define FF_DEBUG_THREADS 0x00010000
2985 #define FF_DEBUG_GREEN_MD 0x00800000
2986 #define FF_DEBUG_NOMC 0x01000000
2991 * - encoding: Set by user.
2992 * - decoding: Set by user.
2995 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2996 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2997 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
3001 * Error recognition; may misdetect some more or less valid parts as errors.
3002 * - encoding: unused
3003 * - decoding: Set by user.
3005 int err_recognition;
3008 * Verify checksums embedded in the bitstream (could be of either encoded or
3009 * decoded data, depending on the codec) and print an error message on mismatch.
3010 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
3011 * decoder returning an error.
3013 #define AV_EF_CRCCHECK (1<<0)
3014 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
3015 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
3016 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
3018 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
3019 #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
3020 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
3021 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
3025 * opaque 64-bit number (generally a PTS) that will be reordered and
3026 * output in AVFrame.reordered_opaque
3027 * - encoding: unused
3028 * - decoding: Set by user.
3030 int64_t reordered_opaque;
3033 * Hardware accelerator in use
3034 * - encoding: unused.
3035 * - decoding: Set by libavcodec
3037 struct AVHWAccel *hwaccel;
3040 * Hardware accelerator context.
3041 * For some hardware accelerators, a global context needs to be
3042 * provided by the user. In that case, this holds display-dependent
3043 * data FFmpeg cannot instantiate itself. Please refer to the
3044 * FFmpeg HW accelerator documentation to know how to fill this
3045 * is. e.g. for VA API, this is a struct vaapi_context.
3046 * - encoding: unused
3047 * - decoding: Set by user
3049 void *hwaccel_context;
3053 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3054 * - decoding: unused
3056 uint64_t error[AV_NUM_DATA_POINTERS];
3059 * DCT algorithm, see FF_DCT_* below
3060 * - encoding: Set by user.
3061 * - decoding: unused
3064 #define FF_DCT_AUTO 0
3065 #define FF_DCT_FASTINT 1
3066 #define FF_DCT_INT 2
3067 #define FF_DCT_MMX 3
3068 #define FF_DCT_ALTIVEC 5
3069 #define FF_DCT_FAAN 6
3072 * IDCT algorithm, see FF_IDCT_* below.
3073 * - encoding: Set by user.
3074 * - decoding: Set by user.
3077 #define FF_IDCT_AUTO 0
3078 #define FF_IDCT_INT 1
3079 #define FF_IDCT_SIMPLE 2
3080 #define FF_IDCT_SIMPLEMMX 3
3081 #define FF_IDCT_ARM 7
3082 #define FF_IDCT_ALTIVEC 8
3084 #define FF_IDCT_SH4 9
3086 #define FF_IDCT_SIMPLEARM 10
3087 #if FF_API_UNUSED_MEMBERS
3088 #define FF_IDCT_IPP 13
3089 #endif /* FF_API_UNUSED_MEMBERS */
3090 #define FF_IDCT_XVID 14
3091 #if FF_API_IDCT_XVIDMMX
3092 #define FF_IDCT_XVIDMMX 14
3093 #endif /* FF_API_IDCT_XVIDMMX */
3094 #define FF_IDCT_SIMPLEARMV5TE 16
3095 #define FF_IDCT_SIMPLEARMV6 17
3096 #if FF_API_ARCH_SPARC
3097 #define FF_IDCT_SIMPLEVIS 18
3099 #define FF_IDCT_FAAN 20
3100 #define FF_IDCT_SIMPLENEON 22
3101 #if FF_API_ARCH_ALPHA
3102 #define FF_IDCT_SIMPLEALPHA 23
3104 #define FF_IDCT_SIMPLEAUTO 128
3107 * bits per sample/pixel from the demuxer (needed for huffyuv).
3108 * - encoding: Set by libavcodec.
3109 * - decoding: Set by user.
3111 int bits_per_coded_sample;
3114 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3115 * - encoding: set by user.
3116 * - decoding: set by libavcodec.
3118 int bits_per_raw_sample;
3122 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3123 * - encoding: unused
3124 * - decoding: Set by user.
3129 #if FF_API_CODED_FRAME
3131 * the picture in the bitstream
3132 * - encoding: Set by libavcodec.
3133 * - decoding: unused
3135 * @deprecated use the quality factor packet side data instead
3137 attribute_deprecated AVFrame *coded_frame;
3142 * is used to decide how many independent tasks should be passed to execute()
3143 * - encoding: Set by user.
3144 * - decoding: Set by user.
3149 * Which multithreading methods to use.
3150 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3151 * so clients which cannot provide future frames should not use it.
3153 * - encoding: Set by user, otherwise the default is used.
3154 * - decoding: Set by user, otherwise the default is used.
3157 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3158 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3161 * Which multithreading methods are in use by the codec.
3162 * - encoding: Set by libavcodec.
3163 * - decoding: Set by libavcodec.
3165 int active_thread_type;
3168 * Set by the client if its custom get_buffer() callback can be called
3169 * synchronously from another thread, which allows faster multithreaded decoding.
3170 * draw_horiz_band() will be called from other threads regardless of this setting.
3171 * Ignored if the default get_buffer() is used.
3172 * - encoding: Set by user.
3173 * - decoding: Set by user.
3175 int thread_safe_callbacks;
3178 * The codec may call this to execute several independent things.
3179 * It will return only after finishing all tasks.
3180 * The user may replace this with some multithreaded implementation,
3181 * the default implementation will execute the parts serially.
3182 * @param count the number of things to execute
3183 * - encoding: Set by libavcodec, user can override.
3184 * - decoding: Set by libavcodec, user can override.
3186 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3189 * The codec may call this to execute several independent things.
3190 * It will return only after finishing all tasks.
3191 * The user may replace this with some multithreaded implementation,
3192 * the default implementation will execute the parts serially.
3193 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3194 * @param c context passed also to func
3195 * @param count the number of things to execute
3196 * @param arg2 argument passed unchanged to func
3197 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3198 * @param func function that will be called count times, with jobnr from 0 to count-1.
3199 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3200 * two instances of func executing at the same time will have the same threadnr.
3201 * @return always 0 currently, but code should handle a future improvement where when any call to func
3202 * returns < 0 no further calls to func may be done and < 0 is returned.
3203 * - encoding: Set by libavcodec, user can override.
3204 * - decoding: Set by libavcodec, user can override.
3206 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3209 * noise vs. sse weight for the nsse comparison function
3210 * - encoding: Set by user.
3211 * - decoding: unused
3217 * - encoding: Set by user.
3218 * - decoding: Set by libavcodec.
3221 #define FF_PROFILE_UNKNOWN -99
3222 #define FF_PROFILE_RESERVED -100
3224 #define FF_PROFILE_AAC_MAIN 0
3225 #define FF_PROFILE_AAC_LOW 1
3226 #define FF_PROFILE_AAC_SSR 2
3227 #define FF_PROFILE_AAC_LTP 3
3228 #define FF_PROFILE_AAC_HE 4
3229 #define FF_PROFILE_AAC_HE_V2 28
3230 #define FF_PROFILE_AAC_LD 22
3231 #define FF_PROFILE_AAC_ELD 38
3232 #define FF_PROFILE_MPEG2_AAC_LOW 128
3233 #define FF_PROFILE_MPEG2_AAC_HE 131
3235 #define FF_PROFILE_DNXHD 0
3236 #define FF_PROFILE_DNXHR_LB 1
3237 #define FF_PROFILE_DNXHR_SQ 2
3238 #define FF_PROFILE_DNXHR_HQ 3
3239 #define FF_PROFILE_DNXHR_HQX 4
3240 #define FF_PROFILE_DNXHR_444 5
3242 #define FF_PROFILE_DTS 20
3243 #define FF_PROFILE_DTS_ES 30
3244 #define FF_PROFILE_DTS_96_24 40
3245 #define FF_PROFILE_DTS_HD_HRA 50
3246 #define FF_PROFILE_DTS_HD_MA 60
3247 #define FF_PROFILE_DTS_EXPRESS 70
3249 #define FF_PROFILE_MPEG2_422 0
3250 #define FF_PROFILE_MPEG2_HIGH 1
3251 #define FF_PROFILE_MPEG2_SS 2
3252 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3253 #define FF_PROFILE_MPEG2_MAIN 4
3254 #define FF_PROFILE_MPEG2_SIMPLE 5
3256 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3257 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3259 #define FF_PROFILE_H264_BASELINE 66
3260 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3261 #define FF_PROFILE_H264_MAIN 77
3262 #define FF_PROFILE_H264_EXTENDED 88
3263 #define FF_PROFILE_H264_HIGH 100
3264 #define FF_PROFILE_H264_HIGH_10 110
3265 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3266 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3267 #define FF_PROFILE_H264_HIGH_422 122
3268 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3269 #define FF_PROFILE_H264_STEREO_HIGH 128
3270 #define FF_PROFILE_H264_HIGH_444 144
3271 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3272 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3273 #define FF_PROFILE_H264_CAVLC_444 44
3275 #define FF_PROFILE_VC1_SIMPLE 0
3276 #define FF_PROFILE_VC1_MAIN 1
3277 #define FF_PROFILE_VC1_COMPLEX 2
3278 #define FF_PROFILE_VC1_ADVANCED 3
3280 #define FF_PROFILE_MPEG4_SIMPLE 0
3281 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3282 #define FF_PROFILE_MPEG4_CORE 2
3283 #define FF_PROFILE_MPEG4_MAIN 3
3284 #define FF_PROFILE_MPEG4_N_BIT 4
3285 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3286 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3287 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3288 #define FF_PROFILE_MPEG4_HYBRID 8
3289 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3290 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3291 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3292 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3293 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3294 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3295 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3297 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3298 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3299 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3300 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3301 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3303 #define FF_PROFILE_VP9_0 0
3304 #define FF_PROFILE_VP9_1 1
3305 #define FF_PROFILE_VP9_2 2
3306 #define FF_PROFILE_VP9_3 3
3308 #define FF_PROFILE_HEVC_MAIN 1
3309 #define FF_PROFILE_HEVC_MAIN_10 2
3310 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3311 #define FF_PROFILE_HEVC_REXT 4
3315 * - encoding: Set by user.
3316 * - decoding: Set by libavcodec.
3319 #define FF_LEVEL_UNKNOWN -99
3322 * Skip loop filtering for selected frames.
3323 * - encoding: unused
3324 * - decoding: Set by user.
3326 enum AVDiscard skip_loop_filter;
3329 * Skip IDCT/dequantization for selected frames.
3330 * - encoding: unused
3331 * - decoding: Set by user.
3333 enum AVDiscard skip_idct;
3336 * Skip decoding for selected frames.
3337 * - encoding: unused
3338 * - decoding: Set by user.
3340 enum AVDiscard skip_frame;
3343 * Header containing style information for text subtitles.
3344 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3345 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3346 * the Format line following. It shouldn't include any Dialogue line.
3347 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3348 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3350 uint8_t *subtitle_header;
3351 int subtitle_header_size;
3353 #if FF_API_ERROR_RATE
3355 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3358 attribute_deprecated
3362 #if FF_API_VBV_DELAY
3364 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3365 * Used for compliant TS muxing.
3366 * - encoding: Set by libavcodec.
3367 * - decoding: unused.
3368 * @deprecated this value is now exported as a part of
3369 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3371 attribute_deprecated
3375 #if FF_API_SIDEDATA_ONLY_PKT
3377 * Encoding only and set by default. Allow encoders to output packets
3378 * that do not contain any encoded data, only side data.
3380 * Some encoders need to output such packets, e.g. to update some stream
3381 * parameters at the end of encoding.
3383 * @deprecated this field disables the default behaviour and
3384 * it is kept only for compatibility.
3386 attribute_deprecated
3387 int side_data_only_packets;
3391 * Audio only. The number of "priming" samples (padding) inserted by the
3392 * encoder at the beginning of the audio. I.e. this number of leading
3393 * decoded samples must be discarded by the caller to get the original audio
3394 * without leading padding.
3396 * - decoding: unused
3397 * - encoding: Set by libavcodec. The timestamps on the output packets are
3398 * adjusted by the encoder so that they always refer to the
3399 * first sample of the data actually contained in the packet,
3400 * including any added padding. E.g. if the timebase is
3401 * 1/samplerate and the timestamp of the first input sample is
3402 * 0, the timestamp of the first output packet will be
3405 int initial_padding;
3408 * - decoding: For codecs that store a framerate value in the compressed
3409 * bitstream, the decoder may export it here. { 0, 1} when
3411 * - encoding: May be used to signal the framerate of CFR content to an
3414 AVRational framerate;
3417 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3418 * - encoding: unused.
3419 * - decoding: Set by libavcodec before calling get_format()
3421 enum AVPixelFormat sw_pix_fmt;
3424 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3425 * - encoding unused.
3426 * - decoding set by user.
3428 AVRational pkt_timebase;
3432 * - encoding: unused.
3433 * - decoding: set by libavcodec.
3435 const AVCodecDescriptor *codec_descriptor;
3439 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3440 * - encoding: unused
3441 * - decoding: Set by user.
3447 * Current statistics for PTS correction.
3448 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3449 * - encoding: unused
3451 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3452 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3453 int64_t pts_correction_last_pts; /// PTS of the last frame
3454 int64_t pts_correction_last_dts; /// DTS of the last frame
3457 * Character encoding of the input subtitles file.
3458 * - decoding: set by user
3459 * - encoding: unused
3464 * Subtitles character encoding mode. Formats or codecs might be adjusting
3465 * this setting (if they are doing the conversion themselves for instance).
3466 * - decoding: set by libavcodec
3467 * - encoding: unused
3469 int sub_charenc_mode;
3470 #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)
3471 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3472 #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
3475 * Skip processing alpha if supported by codec.
3476 * Note that if the format uses pre-multiplied alpha (common with VP6,
3477 * and recommended due to better video quality/compression)
3478 * the image will look as if alpha-blended onto a black background.
3479 * However for formats that do not use pre-multiplied alpha
3480 * there might be serious artefacts (though e.g. libswscale currently
3481 * assumes pre-multiplied alpha anyway).
3483 * - decoding: set by user
3484 * - encoding: unused
3489 * Number of samples to skip after a discontinuity
3490 * - decoding: unused
3491 * - encoding: set by libavcodec
3495 #if !FF_API_DEBUG_MV
3497 * debug motion vectors
3498 * - encoding: Set by user.
3499 * - decoding: Set by user.
3502 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3503 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3504 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3508 * custom intra quantization matrix
3509 * - encoding: Set by user, can be NULL.
3510 * - decoding: unused.
3512 uint16_t *chroma_intra_matrix;
3515 * dump format separator.
3516 * can be ", " or "\n " or anything else
3517 * - encoding: Set by user.
3518 * - decoding: Set by user.
3520 uint8_t *dump_separator;
3523 * ',' separated list of allowed decoders.
3524 * If NULL then all are allowed
3525 * - encoding: unused
3526 * - decoding: set by user
3528 char *codec_whitelist;
3531 * Properties of the stream that gets decoded
3532 * - encoding: unused
3533 * - decoding: set by libavcodec
3535 unsigned properties;
3536 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3537 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3540 * Additional data associated with the entire coded stream.
3542 * - decoding: unused
3543 * - encoding: may be set by libavcodec after avcodec_open2().
3545 AVPacketSideData *coded_side_data;
3546 int nb_coded_side_data;
3549 * A reference to the AVHWFramesContext describing the input (for encoding)
3550 * or output (decoding) frames. The reference is set by the caller and
3551 * afterwards owned (and freed) by libavcodec - it should never be read by
3552 * the caller after being set.
3554 * - decoding: This field should be set by the caller from the get_format()
3555 * callback. The previous reference (if any) will always be
3556 * unreffed by libavcodec before the get_format() call.
3558 * If the default get_buffer2() is used with a hwaccel pixel
3559 * format, then this AVHWFramesContext will be used for
3560 * allocating the frame buffers.
3562 * - encoding: For hardware encoders configured to use a hwaccel pixel
3563 * format, this field should be set by the caller to a reference
3564 * to the AVHWFramesContext describing input frames.
3565 * AVHWFramesContext.format must be equal to
3566 * AVCodecContext.pix_fmt.
3568 * This field should be set before avcodec_open2() is called.
3570 AVBufferRef *hw_frames_ctx;
3573 * Control the form of AVSubtitle.rects[N]->ass
3574 * - decoding: set by user
3575 * - encoding: unused
3577 int sub_text_format;
3578 #define FF_SUB_TEXT_FMT_ASS 0
3579 #if FF_API_ASS_TIMING
3580 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3584 * Audio only. The amount of padding (in samples) appended by the encoder to
3585 * the end of the audio. I.e. this number of decoded samples must be
3586 * discarded by the caller from the end of the stream to get the original
3587 * audio without any trailing padding.
3589 * - decoding: unused
3590 * - encoding: unused
3592 int trailing_padding;
3595 * The number of pixels per image to maximally accept.
3597 * - decoding: set by user
3598 * - encoding: set by user
3603 * A reference to the AVHWDeviceContext describing the device which will
3604 * be used by a hardware encoder/decoder. The reference is set by the
3605 * caller and afterwards owned (and freed) by libavcodec.
3607 * This should be used if either the codec device does not require
3608 * hardware frames or any that are used are to be allocated internally by
3609 * libavcodec. If the user wishes to supply any of the frames used as
3610 * encoder input or decoder output then hw_frames_ctx should be used
3611 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3612 * field will be ignored while decoding the associated stream segment, but
3613 * may again be used on a following one after another get_format() call.
3615 * For both encoders and decoders this field should be set before
3616 * avcodec_open2() is called and must not be written to thereafter.
3618 * Note that some decoders may require this field to be set initially in
3619 * order to support hw_frames_ctx at all - in that case, all frames
3620 * contexts used must be created on the same device.
3622 AVBufferRef *hw_device_ctx;
3625 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3626 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3628 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3629 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3631 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3633 int av_codec_get_lowres(const AVCodecContext *avctx);
3634 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3636 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3637 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3639 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3640 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3645 typedef struct AVProfile {
3647 const char *name; ///< short name for the profile
3650 typedef struct AVCodecDefault AVCodecDefault;
3657 typedef struct AVCodec {
3659 * Name of the codec implementation.
3660 * The name is globally unique among encoders and among decoders (but an
3661 * encoder and a decoder can share the same name).
3662 * This is the primary way to find a codec from the user perspective.
3666 * Descriptive name for the codec, meant to be more human readable than name.
3667 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3669 const char *long_name;
3670 enum AVMediaType type;
3673 * Codec capabilities.
3674 * see AV_CODEC_CAP_*
3677 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3678 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3679 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3680 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3681 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3682 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3683 const AVClass *priv_class; ///< AVClass for the private context
3684 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3686 /*****************************************************************
3687 * No fields below this line are part of the public API. They
3688 * may not be used outside of libavcodec and can be changed and
3690 * New public fields should be added right above.
3691 *****************************************************************
3694 struct AVCodec *next;
3696 * @name Frame-level threading support functions
3700 * If defined, called on thread contexts when they are created.
3701 * If the codec allocates writable tables in init(), re-allocate them here.
3702 * priv_data will be set to a copy of the original.
3704 int (*init_thread_copy)(AVCodecContext *);
3706 * Copy necessary context variables from a previous thread context to the current one.
3707 * If not defined, the next thread will start automatically; otherwise, the codec
3708 * must call ff_thread_finish_setup().
3710 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3712 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3716 * Private codec-specific defaults.
3718 const AVCodecDefault *defaults;
3721 * Initialize codec static data, called from avcodec_register().
3723 void (*init_static_data)(struct AVCodec *codec);
3725 int (*init)(AVCodecContext *);
3726 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3727 const struct AVSubtitle *sub);
3729 * Encode data to an AVPacket.
3731 * @param avctx codec context
3732 * @param avpkt output AVPacket (may contain a user-provided buffer)
3733 * @param[in] frame AVFrame containing the raw data to be encoded
3734 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3735 * non-empty packet was returned in avpkt.
3736 * @return 0 on success, negative error code on failure
3738 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3739 int *got_packet_ptr);
3740 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3741 int (*close)(AVCodecContext *);
3743 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3744 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3746 * - never called if the codec is closed or the wrong type,
3747 * - AVPacket parameter change side data is applied right before calling
3748 * AVCodec->send_packet,
3749 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3750 * - only one drain packet is ever passed down (until the next flush()),
3751 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3753 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3754 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3755 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3756 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3759 * Will be called when seeking
3761 void (*flush)(AVCodecContext *);
3763 * Internal codec capabilities.
3764 * See FF_CODEC_CAP_* in internal.h
3769 int av_codec_get_max_lowres(const AVCodec *codec);
3771 struct MpegEncContext;
3774 * @defgroup lavc_hwaccel AVHWAccel
3777 typedef struct AVHWAccel {
3779 * Name of the hardware accelerated codec.
3780 * The name is globally unique among encoders and among decoders (but an
3781 * encoder and a decoder can share the same name).
3786 * Type of codec implemented by the hardware accelerator.
3788 * See AVMEDIA_TYPE_xxx
3790 enum AVMediaType type;
3793 * Codec implemented by the hardware accelerator.
3795 * See AV_CODEC_ID_xxx
3800 * Supported pixel format.
3802 * Only hardware accelerated formats are supported here.
3804 enum AVPixelFormat pix_fmt;
3807 * Hardware accelerated codec capabilities.
3808 * see HWACCEL_CODEC_CAP_*
3812 /*****************************************************************
3813 * No fields below this line are part of the public API. They
3814 * may not be used outside of libavcodec and can be changed and
3816 * New public fields should be added right above.
3817 *****************************************************************
3819 struct AVHWAccel *next;
3822 * Allocate a custom buffer
3824 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3827 * Called at the beginning of each frame or field picture.
3829 * Meaningful frame information (codec specific) is guaranteed to
3830 * be parsed at this point. This function is mandatory.
3832 * Note that buf can be NULL along with buf_size set to 0.
3833 * Otherwise, this means the whole frame is available at this point.
3835 * @param avctx the codec context
3836 * @param buf the frame data buffer base
3837 * @param buf_size the size of the frame in bytes
3838 * @return zero if successful, a negative value otherwise
3840 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3843 * Callback for each slice.
3845 * Meaningful slice information (codec specific) is guaranteed to
3846 * be parsed at this point. This function is mandatory.
3847 * The only exception is XvMC, that works on MB level.
3849 * @param avctx the codec context
3850 * @param buf the slice data buffer base
3851 * @param buf_size the size of the slice in bytes
3852 * @return zero if successful, a negative value otherwise
3854 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3857 * Called at the end of each frame or field picture.
3859 * The whole picture is parsed at this point and can now be sent
3860 * to the hardware accelerator. This function is mandatory.
3862 * @param avctx the codec context
3863 * @return zero if successful, a negative value otherwise
3865 int (*end_frame)(AVCodecContext *avctx);
3868 * Size of per-frame hardware accelerator private data.
3870 * Private data is allocated with av_mallocz() before
3871 * AVCodecContext.get_buffer() and deallocated after
3872 * AVCodecContext.release_buffer().
3874 int frame_priv_data_size;
3877 * Called for every Macroblock in a slice.
3879 * XvMC uses it to replace the ff_mpv_decode_mb().
3880 * Instead of decoding to raw picture, MB parameters are
3881 * stored in an array provided by the video driver.
3883 * @param s the mpeg context
3885 void (*decode_mb)(struct MpegEncContext *s);
3888 * Initialize the hwaccel private data.
3890 * This will be called from ff_get_format(), after hwaccel and
3891 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3894 int (*init)(AVCodecContext *avctx);
3897 * Uninitialize the hwaccel private data.
3899 * This will be called from get_format() or avcodec_close(), after hwaccel
3900 * and hwaccel_context are already uninitialized.
3902 int (*uninit)(AVCodecContext *avctx);
3905 * Size of the private data to allocate in
3906 * AVCodecInternal.hwaccel_priv_data.
3911 * Internal hwaccel capabilities.
3917 * Hardware acceleration should be used for decoding even if the codec level
3918 * used is unknown or higher than the maximum supported level reported by the
3921 * It's generally a good idea to pass this flag unless you have a specific
3922 * reason not to, as hardware tends to under-report supported levels.
3924 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3927 * Hardware acceleration can output YUV pixel formats with a different chroma
3928 * sampling than 4:2:0 and/or other than 8 bits per component.
3930 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3936 #if FF_API_AVPICTURE
3938 * @defgroup lavc_picture AVPicture
3940 * Functions for working with AVPicture
3945 * Picture data structure.
3947 * Up to four components can be stored into it, the last component is
3949 * @deprecated use AVFrame or imgutils functions instead
3951 typedef struct AVPicture {
3952 attribute_deprecated
3953 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3954 attribute_deprecated
3955 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3963 enum AVSubtitleType {
3966 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3969 * Plain text, the text field must be set by the decoder and is
3970 * authoritative. ass and pict fields may contain approximations.
3975 * Formatted text, the ass field must be set by the decoder and is
3976 * authoritative. pict and text fields may contain approximations.
3981 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3983 typedef struct AVSubtitleRect {
3984 int x; ///< top left corner of pict, undefined when pict is not set
3985 int y; ///< top left corner of pict, undefined when pict is not set
3986 int w; ///< width of pict, undefined when pict is not set
3987 int h; ///< height of pict, undefined when pict is not set
3988 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3990 #if FF_API_AVPICTURE
3992 * @deprecated unused
3994 attribute_deprecated
3998 * data+linesize for the bitmap of this subtitle.
3999 * Can be set for text/ass as well once they are rendered.
4004 enum AVSubtitleType type;
4006 char *text; ///< 0 terminated plain UTF-8 text
4009 * 0 terminated ASS/SSA compatible event line.
4010 * The presentation of this is unaffected by the other values in this
4018 typedef struct AVSubtitle {
4019 uint16_t format; /* 0 = graphics */
4020 uint32_t start_display_time; /* relative to packet pts, in ms */
4021 uint32_t end_display_time; /* relative to packet pts, in ms */
4023 AVSubtitleRect **rects;
4024 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
4028 * This struct describes the properties of an encoded stream.
4030 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4031 * be allocated with avcodec_parameters_alloc() and freed with
4032 * avcodec_parameters_free().
4034 typedef struct AVCodecParameters {
4036 * General type of the encoded data.
4038 enum AVMediaType codec_type;
4040 * Specific type of the encoded data (the codec used).
4042 enum AVCodecID codec_id;
4044 * Additional information about the codec (corresponds to the AVI FOURCC).
4049 * Extra binary data needed for initializing the decoder, codec-dependent.
4051 * Must be allocated with av_malloc() and will be freed by
4052 * avcodec_parameters_free(). The allocated size of extradata must be at
4053 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4058 * Size of the extradata content in bytes.
4063 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4064 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4069 * The average bitrate of the encoded data (in bits per second).
4074 * The number of bits per sample in the codedwords.
4076 * This is basically the bitrate per sample. It is mandatory for a bunch of
4077 * formats to actually decode them. It's the number of bits for one sample in
4078 * the actual coded bitstream.
4080 * This could be for example 4 for ADPCM
4081 * For PCM formats this matches bits_per_raw_sample
4084 int bits_per_coded_sample;
4087 * This is the number of valid bits in each output sample. If the
4088 * sample format has more bits, the least significant bits are additional
4089 * padding bits, which are always 0. Use right shifts to reduce the sample
4090 * to its actual size. For example, audio formats with 24 bit samples will
4091 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4092 * To get the original sample use "(int32_t)sample >> 8"."
4094 * For ADPCM this might be 12 or 16 or similar
4097 int bits_per_raw_sample;
4100 * Codec-specific bitstream restrictions that the stream conforms to.
4106 * Video only. The dimensions of the video frame in pixels.
4112 * Video only. The aspect ratio (width / height) which a single pixel
4113 * should have when displayed.
4115 * When the aspect ratio is unknown / undefined, the numerator should be
4116 * set to 0 (the denominator may have any value).
4118 AVRational sample_aspect_ratio;
4121 * Video only. The order of the fields in interlaced video.
4123 enum AVFieldOrder field_order;
4126 * Video only. Additional colorspace characteristics.
4128 enum AVColorRange color_range;
4129 enum AVColorPrimaries color_primaries;
4130 enum AVColorTransferCharacteristic color_trc;
4131 enum AVColorSpace color_space;
4132 enum AVChromaLocation chroma_location;
4135 * Video only. Number of delayed frames.
4140 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4141 * unknown or unspecified, otherwise the number of bits set must be equal to
4142 * the channels field.
4144 uint64_t channel_layout;
4146 * Audio only. The number of audio channels.
4150 * Audio only. The number of audio samples per second.
4154 * Audio only. The number of bytes per coded audio frame, required by some
4157 * Corresponds to nBlockAlign in WAVEFORMATEX.
4161 * Audio only. Audio frame size, if known. Required by some formats to be static.
4166 * Audio only. The amount of padding (in samples) inserted by the encoder at
4167 * the beginning of the audio. I.e. this number of leading decoded samples
4168 * must be discarded by the caller to get the original audio without leading
4171 int initial_padding;
4173 * Audio only. The amount of padding (in samples) appended by the encoder to
4174 * the end of the audio. I.e. this number of decoded samples must be
4175 * discarded by the caller from the end of the stream to get the original
4176 * audio without any trailing padding.
4178 int trailing_padding;
4180 * Audio only. Number of samples to skip after a discontinuity.
4183 } AVCodecParameters;
4186 * If c is NULL, returns the first registered codec,
4187 * if c is non-NULL, returns the next registered codec after c,
4188 * or NULL if c is the last one.
4190 AVCodec *av_codec_next(const AVCodec *c);
4193 * Return the LIBAVCODEC_VERSION_INT constant.
4195 unsigned avcodec_version(void);
4198 * Return the libavcodec build-time configuration.
4200 const char *avcodec_configuration(void);
4203 * Return the libavcodec license.
4205 const char *avcodec_license(void);
4208 * Register the codec codec and initialize libavcodec.
4210 * @warning either this function or avcodec_register_all() must be called
4211 * before any other libavcodec functions.
4213 * @see avcodec_register_all()
4215 void avcodec_register(AVCodec *codec);
4218 * Register all the codecs, parsers and bitstream filters which were enabled at
4219 * configuration time. If you do not call this function you can select exactly
4220 * which formats you want to support, by using the individual registration
4223 * @see avcodec_register
4224 * @see av_register_codec_parser
4225 * @see av_register_bitstream_filter
4227 void avcodec_register_all(void);
4230 * Allocate an AVCodecContext and set its fields to default values. The
4231 * resulting struct should be freed with avcodec_free_context().
4233 * @param codec if non-NULL, allocate private data and initialize defaults
4234 * for the given codec. It is illegal to then call avcodec_open2()
4235 * with a different codec.
4236 * If NULL, then the codec-specific defaults won't be initialized,
4237 * which may result in suboptimal default settings (this is
4238 * important mainly for encoders, e.g. libx264).
4240 * @return An AVCodecContext filled with default values or NULL on failure.
4242 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4245 * Free the codec context and everything associated with it and write NULL to
4246 * the provided pointer.
4248 void avcodec_free_context(AVCodecContext **avctx);
4250 #if FF_API_GET_CONTEXT_DEFAULTS
4252 * @deprecated This function should not be used, as closing and opening a codec
4253 * context multiple time is not supported. A new codec context should be
4254 * allocated for each new use.
4256 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4260 * Get the AVClass for AVCodecContext. It can be used in combination with
4261 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4263 * @see av_opt_find().
4265 const AVClass *avcodec_get_class(void);
4267 #if FF_API_COPY_CONTEXT
4269 * Get the AVClass for AVFrame. It can be used in combination with
4270 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4272 * @see av_opt_find().
4274 const AVClass *avcodec_get_frame_class(void);
4277 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4278 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4280 * @see av_opt_find().
4282 const AVClass *avcodec_get_subtitle_rect_class(void);
4285 * Copy the settings of the source AVCodecContext into the destination
4286 * AVCodecContext. The resulting destination codec context will be
4287 * unopened, i.e. you are required to call avcodec_open2() before you
4288 * can use this AVCodecContext to decode/encode video/audio data.
4290 * @param dest target codec context, should be initialized with
4291 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4292 * @param src source codec context
4293 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4295 * @deprecated The semantics of this function are ill-defined and it should not
4296 * be used. If you need to transfer the stream parameters from one codec context
4297 * to another, use an intermediate AVCodecParameters instance and the
4298 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4301 attribute_deprecated
4302 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4306 * Allocate a new AVCodecParameters and set its fields to default values
4307 * (unknown/invalid/0). The returned struct must be freed with
4308 * avcodec_parameters_free().
4310 AVCodecParameters *avcodec_parameters_alloc(void);
4313 * Free an AVCodecParameters instance and everything associated with it and
4314 * write NULL to the supplied pointer.
4316 void avcodec_parameters_free(AVCodecParameters **par);
4319 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4320 * replaced with newly allocated duplicates of the corresponding fields in src.
4322 * @return >= 0 on success, a negative AVERROR code on failure.
4324 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4327 * Fill the parameters struct based on the values from the supplied codec
4328 * context. Any allocated fields in par are freed and replaced with duplicates
4329 * of the corresponding fields in codec.
4331 * @return >= 0 on success, a negative AVERROR code on failure
4333 int avcodec_parameters_from_context(AVCodecParameters *par,
4334 const AVCodecContext *codec);
4337 * Fill the codec context based on the values from the supplied codec
4338 * parameters. Any allocated fields in codec that have a corresponding field in
4339 * par are freed and replaced with duplicates of the corresponding field in par.
4340 * Fields in codec that do not have a counterpart in par are not touched.
4342 * @return >= 0 on success, a negative AVERROR code on failure.
4344 int avcodec_parameters_to_context(AVCodecContext *codec,
4345 const AVCodecParameters *par);
4348 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4349 * function the context has to be allocated with avcodec_alloc_context3().
4351 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4352 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4353 * retrieving a codec.
4355 * @warning This function is not thread safe!
4357 * @note Always call this function before using decoding routines (such as
4358 * @ref avcodec_receive_frame()).
4361 * avcodec_register_all();
4362 * av_dict_set(&opts, "b", "2.5M", 0);
4363 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4367 * context = avcodec_alloc_context3(codec);
4369 * if (avcodec_open2(context, codec, opts) < 0)
4373 * @param avctx The context to initialize.
4374 * @param codec The codec to open this context for. If a non-NULL codec has been
4375 * previously passed to avcodec_alloc_context3() or
4376 * for this context, then this parameter MUST be either NULL or
4377 * equal to the previously passed codec.
4378 * @param options A dictionary filled with AVCodecContext and codec-private options.
4379 * On return this object will be filled with options that were not found.
4381 * @return zero on success, a negative value on error
4382 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4383 * av_dict_set(), av_opt_find().
4385 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4388 * Close a given AVCodecContext and free all the data associated with it
4389 * (but not the AVCodecContext itself).
4391 * Calling this function on an AVCodecContext that hasn't been opened will free
4392 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4393 * codec. Subsequent calls will do nothing.
4395 * @note Do not use this function. Use avcodec_free_context() to destroy a
4396 * codec context (either open or closed). Opening and closing a codec context
4397 * multiple times is not supported anymore -- use multiple codec contexts
4400 int avcodec_close(AVCodecContext *avctx);
4403 * Free all allocated data in the given subtitle struct.
4405 * @param sub AVSubtitle to free.
4407 void avsubtitle_free(AVSubtitle *sub);
4414 * @addtogroup lavc_packet
4419 * Allocate an AVPacket and set its fields to default values. The resulting
4420 * struct must be freed using av_packet_free().
4422 * @return An AVPacket filled with default values or NULL on failure.
4424 * @note this only allocates the AVPacket itself, not the data buffers. Those
4425 * must be allocated through other means such as av_new_packet.
4427 * @see av_new_packet
4429 AVPacket *av_packet_alloc(void);
4432 * Create a new packet that references the same data as src.
4434 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4436 * @return newly created AVPacket on success, NULL on error.
4438 * @see av_packet_alloc
4439 * @see av_packet_ref
4441 AVPacket *av_packet_clone(AVPacket *src);
4444 * Free the packet, if the packet is reference counted, it will be
4445 * unreferenced first.
4447 * @param packet packet to be freed. The pointer will be set to NULL.
4448 * @note passing NULL is a no-op.
4450 void av_packet_free(AVPacket **pkt);
4453 * Initialize optional fields of a packet with default values.
4455 * Note, this does not touch the data and size members, which have to be
4456 * initialized separately.
4460 void av_init_packet(AVPacket *pkt);
4463 * Allocate the payload of a packet and initialize its fields with
4467 * @param size wanted payload size
4468 * @return 0 if OK, AVERROR_xxx otherwise
4470 int av_new_packet(AVPacket *pkt, int size);
4473 * Reduce packet size, correctly zeroing padding
4476 * @param size new size
4478 void av_shrink_packet(AVPacket *pkt, int size);
4481 * Increase packet size, correctly zeroing padding
4484 * @param grow_by number of bytes by which to increase the size of the packet
4486 int av_grow_packet(AVPacket *pkt, int grow_by);
4489 * Initialize a reference-counted packet from av_malloc()ed data.
4491 * @param pkt packet to be initialized. This function will set the data, size,
4492 * buf and destruct fields, all others are left untouched.
4493 * @param data Data allocated by av_malloc() to be used as packet data. If this
4494 * function returns successfully, the data is owned by the underlying AVBuffer.
4495 * The caller may not access the data through other means.
4496 * @param size size of data in bytes, without the padding. I.e. the full buffer
4497 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4499 * @return 0 on success, a negative AVERROR on error
4501 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4503 #if FF_API_AVPACKET_OLD_API
4505 * @warning This is a hack - the packet memory allocation stuff is broken. The
4506 * packet is allocated if it was not really allocated.
4508 * @deprecated Use av_packet_ref
4510 attribute_deprecated
4511 int av_dup_packet(AVPacket *pkt);
4513 * Copy packet, including contents
4515 * @return 0 on success, negative AVERROR on fail
4517 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4520 * Copy packet side data
4522 * @return 0 on success, negative AVERROR on fail
4524 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4529 * @deprecated Use av_packet_unref
4531 * @param pkt packet to free
4533 attribute_deprecated
4534 void av_free_packet(AVPacket *pkt);
4537 * Allocate new information of a packet.
4540 * @param type side information type
4541 * @param size side information size
4542 * @return pointer to fresh allocated data or NULL otherwise
4544 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4548 * Wrap an existing array as a packet side data.
4551 * @param type side information type
4552 * @param data the side data array. It must be allocated with the av_malloc()
4553 * family of functions. The ownership of the data is transferred to
4555 * @param size side information size
4556 * @return a non-negative number on success, a negative AVERROR code on
4557 * failure. On failure, the packet is unchanged and the data remains
4558 * owned by the caller.
4560 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4561 uint8_t *data, size_t size);
4564 * Shrink the already allocated side data buffer
4567 * @param type side information type
4568 * @param size new side information size
4569 * @return 0 on success, < 0 on failure
4571 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4575 * Get side information from packet.
4578 * @param type desired side information type
4579 * @param size pointer for side information size to store (optional)
4580 * @return pointer to data if present or NULL otherwise
4582 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4585 #if FF_API_MERGE_SD_API
4586 attribute_deprecated
4587 int av_packet_merge_side_data(AVPacket *pkt);
4589 attribute_deprecated
4590 int av_packet_split_side_data(AVPacket *pkt);
4593 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4596 * Pack a dictionary for use in side_data.
4598 * @param dict The dictionary to pack.
4599 * @param size pointer to store the size of the returned data
4600 * @return pointer to data if successful, NULL otherwise
4602 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4604 * Unpack a dictionary from side_data.
4606 * @param data data from side_data
4607 * @param size size of the data
4608 * @param dict the metadata storage dictionary
4609 * @return 0 on success, < 0 on failure
4611 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4615 * Convenience function to free all the side data stored.
4616 * All the other fields stay untouched.
4620 void av_packet_free_side_data(AVPacket *pkt);
4623 * Setup a new reference to the data described by a given packet
4625 * If src is reference-counted, setup dst as a new reference to the
4626 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4627 * data from src into it.
4629 * All the other fields are copied from src.
4631 * @see av_packet_unref
4633 * @param dst Destination packet
4634 * @param src Source packet
4636 * @return 0 on success, a negative AVERROR on error.
4638 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4643 * Unreference the buffer referenced by the packet and reset the
4644 * remaining packet fields to their default values.
4646 * @param pkt The packet to be unreferenced.
4648 void av_packet_unref(AVPacket *pkt);
4651 * Move every field in src to dst and reset src.
4653 * @see av_packet_unref
4655 * @param src Source packet, will be reset
4656 * @param dst Destination packet
4658 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4661 * Copy only "properties" fields from src to dst.
4663 * Properties for the purpose of this function are all the fields
4664 * beside those related to the packet data (buf, data, size)
4666 * @param dst Destination packet
4667 * @param src Source packet
4669 * @return 0 on success AVERROR on failure.
4671 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4674 * Convert valid timing fields (timestamps / durations) in a packet from one
4675 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4678 * @param pkt packet on which the conversion will be performed
4679 * @param tb_src source timebase, in which the timing fields in pkt are
4681 * @param tb_dst destination timebase, to which the timing fields will be
4684 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4691 * @addtogroup lavc_decoding
4696 * Find a registered decoder with a matching codec ID.
4698 * @param id AVCodecID of the requested decoder
4699 * @return A decoder if one was found, NULL otherwise.
4701 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4704 * Find a registered decoder with the specified name.
4706 * @param name name of the requested decoder
4707 * @return A decoder if one was found, NULL otherwise.
4709 AVCodec *avcodec_find_decoder_by_name(const char *name);
4712 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4713 * it can be called by custom get_buffer2() implementations for decoders without
4714 * AV_CODEC_CAP_DR1 set.
4716 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4720 * Return the amount of padding in pixels which the get_buffer callback must
4721 * provide around the edge of the image for codecs which do not have the
4722 * CODEC_FLAG_EMU_EDGE flag.
4724 * @return Required padding in pixels.
4726 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4729 attribute_deprecated
4730 unsigned avcodec_get_edge_width(void);
4734 * Modify width and height values so that they will result in a memory
4735 * buffer that is acceptable for the codec if you do not use any horizontal
4738 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4740 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4743 * Modify width and height values so that they will result in a memory
4744 * buffer that is acceptable for the codec if you also ensure that all
4745 * line sizes are a multiple of the respective linesize_align[i].
4747 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4749 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4750 int linesize_align[AV_NUM_DATA_POINTERS]);
4753 * Converts AVChromaLocation to swscale x/y chroma position.
4755 * The positions represent the chroma (0,0) position in a coordinates system
4756 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4758 * @param xpos horizontal chroma sample position
4759 * @param ypos vertical chroma sample position
4761 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4764 * Converts swscale x/y chroma position to AVChromaLocation.
4766 * The positions represent the chroma (0,0) position in a coordinates system
4767 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4769 * @param xpos horizontal chroma sample position
4770 * @param ypos vertical chroma sample position
4772 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4775 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4777 * Some decoders may support multiple frames in a single AVPacket. Such
4778 * decoders would then just decode the first frame and the return value would be
4779 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4780 * called again with an AVPacket containing the remaining data in order to
4781 * decode the second frame, etc... Even if no frames are returned, the packet
4782 * needs to be fed to the decoder with remaining data until it is completely
4783 * consumed or an error occurs.
4785 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4786 * and output. This means that for some packets they will not immediately
4787 * produce decoded output and need to be flushed at the end of decoding to get
4788 * all the decoded data. Flushing is done by calling this function with packets
4789 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4790 * returning samples. It is safe to flush even those decoders that are not
4791 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4793 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4794 * larger than the actual read bytes because some optimized bitstream
4795 * readers read 32 or 64 bits at once and could read over the end.
4797 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4798 * before packets may be fed to the decoder.
4800 * @param avctx the codec context
4801 * @param[out] frame The AVFrame in which to store decoded audio samples.
4802 * The decoder will allocate a buffer for the decoded frame by
4803 * calling the AVCodecContext.get_buffer2() callback.
4804 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4805 * reference counted and the returned reference belongs to the
4806 * caller. The caller must release the frame using av_frame_unref()
4807 * when the frame is no longer needed. The caller may safely write
4808 * to the frame if av_frame_is_writable() returns 1.
4809 * When AVCodecContext.refcounted_frames is set to 0, the returned
4810 * reference belongs to the decoder and is valid only until the
4811 * next call to this function or until closing or flushing the
4812 * decoder. The caller may not write to it.
4813 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4814 * non-zero. Note that this field being set to zero
4815 * does not mean that an error has occurred. For
4816 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4817 * call is guaranteed to produce a frame.
4818 * @param[in] avpkt The input AVPacket containing the input buffer.
4819 * At least avpkt->data and avpkt->size should be set. Some
4820 * decoders might also require additional fields to be set.
4821 * @return A negative error code is returned if an error occurred during
4822 * decoding, otherwise the number of bytes consumed from the input
4823 * AVPacket is returned.
4825 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4827 attribute_deprecated
4828 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4829 int *got_frame_ptr, const AVPacket *avpkt);
4832 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4833 * Some decoders may support multiple frames in a single AVPacket, such
4834 * decoders would then just decode the first frame.
4836 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4837 * the actual read bytes because some optimized bitstream readers read 32 or 64
4838 * bits at once and could read over the end.
4840 * @warning The end of the input buffer buf should be set to 0 to ensure that
4841 * no overreading happens for damaged MPEG streams.
4843 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4844 * between input and output, these need to be fed with avpkt->data=NULL,
4845 * avpkt->size=0 at the end to return the remaining frames.
4847 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4848 * before packets may be fed to the decoder.
4850 * @param avctx the codec context
4851 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4852 * Use av_frame_alloc() to get an AVFrame. The codec will
4853 * allocate memory for the actual bitmap by calling the
4854 * AVCodecContext.get_buffer2() callback.
4855 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4856 * reference counted and the returned reference belongs to the
4857 * caller. The caller must release the frame using av_frame_unref()
4858 * when the frame is no longer needed. The caller may safely write
4859 * to the frame if av_frame_is_writable() returns 1.
4860 * When AVCodecContext.refcounted_frames is set to 0, the returned
4861 * reference belongs to the decoder and is valid only until the
4862 * next call to this function or until closing or flushing the
4863 * decoder. The caller may not write to it.
4865 * @param[in] avpkt The input AVPacket containing the input buffer.
4866 * You can create such packet with av_init_packet() and by then setting
4867 * data and size, some decoders might in addition need other fields like
4868 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4870 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4871 * @return On error a negative value is returned, otherwise the number of bytes
4872 * used or zero if no frame could be decompressed.
4874 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4876 attribute_deprecated
4877 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4878 int *got_picture_ptr,
4879 const AVPacket *avpkt);
4882 * Decode a subtitle message.
4883 * Return a negative value on error, otherwise return the number of bytes used.
4884 * If no subtitle could be decompressed, got_sub_ptr is zero.
4885 * Otherwise, the subtitle is stored in *sub.
4886 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4887 * simplicity, because the performance difference is expect to be negligible
4888 * and reusing a get_buffer written for video codecs would probably perform badly
4889 * due to a potentially very different allocation pattern.
4891 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4892 * and output. This means that for some packets they will not immediately
4893 * produce decoded output and need to be flushed at the end of decoding to get
4894 * all the decoded data. Flushing is done by calling this function with packets
4895 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4896 * returning subtitles. It is safe to flush even those decoders that are not
4897 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4899 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4900 * before packets may be fed to the decoder.
4902 * @param avctx the codec context
4903 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4904 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4905 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4906 * @param[in] avpkt The input AVPacket containing the input buffer.
4908 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4913 * Supply raw packet data as input to a decoder.
4915 * Internally, this call will copy relevant AVCodecContext fields, which can
4916 * influence decoding per-packet, and apply them when the packet is actually
4917 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4918 * decoder to drop the frame contained by the packet sent with this function.)
4920 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4921 * larger than the actual read bytes because some optimized bitstream
4922 * readers read 32 or 64 bits at once and could read over the end.
4924 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4925 * on the same AVCodecContext. It will return unexpected results now
4926 * or in future libavcodec versions.
4928 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4929 * before packets may be fed to the decoder.
4931 * @param avctx codec context
4932 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4933 * frame, or several complete audio frames.
4934 * Ownership of the packet remains with the caller, and the
4935 * decoder will not write to the packet. The decoder may create
4936 * a reference to the packet data (or copy it if the packet is
4937 * not reference-counted).
4938 * Unlike with older APIs, the packet is always fully consumed,
4939 * and if it contains multiple frames (e.g. some audio codecs),
4940 * will require you to call avcodec_receive_frame() multiple
4941 * times afterwards before you can send a new packet.
4942 * It can be NULL (or an AVPacket with data set to NULL and
4943 * size set to 0); in this case, it is considered a flush
4944 * packet, which signals the end of the stream. Sending the
4945 * first flush packet will return success. Subsequent ones are
4946 * unnecessary and will return AVERROR_EOF. If the decoder
4947 * still has frames buffered, it will return them after sending
4950 * @return 0 on success, otherwise negative error code:
4951 * AVERROR(EAGAIN): input is not accepted in the current state - user
4952 * must read output with avcodec_receive_frame() (once
4953 * all output is read, the packet should be resent, and
4954 * the call will not fail with EAGAIN).
4955 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4956 * be sent to it (also returned if more than 1 flush
4958 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4959 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4960 * other errors: legitimate decoding errors
4962 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4965 * Return decoded output data from a decoder.
4967 * @param avctx codec context
4968 * @param frame This will be set to a reference-counted video or audio
4969 * frame (depending on the decoder type) allocated by the
4970 * decoder. Note that the function will always call
4971 * av_frame_unref(frame) before doing anything else.
4974 * 0: success, a frame was returned
4975 * AVERROR(EAGAIN): output is not available in this state - user must try
4977 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4978 * no more output frames
4979 * AVERROR(EINVAL): codec not opened, or it is an encoder
4980 * other negative values: legitimate decoding errors
4982 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4985 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4986 * to retrieve buffered output packets.
4988 * @param avctx codec context
4989 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4990 * Ownership of the frame remains with the caller, and the
4991 * encoder will not write to the frame. The encoder may create
4992 * a reference to the frame data (or copy it if the frame is
4993 * not reference-counted).
4994 * It can be NULL, in which case it is considered a flush
4995 * packet. This signals the end of the stream. If the encoder
4996 * still has packets buffered, it will return them after this
4997 * call. Once flushing mode has been entered, additional flush
4998 * packets are ignored, and sending frames will return
5002 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5003 * can have any number of samples.
5004 * If it is not set, frame->nb_samples must be equal to
5005 * avctx->frame_size for all frames except the last.
5006 * The final frame may be smaller than avctx->frame_size.
5007 * @return 0 on success, otherwise negative error code:
5008 * AVERROR(EAGAIN): input is not accepted in the current state - user
5009 * must read output with avcodec_receive_packet() (once
5010 * all output is read, the packet should be resent, and
5011 * the call will not fail with EAGAIN).
5012 * AVERROR_EOF: the encoder has been flushed, and no new frames can
5014 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
5015 * decoder, or requires flush
5016 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5017 * other errors: legitimate decoding errors
5019 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5022 * Read encoded data from the encoder.
5024 * @param avctx codec context
5025 * @param avpkt This will be set to a reference-counted packet allocated by the
5026 * encoder. Note that the function will always call
5027 * av_frame_unref(frame) before doing anything else.
5028 * @return 0 on success, otherwise negative error code:
5029 * AVERROR(EAGAIN): output is not available in the current state - user
5030 * must try to send input
5031 * AVERROR_EOF: the encoder has been fully flushed, and there will be
5032 * no more output packets
5033 * AVERROR(EINVAL): codec not opened, or it is an encoder
5034 * other errors: legitimate decoding errors
5036 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5040 * @defgroup lavc_parsing Frame parsing
5044 enum AVPictureStructure {
5045 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5046 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5047 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5048 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5051 typedef struct AVCodecParserContext {
5053 struct AVCodecParser *parser;
5054 int64_t frame_offset; /* offset of the current frame */
5055 int64_t cur_offset; /* current offset
5056 (incremented by each av_parser_parse()) */
5057 int64_t next_frame_offset; /* offset of the next frame */
5059 int pict_type; /* XXX: Put it back in AVCodecContext. */
5061 * This field is used for proper frame duration computation in lavf.
5062 * It signals, how much longer the frame duration of the current frame
5063 * is compared to normal frame duration.
5065 * frame_duration = (1 + repeat_pict) * time_base
5067 * It is used by codecs like H.264 to display telecined material.
5069 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5070 int64_t pts; /* pts of the current frame */
5071 int64_t dts; /* dts of the current frame */
5076 int fetch_timestamp;
5078 #define AV_PARSER_PTS_NB 4
5079 int cur_frame_start_index;
5080 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5081 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5082 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5085 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5086 #define PARSER_FLAG_ONCE 0x0002
5087 /// Set if the parser has a valid file offset
5088 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5089 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5091 int64_t offset; ///< byte offset from starting packet start
5092 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5095 * Set by parser to 1 for key frames and 0 for non-key frames.
5096 * It is initialized to -1, so if the parser doesn't set this flag,
5097 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5102 #if FF_API_CONVERGENCE_DURATION
5104 * @deprecated unused
5106 attribute_deprecated
5107 int64_t convergence_duration;
5110 // Timestamp generation support:
5112 * Synchronization point for start of timestamp generation.
5114 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5117 * For example, this corresponds to presence of H.264 buffering period
5123 * Offset of the current timestamp against last timestamp sync point in
5124 * units of AVCodecContext.time_base.
5126 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5127 * contain a valid timestamp offset.
5129 * Note that the timestamp of sync point has usually a nonzero
5130 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5131 * the next frame after timestamp sync point will be usually 1.
5133 * For example, this corresponds to H.264 cpb_removal_delay.
5135 int dts_ref_dts_delta;
5138 * Presentation delay of current frame in units of AVCodecContext.time_base.
5140 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5141 * contain valid non-negative timestamp delta (presentation time of a frame
5142 * must not lie in the past).
5144 * This delay represents the difference between decoding and presentation
5145 * time of the frame.
5147 * For example, this corresponds to H.264 dpb_output_delay.
5152 * Position of the packet in file.
5154 * Analogous to cur_frame_pts/dts
5156 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5159 * Byte position of currently parsed frame in stream.
5164 * Previous frame byte position.
5169 * Duration of the current frame.
5170 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5171 * For all other types, this is in units of AVCodecContext.time_base.
5175 enum AVFieldOrder field_order;
5178 * Indicate whether a picture is coded as a frame, top field or bottom field.
5180 * For example, H.264 field_pic_flag equal to 0 corresponds to
5181 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5182 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5183 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5185 enum AVPictureStructure picture_structure;
5188 * Picture number incremented in presentation or output order.
5189 * This field may be reinitialized at the first picture of a new sequence.
5191 * For example, this corresponds to H.264 PicOrderCnt.
5193 int output_picture_number;
5196 * Dimensions of the decoded video intended for presentation.
5202 * Dimensions of the coded video.
5208 * The format of the coded data, corresponds to enum AVPixelFormat for video
5209 * and for enum AVSampleFormat for audio.
5211 * Note that a decoder can have considerable freedom in how exactly it
5212 * decodes the data, so the format reported here might be different from the
5213 * one returned by a decoder.
5216 } AVCodecParserContext;
5218 typedef struct AVCodecParser {
5219 int codec_ids[5]; /* several codec IDs are permitted */
5221 int (*parser_init)(AVCodecParserContext *s);
5222 /* This callback never returns an error, a negative value means that
5223 * the frame start was in a previous packet. */
5224 int (*parser_parse)(AVCodecParserContext *s,
5225 AVCodecContext *avctx,
5226 const uint8_t **poutbuf, int *poutbuf_size,
5227 const uint8_t *buf, int buf_size);
5228 void (*parser_close)(AVCodecParserContext *s);
5229 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5230 struct AVCodecParser *next;
5233 AVCodecParser *av_parser_next(const AVCodecParser *c);
5235 void av_register_codec_parser(AVCodecParser *parser);
5236 AVCodecParserContext *av_parser_init(int codec_id);
5241 * @param s parser context.
5242 * @param avctx codec context.
5243 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5244 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5245 * @param buf input buffer.
5246 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5247 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5248 To signal EOF, this should be 0 (so that the last frame
5250 * @param pts input presentation timestamp.
5251 * @param dts input decoding timestamp.
5252 * @param pos input byte position in stream.
5253 * @return the number of bytes of the input bitstream used.
5258 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5265 * decode_frame(data, size);
5269 int av_parser_parse2(AVCodecParserContext *s,
5270 AVCodecContext *avctx,
5271 uint8_t **poutbuf, int *poutbuf_size,
5272 const uint8_t *buf, int buf_size,
5273 int64_t pts, int64_t dts,
5277 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5278 * @deprecated use AVBitStreamFilter
5280 int av_parser_change(AVCodecParserContext *s,
5281 AVCodecContext *avctx,
5282 uint8_t **poutbuf, int *poutbuf_size,
5283 const uint8_t *buf, int buf_size, int keyframe);
5284 void av_parser_close(AVCodecParserContext *s);
5292 * @addtogroup lavc_encoding
5297 * Find a registered encoder with a matching codec ID.
5299 * @param id AVCodecID of the requested encoder
5300 * @return An encoder if one was found, NULL otherwise.
5302 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5305 * Find a registered encoder with the specified name.
5307 * @param name name of the requested encoder
5308 * @return An encoder if one was found, NULL otherwise.
5310 AVCodec *avcodec_find_encoder_by_name(const char *name);
5313 * Encode a frame of audio.
5315 * Takes input samples from frame and writes the next output packet, if
5316 * available, to avpkt. The output packet does not necessarily contain data for
5317 * the most recent frame, as encoders can delay, split, and combine input frames
5318 * internally as needed.
5320 * @param avctx codec context
5321 * @param avpkt output AVPacket.
5322 * The user can supply an output buffer by setting
5323 * avpkt->data and avpkt->size prior to calling the
5324 * function, but if the size of the user-provided data is not
5325 * large enough, encoding will fail. If avpkt->data and
5326 * avpkt->size are set, avpkt->destruct must also be set. All
5327 * other AVPacket fields will be reset by the encoder using
5328 * av_init_packet(). If avpkt->data is NULL, the encoder will
5329 * allocate it. The encoder will set avpkt->size to the size
5330 * of the output packet.
5332 * If this function fails or produces no output, avpkt will be
5333 * freed using av_packet_unref().
5334 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5335 * May be NULL when flushing an encoder that has the
5336 * AV_CODEC_CAP_DELAY capability set.
5337 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5338 * can have any number of samples.
5339 * If it is not set, frame->nb_samples must be equal to
5340 * avctx->frame_size for all frames except the last.
5341 * The final frame may be smaller than avctx->frame_size.
5342 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5343 * output packet is non-empty, and to 0 if it is
5344 * empty. If the function returns an error, the
5345 * packet can be assumed to be invalid, and the
5346 * value of got_packet_ptr is undefined and should
5348 * @return 0 on success, negative error code on failure
5350 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5352 attribute_deprecated
5353 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5354 const AVFrame *frame, int *got_packet_ptr);
5357 * Encode a frame of video.
5359 * Takes input raw video data from frame and writes the next output packet, if
5360 * available, to avpkt. The output packet does not necessarily contain data for
5361 * the most recent frame, as encoders can delay and reorder input frames
5362 * internally as needed.
5364 * @param avctx codec context
5365 * @param avpkt output AVPacket.
5366 * The user can supply an output buffer by setting
5367 * avpkt->data and avpkt->size prior to calling the
5368 * function, but if the size of the user-provided data is not
5369 * large enough, encoding will fail. All other AVPacket fields
5370 * will be reset by the encoder using av_init_packet(). If
5371 * avpkt->data is NULL, the encoder will allocate it.
5372 * The encoder will set avpkt->size to the size of the
5373 * output packet. The returned data (if any) belongs to the
5374 * caller, he is responsible for freeing it.
5376 * If this function fails or produces no output, avpkt will be
5377 * freed using av_packet_unref().
5378 * @param[in] frame AVFrame containing the raw video data to be encoded.
5379 * May be NULL when flushing an encoder that has the
5380 * AV_CODEC_CAP_DELAY capability set.
5381 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5382 * output packet is non-empty, and to 0 if it is
5383 * empty. If the function returns an error, the
5384 * packet can be assumed to be invalid, and the
5385 * value of got_packet_ptr is undefined and should
5387 * @return 0 on success, negative error code on failure
5389 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5391 attribute_deprecated
5392 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5393 const AVFrame *frame, int *got_packet_ptr);
5395 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5396 const AVSubtitle *sub);
5403 #if FF_API_AVCODEC_RESAMPLE
5405 * @defgroup lavc_resample Audio resampling
5407 * @deprecated use libswresample instead
5411 struct ReSampleContext;
5412 struct AVResampleContext;
5414 typedef struct ReSampleContext ReSampleContext;
5417 * Initialize audio resampling context.
5419 * @param output_channels number of output channels
5420 * @param input_channels number of input channels
5421 * @param output_rate output sample rate
5422 * @param input_rate input sample rate
5423 * @param sample_fmt_out requested output sample format
5424 * @param sample_fmt_in input sample format
5425 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5426 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5427 * @param linear if 1 then the used FIR filter will be linearly interpolated
5428 between the 2 closest, if 0 the closest will be used
5429 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5430 * @return allocated ReSampleContext, NULL if error occurred
5432 attribute_deprecated
5433 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5434 int output_rate, int input_rate,
5435 enum AVSampleFormat sample_fmt_out,
5436 enum AVSampleFormat sample_fmt_in,
5437 int filter_length, int log2_phase_count,
5438 int linear, double cutoff);
5440 attribute_deprecated
5441 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5444 * Free resample context.
5446 * @param s a non-NULL pointer to a resample context previously
5447 * created with av_audio_resample_init()
5449 attribute_deprecated
5450 void audio_resample_close(ReSampleContext *s);
5454 * Initialize an audio resampler.
5455 * Note, if either rate is not an integer then simply scale both rates up so they are.
5456 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5457 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5458 * @param linear If 1 then the used FIR filter will be linearly interpolated
5459 between the 2 closest, if 0 the closest will be used
5460 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5462 attribute_deprecated
5463 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5466 * Resample an array of samples using a previously configured context.
5467 * @param src an array of unconsumed samples
5468 * @param consumed the number of samples of src which have been consumed are returned here
5469 * @param src_size the number of unconsumed samples available
5470 * @param dst_size the amount of space in samples available in dst
5471 * @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.
5472 * @return the number of samples written in dst or -1 if an error occurred
5474 attribute_deprecated
5475 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5479 * Compensate samplerate/timestamp drift. The compensation is done by changing
5480 * the resampler parameters, so no audible clicks or similar distortions occur
5481 * @param compensation_distance distance in output samples over which the compensation should be performed
5482 * @param sample_delta number of output samples which should be output less
5484 * example: av_resample_compensate(c, 10, 500)
5485 * here instead of 510 samples only 500 samples would be output
5487 * note, due to rounding the actual compensation might be slightly different,
5488 * especially if the compensation_distance is large and the in_rate used during init is small
5490 attribute_deprecated
5491 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5492 attribute_deprecated
5493 void av_resample_close(struct AVResampleContext *c);
5500 #if FF_API_AVPICTURE
5502 * @addtogroup lavc_picture
5507 * @deprecated unused
5509 attribute_deprecated
5510 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5513 * @deprecated unused
5515 attribute_deprecated
5516 void avpicture_free(AVPicture *picture);
5519 * @deprecated use av_image_fill_arrays() instead.
5521 attribute_deprecated
5522 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5523 enum AVPixelFormat pix_fmt, int width, int height);
5526 * @deprecated use av_image_copy_to_buffer() instead.
5528 attribute_deprecated
5529 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5530 int width, int height,
5531 unsigned char *dest, int dest_size);
5534 * @deprecated use av_image_get_buffer_size() instead.
5536 attribute_deprecated
5537 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5540 * @deprecated av_image_copy() instead.
5542 attribute_deprecated
5543 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5544 enum AVPixelFormat pix_fmt, int width, int height);
5547 * @deprecated unused
5549 attribute_deprecated
5550 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5551 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5554 * @deprecated unused
5556 attribute_deprecated
5557 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5558 int padtop, int padbottom, int padleft, int padright, int *color);
5566 * @defgroup lavc_misc Utility functions
5569 * Miscellaneous utility functions related to both encoding and decoding
5575 * @defgroup lavc_misc_pixfmt Pixel formats
5577 * Functions for working with pixel formats.
5582 * Utility function to access log2_chroma_w log2_chroma_h from
5583 * the pixel format AVPixFmtDescriptor.
5585 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5586 * for one that returns a failure code and continues in case of invalid
5589 * @param[in] pix_fmt the pixel format
5590 * @param[out] h_shift store log2_chroma_w
5591 * @param[out] v_shift store log2_chroma_h
5593 * @see av_pix_fmt_get_chroma_sub_sample
5596 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5599 * Return a value representing the fourCC code associated to the
5600 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5603 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5606 * @deprecated see av_get_pix_fmt_loss()
5608 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5612 * Find the best pixel format to convert to given a certain source pixel
5613 * format. When converting from one pixel format to another, information loss
5614 * may occur. For example, when converting from RGB24 to GRAY, the color
5615 * information will be lost. Similarly, other losses occur when converting from
5616 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5617 * the given pixel formats should be used to suffer the least amount of loss.
5618 * The pixel formats from which it chooses one, are determined by the
5619 * pix_fmt_list parameter.
5622 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5623 * @param[in] src_pix_fmt source pixel format
5624 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5625 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5626 * @return The best pixel format to convert to or -1 if none was found.
5628 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5629 enum AVPixelFormat src_pix_fmt,
5630 int has_alpha, int *loss_ptr);
5633 * @deprecated see av_find_best_pix_fmt_of_2()
5635 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5636 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5638 attribute_deprecated
5639 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5640 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5642 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5648 #if FF_API_SET_DIMENSIONS
5650 * @deprecated this function is not supposed to be used from outside of lavc
5652 attribute_deprecated
5653 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5657 * Put a string representing the codec tag codec_tag in buf.
5659 * @param buf buffer to place codec tag in
5660 * @param buf_size size in bytes of buf
5661 * @param codec_tag codec tag to assign
5662 * @return the length of the string that would have been generated if
5663 * enough space had been available, excluding the trailing null
5665 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5667 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5670 * Return a name for the specified profile, if available.
5672 * @param codec the codec that is searched for the given profile
5673 * @param profile the profile value for which a name is requested
5674 * @return A name for the profile if found, NULL otherwise.
5676 const char *av_get_profile_name(const AVCodec *codec, int profile);
5679 * Return a name for the specified profile, if available.
5681 * @param codec_id the ID of the codec to which the requested profile belongs
5682 * @param profile the profile value for which a name is requested
5683 * @return A name for the profile if found, NULL otherwise.
5685 * @note unlike av_get_profile_name(), which searches a list of profiles
5686 * supported by a specific decoder or encoder implementation, this
5687 * function searches the list of profiles from the AVCodecDescriptor
5689 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5691 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5692 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5693 //FIXME func typedef
5696 * Fill AVFrame audio data and linesize pointers.
5698 * The buffer buf must be a preallocated buffer with a size big enough
5699 * to contain the specified samples amount. The filled AVFrame data
5700 * pointers will point to this buffer.
5702 * AVFrame extended_data channel pointers are allocated if necessary for
5705 * @param frame the AVFrame
5706 * frame->nb_samples must be set prior to calling the
5707 * function. This function fills in frame->data,
5708 * frame->extended_data, frame->linesize[0].
5709 * @param nb_channels channel count
5710 * @param sample_fmt sample format
5711 * @param buf buffer to use for frame data
5712 * @param buf_size size of buffer
5713 * @param align plane size sample alignment (0 = default)
5714 * @return >=0 on success, negative error code on failure
5715 * @todo return the size in bytes required to store the samples in
5716 * case of success, at the next libavutil bump
5718 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5719 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5720 int buf_size, int align);
5723 * Reset the internal decoder state / flush internal buffers. Should be called
5724 * e.g. when seeking or when switching to a different stream.
5726 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5727 * this invalidates the frames previously returned from the decoder. When
5728 * refcounted frames are used, the decoder just releases any references it might
5729 * keep internally, but the caller's reference remains valid.
5731 void avcodec_flush_buffers(AVCodecContext *avctx);
5734 * Return codec bits per sample.
5736 * @param[in] codec_id the codec
5737 * @return Number of bits per sample or zero if unknown for the given codec.
5739 int av_get_bits_per_sample(enum AVCodecID codec_id);
5742 * Return the PCM codec associated with a sample format.
5743 * @param be endianness, 0 for little, 1 for big,
5744 * -1 (or anything else) for native
5745 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5747 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5750 * Return codec bits per sample.
5751 * Only return non-zero if the bits per sample is exactly correct, not an
5754 * @param[in] codec_id the codec
5755 * @return Number of bits per sample or zero if unknown for the given codec.
5757 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5760 * Return audio frame duration.
5762 * @param avctx codec context
5763 * @param frame_bytes size of the frame, or 0 if unknown
5764 * @return frame duration, in samples, if known. 0 if not able to
5767 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5770 * This function is the same as av_get_audio_frame_duration(), except it works
5771 * with AVCodecParameters instead of an AVCodecContext.
5773 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5776 typedef struct AVBitStreamFilterContext {
5778 const struct AVBitStreamFilter *filter;
5779 AVCodecParserContext *parser;
5780 struct AVBitStreamFilterContext *next;
5782 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5783 * Not for access by library users.
5786 } AVBitStreamFilterContext;
5789 typedef struct AVBSFInternal AVBSFInternal;
5792 * The bitstream filter state.
5794 * This struct must be allocated with av_bsf_alloc() and freed with
5797 * The fields in the struct will only be changed (by the caller or by the
5798 * filter) as described in their documentation, and are to be considered
5799 * immutable otherwise.
5801 typedef struct AVBSFContext {
5803 * A class for logging and AVOptions
5805 const AVClass *av_class;
5808 * The bitstream filter this context is an instance of.
5810 const struct AVBitStreamFilter *filter;
5813 * Opaque libavcodec internal data. Must not be touched by the caller in any
5816 AVBSFInternal *internal;
5819 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5820 * this is an AVOptions-enabled struct.
5825 * Parameters of the input stream. Set by the caller before av_bsf_init().
5827 AVCodecParameters *par_in;
5830 * Parameters of the output stream. Set by the filter in av_bsf_init().
5832 AVCodecParameters *par_out;
5835 * The timebase used for the timestamps of the input packets. Set by the
5836 * caller before av_bsf_init().
5838 AVRational time_base_in;
5841 * The timebase used for the timestamps of the output packets. Set by the
5842 * filter in av_bsf_init().
5844 AVRational time_base_out;
5847 typedef struct AVBitStreamFilter {
5851 * A list of codec ids supported by the filter, terminated by
5853 * May be NULL, in that case the bitstream filter works with any codec id.
5855 const enum AVCodecID *codec_ids;
5858 * A class for the private data, used to declare bitstream filter private
5859 * AVOptions. This field is NULL for bitstream filters that do not declare
5862 * If this field is non-NULL, the first member of the filter private data
5863 * must be a pointer to AVClass, which will be set by libavcodec generic
5864 * code to this class.
5866 const AVClass *priv_class;
5868 /*****************************************************************
5869 * No fields below this line are part of the public API. They
5870 * may not be used outside of libavcodec and can be changed and
5872 * New public fields should be added right above.
5873 *****************************************************************
5877 int (*init)(AVBSFContext *ctx);
5878 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5879 void (*close)(AVBSFContext *ctx);
5880 } AVBitStreamFilter;
5884 * Register a bitstream filter.
5886 * The filter will be accessible to the application code through
5887 * av_bitstream_filter_next() or can be directly initialized with
5888 * av_bitstream_filter_init().
5890 * @see avcodec_register_all()
5892 attribute_deprecated
5893 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5896 * Create and initialize a bitstream filter context given a bitstream
5899 * The returned context must be freed with av_bitstream_filter_close().
5901 * @param name the name of the bitstream filter
5902 * @return a bitstream filter context if a matching filter was found
5903 * and successfully initialized, NULL otherwise
5905 attribute_deprecated
5906 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5911 * This function filters the buffer buf with size buf_size, and places the
5912 * filtered buffer in the buffer pointed to by poutbuf.
5914 * The output buffer must be freed by the caller.
5916 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5917 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5918 * If specified, this must point to the encoder context of the
5919 * output stream the packet is sent to.
5920 * @param args arguments which specify the filter configuration, may be NULL
5921 * @param poutbuf pointer which is updated to point to the filtered buffer
5922 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5923 * @param buf buffer containing the data to filter
5924 * @param buf_size size in bytes of buf
5925 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5926 * @return >= 0 in case of success, or a negative error code in case of failure
5928 * If the return value is positive, an output buffer is allocated and
5929 * is available in *poutbuf, and is distinct from the input buffer.
5931 * If the return value is 0, the output buffer is not allocated and
5932 * should be considered identical to the input buffer, or in case
5933 * *poutbuf was set it points to the input buffer (not necessarily to
5934 * its starting address). A special case is if *poutbuf was set to NULL and
5935 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5937 attribute_deprecated
5938 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5939 AVCodecContext *avctx, const char *args,
5940 uint8_t **poutbuf, int *poutbuf_size,
5941 const uint8_t *buf, int buf_size, int keyframe);
5944 * Release bitstream filter context.
5946 * @param bsf the bitstream filter context created with
5947 * av_bitstream_filter_init(), can be NULL
5949 attribute_deprecated
5950 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5953 * If f is NULL, return the first registered bitstream filter,
5954 * if f is non-NULL, return the next registered bitstream filter
5955 * after f, or NULL if f is the last one.
5957 * This function can be used to iterate over all registered bitstream
5960 attribute_deprecated
5961 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5965 * @return a bitstream filter with the specified name or NULL if no such
5966 * bitstream filter exists.
5968 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5971 * Iterate over all registered bitstream filters.
5973 * @param opaque a pointer where libavcodec will store the iteration state. Must
5974 * point to NULL to start the iteration.
5976 * @return the next registered bitstream filter or NULL when the iteration is
5979 const AVBitStreamFilter *av_bsf_next(void **opaque);
5982 * Allocate a context for a given bitstream filter. The caller must fill in the
5983 * context parameters as described in the documentation and then call
5984 * av_bsf_init() before sending any data to the filter.
5986 * @param filter the filter for which to allocate an instance.
5987 * @param ctx a pointer into which the pointer to the newly-allocated context
5988 * will be written. It must be freed with av_bsf_free() after the
5989 * filtering is done.
5991 * @return 0 on success, a negative AVERROR code on failure
5993 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5996 * Prepare the filter for use, after all the parameters and options have been
5999 int av_bsf_init(AVBSFContext *ctx);
6002 * Submit a packet for filtering.
6004 * After sending each packet, the filter must be completely drained by calling
6005 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
6008 * @param pkt the packet to filter. pkt must contain some payload (i.e data or
6009 * side data must be present in pkt). The bitstream filter will take ownership of
6010 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
6011 * This parameter may be NULL, which signals the end of the stream (i.e. no more
6012 * packets will be sent). That will cause the filter to output any packets it
6013 * may have buffered internally.
6015 * @return 0 on success, a negative AVERROR on error.
6017 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
6020 * Retrieve a filtered packet.
6022 * @param[out] pkt this struct will be filled with the contents of the filtered
6023 * packet. It is owned by the caller and must be freed using
6024 * av_packet_unref() when it is no longer needed.
6025 * This parameter should be "clean" (i.e. freshly allocated
6026 * with av_packet_alloc() or unreffed with av_packet_unref())
6027 * when this function is called. If this function returns
6028 * successfully, the contents of pkt will be completely
6029 * overwritten by the returned data. On failure, pkt is not
6032 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
6033 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
6034 * will be no further output from the filter. Another negative AVERROR value if
6037 * @note one input packet may result in several output packets, so after sending
6038 * a packet with av_bsf_send_packet(), this function needs to be called
6039 * repeatedly until it stops returning 0. It is also possible for a filter to
6040 * output fewer packets than were sent to it, so this function may return
6041 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6043 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6046 * Free a bitstream filter context and everything associated with it; write NULL
6047 * into the supplied pointer.
6049 void av_bsf_free(AVBSFContext **ctx);
6052 * Get the AVClass for AVBSFContext. It can be used in combination with
6053 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6055 * @see av_opt_find().
6057 const AVClass *av_bsf_get_class(void);
6060 * Structure for chain/list of bitstream filters.
6061 * Empty list can be allocated by av_bsf_list_alloc().
6063 typedef struct AVBSFList AVBSFList;
6066 * Allocate empty list of bitstream filters.
6067 * The list must be later freed by av_bsf_list_free()
6068 * or finalized by av_bsf_list_finalize().
6070 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6072 AVBSFList *av_bsf_list_alloc(void);
6075 * Free list of bitstream filters.
6077 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6079 void av_bsf_list_free(AVBSFList **lst);
6082 * Append bitstream filter to the list of bitstream filters.
6084 * @param lst List to append to
6085 * @param bsf Filter context to be appended
6087 * @return >=0 on success, negative AVERROR in case of failure
6089 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6092 * Construct new bitstream filter context given it's name and options
6093 * and append it to the list of bitstream filters.
6095 * @param lst List to append to
6096 * @param bsf_name Name of the bitstream filter
6097 * @param options Options for the bitstream filter, can be set to NULL
6099 * @return >=0 on success, negative AVERROR in case of failure
6101 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6103 * Finalize list of bitstream filters.
6105 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6106 * so the whole chain of bitstream filters can be treated as single filter
6107 * freshly allocated by av_bsf_alloc().
6108 * If the call is successful, @ref AVBSFList structure is freed and lst
6109 * will be set to NULL. In case of failure, caller is responsible for
6110 * freeing the structure by av_bsf_list_free()
6112 * @param lst Filter list structure to be transformed
6113 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6114 * representing the chain of bitstream filters
6116 * @return >=0 on success, negative AVERROR in case of failure
6118 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6121 * Parse string describing list of bitstream filters and create single
6122 * @ref AVBSFContext describing the whole chain of bitstream filters.
6123 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6124 * allocated by av_bsf_alloc().
6126 * @param str String describing chain of bitstream filters in format
6127 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6128 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6129 * representing the chain of bitstream filters
6131 * @return >=0 on success, negative AVERROR in case of failure
6133 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6136 * Get null/pass-through bitstream filter.
6138 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6142 int av_bsf_get_null_filter(AVBSFContext **bsf);
6147 * Same behaviour av_fast_malloc but the buffer has additional
6148 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6150 * In addition the whole buffer will initially and after resizes
6151 * be 0-initialized so that no uninitialized data will ever appear.
6153 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6156 * Same behaviour av_fast_padded_malloc except that buffer will always
6157 * be 0-initialized after call.
6159 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6162 * Encode extradata length to a buffer. Used by xiph codecs.
6164 * @param s buffer to write to; must be at least (v/255+1) bytes long
6165 * @param v size of extradata in bytes
6166 * @return number of bytes written to the buffer.
6168 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6170 #if FF_API_MISSING_SAMPLE
6172 * Log a generic warning message about a missing feature. This function is
6173 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6174 * only, and would normally not be used by applications.
6175 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6176 * a pointer to an AVClass struct
6177 * @param[in] feature string containing the name of the missing feature
6178 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
6179 * If want_sample is non-zero, additional verbiage will be added to the log
6180 * message which tells the user how to report samples to the development
6182 * @deprecated Use avpriv_report_missing_feature() instead.
6184 attribute_deprecated
6185 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
6188 * Log a generic warning message asking for a sample. This function is
6189 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6190 * only, and would normally not be used by applications.
6191 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6192 * a pointer to an AVClass struct
6193 * @param[in] msg string containing an optional message, or NULL if no message
6194 * @deprecated Use avpriv_request_sample() instead.
6196 attribute_deprecated
6197 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
6198 #endif /* FF_API_MISSING_SAMPLE */
6201 * Register the hardware accelerator hwaccel.
6203 void av_register_hwaccel(AVHWAccel *hwaccel);
6206 * If hwaccel is NULL, returns the first registered hardware accelerator,
6207 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6208 * after hwaccel, or NULL if hwaccel is the last one.
6210 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6214 * Lock operation used by lockmgr
6217 AV_LOCK_CREATE, ///< Create a mutex
6218 AV_LOCK_OBTAIN, ///< Lock the mutex
6219 AV_LOCK_RELEASE, ///< Unlock the mutex
6220 AV_LOCK_DESTROY, ///< Free mutex resources
6224 * Register a user provided lock manager supporting the operations
6225 * specified by AVLockOp. The "mutex" argument to the function points
6226 * to a (void *) where the lockmgr should store/get a pointer to a user
6227 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6228 * value left by the last call for all other ops. If the lock manager is
6229 * unable to perform the op then it should leave the mutex in the same
6230 * state as when it was called and return a non-zero value. However,
6231 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6232 * have been successfully destroyed. If av_lockmgr_register succeeds
6233 * it will return a non-negative value, if it fails it will return a
6234 * negative value and destroy all mutex and unregister all callbacks.
6235 * av_lockmgr_register is not thread-safe, it must be called from a
6236 * single thread before any calls which make use of locking are used.
6238 * @param cb User defined callback. av_lockmgr_register invokes calls
6239 * to this callback and the previously registered callback.
6240 * The callback will be used to create more than one mutex
6241 * each of which must be backed by its own underlying locking
6242 * mechanism (i.e. do not use a single static object to
6243 * implement your lock manager). If cb is set to NULL the
6244 * lockmgr will be unregistered.
6246 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6249 * Get the type of the given codec.
6251 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6254 * Get the name of a codec.
6255 * @return a static string identifying the codec; never NULL
6257 const char *avcodec_get_name(enum AVCodecID id);
6260 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6261 * with no corresponding avcodec_close()), 0 otherwise.
6263 int avcodec_is_open(AVCodecContext *s);
6266 * @return a non-zero number if codec is an encoder, zero otherwise
6268 int av_codec_is_encoder(const AVCodec *codec);
6271 * @return a non-zero number if codec is a decoder, zero otherwise
6273 int av_codec_is_decoder(const AVCodec *codec);
6276 * @return descriptor for given codec ID or NULL if no descriptor exists.
6278 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6281 * Iterate over all codec descriptors known to libavcodec.
6283 * @param prev previous descriptor. NULL to get the first descriptor.
6285 * @return next descriptor or NULL after the last descriptor
6287 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6290 * @return codec descriptor with the given name or NULL if no such descriptor
6293 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6296 * Allocate a CPB properties structure and initialize its fields to default
6299 * @param size if non-NULL, the size of the allocated struct will be written
6300 * here. This is useful for embedding it in side data.
6302 * @return the newly allocated struct or NULL on failure
6304 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6310 #endif /* AVCODEC_AVCODEC_H */