2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/log.h"
40 #include "libavutil/pixfmt.h"
41 #include "libavutil/rational.h"
46 * @defgroup libavc libavcodec
47 * Encoding/Decoding Library
51 * @defgroup lavc_decoding Decoding
55 * @defgroup lavc_encoding Encoding
59 * @defgroup lavc_codec Codecs
61 * @defgroup lavc_codec_native Native Codecs
64 * @defgroup lavc_codec_wrappers External library wrappers
67 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
71 * @defgroup lavc_internal Internal
79 * @defgroup lavc_encdec send/receive encoding and decoding API overview
82 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
83 * avcodec_receive_packet() functions provide an encode/decode API, which
84 * decouples input and output.
86 * The API is very similar for encoding/decoding and audio/video, and works as
88 * - Set up and open the AVCodecContext as usual.
90 * - For decoding, call avcodec_send_packet() to give the decoder raw
91 * compressed data in an AVPacket.
92 * - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
93 * containing uncompressed audio or video.
94 * In both cases, it is recommended that AVPackets and AVFrames are
95 * refcounted, or libavcodec might have to copy the input data. (libavformat
96 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
97 * refcounted AVFrames.)
98 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
99 * functions and process their output:
100 * - For decoding, call avcodec_receive_frame(). On success, it will return
101 * an AVFrame containing uncompressed audio or video data.
102 * - For encoding, call avcodec_receive_packet(). On success, it will return
103 * an AVPacket with a compressed frame.
104 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
105 * AVERROR(EAGAIN) return value means that new input data is required to
106 * return new output. In this case, continue with sending input. For each
107 * input frame/packet, the codec will typically return 1 output frame/packet,
108 * but it can also be 0 or more than 1.
110 * At the beginning of decoding or encoding, the codec might accept multiple
111 * input frames/packets without returning a frame, until its internal buffers
112 * are filled. This situation is handled transparently if you follow the steps
115 * In theory, sending input can result in EAGAIN - this should happen only if
116 * not all output was received. You can use this to structure alternative decode
117 * or encode loops other than the one suggested above. For example, you could
118 * try sending new input on each iteration, and try to receive output if that
121 * End of stream situations. These require "flushing" (aka draining) the codec,
122 * as the codec might buffer multiple frames or packets internally for
123 * performance or out of necessity (consider B-frames).
124 * This is handled as follows:
125 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
126 * or avcodec_send_frame() (encoding) functions. This will enter draining
128 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
129 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
130 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
131 * - Before decoding can be resumed again, the codec has to be reset with
132 * avcodec_flush_buffers().
134 * Using the API as outlined above is highly recommended. But it is also
135 * possible to call functions outside of this rigid schema. For example, you can
136 * call avcodec_send_packet() repeatedly without calling
137 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
138 * until the codec's internal buffer has been filled up (which is typically of
139 * size 1 per output frame, after initial input), and then reject input with
140 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
141 * read at least some output.
143 * Not all codecs will follow a rigid and predictable dataflow; the only
144 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
145 * one end implies that a receive/send call on the other end will succeed, or
146 * at least will not fail with AVERROR(EAGAIN). In general, no codec will
147 * permit unlimited buffering of input or output.
149 * This API replaces the following legacy functions:
150 * - avcodec_decode_video2() and avcodec_decode_audio4():
151 * Use avcodec_send_packet() to feed input to the decoder, then use
152 * avcodec_receive_frame() to receive decoded frames after each packet.
153 * Unlike with the old video decoding API, multiple frames might result from
154 * a packet. For audio, splitting the input packet into frames by partially
155 * decoding packets becomes transparent to the API user. You never need to
156 * feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
157 * no data was read from the packet).
158 * Additionally, sending a flush/draining packet is required only once.
159 * - avcodec_encode_video2()/avcodec_encode_audio2():
160 * Use avcodec_send_frame() to feed input to the encoder, then use
161 * avcodec_receive_packet() to receive encoded packets.
162 * Providing user-allocated buffers for avcodec_receive_packet() is not
164 * - The new API does not handle subtitles yet.
166 * Mixing new and old function calls on the same AVCodecContext is not allowed,
167 * and will result in undefined behavior.
169 * Some codecs might require using the new API; using the old API will return
170 * an error when calling it. All codecs support the new API.
172 * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
173 * would be an invalid state, which could put the codec user into an endless
174 * loop. The API has no concept of time either: it cannot happen that trying to
175 * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
176 * later accepts the packet (with no other receive/flush API calls involved).
177 * The API is a strict state machine, and the passage of time is not supposed
178 * to influence it. Some timing-dependent behavior might still be deemed
179 * acceptable in certain cases. But it must never result in both send/receive
180 * returning EAGAIN at the same time at any point. It must also absolutely be
181 * avoided that the current state is "unstable" and can "flip-flop" between
182 * the send/receive APIs allowing progress. For example, it's not allowed that
183 * the codec randomly decides that it actually wants to consume a packet now
184 * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
185 * avcodec_send_packet() call.
190 * @defgroup lavc_core Core functions/structures.
193 * Basic definitions, functions for querying libavcodec capabilities,
194 * allocating core structures, etc.
200 * Identify the syntax and semantics of the bitstream.
201 * The principle is roughly:
202 * Two decoders with the same ID can decode the same streams.
203 * Two encoders with the same ID can encode compatible streams.
204 * There may be slight deviations from the principle due to implementation
207 * If you add a codec ID to this list, add it so that
208 * 1. no value of an existing codec ID changes (that would break ABI),
209 * 2. it is as close as possible to similar codecs
211 * After adding new codec IDs, do not forget to add an entry to the codec
212 * descriptor list and bump libavcodec minor version.
218 AV_CODEC_ID_MPEG1VIDEO,
219 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
221 AV_CODEC_ID_MPEG2VIDEO_XVMC,
222 #endif /* FF_API_XVMC */
233 AV_CODEC_ID_RAWVIDEO,
234 AV_CODEC_ID_MSMPEG4V1,
235 AV_CODEC_ID_MSMPEG4V2,
236 AV_CODEC_ID_MSMPEG4V3,
259 AV_CODEC_ID_INTERPLAY_VIDEO,
266 AV_CODEC_ID_MSVIDEO1,
271 AV_CODEC_ID_TRUEMOTION1,
272 AV_CODEC_ID_VMDVIDEO,
297 AV_CODEC_ID_TRUEMOTION2,
303 AV_CODEC_ID_SMACKVIDEO,
308 AV_CODEC_ID_JPEG2000,
314 AV_CODEC_ID_DSICINVIDEO,
315 AV_CODEC_ID_TIERTEXSEQVIDEO,
323 AV_CODEC_ID_BETHSOFTVID,
335 AV_CODEC_ID_ESCAPE124,
339 AV_CODEC_ID_MOTIONPIXELS,
351 AV_CODEC_ID_FLASHSV2,
352 AV_CODEC_ID_CDGRAPHICS,
355 AV_CODEC_ID_BINKVIDEO,
356 AV_CODEC_ID_IFF_ILBM,
357 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
363 AV_CODEC_ID_A64_MULTI,
364 AV_CODEC_ID_A64_MULTI5,
367 AV_CODEC_ID_LAGARITH,
371 AV_CODEC_ID_WMV3IMAGE,
372 AV_CODEC_ID_VC1IMAGE,
374 AV_CODEC_ID_BMV_VIDEO,
381 AV_CODEC_ID_ZEROCODEC,
390 AV_CODEC_ID_ESCAPE130,
393 AV_CODEC_ID_HNM4_VIDEO,
395 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
397 AV_CODEC_ID_ALIAS_PIX,
398 AV_CODEC_ID_BRENDER_PIX,
399 AV_CODEC_ID_PAF_VIDEO,
412 AV_CODEC_ID_SCREENPRESSO,
415 AV_CODEC_ID_Y41P = 0x8000,
420 AV_CODEC_ID_TARGA_Y216,
432 AV_CODEC_ID_TRUEMOTION2RT,
434 AV_CODEC_ID_MAGICYUV,
435 AV_CODEC_ID_SHEERVIDEO,
442 AV_CODEC_ID_CLEARVIDEO,
445 AV_CODEC_ID_BITPACKED,
452 /* various PCM "codecs" */
453 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
454 AV_CODEC_ID_PCM_S16LE = 0x10000,
455 AV_CODEC_ID_PCM_S16BE,
456 AV_CODEC_ID_PCM_U16LE,
457 AV_CODEC_ID_PCM_U16BE,
460 AV_CODEC_ID_PCM_MULAW,
461 AV_CODEC_ID_PCM_ALAW,
462 AV_CODEC_ID_PCM_S32LE,
463 AV_CODEC_ID_PCM_S32BE,
464 AV_CODEC_ID_PCM_U32LE,
465 AV_CODEC_ID_PCM_U32BE,
466 AV_CODEC_ID_PCM_S24LE,
467 AV_CODEC_ID_PCM_S24BE,
468 AV_CODEC_ID_PCM_U24LE,
469 AV_CODEC_ID_PCM_U24BE,
470 AV_CODEC_ID_PCM_S24DAUD,
471 AV_CODEC_ID_PCM_ZORK,
472 AV_CODEC_ID_PCM_S16LE_PLANAR,
474 AV_CODEC_ID_PCM_F32BE,
475 AV_CODEC_ID_PCM_F32LE,
476 AV_CODEC_ID_PCM_F64BE,
477 AV_CODEC_ID_PCM_F64LE,
478 AV_CODEC_ID_PCM_BLURAY,
481 AV_CODEC_ID_PCM_S8_PLANAR,
482 AV_CODEC_ID_PCM_S24LE_PLANAR,
483 AV_CODEC_ID_PCM_S32LE_PLANAR,
484 AV_CODEC_ID_PCM_S16BE_PLANAR,
486 AV_CODEC_ID_PCM_S64LE = 0x10800,
487 AV_CODEC_ID_PCM_S64BE,
488 AV_CODEC_ID_PCM_F16LE,
489 AV_CODEC_ID_PCM_F24LE,
491 /* various ADPCM codecs */
492 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
493 AV_CODEC_ID_ADPCM_IMA_WAV,
494 AV_CODEC_ID_ADPCM_IMA_DK3,
495 AV_CODEC_ID_ADPCM_IMA_DK4,
496 AV_CODEC_ID_ADPCM_IMA_WS,
497 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
498 AV_CODEC_ID_ADPCM_MS,
499 AV_CODEC_ID_ADPCM_4XM,
500 AV_CODEC_ID_ADPCM_XA,
501 AV_CODEC_ID_ADPCM_ADX,
502 AV_CODEC_ID_ADPCM_EA,
503 AV_CODEC_ID_ADPCM_G726,
504 AV_CODEC_ID_ADPCM_CT,
505 AV_CODEC_ID_ADPCM_SWF,
506 AV_CODEC_ID_ADPCM_YAMAHA,
507 AV_CODEC_ID_ADPCM_SBPRO_4,
508 AV_CODEC_ID_ADPCM_SBPRO_3,
509 AV_CODEC_ID_ADPCM_SBPRO_2,
510 AV_CODEC_ID_ADPCM_THP,
511 AV_CODEC_ID_ADPCM_IMA_AMV,
512 AV_CODEC_ID_ADPCM_EA_R1,
513 AV_CODEC_ID_ADPCM_EA_R3,
514 AV_CODEC_ID_ADPCM_EA_R2,
515 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
516 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
517 AV_CODEC_ID_ADPCM_EA_XAS,
518 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
519 AV_CODEC_ID_ADPCM_IMA_ISS,
520 AV_CODEC_ID_ADPCM_G722,
521 AV_CODEC_ID_ADPCM_IMA_APC,
522 AV_CODEC_ID_ADPCM_VIMA,
524 AV_CODEC_ID_ADPCM_AFC = 0x11800,
525 AV_CODEC_ID_ADPCM_IMA_OKI,
526 AV_CODEC_ID_ADPCM_DTK,
527 AV_CODEC_ID_ADPCM_IMA_RAD,
528 AV_CODEC_ID_ADPCM_G726LE,
529 AV_CODEC_ID_ADPCM_THP_LE,
530 AV_CODEC_ID_ADPCM_PSX,
531 AV_CODEC_ID_ADPCM_AICA,
532 AV_CODEC_ID_ADPCM_IMA_DAT4,
533 AV_CODEC_ID_ADPCM_MTAF,
536 AV_CODEC_ID_AMR_NB = 0x12000,
539 /* RealAudio codecs*/
540 AV_CODEC_ID_RA_144 = 0x13000,
543 /* various DPCM codecs */
544 AV_CODEC_ID_ROQ_DPCM = 0x14000,
545 AV_CODEC_ID_INTERPLAY_DPCM,
546 AV_CODEC_ID_XAN_DPCM,
547 AV_CODEC_ID_SOL_DPCM,
549 AV_CODEC_ID_SDX2_DPCM = 0x14800,
550 AV_CODEC_ID_GREMLIN_DPCM,
553 AV_CODEC_ID_MP2 = 0x15000,
554 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
564 AV_CODEC_ID_VMDAUDIO,
570 AV_CODEC_ID_WESTWOOD_SND1,
571 AV_CODEC_ID_GSM, ///< as in Berlin toast format
574 AV_CODEC_ID_TRUESPEECH,
576 AV_CODEC_ID_SMACKAUDIO,
579 AV_CODEC_ID_DSICINAUDIO,
581 AV_CODEC_ID_MUSEPACK7,
583 AV_CODEC_ID_GSM_MS, /* as found in WAV */
586 AV_CODEC_ID_NELLYMOSER,
587 AV_CODEC_ID_MUSEPACK8,
589 AV_CODEC_ID_WMAVOICE,
591 AV_CODEC_ID_WMALOSSLESS,
600 AV_CODEC_ID_BINKAUDIO_RDFT,
601 AV_CODEC_ID_BINKAUDIO_DCT,
602 AV_CODEC_ID_AAC_LATM,
607 AV_CODEC_ID_8SVX_EXP,
608 AV_CODEC_ID_8SVX_FIB,
609 AV_CODEC_ID_BMV_AUDIO,
614 AV_CODEC_ID_COMFORT_NOISE,
616 AV_CODEC_ID_METASOUND,
617 AV_CODEC_ID_PAF_AUDIO,
621 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
623 AV_CODEC_ID_SONIC_LS,
626 AV_CODEC_ID_DSD_LSBF,
627 AV_CODEC_ID_DSD_MSBF,
628 AV_CODEC_ID_DSD_LSBF_PLANAR,
629 AV_CODEC_ID_DSD_MSBF_PLANAR,
631 AV_CODEC_ID_INTERPLAY_ACM,
635 AV_CODEC_ID_ATRAC3AL,
636 AV_CODEC_ID_ATRAC3PAL,
639 /* subtitle codecs */
640 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
641 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
642 AV_CODEC_ID_DVB_SUBTITLE,
643 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
646 AV_CODEC_ID_MOV_TEXT,
647 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
648 AV_CODEC_ID_DVB_TELETEXT,
651 AV_CODEC_ID_MICRODVD = 0x17800,
655 AV_CODEC_ID_REALTEXT,
657 AV_CODEC_ID_SUBVIEWER1,
658 AV_CODEC_ID_SUBVIEWER,
665 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
667 /* other specific kind of codecs (generally used for attachments) */
668 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
669 AV_CODEC_ID_TTF = 0x18000,
671 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
672 AV_CODEC_ID_BINTEXT = 0x18800,
676 AV_CODEC_ID_SMPTE_KLV,
678 AV_CODEC_ID_TIMED_ID3,
679 AV_CODEC_ID_BIN_DATA,
682 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
684 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
685 * stream (only used by libavformat) */
686 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
687 * stream (only used by libavformat) */
688 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
689 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
693 * This struct describes the properties of a single codec described by an
695 * @see avcodec_descriptor_get()
697 typedef struct AVCodecDescriptor {
699 enum AVMediaType type;
701 * Name of the codec described by this descriptor. It is non-empty and
702 * unique for each codec descriptor. It should contain alphanumeric
703 * characters and '_' only.
707 * A more descriptive name for this codec. May be NULL.
709 const char *long_name;
711 * Codec properties, a combination of AV_CODEC_PROP_* flags.
715 * MIME type(s) associated with the codec.
716 * May be NULL; if not, a NULL-terminated array of MIME types.
717 * The first item is always non-NULL and is the preferred MIME type.
719 const char *const *mime_types;
721 * If non-NULL, an array of profiles recognized for this codec.
722 * Terminated with FF_PROFILE_UNKNOWN.
724 const struct AVProfile *profiles;
728 * Codec uses only intra compression.
729 * Video and audio codecs only.
731 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
733 * Codec supports lossy compression. Audio and video codecs only.
734 * @note a codec may support both lossy and lossless
737 #define AV_CODEC_PROP_LOSSY (1 << 1)
739 * Codec supports lossless compression. Audio and video codecs only.
741 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
743 * Codec supports frame reordering. That is, the coded order (the order in which
744 * the encoded packets are output by the encoders / stored / input to the
745 * decoders) may be different from the presentation order of the corresponding
748 * For codecs that do not have this property set, PTS and DTS should always be
751 #define AV_CODEC_PROP_REORDER (1 << 3)
753 * Subtitle codec is bitmap based
754 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
756 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
758 * Subtitle codec is text based.
759 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
761 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
764 * @ingroup lavc_decoding
765 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
766 * This is mainly needed because some optimized bitstream readers read
767 * 32 or 64 bit at once and could read over the end.<br>
768 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
769 * MPEG bitstreams could cause overread and segfault.
771 #define AV_INPUT_BUFFER_PADDING_SIZE 32
774 * @ingroup lavc_encoding
775 * minimum encoding buffer size
776 * Used to avoid some checks during header writing.
778 #define AV_INPUT_BUFFER_MIN_SIZE 16384
780 #if FF_API_WITHOUT_PREFIX
782 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
784 #define FF_INPUT_BUFFER_PADDING_SIZE 32
787 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
789 #define FF_MIN_BUFFER_SIZE 16384
790 #endif /* FF_API_WITHOUT_PREFIX */
793 * @ingroup lavc_encoding
794 * motion estimation type.
795 * @deprecated use codec private option instead
797 #if FF_API_MOTION_EST
799 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
803 ME_EPZS, ///< enhanced predictive zonal search
804 ME_X1, ///< reserved for experiments
805 ME_HEX, ///< hexagon based search
806 ME_UMH, ///< uneven multi-hexagon search
807 ME_TESA, ///< transformed exhaustive search algorithm
808 ME_ITER=50, ///< iterative search
813 * @ingroup lavc_decoding
816 /* We leave some space between them for extensions (drop some
817 * keyframes for intra-only or drop just some bidir frames). */
818 AVDISCARD_NONE =-16, ///< discard nothing
819 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
820 AVDISCARD_NONREF = 8, ///< discard all non reference
821 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
822 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
823 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
824 AVDISCARD_ALL = 48, ///< discard all
827 enum AVAudioServiceType {
828 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
829 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
830 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
831 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
832 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
833 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
834 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
835 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
836 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
837 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
841 * @ingroup lavc_encoding
843 typedef struct RcOverride{
846 int qscale; // If this is 0 then quality_factor will be used instead.
847 float quality_factor;
850 #if FF_API_MAX_BFRAMES
852 * @deprecated there is no libavcodec-wide limit on the number of B-frames
854 #define FF_MAX_B_FRAMES 16
858 These flags can be passed in AVCodecContext.flags before initialization.
859 Note: Not everything is supported yet.
863 * Allow decoders to produce frames with data planes that are not aligned
864 * to CPU requirements (e.g. due to cropping).
866 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
870 #define AV_CODEC_FLAG_QSCALE (1 << 1)
872 * 4 MV per MB allowed / advanced prediction for H.263.
874 #define AV_CODEC_FLAG_4MV (1 << 2)
876 * Output even those frames that might be corrupted.
878 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
882 #define AV_CODEC_FLAG_QPEL (1 << 4)
884 * Use internal 2pass ratecontrol in first pass mode.
886 #define AV_CODEC_FLAG_PASS1 (1 << 9)
888 * Use internal 2pass ratecontrol in second pass mode.
890 #define AV_CODEC_FLAG_PASS2 (1 << 10)
894 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
896 * Only decode/encode grayscale.
898 #define AV_CODEC_FLAG_GRAY (1 << 13)
900 * error[?] variables will be set during encoding.
902 #define AV_CODEC_FLAG_PSNR (1 << 15)
904 * Input bitstream might be truncated at a random location
905 * instead of only at frame boundaries.
907 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
909 * Use interlaced DCT.
911 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
915 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
917 * Place global headers in extradata instead of every keyframe.
919 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
921 * Use only bitexact stuff (except (I)DCT).
923 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
924 /* Fx : Flag for H.263+ extra options */
926 * H.263 advanced intra coding / MPEG-4 AC prediction
928 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
930 * interlaced motion estimation
932 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
933 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
936 * Allow non spec compliant speedup tricks.
938 #define AV_CODEC_FLAG2_FAST (1 << 0)
940 * Skip bitstream encoding.
942 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
944 * Place global headers at every keyframe instead of in extradata.
946 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
949 * timecode is in drop frame format. DEPRECATED!!!!
951 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
954 * Input bitstream might be truncated at a packet boundaries
955 * instead of only at frame boundaries.
957 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
959 * Discard cropping information from SPS.
961 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
964 * Show all frames before the first keyframe
966 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
968 * Export motion vectors through frame side data
970 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
972 * Do not skip samples and export skip information as frame side data
974 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
976 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
978 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
980 /* Unsupported options :
981 * Syntax Arithmetic coding (SAC)
982 * Reference Picture Selection
983 * Independent Segment Decoding */
985 /* codec capabilities */
988 * Decoder can use draw_horiz_band callback.
990 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
992 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
993 * If not set, it might not use get_buffer() at all or use operations that
994 * assume the buffer was allocated by avcodec_default_get_buffer.
996 #define AV_CODEC_CAP_DR1 (1 << 1)
997 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
999 * Encoder or decoder requires flushing with NULL input at the end in order to
1000 * give the complete and correct output.
1002 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1003 * with NULL data. The user can still send NULL data to the public encode
1004 * or decode function, but libavcodec will not pass it along to the codec
1005 * unless this flag is set.
1008 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1009 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1013 * The encoder needs to be fed with NULL data at the end of encoding until the
1014 * encoder no longer returns data.
1016 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1017 * flag also means that the encoder must set the pts and duration for
1018 * each output packet. If this flag is not set, the pts and duration will
1019 * be determined by libavcodec from the input frame.
1021 #define AV_CODEC_CAP_DELAY (1 << 5)
1023 * Codec can be fed a final frame with a smaller size.
1024 * This can be used to prevent truncation of the last audio samples.
1026 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1029 * Codec can output multiple frames per AVPacket
1030 * Normally demuxers return one frame at a time, demuxers which do not do
1031 * are connected to a parser to split what they return into proper frames.
1032 * This flag is reserved to the very rare category of codecs which have a
1033 * bitstream that cannot be split into frames without timeconsuming
1034 * operations like full decoding. Demuxers carrying such bitstreams thus
1035 * may return multiple frames in a packet. This has many disadvantages like
1036 * prohibiting stream copy in many cases thus it should only be considered
1039 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1041 * Codec is experimental and is thus avoided in favor of non experimental
1044 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1046 * Codec should fill in channel configuration and samplerate instead of container
1048 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1050 * Codec supports frame-level multithreading.
1052 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1054 * Codec supports slice-based (or partition-based) multithreading.
1056 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1058 * Codec supports changed parameters at any point.
1060 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1062 * Codec supports avctx->thread_count == 0 (auto).
1064 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1066 * Audio encoder supports receiving a different number of samples in each call.
1068 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1070 * Decoder is not a preferred choice for probing.
1071 * This indicates that the decoder is not a good choice for probing.
1072 * It could for example be an expensive to spin up hardware decoder,
1073 * or it could simply not provide a lot of useful information about
1075 * A decoder marked with this flag should only be used as last resort
1076 * choice for probing.
1078 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1080 * Codec is intra only.
1082 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1084 * Codec is lossless.
1086 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1089 #if FF_API_WITHOUT_PREFIX
1091 * Allow decoders to produce frames with data planes that are not aligned
1092 * to CPU requirements (e.g. due to cropping).
1094 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1095 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1096 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1097 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1098 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1101 * @deprecated use the "gmc" private option of the libxvid encoder
1103 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1107 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1108 * mpegvideo encoders
1110 #define CODEC_FLAG_MV0 0x0040
1112 #if FF_API_INPUT_PRESERVED
1114 * @deprecated passing reference-counted frames to the encoders replaces this
1117 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1119 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1120 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1121 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1124 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1127 #define CODEC_FLAG_EMU_EDGE 0x4000
1129 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1130 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1132 #if FF_API_NORMALIZE_AQP
1134 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1135 * mpegvideo encoders
1137 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1139 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1140 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1141 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1142 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1143 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1144 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1145 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1146 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1147 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1148 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1149 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1150 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1151 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1153 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1154 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1155 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1156 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1158 /* Unsupported options :
1159 * Syntax Arithmetic coding (SAC)
1160 * Reference Picture Selection
1161 * Independent Segment Decoding */
1163 /* codec capabilities */
1165 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1167 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1168 * If not set, it might not use get_buffer() at all or use operations that
1169 * assume the buffer was allocated by avcodec_default_get_buffer.
1171 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1172 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1174 /* Codec can export data for HW decoding. This flag indicates that
1175 * the codec would call get_format() with list that might contain HW accelerated
1176 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1177 * including raw image format.
1178 * The application can use the passed context to determine bitstream version,
1179 * chroma format, resolution etc.
1181 #define CODEC_CAP_HWACCEL 0x0010
1182 #endif /* FF_API_XVMC */
1184 * Encoder or decoder requires flushing with NULL input at the end in order to
1185 * give the complete and correct output.
1187 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1188 * with NULL data. The user can still send NULL data to the public encode
1189 * or decode function, but libavcodec will not pass it along to the codec
1190 * unless this flag is set.
1193 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1194 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1198 * The encoder needs to be fed with NULL data at the end of encoding until the
1199 * encoder no longer returns data.
1201 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1202 * flag also means that the encoder must set the pts and duration for
1203 * each output packet. If this flag is not set, the pts and duration will
1204 * be determined by libavcodec from the input frame.
1206 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1208 * Codec can be fed a final frame with a smaller size.
1209 * This can be used to prevent truncation of the last audio samples.
1211 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1214 * Codec can output multiple frames per AVPacket
1215 * Normally demuxers return one frame at a time, demuxers which do not do
1216 * are connected to a parser to split what they return into proper frames.
1217 * This flag is reserved to the very rare category of codecs which have a
1218 * bitstream that cannot be split into frames without timeconsuming
1219 * operations like full decoding. Demuxers carrying such bitstreams thus
1220 * may return multiple frames in a packet. This has many disadvantages like
1221 * prohibiting stream copy in many cases thus it should only be considered
1224 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1226 * Codec is experimental and is thus avoided in favor of non experimental
1229 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1231 * Codec should fill in channel configuration and samplerate instead of container
1233 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1234 #if FF_API_NEG_LINESIZES
1236 * @deprecated no codecs use this capability
1238 #define CODEC_CAP_NEG_LINESIZES 0x0800
1241 * Codec supports frame-level multithreading.
1243 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1245 * Codec supports slice-based (or partition-based) multithreading.
1247 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1249 * Codec supports changed parameters at any point.
1251 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1253 * Codec supports avctx->thread_count == 0 (auto).
1255 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1257 * Audio encoder supports receiving a different number of samples in each call.
1259 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1261 * Codec is intra only.
1263 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1265 * Codec is lossless.
1267 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1270 * HWAccel is experimental and is thus avoided in favor of non experimental
1273 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1274 #endif /* FF_API_WITHOUT_PREFIX */
1277 //The following defines may change, don't expect compatibility if you use them.
1278 #define MB_TYPE_INTRA4x4 0x0001
1279 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1280 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1281 #define MB_TYPE_16x16 0x0008
1282 #define MB_TYPE_16x8 0x0010
1283 #define MB_TYPE_8x16 0x0020
1284 #define MB_TYPE_8x8 0x0040
1285 #define MB_TYPE_INTERLACED 0x0080
1286 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1287 #define MB_TYPE_ACPRED 0x0200
1288 #define MB_TYPE_GMC 0x0400
1289 #define MB_TYPE_SKIP 0x0800
1290 #define MB_TYPE_P0L0 0x1000
1291 #define MB_TYPE_P1L0 0x2000
1292 #define MB_TYPE_P0L1 0x4000
1293 #define MB_TYPE_P1L1 0x8000
1294 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1295 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1296 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1297 #define MB_TYPE_QUANT 0x00010000
1298 #define MB_TYPE_CBP 0x00020000
1299 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1304 * This specifies the area which should be displayed.
1305 * Note there may be multiple such areas for one frame.
1307 typedef struct AVPanScan{
1310 * - encoding: Set by user.
1311 * - decoding: Set by libavcodec.
1316 * width and height in 1/16 pel
1317 * - encoding: Set by user.
1318 * - decoding: Set by libavcodec.
1324 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1325 * - encoding: Set by user.
1326 * - decoding: Set by libavcodec.
1328 int16_t position[3][2];
1332 * This structure describes the bitrate properties of an encoded bitstream. It
1333 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1334 * parameters for H.264/HEVC.
1336 typedef struct AVCPBProperties {
1338 * Maximum bitrate of the stream, in bits per second.
1339 * Zero if unknown or unspecified.
1343 * Minimum bitrate of the stream, in bits per second.
1344 * Zero if unknown or unspecified.
1348 * Average bitrate of the stream, in bits per second.
1349 * Zero if unknown or unspecified.
1354 * The size of the buffer to which the ratecontrol is applied, in bits.
1355 * Zero if unknown or unspecified.
1360 * The delay between the time the packet this structure is associated with
1361 * is received and the time when it should be decoded, in periods of a 27MHz
1364 * UINT64_MAX when unknown or unspecified.
1369 #if FF_API_QSCALE_TYPE
1370 #define FF_QSCALE_TYPE_MPEG1 0
1371 #define FF_QSCALE_TYPE_MPEG2 1
1372 #define FF_QSCALE_TYPE_H264 2
1373 #define FF_QSCALE_TYPE_VP56 3
1377 * The decoder will keep a reference to the frame and may reuse it later.
1379 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1382 * @defgroup lavc_packet AVPacket
1384 * Types and functions for working with AVPacket.
1387 enum AVPacketSideDataType {
1389 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1390 * bytes worth of palette. This side data signals that a new palette is
1393 AV_PKT_DATA_PALETTE,
1396 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1397 * that the extradata buffer was changed and the receiving side should
1398 * act upon it appropriately. The new extradata is embedded in the side
1399 * data buffer and should be immediately used for processing the current
1402 AV_PKT_DATA_NEW_EXTRADATA,
1405 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1408 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1409 * s32le channel_count
1410 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1411 * u64le channel_layout
1412 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1414 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1419 AV_PKT_DATA_PARAM_CHANGE,
1422 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1423 * structures with info about macroblocks relevant to splitting the
1424 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1425 * That is, it does not necessarily contain info about all macroblocks,
1426 * as long as the distance between macroblocks in the info is smaller
1427 * than the target payload size.
1428 * Each MB info structure is 12 bytes, and is laid out as follows:
1430 * u32le bit offset from the start of the packet
1431 * u8 current quantizer at the start of the macroblock
1433 * u16le macroblock address within the GOB
1434 * u8 horizontal MV predictor
1435 * u8 vertical MV predictor
1436 * u8 horizontal MV predictor for block number 3
1437 * u8 vertical MV predictor for block number 3
1440 AV_PKT_DATA_H263_MB_INFO,
1443 * This side data should be associated with an audio stream and contains
1444 * ReplayGain information in form of the AVReplayGain struct.
1446 AV_PKT_DATA_REPLAYGAIN,
1449 * This side data contains a 3x3 transformation matrix describing an affine
1450 * transformation that needs to be applied to the decoded video frames for
1451 * correct presentation.
1453 * See libavutil/display.h for a detailed description of the data.
1455 AV_PKT_DATA_DISPLAYMATRIX,
1458 * This side data should be associated with a video stream and contains
1459 * Stereoscopic 3D information in form of the AVStereo3D struct.
1461 AV_PKT_DATA_STEREO3D,
1464 * This side data should be associated with an audio stream and corresponds
1465 * to enum AVAudioServiceType.
1467 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1470 * This side data contains quality related information from the encoder.
1472 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1476 * u64le[error count] sum of squared differences between encoder in and output
1479 AV_PKT_DATA_QUALITY_STATS,
1482 * This side data contains an integer value representing the stream index
1483 * of a "fallback" track. A fallback track indicates an alternate
1484 * track to use when the current track can not be decoded for some reason.
1485 * e.g. no decoder available for codec.
1487 AV_PKT_DATA_FALLBACK_TRACK,
1490 * This side data corresponds to the AVCPBProperties struct.
1492 AV_PKT_DATA_CPB_PROPERTIES,
1495 * Recommmends skipping the specified number of samples
1497 * u32le number of samples to skip from start of this packet
1498 * u32le number of samples to skip from end of this packet
1499 * u8 reason for start skip
1500 * u8 reason for end skip (0=padding silence, 1=convergence)
1503 AV_PKT_DATA_SKIP_SAMPLES=70,
1506 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1507 * the packet may contain "dual mono" audio specific to Japanese DTV
1508 * and if it is true, recommends only the selected channel to be used.
1510 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1513 AV_PKT_DATA_JP_DUALMONO,
1516 * A list of zero terminated key/value strings. There is no end marker for
1517 * the list, so it is required to rely on the side data size to stop.
1519 AV_PKT_DATA_STRINGS_METADATA,
1522 * Subtitle event position
1530 AV_PKT_DATA_SUBTITLE_POSITION,
1533 * Data found in BlockAdditional element of matroska container. There is
1534 * no end marker for the data, so it is required to rely on the side data
1535 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1538 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1541 * The optional first identifier line of a WebVTT cue.
1543 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1546 * The optional settings (rendering instructions) that immediately
1547 * follow the timestamp specifier of a WebVTT cue.
1549 AV_PKT_DATA_WEBVTT_SETTINGS,
1552 * A list of zero terminated key/value strings. There is no end marker for
1553 * the list, so it is required to rely on the side data size to stop. This
1554 * side data includes updated metadata which appeared in the stream.
1556 AV_PKT_DATA_METADATA_UPDATE,
1559 * MPEGTS stream ID, this is required to pass the stream ID
1560 * information from the demuxer to the corresponding muxer.
1562 AV_PKT_DATA_MPEGTS_STREAM_ID,
1565 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1566 * should be associated with a video stream and contains data in the form
1567 * of the AVMasteringDisplayMetadata struct.
1569 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1572 * This side data should be associated with a video stream and corresponds
1573 * to the AVSphericalMapping structure.
1575 AV_PKT_DATA_SPHERICAL,
1578 * Content light level (based on CTA-861.3). This metadata should be
1579 * associated with a video stream and contains data in the form of the
1580 * AVContentLightMetadata struct.
1582 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1585 * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1586 * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1587 * The number of bytes of CC data is AVPacketSideData.size.
1592 * The number of side data elements (in fact a bit more than it).
1593 * This is not part of the public API/ABI in the sense that it may
1594 * change when new side data types are added.
1595 * This must stay the last enum value.
1596 * If its value becomes huge, some code using it
1597 * needs to be updated as it assumes it to be smaller than other limits.
1602 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1604 typedef struct AVPacketSideData {
1607 enum AVPacketSideDataType type;
1611 * This structure stores compressed data. It is typically exported by demuxers
1612 * and then passed as input to decoders, or received as output from encoders and
1613 * then passed to muxers.
1615 * For video, it should typically contain one compressed frame. For audio it may
1616 * contain several compressed frames. Encoders are allowed to output empty
1617 * packets, with no compressed data, containing only side data
1618 * (e.g. to update some stream parameters at the end of encoding).
1620 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1621 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1622 * without libavcodec and libavformat major bump.
1624 * The semantics of data ownership depends on the buf field.
1625 * If it is set, the packet data is dynamically allocated and is
1626 * valid indefinitely until a call to av_packet_unref() reduces the
1627 * reference count to 0.
1629 * If the buf field is not set av_packet_ref() would make a copy instead
1630 * of increasing the reference count.
1632 * The side data is always allocated with av_malloc(), copied by
1633 * av_packet_ref() and freed by av_packet_unref().
1635 * @see av_packet_ref
1636 * @see av_packet_unref
1638 typedef struct AVPacket {
1640 * A reference to the reference-counted buffer where the packet data is
1642 * May be NULL, then the packet data is not reference-counted.
1646 * Presentation timestamp in AVStream->time_base units; the time at which
1647 * the decompressed packet will be presented to the user.
1648 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1649 * pts MUST be larger or equal to dts as presentation cannot happen before
1650 * decompression, unless one wants to view hex dumps. Some formats misuse
1651 * the terms dts and pts/cts to mean something different. Such timestamps
1652 * must be converted to true pts/dts before they are stored in AVPacket.
1656 * Decompression timestamp in AVStream->time_base units; the time at which
1657 * the packet is decompressed.
1658 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1665 * A combination of AV_PKT_FLAG values
1669 * Additional packet data that can be provided by the container.
1670 * Packet can contain several types of side information.
1672 AVPacketSideData *side_data;
1673 int side_data_elems;
1676 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1677 * Equals next_pts - this_pts in presentation order.
1681 int64_t pos; ///< byte position in stream, -1 if unknown
1683 #if FF_API_CONVERGENCE_DURATION
1685 * @deprecated Same as the duration field, but as int64_t. This was required
1686 * for Matroska subtitles, whose duration values could overflow when the
1687 * duration field was still an int.
1689 attribute_deprecated
1690 int64_t convergence_duration;
1693 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1694 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1696 * Flag is used to discard packets which are required to maintain valid
1697 * decoder state but are not required for output and should be dropped
1700 #define AV_PKT_FLAG_DISCARD 0x0004
1702 * The packet comes from a trusted source.
1704 * Otherwise-unsafe constructs such as arbitrary pointers to data
1705 * outside the packet may be followed.
1707 #define AV_PKT_FLAG_TRUSTED 0x0008
1709 enum AVSideDataParamChangeFlags {
1710 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1711 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1712 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1713 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1719 struct AVCodecInternal;
1723 AV_FIELD_PROGRESSIVE,
1724 AV_FIELD_TT, //< Top coded_first, top displayed first
1725 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1726 AV_FIELD_TB, //< Top coded first, bottom displayed first
1727 AV_FIELD_BT, //< Bottom coded first, top displayed first
1731 * main external API structure.
1732 * New fields can be added to the end with minor version bumps.
1733 * Removal, reordering and changes to existing fields require a major
1735 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1737 * The name string for AVOptions options matches the associated command line
1738 * parameter name and can be found in libavcodec/options_table.h
1739 * The AVOption/command line parameter names differ in some cases from the C
1740 * structure field names for historic reasons or brevity.
1741 * sizeof(AVCodecContext) must not be used outside libav*.
1743 typedef struct AVCodecContext {
1745 * information on struct for av_log
1746 * - set by avcodec_alloc_context3
1748 const AVClass *av_class;
1749 int log_level_offset;
1751 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1752 const struct AVCodec *codec;
1753 #if FF_API_CODEC_NAME
1755 * @deprecated this field is not used for anything in libavcodec
1757 attribute_deprecated
1758 char codec_name[32];
1760 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1763 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1764 * This is used to work around some encoder bugs.
1765 * A demuxer should set this to what is stored in the field used to identify the codec.
1766 * If there are multiple such fields in a container then the demuxer should choose the one
1767 * which maximizes the information about the used codec.
1768 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1769 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1770 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1772 * - encoding: Set by user, if not then the default based on codec_id will be used.
1773 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1775 unsigned int codec_tag;
1777 #if FF_API_STREAM_CODEC_TAG
1779 * @deprecated this field is unused
1781 attribute_deprecated
1782 unsigned int stream_codec_tag;
1788 * Private context used for internal data.
1790 * Unlike priv_data, this is not codec-specific. It is used in general
1791 * libavcodec functions.
1793 struct AVCodecInternal *internal;
1796 * Private data of the user, can be used to carry app specific stuff.
1797 * - encoding: Set by user.
1798 * - decoding: Set by user.
1803 * the average bitrate
1804 * - encoding: Set by user; unused for constant quantizer encoding.
1805 * - decoding: Set by user, may be overwritten by libavcodec
1806 * if this info is available in the stream
1811 * number of bits the bitstream is allowed to diverge from the reference.
1812 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1813 * - encoding: Set by user; unused for constant quantizer encoding.
1814 * - decoding: unused
1816 int bit_rate_tolerance;
1819 * Global quality for codecs which cannot change it per frame.
1820 * This should be proportional to MPEG-1/2/4 qscale.
1821 * - encoding: Set by user.
1822 * - decoding: unused
1827 * - encoding: Set by user.
1828 * - decoding: unused
1830 int compression_level;
1831 #define FF_COMPRESSION_DEFAULT -1
1835 * - encoding: Set by user.
1836 * - decoding: Set by user.
1842 * - encoding: Set by user.
1843 * - decoding: Set by user.
1848 * some codecs need / can use extradata like Huffman tables.
1849 * MJPEG: Huffman tables
1850 * rv10: additional flags
1851 * MPEG-4: global headers (they can be in the bitstream or here)
1852 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1853 * than extradata_size to avoid problems if it is read with the bitstream reader.
1854 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1855 * - encoding: Set/allocated/freed by libavcodec.
1856 * - decoding: Set/allocated/freed by user.
1862 * This is the fundamental unit of time (in seconds) in terms
1863 * of which frame timestamps are represented. For fixed-fps content,
1864 * timebase should be 1/framerate and timestamp increments should be
1866 * This often, but not always is the inverse of the frame rate or field rate
1867 * for video. 1/time_base is not the average frame rate if the frame rate is not
1870 * Like containers, elementary streams also can store timestamps, 1/time_base
1871 * is the unit in which these timestamps are specified.
1872 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1873 * vop_time_increment_resolution and fixed_vop_rate
1874 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1876 * - encoding: MUST be set by user.
1877 * - decoding: the use of this field for decoding is deprecated.
1878 * Use framerate instead.
1880 AVRational time_base;
1883 * For some codecs, the time base is closer to the field rate than the frame rate.
1884 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1885 * if no telecine is used ...
1887 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1889 int ticks_per_frame;
1894 * Encoding: Number of frames delay there will be from the encoder input to
1895 * the decoder output. (we assume the decoder matches the spec)
1896 * Decoding: Number of frames delay in addition to what a standard decoder
1897 * as specified in the spec would produce.
1900 * Number of frames the decoded output will be delayed relative to the
1904 * For encoding, this field is unused (see initial_padding).
1906 * For decoding, this is the number of samples the decoder needs to
1907 * output before the decoder's output is valid. When seeking, you should
1908 * start decoding this many samples prior to your desired seek point.
1910 * - encoding: Set by libavcodec.
1911 * - decoding: Set by libavcodec.
1918 * picture width / height.
1920 * @note Those fields may not match the values of the last
1921 * AVFrame output by avcodec_decode_video2 due frame
1924 * - encoding: MUST be set by user.
1925 * - decoding: May be set by the user before opening the decoder if known e.g.
1926 * from the container. Some decoders will require the dimensions
1927 * to be set by the caller. During decoding, the decoder may
1928 * overwrite those values as required while parsing the data.
1933 * Bitstream width / height, may be different from width/height e.g. when
1934 * the decoded frame is cropped before being output or lowres is enabled.
1936 * @note Those field may not match the value of the last
1937 * AVFrame output by avcodec_receive_frame() due frame
1940 * - encoding: unused
1941 * - decoding: May be set by the user before opening the decoder if known
1942 * e.g. from the container. During decoding, the decoder may
1943 * overwrite those values as required while parsing the data.
1945 int coded_width, coded_height;
1947 #if FF_API_ASPECT_EXTENDED
1948 #define FF_ASPECT_EXTENDED 15
1952 * the number of pictures in a group of pictures, or 0 for intra_only
1953 * - encoding: Set by user.
1954 * - decoding: unused
1959 * Pixel format, see AV_PIX_FMT_xxx.
1960 * May be set by the demuxer if known from headers.
1961 * May be overridden by the decoder if it knows better.
1963 * @note This field may not match the value of the last
1964 * AVFrame output by avcodec_receive_frame() due frame
1967 * - encoding: Set by user.
1968 * - decoding: Set by user if known, overridden by libavcodec while
1971 enum AVPixelFormat pix_fmt;
1973 #if FF_API_MOTION_EST
1975 * This option does nothing
1976 * @deprecated use codec private options instead
1978 attribute_deprecated int me_method;
1982 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1983 * decoder to draw a horizontal band. It improves cache usage. Not
1984 * all codecs can do that. You must check the codec capabilities
1986 * When multithreading is used, it may be called from multiple threads
1987 * at the same time; threads might draw different parts of the same AVFrame,
1988 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1990 * The function is also used by hardware acceleration APIs.
1991 * It is called at least once during frame decoding to pass
1992 * the data needed for hardware render.
1993 * In that mode instead of pixel data, AVFrame points to
1994 * a structure specific to the acceleration API. The application
1995 * reads the structure and can change some fields to indicate progress
1997 * - encoding: unused
1998 * - decoding: Set by user.
1999 * @param height the height of the slice
2000 * @param y the y position of the slice
2001 * @param type 1->top field, 2->bottom field, 3->frame
2002 * @param offset offset into the AVFrame.data from which the slice should be read
2004 void (*draw_horiz_band)(struct AVCodecContext *s,
2005 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
2006 int y, int type, int height);
2009 * callback to negotiate the pixelFormat
2010 * @param fmt is the list of formats which are supported by the codec,
2011 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2012 * The first is always the native one.
2013 * @note The callback may be called again immediately if initialization for
2014 * the selected (hardware-accelerated) pixel format failed.
2015 * @warning Behavior is undefined if the callback returns a value not
2016 * in the fmt list of formats.
2017 * @return the chosen format
2018 * - encoding: unused
2019 * - decoding: Set by user, if not set the native format will be chosen.
2021 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
2024 * maximum number of B-frames between non-B-frames
2025 * Note: The output will be delayed by max_b_frames+1 relative to the input.
2026 * - encoding: Set by user.
2027 * - decoding: unused
2032 * qscale factor between IP and B-frames
2033 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
2034 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2035 * - encoding: Set by user.
2036 * - decoding: unused
2038 float b_quant_factor;
2040 #if FF_API_RC_STRATEGY
2041 /** @deprecated use codec private option instead */
2042 attribute_deprecated int rc_strategy;
2043 #define FF_RC_STRATEGY_XVID 1
2046 #if FF_API_PRIVATE_OPT
2047 /** @deprecated use encoder private options instead */
2048 attribute_deprecated
2049 int b_frame_strategy;
2053 * qscale offset between IP and B-frames
2054 * - encoding: Set by user.
2055 * - decoding: unused
2057 float b_quant_offset;
2060 * Size of the frame reordering buffer in the decoder.
2061 * For MPEG-2 it is 1 IPB or 0 low delay IP.
2062 * - encoding: Set by libavcodec.
2063 * - decoding: Set by libavcodec.
2067 #if FF_API_PRIVATE_OPT
2068 /** @deprecated use encoder private options instead */
2069 attribute_deprecated
2074 * qscale factor between P- and I-frames
2075 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2076 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2077 * - encoding: Set by user.
2078 * - decoding: unused
2080 float i_quant_factor;
2083 * qscale offset between P and I-frames
2084 * - encoding: Set by user.
2085 * - decoding: unused
2087 float i_quant_offset;
2090 * luminance masking (0-> disabled)
2091 * - encoding: Set by user.
2092 * - decoding: unused
2097 * temporary complexity masking (0-> disabled)
2098 * - encoding: Set by user.
2099 * - decoding: unused
2101 float temporal_cplx_masking;
2104 * spatial complexity masking (0-> disabled)
2105 * - encoding: Set by user.
2106 * - decoding: unused
2108 float spatial_cplx_masking;
2111 * p block masking (0-> disabled)
2112 * - encoding: Set by user.
2113 * - decoding: unused
2118 * darkness masking (0-> disabled)
2119 * - encoding: Set by user.
2120 * - decoding: unused
2126 * - encoding: Set by libavcodec.
2127 * - decoding: Set by user (or 0).
2131 #if FF_API_PRIVATE_OPT
2132 /** @deprecated use encoder private options instead */
2133 attribute_deprecated
2134 int prediction_method;
2135 #define FF_PRED_LEFT 0
2136 #define FF_PRED_PLANE 1
2137 #define FF_PRED_MEDIAN 2
2141 * slice offsets in the frame in bytes
2142 * - encoding: Set/allocated by libavcodec.
2143 * - decoding: Set/allocated by user (or NULL).
2148 * sample aspect ratio (0 if unknown)
2149 * That is the width of a pixel divided by the height of the pixel.
2150 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2151 * - encoding: Set by user.
2152 * - decoding: Set by libavcodec.
2154 AVRational sample_aspect_ratio;
2157 * motion estimation comparison function
2158 * - encoding: Set by user.
2159 * - decoding: unused
2163 * subpixel motion estimation comparison function
2164 * - encoding: Set by user.
2165 * - decoding: unused
2169 * macroblock comparison function (not supported yet)
2170 * - encoding: Set by user.
2171 * - decoding: unused
2175 * interlaced DCT comparison function
2176 * - encoding: Set by user.
2177 * - decoding: unused
2180 #define FF_CMP_SAD 0
2181 #define FF_CMP_SSE 1
2182 #define FF_CMP_SATD 2
2183 #define FF_CMP_DCT 3
2184 #define FF_CMP_PSNR 4
2185 #define FF_CMP_BIT 5
2187 #define FF_CMP_ZERO 7
2188 #define FF_CMP_VSAD 8
2189 #define FF_CMP_VSSE 9
2190 #define FF_CMP_NSSE 10
2191 #define FF_CMP_W53 11
2192 #define FF_CMP_W97 12
2193 #define FF_CMP_DCTMAX 13
2194 #define FF_CMP_DCT264 14
2195 #define FF_CMP_MEDIAN_SAD 15
2196 #define FF_CMP_CHROMA 256
2199 * ME diamond size & shape
2200 * - encoding: Set by user.
2201 * - decoding: unused
2206 * amount of previous MV predictors (2a+1 x 2a+1 square)
2207 * - encoding: Set by user.
2208 * - decoding: unused
2210 int last_predictor_count;
2212 #if FF_API_PRIVATE_OPT
2213 /** @deprecated use encoder private options instead */
2214 attribute_deprecated
2219 * motion estimation prepass comparison function
2220 * - encoding: Set by user.
2221 * - decoding: unused
2226 * ME prepass diamond size & shape
2227 * - encoding: Set by user.
2228 * - decoding: unused
2234 * - encoding: Set by user.
2235 * - decoding: unused
2237 int me_subpel_quality;
2241 * DTG active format information (additional aspect ratio
2242 * information only used in DVB MPEG-2 transport streams)
2245 * - encoding: unused
2246 * - decoding: Set by decoder.
2247 * @deprecated Deprecated in favor of AVSideData
2249 attribute_deprecated int dtg_active_format;
2250 #define FF_DTG_AFD_SAME 8
2251 #define FF_DTG_AFD_4_3 9
2252 #define FF_DTG_AFD_16_9 10
2253 #define FF_DTG_AFD_14_9 11
2254 #define FF_DTG_AFD_4_3_SP_14_9 13
2255 #define FF_DTG_AFD_16_9_SP_14_9 14
2256 #define FF_DTG_AFD_SP_4_3 15
2257 #endif /* FF_API_AFD */
2260 * maximum motion estimation search range in subpel units
2261 * If 0 then no limit.
2263 * - encoding: Set by user.
2264 * - decoding: unused
2268 #if FF_API_QUANT_BIAS
2270 * @deprecated use encoder private option instead
2272 attribute_deprecated int intra_quant_bias;
2273 #define FF_DEFAULT_QUANT_BIAS 999999
2276 * @deprecated use encoder private option instead
2278 attribute_deprecated int inter_quant_bias;
2283 * - encoding: unused
2284 * - decoding: Set by user.
2287 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2288 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2289 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2293 * XVideo Motion Acceleration
2294 * - encoding: forbidden
2295 * - decoding: set by decoder
2296 * @deprecated XvMC doesn't need it anymore.
2298 attribute_deprecated int xvmc_acceleration;
2299 #endif /* FF_API_XVMC */
2302 * macroblock decision mode
2303 * - encoding: Set by user.
2304 * - decoding: unused
2307 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2308 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2309 #define FF_MB_DECISION_RD 2 ///< rate distortion
2312 * custom intra quantization matrix
2313 * - encoding: Set by user, can be NULL.
2314 * - decoding: Set by libavcodec.
2316 uint16_t *intra_matrix;
2319 * custom inter quantization matrix
2320 * - encoding: Set by user, can be NULL.
2321 * - decoding: Set by libavcodec.
2323 uint16_t *inter_matrix;
2325 #if FF_API_PRIVATE_OPT
2326 /** @deprecated use encoder private options instead */
2327 attribute_deprecated
2328 int scenechange_threshold;
2330 /** @deprecated use encoder private options instead */
2331 attribute_deprecated
2332 int noise_reduction;
2337 * @deprecated this field is unused
2339 attribute_deprecated
2343 * @deprecated this field is unused
2345 attribute_deprecated
2350 * precision of the intra DC coefficient - 8
2351 * - encoding: Set by user.
2352 * - decoding: Set by libavcodec
2354 int intra_dc_precision;
2357 * Number of macroblock rows at the top which are skipped.
2358 * - encoding: unused
2359 * - decoding: Set by user.
2364 * Number of macroblock rows at the bottom which are skipped.
2365 * - encoding: unused
2366 * - decoding: Set by user.
2372 * @deprecated use encoder private options instead
2374 attribute_deprecated
2375 float border_masking;
2379 * minimum MB Lagrange multiplier
2380 * - encoding: Set by user.
2381 * - decoding: unused
2386 * maximum MB Lagrange multiplier
2387 * - encoding: Set by user.
2388 * - decoding: unused
2392 #if FF_API_PRIVATE_OPT
2394 * @deprecated use encoder private options instead
2396 attribute_deprecated
2397 int me_penalty_compensation;
2401 * - encoding: Set by user.
2402 * - decoding: unused
2406 #if FF_API_PRIVATE_OPT
2407 /** @deprecated use encoder private options instead */
2408 attribute_deprecated
2414 * - encoding: Set by user.
2415 * - decoding: unused
2420 * number of reference frames
2421 * - encoding: Set by user.
2422 * - decoding: Set by lavc.
2426 #if FF_API_PRIVATE_OPT
2427 /** @deprecated use encoder private options instead */
2428 attribute_deprecated
2432 #if FF_API_UNUSED_MEMBERS
2434 * Multiplied by qscale for each frame and added to scene_change_score.
2435 * - encoding: Set by user.
2436 * - decoding: unused
2438 attribute_deprecated int scenechange_factor;
2442 * Note: Value depends upon the compare function used for fullpel ME.
2443 * - encoding: Set by user.
2444 * - decoding: unused
2448 #if FF_API_PRIVATE_OPT
2449 /** @deprecated use encoder private options instead */
2450 attribute_deprecated
2455 * Chromaticity coordinates of the source primaries.
2456 * - encoding: Set by user
2457 * - decoding: Set by libavcodec
2459 enum AVColorPrimaries color_primaries;
2462 * Color Transfer Characteristic.
2463 * - encoding: Set by user
2464 * - decoding: Set by libavcodec
2466 enum AVColorTransferCharacteristic color_trc;
2469 * YUV colorspace type.
2470 * - encoding: Set by user
2471 * - decoding: Set by libavcodec
2473 enum AVColorSpace colorspace;
2476 * MPEG vs JPEG YUV range.
2477 * - encoding: Set by user
2478 * - decoding: Set by libavcodec
2480 enum AVColorRange color_range;
2483 * This defines the location of chroma samples.
2484 * - encoding: Set by user
2485 * - decoding: Set by libavcodec
2487 enum AVChromaLocation chroma_sample_location;
2491 * Indicates number of picture subdivisions. Used for parallelized
2493 * - encoding: Set by user
2494 * - decoding: unused
2499 * - encoding: set by libavcodec
2500 * - decoding: Set by user.
2502 enum AVFieldOrder field_order;
2505 int sample_rate; ///< samples per second
2506 int channels; ///< number of audio channels
2509 * audio sample format
2510 * - encoding: Set by user.
2511 * - decoding: Set by libavcodec.
2513 enum AVSampleFormat sample_fmt; ///< sample format
2515 /* The following data should not be initialized. */
2517 * Number of samples per channel in an audio frame.
2519 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2520 * except the last must contain exactly frame_size samples per channel.
2521 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2522 * frame size is not restricted.
2523 * - decoding: may be set by some decoders to indicate constant frame size
2528 * Frame counter, set by libavcodec.
2530 * - decoding: total number of frames returned from the decoder so far.
2531 * - encoding: total number of frames passed to the encoder so far.
2533 * @note the counter is not incremented if encoding/decoding resulted in
2539 * number of bytes per packet if constant and known or 0
2540 * Used by some WAV based audio codecs.
2545 * Audio cutoff bandwidth (0 means "automatic")
2546 * - encoding: Set by user.
2547 * - decoding: unused
2552 * Audio channel layout.
2553 * - encoding: set by user.
2554 * - decoding: set by user, may be overwritten by libavcodec.
2556 uint64_t channel_layout;
2559 * Request decoder to use this channel layout if it can (0 for default)
2560 * - encoding: unused
2561 * - decoding: Set by user.
2563 uint64_t request_channel_layout;
2566 * Type of service that the audio stream conveys.
2567 * - encoding: Set by user.
2568 * - decoding: Set by libavcodec.
2570 enum AVAudioServiceType audio_service_type;
2573 * desired sample format
2574 * - encoding: Not used.
2575 * - decoding: Set by user.
2576 * Decoder will decode to this format if it can.
2578 enum AVSampleFormat request_sample_fmt;
2581 * This callback is called at the beginning of each frame to get data
2582 * buffer(s) for it. There may be one contiguous buffer for all the data or
2583 * there may be a buffer per each data plane or anything in between. What
2584 * this means is, you may set however many entries in buf[] you feel necessary.
2585 * Each buffer must be reference-counted using the AVBuffer API (see description
2588 * The following fields will be set in the frame before this callback is
2591 * - width, height (video only)
2592 * - sample_rate, channel_layout, nb_samples (audio only)
2593 * Their values may differ from the corresponding values in
2594 * AVCodecContext. This callback must use the frame values, not the codec
2595 * context values, to calculate the required buffer size.
2597 * This callback must fill the following fields in the frame:
2601 * * if the data is planar audio with more than 8 channels, then this
2602 * callback must allocate and fill extended_data to contain all pointers
2603 * to all data planes. data[] must hold as many pointers as it can.
2604 * extended_data must be allocated with av_malloc() and will be freed in
2606 * * otherwise extended_data must point to data
2607 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2608 * the frame's data and extended_data pointers must be contained in these. That
2609 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2610 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2611 * and av_buffer_ref().
2612 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2613 * this callback and filled with the extra buffers if there are more
2614 * buffers than buf[] can hold. extended_buf will be freed in
2617 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2618 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2621 * Each data plane must be aligned to the maximum required by the target
2624 * @see avcodec_default_get_buffer2()
2628 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2629 * (read and/or written to if it is writable) later by libavcodec.
2631 * avcodec_align_dimensions2() should be used to find the required width and
2632 * height, as they normally need to be rounded up to the next multiple of 16.
2634 * Some decoders do not support linesizes changing between frames.
2636 * If frame multithreading is used and thread_safe_callbacks is set,
2637 * this callback may be called from a different thread, but not from more
2638 * than one at once. Does not need to be reentrant.
2640 * @see avcodec_align_dimensions2()
2644 * Decoders request a buffer of a particular size by setting
2645 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2646 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2647 * to a smaller value in the output frame.
2649 * As a convenience, av_samples_get_buffer_size() and
2650 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2651 * functions to find the required data size and to fill data pointers and
2652 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2653 * since all planes must be the same size.
2655 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2657 * - encoding: unused
2658 * - decoding: Set by libavcodec, user can override.
2660 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2663 * If non-zero, the decoded audio and video frames returned from
2664 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2665 * and are valid indefinitely. The caller must free them with
2666 * av_frame_unref() when they are not needed anymore.
2667 * Otherwise, the decoded frames must not be freed by the caller and are
2668 * only valid until the next decode call.
2670 * This is always automatically enabled if avcodec_receive_frame() is used.
2672 * - encoding: unused
2673 * - decoding: set by the caller before avcodec_open2().
2675 attribute_deprecated
2676 int refcounted_frames;
2678 /* - encoding parameters */
2679 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2680 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2684 * - encoding: Set by user.
2685 * - decoding: unused
2691 * - encoding: Set by user.
2692 * - decoding: unused
2697 * maximum quantizer difference between frames
2698 * - encoding: Set by user.
2699 * - decoding: unused
2705 * @deprecated use encoder private options instead
2707 attribute_deprecated
2710 attribute_deprecated
2712 attribute_deprecated
2717 * decoder bitstream buffer size
2718 * - encoding: Set by user.
2719 * - decoding: unused
2724 * ratecontrol override, see RcOverride
2725 * - encoding: Allocated/set/freed by user.
2726 * - decoding: unused
2728 int rc_override_count;
2729 RcOverride *rc_override;
2733 * @deprecated use encoder private options instead
2735 attribute_deprecated
2741 * - encoding: Set by user.
2742 * - decoding: Set by user, may be overwritten by libavcodec.
2744 int64_t rc_max_rate;
2748 * - encoding: Set by user.
2749 * - decoding: unused
2751 int64_t rc_min_rate;
2755 * @deprecated use encoder private options instead
2757 attribute_deprecated
2758 float rc_buffer_aggressivity;
2760 attribute_deprecated
2761 float rc_initial_cplx;
2765 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2766 * - encoding: Set by user.
2767 * - decoding: unused.
2769 float rc_max_available_vbv_use;
2772 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2773 * - encoding: Set by user.
2774 * - decoding: unused.
2776 float rc_min_vbv_overflow_use;
2779 * Number of bits which should be loaded into the rc buffer before decoding starts.
2780 * - encoding: Set by user.
2781 * - decoding: unused
2783 int rc_initial_buffer_occupancy;
2785 #if FF_API_CODER_TYPE
2786 #define FF_CODER_TYPE_VLC 0
2787 #define FF_CODER_TYPE_AC 1
2788 #define FF_CODER_TYPE_RAW 2
2789 #define FF_CODER_TYPE_RLE 3
2790 #if FF_API_UNUSED_MEMBERS
2791 #define FF_CODER_TYPE_DEFLATE 4
2792 #endif /* FF_API_UNUSED_MEMBERS */
2794 * @deprecated use encoder private options instead
2796 attribute_deprecated
2798 #endif /* FF_API_CODER_TYPE */
2800 #if FF_API_PRIVATE_OPT
2801 /** @deprecated use encoder private options instead */
2802 attribute_deprecated
2808 * @deprecated use encoder private options instead
2810 attribute_deprecated
2814 * @deprecated use encoder private options instead
2816 attribute_deprecated
2820 #if FF_API_PRIVATE_OPT
2821 /** @deprecated use encoder private options instead */
2822 attribute_deprecated
2823 int frame_skip_threshold;
2825 /** @deprecated use encoder private options instead */
2826 attribute_deprecated
2827 int frame_skip_factor;
2829 /** @deprecated use encoder private options instead */
2830 attribute_deprecated
2833 /** @deprecated use encoder private options instead */
2834 attribute_deprecated
2836 #endif /* FF_API_PRIVATE_OPT */
2839 * trellis RD quantization
2840 * - encoding: Set by user.
2841 * - decoding: unused
2845 #if FF_API_PRIVATE_OPT
2846 /** @deprecated use encoder private options instead */
2847 attribute_deprecated
2848 int min_prediction_order;
2850 /** @deprecated use encoder private options instead */
2851 attribute_deprecated
2852 int max_prediction_order;
2854 /** @deprecated use encoder private options instead */
2855 attribute_deprecated
2856 int64_t timecode_frame_start;
2859 #if FF_API_RTP_CALLBACK
2861 * @deprecated unused
2863 /* The RTP callback: This function is called */
2864 /* every time the encoder has a packet to send. */
2865 /* It depends on the encoder if the data starts */
2866 /* with a Start Code (it should). H.263 does. */
2867 /* mb_nb contains the number of macroblocks */
2868 /* encoded in the RTP payload. */
2869 attribute_deprecated
2870 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2873 #if FF_API_PRIVATE_OPT
2874 /** @deprecated use encoder private options instead */
2875 attribute_deprecated
2876 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2877 /* do its best to deliver a chunk with size */
2878 /* below rtp_payload_size, the chunk will start */
2879 /* with a start code on some codecs like H.263. */
2880 /* This doesn't take account of any particular */
2881 /* headers inside the transmitted RTP payload. */
2884 #if FF_API_STAT_BITS
2885 /* statistics, used for 2-pass encoding */
2886 attribute_deprecated
2888 attribute_deprecated
2890 attribute_deprecated
2892 attribute_deprecated
2894 attribute_deprecated
2896 attribute_deprecated
2898 attribute_deprecated
2900 attribute_deprecated
2903 /** @deprecated this field is unused */
2904 attribute_deprecated
2909 * pass1 encoding statistics output buffer
2910 * - encoding: Set by libavcodec.
2911 * - decoding: unused
2916 * pass2 encoding statistics input buffer
2917 * Concatenated stuff from stats_out of pass1 should be placed here.
2918 * - encoding: Allocated/set/freed by user.
2919 * - decoding: unused
2924 * Work around bugs in encoders which sometimes cannot be detected automatically.
2925 * - encoding: Set by user
2926 * - decoding: Set by user
2928 int workaround_bugs;
2929 #define FF_BUG_AUTODETECT 1 ///< autodetection
2930 #if FF_API_OLD_MSMPEG4
2931 #define FF_BUG_OLD_MSMPEG4 2
2933 #define FF_BUG_XVID_ILACE 4
2934 #define FF_BUG_UMP4 8
2935 #define FF_BUG_NO_PADDING 16
2936 #define FF_BUG_AMV 32
2938 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2940 #define FF_BUG_QPEL_CHROMA 64
2941 #define FF_BUG_STD_QPEL 128
2942 #define FF_BUG_QPEL_CHROMA2 256
2943 #define FF_BUG_DIRECT_BLOCKSIZE 512
2944 #define FF_BUG_EDGE 1024
2945 #define FF_BUG_HPEL_CHROMA 2048
2946 #define FF_BUG_DC_CLIP 4096
2947 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2948 #define FF_BUG_TRUNCATED 16384
2949 #define FF_BUG_IEDGE 32768
2952 * strictly follow the standard (MPEG-4, ...).
2953 * - encoding: Set by user.
2954 * - decoding: Set by user.
2955 * Setting this to STRICT or higher means the encoder and decoder will
2956 * generally do stupid things, whereas setting it to unofficial or lower
2957 * will mean the encoder might produce output that is not supported by all
2958 * spec-compliant decoders. Decoders don't differentiate between normal,
2959 * unofficial and experimental (that is, they always try to decode things
2960 * when they can) unless they are explicitly asked to behave stupidly
2961 * (=strictly conform to the specs)
2963 int strict_std_compliance;
2964 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2965 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2966 #define FF_COMPLIANCE_NORMAL 0
2967 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2968 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2971 * error concealment flags
2972 * - encoding: unused
2973 * - decoding: Set by user.
2975 int error_concealment;
2976 #define FF_EC_GUESS_MVS 1
2977 #define FF_EC_DEBLOCK 2
2978 #define FF_EC_FAVOR_INTER 256
2982 * - encoding: Set by user.
2983 * - decoding: Set by user.
2986 #define FF_DEBUG_PICT_INFO 1
2987 #define FF_DEBUG_RC 2
2988 #define FF_DEBUG_BITSTREAM 4
2989 #define FF_DEBUG_MB_TYPE 8
2990 #define FF_DEBUG_QP 16
2993 * @deprecated this option does nothing
2995 #define FF_DEBUG_MV 32
2997 #define FF_DEBUG_DCT_COEFF 0x00000040
2998 #define FF_DEBUG_SKIP 0x00000080
2999 #define FF_DEBUG_STARTCODE 0x00000100
3000 #if FF_API_UNUSED_MEMBERS
3001 #define FF_DEBUG_PTS 0x00000200
3002 #endif /* FF_API_UNUSED_MEMBERS */
3003 #define FF_DEBUG_ER 0x00000400
3004 #define FF_DEBUG_MMCO 0x00000800
3005 #define FF_DEBUG_BUGS 0x00001000
3007 #define FF_DEBUG_VIS_QP 0x00002000
3008 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
3010 #define FF_DEBUG_BUFFERS 0x00008000
3011 #define FF_DEBUG_THREADS 0x00010000
3012 #define FF_DEBUG_GREEN_MD 0x00800000
3013 #define FF_DEBUG_NOMC 0x01000000
3018 * - encoding: Set by user.
3019 * - decoding: Set by user.
3022 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
3023 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
3024 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
3028 * Error recognition; may misdetect some more or less valid parts as errors.
3029 * - encoding: unused
3030 * - decoding: Set by user.
3032 int err_recognition;
3035 * Verify checksums embedded in the bitstream (could be of either encoded or
3036 * decoded data, depending on the codec) and print an error message on mismatch.
3037 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
3038 * decoder returning an error.
3040 #define AV_EF_CRCCHECK (1<<0)
3041 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
3042 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
3043 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
3045 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
3046 #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
3047 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
3048 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
3052 * opaque 64-bit number (generally a PTS) that will be reordered and
3053 * output in AVFrame.reordered_opaque
3054 * - encoding: unused
3055 * - decoding: Set by user.
3057 int64_t reordered_opaque;
3060 * Hardware accelerator in use
3061 * - encoding: unused.
3062 * - decoding: Set by libavcodec
3064 struct AVHWAccel *hwaccel;
3067 * Hardware accelerator context.
3068 * For some hardware accelerators, a global context needs to be
3069 * provided by the user. In that case, this holds display-dependent
3070 * data FFmpeg cannot instantiate itself. Please refer to the
3071 * FFmpeg HW accelerator documentation to know how to fill this
3072 * is. e.g. for VA API, this is a struct vaapi_context.
3073 * - encoding: unused
3074 * - decoding: Set by user
3076 void *hwaccel_context;
3080 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3081 * - decoding: unused
3083 uint64_t error[AV_NUM_DATA_POINTERS];
3086 * DCT algorithm, see FF_DCT_* below
3087 * - encoding: Set by user.
3088 * - decoding: unused
3091 #define FF_DCT_AUTO 0
3092 #define FF_DCT_FASTINT 1
3093 #define FF_DCT_INT 2
3094 #define FF_DCT_MMX 3
3095 #define FF_DCT_ALTIVEC 5
3096 #define FF_DCT_FAAN 6
3099 * IDCT algorithm, see FF_IDCT_* below.
3100 * - encoding: Set by user.
3101 * - decoding: Set by user.
3104 #define FF_IDCT_AUTO 0
3105 #define FF_IDCT_INT 1
3106 #define FF_IDCT_SIMPLE 2
3107 #define FF_IDCT_SIMPLEMMX 3
3108 #define FF_IDCT_ARM 7
3109 #define FF_IDCT_ALTIVEC 8
3111 #define FF_IDCT_SH4 9
3113 #define FF_IDCT_SIMPLEARM 10
3114 #if FF_API_UNUSED_MEMBERS
3115 #define FF_IDCT_IPP 13
3116 #endif /* FF_API_UNUSED_MEMBERS */
3117 #define FF_IDCT_XVID 14
3118 #if FF_API_IDCT_XVIDMMX
3119 #define FF_IDCT_XVIDMMX 14
3120 #endif /* FF_API_IDCT_XVIDMMX */
3121 #define FF_IDCT_SIMPLEARMV5TE 16
3122 #define FF_IDCT_SIMPLEARMV6 17
3123 #if FF_API_ARCH_SPARC
3124 #define FF_IDCT_SIMPLEVIS 18
3126 #define FF_IDCT_FAAN 20
3127 #define FF_IDCT_SIMPLENEON 22
3128 #if FF_API_ARCH_ALPHA
3129 #define FF_IDCT_SIMPLEALPHA 23
3131 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
3132 #define FF_IDCT_SIMPLEAUTO 128
3135 * bits per sample/pixel from the demuxer (needed for huffyuv).
3136 * - encoding: Set by libavcodec.
3137 * - decoding: Set by user.
3139 int bits_per_coded_sample;
3142 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3143 * - encoding: set by user.
3144 * - decoding: set by libavcodec.
3146 int bits_per_raw_sample;
3150 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3151 * - encoding: unused
3152 * - decoding: Set by user.
3157 #if FF_API_CODED_FRAME
3159 * the picture in the bitstream
3160 * - encoding: Set by libavcodec.
3161 * - decoding: unused
3163 * @deprecated use the quality factor packet side data instead
3165 attribute_deprecated AVFrame *coded_frame;
3170 * is used to decide how many independent tasks should be passed to execute()
3171 * - encoding: Set by user.
3172 * - decoding: Set by user.
3177 * Which multithreading methods to use.
3178 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3179 * so clients which cannot provide future frames should not use it.
3181 * - encoding: Set by user, otherwise the default is used.
3182 * - decoding: Set by user, otherwise the default is used.
3185 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3186 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3189 * Which multithreading methods are in use by the codec.
3190 * - encoding: Set by libavcodec.
3191 * - decoding: Set by libavcodec.
3193 int active_thread_type;
3196 * Set by the client if its custom get_buffer() callback can be called
3197 * synchronously from another thread, which allows faster multithreaded decoding.
3198 * draw_horiz_band() will be called from other threads regardless of this setting.
3199 * Ignored if the default get_buffer() is used.
3200 * - encoding: Set by user.
3201 * - decoding: Set by user.
3203 int thread_safe_callbacks;
3206 * The codec may call this to execute several independent things.
3207 * It will return only after finishing all tasks.
3208 * The user may replace this with some multithreaded implementation,
3209 * the default implementation will execute the parts serially.
3210 * @param count the number of things to execute
3211 * - encoding: Set by libavcodec, user can override.
3212 * - decoding: Set by libavcodec, user can override.
3214 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3217 * The codec may call this to execute several independent things.
3218 * It will return only after finishing all tasks.
3219 * The user may replace this with some multithreaded implementation,
3220 * the default implementation will execute the parts serially.
3221 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3222 * @param c context passed also to func
3223 * @param count the number of things to execute
3224 * @param arg2 argument passed unchanged to func
3225 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3226 * @param func function that will be called count times, with jobnr from 0 to count-1.
3227 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3228 * two instances of func executing at the same time will have the same threadnr.
3229 * @return always 0 currently, but code should handle a future improvement where when any call to func
3230 * returns < 0 no further calls to func may be done and < 0 is returned.
3231 * - encoding: Set by libavcodec, user can override.
3232 * - decoding: Set by libavcodec, user can override.
3234 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3237 * noise vs. sse weight for the nsse comparison function
3238 * - encoding: Set by user.
3239 * - decoding: unused
3245 * - encoding: Set by user.
3246 * - decoding: Set by libavcodec.
3249 #define FF_PROFILE_UNKNOWN -99
3250 #define FF_PROFILE_RESERVED -100
3252 #define FF_PROFILE_AAC_MAIN 0
3253 #define FF_PROFILE_AAC_LOW 1
3254 #define FF_PROFILE_AAC_SSR 2
3255 #define FF_PROFILE_AAC_LTP 3
3256 #define FF_PROFILE_AAC_HE 4
3257 #define FF_PROFILE_AAC_HE_V2 28
3258 #define FF_PROFILE_AAC_LD 22
3259 #define FF_PROFILE_AAC_ELD 38
3260 #define FF_PROFILE_MPEG2_AAC_LOW 128
3261 #define FF_PROFILE_MPEG2_AAC_HE 131
3263 #define FF_PROFILE_DNXHD 0
3264 #define FF_PROFILE_DNXHR_LB 1
3265 #define FF_PROFILE_DNXHR_SQ 2
3266 #define FF_PROFILE_DNXHR_HQ 3
3267 #define FF_PROFILE_DNXHR_HQX 4
3268 #define FF_PROFILE_DNXHR_444 5
3270 #define FF_PROFILE_DTS 20
3271 #define FF_PROFILE_DTS_ES 30
3272 #define FF_PROFILE_DTS_96_24 40
3273 #define FF_PROFILE_DTS_HD_HRA 50
3274 #define FF_PROFILE_DTS_HD_MA 60
3275 #define FF_PROFILE_DTS_EXPRESS 70
3277 #define FF_PROFILE_MPEG2_422 0
3278 #define FF_PROFILE_MPEG2_HIGH 1
3279 #define FF_PROFILE_MPEG2_SS 2
3280 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3281 #define FF_PROFILE_MPEG2_MAIN 4
3282 #define FF_PROFILE_MPEG2_SIMPLE 5
3284 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3285 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3287 #define FF_PROFILE_H264_BASELINE 66
3288 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3289 #define FF_PROFILE_H264_MAIN 77
3290 #define FF_PROFILE_H264_EXTENDED 88
3291 #define FF_PROFILE_H264_HIGH 100
3292 #define FF_PROFILE_H264_HIGH_10 110
3293 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3294 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3295 #define FF_PROFILE_H264_HIGH_422 122
3296 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3297 #define FF_PROFILE_H264_STEREO_HIGH 128
3298 #define FF_PROFILE_H264_HIGH_444 144
3299 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3300 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3301 #define FF_PROFILE_H264_CAVLC_444 44
3303 #define FF_PROFILE_VC1_SIMPLE 0
3304 #define FF_PROFILE_VC1_MAIN 1
3305 #define FF_PROFILE_VC1_COMPLEX 2
3306 #define FF_PROFILE_VC1_ADVANCED 3
3308 #define FF_PROFILE_MPEG4_SIMPLE 0
3309 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3310 #define FF_PROFILE_MPEG4_CORE 2
3311 #define FF_PROFILE_MPEG4_MAIN 3
3312 #define FF_PROFILE_MPEG4_N_BIT 4
3313 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3314 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3315 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3316 #define FF_PROFILE_MPEG4_HYBRID 8
3317 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3318 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3319 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3320 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3321 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3322 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3323 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3325 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3326 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3327 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3328 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3329 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3331 #define FF_PROFILE_VP9_0 0
3332 #define FF_PROFILE_VP9_1 1
3333 #define FF_PROFILE_VP9_2 2
3334 #define FF_PROFILE_VP9_3 3
3336 #define FF_PROFILE_HEVC_MAIN 1
3337 #define FF_PROFILE_HEVC_MAIN_10 2
3338 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3339 #define FF_PROFILE_HEVC_REXT 4
3343 * - encoding: Set by user.
3344 * - decoding: Set by libavcodec.
3347 #define FF_LEVEL_UNKNOWN -99
3350 * Skip loop filtering for selected frames.
3351 * - encoding: unused
3352 * - decoding: Set by user.
3354 enum AVDiscard skip_loop_filter;
3357 * Skip IDCT/dequantization for selected frames.
3358 * - encoding: unused
3359 * - decoding: Set by user.
3361 enum AVDiscard skip_idct;
3364 * Skip decoding for selected frames.
3365 * - encoding: unused
3366 * - decoding: Set by user.
3368 enum AVDiscard skip_frame;
3371 * Header containing style information for text subtitles.
3372 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3373 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3374 * the Format line following. It shouldn't include any Dialogue line.
3375 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3376 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3378 uint8_t *subtitle_header;
3379 int subtitle_header_size;
3381 #if FF_API_ERROR_RATE
3383 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3386 attribute_deprecated
3390 #if FF_API_VBV_DELAY
3392 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3393 * Used for compliant TS muxing.
3394 * - encoding: Set by libavcodec.
3395 * - decoding: unused.
3396 * @deprecated this value is now exported as a part of
3397 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3399 attribute_deprecated
3403 #if FF_API_SIDEDATA_ONLY_PKT
3405 * Encoding only and set by default. Allow encoders to output packets
3406 * that do not contain any encoded data, only side data.
3408 * Some encoders need to output such packets, e.g. to update some stream
3409 * parameters at the end of encoding.
3411 * @deprecated this field disables the default behaviour and
3412 * it is kept only for compatibility.
3414 attribute_deprecated
3415 int side_data_only_packets;
3419 * Audio only. The number of "priming" samples (padding) inserted by the
3420 * encoder at the beginning of the audio. I.e. this number of leading
3421 * decoded samples must be discarded by the caller to get the original audio
3422 * without leading padding.
3424 * - decoding: unused
3425 * - encoding: Set by libavcodec. The timestamps on the output packets are
3426 * adjusted by the encoder so that they always refer to the
3427 * first sample of the data actually contained in the packet,
3428 * including any added padding. E.g. if the timebase is
3429 * 1/samplerate and the timestamp of the first input sample is
3430 * 0, the timestamp of the first output packet will be
3433 int initial_padding;
3436 * - decoding: For codecs that store a framerate value in the compressed
3437 * bitstream, the decoder may export it here. { 0, 1} when
3439 * - encoding: May be used to signal the framerate of CFR content to an
3442 AVRational framerate;
3445 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3446 * - encoding: unused.
3447 * - decoding: Set by libavcodec before calling get_format()
3449 enum AVPixelFormat sw_pix_fmt;
3452 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3453 * - encoding unused.
3454 * - decoding set by user.
3456 AVRational pkt_timebase;
3460 * - encoding: unused.
3461 * - decoding: set by libavcodec.
3463 const AVCodecDescriptor *codec_descriptor;
3467 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3468 * - encoding: unused
3469 * - decoding: Set by user.
3475 * Current statistics for PTS correction.
3476 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3477 * - encoding: unused
3479 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3480 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3481 int64_t pts_correction_last_pts; /// PTS of the last frame
3482 int64_t pts_correction_last_dts; /// DTS of the last frame
3485 * Character encoding of the input subtitles file.
3486 * - decoding: set by user
3487 * - encoding: unused
3492 * Subtitles character encoding mode. Formats or codecs might be adjusting
3493 * this setting (if they are doing the conversion themselves for instance).
3494 * - decoding: set by libavcodec
3495 * - encoding: unused
3497 int sub_charenc_mode;
3498 #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)
3499 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3500 #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
3503 * Skip processing alpha if supported by codec.
3504 * Note that if the format uses pre-multiplied alpha (common with VP6,
3505 * and recommended due to better video quality/compression)
3506 * the image will look as if alpha-blended onto a black background.
3507 * However for formats that do not use pre-multiplied alpha
3508 * there might be serious artefacts (though e.g. libswscale currently
3509 * assumes pre-multiplied alpha anyway).
3511 * - decoding: set by user
3512 * - encoding: unused
3517 * Number of samples to skip after a discontinuity
3518 * - decoding: unused
3519 * - encoding: set by libavcodec
3523 #if !FF_API_DEBUG_MV
3525 * debug motion vectors
3526 * - encoding: Set by user.
3527 * - decoding: Set by user.
3530 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3531 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3532 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3536 * custom intra quantization matrix
3537 * - encoding: Set by user, can be NULL.
3538 * - decoding: unused.
3540 uint16_t *chroma_intra_matrix;
3543 * dump format separator.
3544 * can be ", " or "\n " or anything else
3545 * - encoding: Set by user.
3546 * - decoding: Set by user.
3548 uint8_t *dump_separator;
3551 * ',' separated list of allowed decoders.
3552 * If NULL then all are allowed
3553 * - encoding: unused
3554 * - decoding: set by user
3556 char *codec_whitelist;
3559 * Properties of the stream that gets decoded
3560 * - encoding: unused
3561 * - decoding: set by libavcodec
3563 unsigned properties;
3564 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3565 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3568 * Additional data associated with the entire coded stream.
3570 * - decoding: unused
3571 * - encoding: may be set by libavcodec after avcodec_open2().
3573 AVPacketSideData *coded_side_data;
3574 int nb_coded_side_data;
3577 * A reference to the AVHWFramesContext describing the input (for encoding)
3578 * or output (decoding) frames. The reference is set by the caller and
3579 * afterwards owned (and freed) by libavcodec - it should never be read by
3580 * the caller after being set.
3582 * - decoding: This field should be set by the caller from the get_format()
3583 * callback. The previous reference (if any) will always be
3584 * unreffed by libavcodec before the get_format() call.
3586 * If the default get_buffer2() is used with a hwaccel pixel
3587 * format, then this AVHWFramesContext will be used for
3588 * allocating the frame buffers.
3590 * - encoding: For hardware encoders configured to use a hwaccel pixel
3591 * format, this field should be set by the caller to a reference
3592 * to the AVHWFramesContext describing input frames.
3593 * AVHWFramesContext.format must be equal to
3594 * AVCodecContext.pix_fmt.
3596 * This field should be set before avcodec_open2() is called.
3598 AVBufferRef *hw_frames_ctx;
3601 * Control the form of AVSubtitle.rects[N]->ass
3602 * - decoding: set by user
3603 * - encoding: unused
3605 int sub_text_format;
3606 #define FF_SUB_TEXT_FMT_ASS 0
3607 #if FF_API_ASS_TIMING
3608 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3612 * Audio only. The amount of padding (in samples) appended by the encoder to
3613 * the end of the audio. I.e. this number of decoded samples must be
3614 * discarded by the caller from the end of the stream to get the original
3615 * audio without any trailing padding.
3617 * - decoding: unused
3618 * - encoding: unused
3620 int trailing_padding;
3623 * The number of pixels per image to maximally accept.
3625 * - decoding: set by user
3626 * - encoding: set by user
3631 * A reference to the AVHWDeviceContext describing the device which will
3632 * be used by a hardware encoder/decoder. The reference is set by the
3633 * caller and afterwards owned (and freed) by libavcodec.
3635 * This should be used if either the codec device does not require
3636 * hardware frames or any that are used are to be allocated internally by
3637 * libavcodec. If the user wishes to supply any of the frames used as
3638 * encoder input or decoder output then hw_frames_ctx should be used
3639 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3640 * field will be ignored while decoding the associated stream segment, but
3641 * may again be used on a following one after another get_format() call.
3643 * For both encoders and decoders this field should be set before
3644 * avcodec_open2() is called and must not be written to thereafter.
3646 * Note that some decoders may require this field to be set initially in
3647 * order to support hw_frames_ctx at all - in that case, all frames
3648 * contexts used must be created on the same device.
3650 AVBufferRef *hw_device_ctx;
3653 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3654 * decoding (if active).
3655 * - encoding: unused
3656 * - decoding: Set by user (either before avcodec_open2(), or in the
3657 * AVCodecContext.get_format callback)
3662 * Video decoding only. Certain video codecs support cropping, meaning that
3663 * only a sub-rectangle of the decoded frame is intended for display. This
3664 * option controls how cropping is handled by libavcodec.
3666 * When set to 1 (the default), libavcodec will apply cropping internally.
3667 * I.e. it will modify the output frame width/height fields and offset the
3668 * data pointers (only by as much as possible while preserving alignment, or
3669 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3670 * the frames output by the decoder refer only to the cropped area. The
3671 * crop_* fields of the output frames will be zero.
3673 * When set to 0, the width/height fields of the output frames will be set
3674 * to the coded dimensions and the crop_* fields will describe the cropping
3675 * rectangle. Applying the cropping is left to the caller.
3677 * @warning When hardware acceleration with opaque output frames is used,
3678 * libavcodec is unable to apply cropping from the top/left border.
3680 * @note when this option is set to zero, the width/height fields of the
3681 * AVCodecContext and output AVFrames have different meanings. The codec
3682 * context fields store display dimensions (with the coded dimensions in
3683 * coded_width/height), while the frame fields store the coded dimensions
3684 * (with the display dimensions being determined by the crop_* fields).
3689 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3690 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3692 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3693 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3695 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3697 int av_codec_get_lowres(const AVCodecContext *avctx);
3698 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3700 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3701 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3703 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3704 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3709 typedef struct AVProfile {
3711 const char *name; ///< short name for the profile
3714 typedef struct AVCodecDefault AVCodecDefault;
3721 typedef struct AVCodec {
3723 * Name of the codec implementation.
3724 * The name is globally unique among encoders and among decoders (but an
3725 * encoder and a decoder can share the same name).
3726 * This is the primary way to find a codec from the user perspective.
3730 * Descriptive name for the codec, meant to be more human readable than name.
3731 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3733 const char *long_name;
3734 enum AVMediaType type;
3737 * Codec capabilities.
3738 * see AV_CODEC_CAP_*
3741 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3742 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3743 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3744 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3745 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3746 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3747 const AVClass *priv_class; ///< AVClass for the private context
3748 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3750 /*****************************************************************
3751 * No fields below this line are part of the public API. They
3752 * may not be used outside of libavcodec and can be changed and
3754 * New public fields should be added right above.
3755 *****************************************************************
3758 struct AVCodec *next;
3760 * @name Frame-level threading support functions
3764 * If defined, called on thread contexts when they are created.
3765 * If the codec allocates writable tables in init(), re-allocate them here.
3766 * priv_data will be set to a copy of the original.
3768 int (*init_thread_copy)(AVCodecContext *);
3770 * Copy necessary context variables from a previous thread context to the current one.
3771 * If not defined, the next thread will start automatically; otherwise, the codec
3772 * must call ff_thread_finish_setup().
3774 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3776 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3780 * Private codec-specific defaults.
3782 const AVCodecDefault *defaults;
3785 * Initialize codec static data, called from avcodec_register().
3787 void (*init_static_data)(struct AVCodec *codec);
3789 int (*init)(AVCodecContext *);
3790 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3791 const struct AVSubtitle *sub);
3793 * Encode data to an AVPacket.
3795 * @param avctx codec context
3796 * @param avpkt output AVPacket (may contain a user-provided buffer)
3797 * @param[in] frame AVFrame containing the raw data to be encoded
3798 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3799 * non-empty packet was returned in avpkt.
3800 * @return 0 on success, negative error code on failure
3802 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3803 int *got_packet_ptr);
3804 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3805 int (*close)(AVCodecContext *);
3807 * Encode API with decoupled packet/frame dataflow. The API is the
3808 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3810 * - never called if the codec is closed or the wrong type,
3811 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3812 * - only one drain frame is ever passed down,
3814 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3815 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3818 * Decode API with decoupled packet/frame dataflow. This function is called
3819 * to get one output frame. It should call ff_decode_get_packet() to obtain
3822 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3825 * Will be called when seeking
3827 void (*flush)(AVCodecContext *);
3829 * Internal codec capabilities.
3830 * See FF_CODEC_CAP_* in internal.h
3835 * Decoding only, a comma-separated list of bitstream filters to apply to
3836 * packets before decoding.
3841 int av_codec_get_max_lowres(const AVCodec *codec);
3843 struct MpegEncContext;
3846 * @defgroup lavc_hwaccel AVHWAccel
3849 typedef struct AVHWAccel {
3851 * Name of the hardware accelerated codec.
3852 * The name is globally unique among encoders and among decoders (but an
3853 * encoder and a decoder can share the same name).
3858 * Type of codec implemented by the hardware accelerator.
3860 * See AVMEDIA_TYPE_xxx
3862 enum AVMediaType type;
3865 * Codec implemented by the hardware accelerator.
3867 * See AV_CODEC_ID_xxx
3872 * Supported pixel format.
3874 * Only hardware accelerated formats are supported here.
3876 enum AVPixelFormat pix_fmt;
3879 * Hardware accelerated codec capabilities.
3880 * see AV_HWACCEL_CODEC_CAP_*
3884 /*****************************************************************
3885 * No fields below this line are part of the public API. They
3886 * may not be used outside of libavcodec and can be changed and
3888 * New public fields should be added right above.
3889 *****************************************************************
3891 struct AVHWAccel *next;
3894 * Allocate a custom buffer
3896 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3899 * Called at the beginning of each frame or field picture.
3901 * Meaningful frame information (codec specific) is guaranteed to
3902 * be parsed at this point. This function is mandatory.
3904 * Note that buf can be NULL along with buf_size set to 0.
3905 * Otherwise, this means the whole frame is available at this point.
3907 * @param avctx the codec context
3908 * @param buf the frame data buffer base
3909 * @param buf_size the size of the frame in bytes
3910 * @return zero if successful, a negative value otherwise
3912 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3915 * Callback for each slice.
3917 * Meaningful slice information (codec specific) is guaranteed to
3918 * be parsed at this point. This function is mandatory.
3919 * The only exception is XvMC, that works on MB level.
3921 * @param avctx the codec context
3922 * @param buf the slice data buffer base
3923 * @param buf_size the size of the slice in bytes
3924 * @return zero if successful, a negative value otherwise
3926 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3929 * Called at the end of each frame or field picture.
3931 * The whole picture is parsed at this point and can now be sent
3932 * to the hardware accelerator. This function is mandatory.
3934 * @param avctx the codec context
3935 * @return zero if successful, a negative value otherwise
3937 int (*end_frame)(AVCodecContext *avctx);
3940 * Size of per-frame hardware accelerator private data.
3942 * Private data is allocated with av_mallocz() before
3943 * AVCodecContext.get_buffer() and deallocated after
3944 * AVCodecContext.release_buffer().
3946 int frame_priv_data_size;
3949 * Called for every Macroblock in a slice.
3951 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3952 * Instead of decoding to raw picture, MB parameters are
3953 * stored in an array provided by the video driver.
3955 * @param s the mpeg context
3957 void (*decode_mb)(struct MpegEncContext *s);
3960 * Initialize the hwaccel private data.
3962 * This will be called from ff_get_format(), after hwaccel and
3963 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3966 int (*init)(AVCodecContext *avctx);
3969 * Uninitialize the hwaccel private data.
3971 * This will be called from get_format() or avcodec_close(), after hwaccel
3972 * and hwaccel_context are already uninitialized.
3974 int (*uninit)(AVCodecContext *avctx);
3977 * Size of the private data to allocate in
3978 * AVCodecInternal.hwaccel_priv_data.
3983 * Internal hwaccel capabilities.
3989 * HWAccel is experimental and is thus avoided in favor of non experimental
3992 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3995 * Hardware acceleration should be used for decoding even if the codec level
3996 * used is unknown or higher than the maximum supported level reported by the
3999 * It's generally a good idea to pass this flag unless you have a specific
4000 * reason not to, as hardware tends to under-report supported levels.
4002 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
4005 * Hardware acceleration can output YUV pixel formats with a different chroma
4006 * sampling than 4:2:0 and/or other than 8 bits per component.
4008 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
4011 * Hardware acceleration should still be attempted for decoding when the
4012 * codec profile does not match the reported capabilities of the hardware.
4014 * For example, this can be used to try to decode baseline profile H.264
4015 * streams in hardware - it will often succeed, because many streams marked
4016 * as baseline profile actually conform to constrained baseline profile.
4018 * @warning If the stream is actually not supported then the behaviour is
4019 * undefined, and may include returning entirely incorrect output
4020 * while indicating success.
4022 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
4028 #if FF_API_AVPICTURE
4030 * @defgroup lavc_picture AVPicture
4032 * Functions for working with AVPicture
4037 * Picture data structure.
4039 * Up to four components can be stored into it, the last component is
4041 * @deprecated use AVFrame or imgutils functions instead
4043 typedef struct AVPicture {
4044 attribute_deprecated
4045 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
4046 attribute_deprecated
4047 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
4055 enum AVSubtitleType {
4058 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
4061 * Plain text, the text field must be set by the decoder and is
4062 * authoritative. ass and pict fields may contain approximations.
4067 * Formatted text, the ass field must be set by the decoder and is
4068 * authoritative. pict and text fields may contain approximations.
4073 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
4075 typedef struct AVSubtitleRect {
4076 int x; ///< top left corner of pict, undefined when pict is not set
4077 int y; ///< top left corner of pict, undefined when pict is not set
4078 int w; ///< width of pict, undefined when pict is not set
4079 int h; ///< height of pict, undefined when pict is not set
4080 int nb_colors; ///< number of colors in pict, undefined when pict is not set
4082 #if FF_API_AVPICTURE
4084 * @deprecated unused
4086 attribute_deprecated
4090 * data+linesize for the bitmap of this subtitle.
4091 * Can be set for text/ass as well once they are rendered.
4096 enum AVSubtitleType type;
4098 char *text; ///< 0 terminated plain UTF-8 text
4101 * 0 terminated ASS/SSA compatible event line.
4102 * The presentation of this is unaffected by the other values in this
4110 typedef struct AVSubtitle {
4111 uint16_t format; /* 0 = graphics */
4112 uint32_t start_display_time; /* relative to packet pts, in ms */
4113 uint32_t end_display_time; /* relative to packet pts, in ms */
4115 AVSubtitleRect **rects;
4116 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
4120 * This struct describes the properties of an encoded stream.
4122 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4123 * be allocated with avcodec_parameters_alloc() and freed with
4124 * avcodec_parameters_free().
4126 typedef struct AVCodecParameters {
4128 * General type of the encoded data.
4130 enum AVMediaType codec_type;
4132 * Specific type of the encoded data (the codec used).
4134 enum AVCodecID codec_id;
4136 * Additional information about the codec (corresponds to the AVI FOURCC).
4141 * Extra binary data needed for initializing the decoder, codec-dependent.
4143 * Must be allocated with av_malloc() and will be freed by
4144 * avcodec_parameters_free(). The allocated size of extradata must be at
4145 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4150 * Size of the extradata content in bytes.
4155 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4156 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4161 * The average bitrate of the encoded data (in bits per second).
4166 * The number of bits per sample in the codedwords.
4168 * This is basically the bitrate per sample. It is mandatory for a bunch of
4169 * formats to actually decode them. It's the number of bits for one sample in
4170 * the actual coded bitstream.
4172 * This could be for example 4 for ADPCM
4173 * For PCM formats this matches bits_per_raw_sample
4176 int bits_per_coded_sample;
4179 * This is the number of valid bits in each output sample. If the
4180 * sample format has more bits, the least significant bits are additional
4181 * padding bits, which are always 0. Use right shifts to reduce the sample
4182 * to its actual size. For example, audio formats with 24 bit samples will
4183 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4184 * To get the original sample use "(int32_t)sample >> 8"."
4186 * For ADPCM this might be 12 or 16 or similar
4189 int bits_per_raw_sample;
4192 * Codec-specific bitstream restrictions that the stream conforms to.
4198 * Video only. The dimensions of the video frame in pixels.
4204 * Video only. The aspect ratio (width / height) which a single pixel
4205 * should have when displayed.
4207 * When the aspect ratio is unknown / undefined, the numerator should be
4208 * set to 0 (the denominator may have any value).
4210 AVRational sample_aspect_ratio;
4213 * Video only. The order of the fields in interlaced video.
4215 enum AVFieldOrder field_order;
4218 * Video only. Additional colorspace characteristics.
4220 enum AVColorRange color_range;
4221 enum AVColorPrimaries color_primaries;
4222 enum AVColorTransferCharacteristic color_trc;
4223 enum AVColorSpace color_space;
4224 enum AVChromaLocation chroma_location;
4227 * Video only. Number of delayed frames.
4232 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4233 * unknown or unspecified, otherwise the number of bits set must be equal to
4234 * the channels field.
4236 uint64_t channel_layout;
4238 * Audio only. The number of audio channels.
4242 * Audio only. The number of audio samples per second.
4246 * Audio only. The number of bytes per coded audio frame, required by some
4249 * Corresponds to nBlockAlign in WAVEFORMATEX.
4253 * Audio only. Audio frame size, if known. Required by some formats to be static.
4258 * Audio only. The amount of padding (in samples) inserted by the encoder at
4259 * the beginning of the audio. I.e. this number of leading decoded samples
4260 * must be discarded by the caller to get the original audio without leading
4263 int initial_padding;
4265 * Audio only. The amount of padding (in samples) appended by the encoder to
4266 * the end of the audio. I.e. this number of decoded samples must be
4267 * discarded by the caller from the end of the stream to get the original
4268 * audio without any trailing padding.
4270 int trailing_padding;
4272 * Audio only. Number of samples to skip after a discontinuity.
4275 } AVCodecParameters;
4278 * If c is NULL, returns the first registered codec,
4279 * if c is non-NULL, returns the next registered codec after c,
4280 * or NULL if c is the last one.
4282 AVCodec *av_codec_next(const AVCodec *c);
4285 * Return the LIBAVCODEC_VERSION_INT constant.
4287 unsigned avcodec_version(void);
4290 * Return the libavcodec build-time configuration.
4292 const char *avcodec_configuration(void);
4295 * Return the libavcodec license.
4297 const char *avcodec_license(void);
4300 * Register the codec codec and initialize libavcodec.
4302 * @warning either this function or avcodec_register_all() must be called
4303 * before any other libavcodec functions.
4305 * @see avcodec_register_all()
4307 void avcodec_register(AVCodec *codec);
4310 * Register all the codecs, parsers and bitstream filters which were enabled at
4311 * configuration time. If you do not call this function you can select exactly
4312 * which formats you want to support, by using the individual registration
4315 * @see avcodec_register
4316 * @see av_register_codec_parser
4317 * @see av_register_bitstream_filter
4319 void avcodec_register_all(void);
4322 * Allocate an AVCodecContext and set its fields to default values. The
4323 * resulting struct should be freed with avcodec_free_context().
4325 * @param codec if non-NULL, allocate private data and initialize defaults
4326 * for the given codec. It is illegal to then call avcodec_open2()
4327 * with a different codec.
4328 * If NULL, then the codec-specific defaults won't be initialized,
4329 * which may result in suboptimal default settings (this is
4330 * important mainly for encoders, e.g. libx264).
4332 * @return An AVCodecContext filled with default values or NULL on failure.
4334 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4337 * Free the codec context and everything associated with it and write NULL to
4338 * the provided pointer.
4340 void avcodec_free_context(AVCodecContext **avctx);
4342 #if FF_API_GET_CONTEXT_DEFAULTS
4344 * @deprecated This function should not be used, as closing and opening a codec
4345 * context multiple time is not supported. A new codec context should be
4346 * allocated for each new use.
4348 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4352 * Get the AVClass for AVCodecContext. It can be used in combination with
4353 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4355 * @see av_opt_find().
4357 const AVClass *avcodec_get_class(void);
4359 #if FF_API_COPY_CONTEXT
4361 * Get the AVClass for AVFrame. It can be used in combination with
4362 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4364 * @see av_opt_find().
4366 const AVClass *avcodec_get_frame_class(void);
4369 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4370 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4372 * @see av_opt_find().
4374 const AVClass *avcodec_get_subtitle_rect_class(void);
4377 * Copy the settings of the source AVCodecContext into the destination
4378 * AVCodecContext. The resulting destination codec context will be
4379 * unopened, i.e. you are required to call avcodec_open2() before you
4380 * can use this AVCodecContext to decode/encode video/audio data.
4382 * @param dest target codec context, should be initialized with
4383 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4384 * @param src source codec context
4385 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4387 * @deprecated The semantics of this function are ill-defined and it should not
4388 * be used. If you need to transfer the stream parameters from one codec context
4389 * to another, use an intermediate AVCodecParameters instance and the
4390 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4393 attribute_deprecated
4394 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4398 * Allocate a new AVCodecParameters and set its fields to default values
4399 * (unknown/invalid/0). The returned struct must be freed with
4400 * avcodec_parameters_free().
4402 AVCodecParameters *avcodec_parameters_alloc(void);
4405 * Free an AVCodecParameters instance and everything associated with it and
4406 * write NULL to the supplied pointer.
4408 void avcodec_parameters_free(AVCodecParameters **par);
4411 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4412 * replaced with newly allocated duplicates of the corresponding fields in src.
4414 * @return >= 0 on success, a negative AVERROR code on failure.
4416 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4419 * Fill the parameters struct based on the values from the supplied codec
4420 * context. Any allocated fields in par are freed and replaced with duplicates
4421 * of the corresponding fields in codec.
4423 * @return >= 0 on success, a negative AVERROR code on failure
4425 int avcodec_parameters_from_context(AVCodecParameters *par,
4426 const AVCodecContext *codec);
4429 * Fill the codec context based on the values from the supplied codec
4430 * parameters. Any allocated fields in codec that have a corresponding field in
4431 * par are freed and replaced with duplicates of the corresponding field in par.
4432 * Fields in codec that do not have a counterpart in par are not touched.
4434 * @return >= 0 on success, a negative AVERROR code on failure.
4436 int avcodec_parameters_to_context(AVCodecContext *codec,
4437 const AVCodecParameters *par);
4440 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4441 * function the context has to be allocated with avcodec_alloc_context3().
4443 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4444 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4445 * retrieving a codec.
4447 * @warning This function is not thread safe!
4449 * @note Always call this function before using decoding routines (such as
4450 * @ref avcodec_receive_frame()).
4453 * avcodec_register_all();
4454 * av_dict_set(&opts, "b", "2.5M", 0);
4455 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4459 * context = avcodec_alloc_context3(codec);
4461 * if (avcodec_open2(context, codec, opts) < 0)
4465 * @param avctx The context to initialize.
4466 * @param codec The codec to open this context for. If a non-NULL codec has been
4467 * previously passed to avcodec_alloc_context3() or
4468 * for this context, then this parameter MUST be either NULL or
4469 * equal to the previously passed codec.
4470 * @param options A dictionary filled with AVCodecContext and codec-private options.
4471 * On return this object will be filled with options that were not found.
4473 * @return zero on success, a negative value on error
4474 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4475 * av_dict_set(), av_opt_find().
4477 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4480 * Close a given AVCodecContext and free all the data associated with it
4481 * (but not the AVCodecContext itself).
4483 * Calling this function on an AVCodecContext that hasn't been opened will free
4484 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4485 * codec. Subsequent calls will do nothing.
4487 * @note Do not use this function. Use avcodec_free_context() to destroy a
4488 * codec context (either open or closed). Opening and closing a codec context
4489 * multiple times is not supported anymore -- use multiple codec contexts
4492 int avcodec_close(AVCodecContext *avctx);
4495 * Free all allocated data in the given subtitle struct.
4497 * @param sub AVSubtitle to free.
4499 void avsubtitle_free(AVSubtitle *sub);
4506 * @addtogroup lavc_packet
4511 * Allocate an AVPacket and set its fields to default values. The resulting
4512 * struct must be freed using av_packet_free().
4514 * @return An AVPacket filled with default values or NULL on failure.
4516 * @note this only allocates the AVPacket itself, not the data buffers. Those
4517 * must be allocated through other means such as av_new_packet.
4519 * @see av_new_packet
4521 AVPacket *av_packet_alloc(void);
4524 * Create a new packet that references the same data as src.
4526 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4528 * @return newly created AVPacket on success, NULL on error.
4530 * @see av_packet_alloc
4531 * @see av_packet_ref
4533 AVPacket *av_packet_clone(const AVPacket *src);
4536 * Free the packet, if the packet is reference counted, it will be
4537 * unreferenced first.
4539 * @param pkt packet to be freed. The pointer will be set to NULL.
4540 * @note passing NULL is a no-op.
4542 void av_packet_free(AVPacket **pkt);
4545 * Initialize optional fields of a packet with default values.
4547 * Note, this does not touch the data and size members, which have to be
4548 * initialized separately.
4552 void av_init_packet(AVPacket *pkt);
4555 * Allocate the payload of a packet and initialize its fields with
4559 * @param size wanted payload size
4560 * @return 0 if OK, AVERROR_xxx otherwise
4562 int av_new_packet(AVPacket *pkt, int size);
4565 * Reduce packet size, correctly zeroing padding
4568 * @param size new size
4570 void av_shrink_packet(AVPacket *pkt, int size);
4573 * Increase packet size, correctly zeroing padding
4576 * @param grow_by number of bytes by which to increase the size of the packet
4578 int av_grow_packet(AVPacket *pkt, int grow_by);
4581 * Initialize a reference-counted packet from av_malloc()ed data.
4583 * @param pkt packet to be initialized. This function will set the data, size,
4584 * buf and destruct fields, all others are left untouched.
4585 * @param data Data allocated by av_malloc() to be used as packet data. If this
4586 * function returns successfully, the data is owned by the underlying AVBuffer.
4587 * The caller may not access the data through other means.
4588 * @param size size of data in bytes, without the padding. I.e. the full buffer
4589 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4591 * @return 0 on success, a negative AVERROR on error
4593 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4595 #if FF_API_AVPACKET_OLD_API
4597 * @warning This is a hack - the packet memory allocation stuff is broken. The
4598 * packet is allocated if it was not really allocated.
4600 * @deprecated Use av_packet_ref
4602 attribute_deprecated
4603 int av_dup_packet(AVPacket *pkt);
4605 * Copy packet, including contents
4607 * @return 0 on success, negative AVERROR on fail
4609 * @deprecated Use av_packet_ref
4611 attribute_deprecated
4612 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4615 * Copy packet side data
4617 * @return 0 on success, negative AVERROR on fail
4619 * @deprecated Use av_packet_copy_props
4621 attribute_deprecated
4622 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4627 * @deprecated Use av_packet_unref
4629 * @param pkt packet to free
4631 attribute_deprecated
4632 void av_free_packet(AVPacket *pkt);
4635 * Allocate new information of a packet.
4638 * @param type side information type
4639 * @param size side information size
4640 * @return pointer to fresh allocated data or NULL otherwise
4642 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4646 * Wrap an existing array as a packet side data.
4649 * @param type side information type
4650 * @param data the side data array. It must be allocated with the av_malloc()
4651 * family of functions. The ownership of the data is transferred to
4653 * @param size side information size
4654 * @return a non-negative number on success, a negative AVERROR code on
4655 * failure. On failure, the packet is unchanged and the data remains
4656 * owned by the caller.
4658 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4659 uint8_t *data, size_t size);
4662 * Shrink the already allocated side data buffer
4665 * @param type side information type
4666 * @param size new side information size
4667 * @return 0 on success, < 0 on failure
4669 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4673 * Get side information from packet.
4676 * @param type desired side information type
4677 * @param size pointer for side information size to store (optional)
4678 * @return pointer to data if present or NULL otherwise
4680 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4683 #if FF_API_MERGE_SD_API
4684 attribute_deprecated
4685 int av_packet_merge_side_data(AVPacket *pkt);
4687 attribute_deprecated
4688 int av_packet_split_side_data(AVPacket *pkt);
4691 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4694 * Pack a dictionary for use in side_data.
4696 * @param dict The dictionary to pack.
4697 * @param size pointer to store the size of the returned data
4698 * @return pointer to data if successful, NULL otherwise
4700 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4702 * Unpack a dictionary from side_data.
4704 * @param data data from side_data
4705 * @param size size of the data
4706 * @param dict the metadata storage dictionary
4707 * @return 0 on success, < 0 on failure
4709 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4713 * Convenience function to free all the side data stored.
4714 * All the other fields stay untouched.
4718 void av_packet_free_side_data(AVPacket *pkt);
4721 * Setup a new reference to the data described by a given packet
4723 * If src is reference-counted, setup dst as a new reference to the
4724 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4725 * data from src into it.
4727 * All the other fields are copied from src.
4729 * @see av_packet_unref
4731 * @param dst Destination packet
4732 * @param src Source packet
4734 * @return 0 on success, a negative AVERROR on error.
4736 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4741 * Unreference the buffer referenced by the packet and reset the
4742 * remaining packet fields to their default values.
4744 * @param pkt The packet to be unreferenced.
4746 void av_packet_unref(AVPacket *pkt);
4749 * Move every field in src to dst and reset src.
4751 * @see av_packet_unref
4753 * @param src Source packet, will be reset
4754 * @param dst Destination packet
4756 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4759 * Copy only "properties" fields from src to dst.
4761 * Properties for the purpose of this function are all the fields
4762 * beside those related to the packet data (buf, data, size)
4764 * @param dst Destination packet
4765 * @param src Source packet
4767 * @return 0 on success AVERROR on failure.
4769 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4772 * Convert valid timing fields (timestamps / durations) in a packet from one
4773 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4776 * @param pkt packet on which the conversion will be performed
4777 * @param tb_src source timebase, in which the timing fields in pkt are
4779 * @param tb_dst destination timebase, to which the timing fields will be
4782 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4789 * @addtogroup lavc_decoding
4794 * Find a registered decoder with a matching codec ID.
4796 * @param id AVCodecID of the requested decoder
4797 * @return A decoder if one was found, NULL otherwise.
4799 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4802 * Find a registered decoder with the specified name.
4804 * @param name name of the requested decoder
4805 * @return A decoder if one was found, NULL otherwise.
4807 AVCodec *avcodec_find_decoder_by_name(const char *name);
4810 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4811 * it can be called by custom get_buffer2() implementations for decoders without
4812 * AV_CODEC_CAP_DR1 set.
4814 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4818 * Return the amount of padding in pixels which the get_buffer callback must
4819 * provide around the edge of the image for codecs which do not have the
4820 * CODEC_FLAG_EMU_EDGE flag.
4822 * @return Required padding in pixels.
4824 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4827 attribute_deprecated
4828 unsigned avcodec_get_edge_width(void);
4832 * Modify width and height values so that they will result in a memory
4833 * buffer that is acceptable for the codec if you do not use any horizontal
4836 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4838 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4841 * Modify width and height values so that they will result in a memory
4842 * buffer that is acceptable for the codec if you also ensure that all
4843 * line sizes are a multiple of the respective linesize_align[i].
4845 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4847 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4848 int linesize_align[AV_NUM_DATA_POINTERS]);
4851 * Converts AVChromaLocation to swscale x/y chroma position.
4853 * The positions represent the chroma (0,0) position in a coordinates system
4854 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4856 * @param xpos horizontal chroma sample position
4857 * @param ypos vertical chroma sample position
4859 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4862 * Converts swscale x/y chroma position to AVChromaLocation.
4864 * The positions represent the chroma (0,0) position in a coordinates system
4865 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4867 * @param xpos horizontal chroma sample position
4868 * @param ypos vertical chroma sample position
4870 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4873 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4875 * Some decoders may support multiple frames in a single AVPacket. Such
4876 * decoders would then just decode the first frame and the return value would be
4877 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4878 * called again with an AVPacket containing the remaining data in order to
4879 * decode the second frame, etc... Even if no frames are returned, the packet
4880 * needs to be fed to the decoder with remaining data until it is completely
4881 * consumed or an error occurs.
4883 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4884 * and output. This means that for some packets they will not immediately
4885 * produce decoded output and need to be flushed at the end of decoding to get
4886 * all the decoded data. Flushing is done by calling this function with packets
4887 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4888 * returning samples. It is safe to flush even those decoders that are not
4889 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4891 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4892 * larger than the actual read bytes because some optimized bitstream
4893 * readers read 32 or 64 bits at once and could read over the end.
4895 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4896 * before packets may be fed to the decoder.
4898 * @param avctx the codec context
4899 * @param[out] frame The AVFrame in which to store decoded audio samples.
4900 * The decoder will allocate a buffer for the decoded frame by
4901 * calling the AVCodecContext.get_buffer2() callback.
4902 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4903 * reference counted and the returned reference belongs to the
4904 * caller. The caller must release the frame using av_frame_unref()
4905 * when the frame is no longer needed. The caller may safely write
4906 * to the frame if av_frame_is_writable() returns 1.
4907 * When AVCodecContext.refcounted_frames is set to 0, the returned
4908 * reference belongs to the decoder and is valid only until the
4909 * next call to this function or until closing or flushing the
4910 * decoder. The caller may not write to it.
4911 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4912 * non-zero. Note that this field being set to zero
4913 * does not mean that an error has occurred. For
4914 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4915 * call is guaranteed to produce a frame.
4916 * @param[in] avpkt The input AVPacket containing the input buffer.
4917 * At least avpkt->data and avpkt->size should be set. Some
4918 * decoders might also require additional fields to be set.
4919 * @return A negative error code is returned if an error occurred during
4920 * decoding, otherwise the number of bytes consumed from the input
4921 * AVPacket is returned.
4923 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4925 attribute_deprecated
4926 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4927 int *got_frame_ptr, const AVPacket *avpkt);
4930 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4931 * Some decoders may support multiple frames in a single AVPacket, such
4932 * decoders would then just decode the first frame.
4934 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4935 * the actual read bytes because some optimized bitstream readers read 32 or 64
4936 * bits at once and could read over the end.
4938 * @warning The end of the input buffer buf should be set to 0 to ensure that
4939 * no overreading happens for damaged MPEG streams.
4941 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4942 * between input and output, these need to be fed with avpkt->data=NULL,
4943 * avpkt->size=0 at the end to return the remaining frames.
4945 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4946 * before packets may be fed to the decoder.
4948 * @param avctx the codec context
4949 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4950 * Use av_frame_alloc() to get an AVFrame. The codec will
4951 * allocate memory for the actual bitmap by calling the
4952 * AVCodecContext.get_buffer2() callback.
4953 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4954 * reference counted and the returned reference belongs to the
4955 * caller. The caller must release the frame using av_frame_unref()
4956 * when the frame is no longer needed. The caller may safely write
4957 * to the frame if av_frame_is_writable() returns 1.
4958 * When AVCodecContext.refcounted_frames is set to 0, the returned
4959 * reference belongs to the decoder and is valid only until the
4960 * next call to this function or until closing or flushing the
4961 * decoder. The caller may not write to it.
4963 * @param[in] avpkt The input AVPacket containing the input buffer.
4964 * You can create such packet with av_init_packet() and by then setting
4965 * data and size, some decoders might in addition need other fields like
4966 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4968 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4969 * @return On error a negative value is returned, otherwise the number of bytes
4970 * used or zero if no frame could be decompressed.
4972 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4974 attribute_deprecated
4975 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4976 int *got_picture_ptr,
4977 const AVPacket *avpkt);
4980 * Decode a subtitle message.
4981 * Return a negative value on error, otherwise return the number of bytes used.
4982 * If no subtitle could be decompressed, got_sub_ptr is zero.
4983 * Otherwise, the subtitle is stored in *sub.
4984 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4985 * simplicity, because the performance difference is expect to be negligible
4986 * and reusing a get_buffer written for video codecs would probably perform badly
4987 * due to a potentially very different allocation pattern.
4989 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4990 * and output. This means that for some packets they will not immediately
4991 * produce decoded output and need to be flushed at the end of decoding to get
4992 * all the decoded data. Flushing is done by calling this function with packets
4993 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4994 * returning subtitles. It is safe to flush even those decoders that are not
4995 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4997 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4998 * before packets may be fed to the decoder.
5000 * @param avctx the codec context
5001 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
5002 * must be freed with avsubtitle_free if *got_sub_ptr is set.
5003 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
5004 * @param[in] avpkt The input AVPacket containing the input buffer.
5006 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
5011 * Supply raw packet data as input to a decoder.
5013 * Internally, this call will copy relevant AVCodecContext fields, which can
5014 * influence decoding per-packet, and apply them when the packet is actually
5015 * decoded. (For example AVCodecContext.skip_frame, which might direct the
5016 * decoder to drop the frame contained by the packet sent with this function.)
5018 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
5019 * larger than the actual read bytes because some optimized bitstream
5020 * readers read 32 or 64 bits at once and could read over the end.
5022 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
5023 * on the same AVCodecContext. It will return unexpected results now
5024 * or in future libavcodec versions.
5026 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
5027 * before packets may be fed to the decoder.
5029 * @param avctx codec context
5030 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
5031 * frame, or several complete audio frames.
5032 * Ownership of the packet remains with the caller, and the
5033 * decoder will not write to the packet. The decoder may create
5034 * a reference to the packet data (or copy it if the packet is
5035 * not reference-counted).
5036 * Unlike with older APIs, the packet is always fully consumed,
5037 * and if it contains multiple frames (e.g. some audio codecs),
5038 * will require you to call avcodec_receive_frame() multiple
5039 * times afterwards before you can send a new packet.
5040 * It can be NULL (or an AVPacket with data set to NULL and
5041 * size set to 0); in this case, it is considered a flush
5042 * packet, which signals the end of the stream. Sending the
5043 * first flush packet will return success. Subsequent ones are
5044 * unnecessary and will return AVERROR_EOF. If the decoder
5045 * still has frames buffered, it will return them after sending
5048 * @return 0 on success, otherwise negative error code:
5049 * AVERROR(EAGAIN): input is not accepted in the current state - user
5050 * must read output with avcodec_receive_frame() (once
5051 * all output is read, the packet should be resent, and
5052 * the call will not fail with EAGAIN).
5053 * AVERROR_EOF: the decoder has been flushed, and no new packets can
5054 * be sent to it (also returned if more than 1 flush
5056 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
5057 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5058 * other errors: legitimate decoding errors
5060 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
5063 * Return decoded output data from a decoder.
5065 * @param avctx codec context
5066 * @param frame This will be set to a reference-counted video or audio
5067 * frame (depending on the decoder type) allocated by the
5068 * decoder. Note that the function will always call
5069 * av_frame_unref(frame) before doing anything else.
5072 * 0: success, a frame was returned
5073 * AVERROR(EAGAIN): output is not available in this state - user must try
5075 * AVERROR_EOF: the decoder has been fully flushed, and there will be
5076 * no more output frames
5077 * AVERROR(EINVAL): codec not opened, or it is an encoder
5078 * other negative values: legitimate decoding errors
5080 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
5083 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
5084 * to retrieve buffered output packets.
5086 * @param avctx codec context
5087 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
5088 * Ownership of the frame remains with the caller, and the
5089 * encoder will not write to the frame. The encoder may create
5090 * a reference to the frame data (or copy it if the frame is
5091 * not reference-counted).
5092 * It can be NULL, in which case it is considered a flush
5093 * packet. This signals the end of the stream. If the encoder
5094 * still has packets buffered, it will return them after this
5095 * call. Once flushing mode has been entered, additional flush
5096 * packets are ignored, and sending frames will return
5100 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5101 * can have any number of samples.
5102 * If it is not set, frame->nb_samples must be equal to
5103 * avctx->frame_size for all frames except the last.
5104 * The final frame may be smaller than avctx->frame_size.
5105 * @return 0 on success, otherwise negative error code:
5106 * AVERROR(EAGAIN): input is not accepted in the current state - user
5107 * must read output with avcodec_receive_packet() (once
5108 * all output is read, the packet should be resent, and
5109 * the call will not fail with EAGAIN).
5110 * AVERROR_EOF: the encoder has been flushed, and no new frames can
5112 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
5113 * decoder, or requires flush
5114 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5115 * other errors: legitimate decoding errors
5117 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5120 * Read encoded data from the encoder.
5122 * @param avctx codec context
5123 * @param avpkt This will be set to a reference-counted packet allocated by the
5124 * encoder. Note that the function will always call
5125 * av_frame_unref(frame) before doing anything else.
5126 * @return 0 on success, otherwise negative error code:
5127 * AVERROR(EAGAIN): output is not available in the current state - user
5128 * must try to send input
5129 * AVERROR_EOF: the encoder has been fully flushed, and there will be
5130 * no more output packets
5131 * AVERROR(EINVAL): codec not opened, or it is an encoder
5132 * other errors: legitimate decoding errors
5134 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5138 * @defgroup lavc_parsing Frame parsing
5142 enum AVPictureStructure {
5143 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5144 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5145 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5146 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5149 typedef struct AVCodecParserContext {
5151 struct AVCodecParser *parser;
5152 int64_t frame_offset; /* offset of the current frame */
5153 int64_t cur_offset; /* current offset
5154 (incremented by each av_parser_parse()) */
5155 int64_t next_frame_offset; /* offset of the next frame */
5157 int pict_type; /* XXX: Put it back in AVCodecContext. */
5159 * This field is used for proper frame duration computation in lavf.
5160 * It signals, how much longer the frame duration of the current frame
5161 * is compared to normal frame duration.
5163 * frame_duration = (1 + repeat_pict) * time_base
5165 * It is used by codecs like H.264 to display telecined material.
5167 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5168 int64_t pts; /* pts of the current frame */
5169 int64_t dts; /* dts of the current frame */
5174 int fetch_timestamp;
5176 #define AV_PARSER_PTS_NB 4
5177 int cur_frame_start_index;
5178 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5179 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5180 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5183 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5184 #define PARSER_FLAG_ONCE 0x0002
5185 /// Set if the parser has a valid file offset
5186 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5187 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5189 int64_t offset; ///< byte offset from starting packet start
5190 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5193 * Set by parser to 1 for key frames and 0 for non-key frames.
5194 * It is initialized to -1, so if the parser doesn't set this flag,
5195 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5200 #if FF_API_CONVERGENCE_DURATION
5202 * @deprecated unused
5204 attribute_deprecated
5205 int64_t convergence_duration;
5208 // Timestamp generation support:
5210 * Synchronization point for start of timestamp generation.
5212 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5215 * For example, this corresponds to presence of H.264 buffering period
5221 * Offset of the current timestamp against last timestamp sync point in
5222 * units of AVCodecContext.time_base.
5224 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5225 * contain a valid timestamp offset.
5227 * Note that the timestamp of sync point has usually a nonzero
5228 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5229 * the next frame after timestamp sync point will be usually 1.
5231 * For example, this corresponds to H.264 cpb_removal_delay.
5233 int dts_ref_dts_delta;
5236 * Presentation delay of current frame in units of AVCodecContext.time_base.
5238 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5239 * contain valid non-negative timestamp delta (presentation time of a frame
5240 * must not lie in the past).
5242 * This delay represents the difference between decoding and presentation
5243 * time of the frame.
5245 * For example, this corresponds to H.264 dpb_output_delay.
5250 * Position of the packet in file.
5252 * Analogous to cur_frame_pts/dts
5254 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5257 * Byte position of currently parsed frame in stream.
5262 * Previous frame byte position.
5267 * Duration of the current frame.
5268 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5269 * For all other types, this is in units of AVCodecContext.time_base.
5273 enum AVFieldOrder field_order;
5276 * Indicate whether a picture is coded as a frame, top field or bottom field.
5278 * For example, H.264 field_pic_flag equal to 0 corresponds to
5279 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5280 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5281 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5283 enum AVPictureStructure picture_structure;
5286 * Picture number incremented in presentation or output order.
5287 * This field may be reinitialized at the first picture of a new sequence.
5289 * For example, this corresponds to H.264 PicOrderCnt.
5291 int output_picture_number;
5294 * Dimensions of the decoded video intended for presentation.
5300 * Dimensions of the coded video.
5306 * The format of the coded data, corresponds to enum AVPixelFormat for video
5307 * and for enum AVSampleFormat for audio.
5309 * Note that a decoder can have considerable freedom in how exactly it
5310 * decodes the data, so the format reported here might be different from the
5311 * one returned by a decoder.
5314 } AVCodecParserContext;
5316 typedef struct AVCodecParser {
5317 int codec_ids[5]; /* several codec IDs are permitted */
5319 int (*parser_init)(AVCodecParserContext *s);
5320 /* This callback never returns an error, a negative value means that
5321 * the frame start was in a previous packet. */
5322 int (*parser_parse)(AVCodecParserContext *s,
5323 AVCodecContext *avctx,
5324 const uint8_t **poutbuf, int *poutbuf_size,
5325 const uint8_t *buf, int buf_size);
5326 void (*parser_close)(AVCodecParserContext *s);
5327 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5328 struct AVCodecParser *next;
5331 AVCodecParser *av_parser_next(const AVCodecParser *c);
5333 void av_register_codec_parser(AVCodecParser *parser);
5334 AVCodecParserContext *av_parser_init(int codec_id);
5339 * @param s parser context.
5340 * @param avctx codec context.
5341 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5342 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5343 * @param buf input buffer.
5344 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5345 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5346 To signal EOF, this should be 0 (so that the last frame
5348 * @param pts input presentation timestamp.
5349 * @param dts input decoding timestamp.
5350 * @param pos input byte position in stream.
5351 * @return the number of bytes of the input bitstream used.
5356 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5363 * decode_frame(data, size);
5367 int av_parser_parse2(AVCodecParserContext *s,
5368 AVCodecContext *avctx,
5369 uint8_t **poutbuf, int *poutbuf_size,
5370 const uint8_t *buf, int buf_size,
5371 int64_t pts, int64_t dts,
5375 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5376 * @deprecated use AVBitStreamFilter
5378 int av_parser_change(AVCodecParserContext *s,
5379 AVCodecContext *avctx,
5380 uint8_t **poutbuf, int *poutbuf_size,
5381 const uint8_t *buf, int buf_size, int keyframe);
5382 void av_parser_close(AVCodecParserContext *s);
5390 * @addtogroup lavc_encoding
5395 * Find a registered encoder with a matching codec ID.
5397 * @param id AVCodecID of the requested encoder
5398 * @return An encoder if one was found, NULL otherwise.
5400 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5403 * Find a registered encoder with the specified name.
5405 * @param name name of the requested encoder
5406 * @return An encoder if one was found, NULL otherwise.
5408 AVCodec *avcodec_find_encoder_by_name(const char *name);
5411 * Encode a frame of audio.
5413 * Takes input samples from frame and writes the next output packet, if
5414 * available, to avpkt. The output packet does not necessarily contain data for
5415 * the most recent frame, as encoders can delay, split, and combine input frames
5416 * internally as needed.
5418 * @param avctx codec context
5419 * @param avpkt output AVPacket.
5420 * The user can supply an output buffer by setting
5421 * avpkt->data and avpkt->size prior to calling the
5422 * function, but if the size of the user-provided data is not
5423 * large enough, encoding will fail. If avpkt->data and
5424 * avpkt->size are set, avpkt->destruct must also be set. All
5425 * other AVPacket fields will be reset by the encoder using
5426 * av_init_packet(). If avpkt->data is NULL, the encoder will
5427 * allocate it. The encoder will set avpkt->size to the size
5428 * of the output packet.
5430 * If this function fails or produces no output, avpkt will be
5431 * freed using av_packet_unref().
5432 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5433 * May be NULL when flushing an encoder that has the
5434 * AV_CODEC_CAP_DELAY capability set.
5435 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5436 * can have any number of samples.
5437 * If it is not set, frame->nb_samples must be equal to
5438 * avctx->frame_size for all frames except the last.
5439 * The final frame may be smaller than avctx->frame_size.
5440 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5441 * output packet is non-empty, and to 0 if it is
5442 * empty. If the function returns an error, the
5443 * packet can be assumed to be invalid, and the
5444 * value of got_packet_ptr is undefined and should
5446 * @return 0 on success, negative error code on failure
5448 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5450 attribute_deprecated
5451 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5452 const AVFrame *frame, int *got_packet_ptr);
5455 * Encode a frame of video.
5457 * Takes input raw video data from frame and writes the next output packet, if
5458 * available, to avpkt. The output packet does not necessarily contain data for
5459 * the most recent frame, as encoders can delay and reorder input frames
5460 * internally as needed.
5462 * @param avctx codec context
5463 * @param avpkt output AVPacket.
5464 * The user can supply an output buffer by setting
5465 * avpkt->data and avpkt->size prior to calling the
5466 * function, but if the size of the user-provided data is not
5467 * large enough, encoding will fail. All other AVPacket fields
5468 * will be reset by the encoder using av_init_packet(). If
5469 * avpkt->data is NULL, the encoder will allocate it.
5470 * The encoder will set avpkt->size to the size of the
5471 * output packet. The returned data (if any) belongs to the
5472 * caller, he is responsible for freeing it.
5474 * If this function fails or produces no output, avpkt will be
5475 * freed using av_packet_unref().
5476 * @param[in] frame AVFrame containing the raw video data to be encoded.
5477 * May be NULL when flushing an encoder that has the
5478 * AV_CODEC_CAP_DELAY capability set.
5479 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5480 * output packet is non-empty, and to 0 if it is
5481 * empty. If the function returns an error, the
5482 * packet can be assumed to be invalid, and the
5483 * value of got_packet_ptr is undefined and should
5485 * @return 0 on success, negative error code on failure
5487 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5489 attribute_deprecated
5490 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5491 const AVFrame *frame, int *got_packet_ptr);
5493 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5494 const AVSubtitle *sub);
5501 #if FF_API_AVPICTURE
5503 * @addtogroup lavc_picture
5508 * @deprecated unused
5510 attribute_deprecated
5511 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5514 * @deprecated unused
5516 attribute_deprecated
5517 void avpicture_free(AVPicture *picture);
5520 * @deprecated use av_image_fill_arrays() instead.
5522 attribute_deprecated
5523 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5524 enum AVPixelFormat pix_fmt, int width, int height);
5527 * @deprecated use av_image_copy_to_buffer() instead.
5529 attribute_deprecated
5530 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5531 int width, int height,
5532 unsigned char *dest, int dest_size);
5535 * @deprecated use av_image_get_buffer_size() instead.
5537 attribute_deprecated
5538 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5541 * @deprecated av_image_copy() instead.
5543 attribute_deprecated
5544 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5545 enum AVPixelFormat pix_fmt, int width, int height);
5548 * @deprecated unused
5550 attribute_deprecated
5551 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5552 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5555 * @deprecated unused
5557 attribute_deprecated
5558 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5559 int padtop, int padbottom, int padleft, int padright, int *color);
5567 * @defgroup lavc_misc Utility functions
5570 * Miscellaneous utility functions related to both encoding and decoding
5576 * @defgroup lavc_misc_pixfmt Pixel formats
5578 * Functions for working with pixel formats.
5582 #if FF_API_GETCHROMA
5584 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5587 attribute_deprecated
5588 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5592 * Return a value representing the fourCC code associated to the
5593 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5596 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5599 * @deprecated see av_get_pix_fmt_loss()
5601 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5605 * Find the best pixel format to convert to given a certain source pixel
5606 * format. When converting from one pixel format to another, information loss
5607 * may occur. For example, when converting from RGB24 to GRAY, the color
5608 * information will be lost. Similarly, other losses occur when converting from
5609 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5610 * the given pixel formats should be used to suffer the least amount of loss.
5611 * The pixel formats from which it chooses one, are determined by the
5612 * pix_fmt_list parameter.
5615 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5616 * @param[in] src_pix_fmt source pixel format
5617 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5618 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5619 * @return The best pixel format to convert to or -1 if none was found.
5621 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5622 enum AVPixelFormat src_pix_fmt,
5623 int has_alpha, int *loss_ptr);
5626 * @deprecated see av_find_best_pix_fmt_of_2()
5628 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5629 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5631 attribute_deprecated
5632 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5633 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5635 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5641 #if FF_API_SET_DIMENSIONS
5643 * @deprecated this function is not supposed to be used from outside of lavc
5645 attribute_deprecated
5646 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5649 #if FF_API_TAG_STRING
5651 * Put a string representing the codec tag codec_tag in buf.
5653 * @param buf buffer to place codec tag in
5654 * @param buf_size size in bytes of buf
5655 * @param codec_tag codec tag to assign
5656 * @return the length of the string that would have been generated if
5657 * enough space had been available, excluding the trailing null
5659 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5661 attribute_deprecated
5662 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5665 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5668 * Return a name for the specified profile, if available.
5670 * @param codec the codec that is searched for the given profile
5671 * @param profile the profile value for which a name is requested
5672 * @return A name for the profile if found, NULL otherwise.
5674 const char *av_get_profile_name(const AVCodec *codec, int profile);
5677 * Return a name for the specified profile, if available.
5679 * @param codec_id the ID of the codec to which the requested profile belongs
5680 * @param profile the profile value for which a name is requested
5681 * @return A name for the profile if found, NULL otherwise.
5683 * @note unlike av_get_profile_name(), which searches a list of profiles
5684 * supported by a specific decoder or encoder implementation, this
5685 * function searches the list of profiles from the AVCodecDescriptor
5687 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5689 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5690 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5691 //FIXME func typedef
5694 * Fill AVFrame audio data and linesize pointers.
5696 * The buffer buf must be a preallocated buffer with a size big enough
5697 * to contain the specified samples amount. The filled AVFrame data
5698 * pointers will point to this buffer.
5700 * AVFrame extended_data channel pointers are allocated if necessary for
5703 * @param frame the AVFrame
5704 * frame->nb_samples must be set prior to calling the
5705 * function. This function fills in frame->data,
5706 * frame->extended_data, frame->linesize[0].
5707 * @param nb_channels channel count
5708 * @param sample_fmt sample format
5709 * @param buf buffer to use for frame data
5710 * @param buf_size size of buffer
5711 * @param align plane size sample alignment (0 = default)
5712 * @return >=0 on success, negative error code on failure
5713 * @todo return the size in bytes required to store the samples in
5714 * case of success, at the next libavutil bump
5716 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5717 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5718 int buf_size, int align);
5721 * Reset the internal decoder state / flush internal buffers. Should be called
5722 * e.g. when seeking or when switching to a different stream.
5724 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5725 * this invalidates the frames previously returned from the decoder. When
5726 * refcounted frames are used, the decoder just releases any references it might
5727 * keep internally, but the caller's reference remains valid.
5729 void avcodec_flush_buffers(AVCodecContext *avctx);
5732 * Return codec bits per sample.
5734 * @param[in] codec_id the codec
5735 * @return Number of bits per sample or zero if unknown for the given codec.
5737 int av_get_bits_per_sample(enum AVCodecID codec_id);
5740 * Return the PCM codec associated with a sample format.
5741 * @param be endianness, 0 for little, 1 for big,
5742 * -1 (or anything else) for native
5743 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5745 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5748 * Return codec bits per sample.
5749 * Only return non-zero if the bits per sample is exactly correct, not an
5752 * @param[in] codec_id the codec
5753 * @return Number of bits per sample or zero if unknown for the given codec.
5755 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5758 * Return audio frame duration.
5760 * @param avctx codec context
5761 * @param frame_bytes size of the frame, or 0 if unknown
5762 * @return frame duration, in samples, if known. 0 if not able to
5765 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5768 * This function is the same as av_get_audio_frame_duration(), except it works
5769 * with AVCodecParameters instead of an AVCodecContext.
5771 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5774 typedef struct AVBitStreamFilterContext {
5776 const struct AVBitStreamFilter *filter;
5777 AVCodecParserContext *parser;
5778 struct AVBitStreamFilterContext *next;
5780 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5781 * Not for access by library users.
5784 } AVBitStreamFilterContext;
5787 typedef struct AVBSFInternal AVBSFInternal;
5790 * The bitstream filter state.
5792 * This struct must be allocated with av_bsf_alloc() and freed with
5795 * The fields in the struct will only be changed (by the caller or by the
5796 * filter) as described in their documentation, and are to be considered
5797 * immutable otherwise.
5799 typedef struct AVBSFContext {
5801 * A class for logging and AVOptions
5803 const AVClass *av_class;
5806 * The bitstream filter this context is an instance of.
5808 const struct AVBitStreamFilter *filter;
5811 * Opaque libavcodec internal data. Must not be touched by the caller in any
5814 AVBSFInternal *internal;
5817 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5818 * this is an AVOptions-enabled struct.
5823 * Parameters of the input stream. This field is allocated in
5824 * av_bsf_alloc(), it needs to be filled by the caller before
5827 AVCodecParameters *par_in;
5830 * Parameters of the output stream. This field is allocated in
5831 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5833 AVCodecParameters *par_out;
5836 * The timebase used for the timestamps of the input packets. Set by the
5837 * caller before av_bsf_init().
5839 AVRational time_base_in;
5842 * The timebase used for the timestamps of the output packets. Set by the
5843 * filter in av_bsf_init().
5845 AVRational time_base_out;
5848 typedef struct AVBitStreamFilter {
5852 * A list of codec ids supported by the filter, terminated by
5854 * May be NULL, in that case the bitstream filter works with any codec id.
5856 const enum AVCodecID *codec_ids;
5859 * A class for the private data, used to declare bitstream filter private
5860 * AVOptions. This field is NULL for bitstream filters that do not declare
5863 * If this field is non-NULL, the first member of the filter private data
5864 * must be a pointer to AVClass, which will be set by libavcodec generic
5865 * code to this class.
5867 const AVClass *priv_class;
5869 /*****************************************************************
5870 * No fields below this line are part of the public API. They
5871 * may not be used outside of libavcodec and can be changed and
5873 * New public fields should be added right above.
5874 *****************************************************************
5878 int (*init)(AVBSFContext *ctx);
5879 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5880 void (*close)(AVBSFContext *ctx);
5881 } AVBitStreamFilter;
5885 * Register a bitstream filter.
5887 * The filter will be accessible to the application code through
5888 * av_bitstream_filter_next() or can be directly initialized with
5889 * av_bitstream_filter_init().
5891 * @see avcodec_register_all()
5893 attribute_deprecated
5894 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5897 * Create and initialize a bitstream filter context given a bitstream
5900 * The returned context must be freed with av_bitstream_filter_close().
5902 * @param name the name of the bitstream filter
5903 * @return a bitstream filter context if a matching filter was found
5904 * and successfully initialized, NULL otherwise
5906 attribute_deprecated
5907 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5912 * This function filters the buffer buf with size buf_size, and places the
5913 * filtered buffer in the buffer pointed to by poutbuf.
5915 * The output buffer must be freed by the caller.
5917 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5918 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5919 * If specified, this must point to the encoder context of the
5920 * output stream the packet is sent to.
5921 * @param args arguments which specify the filter configuration, may be NULL
5922 * @param poutbuf pointer which is updated to point to the filtered buffer
5923 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5924 * @param buf buffer containing the data to filter
5925 * @param buf_size size in bytes of buf
5926 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5927 * @return >= 0 in case of success, or a negative error code in case of failure
5929 * If the return value is positive, an output buffer is allocated and
5930 * is available in *poutbuf, and is distinct from the input buffer.
5932 * If the return value is 0, the output buffer is not allocated and
5933 * should be considered identical to the input buffer, or in case
5934 * *poutbuf was set it points to the input buffer (not necessarily to
5935 * its starting address). A special case is if *poutbuf was set to NULL and
5936 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5938 attribute_deprecated
5939 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5940 AVCodecContext *avctx, const char *args,
5941 uint8_t **poutbuf, int *poutbuf_size,
5942 const uint8_t *buf, int buf_size, int keyframe);
5945 * Release bitstream filter context.
5947 * @param bsf the bitstream filter context created with
5948 * av_bitstream_filter_init(), can be NULL
5950 attribute_deprecated
5951 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5954 * If f is NULL, return the first registered bitstream filter,
5955 * if f is non-NULL, return the next registered bitstream filter
5956 * after f, or NULL if f is the last one.
5958 * This function can be used to iterate over all registered bitstream
5961 attribute_deprecated
5962 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5966 * @return a bitstream filter with the specified name or NULL if no such
5967 * bitstream filter exists.
5969 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5972 * Iterate over all registered bitstream filters.
5974 * @param opaque a pointer where libavcodec will store the iteration state. Must
5975 * point to NULL to start the iteration.
5977 * @return the next registered bitstream filter or NULL when the iteration is
5980 const AVBitStreamFilter *av_bsf_next(void **opaque);
5983 * Allocate a context for a given bitstream filter. The caller must fill in the
5984 * context parameters as described in the documentation and then call
5985 * av_bsf_init() before sending any data to the filter.
5987 * @param filter the filter for which to allocate an instance.
5988 * @param ctx a pointer into which the pointer to the newly-allocated context
5989 * will be written. It must be freed with av_bsf_free() after the
5990 * filtering is done.
5992 * @return 0 on success, a negative AVERROR code on failure
5994 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5997 * Prepare the filter for use, after all the parameters and options have been
6000 int av_bsf_init(AVBSFContext *ctx);
6003 * Submit a packet for filtering.
6005 * After sending each packet, the filter must be completely drained by calling
6006 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
6009 * @param pkt the packet to filter. The bitstream filter will take ownership of
6010 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
6011 * This parameter may be NULL, which signals the end of the stream (i.e. no more
6012 * packets will be sent). That will cause the filter to output any packets it
6013 * may have buffered internally.
6015 * @return 0 on success, a negative AVERROR on error.
6017 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
6020 * Retrieve a filtered packet.
6022 * @param[out] pkt this struct will be filled with the contents of the filtered
6023 * packet. It is owned by the caller and must be freed using
6024 * av_packet_unref() when it is no longer needed.
6025 * This parameter should be "clean" (i.e. freshly allocated
6026 * with av_packet_alloc() or unreffed with av_packet_unref())
6027 * when this function is called. If this function returns
6028 * successfully, the contents of pkt will be completely
6029 * overwritten by the returned data. On failure, pkt is not
6032 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
6033 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
6034 * will be no further output from the filter. Another negative AVERROR value if
6037 * @note one input packet may result in several output packets, so after sending
6038 * a packet with av_bsf_send_packet(), this function needs to be called
6039 * repeatedly until it stops returning 0. It is also possible for a filter to
6040 * output fewer packets than were sent to it, so this function may return
6041 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6043 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6046 * Free a bitstream filter context and everything associated with it; write NULL
6047 * into the supplied pointer.
6049 void av_bsf_free(AVBSFContext **ctx);
6052 * Get the AVClass for AVBSFContext. It can be used in combination with
6053 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6055 * @see av_opt_find().
6057 const AVClass *av_bsf_get_class(void);
6060 * Structure for chain/list of bitstream filters.
6061 * Empty list can be allocated by av_bsf_list_alloc().
6063 typedef struct AVBSFList AVBSFList;
6066 * Allocate empty list of bitstream filters.
6067 * The list must be later freed by av_bsf_list_free()
6068 * or finalized by av_bsf_list_finalize().
6070 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6072 AVBSFList *av_bsf_list_alloc(void);
6075 * Free list of bitstream filters.
6077 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6079 void av_bsf_list_free(AVBSFList **lst);
6082 * Append bitstream filter to the list of bitstream filters.
6084 * @param lst List to append to
6085 * @param bsf Filter context to be appended
6087 * @return >=0 on success, negative AVERROR in case of failure
6089 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6092 * Construct new bitstream filter context given it's name and options
6093 * and append it to the list of bitstream filters.
6095 * @param lst List to append to
6096 * @param bsf_name Name of the bitstream filter
6097 * @param options Options for the bitstream filter, can be set to NULL
6099 * @return >=0 on success, negative AVERROR in case of failure
6101 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6103 * Finalize list of bitstream filters.
6105 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6106 * so the whole chain of bitstream filters can be treated as single filter
6107 * freshly allocated by av_bsf_alloc().
6108 * If the call is successful, @ref AVBSFList structure is freed and lst
6109 * will be set to NULL. In case of failure, caller is responsible for
6110 * freeing the structure by av_bsf_list_free()
6112 * @param lst Filter list structure to be transformed
6113 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6114 * representing the chain of bitstream filters
6116 * @return >=0 on success, negative AVERROR in case of failure
6118 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6121 * Parse string describing list of bitstream filters and create single
6122 * @ref AVBSFContext describing the whole chain of bitstream filters.
6123 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6124 * allocated by av_bsf_alloc().
6126 * @param str String describing chain of bitstream filters in format
6127 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6128 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6129 * representing the chain of bitstream filters
6131 * @return >=0 on success, negative AVERROR in case of failure
6133 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6136 * Get null/pass-through bitstream filter.
6138 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6142 int av_bsf_get_null_filter(AVBSFContext **bsf);
6147 * Same behaviour av_fast_malloc but the buffer has additional
6148 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6150 * In addition the whole buffer will initially and after resizes
6151 * be 0-initialized so that no uninitialized data will ever appear.
6153 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6156 * Same behaviour av_fast_padded_malloc except that buffer will always
6157 * be 0-initialized after call.
6159 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6162 * Encode extradata length to a buffer. Used by xiph codecs.
6164 * @param s buffer to write to; must be at least (v/255+1) bytes long
6165 * @param v size of extradata in bytes
6166 * @return number of bytes written to the buffer.
6168 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6171 * Register the hardware accelerator hwaccel.
6173 void av_register_hwaccel(AVHWAccel *hwaccel);
6176 * If hwaccel is NULL, returns the first registered hardware accelerator,
6177 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6178 * after hwaccel, or NULL if hwaccel is the last one.
6180 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6184 * Lock operation used by lockmgr
6187 AV_LOCK_CREATE, ///< Create a mutex
6188 AV_LOCK_OBTAIN, ///< Lock the mutex
6189 AV_LOCK_RELEASE, ///< Unlock the mutex
6190 AV_LOCK_DESTROY, ///< Free mutex resources
6194 * Register a user provided lock manager supporting the operations
6195 * specified by AVLockOp. The "mutex" argument to the function points
6196 * to a (void *) where the lockmgr should store/get a pointer to a user
6197 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6198 * value left by the last call for all other ops. If the lock manager is
6199 * unable to perform the op then it should leave the mutex in the same
6200 * state as when it was called and return a non-zero value. However,
6201 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6202 * have been successfully destroyed. If av_lockmgr_register succeeds
6203 * it will return a non-negative value, if it fails it will return a
6204 * negative value and destroy all mutex and unregister all callbacks.
6205 * av_lockmgr_register is not thread-safe, it must be called from a
6206 * single thread before any calls which make use of locking are used.
6208 * @param cb User defined callback. av_lockmgr_register invokes calls
6209 * to this callback and the previously registered callback.
6210 * The callback will be used to create more than one mutex
6211 * each of which must be backed by its own underlying locking
6212 * mechanism (i.e. do not use a single static object to
6213 * implement your lock manager). If cb is set to NULL the
6214 * lockmgr will be unregistered.
6216 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6219 * Get the type of the given codec.
6221 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6224 * Get the name of a codec.
6225 * @return a static string identifying the codec; never NULL
6227 const char *avcodec_get_name(enum AVCodecID id);
6230 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6231 * with no corresponding avcodec_close()), 0 otherwise.
6233 int avcodec_is_open(AVCodecContext *s);
6236 * @return a non-zero number if codec is an encoder, zero otherwise
6238 int av_codec_is_encoder(const AVCodec *codec);
6241 * @return a non-zero number if codec is a decoder, zero otherwise
6243 int av_codec_is_decoder(const AVCodec *codec);
6246 * @return descriptor for given codec ID or NULL if no descriptor exists.
6248 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6251 * Iterate over all codec descriptors known to libavcodec.
6253 * @param prev previous descriptor. NULL to get the first descriptor.
6255 * @return next descriptor or NULL after the last descriptor
6257 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6260 * @return codec descriptor with the given name or NULL if no such descriptor
6263 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6266 * Allocate a CPB properties structure and initialize its fields to default
6269 * @param size if non-NULL, the size of the allocated struct will be written
6270 * here. This is useful for embedding it in side data.
6272 * @return the newly allocated struct or NULL on failure
6274 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6280 #endif /* AVCODEC_AVCODEC_H */