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 AVERROR(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 AVERROR(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 AVERROR(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 AVERROR(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,
445 AV_CODEC_ID_BITPACKED,
447 /* various PCM "codecs" */
448 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
449 AV_CODEC_ID_PCM_S16LE = 0x10000,
450 AV_CODEC_ID_PCM_S16BE,
451 AV_CODEC_ID_PCM_U16LE,
452 AV_CODEC_ID_PCM_U16BE,
455 AV_CODEC_ID_PCM_MULAW,
456 AV_CODEC_ID_PCM_ALAW,
457 AV_CODEC_ID_PCM_S32LE,
458 AV_CODEC_ID_PCM_S32BE,
459 AV_CODEC_ID_PCM_U32LE,
460 AV_CODEC_ID_PCM_U32BE,
461 AV_CODEC_ID_PCM_S24LE,
462 AV_CODEC_ID_PCM_S24BE,
463 AV_CODEC_ID_PCM_U24LE,
464 AV_CODEC_ID_PCM_U24BE,
465 AV_CODEC_ID_PCM_S24DAUD,
466 AV_CODEC_ID_PCM_ZORK,
467 AV_CODEC_ID_PCM_S16LE_PLANAR,
469 AV_CODEC_ID_PCM_F32BE,
470 AV_CODEC_ID_PCM_F32LE,
471 AV_CODEC_ID_PCM_F64BE,
472 AV_CODEC_ID_PCM_F64LE,
473 AV_CODEC_ID_PCM_BLURAY,
476 AV_CODEC_ID_PCM_S8_PLANAR,
477 AV_CODEC_ID_PCM_S24LE_PLANAR,
478 AV_CODEC_ID_PCM_S32LE_PLANAR,
479 AV_CODEC_ID_PCM_S16BE_PLANAR,
481 AV_CODEC_ID_PCM_S64LE = 0x10800,
482 AV_CODEC_ID_PCM_S64BE,
483 AV_CODEC_ID_PCM_F16LE,
484 AV_CODEC_ID_PCM_F24LE,
486 /* various ADPCM codecs */
487 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
488 AV_CODEC_ID_ADPCM_IMA_WAV,
489 AV_CODEC_ID_ADPCM_IMA_DK3,
490 AV_CODEC_ID_ADPCM_IMA_DK4,
491 AV_CODEC_ID_ADPCM_IMA_WS,
492 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
493 AV_CODEC_ID_ADPCM_MS,
494 AV_CODEC_ID_ADPCM_4XM,
495 AV_CODEC_ID_ADPCM_XA,
496 AV_CODEC_ID_ADPCM_ADX,
497 AV_CODEC_ID_ADPCM_EA,
498 AV_CODEC_ID_ADPCM_G726,
499 AV_CODEC_ID_ADPCM_CT,
500 AV_CODEC_ID_ADPCM_SWF,
501 AV_CODEC_ID_ADPCM_YAMAHA,
502 AV_CODEC_ID_ADPCM_SBPRO_4,
503 AV_CODEC_ID_ADPCM_SBPRO_3,
504 AV_CODEC_ID_ADPCM_SBPRO_2,
505 AV_CODEC_ID_ADPCM_THP,
506 AV_CODEC_ID_ADPCM_IMA_AMV,
507 AV_CODEC_ID_ADPCM_EA_R1,
508 AV_CODEC_ID_ADPCM_EA_R3,
509 AV_CODEC_ID_ADPCM_EA_R2,
510 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
511 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
512 AV_CODEC_ID_ADPCM_EA_XAS,
513 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
514 AV_CODEC_ID_ADPCM_IMA_ISS,
515 AV_CODEC_ID_ADPCM_G722,
516 AV_CODEC_ID_ADPCM_IMA_APC,
517 AV_CODEC_ID_ADPCM_VIMA,
518 #if FF_API_VIMA_DECODER
519 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
522 AV_CODEC_ID_ADPCM_AFC = 0x11800,
523 AV_CODEC_ID_ADPCM_IMA_OKI,
524 AV_CODEC_ID_ADPCM_DTK,
525 AV_CODEC_ID_ADPCM_IMA_RAD,
526 AV_CODEC_ID_ADPCM_G726LE,
527 AV_CODEC_ID_ADPCM_THP_LE,
528 AV_CODEC_ID_ADPCM_PSX,
529 AV_CODEC_ID_ADPCM_AICA,
530 AV_CODEC_ID_ADPCM_IMA_DAT4,
531 AV_CODEC_ID_ADPCM_MTAF,
534 AV_CODEC_ID_AMR_NB = 0x12000,
537 /* RealAudio codecs*/
538 AV_CODEC_ID_RA_144 = 0x13000,
541 /* various DPCM codecs */
542 AV_CODEC_ID_ROQ_DPCM = 0x14000,
543 AV_CODEC_ID_INTERPLAY_DPCM,
544 AV_CODEC_ID_XAN_DPCM,
545 AV_CODEC_ID_SOL_DPCM,
547 AV_CODEC_ID_SDX2_DPCM = 0x14800,
550 AV_CODEC_ID_MP2 = 0x15000,
551 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
561 AV_CODEC_ID_VMDAUDIO,
567 AV_CODEC_ID_WESTWOOD_SND1,
568 AV_CODEC_ID_GSM, ///< as in Berlin toast format
571 AV_CODEC_ID_TRUESPEECH,
573 AV_CODEC_ID_SMACKAUDIO,
576 AV_CODEC_ID_DSICINAUDIO,
578 AV_CODEC_ID_MUSEPACK7,
580 AV_CODEC_ID_GSM_MS, /* as found in WAV */
586 AV_CODEC_ID_NELLYMOSER,
587 AV_CODEC_ID_MUSEPACK8,
589 AV_CODEC_ID_WMAVOICE,
591 AV_CODEC_ID_WMALOSSLESS,
600 AV_CODEC_ID_BINKAUDIO_RDFT,
601 AV_CODEC_ID_BINKAUDIO_DCT,
602 AV_CODEC_ID_AAC_LATM,
607 AV_CODEC_ID_8SVX_EXP,
608 AV_CODEC_ID_8SVX_FIB,
609 AV_CODEC_ID_BMV_AUDIO,
614 AV_CODEC_ID_COMFORT_NOISE,
616 AV_CODEC_ID_METASOUND,
617 AV_CODEC_ID_PAF_AUDIO,
621 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
623 AV_CODEC_ID_SONIC_LS,
626 AV_CODEC_ID_DSD_LSBF,
627 AV_CODEC_ID_DSD_MSBF,
628 AV_CODEC_ID_DSD_LSBF_PLANAR,
629 AV_CODEC_ID_DSD_MSBF_PLANAR,
631 AV_CODEC_ID_INTERPLAY_ACM,
635 AV_CODEC_ID_ATRAC3AL,
636 AV_CODEC_ID_ATRAC3PAL,
638 /* subtitle codecs */
639 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
640 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
641 AV_CODEC_ID_DVB_SUBTITLE,
642 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
645 AV_CODEC_ID_MOV_TEXT,
646 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
647 AV_CODEC_ID_DVB_TELETEXT,
650 AV_CODEC_ID_MICRODVD = 0x17800,
654 AV_CODEC_ID_REALTEXT,
656 AV_CODEC_ID_SUBVIEWER1,
657 AV_CODEC_ID_SUBVIEWER,
664 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
666 /* other specific kind of codecs (generally used for attachments) */
667 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
668 AV_CODEC_ID_TTF = 0x18000,
670 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
671 AV_CODEC_ID_BINTEXT = 0x18800,
675 AV_CODEC_ID_SMPTE_KLV,
677 AV_CODEC_ID_TIMED_ID3,
678 AV_CODEC_ID_BIN_DATA,
681 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
683 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
684 * stream (only used by libavformat) */
685 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
686 * stream (only used by libavformat) */
687 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
688 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
692 * This struct describes the properties of a single codec described by an
694 * @see avcodec_descriptor_get()
696 typedef struct AVCodecDescriptor {
698 enum AVMediaType type;
700 * Name of the codec described by this descriptor. It is non-empty and
701 * unique for each codec descriptor. It should contain alphanumeric
702 * characters and '_' only.
706 * A more descriptive name for this codec. May be NULL.
708 const char *long_name;
710 * Codec properties, a combination of AV_CODEC_PROP_* flags.
714 * MIME type(s) associated with the codec.
715 * May be NULL; if not, a NULL-terminated array of MIME types.
716 * The first item is always non-NULL and is the preferred MIME type.
718 const char *const *mime_types;
720 * If non-NULL, an array of profiles recognized for this codec.
721 * Terminated with FF_PROFILE_UNKNOWN.
723 const struct AVProfile *profiles;
727 * Codec uses only intra compression.
728 * Video and audio codecs only.
730 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
732 * Codec supports lossy compression. Audio and video codecs only.
733 * @note a codec may support both lossy and lossless
736 #define AV_CODEC_PROP_LOSSY (1 << 1)
738 * Codec supports lossless compression. Audio and video codecs only.
740 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
742 * Codec supports frame reordering. That is, the coded order (the order in which
743 * the encoded packets are output by the encoders / stored / input to the
744 * decoders) may be different from the presentation order of the corresponding
747 * For codecs that do not have this property set, PTS and DTS should always be
750 #define AV_CODEC_PROP_REORDER (1 << 3)
752 * Subtitle codec is bitmap based
753 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
755 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
757 * Subtitle codec is text based.
758 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
760 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
763 * @ingroup lavc_decoding
764 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
765 * This is mainly needed because some optimized bitstream readers read
766 * 32 or 64 bit at once and could read over the end.<br>
767 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
768 * MPEG bitstreams could cause overread and segfault.
770 #define AV_INPUT_BUFFER_PADDING_SIZE 32
773 * @ingroup lavc_encoding
774 * minimum encoding buffer size
775 * Used to avoid some checks during header writing.
777 #define AV_INPUT_BUFFER_MIN_SIZE 16384
779 #if FF_API_WITHOUT_PREFIX
781 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
783 #define FF_INPUT_BUFFER_PADDING_SIZE 32
786 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
788 #define FF_MIN_BUFFER_SIZE 16384
789 #endif /* FF_API_WITHOUT_PREFIX */
792 * @ingroup lavc_encoding
793 * motion estimation type.
794 * @deprecated use codec private option instead
796 #if FF_API_MOTION_EST
798 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
802 ME_EPZS, ///< enhanced predictive zonal search
803 ME_X1, ///< reserved for experiments
804 ME_HEX, ///< hexagon based search
805 ME_UMH, ///< uneven multi-hexagon search
806 ME_TESA, ///< transformed exhaustive search algorithm
807 ME_ITER=50, ///< iterative search
812 * @ingroup lavc_decoding
815 /* We leave some space between them for extensions (drop some
816 * keyframes for intra-only or drop just some bidir frames). */
817 AVDISCARD_NONE =-16, ///< discard nothing
818 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
819 AVDISCARD_NONREF = 8, ///< discard all non reference
820 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
821 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
822 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
823 AVDISCARD_ALL = 48, ///< discard all
826 enum AVAudioServiceType {
827 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
828 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
829 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
830 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
831 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
832 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
833 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
834 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
835 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
836 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
840 * @ingroup lavc_encoding
842 typedef struct RcOverride{
845 int qscale; // If this is 0 then quality_factor will be used instead.
846 float quality_factor;
849 #if FF_API_MAX_BFRAMES
851 * @deprecated there is no libavcodec-wide limit on the number of B-frames
853 #define FF_MAX_B_FRAMES 16
857 These flags can be passed in AVCodecContext.flags before initialization.
858 Note: Not everything is supported yet.
862 * Allow decoders to produce frames with data planes that are not aligned
863 * to CPU requirements (e.g. due to cropping).
865 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
869 #define AV_CODEC_FLAG_QSCALE (1 << 1)
871 * 4 MV per MB allowed / advanced prediction for H.263.
873 #define AV_CODEC_FLAG_4MV (1 << 2)
875 * Output even those frames that might be corrupted.
877 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
881 #define AV_CODEC_FLAG_QPEL (1 << 4)
883 * Use internal 2pass ratecontrol in first pass mode.
885 #define AV_CODEC_FLAG_PASS1 (1 << 9)
887 * Use internal 2pass ratecontrol in second pass mode.
889 #define AV_CODEC_FLAG_PASS2 (1 << 10)
893 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
895 * Only decode/encode grayscale.
897 #define AV_CODEC_FLAG_GRAY (1 << 13)
899 * error[?] variables will be set during encoding.
901 #define AV_CODEC_FLAG_PSNR (1 << 15)
903 * Input bitstream might be truncated at a random location
904 * instead of only at frame boundaries.
906 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
908 * Use interlaced DCT.
910 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
914 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
916 * Place global headers in extradata instead of every keyframe.
918 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
920 * Use only bitexact stuff (except (I)DCT).
922 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
923 /* Fx : Flag for H.263+ extra options */
925 * H.263 advanced intra coding / MPEG-4 AC prediction
927 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
929 * interlaced motion estimation
931 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
932 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
935 * Allow non spec compliant speedup tricks.
937 #define AV_CODEC_FLAG2_FAST (1 << 0)
939 * Skip bitstream encoding.
941 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
943 * Place global headers at every keyframe instead of in extradata.
945 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
948 * timecode is in drop frame format. DEPRECATED!!!!
950 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
953 * Input bitstream might be truncated at a packet boundaries
954 * instead of only at frame boundaries.
956 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
958 * Discard cropping information from SPS.
960 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
963 * Show all frames before the first keyframe
965 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
967 * Export motion vectors through frame side data
969 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
971 * Do not skip samples and export skip information as frame side data
973 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
975 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
977 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
979 /* Unsupported options :
980 * Syntax Arithmetic coding (SAC)
981 * Reference Picture Selection
982 * Independent Segment Decoding */
984 /* codec capabilities */
987 * Decoder can use draw_horiz_band callback.
989 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
991 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
992 * If not set, it might not use get_buffer() at all or use operations that
993 * assume the buffer was allocated by avcodec_default_get_buffer.
995 #define AV_CODEC_CAP_DR1 (1 << 1)
996 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
998 * Encoder or decoder requires flushing with NULL input at the end in order to
999 * give the complete and correct output.
1001 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1002 * with NULL data. The user can still send NULL data to the public encode
1003 * or decode function, but libavcodec will not pass it along to the codec
1004 * unless this flag is set.
1007 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1008 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1012 * The encoder needs to be fed with NULL data at the end of encoding until the
1013 * encoder no longer returns data.
1015 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1016 * flag also means that the encoder must set the pts and duration for
1017 * each output packet. If this flag is not set, the pts and duration will
1018 * be determined by libavcodec from the input frame.
1020 #define AV_CODEC_CAP_DELAY (1 << 5)
1022 * Codec can be fed a final frame with a smaller size.
1023 * This can be used to prevent truncation of the last audio samples.
1025 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1027 #if FF_API_CAP_VDPAU
1029 * Codec can export data for HW decoding (VDPAU).
1031 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
1035 * Codec can output multiple frames per AVPacket
1036 * Normally demuxers return one frame at a time, demuxers which do not do
1037 * are connected to a parser to split what they return into proper frames.
1038 * This flag is reserved to the very rare category of codecs which have a
1039 * bitstream that cannot be split into frames without timeconsuming
1040 * operations like full decoding. Demuxers carrying such bitstreams thus
1041 * may return multiple frames in a packet. This has many disadvantages like
1042 * prohibiting stream copy in many cases thus it should only be considered
1045 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1047 * Codec is experimental and is thus avoided in favor of non experimental
1050 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1052 * Codec should fill in channel configuration and samplerate instead of container
1054 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1056 * Codec supports frame-level multithreading.
1058 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1060 * Codec supports slice-based (or partition-based) multithreading.
1062 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1064 * Codec supports changed parameters at any point.
1066 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1068 * Codec supports avctx->thread_count == 0 (auto).
1070 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1072 * Audio encoder supports receiving a different number of samples in each call.
1074 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1076 * Decoder is not a preferred choice for probing.
1077 * This indicates that the decoder is not a good choice for probing.
1078 * It could for example be an expensive to spin up hardware decoder,
1079 * or it could simply not provide a lot of useful information about
1081 * A decoder marked with this flag should only be used as last resort
1082 * choice for probing.
1084 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1086 * Codec is intra only.
1088 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1090 * Codec is lossless.
1092 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1095 #if FF_API_WITHOUT_PREFIX
1097 * Allow decoders to produce frames with data planes that are not aligned
1098 * to CPU requirements (e.g. due to cropping).
1100 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1101 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1102 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1103 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1104 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1107 * @deprecated use the "gmc" private option of the libxvid encoder
1109 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1113 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1114 * mpegvideo encoders
1116 #define CODEC_FLAG_MV0 0x0040
1118 #if FF_API_INPUT_PRESERVED
1120 * @deprecated passing reference-counted frames to the encoders replaces this
1123 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1125 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1126 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1127 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1130 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1133 #define CODEC_FLAG_EMU_EDGE 0x4000
1135 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1136 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1138 #if FF_API_NORMALIZE_AQP
1140 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1141 * mpegvideo encoders
1143 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1145 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1146 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1147 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1148 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1149 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1150 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1151 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1152 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1153 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1154 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1155 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1156 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1157 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1159 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1160 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1161 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1162 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1164 /* Unsupported options :
1165 * Syntax Arithmetic coding (SAC)
1166 * Reference Picture Selection
1167 * Independent Segment Decoding */
1169 /* codec capabilities */
1171 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1173 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1174 * If not set, it might not use get_buffer() at all or use operations that
1175 * assume the buffer was allocated by avcodec_default_get_buffer.
1177 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1178 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1180 /* Codec can export data for HW decoding. This flag indicates that
1181 * the codec would call get_format() with list that might contain HW accelerated
1182 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1183 * including raw image format.
1184 * The application can use the passed context to determine bitstream version,
1185 * chroma format, resolution etc.
1187 #define CODEC_CAP_HWACCEL 0x0010
1188 #endif /* FF_API_XVMC */
1190 * Encoder or decoder requires flushing with NULL input at the end in order to
1191 * give the complete and correct output.
1193 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1194 * with NULL data. The user can still send NULL data to the public encode
1195 * or decode function, but libavcodec will not pass it along to the codec
1196 * unless this flag is set.
1199 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1200 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1204 * The encoder needs to be fed with NULL data at the end of encoding until the
1205 * encoder no longer returns data.
1207 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1208 * flag also means that the encoder must set the pts and duration for
1209 * each output packet. If this flag is not set, the pts and duration will
1210 * be determined by libavcodec from the input frame.
1212 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1214 * Codec can be fed a final frame with a smaller size.
1215 * This can be used to prevent truncation of the last audio samples.
1217 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1218 #if FF_API_CAP_VDPAU
1220 * Codec can export data for HW decoding (VDPAU).
1222 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1225 * Codec can output multiple frames per AVPacket
1226 * Normally demuxers return one frame at a time, demuxers which do not do
1227 * are connected to a parser to split what they return into proper frames.
1228 * This flag is reserved to the very rare category of codecs which have a
1229 * bitstream that cannot be split into frames without timeconsuming
1230 * operations like full decoding. Demuxers carrying such bitstreams thus
1231 * may return multiple frames in a packet. This has many disadvantages like
1232 * prohibiting stream copy in many cases thus it should only be considered
1235 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1237 * Codec is experimental and is thus avoided in favor of non experimental
1240 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1242 * Codec should fill in channel configuration and samplerate instead of container
1244 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1245 #if FF_API_NEG_LINESIZES
1247 * @deprecated no codecs use this capability
1249 #define CODEC_CAP_NEG_LINESIZES 0x0800
1252 * Codec supports frame-level multithreading.
1254 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1256 * Codec supports slice-based (or partition-based) multithreading.
1258 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1260 * Codec supports changed parameters at any point.
1262 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1264 * Codec supports avctx->thread_count == 0 (auto).
1266 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1268 * Audio encoder supports receiving a different number of samples in each call.
1270 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1272 * Codec is intra only.
1274 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1276 * Codec is lossless.
1278 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1281 * HWAccel is experimental and is thus avoided in favor of non experimental
1284 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1285 #endif /* FF_API_WITHOUT_PREFIX */
1288 //The following defines may change, don't expect compatibility if you use them.
1289 #define MB_TYPE_INTRA4x4 0x0001
1290 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1291 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1292 #define MB_TYPE_16x16 0x0008
1293 #define MB_TYPE_16x8 0x0010
1294 #define MB_TYPE_8x16 0x0020
1295 #define MB_TYPE_8x8 0x0040
1296 #define MB_TYPE_INTERLACED 0x0080
1297 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1298 #define MB_TYPE_ACPRED 0x0200
1299 #define MB_TYPE_GMC 0x0400
1300 #define MB_TYPE_SKIP 0x0800
1301 #define MB_TYPE_P0L0 0x1000
1302 #define MB_TYPE_P1L0 0x2000
1303 #define MB_TYPE_P0L1 0x4000
1304 #define MB_TYPE_P1L1 0x8000
1305 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1306 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1307 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1308 #define MB_TYPE_QUANT 0x00010000
1309 #define MB_TYPE_CBP 0x00020000
1310 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1315 * This specifies the area which should be displayed.
1316 * Note there may be multiple such areas for one frame.
1318 typedef struct AVPanScan{
1321 * - encoding: Set by user.
1322 * - decoding: Set by libavcodec.
1327 * width and height in 1/16 pel
1328 * - encoding: Set by user.
1329 * - decoding: Set by libavcodec.
1335 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1336 * - encoding: Set by user.
1337 * - decoding: Set by libavcodec.
1339 int16_t position[3][2];
1343 * This structure describes the bitrate properties of an encoded bitstream. It
1344 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1345 * parameters for H.264/HEVC.
1347 typedef struct AVCPBProperties {
1349 * Maximum bitrate of the stream, in bits per second.
1350 * Zero if unknown or unspecified.
1354 * Minimum bitrate of the stream, in bits per second.
1355 * Zero if unknown or unspecified.
1359 * Average bitrate of the stream, in bits per second.
1360 * Zero if unknown or unspecified.
1365 * The size of the buffer to which the ratecontrol is applied, in bits.
1366 * Zero if unknown or unspecified.
1371 * The delay between the time the packet this structure is associated with
1372 * is received and the time when it should be decoded, in periods of a 27MHz
1375 * UINT64_MAX when unknown or unspecified.
1380 #if FF_API_QSCALE_TYPE
1381 #define FF_QSCALE_TYPE_MPEG1 0
1382 #define FF_QSCALE_TYPE_MPEG2 1
1383 #define FF_QSCALE_TYPE_H264 2
1384 #define FF_QSCALE_TYPE_VP56 3
1388 * The decoder will keep a reference to the frame and may reuse it later.
1390 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1393 * @defgroup lavc_packet AVPacket
1395 * Types and functions for working with AVPacket.
1398 enum AVPacketSideDataType {
1400 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1401 * bytes worth of palette. This side data signals that a new palette is
1404 AV_PKT_DATA_PALETTE,
1407 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1408 * that the extradata buffer was changed and the receiving side should
1409 * act upon it appropriately. The new extradata is embedded in the side
1410 * data buffer and should be immediately used for processing the current
1413 AV_PKT_DATA_NEW_EXTRADATA,
1416 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1419 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1420 * s32le channel_count
1421 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1422 * u64le channel_layout
1423 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1425 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1430 AV_PKT_DATA_PARAM_CHANGE,
1433 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1434 * structures with info about macroblocks relevant to splitting the
1435 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1436 * That is, it does not necessarily contain info about all macroblocks,
1437 * as long as the distance between macroblocks in the info is smaller
1438 * than the target payload size.
1439 * Each MB info structure is 12 bytes, and is laid out as follows:
1441 * u32le bit offset from the start of the packet
1442 * u8 current quantizer at the start of the macroblock
1444 * u16le macroblock address within the GOB
1445 * u8 horizontal MV predictor
1446 * u8 vertical MV predictor
1447 * u8 horizontal MV predictor for block number 3
1448 * u8 vertical MV predictor for block number 3
1451 AV_PKT_DATA_H263_MB_INFO,
1454 * This side data should be associated with an audio stream and contains
1455 * ReplayGain information in form of the AVReplayGain struct.
1457 AV_PKT_DATA_REPLAYGAIN,
1460 * This side data contains a 3x3 transformation matrix describing an affine
1461 * transformation that needs to be applied to the decoded video frames for
1462 * correct presentation.
1464 * See libavutil/display.h for a detailed description of the data.
1466 AV_PKT_DATA_DISPLAYMATRIX,
1469 * This side data should be associated with a video stream and contains
1470 * Stereoscopic 3D information in form of the AVStereo3D struct.
1472 AV_PKT_DATA_STEREO3D,
1475 * This side data should be associated with an audio stream and corresponds
1476 * to enum AVAudioServiceType.
1478 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1481 * This side data contains quality related information from the encoder.
1483 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1487 * u64le[error count] sum of squared differences between encoder in and output
1490 AV_PKT_DATA_QUALITY_STATS,
1493 * This side data contains an integer value representing the stream index
1494 * of a "fallback" track. A fallback track indicates an alternate
1495 * track to use when the current track can not be decoded for some reason.
1496 * e.g. no decoder available for codec.
1498 AV_PKT_DATA_FALLBACK_TRACK,
1501 * This side data corresponds to the AVCPBProperties struct.
1503 AV_PKT_DATA_CPB_PROPERTIES,
1506 * Recommmends skipping the specified number of samples
1508 * u32le number of samples to skip from start of this packet
1509 * u32le number of samples to skip from end of this packet
1510 * u8 reason for start skip
1511 * u8 reason for end skip (0=padding silence, 1=convergence)
1514 AV_PKT_DATA_SKIP_SAMPLES=70,
1517 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1518 * the packet may contain "dual mono" audio specific to Japanese DTV
1519 * and if it is true, recommends only the selected channel to be used.
1521 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1524 AV_PKT_DATA_JP_DUALMONO,
1527 * A list of zero terminated key/value strings. There is no end marker for
1528 * the list, so it is required to rely on the side data size to stop.
1530 AV_PKT_DATA_STRINGS_METADATA,
1533 * Subtitle event position
1541 AV_PKT_DATA_SUBTITLE_POSITION,
1544 * Data found in BlockAdditional element of matroska container. There is
1545 * no end marker for the data, so it is required to rely on the side data
1546 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1549 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1552 * The optional first identifier line of a WebVTT cue.
1554 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1557 * The optional settings (rendering instructions) that immediately
1558 * follow the timestamp specifier of a WebVTT cue.
1560 AV_PKT_DATA_WEBVTT_SETTINGS,
1563 * A list of zero terminated key/value strings. There is no end marker for
1564 * the list, so it is required to rely on the side data size to stop. This
1565 * side data includes updated metadata which appeared in the stream.
1567 AV_PKT_DATA_METADATA_UPDATE,
1570 * MPEGTS stream ID, this is required to pass the stream ID
1571 * information from the demuxer to the corresponding muxer.
1573 AV_PKT_DATA_MPEGTS_STREAM_ID,
1576 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1577 * should be associated with a video stream and contains data in the form
1578 * of the AVMasteringDisplayMetadata struct.
1580 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1583 * This side data should be associated with a video stream and corresponds
1584 * to the AVSphericalMapping structure.
1586 AV_PKT_DATA_SPHERICAL,
1589 * Content light level (based on CTA-861.3). This metadata should be
1590 * associated with a video stream and contains data in the form of the
1591 * AVContentLightMetadata struct.
1593 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1596 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1598 typedef struct AVPacketSideData {
1601 enum AVPacketSideDataType type;
1605 * This structure stores compressed data. It is typically exported by demuxers
1606 * and then passed as input to decoders, or received as output from encoders and
1607 * then passed to muxers.
1609 * For video, it should typically contain one compressed frame. For audio it may
1610 * contain several compressed frames. Encoders are allowed to output empty
1611 * packets, with no compressed data, containing only side data
1612 * (e.g. to update some stream parameters at the end of encoding).
1614 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1615 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1616 * without libavcodec and libavformat major bump.
1618 * The semantics of data ownership depends on the buf field.
1619 * If it is set, the packet data is dynamically allocated and is
1620 * valid indefinitely until a call to av_packet_unref() reduces the
1621 * reference count to 0.
1623 * If the buf field is not set av_packet_ref() would make a copy instead
1624 * of increasing the reference count.
1626 * The side data is always allocated with av_malloc(), copied by
1627 * av_packet_ref() and freed by av_packet_unref().
1629 * @see av_packet_ref
1630 * @see av_packet_unref
1632 typedef struct AVPacket {
1634 * A reference to the reference-counted buffer where the packet data is
1636 * May be NULL, then the packet data is not reference-counted.
1640 * Presentation timestamp in AVStream->time_base units; the time at which
1641 * the decompressed packet will be presented to the user.
1642 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1643 * pts MUST be larger or equal to dts as presentation cannot happen before
1644 * decompression, unless one wants to view hex dumps. Some formats misuse
1645 * the terms dts and pts/cts to mean something different. Such timestamps
1646 * must be converted to true pts/dts before they are stored in AVPacket.
1650 * Decompression timestamp in AVStream->time_base units; the time at which
1651 * the packet is decompressed.
1652 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1659 * A combination of AV_PKT_FLAG values
1663 * Additional packet data that can be provided by the container.
1664 * Packet can contain several types of side information.
1666 AVPacketSideData *side_data;
1667 int side_data_elems;
1670 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1671 * Equals next_pts - this_pts in presentation order.
1675 int64_t pos; ///< byte position in stream, -1 if unknown
1677 #if FF_API_CONVERGENCE_DURATION
1679 * @deprecated Same as the duration field, but as int64_t. This was required
1680 * for Matroska subtitles, whose duration values could overflow when the
1681 * duration field was still an int.
1683 attribute_deprecated
1684 int64_t convergence_duration;
1687 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1688 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1690 * Flag is used to discard packets which are required to maintain valid
1691 * decoder state but are not required for output and should be dropped
1694 #define AV_PKT_FLAG_DISCARD 0x0004
1696 enum AVSideDataParamChangeFlags {
1697 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1698 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1699 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1700 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1706 struct AVCodecInternal;
1710 AV_FIELD_PROGRESSIVE,
1711 AV_FIELD_TT, //< Top coded_first, top displayed first
1712 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1713 AV_FIELD_TB, //< Top coded first, bottom displayed first
1714 AV_FIELD_BT, //< Bottom coded first, top displayed first
1718 * main external API structure.
1719 * New fields can be added to the end with minor version bumps.
1720 * Removal, reordering and changes to existing fields require a major
1722 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1724 * The name string for AVOptions options matches the associated command line
1725 * parameter name and can be found in libavcodec/options_table.h
1726 * The AVOption/command line parameter names differ in some cases from the C
1727 * structure field names for historic reasons or brevity.
1728 * sizeof(AVCodecContext) must not be used outside libav*.
1730 typedef struct AVCodecContext {
1732 * information on struct for av_log
1733 * - set by avcodec_alloc_context3
1735 const AVClass *av_class;
1736 int log_level_offset;
1738 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1739 const struct AVCodec *codec;
1740 #if FF_API_CODEC_NAME
1742 * @deprecated this field is not used for anything in libavcodec
1744 attribute_deprecated
1745 char codec_name[32];
1747 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1750 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1751 * This is used to work around some encoder bugs.
1752 * A demuxer should set this to what is stored in the field used to identify the codec.
1753 * If there are multiple such fields in a container then the demuxer should choose the one
1754 * which maximizes the information about the used codec.
1755 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1756 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1757 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1759 * - encoding: Set by user, if not then the default based on codec_id will be used.
1760 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1762 unsigned int codec_tag;
1764 #if FF_API_STREAM_CODEC_TAG
1766 * @deprecated this field is unused
1768 attribute_deprecated
1769 unsigned int stream_codec_tag;
1775 * Private context used for internal data.
1777 * Unlike priv_data, this is not codec-specific. It is used in general
1778 * libavcodec functions.
1780 struct AVCodecInternal *internal;
1783 * Private data of the user, can be used to carry app specific stuff.
1784 * - encoding: Set by user.
1785 * - decoding: Set by user.
1790 * the average bitrate
1791 * - encoding: Set by user; unused for constant quantizer encoding.
1792 * - decoding: Set by user, may be overwritten by libavcodec
1793 * if this info is available in the stream
1798 * number of bits the bitstream is allowed to diverge from the reference.
1799 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1800 * - encoding: Set by user; unused for constant quantizer encoding.
1801 * - decoding: unused
1803 int bit_rate_tolerance;
1806 * Global quality for codecs which cannot change it per frame.
1807 * This should be proportional to MPEG-1/2/4 qscale.
1808 * - encoding: Set by user.
1809 * - decoding: unused
1814 * - encoding: Set by user.
1815 * - decoding: unused
1817 int compression_level;
1818 #define FF_COMPRESSION_DEFAULT -1
1822 * - encoding: Set by user.
1823 * - decoding: Set by user.
1829 * - encoding: Set by user.
1830 * - decoding: Set by user.
1835 * some codecs need / can use extradata like Huffman tables.
1836 * MJPEG: Huffman tables
1837 * rv10: additional flags
1838 * MPEG-4: global headers (they can be in the bitstream or here)
1839 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1840 * than extradata_size to avoid problems if it is read with the bitstream reader.
1841 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1842 * - encoding: Set/allocated/freed by libavcodec.
1843 * - decoding: Set/allocated/freed by user.
1849 * This is the fundamental unit of time (in seconds) in terms
1850 * of which frame timestamps are represented. For fixed-fps content,
1851 * timebase should be 1/framerate and timestamp increments should be
1853 * This often, but not always is the inverse of the frame rate or field rate
1854 * for video. 1/time_base is not the average frame rate if the frame rate is not
1857 * Like containers, elementary streams also can store timestamps, 1/time_base
1858 * is the unit in which these timestamps are specified.
1859 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1860 * vop_time_increment_resolution and fixed_vop_rate
1861 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1863 * - encoding: MUST be set by user.
1864 * - decoding: the use of this field for decoding is deprecated.
1865 * Use framerate instead.
1867 AVRational time_base;
1870 * For some codecs, the time base is closer to the field rate than the frame rate.
1871 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1872 * if no telecine is used ...
1874 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1876 int ticks_per_frame;
1881 * Encoding: Number of frames delay there will be from the encoder input to
1882 * the decoder output. (we assume the decoder matches the spec)
1883 * Decoding: Number of frames delay in addition to what a standard decoder
1884 * as specified in the spec would produce.
1887 * Number of frames the decoded output will be delayed relative to the
1891 * For encoding, this field is unused (see initial_padding).
1893 * For decoding, this is the number of samples the decoder needs to
1894 * output before the decoder's output is valid. When seeking, you should
1895 * start decoding this many samples prior to your desired seek point.
1897 * - encoding: Set by libavcodec.
1898 * - decoding: Set by libavcodec.
1905 * picture width / height.
1907 * @note Those fields may not match the values of the last
1908 * AVFrame output by avcodec_decode_video2 due frame
1911 * - encoding: MUST be set by user.
1912 * - decoding: May be set by the user before opening the decoder if known e.g.
1913 * from the container. Some decoders will require the dimensions
1914 * to be set by the caller. During decoding, the decoder may
1915 * overwrite those values as required while parsing the data.
1920 * Bitstream width / height, may be different from width/height e.g. when
1921 * the decoded frame is cropped before being output or lowres is enabled.
1923 * @note Those field may not match the value of the last
1924 * AVFrame output by avcodec_receive_frame() due frame
1927 * - encoding: unused
1928 * - decoding: May be set by the user before opening the decoder if known
1929 * e.g. from the container. During decoding, the decoder may
1930 * overwrite those values as required while parsing the data.
1932 int coded_width, coded_height;
1934 #if FF_API_ASPECT_EXTENDED
1935 #define FF_ASPECT_EXTENDED 15
1939 * the number of pictures in a group of pictures, or 0 for intra_only
1940 * - encoding: Set by user.
1941 * - decoding: unused
1946 * Pixel format, see AV_PIX_FMT_xxx.
1947 * May be set by the demuxer if known from headers.
1948 * May be overridden by the decoder if it knows better.
1950 * @note This field may not match the value of the last
1951 * AVFrame output by avcodec_receive_frame() due frame
1954 * - encoding: Set by user.
1955 * - decoding: Set by user if known, overridden by libavcodec while
1958 enum AVPixelFormat pix_fmt;
1960 #if FF_API_MOTION_EST
1962 * This option does nothing
1963 * @deprecated use codec private options instead
1965 attribute_deprecated int me_method;
1969 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1970 * decoder to draw a horizontal band. It improves cache usage. Not
1971 * all codecs can do that. You must check the codec capabilities
1973 * When multithreading is used, it may be called from multiple threads
1974 * at the same time; threads might draw different parts of the same AVFrame,
1975 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1977 * The function is also used by hardware acceleration APIs.
1978 * It is called at least once during frame decoding to pass
1979 * the data needed for hardware render.
1980 * In that mode instead of pixel data, AVFrame points to
1981 * a structure specific to the acceleration API. The application
1982 * reads the structure and can change some fields to indicate progress
1984 * - encoding: unused
1985 * - decoding: Set by user.
1986 * @param height the height of the slice
1987 * @param y the y position of the slice
1988 * @param type 1->top field, 2->bottom field, 3->frame
1989 * @param offset offset into the AVFrame.data from which the slice should be read
1991 void (*draw_horiz_band)(struct AVCodecContext *s,
1992 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1993 int y, int type, int height);
1996 * callback to negotiate the pixelFormat
1997 * @param fmt is the list of formats which are supported by the codec,
1998 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1999 * The first is always the native one.
2000 * @note The callback may be called again immediately if initialization for
2001 * the selected (hardware-accelerated) pixel format failed.
2002 * @warning Behavior is undefined if the callback returns a value not
2003 * in the fmt list of formats.
2004 * @return the chosen format
2005 * - encoding: unused
2006 * - decoding: Set by user, if not set the native format will be chosen.
2008 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
2011 * maximum number of B-frames between non-B-frames
2012 * Note: The output will be delayed by max_b_frames+1 relative to the input.
2013 * - encoding: Set by user.
2014 * - decoding: unused
2019 * qscale factor between IP and B-frames
2020 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
2021 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2022 * - encoding: Set by user.
2023 * - decoding: unused
2025 float b_quant_factor;
2027 #if FF_API_RC_STRATEGY
2028 /** @deprecated use codec private option instead */
2029 attribute_deprecated int rc_strategy;
2030 #define FF_RC_STRATEGY_XVID 1
2033 #if FF_API_PRIVATE_OPT
2034 /** @deprecated use encoder private options instead */
2035 attribute_deprecated
2036 int b_frame_strategy;
2040 * qscale offset between IP and B-frames
2041 * - encoding: Set by user.
2042 * - decoding: unused
2044 float b_quant_offset;
2047 * Size of the frame reordering buffer in the decoder.
2048 * For MPEG-2 it is 1 IPB or 0 low delay IP.
2049 * - encoding: Set by libavcodec.
2050 * - decoding: Set by libavcodec.
2054 #if FF_API_PRIVATE_OPT
2055 /** @deprecated use encoder private options instead */
2056 attribute_deprecated
2061 * qscale factor between P- and I-frames
2062 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2063 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2064 * - encoding: Set by user.
2065 * - decoding: unused
2067 float i_quant_factor;
2070 * qscale offset between P and I-frames
2071 * - encoding: Set by user.
2072 * - decoding: unused
2074 float i_quant_offset;
2077 * luminance masking (0-> disabled)
2078 * - encoding: Set by user.
2079 * - decoding: unused
2084 * temporary complexity masking (0-> disabled)
2085 * - encoding: Set by user.
2086 * - decoding: unused
2088 float temporal_cplx_masking;
2091 * spatial complexity masking (0-> disabled)
2092 * - encoding: Set by user.
2093 * - decoding: unused
2095 float spatial_cplx_masking;
2098 * p block masking (0-> disabled)
2099 * - encoding: Set by user.
2100 * - decoding: unused
2105 * darkness masking (0-> disabled)
2106 * - encoding: Set by user.
2107 * - decoding: unused
2113 * - encoding: Set by libavcodec.
2114 * - decoding: Set by user (or 0).
2118 #if FF_API_PRIVATE_OPT
2119 /** @deprecated use encoder private options instead */
2120 attribute_deprecated
2121 int prediction_method;
2122 #define FF_PRED_LEFT 0
2123 #define FF_PRED_PLANE 1
2124 #define FF_PRED_MEDIAN 2
2128 * slice offsets in the frame in bytes
2129 * - encoding: Set/allocated by libavcodec.
2130 * - decoding: Set/allocated by user (or NULL).
2135 * sample aspect ratio (0 if unknown)
2136 * That is the width of a pixel divided by the height of the pixel.
2137 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2138 * - encoding: Set by user.
2139 * - decoding: Set by libavcodec.
2141 AVRational sample_aspect_ratio;
2144 * motion estimation comparison function
2145 * - encoding: Set by user.
2146 * - decoding: unused
2150 * subpixel motion estimation comparison function
2151 * - encoding: Set by user.
2152 * - decoding: unused
2156 * macroblock comparison function (not supported yet)
2157 * - encoding: Set by user.
2158 * - decoding: unused
2162 * interlaced DCT comparison function
2163 * - encoding: Set by user.
2164 * - decoding: unused
2167 #define FF_CMP_SAD 0
2168 #define FF_CMP_SSE 1
2169 #define FF_CMP_SATD 2
2170 #define FF_CMP_DCT 3
2171 #define FF_CMP_PSNR 4
2172 #define FF_CMP_BIT 5
2174 #define FF_CMP_ZERO 7
2175 #define FF_CMP_VSAD 8
2176 #define FF_CMP_VSSE 9
2177 #define FF_CMP_NSSE 10
2178 #define FF_CMP_W53 11
2179 #define FF_CMP_W97 12
2180 #define FF_CMP_DCTMAX 13
2181 #define FF_CMP_DCT264 14
2182 #define FF_CMP_MEDIAN_SAD 15
2183 #define FF_CMP_CHROMA 256
2186 * ME diamond size & shape
2187 * - encoding: Set by user.
2188 * - decoding: unused
2193 * amount of previous MV predictors (2a+1 x 2a+1 square)
2194 * - encoding: Set by user.
2195 * - decoding: unused
2197 int last_predictor_count;
2199 #if FF_API_PRIVATE_OPT
2200 /** @deprecated use encoder private options instead */
2201 attribute_deprecated
2206 * motion estimation prepass comparison function
2207 * - encoding: Set by user.
2208 * - decoding: unused
2213 * ME prepass diamond size & shape
2214 * - encoding: Set by user.
2215 * - decoding: unused
2221 * - encoding: Set by user.
2222 * - decoding: unused
2224 int me_subpel_quality;
2228 * DTG active format information (additional aspect ratio
2229 * information only used in DVB MPEG-2 transport streams)
2232 * - encoding: unused
2233 * - decoding: Set by decoder.
2234 * @deprecated Deprecated in favor of AVSideData
2236 attribute_deprecated int dtg_active_format;
2237 #define FF_DTG_AFD_SAME 8
2238 #define FF_DTG_AFD_4_3 9
2239 #define FF_DTG_AFD_16_9 10
2240 #define FF_DTG_AFD_14_9 11
2241 #define FF_DTG_AFD_4_3_SP_14_9 13
2242 #define FF_DTG_AFD_16_9_SP_14_9 14
2243 #define FF_DTG_AFD_SP_4_3 15
2244 #endif /* FF_API_AFD */
2247 * maximum motion estimation search range in subpel units
2248 * If 0 then no limit.
2250 * - encoding: Set by user.
2251 * - decoding: unused
2255 #if FF_API_QUANT_BIAS
2257 * @deprecated use encoder private option instead
2259 attribute_deprecated int intra_quant_bias;
2260 #define FF_DEFAULT_QUANT_BIAS 999999
2263 * @deprecated use encoder private option instead
2265 attribute_deprecated int inter_quant_bias;
2270 * - encoding: unused
2271 * - decoding: Set by user.
2274 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2275 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2276 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2280 * XVideo Motion Acceleration
2281 * - encoding: forbidden
2282 * - decoding: set by decoder
2283 * @deprecated XvMC doesn't need it anymore.
2285 attribute_deprecated int xvmc_acceleration;
2286 #endif /* FF_API_XVMC */
2289 * macroblock decision mode
2290 * - encoding: Set by user.
2291 * - decoding: unused
2294 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2295 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2296 #define FF_MB_DECISION_RD 2 ///< rate distortion
2299 * custom intra quantization matrix
2300 * - encoding: Set by user, can be NULL.
2301 * - decoding: Set by libavcodec.
2303 uint16_t *intra_matrix;
2306 * custom inter quantization matrix
2307 * - encoding: Set by user, can be NULL.
2308 * - decoding: Set by libavcodec.
2310 uint16_t *inter_matrix;
2312 #if FF_API_PRIVATE_OPT
2313 /** @deprecated use encoder private options instead */
2314 attribute_deprecated
2315 int scenechange_threshold;
2317 /** @deprecated use encoder private options instead */
2318 attribute_deprecated
2319 int noise_reduction;
2324 * @deprecated this field is unused
2326 attribute_deprecated
2330 * @deprecated this field is unused
2332 attribute_deprecated
2337 * precision of the intra DC coefficient - 8
2338 * - encoding: Set by user.
2339 * - decoding: Set by libavcodec
2341 int intra_dc_precision;
2344 * Number of macroblock rows at the top which are skipped.
2345 * - encoding: unused
2346 * - decoding: Set by user.
2351 * Number of macroblock rows at the bottom which are skipped.
2352 * - encoding: unused
2353 * - decoding: Set by user.
2359 * @deprecated use encoder private options instead
2361 attribute_deprecated
2362 float border_masking;
2366 * minimum MB Lagrange multiplier
2367 * - encoding: Set by user.
2368 * - decoding: unused
2373 * maximum MB Lagrange multiplier
2374 * - encoding: Set by user.
2375 * - decoding: unused
2379 #if FF_API_PRIVATE_OPT
2381 * @deprecated use encoder private options instead
2383 attribute_deprecated
2384 int me_penalty_compensation;
2388 * - encoding: Set by user.
2389 * - decoding: unused
2393 #if FF_API_PRIVATE_OPT
2394 /** @deprecated use encoder private options instead */
2395 attribute_deprecated
2401 * - encoding: Set by user.
2402 * - decoding: unused
2407 * number of reference frames
2408 * - encoding: Set by user.
2409 * - decoding: Set by lavc.
2413 #if FF_API_PRIVATE_OPT
2414 /** @deprecated use encoder private options instead */
2415 attribute_deprecated
2419 #if FF_API_UNUSED_MEMBERS
2421 * Multiplied by qscale for each frame and added to scene_change_score.
2422 * - encoding: Set by user.
2423 * - decoding: unused
2425 attribute_deprecated int scenechange_factor;
2429 * Note: Value depends upon the compare function used for fullpel ME.
2430 * - encoding: Set by user.
2431 * - decoding: unused
2435 #if FF_API_PRIVATE_OPT
2436 /** @deprecated use encoder private options instead */
2437 attribute_deprecated
2442 * Chromaticity coordinates of the source primaries.
2443 * - encoding: Set by user
2444 * - decoding: Set by libavcodec
2446 enum AVColorPrimaries color_primaries;
2449 * Color Transfer Characteristic.
2450 * - encoding: Set by user
2451 * - decoding: Set by libavcodec
2453 enum AVColorTransferCharacteristic color_trc;
2456 * YUV colorspace type.
2457 * - encoding: Set by user
2458 * - decoding: Set by libavcodec
2460 enum AVColorSpace colorspace;
2463 * MPEG vs JPEG YUV range.
2464 * - encoding: Set by user
2465 * - decoding: Set by libavcodec
2467 enum AVColorRange color_range;
2470 * This defines the location of chroma samples.
2471 * - encoding: Set by user
2472 * - decoding: Set by libavcodec
2474 enum AVChromaLocation chroma_sample_location;
2478 * Indicates number of picture subdivisions. Used for parallelized
2480 * - encoding: Set by user
2481 * - decoding: unused
2486 * - encoding: set by libavcodec
2487 * - decoding: Set by user.
2489 enum AVFieldOrder field_order;
2492 int sample_rate; ///< samples per second
2493 int channels; ///< number of audio channels
2496 * audio sample format
2497 * - encoding: Set by user.
2498 * - decoding: Set by libavcodec.
2500 enum AVSampleFormat sample_fmt; ///< sample format
2502 /* The following data should not be initialized. */
2504 * Number of samples per channel in an audio frame.
2506 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2507 * except the last must contain exactly frame_size samples per channel.
2508 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2509 * frame size is not restricted.
2510 * - decoding: may be set by some decoders to indicate constant frame size
2515 * Frame counter, set by libavcodec.
2517 * - decoding: total number of frames returned from the decoder so far.
2518 * - encoding: total number of frames passed to the encoder so far.
2520 * @note the counter is not incremented if encoding/decoding resulted in
2526 * number of bytes per packet if constant and known or 0
2527 * Used by some WAV based audio codecs.
2532 * Audio cutoff bandwidth (0 means "automatic")
2533 * - encoding: Set by user.
2534 * - decoding: unused
2539 * Audio channel layout.
2540 * - encoding: set by user.
2541 * - decoding: set by user, may be overwritten by libavcodec.
2543 uint64_t channel_layout;
2546 * Request decoder to use this channel layout if it can (0 for default)
2547 * - encoding: unused
2548 * - decoding: Set by user.
2550 uint64_t request_channel_layout;
2553 * Type of service that the audio stream conveys.
2554 * - encoding: Set by user.
2555 * - decoding: Set by libavcodec.
2557 enum AVAudioServiceType audio_service_type;
2560 * desired sample format
2561 * - encoding: Not used.
2562 * - decoding: Set by user.
2563 * Decoder will decode to this format if it can.
2565 enum AVSampleFormat request_sample_fmt;
2568 * This callback is called at the beginning of each frame to get data
2569 * buffer(s) for it. There may be one contiguous buffer for all the data or
2570 * there may be a buffer per each data plane or anything in between. What
2571 * this means is, you may set however many entries in buf[] you feel necessary.
2572 * Each buffer must be reference-counted using the AVBuffer API (see description
2575 * The following fields will be set in the frame before this callback is
2578 * - width, height (video only)
2579 * - sample_rate, channel_layout, nb_samples (audio only)
2580 * Their values may differ from the corresponding values in
2581 * AVCodecContext. This callback must use the frame values, not the codec
2582 * context values, to calculate the required buffer size.
2584 * This callback must fill the following fields in the frame:
2588 * * if the data is planar audio with more than 8 channels, then this
2589 * callback must allocate and fill extended_data to contain all pointers
2590 * to all data planes. data[] must hold as many pointers as it can.
2591 * extended_data must be allocated with av_malloc() and will be freed in
2593 * * otherwise extended_data must point to data
2594 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2595 * the frame's data and extended_data pointers must be contained in these. That
2596 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2597 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2598 * and av_buffer_ref().
2599 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2600 * this callback and filled with the extra buffers if there are more
2601 * buffers than buf[] can hold. extended_buf will be freed in
2604 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2605 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2608 * Each data plane must be aligned to the maximum required by the target
2611 * @see avcodec_default_get_buffer2()
2615 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2616 * (read and/or written to if it is writable) later by libavcodec.
2618 * avcodec_align_dimensions2() should be used to find the required width and
2619 * height, as they normally need to be rounded up to the next multiple of 16.
2621 * Some decoders do not support linesizes changing between frames.
2623 * If frame multithreading is used and thread_safe_callbacks is set,
2624 * this callback may be called from a different thread, but not from more
2625 * than one at once. Does not need to be reentrant.
2627 * @see avcodec_align_dimensions2()
2631 * Decoders request a buffer of a particular size by setting
2632 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2633 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2634 * to a smaller value in the output frame.
2636 * As a convenience, av_samples_get_buffer_size() and
2637 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2638 * functions to find the required data size and to fill data pointers and
2639 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2640 * since all planes must be the same size.
2642 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2644 * - encoding: unused
2645 * - decoding: Set by libavcodec, user can override.
2647 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2650 * If non-zero, the decoded audio and video frames returned from
2651 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2652 * and are valid indefinitely. The caller must free them with
2653 * av_frame_unref() when they are not needed anymore.
2654 * Otherwise, the decoded frames must not be freed by the caller and are
2655 * only valid until the next decode call.
2657 * This is always automatically enabled if avcodec_receive_frame() is used.
2659 * - encoding: unused
2660 * - decoding: set by the caller before avcodec_open2().
2662 int refcounted_frames;
2664 /* - encoding parameters */
2665 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2666 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2670 * - encoding: Set by user.
2671 * - decoding: unused
2677 * - encoding: Set by user.
2678 * - decoding: unused
2683 * maximum quantizer difference between frames
2684 * - encoding: Set by user.
2685 * - decoding: unused
2691 * @deprecated use encoder private options instead
2693 attribute_deprecated
2696 attribute_deprecated
2698 attribute_deprecated
2703 * decoder bitstream buffer size
2704 * - encoding: Set by user.
2705 * - decoding: unused
2710 * ratecontrol override, see RcOverride
2711 * - encoding: Allocated/set/freed by user.
2712 * - decoding: unused
2714 int rc_override_count;
2715 RcOverride *rc_override;
2719 * @deprecated use encoder private options instead
2721 attribute_deprecated
2727 * - encoding: Set by user.
2728 * - decoding: Set by user, may be overwritten by libavcodec.
2730 int64_t rc_max_rate;
2734 * - encoding: Set by user.
2735 * - decoding: unused
2737 int64_t rc_min_rate;
2741 * @deprecated use encoder private options instead
2743 attribute_deprecated
2744 float rc_buffer_aggressivity;
2746 attribute_deprecated
2747 float rc_initial_cplx;
2751 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2752 * - encoding: Set by user.
2753 * - decoding: unused.
2755 float rc_max_available_vbv_use;
2758 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2759 * - encoding: Set by user.
2760 * - decoding: unused.
2762 float rc_min_vbv_overflow_use;
2765 * Number of bits which should be loaded into the rc buffer before decoding starts.
2766 * - encoding: Set by user.
2767 * - decoding: unused
2769 int rc_initial_buffer_occupancy;
2771 #if FF_API_CODER_TYPE
2772 #define FF_CODER_TYPE_VLC 0
2773 #define FF_CODER_TYPE_AC 1
2774 #define FF_CODER_TYPE_RAW 2
2775 #define FF_CODER_TYPE_RLE 3
2776 #if FF_API_UNUSED_MEMBERS
2777 #define FF_CODER_TYPE_DEFLATE 4
2778 #endif /* FF_API_UNUSED_MEMBERS */
2780 * @deprecated use encoder private options instead
2782 attribute_deprecated
2784 #endif /* FF_API_CODER_TYPE */
2786 #if FF_API_PRIVATE_OPT
2787 /** @deprecated use encoder private options instead */
2788 attribute_deprecated
2794 * @deprecated use encoder private options instead
2796 attribute_deprecated
2800 * @deprecated use encoder private options instead
2802 attribute_deprecated
2806 #if FF_API_PRIVATE_OPT
2807 /** @deprecated use encoder private options instead */
2808 attribute_deprecated
2809 int frame_skip_threshold;
2811 /** @deprecated use encoder private options instead */
2812 attribute_deprecated
2813 int frame_skip_factor;
2815 /** @deprecated use encoder private options instead */
2816 attribute_deprecated
2819 /** @deprecated use encoder private options instead */
2820 attribute_deprecated
2822 #endif /* FF_API_PRIVATE_OPT */
2825 * trellis RD quantization
2826 * - encoding: Set by user.
2827 * - decoding: unused
2831 #if FF_API_PRIVATE_OPT
2832 /** @deprecated use encoder private options instead */
2833 attribute_deprecated
2834 int min_prediction_order;
2836 /** @deprecated use encoder private options instead */
2837 attribute_deprecated
2838 int max_prediction_order;
2840 /** @deprecated use encoder private options instead */
2841 attribute_deprecated
2842 int64_t timecode_frame_start;
2845 #if FF_API_RTP_CALLBACK
2847 * @deprecated unused
2849 /* The RTP callback: This function is called */
2850 /* every time the encoder has a packet to send. */
2851 /* It depends on the encoder if the data starts */
2852 /* with a Start Code (it should). H.263 does. */
2853 /* mb_nb contains the number of macroblocks */
2854 /* encoded in the RTP payload. */
2855 attribute_deprecated
2856 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2859 #if FF_API_PRIVATE_OPT
2860 /** @deprecated use encoder private options instead */
2861 attribute_deprecated
2862 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2863 /* do its best to deliver a chunk with size */
2864 /* below rtp_payload_size, the chunk will start */
2865 /* with a start code on some codecs like H.263. */
2866 /* This doesn't take account of any particular */
2867 /* headers inside the transmitted RTP payload. */
2870 #if FF_API_STAT_BITS
2871 /* statistics, used for 2-pass encoding */
2872 attribute_deprecated
2874 attribute_deprecated
2876 attribute_deprecated
2878 attribute_deprecated
2880 attribute_deprecated
2882 attribute_deprecated
2884 attribute_deprecated
2886 attribute_deprecated
2889 /** @deprecated this field is unused */
2890 attribute_deprecated
2895 * pass1 encoding statistics output buffer
2896 * - encoding: Set by libavcodec.
2897 * - decoding: unused
2902 * pass2 encoding statistics input buffer
2903 * Concatenated stuff from stats_out of pass1 should be placed here.
2904 * - encoding: Allocated/set/freed by user.
2905 * - decoding: unused
2910 * Work around bugs in encoders which sometimes cannot be detected automatically.
2911 * - encoding: Set by user
2912 * - decoding: Set by user
2914 int workaround_bugs;
2915 #define FF_BUG_AUTODETECT 1 ///< autodetection
2916 #if FF_API_OLD_MSMPEG4
2917 #define FF_BUG_OLD_MSMPEG4 2
2919 #define FF_BUG_XVID_ILACE 4
2920 #define FF_BUG_UMP4 8
2921 #define FF_BUG_NO_PADDING 16
2922 #define FF_BUG_AMV 32
2924 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2926 #define FF_BUG_QPEL_CHROMA 64
2927 #define FF_BUG_STD_QPEL 128
2928 #define FF_BUG_QPEL_CHROMA2 256
2929 #define FF_BUG_DIRECT_BLOCKSIZE 512
2930 #define FF_BUG_EDGE 1024
2931 #define FF_BUG_HPEL_CHROMA 2048
2932 #define FF_BUG_DC_CLIP 4096
2933 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2934 #define FF_BUG_TRUNCATED 16384
2935 #define FF_BUG_IEDGE 32768
2938 * strictly follow the standard (MPEG-4, ...).
2939 * - encoding: Set by user.
2940 * - decoding: Set by user.
2941 * Setting this to STRICT or higher means the encoder and decoder will
2942 * generally do stupid things, whereas setting it to unofficial or lower
2943 * will mean the encoder might produce output that is not supported by all
2944 * spec-compliant decoders. Decoders don't differentiate between normal,
2945 * unofficial and experimental (that is, they always try to decode things
2946 * when they can) unless they are explicitly asked to behave stupidly
2947 * (=strictly conform to the specs)
2949 int strict_std_compliance;
2950 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2951 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2952 #define FF_COMPLIANCE_NORMAL 0
2953 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2954 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2957 * error concealment flags
2958 * - encoding: unused
2959 * - decoding: Set by user.
2961 int error_concealment;
2962 #define FF_EC_GUESS_MVS 1
2963 #define FF_EC_DEBLOCK 2
2964 #define FF_EC_FAVOR_INTER 256
2968 * - encoding: Set by user.
2969 * - decoding: Set by user.
2972 #define FF_DEBUG_PICT_INFO 1
2973 #define FF_DEBUG_RC 2
2974 #define FF_DEBUG_BITSTREAM 4
2975 #define FF_DEBUG_MB_TYPE 8
2976 #define FF_DEBUG_QP 16
2979 * @deprecated this option does nothing
2981 #define FF_DEBUG_MV 32
2983 #define FF_DEBUG_DCT_COEFF 0x00000040
2984 #define FF_DEBUG_SKIP 0x00000080
2985 #define FF_DEBUG_STARTCODE 0x00000100
2986 #if FF_API_UNUSED_MEMBERS
2987 #define FF_DEBUG_PTS 0x00000200
2988 #endif /* FF_API_UNUSED_MEMBERS */
2989 #define FF_DEBUG_ER 0x00000400
2990 #define FF_DEBUG_MMCO 0x00000800
2991 #define FF_DEBUG_BUGS 0x00001000
2993 #define FF_DEBUG_VIS_QP 0x00002000
2994 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2996 #define FF_DEBUG_BUFFERS 0x00008000
2997 #define FF_DEBUG_THREADS 0x00010000
2998 #define FF_DEBUG_GREEN_MD 0x00800000
2999 #define FF_DEBUG_NOMC 0x01000000
3004 * - encoding: Set by user.
3005 * - decoding: Set by user.
3008 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
3009 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
3010 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
3014 * Error recognition; may misdetect some more or less valid parts as errors.
3015 * - encoding: unused
3016 * - decoding: Set by user.
3018 int err_recognition;
3021 * Verify checksums embedded in the bitstream (could be of either encoded or
3022 * decoded data, depending on the codec) and print an error message on mismatch.
3023 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
3024 * decoder returning an error.
3026 #define AV_EF_CRCCHECK (1<<0)
3027 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
3028 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
3029 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
3031 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
3032 #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
3033 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
3034 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
3038 * opaque 64-bit number (generally a PTS) that will be reordered and
3039 * output in AVFrame.reordered_opaque
3040 * - encoding: unused
3041 * - decoding: Set by user.
3043 int64_t reordered_opaque;
3046 * Hardware accelerator in use
3047 * - encoding: unused.
3048 * - decoding: Set by libavcodec
3050 struct AVHWAccel *hwaccel;
3053 * Hardware accelerator context.
3054 * For some hardware accelerators, a global context needs to be
3055 * provided by the user. In that case, this holds display-dependent
3056 * data FFmpeg cannot instantiate itself. Please refer to the
3057 * FFmpeg HW accelerator documentation to know how to fill this
3058 * is. e.g. for VA API, this is a struct vaapi_context.
3059 * - encoding: unused
3060 * - decoding: Set by user
3062 void *hwaccel_context;
3066 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3067 * - decoding: unused
3069 uint64_t error[AV_NUM_DATA_POINTERS];
3072 * DCT algorithm, see FF_DCT_* below
3073 * - encoding: Set by user.
3074 * - decoding: unused
3077 #define FF_DCT_AUTO 0
3078 #define FF_DCT_FASTINT 1
3079 #define FF_DCT_INT 2
3080 #define FF_DCT_MMX 3
3081 #define FF_DCT_ALTIVEC 5
3082 #define FF_DCT_FAAN 6
3085 * IDCT algorithm, see FF_IDCT_* below.
3086 * - encoding: Set by user.
3087 * - decoding: Set by user.
3090 #define FF_IDCT_AUTO 0
3091 #define FF_IDCT_INT 1
3092 #define FF_IDCT_SIMPLE 2
3093 #define FF_IDCT_SIMPLEMMX 3
3094 #define FF_IDCT_ARM 7
3095 #define FF_IDCT_ALTIVEC 8
3097 #define FF_IDCT_SH4 9
3099 #define FF_IDCT_SIMPLEARM 10
3100 #if FF_API_UNUSED_MEMBERS
3101 #define FF_IDCT_IPP 13
3102 #endif /* FF_API_UNUSED_MEMBERS */
3103 #define FF_IDCT_XVID 14
3104 #if FF_API_IDCT_XVIDMMX
3105 #define FF_IDCT_XVIDMMX 14
3106 #endif /* FF_API_IDCT_XVIDMMX */
3107 #define FF_IDCT_SIMPLEARMV5TE 16
3108 #define FF_IDCT_SIMPLEARMV6 17
3109 #if FF_API_ARCH_SPARC
3110 #define FF_IDCT_SIMPLEVIS 18
3112 #define FF_IDCT_FAAN 20
3113 #define FF_IDCT_SIMPLENEON 22
3114 #if FF_API_ARCH_ALPHA
3115 #define FF_IDCT_SIMPLEALPHA 23
3117 #define FF_IDCT_SIMPLEAUTO 128
3120 * bits per sample/pixel from the demuxer (needed for huffyuv).
3121 * - encoding: Set by libavcodec.
3122 * - decoding: Set by user.
3124 int bits_per_coded_sample;
3127 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3128 * - encoding: set by user.
3129 * - decoding: set by libavcodec.
3131 int bits_per_raw_sample;
3135 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3136 * - encoding: unused
3137 * - decoding: Set by user.
3142 #if FF_API_CODED_FRAME
3144 * the picture in the bitstream
3145 * - encoding: Set by libavcodec.
3146 * - decoding: unused
3148 * @deprecated use the quality factor packet side data instead
3150 attribute_deprecated AVFrame *coded_frame;
3155 * is used to decide how many independent tasks should be passed to execute()
3156 * - encoding: Set by user.
3157 * - decoding: Set by user.
3162 * Which multithreading methods to use.
3163 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3164 * so clients which cannot provide future frames should not use it.
3166 * - encoding: Set by user, otherwise the default is used.
3167 * - decoding: Set by user, otherwise the default is used.
3170 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3171 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3174 * Which multithreading methods are in use by the codec.
3175 * - encoding: Set by libavcodec.
3176 * - decoding: Set by libavcodec.
3178 int active_thread_type;
3181 * Set by the client if its custom get_buffer() callback can be called
3182 * synchronously from another thread, which allows faster multithreaded decoding.
3183 * draw_horiz_band() will be called from other threads regardless of this setting.
3184 * Ignored if the default get_buffer() is used.
3185 * - encoding: Set by user.
3186 * - decoding: Set by user.
3188 int thread_safe_callbacks;
3191 * The codec may call this to execute several independent things.
3192 * It will return only after finishing all tasks.
3193 * The user may replace this with some multithreaded implementation,
3194 * the default implementation will execute the parts serially.
3195 * @param count the number of things to execute
3196 * - encoding: Set by libavcodec, user can override.
3197 * - decoding: Set by libavcodec, user can override.
3199 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3202 * The codec may call this to execute several independent things.
3203 * It will return only after finishing all tasks.
3204 * The user may replace this with some multithreaded implementation,
3205 * the default implementation will execute the parts serially.
3206 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3207 * @param c context passed also to func
3208 * @param count the number of things to execute
3209 * @param arg2 argument passed unchanged to func
3210 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3211 * @param func function that will be called count times, with jobnr from 0 to count-1.
3212 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3213 * two instances of func executing at the same time will have the same threadnr.
3214 * @return always 0 currently, but code should handle a future improvement where when any call to func
3215 * returns < 0 no further calls to func may be done and < 0 is returned.
3216 * - encoding: Set by libavcodec, user can override.
3217 * - decoding: Set by libavcodec, user can override.
3219 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3222 * noise vs. sse weight for the nsse comparison function
3223 * - encoding: Set by user.
3224 * - decoding: unused
3230 * - encoding: Set by user.
3231 * - decoding: Set by libavcodec.
3234 #define FF_PROFILE_UNKNOWN -99
3235 #define FF_PROFILE_RESERVED -100
3237 #define FF_PROFILE_AAC_MAIN 0
3238 #define FF_PROFILE_AAC_LOW 1
3239 #define FF_PROFILE_AAC_SSR 2
3240 #define FF_PROFILE_AAC_LTP 3
3241 #define FF_PROFILE_AAC_HE 4
3242 #define FF_PROFILE_AAC_HE_V2 28
3243 #define FF_PROFILE_AAC_LD 22
3244 #define FF_PROFILE_AAC_ELD 38
3245 #define FF_PROFILE_MPEG2_AAC_LOW 128
3246 #define FF_PROFILE_MPEG2_AAC_HE 131
3248 #define FF_PROFILE_DNXHD 0
3249 #define FF_PROFILE_DNXHR_LB 1
3250 #define FF_PROFILE_DNXHR_SQ 2
3251 #define FF_PROFILE_DNXHR_HQ 3
3252 #define FF_PROFILE_DNXHR_HQX 4
3253 #define FF_PROFILE_DNXHR_444 5
3255 #define FF_PROFILE_DTS 20
3256 #define FF_PROFILE_DTS_ES 30
3257 #define FF_PROFILE_DTS_96_24 40
3258 #define FF_PROFILE_DTS_HD_HRA 50
3259 #define FF_PROFILE_DTS_HD_MA 60
3260 #define FF_PROFILE_DTS_EXPRESS 70
3262 #define FF_PROFILE_MPEG2_422 0
3263 #define FF_PROFILE_MPEG2_HIGH 1
3264 #define FF_PROFILE_MPEG2_SS 2
3265 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3266 #define FF_PROFILE_MPEG2_MAIN 4
3267 #define FF_PROFILE_MPEG2_SIMPLE 5
3269 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3270 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3272 #define FF_PROFILE_H264_BASELINE 66
3273 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3274 #define FF_PROFILE_H264_MAIN 77
3275 #define FF_PROFILE_H264_EXTENDED 88
3276 #define FF_PROFILE_H264_HIGH 100
3277 #define FF_PROFILE_H264_HIGH_10 110
3278 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3279 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3280 #define FF_PROFILE_H264_HIGH_422 122
3281 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3282 #define FF_PROFILE_H264_STEREO_HIGH 128
3283 #define FF_PROFILE_H264_HIGH_444 144
3284 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3285 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3286 #define FF_PROFILE_H264_CAVLC_444 44
3288 #define FF_PROFILE_VC1_SIMPLE 0
3289 #define FF_PROFILE_VC1_MAIN 1
3290 #define FF_PROFILE_VC1_COMPLEX 2
3291 #define FF_PROFILE_VC1_ADVANCED 3
3293 #define FF_PROFILE_MPEG4_SIMPLE 0
3294 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3295 #define FF_PROFILE_MPEG4_CORE 2
3296 #define FF_PROFILE_MPEG4_MAIN 3
3297 #define FF_PROFILE_MPEG4_N_BIT 4
3298 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3299 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3300 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3301 #define FF_PROFILE_MPEG4_HYBRID 8
3302 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3303 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3304 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3305 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3306 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3307 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3308 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3310 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3311 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3312 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3313 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3314 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3316 #define FF_PROFILE_VP9_0 0
3317 #define FF_PROFILE_VP9_1 1
3318 #define FF_PROFILE_VP9_2 2
3319 #define FF_PROFILE_VP9_3 3
3321 #define FF_PROFILE_HEVC_MAIN 1
3322 #define FF_PROFILE_HEVC_MAIN_10 2
3323 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3324 #define FF_PROFILE_HEVC_REXT 4
3328 * - encoding: Set by user.
3329 * - decoding: Set by libavcodec.
3332 #define FF_LEVEL_UNKNOWN -99
3335 * Skip loop filtering for selected frames.
3336 * - encoding: unused
3337 * - decoding: Set by user.
3339 enum AVDiscard skip_loop_filter;
3342 * Skip IDCT/dequantization for selected frames.
3343 * - encoding: unused
3344 * - decoding: Set by user.
3346 enum AVDiscard skip_idct;
3349 * Skip decoding for selected frames.
3350 * - encoding: unused
3351 * - decoding: Set by user.
3353 enum AVDiscard skip_frame;
3356 * Header containing style information for text subtitles.
3357 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3358 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3359 * the Format line following. It shouldn't include any Dialogue line.
3360 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3361 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3363 uint8_t *subtitle_header;
3364 int subtitle_header_size;
3366 #if FF_API_ERROR_RATE
3368 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3371 attribute_deprecated
3375 #if FF_API_VBV_DELAY
3377 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3378 * Used for compliant TS muxing.
3379 * - encoding: Set by libavcodec.
3380 * - decoding: unused.
3381 * @deprecated this value is now exported as a part of
3382 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3384 attribute_deprecated
3388 #if FF_API_SIDEDATA_ONLY_PKT
3390 * Encoding only and set by default. Allow encoders to output packets
3391 * that do not contain any encoded data, only side data.
3393 * Some encoders need to output such packets, e.g. to update some stream
3394 * parameters at the end of encoding.
3396 * @deprecated this field disables the default behaviour and
3397 * it is kept only for compatibility.
3399 attribute_deprecated
3400 int side_data_only_packets;
3404 * Audio only. The number of "priming" samples (padding) inserted by the
3405 * encoder at the beginning of the audio. I.e. this number of leading
3406 * decoded samples must be discarded by the caller to get the original audio
3407 * without leading padding.
3409 * - decoding: unused
3410 * - encoding: Set by libavcodec. The timestamps on the output packets are
3411 * adjusted by the encoder so that they always refer to the
3412 * first sample of the data actually contained in the packet,
3413 * including any added padding. E.g. if the timebase is
3414 * 1/samplerate and the timestamp of the first input sample is
3415 * 0, the timestamp of the first output packet will be
3418 int initial_padding;
3421 * - decoding: For codecs that store a framerate value in the compressed
3422 * bitstream, the decoder may export it here. { 0, 1} when
3424 * - encoding: May be used to signal the framerate of CFR content to an
3427 AVRational framerate;
3430 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3431 * - encoding: unused.
3432 * - decoding: Set by libavcodec before calling get_format()
3434 enum AVPixelFormat sw_pix_fmt;
3437 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3438 * - encoding unused.
3439 * - decoding set by user.
3441 AVRational pkt_timebase;
3445 * - encoding: unused.
3446 * - decoding: set by libavcodec.
3448 const AVCodecDescriptor *codec_descriptor;
3452 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3453 * - encoding: unused
3454 * - decoding: Set by user.
3460 * Current statistics for PTS correction.
3461 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3462 * - encoding: unused
3464 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3465 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3466 int64_t pts_correction_last_pts; /// PTS of the last frame
3467 int64_t pts_correction_last_dts; /// DTS of the last frame
3470 * Character encoding of the input subtitles file.
3471 * - decoding: set by user
3472 * - encoding: unused
3477 * Subtitles character encoding mode. Formats or codecs might be adjusting
3478 * this setting (if they are doing the conversion themselves for instance).
3479 * - decoding: set by libavcodec
3480 * - encoding: unused
3482 int sub_charenc_mode;
3483 #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)
3484 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3485 #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
3488 * Skip processing alpha if supported by codec.
3489 * Note that if the format uses pre-multiplied alpha (common with VP6,
3490 * and recommended due to better video quality/compression)
3491 * the image will look as if alpha-blended onto a black background.
3492 * However for formats that do not use pre-multiplied alpha
3493 * there might be serious artefacts (though e.g. libswscale currently
3494 * assumes pre-multiplied alpha anyway).
3496 * - decoding: set by user
3497 * - encoding: unused
3502 * Number of samples to skip after a discontinuity
3503 * - decoding: unused
3504 * - encoding: set by libavcodec
3508 #if !FF_API_DEBUG_MV
3510 * debug motion vectors
3511 * - encoding: Set by user.
3512 * - decoding: Set by user.
3515 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3516 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3517 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3521 * custom intra quantization matrix
3522 * - encoding: Set by user, can be NULL.
3523 * - decoding: unused.
3525 uint16_t *chroma_intra_matrix;
3528 * dump format separator.
3529 * can be ", " or "\n " or anything else
3530 * - encoding: Set by user.
3531 * - decoding: Set by user.
3533 uint8_t *dump_separator;
3536 * ',' separated list of allowed decoders.
3537 * If NULL then all are allowed
3538 * - encoding: unused
3539 * - decoding: set by user
3541 char *codec_whitelist;
3544 * Properties of the stream that gets decoded
3545 * - encoding: unused
3546 * - decoding: set by libavcodec
3548 unsigned properties;
3549 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3550 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3553 * Additional data associated with the entire coded stream.
3555 * - decoding: unused
3556 * - encoding: may be set by libavcodec after avcodec_open2().
3558 AVPacketSideData *coded_side_data;
3559 int nb_coded_side_data;
3562 * A reference to the AVHWFramesContext describing the input (for encoding)
3563 * or output (decoding) frames. The reference is set by the caller and
3564 * afterwards owned (and freed) by libavcodec - it should never be read by
3565 * the caller after being set.
3567 * - decoding: This field should be set by the caller from the get_format()
3568 * callback. The previous reference (if any) will always be
3569 * unreffed by libavcodec before the get_format() call.
3571 * If the default get_buffer2() is used with a hwaccel pixel
3572 * format, then this AVHWFramesContext will be used for
3573 * allocating the frame buffers.
3575 * - encoding: For hardware encoders configured to use a hwaccel pixel
3576 * format, this field should be set by the caller to a reference
3577 * to the AVHWFramesContext describing input frames.
3578 * AVHWFramesContext.format must be equal to
3579 * AVCodecContext.pix_fmt.
3581 * This field should be set before avcodec_open2() is called.
3583 AVBufferRef *hw_frames_ctx;
3586 * Control the form of AVSubtitle.rects[N]->ass
3587 * - decoding: set by user
3588 * - encoding: unused
3590 int sub_text_format;
3591 #define FF_SUB_TEXT_FMT_ASS 0
3592 #if FF_API_ASS_TIMING
3593 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3597 * Audio only. The amount of padding (in samples) appended by the encoder to
3598 * the end of the audio. I.e. this number of decoded samples must be
3599 * discarded by the caller from the end of the stream to get the original
3600 * audio without any trailing padding.
3602 * - decoding: unused
3603 * - encoding: unused
3605 int trailing_padding;
3608 * The number of pixels per image to maximally accept.
3610 * - decoding: set by user
3611 * - encoding: set by user
3616 * A reference to the AVHWDeviceContext describing the device which will
3617 * be used by a hardware encoder/decoder. The reference is set by the
3618 * caller and afterwards owned (and freed) by libavcodec.
3620 * This should be used if either the codec device does not require
3621 * hardware frames or any that are used are to be allocated internally by
3622 * libavcodec. If the user wishes to supply any of the frames used as
3623 * encoder input or decoder output then hw_frames_ctx should be used
3624 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3625 * field will be ignored while decoding the associated stream segment, but
3626 * may again be used on a following one after another get_format() call.
3628 * For both encoders and decoders this field should be set before
3629 * avcodec_open2() is called and must not be written to thereafter.
3631 * Note that some decoders may require this field to be set initially in
3632 * order to support hw_frames_ctx at all - in that case, all frames
3633 * contexts used must be created on the same device.
3635 AVBufferRef *hw_device_ctx;
3638 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3639 * decoding (if active).
3640 * - encoding: unused
3641 * - decoding: Set by user (either before avcodec_open2(), or in the
3642 * AVCodecContext.get_format callback)
3647 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3648 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3650 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3651 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3653 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3655 int av_codec_get_lowres(const AVCodecContext *avctx);
3656 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3658 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3659 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3661 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3662 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3667 typedef struct AVProfile {
3669 const char *name; ///< short name for the profile
3672 typedef struct AVCodecDefault AVCodecDefault;
3679 typedef struct AVCodec {
3681 * Name of the codec implementation.
3682 * The name is globally unique among encoders and among decoders (but an
3683 * encoder and a decoder can share the same name).
3684 * This is the primary way to find a codec from the user perspective.
3688 * Descriptive name for the codec, meant to be more human readable than name.
3689 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3691 const char *long_name;
3692 enum AVMediaType type;
3695 * Codec capabilities.
3696 * see AV_CODEC_CAP_*
3699 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3700 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3701 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3702 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3703 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3704 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3705 const AVClass *priv_class; ///< AVClass for the private context
3706 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3708 /*****************************************************************
3709 * No fields below this line are part of the public API. They
3710 * may not be used outside of libavcodec and can be changed and
3712 * New public fields should be added right above.
3713 *****************************************************************
3716 struct AVCodec *next;
3718 * @name Frame-level threading support functions
3722 * If defined, called on thread contexts when they are created.
3723 * If the codec allocates writable tables in init(), re-allocate them here.
3724 * priv_data will be set to a copy of the original.
3726 int (*init_thread_copy)(AVCodecContext *);
3728 * Copy necessary context variables from a previous thread context to the current one.
3729 * If not defined, the next thread will start automatically; otherwise, the codec
3730 * must call ff_thread_finish_setup().
3732 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3734 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3738 * Private codec-specific defaults.
3740 const AVCodecDefault *defaults;
3743 * Initialize codec static data, called from avcodec_register().
3745 void (*init_static_data)(struct AVCodec *codec);
3747 int (*init)(AVCodecContext *);
3748 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3749 const struct AVSubtitle *sub);
3751 * Encode data to an AVPacket.
3753 * @param avctx codec context
3754 * @param avpkt output AVPacket (may contain a user-provided buffer)
3755 * @param[in] frame AVFrame containing the raw data to be encoded
3756 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3757 * non-empty packet was returned in avpkt.
3758 * @return 0 on success, negative error code on failure
3760 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3761 int *got_packet_ptr);
3762 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3763 int (*close)(AVCodecContext *);
3765 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3766 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3768 * - never called if the codec is closed or the wrong type,
3769 * - AVPacket parameter change side data is applied right before calling
3770 * AVCodec->send_packet,
3771 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3772 * - only one drain packet is ever passed down (until the next flush()),
3773 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3775 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3776 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3777 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3778 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3781 * Will be called when seeking
3783 void (*flush)(AVCodecContext *);
3785 * Internal codec capabilities.
3786 * See FF_CODEC_CAP_* in internal.h
3791 int av_codec_get_max_lowres(const AVCodec *codec);
3793 struct MpegEncContext;
3796 * @defgroup lavc_hwaccel AVHWAccel
3799 typedef struct AVHWAccel {
3801 * Name of the hardware accelerated codec.
3802 * The name is globally unique among encoders and among decoders (but an
3803 * encoder and a decoder can share the same name).
3808 * Type of codec implemented by the hardware accelerator.
3810 * See AVMEDIA_TYPE_xxx
3812 enum AVMediaType type;
3815 * Codec implemented by the hardware accelerator.
3817 * See AV_CODEC_ID_xxx
3822 * Supported pixel format.
3824 * Only hardware accelerated formats are supported here.
3826 enum AVPixelFormat pix_fmt;
3829 * Hardware accelerated codec capabilities.
3830 * see HWACCEL_CODEC_CAP_*
3834 /*****************************************************************
3835 * No fields below this line are part of the public API. They
3836 * may not be used outside of libavcodec and can be changed and
3838 * New public fields should be added right above.
3839 *****************************************************************
3841 struct AVHWAccel *next;
3844 * Allocate a custom buffer
3846 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3849 * Called at the beginning of each frame or field picture.
3851 * Meaningful frame information (codec specific) is guaranteed to
3852 * be parsed at this point. This function is mandatory.
3854 * Note that buf can be NULL along with buf_size set to 0.
3855 * Otherwise, this means the whole frame is available at this point.
3857 * @param avctx the codec context
3858 * @param buf the frame data buffer base
3859 * @param buf_size the size of the frame in bytes
3860 * @return zero if successful, a negative value otherwise
3862 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3865 * Callback for each slice.
3867 * Meaningful slice information (codec specific) is guaranteed to
3868 * be parsed at this point. This function is mandatory.
3869 * The only exception is XvMC, that works on MB level.
3871 * @param avctx the codec context
3872 * @param buf the slice data buffer base
3873 * @param buf_size the size of the slice in bytes
3874 * @return zero if successful, a negative value otherwise
3876 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3879 * Called at the end of each frame or field picture.
3881 * The whole picture is parsed at this point and can now be sent
3882 * to the hardware accelerator. This function is mandatory.
3884 * @param avctx the codec context
3885 * @return zero if successful, a negative value otherwise
3887 int (*end_frame)(AVCodecContext *avctx);
3890 * Size of per-frame hardware accelerator private data.
3892 * Private data is allocated with av_mallocz() before
3893 * AVCodecContext.get_buffer() and deallocated after
3894 * AVCodecContext.release_buffer().
3896 int frame_priv_data_size;
3899 * Called for every Macroblock in a slice.
3901 * XvMC uses it to replace the ff_mpv_decode_mb().
3902 * Instead of decoding to raw picture, MB parameters are
3903 * stored in an array provided by the video driver.
3905 * @param s the mpeg context
3907 void (*decode_mb)(struct MpegEncContext *s);
3910 * Initialize the hwaccel private data.
3912 * This will be called from ff_get_format(), after hwaccel and
3913 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3916 int (*init)(AVCodecContext *avctx);
3919 * Uninitialize the hwaccel private data.
3921 * This will be called from get_format() or avcodec_close(), after hwaccel
3922 * and hwaccel_context are already uninitialized.
3924 int (*uninit)(AVCodecContext *avctx);
3927 * Size of the private data to allocate in
3928 * AVCodecInternal.hwaccel_priv_data.
3933 * Internal hwaccel capabilities.
3939 * Hardware acceleration should be used for decoding even if the codec level
3940 * used is unknown or higher than the maximum supported level reported by the
3943 * It's generally a good idea to pass this flag unless you have a specific
3944 * reason not to, as hardware tends to under-report supported levels.
3946 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3949 * Hardware acceleration can output YUV pixel formats with a different chroma
3950 * sampling than 4:2:0 and/or other than 8 bits per component.
3952 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3958 #if FF_API_AVPICTURE
3960 * @defgroup lavc_picture AVPicture
3962 * Functions for working with AVPicture
3967 * Picture data structure.
3969 * Up to four components can be stored into it, the last component is
3971 * @deprecated use AVFrame or imgutils functions instead
3973 typedef struct AVPicture {
3974 attribute_deprecated
3975 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3976 attribute_deprecated
3977 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3985 enum AVSubtitleType {
3988 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3991 * Plain text, the text field must be set by the decoder and is
3992 * authoritative. ass and pict fields may contain approximations.
3997 * Formatted text, the ass field must be set by the decoder and is
3998 * authoritative. pict and text fields may contain approximations.
4003 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
4005 typedef struct AVSubtitleRect {
4006 int x; ///< top left corner of pict, undefined when pict is not set
4007 int y; ///< top left corner of pict, undefined when pict is not set
4008 int w; ///< width of pict, undefined when pict is not set
4009 int h; ///< height of pict, undefined when pict is not set
4010 int nb_colors; ///< number of colors in pict, undefined when pict is not set
4012 #if FF_API_AVPICTURE
4014 * @deprecated unused
4016 attribute_deprecated
4020 * data+linesize for the bitmap of this subtitle.
4021 * Can be set for text/ass as well once they are rendered.
4026 enum AVSubtitleType type;
4028 char *text; ///< 0 terminated plain UTF-8 text
4031 * 0 terminated ASS/SSA compatible event line.
4032 * The presentation of this is unaffected by the other values in this
4040 typedef struct AVSubtitle {
4041 uint16_t format; /* 0 = graphics */
4042 uint32_t start_display_time; /* relative to packet pts, in ms */
4043 uint32_t end_display_time; /* relative to packet pts, in ms */
4045 AVSubtitleRect **rects;
4046 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
4050 * This struct describes the properties of an encoded stream.
4052 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4053 * be allocated with avcodec_parameters_alloc() and freed with
4054 * avcodec_parameters_free().
4056 typedef struct AVCodecParameters {
4058 * General type of the encoded data.
4060 enum AVMediaType codec_type;
4062 * Specific type of the encoded data (the codec used).
4064 enum AVCodecID codec_id;
4066 * Additional information about the codec (corresponds to the AVI FOURCC).
4071 * Extra binary data needed for initializing the decoder, codec-dependent.
4073 * Must be allocated with av_malloc() and will be freed by
4074 * avcodec_parameters_free(). The allocated size of extradata must be at
4075 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4080 * Size of the extradata content in bytes.
4085 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4086 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4091 * The average bitrate of the encoded data (in bits per second).
4096 * The number of bits per sample in the codedwords.
4098 * This is basically the bitrate per sample. It is mandatory for a bunch of
4099 * formats to actually decode them. It's the number of bits for one sample in
4100 * the actual coded bitstream.
4102 * This could be for example 4 for ADPCM
4103 * For PCM formats this matches bits_per_raw_sample
4106 int bits_per_coded_sample;
4109 * This is the number of valid bits in each output sample. If the
4110 * sample format has more bits, the least significant bits are additional
4111 * padding bits, which are always 0. Use right shifts to reduce the sample
4112 * to its actual size. For example, audio formats with 24 bit samples will
4113 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4114 * To get the original sample use "(int32_t)sample >> 8"."
4116 * For ADPCM this might be 12 or 16 or similar
4119 int bits_per_raw_sample;
4122 * Codec-specific bitstream restrictions that the stream conforms to.
4128 * Video only. The dimensions of the video frame in pixels.
4134 * Video only. The aspect ratio (width / height) which a single pixel
4135 * should have when displayed.
4137 * When the aspect ratio is unknown / undefined, the numerator should be
4138 * set to 0 (the denominator may have any value).
4140 AVRational sample_aspect_ratio;
4143 * Video only. The order of the fields in interlaced video.
4145 enum AVFieldOrder field_order;
4148 * Video only. Additional colorspace characteristics.
4150 enum AVColorRange color_range;
4151 enum AVColorPrimaries color_primaries;
4152 enum AVColorTransferCharacteristic color_trc;
4153 enum AVColorSpace color_space;
4154 enum AVChromaLocation chroma_location;
4157 * Video only. Number of delayed frames.
4162 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4163 * unknown or unspecified, otherwise the number of bits set must be equal to
4164 * the channels field.
4166 uint64_t channel_layout;
4168 * Audio only. The number of audio channels.
4172 * Audio only. The number of audio samples per second.
4176 * Audio only. The number of bytes per coded audio frame, required by some
4179 * Corresponds to nBlockAlign in WAVEFORMATEX.
4183 * Audio only. Audio frame size, if known. Required by some formats to be static.
4188 * Audio only. The amount of padding (in samples) inserted by the encoder at
4189 * the beginning of the audio. I.e. this number of leading decoded samples
4190 * must be discarded by the caller to get the original audio without leading
4193 int initial_padding;
4195 * Audio only. The amount of padding (in samples) appended by the encoder to
4196 * the end of the audio. I.e. this number of decoded samples must be
4197 * discarded by the caller from the end of the stream to get the original
4198 * audio without any trailing padding.
4200 int trailing_padding;
4202 * Audio only. Number of samples to skip after a discontinuity.
4205 } AVCodecParameters;
4208 * If c is NULL, returns the first registered codec,
4209 * if c is non-NULL, returns the next registered codec after c,
4210 * or NULL if c is the last one.
4212 AVCodec *av_codec_next(const AVCodec *c);
4215 * Return the LIBAVCODEC_VERSION_INT constant.
4217 unsigned avcodec_version(void);
4220 * Return the libavcodec build-time configuration.
4222 const char *avcodec_configuration(void);
4225 * Return the libavcodec license.
4227 const char *avcodec_license(void);
4230 * Register the codec codec and initialize libavcodec.
4232 * @warning either this function or avcodec_register_all() must be called
4233 * before any other libavcodec functions.
4235 * @see avcodec_register_all()
4237 void avcodec_register(AVCodec *codec);
4240 * Register all the codecs, parsers and bitstream filters which were enabled at
4241 * configuration time. If you do not call this function you can select exactly
4242 * which formats you want to support, by using the individual registration
4245 * @see avcodec_register
4246 * @see av_register_codec_parser
4247 * @see av_register_bitstream_filter
4249 void avcodec_register_all(void);
4252 * Allocate an AVCodecContext and set its fields to default values. The
4253 * resulting struct should be freed with avcodec_free_context().
4255 * @param codec if non-NULL, allocate private data and initialize defaults
4256 * for the given codec. It is illegal to then call avcodec_open2()
4257 * with a different codec.
4258 * If NULL, then the codec-specific defaults won't be initialized,
4259 * which may result in suboptimal default settings (this is
4260 * important mainly for encoders, e.g. libx264).
4262 * @return An AVCodecContext filled with default values or NULL on failure.
4264 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4267 * Free the codec context and everything associated with it and write NULL to
4268 * the provided pointer.
4270 void avcodec_free_context(AVCodecContext **avctx);
4272 #if FF_API_GET_CONTEXT_DEFAULTS
4274 * @deprecated This function should not be used, as closing and opening a codec
4275 * context multiple time is not supported. A new codec context should be
4276 * allocated for each new use.
4278 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4282 * Get the AVClass for AVCodecContext. It can be used in combination with
4283 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4285 * @see av_opt_find().
4287 const AVClass *avcodec_get_class(void);
4289 #if FF_API_COPY_CONTEXT
4291 * Get the AVClass for AVFrame. It can be used in combination with
4292 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4294 * @see av_opt_find().
4296 const AVClass *avcodec_get_frame_class(void);
4299 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4300 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4302 * @see av_opt_find().
4304 const AVClass *avcodec_get_subtitle_rect_class(void);
4307 * Copy the settings of the source AVCodecContext into the destination
4308 * AVCodecContext. The resulting destination codec context will be
4309 * unopened, i.e. you are required to call avcodec_open2() before you
4310 * can use this AVCodecContext to decode/encode video/audio data.
4312 * @param dest target codec context, should be initialized with
4313 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4314 * @param src source codec context
4315 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4317 * @deprecated The semantics of this function are ill-defined and it should not
4318 * be used. If you need to transfer the stream parameters from one codec context
4319 * to another, use an intermediate AVCodecParameters instance and the
4320 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4323 attribute_deprecated
4324 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4328 * Allocate a new AVCodecParameters and set its fields to default values
4329 * (unknown/invalid/0). The returned struct must be freed with
4330 * avcodec_parameters_free().
4332 AVCodecParameters *avcodec_parameters_alloc(void);
4335 * Free an AVCodecParameters instance and everything associated with it and
4336 * write NULL to the supplied pointer.
4338 void avcodec_parameters_free(AVCodecParameters **par);
4341 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4342 * replaced with newly allocated duplicates of the corresponding fields in src.
4344 * @return >= 0 on success, a negative AVERROR code on failure.
4346 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4349 * Fill the parameters struct based on the values from the supplied codec
4350 * context. Any allocated fields in par are freed and replaced with duplicates
4351 * of the corresponding fields in codec.
4353 * @return >= 0 on success, a negative AVERROR code on failure
4355 int avcodec_parameters_from_context(AVCodecParameters *par,
4356 const AVCodecContext *codec);
4359 * Fill the codec context based on the values from the supplied codec
4360 * parameters. Any allocated fields in codec that have a corresponding field in
4361 * par are freed and replaced with duplicates of the corresponding field in par.
4362 * Fields in codec that do not have a counterpart in par are not touched.
4364 * @return >= 0 on success, a negative AVERROR code on failure.
4366 int avcodec_parameters_to_context(AVCodecContext *codec,
4367 const AVCodecParameters *par);
4370 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4371 * function the context has to be allocated with avcodec_alloc_context3().
4373 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4374 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4375 * retrieving a codec.
4377 * @warning This function is not thread safe!
4379 * @note Always call this function before using decoding routines (such as
4380 * @ref avcodec_receive_frame()).
4383 * avcodec_register_all();
4384 * av_dict_set(&opts, "b", "2.5M", 0);
4385 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4389 * context = avcodec_alloc_context3(codec);
4391 * if (avcodec_open2(context, codec, opts) < 0)
4395 * @param avctx The context to initialize.
4396 * @param codec The codec to open this context for. If a non-NULL codec has been
4397 * previously passed to avcodec_alloc_context3() or
4398 * for this context, then this parameter MUST be either NULL or
4399 * equal to the previously passed codec.
4400 * @param options A dictionary filled with AVCodecContext and codec-private options.
4401 * On return this object will be filled with options that were not found.
4403 * @return zero on success, a negative value on error
4404 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4405 * av_dict_set(), av_opt_find().
4407 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4410 * Close a given AVCodecContext and free all the data associated with it
4411 * (but not the AVCodecContext itself).
4413 * Calling this function on an AVCodecContext that hasn't been opened will free
4414 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4415 * codec. Subsequent calls will do nothing.
4417 * @note Do not use this function. Use avcodec_free_context() to destroy a
4418 * codec context (either open or closed). Opening and closing a codec context
4419 * multiple times is not supported anymore -- use multiple codec contexts
4422 int avcodec_close(AVCodecContext *avctx);
4425 * Free all allocated data in the given subtitle struct.
4427 * @param sub AVSubtitle to free.
4429 void avsubtitle_free(AVSubtitle *sub);
4436 * @addtogroup lavc_packet
4441 * Allocate an AVPacket and set its fields to default values. The resulting
4442 * struct must be freed using av_packet_free().
4444 * @return An AVPacket filled with default values or NULL on failure.
4446 * @note this only allocates the AVPacket itself, not the data buffers. Those
4447 * must be allocated through other means such as av_new_packet.
4449 * @see av_new_packet
4451 AVPacket *av_packet_alloc(void);
4454 * Create a new packet that references the same data as src.
4456 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4458 * @return newly created AVPacket on success, NULL on error.
4460 * @see av_packet_alloc
4461 * @see av_packet_ref
4463 AVPacket *av_packet_clone(const AVPacket *src);
4466 * Free the packet, if the packet is reference counted, it will be
4467 * unreferenced first.
4469 * @param pkt packet to be freed. The pointer will be set to NULL.
4470 * @note passing NULL is a no-op.
4472 void av_packet_free(AVPacket **pkt);
4475 * Initialize optional fields of a packet with default values.
4477 * Note, this does not touch the data and size members, which have to be
4478 * initialized separately.
4482 void av_init_packet(AVPacket *pkt);
4485 * Allocate the payload of a packet and initialize its fields with
4489 * @param size wanted payload size
4490 * @return 0 if OK, AVERROR_xxx otherwise
4492 int av_new_packet(AVPacket *pkt, int size);
4495 * Reduce packet size, correctly zeroing padding
4498 * @param size new size
4500 void av_shrink_packet(AVPacket *pkt, int size);
4503 * Increase packet size, correctly zeroing padding
4506 * @param grow_by number of bytes by which to increase the size of the packet
4508 int av_grow_packet(AVPacket *pkt, int grow_by);
4511 * Initialize a reference-counted packet from av_malloc()ed data.
4513 * @param pkt packet to be initialized. This function will set the data, size,
4514 * buf and destruct fields, all others are left untouched.
4515 * @param data Data allocated by av_malloc() to be used as packet data. If this
4516 * function returns successfully, the data is owned by the underlying AVBuffer.
4517 * The caller may not access the data through other means.
4518 * @param size size of data in bytes, without the padding. I.e. the full buffer
4519 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4521 * @return 0 on success, a negative AVERROR on error
4523 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4525 #if FF_API_AVPACKET_OLD_API
4527 * @warning This is a hack - the packet memory allocation stuff is broken. The
4528 * packet is allocated if it was not really allocated.
4530 * @deprecated Use av_packet_ref
4532 attribute_deprecated
4533 int av_dup_packet(AVPacket *pkt);
4535 * Copy packet, including contents
4537 * @return 0 on success, negative AVERROR on fail
4539 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4542 * Copy packet side data
4544 * @return 0 on success, negative AVERROR on fail
4546 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4551 * @deprecated Use av_packet_unref
4553 * @param pkt packet to free
4555 attribute_deprecated
4556 void av_free_packet(AVPacket *pkt);
4559 * Allocate new information of a packet.
4562 * @param type side information type
4563 * @param size side information size
4564 * @return pointer to fresh allocated data or NULL otherwise
4566 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4570 * Wrap an existing array as a packet side data.
4573 * @param type side information type
4574 * @param data the side data array. It must be allocated with the av_malloc()
4575 * family of functions. The ownership of the data is transferred to
4577 * @param size side information size
4578 * @return a non-negative number on success, a negative AVERROR code on
4579 * failure. On failure, the packet is unchanged and the data remains
4580 * owned by the caller.
4582 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4583 uint8_t *data, size_t size);
4586 * Shrink the already allocated side data buffer
4589 * @param type side information type
4590 * @param size new side information size
4591 * @return 0 on success, < 0 on failure
4593 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4597 * Get side information from packet.
4600 * @param type desired side information type
4601 * @param size pointer for side information size to store (optional)
4602 * @return pointer to data if present or NULL otherwise
4604 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4607 #if FF_API_MERGE_SD_API
4608 attribute_deprecated
4609 int av_packet_merge_side_data(AVPacket *pkt);
4611 attribute_deprecated
4612 int av_packet_split_side_data(AVPacket *pkt);
4615 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4618 * Pack a dictionary for use in side_data.
4620 * @param dict The dictionary to pack.
4621 * @param size pointer to store the size of the returned data
4622 * @return pointer to data if successful, NULL otherwise
4624 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4626 * Unpack a dictionary from side_data.
4628 * @param data data from side_data
4629 * @param size size of the data
4630 * @param dict the metadata storage dictionary
4631 * @return 0 on success, < 0 on failure
4633 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4637 * Convenience function to free all the side data stored.
4638 * All the other fields stay untouched.
4642 void av_packet_free_side_data(AVPacket *pkt);
4645 * Setup a new reference to the data described by a given packet
4647 * If src is reference-counted, setup dst as a new reference to the
4648 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4649 * data from src into it.
4651 * All the other fields are copied from src.
4653 * @see av_packet_unref
4655 * @param dst Destination packet
4656 * @param src Source packet
4658 * @return 0 on success, a negative AVERROR on error.
4660 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4665 * Unreference the buffer referenced by the packet and reset the
4666 * remaining packet fields to their default values.
4668 * @param pkt The packet to be unreferenced.
4670 void av_packet_unref(AVPacket *pkt);
4673 * Move every field in src to dst and reset src.
4675 * @see av_packet_unref
4677 * @param src Source packet, will be reset
4678 * @param dst Destination packet
4680 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4683 * Copy only "properties" fields from src to dst.
4685 * Properties for the purpose of this function are all the fields
4686 * beside those related to the packet data (buf, data, size)
4688 * @param dst Destination packet
4689 * @param src Source packet
4691 * @return 0 on success AVERROR on failure.
4693 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4696 * Convert valid timing fields (timestamps / durations) in a packet from one
4697 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4700 * @param pkt packet on which the conversion will be performed
4701 * @param tb_src source timebase, in which the timing fields in pkt are
4703 * @param tb_dst destination timebase, to which the timing fields will be
4706 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4713 * @addtogroup lavc_decoding
4718 * Find a registered decoder with a matching codec ID.
4720 * @param id AVCodecID of the requested decoder
4721 * @return A decoder if one was found, NULL otherwise.
4723 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4726 * Find a registered decoder with the specified name.
4728 * @param name name of the requested decoder
4729 * @return A decoder if one was found, NULL otherwise.
4731 AVCodec *avcodec_find_decoder_by_name(const char *name);
4734 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4735 * it can be called by custom get_buffer2() implementations for decoders without
4736 * AV_CODEC_CAP_DR1 set.
4738 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4742 * Return the amount of padding in pixels which the get_buffer callback must
4743 * provide around the edge of the image for codecs which do not have the
4744 * CODEC_FLAG_EMU_EDGE flag.
4746 * @return Required padding in pixels.
4748 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4751 attribute_deprecated
4752 unsigned avcodec_get_edge_width(void);
4756 * Modify width and height values so that they will result in a memory
4757 * buffer that is acceptable for the codec if you do not use any horizontal
4760 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4762 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4765 * Modify width and height values so that they will result in a memory
4766 * buffer that is acceptable for the codec if you also ensure that all
4767 * line sizes are a multiple of the respective linesize_align[i].
4769 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4771 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4772 int linesize_align[AV_NUM_DATA_POINTERS]);
4775 * Converts AVChromaLocation to swscale x/y chroma position.
4777 * The positions represent the chroma (0,0) position in a coordinates system
4778 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4780 * @param xpos horizontal chroma sample position
4781 * @param ypos vertical chroma sample position
4783 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4786 * Converts swscale x/y chroma position to AVChromaLocation.
4788 * The positions represent the chroma (0,0) position in a coordinates system
4789 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4791 * @param xpos horizontal chroma sample position
4792 * @param ypos vertical chroma sample position
4794 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4797 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4799 * Some decoders may support multiple frames in a single AVPacket. Such
4800 * decoders would then just decode the first frame and the return value would be
4801 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4802 * called again with an AVPacket containing the remaining data in order to
4803 * decode the second frame, etc... Even if no frames are returned, the packet
4804 * needs to be fed to the decoder with remaining data until it is completely
4805 * consumed or an error occurs.
4807 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4808 * and output. This means that for some packets they will not immediately
4809 * produce decoded output and need to be flushed at the end of decoding to get
4810 * all the decoded data. Flushing is done by calling this function with packets
4811 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4812 * returning samples. It is safe to flush even those decoders that are not
4813 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4815 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4816 * larger than the actual read bytes because some optimized bitstream
4817 * readers read 32 or 64 bits at once and could read over the end.
4819 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4820 * before packets may be fed to the decoder.
4822 * @param avctx the codec context
4823 * @param[out] frame The AVFrame in which to store decoded audio samples.
4824 * The decoder will allocate a buffer for the decoded frame by
4825 * calling the AVCodecContext.get_buffer2() callback.
4826 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4827 * reference counted and the returned reference belongs to the
4828 * caller. The caller must release the frame using av_frame_unref()
4829 * when the frame is no longer needed. The caller may safely write
4830 * to the frame if av_frame_is_writable() returns 1.
4831 * When AVCodecContext.refcounted_frames is set to 0, the returned
4832 * reference belongs to the decoder and is valid only until the
4833 * next call to this function or until closing or flushing the
4834 * decoder. The caller may not write to it.
4835 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4836 * non-zero. Note that this field being set to zero
4837 * does not mean that an error has occurred. For
4838 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4839 * call is guaranteed to produce a frame.
4840 * @param[in] avpkt The input AVPacket containing the input buffer.
4841 * At least avpkt->data and avpkt->size should be set. Some
4842 * decoders might also require additional fields to be set.
4843 * @return A negative error code is returned if an error occurred during
4844 * decoding, otherwise the number of bytes consumed from the input
4845 * AVPacket is returned.
4847 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4849 attribute_deprecated
4850 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4851 int *got_frame_ptr, const AVPacket *avpkt);
4854 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4855 * Some decoders may support multiple frames in a single AVPacket, such
4856 * decoders would then just decode the first frame.
4858 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4859 * the actual read bytes because some optimized bitstream readers read 32 or 64
4860 * bits at once and could read over the end.
4862 * @warning The end of the input buffer buf should be set to 0 to ensure that
4863 * no overreading happens for damaged MPEG streams.
4865 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4866 * between input and output, these need to be fed with avpkt->data=NULL,
4867 * avpkt->size=0 at the end to return the remaining frames.
4869 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4870 * before packets may be fed to the decoder.
4872 * @param avctx the codec context
4873 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4874 * Use av_frame_alloc() to get an AVFrame. The codec will
4875 * allocate memory for the actual bitmap by calling the
4876 * AVCodecContext.get_buffer2() callback.
4877 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4878 * reference counted and the returned reference belongs to the
4879 * caller. The caller must release the frame using av_frame_unref()
4880 * when the frame is no longer needed. The caller may safely write
4881 * to the frame if av_frame_is_writable() returns 1.
4882 * When AVCodecContext.refcounted_frames is set to 0, the returned
4883 * reference belongs to the decoder and is valid only until the
4884 * next call to this function or until closing or flushing the
4885 * decoder. The caller may not write to it.
4887 * @param[in] avpkt The input AVPacket containing the input buffer.
4888 * You can create such packet with av_init_packet() and by then setting
4889 * data and size, some decoders might in addition need other fields like
4890 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4892 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4893 * @return On error a negative value is returned, otherwise the number of bytes
4894 * used or zero if no frame could be decompressed.
4896 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4898 attribute_deprecated
4899 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4900 int *got_picture_ptr,
4901 const AVPacket *avpkt);
4904 * Decode a subtitle message.
4905 * Return a negative value on error, otherwise return the number of bytes used.
4906 * If no subtitle could be decompressed, got_sub_ptr is zero.
4907 * Otherwise, the subtitle is stored in *sub.
4908 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4909 * simplicity, because the performance difference is expect to be negligible
4910 * and reusing a get_buffer written for video codecs would probably perform badly
4911 * due to a potentially very different allocation pattern.
4913 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4914 * and output. This means that for some packets they will not immediately
4915 * produce decoded output and need to be flushed at the end of decoding to get
4916 * all the decoded data. Flushing is done by calling this function with packets
4917 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4918 * returning subtitles. It is safe to flush even those decoders that are not
4919 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4921 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4922 * before packets may be fed to the decoder.
4924 * @param avctx the codec context
4925 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4926 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4927 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4928 * @param[in] avpkt The input AVPacket containing the input buffer.
4930 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4935 * Supply raw packet data as input to a decoder.
4937 * Internally, this call will copy relevant AVCodecContext fields, which can
4938 * influence decoding per-packet, and apply them when the packet is actually
4939 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4940 * decoder to drop the frame contained by the packet sent with this function.)
4942 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4943 * larger than the actual read bytes because some optimized bitstream
4944 * readers read 32 or 64 bits at once and could read over the end.
4946 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4947 * on the same AVCodecContext. It will return unexpected results now
4948 * or in future libavcodec versions.
4950 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4951 * before packets may be fed to the decoder.
4953 * @param avctx codec context
4954 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4955 * frame, or several complete audio frames.
4956 * Ownership of the packet remains with the caller, and the
4957 * decoder will not write to the packet. The decoder may create
4958 * a reference to the packet data (or copy it if the packet is
4959 * not reference-counted).
4960 * Unlike with older APIs, the packet is always fully consumed,
4961 * and if it contains multiple frames (e.g. some audio codecs),
4962 * will require you to call avcodec_receive_frame() multiple
4963 * times afterwards before you can send a new packet.
4964 * It can be NULL (or an AVPacket with data set to NULL and
4965 * size set to 0); in this case, it is considered a flush
4966 * packet, which signals the end of the stream. Sending the
4967 * first flush packet will return success. Subsequent ones are
4968 * unnecessary and will return AVERROR_EOF. If the decoder
4969 * still has frames buffered, it will return them after sending
4972 * @return 0 on success, otherwise negative error code:
4973 * AVERROR(EAGAIN): input is not accepted in the current state - user
4974 * must read output with avcodec_receive_frame() (once
4975 * all output is read, the packet should be resent, and
4976 * the call will not fail with EAGAIN).
4977 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4978 * be sent to it (also returned if more than 1 flush
4980 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4981 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4982 * other errors: legitimate decoding errors
4984 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4987 * Return decoded output data from a decoder.
4989 * @param avctx codec context
4990 * @param frame This will be set to a reference-counted video or audio
4991 * frame (depending on the decoder type) allocated by the
4992 * decoder. Note that the function will always call
4993 * av_frame_unref(frame) before doing anything else.
4996 * 0: success, a frame was returned
4997 * AVERROR(EAGAIN): output is not available in this state - user must try
4999 * AVERROR_EOF: the decoder has been fully flushed, and there will be
5000 * no more output frames
5001 * AVERROR(EINVAL): codec not opened, or it is an encoder
5002 * other negative values: legitimate decoding errors
5004 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
5007 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
5008 * to retrieve buffered output packets.
5010 * @param avctx codec context
5011 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
5012 * Ownership of the frame remains with the caller, and the
5013 * encoder will not write to the frame. The encoder may create
5014 * a reference to the frame data (or copy it if the frame is
5015 * not reference-counted).
5016 * It can be NULL, in which case it is considered a flush
5017 * packet. This signals the end of the stream. If the encoder
5018 * still has packets buffered, it will return them after this
5019 * call. Once flushing mode has been entered, additional flush
5020 * packets are ignored, and sending frames will return
5024 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5025 * can have any number of samples.
5026 * If it is not set, frame->nb_samples must be equal to
5027 * avctx->frame_size for all frames except the last.
5028 * The final frame may be smaller than avctx->frame_size.
5029 * @return 0 on success, otherwise negative error code:
5030 * AVERROR(EAGAIN): input is not accepted in the current state - user
5031 * must read output with avcodec_receive_packet() (once
5032 * all output is read, the packet should be resent, and
5033 * the call will not fail with EAGAIN).
5034 * AVERROR_EOF: the encoder has been flushed, and no new frames can
5036 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
5037 * decoder, or requires flush
5038 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5039 * other errors: legitimate decoding errors
5041 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5044 * Read encoded data from the encoder.
5046 * @param avctx codec context
5047 * @param avpkt This will be set to a reference-counted packet allocated by the
5048 * encoder. Note that the function will always call
5049 * av_frame_unref(frame) before doing anything else.
5050 * @return 0 on success, otherwise negative error code:
5051 * AVERROR(EAGAIN): output is not available in the current state - user
5052 * must try to send input
5053 * AVERROR_EOF: the encoder has been fully flushed, and there will be
5054 * no more output packets
5055 * AVERROR(EINVAL): codec not opened, or it is an encoder
5056 * other errors: legitimate decoding errors
5058 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5062 * @defgroup lavc_parsing Frame parsing
5066 enum AVPictureStructure {
5067 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5068 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5069 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5070 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5073 typedef struct AVCodecParserContext {
5075 struct AVCodecParser *parser;
5076 int64_t frame_offset; /* offset of the current frame */
5077 int64_t cur_offset; /* current offset
5078 (incremented by each av_parser_parse()) */
5079 int64_t next_frame_offset; /* offset of the next frame */
5081 int pict_type; /* XXX: Put it back in AVCodecContext. */
5083 * This field is used for proper frame duration computation in lavf.
5084 * It signals, how much longer the frame duration of the current frame
5085 * is compared to normal frame duration.
5087 * frame_duration = (1 + repeat_pict) * time_base
5089 * It is used by codecs like H.264 to display telecined material.
5091 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5092 int64_t pts; /* pts of the current frame */
5093 int64_t dts; /* dts of the current frame */
5098 int fetch_timestamp;
5100 #define AV_PARSER_PTS_NB 4
5101 int cur_frame_start_index;
5102 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5103 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5104 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5107 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5108 #define PARSER_FLAG_ONCE 0x0002
5109 /// Set if the parser has a valid file offset
5110 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5111 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5113 int64_t offset; ///< byte offset from starting packet start
5114 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5117 * Set by parser to 1 for key frames and 0 for non-key frames.
5118 * It is initialized to -1, so if the parser doesn't set this flag,
5119 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5124 #if FF_API_CONVERGENCE_DURATION
5126 * @deprecated unused
5128 attribute_deprecated
5129 int64_t convergence_duration;
5132 // Timestamp generation support:
5134 * Synchronization point for start of timestamp generation.
5136 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5139 * For example, this corresponds to presence of H.264 buffering period
5145 * Offset of the current timestamp against last timestamp sync point in
5146 * units of AVCodecContext.time_base.
5148 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5149 * contain a valid timestamp offset.
5151 * Note that the timestamp of sync point has usually a nonzero
5152 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5153 * the next frame after timestamp sync point will be usually 1.
5155 * For example, this corresponds to H.264 cpb_removal_delay.
5157 int dts_ref_dts_delta;
5160 * Presentation delay of current frame in units of AVCodecContext.time_base.
5162 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5163 * contain valid non-negative timestamp delta (presentation time of a frame
5164 * must not lie in the past).
5166 * This delay represents the difference between decoding and presentation
5167 * time of the frame.
5169 * For example, this corresponds to H.264 dpb_output_delay.
5174 * Position of the packet in file.
5176 * Analogous to cur_frame_pts/dts
5178 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5181 * Byte position of currently parsed frame in stream.
5186 * Previous frame byte position.
5191 * Duration of the current frame.
5192 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5193 * For all other types, this is in units of AVCodecContext.time_base.
5197 enum AVFieldOrder field_order;
5200 * Indicate whether a picture is coded as a frame, top field or bottom field.
5202 * For example, H.264 field_pic_flag equal to 0 corresponds to
5203 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5204 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5205 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5207 enum AVPictureStructure picture_structure;
5210 * Picture number incremented in presentation or output order.
5211 * This field may be reinitialized at the first picture of a new sequence.
5213 * For example, this corresponds to H.264 PicOrderCnt.
5215 int output_picture_number;
5218 * Dimensions of the decoded video intended for presentation.
5224 * Dimensions of the coded video.
5230 * The format of the coded data, corresponds to enum AVPixelFormat for video
5231 * and for enum AVSampleFormat for audio.
5233 * Note that a decoder can have considerable freedom in how exactly it
5234 * decodes the data, so the format reported here might be different from the
5235 * one returned by a decoder.
5238 } AVCodecParserContext;
5240 typedef struct AVCodecParser {
5241 int codec_ids[5]; /* several codec IDs are permitted */
5243 int (*parser_init)(AVCodecParserContext *s);
5244 /* This callback never returns an error, a negative value means that
5245 * the frame start was in a previous packet. */
5246 int (*parser_parse)(AVCodecParserContext *s,
5247 AVCodecContext *avctx,
5248 const uint8_t **poutbuf, int *poutbuf_size,
5249 const uint8_t *buf, int buf_size);
5250 void (*parser_close)(AVCodecParserContext *s);
5251 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5252 struct AVCodecParser *next;
5255 AVCodecParser *av_parser_next(const AVCodecParser *c);
5257 void av_register_codec_parser(AVCodecParser *parser);
5258 AVCodecParserContext *av_parser_init(int codec_id);
5263 * @param s parser context.
5264 * @param avctx codec context.
5265 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5266 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5267 * @param buf input buffer.
5268 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5269 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5270 To signal EOF, this should be 0 (so that the last frame
5272 * @param pts input presentation timestamp.
5273 * @param dts input decoding timestamp.
5274 * @param pos input byte position in stream.
5275 * @return the number of bytes of the input bitstream used.
5280 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5287 * decode_frame(data, size);
5291 int av_parser_parse2(AVCodecParserContext *s,
5292 AVCodecContext *avctx,
5293 uint8_t **poutbuf, int *poutbuf_size,
5294 const uint8_t *buf, int buf_size,
5295 int64_t pts, int64_t dts,
5299 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5300 * @deprecated use AVBitStreamFilter
5302 int av_parser_change(AVCodecParserContext *s,
5303 AVCodecContext *avctx,
5304 uint8_t **poutbuf, int *poutbuf_size,
5305 const uint8_t *buf, int buf_size, int keyframe);
5306 void av_parser_close(AVCodecParserContext *s);
5314 * @addtogroup lavc_encoding
5319 * Find a registered encoder with a matching codec ID.
5321 * @param id AVCodecID of the requested encoder
5322 * @return An encoder if one was found, NULL otherwise.
5324 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5327 * Find a registered encoder with the specified name.
5329 * @param name name of the requested encoder
5330 * @return An encoder if one was found, NULL otherwise.
5332 AVCodec *avcodec_find_encoder_by_name(const char *name);
5335 * Encode a frame of audio.
5337 * Takes input samples from frame and writes the next output packet, if
5338 * available, to avpkt. The output packet does not necessarily contain data for
5339 * the most recent frame, as encoders can delay, split, and combine input frames
5340 * internally as needed.
5342 * @param avctx codec context
5343 * @param avpkt output AVPacket.
5344 * The user can supply an output buffer by setting
5345 * avpkt->data and avpkt->size prior to calling the
5346 * function, but if the size of the user-provided data is not
5347 * large enough, encoding will fail. If avpkt->data and
5348 * avpkt->size are set, avpkt->destruct must also be set. All
5349 * other AVPacket fields will be reset by the encoder using
5350 * av_init_packet(). If avpkt->data is NULL, the encoder will
5351 * allocate it. The encoder will set avpkt->size to the size
5352 * of the output packet.
5354 * If this function fails or produces no output, avpkt will be
5355 * freed using av_packet_unref().
5356 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5357 * May be NULL when flushing an encoder that has the
5358 * AV_CODEC_CAP_DELAY capability set.
5359 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5360 * can have any number of samples.
5361 * If it is not set, frame->nb_samples must be equal to
5362 * avctx->frame_size for all frames except the last.
5363 * The final frame may be smaller than avctx->frame_size.
5364 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5365 * output packet is non-empty, and to 0 if it is
5366 * empty. If the function returns an error, the
5367 * packet can be assumed to be invalid, and the
5368 * value of got_packet_ptr is undefined and should
5370 * @return 0 on success, negative error code on failure
5372 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5374 attribute_deprecated
5375 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5376 const AVFrame *frame, int *got_packet_ptr);
5379 * Encode a frame of video.
5381 * Takes input raw video data from frame and writes the next output packet, if
5382 * available, to avpkt. The output packet does not necessarily contain data for
5383 * the most recent frame, as encoders can delay and reorder input frames
5384 * internally as needed.
5386 * @param avctx codec context
5387 * @param avpkt output AVPacket.
5388 * The user can supply an output buffer by setting
5389 * avpkt->data and avpkt->size prior to calling the
5390 * function, but if the size of the user-provided data is not
5391 * large enough, encoding will fail. All other AVPacket fields
5392 * will be reset by the encoder using av_init_packet(). If
5393 * avpkt->data is NULL, the encoder will allocate it.
5394 * The encoder will set avpkt->size to the size of the
5395 * output packet. The returned data (if any) belongs to the
5396 * caller, he is responsible for freeing it.
5398 * If this function fails or produces no output, avpkt will be
5399 * freed using av_packet_unref().
5400 * @param[in] frame AVFrame containing the raw video data to be encoded.
5401 * May be NULL when flushing an encoder that has the
5402 * AV_CODEC_CAP_DELAY capability set.
5403 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5404 * output packet is non-empty, and to 0 if it is
5405 * empty. If the function returns an error, the
5406 * packet can be assumed to be invalid, and the
5407 * value of got_packet_ptr is undefined and should
5409 * @return 0 on success, negative error code on failure
5411 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5413 attribute_deprecated
5414 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5415 const AVFrame *frame, int *got_packet_ptr);
5417 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5418 const AVSubtitle *sub);
5425 #if FF_API_AVCODEC_RESAMPLE
5427 * @defgroup lavc_resample Audio resampling
5429 * @deprecated use libswresample instead
5433 struct ReSampleContext;
5434 struct AVResampleContext;
5436 typedef struct ReSampleContext ReSampleContext;
5439 * Initialize audio resampling context.
5441 * @param output_channels number of output channels
5442 * @param input_channels number of input channels
5443 * @param output_rate output sample rate
5444 * @param input_rate input sample rate
5445 * @param sample_fmt_out requested output sample format
5446 * @param sample_fmt_in input sample format
5447 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5448 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5449 * @param linear if 1 then the used FIR filter will be linearly interpolated
5450 between the 2 closest, if 0 the closest will be used
5451 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5452 * @return allocated ReSampleContext, NULL if error occurred
5454 attribute_deprecated
5455 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5456 int output_rate, int input_rate,
5457 enum AVSampleFormat sample_fmt_out,
5458 enum AVSampleFormat sample_fmt_in,
5459 int filter_length, int log2_phase_count,
5460 int linear, double cutoff);
5462 attribute_deprecated
5463 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5466 * Free resample context.
5468 * @param s a non-NULL pointer to a resample context previously
5469 * created with av_audio_resample_init()
5471 attribute_deprecated
5472 void audio_resample_close(ReSampleContext *s);
5476 * Initialize an audio resampler.
5477 * Note, if either rate is not an integer then simply scale both rates up so they are.
5478 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5479 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5480 * @param linear If 1 then the used FIR filter will be linearly interpolated
5481 between the 2 closest, if 0 the closest will be used
5482 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5484 attribute_deprecated
5485 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5488 * Resample an array of samples using a previously configured context.
5489 * @param src an array of unconsumed samples
5490 * @param consumed the number of samples of src which have been consumed are returned here
5491 * @param src_size the number of unconsumed samples available
5492 * @param dst_size the amount of space in samples available in dst
5493 * @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.
5494 * @return the number of samples written in dst or -1 if an error occurred
5496 attribute_deprecated
5497 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5501 * Compensate samplerate/timestamp drift. The compensation is done by changing
5502 * the resampler parameters, so no audible clicks or similar distortions occur
5503 * @param compensation_distance distance in output samples over which the compensation should be performed
5504 * @param sample_delta number of output samples which should be output less
5506 * example: av_resample_compensate(c, 10, 500)
5507 * here instead of 510 samples only 500 samples would be output
5509 * note, due to rounding the actual compensation might be slightly different,
5510 * especially if the compensation_distance is large and the in_rate used during init is small
5512 attribute_deprecated
5513 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5514 attribute_deprecated
5515 void av_resample_close(struct AVResampleContext *c);
5522 #if FF_API_AVPICTURE
5524 * @addtogroup lavc_picture
5529 * @deprecated unused
5531 attribute_deprecated
5532 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5535 * @deprecated unused
5537 attribute_deprecated
5538 void avpicture_free(AVPicture *picture);
5541 * @deprecated use av_image_fill_arrays() instead.
5543 attribute_deprecated
5544 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5545 enum AVPixelFormat pix_fmt, int width, int height);
5548 * @deprecated use av_image_copy_to_buffer() instead.
5550 attribute_deprecated
5551 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5552 int width, int height,
5553 unsigned char *dest, int dest_size);
5556 * @deprecated use av_image_get_buffer_size() instead.
5558 attribute_deprecated
5559 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5562 * @deprecated av_image_copy() instead.
5564 attribute_deprecated
5565 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5566 enum AVPixelFormat pix_fmt, int width, int height);
5569 * @deprecated unused
5571 attribute_deprecated
5572 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5573 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5576 * @deprecated unused
5578 attribute_deprecated
5579 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5580 int padtop, int padbottom, int padleft, int padright, int *color);
5588 * @defgroup lavc_misc Utility functions
5591 * Miscellaneous utility functions related to both encoding and decoding
5597 * @defgroup lavc_misc_pixfmt Pixel formats
5599 * Functions for working with pixel formats.
5604 * Utility function to access log2_chroma_w log2_chroma_h from
5605 * the pixel format AVPixFmtDescriptor.
5607 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5608 * for one that returns a failure code and continues in case of invalid
5611 * @param[in] pix_fmt the pixel format
5612 * @param[out] h_shift store log2_chroma_w
5613 * @param[out] v_shift store log2_chroma_h
5615 * @see av_pix_fmt_get_chroma_sub_sample
5618 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5621 * Return a value representing the fourCC code associated to the
5622 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5625 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5628 * @deprecated see av_get_pix_fmt_loss()
5630 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5634 * Find the best pixel format to convert to given a certain source pixel
5635 * format. When converting from one pixel format to another, information loss
5636 * may occur. For example, when converting from RGB24 to GRAY, the color
5637 * information will be lost. Similarly, other losses occur when converting from
5638 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5639 * the given pixel formats should be used to suffer the least amount of loss.
5640 * The pixel formats from which it chooses one, are determined by the
5641 * pix_fmt_list parameter.
5644 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5645 * @param[in] src_pix_fmt source pixel format
5646 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5647 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5648 * @return The best pixel format to convert to or -1 if none was found.
5650 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5651 enum AVPixelFormat src_pix_fmt,
5652 int has_alpha, int *loss_ptr);
5655 * @deprecated see av_find_best_pix_fmt_of_2()
5657 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5658 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5660 attribute_deprecated
5661 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5662 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5664 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5670 #if FF_API_SET_DIMENSIONS
5672 * @deprecated this function is not supposed to be used from outside of lavc
5674 attribute_deprecated
5675 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5678 #if FF_API_TAG_STRING
5680 * Put a string representing the codec tag codec_tag in buf.
5682 * @param buf buffer to place codec tag in
5683 * @param buf_size size in bytes of buf
5684 * @param codec_tag codec tag to assign
5685 * @return the length of the string that would have been generated if
5686 * enough space had been available, excluding the trailing null
5688 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5690 attribute_deprecated
5691 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5694 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5697 * Return a name for the specified profile, if available.
5699 * @param codec the codec that is searched for the given profile
5700 * @param profile the profile value for which a name is requested
5701 * @return A name for the profile if found, NULL otherwise.
5703 const char *av_get_profile_name(const AVCodec *codec, int profile);
5706 * Return a name for the specified profile, if available.
5708 * @param codec_id the ID of the codec to which the requested profile belongs
5709 * @param profile the profile value for which a name is requested
5710 * @return A name for the profile if found, NULL otherwise.
5712 * @note unlike av_get_profile_name(), which searches a list of profiles
5713 * supported by a specific decoder or encoder implementation, this
5714 * function searches the list of profiles from the AVCodecDescriptor
5716 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5718 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5719 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5720 //FIXME func typedef
5723 * Fill AVFrame audio data and linesize pointers.
5725 * The buffer buf must be a preallocated buffer with a size big enough
5726 * to contain the specified samples amount. The filled AVFrame data
5727 * pointers will point to this buffer.
5729 * AVFrame extended_data channel pointers are allocated if necessary for
5732 * @param frame the AVFrame
5733 * frame->nb_samples must be set prior to calling the
5734 * function. This function fills in frame->data,
5735 * frame->extended_data, frame->linesize[0].
5736 * @param nb_channels channel count
5737 * @param sample_fmt sample format
5738 * @param buf buffer to use for frame data
5739 * @param buf_size size of buffer
5740 * @param align plane size sample alignment (0 = default)
5741 * @return >=0 on success, negative error code on failure
5742 * @todo return the size in bytes required to store the samples in
5743 * case of success, at the next libavutil bump
5745 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5746 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5747 int buf_size, int align);
5750 * Reset the internal decoder state / flush internal buffers. Should be called
5751 * e.g. when seeking or when switching to a different stream.
5753 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5754 * this invalidates the frames previously returned from the decoder. When
5755 * refcounted frames are used, the decoder just releases any references it might
5756 * keep internally, but the caller's reference remains valid.
5758 void avcodec_flush_buffers(AVCodecContext *avctx);
5761 * Return codec bits per sample.
5763 * @param[in] codec_id the codec
5764 * @return Number of bits per sample or zero if unknown for the given codec.
5766 int av_get_bits_per_sample(enum AVCodecID codec_id);
5769 * Return the PCM codec associated with a sample format.
5770 * @param be endianness, 0 for little, 1 for big,
5771 * -1 (or anything else) for native
5772 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5774 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5777 * Return codec bits per sample.
5778 * Only return non-zero if the bits per sample is exactly correct, not an
5781 * @param[in] codec_id the codec
5782 * @return Number of bits per sample or zero if unknown for the given codec.
5784 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5787 * Return audio frame duration.
5789 * @param avctx codec context
5790 * @param frame_bytes size of the frame, or 0 if unknown
5791 * @return frame duration, in samples, if known. 0 if not able to
5794 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5797 * This function is the same as av_get_audio_frame_duration(), except it works
5798 * with AVCodecParameters instead of an AVCodecContext.
5800 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5803 typedef struct AVBitStreamFilterContext {
5805 const struct AVBitStreamFilter *filter;
5806 AVCodecParserContext *parser;
5807 struct AVBitStreamFilterContext *next;
5809 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5810 * Not for access by library users.
5813 } AVBitStreamFilterContext;
5816 typedef struct AVBSFInternal AVBSFInternal;
5819 * The bitstream filter state.
5821 * This struct must be allocated with av_bsf_alloc() and freed with
5824 * The fields in the struct will only be changed (by the caller or by the
5825 * filter) as described in their documentation, and are to be considered
5826 * immutable otherwise.
5828 typedef struct AVBSFContext {
5830 * A class for logging and AVOptions
5832 const AVClass *av_class;
5835 * The bitstream filter this context is an instance of.
5837 const struct AVBitStreamFilter *filter;
5840 * Opaque libavcodec internal data. Must not be touched by the caller in any
5843 AVBSFInternal *internal;
5846 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5847 * this is an AVOptions-enabled struct.
5852 * Parameters of the input stream. This field is allocated in
5853 * av_bsf_alloc(), it needs to be filled by the caller before
5856 AVCodecParameters *par_in;
5859 * Parameters of the output stream. This field is allocated in
5860 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5862 AVCodecParameters *par_out;
5865 * The timebase used for the timestamps of the input packets. Set by the
5866 * caller before av_bsf_init().
5868 AVRational time_base_in;
5871 * The timebase used for the timestamps of the output packets. Set by the
5872 * filter in av_bsf_init().
5874 AVRational time_base_out;
5877 typedef struct AVBitStreamFilter {
5881 * A list of codec ids supported by the filter, terminated by
5883 * May be NULL, in that case the bitstream filter works with any codec id.
5885 const enum AVCodecID *codec_ids;
5888 * A class for the private data, used to declare bitstream filter private
5889 * AVOptions. This field is NULL for bitstream filters that do not declare
5892 * If this field is non-NULL, the first member of the filter private data
5893 * must be a pointer to AVClass, which will be set by libavcodec generic
5894 * code to this class.
5896 const AVClass *priv_class;
5898 /*****************************************************************
5899 * No fields below this line are part of the public API. They
5900 * may not be used outside of libavcodec and can be changed and
5902 * New public fields should be added right above.
5903 *****************************************************************
5907 int (*init)(AVBSFContext *ctx);
5908 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5909 void (*close)(AVBSFContext *ctx);
5910 } AVBitStreamFilter;
5914 * Register a bitstream filter.
5916 * The filter will be accessible to the application code through
5917 * av_bitstream_filter_next() or can be directly initialized with
5918 * av_bitstream_filter_init().
5920 * @see avcodec_register_all()
5922 attribute_deprecated
5923 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5926 * Create and initialize a bitstream filter context given a bitstream
5929 * The returned context must be freed with av_bitstream_filter_close().
5931 * @param name the name of the bitstream filter
5932 * @return a bitstream filter context if a matching filter was found
5933 * and successfully initialized, NULL otherwise
5935 attribute_deprecated
5936 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5941 * This function filters the buffer buf with size buf_size, and places the
5942 * filtered buffer in the buffer pointed to by poutbuf.
5944 * The output buffer must be freed by the caller.
5946 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5947 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5948 * If specified, this must point to the encoder context of the
5949 * output stream the packet is sent to.
5950 * @param args arguments which specify the filter configuration, may be NULL
5951 * @param poutbuf pointer which is updated to point to the filtered buffer
5952 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5953 * @param buf buffer containing the data to filter
5954 * @param buf_size size in bytes of buf
5955 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5956 * @return >= 0 in case of success, or a negative error code in case of failure
5958 * If the return value is positive, an output buffer is allocated and
5959 * is available in *poutbuf, and is distinct from the input buffer.
5961 * If the return value is 0, the output buffer is not allocated and
5962 * should be considered identical to the input buffer, or in case
5963 * *poutbuf was set it points to the input buffer (not necessarily to
5964 * its starting address). A special case is if *poutbuf was set to NULL and
5965 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5967 attribute_deprecated
5968 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5969 AVCodecContext *avctx, const char *args,
5970 uint8_t **poutbuf, int *poutbuf_size,
5971 const uint8_t *buf, int buf_size, int keyframe);
5974 * Release bitstream filter context.
5976 * @param bsf the bitstream filter context created with
5977 * av_bitstream_filter_init(), can be NULL
5979 attribute_deprecated
5980 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5983 * If f is NULL, return the first registered bitstream filter,
5984 * if f is non-NULL, return the next registered bitstream filter
5985 * after f, or NULL if f is the last one.
5987 * This function can be used to iterate over all registered bitstream
5990 attribute_deprecated
5991 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5995 * @return a bitstream filter with the specified name or NULL if no such
5996 * bitstream filter exists.
5998 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
6001 * Iterate over all registered bitstream filters.
6003 * @param opaque a pointer where libavcodec will store the iteration state. Must
6004 * point to NULL to start the iteration.
6006 * @return the next registered bitstream filter or NULL when the iteration is
6009 const AVBitStreamFilter *av_bsf_next(void **opaque);
6012 * Allocate a context for a given bitstream filter. The caller must fill in the
6013 * context parameters as described in the documentation and then call
6014 * av_bsf_init() before sending any data to the filter.
6016 * @param filter the filter for which to allocate an instance.
6017 * @param ctx a pointer into which the pointer to the newly-allocated context
6018 * will be written. It must be freed with av_bsf_free() after the
6019 * filtering is done.
6021 * @return 0 on success, a negative AVERROR code on failure
6023 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
6026 * Prepare the filter for use, after all the parameters and options have been
6029 int av_bsf_init(AVBSFContext *ctx);
6032 * Submit a packet for filtering.
6034 * After sending each packet, the filter must be completely drained by calling
6035 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
6038 * @param pkt the packet to filter. pkt must contain some payload (i.e data or
6039 * side data must be present in pkt). The bitstream filter will take ownership of
6040 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
6041 * This parameter may be NULL, which signals the end of the stream (i.e. no more
6042 * packets will be sent). That will cause the filter to output any packets it
6043 * may have buffered internally.
6045 * @return 0 on success, a negative AVERROR on error.
6047 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
6050 * Retrieve a filtered packet.
6052 * @param[out] pkt this struct will be filled with the contents of the filtered
6053 * packet. It is owned by the caller and must be freed using
6054 * av_packet_unref() when it is no longer needed.
6055 * This parameter should be "clean" (i.e. freshly allocated
6056 * with av_packet_alloc() or unreffed with av_packet_unref())
6057 * when this function is called. If this function returns
6058 * successfully, the contents of pkt will be completely
6059 * overwritten by the returned data. On failure, pkt is not
6062 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
6063 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
6064 * will be no further output from the filter. Another negative AVERROR value if
6067 * @note one input packet may result in several output packets, so after sending
6068 * a packet with av_bsf_send_packet(), this function needs to be called
6069 * repeatedly until it stops returning 0. It is also possible for a filter to
6070 * output fewer packets than were sent to it, so this function may return
6071 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6073 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6076 * Free a bitstream filter context and everything associated with it; write NULL
6077 * into the supplied pointer.
6079 void av_bsf_free(AVBSFContext **ctx);
6082 * Get the AVClass for AVBSFContext. It can be used in combination with
6083 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6085 * @see av_opt_find().
6087 const AVClass *av_bsf_get_class(void);
6090 * Structure for chain/list of bitstream filters.
6091 * Empty list can be allocated by av_bsf_list_alloc().
6093 typedef struct AVBSFList AVBSFList;
6096 * Allocate empty list of bitstream filters.
6097 * The list must be later freed by av_bsf_list_free()
6098 * or finalized by av_bsf_list_finalize().
6100 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6102 AVBSFList *av_bsf_list_alloc(void);
6105 * Free list of bitstream filters.
6107 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6109 void av_bsf_list_free(AVBSFList **lst);
6112 * Append bitstream filter to the list of bitstream filters.
6114 * @param lst List to append to
6115 * @param bsf Filter context to be appended
6117 * @return >=0 on success, negative AVERROR in case of failure
6119 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6122 * Construct new bitstream filter context given it's name and options
6123 * and append it to the list of bitstream filters.
6125 * @param lst List to append to
6126 * @param bsf_name Name of the bitstream filter
6127 * @param options Options for the bitstream filter, can be set to NULL
6129 * @return >=0 on success, negative AVERROR in case of failure
6131 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6133 * Finalize list of bitstream filters.
6135 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6136 * so the whole chain of bitstream filters can be treated as single filter
6137 * freshly allocated by av_bsf_alloc().
6138 * If the call is successful, @ref AVBSFList structure is freed and lst
6139 * will be set to NULL. In case of failure, caller is responsible for
6140 * freeing the structure by av_bsf_list_free()
6142 * @param lst Filter list structure to be transformed
6143 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6144 * representing the chain of bitstream filters
6146 * @return >=0 on success, negative AVERROR in case of failure
6148 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6151 * Parse string describing list of bitstream filters and create single
6152 * @ref AVBSFContext describing the whole chain of bitstream filters.
6153 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6154 * allocated by av_bsf_alloc().
6156 * @param str String describing chain of bitstream filters in format
6157 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6158 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6159 * representing the chain of bitstream filters
6161 * @return >=0 on success, negative AVERROR in case of failure
6163 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6166 * Get null/pass-through bitstream filter.
6168 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6172 int av_bsf_get_null_filter(AVBSFContext **bsf);
6177 * Same behaviour av_fast_malloc but the buffer has additional
6178 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6180 * In addition the whole buffer will initially and after resizes
6181 * be 0-initialized so that no uninitialized data will ever appear.
6183 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6186 * Same behaviour av_fast_padded_malloc except that buffer will always
6187 * be 0-initialized after call.
6189 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6192 * Encode extradata length to a buffer. Used by xiph codecs.
6194 * @param s buffer to write to; must be at least (v/255+1) bytes long
6195 * @param v size of extradata in bytes
6196 * @return number of bytes written to the buffer.
6198 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6200 #if FF_API_MISSING_SAMPLE
6202 * Log a generic warning message about a missing feature. This function is
6203 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6204 * only, and would normally not be used by applications.
6205 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6206 * a pointer to an AVClass struct
6207 * @param[in] feature string containing the name of the missing feature
6208 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
6209 * If want_sample is non-zero, additional verbiage will be added to the log
6210 * message which tells the user how to report samples to the development
6212 * @deprecated Use avpriv_report_missing_feature() instead.
6214 attribute_deprecated
6215 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
6218 * Log a generic warning message asking for a sample. This function is
6219 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6220 * only, and would normally not be used by applications.
6221 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6222 * a pointer to an AVClass struct
6223 * @param[in] msg string containing an optional message, or NULL if no message
6224 * @deprecated Use avpriv_request_sample() instead.
6226 attribute_deprecated
6227 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
6228 #endif /* FF_API_MISSING_SAMPLE */
6231 * Register the hardware accelerator hwaccel.
6233 void av_register_hwaccel(AVHWAccel *hwaccel);
6236 * If hwaccel is NULL, returns the first registered hardware accelerator,
6237 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6238 * after hwaccel, or NULL if hwaccel is the last one.
6240 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6244 * Lock operation used by lockmgr
6247 AV_LOCK_CREATE, ///< Create a mutex
6248 AV_LOCK_OBTAIN, ///< Lock the mutex
6249 AV_LOCK_RELEASE, ///< Unlock the mutex
6250 AV_LOCK_DESTROY, ///< Free mutex resources
6254 * Register a user provided lock manager supporting the operations
6255 * specified by AVLockOp. The "mutex" argument to the function points
6256 * to a (void *) where the lockmgr should store/get a pointer to a user
6257 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6258 * value left by the last call for all other ops. If the lock manager is
6259 * unable to perform the op then it should leave the mutex in the same
6260 * state as when it was called and return a non-zero value. However,
6261 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6262 * have been successfully destroyed. If av_lockmgr_register succeeds
6263 * it will return a non-negative value, if it fails it will return a
6264 * negative value and destroy all mutex and unregister all callbacks.
6265 * av_lockmgr_register is not thread-safe, it must be called from a
6266 * single thread before any calls which make use of locking are used.
6268 * @param cb User defined callback. av_lockmgr_register invokes calls
6269 * to this callback and the previously registered callback.
6270 * The callback will be used to create more than one mutex
6271 * each of which must be backed by its own underlying locking
6272 * mechanism (i.e. do not use a single static object to
6273 * implement your lock manager). If cb is set to NULL the
6274 * lockmgr will be unregistered.
6276 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6279 * Get the type of the given codec.
6281 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6284 * Get the name of a codec.
6285 * @return a static string identifying the codec; never NULL
6287 const char *avcodec_get_name(enum AVCodecID id);
6290 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6291 * with no corresponding avcodec_close()), 0 otherwise.
6293 int avcodec_is_open(AVCodecContext *s);
6296 * @return a non-zero number if codec is an encoder, zero otherwise
6298 int av_codec_is_encoder(const AVCodec *codec);
6301 * @return a non-zero number if codec is a decoder, zero otherwise
6303 int av_codec_is_decoder(const AVCodec *codec);
6306 * @return descriptor for given codec ID or NULL if no descriptor exists.
6308 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6311 * Iterate over all codec descriptors known to libavcodec.
6313 * @param prev previous descriptor. NULL to get the first descriptor.
6315 * @return next descriptor or NULL after the last descriptor
6317 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6320 * @return codec descriptor with the given name or NULL if no such descriptor
6323 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6326 * Allocate a CPB properties structure and initialize its fields to default
6329 * @param size if non-NULL, the size of the allocated struct will be written
6330 * here. This is useful for embedding it in side data.
6332 * @return the newly allocated struct or NULL on failure
6334 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6340 #endif /* AVCODEC_AVCODEC_H */