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,
453 /* various PCM "codecs" */
454 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
455 AV_CODEC_ID_PCM_S16LE = 0x10000,
456 AV_CODEC_ID_PCM_S16BE,
457 AV_CODEC_ID_PCM_U16LE,
458 AV_CODEC_ID_PCM_U16BE,
461 AV_CODEC_ID_PCM_MULAW,
462 AV_CODEC_ID_PCM_ALAW,
463 AV_CODEC_ID_PCM_S32LE,
464 AV_CODEC_ID_PCM_S32BE,
465 AV_CODEC_ID_PCM_U32LE,
466 AV_CODEC_ID_PCM_U32BE,
467 AV_CODEC_ID_PCM_S24LE,
468 AV_CODEC_ID_PCM_S24BE,
469 AV_CODEC_ID_PCM_U24LE,
470 AV_CODEC_ID_PCM_U24BE,
471 AV_CODEC_ID_PCM_S24DAUD,
472 AV_CODEC_ID_PCM_ZORK,
473 AV_CODEC_ID_PCM_S16LE_PLANAR,
475 AV_CODEC_ID_PCM_F32BE,
476 AV_CODEC_ID_PCM_F32LE,
477 AV_CODEC_ID_PCM_F64BE,
478 AV_CODEC_ID_PCM_F64LE,
479 AV_CODEC_ID_PCM_BLURAY,
482 AV_CODEC_ID_PCM_S8_PLANAR,
483 AV_CODEC_ID_PCM_S24LE_PLANAR,
484 AV_CODEC_ID_PCM_S32LE_PLANAR,
485 AV_CODEC_ID_PCM_S16BE_PLANAR,
487 AV_CODEC_ID_PCM_S64LE = 0x10800,
488 AV_CODEC_ID_PCM_S64BE,
489 AV_CODEC_ID_PCM_F16LE,
490 AV_CODEC_ID_PCM_F24LE,
492 /* various ADPCM codecs */
493 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
494 AV_CODEC_ID_ADPCM_IMA_WAV,
495 AV_CODEC_ID_ADPCM_IMA_DK3,
496 AV_CODEC_ID_ADPCM_IMA_DK4,
497 AV_CODEC_ID_ADPCM_IMA_WS,
498 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
499 AV_CODEC_ID_ADPCM_MS,
500 AV_CODEC_ID_ADPCM_4XM,
501 AV_CODEC_ID_ADPCM_XA,
502 AV_CODEC_ID_ADPCM_ADX,
503 AV_CODEC_ID_ADPCM_EA,
504 AV_CODEC_ID_ADPCM_G726,
505 AV_CODEC_ID_ADPCM_CT,
506 AV_CODEC_ID_ADPCM_SWF,
507 AV_CODEC_ID_ADPCM_YAMAHA,
508 AV_CODEC_ID_ADPCM_SBPRO_4,
509 AV_CODEC_ID_ADPCM_SBPRO_3,
510 AV_CODEC_ID_ADPCM_SBPRO_2,
511 AV_CODEC_ID_ADPCM_THP,
512 AV_CODEC_ID_ADPCM_IMA_AMV,
513 AV_CODEC_ID_ADPCM_EA_R1,
514 AV_CODEC_ID_ADPCM_EA_R3,
515 AV_CODEC_ID_ADPCM_EA_R2,
516 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
517 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
518 AV_CODEC_ID_ADPCM_EA_XAS,
519 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
520 AV_CODEC_ID_ADPCM_IMA_ISS,
521 AV_CODEC_ID_ADPCM_G722,
522 AV_CODEC_ID_ADPCM_IMA_APC,
523 AV_CODEC_ID_ADPCM_VIMA,
525 AV_CODEC_ID_ADPCM_AFC = 0x11800,
526 AV_CODEC_ID_ADPCM_IMA_OKI,
527 AV_CODEC_ID_ADPCM_DTK,
528 AV_CODEC_ID_ADPCM_IMA_RAD,
529 AV_CODEC_ID_ADPCM_G726LE,
530 AV_CODEC_ID_ADPCM_THP_LE,
531 AV_CODEC_ID_ADPCM_PSX,
532 AV_CODEC_ID_ADPCM_AICA,
533 AV_CODEC_ID_ADPCM_IMA_DAT4,
534 AV_CODEC_ID_ADPCM_MTAF,
537 AV_CODEC_ID_AMR_NB = 0x12000,
540 /* RealAudio codecs*/
541 AV_CODEC_ID_RA_144 = 0x13000,
544 /* various DPCM codecs */
545 AV_CODEC_ID_ROQ_DPCM = 0x14000,
546 AV_CODEC_ID_INTERPLAY_DPCM,
547 AV_CODEC_ID_XAN_DPCM,
548 AV_CODEC_ID_SOL_DPCM,
550 AV_CODEC_ID_SDX2_DPCM = 0x14800,
551 AV_CODEC_ID_GREMLIN_DPCM,
554 AV_CODEC_ID_MP2 = 0x15000,
555 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
565 AV_CODEC_ID_VMDAUDIO,
571 AV_CODEC_ID_WESTWOOD_SND1,
572 AV_CODEC_ID_GSM, ///< as in Berlin toast format
575 AV_CODEC_ID_TRUESPEECH,
577 AV_CODEC_ID_SMACKAUDIO,
580 AV_CODEC_ID_DSICINAUDIO,
582 AV_CODEC_ID_MUSEPACK7,
584 AV_CODEC_ID_GSM_MS, /* as found in WAV */
587 AV_CODEC_ID_NELLYMOSER,
588 AV_CODEC_ID_MUSEPACK8,
590 AV_CODEC_ID_WMAVOICE,
592 AV_CODEC_ID_WMALOSSLESS,
601 AV_CODEC_ID_BINKAUDIO_RDFT,
602 AV_CODEC_ID_BINKAUDIO_DCT,
603 AV_CODEC_ID_AAC_LATM,
608 AV_CODEC_ID_8SVX_EXP,
609 AV_CODEC_ID_8SVX_FIB,
610 AV_CODEC_ID_BMV_AUDIO,
615 AV_CODEC_ID_COMFORT_NOISE,
617 AV_CODEC_ID_METASOUND,
618 AV_CODEC_ID_PAF_AUDIO,
623 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
625 AV_CODEC_ID_SONIC_LS,
628 AV_CODEC_ID_DSD_LSBF,
629 AV_CODEC_ID_DSD_MSBF,
630 AV_CODEC_ID_DSD_LSBF_PLANAR,
631 AV_CODEC_ID_DSD_MSBF_PLANAR,
633 AV_CODEC_ID_INTERPLAY_ACM,
637 AV_CODEC_ID_ATRAC3AL,
638 AV_CODEC_ID_ATRAC3PAL,
645 /* subtitle codecs */
646 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
647 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
648 AV_CODEC_ID_DVB_SUBTITLE,
649 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
652 AV_CODEC_ID_MOV_TEXT,
653 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
654 AV_CODEC_ID_DVB_TELETEXT,
657 AV_CODEC_ID_MICRODVD = 0x17800,
661 AV_CODEC_ID_REALTEXT,
663 AV_CODEC_ID_SUBVIEWER1,
664 AV_CODEC_ID_SUBVIEWER,
671 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
674 /* other specific kind of codecs (generally used for attachments) */
675 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
676 AV_CODEC_ID_TTF = 0x18000,
678 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
679 AV_CODEC_ID_BINTEXT = 0x18800,
683 AV_CODEC_ID_SMPTE_KLV,
685 AV_CODEC_ID_TIMED_ID3,
686 AV_CODEC_ID_BIN_DATA,
689 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
691 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
692 * stream (only used by libavformat) */
693 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
694 * stream (only used by libavformat) */
695 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
696 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
700 * This struct describes the properties of a single codec described by an
702 * @see avcodec_descriptor_get()
704 typedef struct AVCodecDescriptor {
706 enum AVMediaType type;
708 * Name of the codec described by this descriptor. It is non-empty and
709 * unique for each codec descriptor. It should contain alphanumeric
710 * characters and '_' only.
714 * A more descriptive name for this codec. May be NULL.
716 const char *long_name;
718 * Codec properties, a combination of AV_CODEC_PROP_* flags.
722 * MIME type(s) associated with the codec.
723 * May be NULL; if not, a NULL-terminated array of MIME types.
724 * The first item is always non-NULL and is the preferred MIME type.
726 const char *const *mime_types;
728 * If non-NULL, an array of profiles recognized for this codec.
729 * Terminated with FF_PROFILE_UNKNOWN.
731 const struct AVProfile *profiles;
735 * Codec uses only intra compression.
736 * Video and audio codecs only.
738 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
740 * Codec supports lossy compression. Audio and video codecs only.
741 * @note a codec may support both lossy and lossless
744 #define AV_CODEC_PROP_LOSSY (1 << 1)
746 * Codec supports lossless compression. Audio and video codecs only.
748 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
750 * Codec supports frame reordering. That is, the coded order (the order in which
751 * the encoded packets are output by the encoders / stored / input to the
752 * decoders) may be different from the presentation order of the corresponding
755 * For codecs that do not have this property set, PTS and DTS should always be
758 #define AV_CODEC_PROP_REORDER (1 << 3)
760 * Subtitle codec is bitmap based
761 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
763 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
765 * Subtitle codec is text based.
766 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
768 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
771 * @ingroup lavc_decoding
772 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
773 * This is mainly needed because some optimized bitstream readers read
774 * 32 or 64 bit at once and could read over the end.<br>
775 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
776 * MPEG bitstreams could cause overread and segfault.
778 #define AV_INPUT_BUFFER_PADDING_SIZE 64
781 * @ingroup lavc_encoding
782 * minimum encoding buffer size
783 * Used to avoid some checks during header writing.
785 #define AV_INPUT_BUFFER_MIN_SIZE 16384
788 * @ingroup lavc_decoding
791 /* We leave some space between them for extensions (drop some
792 * keyframes for intra-only or drop just some bidir frames). */
793 AVDISCARD_NONE =-16, ///< discard nothing
794 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
795 AVDISCARD_NONREF = 8, ///< discard all non reference
796 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
797 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
798 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
799 AVDISCARD_ALL = 48, ///< discard all
802 enum AVAudioServiceType {
803 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
804 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
805 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
806 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
807 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
808 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
809 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
810 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
811 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
812 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
816 * @ingroup lavc_encoding
818 typedef struct RcOverride{
821 int qscale; // If this is 0 then quality_factor will be used instead.
822 float quality_factor;
826 These flags can be passed in AVCodecContext.flags before initialization.
827 Note: Not everything is supported yet.
831 * Allow decoders to produce frames with data planes that are not aligned
832 * to CPU requirements (e.g. due to cropping).
834 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
838 #define AV_CODEC_FLAG_QSCALE (1 << 1)
840 * 4 MV per MB allowed / advanced prediction for H.263.
842 #define AV_CODEC_FLAG_4MV (1 << 2)
844 * Output even those frames that might be corrupted.
846 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
850 #define AV_CODEC_FLAG_QPEL (1 << 4)
852 * Use internal 2pass ratecontrol in first pass mode.
854 #define AV_CODEC_FLAG_PASS1 (1 << 9)
856 * Use internal 2pass ratecontrol in second pass mode.
858 #define AV_CODEC_FLAG_PASS2 (1 << 10)
862 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
864 * Only decode/encode grayscale.
866 #define AV_CODEC_FLAG_GRAY (1 << 13)
868 * error[?] variables will be set during encoding.
870 #define AV_CODEC_FLAG_PSNR (1 << 15)
872 * Input bitstream might be truncated at a random location
873 * instead of only at frame boundaries.
875 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
877 * Use interlaced DCT.
879 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
883 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
885 * Place global headers in extradata instead of every keyframe.
887 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
889 * Use only bitexact stuff (except (I)DCT).
891 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
892 /* Fx : Flag for H.263+ extra options */
894 * H.263 advanced intra coding / MPEG-4 AC prediction
896 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
898 * interlaced motion estimation
900 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
901 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
904 * Allow non spec compliant speedup tricks.
906 #define AV_CODEC_FLAG2_FAST (1 << 0)
908 * Skip bitstream encoding.
910 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
912 * Place global headers at every keyframe instead of in extradata.
914 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
917 * timecode is in drop frame format. DEPRECATED!!!!
919 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
922 * Input bitstream might be truncated at a packet boundaries
923 * instead of only at frame boundaries.
925 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
927 * Discard cropping information from SPS.
929 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
932 * Show all frames before the first keyframe
934 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
936 * Export motion vectors through frame side data
938 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
940 * Do not skip samples and export skip information as frame side data
942 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
944 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
946 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
948 /* Unsupported options :
949 * Syntax Arithmetic coding (SAC)
950 * Reference Picture Selection
951 * Independent Segment Decoding */
953 /* codec capabilities */
956 * Decoder can use draw_horiz_band callback.
958 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
960 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
961 * If not set, it might not use get_buffer() at all or use operations that
962 * assume the buffer was allocated by avcodec_default_get_buffer.
964 #define AV_CODEC_CAP_DR1 (1 << 1)
965 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
967 * Encoder or decoder requires flushing with NULL input at the end in order to
968 * give the complete and correct output.
970 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
971 * with NULL data. The user can still send NULL data to the public encode
972 * or decode function, but libavcodec will not pass it along to the codec
973 * unless this flag is set.
976 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
977 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
981 * The encoder needs to be fed with NULL data at the end of encoding until the
982 * encoder no longer returns data.
984 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
985 * flag also means that the encoder must set the pts and duration for
986 * each output packet. If this flag is not set, the pts and duration will
987 * be determined by libavcodec from the input frame.
989 #define AV_CODEC_CAP_DELAY (1 << 5)
991 * Codec can be fed a final frame with a smaller size.
992 * This can be used to prevent truncation of the last audio samples.
994 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
997 * Codec can output multiple frames per AVPacket
998 * Normally demuxers return one frame at a time, demuxers which do not do
999 * are connected to a parser to split what they return into proper frames.
1000 * This flag is reserved to the very rare category of codecs which have a
1001 * bitstream that cannot be split into frames without timeconsuming
1002 * operations like full decoding. Demuxers carrying such bitstreams thus
1003 * may return multiple frames in a packet. This has many disadvantages like
1004 * prohibiting stream copy in many cases thus it should only be considered
1007 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1009 * Codec is experimental and is thus avoided in favor of non experimental
1012 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1014 * Codec should fill in channel configuration and samplerate instead of container
1016 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1018 * Codec supports frame-level multithreading.
1020 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1022 * Codec supports slice-based (or partition-based) multithreading.
1024 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1026 * Codec supports changed parameters at any point.
1028 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1030 * Codec supports avctx->thread_count == 0 (auto).
1032 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1034 * Audio encoder supports receiving a different number of samples in each call.
1036 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1038 * Decoder is not a preferred choice for probing.
1039 * This indicates that the decoder is not a good choice for probing.
1040 * It could for example be an expensive to spin up hardware decoder,
1041 * or it could simply not provide a lot of useful information about
1043 * A decoder marked with this flag should only be used as last resort
1044 * choice for probing.
1046 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1048 * Codec is intra only.
1050 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1052 * Codec is lossless.
1054 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1057 * Codec is backed by a hardware implementation. Typically used to
1058 * identify a non-hwaccel hardware decoder. For information about hwaccels, use
1059 * avcodec_get_hw_config() instead.
1061 #define AV_CODEC_CAP_HARDWARE (1 << 18)
1064 * Codec is potentially backed by a hardware implementation, but not
1065 * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
1066 * implementation provides some sort of internal fallback.
1068 #define AV_CODEC_CAP_HYBRID (1 << 19)
1072 * This specifies the area which should be displayed.
1073 * Note there may be multiple such areas for one frame.
1075 typedef struct AVPanScan {
1078 * - encoding: Set by user.
1079 * - decoding: Set by libavcodec.
1084 * width and height in 1/16 pel
1085 * - encoding: Set by user.
1086 * - decoding: Set by libavcodec.
1092 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1093 * - encoding: Set by user.
1094 * - decoding: Set by libavcodec.
1096 int16_t position[3][2];
1100 * This structure describes the bitrate properties of an encoded bitstream. It
1101 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1102 * parameters for H.264/HEVC.
1104 typedef struct AVCPBProperties {
1106 * Maximum bitrate of the stream, in bits per second.
1107 * Zero if unknown or unspecified.
1111 * Minimum bitrate of the stream, in bits per second.
1112 * Zero if unknown or unspecified.
1116 * Average bitrate of the stream, in bits per second.
1117 * Zero if unknown or unspecified.
1122 * The size of the buffer to which the ratecontrol is applied, in bits.
1123 * Zero if unknown or unspecified.
1128 * The delay between the time the packet this structure is associated with
1129 * is received and the time when it should be decoded, in periods of a 27MHz
1132 * UINT64_MAX when unknown or unspecified.
1138 * The decoder will keep a reference to the frame and may reuse it later.
1140 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1143 * @defgroup lavc_packet AVPacket
1145 * Types and functions for working with AVPacket.
1148 enum AVPacketSideDataType {
1150 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1151 * bytes worth of palette. This side data signals that a new palette is
1154 AV_PKT_DATA_PALETTE,
1157 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1158 * that the extradata buffer was changed and the receiving side should
1159 * act upon it appropriately. The new extradata is embedded in the side
1160 * data buffer and should be immediately used for processing the current
1163 AV_PKT_DATA_NEW_EXTRADATA,
1166 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1169 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1170 * s32le channel_count
1171 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1172 * u64le channel_layout
1173 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1175 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1180 AV_PKT_DATA_PARAM_CHANGE,
1183 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1184 * structures with info about macroblocks relevant to splitting the
1185 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1186 * That is, it does not necessarily contain info about all macroblocks,
1187 * as long as the distance between macroblocks in the info is smaller
1188 * than the target payload size.
1189 * Each MB info structure is 12 bytes, and is laid out as follows:
1191 * u32le bit offset from the start of the packet
1192 * u8 current quantizer at the start of the macroblock
1194 * u16le macroblock address within the GOB
1195 * u8 horizontal MV predictor
1196 * u8 vertical MV predictor
1197 * u8 horizontal MV predictor for block number 3
1198 * u8 vertical MV predictor for block number 3
1201 AV_PKT_DATA_H263_MB_INFO,
1204 * This side data should be associated with an audio stream and contains
1205 * ReplayGain information in form of the AVReplayGain struct.
1207 AV_PKT_DATA_REPLAYGAIN,
1210 * This side data contains a 3x3 transformation matrix describing an affine
1211 * transformation that needs to be applied to the decoded video frames for
1212 * correct presentation.
1214 * See libavutil/display.h for a detailed description of the data.
1216 AV_PKT_DATA_DISPLAYMATRIX,
1219 * This side data should be associated with a video stream and contains
1220 * Stereoscopic 3D information in form of the AVStereo3D struct.
1222 AV_PKT_DATA_STEREO3D,
1225 * This side data should be associated with an audio stream and corresponds
1226 * to enum AVAudioServiceType.
1228 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1231 * This side data contains quality related information from the encoder.
1233 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1237 * u64le[error count] sum of squared differences between encoder in and output
1240 AV_PKT_DATA_QUALITY_STATS,
1243 * This side data contains an integer value representing the stream index
1244 * of a "fallback" track. A fallback track indicates an alternate
1245 * track to use when the current track can not be decoded for some reason.
1246 * e.g. no decoder available for codec.
1248 AV_PKT_DATA_FALLBACK_TRACK,
1251 * This side data corresponds to the AVCPBProperties struct.
1253 AV_PKT_DATA_CPB_PROPERTIES,
1256 * Recommmends skipping the specified number of samples
1258 * u32le number of samples to skip from start of this packet
1259 * u32le number of samples to skip from end of this packet
1260 * u8 reason for start skip
1261 * u8 reason for end skip (0=padding silence, 1=convergence)
1264 AV_PKT_DATA_SKIP_SAMPLES,
1267 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1268 * the packet may contain "dual mono" audio specific to Japanese DTV
1269 * and if it is true, recommends only the selected channel to be used.
1271 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1274 AV_PKT_DATA_JP_DUALMONO,
1277 * A list of zero terminated key/value strings. There is no end marker for
1278 * the list, so it is required to rely on the side data size to stop.
1280 AV_PKT_DATA_STRINGS_METADATA,
1283 * Subtitle event position
1291 AV_PKT_DATA_SUBTITLE_POSITION,
1294 * Data found in BlockAdditional element of matroska container. There is
1295 * no end marker for the data, so it is required to rely on the side data
1296 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1299 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1302 * The optional first identifier line of a WebVTT cue.
1304 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1307 * The optional settings (rendering instructions) that immediately
1308 * follow the timestamp specifier of a WebVTT cue.
1310 AV_PKT_DATA_WEBVTT_SETTINGS,
1313 * A list of zero terminated key/value strings. There is no end marker for
1314 * the list, so it is required to rely on the side data size to stop. This
1315 * side data includes updated metadata which appeared in the stream.
1317 AV_PKT_DATA_METADATA_UPDATE,
1320 * MPEGTS stream ID, this is required to pass the stream ID
1321 * information from the demuxer to the corresponding muxer.
1323 AV_PKT_DATA_MPEGTS_STREAM_ID,
1326 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1327 * should be associated with a video stream and contains data in the form
1328 * of the AVMasteringDisplayMetadata struct.
1330 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1333 * This side data should be associated with a video stream and corresponds
1334 * to the AVSphericalMapping structure.
1336 AV_PKT_DATA_SPHERICAL,
1339 * Content light level (based on CTA-861.3). This metadata should be
1340 * associated with a video stream and contains data in the form of the
1341 * AVContentLightMetadata struct.
1343 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1346 * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1347 * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1348 * The number of bytes of CC data is AVPacketSideData.size.
1353 * This side data is encryption initialization data.
1354 * The format is not part of ABI, use av_encryption_init_info_* methods to
1357 AV_PKT_DATA_ENCRYPTION_INIT_INFO,
1360 * This side data contains encryption info for how to decrypt the packet.
1361 * The format is not part of ABI, use av_encryption_info_* methods to access.
1363 AV_PKT_DATA_ENCRYPTION_INFO,
1366 * The number of side data types.
1367 * This is not part of the public API/ABI in the sense that it may
1368 * change when new side data types are added.
1369 * This must stay the last enum value.
1370 * If its value becomes huge, some code using it
1371 * needs to be updated as it assumes it to be smaller than other limits.
1376 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1378 typedef struct AVPacketSideData {
1381 enum AVPacketSideDataType type;
1385 * This structure stores compressed data. It is typically exported by demuxers
1386 * and then passed as input to decoders, or received as output from encoders and
1387 * then passed to muxers.
1389 * For video, it should typically contain one compressed frame. For audio it may
1390 * contain several compressed frames. Encoders are allowed to output empty
1391 * packets, with no compressed data, containing only side data
1392 * (e.g. to update some stream parameters at the end of encoding).
1394 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1395 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1396 * without libavcodec and libavformat major bump.
1398 * The semantics of data ownership depends on the buf field.
1399 * If it is set, the packet data is dynamically allocated and is
1400 * valid indefinitely until a call to av_packet_unref() reduces the
1401 * reference count to 0.
1403 * If the buf field is not set av_packet_ref() would make a copy instead
1404 * of increasing the reference count.
1406 * The side data is always allocated with av_malloc(), copied by
1407 * av_packet_ref() and freed by av_packet_unref().
1409 * @see av_packet_ref
1410 * @see av_packet_unref
1412 typedef struct AVPacket {
1414 * A reference to the reference-counted buffer where the packet data is
1416 * May be NULL, then the packet data is not reference-counted.
1420 * Presentation timestamp in AVStream->time_base units; the time at which
1421 * the decompressed packet will be presented to the user.
1422 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1423 * pts MUST be larger or equal to dts as presentation cannot happen before
1424 * decompression, unless one wants to view hex dumps. Some formats misuse
1425 * the terms dts and pts/cts to mean something different. Such timestamps
1426 * must be converted to true pts/dts before they are stored in AVPacket.
1430 * Decompression timestamp in AVStream->time_base units; the time at which
1431 * the packet is decompressed.
1432 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1439 * A combination of AV_PKT_FLAG values
1443 * Additional packet data that can be provided by the container.
1444 * Packet can contain several types of side information.
1446 AVPacketSideData *side_data;
1447 int side_data_elems;
1450 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1451 * Equals next_pts - this_pts in presentation order.
1455 int64_t pos; ///< byte position in stream, -1 if unknown
1457 #if FF_API_CONVERGENCE_DURATION
1459 * @deprecated Same as the duration field, but as int64_t. This was required
1460 * for Matroska subtitles, whose duration values could overflow when the
1461 * duration field was still an int.
1463 attribute_deprecated
1464 int64_t convergence_duration;
1467 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1468 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1470 * Flag is used to discard packets which are required to maintain valid
1471 * decoder state but are not required for output and should be dropped
1474 #define AV_PKT_FLAG_DISCARD 0x0004
1476 * The packet comes from a trusted source.
1478 * Otherwise-unsafe constructs such as arbitrary pointers to data
1479 * outside the packet may be followed.
1481 #define AV_PKT_FLAG_TRUSTED 0x0008
1483 * Flag is used to indicate packets that contain frames that can
1484 * be discarded by the decoder. I.e. Non-reference frames.
1486 #define AV_PKT_FLAG_DISPOSABLE 0x0010
1489 enum AVSideDataParamChangeFlags {
1490 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1491 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1492 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1493 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1499 struct AVCodecInternal;
1503 AV_FIELD_PROGRESSIVE,
1504 AV_FIELD_TT, //< Top coded_first, top displayed first
1505 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1506 AV_FIELD_TB, //< Top coded first, bottom displayed first
1507 AV_FIELD_BT, //< Bottom coded first, top displayed first
1511 * main external API structure.
1512 * New fields can be added to the end with minor version bumps.
1513 * Removal, reordering and changes to existing fields require a major
1515 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1517 * The name string for AVOptions options matches the associated command line
1518 * parameter name and can be found in libavcodec/options_table.h
1519 * The AVOption/command line parameter names differ in some cases from the C
1520 * structure field names for historic reasons or brevity.
1521 * sizeof(AVCodecContext) must not be used outside libav*.
1523 typedef struct AVCodecContext {
1525 * information on struct for av_log
1526 * - set by avcodec_alloc_context3
1528 const AVClass *av_class;
1529 int log_level_offset;
1531 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1532 const struct AVCodec *codec;
1533 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1536 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1537 * This is used to work around some encoder bugs.
1538 * A demuxer should set this to what is stored in the field used to identify the codec.
1539 * If there are multiple such fields in a container then the demuxer should choose the one
1540 * which maximizes the information about the used codec.
1541 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1542 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1543 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1545 * - encoding: Set by user, if not then the default based on codec_id will be used.
1546 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1548 unsigned int codec_tag;
1553 * Private context used for internal data.
1555 * Unlike priv_data, this is not codec-specific. It is used in general
1556 * libavcodec functions.
1558 struct AVCodecInternal *internal;
1561 * Private data of the user, can be used to carry app specific stuff.
1562 * - encoding: Set by user.
1563 * - decoding: Set by user.
1568 * the average bitrate
1569 * - encoding: Set by user; unused for constant quantizer encoding.
1570 * - decoding: Set by user, may be overwritten by libavcodec
1571 * if this info is available in the stream
1576 * number of bits the bitstream is allowed to diverge from the reference.
1577 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1578 * - encoding: Set by user; unused for constant quantizer encoding.
1579 * - decoding: unused
1581 int bit_rate_tolerance;
1584 * Global quality for codecs which cannot change it per frame.
1585 * This should be proportional to MPEG-1/2/4 qscale.
1586 * - encoding: Set by user.
1587 * - decoding: unused
1592 * - encoding: Set by user.
1593 * - decoding: unused
1595 int compression_level;
1596 #define FF_COMPRESSION_DEFAULT -1
1600 * - encoding: Set by user.
1601 * - decoding: Set by user.
1607 * - encoding: Set by user.
1608 * - decoding: Set by user.
1613 * some codecs need / can use extradata like Huffman tables.
1614 * MJPEG: Huffman tables
1615 * rv10: additional flags
1616 * MPEG-4: global headers (they can be in the bitstream or here)
1617 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1618 * than extradata_size to avoid problems if it is read with the bitstream reader.
1619 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1620 * - encoding: Set/allocated/freed by libavcodec.
1621 * - decoding: Set/allocated/freed by user.
1627 * This is the fundamental unit of time (in seconds) in terms
1628 * of which frame timestamps are represented. For fixed-fps content,
1629 * timebase should be 1/framerate and timestamp increments should be
1631 * This often, but not always is the inverse of the frame rate or field rate
1632 * for video. 1/time_base is not the average frame rate if the frame rate is not
1635 * Like containers, elementary streams also can store timestamps, 1/time_base
1636 * is the unit in which these timestamps are specified.
1637 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1638 * vop_time_increment_resolution and fixed_vop_rate
1639 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1641 * - encoding: MUST be set by user.
1642 * - decoding: the use of this field for decoding is deprecated.
1643 * Use framerate instead.
1645 AVRational time_base;
1648 * For some codecs, the time base is closer to the field rate than the frame rate.
1649 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1650 * if no telecine is used ...
1652 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1654 int ticks_per_frame;
1659 * Encoding: Number of frames delay there will be from the encoder input to
1660 * the decoder output. (we assume the decoder matches the spec)
1661 * Decoding: Number of frames delay in addition to what a standard decoder
1662 * as specified in the spec would produce.
1665 * Number of frames the decoded output will be delayed relative to the
1669 * For encoding, this field is unused (see initial_padding).
1671 * For decoding, this is the number of samples the decoder needs to
1672 * output before the decoder's output is valid. When seeking, you should
1673 * start decoding this many samples prior to your desired seek point.
1675 * - encoding: Set by libavcodec.
1676 * - decoding: Set by libavcodec.
1683 * picture width / height.
1685 * @note Those fields may not match the values of the last
1686 * AVFrame output by avcodec_decode_video2 due frame
1689 * - encoding: MUST be set by user.
1690 * - decoding: May be set by the user before opening the decoder if known e.g.
1691 * from the container. Some decoders will require the dimensions
1692 * to be set by the caller. During decoding, the decoder may
1693 * overwrite those values as required while parsing the data.
1698 * Bitstream width / height, may be different from width/height e.g. when
1699 * the decoded frame is cropped before being output or lowres is enabled.
1701 * @note Those field may not match the value of the last
1702 * AVFrame output by avcodec_receive_frame() due frame
1705 * - encoding: unused
1706 * - decoding: May be set by the user before opening the decoder if known
1707 * e.g. from the container. During decoding, the decoder may
1708 * overwrite those values as required while parsing the data.
1710 int coded_width, coded_height;
1713 * the number of pictures in a group of pictures, or 0 for intra_only
1714 * - encoding: Set by user.
1715 * - decoding: unused
1720 * Pixel format, see AV_PIX_FMT_xxx.
1721 * May be set by the demuxer if known from headers.
1722 * May be overridden by the decoder if it knows better.
1724 * @note This field may not match the value of the last
1725 * AVFrame output by avcodec_receive_frame() due frame
1728 * - encoding: Set by user.
1729 * - decoding: Set by user if known, overridden by libavcodec while
1732 enum AVPixelFormat pix_fmt;
1735 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1736 * decoder to draw a horizontal band. It improves cache usage. Not
1737 * all codecs can do that. You must check the codec capabilities
1739 * When multithreading is used, it may be called from multiple threads
1740 * at the same time; threads might draw different parts of the same AVFrame,
1741 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1743 * The function is also used by hardware acceleration APIs.
1744 * It is called at least once during frame decoding to pass
1745 * the data needed for hardware render.
1746 * In that mode instead of pixel data, AVFrame points to
1747 * a structure specific to the acceleration API. The application
1748 * reads the structure and can change some fields to indicate progress
1750 * - encoding: unused
1751 * - decoding: Set by user.
1752 * @param height the height of the slice
1753 * @param y the y position of the slice
1754 * @param type 1->top field, 2->bottom field, 3->frame
1755 * @param offset offset into the AVFrame.data from which the slice should be read
1757 void (*draw_horiz_band)(struct AVCodecContext *s,
1758 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1759 int y, int type, int height);
1762 * callback to negotiate the pixelFormat
1763 * @param fmt is the list of formats which are supported by the codec,
1764 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1765 * The first is always the native one.
1766 * @note The callback may be called again immediately if initialization for
1767 * the selected (hardware-accelerated) pixel format failed.
1768 * @warning Behavior is undefined if the callback returns a value not
1769 * in the fmt list of formats.
1770 * @return the chosen format
1771 * - encoding: unused
1772 * - decoding: Set by user, if not set the native format will be chosen.
1774 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1777 * maximum number of B-frames between non-B-frames
1778 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1779 * - encoding: Set by user.
1780 * - decoding: unused
1785 * qscale factor between IP and B-frames
1786 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1787 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1788 * - encoding: Set by user.
1789 * - decoding: unused
1791 float b_quant_factor;
1793 #if FF_API_PRIVATE_OPT
1794 /** @deprecated use encoder private options instead */
1795 attribute_deprecated
1796 int b_frame_strategy;
1800 * qscale offset between IP and B-frames
1801 * - encoding: Set by user.
1802 * - decoding: unused
1804 float b_quant_offset;
1807 * Size of the frame reordering buffer in the decoder.
1808 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1809 * - encoding: Set by libavcodec.
1810 * - decoding: Set by libavcodec.
1814 #if FF_API_PRIVATE_OPT
1815 /** @deprecated use encoder private options instead */
1816 attribute_deprecated
1821 * qscale factor between P- and I-frames
1822 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1823 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1824 * - encoding: Set by user.
1825 * - decoding: unused
1827 float i_quant_factor;
1830 * qscale offset between P and I-frames
1831 * - encoding: Set by user.
1832 * - decoding: unused
1834 float i_quant_offset;
1837 * luminance masking (0-> disabled)
1838 * - encoding: Set by user.
1839 * - decoding: unused
1844 * temporary complexity masking (0-> disabled)
1845 * - encoding: Set by user.
1846 * - decoding: unused
1848 float temporal_cplx_masking;
1851 * spatial complexity masking (0-> disabled)
1852 * - encoding: Set by user.
1853 * - decoding: unused
1855 float spatial_cplx_masking;
1858 * p block masking (0-> disabled)
1859 * - encoding: Set by user.
1860 * - decoding: unused
1865 * darkness masking (0-> disabled)
1866 * - encoding: Set by user.
1867 * - decoding: unused
1873 * - encoding: Set by libavcodec.
1874 * - decoding: Set by user (or 0).
1878 #if FF_API_PRIVATE_OPT
1879 /** @deprecated use encoder private options instead */
1880 attribute_deprecated
1881 int prediction_method;
1882 #define FF_PRED_LEFT 0
1883 #define FF_PRED_PLANE 1
1884 #define FF_PRED_MEDIAN 2
1888 * slice offsets in the frame in bytes
1889 * - encoding: Set/allocated by libavcodec.
1890 * - decoding: Set/allocated by user (or NULL).
1895 * sample aspect ratio (0 if unknown)
1896 * That is the width of a pixel divided by the height of the pixel.
1897 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1898 * - encoding: Set by user.
1899 * - decoding: Set by libavcodec.
1901 AVRational sample_aspect_ratio;
1904 * motion estimation comparison function
1905 * - encoding: Set by user.
1906 * - decoding: unused
1910 * subpixel motion estimation comparison function
1911 * - encoding: Set by user.
1912 * - decoding: unused
1916 * macroblock comparison function (not supported yet)
1917 * - encoding: Set by user.
1918 * - decoding: unused
1922 * interlaced DCT comparison function
1923 * - encoding: Set by user.
1924 * - decoding: unused
1927 #define FF_CMP_SAD 0
1928 #define FF_CMP_SSE 1
1929 #define FF_CMP_SATD 2
1930 #define FF_CMP_DCT 3
1931 #define FF_CMP_PSNR 4
1932 #define FF_CMP_BIT 5
1934 #define FF_CMP_ZERO 7
1935 #define FF_CMP_VSAD 8
1936 #define FF_CMP_VSSE 9
1937 #define FF_CMP_NSSE 10
1938 #define FF_CMP_W53 11
1939 #define FF_CMP_W97 12
1940 #define FF_CMP_DCTMAX 13
1941 #define FF_CMP_DCT264 14
1942 #define FF_CMP_MEDIAN_SAD 15
1943 #define FF_CMP_CHROMA 256
1946 * ME diamond size & shape
1947 * - encoding: Set by user.
1948 * - decoding: unused
1953 * amount of previous MV predictors (2a+1 x 2a+1 square)
1954 * - encoding: Set by user.
1955 * - decoding: unused
1957 int last_predictor_count;
1959 #if FF_API_PRIVATE_OPT
1960 /** @deprecated use encoder private options instead */
1961 attribute_deprecated
1966 * motion estimation prepass comparison function
1967 * - encoding: Set by user.
1968 * - decoding: unused
1973 * ME prepass diamond size & shape
1974 * - encoding: Set by user.
1975 * - decoding: unused
1981 * - encoding: Set by user.
1982 * - decoding: unused
1984 int me_subpel_quality;
1987 * maximum motion estimation search range in subpel units
1988 * If 0 then no limit.
1990 * - encoding: Set by user.
1991 * - decoding: unused
1997 * - encoding: unused
1998 * - decoding: Set by user.
2001 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2002 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2003 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2006 * macroblock decision mode
2007 * - encoding: Set by user.
2008 * - decoding: unused
2011 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2012 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2013 #define FF_MB_DECISION_RD 2 ///< rate distortion
2016 * custom intra quantization matrix
2017 * - encoding: Set by user, can be NULL.
2018 * - decoding: Set by libavcodec.
2020 uint16_t *intra_matrix;
2023 * custom inter quantization matrix
2024 * - encoding: Set by user, can be NULL.
2025 * - decoding: Set by libavcodec.
2027 uint16_t *inter_matrix;
2029 #if FF_API_PRIVATE_OPT
2030 /** @deprecated use encoder private options instead */
2031 attribute_deprecated
2032 int scenechange_threshold;
2034 /** @deprecated use encoder private options instead */
2035 attribute_deprecated
2036 int noise_reduction;
2040 * precision of the intra DC coefficient - 8
2041 * - encoding: Set by user.
2042 * - decoding: Set by libavcodec
2044 int intra_dc_precision;
2047 * Number of macroblock rows at the top which are skipped.
2048 * - encoding: unused
2049 * - decoding: Set by user.
2054 * Number of macroblock rows at the bottom which are skipped.
2055 * - encoding: unused
2056 * - decoding: Set by user.
2061 * minimum MB Lagrange multiplier
2062 * - encoding: Set by user.
2063 * - decoding: unused
2068 * maximum MB Lagrange multiplier
2069 * - encoding: Set by user.
2070 * - decoding: unused
2074 #if FF_API_PRIVATE_OPT
2076 * @deprecated use encoder private options instead
2078 attribute_deprecated
2079 int me_penalty_compensation;
2083 * - encoding: Set by user.
2084 * - decoding: unused
2088 #if FF_API_PRIVATE_OPT
2089 /** @deprecated use encoder private options instead */
2090 attribute_deprecated
2096 * - encoding: Set by user.
2097 * - decoding: unused
2102 * number of reference frames
2103 * - encoding: Set by user.
2104 * - decoding: Set by lavc.
2108 #if FF_API_PRIVATE_OPT
2109 /** @deprecated use encoder private options instead */
2110 attribute_deprecated
2115 * Note: Value depends upon the compare function used for fullpel ME.
2116 * - encoding: Set by user.
2117 * - decoding: unused
2121 #if FF_API_PRIVATE_OPT
2122 /** @deprecated use encoder private options instead */
2123 attribute_deprecated
2128 * Chromaticity coordinates of the source primaries.
2129 * - encoding: Set by user
2130 * - decoding: Set by libavcodec
2132 enum AVColorPrimaries color_primaries;
2135 * Color Transfer Characteristic.
2136 * - encoding: Set by user
2137 * - decoding: Set by libavcodec
2139 enum AVColorTransferCharacteristic color_trc;
2142 * YUV colorspace type.
2143 * - encoding: Set by user
2144 * - decoding: Set by libavcodec
2146 enum AVColorSpace colorspace;
2149 * MPEG vs JPEG YUV range.
2150 * - encoding: Set by user
2151 * - decoding: Set by libavcodec
2153 enum AVColorRange color_range;
2156 * This defines the location of chroma samples.
2157 * - encoding: Set by user
2158 * - decoding: Set by libavcodec
2160 enum AVChromaLocation chroma_sample_location;
2164 * Indicates number of picture subdivisions. Used for parallelized
2166 * - encoding: Set by user
2167 * - decoding: unused
2172 * - encoding: set by libavcodec
2173 * - decoding: Set by user.
2175 enum AVFieldOrder field_order;
2178 int sample_rate; ///< samples per second
2179 int channels; ///< number of audio channels
2182 * audio sample format
2183 * - encoding: Set by user.
2184 * - decoding: Set by libavcodec.
2186 enum AVSampleFormat sample_fmt; ///< sample format
2188 /* The following data should not be initialized. */
2190 * Number of samples per channel in an audio frame.
2192 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2193 * except the last must contain exactly frame_size samples per channel.
2194 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2195 * frame size is not restricted.
2196 * - decoding: may be set by some decoders to indicate constant frame size
2201 * Frame counter, set by libavcodec.
2203 * - decoding: total number of frames returned from the decoder so far.
2204 * - encoding: total number of frames passed to the encoder so far.
2206 * @note the counter is not incremented if encoding/decoding resulted in
2212 * number of bytes per packet if constant and known or 0
2213 * Used by some WAV based audio codecs.
2218 * Audio cutoff bandwidth (0 means "automatic")
2219 * - encoding: Set by user.
2220 * - decoding: unused
2225 * Audio channel layout.
2226 * - encoding: set by user.
2227 * - decoding: set by user, may be overwritten by libavcodec.
2229 uint64_t channel_layout;
2232 * Request decoder to use this channel layout if it can (0 for default)
2233 * - encoding: unused
2234 * - decoding: Set by user.
2236 uint64_t request_channel_layout;
2239 * Type of service that the audio stream conveys.
2240 * - encoding: Set by user.
2241 * - decoding: Set by libavcodec.
2243 enum AVAudioServiceType audio_service_type;
2246 * desired sample format
2247 * - encoding: Not used.
2248 * - decoding: Set by user.
2249 * Decoder will decode to this format if it can.
2251 enum AVSampleFormat request_sample_fmt;
2254 * This callback is called at the beginning of each frame to get data
2255 * buffer(s) for it. There may be one contiguous buffer for all the data or
2256 * there may be a buffer per each data plane or anything in between. What
2257 * this means is, you may set however many entries in buf[] you feel necessary.
2258 * Each buffer must be reference-counted using the AVBuffer API (see description
2261 * The following fields will be set in the frame before this callback is
2264 * - width, height (video only)
2265 * - sample_rate, channel_layout, nb_samples (audio only)
2266 * Their values may differ from the corresponding values in
2267 * AVCodecContext. This callback must use the frame values, not the codec
2268 * context values, to calculate the required buffer size.
2270 * This callback must fill the following fields in the frame:
2274 * * if the data is planar audio with more than 8 channels, then this
2275 * callback must allocate and fill extended_data to contain all pointers
2276 * to all data planes. data[] must hold as many pointers as it can.
2277 * extended_data must be allocated with av_malloc() and will be freed in
2279 * * otherwise extended_data must point to data
2280 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2281 * the frame's data and extended_data pointers must be contained in these. That
2282 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2283 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2284 * and av_buffer_ref().
2285 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2286 * this callback and filled with the extra buffers if there are more
2287 * buffers than buf[] can hold. extended_buf will be freed in
2290 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2291 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2294 * Each data plane must be aligned to the maximum required by the target
2297 * @see avcodec_default_get_buffer2()
2301 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2302 * (read and/or written to if it is writable) later by libavcodec.
2304 * avcodec_align_dimensions2() should be used to find the required width and
2305 * height, as they normally need to be rounded up to the next multiple of 16.
2307 * Some decoders do not support linesizes changing between frames.
2309 * If frame multithreading is used and thread_safe_callbacks is set,
2310 * this callback may be called from a different thread, but not from more
2311 * than one at once. Does not need to be reentrant.
2313 * @see avcodec_align_dimensions2()
2317 * Decoders request a buffer of a particular size by setting
2318 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2319 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2320 * to a smaller value in the output frame.
2322 * As a convenience, av_samples_get_buffer_size() and
2323 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2324 * functions to find the required data size and to fill data pointers and
2325 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2326 * since all planes must be the same size.
2328 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2330 * - encoding: unused
2331 * - decoding: Set by libavcodec, user can override.
2333 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2336 * If non-zero, the decoded audio and video frames returned from
2337 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2338 * and are valid indefinitely. The caller must free them with
2339 * av_frame_unref() when they are not needed anymore.
2340 * Otherwise, the decoded frames must not be freed by the caller and are
2341 * only valid until the next decode call.
2343 * This is always automatically enabled if avcodec_receive_frame() is used.
2345 * - encoding: unused
2346 * - decoding: set by the caller before avcodec_open2().
2348 attribute_deprecated
2349 int refcounted_frames;
2351 /* - encoding parameters */
2352 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2353 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2357 * - encoding: Set by user.
2358 * - decoding: unused
2364 * - encoding: Set by user.
2365 * - decoding: unused
2370 * maximum quantizer difference between frames
2371 * - encoding: Set by user.
2372 * - decoding: unused
2377 * decoder bitstream buffer size
2378 * - encoding: Set by user.
2379 * - decoding: unused
2384 * ratecontrol override, see RcOverride
2385 * - encoding: Allocated/set/freed by user.
2386 * - decoding: unused
2388 int rc_override_count;
2389 RcOverride *rc_override;
2393 * - encoding: Set by user.
2394 * - decoding: Set by user, may be overwritten by libavcodec.
2396 int64_t rc_max_rate;
2400 * - encoding: Set by user.
2401 * - decoding: unused
2403 int64_t rc_min_rate;
2406 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2407 * - encoding: Set by user.
2408 * - decoding: unused.
2410 float rc_max_available_vbv_use;
2413 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2414 * - encoding: Set by user.
2415 * - decoding: unused.
2417 float rc_min_vbv_overflow_use;
2420 * Number of bits which should be loaded into the rc buffer before decoding starts.
2421 * - encoding: Set by user.
2422 * - decoding: unused
2424 int rc_initial_buffer_occupancy;
2426 #if FF_API_CODER_TYPE
2427 #define FF_CODER_TYPE_VLC 0
2428 #define FF_CODER_TYPE_AC 1
2429 #define FF_CODER_TYPE_RAW 2
2430 #define FF_CODER_TYPE_RLE 3
2432 * @deprecated use encoder private options instead
2434 attribute_deprecated
2436 #endif /* FF_API_CODER_TYPE */
2438 #if FF_API_PRIVATE_OPT
2439 /** @deprecated use encoder private options instead */
2440 attribute_deprecated
2444 #if FF_API_PRIVATE_OPT
2445 /** @deprecated use encoder private options instead */
2446 attribute_deprecated
2447 int frame_skip_threshold;
2449 /** @deprecated use encoder private options instead */
2450 attribute_deprecated
2451 int frame_skip_factor;
2453 /** @deprecated use encoder private options instead */
2454 attribute_deprecated
2457 /** @deprecated use encoder private options instead */
2458 attribute_deprecated
2460 #endif /* FF_API_PRIVATE_OPT */
2463 * trellis RD quantization
2464 * - encoding: Set by user.
2465 * - decoding: unused
2469 #if FF_API_PRIVATE_OPT
2470 /** @deprecated use encoder private options instead */
2471 attribute_deprecated
2472 int min_prediction_order;
2474 /** @deprecated use encoder private options instead */
2475 attribute_deprecated
2476 int max_prediction_order;
2478 /** @deprecated use encoder private options instead */
2479 attribute_deprecated
2480 int64_t timecode_frame_start;
2483 #if FF_API_RTP_CALLBACK
2485 * @deprecated unused
2487 /* The RTP callback: This function is called */
2488 /* every time the encoder has a packet to send. */
2489 /* It depends on the encoder if the data starts */
2490 /* with a Start Code (it should). H.263 does. */
2491 /* mb_nb contains the number of macroblocks */
2492 /* encoded in the RTP payload. */
2493 attribute_deprecated
2494 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2497 #if FF_API_PRIVATE_OPT
2498 /** @deprecated use encoder private options instead */
2499 attribute_deprecated
2500 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2501 /* do its best to deliver a chunk with size */
2502 /* below rtp_payload_size, the chunk will start */
2503 /* with a start code on some codecs like H.263. */
2504 /* This doesn't take account of any particular */
2505 /* headers inside the transmitted RTP payload. */
2508 #if FF_API_STAT_BITS
2509 /* statistics, used for 2-pass encoding */
2510 attribute_deprecated
2512 attribute_deprecated
2514 attribute_deprecated
2516 attribute_deprecated
2518 attribute_deprecated
2520 attribute_deprecated
2522 attribute_deprecated
2524 attribute_deprecated
2527 /** @deprecated this field is unused */
2528 attribute_deprecated
2533 * pass1 encoding statistics output buffer
2534 * - encoding: Set by libavcodec.
2535 * - decoding: unused
2540 * pass2 encoding statistics input buffer
2541 * Concatenated stuff from stats_out of pass1 should be placed here.
2542 * - encoding: Allocated/set/freed by user.
2543 * - decoding: unused
2548 * Work around bugs in encoders which sometimes cannot be detected automatically.
2549 * - encoding: Set by user
2550 * - decoding: Set by user
2552 int workaround_bugs;
2553 #define FF_BUG_AUTODETECT 1 ///< autodetection
2554 #define FF_BUG_XVID_ILACE 4
2555 #define FF_BUG_UMP4 8
2556 #define FF_BUG_NO_PADDING 16
2557 #define FF_BUG_AMV 32
2558 #define FF_BUG_QPEL_CHROMA 64
2559 #define FF_BUG_STD_QPEL 128
2560 #define FF_BUG_QPEL_CHROMA2 256
2561 #define FF_BUG_DIRECT_BLOCKSIZE 512
2562 #define FF_BUG_EDGE 1024
2563 #define FF_BUG_HPEL_CHROMA 2048
2564 #define FF_BUG_DC_CLIP 4096
2565 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2566 #define FF_BUG_TRUNCATED 16384
2567 #define FF_BUG_IEDGE 32768
2570 * strictly follow the standard (MPEG-4, ...).
2571 * - encoding: Set by user.
2572 * - decoding: Set by user.
2573 * Setting this to STRICT or higher means the encoder and decoder will
2574 * generally do stupid things, whereas setting it to unofficial or lower
2575 * will mean the encoder might produce output that is not supported by all
2576 * spec-compliant decoders. Decoders don't differentiate between normal,
2577 * unofficial and experimental (that is, they always try to decode things
2578 * when they can) unless they are explicitly asked to behave stupidly
2579 * (=strictly conform to the specs)
2581 int strict_std_compliance;
2582 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2583 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2584 #define FF_COMPLIANCE_NORMAL 0
2585 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2586 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2589 * error concealment flags
2590 * - encoding: unused
2591 * - decoding: Set by user.
2593 int error_concealment;
2594 #define FF_EC_GUESS_MVS 1
2595 #define FF_EC_DEBLOCK 2
2596 #define FF_EC_FAVOR_INTER 256
2600 * - encoding: Set by user.
2601 * - decoding: Set by user.
2604 #define FF_DEBUG_PICT_INFO 1
2605 #define FF_DEBUG_RC 2
2606 #define FF_DEBUG_BITSTREAM 4
2607 #define FF_DEBUG_MB_TYPE 8
2608 #define FF_DEBUG_QP 16
2611 * @deprecated this option does nothing
2613 #define FF_DEBUG_MV 32
2615 #define FF_DEBUG_DCT_COEFF 0x00000040
2616 #define FF_DEBUG_SKIP 0x00000080
2617 #define FF_DEBUG_STARTCODE 0x00000100
2618 #define FF_DEBUG_ER 0x00000400
2619 #define FF_DEBUG_MMCO 0x00000800
2620 #define FF_DEBUG_BUGS 0x00001000
2622 #define FF_DEBUG_VIS_QP 0x00002000
2623 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2625 #define FF_DEBUG_BUFFERS 0x00008000
2626 #define FF_DEBUG_THREADS 0x00010000
2627 #define FF_DEBUG_GREEN_MD 0x00800000
2628 #define FF_DEBUG_NOMC 0x01000000
2633 * - encoding: Set by user.
2634 * - decoding: Set by user.
2637 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2638 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2639 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2643 * Error recognition; may misdetect some more or less valid parts as errors.
2644 * - encoding: unused
2645 * - decoding: Set by user.
2647 int err_recognition;
2650 * Verify checksums embedded in the bitstream (could be of either encoded or
2651 * decoded data, depending on the codec) and print an error message on mismatch.
2652 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2653 * decoder returning an error.
2655 #define AV_EF_CRCCHECK (1<<0)
2656 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2657 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2658 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2660 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2661 #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
2662 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2663 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2667 * opaque 64-bit number (generally a PTS) that will be reordered and
2668 * output in AVFrame.reordered_opaque
2669 * - encoding: unused
2670 * - decoding: Set by user.
2672 int64_t reordered_opaque;
2675 * Hardware accelerator in use
2676 * - encoding: unused.
2677 * - decoding: Set by libavcodec
2679 const struct AVHWAccel *hwaccel;
2682 * Hardware accelerator context.
2683 * For some hardware accelerators, a global context needs to be
2684 * provided by the user. In that case, this holds display-dependent
2685 * data FFmpeg cannot instantiate itself. Please refer to the
2686 * FFmpeg HW accelerator documentation to know how to fill this
2687 * is. e.g. for VA API, this is a struct vaapi_context.
2688 * - encoding: unused
2689 * - decoding: Set by user
2691 void *hwaccel_context;
2695 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2696 * - decoding: unused
2698 uint64_t error[AV_NUM_DATA_POINTERS];
2701 * DCT algorithm, see FF_DCT_* below
2702 * - encoding: Set by user.
2703 * - decoding: unused
2706 #define FF_DCT_AUTO 0
2707 #define FF_DCT_FASTINT 1
2708 #define FF_DCT_INT 2
2709 #define FF_DCT_MMX 3
2710 #define FF_DCT_ALTIVEC 5
2711 #define FF_DCT_FAAN 6
2714 * IDCT algorithm, see FF_IDCT_* below.
2715 * - encoding: Set by user.
2716 * - decoding: Set by user.
2719 #define FF_IDCT_AUTO 0
2720 #define FF_IDCT_INT 1
2721 #define FF_IDCT_SIMPLE 2
2722 #define FF_IDCT_SIMPLEMMX 3
2723 #define FF_IDCT_ARM 7
2724 #define FF_IDCT_ALTIVEC 8
2725 #define FF_IDCT_SIMPLEARM 10
2726 #define FF_IDCT_XVID 14
2727 #define FF_IDCT_SIMPLEARMV5TE 16
2728 #define FF_IDCT_SIMPLEARMV6 17
2729 #define FF_IDCT_FAAN 20
2730 #define FF_IDCT_SIMPLENEON 22
2731 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2732 #define FF_IDCT_SIMPLEAUTO 128
2735 * bits per sample/pixel from the demuxer (needed for huffyuv).
2736 * - encoding: Set by libavcodec.
2737 * - decoding: Set by user.
2739 int bits_per_coded_sample;
2742 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2743 * - encoding: set by user.
2744 * - decoding: set by libavcodec.
2746 int bits_per_raw_sample;
2750 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2751 * - encoding: unused
2752 * - decoding: Set by user.
2757 #if FF_API_CODED_FRAME
2759 * the picture in the bitstream
2760 * - encoding: Set by libavcodec.
2761 * - decoding: unused
2763 * @deprecated use the quality factor packet side data instead
2765 attribute_deprecated AVFrame *coded_frame;
2770 * is used to decide how many independent tasks should be passed to execute()
2771 * - encoding: Set by user.
2772 * - decoding: Set by user.
2777 * Which multithreading methods to use.
2778 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2779 * so clients which cannot provide future frames should not use it.
2781 * - encoding: Set by user, otherwise the default is used.
2782 * - decoding: Set by user, otherwise the default is used.
2785 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2786 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2789 * Which multithreading methods are in use by the codec.
2790 * - encoding: Set by libavcodec.
2791 * - decoding: Set by libavcodec.
2793 int active_thread_type;
2796 * Set by the client if its custom get_buffer() callback can be called
2797 * synchronously from another thread, which allows faster multithreaded decoding.
2798 * draw_horiz_band() will be called from other threads regardless of this setting.
2799 * Ignored if the default get_buffer() is used.
2800 * - encoding: Set by user.
2801 * - decoding: Set by user.
2803 int thread_safe_callbacks;
2806 * The codec may call this to execute several independent things.
2807 * It will return only after finishing all tasks.
2808 * The user may replace this with some multithreaded implementation,
2809 * the default implementation will execute the parts serially.
2810 * @param count the number of things to execute
2811 * - encoding: Set by libavcodec, user can override.
2812 * - decoding: Set by libavcodec, user can override.
2814 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2817 * The codec may call this to execute several independent things.
2818 * It will return only after finishing all tasks.
2819 * The user may replace this with some multithreaded implementation,
2820 * the default implementation will execute the parts serially.
2821 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2822 * @param c context passed also to func
2823 * @param count the number of things to execute
2824 * @param arg2 argument passed unchanged to func
2825 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2826 * @param func function that will be called count times, with jobnr from 0 to count-1.
2827 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2828 * two instances of func executing at the same time will have the same threadnr.
2829 * @return always 0 currently, but code should handle a future improvement where when any call to func
2830 * returns < 0 no further calls to func may be done and < 0 is returned.
2831 * - encoding: Set by libavcodec, user can override.
2832 * - decoding: Set by libavcodec, user can override.
2834 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2837 * noise vs. sse weight for the nsse comparison function
2838 * - encoding: Set by user.
2839 * - decoding: unused
2845 * - encoding: Set by user.
2846 * - decoding: Set by libavcodec.
2849 #define FF_PROFILE_UNKNOWN -99
2850 #define FF_PROFILE_RESERVED -100
2852 #define FF_PROFILE_AAC_MAIN 0
2853 #define FF_PROFILE_AAC_LOW 1
2854 #define FF_PROFILE_AAC_SSR 2
2855 #define FF_PROFILE_AAC_LTP 3
2856 #define FF_PROFILE_AAC_HE 4
2857 #define FF_PROFILE_AAC_HE_V2 28
2858 #define FF_PROFILE_AAC_LD 22
2859 #define FF_PROFILE_AAC_ELD 38
2860 #define FF_PROFILE_MPEG2_AAC_LOW 128
2861 #define FF_PROFILE_MPEG2_AAC_HE 131
2863 #define FF_PROFILE_DNXHD 0
2864 #define FF_PROFILE_DNXHR_LB 1
2865 #define FF_PROFILE_DNXHR_SQ 2
2866 #define FF_PROFILE_DNXHR_HQ 3
2867 #define FF_PROFILE_DNXHR_HQX 4
2868 #define FF_PROFILE_DNXHR_444 5
2870 #define FF_PROFILE_DTS 20
2871 #define FF_PROFILE_DTS_ES 30
2872 #define FF_PROFILE_DTS_96_24 40
2873 #define FF_PROFILE_DTS_HD_HRA 50
2874 #define FF_PROFILE_DTS_HD_MA 60
2875 #define FF_PROFILE_DTS_EXPRESS 70
2877 #define FF_PROFILE_MPEG2_422 0
2878 #define FF_PROFILE_MPEG2_HIGH 1
2879 #define FF_PROFILE_MPEG2_SS 2
2880 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2881 #define FF_PROFILE_MPEG2_MAIN 4
2882 #define FF_PROFILE_MPEG2_SIMPLE 5
2884 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2885 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2887 #define FF_PROFILE_H264_BASELINE 66
2888 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2889 #define FF_PROFILE_H264_MAIN 77
2890 #define FF_PROFILE_H264_EXTENDED 88
2891 #define FF_PROFILE_H264_HIGH 100
2892 #define FF_PROFILE_H264_HIGH_10 110
2893 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2894 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2895 #define FF_PROFILE_H264_HIGH_422 122
2896 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2897 #define FF_PROFILE_H264_STEREO_HIGH 128
2898 #define FF_PROFILE_H264_HIGH_444 144
2899 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2900 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2901 #define FF_PROFILE_H264_CAVLC_444 44
2903 #define FF_PROFILE_VC1_SIMPLE 0
2904 #define FF_PROFILE_VC1_MAIN 1
2905 #define FF_PROFILE_VC1_COMPLEX 2
2906 #define FF_PROFILE_VC1_ADVANCED 3
2908 #define FF_PROFILE_MPEG4_SIMPLE 0
2909 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2910 #define FF_PROFILE_MPEG4_CORE 2
2911 #define FF_PROFILE_MPEG4_MAIN 3
2912 #define FF_PROFILE_MPEG4_N_BIT 4
2913 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2914 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2915 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2916 #define FF_PROFILE_MPEG4_HYBRID 8
2917 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2918 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2919 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2920 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2921 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2922 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2923 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2925 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2926 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2927 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2928 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2929 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2931 #define FF_PROFILE_VP9_0 0
2932 #define FF_PROFILE_VP9_1 1
2933 #define FF_PROFILE_VP9_2 2
2934 #define FF_PROFILE_VP9_3 3
2936 #define FF_PROFILE_HEVC_MAIN 1
2937 #define FF_PROFILE_HEVC_MAIN_10 2
2938 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2939 #define FF_PROFILE_HEVC_REXT 4
2941 #define FF_PROFILE_AV1_MAIN 0
2942 #define FF_PROFILE_AV1_HIGH 1
2943 #define FF_PROFILE_AV1_PROFESSIONAL 2
2945 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
2946 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
2947 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
2948 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
2949 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
2951 #define FF_PROFILE_SBC_MSBC 1
2955 * - encoding: Set by user.
2956 * - decoding: Set by libavcodec.
2959 #define FF_LEVEL_UNKNOWN -99
2962 * Skip loop filtering for selected frames.
2963 * - encoding: unused
2964 * - decoding: Set by user.
2966 enum AVDiscard skip_loop_filter;
2969 * Skip IDCT/dequantization for selected frames.
2970 * - encoding: unused
2971 * - decoding: Set by user.
2973 enum AVDiscard skip_idct;
2976 * Skip decoding for selected frames.
2977 * - encoding: unused
2978 * - decoding: Set by user.
2980 enum AVDiscard skip_frame;
2983 * Header containing style information for text subtitles.
2984 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2985 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2986 * the Format line following. It shouldn't include any Dialogue line.
2987 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2988 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2990 uint8_t *subtitle_header;
2991 int subtitle_header_size;
2993 #if FF_API_VBV_DELAY
2995 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2996 * Used for compliant TS muxing.
2997 * - encoding: Set by libavcodec.
2998 * - decoding: unused.
2999 * @deprecated this value is now exported as a part of
3000 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3002 attribute_deprecated
3006 #if FF_API_SIDEDATA_ONLY_PKT
3008 * Encoding only and set by default. Allow encoders to output packets
3009 * that do not contain any encoded data, only side data.
3011 * Some encoders need to output such packets, e.g. to update some stream
3012 * parameters at the end of encoding.
3014 * @deprecated this field disables the default behaviour and
3015 * it is kept only for compatibility.
3017 attribute_deprecated
3018 int side_data_only_packets;
3022 * Audio only. The number of "priming" samples (padding) inserted by the
3023 * encoder at the beginning of the audio. I.e. this number of leading
3024 * decoded samples must be discarded by the caller to get the original audio
3025 * without leading padding.
3027 * - decoding: unused
3028 * - encoding: Set by libavcodec. The timestamps on the output packets are
3029 * adjusted by the encoder so that they always refer to the
3030 * first sample of the data actually contained in the packet,
3031 * including any added padding. E.g. if the timebase is
3032 * 1/samplerate and the timestamp of the first input sample is
3033 * 0, the timestamp of the first output packet will be
3036 int initial_padding;
3039 * - decoding: For codecs that store a framerate value in the compressed
3040 * bitstream, the decoder may export it here. { 0, 1} when
3042 * - encoding: May be used to signal the framerate of CFR content to an
3045 AVRational framerate;
3048 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3049 * - encoding: unused.
3050 * - decoding: Set by libavcodec before calling get_format()
3052 enum AVPixelFormat sw_pix_fmt;
3055 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3056 * - encoding unused.
3057 * - decoding set by user.
3059 AVRational pkt_timebase;
3063 * - encoding: unused.
3064 * - decoding: set by libavcodec.
3066 const AVCodecDescriptor *codec_descriptor;
3070 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3071 * - encoding: unused
3072 * - decoding: Set by user.
3078 * Current statistics for PTS correction.
3079 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3080 * - encoding: unused
3082 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3083 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3084 int64_t pts_correction_last_pts; /// PTS of the last frame
3085 int64_t pts_correction_last_dts; /// DTS of the last frame
3088 * Character encoding of the input subtitles file.
3089 * - decoding: set by user
3090 * - encoding: unused
3095 * Subtitles character encoding mode. Formats or codecs might be adjusting
3096 * this setting (if they are doing the conversion themselves for instance).
3097 * - decoding: set by libavcodec
3098 * - encoding: unused
3100 int sub_charenc_mode;
3101 #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)
3102 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3103 #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
3104 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
3107 * Skip processing alpha if supported by codec.
3108 * Note that if the format uses pre-multiplied alpha (common with VP6,
3109 * and recommended due to better video quality/compression)
3110 * the image will look as if alpha-blended onto a black background.
3111 * However for formats that do not use pre-multiplied alpha
3112 * there might be serious artefacts (though e.g. libswscale currently
3113 * assumes pre-multiplied alpha anyway).
3115 * - decoding: set by user
3116 * - encoding: unused
3121 * Number of samples to skip after a discontinuity
3122 * - decoding: unused
3123 * - encoding: set by libavcodec
3127 #if !FF_API_DEBUG_MV
3129 * debug motion vectors
3130 * - encoding: Set by user.
3131 * - decoding: Set by user.
3134 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3135 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3136 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3140 * custom intra quantization matrix
3141 * - encoding: Set by user, can be NULL.
3142 * - decoding: unused.
3144 uint16_t *chroma_intra_matrix;
3147 * dump format separator.
3148 * can be ", " or "\n " or anything else
3149 * - encoding: Set by user.
3150 * - decoding: Set by user.
3152 uint8_t *dump_separator;
3155 * ',' separated list of allowed decoders.
3156 * If NULL then all are allowed
3157 * - encoding: unused
3158 * - decoding: set by user
3160 char *codec_whitelist;
3163 * Properties of the stream that gets decoded
3164 * - encoding: unused
3165 * - decoding: set by libavcodec
3167 unsigned properties;
3168 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3169 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3172 * Additional data associated with the entire coded stream.
3174 * - decoding: unused
3175 * - encoding: may be set by libavcodec after avcodec_open2().
3177 AVPacketSideData *coded_side_data;
3178 int nb_coded_side_data;
3181 * A reference to the AVHWFramesContext describing the input (for encoding)
3182 * or output (decoding) frames. The reference is set by the caller and
3183 * afterwards owned (and freed) by libavcodec - it should never be read by
3184 * the caller after being set.
3186 * - decoding: This field should be set by the caller from the get_format()
3187 * callback. The previous reference (if any) will always be
3188 * unreffed by libavcodec before the get_format() call.
3190 * If the default get_buffer2() is used with a hwaccel pixel
3191 * format, then this AVHWFramesContext will be used for
3192 * allocating the frame buffers.
3194 * - encoding: For hardware encoders configured to use a hwaccel pixel
3195 * format, this field should be set by the caller to a reference
3196 * to the AVHWFramesContext describing input frames.
3197 * AVHWFramesContext.format must be equal to
3198 * AVCodecContext.pix_fmt.
3200 * This field should be set before avcodec_open2() is called.
3202 AVBufferRef *hw_frames_ctx;
3205 * Control the form of AVSubtitle.rects[N]->ass
3206 * - decoding: set by user
3207 * - encoding: unused
3209 int sub_text_format;
3210 #define FF_SUB_TEXT_FMT_ASS 0
3211 #if FF_API_ASS_TIMING
3212 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3216 * Audio only. The amount of padding (in samples) appended by the encoder to
3217 * the end of the audio. I.e. this number of decoded samples must be
3218 * discarded by the caller from the end of the stream to get the original
3219 * audio without any trailing padding.
3221 * - decoding: unused
3222 * - encoding: unused
3224 int trailing_padding;
3227 * The number of pixels per image to maximally accept.
3229 * - decoding: set by user
3230 * - encoding: set by user
3235 * A reference to the AVHWDeviceContext describing the device which will
3236 * be used by a hardware encoder/decoder. The reference is set by the
3237 * caller and afterwards owned (and freed) by libavcodec.
3239 * This should be used if either the codec device does not require
3240 * hardware frames or any that are used are to be allocated internally by
3241 * libavcodec. If the user wishes to supply any of the frames used as
3242 * encoder input or decoder output then hw_frames_ctx should be used
3243 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3244 * field will be ignored while decoding the associated stream segment, but
3245 * may again be used on a following one after another get_format() call.
3247 * For both encoders and decoders this field should be set before
3248 * avcodec_open2() is called and must not be written to thereafter.
3250 * Note that some decoders may require this field to be set initially in
3251 * order to support hw_frames_ctx at all - in that case, all frames
3252 * contexts used must be created on the same device.
3254 AVBufferRef *hw_device_ctx;
3257 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3258 * decoding (if active).
3259 * - encoding: unused
3260 * - decoding: Set by user (either before avcodec_open2(), or in the
3261 * AVCodecContext.get_format callback)
3266 * Video decoding only. Certain video codecs support cropping, meaning that
3267 * only a sub-rectangle of the decoded frame is intended for display. This
3268 * option controls how cropping is handled by libavcodec.
3270 * When set to 1 (the default), libavcodec will apply cropping internally.
3271 * I.e. it will modify the output frame width/height fields and offset the
3272 * data pointers (only by as much as possible while preserving alignment, or
3273 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3274 * the frames output by the decoder refer only to the cropped area. The
3275 * crop_* fields of the output frames will be zero.
3277 * When set to 0, the width/height fields of the output frames will be set
3278 * to the coded dimensions and the crop_* fields will describe the cropping
3279 * rectangle. Applying the cropping is left to the caller.
3281 * @warning When hardware acceleration with opaque output frames is used,
3282 * libavcodec is unable to apply cropping from the top/left border.
3284 * @note when this option is set to zero, the width/height fields of the
3285 * AVCodecContext and output AVFrames have different meanings. The codec
3286 * context fields store display dimensions (with the coded dimensions in
3287 * coded_width/height), while the frame fields store the coded dimensions
3288 * (with the display dimensions being determined by the crop_* fields).
3293 * Video decoding only. Sets the number of extra hardware frames which
3294 * the decoder will allocate for use by the caller. This must be set
3295 * before avcodec_open2() is called.
3297 * Some hardware decoders require all frames that they will use for
3298 * output to be defined in advance before decoding starts. For such
3299 * decoders, the hardware frame pool must therefore be of a fixed size.
3300 * The extra frames set here are on top of any number that the decoder
3301 * needs internally in order to operate normally (for example, frames
3302 * used as reference pictures).
3304 int extra_hw_frames;
3307 #if FF_API_CODEC_GET_SET
3309 * Accessors for some AVCodecContext fields. These used to be provided for ABI
3310 * compatibility, and do not need to be used anymore.
3312 attribute_deprecated
3313 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3314 attribute_deprecated
3315 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3317 attribute_deprecated
3318 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3319 attribute_deprecated
3320 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3322 attribute_deprecated
3323 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3326 attribute_deprecated
3327 int av_codec_get_lowres(const AVCodecContext *avctx);
3328 attribute_deprecated
3329 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3332 attribute_deprecated
3333 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3334 attribute_deprecated
3335 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3337 attribute_deprecated
3338 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3339 attribute_deprecated
3340 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3346 typedef struct AVProfile {
3348 const char *name; ///< short name for the profile
3353 * The codec supports this format via the hw_device_ctx interface.
3355 * When selecting this format, AVCodecContext.hw_device_ctx should
3356 * have been set to a device of the specified type before calling
3359 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
3361 * The codec supports this format via the hw_frames_ctx interface.
3363 * When selecting this format for a decoder,
3364 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3365 * context inside the get_format() callback. The frames context
3366 * must have been created on a device of the specified type.
3368 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
3370 * The codec supports this format by some internal method.
3372 * This format can be selected without any additional configuration -
3373 * no device or frames context is required.
3375 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
3377 * The codec supports this format by some ad-hoc method.
3379 * Additional settings and/or function calls are required. See the
3380 * codec-specific documentation for details. (Methods requiring
3381 * this sort of configuration are deprecated and others should be
3382 * used in preference.)
3384 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
3387 typedef struct AVCodecHWConfig {
3389 * A hardware pixel format which the codec can use.
3391 enum AVPixelFormat pix_fmt;
3393 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3394 * setup methods which can be used with this configuration.
3398 * The device type associated with the configuration.
3400 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3401 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3403 enum AVHWDeviceType device_type;
3406 typedef struct AVCodecDefault AVCodecDefault;
3413 typedef struct AVCodec {
3415 * Name of the codec implementation.
3416 * The name is globally unique among encoders and among decoders (but an
3417 * encoder and a decoder can share the same name).
3418 * This is the primary way to find a codec from the user perspective.
3422 * Descriptive name for the codec, meant to be more human readable than name.
3423 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3425 const char *long_name;
3426 enum AVMediaType type;
3429 * Codec capabilities.
3430 * see AV_CODEC_CAP_*
3433 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3434 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3435 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3436 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3437 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3438 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3439 const AVClass *priv_class; ///< AVClass for the private context
3440 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3443 * Group name of the codec implementation.
3444 * This is a short symbolic name of the wrapper backing this codec. A
3445 * wrapper uses some kind of external implementation for the codec, such
3446 * as an external library, or a codec implementation provided by the OS or
3448 * If this field is NULL, this is a builtin, libavcodec native codec.
3449 * If non-NULL, this will be the suffix in AVCodec.name in most cases
3450 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3452 const char *wrapper_name;
3454 /*****************************************************************
3455 * No fields below this line are part of the public API. They
3456 * may not be used outside of libavcodec and can be changed and
3458 * New public fields should be added right above.
3459 *****************************************************************
3462 struct AVCodec *next;
3464 * @name Frame-level threading support functions
3468 * If defined, called on thread contexts when they are created.
3469 * If the codec allocates writable tables in init(), re-allocate them here.
3470 * priv_data will be set to a copy of the original.
3472 int (*init_thread_copy)(AVCodecContext *);
3474 * Copy necessary context variables from a previous thread context to the current one.
3475 * If not defined, the next thread will start automatically; otherwise, the codec
3476 * must call ff_thread_finish_setup().
3478 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3480 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3484 * Private codec-specific defaults.
3486 const AVCodecDefault *defaults;
3489 * Initialize codec static data, called from avcodec_register().
3491 * This is not intended for time consuming operations as it is
3492 * run for every codec regardless of that codec being used.
3494 void (*init_static_data)(struct AVCodec *codec);
3496 int (*init)(AVCodecContext *);
3497 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3498 const struct AVSubtitle *sub);
3500 * Encode data to an AVPacket.
3502 * @param avctx codec context
3503 * @param avpkt output AVPacket (may contain a user-provided buffer)
3504 * @param[in] frame AVFrame containing the raw data to be encoded
3505 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3506 * non-empty packet was returned in avpkt.
3507 * @return 0 on success, negative error code on failure
3509 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3510 int *got_packet_ptr);
3511 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3512 int (*close)(AVCodecContext *);
3514 * Encode API with decoupled packet/frame dataflow. The API is the
3515 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3517 * - never called if the codec is closed or the wrong type,
3518 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3519 * - only one drain frame is ever passed down,
3521 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3522 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3525 * Decode API with decoupled packet/frame dataflow. This function is called
3526 * to get one output frame. It should call ff_decode_get_packet() to obtain
3529 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3532 * Will be called when seeking
3534 void (*flush)(AVCodecContext *);
3536 * Internal codec capabilities.
3537 * See FF_CODEC_CAP_* in internal.h
3542 * Decoding only, a comma-separated list of bitstream filters to apply to
3543 * packets before decoding.
3548 * Array of pointers to hardware configurations supported by the codec,
3549 * or NULL if no hardware supported. The array is terminated by a NULL
3552 * The user can only access this field via avcodec_get_hw_config().
3554 const struct AVCodecHWConfigInternal **hw_configs;
3557 #if FF_API_CODEC_GET_SET
3558 attribute_deprecated
3559 int av_codec_get_max_lowres(const AVCodec *codec);
3562 struct MpegEncContext;
3565 * Retrieve supported hardware configurations for a codec.
3567 * Values of index from zero to some maximum return the indexed configuration
3568 * descriptor; all other values return NULL. If the codec does not support
3569 * any hardware configurations then it will always return NULL.
3571 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3574 * @defgroup lavc_hwaccel AVHWAccel
3576 * @note Nothing in this structure should be accessed by the user. At some
3577 * point in future it will not be externally visible at all.
3581 typedef struct AVHWAccel {
3583 * Name of the hardware accelerated codec.
3584 * The name is globally unique among encoders and among decoders (but an
3585 * encoder and a decoder can share the same name).
3590 * Type of codec implemented by the hardware accelerator.
3592 * See AVMEDIA_TYPE_xxx
3594 enum AVMediaType type;
3597 * Codec implemented by the hardware accelerator.
3599 * See AV_CODEC_ID_xxx
3604 * Supported pixel format.
3606 * Only hardware accelerated formats are supported here.
3608 enum AVPixelFormat pix_fmt;
3611 * Hardware accelerated codec capabilities.
3612 * see AV_HWACCEL_CODEC_CAP_*
3616 /*****************************************************************
3617 * No fields below this line are part of the public API. They
3618 * may not be used outside of libavcodec and can be changed and
3620 * New public fields should be added right above.
3621 *****************************************************************
3625 * Allocate a custom buffer
3627 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3630 * Called at the beginning of each frame or field picture.
3632 * Meaningful frame information (codec specific) is guaranteed to
3633 * be parsed at this point. This function is mandatory.
3635 * Note that buf can be NULL along with buf_size set to 0.
3636 * Otherwise, this means the whole frame is available at this point.
3638 * @param avctx the codec context
3639 * @param buf the frame data buffer base
3640 * @param buf_size the size of the frame in bytes
3641 * @return zero if successful, a negative value otherwise
3643 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3646 * Callback for parameter data (SPS/PPS/VPS etc).
3648 * Useful for hardware decoders which keep persistent state about the
3649 * video parameters, and need to receive any changes to update that state.
3651 * @param avctx the codec context
3652 * @param type the nal unit type
3653 * @param buf the nal unit data buffer
3654 * @param buf_size the size of the nal unit in bytes
3655 * @return zero if successful, a negative value otherwise
3657 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3660 * Callback for each slice.
3662 * Meaningful slice information (codec specific) is guaranteed to
3663 * be parsed at this point. This function is mandatory.
3664 * The only exception is XvMC, that works on MB level.
3666 * @param avctx the codec context
3667 * @param buf the slice data buffer base
3668 * @param buf_size the size of the slice in bytes
3669 * @return zero if successful, a negative value otherwise
3671 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3674 * Called at the end of each frame or field picture.
3676 * The whole picture is parsed at this point and can now be sent
3677 * to the hardware accelerator. This function is mandatory.
3679 * @param avctx the codec context
3680 * @return zero if successful, a negative value otherwise
3682 int (*end_frame)(AVCodecContext *avctx);
3685 * Size of per-frame hardware accelerator private data.
3687 * Private data is allocated with av_mallocz() before
3688 * AVCodecContext.get_buffer() and deallocated after
3689 * AVCodecContext.release_buffer().
3691 int frame_priv_data_size;
3694 * Called for every Macroblock in a slice.
3696 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3697 * Instead of decoding to raw picture, MB parameters are
3698 * stored in an array provided by the video driver.
3700 * @param s the mpeg context
3702 void (*decode_mb)(struct MpegEncContext *s);
3705 * Initialize the hwaccel private data.
3707 * This will be called from ff_get_format(), after hwaccel and
3708 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3711 int (*init)(AVCodecContext *avctx);
3714 * Uninitialize the hwaccel private data.
3716 * This will be called from get_format() or avcodec_close(), after hwaccel
3717 * and hwaccel_context are already uninitialized.
3719 int (*uninit)(AVCodecContext *avctx);
3722 * Size of the private data to allocate in
3723 * AVCodecInternal.hwaccel_priv_data.
3728 * Internal hwaccel capabilities.
3733 * Fill the given hw_frames context with current codec parameters. Called
3734 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3737 * This CAN be called before AVHWAccel.init is called, and you must assume
3738 * that avctx->hwaccel_priv_data is invalid.
3740 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3744 * HWAccel is experimental and is thus avoided in favor of non experimental
3747 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3750 * Hardware acceleration should be used for decoding even if the codec level
3751 * used is unknown or higher than the maximum supported level reported by the
3754 * It's generally a good idea to pass this flag unless you have a specific
3755 * reason not to, as hardware tends to under-report supported levels.
3757 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3760 * Hardware acceleration can output YUV pixel formats with a different chroma
3761 * sampling than 4:2:0 and/or other than 8 bits per component.
3763 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3766 * Hardware acceleration should still be attempted for decoding when the
3767 * codec profile does not match the reported capabilities of the hardware.
3769 * For example, this can be used to try to decode baseline profile H.264
3770 * streams in hardware - it will often succeed, because many streams marked
3771 * as baseline profile actually conform to constrained baseline profile.
3773 * @warning If the stream is actually not supported then the behaviour is
3774 * undefined, and may include returning entirely incorrect output
3775 * while indicating success.
3777 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3783 #if FF_API_AVPICTURE
3785 * @defgroup lavc_picture AVPicture
3787 * Functions for working with AVPicture
3792 * Picture data structure.
3794 * Up to four components can be stored into it, the last component is
3796 * @deprecated use AVFrame or imgutils functions instead
3798 typedef struct AVPicture {
3799 attribute_deprecated
3800 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3801 attribute_deprecated
3802 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3810 enum AVSubtitleType {
3813 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3816 * Plain text, the text field must be set by the decoder and is
3817 * authoritative. ass and pict fields may contain approximations.
3822 * Formatted text, the ass field must be set by the decoder and is
3823 * authoritative. pict and text fields may contain approximations.
3828 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3830 typedef struct AVSubtitleRect {
3831 int x; ///< top left corner of pict, undefined when pict is not set
3832 int y; ///< top left corner of pict, undefined when pict is not set
3833 int w; ///< width of pict, undefined when pict is not set
3834 int h; ///< height of pict, undefined when pict is not set
3835 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3837 #if FF_API_AVPICTURE
3839 * @deprecated unused
3841 attribute_deprecated
3845 * data+linesize for the bitmap of this subtitle.
3846 * Can be set for text/ass as well once they are rendered.
3851 enum AVSubtitleType type;
3853 char *text; ///< 0 terminated plain UTF-8 text
3856 * 0 terminated ASS/SSA compatible event line.
3857 * The presentation of this is unaffected by the other values in this
3865 typedef struct AVSubtitle {
3866 uint16_t format; /* 0 = graphics */
3867 uint32_t start_display_time; /* relative to packet pts, in ms */
3868 uint32_t end_display_time; /* relative to packet pts, in ms */
3870 AVSubtitleRect **rects;
3871 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3875 * This struct describes the properties of an encoded stream.
3877 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3878 * be allocated with avcodec_parameters_alloc() and freed with
3879 * avcodec_parameters_free().
3881 typedef struct AVCodecParameters {
3883 * General type of the encoded data.
3885 enum AVMediaType codec_type;
3887 * Specific type of the encoded data (the codec used).
3889 enum AVCodecID codec_id;
3891 * Additional information about the codec (corresponds to the AVI FOURCC).
3896 * Extra binary data needed for initializing the decoder, codec-dependent.
3898 * Must be allocated with av_malloc() and will be freed by
3899 * avcodec_parameters_free(). The allocated size of extradata must be at
3900 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3905 * Size of the extradata content in bytes.
3910 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3911 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3916 * The average bitrate of the encoded data (in bits per second).
3921 * The number of bits per sample in the codedwords.
3923 * This is basically the bitrate per sample. It is mandatory for a bunch of
3924 * formats to actually decode them. It's the number of bits for one sample in
3925 * the actual coded bitstream.
3927 * This could be for example 4 for ADPCM
3928 * For PCM formats this matches bits_per_raw_sample
3931 int bits_per_coded_sample;
3934 * This is the number of valid bits in each output sample. If the
3935 * sample format has more bits, the least significant bits are additional
3936 * padding bits, which are always 0. Use right shifts to reduce the sample
3937 * to its actual size. For example, audio formats with 24 bit samples will
3938 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3939 * To get the original sample use "(int32_t)sample >> 8"."
3941 * For ADPCM this might be 12 or 16 or similar
3944 int bits_per_raw_sample;
3947 * Codec-specific bitstream restrictions that the stream conforms to.
3953 * Video only. The dimensions of the video frame in pixels.
3959 * Video only. The aspect ratio (width / height) which a single pixel
3960 * should have when displayed.
3962 * When the aspect ratio is unknown / undefined, the numerator should be
3963 * set to 0 (the denominator may have any value).
3965 AVRational sample_aspect_ratio;
3968 * Video only. The order of the fields in interlaced video.
3970 enum AVFieldOrder field_order;
3973 * Video only. Additional colorspace characteristics.
3975 enum AVColorRange color_range;
3976 enum AVColorPrimaries color_primaries;
3977 enum AVColorTransferCharacteristic color_trc;
3978 enum AVColorSpace color_space;
3979 enum AVChromaLocation chroma_location;
3982 * Video only. Number of delayed frames.
3987 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3988 * unknown or unspecified, otherwise the number of bits set must be equal to
3989 * the channels field.
3991 uint64_t channel_layout;
3993 * Audio only. The number of audio channels.
3997 * Audio only. The number of audio samples per second.
4001 * Audio only. The number of bytes per coded audio frame, required by some
4004 * Corresponds to nBlockAlign in WAVEFORMATEX.
4008 * Audio only. Audio frame size, if known. Required by some formats to be static.
4013 * Audio only. The amount of padding (in samples) inserted by the encoder at
4014 * the beginning of the audio. I.e. this number of leading decoded samples
4015 * must be discarded by the caller to get the original audio without leading
4018 int initial_padding;
4020 * Audio only. The amount of padding (in samples) appended by the encoder to
4021 * the end of the audio. I.e. this number of decoded samples must be
4022 * discarded by the caller from the end of the stream to get the original
4023 * audio without any trailing padding.
4025 int trailing_padding;
4027 * Audio only. Number of samples to skip after a discontinuity.
4030 } AVCodecParameters;
4033 * Iterate over all registered codecs.
4035 * @param opaque a pointer where libavcodec will store the iteration state. Must
4036 * point to NULL to start the iteration.
4038 * @return the next registered codec or NULL when the iteration is
4041 const AVCodec *av_codec_iterate(void **opaque);
4045 * If c is NULL, returns the first registered codec,
4046 * if c is non-NULL, returns the next registered codec after c,
4047 * or NULL if c is the last one.
4049 attribute_deprecated
4050 AVCodec *av_codec_next(const AVCodec *c);
4054 * Return the LIBAVCODEC_VERSION_INT constant.
4056 unsigned avcodec_version(void);
4059 * Return the libavcodec build-time configuration.
4061 const char *avcodec_configuration(void);
4064 * Return the libavcodec license.
4066 const char *avcodec_license(void);
4070 * Register the codec codec and initialize libavcodec.
4072 * @warning either this function or avcodec_register_all() must be called
4073 * before any other libavcodec functions.
4075 * @see avcodec_register_all()
4077 attribute_deprecated
4078 void avcodec_register(AVCodec *codec);
4081 * Register all the codecs, parsers and bitstream filters which were enabled at
4082 * configuration time. If you do not call this function you can select exactly
4083 * which formats you want to support, by using the individual registration
4086 * @see avcodec_register
4087 * @see av_register_codec_parser
4088 * @see av_register_bitstream_filter
4090 attribute_deprecated
4091 void avcodec_register_all(void);
4095 * Allocate an AVCodecContext and set its fields to default values. The
4096 * resulting struct should be freed with avcodec_free_context().
4098 * @param codec if non-NULL, allocate private data and initialize defaults
4099 * for the given codec. It is illegal to then call avcodec_open2()
4100 * with a different codec.
4101 * If NULL, then the codec-specific defaults won't be initialized,
4102 * which may result in suboptimal default settings (this is
4103 * important mainly for encoders, e.g. libx264).
4105 * @return An AVCodecContext filled with default values or NULL on failure.
4107 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4110 * Free the codec context and everything associated with it and write NULL to
4111 * the provided pointer.
4113 void avcodec_free_context(AVCodecContext **avctx);
4115 #if FF_API_GET_CONTEXT_DEFAULTS
4117 * @deprecated This function should not be used, as closing and opening a codec
4118 * context multiple time is not supported. A new codec context should be
4119 * allocated for each new use.
4121 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4125 * Get the AVClass for AVCodecContext. It can be used in combination with
4126 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4128 * @see av_opt_find().
4130 const AVClass *avcodec_get_class(void);
4132 #if FF_API_COPY_CONTEXT
4134 * Get the AVClass for AVFrame. It can be used in combination with
4135 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4137 * @see av_opt_find().
4139 const AVClass *avcodec_get_frame_class(void);
4142 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4143 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4145 * @see av_opt_find().
4147 const AVClass *avcodec_get_subtitle_rect_class(void);
4150 * Copy the settings of the source AVCodecContext into the destination
4151 * AVCodecContext. The resulting destination codec context will be
4152 * unopened, i.e. you are required to call avcodec_open2() before you
4153 * can use this AVCodecContext to decode/encode video/audio data.
4155 * @param dest target codec context, should be initialized with
4156 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4157 * @param src source codec context
4158 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4160 * @deprecated The semantics of this function are ill-defined and it should not
4161 * be used. If you need to transfer the stream parameters from one codec context
4162 * to another, use an intermediate AVCodecParameters instance and the
4163 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4166 attribute_deprecated
4167 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4171 * Allocate a new AVCodecParameters and set its fields to default values
4172 * (unknown/invalid/0). The returned struct must be freed with
4173 * avcodec_parameters_free().
4175 AVCodecParameters *avcodec_parameters_alloc(void);
4178 * Free an AVCodecParameters instance and everything associated with it and
4179 * write NULL to the supplied pointer.
4181 void avcodec_parameters_free(AVCodecParameters **par);
4184 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4185 * replaced with newly allocated duplicates of the corresponding fields in src.
4187 * @return >= 0 on success, a negative AVERROR code on failure.
4189 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4192 * Fill the parameters struct based on the values from the supplied codec
4193 * context. Any allocated fields in par are freed and replaced with duplicates
4194 * of the corresponding fields in codec.
4196 * @return >= 0 on success, a negative AVERROR code on failure
4198 int avcodec_parameters_from_context(AVCodecParameters *par,
4199 const AVCodecContext *codec);
4202 * Fill the codec context based on the values from the supplied codec
4203 * parameters. Any allocated fields in codec that have a corresponding field in
4204 * par are freed and replaced with duplicates of the corresponding field in par.
4205 * Fields in codec that do not have a counterpart in par are not touched.
4207 * @return >= 0 on success, a negative AVERROR code on failure.
4209 int avcodec_parameters_to_context(AVCodecContext *codec,
4210 const AVCodecParameters *par);
4213 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4214 * function the context has to be allocated with avcodec_alloc_context3().
4216 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4217 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4218 * retrieving a codec.
4220 * @warning This function is not thread safe!
4222 * @note Always call this function before using decoding routines (such as
4223 * @ref avcodec_receive_frame()).
4226 * avcodec_register_all();
4227 * av_dict_set(&opts, "b", "2.5M", 0);
4228 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4232 * context = avcodec_alloc_context3(codec);
4234 * if (avcodec_open2(context, codec, opts) < 0)
4238 * @param avctx The context to initialize.
4239 * @param codec The codec to open this context for. If a non-NULL codec has been
4240 * previously passed to avcodec_alloc_context3() or
4241 * for this context, then this parameter MUST be either NULL or
4242 * equal to the previously passed codec.
4243 * @param options A dictionary filled with AVCodecContext and codec-private options.
4244 * On return this object will be filled with options that were not found.
4246 * @return zero on success, a negative value on error
4247 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4248 * av_dict_set(), av_opt_find().
4250 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4253 * Close a given AVCodecContext and free all the data associated with it
4254 * (but not the AVCodecContext itself).
4256 * Calling this function on an AVCodecContext that hasn't been opened will free
4257 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4258 * codec. Subsequent calls will do nothing.
4260 * @note Do not use this function. Use avcodec_free_context() to destroy a
4261 * codec context (either open or closed). Opening and closing a codec context
4262 * multiple times is not supported anymore -- use multiple codec contexts
4265 int avcodec_close(AVCodecContext *avctx);
4268 * Free all allocated data in the given subtitle struct.
4270 * @param sub AVSubtitle to free.
4272 void avsubtitle_free(AVSubtitle *sub);
4279 * @addtogroup lavc_packet
4284 * Allocate an AVPacket and set its fields to default values. The resulting
4285 * struct must be freed using av_packet_free().
4287 * @return An AVPacket filled with default values or NULL on failure.
4289 * @note this only allocates the AVPacket itself, not the data buffers. Those
4290 * must be allocated through other means such as av_new_packet.
4292 * @see av_new_packet
4294 AVPacket *av_packet_alloc(void);
4297 * Create a new packet that references the same data as src.
4299 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4301 * @return newly created AVPacket on success, NULL on error.
4303 * @see av_packet_alloc
4304 * @see av_packet_ref
4306 AVPacket *av_packet_clone(const AVPacket *src);
4309 * Free the packet, if the packet is reference counted, it will be
4310 * unreferenced first.
4312 * @param pkt packet to be freed. The pointer will be set to NULL.
4313 * @note passing NULL is a no-op.
4315 void av_packet_free(AVPacket **pkt);
4318 * Initialize optional fields of a packet with default values.
4320 * Note, this does not touch the data and size members, which have to be
4321 * initialized separately.
4325 void av_init_packet(AVPacket *pkt);
4328 * Allocate the payload of a packet and initialize its fields with
4332 * @param size wanted payload size
4333 * @return 0 if OK, AVERROR_xxx otherwise
4335 int av_new_packet(AVPacket *pkt, int size);
4338 * Reduce packet size, correctly zeroing padding
4341 * @param size new size
4343 void av_shrink_packet(AVPacket *pkt, int size);
4346 * Increase packet size, correctly zeroing padding
4349 * @param grow_by number of bytes by which to increase the size of the packet
4351 int av_grow_packet(AVPacket *pkt, int grow_by);
4354 * Initialize a reference-counted packet from av_malloc()ed data.
4356 * @param pkt packet to be initialized. This function will set the data, size,
4357 * buf and destruct fields, all others are left untouched.
4358 * @param data Data allocated by av_malloc() to be used as packet data. If this
4359 * function returns successfully, the data is owned by the underlying AVBuffer.
4360 * The caller may not access the data through other means.
4361 * @param size size of data in bytes, without the padding. I.e. the full buffer
4362 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4364 * @return 0 on success, a negative AVERROR on error
4366 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4368 #if FF_API_AVPACKET_OLD_API
4370 * @warning This is a hack - the packet memory allocation stuff is broken. The
4371 * packet is allocated if it was not really allocated.
4373 * @deprecated Use av_packet_ref or av_packet_make_refcounted
4375 attribute_deprecated
4376 int av_dup_packet(AVPacket *pkt);
4378 * Copy packet, including contents
4380 * @return 0 on success, negative AVERROR on fail
4382 * @deprecated Use av_packet_ref
4384 attribute_deprecated
4385 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4388 * Copy packet side data
4390 * @return 0 on success, negative AVERROR on fail
4392 * @deprecated Use av_packet_copy_props
4394 attribute_deprecated
4395 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4400 * @deprecated Use av_packet_unref
4402 * @param pkt packet to free
4404 attribute_deprecated
4405 void av_free_packet(AVPacket *pkt);
4408 * Allocate new information of a packet.
4411 * @param type side information type
4412 * @param size side information size
4413 * @return pointer to fresh allocated data or NULL otherwise
4415 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4419 * Wrap an existing array as a packet side data.
4422 * @param type side information type
4423 * @param data the side data array. It must be allocated with the av_malloc()
4424 * family of functions. The ownership of the data is transferred to
4426 * @param size side information size
4427 * @return a non-negative number on success, a negative AVERROR code on
4428 * failure. On failure, the packet is unchanged and the data remains
4429 * owned by the caller.
4431 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4432 uint8_t *data, size_t size);
4435 * Shrink the already allocated side data buffer
4438 * @param type side information type
4439 * @param size new side information size
4440 * @return 0 on success, < 0 on failure
4442 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4446 * Get side information from packet.
4449 * @param type desired side information type
4450 * @param size pointer for side information size to store (optional)
4451 * @return pointer to data if present or NULL otherwise
4453 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4456 #if FF_API_MERGE_SD_API
4457 attribute_deprecated
4458 int av_packet_merge_side_data(AVPacket *pkt);
4460 attribute_deprecated
4461 int av_packet_split_side_data(AVPacket *pkt);
4464 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4467 * Pack a dictionary for use in side_data.
4469 * @param dict The dictionary to pack.
4470 * @param size pointer to store the size of the returned data
4471 * @return pointer to data if successful, NULL otherwise
4473 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4475 * Unpack a dictionary from side_data.
4477 * @param data data from side_data
4478 * @param size size of the data
4479 * @param dict the metadata storage dictionary
4480 * @return 0 on success, < 0 on failure
4482 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4486 * Convenience function to free all the side data stored.
4487 * All the other fields stay untouched.
4491 void av_packet_free_side_data(AVPacket *pkt);
4494 * Setup a new reference to the data described by a given packet
4496 * If src is reference-counted, setup dst as a new reference to the
4497 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4498 * data from src into it.
4500 * All the other fields are copied from src.
4502 * @see av_packet_unref
4504 * @param dst Destination packet
4505 * @param src Source packet
4507 * @return 0 on success, a negative AVERROR on error.
4509 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4514 * Unreference the buffer referenced by the packet and reset the
4515 * remaining packet fields to their default values.
4517 * @param pkt The packet to be unreferenced.
4519 void av_packet_unref(AVPacket *pkt);
4522 * Move every field in src to dst and reset src.
4524 * @see av_packet_unref
4526 * @param src Source packet, will be reset
4527 * @param dst Destination packet
4529 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4532 * Copy only "properties" fields from src to dst.
4534 * Properties for the purpose of this function are all the fields
4535 * beside those related to the packet data (buf, data, size)
4537 * @param dst Destination packet
4538 * @param src Source packet
4540 * @return 0 on success AVERROR on failure.
4542 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4545 * Ensure the data described by a given packet is reference counted.
4547 * @note This function does not ensure that the reference will be writable.
4548 * Use av_packet_make_writable instead for that purpose.
4550 * @see av_packet_ref
4551 * @see av_packet_make_writable
4553 * @param pkt packet whose data should be made reference counted.
4555 * @return 0 on success, a negative AVERROR on error. On failure, the
4556 * packet is unchanged.
4558 int av_packet_make_refcounted(AVPacket *pkt);
4561 * Create a writable reference for the data described by a given packet,
4562 * avoiding data copy if possible.
4564 * @param pkt Packet whose data should be made writable.
4566 * @return 0 on success, a negative AVERROR on failure. On failure, the
4567 * packet is unchanged.
4569 int av_packet_make_writable(AVPacket *pkt);
4572 * Convert valid timing fields (timestamps / durations) in a packet from one
4573 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4576 * @param pkt packet on which the conversion will be performed
4577 * @param tb_src source timebase, in which the timing fields in pkt are
4579 * @param tb_dst destination timebase, to which the timing fields will be
4582 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4589 * @addtogroup lavc_decoding
4594 * Find a registered decoder with a matching codec ID.
4596 * @param id AVCodecID of the requested decoder
4597 * @return A decoder if one was found, NULL otherwise.
4599 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4602 * Find a registered decoder with the specified name.
4604 * @param name name of the requested decoder
4605 * @return A decoder if one was found, NULL otherwise.
4607 AVCodec *avcodec_find_decoder_by_name(const char *name);
4610 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4611 * it can be called by custom get_buffer2() implementations for decoders without
4612 * AV_CODEC_CAP_DR1 set.
4614 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4617 * Modify width and height values so that they will result in a memory
4618 * buffer that is acceptable for the codec if you do not use any horizontal
4621 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4623 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4626 * Modify width and height values so that they will result in a memory
4627 * buffer that is acceptable for the codec if you also ensure that all
4628 * line sizes are a multiple of the respective linesize_align[i].
4630 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4632 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4633 int linesize_align[AV_NUM_DATA_POINTERS]);
4636 * Converts AVChromaLocation to swscale x/y chroma position.
4638 * The positions represent the chroma (0,0) position in a coordinates system
4639 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4641 * @param xpos horizontal chroma sample position
4642 * @param ypos vertical chroma sample position
4644 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4647 * Converts swscale x/y chroma position to AVChromaLocation.
4649 * The positions represent the chroma (0,0) position in a coordinates system
4650 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4652 * @param xpos horizontal chroma sample position
4653 * @param ypos vertical chroma sample position
4655 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4658 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4660 * Some decoders may support multiple frames in a single AVPacket. Such
4661 * decoders would then just decode the first frame and the return value would be
4662 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4663 * called again with an AVPacket containing the remaining data in order to
4664 * decode the second frame, etc... Even if no frames are returned, the packet
4665 * needs to be fed to the decoder with remaining data until it is completely
4666 * consumed or an error occurs.
4668 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4669 * and output. This means that for some packets they will not immediately
4670 * produce decoded output and need to be flushed at the end of decoding to get
4671 * all the decoded data. Flushing is done by calling this function with packets
4672 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4673 * returning samples. It is safe to flush even those decoders that are not
4674 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4676 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4677 * larger than the actual read bytes because some optimized bitstream
4678 * readers read 32 or 64 bits at once and could read over the end.
4680 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4681 * before packets may be fed to the decoder.
4683 * @param avctx the codec context
4684 * @param[out] frame The AVFrame in which to store decoded audio samples.
4685 * The decoder will allocate a buffer for the decoded frame by
4686 * calling the AVCodecContext.get_buffer2() callback.
4687 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4688 * reference counted and the returned reference belongs to the
4689 * caller. The caller must release the frame using av_frame_unref()
4690 * when the frame is no longer needed. The caller may safely write
4691 * to the frame if av_frame_is_writable() returns 1.
4692 * When AVCodecContext.refcounted_frames is set to 0, the returned
4693 * reference belongs to the decoder and is valid only until the
4694 * next call to this function or until closing or flushing the
4695 * decoder. The caller may not write to it.
4696 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4697 * non-zero. Note that this field being set to zero
4698 * does not mean that an error has occurred. For
4699 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4700 * call is guaranteed to produce a frame.
4701 * @param[in] avpkt The input AVPacket containing the input buffer.
4702 * At least avpkt->data and avpkt->size should be set. Some
4703 * decoders might also require additional fields to be set.
4704 * @return A negative error code is returned if an error occurred during
4705 * decoding, otherwise the number of bytes consumed from the input
4706 * AVPacket is returned.
4708 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4710 attribute_deprecated
4711 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4712 int *got_frame_ptr, const AVPacket *avpkt);
4715 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4716 * Some decoders may support multiple frames in a single AVPacket, such
4717 * decoders would then just decode the first frame.
4719 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4720 * the actual read bytes because some optimized bitstream readers read 32 or 64
4721 * bits at once and could read over the end.
4723 * @warning The end of the input buffer buf should be set to 0 to ensure that
4724 * no overreading happens for damaged MPEG streams.
4726 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4727 * between input and output, these need to be fed with avpkt->data=NULL,
4728 * avpkt->size=0 at the end to return the remaining frames.
4730 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4731 * before packets may be fed to the decoder.
4733 * @param avctx the codec context
4734 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4735 * Use av_frame_alloc() to get an AVFrame. The codec will
4736 * allocate memory for the actual bitmap by calling the
4737 * AVCodecContext.get_buffer2() callback.
4738 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4739 * reference counted and the returned reference belongs to the
4740 * caller. The caller must release the frame using av_frame_unref()
4741 * when the frame is no longer needed. The caller may safely write
4742 * to the frame if av_frame_is_writable() returns 1.
4743 * When AVCodecContext.refcounted_frames is set to 0, the returned
4744 * reference belongs to the decoder and is valid only until the
4745 * next call to this function or until closing or flushing the
4746 * decoder. The caller may not write to it.
4748 * @param[in] avpkt The input AVPacket containing the input buffer.
4749 * You can create such packet with av_init_packet() and by then setting
4750 * data and size, some decoders might in addition need other fields like
4751 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4753 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4754 * @return On error a negative value is returned, otherwise the number of bytes
4755 * used or zero if no frame could be decompressed.
4757 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4759 attribute_deprecated
4760 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4761 int *got_picture_ptr,
4762 const AVPacket *avpkt);
4765 * Decode a subtitle message.
4766 * Return a negative value on error, otherwise return the number of bytes used.
4767 * If no subtitle could be decompressed, got_sub_ptr is zero.
4768 * Otherwise, the subtitle is stored in *sub.
4769 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4770 * simplicity, because the performance difference is expect to be negligible
4771 * and reusing a get_buffer written for video codecs would probably perform badly
4772 * due to a potentially very different allocation pattern.
4774 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4775 * and output. This means that for some packets they will not immediately
4776 * produce decoded output and need to be flushed at the end of decoding to get
4777 * all the decoded data. Flushing is done by calling this function with packets
4778 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4779 * returning subtitles. It is safe to flush even those decoders that are not
4780 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4782 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4783 * before packets may be fed to the decoder.
4785 * @param avctx the codec context
4786 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4787 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4788 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4789 * @param[in] avpkt The input AVPacket containing the input buffer.
4791 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4796 * Supply raw packet data as input to a decoder.
4798 * Internally, this call will copy relevant AVCodecContext fields, which can
4799 * influence decoding per-packet, and apply them when the packet is actually
4800 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4801 * decoder to drop the frame contained by the packet sent with this function.)
4803 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4804 * larger than the actual read bytes because some optimized bitstream
4805 * readers read 32 or 64 bits at once and could read over the end.
4807 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4808 * on the same AVCodecContext. It will return unexpected results now
4809 * or in future libavcodec versions.
4811 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4812 * before packets may be fed to the decoder.
4814 * @param avctx codec context
4815 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4816 * frame, or several complete audio frames.
4817 * Ownership of the packet remains with the caller, and the
4818 * decoder will not write to the packet. The decoder may create
4819 * a reference to the packet data (or copy it if the packet is
4820 * not reference-counted).
4821 * Unlike with older APIs, the packet is always fully consumed,
4822 * and if it contains multiple frames (e.g. some audio codecs),
4823 * will require you to call avcodec_receive_frame() multiple
4824 * times afterwards before you can send a new packet.
4825 * It can be NULL (or an AVPacket with data set to NULL and
4826 * size set to 0); in this case, it is considered a flush
4827 * packet, which signals the end of the stream. Sending the
4828 * first flush packet will return success. Subsequent ones are
4829 * unnecessary and will return AVERROR_EOF. If the decoder
4830 * still has frames buffered, it will return them after sending
4833 * @return 0 on success, otherwise negative error code:
4834 * AVERROR(EAGAIN): input is not accepted in the current state - user
4835 * must read output with avcodec_receive_frame() (once
4836 * all output is read, the packet should be resent, and
4837 * the call will not fail with EAGAIN).
4838 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4839 * be sent to it (also returned if more than 1 flush
4841 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4842 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4843 * other errors: legitimate decoding errors
4845 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4848 * Return decoded output data from a decoder.
4850 * @param avctx codec context
4851 * @param frame This will be set to a reference-counted video or audio
4852 * frame (depending on the decoder type) allocated by the
4853 * decoder. Note that the function will always call
4854 * av_frame_unref(frame) before doing anything else.
4857 * 0: success, a frame was returned
4858 * AVERROR(EAGAIN): output is not available in this state - user must try
4860 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4861 * no more output frames
4862 * AVERROR(EINVAL): codec not opened, or it is an encoder
4863 * other negative values: legitimate decoding errors
4865 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4868 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4869 * to retrieve buffered output packets.
4871 * @param avctx codec context
4872 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4873 * Ownership of the frame remains with the caller, and the
4874 * encoder will not write to the frame. The encoder may create
4875 * a reference to the frame data (or copy it if the frame is
4876 * not reference-counted).
4877 * It can be NULL, in which case it is considered a flush
4878 * packet. This signals the end of the stream. If the encoder
4879 * still has packets buffered, it will return them after this
4880 * call. Once flushing mode has been entered, additional flush
4881 * packets are ignored, and sending frames will return
4885 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4886 * can have any number of samples.
4887 * If it is not set, frame->nb_samples must be equal to
4888 * avctx->frame_size for all frames except the last.
4889 * The final frame may be smaller than avctx->frame_size.
4890 * @return 0 on success, otherwise negative error code:
4891 * AVERROR(EAGAIN): input is not accepted in the current state - user
4892 * must read output with avcodec_receive_packet() (once
4893 * all output is read, the packet should be resent, and
4894 * the call will not fail with EAGAIN).
4895 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4897 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4898 * decoder, or requires flush
4899 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4900 * other errors: legitimate decoding errors
4902 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4905 * Read encoded data from the encoder.
4907 * @param avctx codec context
4908 * @param avpkt This will be set to a reference-counted packet allocated by the
4909 * encoder. Note that the function will always call
4910 * av_frame_unref(frame) before doing anything else.
4911 * @return 0 on success, otherwise negative error code:
4912 * AVERROR(EAGAIN): output is not available in the current state - user
4913 * must try to send input
4914 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4915 * no more output packets
4916 * AVERROR(EINVAL): codec not opened, or it is an encoder
4917 * other errors: legitimate decoding errors
4919 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4922 * Create and return a AVHWFramesContext with values adequate for hardware
4923 * decoding. This is meant to get called from the get_format callback, and is
4924 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
4925 * This API is for decoding with certain hardware acceleration modes/APIs only.
4927 * The returned AVHWFramesContext is not initialized. The caller must do this
4928 * with av_hwframe_ctx_init().
4930 * Calling this function is not a requirement, but makes it simpler to avoid
4931 * codec or hardware API specific details when manually allocating frames.
4933 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
4934 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
4935 * it unnecessary to call this function or having to care about
4936 * AVHWFramesContext initialization at all.
4938 * There are a number of requirements for calling this function:
4940 * - It must be called from get_format with the same avctx parameter that was
4941 * passed to get_format. Calling it outside of get_format is not allowed, and
4942 * can trigger undefined behavior.
4943 * - The function is not always supported (see description of return values).
4944 * Even if this function returns successfully, hwaccel initialization could
4945 * fail later. (The degree to which implementations check whether the stream
4946 * is actually supported varies. Some do this check only after the user's
4947 * get_format callback returns.)
4948 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
4949 * user decides to use a AVHWFramesContext prepared with this API function,
4950 * the user must return the same hw_pix_fmt from get_format.
4951 * - The device_ref passed to this function must support the given hw_pix_fmt.
4952 * - After calling this API function, it is the user's responsibility to
4953 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
4954 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
4955 * before returning from get_format (this is implied by the normal
4956 * AVCodecContext.hw_frames_ctx API rules).
4957 * - The AVHWFramesContext parameters may change every time time get_format is
4958 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
4959 * you are inherently required to go through this process again on every
4961 * - It is perfectly possible to call this function without actually using
4962 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
4963 * previously initialized AVHWFramesContext, and calling this API function
4964 * only to test whether the required frame parameters have changed.
4965 * - Fields that use dynamically allocated values of any kind must not be set
4966 * by the user unless setting them is explicitly allowed by the documentation.
4967 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
4968 * the new free callback must call the potentially set previous free callback.
4969 * This API call may set any dynamically allocated fields, including the free
4972 * The function will set at least the following fields on AVHWFramesContext
4973 * (potentially more, depending on hwaccel API):
4975 * - All fields set by av_hwframe_ctx_alloc().
4976 * - Set the format field to hw_pix_fmt.
4977 * - Set the sw_format field to the most suited and most versatile format. (An
4978 * implication is that this will prefer generic formats over opaque formats
4979 * with arbitrary restrictions, if possible.)
4980 * - Set the width/height fields to the coded frame size, rounded up to the
4981 * API-specific minimum alignment.
4982 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
4983 * field to the number of maximum reference surfaces possible with the codec,
4984 * plus 1 surface for the user to work (meaning the user can safely reference
4985 * at most 1 decoded surface at a time), plus additional buffering introduced
4986 * by frame threading. If the hwaccel does not require pre-allocation, the
4987 * field is left to 0, and the decoder will allocate new surfaces on demand
4989 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
4992 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
4993 * with basic frame parameters set.
4995 * The function is stateless, and does not change the AVCodecContext or the
4996 * device_ref AVHWDeviceContext.
4998 * @param avctx The context which is currently calling get_format, and which
4999 * implicitly contains all state needed for filling the returned
5000 * AVHWFramesContext properly.
5001 * @param device_ref A reference to the AVHWDeviceContext describing the device
5002 * which will be used by the hardware decoder.
5003 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
5004 * @param out_frames_ref On success, set to a reference to an _uninitialized_
5005 * AVHWFramesContext, created from the given device_ref.
5006 * Fields will be set to values required for decoding.
5007 * Not changed if an error is returned.
5008 * @return zero on success, a negative value on error. The following error codes
5009 * have special semantics:
5010 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
5011 * is always manual, or it is a decoder which does not
5012 * support setting AVCodecContext.hw_frames_ctx at all,
5013 * or it is a software format.
5014 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
5015 * this configuration, or the device_ref is not supported
5016 * for the hwaccel referenced by hw_pix_fmt.
5018 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
5019 AVBufferRef *device_ref,
5020 enum AVPixelFormat hw_pix_fmt,
5021 AVBufferRef **out_frames_ref);
5026 * @defgroup lavc_parsing Frame parsing
5030 enum AVPictureStructure {
5031 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5032 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5033 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5034 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5037 typedef struct AVCodecParserContext {
5039 struct AVCodecParser *parser;
5040 int64_t frame_offset; /* offset of the current frame */
5041 int64_t cur_offset; /* current offset
5042 (incremented by each av_parser_parse()) */
5043 int64_t next_frame_offset; /* offset of the next frame */
5045 int pict_type; /* XXX: Put it back in AVCodecContext. */
5047 * This field is used for proper frame duration computation in lavf.
5048 * It signals, how much longer the frame duration of the current frame
5049 * is compared to normal frame duration.
5051 * frame_duration = (1 + repeat_pict) * time_base
5053 * It is used by codecs like H.264 to display telecined material.
5055 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5056 int64_t pts; /* pts of the current frame */
5057 int64_t dts; /* dts of the current frame */
5062 int fetch_timestamp;
5064 #define AV_PARSER_PTS_NB 4
5065 int cur_frame_start_index;
5066 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5067 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5068 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5071 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5072 #define PARSER_FLAG_ONCE 0x0002
5073 /// Set if the parser has a valid file offset
5074 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5075 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5077 int64_t offset; ///< byte offset from starting packet start
5078 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5081 * Set by parser to 1 for key frames and 0 for non-key frames.
5082 * It is initialized to -1, so if the parser doesn't set this flag,
5083 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5088 #if FF_API_CONVERGENCE_DURATION
5090 * @deprecated unused
5092 attribute_deprecated
5093 int64_t convergence_duration;
5096 // Timestamp generation support:
5098 * Synchronization point for start of timestamp generation.
5100 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5103 * For example, this corresponds to presence of H.264 buffering period
5109 * Offset of the current timestamp against last timestamp sync point in
5110 * units of AVCodecContext.time_base.
5112 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5113 * contain a valid timestamp offset.
5115 * Note that the timestamp of sync point has usually a nonzero
5116 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5117 * the next frame after timestamp sync point will be usually 1.
5119 * For example, this corresponds to H.264 cpb_removal_delay.
5121 int dts_ref_dts_delta;
5124 * Presentation delay of current frame in units of AVCodecContext.time_base.
5126 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5127 * contain valid non-negative timestamp delta (presentation time of a frame
5128 * must not lie in the past).
5130 * This delay represents the difference between decoding and presentation
5131 * time of the frame.
5133 * For example, this corresponds to H.264 dpb_output_delay.
5138 * Position of the packet in file.
5140 * Analogous to cur_frame_pts/dts
5142 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5145 * Byte position of currently parsed frame in stream.
5150 * Previous frame byte position.
5155 * Duration of the current frame.
5156 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5157 * For all other types, this is in units of AVCodecContext.time_base.
5161 enum AVFieldOrder field_order;
5164 * Indicate whether a picture is coded as a frame, top field or bottom field.
5166 * For example, H.264 field_pic_flag equal to 0 corresponds to
5167 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5168 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5169 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5171 enum AVPictureStructure picture_structure;
5174 * Picture number incremented in presentation or output order.
5175 * This field may be reinitialized at the first picture of a new sequence.
5177 * For example, this corresponds to H.264 PicOrderCnt.
5179 int output_picture_number;
5182 * Dimensions of the decoded video intended for presentation.
5188 * Dimensions of the coded video.
5194 * The format of the coded data, corresponds to enum AVPixelFormat for video
5195 * and for enum AVSampleFormat for audio.
5197 * Note that a decoder can have considerable freedom in how exactly it
5198 * decodes the data, so the format reported here might be different from the
5199 * one returned by a decoder.
5202 } AVCodecParserContext;
5204 typedef struct AVCodecParser {
5205 int codec_ids[5]; /* several codec IDs are permitted */
5207 int (*parser_init)(AVCodecParserContext *s);
5208 /* This callback never returns an error, a negative value means that
5209 * the frame start was in a previous packet. */
5210 int (*parser_parse)(AVCodecParserContext *s,
5211 AVCodecContext *avctx,
5212 const uint8_t **poutbuf, int *poutbuf_size,
5213 const uint8_t *buf, int buf_size);
5214 void (*parser_close)(AVCodecParserContext *s);
5215 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5216 struct AVCodecParser *next;
5220 * Iterate over all registered codec parsers.
5222 * @param opaque a pointer where libavcodec will store the iteration state. Must
5223 * point to NULL to start the iteration.
5225 * @return the next registered codec parser or NULL when the iteration is
5228 const AVCodecParser *av_parser_iterate(void **opaque);
5230 attribute_deprecated
5231 AVCodecParser *av_parser_next(const AVCodecParser *c);
5233 attribute_deprecated
5234 void av_register_codec_parser(AVCodecParser *parser);
5235 AVCodecParserContext *av_parser_init(int codec_id);
5240 * @param s parser context.
5241 * @param avctx codec context.
5242 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5243 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5244 * @param buf input buffer.
5245 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5246 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5247 To signal EOF, this should be 0 (so that the last frame
5249 * @param pts input presentation timestamp.
5250 * @param dts input decoding timestamp.
5251 * @param pos input byte position in stream.
5252 * @return the number of bytes of the input bitstream used.
5257 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5264 * decode_frame(data, size);
5268 int av_parser_parse2(AVCodecParserContext *s,
5269 AVCodecContext *avctx,
5270 uint8_t **poutbuf, int *poutbuf_size,
5271 const uint8_t *buf, int buf_size,
5272 int64_t pts, int64_t dts,
5276 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5277 * @deprecated use AVBitStreamFilter
5279 int av_parser_change(AVCodecParserContext *s,
5280 AVCodecContext *avctx,
5281 uint8_t **poutbuf, int *poutbuf_size,
5282 const uint8_t *buf, int buf_size, int keyframe);
5283 void av_parser_close(AVCodecParserContext *s);
5291 * @addtogroup lavc_encoding
5296 * Find a registered encoder with a matching codec ID.
5298 * @param id AVCodecID of the requested encoder
5299 * @return An encoder if one was found, NULL otherwise.
5301 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5304 * Find a registered encoder with the specified name.
5306 * @param name name of the requested encoder
5307 * @return An encoder if one was found, NULL otherwise.
5309 AVCodec *avcodec_find_encoder_by_name(const char *name);
5312 * Encode a frame of audio.
5314 * Takes input samples from frame and writes the next output packet, if
5315 * available, to avpkt. The output packet does not necessarily contain data for
5316 * the most recent frame, as encoders can delay, split, and combine input frames
5317 * internally as needed.
5319 * @param avctx codec context
5320 * @param avpkt output AVPacket.
5321 * The user can supply an output buffer by setting
5322 * avpkt->data and avpkt->size prior to calling the
5323 * function, but if the size of the user-provided data is not
5324 * large enough, encoding will fail. If avpkt->data and
5325 * avpkt->size are set, avpkt->destruct must also be set. All
5326 * other AVPacket fields will be reset by the encoder using
5327 * av_init_packet(). If avpkt->data is NULL, the encoder will
5328 * allocate it. The encoder will set avpkt->size to the size
5329 * of the output packet.
5331 * If this function fails or produces no output, avpkt will be
5332 * freed using av_packet_unref().
5333 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5334 * May be NULL when flushing an encoder that has the
5335 * AV_CODEC_CAP_DELAY capability set.
5336 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5337 * can have any number of samples.
5338 * If it is not set, frame->nb_samples must be equal to
5339 * avctx->frame_size for all frames except the last.
5340 * The final frame may be smaller than avctx->frame_size.
5341 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5342 * output packet is non-empty, and to 0 if it is
5343 * empty. If the function returns an error, the
5344 * packet can be assumed to be invalid, and the
5345 * value of got_packet_ptr is undefined and should
5347 * @return 0 on success, negative error code on failure
5349 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5351 attribute_deprecated
5352 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5353 const AVFrame *frame, int *got_packet_ptr);
5356 * Encode a frame of video.
5358 * Takes input raw video data from frame and writes the next output packet, if
5359 * available, to avpkt. The output packet does not necessarily contain data for
5360 * the most recent frame, as encoders can delay and reorder input frames
5361 * internally as needed.
5363 * @param avctx codec context
5364 * @param avpkt output AVPacket.
5365 * The user can supply an output buffer by setting
5366 * avpkt->data and avpkt->size prior to calling the
5367 * function, but if the size of the user-provided data is not
5368 * large enough, encoding will fail. All other AVPacket fields
5369 * will be reset by the encoder using av_init_packet(). If
5370 * avpkt->data is NULL, the encoder will allocate it.
5371 * The encoder will set avpkt->size to the size of the
5372 * output packet. The returned data (if any) belongs to the
5373 * caller, he is responsible for freeing it.
5375 * If this function fails or produces no output, avpkt will be
5376 * freed using av_packet_unref().
5377 * @param[in] frame AVFrame containing the raw video data to be encoded.
5378 * May be NULL when flushing an encoder that has the
5379 * AV_CODEC_CAP_DELAY capability set.
5380 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5381 * output packet is non-empty, and to 0 if it is
5382 * empty. If the function returns an error, the
5383 * packet can be assumed to be invalid, and the
5384 * value of got_packet_ptr is undefined and should
5386 * @return 0 on success, negative error code on failure
5388 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5390 attribute_deprecated
5391 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5392 const AVFrame *frame, int *got_packet_ptr);
5394 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5395 const AVSubtitle *sub);
5402 #if FF_API_AVPICTURE
5404 * @addtogroup lavc_picture
5409 * @deprecated unused
5411 attribute_deprecated
5412 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5415 * @deprecated unused
5417 attribute_deprecated
5418 void avpicture_free(AVPicture *picture);
5421 * @deprecated use av_image_fill_arrays() instead.
5423 attribute_deprecated
5424 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5425 enum AVPixelFormat pix_fmt, int width, int height);
5428 * @deprecated use av_image_copy_to_buffer() instead.
5430 attribute_deprecated
5431 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5432 int width, int height,
5433 unsigned char *dest, int dest_size);
5436 * @deprecated use av_image_get_buffer_size() instead.
5438 attribute_deprecated
5439 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5442 * @deprecated av_image_copy() instead.
5444 attribute_deprecated
5445 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5446 enum AVPixelFormat pix_fmt, int width, int height);
5449 * @deprecated unused
5451 attribute_deprecated
5452 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5453 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5456 * @deprecated unused
5458 attribute_deprecated
5459 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5460 int padtop, int padbottom, int padleft, int padright, int *color);
5468 * @defgroup lavc_misc Utility functions
5471 * Miscellaneous utility functions related to both encoding and decoding
5477 * @defgroup lavc_misc_pixfmt Pixel formats
5479 * Functions for working with pixel formats.
5483 #if FF_API_GETCHROMA
5485 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5488 attribute_deprecated
5489 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5493 * Return a value representing the fourCC code associated to the
5494 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5497 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5500 * @deprecated see av_get_pix_fmt_loss()
5502 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5506 * Find the best pixel format to convert to given a certain source pixel
5507 * format. When converting from one pixel format to another, information loss
5508 * may occur. For example, when converting from RGB24 to GRAY, the color
5509 * information will be lost. Similarly, other losses occur when converting from
5510 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5511 * the given pixel formats should be used to suffer the least amount of loss.
5512 * The pixel formats from which it chooses one, are determined by the
5513 * pix_fmt_list parameter.
5516 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5517 * @param[in] src_pix_fmt source pixel format
5518 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5519 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5520 * @return The best pixel format to convert to or -1 if none was found.
5522 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5523 enum AVPixelFormat src_pix_fmt,
5524 int has_alpha, int *loss_ptr);
5527 * @deprecated see av_find_best_pix_fmt_of_2()
5529 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5530 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5532 attribute_deprecated
5533 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5534 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5536 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5542 #if FF_API_TAG_STRING
5544 * Put a string representing the codec tag codec_tag in buf.
5546 * @param buf buffer to place codec tag in
5547 * @param buf_size size in bytes of buf
5548 * @param codec_tag codec tag to assign
5549 * @return the length of the string that would have been generated if
5550 * enough space had been available, excluding the trailing null
5552 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5554 attribute_deprecated
5555 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5558 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5561 * Return a name for the specified profile, if available.
5563 * @param codec the codec that is searched for the given profile
5564 * @param profile the profile value for which a name is requested
5565 * @return A name for the profile if found, NULL otherwise.
5567 const char *av_get_profile_name(const AVCodec *codec, int profile);
5570 * Return a name for the specified profile, if available.
5572 * @param codec_id the ID of the codec to which the requested profile belongs
5573 * @param profile the profile value for which a name is requested
5574 * @return A name for the profile if found, NULL otherwise.
5576 * @note unlike av_get_profile_name(), which searches a list of profiles
5577 * supported by a specific decoder or encoder implementation, this
5578 * function searches the list of profiles from the AVCodecDescriptor
5580 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5582 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5583 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5584 //FIXME func typedef
5587 * Fill AVFrame audio data and linesize pointers.
5589 * The buffer buf must be a preallocated buffer with a size big enough
5590 * to contain the specified samples amount. The filled AVFrame data
5591 * pointers will point to this buffer.
5593 * AVFrame extended_data channel pointers are allocated if necessary for
5596 * @param frame the AVFrame
5597 * frame->nb_samples must be set prior to calling the
5598 * function. This function fills in frame->data,
5599 * frame->extended_data, frame->linesize[0].
5600 * @param nb_channels channel count
5601 * @param sample_fmt sample format
5602 * @param buf buffer to use for frame data
5603 * @param buf_size size of buffer
5604 * @param align plane size sample alignment (0 = default)
5605 * @return >=0 on success, negative error code on failure
5606 * @todo return the size in bytes required to store the samples in
5607 * case of success, at the next libavutil bump
5609 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5610 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5611 int buf_size, int align);
5614 * Reset the internal decoder state / flush internal buffers. Should be called
5615 * e.g. when seeking or when switching to a different stream.
5617 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5618 * this invalidates the frames previously returned from the decoder. When
5619 * refcounted frames are used, the decoder just releases any references it might
5620 * keep internally, but the caller's reference remains valid.
5622 void avcodec_flush_buffers(AVCodecContext *avctx);
5625 * Return codec bits per sample.
5627 * @param[in] codec_id the codec
5628 * @return Number of bits per sample or zero if unknown for the given codec.
5630 int av_get_bits_per_sample(enum AVCodecID codec_id);
5633 * Return the PCM codec associated with a sample format.
5634 * @param be endianness, 0 for little, 1 for big,
5635 * -1 (or anything else) for native
5636 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5638 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5641 * Return codec bits per sample.
5642 * Only return non-zero if the bits per sample is exactly correct, not an
5645 * @param[in] codec_id the codec
5646 * @return Number of bits per sample or zero if unknown for the given codec.
5648 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5651 * Return audio frame duration.
5653 * @param avctx codec context
5654 * @param frame_bytes size of the frame, or 0 if unknown
5655 * @return frame duration, in samples, if known. 0 if not able to
5658 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5661 * This function is the same as av_get_audio_frame_duration(), except it works
5662 * with AVCodecParameters instead of an AVCodecContext.
5664 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5667 typedef struct AVBitStreamFilterContext {
5669 const struct AVBitStreamFilter *filter;
5670 AVCodecParserContext *parser;
5671 struct AVBitStreamFilterContext *next;
5673 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5674 * Not for access by library users.
5677 } AVBitStreamFilterContext;
5680 typedef struct AVBSFInternal AVBSFInternal;
5683 * The bitstream filter state.
5685 * This struct must be allocated with av_bsf_alloc() and freed with
5688 * The fields in the struct will only be changed (by the caller or by the
5689 * filter) as described in their documentation, and are to be considered
5690 * immutable otherwise.
5692 typedef struct AVBSFContext {
5694 * A class for logging and AVOptions
5696 const AVClass *av_class;
5699 * The bitstream filter this context is an instance of.
5701 const struct AVBitStreamFilter *filter;
5704 * Opaque libavcodec internal data. Must not be touched by the caller in any
5707 AVBSFInternal *internal;
5710 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5711 * this is an AVOptions-enabled struct.
5716 * Parameters of the input stream. This field is allocated in
5717 * av_bsf_alloc(), it needs to be filled by the caller before
5720 AVCodecParameters *par_in;
5723 * Parameters of the output stream. This field is allocated in
5724 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5726 AVCodecParameters *par_out;
5729 * The timebase used for the timestamps of the input packets. Set by the
5730 * caller before av_bsf_init().
5732 AVRational time_base_in;
5735 * The timebase used for the timestamps of the output packets. Set by the
5736 * filter in av_bsf_init().
5738 AVRational time_base_out;
5741 typedef struct AVBitStreamFilter {
5745 * A list of codec ids supported by the filter, terminated by
5747 * May be NULL, in that case the bitstream filter works with any codec id.
5749 const enum AVCodecID *codec_ids;
5752 * A class for the private data, used to declare bitstream filter private
5753 * AVOptions. This field is NULL for bitstream filters that do not declare
5756 * If this field is non-NULL, the first member of the filter private data
5757 * must be a pointer to AVClass, which will be set by libavcodec generic
5758 * code to this class.
5760 const AVClass *priv_class;
5762 /*****************************************************************
5763 * No fields below this line are part of the public API. They
5764 * may not be used outside of libavcodec and can be changed and
5766 * New public fields should be added right above.
5767 *****************************************************************
5771 int (*init)(AVBSFContext *ctx);
5772 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5773 void (*close)(AVBSFContext *ctx);
5774 void (*flush)(AVBSFContext *ctx);
5775 } AVBitStreamFilter;
5779 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5780 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5782 attribute_deprecated
5783 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5785 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5786 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
5787 * from the new bitstream filtering API (using AVBSFContext).
5789 attribute_deprecated
5790 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5792 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5793 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
5794 * new bitstream filtering API (using AVBSFContext).
5796 attribute_deprecated
5797 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5798 AVCodecContext *avctx, const char *args,
5799 uint8_t **poutbuf, int *poutbuf_size,
5800 const uint8_t *buf, int buf_size, int keyframe);
5802 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5803 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
5806 attribute_deprecated
5807 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5809 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5810 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
5813 attribute_deprecated
5814 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5818 * @return a bitstream filter with the specified name or NULL if no such
5819 * bitstream filter exists.
5821 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5824 * Iterate over all registered bitstream filters.
5826 * @param opaque a pointer where libavcodec will store the iteration state. Must
5827 * point to NULL to start the iteration.
5829 * @return the next registered bitstream filter or NULL when the iteration is
5832 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
5834 attribute_deprecated
5835 const AVBitStreamFilter *av_bsf_next(void **opaque);
5839 * Allocate a context for a given bitstream filter. The caller must fill in the
5840 * context parameters as described in the documentation and then call
5841 * av_bsf_init() before sending any data to the filter.
5843 * @param filter the filter for which to allocate an instance.
5844 * @param ctx a pointer into which the pointer to the newly-allocated context
5845 * will be written. It must be freed with av_bsf_free() after the
5846 * filtering is done.
5848 * @return 0 on success, a negative AVERROR code on failure
5850 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5853 * Prepare the filter for use, after all the parameters and options have been
5856 int av_bsf_init(AVBSFContext *ctx);
5859 * Submit a packet for filtering.
5861 * After sending each packet, the filter must be completely drained by calling
5862 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5865 * @param pkt the packet to filter. The bitstream filter will take ownership of
5866 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5867 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5868 * packets will be sent). That will cause the filter to output any packets it
5869 * may have buffered internally.
5871 * @return 0 on success, a negative AVERROR on error.
5873 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5876 * Retrieve a filtered packet.
5878 * @param[out] pkt this struct will be filled with the contents of the filtered
5879 * packet. It is owned by the caller and must be freed using
5880 * av_packet_unref() when it is no longer needed.
5881 * This parameter should be "clean" (i.e. freshly allocated
5882 * with av_packet_alloc() or unreffed with av_packet_unref())
5883 * when this function is called. If this function returns
5884 * successfully, the contents of pkt will be completely
5885 * overwritten by the returned data. On failure, pkt is not
5888 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5889 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5890 * will be no further output from the filter. Another negative AVERROR value if
5893 * @note one input packet may result in several output packets, so after sending
5894 * a packet with av_bsf_send_packet(), this function needs to be called
5895 * repeatedly until it stops returning 0. It is also possible for a filter to
5896 * output fewer packets than were sent to it, so this function may return
5897 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5899 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5902 * Reset the internal bitstream filter state / flush internal buffers.
5904 void av_bsf_flush(AVBSFContext *ctx);
5907 * Free a bitstream filter context and everything associated with it; write NULL
5908 * into the supplied pointer.
5910 void av_bsf_free(AVBSFContext **ctx);
5913 * Get the AVClass for AVBSFContext. It can be used in combination with
5914 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5916 * @see av_opt_find().
5918 const AVClass *av_bsf_get_class(void);
5921 * Structure for chain/list of bitstream filters.
5922 * Empty list can be allocated by av_bsf_list_alloc().
5924 typedef struct AVBSFList AVBSFList;
5927 * Allocate empty list of bitstream filters.
5928 * The list must be later freed by av_bsf_list_free()
5929 * or finalized by av_bsf_list_finalize().
5931 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
5933 AVBSFList *av_bsf_list_alloc(void);
5936 * Free list of bitstream filters.
5938 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
5940 void av_bsf_list_free(AVBSFList **lst);
5943 * Append bitstream filter to the list of bitstream filters.
5945 * @param lst List to append to
5946 * @param bsf Filter context to be appended
5948 * @return >=0 on success, negative AVERROR in case of failure
5950 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
5953 * Construct new bitstream filter context given it's name and options
5954 * and append it to the list of bitstream filters.
5956 * @param lst List to append to
5957 * @param bsf_name Name of the bitstream filter
5958 * @param options Options for the bitstream filter, can be set to NULL
5960 * @return >=0 on success, negative AVERROR in case of failure
5962 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
5964 * Finalize list of bitstream filters.
5966 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
5967 * so the whole chain of bitstream filters can be treated as single filter
5968 * freshly allocated by av_bsf_alloc().
5969 * If the call is successful, @ref AVBSFList structure is freed and lst
5970 * will be set to NULL. In case of failure, caller is responsible for
5971 * freeing the structure by av_bsf_list_free()
5973 * @param lst Filter list structure to be transformed
5974 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
5975 * representing the chain of bitstream filters
5977 * @return >=0 on success, negative AVERROR in case of failure
5979 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
5982 * Parse string describing list of bitstream filters and create single
5983 * @ref AVBSFContext describing the whole chain of bitstream filters.
5984 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
5985 * allocated by av_bsf_alloc().
5987 * @param str String describing chain of bitstream filters in format
5988 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
5989 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
5990 * representing the chain of bitstream filters
5992 * @return >=0 on success, negative AVERROR in case of failure
5994 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
5997 * Get null/pass-through bitstream filter.
5999 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6003 int av_bsf_get_null_filter(AVBSFContext **bsf);
6008 * Same behaviour av_fast_malloc but the buffer has additional
6009 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6011 * In addition the whole buffer will initially and after resizes
6012 * be 0-initialized so that no uninitialized data will ever appear.
6014 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6017 * Same behaviour av_fast_padded_malloc except that buffer will always
6018 * be 0-initialized after call.
6020 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6023 * Encode extradata length to a buffer. Used by xiph codecs.
6025 * @param s buffer to write to; must be at least (v/255+1) bytes long
6026 * @param v size of extradata in bytes
6027 * @return number of bytes written to the buffer.
6029 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6031 #if FF_API_USER_VISIBLE_AVHWACCEL
6033 * Register the hardware accelerator hwaccel.
6035 * @deprecated This function doesn't do anything.
6037 attribute_deprecated
6038 void av_register_hwaccel(AVHWAccel *hwaccel);
6041 * If hwaccel is NULL, returns the first registered hardware accelerator,
6042 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6043 * after hwaccel, or NULL if hwaccel is the last one.
6045 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
6046 * this function should not be used.
6048 attribute_deprecated
6049 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6054 * Lock operation used by lockmgr
6056 * @deprecated Deprecated together with av_lockmgr_register().
6059 AV_LOCK_CREATE, ///< Create a mutex
6060 AV_LOCK_OBTAIN, ///< Lock the mutex
6061 AV_LOCK_RELEASE, ///< Unlock the mutex
6062 AV_LOCK_DESTROY, ///< Free mutex resources
6066 * Register a user provided lock manager supporting the operations
6067 * specified by AVLockOp. The "mutex" argument to the function points
6068 * to a (void *) where the lockmgr should store/get a pointer to a user
6069 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6070 * value left by the last call for all other ops. If the lock manager is
6071 * unable to perform the op then it should leave the mutex in the same
6072 * state as when it was called and return a non-zero value. However,
6073 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6074 * have been successfully destroyed. If av_lockmgr_register succeeds
6075 * it will return a non-negative value, if it fails it will return a
6076 * negative value and destroy all mutex and unregister all callbacks.
6077 * av_lockmgr_register is not thread-safe, it must be called from a
6078 * single thread before any calls which make use of locking are used.
6080 * @param cb User defined callback. av_lockmgr_register invokes calls
6081 * to this callback and the previously registered callback.
6082 * The callback will be used to create more than one mutex
6083 * each of which must be backed by its own underlying locking
6084 * mechanism (i.e. do not use a single static object to
6085 * implement your lock manager). If cb is set to NULL the
6086 * lockmgr will be unregistered.
6088 * @deprecated This function does nothing, and always returns 0. Be sure to
6089 * build with thread support to get basic thread safety.
6091 attribute_deprecated
6092 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6096 * Get the type of the given codec.
6098 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6101 * Get the name of a codec.
6102 * @return a static string identifying the codec; never NULL
6104 const char *avcodec_get_name(enum AVCodecID id);
6107 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6108 * with no corresponding avcodec_close()), 0 otherwise.
6110 int avcodec_is_open(AVCodecContext *s);
6113 * @return a non-zero number if codec is an encoder, zero otherwise
6115 int av_codec_is_encoder(const AVCodec *codec);
6118 * @return a non-zero number if codec is a decoder, zero otherwise
6120 int av_codec_is_decoder(const AVCodec *codec);
6123 * @return descriptor for given codec ID or NULL if no descriptor exists.
6125 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6128 * Iterate over all codec descriptors known to libavcodec.
6130 * @param prev previous descriptor. NULL to get the first descriptor.
6132 * @return next descriptor or NULL after the last descriptor
6134 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6137 * @return codec descriptor with the given name or NULL if no such descriptor
6140 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6143 * Allocate a CPB properties structure and initialize its fields to default
6146 * @param size if non-NULL, the size of the allocated struct will be written
6147 * here. This is useful for embedding it in side data.
6149 * @return the newly allocated struct or NULL on failure
6151 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6157 #endif /* AVCODEC_AVCODEC_H */