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 * Must be allocated with the av_malloc() family of functions.
1621 * - encoding: Set/allocated/freed by libavcodec.
1622 * - decoding: Set/allocated/freed by user.
1628 * This is the fundamental unit of time (in seconds) in terms
1629 * of which frame timestamps are represented. For fixed-fps content,
1630 * timebase should be 1/framerate and timestamp increments should be
1632 * This often, but not always is the inverse of the frame rate or field rate
1633 * for video. 1/time_base is not the average frame rate if the frame rate is not
1636 * Like containers, elementary streams also can store timestamps, 1/time_base
1637 * is the unit in which these timestamps are specified.
1638 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1639 * vop_time_increment_resolution and fixed_vop_rate
1640 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1642 * - encoding: MUST be set by user.
1643 * - decoding: the use of this field for decoding is deprecated.
1644 * Use framerate instead.
1646 AVRational time_base;
1649 * For some codecs, the time base is closer to the field rate than the frame rate.
1650 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1651 * if no telecine is used ...
1653 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1655 int ticks_per_frame;
1660 * Encoding: Number of frames delay there will be from the encoder input to
1661 * the decoder output. (we assume the decoder matches the spec)
1662 * Decoding: Number of frames delay in addition to what a standard decoder
1663 * as specified in the spec would produce.
1666 * Number of frames the decoded output will be delayed relative to the
1670 * For encoding, this field is unused (see initial_padding).
1672 * For decoding, this is the number of samples the decoder needs to
1673 * output before the decoder's output is valid. When seeking, you should
1674 * start decoding this many samples prior to your desired seek point.
1676 * - encoding: Set by libavcodec.
1677 * - decoding: Set by libavcodec.
1684 * picture width / height.
1686 * @note Those fields may not match the values of the last
1687 * AVFrame output by avcodec_decode_video2 due frame
1690 * - encoding: MUST be set by user.
1691 * - decoding: May be set by the user before opening the decoder if known e.g.
1692 * from the container. Some decoders will require the dimensions
1693 * to be set by the caller. During decoding, the decoder may
1694 * overwrite those values as required while parsing the data.
1699 * Bitstream width / height, may be different from width/height e.g. when
1700 * the decoded frame is cropped before being output or lowres is enabled.
1702 * @note Those field may not match the value of the last
1703 * AVFrame output by avcodec_receive_frame() due frame
1706 * - encoding: unused
1707 * - decoding: May be set by the user before opening the decoder if known
1708 * e.g. from the container. During decoding, the decoder may
1709 * overwrite those values as required while parsing the data.
1711 int coded_width, coded_height;
1714 * the number of pictures in a group of pictures, or 0 for intra_only
1715 * - encoding: Set by user.
1716 * - decoding: unused
1721 * Pixel format, see AV_PIX_FMT_xxx.
1722 * May be set by the demuxer if known from headers.
1723 * May be overridden by the decoder if it knows better.
1725 * @note This field may not match the value of the last
1726 * AVFrame output by avcodec_receive_frame() due frame
1729 * - encoding: Set by user.
1730 * - decoding: Set by user if known, overridden by libavcodec while
1733 enum AVPixelFormat pix_fmt;
1736 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1737 * decoder to draw a horizontal band. It improves cache usage. Not
1738 * all codecs can do that. You must check the codec capabilities
1740 * When multithreading is used, it may be called from multiple threads
1741 * at the same time; threads might draw different parts of the same AVFrame,
1742 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1744 * The function is also used by hardware acceleration APIs.
1745 * It is called at least once during frame decoding to pass
1746 * the data needed for hardware render.
1747 * In that mode instead of pixel data, AVFrame points to
1748 * a structure specific to the acceleration API. The application
1749 * reads the structure and can change some fields to indicate progress
1751 * - encoding: unused
1752 * - decoding: Set by user.
1753 * @param height the height of the slice
1754 * @param y the y position of the slice
1755 * @param type 1->top field, 2->bottom field, 3->frame
1756 * @param offset offset into the AVFrame.data from which the slice should be read
1758 void (*draw_horiz_band)(struct AVCodecContext *s,
1759 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1760 int y, int type, int height);
1763 * callback to negotiate the pixelFormat
1764 * @param fmt is the list of formats which are supported by the codec,
1765 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1766 * The first is always the native one.
1767 * @note The callback may be called again immediately if initialization for
1768 * the selected (hardware-accelerated) pixel format failed.
1769 * @warning Behavior is undefined if the callback returns a value not
1770 * in the fmt list of formats.
1771 * @return the chosen format
1772 * - encoding: unused
1773 * - decoding: Set by user, if not set the native format will be chosen.
1775 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1778 * maximum number of B-frames between non-B-frames
1779 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1780 * - encoding: Set by user.
1781 * - decoding: unused
1786 * qscale factor between IP and B-frames
1787 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1788 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1789 * - encoding: Set by user.
1790 * - decoding: unused
1792 float b_quant_factor;
1794 #if FF_API_PRIVATE_OPT
1795 /** @deprecated use encoder private options instead */
1796 attribute_deprecated
1797 int b_frame_strategy;
1801 * qscale offset between IP and B-frames
1802 * - encoding: Set by user.
1803 * - decoding: unused
1805 float b_quant_offset;
1808 * Size of the frame reordering buffer in the decoder.
1809 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1810 * - encoding: Set by libavcodec.
1811 * - decoding: Set by libavcodec.
1815 #if FF_API_PRIVATE_OPT
1816 /** @deprecated use encoder private options instead */
1817 attribute_deprecated
1822 * qscale factor between P- and I-frames
1823 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1824 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1825 * - encoding: Set by user.
1826 * - decoding: unused
1828 float i_quant_factor;
1831 * qscale offset between P and I-frames
1832 * - encoding: Set by user.
1833 * - decoding: unused
1835 float i_quant_offset;
1838 * luminance masking (0-> disabled)
1839 * - encoding: Set by user.
1840 * - decoding: unused
1845 * temporary complexity masking (0-> disabled)
1846 * - encoding: Set by user.
1847 * - decoding: unused
1849 float temporal_cplx_masking;
1852 * spatial complexity masking (0-> disabled)
1853 * - encoding: Set by user.
1854 * - decoding: unused
1856 float spatial_cplx_masking;
1859 * p block masking (0-> disabled)
1860 * - encoding: Set by user.
1861 * - decoding: unused
1866 * darkness masking (0-> disabled)
1867 * - encoding: Set by user.
1868 * - decoding: unused
1874 * - encoding: Set by libavcodec.
1875 * - decoding: Set by user (or 0).
1879 #if FF_API_PRIVATE_OPT
1880 /** @deprecated use encoder private options instead */
1881 attribute_deprecated
1882 int prediction_method;
1883 #define FF_PRED_LEFT 0
1884 #define FF_PRED_PLANE 1
1885 #define FF_PRED_MEDIAN 2
1889 * slice offsets in the frame in bytes
1890 * - encoding: Set/allocated by libavcodec.
1891 * - decoding: Set/allocated by user (or NULL).
1896 * sample aspect ratio (0 if unknown)
1897 * That is the width of a pixel divided by the height of the pixel.
1898 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1899 * - encoding: Set by user.
1900 * - decoding: Set by libavcodec.
1902 AVRational sample_aspect_ratio;
1905 * motion estimation comparison function
1906 * - encoding: Set by user.
1907 * - decoding: unused
1911 * subpixel motion estimation comparison function
1912 * - encoding: Set by user.
1913 * - decoding: unused
1917 * macroblock comparison function (not supported yet)
1918 * - encoding: Set by user.
1919 * - decoding: unused
1923 * interlaced DCT comparison function
1924 * - encoding: Set by user.
1925 * - decoding: unused
1928 #define FF_CMP_SAD 0
1929 #define FF_CMP_SSE 1
1930 #define FF_CMP_SATD 2
1931 #define FF_CMP_DCT 3
1932 #define FF_CMP_PSNR 4
1933 #define FF_CMP_BIT 5
1935 #define FF_CMP_ZERO 7
1936 #define FF_CMP_VSAD 8
1937 #define FF_CMP_VSSE 9
1938 #define FF_CMP_NSSE 10
1939 #define FF_CMP_W53 11
1940 #define FF_CMP_W97 12
1941 #define FF_CMP_DCTMAX 13
1942 #define FF_CMP_DCT264 14
1943 #define FF_CMP_MEDIAN_SAD 15
1944 #define FF_CMP_CHROMA 256
1947 * ME diamond size & shape
1948 * - encoding: Set by user.
1949 * - decoding: unused
1954 * amount of previous MV predictors (2a+1 x 2a+1 square)
1955 * - encoding: Set by user.
1956 * - decoding: unused
1958 int last_predictor_count;
1960 #if FF_API_PRIVATE_OPT
1961 /** @deprecated use encoder private options instead */
1962 attribute_deprecated
1967 * motion estimation prepass comparison function
1968 * - encoding: Set by user.
1969 * - decoding: unused
1974 * ME prepass diamond size & shape
1975 * - encoding: Set by user.
1976 * - decoding: unused
1982 * - encoding: Set by user.
1983 * - decoding: unused
1985 int me_subpel_quality;
1988 * maximum motion estimation search range in subpel units
1989 * If 0 then no limit.
1991 * - encoding: Set by user.
1992 * - decoding: unused
1998 * - encoding: unused
1999 * - decoding: Set by user.
2002 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2003 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2004 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2007 * macroblock decision mode
2008 * - encoding: Set by user.
2009 * - decoding: unused
2012 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2013 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2014 #define FF_MB_DECISION_RD 2 ///< rate distortion
2017 * custom intra quantization matrix
2018 * - encoding: Set by user, can be NULL.
2019 * - decoding: Set by libavcodec.
2021 uint16_t *intra_matrix;
2024 * custom inter quantization matrix
2025 * - encoding: Set by user, can be NULL.
2026 * - decoding: Set by libavcodec.
2028 uint16_t *inter_matrix;
2030 #if FF_API_PRIVATE_OPT
2031 /** @deprecated use encoder private options instead */
2032 attribute_deprecated
2033 int scenechange_threshold;
2035 /** @deprecated use encoder private options instead */
2036 attribute_deprecated
2037 int noise_reduction;
2041 * precision of the intra DC coefficient - 8
2042 * - encoding: Set by user.
2043 * - decoding: Set by libavcodec
2045 int intra_dc_precision;
2048 * Number of macroblock rows at the top which are skipped.
2049 * - encoding: unused
2050 * - decoding: Set by user.
2055 * Number of macroblock rows at the bottom which are skipped.
2056 * - encoding: unused
2057 * - decoding: Set by user.
2062 * minimum MB Lagrange multiplier
2063 * - encoding: Set by user.
2064 * - decoding: unused
2069 * maximum MB Lagrange multiplier
2070 * - encoding: Set by user.
2071 * - decoding: unused
2075 #if FF_API_PRIVATE_OPT
2077 * @deprecated use encoder private options instead
2079 attribute_deprecated
2080 int me_penalty_compensation;
2084 * - encoding: Set by user.
2085 * - decoding: unused
2089 #if FF_API_PRIVATE_OPT
2090 /** @deprecated use encoder private options instead */
2091 attribute_deprecated
2097 * - encoding: Set by user.
2098 * - decoding: unused
2103 * number of reference frames
2104 * - encoding: Set by user.
2105 * - decoding: Set by lavc.
2109 #if FF_API_PRIVATE_OPT
2110 /** @deprecated use encoder private options instead */
2111 attribute_deprecated
2116 * Note: Value depends upon the compare function used for fullpel ME.
2117 * - encoding: Set by user.
2118 * - decoding: unused
2122 #if FF_API_PRIVATE_OPT
2123 /** @deprecated use encoder private options instead */
2124 attribute_deprecated
2129 * Chromaticity coordinates of the source primaries.
2130 * - encoding: Set by user
2131 * - decoding: Set by libavcodec
2133 enum AVColorPrimaries color_primaries;
2136 * Color Transfer Characteristic.
2137 * - encoding: Set by user
2138 * - decoding: Set by libavcodec
2140 enum AVColorTransferCharacteristic color_trc;
2143 * YUV colorspace type.
2144 * - encoding: Set by user
2145 * - decoding: Set by libavcodec
2147 enum AVColorSpace colorspace;
2150 * MPEG vs JPEG YUV range.
2151 * - encoding: Set by user
2152 * - decoding: Set by libavcodec
2154 enum AVColorRange color_range;
2157 * This defines the location of chroma samples.
2158 * - encoding: Set by user
2159 * - decoding: Set by libavcodec
2161 enum AVChromaLocation chroma_sample_location;
2165 * Indicates number of picture subdivisions. Used for parallelized
2167 * - encoding: Set by user
2168 * - decoding: unused
2173 * - encoding: set by libavcodec
2174 * - decoding: Set by user.
2176 enum AVFieldOrder field_order;
2179 int sample_rate; ///< samples per second
2180 int channels; ///< number of audio channels
2183 * audio sample format
2184 * - encoding: Set by user.
2185 * - decoding: Set by libavcodec.
2187 enum AVSampleFormat sample_fmt; ///< sample format
2189 /* The following data should not be initialized. */
2191 * Number of samples per channel in an audio frame.
2193 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2194 * except the last must contain exactly frame_size samples per channel.
2195 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2196 * frame size is not restricted.
2197 * - decoding: may be set by some decoders to indicate constant frame size
2202 * Frame counter, set by libavcodec.
2204 * - decoding: total number of frames returned from the decoder so far.
2205 * - encoding: total number of frames passed to the encoder so far.
2207 * @note the counter is not incremented if encoding/decoding resulted in
2213 * number of bytes per packet if constant and known or 0
2214 * Used by some WAV based audio codecs.
2219 * Audio cutoff bandwidth (0 means "automatic")
2220 * - encoding: Set by user.
2221 * - decoding: unused
2226 * Audio channel layout.
2227 * - encoding: set by user.
2228 * - decoding: set by user, may be overwritten by libavcodec.
2230 uint64_t channel_layout;
2233 * Request decoder to use this channel layout if it can (0 for default)
2234 * - encoding: unused
2235 * - decoding: Set by user.
2237 uint64_t request_channel_layout;
2240 * Type of service that the audio stream conveys.
2241 * - encoding: Set by user.
2242 * - decoding: Set by libavcodec.
2244 enum AVAudioServiceType audio_service_type;
2247 * desired sample format
2248 * - encoding: Not used.
2249 * - decoding: Set by user.
2250 * Decoder will decode to this format if it can.
2252 enum AVSampleFormat request_sample_fmt;
2255 * This callback is called at the beginning of each frame to get data
2256 * buffer(s) for it. There may be one contiguous buffer for all the data or
2257 * there may be a buffer per each data plane or anything in between. What
2258 * this means is, you may set however many entries in buf[] you feel necessary.
2259 * Each buffer must be reference-counted using the AVBuffer API (see description
2262 * The following fields will be set in the frame before this callback is
2265 * - width, height (video only)
2266 * - sample_rate, channel_layout, nb_samples (audio only)
2267 * Their values may differ from the corresponding values in
2268 * AVCodecContext. This callback must use the frame values, not the codec
2269 * context values, to calculate the required buffer size.
2271 * This callback must fill the following fields in the frame:
2275 * * if the data is planar audio with more than 8 channels, then this
2276 * callback must allocate and fill extended_data to contain all pointers
2277 * to all data planes. data[] must hold as many pointers as it can.
2278 * extended_data must be allocated with av_malloc() and will be freed in
2280 * * otherwise extended_data must point to data
2281 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2282 * the frame's data and extended_data pointers must be contained in these. That
2283 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2284 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2285 * and av_buffer_ref().
2286 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2287 * this callback and filled with the extra buffers if there are more
2288 * buffers than buf[] can hold. extended_buf will be freed in
2291 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2292 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2295 * Each data plane must be aligned to the maximum required by the target
2298 * @see avcodec_default_get_buffer2()
2302 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2303 * (read and/or written to if it is writable) later by libavcodec.
2305 * avcodec_align_dimensions2() should be used to find the required width and
2306 * height, as they normally need to be rounded up to the next multiple of 16.
2308 * Some decoders do not support linesizes changing between frames.
2310 * If frame multithreading is used and thread_safe_callbacks is set,
2311 * this callback may be called from a different thread, but not from more
2312 * than one at once. Does not need to be reentrant.
2314 * @see avcodec_align_dimensions2()
2318 * Decoders request a buffer of a particular size by setting
2319 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2320 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2321 * to a smaller value in the output frame.
2323 * As a convenience, av_samples_get_buffer_size() and
2324 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2325 * functions to find the required data size and to fill data pointers and
2326 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2327 * since all planes must be the same size.
2329 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2331 * - encoding: unused
2332 * - decoding: Set by libavcodec, user can override.
2334 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2337 * If non-zero, the decoded audio and video frames returned from
2338 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2339 * and are valid indefinitely. The caller must free them with
2340 * av_frame_unref() when they are not needed anymore.
2341 * Otherwise, the decoded frames must not be freed by the caller and are
2342 * only valid until the next decode call.
2344 * This is always automatically enabled if avcodec_receive_frame() is used.
2346 * - encoding: unused
2347 * - decoding: set by the caller before avcodec_open2().
2349 attribute_deprecated
2350 int refcounted_frames;
2352 /* - encoding parameters */
2353 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2354 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2358 * - encoding: Set by user.
2359 * - decoding: unused
2365 * - encoding: Set by user.
2366 * - decoding: unused
2371 * maximum quantizer difference between frames
2372 * - encoding: Set by user.
2373 * - decoding: unused
2378 * decoder bitstream buffer size
2379 * - encoding: Set by user.
2380 * - decoding: unused
2385 * ratecontrol override, see RcOverride
2386 * - encoding: Allocated/set/freed by user.
2387 * - decoding: unused
2389 int rc_override_count;
2390 RcOverride *rc_override;
2394 * - encoding: Set by user.
2395 * - decoding: Set by user, may be overwritten by libavcodec.
2397 int64_t rc_max_rate;
2401 * - encoding: Set by user.
2402 * - decoding: unused
2404 int64_t rc_min_rate;
2407 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2408 * - encoding: Set by user.
2409 * - decoding: unused.
2411 float rc_max_available_vbv_use;
2414 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2415 * - encoding: Set by user.
2416 * - decoding: unused.
2418 float rc_min_vbv_overflow_use;
2421 * Number of bits which should be loaded into the rc buffer before decoding starts.
2422 * - encoding: Set by user.
2423 * - decoding: unused
2425 int rc_initial_buffer_occupancy;
2427 #if FF_API_CODER_TYPE
2428 #define FF_CODER_TYPE_VLC 0
2429 #define FF_CODER_TYPE_AC 1
2430 #define FF_CODER_TYPE_RAW 2
2431 #define FF_CODER_TYPE_RLE 3
2433 * @deprecated use encoder private options instead
2435 attribute_deprecated
2437 #endif /* FF_API_CODER_TYPE */
2439 #if FF_API_PRIVATE_OPT
2440 /** @deprecated use encoder private options instead */
2441 attribute_deprecated
2445 #if FF_API_PRIVATE_OPT
2446 /** @deprecated use encoder private options instead */
2447 attribute_deprecated
2448 int frame_skip_threshold;
2450 /** @deprecated use encoder private options instead */
2451 attribute_deprecated
2452 int frame_skip_factor;
2454 /** @deprecated use encoder private options instead */
2455 attribute_deprecated
2458 /** @deprecated use encoder private options instead */
2459 attribute_deprecated
2461 #endif /* FF_API_PRIVATE_OPT */
2464 * trellis RD quantization
2465 * - encoding: Set by user.
2466 * - decoding: unused
2470 #if FF_API_PRIVATE_OPT
2471 /** @deprecated use encoder private options instead */
2472 attribute_deprecated
2473 int min_prediction_order;
2475 /** @deprecated use encoder private options instead */
2476 attribute_deprecated
2477 int max_prediction_order;
2479 /** @deprecated use encoder private options instead */
2480 attribute_deprecated
2481 int64_t timecode_frame_start;
2484 #if FF_API_RTP_CALLBACK
2486 * @deprecated unused
2488 /* The RTP callback: This function is called */
2489 /* every time the encoder has a packet to send. */
2490 /* It depends on the encoder if the data starts */
2491 /* with a Start Code (it should). H.263 does. */
2492 /* mb_nb contains the number of macroblocks */
2493 /* encoded in the RTP payload. */
2494 attribute_deprecated
2495 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2498 #if FF_API_PRIVATE_OPT
2499 /** @deprecated use encoder private options instead */
2500 attribute_deprecated
2501 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2502 /* do its best to deliver a chunk with size */
2503 /* below rtp_payload_size, the chunk will start */
2504 /* with a start code on some codecs like H.263. */
2505 /* This doesn't take account of any particular */
2506 /* headers inside the transmitted RTP payload. */
2509 #if FF_API_STAT_BITS
2510 /* statistics, used for 2-pass encoding */
2511 attribute_deprecated
2513 attribute_deprecated
2515 attribute_deprecated
2517 attribute_deprecated
2519 attribute_deprecated
2521 attribute_deprecated
2523 attribute_deprecated
2525 attribute_deprecated
2528 /** @deprecated this field is unused */
2529 attribute_deprecated
2534 * pass1 encoding statistics output buffer
2535 * - encoding: Set by libavcodec.
2536 * - decoding: unused
2541 * pass2 encoding statistics input buffer
2542 * Concatenated stuff from stats_out of pass1 should be placed here.
2543 * - encoding: Allocated/set/freed by user.
2544 * - decoding: unused
2549 * Work around bugs in encoders which sometimes cannot be detected automatically.
2550 * - encoding: Set by user
2551 * - decoding: Set by user
2553 int workaround_bugs;
2554 #define FF_BUG_AUTODETECT 1 ///< autodetection
2555 #define FF_BUG_XVID_ILACE 4
2556 #define FF_BUG_UMP4 8
2557 #define FF_BUG_NO_PADDING 16
2558 #define FF_BUG_AMV 32
2559 #define FF_BUG_QPEL_CHROMA 64
2560 #define FF_BUG_STD_QPEL 128
2561 #define FF_BUG_QPEL_CHROMA2 256
2562 #define FF_BUG_DIRECT_BLOCKSIZE 512
2563 #define FF_BUG_EDGE 1024
2564 #define FF_BUG_HPEL_CHROMA 2048
2565 #define FF_BUG_DC_CLIP 4096
2566 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2567 #define FF_BUG_TRUNCATED 16384
2568 #define FF_BUG_IEDGE 32768
2571 * strictly follow the standard (MPEG-4, ...).
2572 * - encoding: Set by user.
2573 * - decoding: Set by user.
2574 * Setting this to STRICT or higher means the encoder and decoder will
2575 * generally do stupid things, whereas setting it to unofficial or lower
2576 * will mean the encoder might produce output that is not supported by all
2577 * spec-compliant decoders. Decoders don't differentiate between normal,
2578 * unofficial and experimental (that is, they always try to decode things
2579 * when they can) unless they are explicitly asked to behave stupidly
2580 * (=strictly conform to the specs)
2582 int strict_std_compliance;
2583 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2584 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2585 #define FF_COMPLIANCE_NORMAL 0
2586 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2587 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2590 * error concealment flags
2591 * - encoding: unused
2592 * - decoding: Set by user.
2594 int error_concealment;
2595 #define FF_EC_GUESS_MVS 1
2596 #define FF_EC_DEBLOCK 2
2597 #define FF_EC_FAVOR_INTER 256
2601 * - encoding: Set by user.
2602 * - decoding: Set by user.
2605 #define FF_DEBUG_PICT_INFO 1
2606 #define FF_DEBUG_RC 2
2607 #define FF_DEBUG_BITSTREAM 4
2608 #define FF_DEBUG_MB_TYPE 8
2609 #define FF_DEBUG_QP 16
2612 * @deprecated this option does nothing
2614 #define FF_DEBUG_MV 32
2616 #define FF_DEBUG_DCT_COEFF 0x00000040
2617 #define FF_DEBUG_SKIP 0x00000080
2618 #define FF_DEBUG_STARTCODE 0x00000100
2619 #define FF_DEBUG_ER 0x00000400
2620 #define FF_DEBUG_MMCO 0x00000800
2621 #define FF_DEBUG_BUGS 0x00001000
2623 #define FF_DEBUG_VIS_QP 0x00002000
2624 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2626 #define FF_DEBUG_BUFFERS 0x00008000
2627 #define FF_DEBUG_THREADS 0x00010000
2628 #define FF_DEBUG_GREEN_MD 0x00800000
2629 #define FF_DEBUG_NOMC 0x01000000
2634 * - encoding: Set by user.
2635 * - decoding: Set by user.
2638 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2639 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2640 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2644 * Error recognition; may misdetect some more or less valid parts as errors.
2645 * - encoding: unused
2646 * - decoding: Set by user.
2648 int err_recognition;
2651 * Verify checksums embedded in the bitstream (could be of either encoded or
2652 * decoded data, depending on the codec) and print an error message on mismatch.
2653 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2654 * decoder returning an error.
2656 #define AV_EF_CRCCHECK (1<<0)
2657 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2658 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2659 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2661 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2662 #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
2663 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2664 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2668 * opaque 64-bit number (generally a PTS) that will be reordered and
2669 * output in AVFrame.reordered_opaque
2670 * - encoding: unused
2671 * - decoding: Set by user.
2673 int64_t reordered_opaque;
2676 * Hardware accelerator in use
2677 * - encoding: unused.
2678 * - decoding: Set by libavcodec
2680 const struct AVHWAccel *hwaccel;
2683 * Hardware accelerator context.
2684 * For some hardware accelerators, a global context needs to be
2685 * provided by the user. In that case, this holds display-dependent
2686 * data FFmpeg cannot instantiate itself. Please refer to the
2687 * FFmpeg HW accelerator documentation to know how to fill this
2688 * is. e.g. for VA API, this is a struct vaapi_context.
2689 * - encoding: unused
2690 * - decoding: Set by user
2692 void *hwaccel_context;
2696 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2697 * - decoding: unused
2699 uint64_t error[AV_NUM_DATA_POINTERS];
2702 * DCT algorithm, see FF_DCT_* below
2703 * - encoding: Set by user.
2704 * - decoding: unused
2707 #define FF_DCT_AUTO 0
2708 #define FF_DCT_FASTINT 1
2709 #define FF_DCT_INT 2
2710 #define FF_DCT_MMX 3
2711 #define FF_DCT_ALTIVEC 5
2712 #define FF_DCT_FAAN 6
2715 * IDCT algorithm, see FF_IDCT_* below.
2716 * - encoding: Set by user.
2717 * - decoding: Set by user.
2720 #define FF_IDCT_AUTO 0
2721 #define FF_IDCT_INT 1
2722 #define FF_IDCT_SIMPLE 2
2723 #define FF_IDCT_SIMPLEMMX 3
2724 #define FF_IDCT_ARM 7
2725 #define FF_IDCT_ALTIVEC 8
2726 #define FF_IDCT_SIMPLEARM 10
2727 #define FF_IDCT_XVID 14
2728 #define FF_IDCT_SIMPLEARMV5TE 16
2729 #define FF_IDCT_SIMPLEARMV6 17
2730 #define FF_IDCT_FAAN 20
2731 #define FF_IDCT_SIMPLENEON 22
2732 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2733 #define FF_IDCT_SIMPLEAUTO 128
2736 * bits per sample/pixel from the demuxer (needed for huffyuv).
2737 * - encoding: Set by libavcodec.
2738 * - decoding: Set by user.
2740 int bits_per_coded_sample;
2743 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2744 * - encoding: set by user.
2745 * - decoding: set by libavcodec.
2747 int bits_per_raw_sample;
2751 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2752 * - encoding: unused
2753 * - decoding: Set by user.
2758 #if FF_API_CODED_FRAME
2760 * the picture in the bitstream
2761 * - encoding: Set by libavcodec.
2762 * - decoding: unused
2764 * @deprecated use the quality factor packet side data instead
2766 attribute_deprecated AVFrame *coded_frame;
2771 * is used to decide how many independent tasks should be passed to execute()
2772 * - encoding: Set by user.
2773 * - decoding: Set by user.
2778 * Which multithreading methods to use.
2779 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2780 * so clients which cannot provide future frames should not use it.
2782 * - encoding: Set by user, otherwise the default is used.
2783 * - decoding: Set by user, otherwise the default is used.
2786 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2787 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2790 * Which multithreading methods are in use by the codec.
2791 * - encoding: Set by libavcodec.
2792 * - decoding: Set by libavcodec.
2794 int active_thread_type;
2797 * Set by the client if its custom get_buffer() callback can be called
2798 * synchronously from another thread, which allows faster multithreaded decoding.
2799 * draw_horiz_band() will be called from other threads regardless of this setting.
2800 * Ignored if the default get_buffer() is used.
2801 * - encoding: Set by user.
2802 * - decoding: Set by user.
2804 int thread_safe_callbacks;
2807 * The codec may call this to execute several independent things.
2808 * It will return only after finishing all tasks.
2809 * The user may replace this with some multithreaded implementation,
2810 * the default implementation will execute the parts serially.
2811 * @param count the number of things to execute
2812 * - encoding: Set by libavcodec, user can override.
2813 * - decoding: Set by libavcodec, user can override.
2815 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2818 * The codec may call this to execute several independent things.
2819 * It will return only after finishing all tasks.
2820 * The user may replace this with some multithreaded implementation,
2821 * the default implementation will execute the parts serially.
2822 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2823 * @param c context passed also to func
2824 * @param count the number of things to execute
2825 * @param arg2 argument passed unchanged to func
2826 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2827 * @param func function that will be called count times, with jobnr from 0 to count-1.
2828 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2829 * two instances of func executing at the same time will have the same threadnr.
2830 * @return always 0 currently, but code should handle a future improvement where when any call to func
2831 * returns < 0 no further calls to func may be done and < 0 is returned.
2832 * - encoding: Set by libavcodec, user can override.
2833 * - decoding: Set by libavcodec, user can override.
2835 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2838 * noise vs. sse weight for the nsse comparison function
2839 * - encoding: Set by user.
2840 * - decoding: unused
2846 * - encoding: Set by user.
2847 * - decoding: Set by libavcodec.
2850 #define FF_PROFILE_UNKNOWN -99
2851 #define FF_PROFILE_RESERVED -100
2853 #define FF_PROFILE_AAC_MAIN 0
2854 #define FF_PROFILE_AAC_LOW 1
2855 #define FF_PROFILE_AAC_SSR 2
2856 #define FF_PROFILE_AAC_LTP 3
2857 #define FF_PROFILE_AAC_HE 4
2858 #define FF_PROFILE_AAC_HE_V2 28
2859 #define FF_PROFILE_AAC_LD 22
2860 #define FF_PROFILE_AAC_ELD 38
2861 #define FF_PROFILE_MPEG2_AAC_LOW 128
2862 #define FF_PROFILE_MPEG2_AAC_HE 131
2864 #define FF_PROFILE_DNXHD 0
2865 #define FF_PROFILE_DNXHR_LB 1
2866 #define FF_PROFILE_DNXHR_SQ 2
2867 #define FF_PROFILE_DNXHR_HQ 3
2868 #define FF_PROFILE_DNXHR_HQX 4
2869 #define FF_PROFILE_DNXHR_444 5
2871 #define FF_PROFILE_DTS 20
2872 #define FF_PROFILE_DTS_ES 30
2873 #define FF_PROFILE_DTS_96_24 40
2874 #define FF_PROFILE_DTS_HD_HRA 50
2875 #define FF_PROFILE_DTS_HD_MA 60
2876 #define FF_PROFILE_DTS_EXPRESS 70
2878 #define FF_PROFILE_MPEG2_422 0
2879 #define FF_PROFILE_MPEG2_HIGH 1
2880 #define FF_PROFILE_MPEG2_SS 2
2881 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2882 #define FF_PROFILE_MPEG2_MAIN 4
2883 #define FF_PROFILE_MPEG2_SIMPLE 5
2885 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2886 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2888 #define FF_PROFILE_H264_BASELINE 66
2889 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2890 #define FF_PROFILE_H264_MAIN 77
2891 #define FF_PROFILE_H264_EXTENDED 88
2892 #define FF_PROFILE_H264_HIGH 100
2893 #define FF_PROFILE_H264_HIGH_10 110
2894 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2895 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2896 #define FF_PROFILE_H264_HIGH_422 122
2897 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2898 #define FF_PROFILE_H264_STEREO_HIGH 128
2899 #define FF_PROFILE_H264_HIGH_444 144
2900 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2901 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2902 #define FF_PROFILE_H264_CAVLC_444 44
2904 #define FF_PROFILE_VC1_SIMPLE 0
2905 #define FF_PROFILE_VC1_MAIN 1
2906 #define FF_PROFILE_VC1_COMPLEX 2
2907 #define FF_PROFILE_VC1_ADVANCED 3
2909 #define FF_PROFILE_MPEG4_SIMPLE 0
2910 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2911 #define FF_PROFILE_MPEG4_CORE 2
2912 #define FF_PROFILE_MPEG4_MAIN 3
2913 #define FF_PROFILE_MPEG4_N_BIT 4
2914 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2915 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2916 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2917 #define FF_PROFILE_MPEG4_HYBRID 8
2918 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2919 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2920 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2921 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2922 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2923 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2924 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2926 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2927 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2928 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2929 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2930 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2932 #define FF_PROFILE_VP9_0 0
2933 #define FF_PROFILE_VP9_1 1
2934 #define FF_PROFILE_VP9_2 2
2935 #define FF_PROFILE_VP9_3 3
2937 #define FF_PROFILE_HEVC_MAIN 1
2938 #define FF_PROFILE_HEVC_MAIN_10 2
2939 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2940 #define FF_PROFILE_HEVC_REXT 4
2942 #define FF_PROFILE_AV1_MAIN 0
2943 #define FF_PROFILE_AV1_HIGH 1
2944 #define FF_PROFILE_AV1_PROFESSIONAL 2
2946 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT 0xc0
2947 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
2948 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT 0xc2
2949 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS 0xc3
2950 #define FF_PROFILE_MJPEG_JPEG_LS 0xf7
2952 #define FF_PROFILE_SBC_MSBC 1
2956 * - encoding: Set by user.
2957 * - decoding: Set by libavcodec.
2960 #define FF_LEVEL_UNKNOWN -99
2963 * Skip loop filtering for selected frames.
2964 * - encoding: unused
2965 * - decoding: Set by user.
2967 enum AVDiscard skip_loop_filter;
2970 * Skip IDCT/dequantization for selected frames.
2971 * - encoding: unused
2972 * - decoding: Set by user.
2974 enum AVDiscard skip_idct;
2977 * Skip decoding for selected frames.
2978 * - encoding: unused
2979 * - decoding: Set by user.
2981 enum AVDiscard skip_frame;
2984 * Header containing style information for text subtitles.
2985 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2986 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2987 * the Format line following. It shouldn't include any Dialogue line.
2988 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2989 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2991 uint8_t *subtitle_header;
2992 int subtitle_header_size;
2994 #if FF_API_VBV_DELAY
2996 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2997 * Used for compliant TS muxing.
2998 * - encoding: Set by libavcodec.
2999 * - decoding: unused.
3000 * @deprecated this value is now exported as a part of
3001 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3003 attribute_deprecated
3007 #if FF_API_SIDEDATA_ONLY_PKT
3009 * Encoding only and set by default. Allow encoders to output packets
3010 * that do not contain any encoded data, only side data.
3012 * Some encoders need to output such packets, e.g. to update some stream
3013 * parameters at the end of encoding.
3015 * @deprecated this field disables the default behaviour and
3016 * it is kept only for compatibility.
3018 attribute_deprecated
3019 int side_data_only_packets;
3023 * Audio only. The number of "priming" samples (padding) inserted by the
3024 * encoder at the beginning of the audio. I.e. this number of leading
3025 * decoded samples must be discarded by the caller to get the original audio
3026 * without leading padding.
3028 * - decoding: unused
3029 * - encoding: Set by libavcodec. The timestamps on the output packets are
3030 * adjusted by the encoder so that they always refer to the
3031 * first sample of the data actually contained in the packet,
3032 * including any added padding. E.g. if the timebase is
3033 * 1/samplerate and the timestamp of the first input sample is
3034 * 0, the timestamp of the first output packet will be
3037 int initial_padding;
3040 * - decoding: For codecs that store a framerate value in the compressed
3041 * bitstream, the decoder may export it here. { 0, 1} when
3043 * - encoding: May be used to signal the framerate of CFR content to an
3046 AVRational framerate;
3049 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3050 * - encoding: unused.
3051 * - decoding: Set by libavcodec before calling get_format()
3053 enum AVPixelFormat sw_pix_fmt;
3056 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3057 * - encoding unused.
3058 * - decoding set by user.
3060 AVRational pkt_timebase;
3064 * - encoding: unused.
3065 * - decoding: set by libavcodec.
3067 const AVCodecDescriptor *codec_descriptor;
3071 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3072 * - encoding: unused
3073 * - decoding: Set by user.
3079 * Current statistics for PTS correction.
3080 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3081 * - encoding: unused
3083 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3084 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3085 int64_t pts_correction_last_pts; /// PTS of the last frame
3086 int64_t pts_correction_last_dts; /// DTS of the last frame
3089 * Character encoding of the input subtitles file.
3090 * - decoding: set by user
3091 * - encoding: unused
3096 * Subtitles character encoding mode. Formats or codecs might be adjusting
3097 * this setting (if they are doing the conversion themselves for instance).
3098 * - decoding: set by libavcodec
3099 * - encoding: unused
3101 int sub_charenc_mode;
3102 #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)
3103 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3104 #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
3105 #define FF_SUB_CHARENC_MODE_IGNORE 2 ///< neither convert the subtitles, nor check them for valid UTF-8
3108 * Skip processing alpha if supported by codec.
3109 * Note that if the format uses pre-multiplied alpha (common with VP6,
3110 * and recommended due to better video quality/compression)
3111 * the image will look as if alpha-blended onto a black background.
3112 * However for formats that do not use pre-multiplied alpha
3113 * there might be serious artefacts (though e.g. libswscale currently
3114 * assumes pre-multiplied alpha anyway).
3116 * - decoding: set by user
3117 * - encoding: unused
3122 * Number of samples to skip after a discontinuity
3123 * - decoding: unused
3124 * - encoding: set by libavcodec
3128 #if !FF_API_DEBUG_MV
3130 * debug motion vectors
3131 * - encoding: Set by user.
3132 * - decoding: Set by user.
3135 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3136 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3137 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3141 * custom intra quantization matrix
3142 * - encoding: Set by user, can be NULL.
3143 * - decoding: unused.
3145 uint16_t *chroma_intra_matrix;
3148 * dump format separator.
3149 * can be ", " or "\n " or anything else
3150 * - encoding: Set by user.
3151 * - decoding: Set by user.
3153 uint8_t *dump_separator;
3156 * ',' separated list of allowed decoders.
3157 * If NULL then all are allowed
3158 * - encoding: unused
3159 * - decoding: set by user
3161 char *codec_whitelist;
3164 * Properties of the stream that gets decoded
3165 * - encoding: unused
3166 * - decoding: set by libavcodec
3168 unsigned properties;
3169 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3170 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3173 * Additional data associated with the entire coded stream.
3175 * - decoding: unused
3176 * - encoding: may be set by libavcodec after avcodec_open2().
3178 AVPacketSideData *coded_side_data;
3179 int nb_coded_side_data;
3182 * A reference to the AVHWFramesContext describing the input (for encoding)
3183 * or output (decoding) frames. The reference is set by the caller and
3184 * afterwards owned (and freed) by libavcodec - it should never be read by
3185 * the caller after being set.
3187 * - decoding: This field should be set by the caller from the get_format()
3188 * callback. The previous reference (if any) will always be
3189 * unreffed by libavcodec before the get_format() call.
3191 * If the default get_buffer2() is used with a hwaccel pixel
3192 * format, then this AVHWFramesContext will be used for
3193 * allocating the frame buffers.
3195 * - encoding: For hardware encoders configured to use a hwaccel pixel
3196 * format, this field should be set by the caller to a reference
3197 * to the AVHWFramesContext describing input frames.
3198 * AVHWFramesContext.format must be equal to
3199 * AVCodecContext.pix_fmt.
3201 * This field should be set before avcodec_open2() is called.
3203 AVBufferRef *hw_frames_ctx;
3206 * Control the form of AVSubtitle.rects[N]->ass
3207 * - decoding: set by user
3208 * - encoding: unused
3210 int sub_text_format;
3211 #define FF_SUB_TEXT_FMT_ASS 0
3212 #if FF_API_ASS_TIMING
3213 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3217 * Audio only. The amount of padding (in samples) appended by the encoder to
3218 * the end of the audio. I.e. this number of decoded samples must be
3219 * discarded by the caller from the end of the stream to get the original
3220 * audio without any trailing padding.
3222 * - decoding: unused
3223 * - encoding: unused
3225 int trailing_padding;
3228 * The number of pixels per image to maximally accept.
3230 * - decoding: set by user
3231 * - encoding: set by user
3236 * A reference to the AVHWDeviceContext describing the device which will
3237 * be used by a hardware encoder/decoder. The reference is set by the
3238 * caller and afterwards owned (and freed) by libavcodec.
3240 * This should be used if either the codec device does not require
3241 * hardware frames or any that are used are to be allocated internally by
3242 * libavcodec. If the user wishes to supply any of the frames used as
3243 * encoder input or decoder output then hw_frames_ctx should be used
3244 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3245 * field will be ignored while decoding the associated stream segment, but
3246 * may again be used on a following one after another get_format() call.
3248 * For both encoders and decoders this field should be set before
3249 * avcodec_open2() is called and must not be written to thereafter.
3251 * Note that some decoders may require this field to be set initially in
3252 * order to support hw_frames_ctx at all - in that case, all frames
3253 * contexts used must be created on the same device.
3255 AVBufferRef *hw_device_ctx;
3258 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3259 * decoding (if active).
3260 * - encoding: unused
3261 * - decoding: Set by user (either before avcodec_open2(), or in the
3262 * AVCodecContext.get_format callback)
3267 * Video decoding only. Certain video codecs support cropping, meaning that
3268 * only a sub-rectangle of the decoded frame is intended for display. This
3269 * option controls how cropping is handled by libavcodec.
3271 * When set to 1 (the default), libavcodec will apply cropping internally.
3272 * I.e. it will modify the output frame width/height fields and offset the
3273 * data pointers (only by as much as possible while preserving alignment, or
3274 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3275 * the frames output by the decoder refer only to the cropped area. The
3276 * crop_* fields of the output frames will be zero.
3278 * When set to 0, the width/height fields of the output frames will be set
3279 * to the coded dimensions and the crop_* fields will describe the cropping
3280 * rectangle. Applying the cropping is left to the caller.
3282 * @warning When hardware acceleration with opaque output frames is used,
3283 * libavcodec is unable to apply cropping from the top/left border.
3285 * @note when this option is set to zero, the width/height fields of the
3286 * AVCodecContext and output AVFrames have different meanings. The codec
3287 * context fields store display dimensions (with the coded dimensions in
3288 * coded_width/height), while the frame fields store the coded dimensions
3289 * (with the display dimensions being determined by the crop_* fields).
3294 * Video decoding only. Sets the number of extra hardware frames which
3295 * the decoder will allocate for use by the caller. This must be set
3296 * before avcodec_open2() is called.
3298 * Some hardware decoders require all frames that they will use for
3299 * output to be defined in advance before decoding starts. For such
3300 * decoders, the hardware frame pool must therefore be of a fixed size.
3301 * The extra frames set here are on top of any number that the decoder
3302 * needs internally in order to operate normally (for example, frames
3303 * used as reference pictures).
3305 int extra_hw_frames;
3308 #if FF_API_CODEC_GET_SET
3310 * Accessors for some AVCodecContext fields. These used to be provided for ABI
3311 * compatibility, and do not need to be used anymore.
3313 attribute_deprecated
3314 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3315 attribute_deprecated
3316 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3318 attribute_deprecated
3319 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3320 attribute_deprecated
3321 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3323 attribute_deprecated
3324 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3327 attribute_deprecated
3328 int av_codec_get_lowres(const AVCodecContext *avctx);
3329 attribute_deprecated
3330 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3333 attribute_deprecated
3334 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3335 attribute_deprecated
3336 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3338 attribute_deprecated
3339 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3340 attribute_deprecated
3341 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3347 typedef struct AVProfile {
3349 const char *name; ///< short name for the profile
3354 * The codec supports this format via the hw_device_ctx interface.
3356 * When selecting this format, AVCodecContext.hw_device_ctx should
3357 * have been set to a device of the specified type before calling
3360 AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
3362 * The codec supports this format via the hw_frames_ctx interface.
3364 * When selecting this format for a decoder,
3365 * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3366 * context inside the get_format() callback. The frames context
3367 * must have been created on a device of the specified type.
3369 AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
3371 * The codec supports this format by some internal method.
3373 * This format can be selected without any additional configuration -
3374 * no device or frames context is required.
3376 AV_CODEC_HW_CONFIG_METHOD_INTERNAL = 0x04,
3378 * The codec supports this format by some ad-hoc method.
3380 * Additional settings and/or function calls are required. See the
3381 * codec-specific documentation for details. (Methods requiring
3382 * this sort of configuration are deprecated and others should be
3383 * used in preference.)
3385 AV_CODEC_HW_CONFIG_METHOD_AD_HOC = 0x08,
3388 typedef struct AVCodecHWConfig {
3390 * A hardware pixel format which the codec can use.
3392 enum AVPixelFormat pix_fmt;
3394 * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3395 * setup methods which can be used with this configuration.
3399 * The device type associated with the configuration.
3401 * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3402 * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3404 enum AVHWDeviceType device_type;
3407 typedef struct AVCodecDefault AVCodecDefault;
3414 typedef struct AVCodec {
3416 * Name of the codec implementation.
3417 * The name is globally unique among encoders and among decoders (but an
3418 * encoder and a decoder can share the same name).
3419 * This is the primary way to find a codec from the user perspective.
3423 * Descriptive name for the codec, meant to be more human readable than name.
3424 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3426 const char *long_name;
3427 enum AVMediaType type;
3430 * Codec capabilities.
3431 * see AV_CODEC_CAP_*
3434 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3435 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3436 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3437 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3438 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3439 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3440 const AVClass *priv_class; ///< AVClass for the private context
3441 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3444 * Group name of the codec implementation.
3445 * This is a short symbolic name of the wrapper backing this codec. A
3446 * wrapper uses some kind of external implementation for the codec, such
3447 * as an external library, or a codec implementation provided by the OS or
3449 * If this field is NULL, this is a builtin, libavcodec native codec.
3450 * If non-NULL, this will be the suffix in AVCodec.name in most cases
3451 * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3453 const char *wrapper_name;
3455 /*****************************************************************
3456 * No fields below this line are part of the public API. They
3457 * may not be used outside of libavcodec and can be changed and
3459 * New public fields should be added right above.
3460 *****************************************************************
3463 struct AVCodec *next;
3465 * @name Frame-level threading support functions
3469 * If defined, called on thread contexts when they are created.
3470 * If the codec allocates writable tables in init(), re-allocate them here.
3471 * priv_data will be set to a copy of the original.
3473 int (*init_thread_copy)(AVCodecContext *);
3475 * Copy necessary context variables from a previous thread context to the current one.
3476 * If not defined, the next thread will start automatically; otherwise, the codec
3477 * must call ff_thread_finish_setup().
3479 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3481 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3485 * Private codec-specific defaults.
3487 const AVCodecDefault *defaults;
3490 * Initialize codec static data, called from avcodec_register().
3492 * This is not intended for time consuming operations as it is
3493 * run for every codec regardless of that codec being used.
3495 void (*init_static_data)(struct AVCodec *codec);
3497 int (*init)(AVCodecContext *);
3498 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3499 const struct AVSubtitle *sub);
3501 * Encode data to an AVPacket.
3503 * @param avctx codec context
3504 * @param avpkt output AVPacket (may contain a user-provided buffer)
3505 * @param[in] frame AVFrame containing the raw data to be encoded
3506 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3507 * non-empty packet was returned in avpkt.
3508 * @return 0 on success, negative error code on failure
3510 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3511 int *got_packet_ptr);
3512 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3513 int (*close)(AVCodecContext *);
3515 * Encode API with decoupled packet/frame dataflow. The API is the
3516 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3518 * - never called if the codec is closed or the wrong type,
3519 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3520 * - only one drain frame is ever passed down,
3522 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3523 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3526 * Decode API with decoupled packet/frame dataflow. This function is called
3527 * to get one output frame. It should call ff_decode_get_packet() to obtain
3530 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3533 * Will be called when seeking
3535 void (*flush)(AVCodecContext *);
3537 * Internal codec capabilities.
3538 * See FF_CODEC_CAP_* in internal.h
3543 * Decoding only, a comma-separated list of bitstream filters to apply to
3544 * packets before decoding.
3549 * Array of pointers to hardware configurations supported by the codec,
3550 * or NULL if no hardware supported. The array is terminated by a NULL
3553 * The user can only access this field via avcodec_get_hw_config().
3555 const struct AVCodecHWConfigInternal **hw_configs;
3558 #if FF_API_CODEC_GET_SET
3559 attribute_deprecated
3560 int av_codec_get_max_lowres(const AVCodec *codec);
3563 struct MpegEncContext;
3566 * Retrieve supported hardware configurations for a codec.
3568 * Values of index from zero to some maximum return the indexed configuration
3569 * descriptor; all other values return NULL. If the codec does not support
3570 * any hardware configurations then it will always return NULL.
3572 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3575 * @defgroup lavc_hwaccel AVHWAccel
3577 * @note Nothing in this structure should be accessed by the user. At some
3578 * point in future it will not be externally visible at all.
3582 typedef struct AVHWAccel {
3584 * Name of the hardware accelerated codec.
3585 * The name is globally unique among encoders and among decoders (but an
3586 * encoder and a decoder can share the same name).
3591 * Type of codec implemented by the hardware accelerator.
3593 * See AVMEDIA_TYPE_xxx
3595 enum AVMediaType type;
3598 * Codec implemented by the hardware accelerator.
3600 * See AV_CODEC_ID_xxx
3605 * Supported pixel format.
3607 * Only hardware accelerated formats are supported here.
3609 enum AVPixelFormat pix_fmt;
3612 * Hardware accelerated codec capabilities.
3613 * see AV_HWACCEL_CODEC_CAP_*
3617 /*****************************************************************
3618 * No fields below this line are part of the public API. They
3619 * may not be used outside of libavcodec and can be changed and
3621 * New public fields should be added right above.
3622 *****************************************************************
3626 * Allocate a custom buffer
3628 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3631 * Called at the beginning of each frame or field picture.
3633 * Meaningful frame information (codec specific) is guaranteed to
3634 * be parsed at this point. This function is mandatory.
3636 * Note that buf can be NULL along with buf_size set to 0.
3637 * Otherwise, this means the whole frame is available at this point.
3639 * @param avctx the codec context
3640 * @param buf the frame data buffer base
3641 * @param buf_size the size of the frame in bytes
3642 * @return zero if successful, a negative value otherwise
3644 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3647 * Callback for parameter data (SPS/PPS/VPS etc).
3649 * Useful for hardware decoders which keep persistent state about the
3650 * video parameters, and need to receive any changes to update that state.
3652 * @param avctx the codec context
3653 * @param type the nal unit type
3654 * @param buf the nal unit data buffer
3655 * @param buf_size the size of the nal unit in bytes
3656 * @return zero if successful, a negative value otherwise
3658 int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3661 * Callback for each slice.
3663 * Meaningful slice information (codec specific) is guaranteed to
3664 * be parsed at this point. This function is mandatory.
3665 * The only exception is XvMC, that works on MB level.
3667 * @param avctx the codec context
3668 * @param buf the slice data buffer base
3669 * @param buf_size the size of the slice in bytes
3670 * @return zero if successful, a negative value otherwise
3672 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3675 * Called at the end of each frame or field picture.
3677 * The whole picture is parsed at this point and can now be sent
3678 * to the hardware accelerator. This function is mandatory.
3680 * @param avctx the codec context
3681 * @return zero if successful, a negative value otherwise
3683 int (*end_frame)(AVCodecContext *avctx);
3686 * Size of per-frame hardware accelerator private data.
3688 * Private data is allocated with av_mallocz() before
3689 * AVCodecContext.get_buffer() and deallocated after
3690 * AVCodecContext.release_buffer().
3692 int frame_priv_data_size;
3695 * Called for every Macroblock in a slice.
3697 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3698 * Instead of decoding to raw picture, MB parameters are
3699 * stored in an array provided by the video driver.
3701 * @param s the mpeg context
3703 void (*decode_mb)(struct MpegEncContext *s);
3706 * Initialize the hwaccel private data.
3708 * This will be called from ff_get_format(), after hwaccel and
3709 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3712 int (*init)(AVCodecContext *avctx);
3715 * Uninitialize the hwaccel private data.
3717 * This will be called from get_format() or avcodec_close(), after hwaccel
3718 * and hwaccel_context are already uninitialized.
3720 int (*uninit)(AVCodecContext *avctx);
3723 * Size of the private data to allocate in
3724 * AVCodecInternal.hwaccel_priv_data.
3729 * Internal hwaccel capabilities.
3734 * Fill the given hw_frames context with current codec parameters. Called
3735 * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3738 * This CAN be called before AVHWAccel.init is called, and you must assume
3739 * that avctx->hwaccel_priv_data is invalid.
3741 int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3745 * HWAccel is experimental and is thus avoided in favor of non experimental
3748 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3751 * Hardware acceleration should be used for decoding even if the codec level
3752 * used is unknown or higher than the maximum supported level reported by the
3755 * It's generally a good idea to pass this flag unless you have a specific
3756 * reason not to, as hardware tends to under-report supported levels.
3758 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3761 * Hardware acceleration can output YUV pixel formats with a different chroma
3762 * sampling than 4:2:0 and/or other than 8 bits per component.
3764 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3767 * Hardware acceleration should still be attempted for decoding when the
3768 * codec profile does not match the reported capabilities of the hardware.
3770 * For example, this can be used to try to decode baseline profile H.264
3771 * streams in hardware - it will often succeed, because many streams marked
3772 * as baseline profile actually conform to constrained baseline profile.
3774 * @warning If the stream is actually not supported then the behaviour is
3775 * undefined, and may include returning entirely incorrect output
3776 * while indicating success.
3778 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3784 #if FF_API_AVPICTURE
3786 * @defgroup lavc_picture AVPicture
3788 * Functions for working with AVPicture
3793 * Picture data structure.
3795 * Up to four components can be stored into it, the last component is
3797 * @deprecated use AVFrame or imgutils functions instead
3799 typedef struct AVPicture {
3800 attribute_deprecated
3801 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3802 attribute_deprecated
3803 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3811 enum AVSubtitleType {
3814 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3817 * Plain text, the text field must be set by the decoder and is
3818 * authoritative. ass and pict fields may contain approximations.
3823 * Formatted text, the ass field must be set by the decoder and is
3824 * authoritative. pict and text fields may contain approximations.
3829 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3831 typedef struct AVSubtitleRect {
3832 int x; ///< top left corner of pict, undefined when pict is not set
3833 int y; ///< top left corner of pict, undefined when pict is not set
3834 int w; ///< width of pict, undefined when pict is not set
3835 int h; ///< height of pict, undefined when pict is not set
3836 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3838 #if FF_API_AVPICTURE
3840 * @deprecated unused
3842 attribute_deprecated
3846 * data+linesize for the bitmap of this subtitle.
3847 * Can be set for text/ass as well once they are rendered.
3852 enum AVSubtitleType type;
3854 char *text; ///< 0 terminated plain UTF-8 text
3857 * 0 terminated ASS/SSA compatible event line.
3858 * The presentation of this is unaffected by the other values in this
3866 typedef struct AVSubtitle {
3867 uint16_t format; /* 0 = graphics */
3868 uint32_t start_display_time; /* relative to packet pts, in ms */
3869 uint32_t end_display_time; /* relative to packet pts, in ms */
3871 AVSubtitleRect **rects;
3872 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3876 * This struct describes the properties of an encoded stream.
3878 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3879 * be allocated with avcodec_parameters_alloc() and freed with
3880 * avcodec_parameters_free().
3882 typedef struct AVCodecParameters {
3884 * General type of the encoded data.
3886 enum AVMediaType codec_type;
3888 * Specific type of the encoded data (the codec used).
3890 enum AVCodecID codec_id;
3892 * Additional information about the codec (corresponds to the AVI FOURCC).
3897 * Extra binary data needed for initializing the decoder, codec-dependent.
3899 * Must be allocated with av_malloc() and will be freed by
3900 * avcodec_parameters_free(). The allocated size of extradata must be at
3901 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3906 * Size of the extradata content in bytes.
3911 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3912 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3917 * The average bitrate of the encoded data (in bits per second).
3922 * The number of bits per sample in the codedwords.
3924 * This is basically the bitrate per sample. It is mandatory for a bunch of
3925 * formats to actually decode them. It's the number of bits for one sample in
3926 * the actual coded bitstream.
3928 * This could be for example 4 for ADPCM
3929 * For PCM formats this matches bits_per_raw_sample
3932 int bits_per_coded_sample;
3935 * This is the number of valid bits in each output sample. If the
3936 * sample format has more bits, the least significant bits are additional
3937 * padding bits, which are always 0. Use right shifts to reduce the sample
3938 * to its actual size. For example, audio formats with 24 bit samples will
3939 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3940 * To get the original sample use "(int32_t)sample >> 8"."
3942 * For ADPCM this might be 12 or 16 or similar
3945 int bits_per_raw_sample;
3948 * Codec-specific bitstream restrictions that the stream conforms to.
3954 * Video only. The dimensions of the video frame in pixels.
3960 * Video only. The aspect ratio (width / height) which a single pixel
3961 * should have when displayed.
3963 * When the aspect ratio is unknown / undefined, the numerator should be
3964 * set to 0 (the denominator may have any value).
3966 AVRational sample_aspect_ratio;
3969 * Video only. The order of the fields in interlaced video.
3971 enum AVFieldOrder field_order;
3974 * Video only. Additional colorspace characteristics.
3976 enum AVColorRange color_range;
3977 enum AVColorPrimaries color_primaries;
3978 enum AVColorTransferCharacteristic color_trc;
3979 enum AVColorSpace color_space;
3980 enum AVChromaLocation chroma_location;
3983 * Video only. Number of delayed frames.
3988 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3989 * unknown or unspecified, otherwise the number of bits set must be equal to
3990 * the channels field.
3992 uint64_t channel_layout;
3994 * Audio only. The number of audio channels.
3998 * Audio only. The number of audio samples per second.
4002 * Audio only. The number of bytes per coded audio frame, required by some
4005 * Corresponds to nBlockAlign in WAVEFORMATEX.
4009 * Audio only. Audio frame size, if known. Required by some formats to be static.
4014 * Audio only. The amount of padding (in samples) inserted by the encoder at
4015 * the beginning of the audio. I.e. this number of leading decoded samples
4016 * must be discarded by the caller to get the original audio without leading
4019 int initial_padding;
4021 * Audio only. The amount of padding (in samples) appended by the encoder to
4022 * the end of the audio. I.e. this number of decoded samples must be
4023 * discarded by the caller from the end of the stream to get the original
4024 * audio without any trailing padding.
4026 int trailing_padding;
4028 * Audio only. Number of samples to skip after a discontinuity.
4031 } AVCodecParameters;
4034 * Iterate over all registered codecs.
4036 * @param opaque a pointer where libavcodec will store the iteration state. Must
4037 * point to NULL to start the iteration.
4039 * @return the next registered codec or NULL when the iteration is
4042 const AVCodec *av_codec_iterate(void **opaque);
4046 * If c is NULL, returns the first registered codec,
4047 * if c is non-NULL, returns the next registered codec after c,
4048 * or NULL if c is the last one.
4050 attribute_deprecated
4051 AVCodec *av_codec_next(const AVCodec *c);
4055 * Return the LIBAVCODEC_VERSION_INT constant.
4057 unsigned avcodec_version(void);
4060 * Return the libavcodec build-time configuration.
4062 const char *avcodec_configuration(void);
4065 * Return the libavcodec license.
4067 const char *avcodec_license(void);
4071 * Register the codec codec and initialize libavcodec.
4073 * @warning either this function or avcodec_register_all() must be called
4074 * before any other libavcodec functions.
4076 * @see avcodec_register_all()
4078 attribute_deprecated
4079 void avcodec_register(AVCodec *codec);
4082 * Register all the codecs, parsers and bitstream filters which were enabled at
4083 * configuration time. If you do not call this function you can select exactly
4084 * which formats you want to support, by using the individual registration
4087 * @see avcodec_register
4088 * @see av_register_codec_parser
4089 * @see av_register_bitstream_filter
4091 attribute_deprecated
4092 void avcodec_register_all(void);
4096 * Allocate an AVCodecContext and set its fields to default values. The
4097 * resulting struct should be freed with avcodec_free_context().
4099 * @param codec if non-NULL, allocate private data and initialize defaults
4100 * for the given codec. It is illegal to then call avcodec_open2()
4101 * with a different codec.
4102 * If NULL, then the codec-specific defaults won't be initialized,
4103 * which may result in suboptimal default settings (this is
4104 * important mainly for encoders, e.g. libx264).
4106 * @return An AVCodecContext filled with default values or NULL on failure.
4108 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4111 * Free the codec context and everything associated with it and write NULL to
4112 * the provided pointer.
4114 void avcodec_free_context(AVCodecContext **avctx);
4116 #if FF_API_GET_CONTEXT_DEFAULTS
4118 * @deprecated This function should not be used, as closing and opening a codec
4119 * context multiple time is not supported. A new codec context should be
4120 * allocated for each new use.
4122 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4126 * Get the AVClass for AVCodecContext. It can be used in combination with
4127 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4129 * @see av_opt_find().
4131 const AVClass *avcodec_get_class(void);
4133 #if FF_API_COPY_CONTEXT
4135 * Get the AVClass for AVFrame. It can be used in combination with
4136 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4138 * @see av_opt_find().
4140 const AVClass *avcodec_get_frame_class(void);
4143 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4144 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4146 * @see av_opt_find().
4148 const AVClass *avcodec_get_subtitle_rect_class(void);
4151 * Copy the settings of the source AVCodecContext into the destination
4152 * AVCodecContext. The resulting destination codec context will be
4153 * unopened, i.e. you are required to call avcodec_open2() before you
4154 * can use this AVCodecContext to decode/encode video/audio data.
4156 * @param dest target codec context, should be initialized with
4157 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4158 * @param src source codec context
4159 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4161 * @deprecated The semantics of this function are ill-defined and it should not
4162 * be used. If you need to transfer the stream parameters from one codec context
4163 * to another, use an intermediate AVCodecParameters instance and the
4164 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4167 attribute_deprecated
4168 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4172 * Allocate a new AVCodecParameters and set its fields to default values
4173 * (unknown/invalid/0). The returned struct must be freed with
4174 * avcodec_parameters_free().
4176 AVCodecParameters *avcodec_parameters_alloc(void);
4179 * Free an AVCodecParameters instance and everything associated with it and
4180 * write NULL to the supplied pointer.
4182 void avcodec_parameters_free(AVCodecParameters **par);
4185 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4186 * replaced with newly allocated duplicates of the corresponding fields in src.
4188 * @return >= 0 on success, a negative AVERROR code on failure.
4190 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4193 * Fill the parameters struct based on the values from the supplied codec
4194 * context. Any allocated fields in par are freed and replaced with duplicates
4195 * of the corresponding fields in codec.
4197 * @return >= 0 on success, a negative AVERROR code on failure
4199 int avcodec_parameters_from_context(AVCodecParameters *par,
4200 const AVCodecContext *codec);
4203 * Fill the codec context based on the values from the supplied codec
4204 * parameters. Any allocated fields in codec that have a corresponding field in
4205 * par are freed and replaced with duplicates of the corresponding field in par.
4206 * Fields in codec that do not have a counterpart in par are not touched.
4208 * @return >= 0 on success, a negative AVERROR code on failure.
4210 int avcodec_parameters_to_context(AVCodecContext *codec,
4211 const AVCodecParameters *par);
4214 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4215 * function the context has to be allocated with avcodec_alloc_context3().
4217 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4218 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4219 * retrieving a codec.
4221 * @warning This function is not thread safe!
4223 * @note Always call this function before using decoding routines (such as
4224 * @ref avcodec_receive_frame()).
4227 * avcodec_register_all();
4228 * av_dict_set(&opts, "b", "2.5M", 0);
4229 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4233 * context = avcodec_alloc_context3(codec);
4235 * if (avcodec_open2(context, codec, opts) < 0)
4239 * @param avctx The context to initialize.
4240 * @param codec The codec to open this context for. If a non-NULL codec has been
4241 * previously passed to avcodec_alloc_context3() or
4242 * for this context, then this parameter MUST be either NULL or
4243 * equal to the previously passed codec.
4244 * @param options A dictionary filled with AVCodecContext and codec-private options.
4245 * On return this object will be filled with options that were not found.
4247 * @return zero on success, a negative value on error
4248 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4249 * av_dict_set(), av_opt_find().
4251 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4254 * Close a given AVCodecContext and free all the data associated with it
4255 * (but not the AVCodecContext itself).
4257 * Calling this function on an AVCodecContext that hasn't been opened will free
4258 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4259 * codec. Subsequent calls will do nothing.
4261 * @note Do not use this function. Use avcodec_free_context() to destroy a
4262 * codec context (either open or closed). Opening and closing a codec context
4263 * multiple times is not supported anymore -- use multiple codec contexts
4266 int avcodec_close(AVCodecContext *avctx);
4269 * Free all allocated data in the given subtitle struct.
4271 * @param sub AVSubtitle to free.
4273 void avsubtitle_free(AVSubtitle *sub);
4280 * @addtogroup lavc_packet
4285 * Allocate an AVPacket and set its fields to default values. The resulting
4286 * struct must be freed using av_packet_free().
4288 * @return An AVPacket filled with default values or NULL on failure.
4290 * @note this only allocates the AVPacket itself, not the data buffers. Those
4291 * must be allocated through other means such as av_new_packet.
4293 * @see av_new_packet
4295 AVPacket *av_packet_alloc(void);
4298 * Create a new packet that references the same data as src.
4300 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4302 * @return newly created AVPacket on success, NULL on error.
4304 * @see av_packet_alloc
4305 * @see av_packet_ref
4307 AVPacket *av_packet_clone(const AVPacket *src);
4310 * Free the packet, if the packet is reference counted, it will be
4311 * unreferenced first.
4313 * @param pkt packet to be freed. The pointer will be set to NULL.
4314 * @note passing NULL is a no-op.
4316 void av_packet_free(AVPacket **pkt);
4319 * Initialize optional fields of a packet with default values.
4321 * Note, this does not touch the data and size members, which have to be
4322 * initialized separately.
4326 void av_init_packet(AVPacket *pkt);
4329 * Allocate the payload of a packet and initialize its fields with
4333 * @param size wanted payload size
4334 * @return 0 if OK, AVERROR_xxx otherwise
4336 int av_new_packet(AVPacket *pkt, int size);
4339 * Reduce packet size, correctly zeroing padding
4342 * @param size new size
4344 void av_shrink_packet(AVPacket *pkt, int size);
4347 * Increase packet size, correctly zeroing padding
4350 * @param grow_by number of bytes by which to increase the size of the packet
4352 int av_grow_packet(AVPacket *pkt, int grow_by);
4355 * Initialize a reference-counted packet from av_malloc()ed data.
4357 * @param pkt packet to be initialized. This function will set the data, size,
4358 * buf and destruct fields, all others are left untouched.
4359 * @param data Data allocated by av_malloc() to be used as packet data. If this
4360 * function returns successfully, the data is owned by the underlying AVBuffer.
4361 * The caller may not access the data through other means.
4362 * @param size size of data in bytes, without the padding. I.e. the full buffer
4363 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4365 * @return 0 on success, a negative AVERROR on error
4367 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4369 #if FF_API_AVPACKET_OLD_API
4371 * @warning This is a hack - the packet memory allocation stuff is broken. The
4372 * packet is allocated if it was not really allocated.
4374 * @deprecated Use av_packet_ref or av_packet_make_refcounted
4376 attribute_deprecated
4377 int av_dup_packet(AVPacket *pkt);
4379 * Copy packet, including contents
4381 * @return 0 on success, negative AVERROR on fail
4383 * @deprecated Use av_packet_ref
4385 attribute_deprecated
4386 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4389 * Copy packet side data
4391 * @return 0 on success, negative AVERROR on fail
4393 * @deprecated Use av_packet_copy_props
4395 attribute_deprecated
4396 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4401 * @deprecated Use av_packet_unref
4403 * @param pkt packet to free
4405 attribute_deprecated
4406 void av_free_packet(AVPacket *pkt);
4409 * Allocate new information of a packet.
4412 * @param type side information type
4413 * @param size side information size
4414 * @return pointer to fresh allocated data or NULL otherwise
4416 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4420 * Wrap an existing array as a packet side data.
4423 * @param type side information type
4424 * @param data the side data array. It must be allocated with the av_malloc()
4425 * family of functions. The ownership of the data is transferred to
4427 * @param size side information size
4428 * @return a non-negative number on success, a negative AVERROR code on
4429 * failure. On failure, the packet is unchanged and the data remains
4430 * owned by the caller.
4432 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4433 uint8_t *data, size_t size);
4436 * Shrink the already allocated side data buffer
4439 * @param type side information type
4440 * @param size new side information size
4441 * @return 0 on success, < 0 on failure
4443 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4447 * Get side information from packet.
4450 * @param type desired side information type
4451 * @param size pointer for side information size to store (optional)
4452 * @return pointer to data if present or NULL otherwise
4454 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4457 #if FF_API_MERGE_SD_API
4458 attribute_deprecated
4459 int av_packet_merge_side_data(AVPacket *pkt);
4461 attribute_deprecated
4462 int av_packet_split_side_data(AVPacket *pkt);
4465 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4468 * Pack a dictionary for use in side_data.
4470 * @param dict The dictionary to pack.
4471 * @param size pointer to store the size of the returned data
4472 * @return pointer to data if successful, NULL otherwise
4474 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4476 * Unpack a dictionary from side_data.
4478 * @param data data from side_data
4479 * @param size size of the data
4480 * @param dict the metadata storage dictionary
4481 * @return 0 on success, < 0 on failure
4483 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4487 * Convenience function to free all the side data stored.
4488 * All the other fields stay untouched.
4492 void av_packet_free_side_data(AVPacket *pkt);
4495 * Setup a new reference to the data described by a given packet
4497 * If src is reference-counted, setup dst as a new reference to the
4498 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4499 * data from src into it.
4501 * All the other fields are copied from src.
4503 * @see av_packet_unref
4505 * @param dst Destination packet
4506 * @param src Source packet
4508 * @return 0 on success, a negative AVERROR on error.
4510 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4515 * Unreference the buffer referenced by the packet and reset the
4516 * remaining packet fields to their default values.
4518 * @param pkt The packet to be unreferenced.
4520 void av_packet_unref(AVPacket *pkt);
4523 * Move every field in src to dst and reset src.
4525 * @see av_packet_unref
4527 * @param src Source packet, will be reset
4528 * @param dst Destination packet
4530 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4533 * Copy only "properties" fields from src to dst.
4535 * Properties for the purpose of this function are all the fields
4536 * beside those related to the packet data (buf, data, size)
4538 * @param dst Destination packet
4539 * @param src Source packet
4541 * @return 0 on success AVERROR on failure.
4543 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4546 * Ensure the data described by a given packet is reference counted.
4548 * @note This function does not ensure that the reference will be writable.
4549 * Use av_packet_make_writable instead for that purpose.
4551 * @see av_packet_ref
4552 * @see av_packet_make_writable
4554 * @param pkt packet whose data should be made reference counted.
4556 * @return 0 on success, a negative AVERROR on error. On failure, the
4557 * packet is unchanged.
4559 int av_packet_make_refcounted(AVPacket *pkt);
4562 * Create a writable reference for the data described by a given packet,
4563 * avoiding data copy if possible.
4565 * @param pkt Packet whose data should be made writable.
4567 * @return 0 on success, a negative AVERROR on failure. On failure, the
4568 * packet is unchanged.
4570 int av_packet_make_writable(AVPacket *pkt);
4573 * Convert valid timing fields (timestamps / durations) in a packet from one
4574 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4577 * @param pkt packet on which the conversion will be performed
4578 * @param tb_src source timebase, in which the timing fields in pkt are
4580 * @param tb_dst destination timebase, to which the timing fields will be
4583 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4590 * @addtogroup lavc_decoding
4595 * Find a registered decoder with a matching codec ID.
4597 * @param id AVCodecID of the requested decoder
4598 * @return A decoder if one was found, NULL otherwise.
4600 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4603 * Find a registered decoder with the specified name.
4605 * @param name name of the requested decoder
4606 * @return A decoder if one was found, NULL otherwise.
4608 AVCodec *avcodec_find_decoder_by_name(const char *name);
4611 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4612 * it can be called by custom get_buffer2() implementations for decoders without
4613 * AV_CODEC_CAP_DR1 set.
4615 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4618 * Modify width and height values so that they will result in a memory
4619 * buffer that is acceptable for the codec if you do not use any horizontal
4622 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4624 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4627 * Modify width and height values so that they will result in a memory
4628 * buffer that is acceptable for the codec if you also ensure that all
4629 * line sizes are a multiple of the respective linesize_align[i].
4631 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4633 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4634 int linesize_align[AV_NUM_DATA_POINTERS]);
4637 * Converts AVChromaLocation to swscale x/y chroma position.
4639 * The positions represent the chroma (0,0) position in a coordinates system
4640 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4642 * @param xpos horizontal chroma sample position
4643 * @param ypos vertical chroma sample position
4645 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4648 * Converts swscale x/y chroma position to AVChromaLocation.
4650 * The positions represent the chroma (0,0) position in a coordinates system
4651 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4653 * @param xpos horizontal chroma sample position
4654 * @param ypos vertical chroma sample position
4656 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4659 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4661 * Some decoders may support multiple frames in a single AVPacket. Such
4662 * decoders would then just decode the first frame and the return value would be
4663 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4664 * called again with an AVPacket containing the remaining data in order to
4665 * decode the second frame, etc... Even if no frames are returned, the packet
4666 * needs to be fed to the decoder with remaining data until it is completely
4667 * consumed or an error occurs.
4669 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4670 * and output. This means that for some packets they will not immediately
4671 * produce decoded output and need to be flushed at the end of decoding to get
4672 * all the decoded data. Flushing is done by calling this function with packets
4673 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4674 * returning samples. It is safe to flush even those decoders that are not
4675 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4677 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4678 * larger than the actual read bytes because some optimized bitstream
4679 * readers read 32 or 64 bits at once and could read over the end.
4681 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4682 * before packets may be fed to the decoder.
4684 * @param avctx the codec context
4685 * @param[out] frame The AVFrame in which to store decoded audio samples.
4686 * The decoder will allocate a buffer for the decoded frame by
4687 * calling the AVCodecContext.get_buffer2() callback.
4688 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4689 * reference counted and the returned reference belongs to the
4690 * caller. The caller must release the frame using av_frame_unref()
4691 * when the frame is no longer needed. The caller may safely write
4692 * to the frame if av_frame_is_writable() returns 1.
4693 * When AVCodecContext.refcounted_frames is set to 0, the returned
4694 * reference belongs to the decoder and is valid only until the
4695 * next call to this function or until closing or flushing the
4696 * decoder. The caller may not write to it.
4697 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4698 * non-zero. Note that this field being set to zero
4699 * does not mean that an error has occurred. For
4700 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4701 * call is guaranteed to produce a frame.
4702 * @param[in] avpkt The input AVPacket containing the input buffer.
4703 * At least avpkt->data and avpkt->size should be set. Some
4704 * decoders might also require additional fields to be set.
4705 * @return A negative error code is returned if an error occurred during
4706 * decoding, otherwise the number of bytes consumed from the input
4707 * AVPacket is returned.
4709 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4711 attribute_deprecated
4712 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4713 int *got_frame_ptr, const AVPacket *avpkt);
4716 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4717 * Some decoders may support multiple frames in a single AVPacket, such
4718 * decoders would then just decode the first frame.
4720 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4721 * the actual read bytes because some optimized bitstream readers read 32 or 64
4722 * bits at once and could read over the end.
4724 * @warning The end of the input buffer buf should be set to 0 to ensure that
4725 * no overreading happens for damaged MPEG streams.
4727 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4728 * between input and output, these need to be fed with avpkt->data=NULL,
4729 * avpkt->size=0 at the end to return the remaining frames.
4731 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4732 * before packets may be fed to the decoder.
4734 * @param avctx the codec context
4735 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4736 * Use av_frame_alloc() to get an AVFrame. The codec will
4737 * allocate memory for the actual bitmap by calling the
4738 * AVCodecContext.get_buffer2() callback.
4739 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4740 * reference counted and the returned reference belongs to the
4741 * caller. The caller must release the frame using av_frame_unref()
4742 * when the frame is no longer needed. The caller may safely write
4743 * to the frame if av_frame_is_writable() returns 1.
4744 * When AVCodecContext.refcounted_frames is set to 0, the returned
4745 * reference belongs to the decoder and is valid only until the
4746 * next call to this function or until closing or flushing the
4747 * decoder. The caller may not write to it.
4749 * @param[in] avpkt The input AVPacket containing the input buffer.
4750 * You can create such packet with av_init_packet() and by then setting
4751 * data and size, some decoders might in addition need other fields like
4752 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4754 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4755 * @return On error a negative value is returned, otherwise the number of bytes
4756 * used or zero if no frame could be decompressed.
4758 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4760 attribute_deprecated
4761 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4762 int *got_picture_ptr,
4763 const AVPacket *avpkt);
4766 * Decode a subtitle message.
4767 * Return a negative value on error, otherwise return the number of bytes used.
4768 * If no subtitle could be decompressed, got_sub_ptr is zero.
4769 * Otherwise, the subtitle is stored in *sub.
4770 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4771 * simplicity, because the performance difference is expect to be negligible
4772 * and reusing a get_buffer written for video codecs would probably perform badly
4773 * due to a potentially very different allocation pattern.
4775 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4776 * and output. This means that for some packets they will not immediately
4777 * produce decoded output and need to be flushed at the end of decoding to get
4778 * all the decoded data. Flushing is done by calling this function with packets
4779 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4780 * returning subtitles. It is safe to flush even those decoders that are not
4781 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4783 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4784 * before packets may be fed to the decoder.
4786 * @param avctx the codec context
4787 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4788 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4789 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4790 * @param[in] avpkt The input AVPacket containing the input buffer.
4792 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4797 * Supply raw packet data as input to a decoder.
4799 * Internally, this call will copy relevant AVCodecContext fields, which can
4800 * influence decoding per-packet, and apply them when the packet is actually
4801 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4802 * decoder to drop the frame contained by the packet sent with this function.)
4804 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4805 * larger than the actual read bytes because some optimized bitstream
4806 * readers read 32 or 64 bits at once and could read over the end.
4808 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4809 * on the same AVCodecContext. It will return unexpected results now
4810 * or in future libavcodec versions.
4812 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4813 * before packets may be fed to the decoder.
4815 * @param avctx codec context
4816 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4817 * frame, or several complete audio frames.
4818 * Ownership of the packet remains with the caller, and the
4819 * decoder will not write to the packet. The decoder may create
4820 * a reference to the packet data (or copy it if the packet is
4821 * not reference-counted).
4822 * Unlike with older APIs, the packet is always fully consumed,
4823 * and if it contains multiple frames (e.g. some audio codecs),
4824 * will require you to call avcodec_receive_frame() multiple
4825 * times afterwards before you can send a new packet.
4826 * It can be NULL (or an AVPacket with data set to NULL and
4827 * size set to 0); in this case, it is considered a flush
4828 * packet, which signals the end of the stream. Sending the
4829 * first flush packet will return success. Subsequent ones are
4830 * unnecessary and will return AVERROR_EOF. If the decoder
4831 * still has frames buffered, it will return them after sending
4834 * @return 0 on success, otherwise negative error code:
4835 * AVERROR(EAGAIN): input is not accepted in the current state - user
4836 * must read output with avcodec_receive_frame() (once
4837 * all output is read, the packet should be resent, and
4838 * the call will not fail with EAGAIN).
4839 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4840 * be sent to it (also returned if more than 1 flush
4842 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4843 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4844 * other errors: legitimate decoding errors
4846 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4849 * Return decoded output data from a decoder.
4851 * @param avctx codec context
4852 * @param frame This will be set to a reference-counted video or audio
4853 * frame (depending on the decoder type) allocated by the
4854 * decoder. Note that the function will always call
4855 * av_frame_unref(frame) before doing anything else.
4858 * 0: success, a frame was returned
4859 * AVERROR(EAGAIN): output is not available in this state - user must try
4861 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4862 * no more output frames
4863 * AVERROR(EINVAL): codec not opened, or it is an encoder
4864 * other negative values: legitimate decoding errors
4866 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4869 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4870 * to retrieve buffered output packets.
4872 * @param avctx codec context
4873 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4874 * Ownership of the frame remains with the caller, and the
4875 * encoder will not write to the frame. The encoder may create
4876 * a reference to the frame data (or copy it if the frame is
4877 * not reference-counted).
4878 * It can be NULL, in which case it is considered a flush
4879 * packet. This signals the end of the stream. If the encoder
4880 * still has packets buffered, it will return them after this
4881 * call. Once flushing mode has been entered, additional flush
4882 * packets are ignored, and sending frames will return
4886 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4887 * can have any number of samples.
4888 * If it is not set, frame->nb_samples must be equal to
4889 * avctx->frame_size for all frames except the last.
4890 * The final frame may be smaller than avctx->frame_size.
4891 * @return 0 on success, otherwise negative error code:
4892 * AVERROR(EAGAIN): input is not accepted in the current state - user
4893 * must read output with avcodec_receive_packet() (once
4894 * all output is read, the packet should be resent, and
4895 * the call will not fail with EAGAIN).
4896 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4898 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4899 * decoder, or requires flush
4900 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4901 * other errors: legitimate decoding errors
4903 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4906 * Read encoded data from the encoder.
4908 * @param avctx codec context
4909 * @param avpkt This will be set to a reference-counted packet allocated by the
4910 * encoder. Note that the function will always call
4911 * av_frame_unref(frame) before doing anything else.
4912 * @return 0 on success, otherwise negative error code:
4913 * AVERROR(EAGAIN): output is not available in the current state - user
4914 * must try to send input
4915 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4916 * no more output packets
4917 * AVERROR(EINVAL): codec not opened, or it is an encoder
4918 * other errors: legitimate decoding errors
4920 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4923 * Create and return a AVHWFramesContext with values adequate for hardware
4924 * decoding. This is meant to get called from the get_format callback, and is
4925 * a helper for preparing a AVHWFramesContext for AVCodecContext.hw_frames_ctx.
4926 * This API is for decoding with certain hardware acceleration modes/APIs only.
4928 * The returned AVHWFramesContext is not initialized. The caller must do this
4929 * with av_hwframe_ctx_init().
4931 * Calling this function is not a requirement, but makes it simpler to avoid
4932 * codec or hardware API specific details when manually allocating frames.
4934 * Alternatively to this, an API user can set AVCodecContext.hw_device_ctx,
4935 * which sets up AVCodecContext.hw_frames_ctx fully automatically, and makes
4936 * it unnecessary to call this function or having to care about
4937 * AVHWFramesContext initialization at all.
4939 * There are a number of requirements for calling this function:
4941 * - It must be called from get_format with the same avctx parameter that was
4942 * passed to get_format. Calling it outside of get_format is not allowed, and
4943 * can trigger undefined behavior.
4944 * - The function is not always supported (see description of return values).
4945 * Even if this function returns successfully, hwaccel initialization could
4946 * fail later. (The degree to which implementations check whether the stream
4947 * is actually supported varies. Some do this check only after the user's
4948 * get_format callback returns.)
4949 * - The hw_pix_fmt must be one of the choices suggested by get_format. If the
4950 * user decides to use a AVHWFramesContext prepared with this API function,
4951 * the user must return the same hw_pix_fmt from get_format.
4952 * - The device_ref passed to this function must support the given hw_pix_fmt.
4953 * - After calling this API function, it is the user's responsibility to
4954 * initialize the AVHWFramesContext (returned by the out_frames_ref parameter),
4955 * and to set AVCodecContext.hw_frames_ctx to it. If done, this must be done
4956 * before returning from get_format (this is implied by the normal
4957 * AVCodecContext.hw_frames_ctx API rules).
4958 * - The AVHWFramesContext parameters may change every time time get_format is
4959 * called. Also, AVCodecContext.hw_frames_ctx is reset before get_format. So
4960 * you are inherently required to go through this process again on every
4962 * - It is perfectly possible to call this function without actually using
4963 * the resulting AVHWFramesContext. One use-case might be trying to reuse a
4964 * previously initialized AVHWFramesContext, and calling this API function
4965 * only to test whether the required frame parameters have changed.
4966 * - Fields that use dynamically allocated values of any kind must not be set
4967 * by the user unless setting them is explicitly allowed by the documentation.
4968 * If the user sets AVHWFramesContext.free and AVHWFramesContext.user_opaque,
4969 * the new free callback must call the potentially set previous free callback.
4970 * This API call may set any dynamically allocated fields, including the free
4973 * The function will set at least the following fields on AVHWFramesContext
4974 * (potentially more, depending on hwaccel API):
4976 * - All fields set by av_hwframe_ctx_alloc().
4977 * - Set the format field to hw_pix_fmt.
4978 * - Set the sw_format field to the most suited and most versatile format. (An
4979 * implication is that this will prefer generic formats over opaque formats
4980 * with arbitrary restrictions, if possible.)
4981 * - Set the width/height fields to the coded frame size, rounded up to the
4982 * API-specific minimum alignment.
4983 * - Only _if_ the hwaccel requires a pre-allocated pool: set the initial_pool_size
4984 * field to the number of maximum reference surfaces possible with the codec,
4985 * plus 1 surface for the user to work (meaning the user can safely reference
4986 * at most 1 decoded surface at a time), plus additional buffering introduced
4987 * by frame threading. If the hwaccel does not require pre-allocation, the
4988 * field is left to 0, and the decoder will allocate new surfaces on demand
4990 * - Possibly AVHWFramesContext.hwctx fields, depending on the underlying
4993 * Essentially, out_frames_ref returns the same as av_hwframe_ctx_alloc(), but
4994 * with basic frame parameters set.
4996 * The function is stateless, and does not change the AVCodecContext or the
4997 * device_ref AVHWDeviceContext.
4999 * @param avctx The context which is currently calling get_format, and which
5000 * implicitly contains all state needed for filling the returned
5001 * AVHWFramesContext properly.
5002 * @param device_ref A reference to the AVHWDeviceContext describing the device
5003 * which will be used by the hardware decoder.
5004 * @param hw_pix_fmt The hwaccel format you are going to return from get_format.
5005 * @param out_frames_ref On success, set to a reference to an _uninitialized_
5006 * AVHWFramesContext, created from the given device_ref.
5007 * Fields will be set to values required for decoding.
5008 * Not changed if an error is returned.
5009 * @return zero on success, a negative value on error. The following error codes
5010 * have special semantics:
5011 * AVERROR(ENOENT): the decoder does not support this functionality. Setup
5012 * is always manual, or it is a decoder which does not
5013 * support setting AVCodecContext.hw_frames_ctx at all,
5014 * or it is a software format.
5015 * AVERROR(EINVAL): it is known that hardware decoding is not supported for
5016 * this configuration, or the device_ref is not supported
5017 * for the hwaccel referenced by hw_pix_fmt.
5019 int avcodec_get_hw_frames_parameters(AVCodecContext *avctx,
5020 AVBufferRef *device_ref,
5021 enum AVPixelFormat hw_pix_fmt,
5022 AVBufferRef **out_frames_ref);
5027 * @defgroup lavc_parsing Frame parsing
5031 enum AVPictureStructure {
5032 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5033 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5034 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5035 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5038 typedef struct AVCodecParserContext {
5040 struct AVCodecParser *parser;
5041 int64_t frame_offset; /* offset of the current frame */
5042 int64_t cur_offset; /* current offset
5043 (incremented by each av_parser_parse()) */
5044 int64_t next_frame_offset; /* offset of the next frame */
5046 int pict_type; /* XXX: Put it back in AVCodecContext. */
5048 * This field is used for proper frame duration computation in lavf.
5049 * It signals, how much longer the frame duration of the current frame
5050 * is compared to normal frame duration.
5052 * frame_duration = (1 + repeat_pict) * time_base
5054 * It is used by codecs like H.264 to display telecined material.
5056 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5057 int64_t pts; /* pts of the current frame */
5058 int64_t dts; /* dts of the current frame */
5063 int fetch_timestamp;
5065 #define AV_PARSER_PTS_NB 4
5066 int cur_frame_start_index;
5067 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5068 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5069 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5072 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5073 #define PARSER_FLAG_ONCE 0x0002
5074 /// Set if the parser has a valid file offset
5075 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5076 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5078 int64_t offset; ///< byte offset from starting packet start
5079 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5082 * Set by parser to 1 for key frames and 0 for non-key frames.
5083 * It is initialized to -1, so if the parser doesn't set this flag,
5084 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5089 #if FF_API_CONVERGENCE_DURATION
5091 * @deprecated unused
5093 attribute_deprecated
5094 int64_t convergence_duration;
5097 // Timestamp generation support:
5099 * Synchronization point for start of timestamp generation.
5101 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5104 * For example, this corresponds to presence of H.264 buffering period
5110 * Offset of the current timestamp against last timestamp sync point in
5111 * units of AVCodecContext.time_base.
5113 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5114 * contain a valid timestamp offset.
5116 * Note that the timestamp of sync point has usually a nonzero
5117 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5118 * the next frame after timestamp sync point will be usually 1.
5120 * For example, this corresponds to H.264 cpb_removal_delay.
5122 int dts_ref_dts_delta;
5125 * Presentation delay of current frame in units of AVCodecContext.time_base.
5127 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5128 * contain valid non-negative timestamp delta (presentation time of a frame
5129 * must not lie in the past).
5131 * This delay represents the difference between decoding and presentation
5132 * time of the frame.
5134 * For example, this corresponds to H.264 dpb_output_delay.
5139 * Position of the packet in file.
5141 * Analogous to cur_frame_pts/dts
5143 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5146 * Byte position of currently parsed frame in stream.
5151 * Previous frame byte position.
5156 * Duration of the current frame.
5157 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5158 * For all other types, this is in units of AVCodecContext.time_base.
5162 enum AVFieldOrder field_order;
5165 * Indicate whether a picture is coded as a frame, top field or bottom field.
5167 * For example, H.264 field_pic_flag equal to 0 corresponds to
5168 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5169 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5170 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5172 enum AVPictureStructure picture_structure;
5175 * Picture number incremented in presentation or output order.
5176 * This field may be reinitialized at the first picture of a new sequence.
5178 * For example, this corresponds to H.264 PicOrderCnt.
5180 int output_picture_number;
5183 * Dimensions of the decoded video intended for presentation.
5189 * Dimensions of the coded video.
5195 * The format of the coded data, corresponds to enum AVPixelFormat for video
5196 * and for enum AVSampleFormat for audio.
5198 * Note that a decoder can have considerable freedom in how exactly it
5199 * decodes the data, so the format reported here might be different from the
5200 * one returned by a decoder.
5203 } AVCodecParserContext;
5205 typedef struct AVCodecParser {
5206 int codec_ids[5]; /* several codec IDs are permitted */
5208 int (*parser_init)(AVCodecParserContext *s);
5209 /* This callback never returns an error, a negative value means that
5210 * the frame start was in a previous packet. */
5211 int (*parser_parse)(AVCodecParserContext *s,
5212 AVCodecContext *avctx,
5213 const uint8_t **poutbuf, int *poutbuf_size,
5214 const uint8_t *buf, int buf_size);
5215 void (*parser_close)(AVCodecParserContext *s);
5216 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5217 struct AVCodecParser *next;
5221 * Iterate over all registered codec parsers.
5223 * @param opaque a pointer where libavcodec will store the iteration state. Must
5224 * point to NULL to start the iteration.
5226 * @return the next registered codec parser or NULL when the iteration is
5229 const AVCodecParser *av_parser_iterate(void **opaque);
5231 attribute_deprecated
5232 AVCodecParser *av_parser_next(const AVCodecParser *c);
5234 attribute_deprecated
5235 void av_register_codec_parser(AVCodecParser *parser);
5236 AVCodecParserContext *av_parser_init(int codec_id);
5241 * @param s parser context.
5242 * @param avctx codec context.
5243 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5244 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5245 * @param buf input buffer.
5246 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5247 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5248 To signal EOF, this should be 0 (so that the last frame
5250 * @param pts input presentation timestamp.
5251 * @param dts input decoding timestamp.
5252 * @param pos input byte position in stream.
5253 * @return the number of bytes of the input bitstream used.
5258 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5265 * decode_frame(data, size);
5269 int av_parser_parse2(AVCodecParserContext *s,
5270 AVCodecContext *avctx,
5271 uint8_t **poutbuf, int *poutbuf_size,
5272 const uint8_t *buf, int buf_size,
5273 int64_t pts, int64_t dts,
5277 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5278 * @deprecated use AVBitStreamFilter
5280 int av_parser_change(AVCodecParserContext *s,
5281 AVCodecContext *avctx,
5282 uint8_t **poutbuf, int *poutbuf_size,
5283 const uint8_t *buf, int buf_size, int keyframe);
5284 void av_parser_close(AVCodecParserContext *s);
5292 * @addtogroup lavc_encoding
5297 * Find a registered encoder with a matching codec ID.
5299 * @param id AVCodecID of the requested encoder
5300 * @return An encoder if one was found, NULL otherwise.
5302 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5305 * Find a registered encoder with the specified name.
5307 * @param name name of the requested encoder
5308 * @return An encoder if one was found, NULL otherwise.
5310 AVCodec *avcodec_find_encoder_by_name(const char *name);
5313 * Encode a frame of audio.
5315 * Takes input samples from frame and writes the next output packet, if
5316 * available, to avpkt. The output packet does not necessarily contain data for
5317 * the most recent frame, as encoders can delay, split, and combine input frames
5318 * internally as needed.
5320 * @param avctx codec context
5321 * @param avpkt output AVPacket.
5322 * The user can supply an output buffer by setting
5323 * avpkt->data and avpkt->size prior to calling the
5324 * function, but if the size of the user-provided data is not
5325 * large enough, encoding will fail. If avpkt->data and
5326 * avpkt->size are set, avpkt->destruct must also be set. All
5327 * other AVPacket fields will be reset by the encoder using
5328 * av_init_packet(). If avpkt->data is NULL, the encoder will
5329 * allocate it. The encoder will set avpkt->size to the size
5330 * of the output packet.
5332 * If this function fails or produces no output, avpkt will be
5333 * freed using av_packet_unref().
5334 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5335 * May be NULL when flushing an encoder that has the
5336 * AV_CODEC_CAP_DELAY capability set.
5337 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5338 * can have any number of samples.
5339 * If it is not set, frame->nb_samples must be equal to
5340 * avctx->frame_size for all frames except the last.
5341 * The final frame may be smaller than avctx->frame_size.
5342 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5343 * output packet is non-empty, and to 0 if it is
5344 * empty. If the function returns an error, the
5345 * packet can be assumed to be invalid, and the
5346 * value of got_packet_ptr is undefined and should
5348 * @return 0 on success, negative error code on failure
5350 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5352 attribute_deprecated
5353 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5354 const AVFrame *frame, int *got_packet_ptr);
5357 * Encode a frame of video.
5359 * Takes input raw video data from frame and writes the next output packet, if
5360 * available, to avpkt. The output packet does not necessarily contain data for
5361 * the most recent frame, as encoders can delay and reorder input frames
5362 * internally as needed.
5364 * @param avctx codec context
5365 * @param avpkt output AVPacket.
5366 * The user can supply an output buffer by setting
5367 * avpkt->data and avpkt->size prior to calling the
5368 * function, but if the size of the user-provided data is not
5369 * large enough, encoding will fail. All other AVPacket fields
5370 * will be reset by the encoder using av_init_packet(). If
5371 * avpkt->data is NULL, the encoder will allocate it.
5372 * The encoder will set avpkt->size to the size of the
5373 * output packet. The returned data (if any) belongs to the
5374 * caller, he is responsible for freeing it.
5376 * If this function fails or produces no output, avpkt will be
5377 * freed using av_packet_unref().
5378 * @param[in] frame AVFrame containing the raw video data to be encoded.
5379 * May be NULL when flushing an encoder that has the
5380 * AV_CODEC_CAP_DELAY capability set.
5381 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5382 * output packet is non-empty, and to 0 if it is
5383 * empty. If the function returns an error, the
5384 * packet can be assumed to be invalid, and the
5385 * value of got_packet_ptr is undefined and should
5387 * @return 0 on success, negative error code on failure
5389 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5391 attribute_deprecated
5392 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5393 const AVFrame *frame, int *got_packet_ptr);
5395 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5396 const AVSubtitle *sub);
5403 #if FF_API_AVPICTURE
5405 * @addtogroup lavc_picture
5410 * @deprecated unused
5412 attribute_deprecated
5413 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5416 * @deprecated unused
5418 attribute_deprecated
5419 void avpicture_free(AVPicture *picture);
5422 * @deprecated use av_image_fill_arrays() instead.
5424 attribute_deprecated
5425 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5426 enum AVPixelFormat pix_fmt, int width, int height);
5429 * @deprecated use av_image_copy_to_buffer() instead.
5431 attribute_deprecated
5432 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5433 int width, int height,
5434 unsigned char *dest, int dest_size);
5437 * @deprecated use av_image_get_buffer_size() instead.
5439 attribute_deprecated
5440 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5443 * @deprecated av_image_copy() instead.
5445 attribute_deprecated
5446 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5447 enum AVPixelFormat pix_fmt, int width, int height);
5450 * @deprecated unused
5452 attribute_deprecated
5453 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5454 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5457 * @deprecated unused
5459 attribute_deprecated
5460 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5461 int padtop, int padbottom, int padleft, int padright, int *color);
5469 * @defgroup lavc_misc Utility functions
5472 * Miscellaneous utility functions related to both encoding and decoding
5478 * @defgroup lavc_misc_pixfmt Pixel formats
5480 * Functions for working with pixel formats.
5484 #if FF_API_GETCHROMA
5486 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5489 attribute_deprecated
5490 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5494 * Return a value representing the fourCC code associated to the
5495 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5498 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5501 * @deprecated see av_get_pix_fmt_loss()
5503 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5507 * Find the best pixel format to convert to given a certain source pixel
5508 * format. When converting from one pixel format to another, information loss
5509 * may occur. For example, when converting from RGB24 to GRAY, the color
5510 * information will be lost. Similarly, other losses occur when converting from
5511 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5512 * the given pixel formats should be used to suffer the least amount of loss.
5513 * The pixel formats from which it chooses one, are determined by the
5514 * pix_fmt_list parameter.
5517 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5518 * @param[in] src_pix_fmt source pixel format
5519 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5520 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5521 * @return The best pixel format to convert to or -1 if none was found.
5523 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5524 enum AVPixelFormat src_pix_fmt,
5525 int has_alpha, int *loss_ptr);
5528 * @deprecated see av_find_best_pix_fmt_of_2()
5530 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5531 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5533 attribute_deprecated
5534 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5535 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5537 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5543 #if FF_API_TAG_STRING
5545 * Put a string representing the codec tag codec_tag in buf.
5547 * @param buf buffer to place codec tag in
5548 * @param buf_size size in bytes of buf
5549 * @param codec_tag codec tag to assign
5550 * @return the length of the string that would have been generated if
5551 * enough space had been available, excluding the trailing null
5553 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5555 attribute_deprecated
5556 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5559 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5562 * Return a name for the specified profile, if available.
5564 * @param codec the codec that is searched for the given profile
5565 * @param profile the profile value for which a name is requested
5566 * @return A name for the profile if found, NULL otherwise.
5568 const char *av_get_profile_name(const AVCodec *codec, int profile);
5571 * Return a name for the specified profile, if available.
5573 * @param codec_id the ID of the codec to which the requested profile belongs
5574 * @param profile the profile value for which a name is requested
5575 * @return A name for the profile if found, NULL otherwise.
5577 * @note unlike av_get_profile_name(), which searches a list of profiles
5578 * supported by a specific decoder or encoder implementation, this
5579 * function searches the list of profiles from the AVCodecDescriptor
5581 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5583 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5584 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5585 //FIXME func typedef
5588 * Fill AVFrame audio data and linesize pointers.
5590 * The buffer buf must be a preallocated buffer with a size big enough
5591 * to contain the specified samples amount. The filled AVFrame data
5592 * pointers will point to this buffer.
5594 * AVFrame extended_data channel pointers are allocated if necessary for
5597 * @param frame the AVFrame
5598 * frame->nb_samples must be set prior to calling the
5599 * function. This function fills in frame->data,
5600 * frame->extended_data, frame->linesize[0].
5601 * @param nb_channels channel count
5602 * @param sample_fmt sample format
5603 * @param buf buffer to use for frame data
5604 * @param buf_size size of buffer
5605 * @param align plane size sample alignment (0 = default)
5606 * @return >=0 on success, negative error code on failure
5607 * @todo return the size in bytes required to store the samples in
5608 * case of success, at the next libavutil bump
5610 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5611 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5612 int buf_size, int align);
5615 * Reset the internal decoder state / flush internal buffers. Should be called
5616 * e.g. when seeking or when switching to a different stream.
5618 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5619 * this invalidates the frames previously returned from the decoder. When
5620 * refcounted frames are used, the decoder just releases any references it might
5621 * keep internally, but the caller's reference remains valid.
5623 void avcodec_flush_buffers(AVCodecContext *avctx);
5626 * Return codec bits per sample.
5628 * @param[in] codec_id the codec
5629 * @return Number of bits per sample or zero if unknown for the given codec.
5631 int av_get_bits_per_sample(enum AVCodecID codec_id);
5634 * Return the PCM codec associated with a sample format.
5635 * @param be endianness, 0 for little, 1 for big,
5636 * -1 (or anything else) for native
5637 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5639 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5642 * Return codec bits per sample.
5643 * Only return non-zero if the bits per sample is exactly correct, not an
5646 * @param[in] codec_id the codec
5647 * @return Number of bits per sample or zero if unknown for the given codec.
5649 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5652 * Return audio frame duration.
5654 * @param avctx codec context
5655 * @param frame_bytes size of the frame, or 0 if unknown
5656 * @return frame duration, in samples, if known. 0 if not able to
5659 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5662 * This function is the same as av_get_audio_frame_duration(), except it works
5663 * with AVCodecParameters instead of an AVCodecContext.
5665 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5668 typedef struct AVBitStreamFilterContext {
5670 const struct AVBitStreamFilter *filter;
5671 AVCodecParserContext *parser;
5672 struct AVBitStreamFilterContext *next;
5674 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5675 * Not for access by library users.
5678 } AVBitStreamFilterContext;
5681 typedef struct AVBSFInternal AVBSFInternal;
5684 * The bitstream filter state.
5686 * This struct must be allocated with av_bsf_alloc() and freed with
5689 * The fields in the struct will only be changed (by the caller or by the
5690 * filter) as described in their documentation, and are to be considered
5691 * immutable otherwise.
5693 typedef struct AVBSFContext {
5695 * A class for logging and AVOptions
5697 const AVClass *av_class;
5700 * The bitstream filter this context is an instance of.
5702 const struct AVBitStreamFilter *filter;
5705 * Opaque libavcodec internal data. Must not be touched by the caller in any
5708 AVBSFInternal *internal;
5711 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5712 * this is an AVOptions-enabled struct.
5717 * Parameters of the input stream. This field is allocated in
5718 * av_bsf_alloc(), it needs to be filled by the caller before
5721 AVCodecParameters *par_in;
5724 * Parameters of the output stream. This field is allocated in
5725 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5727 AVCodecParameters *par_out;
5730 * The timebase used for the timestamps of the input packets. Set by the
5731 * caller before av_bsf_init().
5733 AVRational time_base_in;
5736 * The timebase used for the timestamps of the output packets. Set by the
5737 * filter in av_bsf_init().
5739 AVRational time_base_out;
5742 typedef struct AVBitStreamFilter {
5746 * A list of codec ids supported by the filter, terminated by
5748 * May be NULL, in that case the bitstream filter works with any codec id.
5750 const enum AVCodecID *codec_ids;
5753 * A class for the private data, used to declare bitstream filter private
5754 * AVOptions. This field is NULL for bitstream filters that do not declare
5757 * If this field is non-NULL, the first member of the filter private data
5758 * must be a pointer to AVClass, which will be set by libavcodec generic
5759 * code to this class.
5761 const AVClass *priv_class;
5763 /*****************************************************************
5764 * No fields below this line are part of the public API. They
5765 * may not be used outside of libavcodec and can be changed and
5767 * New public fields should be added right above.
5768 *****************************************************************
5772 int (*init)(AVBSFContext *ctx);
5773 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5774 void (*close)(AVBSFContext *ctx);
5775 void (*flush)(AVBSFContext *ctx);
5776 } AVBitStreamFilter;
5780 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5781 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5783 attribute_deprecated
5784 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5786 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5787 * is deprecated. Use av_bsf_get_by_name(), av_bsf_alloc(), and av_bsf_init()
5788 * from the new bitstream filtering API (using AVBSFContext).
5790 attribute_deprecated
5791 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5793 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5794 * is deprecated. Use av_bsf_send_packet() and av_bsf_receive_packet() from the
5795 * new bitstream filtering API (using AVBSFContext).
5797 attribute_deprecated
5798 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5799 AVCodecContext *avctx, const char *args,
5800 uint8_t **poutbuf, int *poutbuf_size,
5801 const uint8_t *buf, int buf_size, int keyframe);
5803 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5804 * is deprecated. Use av_bsf_free() from the new bitstream filtering API (using
5807 attribute_deprecated
5808 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5810 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5811 * is deprecated. Use av_bsf_iterate() from the new bitstream filtering API (using
5814 attribute_deprecated
5815 const AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5819 * @return a bitstream filter with the specified name or NULL if no such
5820 * bitstream filter exists.
5822 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5825 * Iterate over all registered bitstream filters.
5827 * @param opaque a pointer where libavcodec will store the iteration state. Must
5828 * point to NULL to start the iteration.
5830 * @return the next registered bitstream filter or NULL when the iteration is
5833 const AVBitStreamFilter *av_bsf_iterate(void **opaque);
5835 attribute_deprecated
5836 const AVBitStreamFilter *av_bsf_next(void **opaque);
5840 * Allocate a context for a given bitstream filter. The caller must fill in the
5841 * context parameters as described in the documentation and then call
5842 * av_bsf_init() before sending any data to the filter.
5844 * @param filter the filter for which to allocate an instance.
5845 * @param ctx a pointer into which the pointer to the newly-allocated context
5846 * will be written. It must be freed with av_bsf_free() after the
5847 * filtering is done.
5849 * @return 0 on success, a negative AVERROR code on failure
5851 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5854 * Prepare the filter for use, after all the parameters and options have been
5857 int av_bsf_init(AVBSFContext *ctx);
5860 * Submit a packet for filtering.
5862 * After sending each packet, the filter must be completely drained by calling
5863 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5866 * @param pkt the packet to filter. The bitstream filter will take ownership of
5867 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5868 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5869 * packets will be sent). That will cause the filter to output any packets it
5870 * may have buffered internally.
5872 * @return 0 on success, a negative AVERROR on error.
5874 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5877 * Retrieve a filtered packet.
5879 * @param[out] pkt this struct will be filled with the contents of the filtered
5880 * packet. It is owned by the caller and must be freed using
5881 * av_packet_unref() when it is no longer needed.
5882 * This parameter should be "clean" (i.e. freshly allocated
5883 * with av_packet_alloc() or unreffed with av_packet_unref())
5884 * when this function is called. If this function returns
5885 * successfully, the contents of pkt will be completely
5886 * overwritten by the returned data. On failure, pkt is not
5889 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5890 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5891 * will be no further output from the filter. Another negative AVERROR value if
5894 * @note one input packet may result in several output packets, so after sending
5895 * a packet with av_bsf_send_packet(), this function needs to be called
5896 * repeatedly until it stops returning 0. It is also possible for a filter to
5897 * output fewer packets than were sent to it, so this function may return
5898 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5900 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5903 * Reset the internal bitstream filter state / flush internal buffers.
5905 void av_bsf_flush(AVBSFContext *ctx);
5908 * Free a bitstream filter context and everything associated with it; write NULL
5909 * into the supplied pointer.
5911 void av_bsf_free(AVBSFContext **ctx);
5914 * Get the AVClass for AVBSFContext. It can be used in combination with
5915 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5917 * @see av_opt_find().
5919 const AVClass *av_bsf_get_class(void);
5922 * Structure for chain/list of bitstream filters.
5923 * Empty list can be allocated by av_bsf_list_alloc().
5925 typedef struct AVBSFList AVBSFList;
5928 * Allocate empty list of bitstream filters.
5929 * The list must be later freed by av_bsf_list_free()
5930 * or finalized by av_bsf_list_finalize().
5932 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
5934 AVBSFList *av_bsf_list_alloc(void);
5937 * Free list of bitstream filters.
5939 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
5941 void av_bsf_list_free(AVBSFList **lst);
5944 * Append bitstream filter to the list of bitstream filters.
5946 * @param lst List to append to
5947 * @param bsf Filter context to be appended
5949 * @return >=0 on success, negative AVERROR in case of failure
5951 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
5954 * Construct new bitstream filter context given it's name and options
5955 * and append it to the list of bitstream filters.
5957 * @param lst List to append to
5958 * @param bsf_name Name of the bitstream filter
5959 * @param options Options for the bitstream filter, can be set to NULL
5961 * @return >=0 on success, negative AVERROR in case of failure
5963 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
5965 * Finalize list of bitstream filters.
5967 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
5968 * so the whole chain of bitstream filters can be treated as single filter
5969 * freshly allocated by av_bsf_alloc().
5970 * If the call is successful, @ref AVBSFList structure is freed and lst
5971 * will be set to NULL. In case of failure, caller is responsible for
5972 * freeing the structure by av_bsf_list_free()
5974 * @param lst Filter list structure to be transformed
5975 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
5976 * representing the chain of bitstream filters
5978 * @return >=0 on success, negative AVERROR in case of failure
5980 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
5983 * Parse string describing list of bitstream filters and create single
5984 * @ref AVBSFContext describing the whole chain of bitstream filters.
5985 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
5986 * allocated by av_bsf_alloc().
5988 * @param str String describing chain of bitstream filters in format
5989 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
5990 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
5991 * representing the chain of bitstream filters
5993 * @return >=0 on success, negative AVERROR in case of failure
5995 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
5998 * Get null/pass-through bitstream filter.
6000 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6004 int av_bsf_get_null_filter(AVBSFContext **bsf);
6009 * Same behaviour av_fast_malloc but the buffer has additional
6010 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6012 * In addition the whole buffer will initially and after resizes
6013 * be 0-initialized so that no uninitialized data will ever appear.
6015 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6018 * Same behaviour av_fast_padded_malloc except that buffer will always
6019 * be 0-initialized after call.
6021 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6024 * Encode extradata length to a buffer. Used by xiph codecs.
6026 * @param s buffer to write to; must be at least (v/255+1) bytes long
6027 * @param v size of extradata in bytes
6028 * @return number of bytes written to the buffer.
6030 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6032 #if FF_API_USER_VISIBLE_AVHWACCEL
6034 * Register the hardware accelerator hwaccel.
6036 * @deprecated This function doesn't do anything.
6038 attribute_deprecated
6039 void av_register_hwaccel(AVHWAccel *hwaccel);
6042 * If hwaccel is NULL, returns the first registered hardware accelerator,
6043 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6044 * after hwaccel, or NULL if hwaccel is the last one.
6046 * @deprecated AVHWaccel structures contain no user-serviceable parts, so
6047 * this function should not be used.
6049 attribute_deprecated
6050 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6055 * Lock operation used by lockmgr
6057 * @deprecated Deprecated together with av_lockmgr_register().
6060 AV_LOCK_CREATE, ///< Create a mutex
6061 AV_LOCK_OBTAIN, ///< Lock the mutex
6062 AV_LOCK_RELEASE, ///< Unlock the mutex
6063 AV_LOCK_DESTROY, ///< Free mutex resources
6067 * Register a user provided lock manager supporting the operations
6068 * specified by AVLockOp. The "mutex" argument to the function points
6069 * to a (void *) where the lockmgr should store/get a pointer to a user
6070 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6071 * value left by the last call for all other ops. If the lock manager is
6072 * unable to perform the op then it should leave the mutex in the same
6073 * state as when it was called and return a non-zero value. However,
6074 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6075 * have been successfully destroyed. If av_lockmgr_register succeeds
6076 * it will return a non-negative value, if it fails it will return a
6077 * negative value and destroy all mutex and unregister all callbacks.
6078 * av_lockmgr_register is not thread-safe, it must be called from a
6079 * single thread before any calls which make use of locking are used.
6081 * @param cb User defined callback. av_lockmgr_register invokes calls
6082 * to this callback and the previously registered callback.
6083 * The callback will be used to create more than one mutex
6084 * each of which must be backed by its own underlying locking
6085 * mechanism (i.e. do not use a single static object to
6086 * implement your lock manager). If cb is set to NULL the
6087 * lockmgr will be unregistered.
6089 * @deprecated This function does nothing, and always returns 0. Be sure to
6090 * build with thread support to get basic thread safety.
6092 attribute_deprecated
6093 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6097 * Get the type of the given codec.
6099 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6102 * Get the name of a codec.
6103 * @return a static string identifying the codec; never NULL
6105 const char *avcodec_get_name(enum AVCodecID id);
6108 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6109 * with no corresponding avcodec_close()), 0 otherwise.
6111 int avcodec_is_open(AVCodecContext *s);
6114 * @return a non-zero number if codec is an encoder, zero otherwise
6116 int av_codec_is_encoder(const AVCodec *codec);
6119 * @return a non-zero number if codec is a decoder, zero otherwise
6121 int av_codec_is_decoder(const AVCodec *codec);
6124 * @return descriptor for given codec ID or NULL if no descriptor exists.
6126 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6129 * Iterate over all codec descriptors known to libavcodec.
6131 * @param prev previous descriptor. NULL to get the first descriptor.
6133 * @return next descriptor or NULL after the last descriptor
6135 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6138 * @return codec descriptor with the given name or NULL if no such descriptor
6141 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6144 * Allocate a CPB properties structure and initialize its fields to default
6147 * @param size if non-NULL, the size of the allocated struct will be written
6148 * here. This is useful for embedding it in side data.
6150 * @return the newly allocated struct or NULL on failure
6152 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6158 #endif /* AVCODEC_AVCODEC_H */