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/hwcontext.h"
40 #include "libavutil/log.h"
41 #include "libavutil/pixfmt.h"
42 #include "libavutil/rational.h"
47 * @defgroup libavc libavcodec
48 * Encoding/Decoding Library
52 * @defgroup lavc_decoding Decoding
56 * @defgroup lavc_encoding Encoding
60 * @defgroup lavc_codec Codecs
62 * @defgroup lavc_codec_native Native Codecs
65 * @defgroup lavc_codec_wrappers External library wrappers
68 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
72 * @defgroup lavc_internal Internal
80 * @defgroup lavc_encdec send/receive encoding and decoding API overview
83 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
84 * avcodec_receive_packet() functions provide an encode/decode API, which
85 * decouples input and output.
87 * The API is very similar for encoding/decoding and audio/video, and works as
89 * - Set up and open the AVCodecContext as usual.
91 * - For decoding, call avcodec_send_packet() to give the decoder raw
92 * compressed data in an AVPacket.
93 * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
94 * containing uncompressed audio or video.
95 * In both cases, it is recommended that AVPackets and AVFrames are
96 * refcounted, or libavcodec might have to copy the input data. (libavformat
97 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
98 * refcounted AVFrames.)
99 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
100 * functions and process their output:
101 * - For decoding, call avcodec_receive_frame(). On success, it will return
102 * an AVFrame containing uncompressed audio or video data.
103 * - For encoding, call avcodec_receive_packet(). On success, it will return
104 * an AVPacket with a compressed frame.
105 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
106 * AVERROR(EAGAIN) return value means that new input data is required to
107 * return new output. In this case, continue with sending input. For each
108 * input frame/packet, the codec will typically return 1 output frame/packet,
109 * but it can also be 0 or more than 1.
111 * At the beginning of decoding or encoding, the codec might accept multiple
112 * input frames/packets without returning a frame, until its internal buffers
113 * are filled. This situation is handled transparently if you follow the steps
116 * In theory, sending input can result in EAGAIN - this should happen only if
117 * not all output was received. You can use this to structure alternative decode
118 * or encode loops other than the one suggested above. For example, you could
119 * try sending new input on each iteration, and try to receive output if that
122 * End of stream situations. These require "flushing" (aka draining) the codec,
123 * as the codec might buffer multiple frames or packets internally for
124 * performance or out of necessity (consider B-frames).
125 * This is handled as follows:
126 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
127 * or avcodec_send_frame() (encoding) functions. This will enter draining
129 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
130 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
131 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
132 * - Before decoding can be resumed again, the codec has to be reset with
133 * avcodec_flush_buffers().
135 * Using the API as outlined above is highly recommended. But it is also
136 * possible to call functions outside of this rigid schema. For example, you can
137 * call avcodec_send_packet() repeatedly without calling
138 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
139 * until the codec's internal buffer has been filled up (which is typically of
140 * size 1 per output frame, after initial input), and then reject input with
141 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
142 * read at least some output.
144 * Not all codecs will follow a rigid and predictable dataflow; the only
145 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
146 * one end implies that a receive/send call on the other end will succeed, or
147 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
148 * permit unlimited buffering of input or output.
150 * This API replaces the following legacy functions:
151 * - avcodec_decode_video2() and avcodec_decode_audio4():
152 * Use avcodec_send_packet() to feed input to the decoder, then use
153 * avcodec_receive_frame() to receive decoded frames after each packet.
154 * Unlike with the old video decoding API, multiple frames might result from
155 * a packet. For audio, splitting the input packet into frames by partially
156 * decoding packets becomes transparent to the API user. You never need to
157 * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
158 * no data was read from the packet).
159 * Additionally, sending a flush/draining packet is required only once.
160 * - avcodec_encode_video2()/avcodec_encode_audio2():
161 * Use avcodec_send_frame() to feed input to the encoder, then use
162 * avcodec_receive_packet() to receive encoded packets.
163 * Providing user-allocated buffers for avcodec_receive_packet() is not
165 * - The new API does not handle subtitles yet.
167 * Mixing new and old function calls on the same AVCodecContext is not allowed,
168 * and will result in undefined behavior.
170 * Some codecs might require using the new API; using the old API will return
171 * an error when calling it. All codecs support the new API.
173 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
174 * would be an invalid state, which could put the codec user into an endless
175 * loop. The API has no concept of time either: it cannot happen that trying to
176 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
177 * later accepts the packet (with no other receive/flush API calls involved).
178 * The API is a strict state machine, and the passage of time is not supposed
179 * to influence it. Some timing-dependent behavior might still be deemed
180 * acceptable in certain cases. But it must never result in both send/receive
181 * returning EAGAIN at the same time at any point. It must also absolutely be
182 * avoided that the current state is "unstable" and can "flip-flop" between
183 * the send/receive APIs allowing progress. For example, it's not allowed that
184 * the codec randomly decides that it actually wants to consume a packet now
185 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
186 * avcodec_send_packet() call.
191 * @defgroup lavc_core Core functions/structures.
194 * Basic definitions, functions for querying libavcodec capabilities,
195 * allocating core structures, etc.
201 * Identify the syntax and semantics of the bitstream.
202 * The principle is roughly:
203 * Two decoders with the same ID can decode the same streams.
204 * Two encoders with the same ID can encode compatible streams.
205 * There may be slight deviations from the principle due to implementation
208 * If you add a codec ID to this list, add it so that
209 * 1. no value of an existing codec ID changes (that would break ABI),
210 * 2. it is as close as possible to similar codecs
212 * After adding new codec IDs, do not forget to add an entry to the codec
213 * descriptor list and bump libavcodec minor version.
219 AV_CODEC_ID_MPEG1VIDEO,
220 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
231 AV_CODEC_ID_RAWVIDEO,
232 AV_CODEC_ID_MSMPEG4V1,
233 AV_CODEC_ID_MSMPEG4V2,
234 AV_CODEC_ID_MSMPEG4V3,
257 AV_CODEC_ID_INTERPLAY_VIDEO,
264 AV_CODEC_ID_MSVIDEO1,
269 AV_CODEC_ID_TRUEMOTION1,
270 AV_CODEC_ID_VMDVIDEO,
295 AV_CODEC_ID_TRUEMOTION2,
301 AV_CODEC_ID_SMACKVIDEO,
306 AV_CODEC_ID_JPEG2000,
312 AV_CODEC_ID_DSICINVIDEO,
313 AV_CODEC_ID_TIERTEXSEQVIDEO,
321 AV_CODEC_ID_BETHSOFTVID,
333 AV_CODEC_ID_ESCAPE124,
337 AV_CODEC_ID_MOTIONPIXELS,
349 AV_CODEC_ID_FLASHSV2,
350 AV_CODEC_ID_CDGRAPHICS,
353 AV_CODEC_ID_BINKVIDEO,
354 AV_CODEC_ID_IFF_ILBM,
355 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
361 AV_CODEC_ID_A64_MULTI,
362 AV_CODEC_ID_A64_MULTI5,
365 AV_CODEC_ID_LAGARITH,
369 AV_CODEC_ID_WMV3IMAGE,
370 AV_CODEC_ID_VC1IMAGE,
372 AV_CODEC_ID_BMV_VIDEO,
379 AV_CODEC_ID_ZEROCODEC,
388 AV_CODEC_ID_ESCAPE130,
391 AV_CODEC_ID_HNM4_VIDEO,
393 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
395 AV_CODEC_ID_ALIAS_PIX,
396 AV_CODEC_ID_BRENDER_PIX,
397 AV_CODEC_ID_PAF_VIDEO,
410 AV_CODEC_ID_SCREENPRESSO,
414 AV_CODEC_ID_Y41P = 0x8000,
419 AV_CODEC_ID_TARGA_Y216,
431 AV_CODEC_ID_TRUEMOTION2RT,
433 AV_CODEC_ID_MAGICYUV,
434 AV_CODEC_ID_SHEERVIDEO,
441 AV_CODEC_ID_CLEARVIDEO,
444 AV_CODEC_ID_BITPACKED,
451 AV_CODEC_ID_PROSUMER,
456 /* various PCM "codecs" */
457 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
458 AV_CODEC_ID_PCM_S16LE = 0x10000,
459 AV_CODEC_ID_PCM_S16BE,
460 AV_CODEC_ID_PCM_U16LE,
461 AV_CODEC_ID_PCM_U16BE,
464 AV_CODEC_ID_PCM_MULAW,
465 AV_CODEC_ID_PCM_ALAW,
466 AV_CODEC_ID_PCM_S32LE,
467 AV_CODEC_ID_PCM_S32BE,
468 AV_CODEC_ID_PCM_U32LE,
469 AV_CODEC_ID_PCM_U32BE,
470 AV_CODEC_ID_PCM_S24LE,
471 AV_CODEC_ID_PCM_S24BE,
472 AV_CODEC_ID_PCM_U24LE,
473 AV_CODEC_ID_PCM_U24BE,
474 AV_CODEC_ID_PCM_S24DAUD,
475 AV_CODEC_ID_PCM_ZORK,
476 AV_CODEC_ID_PCM_S16LE_PLANAR,
478 AV_CODEC_ID_PCM_F32BE,
479 AV_CODEC_ID_PCM_F32LE,
480 AV_CODEC_ID_PCM_F64BE,
481 AV_CODEC_ID_PCM_F64LE,
482 AV_CODEC_ID_PCM_BLURAY,
485 AV_CODEC_ID_PCM_S8_PLANAR,
486 AV_CODEC_ID_PCM_S24LE_PLANAR,
487 AV_CODEC_ID_PCM_S32LE_PLANAR,
488 AV_CODEC_ID_PCM_S16BE_PLANAR,
490 AV_CODEC_ID_PCM_S64LE = 0x10800,
491 AV_CODEC_ID_PCM_S64BE,
492 AV_CODEC_ID_PCM_F16LE,
493 AV_CODEC_ID_PCM_F24LE,
494 AV_CODEC_ID_PCM_VIDC,
496 /* various ADPCM codecs */
497 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
498 AV_CODEC_ID_ADPCM_IMA_WAV,
499 AV_CODEC_ID_ADPCM_IMA_DK3,
500 AV_CODEC_ID_ADPCM_IMA_DK4,
501 AV_CODEC_ID_ADPCM_IMA_WS,
502 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
503 AV_CODEC_ID_ADPCM_MS,
504 AV_CODEC_ID_ADPCM_4XM,
505 AV_CODEC_ID_ADPCM_XA,
506 AV_CODEC_ID_ADPCM_ADX,
507 AV_CODEC_ID_ADPCM_EA,
508 AV_CODEC_ID_ADPCM_G726,
509 AV_CODEC_ID_ADPCM_CT,
510 AV_CODEC_ID_ADPCM_SWF,
511 AV_CODEC_ID_ADPCM_YAMAHA,
512 AV_CODEC_ID_ADPCM_SBPRO_4,
513 AV_CODEC_ID_ADPCM_SBPRO_3,
514 AV_CODEC_ID_ADPCM_SBPRO_2,
515 AV_CODEC_ID_ADPCM_THP,
516 AV_CODEC_ID_ADPCM_IMA_AMV,
517 AV_CODEC_ID_ADPCM_EA_R1,
518 AV_CODEC_ID_ADPCM_EA_R3,
519 AV_CODEC_ID_ADPCM_EA_R2,
520 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
521 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
522 AV_CODEC_ID_ADPCM_EA_XAS,
523 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
524 AV_CODEC_ID_ADPCM_IMA_ISS,
525 AV_CODEC_ID_ADPCM_G722,
526 AV_CODEC_ID_ADPCM_IMA_APC,
527 AV_CODEC_ID_ADPCM_VIMA,
529 AV_CODEC_ID_ADPCM_AFC = 0x11800,
530 AV_CODEC_ID_ADPCM_IMA_OKI,
531 AV_CODEC_ID_ADPCM_DTK,
532 AV_CODEC_ID_ADPCM_IMA_RAD,
533 AV_CODEC_ID_ADPCM_G726LE,
534 AV_CODEC_ID_ADPCM_THP_LE,
535 AV_CODEC_ID_ADPCM_PSX,
536 AV_CODEC_ID_ADPCM_AICA,
537 AV_CODEC_ID_ADPCM_IMA_DAT4,
538 AV_CODEC_ID_ADPCM_MTAF,
541 AV_CODEC_ID_AMR_NB = 0x12000,
544 /* RealAudio codecs*/
545 AV_CODEC_ID_RA_144 = 0x13000,
548 /* various DPCM codecs */
549 AV_CODEC_ID_ROQ_DPCM = 0x14000,
550 AV_CODEC_ID_INTERPLAY_DPCM,
551 AV_CODEC_ID_XAN_DPCM,
552 AV_CODEC_ID_SOL_DPCM,
554 AV_CODEC_ID_SDX2_DPCM = 0x14800,
555 AV_CODEC_ID_GREMLIN_DPCM,
558 AV_CODEC_ID_MP2 = 0x15000,
559 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
569 AV_CODEC_ID_VMDAUDIO,
575 AV_CODEC_ID_WESTWOOD_SND1,
576 AV_CODEC_ID_GSM, ///< as in Berlin toast format
579 AV_CODEC_ID_TRUESPEECH,
581 AV_CODEC_ID_SMACKAUDIO,
584 AV_CODEC_ID_DSICINAUDIO,
586 AV_CODEC_ID_MUSEPACK7,
588 AV_CODEC_ID_GSM_MS, /* as found in WAV */
591 AV_CODEC_ID_NELLYMOSER,
592 AV_CODEC_ID_MUSEPACK8,
594 AV_CODEC_ID_WMAVOICE,
596 AV_CODEC_ID_WMALOSSLESS,
605 AV_CODEC_ID_BINKAUDIO_RDFT,
606 AV_CODEC_ID_BINKAUDIO_DCT,
607 AV_CODEC_ID_AAC_LATM,
612 AV_CODEC_ID_8SVX_EXP,
613 AV_CODEC_ID_8SVX_FIB,
614 AV_CODEC_ID_BMV_AUDIO,
619 AV_CODEC_ID_COMFORT_NOISE,
621 AV_CODEC_ID_METASOUND,
622 AV_CODEC_ID_PAF_AUDIO,
627 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
629 AV_CODEC_ID_SONIC_LS,
632 AV_CODEC_ID_DSD_LSBF,
633 AV_CODEC_ID_DSD_MSBF,
634 AV_CODEC_ID_DSD_LSBF_PLANAR,
635 AV_CODEC_ID_DSD_MSBF_PLANAR,
637 AV_CODEC_ID_INTERPLAY_ACM,
641 AV_CODEC_ID_ATRAC3AL,
642 AV_CODEC_ID_ATRAC3PAL,
649 /* subtitle codecs */
650 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
651 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
652 AV_CODEC_ID_DVB_SUBTITLE,
653 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
656 AV_CODEC_ID_MOV_TEXT,
657 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
658 AV_CODEC_ID_DVB_TELETEXT,
661 AV_CODEC_ID_MICRODVD = 0x17800,
665 AV_CODEC_ID_REALTEXT,
667 AV_CODEC_ID_SUBVIEWER1,
668 AV_CODEC_ID_SUBVIEWER,
675 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
678 /* other specific kind of codecs (generally used for attachments) */
679 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
680 AV_CODEC_ID_TTF = 0x18000,
682 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
683 AV_CODEC_ID_BINTEXT = 0x18800,
687 AV_CODEC_ID_SMPTE_KLV,
689 AV_CODEC_ID_TIMED_ID3,
690 AV_CODEC_ID_BIN_DATA,
693 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
695 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
696 * stream (only used by libavformat) */
697 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
698 * stream (only used by libavformat) */
699 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
700 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
704 * This struct describes the properties of a single codec described by an
706 * @see avcodec_descriptor_get()
708 typedef struct AVCodecDescriptor {
710 enum AVMediaType type;
712 * Name of the codec described by this descriptor. It is non-empty and
713 * unique for each codec descriptor. It should contain alphanumeric
714 * characters and '_' only.
718 * A more descriptive name for this codec. May be NULL.
720 const char *long_name;
722 * Codec properties, a combination of AV_CODEC_PROP_* flags.
726 * MIME type(s) associated with the codec.
727 * May be NULL; if not, a NULL-terminated array of MIME types.
728 * The first item is always non-NULL and is the preferred MIME type.
730 const char *const *mime_types;
732 * If non-NULL, an array of profiles recognized for this codec.
733 * Terminated with FF_PROFILE_UNKNOWN.
735 const struct AVProfile *profiles;
739 * Codec uses only intra compression.
740 * Video and audio codecs only.
742 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
744 * Codec supports lossy compression. Audio and video codecs only.
745 * @note a codec may support both lossy and lossless
748 #define AV_CODEC_PROP_LOSSY (1 << 1)
750 * Codec supports lossless compression. Audio and video codecs only.
752 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
754 * Codec supports frame reordering. That is, the coded order (the order in which
755 * the encoded packets are output by the encoders / stored / input to the
756 * decoders) may be different from the presentation order of the corresponding
759 * For codecs that do not have this property set, PTS and DTS should always be
762 #define AV_CODEC_PROP_REORDER (1 << 3)
764 * Subtitle codec is bitmap based
765 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
767 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
769 * Subtitle codec is text based.
770 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
772 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
775 * @ingroup lavc_decoding
776 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
777 * This is mainly needed because some optimized bitstream readers read
778 * 32 or 64 bit at once and could read over the end.<br>
779 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
780 * MPEG bitstreams could cause overread and segfault.
782 #define AV_INPUT_BUFFER_PADDING_SIZE 64
785 * @ingroup lavc_encoding
786 * minimum encoding buffer size
787 * Used to avoid some checks during header writing.
789 #define AV_INPUT_BUFFER_MIN_SIZE 16384
792 * @ingroup lavc_decoding
795 /* We leave some space between them for extensions (drop some
796 * keyframes for intra-only or drop just some bidir frames). */
797 AVDISCARD_NONE =-16, ///< discard nothing
798 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
799 AVDISCARD_NONREF = 8, ///< discard all non reference
800 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
801 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
802 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
803 AVDISCARD_ALL = 48, ///< discard all
806 enum AVAudioServiceType {
807 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
808 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
809 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
810 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
811 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
812 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
813 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
814 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
815 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
816 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
820 * @ingroup lavc_encoding
822 typedef struct RcOverride{
825 int qscale; // If this is 0 then quality_factor will be used instead.
826 float quality_factor;
830 These flags can be passed in AVCodecContext.flags before initialization.
831 Note: Not everything is supported yet.
835 * Allow decoders to produce frames with data planes that are not aligned
836 * to CPU requirements (e.g. due to cropping).
838 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
842 #define AV_CODEC_FLAG_QSCALE (1 << 1)
844 * 4 MV per MB allowed / advanced prediction for H.263.
846 #define AV_CODEC_FLAG_4MV (1 << 2)
848 * Output even those frames that might be corrupted.
850 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
854 #define AV_CODEC_FLAG_QPEL (1 << 4)
856 * Use internal 2pass ratecontrol in first pass mode.
858 #define AV_CODEC_FLAG_PASS1 (1 << 9)
860 * Use internal 2pass ratecontrol in second pass mode.
862 #define AV_CODEC_FLAG_PASS2 (1 << 10)
866 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
868 * Only decode/encode grayscale.
870 #define AV_CODEC_FLAG_GRAY (1 << 13)
872 * error[?] variables will be set during encoding.
874 #define AV_CODEC_FLAG_PSNR (1 << 15)
876 * Input bitstream might be truncated at a random location
877 * instead of only at frame boundaries.
879 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
881 * Use interlaced DCT.
883 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
887 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
889 * Place global headers in extradata instead of every keyframe.
891 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
893 * Use only bitexact stuff (except (I)DCT).
895 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
896 /* Fx : Flag for H.263+ extra options */
898 * H.263 advanced intra coding / MPEG-4 AC prediction
900 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
902 * interlaced motion estimation
904 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
905 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
908 * Allow non spec compliant speedup tricks.
910 #define AV_CODEC_FLAG2_FAST (1 << 0)
912 * Skip bitstream encoding.
914 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
916 * Place global headers at every keyframe instead of in extradata.
918 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
921 * timecode is in drop frame format. DEPRECATED!!!!
923 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
926 * Input bitstream might be truncated at a packet boundaries
927 * instead of only at frame boundaries.
929 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
931 * Discard cropping information from SPS.
933 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
936 * Show all frames before the first keyframe
938 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
940 * Export motion vectors through frame side data
942 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
944 * Do not skip samples and export skip information as frame side data
946 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
948 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
950 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
952 /* Unsupported options :
953 * Syntax Arithmetic coding (SAC)
954 * Reference Picture Selection
955 * Independent Segment Decoding */
957 /* codec capabilities */
960 * Decoder can use draw_horiz_band callback.
962 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
964 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
965 * If not set, it might not use get_buffer() at all or use operations that
966 * assume the buffer was allocated by avcodec_default_get_buffer.
968 #define AV_CODEC_CAP_DR1 (1 << 1)
969 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
971 * Encoder or decoder requires flushing with NULL input at the end in order to
972 * give the complete and correct output.
974 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
975 * with NULL data. The user can still send NULL data to the public encode
976 * or decode function, but libavcodec will not pass it along to the codec
977 * unless this flag is set.
980 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
981 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
985 * The encoder needs to be fed with NULL data at the end of encoding until the
986 * encoder no longer returns data.
988 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
989 * flag also means that the encoder must set the pts and duration for
990 * each output packet. If this flag is not set, the pts and duration will
991 * be determined by libavcodec from the input frame.
993 #define AV_CODEC_CAP_DELAY (1 << 5)
995 * Codec can be fed a final frame with a smaller size.
996 * This can be used to prevent truncation of the last audio samples.
998 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1001 * Codec can output multiple frames per AVPacket
1002 * Normally demuxers return one frame at a time, demuxers which do not do
1003 * are connected to a parser to split what they return into proper frames.
1004 * This flag is reserved to the very rare category of codecs which have a
1005 * bitstream that cannot be split into frames without timeconsuming
1006 * operations like full decoding. Demuxers carrying such bitstreams thus
1007 * may return multiple frames in a packet. This has many disadvantages like
1008 * prohibiting stream copy in many cases thus it should only be considered
1011 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1013 * Codec is experimental and is thus avoided in favor of non experimental
1016 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1018 * Codec should fill in channel configuration and samplerate instead of container
1020 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1022 * Codec supports frame-level multithreading.
1024 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1026 * Codec supports slice-based (or partition-based) multithreading.
1028 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1030 * Codec supports changed parameters at any point.
1032 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1034 * Codec supports avctx->thread_count == 0 (auto).
1036 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1038 * Audio encoder supports receiving a different number of samples in each call.
1040 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1042 * Decoder is not a preferred choice for probing.
1043 * This indicates that the decoder is not a good choice for probing.
1044 * It could for example be an expensive to spin up hardware decoder,
1045 * or it could simply not provide a lot of useful information about
1047 * A decoder marked with this flag should only be used as last resort
1048 * choice for probing.
1050 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1052 * Codec is intra only.
1054 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1056 * Codec is lossless.
1058 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1061 * Codec is backed by a hardware implementation. Typically used to
1062 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
1063 * avcodec_get_hw_config() instead.
1065 #define AV_CODEC_CAP_HARDWARE (1 << 18)
1068 * Codec is potentially backed by a hardware implementation, but not
1069 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
1070 * implementation provides some sort of internal fallback.
1072 #define AV_CODEC_CAP_HYBRID (1 << 19)
1075 * This codec takes the reordered_opaque field from input AVFrames
1076 * and returns it in the corresponding field in AVCodecContext after
1079 #define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE (1 << 20)
1083 * This specifies the area which should be displayed.
1084 * Note there may be multiple such areas for one frame.
1086 typedef struct AVPanScan {
1089 * - encoding: Set by user.
1090 * - decoding: Set by libavcodec.
1095 * width and height in 1/16 pel
1096 * - encoding: Set by user.
1097 * - decoding: Set by libavcodec.
1103 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1104 * - encoding: Set by user.
1105 * - decoding: Set by libavcodec.
1107 int16_t position[3][2];
1111 * This structure describes the bitrate properties of an encoded bitstream. It
1112 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1113 * parameters for H.264/HEVC.
1115 typedef struct AVCPBProperties {
1117 * Maximum bitrate of the stream, in bits per second.
1118 * Zero if unknown or unspecified.
1122 * Minimum bitrate of the stream, in bits per second.
1123 * Zero if unknown or unspecified.
1127 * Average bitrate of the stream, in bits per second.
1128 * Zero if unknown or unspecified.
1133 * The size of the buffer to which the ratecontrol is applied, in bits.
1134 * Zero if unknown or unspecified.
1139 * The delay between the time the packet this structure is associated with
1140 * is received and the time when it should be decoded, in periods of a 27MHz
1143 * UINT64_MAX when unknown or unspecified.
1149 * The decoder will keep a reference to the frame and may reuse it later.
1151 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1154 * @defgroup lavc_packet AVPacket
1156 * Types and functions for working with AVPacket.
1159 enum AVPacketSideDataType {
1161 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1162 * bytes worth of palette. This side data signals that a new palette is
1165 AV_PKT_DATA_PALETTE,
1168 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1169 * that the extradata buffer was changed and the receiving side should
1170 * act upon it appropriately. The new extradata is embedded in the side
1171 * data buffer and should be immediately used for processing the current
1174 AV_PKT_DATA_NEW_EXTRADATA,
1177 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1180 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1181 * s32le channel_count
1182 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1183 * u64le channel_layout
1184 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1186 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1191 AV_PKT_DATA_PARAM_CHANGE,
1194 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1195 * structures with info about macroblocks relevant to splitting the
1196 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1197 * That is, it does not necessarily contain info about all macroblocks,
1198 * as long as the distance between macroblocks in the info is smaller
1199 * than the target payload size.
1200 * Each MB info structure is 12 bytes, and is laid out as follows:
1202 * u32le bit offset from the start of the packet
1203 * u8 current quantizer at the start of the macroblock
1205 * u16le macroblock address within the GOB
1206 * u8 horizontal MV predictor
1207 * u8 vertical MV predictor
1208 * u8 horizontal MV predictor for block number 3
1209 * u8 vertical MV predictor for block number 3
1212 AV_PKT_DATA_H263_MB_INFO,
1215 * This side data should be associated with an audio stream and contains
1216 * ReplayGain information in form of the AVReplayGain struct.
1218 AV_PKT_DATA_REPLAYGAIN,
1221 * This side data contains a 3x3 transformation matrix describing an affine
1222 * transformation that needs to be applied to the decoded video frames for
1223 * correct presentation.
1225 * See libavutil/display.h for a detailed description of the data.
1227 AV_PKT_DATA_DISPLAYMATRIX,
1230 * This side data should be associated with a video stream and contains
1231 * Stereoscopic 3D information in form of the AVStereo3D struct.
1233 AV_PKT_DATA_STEREO3D,
1236 * This side data should be associated with an audio stream and corresponds
1237 * to enum AVAudioServiceType.
1239 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1242 * This side data contains quality related information from the encoder.
1244 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1248 * u64le[error count] sum of squared differences between encoder in and output
1251 AV_PKT_DATA_QUALITY_STATS,
1254 * This side data contains an integer value representing the stream index
1255 * of a "fallback" track. A fallback track indicates an alternate
1256 * track to use when the current track can not be decoded for some reason.
1257 * e.g. no decoder available for codec.
1259 AV_PKT_DATA_FALLBACK_TRACK,
1262 * This side data corresponds to the AVCPBProperties struct.
1264 AV_PKT_DATA_CPB_PROPERTIES,
1267 * Recommmends skipping the specified number of samples
1269 * u32le number of samples to skip from start of this packet
1270 * u32le number of samples to skip from end of this packet
1271 * u8 reason for start skip
1272 * u8 reason for end skip (0=padding silence, 1=convergence)
1275 AV_PKT_DATA_SKIP_SAMPLES,
1278 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1279 * the packet may contain "dual mono" audio specific to Japanese DTV
1280 * and if it is true, recommends only the selected channel to be used.
1282 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1285 AV_PKT_DATA_JP_DUALMONO,
1288 * A list of zero terminated key/value strings. There is no end marker for
1289 * the list, so it is required to rely on the side data size to stop.
1291 AV_PKT_DATA_STRINGS_METADATA,
1294 * Subtitle event position
1302 AV_PKT_DATA_SUBTITLE_POSITION,
1305 * Data found in BlockAdditional element of matroska container. There is
1306 * no end marker for the data, so it is required to rely on the side data
1307 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1310 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1313 * The optional first identifier line of a WebVTT cue.
1315 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1318 * The optional settings (rendering instructions) that immediately
1319 * follow the timestamp specifier of a WebVTT cue.
1321 AV_PKT_DATA_WEBVTT_SETTINGS,
1324 * A list of zero terminated key/value strings. There is no end marker for
1325 * the list, so it is required to rely on the side data size to stop. This
1326 * side data includes updated metadata which appeared in the stream.
1328 AV_PKT_DATA_METADATA_UPDATE,
1331 * MPEGTS stream ID as uint8_t, this is required to pass the stream ID
1332 * information from the demuxer to the corresponding muxer.
1334 AV_PKT_DATA_MPEGTS_STREAM_ID,
1337 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1338 * should be associated with a video stream and contains data in the form
1339 * of the AVMasteringDisplayMetadata struct.
1341 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1344 * This side data should be associated with a video stream and corresponds
1345 * to the AVSphericalMapping structure.
1347 AV_PKT_DATA_SPHERICAL,
1350 * Content light level (based on CTA-861.3). This metadata should be
1351 * associated with a video stream and contains data in the form of the
1352 * AVContentLightMetadata struct.
1354 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1357 * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1358 * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1359 * The number of bytes of CC data is AVPacketSideData.size.
1364 * This side data is encryption initialization data.
1365 * The format is not part of ABI, use av_encryption_init_info_* methods to
1368 AV_PKT_DATA_ENCRYPTION_INIT_INFO,
1371 * This side data contains encryption info for how to decrypt the packet.
1372 * The format is not part of ABI, use av_encryption_info_* methods to access.
1374 AV_PKT_DATA_ENCRYPTION_INFO,
1377 * Active Format Description data consisting of a single byte as specified
1378 * in ETSI TS 101 154 using AVActiveFormatDescription enum.
1383 * The number of side data types.
1384 * This is not part of the public API/ABI in the sense that it may
1385 * change when new side data types are added.
1386 * This must stay the last enum value.
1387 * If its value becomes huge, some code using it
1388 * needs to be updated as it assumes it to be smaller than other limits.
1393 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1395 typedef struct AVPacketSideData {
1398 enum AVPacketSideDataType type;
1402 * This structure stores compressed data. It is typically exported by demuxers
1403 * and then passed as input to decoders, or received as output from encoders and
1404 * then passed to muxers.
1406 * For video, it should typically contain one compressed frame. For audio it may
1407 * contain several compressed frames. Encoders are allowed to output empty
1408 * packets, with no compressed data, containing only side data
1409 * (e.g. to update some stream parameters at the end of encoding).
1411 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1412 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1413 * without libavcodec and libavformat major bump.
1415 * The semantics of data ownership depends on the buf field.
1416 * If it is set, the packet data is dynamically allocated and is
1417 * valid indefinitely until a call to av_packet_unref() reduces the
1418 * reference count to 0.
1420 * If the buf field is not set av_packet_ref() would make a copy instead
1421 * of increasing the reference count.
1423 * The side data is always allocated with av_malloc(), copied by
1424 * av_packet_ref() and freed by av_packet_unref().
1426 * @see av_packet_ref
1427 * @see av_packet_unref
1429 typedef struct AVPacket {
1431 * A reference to the reference-counted buffer where the packet data is
1433 * May be NULL, then the packet data is not reference-counted.
1437 * Presentation timestamp in AVStream->time_base units; the time at which
1438 * the decompressed packet will be presented to the user.
1439 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1440 * pts MUST be larger or equal to dts as presentation cannot happen before
1441 * decompression, unless one wants to view hex dumps. Some formats misuse
1442 * the terms dts and pts/cts to mean something different. Such timestamps
1443 * must be converted to true pts/dts before they are stored in AVPacket.
1447 * Decompression timestamp in AVStream->time_base units; the time at which
1448 * the packet is decompressed.
1449 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1456 * A combination of AV_PKT_FLAG values
1460 * Additional packet data that can be provided by the container.
1461 * Packet can contain several types of side information.
1463 AVPacketSideData *side_data;
1464 int side_data_elems;
1467 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1468 * Equals next_pts - this_pts in presentation order.
1472 int64_t pos; ///< byte position in stream, -1 if unknown
1474 #if FF_API_CONVERGENCE_DURATION
1476 * @deprecated Same as the duration field, but as int64_t. This was required
1477 * for Matroska subtitles, whose duration values could overflow when the
1478 * duration field was still an int.
1480 attribute_deprecated
1481 int64_t convergence_duration;
1484 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1485 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1487 * Flag is used to discard packets which are required to maintain valid
1488 * decoder state but are not required for output and should be dropped
1491 #define AV_PKT_FLAG_DISCARD 0x0004
1493 * The packet comes from a trusted source.
1495 * Otherwise-unsafe constructs such as arbitrary pointers to data
1496 * outside the packet may be followed.
1498 #define AV_PKT_FLAG_TRUSTED 0x0008
1500 * Flag is used to indicate packets that contain frames that can
1501 * be discarded by the decoder. I.e. Non-reference frames.
1503 #define AV_PKT_FLAG_DISPOSABLE 0x0010
1506 enum AVSideDataParamChangeFlags {
1507 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1508 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1509 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1510 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1516 struct AVCodecInternal;
1520 AV_FIELD_PROGRESSIVE,
1521 AV_FIELD_TT, //< Top coded_first, top displayed first
1522 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1523 AV_FIELD_TB, //< Top coded first, bottom displayed first
1524 AV_FIELD_BT, //< Bottom coded first, top displayed first
1528 * main external API structure.
1529 * New fields can be added to the end with minor version bumps.
1530 * Removal, reordering and changes to existing fields require a major
1532 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1534 * The name string for AVOptions options matches the associated command line
1535 * parameter name and can be found in libavcodec/options_table.h
1536 * The AVOption/command line parameter names differ in some cases from the C
1537 * structure field names for historic reasons or brevity.
1538 * sizeof(AVCodecContext) must not be used outside libav*.
1540 typedef struct AVCodecContext {
1542 * information on struct for av_log
1543 * - set by avcodec_alloc_context3
1545 const AVClass *av_class;
1546 int log_level_offset;
1548 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1549 const struct AVCodec *codec;
1550 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1553 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1554 * This is used to work around some encoder bugs.
1555 * A demuxer should set this to what is stored in the field used to identify the codec.
1556 * If there are multiple such fields in a container then the demuxer should choose the one
1557 * which maximizes the information about the used codec.
1558 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1559 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1560 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1562 * - encoding: Set by user, if not then the default based on codec_id will be used.
1563 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1565 unsigned int codec_tag;
1570 * Private context used for internal data.
1572 * Unlike priv_data, this is not codec-specific. It is used in general
1573 * libavcodec functions.
1575 struct AVCodecInternal *internal;
1578 * Private data of the user, can be used to carry app specific stuff.
1579 * - encoding: Set by user.
1580 * - decoding: Set by user.
1585 * the average bitrate
1586 * - encoding: Set by user; unused for constant quantizer encoding.
1587 * - decoding: Set by user, may be overwritten by libavcodec
1588 * if this info is available in the stream
1593 * number of bits the bitstream is allowed to diverge from the reference.
1594 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1595 * - encoding: Set by user; unused for constant quantizer encoding.
1596 * - decoding: unused
1598 int bit_rate_tolerance;
1601 * Global quality for codecs which cannot change it per frame.
1602 * This should be proportional to MPEG-1/2/4 qscale.
1603 * - encoding: Set by user.
1604 * - decoding: unused
1609 * - encoding: Set by user.
1610 * - decoding: unused
1612 int compression_level;
1613 #define FF_COMPRESSION_DEFAULT -1
1617 * - encoding: Set by user.
1618 * - decoding: Set by user.
1624 * - encoding: Set by user.
1625 * - decoding: Set by user.
1630 * some codecs need / can use extradata like Huffman tables.
1631 * MJPEG: Huffman tables
1632 * rv10: additional flags
1633 * MPEG-4: global headers (they can be in the bitstream or here)
1634 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1635 * than extradata_size to avoid problems if it is read with the bitstream reader.
1636 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1637 * Must be allocated with the av_malloc() family of functions.
1638 * - encoding: Set/allocated/freed by libavcodec.
1639 * - decoding: Set/allocated/freed by user.
1645 * This is the fundamental unit of time (in seconds) in terms
1646 * of which frame timestamps are represented. For fixed-fps content,
1647 * timebase should be 1/framerate and timestamp increments should be
1649 * This often, but not always is the inverse of the frame rate or field rate
1650 * for video. 1/time_base is not the average frame rate if the frame rate is not
1653 * Like containers, elementary streams also can store timestamps, 1/time_base
1654 * is the unit in which these timestamps are specified.
1655 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1656 * vop_time_increment_resolution and fixed_vop_rate
1657 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1659 * - encoding: MUST be set by user.
1660 * - decoding: the use of this field for decoding is deprecated.
1661 * Use framerate instead.
1663 AVRational time_base;
1666 * For some codecs, the time base is closer to the field rate than the frame rate.
1667 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1668 * if no telecine is used ...
1670 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1672 int ticks_per_frame;
1677 * Encoding: Number of frames delay there will be from the encoder input to
1678 * the decoder output. (we assume the decoder matches the spec)
1679 * Decoding: Number of frames delay in addition to what a standard decoder
1680 * as specified in the spec would produce.
1683 * Number of frames the decoded output will be delayed relative to the
1687 * For encoding, this field is unused (see initial_padding).
1689 * For decoding, this is the number of samples the decoder needs to
1690 * output before the decoder's output is valid. When seeking, you should
1691 * start decoding this many samples prior to your desired seek point.
1693 * - encoding: Set by libavcodec.
1694 * - decoding: Set by libavcodec.
1701 * picture width / height.
1703 * @note Those fields may not match the values of the last
1704 * AVFrame output by avcodec_decode_video2 due frame
1707 * - encoding: MUST be set by user.
1708 * - decoding: May be set by the user before opening the decoder if known e.g.
1709 * from the container. Some decoders will require the dimensions
1710 * to be set by the caller. During decoding, the decoder may
1711 * overwrite those values as required while parsing the data.
1716 * Bitstream width / height, may be different from width/height e.g. when
1717 * the decoded frame is cropped before being output or lowres is enabled.
1719 * @note Those field may not match the value of the last
1720 * AVFrame output by avcodec_receive_frame() due frame
1723 * - encoding: unused
1724 * - decoding: May be set by the user before opening the decoder if known
1725 * e.g. from the container. During decoding, the decoder may
1726 * overwrite those values as required while parsing the data.
1728 int coded_width, coded_height;
1731 * the number of pictures in a group of pictures, or 0 for intra_only
1732 * - encoding: Set by user.
1733 * - decoding: unused
1738 * Pixel format, see AV_PIX_FMT_xxx.
1739 * May be set by the demuxer if known from headers.
1740 * May be overridden by the decoder if it knows better.
1742 * @note This field may not match the value of the last
1743 * AVFrame output by avcodec_receive_frame() due frame
1746 * - encoding: Set by user.
1747 * - decoding: Set by user if known, overridden by libavcodec while
1750 enum AVPixelFormat pix_fmt;
1753 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1754 * decoder to draw a horizontal band. It improves cache usage. Not
1755 * all codecs can do that. You must check the codec capabilities
1757 * When multithreading is used, it may be called from multiple threads
1758 * at the same time; threads might draw different parts of the same AVFrame,
1759 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1761 * The function is also used by hardware acceleration APIs.
1762 * It is called at least once during frame decoding to pass
1763 * the data needed for hardware render.
1764 * In that mode instead of pixel data, AVFrame points to
1765 * a structure specific to the acceleration API. The application
1766 * reads the structure and can change some fields to indicate progress
1768 * - encoding: unused
1769 * - decoding: Set by user.
1770 * @param height the height of the slice
1771 * @param y the y position of the slice
1772 * @param type 1->top field, 2->bottom field, 3->frame
1773 * @param offset offset into the AVFrame.data from which the slice should be read
1775 void (*draw_horiz_band)(struct AVCodecContext *s,
1776 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1777 int y, int type, int height);
1780 * callback to negotiate the pixelFormat
1781 * @param fmt is the list of formats which are supported by the codec,
1782 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1783 * The first is always the native one.
1784 * @note The callback may be called again immediately if initialization for
1785 * the selected (hardware-accelerated) pixel format failed.
1786 * @warning Behavior is undefined if the callback returns a value not
1787 * in the fmt list of formats.
1788 * @return the chosen format
1789 * - encoding: unused
1790 * - decoding: Set by user, if not set the native format will be chosen.
1792 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1795 * maximum number of B-frames between non-B-frames
1796 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1797 * - encoding: Set by user.
1798 * - decoding: unused
1803 * qscale factor between IP and B-frames
1804 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1805 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1806 * - encoding: Set by user.
1807 * - decoding: unused
1809 float b_quant_factor;
1811 #if FF_API_PRIVATE_OPT
1812 /** @deprecated use encoder private options instead */
1813 attribute_deprecated
1814 int b_frame_strategy;
1818 * qscale offset between IP and B-frames
1819 * - encoding: Set by user.
1820 * - decoding: unused
1822 float b_quant_offset;
1825 * Size of the frame reordering buffer in the decoder.
1826 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1827 * - encoding: Set by libavcodec.
1828 * - decoding: Set by libavcodec.
1832 #if FF_API_PRIVATE_OPT
1833 /** @deprecated use encoder private options instead */
1834 attribute_deprecated
1839 * qscale factor between P- and I-frames
1840 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1841 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1842 * - encoding: Set by user.
1843 * - decoding: unused
1845 float i_quant_factor;
1848 * qscale offset between P and I-frames
1849 * - encoding: Set by user.
1850 * - decoding: unused
1852 float i_quant_offset;
1855 * luminance masking (0-> disabled)
1856 * - encoding: Set by user.
1857 * - decoding: unused
1862 * temporary complexity masking (0-> disabled)
1863 * - encoding: Set by user.
1864 * - decoding: unused
1866 float temporal_cplx_masking;
1869 * spatial complexity masking (0-> disabled)
1870 * - encoding: Set by user.
1871 * - decoding: unused
1873 float spatial_cplx_masking;
1876 * p block masking (0-> disabled)
1877 * - encoding: Set by user.
1878 * - decoding: unused
1883 * darkness masking (0-> disabled)
1884 * - encoding: Set by user.
1885 * - decoding: unused
1891 * - encoding: Set by libavcodec.
1892 * - decoding: Set by user (or 0).
1896 #if FF_API_PRIVATE_OPT
1897 /** @deprecated use encoder private options instead */
1898 attribute_deprecated
1899 int prediction_method;
1900 #define FF_PRED_LEFT 0
1901 #define FF_PRED_PLANE 1
1902 #define FF_PRED_MEDIAN 2
1906 * slice offsets in the frame in bytes
1907 * - encoding: Set/allocated by libavcodec.
1908 * - decoding: Set/allocated by user (or NULL).
1913 * sample aspect ratio (0 if unknown)
1914 * That is the width of a pixel divided by the height of the pixel.
1915 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1916 * - encoding: Set by user.
1917 * - decoding: Set by libavcodec.
1919 AVRational sample_aspect_ratio;
1922 * motion estimation comparison function
1923 * - encoding: Set by user.
1924 * - decoding: unused
1928 * subpixel motion estimation comparison function
1929 * - encoding: Set by user.
1930 * - decoding: unused
1934 * macroblock comparison function (not supported yet)
1935 * - encoding: Set by user.
1936 * - decoding: unused
1940 * interlaced DCT comparison function
1941 * - encoding: Set by user.
1942 * - decoding: unused
1945 #define FF_CMP_SAD 0
1946 #define FF_CMP_SSE 1
1947 #define FF_CMP_SATD 2
1948 #define FF_CMP_DCT 3
1949 #define FF_CMP_PSNR 4
1950 #define FF_CMP_BIT 5
1952 #define FF_CMP_ZERO 7
1953 #define FF_CMP_VSAD 8
1954 #define FF_CMP_VSSE 9
1955 #define FF_CMP_NSSE 10
1956 #define FF_CMP_W53 11
1957 #define FF_CMP_W97 12
1958 #define FF_CMP_DCTMAX 13
1959 #define FF_CMP_DCT264 14
1960 #define FF_CMP_MEDIAN_SAD 15
1961 #define FF_CMP_CHROMA 256
1964 * ME diamond size & shape
1965 * - encoding: Set by user.
1966 * - decoding: unused
1971 * amount of previous MV predictors (2a+1 x 2a+1 square)
1972 * - encoding: Set by user.
1973 * - decoding: unused
1975 int last_predictor_count;
1977 #if FF_API_PRIVATE_OPT
1978 /** @deprecated use encoder private options instead */
1979 attribute_deprecated
1984 * motion estimation prepass comparison function
1985 * - encoding: Set by user.
1986 * - decoding: unused
1991 * ME prepass diamond size & shape
1992 * - encoding: Set by user.
1993 * - decoding: unused
1999 * - encoding: Set by user.
2000 * - decoding: unused
2002 int me_subpel_quality;
2005 * maximum motion estimation search range in subpel units
2006 * If 0 then no limit.
2008 * - encoding: Set by user.
2009 * - decoding: unused
2015 * - encoding: unused
2016 * - decoding: Set by user.
2019 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2020 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2021 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2024 * macroblock decision mode
2025 * - encoding: Set by user.
2026 * - decoding: unused
2029 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2030 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2031 #define FF_MB_DECISION_RD 2 ///< rate distortion
2034 * custom intra quantization matrix
2035 * - encoding: Set by user, can be NULL.
2036 * - decoding: Set by libavcodec.
2038 uint16_t *intra_matrix;
2041 * custom inter quantization matrix
2042 * - encoding: Set by user, can be NULL.
2043 * - decoding: Set by libavcodec.
2045 uint16_t *inter_matrix;
2047 #if FF_API_PRIVATE_OPT
2048 /** @deprecated use encoder private options instead */
2049 attribute_deprecated
2050 int scenechange_threshold;
2052 /** @deprecated use encoder private options instead */
2053 attribute_deprecated
2054 int noise_reduction;
2058 * precision of the intra DC coefficient - 8
2059 * - encoding: Set by user.
2060 * - decoding: Set by libavcodec
2062 int intra_dc_precision;
2065 * Number of macroblock rows at the top which are skipped.
2066 * - encoding: unused
2067 * - decoding: Set by user.
2072 * Number of macroblock rows at the bottom which are skipped.
2073 * - encoding: unused
2074 * - decoding: Set by user.
2079 * minimum MB Lagrange multiplier
2080 * - encoding: Set by user.
2081 * - decoding: unused
2086 * maximum MB Lagrange multiplier
2087 * - encoding: Set by user.
2088 * - decoding: unused
2092 #if FF_API_PRIVATE_OPT
2094 * @deprecated use encoder private options instead
2096 attribute_deprecated
2097 int me_penalty_compensation;
2101 * - encoding: Set by user.
2102 * - decoding: unused
2106 #if FF_API_PRIVATE_OPT
2107 /** @deprecated use encoder private options instead */
2108 attribute_deprecated
2114 * - encoding: Set by user.
2115 * - decoding: unused
2120 * number of reference frames
2121 * - encoding: Set by user.
2122 * - decoding: Set by lavc.
2126 #if FF_API_PRIVATE_OPT
2127 /** @deprecated use encoder private options instead */
2128 attribute_deprecated
2133 * Note: Value depends upon the compare function used for fullpel ME.
2134 * - encoding: Set by user.
2135 * - decoding: unused
2139 #if FF_API_PRIVATE_OPT
2140 /** @deprecated use encoder private options instead */
2141 attribute_deprecated
2146 * Chromaticity coordinates of the source primaries.
2147 * - encoding: Set by user
2148 * - decoding: Set by libavcodec
2150 enum AVColorPrimaries color_primaries;
2153 * Color Transfer Characteristic.
2154 * - encoding: Set by user
2155 * - decoding: Set by libavcodec
2157 enum AVColorTransferCharacteristic color_trc;
2160 * YUV colorspace type.
2161 * - encoding: Set by user
2162 * - decoding: Set by libavcodec
2164 enum AVColorSpace colorspace;
2167 * MPEG vs JPEG YUV range.
2168 * - encoding: Set by user
2169 * - decoding: Set by libavcodec
2171 enum AVColorRange color_range;
2174 * This defines the location of chroma samples.
2175 * - encoding: Set by user
2176 * - decoding: Set by libavcodec
2178 enum AVChromaLocation chroma_sample_location;
2182 * Indicates number of picture subdivisions. Used for parallelized
2184 * - encoding: Set by user
2185 * - decoding: unused
2190 * - encoding: set by libavcodec
2191 * - decoding: Set by user.
2193 enum AVFieldOrder field_order;
2196 int sample_rate; ///< samples per second
2197 int channels; ///< number of audio channels
2200 * audio sample format
2201 * - encoding: Set by user.
2202 * - decoding: Set by libavcodec.
2204 enum AVSampleFormat sample_fmt; ///< sample format
2206 /* The following data should not be initialized. */
2208 * Number of samples per channel in an audio frame.
2210 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2211 * except the last must contain exactly frame_size samples per channel.
2212 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2213 * frame size is not restricted.
2214 * - decoding: may be set by some decoders to indicate constant frame size
2219 * Frame counter, set by libavcodec.
2221 * - decoding: total number of frames returned from the decoder so far.
2222 * - encoding: total number of frames passed to the encoder so far.
2224 * @note the counter is not incremented if encoding/decoding resulted in
2230 * number of bytes per packet if constant and known or 0
2231 * Used by some WAV based audio codecs.
2236 * Audio cutoff bandwidth (0 means "automatic")
2237 * - encoding: Set by user.
2238 * - decoding: unused
2243 * Audio channel layout.
2244 * - encoding: set by user.
2245 * - decoding: set by user, may be overwritten by libavcodec.
2247 uint64_t channel_layout;
2250 * Request decoder to use this channel layout if it can (0 for default)
2251 * - encoding: unused
2252 * - decoding: Set by user.
2254 uint64_t request_channel_layout;
2257 * Type of service that the audio stream conveys.
2258 * - encoding: Set by user.
2259 * - decoding: Set by libavcodec.
2261 enum AVAudioServiceType audio_service_type;
2264 * desired sample format
2265 * - encoding: Not used.
2266 * - decoding: Set by user.
2267 * Decoder will decode to this format if it can.
2269 enum AVSampleFormat request_sample_fmt;
2272 * This callback is called at the beginning of each frame to get data
2273 * buffer(s) for it. There may be one contiguous buffer for all the data or
2274 * there may be a buffer per each data plane or anything in between. What
2275 * this means is, you may set however many entries in buf[] you feel necessary.
2276 * Each buffer must be reference-counted using the AVBuffer API (see description
2279 * The following fields will be set in the frame before this callback is
2282 * - width, height (video only)
2283 * - sample_rate, channel_layout, nb_samples (audio only)
2284 * Their values may differ from the corresponding values in
2285 * AVCodecContext. This callback must use the frame values, not the codec
2286 * context values, to calculate the required buffer size.
2288 * This callback must fill the following fields in the frame:
2292 * * if the data is planar audio with more than 8 channels, then this
2293 * callback must allocate and fill extended_data to contain all pointers
2294 * to all data planes. data[] must hold as many pointers as it can.
2295 * extended_data must be allocated with av_malloc() and will be freed in
2297 * * otherwise extended_data must point to data
2298 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2299 * the frame's data and extended_data pointers must be contained in these. That
2300 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2301 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2302 * and av_buffer_ref().
2303 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2304 * this callback and filled with the extra buffers if there are more
2305 * buffers than buf[] can hold. extended_buf will be freed in
2308 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2309 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2312 * Each data plane must be aligned to the maximum required by the target
2315 * @see avcodec_default_get_buffer2()
2319 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2320 * (read and/or written to if it is writable) later by libavcodec.
2322 * avcodec_align_dimensions2() should be used to find the required width and
2323 * height, as they normally need to be rounded up to the next multiple of 16.
2325 * Some decoders do not support linesizes changing between frames.
2327 * If frame multithreading is used and thread_safe_callbacks is set,
2328 * this callback may be called from a different thread, but not from more
2329 * than one at once. Does not need to be reentrant.
2331 * @see avcodec_align_dimensions2()
2335 * Decoders request a buffer of a particular size by setting
2336 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2337 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2338 * to a smaller value in the output frame.
2340 * As a convenience, av_samples_get_buffer_size() and
2341 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2342 * functions to find the required data size and to fill data pointers and
2343 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2344 * since all planes must be the same size.
2346 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2348 * - encoding: unused
2349 * - decoding: Set by libavcodec, user can override.
2351 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2354 * If non-zero, the decoded audio and video frames returned from
2355 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2356 * and are valid indefinitely. The caller must free them with
2357 * av_frame_unref() when they are not needed anymore.
2358 * Otherwise, the decoded frames must not be freed by the caller and are
2359 * only valid until the next decode call.
2361 * This is always automatically enabled if avcodec_receive_frame() is used.
2363 * - encoding: unused
2364 * - decoding: set by the caller before avcodec_open2().
2366 attribute_deprecated
2367 int refcounted_frames;
2369 /* - encoding parameters */
2370 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2371 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2375 * - encoding: Set by user.
2376 * - decoding: unused
2382 * - encoding: Set by user.
2383 * - decoding: unused
2388 * maximum quantizer difference between frames
2389 * - encoding: Set by user.
2390 * - decoding: unused
2395 * decoder bitstream buffer size
2396 * - encoding: Set by user.
2397 * - decoding: unused
2402 * ratecontrol override, see RcOverride
2403 * - encoding: Allocated/set/freed by user.
2404 * - decoding: unused
2406 int rc_override_count;
2407 RcOverride *rc_override;
2411 * - encoding: Set by user.
2412 * - decoding: Set by user, may be overwritten by libavcodec.
2414 int64_t rc_max_rate;
2418 * - encoding: Set by user.
2419 * - decoding: unused
2421 int64_t rc_min_rate;
2424 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2425 * - encoding: Set by user.
2426 * - decoding: unused.
2428 float rc_max_available_vbv_use;
2431 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2432 * - encoding: Set by user.
2433 * - decoding: unused.
2435 float rc_min_vbv_overflow_use;
2438 * Number of bits which should be loaded into the rc buffer before decoding starts.
2439 * - encoding: Set by user.
2440 * - decoding: unused
2442 int rc_initial_buffer_occupancy;
2444 #if FF_API_CODER_TYPE
2445 #define FF_CODER_TYPE_VLC 0
2446 #define FF_CODER_TYPE_AC 1
2447 #define FF_CODER_TYPE_RAW 2
2448 #define FF_CODER_TYPE_RLE 3
2450 * @deprecated use encoder private options instead
2452 attribute_deprecated
2454 #endif /* FF_API_CODER_TYPE */
2456 #if FF_API_PRIVATE_OPT
2457 /** @deprecated use encoder private options instead */
2458 attribute_deprecated
2462 #if FF_API_PRIVATE_OPT
2463 /** @deprecated use encoder private options instead */
2464 attribute_deprecated
2465 int frame_skip_threshold;
2467 /** @deprecated use encoder private options instead */
2468 attribute_deprecated
2469 int frame_skip_factor;
2471 /** @deprecated use encoder private options instead */
2472 attribute_deprecated
2475 /** @deprecated use encoder private options instead */
2476 attribute_deprecated
2478 #endif /* FF_API_PRIVATE_OPT */
2481 * trellis RD quantization
2482 * - encoding: Set by user.
2483 * - decoding: unused
2487 #if FF_API_PRIVATE_OPT
2488 /** @deprecated use encoder private options instead */
2489 attribute_deprecated
2490 int min_prediction_order;
2492 /** @deprecated use encoder private options instead */
2493 attribute_deprecated
2494 int max_prediction_order;
2496 /** @deprecated use encoder private options instead */
2497 attribute_deprecated
2498 int64_t timecode_frame_start;
2501 #if FF_API_RTP_CALLBACK
2503 * @deprecated unused
2505 /* The RTP callback: This function is called */
2506 /* every time the encoder has a packet to send. */
2507 /* It depends on the encoder if the data starts */
2508 /* with a Start Code (it should). H.263 does. */
2509 /* mb_nb contains the number of macroblocks */
2510 /* encoded in the RTP payload. */
2511 attribute_deprecated
2512 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2515 #if FF_API_PRIVATE_OPT
2516 /** @deprecated use encoder private options instead */
2517 attribute_deprecated
2518 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2519 /* do its best to deliver a chunk with size */
2520 /* below rtp_payload_size, the chunk will start */
2521 /* with a start code on some codecs like H.263. */
2522 /* This doesn't take account of any particular */
2523 /* headers inside the transmitted RTP payload. */
2526 #if FF_API_STAT_BITS
2527 /* statistics, used for 2-pass encoding */
2528 attribute_deprecated
2530 attribute_deprecated
2532 attribute_deprecated
2534 attribute_deprecated
2536 attribute_deprecated
2538 attribute_deprecated
2540 attribute_deprecated
2542 attribute_deprecated
2545 /** @deprecated this field is unused */
2546 attribute_deprecated
2551 * pass1 encoding statistics output buffer
2552 * - encoding: Set by libavcodec.
2553 * - decoding: unused
2558 * pass2 encoding statistics input buffer
2559 * Concatenated stuff from stats_out of pass1 should be placed here.
2560 * - encoding: Allocated/set/freed by user.
2561 * - decoding: unused
2566 * Work around bugs in encoders which sometimes cannot be detected automatically.
2567 * - encoding: Set by user
2568 * - decoding: Set by user
2570 int workaround_bugs;
2571 #define FF_BUG_AUTODETECT 1 ///< autodetection
2572 #define FF_BUG_XVID_ILACE 4
2573 #define FF_BUG_UMP4 8
2574 #define FF_BUG_NO_PADDING 16
2575 #define FF_BUG_AMV 32
2576 #define FF_BUG_QPEL_CHROMA 64
2577 #define FF_BUG_STD_QPEL 128
2578 #define FF_BUG_QPEL_CHROMA2 256
2579 #define FF_BUG_DIRECT_BLOCKSIZE 512
2580 #define FF_BUG_EDGE 1024
2581 #define FF_BUG_HPEL_CHROMA 2048
2582 #define FF_BUG_DC_CLIP 4096
2583 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2584 #define FF_BUG_TRUNCATED 16384
2585 #define FF_BUG_IEDGE 32768
2588 * strictly follow the standard (MPEG-4, ...).
2589 * - encoding: Set by user.
2590 * - decoding: Set by user.
2591 * Setting this to STRICT or higher means the encoder and decoder will
2592 * generally do stupid things, whereas setting it to unofficial or lower
2593 * will mean the encoder might produce output that is not supported by all
2594 * spec-compliant decoders. Decoders don't differentiate between normal,
2595 * unofficial and experimental (that is, they always try to decode things
2596 * when they can) unless they are explicitly asked to behave stupidly
2597 * (=strictly conform to the specs)
2599 int strict_std_compliance;
2600 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2601 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2602 #define FF_COMPLIANCE_NORMAL 0
2603 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2604 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2607 * error concealment flags
2608 * - encoding: unused
2609 * - decoding: Set by user.
2611 int error_concealment;
2612 #define FF_EC_GUESS_MVS 1
2613 #define FF_EC_DEBLOCK 2
2614 #define FF_EC_FAVOR_INTER 256
2618 * - encoding: Set by user.
2619 * - decoding: Set by user.
2622 #define FF_DEBUG_PICT_INFO 1
2623 #define FF_DEBUG_RC 2
2624 #define FF_DEBUG_BITSTREAM 4
2625 #define FF_DEBUG_MB_TYPE 8
2626 #define FF_DEBUG_QP 16
2629 * @deprecated this option does nothing
2631 #define FF_DEBUG_MV 32
2633 #define FF_DEBUG_DCT_COEFF 0x00000040
2634 #define FF_DEBUG_SKIP 0x00000080
2635 #define FF_DEBUG_STARTCODE 0x00000100
2636 #define FF_DEBUG_ER 0x00000400
2637 #define FF_DEBUG_MMCO 0x00000800
2638 #define FF_DEBUG_BUGS 0x00001000
2640 #define FF_DEBUG_VIS_QP 0x00002000
2641 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2643 #define FF_DEBUG_BUFFERS 0x00008000
2644 #define FF_DEBUG_THREADS 0x00010000
2645 #define FF_DEBUG_GREEN_MD 0x00800000
2646 #define FF_DEBUG_NOMC 0x01000000
2651 * - encoding: Set by user.
2652 * - decoding: Set by user.
2655 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2656 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2657 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2661 * Error recognition; may misdetect some more or less valid parts as errors.
2662 * - encoding: unused
2663 * - decoding: Set by user.
2665 int err_recognition;
2668 * Verify checksums embedded in the bitstream (could be of either encoded or
2669 * decoded data, depending on the codec) and print an error message on mismatch.
2670 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2671 * decoder returning an error.
2673 #define AV_EF_CRCCHECK (1<<0)
2674 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2675 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2676 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2678 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2679 #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
2680 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2681 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2685 * opaque 64-bit number (generally a PTS) that will be reordered and
2686 * output in AVFrame.reordered_opaque
2687 * - encoding: Set by libavcodec to the reordered_opaque of the input
2688 * frame corresponding to the last returned packet. Only
2689 * supported by encoders with the
2690 * AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE capability.
2691 * - decoding: Set by user.
2693 int64_t reordered_opaque;
2696 * Hardware accelerator in use
2697 * - encoding: unused.
2698 * - decoding: Set by libavcodec
2700 const struct AVHWAccel *hwaccel;
2703 * Hardware accelerator context.
2704 * For some hardware accelerators, a global context needs to be
2705 * provided by the user. In that case, this holds display-dependent
2706 * data FFmpeg cannot instantiate itself. Please refer to the
2707 * FFmpeg HW accelerator documentation to know how to fill this
2708 * is. e.g. for VA API, this is a struct vaapi_context.
2709 * - encoding: unused
2710 * - decoding: Set by user
2712 void *hwaccel_context;
2716 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2717 * - decoding: unused
2719 uint64_t error[AV_NUM_DATA_POINTERS];
2722 * DCT algorithm, see FF_DCT_* below
2723 * - encoding: Set by user.
2724 * - decoding: unused
2727 #define FF_DCT_AUTO 0
2728 #define FF_DCT_FASTINT 1
2729 #define FF_DCT_INT 2
2730 #define FF_DCT_MMX 3
2731 #define FF_DCT_ALTIVEC 5
2732 #define FF_DCT_FAAN 6
2735 * IDCT algorithm, see FF_IDCT_* below.
2736 * - encoding: Set by user.
2737 * - decoding: Set by user.
2740 #define FF_IDCT_AUTO 0
2741 #define FF_IDCT_INT 1
2742 #define FF_IDCT_SIMPLE 2
2743 #define FF_IDCT_SIMPLEMMX 3
2744 #define FF_IDCT_ARM 7
2745 #define FF_IDCT_ALTIVEC 8
2746 #define FF_IDCT_SIMPLEARM 10
2747 #define FF_IDCT_XVID 14
2748 #define FF_IDCT_SIMPLEARMV5TE 16
2749 #define FF_IDCT_SIMPLEARMV6 17
2750 #define FF_IDCT_FAAN 20
2751 #define FF_IDCT_SIMPLENEON 22
2752 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2753 #define FF_IDCT_SIMPLEAUTO 128
2756 * bits per sample/pixel from the demuxer (needed for huffyuv).
2757 * - encoding: Set by libavcodec.
2758 * - decoding: Set by user.
2760 int bits_per_coded_sample;
2763 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2764 * - encoding: set by user.
2765 * - decoding: set by libavcodec.
2767 int bits_per_raw_sample;
2771 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2772 * - encoding: unused
2773 * - decoding: Set by user.
2778 #if FF_API_CODED_FRAME
2780 * the picture in the bitstream
2781 * - encoding: Set by libavcodec.
2782 * - decoding: unused
2784 * @deprecated use the quality factor packet side data instead
2786 attribute_deprecated AVFrame *coded_frame;
2791 * is used to decide how many independent tasks should be passed to execute()
2792 * - encoding: Set by user.
2793 * - decoding: Set by user.
2798 * Which multithreading methods to use.
2799 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2800 * so clients which cannot provide future frames should not use it.
2802 * - encoding: Set by user, otherwise the default is used.
2803 * - decoding: Set by user, otherwise the default is used.
2806 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2807 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2810 * Which multithreading methods are in use by the codec.
2811 * - encoding: Set by libavcodec.
2812 * - decoding: Set by libavcodec.
2814 int active_thread_type;
2817 * Set by the client if its custom get_buffer() callback can be called
2818 * synchronously from another thread, which allows faster multithreaded decoding.
2819 * draw_horiz_band() will be called from other threads regardless of this setting.
2820 * Ignored if the default get_buffer() is used.
2821 * - encoding: Set by user.
2822 * - decoding: Set by user.
2824 int thread_safe_callbacks;
2827 * The codec may call this to execute several independent things.
2828 * It will return only after finishing all tasks.
2829 * The user may replace this with some multithreaded implementation,
2830 * the default implementation will execute the parts serially.
2831 * @param count the number of things to execute
2832 * - encoding: Set by libavcodec, user can override.
2833 * - decoding: Set by libavcodec, user can override.
2835 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2838 * The codec may call this to execute several independent things.
2839 * It will return only after finishing all tasks.
2840 * The user may replace this with some multithreaded implementation,
2841 * the default implementation will execute the parts serially.
2842 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2843 * @param c context passed also to func
2844 * @param count the number of things to execute
2845 * @param arg2 argument passed unchanged to func
2846 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2847 * @param func function that will be called count times, with jobnr from 0 to count-1.
2848 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2849 * two instances of func executing at the same time will have the same threadnr.
2850 * @return always 0 currently, but code should handle a future improvement where when any call to func
2851 * returns < 0 no further calls to func may be done and < 0 is returned.
2852 * - encoding: Set by libavcodec, user can override.
2853 * - decoding: Set by libavcodec, user can override.
2855 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2858 * noise vs. sse weight for the nsse comparison function
2859 * - encoding: Set by user.
2860 * - decoding: unused
2866 * - encoding: Set by user.
2867 * - decoding: Set by libavcodec.
2870 #define FF_PROFILE_UNKNOWN -99
2871 #define FF_PROFILE_RESERVED -100
2873 #define FF_PROFILE_AAC_MAIN 0
2874 #define FF_PROFILE_AAC_LOW 1
2875 #define FF_PROFILE_AAC_SSR 2
2876 #define FF_PROFILE_AAC_LTP 3
2877 #define FF_PROFILE_AAC_HE 4
2878 #define FF_PROFILE_AAC_HE_V2 28
2879 #define FF_PROFILE_AAC_LD 22
2880 #define FF_PROFILE_AAC_ELD 38
2881 #define FF_PROFILE_MPEG2_AAC_LOW 128
2882 #define FF_PROFILE_MPEG2_AAC_HE 131
2884 #define FF_PROFILE_DNXHD 0
2885 #define FF_PROFILE_DNXHR_LB 1
2886 #define FF_PROFILE_DNXHR_SQ 2
2887 #define FF_PROFILE_DNXHR_HQ 3
2888 #define FF_PROFILE_DNXHR_HQX 4
2889 #define FF_PROFILE_DNXHR_444 5
2891 #define FF_PROFILE_DTS 20
2892 #define FF_PROFILE_DTS_ES 30
2893 #define FF_PROFILE_DTS_96_24 40
2894 #define FF_PROFILE_DTS_HD_HRA 50
2895 #define FF_PROFILE_DTS_HD_MA 60
2896 #define FF_PROFILE_DTS_EXPRESS 70
2898 #define FF_PROFILE_MPEG2_422 0
2899 #define FF_PROFILE_MPEG2_HIGH 1
2900 #define FF_PROFILE_MPEG2_SS 2
2901 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2902 #define FF_PROFILE_MPEG2_MAIN 4
2903 #define FF_PROFILE_MPEG2_SIMPLE 5
2905 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2906 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2908 #define FF_PROFILE_H264_BASELINE 66
2909 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2910 #define FF_PROFILE_H264_MAIN 77
2911 #define FF_PROFILE_H264_EXTENDED 88
2912 #define FF_PROFILE_H264_HIGH 100
2913 #define FF_PROFILE_H264_HIGH_10 110
2914 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2915 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2916 #define FF_PROFILE_H264_HIGH_422 122
2917 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2918 #define FF_PROFILE_H264_STEREO_HIGH 128
2919 #define FF_PROFILE_H264_HIGH_444 144
2920 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2921 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2922 #define FF_PROFILE_H264_CAVLC_444 44
2924 #define FF_PROFILE_VC1_SIMPLE 0
2925 #define FF_PROFILE_VC1_MAIN 1
2926 #define FF_PROFILE_VC1_COMPLEX 2
2927 #define FF_PROFILE_VC1_ADVANCED 3
2929 #define FF_PROFILE_MPEG4_SIMPLE 0
2930 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2931 #define FF_PROFILE_MPEG4_CORE 2
2932 #define FF_PROFILE_MPEG4_MAIN 3
2933 #define FF_PROFILE_MPEG4_N_BIT 4
2934 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2935 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2936 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2937 #define FF_PROFILE_MPEG4_HYBRID 8
2938 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2939 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2940 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2941 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2942 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2943 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2944 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2946 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2947 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2948 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2949 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2950 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2952 #define FF_PROFILE_VP9_0 0
2953 #define FF_PROFILE_VP9_1 1
2954 #define FF_PROFILE_VP9_2 2
2955 #define FF_PROFILE_VP9_3 3
2957 #define FF_PROFILE_HEVC_MAIN 1
2958 #define FF_PROFILE_HEVC_MAIN_10 2
2959 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2960 #define FF_PROFILE_HEVC_REXT 4
2962 #define FF_PROFILE_AV1_MAIN 0
2963 #define FF_PROFILE_AV1_HIGH 1
2964 #define FF_PROFILE_AV1_PROFESSIONAL 2
2966 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
2967 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
2968 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
2969 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
2970 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
2972 #define FF_PROFILE_SBC_MSBC 1
2974 #define FF_PROFILE_PRORES_PROXY 0
2975 #define FF_PROFILE_PRORES_LT 1
2976 #define FF_PROFILE_PRORES_STANDARD 2
2977 #define FF_PROFILE_PRORES_HQ 3
2978 #define FF_PROFILE_PRORES_4444 4
2979 #define FF_PROFILE_PRORES_XQ 5
2983 * - encoding: Set by user.
2984 * - decoding: Set by libavcodec.
2987 #define FF_LEVEL_UNKNOWN -99
2990 * Skip loop filtering for selected frames.
2991 * - encoding: unused
2992 * - decoding: Set by user.
2994 enum AVDiscard skip_loop_filter;
2997 * Skip IDCT/dequantization for selected frames.
2998 * - encoding: unused
2999 * - decoding: Set by user.
3001 enum AVDiscard skip_idct;
3004 * Skip decoding for selected frames.
3005 * - encoding: unused
3006 * - decoding: Set by user.
3008 enum AVDiscard skip_frame;
3011 * Header containing style information for text subtitles.
3012 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3013 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3014 * the Format line following. It shouldn't include any Dialogue line.
3015 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3016 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3018 uint8_t *subtitle_header;
3019 int subtitle_header_size;
3021 #if FF_API_VBV_DELAY
3023 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3024 * Used for compliant TS muxing.
3025 * - encoding: Set by libavcodec.
3026 * - decoding: unused.
3027 * @deprecated this value is now exported as a part of
3028 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3030 attribute_deprecated
3034 #if FF_API_SIDEDATA_ONLY_PKT
3036 * Encoding only and set by default. Allow encoders to output packets
3037 * that do not contain any encoded data, only side data.
3039 * Some encoders need to output such packets, e.g. to update some stream
3040 * parameters at the end of encoding.
3042 * @deprecated this field disables the default behaviour and
3043 * it is kept only for compatibility.
3045 attribute_deprecated
3046 int side_data_only_packets;
3050 * Audio only. The number of "priming" samples (padding) inserted by the
3051 * encoder at the beginning of the audio. I.e. this number of leading
3052 * decoded samples must be discarded by the caller to get the original audio
3053 * without leading padding.
3055 * - decoding: unused
3056 * - encoding: Set by libavcodec. The timestamps on the output packets are
3057 * adjusted by the encoder so that they always refer to the
3058 * first sample of the data actually contained in the packet,
3059 * including any added padding. E.g. if the timebase is
3060 * 1/samplerate and the timestamp of the first input sample is
3061 * 0, the timestamp of the first output packet will be
3064 int initial_padding;
3067 * - decoding: For codecs that store a framerate value in the compressed
3068 * bitstream, the decoder may export it here. { 0, 1} when
3070 * - encoding: May be used to signal the framerate of CFR content to an
3073 AVRational framerate;
3076 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3077 * - encoding: unused.
3078 * - decoding: Set by libavcodec before calling get_format()
3080 enum AVPixelFormat sw_pix_fmt;
3083 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3084 * - encoding unused.
3085 * - decoding set by user.
3087 AVRational pkt_timebase;
3091 * - encoding: unused.
3092 * - decoding: set by libavcodec.
3094 const AVCodecDescriptor *codec_descriptor;
3098 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3099 * - encoding: unused
3100 * - decoding: Set by user.
3106 * Current statistics for PTS correction.
3107 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3108 * - encoding: unused
3110 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3111 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3112 int64_t pts_correction_last_pts; /// PTS of the last frame
3113 int64_t pts_correction_last_dts; /// DTS of the last frame
3116 * Character encoding of the input subtitles file.
3117 * - decoding: set by user
3118 * - encoding: unused
3123 * Subtitles character encoding mode. Formats or codecs might be adjusting
3124 * this setting (if they are doing the conversion themselves for instance).
3125 * - decoding: set by libavcodec
3126 * - encoding: unused
3128 int sub_charenc_mode;
3129 #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)
3130 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3131 #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
3132 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
3135 * Skip processing alpha if supported by codec.
3136 * Note that if the format uses pre-multiplied alpha (common with VP6,
3137 * and recommended due to better video quality/compression)
3138 * the image will look as if alpha-blended onto a black background.
3139 * However for formats that do not use pre-multiplied alpha
3140 * there might be serious artefacts (though e.g. libswscale currently
3141 * assumes pre-multiplied alpha anyway).
3143 * - decoding: set by user
3144 * - encoding: unused
3149 * Number of samples to skip after a discontinuity
3150 * - decoding: unused
3151 * - encoding: set by libavcodec
3155 #if !FF_API_DEBUG_MV
3157 * debug motion vectors
3158 * - encoding: Set by user.
3159 * - decoding: Set by user.
3162 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3163 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3164 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3168 * custom intra quantization matrix
3169 * - encoding: Set by user, can be NULL.
3170 * - decoding: unused.
3172 uint16_t *chroma_intra_matrix;
3175 * dump format separator.
3176 * can be ", " or "\n " or anything else
3177 * - encoding: Set by user.
3178 * - decoding: Set by user.
3180 uint8_t *dump_separator;
3183 * ',' separated list of allowed decoders.
3184 * If NULL then all are allowed
3185 * - encoding: unused
3186 * - decoding: set by user
3188 char *codec_whitelist;
3191 * Properties of the stream that gets decoded
3192 * - encoding: unused
3193 * - decoding: set by libavcodec
3195 unsigned properties;
3196 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3197 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3200 * Additional data associated with the entire coded stream.
3202 * - decoding: unused
3203 * - encoding: may be set by libavcodec after avcodec_open2().
3205 AVPacketSideData *coded_side_data;
3206 int nb_coded_side_data;
3209 * A reference to the AVHWFramesContext describing the input (for encoding)
3210 * or output (decoding) frames. The reference is set by the caller and
3211 * afterwards owned (and freed) by libavcodec - it should never be read by
3212 * the caller after being set.
3214 * - decoding: This field should be set by the caller from the get_format()
3215 * callback. The previous reference (if any) will always be
3216 * unreffed by libavcodec before the get_format() call.
3218 * If the default get_buffer2() is used with a hwaccel pixel
3219 * format, then this AVHWFramesContext will be used for
3220 * allocating the frame buffers.
3222 * - encoding: For hardware encoders configured to use a hwaccel pixel
3223 * format, this field should be set by the caller to a reference
3224 * to the AVHWFramesContext describing input frames.
3225 * AVHWFramesContext.format must be equal to
3226 * AVCodecContext.pix_fmt.
3228 * This field should be set before avcodec_open2() is called.
3230 AVBufferRef *hw_frames_ctx;
3233 * Control the form of AVSubtitle.rects[N]->ass
3234 * - decoding: set by user
3235 * - encoding: unused
3237 int sub_text_format;
3238 #define FF_SUB_TEXT_FMT_ASS 0
3239 #if FF_API_ASS_TIMING
3240 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3244 * Audio only. The amount of padding (in samples) appended by the encoder to
3245 * the end of the audio. I.e. this number of decoded samples must be
3246 * discarded by the caller from the end of the stream to get the original
3247 * audio without any trailing padding.
3249 * - decoding: unused
3250 * - encoding: unused
3252 int trailing_padding;
3255 * The number of pixels per image to maximally accept.
3257 * - decoding: set by user
3258 * - encoding: set by user
3263 * A reference to the AVHWDeviceContext describing the device which will
3264 * be used by a hardware encoder/decoder. The reference is set by the
3265 * caller and afterwards owned (and freed) by libavcodec.
3267 * This should be used if either the codec device does not require
3268 * hardware frames or any that are used are to be allocated internally by
3269 * libavcodec. If the user wishes to supply any of the frames used as
3270 * encoder input or decoder output then hw_frames_ctx should be used
3271 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3272 * field will be ignored while decoding the associated stream segment, but
3273 * may again be used on a following one after another get_format() call.
3275 * For both encoders and decoders this field should be set before
3276 * avcodec_open2() is called and must not be written to thereafter.
3278 * Note that some decoders may require this field to be set initially in
3279 * order to support hw_frames_ctx at all - in that case, all frames
3280 * contexts used must be created on the same device.
3282 AVBufferRef *hw_device_ctx;
3285 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3286 * decoding (if active).
3287 * - encoding: unused
3288 * - decoding: Set by user (either before avcodec_open2(), or in the
3289 * AVCodecContext.get_format callback)
3294 * Video decoding only. Certain video codecs support cropping, meaning that
3295 * only a sub-rectangle of the decoded frame is intended for display. This
3296 * option controls how cropping is handled by libavcodec.
3298 * When set to 1 (the default), libavcodec will apply cropping internally.
3299 * I.e. it will modify the output frame width/height fields and offset the
3300 * data pointers (only by as much as possible while preserving alignment, or
3301 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3302 * the frames output by the decoder refer only to the cropped area. The
3303 * crop_* fields of the output frames will be zero.
3305 * When set to 0, the width/height fields of the output frames will be set
3306 * to the coded dimensions and the crop_* fields will describe the cropping
3307 * rectangle. Applying the cropping is left to the caller.
3309 * @warning When hardware acceleration with opaque output frames is used,
3310 * libavcodec is unable to apply cropping from the top/left border.
3312 * @note when this option is set to zero, the width/height fields of the
3313 * AVCodecContext and output AVFrames have different meanings. The codec
3314 * context fields store display dimensions (with the coded dimensions in
3315 * coded_width/height), while the frame fields store the coded dimensions
3316 * (with the display dimensions being determined by the crop_* fields).
3321 * Video decoding only. Sets the number of extra hardware frames which
3322 * the decoder will allocate for use by the caller. This must be set
3323 * before avcodec_open2() is called.
3325 * Some hardware decoders require all frames that they will use for
3326 * output to be defined in advance before decoding starts. For such
3327 * decoders, the hardware frame pool must therefore be of a fixed size.
3328 * The extra frames set here are on top of any number that the decoder
3329 * needs internally in order to operate normally (for example, frames
3330 * used as reference pictures).
3332 int extra_hw_frames;
3335 #if FF_API_CODEC_GET_SET
3337 * Accessors for some AVCodecContext fields. These used to be provided for ABI
3338 * compatibility, and do not need to be used anymore.
3340 attribute_deprecated
3341 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3342 attribute_deprecated
3343 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3345 attribute_deprecated
3346 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3347 attribute_deprecated
3348 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3350 attribute_deprecated
3351 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3354 attribute_deprecated
3355 int av_codec_get_lowres(const AVCodecContext *avctx);
3356 attribute_deprecated
3357 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3360 attribute_deprecated
3361 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3362 attribute_deprecated
3363 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3365 attribute_deprecated
3366 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3367 attribute_deprecated
3368 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3374 typedef struct AVProfile {
3376 const char *name; ///< short name for the profile
3381 * The codec supports this format via the hw_device_ctx interface.
3383 * When selecting this format, AVCodecContext.hw_device_ctx should
3384 * have been set to a device of the specified type before calling
3387 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
3389 * The codec supports this format via the hw_frames_ctx interface.
3391 * When selecting this format for a decoder,
3392 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3393 * context inside the get_format() callback. The frames context
3394 * must have been created on a device of the specified type.
3396 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
3398 * The codec supports this format by some internal method.
3400 * This format can be selected without any additional configuration -
3401 * no device or frames context is required.
3403 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
3405 * The codec supports this format by some ad-hoc method.
3407 * Additional settings and/or function calls are required. See the
3408 * codec-specific documentation for details. (Methods requiring
3409 * this sort of configuration are deprecated and others should be
3410 * used in preference.)
3412 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
3415 typedef struct AVCodecHWConfig {
3417 * A hardware pixel format which the codec can use.
3419 enum AVPixelFormat pix_fmt;
3421 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3422 * setup methods which can be used with this configuration.
3426 * The device type associated with the configuration.
3428 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3429 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3431 enum AVHWDeviceType device_type;
3434 typedef struct AVCodecDefault AVCodecDefault;
3441 typedef struct AVCodec {
3443 * Name of the codec implementation.
3444 * The name is globally unique among encoders and among decoders (but an
3445 * encoder and a decoder can share the same name).
3446 * This is the primary way to find a codec from the user perspective.
3450 * Descriptive name for the codec, meant to be more human readable than name.
3451 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3453 const char *long_name;
3454 enum AVMediaType type;
3457 * Codec capabilities.
3458 * see AV_CODEC_CAP_*
3461 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3462 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3463 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3464 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3465 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3466 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3467 const AVClass *priv_class; ///< AVClass for the private context
3468 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3471 * Group name of the codec implementation.
3472 * This is a short symbolic name of the wrapper backing this codec. A
3473 * wrapper uses some kind of external implementation for the codec, such
3474 * as an external library, or a codec implementation provided by the OS or
3476 * If this field is NULL, this is a builtin, libavcodec native codec.
3477 * If non-NULL, this will be the suffix in AVCodec.name in most cases
3478 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3480 const char *wrapper_name;
3482 /*****************************************************************
3483 * No fields below this line are part of the public API. They
3484 * may not be used outside of libavcodec and can be changed and
3486 * New public fields should be added right above.
3487 *****************************************************************
3490 struct AVCodec *next;
3492 * @name Frame-level threading support functions
3496 * If defined, called on thread contexts when they are created.
3497 * If the codec allocates writable tables in init(), re-allocate them here.
3498 * priv_data will be set to a copy of the original.
3500 int (*init_thread_copy)(AVCodecContext *);
3502 * Copy necessary context variables from a previous thread context to the current one.
3503 * If not defined, the next thread will start automatically; otherwise, the codec
3504 * must call ff_thread_finish_setup().
3506 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3508 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3512 * Private codec-specific defaults.
3514 const AVCodecDefault *defaults;
3517 * Initialize codec static data, called from avcodec_register().
3519 * This is not intended for time consuming operations as it is
3520 * run for every codec regardless of that codec being used.
3522 void (*init_static_data)(struct AVCodec *codec);
3524 int (*init)(AVCodecContext *);
3525 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3526 const struct AVSubtitle *sub);
3528 * Encode data to an AVPacket.
3530 * @param avctx codec context
3531 * @param avpkt output AVPacket (may contain a user-provided buffer)
3532 * @param[in] frame AVFrame containing the raw data to be encoded
3533 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3534 * non-empty packet was returned in avpkt.
3535 * @return 0 on success, negative error code on failure
3537 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3538 int *got_packet_ptr);
3539 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3540 int (*close)(AVCodecContext *);
3542 * Encode API with decoupled packet/frame dataflow. The API is the
3543 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3545 * - never called if the codec is closed or the wrong type,
3546 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3547 * - only one drain frame is ever passed down,
3549 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3550 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3553 * Decode API with decoupled packet/frame dataflow. This function is called
3554 * to get one output frame. It should call ff_decode_get_packet() to obtain
3557 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3560 * Will be called when seeking
3562 void (*flush)(AVCodecContext *);
3564 * Internal codec capabilities.
3565 * See FF_CODEC_CAP_* in internal.h
3570 * Decoding only, a comma-separated list of bitstream filters to apply to
3571 * packets before decoding.
3576 * Array of pointers to hardware configurations supported by the codec,
3577 * or NULL if no hardware supported. The array is terminated by a NULL
3580 * The user can only access this field via avcodec_get_hw_config().
3582 const struct AVCodecHWConfigInternal **hw_configs;
3585 #if FF_API_CODEC_GET_SET
3586 attribute_deprecated
3587 int av_codec_get_max_lowres(const AVCodec *codec);
3590 struct MpegEncContext;
3593 * Retrieve supported hardware configurations for a codec.
3595 * Values of index from zero to some maximum return the indexed configuration
3596 * descriptor; all other values return NULL. If the codec does not support
3597 * any hardware configurations then it will always return NULL.
3599 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3602 * @defgroup lavc_hwaccel AVHWAccel
3604 * @note Nothing in this structure should be accessed by the user. At some
3605 * point in future it will not be externally visible at all.
3609 typedef struct AVHWAccel {
3611 * Name of the hardware accelerated codec.
3612 * The name is globally unique among encoders and among decoders (but an
3613 * encoder and a decoder can share the same name).
3618 * Type of codec implemented by the hardware accelerator.
3620 * See AVMEDIA_TYPE_xxx
3622 enum AVMediaType type;
3625 * Codec implemented by the hardware accelerator.
3627 * See AV_CODEC_ID_xxx
3632 * Supported pixel format.
3634 * Only hardware accelerated formats are supported here.
3636 enum AVPixelFormat pix_fmt;
3639 * Hardware accelerated codec capabilities.
3640 * see AV_HWACCEL_CODEC_CAP_*
3644 /*****************************************************************
3645 * No fields below this line are part of the public API. They
3646 * may not be used outside of libavcodec and can be changed and
3648 * New public fields should be added right above.
3649 *****************************************************************
3653 * Allocate a custom buffer
3655 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3658 * Called at the beginning of each frame or field picture.
3660 * Meaningful frame information (codec specific) is guaranteed to
3661 * be parsed at this point. This function is mandatory.
3663 * Note that buf can be NULL along with buf_size set to 0.
3664 * Otherwise, this means the whole frame is available at this point.
3666 * @param avctx the codec context
3667 * @param buf the frame data buffer base
3668 * @param buf_size the size of the frame in bytes
3669 * @return zero if successful, a negative value otherwise
3671 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3674 * Callback for parameter data (SPS/PPS/VPS etc).
3676 * Useful for hardware decoders which keep persistent state about the
3677 * video parameters, and need to receive any changes to update that state.
3679 * @param avctx the codec context
3680 * @param type the nal unit type
3681 * @param buf the nal unit data buffer
3682 * @param buf_size the size of the nal unit in bytes
3683 * @return zero if successful, a negative value otherwise
3685 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3688 * Callback for each slice.
3690 * Meaningful slice information (codec specific) is guaranteed to
3691 * be parsed at this point. This function is mandatory.
3692 * The only exception is XvMC, that works on MB level.
3694 * @param avctx the codec context
3695 * @param buf the slice data buffer base
3696 * @param buf_size the size of the slice in bytes
3697 * @return zero if successful, a negative value otherwise
3699 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3702 * Called at the end of each frame or field picture.
3704 * The whole picture is parsed at this point and can now be sent
3705 * to the hardware accelerator. This function is mandatory.
3707 * @param avctx the codec context
3708 * @return zero if successful, a negative value otherwise
3710 int (*end_frame)(AVCodecContext *avctx);
3713 * Size of per-frame hardware accelerator private data.
3715 * Private data is allocated with av_mallocz() before
3716 * AVCodecContext.get_buffer() and deallocated after
3717 * AVCodecContext.release_buffer().
3719 int frame_priv_data_size;
3722 * Called for every Macroblock in a slice.
3724 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3725 * Instead of decoding to raw picture, MB parameters are
3726 * stored in an array provided by the video driver.
3728 * @param s the mpeg context
3730 void (*decode_mb)(struct MpegEncContext *s);
3733 * Initialize the hwaccel private data.
3735 * This will be called from ff_get_format(), after hwaccel and
3736 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3739 int (*init)(AVCodecContext *avctx);
3742 * Uninitialize the hwaccel private data.
3744 * This will be called from get_format() or avcodec_close(), after hwaccel
3745 * and hwaccel_context are already uninitialized.
3747 int (*uninit)(AVCodecContext *avctx);
3750 * Size of the private data to allocate in
3751 * AVCodecInternal.hwaccel_priv_data.
3756 * Internal hwaccel capabilities.
3761 * Fill the given hw_frames context with current codec parameters. Called
3762 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3765 * This CAN be called before AVHWAccel.init is called, and you must assume
3766 * that avctx->hwaccel_priv_data is invalid.
3768 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3772 * HWAccel is experimental and is thus avoided in favor of non experimental
3775 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3778 * Hardware acceleration should be used for decoding even if the codec level
3779 * used is unknown or higher than the maximum supported level reported by the
3782 * It's generally a good idea to pass this flag unless you have a specific
3783 * reason not to, as hardware tends to under-report supported levels.
3785 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3788 * Hardware acceleration can output YUV pixel formats with a different chroma
3789 * sampling than 4:2:0 and/or other than 8 bits per component.
3791 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3794 * Hardware acceleration should still be attempted for decoding when the
3795 * codec profile does not match the reported capabilities of the hardware.
3797 * For example, this can be used to try to decode baseline profile H.264
3798 * streams in hardware - it will often succeed, because many streams marked
3799 * as baseline profile actually conform to constrained baseline profile.
3801 * @warning If the stream is actually not supported then the behaviour is
3802 * undefined, and may include returning entirely incorrect output
3803 * while indicating success.
3805 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3811 #if FF_API_AVPICTURE
3813 * @defgroup lavc_picture AVPicture
3815 * Functions for working with AVPicture
3820 * Picture data structure.
3822 * Up to four components can be stored into it, the last component is
3824 * @deprecated use AVFrame or imgutils functions instead
3826 typedef struct AVPicture {
3827 attribute_deprecated
3828 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3829 attribute_deprecated
3830 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3838 enum AVSubtitleType {
3841 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3844 * Plain text, the text field must be set by the decoder and is
3845 * authoritative. ass and pict fields may contain approximations.
3850 * Formatted text, the ass field must be set by the decoder and is
3851 * authoritative. pict and text fields may contain approximations.
3856 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3858 typedef struct AVSubtitleRect {
3859 int x; ///< top left corner of pict, undefined when pict is not set
3860 int y; ///< top left corner of pict, undefined when pict is not set
3861 int w; ///< width of pict, undefined when pict is not set
3862 int h; ///< height of pict, undefined when pict is not set
3863 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3865 #if FF_API_AVPICTURE
3867 * @deprecated unused
3869 attribute_deprecated
3873 * data+linesize for the bitmap of this subtitle.
3874 * Can be set for text/ass as well once they are rendered.
3879 enum AVSubtitleType type;
3881 char *text; ///< 0 terminated plain UTF-8 text
3884 * 0 terminated ASS/SSA compatible event line.
3885 * The presentation of this is unaffected by the other values in this
3893 typedef struct AVSubtitle {
3894 uint16_t format; /* 0 = graphics */
3895 uint32_t start_display_time; /* relative to packet pts, in ms */
3896 uint32_t end_display_time; /* relative to packet pts, in ms */
3898 AVSubtitleRect **rects;
3899 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3903 * This struct describes the properties of an encoded stream.
3905 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3906 * be allocated with avcodec_parameters_alloc() and freed with
3907 * avcodec_parameters_free().
3909 typedef struct AVCodecParameters {
3911 * General type of the encoded data.
3913 enum AVMediaType codec_type;
3915 * Specific type of the encoded data (the codec used).
3917 enum AVCodecID codec_id;
3919 * Additional information about the codec (corresponds to the AVI FOURCC).
3924 * Extra binary data needed for initializing the decoder, codec-dependent.
3926 * Must be allocated with av_malloc() and will be freed by
3927 * avcodec_parameters_free(). The allocated size of extradata must be at
3928 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3933 * Size of the extradata content in bytes.
3938 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3939 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3944 * The average bitrate of the encoded data (in bits per second).
3949 * The number of bits per sample in the codedwords.
3951 * This is basically the bitrate per sample. It is mandatory for a bunch of
3952 * formats to actually decode them. It's the number of bits for one sample in
3953 * the actual coded bitstream.
3955 * This could be for example 4 for ADPCM
3956 * For PCM formats this matches bits_per_raw_sample
3959 int bits_per_coded_sample;
3962 * This is the number of valid bits in each output sample. If the
3963 * sample format has more bits, the least significant bits are additional
3964 * padding bits, which are always 0. Use right shifts to reduce the sample
3965 * to its actual size. For example, audio formats with 24 bit samples will
3966 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3967 * To get the original sample use "(int32_t)sample >> 8"."
3969 * For ADPCM this might be 12 or 16 or similar
3972 int bits_per_raw_sample;
3975 * Codec-specific bitstream restrictions that the stream conforms to.
3981 * Video only. The dimensions of the video frame in pixels.
3987 * Video only. The aspect ratio (width / height) which a single pixel
3988 * should have when displayed.
3990 * When the aspect ratio is unknown / undefined, the numerator should be
3991 * set to 0 (the denominator may have any value).
3993 AVRational sample_aspect_ratio;
3996 * Video only. The order of the fields in interlaced video.
3998 enum AVFieldOrder field_order;
4001 * Video only. Additional colorspace characteristics.
4003 enum AVColorRange color_range;
4004 enum AVColorPrimaries color_primaries;
4005 enum AVColorTransferCharacteristic color_trc;
4006 enum AVColorSpace color_space;
4007 enum AVChromaLocation chroma_location;
4010 * Video only. Number of delayed frames.
4015 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4016 * unknown or unspecified, otherwise the number of bits set must be equal to
4017 * the channels field.
4019 uint64_t channel_layout;
4021 * Audio only. The number of audio channels.
4025 * Audio only. The number of audio samples per second.
4029 * Audio only. The number of bytes per coded audio frame, required by some
4032 * Corresponds to nBlockAlign in WAVEFORMATEX.
4036 * Audio only. Audio frame size, if known. Required by some formats to be static.
4041 * Audio only. The amount of padding (in samples) inserted by the encoder at
4042 * the beginning of the audio. I.e. this number of leading decoded samples
4043 * must be discarded by the caller to get the original audio without leading
4046 int initial_padding;
4048 * Audio only. The amount of padding (in samples) appended by the encoder to
4049 * the end of the audio. I.e. this number of decoded samples must be
4050 * discarded by the caller from the end of the stream to get the original
4051 * audio without any trailing padding.
4053 int trailing_padding;
4055 * Audio only. Number of samples to skip after a discontinuity.
4058 } AVCodecParameters;
4061 * Iterate over all registered codecs.
4063 * @param opaque a pointer where libavcodec will store the iteration state. Must
4064 * point to NULL to start the iteration.
4066 * @return the next registered codec or NULL when the iteration is
4069 const AVCodec *av_codec_iterate(void **opaque);
4073 * If c is NULL, returns the first registered codec,
4074 * if c is non-NULL, returns the next registered codec after c,
4075 * or NULL if c is the last one.
4077 attribute_deprecated
4078 AVCodec *av_codec_next(const AVCodec *c);
4082 * Return the LIBAVCODEC_VERSION_INT constant.
4084 unsigned avcodec_version(void);
4087 * Return the libavcodec build-time configuration.
4089 const char *avcodec_configuration(void);
4092 * Return the libavcodec license.
4094 const char *avcodec_license(void);
4098 * Register the codec codec and initialize libavcodec.
4100 * @warning either this function or avcodec_register_all() must be called
4101 * before any other libavcodec functions.
4103 * @see avcodec_register_all()
4105 attribute_deprecated
4106 void avcodec_register(AVCodec *codec);
4109 * Register all the codecs, parsers and bitstream filters which were enabled at
4110 * configuration time. If you do not call this function you can select exactly
4111 * which formats you want to support, by using the individual registration
4114 * @see avcodec_register
4115 * @see av_register_codec_parser
4116 * @see av_register_bitstream_filter
4118 attribute_deprecated
4119 void avcodec_register_all(void);
4123 * Allocate an AVCodecContext and set its fields to default values. The
4124 * resulting struct should be freed with avcodec_free_context().
4126 * @param codec if non-NULL, allocate private data and initialize defaults
4127 * for the given codec. It is illegal to then call avcodec_open2()
4128 * with a different codec.
4129 * If NULL, then the codec-specific defaults won't be initialized,
4130 * which may result in suboptimal default settings (this is
4131 * important mainly for encoders, e.g. libx264).
4133 * @return An AVCodecContext filled with default values or NULL on failure.
4135 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4138 * Free the codec context and everything associated with it and write NULL to
4139 * the provided pointer.
4141 void avcodec_free_context(AVCodecContext **avctx);
4143 #if FF_API_GET_CONTEXT_DEFAULTS
4145 * @deprecated This function should not be used, as closing and opening a codec
4146 * context multiple time is not supported. A new codec context should be
4147 * allocated for each new use.
4149 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4153 * Get the AVClass for AVCodecContext. It can be used in combination with
4154 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4156 * @see av_opt_find().
4158 const AVClass *avcodec_get_class(void);
4160 #if FF_API_COPY_CONTEXT
4162 * Get the AVClass for AVFrame. It can be used in combination with
4163 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4165 * @see av_opt_find().
4167 const AVClass *avcodec_get_frame_class(void);
4170 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4171 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4173 * @see av_opt_find().
4175 const AVClass *avcodec_get_subtitle_rect_class(void);
4178 * Copy the settings of the source AVCodecContext into the destination
4179 * AVCodecContext. The resulting destination codec context will be
4180 * unopened, i.e. you are required to call avcodec_open2() before you
4181 * can use this AVCodecContext to decode/encode video/audio data.
4183 * @param dest target codec context, should be initialized with
4184 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4185 * @param src source codec context
4186 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4188 * @deprecated The semantics of this function are ill-defined and it should not
4189 * be used. If you need to transfer the stream parameters from one codec context
4190 * to another, use an intermediate AVCodecParameters instance and the
4191 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4194 attribute_deprecated
4195 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4199 * Allocate a new AVCodecParameters and set its fields to default values
4200 * (unknown/invalid/0). The returned struct must be freed with
4201 * avcodec_parameters_free().
4203 AVCodecParameters *avcodec_parameters_alloc(void);
4206 * Free an AVCodecParameters instance and everything associated with it and
4207 * write NULL to the supplied pointer.
4209 void avcodec_parameters_free(AVCodecParameters **par);
4212 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4213 * replaced with newly allocated duplicates of the corresponding fields in src.
4215 * @return >= 0 on success, a negative AVERROR code on failure.
4217 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4220 * Fill the parameters struct based on the values from the supplied codec
4221 * context. Any allocated fields in par are freed and replaced with duplicates
4222 * of the corresponding fields in codec.
4224 * @return >= 0 on success, a negative AVERROR code on failure
4226 int avcodec_parameters_from_context(AVCodecParameters *par,
4227 const AVCodecContext *codec);
4230 * Fill the codec context based on the values from the supplied codec
4231 * parameters. Any allocated fields in codec that have a corresponding field in
4232 * par are freed and replaced with duplicates of the corresponding field in par.
4233 * Fields in codec that do not have a counterpart in par are not touched.
4235 * @return >= 0 on success, a negative AVERROR code on failure.
4237 int avcodec_parameters_to_context(AVCodecContext *codec,
4238 const AVCodecParameters *par);
4241 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4242 * function the context has to be allocated with avcodec_alloc_context3().
4244 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4245 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4246 * retrieving a codec.
4248 * @warning This function is not thread safe!
4250 * @note Always call this function before using decoding routines (such as
4251 * @ref avcodec_receive_frame()).
4254 * avcodec_register_all();
4255 * av_dict_set(&opts, "b", "2.5M", 0);
4256 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4260 * context = avcodec_alloc_context3(codec);
4262 * if (avcodec_open2(context, codec, opts) < 0)
4266 * @param avctx The context to initialize.
4267 * @param codec The codec to open this context for. If a non-NULL codec has been
4268 * previously passed to avcodec_alloc_context3() or
4269 * for this context, then this parameter MUST be either NULL or
4270 * equal to the previously passed codec.
4271 * @param options A dictionary filled with AVCodecContext and codec-private options.
4272 * On return this object will be filled with options that were not found.
4274 * @return zero on success, a negative value on error
4275 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4276 * av_dict_set(), av_opt_find().
4278 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4281 * Close a given AVCodecContext and free all the data associated with it
4282 * (but not the AVCodecContext itself).
4284 * Calling this function on an AVCodecContext that hasn't been opened will free
4285 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4286 * codec. Subsequent calls will do nothing.
4288 * @note Do not use this function. Use avcodec_free_context() to destroy a
4289 * codec context (either open or closed). Opening and closing a codec context
4290 * multiple times is not supported anymore -- use multiple codec contexts
4293 int avcodec_close(AVCodecContext *avctx);
4296 * Free all allocated data in the given subtitle struct.
4298 * @param sub AVSubtitle to free.
4300 void avsubtitle_free(AVSubtitle *sub);
4307 * @addtogroup lavc_packet
4312 * Allocate an AVPacket and set its fields to default values. The resulting
4313 * struct must be freed using av_packet_free().
4315 * @return An AVPacket filled with default values or NULL on failure.
4317 * @note this only allocates the AVPacket itself, not the data buffers. Those
4318 * must be allocated through other means such as av_new_packet.
4320 * @see av_new_packet
4322 AVPacket *av_packet_alloc(void);
4325 * Create a new packet that references the same data as src.
4327 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4329 * @return newly created AVPacket on success, NULL on error.
4331 * @see av_packet_alloc
4332 * @see av_packet_ref
4334 AVPacket *av_packet_clone(const AVPacket *src);
4337 * Free the packet, if the packet is reference counted, it will be
4338 * unreferenced first.
4340 * @param pkt packet to be freed. The pointer will be set to NULL.
4341 * @note passing NULL is a no-op.
4343 void av_packet_free(AVPacket **pkt);
4346 * Initialize optional fields of a packet with default values.
4348 * Note, this does not touch the data and size members, which have to be
4349 * initialized separately.
4353 void av_init_packet(AVPacket *pkt);
4356 * Allocate the payload of a packet and initialize its fields with
4360 * @param size wanted payload size
4361 * @return 0 if OK, AVERROR_xxx otherwise
4363 int av_new_packet(AVPacket *pkt, int size);
4366 * Reduce packet size, correctly zeroing padding
4369 * @param size new size
4371 void av_shrink_packet(AVPacket *pkt, int size);
4374 * Increase packet size, correctly zeroing padding
4377 * @param grow_by number of bytes by which to increase the size of the packet
4379 int av_grow_packet(AVPacket *pkt, int grow_by);
4382 * Initialize a reference-counted packet from av_malloc()ed data.
4384 * @param pkt packet to be initialized. This function will set the data, size,
4385 * buf and destruct fields, all others are left untouched.
4386 * @param data Data allocated by av_malloc() to be used as packet data. If this
4387 * function returns successfully, the data is owned by the underlying AVBuffer.
4388 * The caller may not access the data through other means.
4389 * @param size size of data in bytes, without the padding. I.e. the full buffer
4390 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4392 * @return 0 on success, a negative AVERROR on error
4394 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4396 #if FF_API_AVPACKET_OLD_API
4398 * @warning This is a hack - the packet memory allocation stuff is broken. The
4399 * packet is allocated if it was not really allocated.
4401 * @deprecated Use av_packet_ref or av_packet_make_refcounted
4403 attribute_deprecated
4404 int av_dup_packet(AVPacket *pkt);
4406 * Copy packet, including contents
4408 * @return 0 on success, negative AVERROR on fail
4410 * @deprecated Use av_packet_ref
4412 attribute_deprecated
4413 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4416 * Copy packet side data
4418 * @return 0 on success, negative AVERROR on fail
4420 * @deprecated Use av_packet_copy_props
4422 attribute_deprecated
4423 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4428 * @deprecated Use av_packet_unref
4430 * @param pkt packet to free
4432 attribute_deprecated
4433 void av_free_packet(AVPacket *pkt);
4436 * Allocate new information of a packet.
4439 * @param type side information type
4440 * @param size side information size
4441 * @return pointer to fresh allocated data or NULL otherwise
4443 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4447 * Wrap an existing array as a packet side data.
4450 * @param type side information type
4451 * @param data the side data array. It must be allocated with the av_malloc()
4452 * family of functions. The ownership of the data is transferred to
4454 * @param size side information size
4455 * @return a non-negative number on success, a negative AVERROR code on
4456 * failure. On failure, the packet is unchanged and the data remains
4457 * owned by the caller.
4459 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4460 uint8_t *data, size_t size);
4463 * Shrink the already allocated side data buffer
4466 * @param type side information type
4467 * @param size new side information size
4468 * @return 0 on success, < 0 on failure
4470 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4474 * Get side information from packet.
4477 * @param type desired side information type
4478 * @param size pointer for side information size to store (optional)
4479 * @return pointer to data if present or NULL otherwise
4481 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4484 #if FF_API_MERGE_SD_API
4485 attribute_deprecated
4486 int av_packet_merge_side_data(AVPacket *pkt);
4488 attribute_deprecated
4489 int av_packet_split_side_data(AVPacket *pkt);
4492 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4495 * Pack a dictionary for use in side_data.
4497 * @param dict The dictionary to pack.
4498 * @param size pointer to store the size of the returned data
4499 * @return pointer to data if successful, NULL otherwise
4501 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4503 * Unpack a dictionary from side_data.
4505 * @param data data from side_data
4506 * @param size size of the data
4507 * @param dict the metadata storage dictionary
4508 * @return 0 on success, < 0 on failure
4510 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4514 * Convenience function to free all the side data stored.
4515 * All the other fields stay untouched.
4519 void av_packet_free_side_data(AVPacket *pkt);
4522 * Setup a new reference to the data described by a given packet
4524 * If src is reference-counted, setup dst as a new reference to the
4525 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4526 * data from src into it.
4528 * All the other fields are copied from src.
4530 * @see av_packet_unref
4532 * @param dst Destination packet
4533 * @param src Source packet
4535 * @return 0 on success, a negative AVERROR on error.
4537 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4542 * Unreference the buffer referenced by the packet and reset the
4543 * remaining packet fields to their default values.
4545 * @param pkt The packet to be unreferenced.
4547 void av_packet_unref(AVPacket *pkt);
4550 * Move every field in src to dst and reset src.
4552 * @see av_packet_unref
4554 * @param src Source packet, will be reset
4555 * @param dst Destination packet
4557 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4560 * Copy only "properties" fields from src to dst.
4562 * Properties for the purpose of this function are all the fields
4563 * beside those related to the packet data (buf, data, size)
4565 * @param dst Destination packet
4566 * @param src Source packet
4568 * @return 0 on success AVERROR on failure.
4570 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4573 * Ensure the data described by a given packet is reference counted.
4575 * @note This function does not ensure that the reference will be writable.
4576 * Use av_packet_make_writable instead for that purpose.
4578 * @see av_packet_ref
4579 * @see av_packet_make_writable
4581 * @param pkt packet whose data should be made reference counted.
4583 * @return 0 on success, a negative AVERROR on error. On failure, the
4584 * packet is unchanged.
4586 int av_packet_make_refcounted(AVPacket *pkt);
4589 * Create a writable reference for the data described by a given packet,
4590 * avoiding data copy if possible.
4592 * @param pkt Packet whose data should be made writable.
4594 * @return 0 on success, a negative AVERROR on failure. On failure, the
4595 * packet is unchanged.
4597 int av_packet_make_writable(AVPacket *pkt);
4600 * Convert valid timing fields (timestamps / durations) in a packet from one
4601 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4604 * @param pkt packet on which the conversion will be performed
4605 * @param tb_src source timebase, in which the timing fields in pkt are
4607 * @param tb_dst destination timebase, to which the timing fields will be
4610 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4617 * @addtogroup lavc_decoding
4622 * Find a registered decoder with a matching codec ID.
4624 * @param id AVCodecID of the requested decoder
4625 * @return A decoder if one was found, NULL otherwise.
4627 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4630 * Find a registered decoder with the specified name.
4632 * @param name name of the requested decoder
4633 * @return A decoder if one was found, NULL otherwise.
4635 AVCodec *avcodec_find_decoder_by_name(const char *name);
4638 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4639 * it can be called by custom get_buffer2() implementations for decoders without
4640 * AV_CODEC_CAP_DR1 set.
4642 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4645 * Modify width and height values so that they will result in a memory
4646 * buffer that is acceptable for the codec if you do not use any horizontal
4649 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4651 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4654 * Modify width and height values so that they will result in a memory
4655 * buffer that is acceptable for the codec if you also ensure that all
4656 * line sizes are a multiple of the respective linesize_align[i].
4658 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4660 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4661 int linesize_align[AV_NUM_DATA_POINTERS]);
4664 * Converts AVChromaLocation to swscale x/y chroma position.
4666 * The positions represent the chroma (0,0) position in a coordinates system
4667 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4669 * @param xpos horizontal chroma sample position
4670 * @param ypos vertical chroma sample position
4672 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4675 * Converts swscale x/y chroma position to AVChromaLocation.
4677 * The positions represent the chroma (0,0) position in a coordinates system
4678 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4680 * @param xpos horizontal chroma sample position
4681 * @param ypos vertical chroma sample position
4683 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4686 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4688 * Some decoders may support multiple frames in a single AVPacket. Such
4689 * decoders would then just decode the first frame and the return value would be
4690 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4691 * called again with an AVPacket containing the remaining data in order to
4692 * decode the second frame, etc... Even if no frames are returned, the packet
4693 * needs to be fed to the decoder with remaining data until it is completely
4694 * consumed or an error occurs.
4696 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4697 * and output. This means that for some packets they will not immediately
4698 * produce decoded output and need to be flushed at the end of decoding to get
4699 * all the decoded data. Flushing is done by calling this function with packets
4700 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4701 * returning samples. It is safe to flush even those decoders that are not
4702 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4704 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4705 * larger than the actual read bytes because some optimized bitstream
4706 * readers read 32 or 64 bits at once and could read over the end.
4708 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4709 * before packets may be fed to the decoder.
4711 * @param avctx the codec context
4712 * @param[out] frame The AVFrame in which to store decoded audio samples.
4713 * The decoder will allocate a buffer for the decoded frame by
4714 * calling the AVCodecContext.get_buffer2() callback.
4715 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4716 * reference counted and the returned reference belongs to the
4717 * caller. The caller must release the frame using av_frame_unref()
4718 * when the frame is no longer needed. The caller may safely write
4719 * to the frame if av_frame_is_writable() returns 1.
4720 * When AVCodecContext.refcounted_frames is set to 0, the returned
4721 * reference belongs to the decoder and is valid only until the
4722 * next call to this function or until closing or flushing the
4723 * decoder. The caller may not write to it.
4724 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4725 * non-zero. Note that this field being set to zero
4726 * does not mean that an error has occurred. For
4727 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4728 * call is guaranteed to produce a frame.
4729 * @param[in] avpkt The input AVPacket containing the input buffer.
4730 * At least avpkt->data and avpkt->size should be set. Some
4731 * decoders might also require additional fields to be set.
4732 * @return A negative error code is returned if an error occurred during
4733 * decoding, otherwise the number of bytes consumed from the input
4734 * AVPacket is returned.
4736 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4738 attribute_deprecated
4739 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4740 int *got_frame_ptr, const AVPacket *avpkt);
4743 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4744 * Some decoders may support multiple frames in a single AVPacket, such
4745 * decoders would then just decode the first frame.
4747 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4748 * the actual read bytes because some optimized bitstream readers read 32 or 64
4749 * bits at once and could read over the end.
4751 * @warning The end of the input buffer buf should be set to 0 to ensure that
4752 * no overreading happens for damaged MPEG streams.
4754 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4755 * between input and output, these need to be fed with avpkt->data=NULL,
4756 * avpkt->size=0 at the end to return the remaining frames.
4758 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4759 * before packets may be fed to the decoder.
4761 * @param avctx the codec context
4762 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4763 * Use av_frame_alloc() to get an AVFrame. The codec will
4764 * allocate memory for the actual bitmap by calling the
4765 * AVCodecContext.get_buffer2() callback.
4766 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4767 * reference counted and the returned reference belongs to the
4768 * caller. The caller must release the frame using av_frame_unref()
4769 * when the frame is no longer needed. The caller may safely write
4770 * to the frame if av_frame_is_writable() returns 1.
4771 * When AVCodecContext.refcounted_frames is set to 0, the returned
4772 * reference belongs to the decoder and is valid only until the
4773 * next call to this function or until closing or flushing the
4774 * decoder. The caller may not write to it.
4776 * @param[in] avpkt The input AVPacket containing the input buffer.
4777 * You can create such packet with av_init_packet() and by then setting
4778 * data and size, some decoders might in addition need other fields like
4779 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4781 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4782 * @return On error a negative value is returned, otherwise the number of bytes
4783 * used or zero if no frame could be decompressed.
4785 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4787 attribute_deprecated
4788 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4789 int *got_picture_ptr,
4790 const AVPacket *avpkt);
4793 * Decode a subtitle message.
4794 * Return a negative value on error, otherwise return the number of bytes used.
4795 * If no subtitle could be decompressed, got_sub_ptr is zero.
4796 * Otherwise, the subtitle is stored in *sub.
4797 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4798 * simplicity, because the performance difference is expect to be negligible
4799 * and reusing a get_buffer written for video codecs would probably perform badly
4800 * due to a potentially very different allocation pattern.
4802 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4803 * and output. This means that for some packets they will not immediately
4804 * produce decoded output and need to be flushed at the end of decoding to get
4805 * all the decoded data. Flushing is done by calling this function with packets
4806 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4807 * returning subtitles. It is safe to flush even those decoders that are not
4808 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4810 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4811 * before packets may be fed to the decoder.
4813 * @param avctx the codec context
4814 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4815 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4816 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4817 * @param[in] avpkt The input AVPacket containing the input buffer.
4819 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4824 * Supply raw packet data as input to a decoder.
4826 * Internally, this call will copy relevant AVCodecContext fields, which can
4827 * influence decoding per-packet, and apply them when the packet is actually
4828 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4829 * decoder to drop the frame contained by the packet sent with this function.)
4831 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4832 * larger than the actual read bytes because some optimized bitstream
4833 * readers read 32 or 64 bits at once and could read over the end.
4835 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4836 * on the same AVCodecContext. It will return unexpected results now
4837 * or in future libavcodec versions.
4839 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4840 * before packets may be fed to the decoder.
4842 * @param avctx codec context
4843 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4844 * frame, or several complete audio frames.
4845 * Ownership of the packet remains with the caller, and the
4846 * decoder will not write to the packet. The decoder may create
4847 * a reference to the packet data (or copy it if the packet is
4848 * not reference-counted).
4849 * Unlike with older APIs, the packet is always fully consumed,
4850 * and if it contains multiple frames (e.g. some audio codecs),
4851 * will require you to call avcodec_receive_frame() multiple
4852 * times afterwards before you can send a new packet.
4853 * It can be NULL (or an AVPacket with data set to NULL and
4854 * size set to 0); in this case, it is considered a flush
4855 * packet, which signals the end of the stream. Sending the
4856 * first flush packet will return success. Subsequent ones are
4857 * unnecessary and will return AVERROR_EOF. If the decoder
4858 * still has frames buffered, it will return them after sending
4861 * @return 0 on success, otherwise negative error code:
4862 * AVERROR(EAGAIN): input is not accepted in the current state - user
4863 * must read output with avcodec_receive_frame() (once
4864 * all output is read, the packet should be resent, and
4865 * the call will not fail with EAGAIN).
4866 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4867 * be sent to it (also returned if more than 1 flush
4869 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4870 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4871 * other errors: legitimate decoding errors
4873 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4876 * Return decoded output data from a decoder.
4878 * @param avctx codec context
4879 * @param frame This will be set to a reference-counted video or audio
4880 * frame (depending on the decoder type) allocated by the
4881 * decoder. Note that the function will always call
4882 * av_frame_unref(frame) before doing anything else.
4885 * 0: success, a frame was returned
4886 * AVERROR(EAGAIN): output is not available in this state - user must try
4888 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4889 * no more output frames
4890 * AVERROR(EINVAL): codec not opened, or it is an encoder
4891 * other negative values: legitimate decoding errors
4893 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4896 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4897 * to retrieve buffered output packets.
4899 * @param avctx codec context
4900 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4901 * Ownership of the frame remains with the caller, and the
4902 * encoder will not write to the frame. The encoder may create
4903 * a reference to the frame data (or copy it if the frame is
4904 * not reference-counted).
4905 * It can be NULL, in which case it is considered a flush
4906 * packet. This signals the end of the stream. If the encoder
4907 * still has packets buffered, it will return them after this
4908 * call. Once flushing mode has been entered, additional flush
4909 * packets are ignored, and sending frames will return
4913 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4914 * can have any number of samples.
4915 * If it is not set, frame->nb_samples must be equal to
4916 * avctx->frame_size for all frames except the last.
4917 * The final frame may be smaller than avctx->frame_size.
4918 * @return 0 on success, otherwise negative error code:
4919 * AVERROR(EAGAIN): input is not accepted in the current state - user
4920 * must read output with avcodec_receive_packet() (once
4921 * all output is read, the packet should be resent, and
4922 * the call will not fail with EAGAIN).
4923 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4925 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4926 * decoder, or requires flush
4927 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4928 * other errors: legitimate decoding errors
4930 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4933 * Read encoded data from the encoder.
4935 * @param avctx codec context
4936 * @param avpkt This will be set to a reference-counted packet allocated by the
4937 * encoder. Note that the function will always call
4938 * av_frame_unref(frame) before doing anything else.
4939 * @return 0 on success, otherwise negative error code:
4940 * AVERROR(EAGAIN): output is not available in the current state - user
4941 * must try to send input
4942 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4943 * no more output packets
4944 * AVERROR(EINVAL): codec not opened, or it is an encoder
4945 * other errors: legitimate decoding errors
4947 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4950 * Create and return a AVHWFramesContext with values adequate for hardware
4951 * decoding. This is meant to get called from the get_format callback, and is
4952 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
4953 * This API is for decoding with certain hardware acceleration modes/APIs only.
4955 * The returned AVHWFramesContext is not initialized. The caller must do this
4956 * with av_hwframe_ctx_init().
4958 * Calling this function is not a requirement, but makes it simpler to avoid
4959 * codec or hardware API specific details when manually allocating frames.
4961 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
4962 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
4963 * it unnecessary to call this function or having to care about
4964 * AVHWFramesContext initialization at all.
4966 * There are a number of requirements for calling this function:
4968 * - It must be called from get_format with the same avctx parameter that was
4969 * passed to get_format. Calling it outside of get_format is not allowed, and
4970 * can trigger undefined behavior.
4971 * - The function is not always supported (see description of return values).
4972 * Even if this function returns successfully, hwaccel initialization could
4973 * fail later. (The degree to which implementations check whether the stream
4974 * is actually supported varies. Some do this check only after the user's
4975 * get_format callback returns.)
4976 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
4977 * user decides to use a AVHWFramesContext prepared with this API function,
4978 * the user must return the same hw_pix_fmt from get_format.
4979 * - The device_ref passed to this function must support the given hw_pix_fmt.
4980 * - After calling this API function, it is the user's responsibility to
4981 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
4982 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
4983 * before returning from get_format (this is implied by the normal
4984 * AVCodecContext.hw_frames_ctx API rules).
4985 * - The AVHWFramesContext parameters may change every time time get_format is
4986 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
4987 * you are inherently required to go through this process again on every
4989 * - It is perfectly possible to call this function without actually using
4990 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
4991 * previously initialized AVHWFramesContext, and calling this API function
4992 * only to test whether the required frame parameters have changed.
4993 * - Fields that use dynamically allocated values of any kind must not be set
4994 * by the user unless setting them is explicitly allowed by the documentation.
4995 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
4996 * the new free callback must call the potentially set previous free callback.
4997 * This API call may set any dynamically allocated fields, including the free
5000 * The function will set at least the following fields on AVHWFramesContext
5001 * (potentially more, depending on hwaccel API):
5003 * - All fields set by av_hwframe_ctx_alloc().
5004 * - Set the format field to hw_pix_fmt.
5005 * - Set the sw_format field to the most suited and most versatile format. (An
5006 * implication is that this will prefer generic formats over opaque formats
5007 * with arbitrary restrictions, if possible.)
5008 * - Set the width/height fields to the coded frame size, rounded up to the
5009 * API-specific minimum alignment.
5010 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
5011 * field to the number of maximum reference surfaces possible with the codec,
5012 * plus 1 surface for the user to work (meaning the user can safely reference
5013 * at most 1 decoded surface at a time), plus additional buffering introduced
5014 * by frame threading. If the hwaccel does not require pre-allocation, the
5015 * field is left to 0, and the decoder will allocate new surfaces on demand
5017 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
5020 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
5021 * with basic frame parameters set.
5023 * The function is stateless, and does not change the AVCodecContext or the
5024 * device_ref AVHWDeviceContext.
5026 * @param avctx The context which is currently calling get_format, and which
5027 * implicitly contains all state needed for filling the returned
5028 * AVHWFramesContext properly.
5029 * @param device_ref A reference to the AVHWDeviceContext describing the device
5030 * which will be used by the hardware decoder.
5031 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
5032 * @param out_frames_ref On success, set to a reference to an _uninitialized_
5033 * AVHWFramesContext, created from the given device_ref.
5034 * Fields will be set to values required for decoding.
5035 * Not changed if an error is returned.
5036 * @return zero on success, a negative value on error. The following error codes
5037 * have special semantics:
5038 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
5039 * is always manual, or it is a decoder which does not
5040 * support setting AVCodecContext.hw_frames_ctx at all,
5041 * or it is a software format.
5042 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
5043 * this configuration, or the device_ref is not supported
5044 * for the hwaccel referenced by hw_pix_fmt.
5046 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
5047 AVBufferRef *device_ref,
5048 enum AVPixelFormat hw_pix_fmt,
5049 AVBufferRef **out_frames_ref);
5054 * @defgroup lavc_parsing Frame parsing
5058 enum AVPictureStructure {
5059 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5060 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5061 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5062 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5065 typedef struct AVCodecParserContext {
5067 struct AVCodecParser *parser;
5068 int64_t frame_offset; /* offset of the current frame */
5069 int64_t cur_offset; /* current offset
5070 (incremented by each av_parser_parse()) */
5071 int64_t next_frame_offset; /* offset of the next frame */
5073 int pict_type; /* XXX: Put it back in AVCodecContext. */
5075 * This field is used for proper frame duration computation in lavf.
5076 * It signals, how much longer the frame duration of the current frame
5077 * is compared to normal frame duration.
5079 * frame_duration = (1 + repeat_pict) * time_base
5081 * It is used by codecs like H.264 to display telecined material.
5083 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5084 int64_t pts; /* pts of the current frame */
5085 int64_t dts; /* dts of the current frame */
5090 int fetch_timestamp;
5092 #define AV_PARSER_PTS_NB 4
5093 int cur_frame_start_index;
5094 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5095 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5096 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5099 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5100 #define PARSER_FLAG_ONCE 0x0002
5101 /// Set if the parser has a valid file offset
5102 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5103 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5105 int64_t offset; ///< byte offset from starting packet start
5106 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5109 * Set by parser to 1 for key frames and 0 for non-key frames.
5110 * It is initialized to -1, so if the parser doesn't set this flag,
5111 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5116 #if FF_API_CONVERGENCE_DURATION
5118 * @deprecated unused
5120 attribute_deprecated
5121 int64_t convergence_duration;
5124 // Timestamp generation support:
5126 * Synchronization point for start of timestamp generation.
5128 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5131 * For example, this corresponds to presence of H.264 buffering period
5137 * Offset of the current timestamp against last timestamp sync point in
5138 * units of AVCodecContext.time_base.
5140 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5141 * contain a valid timestamp offset.
5143 * Note that the timestamp of sync point has usually a nonzero
5144 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5145 * the next frame after timestamp sync point will be usually 1.
5147 * For example, this corresponds to H.264 cpb_removal_delay.
5149 int dts_ref_dts_delta;
5152 * Presentation delay of current frame in units of AVCodecContext.time_base.
5154 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5155 * contain valid non-negative timestamp delta (presentation time of a frame
5156 * must not lie in the past).
5158 * This delay represents the difference between decoding and presentation
5159 * time of the frame.
5161 * For example, this corresponds to H.264 dpb_output_delay.
5166 * Position of the packet in file.
5168 * Analogous to cur_frame_pts/dts
5170 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5173 * Byte position of currently parsed frame in stream.
5178 * Previous frame byte position.
5183 * Duration of the current frame.
5184 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5185 * For all other types, this is in units of AVCodecContext.time_base.
5189 enum AVFieldOrder field_order;
5192 * Indicate whether a picture is coded as a frame, top field or bottom field.
5194 * For example, H.264 field_pic_flag equal to 0 corresponds to
5195 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5196 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5197 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5199 enum AVPictureStructure picture_structure;
5202 * Picture number incremented in presentation or output order.
5203 * This field may be reinitialized at the first picture of a new sequence.
5205 * For example, this corresponds to H.264 PicOrderCnt.
5207 int output_picture_number;
5210 * Dimensions of the decoded video intended for presentation.
5216 * Dimensions of the coded video.
5222 * The format of the coded data, corresponds to enum AVPixelFormat for video
5223 * and for enum AVSampleFormat for audio.
5225 * Note that a decoder can have considerable freedom in how exactly it
5226 * decodes the data, so the format reported here might be different from the
5227 * one returned by a decoder.
5230 } AVCodecParserContext;
5232 typedef struct AVCodecParser {
5233 int codec_ids[5]; /* several codec IDs are permitted */
5235 int (*parser_init)(AVCodecParserContext *s);
5236 /* This callback never returns an error, a negative value means that
5237 * the frame start was in a previous packet. */
5238 int (*parser_parse)(AVCodecParserContext *s,
5239 AVCodecContext *avctx,
5240 const uint8_t **poutbuf, int *poutbuf_size,
5241 const uint8_t *buf, int buf_size);
5242 void (*parser_close)(AVCodecParserContext *s);
5243 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5244 struct AVCodecParser *next;
5248 * Iterate over all registered codec parsers.
5250 * @param opaque a pointer where libavcodec will store the iteration state. Must
5251 * point to NULL to start the iteration.
5253 * @return the next registered codec parser or NULL when the iteration is
5256 const AVCodecParser *av_parser_iterate(void **opaque);
5258 attribute_deprecated
5259 AVCodecParser *av_parser_next(const AVCodecParser *c);
5261 attribute_deprecated
5262 void av_register_codec_parser(AVCodecParser *parser);
5263 AVCodecParserContext *av_parser_init(int codec_id);
5268 * @param s parser context.
5269 * @param avctx codec context.
5270 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5271 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5272 * @param buf input buffer.
5273 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5274 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5275 To signal EOF, this should be 0 (so that the last frame
5277 * @param pts input presentation timestamp.
5278 * @param dts input decoding timestamp.
5279 * @param pos input byte position in stream.
5280 * @return the number of bytes of the input bitstream used.
5285 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5292 * decode_frame(data, size);
5296 int av_parser_parse2(AVCodecParserContext *s,
5297 AVCodecContext *avctx,
5298 uint8_t **poutbuf, int *poutbuf_size,
5299 const uint8_t *buf, int buf_size,
5300 int64_t pts, int64_t dts,
5304 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5305 * @deprecated use AVBitStreamFilter
5307 int av_parser_change(AVCodecParserContext *s,
5308 AVCodecContext *avctx,
5309 uint8_t **poutbuf, int *poutbuf_size,
5310 const uint8_t *buf, int buf_size, int keyframe);
5311 void av_parser_close(AVCodecParserContext *s);
5319 * @addtogroup lavc_encoding
5324 * Find a registered encoder with a matching codec ID.
5326 * @param id AVCodecID of the requested encoder
5327 * @return An encoder if one was found, NULL otherwise.
5329 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5332 * Find a registered encoder with the specified name.
5334 * @param name name of the requested encoder
5335 * @return An encoder if one was found, NULL otherwise.
5337 AVCodec *avcodec_find_encoder_by_name(const char *name);
5340 * Encode a frame of audio.
5342 * Takes input samples from frame and writes the next output packet, if
5343 * available, to avpkt. The output packet does not necessarily contain data for
5344 * the most recent frame, as encoders can delay, split, and combine input frames
5345 * internally as needed.
5347 * @param avctx codec context
5348 * @param avpkt output AVPacket.
5349 * The user can supply an output buffer by setting
5350 * avpkt->data and avpkt->size prior to calling the
5351 * function, but if the size of the user-provided data is not
5352 * large enough, encoding will fail. If avpkt->data and
5353 * avpkt->size are set, avpkt->destruct must also be set. All
5354 * other AVPacket fields will be reset by the encoder using
5355 * av_init_packet(). If avpkt->data is NULL, the encoder will
5356 * allocate it. The encoder will set avpkt->size to the size
5357 * of the output packet.
5359 * If this function fails or produces no output, avpkt will be
5360 * freed using av_packet_unref().
5361 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5362 * May be NULL when flushing an encoder that has the
5363 * AV_CODEC_CAP_DELAY capability set.
5364 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5365 * can have any number of samples.
5366 * If it is not set, frame->nb_samples must be equal to
5367 * avctx->frame_size for all frames except the last.
5368 * The final frame may be smaller than avctx->frame_size.
5369 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5370 * output packet is non-empty, and to 0 if it is
5371 * empty. If the function returns an error, the
5372 * packet can be assumed to be invalid, and the
5373 * value of got_packet_ptr is undefined and should
5375 * @return 0 on success, negative error code on failure
5377 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5379 attribute_deprecated
5380 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5381 const AVFrame *frame, int *got_packet_ptr);
5384 * Encode a frame of video.
5386 * Takes input raw video data from frame and writes the next output packet, if
5387 * available, to avpkt. The output packet does not necessarily contain data for
5388 * the most recent frame, as encoders can delay and reorder input frames
5389 * internally as needed.
5391 * @param avctx codec context
5392 * @param avpkt output AVPacket.
5393 * The user can supply an output buffer by setting
5394 * avpkt->data and avpkt->size prior to calling the
5395 * function, but if the size of the user-provided data is not
5396 * large enough, encoding will fail. All other AVPacket fields
5397 * will be reset by the encoder using av_init_packet(). If
5398 * avpkt->data is NULL, the encoder will allocate it.
5399 * The encoder will set avpkt->size to the size of the
5400 * output packet. The returned data (if any) belongs to the
5401 * caller, he is responsible for freeing it.
5403 * If this function fails or produces no output, avpkt will be
5404 * freed using av_packet_unref().
5405 * @param[in] frame AVFrame containing the raw video data to be encoded.
5406 * May be NULL when flushing an encoder that has the
5407 * AV_CODEC_CAP_DELAY capability set.
5408 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5409 * output packet is non-empty, and to 0 if it is
5410 * empty. If the function returns an error, the
5411 * packet can be assumed to be invalid, and the
5412 * value of got_packet_ptr is undefined and should
5414 * @return 0 on success, negative error code on failure
5416 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5418 attribute_deprecated
5419 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5420 const AVFrame *frame, int *got_packet_ptr);
5422 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5423 const AVSubtitle *sub);
5430 #if FF_API_AVPICTURE
5432 * @addtogroup lavc_picture
5437 * @deprecated unused
5439 attribute_deprecated
5440 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5443 * @deprecated unused
5445 attribute_deprecated
5446 void avpicture_free(AVPicture *picture);
5449 * @deprecated use av_image_fill_arrays() instead.
5451 attribute_deprecated
5452 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5453 enum AVPixelFormat pix_fmt, int width, int height);
5456 * @deprecated use av_image_copy_to_buffer() instead.
5458 attribute_deprecated
5459 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5460 int width, int height,
5461 unsigned char *dest, int dest_size);
5464 * @deprecated use av_image_get_buffer_size() instead.
5466 attribute_deprecated
5467 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5470 * @deprecated av_image_copy() instead.
5472 attribute_deprecated
5473 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5474 enum AVPixelFormat pix_fmt, int width, int height);
5477 * @deprecated unused
5479 attribute_deprecated
5480 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5481 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5484 * @deprecated unused
5486 attribute_deprecated
5487 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5488 int padtop, int padbottom, int padleft, int padright, int *color);
5496 * @defgroup lavc_misc Utility functions
5499 * Miscellaneous utility functions related to both encoding and decoding
5505 * @defgroup lavc_misc_pixfmt Pixel formats
5507 * Functions for working with pixel formats.
5511 #if FF_API_GETCHROMA
5513 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5516 attribute_deprecated
5517 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5521 * Return a value representing the fourCC code associated to the
5522 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5525 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5528 * @deprecated see av_get_pix_fmt_loss()
5530 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5534 * Find the best pixel format to convert to given a certain source pixel
5535 * format. When converting from one pixel format to another, information loss
5536 * may occur. For example, when converting from RGB24 to GRAY, the color
5537 * information will be lost. Similarly, other losses occur when converting from
5538 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5539 * the given pixel formats should be used to suffer the least amount of loss.
5540 * The pixel formats from which it chooses one, are determined by the
5541 * pix_fmt_list parameter.
5544 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5545 * @param[in] src_pix_fmt source pixel format
5546 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5547 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5548 * @return The best pixel format to convert to or -1 if none was found.
5550 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5551 enum AVPixelFormat src_pix_fmt,
5552 int has_alpha, int *loss_ptr);
5555 * @deprecated see av_find_best_pix_fmt_of_2()
5557 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5558 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5560 attribute_deprecated
5561 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5562 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5564 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5570 #if FF_API_TAG_STRING
5572 * Put a string representing the codec tag codec_tag in buf.
5574 * @param buf buffer to place codec tag in
5575 * @param buf_size size in bytes of buf
5576 * @param codec_tag codec tag to assign
5577 * @return the length of the string that would have been generated if
5578 * enough space had been available, excluding the trailing null
5580 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5582 attribute_deprecated
5583 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5586 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5589 * Return a name for the specified profile, if available.
5591 * @param codec the codec that is searched for the given profile
5592 * @param profile the profile value for which a name is requested
5593 * @return A name for the profile if found, NULL otherwise.
5595 const char *av_get_profile_name(const AVCodec *codec, int profile);
5598 * Return a name for the specified profile, if available.
5600 * @param codec_id the ID of the codec to which the requested profile belongs
5601 * @param profile the profile value for which a name is requested
5602 * @return A name for the profile if found, NULL otherwise.
5604 * @note unlike av_get_profile_name(), which searches a list of profiles
5605 * supported by a specific decoder or encoder implementation, this
5606 * function searches the list of profiles from the AVCodecDescriptor
5608 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5610 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5611 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5612 //FIXME func typedef
5615 * Fill AVFrame audio data and linesize pointers.
5617 * The buffer buf must be a preallocated buffer with a size big enough
5618 * to contain the specified samples amount. The filled AVFrame data
5619 * pointers will point to this buffer.
5621 * AVFrame extended_data channel pointers are allocated if necessary for
5624 * @param frame the AVFrame
5625 * frame->nb_samples must be set prior to calling the
5626 * function. This function fills in frame->data,
5627 * frame->extended_data, frame->linesize[0].
5628 * @param nb_channels channel count
5629 * @param sample_fmt sample format
5630 * @param buf buffer to use for frame data
5631 * @param buf_size size of buffer
5632 * @param align plane size sample alignment (0 = default)
5633 * @return >=0 on success, negative error code on failure
5634 * @todo return the size in bytes required to store the samples in
5635 * case of success, at the next libavutil bump
5637 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5638 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5639 int buf_size, int align);
5642 * Reset the internal decoder state / flush internal buffers. Should be called
5643 * e.g. when seeking or when switching to a different stream.
5645 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5646 * this invalidates the frames previously returned from the decoder. When
5647 * refcounted frames are used, the decoder just releases any references it might
5648 * keep internally, but the caller's reference remains valid.
5650 void avcodec_flush_buffers(AVCodecContext *avctx);
5653 * Return codec bits per sample.
5655 * @param[in] codec_id the codec
5656 * @return Number of bits per sample or zero if unknown for the given codec.
5658 int av_get_bits_per_sample(enum AVCodecID codec_id);
5661 * Return the PCM codec associated with a sample format.
5662 * @param be endianness, 0 for little, 1 for big,
5663 * -1 (or anything else) for native
5664 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5666 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5669 * Return codec bits per sample.
5670 * Only return non-zero if the bits per sample is exactly correct, not an
5673 * @param[in] codec_id the codec
5674 * @return Number of bits per sample or zero if unknown for the given codec.
5676 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5679 * Return audio frame duration.
5681 * @param avctx codec context
5682 * @param frame_bytes size of the frame, or 0 if unknown
5683 * @return frame duration, in samples, if known. 0 if not able to
5686 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5689 * This function is the same as av_get_audio_frame_duration(), except it works
5690 * with AVCodecParameters instead of an AVCodecContext.
5692 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5695 typedef struct AVBitStreamFilterContext {
5697 const struct AVBitStreamFilter *filter;
5698 AVCodecParserContext *parser;
5699 struct AVBitStreamFilterContext *next;
5701 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5702 * Not for access by library users.
5705 } AVBitStreamFilterContext;
5708 typedef struct AVBSFInternal AVBSFInternal;
5711 * The bitstream filter state.
5713 * This struct must be allocated with av_bsf_alloc() and freed with
5716 * The fields in the struct will only be changed (by the caller or by the
5717 * filter) as described in their documentation, and are to be considered
5718 * immutable otherwise.
5720 typedef struct AVBSFContext {
5722 * A class for logging and AVOptions
5724 const AVClass *av_class;
5727 * The bitstream filter this context is an instance of.
5729 const struct AVBitStreamFilter *filter;
5732 * Opaque libavcodec internal data. Must not be touched by the caller in any
5735 AVBSFInternal *internal;
5738 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5739 * this is an AVOptions-enabled struct.
5744 * Parameters of the input stream. This field is allocated in
5745 * av_bsf_alloc(), it needs to be filled by the caller before
5748 AVCodecParameters *par_in;
5751 * Parameters of the output stream. This field is allocated in
5752 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5754 AVCodecParameters *par_out;
5757 * The timebase used for the timestamps of the input packets. Set by the
5758 * caller before av_bsf_init().
5760 AVRational time_base_in;
5763 * The timebase used for the timestamps of the output packets. Set by the
5764 * filter in av_bsf_init().
5766 AVRational time_base_out;
5769 typedef struct AVBitStreamFilter {
5773 * A list of codec ids supported by the filter, terminated by
5775 * May be NULL, in that case the bitstream filter works with any codec id.
5777 const enum AVCodecID *codec_ids;
5780 * A class for the private data, used to declare bitstream filter private
5781 * AVOptions. This field is NULL for bitstream filters that do not declare
5784 * If this field is non-NULL, the first member of the filter private data
5785 * must be a pointer to AVClass, which will be set by libavcodec generic
5786 * code to this class.
5788 const AVClass *priv_class;
5790 /*****************************************************************
5791 * No fields below this line are part of the public API. They
5792 * may not be used outside of libavcodec and can be changed and
5794 * New public fields should be added right above.
5795 *****************************************************************
5799 int (*init)(AVBSFContext *ctx);
5800 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5801 void (*close)(AVBSFContext *ctx);
5802 void (*flush)(AVBSFContext *ctx);
5803 } AVBitStreamFilter;
5807 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5808 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5810 attribute_deprecated
5811 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5813 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5814 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
5815 * from the new bitstream filtering API (using AVBSFContext).
5817 attribute_deprecated
5818 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5820 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5821 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
5822 * new bitstream filtering API (using AVBSFContext).
5824 attribute_deprecated
5825 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5826 AVCodecContext *avctx, const char *args,
5827 uint8_t **poutbuf, int *poutbuf_size,
5828 const uint8_t *buf, int buf_size, int keyframe);
5830 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5831 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
5834 attribute_deprecated
5835 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5837 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5838 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
5841 attribute_deprecated
5842 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5846 * @return a bitstream filter with the specified name or NULL if no such
5847 * bitstream filter exists.
5849 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5852 * Iterate over all registered bitstream filters.
5854 * @param opaque a pointer where libavcodec will store the iteration state. Must
5855 * point to NULL to start the iteration.
5857 * @return the next registered bitstream filter or NULL when the iteration is
5860 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
5862 attribute_deprecated
5863 const AVBitStreamFilter *av_bsf_next(void **opaque);
5867 * Allocate a context for a given bitstream filter. The caller must fill in the
5868 * context parameters as described in the documentation and then call
5869 * av_bsf_init() before sending any data to the filter.
5871 * @param filter the filter for which to allocate an instance.
5872 * @param ctx a pointer into which the pointer to the newly-allocated context
5873 * will be written. It must be freed with av_bsf_free() after the
5874 * filtering is done.
5876 * @return 0 on success, a negative AVERROR code on failure
5878 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5881 * Prepare the filter for use, after all the parameters and options have been
5884 int av_bsf_init(AVBSFContext *ctx);
5887 * Submit a packet for filtering.
5889 * After sending each packet, the filter must be completely drained by calling
5890 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5893 * @param pkt the packet to filter. The bitstream filter will take ownership of
5894 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5895 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5896 * packets will be sent). That will cause the filter to output any packets it
5897 * may have buffered internally.
5899 * @return 0 on success, a negative AVERROR on error.
5901 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5904 * Retrieve a filtered packet.
5906 * @param[out] pkt this struct will be filled with the contents of the filtered
5907 * packet. It is owned by the caller and must be freed using
5908 * av_packet_unref() when it is no longer needed.
5909 * This parameter should be "clean" (i.e. freshly allocated
5910 * with av_packet_alloc() or unreffed with av_packet_unref())
5911 * when this function is called. If this function returns
5912 * successfully, the contents of pkt will be completely
5913 * overwritten by the returned data. On failure, pkt is not
5916 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5917 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5918 * will be no further output from the filter. Another negative AVERROR value if
5921 * @note one input packet may result in several output packets, so after sending
5922 * a packet with av_bsf_send_packet(), this function needs to be called
5923 * repeatedly until it stops returning 0. It is also possible for a filter to
5924 * output fewer packets than were sent to it, so this function may return
5925 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5927 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5930 * Reset the internal bitstream filter state / flush internal buffers.
5932 void av_bsf_flush(AVBSFContext *ctx);
5935 * Free a bitstream filter context and everything associated with it; write NULL
5936 * into the supplied pointer.
5938 void av_bsf_free(AVBSFContext **ctx);
5941 * Get the AVClass for AVBSFContext. It can be used in combination with
5942 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5944 * @see av_opt_find().
5946 const AVClass *av_bsf_get_class(void);
5949 * Structure for chain/list of bitstream filters.
5950 * Empty list can be allocated by av_bsf_list_alloc().
5952 typedef struct AVBSFList AVBSFList;
5955 * Allocate empty list of bitstream filters.
5956 * The list must be later freed by av_bsf_list_free()
5957 * or finalized by av_bsf_list_finalize().
5959 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
5961 AVBSFList *av_bsf_list_alloc(void);
5964 * Free list of bitstream filters.
5966 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
5968 void av_bsf_list_free(AVBSFList **lst);
5971 * Append bitstream filter to the list of bitstream filters.
5973 * @param lst List to append to
5974 * @param bsf Filter context to be appended
5976 * @return >=0 on success, negative AVERROR in case of failure
5978 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
5981 * Construct new bitstream filter context given it's name and options
5982 * and append it to the list of bitstream filters.
5984 * @param lst List to append to
5985 * @param bsf_name Name of the bitstream filter
5986 * @param options Options for the bitstream filter, can be set to NULL
5988 * @return >=0 on success, negative AVERROR in case of failure
5990 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
5992 * Finalize list of bitstream filters.
5994 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
5995 * so the whole chain of bitstream filters can be treated as single filter
5996 * freshly allocated by av_bsf_alloc().
5997 * If the call is successful, @ref AVBSFList structure is freed and lst
5998 * will be set to NULL. In case of failure, caller is responsible for
5999 * freeing the structure by av_bsf_list_free()
6001 * @param lst Filter list structure to be transformed
6002 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6003 * representing the chain of bitstream filters
6005 * @return >=0 on success, negative AVERROR in case of failure
6007 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6010 * Parse string describing list of bitstream filters and create single
6011 * @ref AVBSFContext describing the whole chain of bitstream filters.
6012 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6013 * allocated by av_bsf_alloc().
6015 * @param str String describing chain of bitstream filters in format
6016 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6017 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6018 * representing the chain of bitstream filters
6020 * @return >=0 on success, negative AVERROR in case of failure
6022 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6025 * Get null/pass-through bitstream filter.
6027 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6031 int av_bsf_get_null_filter(AVBSFContext **bsf);
6036 * Same behaviour av_fast_malloc but the buffer has additional
6037 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6039 * In addition the whole buffer will initially and after resizes
6040 * be 0-initialized so that no uninitialized data will ever appear.
6042 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6045 * Same behaviour av_fast_padded_malloc except that buffer will always
6046 * be 0-initialized after call.
6048 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6051 * Encode extradata length to a buffer. Used by xiph codecs.
6053 * @param s buffer to write to; must be at least (v/255+1) bytes long
6054 * @param v size of extradata in bytes
6055 * @return number of bytes written to the buffer.
6057 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6059 #if FF_API_USER_VISIBLE_AVHWACCEL
6061 * Register the hardware accelerator hwaccel.
6063 * @deprecated This function doesn't do anything.
6065 attribute_deprecated
6066 void av_register_hwaccel(AVHWAccel *hwaccel);
6069 * If hwaccel is NULL, returns the first registered hardware accelerator,
6070 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6071 * after hwaccel, or NULL if hwaccel is the last one.
6073 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
6074 * this function should not be used.
6076 attribute_deprecated
6077 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6082 * Lock operation used by lockmgr
6084 * @deprecated Deprecated together with av_lockmgr_register().
6087 AV_LOCK_CREATE, ///< Create a mutex
6088 AV_LOCK_OBTAIN, ///< Lock the mutex
6089 AV_LOCK_RELEASE, ///< Unlock the mutex
6090 AV_LOCK_DESTROY, ///< Free mutex resources
6094 * Register a user provided lock manager supporting the operations
6095 * specified by AVLockOp. The "mutex" argument to the function points
6096 * to a (void *) where the lockmgr should store/get a pointer to a user
6097 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6098 * value left by the last call for all other ops. If the lock manager is
6099 * unable to perform the op then it should leave the mutex in the same
6100 * state as when it was called and return a non-zero value. However,
6101 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6102 * have been successfully destroyed. If av_lockmgr_register succeeds
6103 * it will return a non-negative value, if it fails it will return a
6104 * negative value and destroy all mutex and unregister all callbacks.
6105 * av_lockmgr_register is not thread-safe, it must be called from a
6106 * single thread before any calls which make use of locking are used.
6108 * @param cb User defined callback. av_lockmgr_register invokes calls
6109 * to this callback and the previously registered callback.
6110 * The callback will be used to create more than one mutex
6111 * each of which must be backed by its own underlying locking
6112 * mechanism (i.e. do not use a single static object to
6113 * implement your lock manager). If cb is set to NULL the
6114 * lockmgr will be unregistered.
6116 * @deprecated This function does nothing, and always returns 0. Be sure to
6117 * build with thread support to get basic thread safety.
6119 attribute_deprecated
6120 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6124 * Get the type of the given codec.
6126 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6129 * Get the name of a codec.
6130 * @return a static string identifying the codec; never NULL
6132 const char *avcodec_get_name(enum AVCodecID id);
6135 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6136 * with no corresponding avcodec_close()), 0 otherwise.
6138 int avcodec_is_open(AVCodecContext *s);
6141 * @return a non-zero number if codec is an encoder, zero otherwise
6143 int av_codec_is_encoder(const AVCodec *codec);
6146 * @return a non-zero number if codec is a decoder, zero otherwise
6148 int av_codec_is_decoder(const AVCodec *codec);
6151 * @return descriptor for given codec ID or NULL if no descriptor exists.
6153 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6156 * Iterate over all codec descriptors known to libavcodec.
6158 * @param prev previous descriptor. NULL to get the first descriptor.
6160 * @return next descriptor or NULL after the last descriptor
6162 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6165 * @return codec descriptor with the given name or NULL if no such descriptor
6168 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6171 * Allocate a CPB properties structure and initialize its fields to default
6174 * @param size if non-NULL, the size of the allocated struct will be written
6175 * here. This is useful for embedding it in side data.
6177 * @return the newly allocated struct or NULL on failure
6179 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6185 #endif /* AVCODEC_AVCODEC_H */