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 */
589 AV_CODEC_ID_NELLYMOSER,
590 AV_CODEC_ID_MUSEPACK8,
592 AV_CODEC_ID_WMAVOICE,
594 AV_CODEC_ID_WMALOSSLESS,
603 AV_CODEC_ID_BINKAUDIO_RDFT,
604 AV_CODEC_ID_BINKAUDIO_DCT,
605 AV_CODEC_ID_AAC_LATM,
610 AV_CODEC_ID_8SVX_EXP,
611 AV_CODEC_ID_8SVX_FIB,
612 AV_CODEC_ID_BMV_AUDIO,
617 AV_CODEC_ID_COMFORT_NOISE,
619 AV_CODEC_ID_METASOUND,
620 AV_CODEC_ID_PAF_AUDIO,
624 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
626 AV_CODEC_ID_SONIC_LS,
629 AV_CODEC_ID_DSD_LSBF,
630 AV_CODEC_ID_DSD_MSBF,
631 AV_CODEC_ID_DSD_LSBF_PLANAR,
632 AV_CODEC_ID_DSD_MSBF_PLANAR,
634 AV_CODEC_ID_INTERPLAY_ACM,
638 AV_CODEC_ID_ATRAC3AL,
639 AV_CODEC_ID_ATRAC3PAL,
642 /* subtitle codecs */
643 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
644 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
645 AV_CODEC_ID_DVB_SUBTITLE,
646 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
649 AV_CODEC_ID_MOV_TEXT,
650 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
651 AV_CODEC_ID_DVB_TELETEXT,
654 AV_CODEC_ID_MICRODVD = 0x17800,
658 AV_CODEC_ID_REALTEXT,
660 AV_CODEC_ID_SUBVIEWER1,
661 AV_CODEC_ID_SUBVIEWER,
668 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
670 /* other specific kind of codecs (generally used for attachments) */
671 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
672 AV_CODEC_ID_TTF = 0x18000,
674 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
675 AV_CODEC_ID_BINTEXT = 0x18800,
679 AV_CODEC_ID_SMPTE_KLV,
681 AV_CODEC_ID_TIMED_ID3,
682 AV_CODEC_ID_BIN_DATA,
685 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
687 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
688 * stream (only used by libavformat) */
689 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
690 * stream (only used by libavformat) */
691 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
692 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
696 * This struct describes the properties of a single codec described by an
698 * @see avcodec_descriptor_get()
700 typedef struct AVCodecDescriptor {
702 enum AVMediaType type;
704 * Name of the codec described by this descriptor. It is non-empty and
705 * unique for each codec descriptor. It should contain alphanumeric
706 * characters and '_' only.
710 * A more descriptive name for this codec. May be NULL.
712 const char *long_name;
714 * Codec properties, a combination of AV_CODEC_PROP_* flags.
718 * MIME type(s) associated with the codec.
719 * May be NULL; if not, a NULL-terminated array of MIME types.
720 * The first item is always non-NULL and is the preferred MIME type.
722 const char *const *mime_types;
724 * If non-NULL, an array of profiles recognized for this codec.
725 * Terminated with FF_PROFILE_UNKNOWN.
727 const struct AVProfile *profiles;
731 * Codec uses only intra compression.
732 * Video and audio codecs only.
734 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
736 * Codec supports lossy compression. Audio and video codecs only.
737 * @note a codec may support both lossy and lossless
740 #define AV_CODEC_PROP_LOSSY (1 << 1)
742 * Codec supports lossless compression. Audio and video codecs only.
744 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
746 * Codec supports frame reordering. That is, the coded order (the order in which
747 * the encoded packets are output by the encoders / stored / input to the
748 * decoders) may be different from the presentation order of the corresponding
751 * For codecs that do not have this property set, PTS and DTS should always be
754 #define AV_CODEC_PROP_REORDER (1 << 3)
756 * Subtitle codec is bitmap based
757 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
759 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
761 * Subtitle codec is text based.
762 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
764 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
767 * @ingroup lavc_decoding
768 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
769 * This is mainly needed because some optimized bitstream readers read
770 * 32 or 64 bit at once and could read over the end.<br>
771 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
772 * MPEG bitstreams could cause overread and segfault.
774 #define AV_INPUT_BUFFER_PADDING_SIZE 32
777 * @ingroup lavc_encoding
778 * minimum encoding buffer size
779 * Used to avoid some checks during header writing.
781 #define AV_INPUT_BUFFER_MIN_SIZE 16384
783 #if FF_API_WITHOUT_PREFIX
785 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
787 #define FF_INPUT_BUFFER_PADDING_SIZE 32
790 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
792 #define FF_MIN_BUFFER_SIZE 16384
793 #endif /* FF_API_WITHOUT_PREFIX */
796 * @ingroup lavc_encoding
797 * motion estimation type.
798 * @deprecated use codec private option instead
800 #if FF_API_MOTION_EST
802 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
806 ME_EPZS, ///< enhanced predictive zonal search
807 ME_X1, ///< reserved for experiments
808 ME_HEX, ///< hexagon based search
809 ME_UMH, ///< uneven multi-hexagon search
810 ME_TESA, ///< transformed exhaustive search algorithm
811 ME_ITER=50, ///< iterative search
816 * @ingroup lavc_decoding
819 /* We leave some space between them for extensions (drop some
820 * keyframes for intra-only or drop just some bidir frames). */
821 AVDISCARD_NONE =-16, ///< discard nothing
822 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
823 AVDISCARD_NONREF = 8, ///< discard all non reference
824 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
825 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
826 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
827 AVDISCARD_ALL = 48, ///< discard all
830 enum AVAudioServiceType {
831 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
832 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
833 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
834 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
835 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
836 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
837 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
838 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
839 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
840 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
844 * @ingroup lavc_encoding
846 typedef struct RcOverride{
849 int qscale; // If this is 0 then quality_factor will be used instead.
850 float quality_factor;
853 #if FF_API_MAX_BFRAMES
855 * @deprecated there is no libavcodec-wide limit on the number of B-frames
857 #define FF_MAX_B_FRAMES 16
861 These flags can be passed in AVCodecContext.flags before initialization.
862 Note: Not everything is supported yet.
866 * Allow decoders to produce frames with data planes that are not aligned
867 * to CPU requirements (e.g. due to cropping).
869 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
873 #define AV_CODEC_FLAG_QSCALE (1 << 1)
875 * 4 MV per MB allowed / advanced prediction for H.263.
877 #define AV_CODEC_FLAG_4MV (1 << 2)
879 * Output even those frames that might be corrupted.
881 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
885 #define AV_CODEC_FLAG_QPEL (1 << 4)
887 * Use internal 2pass ratecontrol in first pass mode.
889 #define AV_CODEC_FLAG_PASS1 (1 << 9)
891 * Use internal 2pass ratecontrol in second pass mode.
893 #define AV_CODEC_FLAG_PASS2 (1 << 10)
897 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
899 * Only decode/encode grayscale.
901 #define AV_CODEC_FLAG_GRAY (1 << 13)
903 * error[?] variables will be set during encoding.
905 #define AV_CODEC_FLAG_PSNR (1 << 15)
907 * Input bitstream might be truncated at a random location
908 * instead of only at frame boundaries.
910 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
912 * Use interlaced DCT.
914 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
918 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
920 * Place global headers in extradata instead of every keyframe.
922 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
924 * Use only bitexact stuff (except (I)DCT).
926 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
927 /* Fx : Flag for H.263+ extra options */
929 * H.263 advanced intra coding / MPEG-4 AC prediction
931 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
933 * interlaced motion estimation
935 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
936 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
939 * Allow non spec compliant speedup tricks.
941 #define AV_CODEC_FLAG2_FAST (1 << 0)
943 * Skip bitstream encoding.
945 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
947 * Place global headers at every keyframe instead of in extradata.
949 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
952 * timecode is in drop frame format. DEPRECATED!!!!
954 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
957 * Input bitstream might be truncated at a packet boundaries
958 * instead of only at frame boundaries.
960 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
962 * Discard cropping information from SPS.
964 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
967 * Show all frames before the first keyframe
969 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
971 * Export motion vectors through frame side data
973 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
975 * Do not skip samples and export skip information as frame side data
977 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
979 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
981 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
983 /* Unsupported options :
984 * Syntax Arithmetic coding (SAC)
985 * Reference Picture Selection
986 * Independent Segment Decoding */
988 /* codec capabilities */
991 * Decoder can use draw_horiz_band callback.
993 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
995 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
996 * If not set, it might not use get_buffer() at all or use operations that
997 * assume the buffer was allocated by avcodec_default_get_buffer.
999 #define AV_CODEC_CAP_DR1 (1 << 1)
1000 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
1002 * Encoder or decoder requires flushing with NULL input at the end in order to
1003 * give the complete and correct output.
1005 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1006 * with NULL data. The user can still send NULL data to the public encode
1007 * or decode function, but libavcodec will not pass it along to the codec
1008 * unless this flag is set.
1011 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1012 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1016 * The encoder needs to be fed with NULL data at the end of encoding until the
1017 * encoder no longer returns data.
1019 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1020 * flag also means that the encoder must set the pts and duration for
1021 * each output packet. If this flag is not set, the pts and duration will
1022 * be determined by libavcodec from the input frame.
1024 #define AV_CODEC_CAP_DELAY (1 << 5)
1026 * Codec can be fed a final frame with a smaller size.
1027 * This can be used to prevent truncation of the last audio samples.
1029 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
1032 * Codec can output multiple frames per AVPacket
1033 * Normally demuxers return one frame at a time, demuxers which do not do
1034 * are connected to a parser to split what they return into proper frames.
1035 * This flag is reserved to the very rare category of codecs which have a
1036 * bitstream that cannot be split into frames without timeconsuming
1037 * operations like full decoding. Demuxers carrying such bitstreams thus
1038 * may return multiple frames in a packet. This has many disadvantages like
1039 * prohibiting stream copy in many cases thus it should only be considered
1042 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1044 * Codec is experimental and is thus avoided in favor of non experimental
1047 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1049 * Codec should fill in channel configuration and samplerate instead of container
1051 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1053 * Codec supports frame-level multithreading.
1055 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1057 * Codec supports slice-based (or partition-based) multithreading.
1059 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1061 * Codec supports changed parameters at any point.
1063 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1065 * Codec supports avctx->thread_count == 0 (auto).
1067 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1069 * Audio encoder supports receiving a different number of samples in each call.
1071 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1073 * Decoder is not a preferred choice for probing.
1074 * This indicates that the decoder is not a good choice for probing.
1075 * It could for example be an expensive to spin up hardware decoder,
1076 * or it could simply not provide a lot of useful information about
1078 * A decoder marked with this flag should only be used as last resort
1079 * choice for probing.
1081 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1083 * Codec is intra only.
1085 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1087 * Codec is lossless.
1089 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1092 #if FF_API_WITHOUT_PREFIX
1094 * Allow decoders to produce frames with data planes that are not aligned
1095 * to CPU requirements (e.g. due to cropping).
1097 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1098 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1099 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1100 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1101 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1104 * @deprecated use the "gmc" private option of the libxvid encoder
1106 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1110 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1111 * mpegvideo encoders
1113 #define CODEC_FLAG_MV0 0x0040
1115 #if FF_API_INPUT_PRESERVED
1117 * @deprecated passing reference-counted frames to the encoders replaces this
1120 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1122 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1123 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1124 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1127 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1130 #define CODEC_FLAG_EMU_EDGE 0x4000
1132 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1133 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1135 #if FF_API_NORMALIZE_AQP
1137 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1138 * mpegvideo encoders
1140 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1142 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1143 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1144 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1145 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1146 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1147 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1148 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1149 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1150 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1151 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1152 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1153 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1154 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1156 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1157 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1158 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1159 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1161 /* Unsupported options :
1162 * Syntax Arithmetic coding (SAC)
1163 * Reference Picture Selection
1164 * Independent Segment Decoding */
1166 /* codec capabilities */
1168 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1170 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1171 * If not set, it might not use get_buffer() at all or use operations that
1172 * assume the buffer was allocated by avcodec_default_get_buffer.
1174 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1175 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1177 /* Codec can export data for HW decoding. This flag indicates that
1178 * the codec would call get_format() with list that might contain HW accelerated
1179 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1180 * including raw image format.
1181 * The application can use the passed context to determine bitstream version,
1182 * chroma format, resolution etc.
1184 #define CODEC_CAP_HWACCEL 0x0010
1185 #endif /* FF_API_XVMC */
1187 * Encoder or decoder requires flushing with NULL input at the end in order to
1188 * give the complete and correct output.
1190 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1191 * with NULL data. The user can still send NULL data to the public encode
1192 * or decode function, but libavcodec will not pass it along to the codec
1193 * unless this flag is set.
1196 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1197 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1201 * The encoder needs to be fed with NULL data at the end of encoding until the
1202 * encoder no longer returns data.
1204 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1205 * flag also means that the encoder must set the pts and duration for
1206 * each output packet. If this flag is not set, the pts and duration will
1207 * be determined by libavcodec from the input frame.
1209 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1211 * Codec can be fed a final frame with a smaller size.
1212 * This can be used to prevent truncation of the last audio samples.
1214 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1217 * Codec can output multiple frames per AVPacket
1218 * Normally demuxers return one frame at a time, demuxers which do not do
1219 * are connected to a parser to split what they return into proper frames.
1220 * This flag is reserved to the very rare category of codecs which have a
1221 * bitstream that cannot be split into frames without timeconsuming
1222 * operations like full decoding. Demuxers carrying such bitstreams thus
1223 * may return multiple frames in a packet. This has many disadvantages like
1224 * prohibiting stream copy in many cases thus it should only be considered
1227 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1229 * Codec is experimental and is thus avoided in favor of non experimental
1232 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1234 * Codec should fill in channel configuration and samplerate instead of container
1236 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1237 #if FF_API_NEG_LINESIZES
1239 * @deprecated no codecs use this capability
1241 #define CODEC_CAP_NEG_LINESIZES 0x0800
1244 * Codec supports frame-level multithreading.
1246 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1248 * Codec supports slice-based (or partition-based) multithreading.
1250 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1252 * Codec supports changed parameters at any point.
1254 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1256 * Codec supports avctx->thread_count == 0 (auto).
1258 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1260 * Audio encoder supports receiving a different number of samples in each call.
1262 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1264 * Codec is intra only.
1266 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1268 * Codec is lossless.
1270 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1273 * HWAccel is experimental and is thus avoided in favor of non experimental
1276 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1277 #endif /* FF_API_WITHOUT_PREFIX */
1280 //The following defines may change, don't expect compatibility if you use them.
1281 #define MB_TYPE_INTRA4x4 0x0001
1282 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1283 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1284 #define MB_TYPE_16x16 0x0008
1285 #define MB_TYPE_16x8 0x0010
1286 #define MB_TYPE_8x16 0x0020
1287 #define MB_TYPE_8x8 0x0040
1288 #define MB_TYPE_INTERLACED 0x0080
1289 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1290 #define MB_TYPE_ACPRED 0x0200
1291 #define MB_TYPE_GMC 0x0400
1292 #define MB_TYPE_SKIP 0x0800
1293 #define MB_TYPE_P0L0 0x1000
1294 #define MB_TYPE_P1L0 0x2000
1295 #define MB_TYPE_P0L1 0x4000
1296 #define MB_TYPE_P1L1 0x8000
1297 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1298 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1299 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1300 #define MB_TYPE_QUANT 0x00010000
1301 #define MB_TYPE_CBP 0x00020000
1302 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1307 * This specifies the area which should be displayed.
1308 * Note there may be multiple such areas for one frame.
1310 typedef struct AVPanScan{
1313 * - encoding: Set by user.
1314 * - decoding: Set by libavcodec.
1319 * width and height in 1/16 pel
1320 * - encoding: Set by user.
1321 * - decoding: Set by libavcodec.
1327 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1328 * - encoding: Set by user.
1329 * - decoding: Set by libavcodec.
1331 int16_t position[3][2];
1335 * This structure describes the bitrate properties of an encoded bitstream. It
1336 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1337 * parameters for H.264/HEVC.
1339 typedef struct AVCPBProperties {
1341 * Maximum bitrate of the stream, in bits per second.
1342 * Zero if unknown or unspecified.
1346 * Minimum bitrate of the stream, in bits per second.
1347 * Zero if unknown or unspecified.
1351 * Average bitrate of the stream, in bits per second.
1352 * Zero if unknown or unspecified.
1357 * The size of the buffer to which the ratecontrol is applied, in bits.
1358 * Zero if unknown or unspecified.
1363 * The delay between the time the packet this structure is associated with
1364 * is received and the time when it should be decoded, in periods of a 27MHz
1367 * UINT64_MAX when unknown or unspecified.
1372 #if FF_API_QSCALE_TYPE
1373 #define FF_QSCALE_TYPE_MPEG1 0
1374 #define FF_QSCALE_TYPE_MPEG2 1
1375 #define FF_QSCALE_TYPE_H264 2
1376 #define FF_QSCALE_TYPE_VP56 3
1380 * The decoder will keep a reference to the frame and may reuse it later.
1382 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1385 * @defgroup lavc_packet AVPacket
1387 * Types and functions for working with AVPacket.
1390 enum AVPacketSideDataType {
1392 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1393 * bytes worth of palette. This side data signals that a new palette is
1396 AV_PKT_DATA_PALETTE,
1399 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1400 * that the extradata buffer was changed and the receiving side should
1401 * act upon it appropriately. The new extradata is embedded in the side
1402 * data buffer and should be immediately used for processing the current
1405 AV_PKT_DATA_NEW_EXTRADATA,
1408 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1411 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1412 * s32le channel_count
1413 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1414 * u64le channel_layout
1415 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1417 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1422 AV_PKT_DATA_PARAM_CHANGE,
1425 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1426 * structures with info about macroblocks relevant to splitting the
1427 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1428 * That is, it does not necessarily contain info about all macroblocks,
1429 * as long as the distance between macroblocks in the info is smaller
1430 * than the target payload size.
1431 * Each MB info structure is 12 bytes, and is laid out as follows:
1433 * u32le bit offset from the start of the packet
1434 * u8 current quantizer at the start of the macroblock
1436 * u16le macroblock address within the GOB
1437 * u8 horizontal MV predictor
1438 * u8 vertical MV predictor
1439 * u8 horizontal MV predictor for block number 3
1440 * u8 vertical MV predictor for block number 3
1443 AV_PKT_DATA_H263_MB_INFO,
1446 * This side data should be associated with an audio stream and contains
1447 * ReplayGain information in form of the AVReplayGain struct.
1449 AV_PKT_DATA_REPLAYGAIN,
1452 * This side data contains a 3x3 transformation matrix describing an affine
1453 * transformation that needs to be applied to the decoded video frames for
1454 * correct presentation.
1456 * See libavutil/display.h for a detailed description of the data.
1458 AV_PKT_DATA_DISPLAYMATRIX,
1461 * This side data should be associated with a video stream and contains
1462 * Stereoscopic 3D information in form of the AVStereo3D struct.
1464 AV_PKT_DATA_STEREO3D,
1467 * This side data should be associated with an audio stream and corresponds
1468 * to enum AVAudioServiceType.
1470 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1473 * This side data contains quality related information from the encoder.
1475 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1479 * u64le[error count] sum of squared differences between encoder in and output
1482 AV_PKT_DATA_QUALITY_STATS,
1485 * This side data contains an integer value representing the stream index
1486 * of a "fallback" track. A fallback track indicates an alternate
1487 * track to use when the current track can not be decoded for some reason.
1488 * e.g. no decoder available for codec.
1490 AV_PKT_DATA_FALLBACK_TRACK,
1493 * This side data corresponds to the AVCPBProperties struct.
1495 AV_PKT_DATA_CPB_PROPERTIES,
1498 * Recommmends skipping the specified number of samples
1500 * u32le number of samples to skip from start of this packet
1501 * u32le number of samples to skip from end of this packet
1502 * u8 reason for start skip
1503 * u8 reason for end skip (0=padding silence, 1=convergence)
1506 AV_PKT_DATA_SKIP_SAMPLES=70,
1509 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1510 * the packet may contain "dual mono" audio specific to Japanese DTV
1511 * and if it is true, recommends only the selected channel to be used.
1513 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1516 AV_PKT_DATA_JP_DUALMONO,
1519 * A list of zero terminated key/value strings. There is no end marker for
1520 * the list, so it is required to rely on the side data size to stop.
1522 AV_PKT_DATA_STRINGS_METADATA,
1525 * Subtitle event position
1533 AV_PKT_DATA_SUBTITLE_POSITION,
1536 * Data found in BlockAdditional element of matroska container. There is
1537 * no end marker for the data, so it is required to rely on the side data
1538 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1541 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1544 * The optional first identifier line of a WebVTT cue.
1546 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1549 * The optional settings (rendering instructions) that immediately
1550 * follow the timestamp specifier of a WebVTT cue.
1552 AV_PKT_DATA_WEBVTT_SETTINGS,
1555 * A list of zero terminated key/value strings. There is no end marker for
1556 * the list, so it is required to rely on the side data size to stop. This
1557 * side data includes updated metadata which appeared in the stream.
1559 AV_PKT_DATA_METADATA_UPDATE,
1562 * MPEGTS stream ID, this is required to pass the stream ID
1563 * information from the demuxer to the corresponding muxer.
1565 AV_PKT_DATA_MPEGTS_STREAM_ID,
1568 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1569 * should be associated with a video stream and contains data in the form
1570 * of the AVMasteringDisplayMetadata struct.
1572 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1575 * This side data should be associated with a video stream and corresponds
1576 * to the AVSphericalMapping structure.
1578 AV_PKT_DATA_SPHERICAL,
1581 * Content light level (based on CTA-861.3). This metadata should be
1582 * associated with a video stream and contains data in the form of the
1583 * AVContentLightMetadata struct.
1585 AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1588 * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1589 * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1590 * The number of bytes of CC data is AVPacketSideData.size.
1595 * The number of side data elements (in fact a bit more than it).
1596 * This is not part of the public API/ABI in the sense that it may
1597 * change when new side data types are added.
1598 * This must stay the last enum value.
1599 * If its value becomes huge, some code using it
1600 * needs to be updated as it assumes it to be smaller than other limits.
1605 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1607 typedef struct AVPacketSideData {
1610 enum AVPacketSideDataType type;
1614 * This structure stores compressed data. It is typically exported by demuxers
1615 * and then passed as input to decoders, or received as output from encoders and
1616 * then passed to muxers.
1618 * For video, it should typically contain one compressed frame. For audio it may
1619 * contain several compressed frames. Encoders are allowed to output empty
1620 * packets, with no compressed data, containing only side data
1621 * (e.g. to update some stream parameters at the end of encoding).
1623 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1624 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1625 * without libavcodec and libavformat major bump.
1627 * The semantics of data ownership depends on the buf field.
1628 * If it is set, the packet data is dynamically allocated and is
1629 * valid indefinitely until a call to av_packet_unref() reduces the
1630 * reference count to 0.
1632 * If the buf field is not set av_packet_ref() would make a copy instead
1633 * of increasing the reference count.
1635 * The side data is always allocated with av_malloc(), copied by
1636 * av_packet_ref() and freed by av_packet_unref().
1638 * @see av_packet_ref
1639 * @see av_packet_unref
1641 typedef struct AVPacket {
1643 * A reference to the reference-counted buffer where the packet data is
1645 * May be NULL, then the packet data is not reference-counted.
1649 * Presentation timestamp in AVStream->time_base units; the time at which
1650 * the decompressed packet will be presented to the user.
1651 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1652 * pts MUST be larger or equal to dts as presentation cannot happen before
1653 * decompression, unless one wants to view hex dumps. Some formats misuse
1654 * the terms dts and pts/cts to mean something different. Such timestamps
1655 * must be converted to true pts/dts before they are stored in AVPacket.
1659 * Decompression timestamp in AVStream->time_base units; the time at which
1660 * the packet is decompressed.
1661 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1668 * A combination of AV_PKT_FLAG values
1672 * Additional packet data that can be provided by the container.
1673 * Packet can contain several types of side information.
1675 AVPacketSideData *side_data;
1676 int side_data_elems;
1679 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1680 * Equals next_pts - this_pts in presentation order.
1684 int64_t pos; ///< byte position in stream, -1 if unknown
1686 #if FF_API_CONVERGENCE_DURATION
1688 * @deprecated Same as the duration field, but as int64_t. This was required
1689 * for Matroska subtitles, whose duration values could overflow when the
1690 * duration field was still an int.
1692 attribute_deprecated
1693 int64_t convergence_duration;
1696 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1697 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1699 * Flag is used to discard packets which are required to maintain valid
1700 * decoder state but are not required for output and should be dropped
1703 #define AV_PKT_FLAG_DISCARD 0x0004
1705 * The packet comes from a trusted source.
1707 * Otherwise-unsafe constructs such as arbitrary pointers to data
1708 * outside the packet may be followed.
1710 #define AV_PKT_FLAG_TRUSTED 0x0008
1712 enum AVSideDataParamChangeFlags {
1713 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1714 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1715 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1716 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1722 struct AVCodecInternal;
1726 AV_FIELD_PROGRESSIVE,
1727 AV_FIELD_TT, //< Top coded_first, top displayed first
1728 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1729 AV_FIELD_TB, //< Top coded first, bottom displayed first
1730 AV_FIELD_BT, //< Bottom coded first, top displayed first
1734 * main external API structure.
1735 * New fields can be added to the end with minor version bumps.
1736 * Removal, reordering and changes to existing fields require a major
1738 * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1740 * The name string for AVOptions options matches the associated command line
1741 * parameter name and can be found in libavcodec/options_table.h
1742 * The AVOption/command line parameter names differ in some cases from the C
1743 * structure field names for historic reasons or brevity.
1744 * sizeof(AVCodecContext) must not be used outside libav*.
1746 typedef struct AVCodecContext {
1748 * information on struct for av_log
1749 * - set by avcodec_alloc_context3
1751 const AVClass *av_class;
1752 int log_level_offset;
1754 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1755 const struct AVCodec *codec;
1756 #if FF_API_CODEC_NAME
1758 * @deprecated this field is not used for anything in libavcodec
1760 attribute_deprecated
1761 char codec_name[32];
1763 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1766 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1767 * This is used to work around some encoder bugs.
1768 * A demuxer should set this to what is stored in the field used to identify the codec.
1769 * If there are multiple such fields in a container then the demuxer should choose the one
1770 * which maximizes the information about the used codec.
1771 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1772 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1773 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1775 * - encoding: Set by user, if not then the default based on codec_id will be used.
1776 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1778 unsigned int codec_tag;
1780 #if FF_API_STREAM_CODEC_TAG
1782 * @deprecated this field is unused
1784 attribute_deprecated
1785 unsigned int stream_codec_tag;
1791 * Private context used for internal data.
1793 * Unlike priv_data, this is not codec-specific. It is used in general
1794 * libavcodec functions.
1796 struct AVCodecInternal *internal;
1799 * Private data of the user, can be used to carry app specific stuff.
1800 * - encoding: Set by user.
1801 * - decoding: Set by user.
1806 * the average bitrate
1807 * - encoding: Set by user; unused for constant quantizer encoding.
1808 * - decoding: Set by user, may be overwritten by libavcodec
1809 * if this info is available in the stream
1814 * number of bits the bitstream is allowed to diverge from the reference.
1815 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1816 * - encoding: Set by user; unused for constant quantizer encoding.
1817 * - decoding: unused
1819 int bit_rate_tolerance;
1822 * Global quality for codecs which cannot change it per frame.
1823 * This should be proportional to MPEG-1/2/4 qscale.
1824 * - encoding: Set by user.
1825 * - decoding: unused
1830 * - encoding: Set by user.
1831 * - decoding: unused
1833 int compression_level;
1834 #define FF_COMPRESSION_DEFAULT -1
1838 * - encoding: Set by user.
1839 * - decoding: Set by user.
1845 * - encoding: Set by user.
1846 * - decoding: Set by user.
1851 * some codecs need / can use extradata like Huffman tables.
1852 * MJPEG: Huffman tables
1853 * rv10: additional flags
1854 * MPEG-4: global headers (they can be in the bitstream or here)
1855 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1856 * than extradata_size to avoid problems if it is read with the bitstream reader.
1857 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1858 * - encoding: Set/allocated/freed by libavcodec.
1859 * - decoding: Set/allocated/freed by user.
1865 * This is the fundamental unit of time (in seconds) in terms
1866 * of which frame timestamps are represented. For fixed-fps content,
1867 * timebase should be 1/framerate and timestamp increments should be
1869 * This often, but not always is the inverse of the frame rate or field rate
1870 * for video. 1/time_base is not the average frame rate if the frame rate is not
1873 * Like containers, elementary streams also can store timestamps, 1/time_base
1874 * is the unit in which these timestamps are specified.
1875 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1876 * vop_time_increment_resolution and fixed_vop_rate
1877 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1879 * - encoding: MUST be set by user.
1880 * - decoding: the use of this field for decoding is deprecated.
1881 * Use framerate instead.
1883 AVRational time_base;
1886 * For some codecs, the time base is closer to the field rate than the frame rate.
1887 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1888 * if no telecine is used ...
1890 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1892 int ticks_per_frame;
1897 * Encoding: Number of frames delay there will be from the encoder input to
1898 * the decoder output. (we assume the decoder matches the spec)
1899 * Decoding: Number of frames delay in addition to what a standard decoder
1900 * as specified in the spec would produce.
1903 * Number of frames the decoded output will be delayed relative to the
1907 * For encoding, this field is unused (see initial_padding).
1909 * For decoding, this is the number of samples the decoder needs to
1910 * output before the decoder's output is valid. When seeking, you should
1911 * start decoding this many samples prior to your desired seek point.
1913 * - encoding: Set by libavcodec.
1914 * - decoding: Set by libavcodec.
1921 * picture width / height.
1923 * @note Those fields may not match the values of the last
1924 * AVFrame output by avcodec_decode_video2 due frame
1927 * - encoding: MUST be set by user.
1928 * - decoding: May be set by the user before opening the decoder if known e.g.
1929 * from the container. Some decoders will require the dimensions
1930 * to be set by the caller. During decoding, the decoder may
1931 * overwrite those values as required while parsing the data.
1936 * Bitstream width / height, may be different from width/height e.g. when
1937 * the decoded frame is cropped before being output or lowres is enabled.
1939 * @note Those field may not match the value of the last
1940 * AVFrame output by avcodec_receive_frame() due frame
1943 * - encoding: unused
1944 * - decoding: May be set by the user before opening the decoder if known
1945 * e.g. from the container. During decoding, the decoder may
1946 * overwrite those values as required while parsing the data.
1948 int coded_width, coded_height;
1950 #if FF_API_ASPECT_EXTENDED
1951 #define FF_ASPECT_EXTENDED 15
1955 * the number of pictures in a group of pictures, or 0 for intra_only
1956 * - encoding: Set by user.
1957 * - decoding: unused
1962 * Pixel format, see AV_PIX_FMT_xxx.
1963 * May be set by the demuxer if known from headers.
1964 * May be overridden by the decoder if it knows better.
1966 * @note This field may not match the value of the last
1967 * AVFrame output by avcodec_receive_frame() due frame
1970 * - encoding: Set by user.
1971 * - decoding: Set by user if known, overridden by libavcodec while
1974 enum AVPixelFormat pix_fmt;
1976 #if FF_API_MOTION_EST
1978 * This option does nothing
1979 * @deprecated use codec private options instead
1981 attribute_deprecated int me_method;
1985 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1986 * decoder to draw a horizontal band. It improves cache usage. Not
1987 * all codecs can do that. You must check the codec capabilities
1989 * When multithreading is used, it may be called from multiple threads
1990 * at the same time; threads might draw different parts of the same AVFrame,
1991 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1993 * The function is also used by hardware acceleration APIs.
1994 * It is called at least once during frame decoding to pass
1995 * the data needed for hardware render.
1996 * In that mode instead of pixel data, AVFrame points to
1997 * a structure specific to the acceleration API. The application
1998 * reads the structure and can change some fields to indicate progress
2000 * - encoding: unused
2001 * - decoding: Set by user.
2002 * @param height the height of the slice
2003 * @param y the y position of the slice
2004 * @param type 1->top field, 2->bottom field, 3->frame
2005 * @param offset offset into the AVFrame.data from which the slice should be read
2007 void (*draw_horiz_band)(struct AVCodecContext *s,
2008 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
2009 int y, int type, int height);
2012 * callback to negotiate the pixelFormat
2013 * @param fmt is the list of formats which are supported by the codec,
2014 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2015 * The first is always the native one.
2016 * @note The callback may be called again immediately if initialization for
2017 * the selected (hardware-accelerated) pixel format failed.
2018 * @warning Behavior is undefined if the callback returns a value not
2019 * in the fmt list of formats.
2020 * @return the chosen format
2021 * - encoding: unused
2022 * - decoding: Set by user, if not set the native format will be chosen.
2024 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
2027 * maximum number of B-frames between non-B-frames
2028 * Note: The output will be delayed by max_b_frames+1 relative to the input.
2029 * - encoding: Set by user.
2030 * - decoding: unused
2035 * qscale factor between IP and B-frames
2036 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
2037 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2038 * - encoding: Set by user.
2039 * - decoding: unused
2041 float b_quant_factor;
2043 #if FF_API_RC_STRATEGY
2044 /** @deprecated use codec private option instead */
2045 attribute_deprecated int rc_strategy;
2046 #define FF_RC_STRATEGY_XVID 1
2049 #if FF_API_PRIVATE_OPT
2050 /** @deprecated use encoder private options instead */
2051 attribute_deprecated
2052 int b_frame_strategy;
2056 * qscale offset between IP and B-frames
2057 * - encoding: Set by user.
2058 * - decoding: unused
2060 float b_quant_offset;
2063 * Size of the frame reordering buffer in the decoder.
2064 * For MPEG-2 it is 1 IPB or 0 low delay IP.
2065 * - encoding: Set by libavcodec.
2066 * - decoding: Set by libavcodec.
2070 #if FF_API_PRIVATE_OPT
2071 /** @deprecated use encoder private options instead */
2072 attribute_deprecated
2077 * qscale factor between P- and I-frames
2078 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2079 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2080 * - encoding: Set by user.
2081 * - decoding: unused
2083 float i_quant_factor;
2086 * qscale offset between P and I-frames
2087 * - encoding: Set by user.
2088 * - decoding: unused
2090 float i_quant_offset;
2093 * luminance masking (0-> disabled)
2094 * - encoding: Set by user.
2095 * - decoding: unused
2100 * temporary complexity masking (0-> disabled)
2101 * - encoding: Set by user.
2102 * - decoding: unused
2104 float temporal_cplx_masking;
2107 * spatial complexity masking (0-> disabled)
2108 * - encoding: Set by user.
2109 * - decoding: unused
2111 float spatial_cplx_masking;
2114 * p block masking (0-> disabled)
2115 * - encoding: Set by user.
2116 * - decoding: unused
2121 * darkness masking (0-> disabled)
2122 * - encoding: Set by user.
2123 * - decoding: unused
2129 * - encoding: Set by libavcodec.
2130 * - decoding: Set by user (or 0).
2134 #if FF_API_PRIVATE_OPT
2135 /** @deprecated use encoder private options instead */
2136 attribute_deprecated
2137 int prediction_method;
2138 #define FF_PRED_LEFT 0
2139 #define FF_PRED_PLANE 1
2140 #define FF_PRED_MEDIAN 2
2144 * slice offsets in the frame in bytes
2145 * - encoding: Set/allocated by libavcodec.
2146 * - decoding: Set/allocated by user (or NULL).
2151 * sample aspect ratio (0 if unknown)
2152 * That is the width of a pixel divided by the height of the pixel.
2153 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2154 * - encoding: Set by user.
2155 * - decoding: Set by libavcodec.
2157 AVRational sample_aspect_ratio;
2160 * motion estimation comparison function
2161 * - encoding: Set by user.
2162 * - decoding: unused
2166 * subpixel motion estimation comparison function
2167 * - encoding: Set by user.
2168 * - decoding: unused
2172 * macroblock comparison function (not supported yet)
2173 * - encoding: Set by user.
2174 * - decoding: unused
2178 * interlaced DCT comparison function
2179 * - encoding: Set by user.
2180 * - decoding: unused
2183 #define FF_CMP_SAD 0
2184 #define FF_CMP_SSE 1
2185 #define FF_CMP_SATD 2
2186 #define FF_CMP_DCT 3
2187 #define FF_CMP_PSNR 4
2188 #define FF_CMP_BIT 5
2190 #define FF_CMP_ZERO 7
2191 #define FF_CMP_VSAD 8
2192 #define FF_CMP_VSSE 9
2193 #define FF_CMP_NSSE 10
2194 #define FF_CMP_W53 11
2195 #define FF_CMP_W97 12
2196 #define FF_CMP_DCTMAX 13
2197 #define FF_CMP_DCT264 14
2198 #define FF_CMP_MEDIAN_SAD 15
2199 #define FF_CMP_CHROMA 256
2202 * ME diamond size & shape
2203 * - encoding: Set by user.
2204 * - decoding: unused
2209 * amount of previous MV predictors (2a+1 x 2a+1 square)
2210 * - encoding: Set by user.
2211 * - decoding: unused
2213 int last_predictor_count;
2215 #if FF_API_PRIVATE_OPT
2216 /** @deprecated use encoder private options instead */
2217 attribute_deprecated
2222 * motion estimation prepass comparison function
2223 * - encoding: Set by user.
2224 * - decoding: unused
2229 * ME prepass diamond size & shape
2230 * - encoding: Set by user.
2231 * - decoding: unused
2237 * - encoding: Set by user.
2238 * - decoding: unused
2240 int me_subpel_quality;
2244 * DTG active format information (additional aspect ratio
2245 * information only used in DVB MPEG-2 transport streams)
2248 * - encoding: unused
2249 * - decoding: Set by decoder.
2250 * @deprecated Deprecated in favor of AVSideData
2252 attribute_deprecated int dtg_active_format;
2253 #define FF_DTG_AFD_SAME 8
2254 #define FF_DTG_AFD_4_3 9
2255 #define FF_DTG_AFD_16_9 10
2256 #define FF_DTG_AFD_14_9 11
2257 #define FF_DTG_AFD_4_3_SP_14_9 13
2258 #define FF_DTG_AFD_16_9_SP_14_9 14
2259 #define FF_DTG_AFD_SP_4_3 15
2260 #endif /* FF_API_AFD */
2263 * maximum motion estimation search range in subpel units
2264 * If 0 then no limit.
2266 * - encoding: Set by user.
2267 * - decoding: unused
2271 #if FF_API_QUANT_BIAS
2273 * @deprecated use encoder private option instead
2275 attribute_deprecated int intra_quant_bias;
2276 #define FF_DEFAULT_QUANT_BIAS 999999
2279 * @deprecated use encoder private option instead
2281 attribute_deprecated int inter_quant_bias;
2286 * - encoding: unused
2287 * - decoding: Set by user.
2290 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2291 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2292 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2296 * XVideo Motion Acceleration
2297 * - encoding: forbidden
2298 * - decoding: set by decoder
2299 * @deprecated XvMC doesn't need it anymore.
2301 attribute_deprecated int xvmc_acceleration;
2302 #endif /* FF_API_XVMC */
2305 * macroblock decision mode
2306 * - encoding: Set by user.
2307 * - decoding: unused
2310 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2311 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2312 #define FF_MB_DECISION_RD 2 ///< rate distortion
2315 * custom intra quantization matrix
2316 * - encoding: Set by user, can be NULL.
2317 * - decoding: Set by libavcodec.
2319 uint16_t *intra_matrix;
2322 * custom inter quantization matrix
2323 * - encoding: Set by user, can be NULL.
2324 * - decoding: Set by libavcodec.
2326 uint16_t *inter_matrix;
2328 #if FF_API_PRIVATE_OPT
2329 /** @deprecated use encoder private options instead */
2330 attribute_deprecated
2331 int scenechange_threshold;
2333 /** @deprecated use encoder private options instead */
2334 attribute_deprecated
2335 int noise_reduction;
2340 * @deprecated this field is unused
2342 attribute_deprecated
2346 * @deprecated this field is unused
2348 attribute_deprecated
2353 * precision of the intra DC coefficient - 8
2354 * - encoding: Set by user.
2355 * - decoding: Set by libavcodec
2357 int intra_dc_precision;
2360 * Number of macroblock rows at the top which are skipped.
2361 * - encoding: unused
2362 * - decoding: Set by user.
2367 * Number of macroblock rows at the bottom which are skipped.
2368 * - encoding: unused
2369 * - decoding: Set by user.
2375 * @deprecated use encoder private options instead
2377 attribute_deprecated
2378 float border_masking;
2382 * minimum MB Lagrange multiplier
2383 * - encoding: Set by user.
2384 * - decoding: unused
2389 * maximum MB Lagrange multiplier
2390 * - encoding: Set by user.
2391 * - decoding: unused
2395 #if FF_API_PRIVATE_OPT
2397 * @deprecated use encoder private options instead
2399 attribute_deprecated
2400 int me_penalty_compensation;
2404 * - encoding: Set by user.
2405 * - decoding: unused
2409 #if FF_API_PRIVATE_OPT
2410 /** @deprecated use encoder private options instead */
2411 attribute_deprecated
2417 * - encoding: Set by user.
2418 * - decoding: unused
2423 * number of reference frames
2424 * - encoding: Set by user.
2425 * - decoding: Set by lavc.
2429 #if FF_API_PRIVATE_OPT
2430 /** @deprecated use encoder private options instead */
2431 attribute_deprecated
2435 #if FF_API_UNUSED_MEMBERS
2437 * Multiplied by qscale for each frame and added to scene_change_score.
2438 * - encoding: Set by user.
2439 * - decoding: unused
2441 attribute_deprecated int scenechange_factor;
2445 * Note: Value depends upon the compare function used for fullpel ME.
2446 * - encoding: Set by user.
2447 * - decoding: unused
2451 #if FF_API_PRIVATE_OPT
2452 /** @deprecated use encoder private options instead */
2453 attribute_deprecated
2458 * Chromaticity coordinates of the source primaries.
2459 * - encoding: Set by user
2460 * - decoding: Set by libavcodec
2462 enum AVColorPrimaries color_primaries;
2465 * Color Transfer Characteristic.
2466 * - encoding: Set by user
2467 * - decoding: Set by libavcodec
2469 enum AVColorTransferCharacteristic color_trc;
2472 * YUV colorspace type.
2473 * - encoding: Set by user
2474 * - decoding: Set by libavcodec
2476 enum AVColorSpace colorspace;
2479 * MPEG vs JPEG YUV range.
2480 * - encoding: Set by user
2481 * - decoding: Set by libavcodec
2483 enum AVColorRange color_range;
2486 * This defines the location of chroma samples.
2487 * - encoding: Set by user
2488 * - decoding: Set by libavcodec
2490 enum AVChromaLocation chroma_sample_location;
2494 * Indicates number of picture subdivisions. Used for parallelized
2496 * - encoding: Set by user
2497 * - decoding: unused
2502 * - encoding: set by libavcodec
2503 * - decoding: Set by user.
2505 enum AVFieldOrder field_order;
2508 int sample_rate; ///< samples per second
2509 int channels; ///< number of audio channels
2512 * audio sample format
2513 * - encoding: Set by user.
2514 * - decoding: Set by libavcodec.
2516 enum AVSampleFormat sample_fmt; ///< sample format
2518 /* The following data should not be initialized. */
2520 * Number of samples per channel in an audio frame.
2522 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2523 * except the last must contain exactly frame_size samples per channel.
2524 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2525 * frame size is not restricted.
2526 * - decoding: may be set by some decoders to indicate constant frame size
2531 * Frame counter, set by libavcodec.
2533 * - decoding: total number of frames returned from the decoder so far.
2534 * - encoding: total number of frames passed to the encoder so far.
2536 * @note the counter is not incremented if encoding/decoding resulted in
2542 * number of bytes per packet if constant and known or 0
2543 * Used by some WAV based audio codecs.
2548 * Audio cutoff bandwidth (0 means "automatic")
2549 * - encoding: Set by user.
2550 * - decoding: unused
2555 * Audio channel layout.
2556 * - encoding: set by user.
2557 * - decoding: set by user, may be overwritten by libavcodec.
2559 uint64_t channel_layout;
2562 * Request decoder to use this channel layout if it can (0 for default)
2563 * - encoding: unused
2564 * - decoding: Set by user.
2566 uint64_t request_channel_layout;
2569 * Type of service that the audio stream conveys.
2570 * - encoding: Set by user.
2571 * - decoding: Set by libavcodec.
2573 enum AVAudioServiceType audio_service_type;
2576 * desired sample format
2577 * - encoding: Not used.
2578 * - decoding: Set by user.
2579 * Decoder will decode to this format if it can.
2581 enum AVSampleFormat request_sample_fmt;
2584 * This callback is called at the beginning of each frame to get data
2585 * buffer(s) for it. There may be one contiguous buffer for all the data or
2586 * there may be a buffer per each data plane or anything in between. What
2587 * this means is, you may set however many entries in buf[] you feel necessary.
2588 * Each buffer must be reference-counted using the AVBuffer API (see description
2591 * The following fields will be set in the frame before this callback is
2594 * - width, height (video only)
2595 * - sample_rate, channel_layout, nb_samples (audio only)
2596 * Their values may differ from the corresponding values in
2597 * AVCodecContext. This callback must use the frame values, not the codec
2598 * context values, to calculate the required buffer size.
2600 * This callback must fill the following fields in the frame:
2604 * * if the data is planar audio with more than 8 channels, then this
2605 * callback must allocate and fill extended_data to contain all pointers
2606 * to all data planes. data[] must hold as many pointers as it can.
2607 * extended_data must be allocated with av_malloc() and will be freed in
2609 * * otherwise extended_data must point to data
2610 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2611 * the frame's data and extended_data pointers must be contained in these. That
2612 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2613 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2614 * and av_buffer_ref().
2615 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2616 * this callback and filled with the extra buffers if there are more
2617 * buffers than buf[] can hold. extended_buf will be freed in
2620 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2621 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2624 * Each data plane must be aligned to the maximum required by the target
2627 * @see avcodec_default_get_buffer2()
2631 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2632 * (read and/or written to if it is writable) later by libavcodec.
2634 * avcodec_align_dimensions2() should be used to find the required width and
2635 * height, as they normally need to be rounded up to the next multiple of 16.
2637 * Some decoders do not support linesizes changing between frames.
2639 * If frame multithreading is used and thread_safe_callbacks is set,
2640 * this callback may be called from a different thread, but not from more
2641 * than one at once. Does not need to be reentrant.
2643 * @see avcodec_align_dimensions2()
2647 * Decoders request a buffer of a particular size by setting
2648 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2649 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2650 * to a smaller value in the output frame.
2652 * As a convenience, av_samples_get_buffer_size() and
2653 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2654 * functions to find the required data size and to fill data pointers and
2655 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2656 * since all planes must be the same size.
2658 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2660 * - encoding: unused
2661 * - decoding: Set by libavcodec, user can override.
2663 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2666 * If non-zero, the decoded audio and video frames returned from
2667 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2668 * and are valid indefinitely. The caller must free them with
2669 * av_frame_unref() when they are not needed anymore.
2670 * Otherwise, the decoded frames must not be freed by the caller and are
2671 * only valid until the next decode call.
2673 * This is always automatically enabled if avcodec_receive_frame() is used.
2675 * - encoding: unused
2676 * - decoding: set by the caller before avcodec_open2().
2678 attribute_deprecated
2679 int refcounted_frames;
2681 /* - encoding parameters */
2682 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2683 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2687 * - encoding: Set by user.
2688 * - decoding: unused
2694 * - encoding: Set by user.
2695 * - decoding: unused
2700 * maximum quantizer difference between frames
2701 * - encoding: Set by user.
2702 * - decoding: unused
2708 * @deprecated use encoder private options instead
2710 attribute_deprecated
2713 attribute_deprecated
2715 attribute_deprecated
2720 * decoder bitstream buffer size
2721 * - encoding: Set by user.
2722 * - decoding: unused
2727 * ratecontrol override, see RcOverride
2728 * - encoding: Allocated/set/freed by user.
2729 * - decoding: unused
2731 int rc_override_count;
2732 RcOverride *rc_override;
2736 * @deprecated use encoder private options instead
2738 attribute_deprecated
2744 * - encoding: Set by user.
2745 * - decoding: Set by user, may be overwritten by libavcodec.
2747 int64_t rc_max_rate;
2751 * - encoding: Set by user.
2752 * - decoding: unused
2754 int64_t rc_min_rate;
2758 * @deprecated use encoder private options instead
2760 attribute_deprecated
2761 float rc_buffer_aggressivity;
2763 attribute_deprecated
2764 float rc_initial_cplx;
2768 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2769 * - encoding: Set by user.
2770 * - decoding: unused.
2772 float rc_max_available_vbv_use;
2775 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2776 * - encoding: Set by user.
2777 * - decoding: unused.
2779 float rc_min_vbv_overflow_use;
2782 * Number of bits which should be loaded into the rc buffer before decoding starts.
2783 * - encoding: Set by user.
2784 * - decoding: unused
2786 int rc_initial_buffer_occupancy;
2788 #if FF_API_CODER_TYPE
2789 #define FF_CODER_TYPE_VLC 0
2790 #define FF_CODER_TYPE_AC 1
2791 #define FF_CODER_TYPE_RAW 2
2792 #define FF_CODER_TYPE_RLE 3
2793 #if FF_API_UNUSED_MEMBERS
2794 #define FF_CODER_TYPE_DEFLATE 4
2795 #endif /* FF_API_UNUSED_MEMBERS */
2797 * @deprecated use encoder private options instead
2799 attribute_deprecated
2801 #endif /* FF_API_CODER_TYPE */
2803 #if FF_API_PRIVATE_OPT
2804 /** @deprecated use encoder private options instead */
2805 attribute_deprecated
2811 * @deprecated use encoder private options instead
2813 attribute_deprecated
2817 * @deprecated use encoder private options instead
2819 attribute_deprecated
2823 #if FF_API_PRIVATE_OPT
2824 /** @deprecated use encoder private options instead */
2825 attribute_deprecated
2826 int frame_skip_threshold;
2828 /** @deprecated use encoder private options instead */
2829 attribute_deprecated
2830 int frame_skip_factor;
2832 /** @deprecated use encoder private options instead */
2833 attribute_deprecated
2836 /** @deprecated use encoder private options instead */
2837 attribute_deprecated
2839 #endif /* FF_API_PRIVATE_OPT */
2842 * trellis RD quantization
2843 * - encoding: Set by user.
2844 * - decoding: unused
2848 #if FF_API_PRIVATE_OPT
2849 /** @deprecated use encoder private options instead */
2850 attribute_deprecated
2851 int min_prediction_order;
2853 /** @deprecated use encoder private options instead */
2854 attribute_deprecated
2855 int max_prediction_order;
2857 /** @deprecated use encoder private options instead */
2858 attribute_deprecated
2859 int64_t timecode_frame_start;
2862 #if FF_API_RTP_CALLBACK
2864 * @deprecated unused
2866 /* The RTP callback: This function is called */
2867 /* every time the encoder has a packet to send. */
2868 /* It depends on the encoder if the data starts */
2869 /* with a Start Code (it should). H.263 does. */
2870 /* mb_nb contains the number of macroblocks */
2871 /* encoded in the RTP payload. */
2872 attribute_deprecated
2873 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2876 #if FF_API_PRIVATE_OPT
2877 /** @deprecated use encoder private options instead */
2878 attribute_deprecated
2879 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2880 /* do its best to deliver a chunk with size */
2881 /* below rtp_payload_size, the chunk will start */
2882 /* with a start code on some codecs like H.263. */
2883 /* This doesn't take account of any particular */
2884 /* headers inside the transmitted RTP payload. */
2887 #if FF_API_STAT_BITS
2888 /* statistics, used for 2-pass encoding */
2889 attribute_deprecated
2891 attribute_deprecated
2893 attribute_deprecated
2895 attribute_deprecated
2897 attribute_deprecated
2899 attribute_deprecated
2901 attribute_deprecated
2903 attribute_deprecated
2906 /** @deprecated this field is unused */
2907 attribute_deprecated
2912 * pass1 encoding statistics output buffer
2913 * - encoding: Set by libavcodec.
2914 * - decoding: unused
2919 * pass2 encoding statistics input buffer
2920 * Concatenated stuff from stats_out of pass1 should be placed here.
2921 * - encoding: Allocated/set/freed by user.
2922 * - decoding: unused
2927 * Work around bugs in encoders which sometimes cannot be detected automatically.
2928 * - encoding: Set by user
2929 * - decoding: Set by user
2931 int workaround_bugs;
2932 #define FF_BUG_AUTODETECT 1 ///< autodetection
2933 #if FF_API_OLD_MSMPEG4
2934 #define FF_BUG_OLD_MSMPEG4 2
2936 #define FF_BUG_XVID_ILACE 4
2937 #define FF_BUG_UMP4 8
2938 #define FF_BUG_NO_PADDING 16
2939 #define FF_BUG_AMV 32
2941 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2943 #define FF_BUG_QPEL_CHROMA 64
2944 #define FF_BUG_STD_QPEL 128
2945 #define FF_BUG_QPEL_CHROMA2 256
2946 #define FF_BUG_DIRECT_BLOCKSIZE 512
2947 #define FF_BUG_EDGE 1024
2948 #define FF_BUG_HPEL_CHROMA 2048
2949 #define FF_BUG_DC_CLIP 4096
2950 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2951 #define FF_BUG_TRUNCATED 16384
2952 #define FF_BUG_IEDGE 32768
2955 * strictly follow the standard (MPEG-4, ...).
2956 * - encoding: Set by user.
2957 * - decoding: Set by user.
2958 * Setting this to STRICT or higher means the encoder and decoder will
2959 * generally do stupid things, whereas setting it to unofficial or lower
2960 * will mean the encoder might produce output that is not supported by all
2961 * spec-compliant decoders. Decoders don't differentiate between normal,
2962 * unofficial and experimental (that is, they always try to decode things
2963 * when they can) unless they are explicitly asked to behave stupidly
2964 * (=strictly conform to the specs)
2966 int strict_std_compliance;
2967 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2968 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2969 #define FF_COMPLIANCE_NORMAL 0
2970 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2971 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2974 * error concealment flags
2975 * - encoding: unused
2976 * - decoding: Set by user.
2978 int error_concealment;
2979 #define FF_EC_GUESS_MVS 1
2980 #define FF_EC_DEBLOCK 2
2981 #define FF_EC_FAVOR_INTER 256
2985 * - encoding: Set by user.
2986 * - decoding: Set by user.
2989 #define FF_DEBUG_PICT_INFO 1
2990 #define FF_DEBUG_RC 2
2991 #define FF_DEBUG_BITSTREAM 4
2992 #define FF_DEBUG_MB_TYPE 8
2993 #define FF_DEBUG_QP 16
2996 * @deprecated this option does nothing
2998 #define FF_DEBUG_MV 32
3000 #define FF_DEBUG_DCT_COEFF 0x00000040
3001 #define FF_DEBUG_SKIP 0x00000080
3002 #define FF_DEBUG_STARTCODE 0x00000100
3003 #if FF_API_UNUSED_MEMBERS
3004 #define FF_DEBUG_PTS 0x00000200
3005 #endif /* FF_API_UNUSED_MEMBERS */
3006 #define FF_DEBUG_ER 0x00000400
3007 #define FF_DEBUG_MMCO 0x00000800
3008 #define FF_DEBUG_BUGS 0x00001000
3010 #define FF_DEBUG_VIS_QP 0x00002000
3011 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
3013 #define FF_DEBUG_BUFFERS 0x00008000
3014 #define FF_DEBUG_THREADS 0x00010000
3015 #define FF_DEBUG_GREEN_MD 0x00800000
3016 #define FF_DEBUG_NOMC 0x01000000
3021 * - encoding: Set by user.
3022 * - decoding: Set by user.
3025 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
3026 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
3027 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
3031 * Error recognition; may misdetect some more or less valid parts as errors.
3032 * - encoding: unused
3033 * - decoding: Set by user.
3035 int err_recognition;
3038 * Verify checksums embedded in the bitstream (could be of either encoded or
3039 * decoded data, depending on the codec) and print an error message on mismatch.
3040 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
3041 * decoder returning an error.
3043 #define AV_EF_CRCCHECK (1<<0)
3044 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
3045 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
3046 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
3048 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
3049 #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
3050 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
3051 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
3055 * opaque 64-bit number (generally a PTS) that will be reordered and
3056 * output in AVFrame.reordered_opaque
3057 * - encoding: unused
3058 * - decoding: Set by user.
3060 int64_t reordered_opaque;
3063 * Hardware accelerator in use
3064 * - encoding: unused.
3065 * - decoding: Set by libavcodec
3067 struct AVHWAccel *hwaccel;
3070 * Hardware accelerator context.
3071 * For some hardware accelerators, a global context needs to be
3072 * provided by the user. In that case, this holds display-dependent
3073 * data FFmpeg cannot instantiate itself. Please refer to the
3074 * FFmpeg HW accelerator documentation to know how to fill this
3075 * is. e.g. for VA API, this is a struct vaapi_context.
3076 * - encoding: unused
3077 * - decoding: Set by user
3079 void *hwaccel_context;
3083 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3084 * - decoding: unused
3086 uint64_t error[AV_NUM_DATA_POINTERS];
3089 * DCT algorithm, see FF_DCT_* below
3090 * - encoding: Set by user.
3091 * - decoding: unused
3094 #define FF_DCT_AUTO 0
3095 #define FF_DCT_FASTINT 1
3096 #define FF_DCT_INT 2
3097 #define FF_DCT_MMX 3
3098 #define FF_DCT_ALTIVEC 5
3099 #define FF_DCT_FAAN 6
3102 * IDCT algorithm, see FF_IDCT_* below.
3103 * - encoding: Set by user.
3104 * - decoding: Set by user.
3107 #define FF_IDCT_AUTO 0
3108 #define FF_IDCT_INT 1
3109 #define FF_IDCT_SIMPLE 2
3110 #define FF_IDCT_SIMPLEMMX 3
3111 #define FF_IDCT_ARM 7
3112 #define FF_IDCT_ALTIVEC 8
3114 #define FF_IDCT_SH4 9
3116 #define FF_IDCT_SIMPLEARM 10
3117 #if FF_API_UNUSED_MEMBERS
3118 #define FF_IDCT_IPP 13
3119 #endif /* FF_API_UNUSED_MEMBERS */
3120 #define FF_IDCT_XVID 14
3121 #if FF_API_IDCT_XVIDMMX
3122 #define FF_IDCT_XVIDMMX 14
3123 #endif /* FF_API_IDCT_XVIDMMX */
3124 #define FF_IDCT_SIMPLEARMV5TE 16
3125 #define FF_IDCT_SIMPLEARMV6 17
3126 #if FF_API_ARCH_SPARC
3127 #define FF_IDCT_SIMPLEVIS 18
3129 #define FF_IDCT_FAAN 20
3130 #define FF_IDCT_SIMPLENEON 22
3131 #if FF_API_ARCH_ALPHA
3132 #define FF_IDCT_SIMPLEALPHA 23
3134 #define FF_IDCT_NONE 24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
3135 #define FF_IDCT_SIMPLEAUTO 128
3138 * bits per sample/pixel from the demuxer (needed for huffyuv).
3139 * - encoding: Set by libavcodec.
3140 * - decoding: Set by user.
3142 int bits_per_coded_sample;
3145 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3146 * - encoding: set by user.
3147 * - decoding: set by libavcodec.
3149 int bits_per_raw_sample;
3153 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3154 * - encoding: unused
3155 * - decoding: Set by user.
3160 #if FF_API_CODED_FRAME
3162 * the picture in the bitstream
3163 * - encoding: Set by libavcodec.
3164 * - decoding: unused
3166 * @deprecated use the quality factor packet side data instead
3168 attribute_deprecated AVFrame *coded_frame;
3173 * is used to decide how many independent tasks should be passed to execute()
3174 * - encoding: Set by user.
3175 * - decoding: Set by user.
3180 * Which multithreading methods to use.
3181 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3182 * so clients which cannot provide future frames should not use it.
3184 * - encoding: Set by user, otherwise the default is used.
3185 * - decoding: Set by user, otherwise the default is used.
3188 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3189 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3192 * Which multithreading methods are in use by the codec.
3193 * - encoding: Set by libavcodec.
3194 * - decoding: Set by libavcodec.
3196 int active_thread_type;
3199 * Set by the client if its custom get_buffer() callback can be called
3200 * synchronously from another thread, which allows faster multithreaded decoding.
3201 * draw_horiz_band() will be called from other threads regardless of this setting.
3202 * Ignored if the default get_buffer() is used.
3203 * - encoding: Set by user.
3204 * - decoding: Set by user.
3206 int thread_safe_callbacks;
3209 * The codec may call this to execute several independent things.
3210 * It will return only after finishing all tasks.
3211 * The user may replace this with some multithreaded implementation,
3212 * the default implementation will execute the parts serially.
3213 * @param count the number of things to execute
3214 * - encoding: Set by libavcodec, user can override.
3215 * - decoding: Set by libavcodec, user can override.
3217 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3220 * The codec may call this to execute several independent things.
3221 * It will return only after finishing all tasks.
3222 * The user may replace this with some multithreaded implementation,
3223 * the default implementation will execute the parts serially.
3224 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3225 * @param c context passed also to func
3226 * @param count the number of things to execute
3227 * @param arg2 argument passed unchanged to func
3228 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3229 * @param func function that will be called count times, with jobnr from 0 to count-1.
3230 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3231 * two instances of func executing at the same time will have the same threadnr.
3232 * @return always 0 currently, but code should handle a future improvement where when any call to func
3233 * returns < 0 no further calls to func may be done and < 0 is returned.
3234 * - encoding: Set by libavcodec, user can override.
3235 * - decoding: Set by libavcodec, user can override.
3237 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3240 * noise vs. sse weight for the nsse comparison function
3241 * - encoding: Set by user.
3242 * - decoding: unused
3248 * - encoding: Set by user.
3249 * - decoding: Set by libavcodec.
3252 #define FF_PROFILE_UNKNOWN -99
3253 #define FF_PROFILE_RESERVED -100
3255 #define FF_PROFILE_AAC_MAIN 0
3256 #define FF_PROFILE_AAC_LOW 1
3257 #define FF_PROFILE_AAC_SSR 2
3258 #define FF_PROFILE_AAC_LTP 3
3259 #define FF_PROFILE_AAC_HE 4
3260 #define FF_PROFILE_AAC_HE_V2 28
3261 #define FF_PROFILE_AAC_LD 22
3262 #define FF_PROFILE_AAC_ELD 38
3263 #define FF_PROFILE_MPEG2_AAC_LOW 128
3264 #define FF_PROFILE_MPEG2_AAC_HE 131
3266 #define FF_PROFILE_DNXHD 0
3267 #define FF_PROFILE_DNXHR_LB 1
3268 #define FF_PROFILE_DNXHR_SQ 2
3269 #define FF_PROFILE_DNXHR_HQ 3
3270 #define FF_PROFILE_DNXHR_HQX 4
3271 #define FF_PROFILE_DNXHR_444 5
3273 #define FF_PROFILE_DTS 20
3274 #define FF_PROFILE_DTS_ES 30
3275 #define FF_PROFILE_DTS_96_24 40
3276 #define FF_PROFILE_DTS_HD_HRA 50
3277 #define FF_PROFILE_DTS_HD_MA 60
3278 #define FF_PROFILE_DTS_EXPRESS 70
3280 #define FF_PROFILE_MPEG2_422 0
3281 #define FF_PROFILE_MPEG2_HIGH 1
3282 #define FF_PROFILE_MPEG2_SS 2
3283 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3284 #define FF_PROFILE_MPEG2_MAIN 4
3285 #define FF_PROFILE_MPEG2_SIMPLE 5
3287 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3288 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3290 #define FF_PROFILE_H264_BASELINE 66
3291 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3292 #define FF_PROFILE_H264_MAIN 77
3293 #define FF_PROFILE_H264_EXTENDED 88
3294 #define FF_PROFILE_H264_HIGH 100
3295 #define FF_PROFILE_H264_HIGH_10 110
3296 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3297 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3298 #define FF_PROFILE_H264_HIGH_422 122
3299 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3300 #define FF_PROFILE_H264_STEREO_HIGH 128
3301 #define FF_PROFILE_H264_HIGH_444 144
3302 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3303 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3304 #define FF_PROFILE_H264_CAVLC_444 44
3306 #define FF_PROFILE_VC1_SIMPLE 0
3307 #define FF_PROFILE_VC1_MAIN 1
3308 #define FF_PROFILE_VC1_COMPLEX 2
3309 #define FF_PROFILE_VC1_ADVANCED 3
3311 #define FF_PROFILE_MPEG4_SIMPLE 0
3312 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3313 #define FF_PROFILE_MPEG4_CORE 2
3314 #define FF_PROFILE_MPEG4_MAIN 3
3315 #define FF_PROFILE_MPEG4_N_BIT 4
3316 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3317 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3318 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3319 #define FF_PROFILE_MPEG4_HYBRID 8
3320 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3321 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3322 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3323 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3324 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3325 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3326 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3328 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3329 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3330 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3331 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3332 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3334 #define FF_PROFILE_VP9_0 0
3335 #define FF_PROFILE_VP9_1 1
3336 #define FF_PROFILE_VP9_2 2
3337 #define FF_PROFILE_VP9_3 3
3339 #define FF_PROFILE_HEVC_MAIN 1
3340 #define FF_PROFILE_HEVC_MAIN_10 2
3341 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3342 #define FF_PROFILE_HEVC_REXT 4
3346 * - encoding: Set by user.
3347 * - decoding: Set by libavcodec.
3350 #define FF_LEVEL_UNKNOWN -99
3353 * Skip loop filtering for selected frames.
3354 * - encoding: unused
3355 * - decoding: Set by user.
3357 enum AVDiscard skip_loop_filter;
3360 * Skip IDCT/dequantization for selected frames.
3361 * - encoding: unused
3362 * - decoding: Set by user.
3364 enum AVDiscard skip_idct;
3367 * Skip decoding for selected frames.
3368 * - encoding: unused
3369 * - decoding: Set by user.
3371 enum AVDiscard skip_frame;
3374 * Header containing style information for text subtitles.
3375 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3376 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3377 * the Format line following. It shouldn't include any Dialogue line.
3378 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3379 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3381 uint8_t *subtitle_header;
3382 int subtitle_header_size;
3384 #if FF_API_ERROR_RATE
3386 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3389 attribute_deprecated
3393 #if FF_API_VBV_DELAY
3395 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3396 * Used for compliant TS muxing.
3397 * - encoding: Set by libavcodec.
3398 * - decoding: unused.
3399 * @deprecated this value is now exported as a part of
3400 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3402 attribute_deprecated
3406 #if FF_API_SIDEDATA_ONLY_PKT
3408 * Encoding only and set by default. Allow encoders to output packets
3409 * that do not contain any encoded data, only side data.
3411 * Some encoders need to output such packets, e.g. to update some stream
3412 * parameters at the end of encoding.
3414 * @deprecated this field disables the default behaviour and
3415 * it is kept only for compatibility.
3417 attribute_deprecated
3418 int side_data_only_packets;
3422 * Audio only. The number of "priming" samples (padding) inserted by the
3423 * encoder at the beginning of the audio. I.e. this number of leading
3424 * decoded samples must be discarded by the caller to get the original audio
3425 * without leading padding.
3427 * - decoding: unused
3428 * - encoding: Set by libavcodec. The timestamps on the output packets are
3429 * adjusted by the encoder so that they always refer to the
3430 * first sample of the data actually contained in the packet,
3431 * including any added padding. E.g. if the timebase is
3432 * 1/samplerate and the timestamp of the first input sample is
3433 * 0, the timestamp of the first output packet will be
3436 int initial_padding;
3439 * - decoding: For codecs that store a framerate value in the compressed
3440 * bitstream, the decoder may export it here. { 0, 1} when
3442 * - encoding: May be used to signal the framerate of CFR content to an
3445 AVRational framerate;
3448 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3449 * - encoding: unused.
3450 * - decoding: Set by libavcodec before calling get_format()
3452 enum AVPixelFormat sw_pix_fmt;
3455 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3456 * - encoding unused.
3457 * - decoding set by user.
3459 AVRational pkt_timebase;
3463 * - encoding: unused.
3464 * - decoding: set by libavcodec.
3466 const AVCodecDescriptor *codec_descriptor;
3470 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3471 * - encoding: unused
3472 * - decoding: Set by user.
3478 * Current statistics for PTS correction.
3479 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3480 * - encoding: unused
3482 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3483 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3484 int64_t pts_correction_last_pts; /// PTS of the last frame
3485 int64_t pts_correction_last_dts; /// DTS of the last frame
3488 * Character encoding of the input subtitles file.
3489 * - decoding: set by user
3490 * - encoding: unused
3495 * Subtitles character encoding mode. Formats or codecs might be adjusting
3496 * this setting (if they are doing the conversion themselves for instance).
3497 * - decoding: set by libavcodec
3498 * - encoding: unused
3500 int sub_charenc_mode;
3501 #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)
3502 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3503 #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
3506 * Skip processing alpha if supported by codec.
3507 * Note that if the format uses pre-multiplied alpha (common with VP6,
3508 * and recommended due to better video quality/compression)
3509 * the image will look as if alpha-blended onto a black background.
3510 * However for formats that do not use pre-multiplied alpha
3511 * there might be serious artefacts (though e.g. libswscale currently
3512 * assumes pre-multiplied alpha anyway).
3514 * - decoding: set by user
3515 * - encoding: unused
3520 * Number of samples to skip after a discontinuity
3521 * - decoding: unused
3522 * - encoding: set by libavcodec
3526 #if !FF_API_DEBUG_MV
3528 * debug motion vectors
3529 * - encoding: Set by user.
3530 * - decoding: Set by user.
3533 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3534 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3535 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3539 * custom intra quantization matrix
3540 * - encoding: Set by user, can be NULL.
3541 * - decoding: unused.
3543 uint16_t *chroma_intra_matrix;
3546 * dump format separator.
3547 * can be ", " or "\n " or anything else
3548 * - encoding: Set by user.
3549 * - decoding: Set by user.
3551 uint8_t *dump_separator;
3554 * ',' separated list of allowed decoders.
3555 * If NULL then all are allowed
3556 * - encoding: unused
3557 * - decoding: set by user
3559 char *codec_whitelist;
3562 * Properties of the stream that gets decoded
3563 * - encoding: unused
3564 * - decoding: set by libavcodec
3566 unsigned properties;
3567 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3568 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3571 * Additional data associated with the entire coded stream.
3573 * - decoding: unused
3574 * - encoding: may be set by libavcodec after avcodec_open2().
3576 AVPacketSideData *coded_side_data;
3577 int nb_coded_side_data;
3580 * A reference to the AVHWFramesContext describing the input (for encoding)
3581 * or output (decoding) frames. The reference is set by the caller and
3582 * afterwards owned (and freed) by libavcodec - it should never be read by
3583 * the caller after being set.
3585 * - decoding: This field should be set by the caller from the get_format()
3586 * callback. The previous reference (if any) will always be
3587 * unreffed by libavcodec before the get_format() call.
3589 * If the default get_buffer2() is used with a hwaccel pixel
3590 * format, then this AVHWFramesContext will be used for
3591 * allocating the frame buffers.
3593 * - encoding: For hardware encoders configured to use a hwaccel pixel
3594 * format, this field should be set by the caller to a reference
3595 * to the AVHWFramesContext describing input frames.
3596 * AVHWFramesContext.format must be equal to
3597 * AVCodecContext.pix_fmt.
3599 * This field should be set before avcodec_open2() is called.
3601 AVBufferRef *hw_frames_ctx;
3604 * Control the form of AVSubtitle.rects[N]->ass
3605 * - decoding: set by user
3606 * - encoding: unused
3608 int sub_text_format;
3609 #define FF_SUB_TEXT_FMT_ASS 0
3610 #if FF_API_ASS_TIMING
3611 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3615 * Audio only. The amount of padding (in samples) appended by the encoder to
3616 * the end of the audio. I.e. this number of decoded samples must be
3617 * discarded by the caller from the end of the stream to get the original
3618 * audio without any trailing padding.
3620 * - decoding: unused
3621 * - encoding: unused
3623 int trailing_padding;
3626 * The number of pixels per image to maximally accept.
3628 * - decoding: set by user
3629 * - encoding: set by user
3634 * A reference to the AVHWDeviceContext describing the device which will
3635 * be used by a hardware encoder/decoder. The reference is set by the
3636 * caller and afterwards owned (and freed) by libavcodec.
3638 * This should be used if either the codec device does not require
3639 * hardware frames or any that are used are to be allocated internally by
3640 * libavcodec. If the user wishes to supply any of the frames used as
3641 * encoder input or decoder output then hw_frames_ctx should be used
3642 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
3643 * field will be ignored while decoding the associated stream segment, but
3644 * may again be used on a following one after another get_format() call.
3646 * For both encoders and decoders this field should be set before
3647 * avcodec_open2() is called and must not be written to thereafter.
3649 * Note that some decoders may require this field to be set initially in
3650 * order to support hw_frames_ctx at all - in that case, all frames
3651 * contexts used must be created on the same device.
3653 AVBufferRef *hw_device_ctx;
3656 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3657 * decoding (if active).
3658 * - encoding: unused
3659 * - decoding: Set by user (either before avcodec_open2(), or in the
3660 * AVCodecContext.get_format callback)
3665 * Video decoding only. Certain video codecs support cropping, meaning that
3666 * only a sub-rectangle of the decoded frame is intended for display. This
3667 * option controls how cropping is handled by libavcodec.
3669 * When set to 1 (the default), libavcodec will apply cropping internally.
3670 * I.e. it will modify the output frame width/height fields and offset the
3671 * data pointers (only by as much as possible while preserving alignment, or
3672 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3673 * the frames output by the decoder refer only to the cropped area. The
3674 * crop_* fields of the output frames will be zero.
3676 * When set to 0, the width/height fields of the output frames will be set
3677 * to the coded dimensions and the crop_* fields will describe the cropping
3678 * rectangle. Applying the cropping is left to the caller.
3680 * @warning When hardware acceleration with opaque output frames is used,
3681 * libavcodec is unable to apply cropping from the top/left border.
3683 * @note when this option is set to zero, the width/height fields of the
3684 * AVCodecContext and output AVFrames have different meanings. The codec
3685 * context fields store display dimensions (with the coded dimensions in
3686 * coded_width/height), while the frame fields store the coded dimensions
3687 * (with the display dimensions being determined by the crop_* fields).
3692 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3693 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3695 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3696 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3698 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3700 int av_codec_get_lowres(const AVCodecContext *avctx);
3701 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3703 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3704 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3706 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3707 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3712 typedef struct AVProfile {
3714 const char *name; ///< short name for the profile
3717 typedef struct AVCodecDefault AVCodecDefault;
3724 typedef struct AVCodec {
3726 * Name of the codec implementation.
3727 * The name is globally unique among encoders and among decoders (but an
3728 * encoder and a decoder can share the same name).
3729 * This is the primary way to find a codec from the user perspective.
3733 * Descriptive name for the codec, meant to be more human readable than name.
3734 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3736 const char *long_name;
3737 enum AVMediaType type;
3740 * Codec capabilities.
3741 * see AV_CODEC_CAP_*
3744 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3745 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3746 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3747 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3748 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3749 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3750 const AVClass *priv_class; ///< AVClass for the private context
3751 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3753 /*****************************************************************
3754 * No fields below this line are part of the public API. They
3755 * may not be used outside of libavcodec and can be changed and
3757 * New public fields should be added right above.
3758 *****************************************************************
3761 struct AVCodec *next;
3763 * @name Frame-level threading support functions
3767 * If defined, called on thread contexts when they are created.
3768 * If the codec allocates writable tables in init(), re-allocate them here.
3769 * priv_data will be set to a copy of the original.
3771 int (*init_thread_copy)(AVCodecContext *);
3773 * Copy necessary context variables from a previous thread context to the current one.
3774 * If not defined, the next thread will start automatically; otherwise, the codec
3775 * must call ff_thread_finish_setup().
3777 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3779 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3783 * Private codec-specific defaults.
3785 const AVCodecDefault *defaults;
3788 * Initialize codec static data, called from avcodec_register().
3790 void (*init_static_data)(struct AVCodec *codec);
3792 int (*init)(AVCodecContext *);
3793 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3794 const struct AVSubtitle *sub);
3796 * Encode data to an AVPacket.
3798 * @param avctx codec context
3799 * @param avpkt output AVPacket (may contain a user-provided buffer)
3800 * @param[in] frame AVFrame containing the raw data to be encoded
3801 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3802 * non-empty packet was returned in avpkt.
3803 * @return 0 on success, negative error code on failure
3805 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3806 int *got_packet_ptr);
3807 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3808 int (*close)(AVCodecContext *);
3810 * Encode API with decoupled packet/frame dataflow. The API is the
3811 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3813 * - never called if the codec is closed or the wrong type,
3814 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3815 * - only one drain frame is ever passed down,
3817 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3818 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3821 * Decode API with decoupled packet/frame dataflow. This function is called
3822 * to get one output frame. It should call ff_decode_get_packet() to obtain
3825 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3828 * Will be called when seeking
3830 void (*flush)(AVCodecContext *);
3832 * Internal codec capabilities.
3833 * See FF_CODEC_CAP_* in internal.h
3838 * Decoding only, a comma-separated list of bitstream filters to apply to
3839 * packets before decoding.
3844 int av_codec_get_max_lowres(const AVCodec *codec);
3846 struct MpegEncContext;
3849 * @defgroup lavc_hwaccel AVHWAccel
3852 typedef struct AVHWAccel {
3854 * Name of the hardware accelerated codec.
3855 * The name is globally unique among encoders and among decoders (but an
3856 * encoder and a decoder can share the same name).
3861 * Type of codec implemented by the hardware accelerator.
3863 * See AVMEDIA_TYPE_xxx
3865 enum AVMediaType type;
3868 * Codec implemented by the hardware accelerator.
3870 * See AV_CODEC_ID_xxx
3875 * Supported pixel format.
3877 * Only hardware accelerated formats are supported here.
3879 enum AVPixelFormat pix_fmt;
3882 * Hardware accelerated codec capabilities.
3883 * see AV_HWACCEL_CODEC_CAP_*
3887 /*****************************************************************
3888 * No fields below this line are part of the public API. They
3889 * may not be used outside of libavcodec and can be changed and
3891 * New public fields should be added right above.
3892 *****************************************************************
3894 struct AVHWAccel *next;
3897 * Allocate a custom buffer
3899 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3902 * Called at the beginning of each frame or field picture.
3904 * Meaningful frame information (codec specific) is guaranteed to
3905 * be parsed at this point. This function is mandatory.
3907 * Note that buf can be NULL along with buf_size set to 0.
3908 * Otherwise, this means the whole frame is available at this point.
3910 * @param avctx the codec context
3911 * @param buf the frame data buffer base
3912 * @param buf_size the size of the frame in bytes
3913 * @return zero if successful, a negative value otherwise
3915 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3918 * Callback for each slice.
3920 * Meaningful slice information (codec specific) is guaranteed to
3921 * be parsed at this point. This function is mandatory.
3922 * The only exception is XvMC, that works on MB level.
3924 * @param avctx the codec context
3925 * @param buf the slice data buffer base
3926 * @param buf_size the size of the slice in bytes
3927 * @return zero if successful, a negative value otherwise
3929 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3932 * Called at the end of each frame or field picture.
3934 * The whole picture is parsed at this point and can now be sent
3935 * to the hardware accelerator. This function is mandatory.
3937 * @param avctx the codec context
3938 * @return zero if successful, a negative value otherwise
3940 int (*end_frame)(AVCodecContext *avctx);
3943 * Size of per-frame hardware accelerator private data.
3945 * Private data is allocated with av_mallocz() before
3946 * AVCodecContext.get_buffer() and deallocated after
3947 * AVCodecContext.release_buffer().
3949 int frame_priv_data_size;
3952 * Called for every Macroblock in a slice.
3954 * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3955 * Instead of decoding to raw picture, MB parameters are
3956 * stored in an array provided by the video driver.
3958 * @param s the mpeg context
3960 void (*decode_mb)(struct MpegEncContext *s);
3963 * Initialize the hwaccel private data.
3965 * This will be called from ff_get_format(), after hwaccel and
3966 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3969 int (*init)(AVCodecContext *avctx);
3972 * Uninitialize the hwaccel private data.
3974 * This will be called from get_format() or avcodec_close(), after hwaccel
3975 * and hwaccel_context are already uninitialized.
3977 int (*uninit)(AVCodecContext *avctx);
3980 * Size of the private data to allocate in
3981 * AVCodecInternal.hwaccel_priv_data.
3986 * Internal hwaccel capabilities.
3992 * HWAccel is experimental and is thus avoided in favor of non experimental
3995 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3998 * Hardware acceleration should be used for decoding even if the codec level
3999 * used is unknown or higher than the maximum supported level reported by the
4002 * It's generally a good idea to pass this flag unless you have a specific
4003 * reason not to, as hardware tends to under-report supported levels.
4005 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
4008 * Hardware acceleration can output YUV pixel formats with a different chroma
4009 * sampling than 4:2:0 and/or other than 8 bits per component.
4011 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
4014 * Hardware acceleration should still be attempted for decoding when the
4015 * codec profile does not match the reported capabilities of the hardware.
4017 * For example, this can be used to try to decode baseline profile H.264
4018 * streams in hardware - it will often succeed, because many streams marked
4019 * as baseline profile actually conform to constrained baseline profile.
4021 * @warning If the stream is actually not supported then the behaviour is
4022 * undefined, and may include returning entirely incorrect output
4023 * while indicating success.
4025 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
4031 #if FF_API_AVPICTURE
4033 * @defgroup lavc_picture AVPicture
4035 * Functions for working with AVPicture
4040 * Picture data structure.
4042 * Up to four components can be stored into it, the last component is
4044 * @deprecated use AVFrame or imgutils functions instead
4046 typedef struct AVPicture {
4047 attribute_deprecated
4048 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
4049 attribute_deprecated
4050 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
4058 enum AVSubtitleType {
4061 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
4064 * Plain text, the text field must be set by the decoder and is
4065 * authoritative. ass and pict fields may contain approximations.
4070 * Formatted text, the ass field must be set by the decoder and is
4071 * authoritative. pict and text fields may contain approximations.
4076 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
4078 typedef struct AVSubtitleRect {
4079 int x; ///< top left corner of pict, undefined when pict is not set
4080 int y; ///< top left corner of pict, undefined when pict is not set
4081 int w; ///< width of pict, undefined when pict is not set
4082 int h; ///< height of pict, undefined when pict is not set
4083 int nb_colors; ///< number of colors in pict, undefined when pict is not set
4085 #if FF_API_AVPICTURE
4087 * @deprecated unused
4089 attribute_deprecated
4093 * data+linesize for the bitmap of this subtitle.
4094 * Can be set for text/ass as well once they are rendered.
4099 enum AVSubtitleType type;
4101 char *text; ///< 0 terminated plain UTF-8 text
4104 * 0 terminated ASS/SSA compatible event line.
4105 * The presentation of this is unaffected by the other values in this
4113 typedef struct AVSubtitle {
4114 uint16_t format; /* 0 = graphics */
4115 uint32_t start_display_time; /* relative to packet pts, in ms */
4116 uint32_t end_display_time; /* relative to packet pts, in ms */
4118 AVSubtitleRect **rects;
4119 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
4123 * This struct describes the properties of an encoded stream.
4125 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4126 * be allocated with avcodec_parameters_alloc() and freed with
4127 * avcodec_parameters_free().
4129 typedef struct AVCodecParameters {
4131 * General type of the encoded data.
4133 enum AVMediaType codec_type;
4135 * Specific type of the encoded data (the codec used).
4137 enum AVCodecID codec_id;
4139 * Additional information about the codec (corresponds to the AVI FOURCC).
4144 * Extra binary data needed for initializing the decoder, codec-dependent.
4146 * Must be allocated with av_malloc() and will be freed by
4147 * avcodec_parameters_free(). The allocated size of extradata must be at
4148 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4153 * Size of the extradata content in bytes.
4158 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4159 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4164 * The average bitrate of the encoded data (in bits per second).
4169 * The number of bits per sample in the codedwords.
4171 * This is basically the bitrate per sample. It is mandatory for a bunch of
4172 * formats to actually decode them. It's the number of bits for one sample in
4173 * the actual coded bitstream.
4175 * This could be for example 4 for ADPCM
4176 * For PCM formats this matches bits_per_raw_sample
4179 int bits_per_coded_sample;
4182 * This is the number of valid bits in each output sample. If the
4183 * sample format has more bits, the least significant bits are additional
4184 * padding bits, which are always 0. Use right shifts to reduce the sample
4185 * to its actual size. For example, audio formats with 24 bit samples will
4186 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4187 * To get the original sample use "(int32_t)sample >> 8"."
4189 * For ADPCM this might be 12 or 16 or similar
4192 int bits_per_raw_sample;
4195 * Codec-specific bitstream restrictions that the stream conforms to.
4201 * Video only. The dimensions of the video frame in pixels.
4207 * Video only. The aspect ratio (width / height) which a single pixel
4208 * should have when displayed.
4210 * When the aspect ratio is unknown / undefined, the numerator should be
4211 * set to 0 (the denominator may have any value).
4213 AVRational sample_aspect_ratio;
4216 * Video only. The order of the fields in interlaced video.
4218 enum AVFieldOrder field_order;
4221 * Video only. Additional colorspace characteristics.
4223 enum AVColorRange color_range;
4224 enum AVColorPrimaries color_primaries;
4225 enum AVColorTransferCharacteristic color_trc;
4226 enum AVColorSpace color_space;
4227 enum AVChromaLocation chroma_location;
4230 * Video only. Number of delayed frames.
4235 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4236 * unknown or unspecified, otherwise the number of bits set must be equal to
4237 * the channels field.
4239 uint64_t channel_layout;
4241 * Audio only. The number of audio channels.
4245 * Audio only. The number of audio samples per second.
4249 * Audio only. The number of bytes per coded audio frame, required by some
4252 * Corresponds to nBlockAlign in WAVEFORMATEX.
4256 * Audio only. Audio frame size, if known. Required by some formats to be static.
4261 * Audio only. The amount of padding (in samples) inserted by the encoder at
4262 * the beginning of the audio. I.e. this number of leading decoded samples
4263 * must be discarded by the caller to get the original audio without leading
4266 int initial_padding;
4268 * Audio only. The amount of padding (in samples) appended by the encoder to
4269 * the end of the audio. I.e. this number of decoded samples must be
4270 * discarded by the caller from the end of the stream to get the original
4271 * audio without any trailing padding.
4273 int trailing_padding;
4275 * Audio only. Number of samples to skip after a discontinuity.
4278 } AVCodecParameters;
4281 * If c is NULL, returns the first registered codec,
4282 * if c is non-NULL, returns the next registered codec after c,
4283 * or NULL if c is the last one.
4285 AVCodec *av_codec_next(const AVCodec *c);
4288 * Return the LIBAVCODEC_VERSION_INT constant.
4290 unsigned avcodec_version(void);
4293 * Return the libavcodec build-time configuration.
4295 const char *avcodec_configuration(void);
4298 * Return the libavcodec license.
4300 const char *avcodec_license(void);
4303 * Register the codec codec and initialize libavcodec.
4305 * @warning either this function or avcodec_register_all() must be called
4306 * before any other libavcodec functions.
4308 * @see avcodec_register_all()
4310 void avcodec_register(AVCodec *codec);
4313 * Register all the codecs, parsers and bitstream filters which were enabled at
4314 * configuration time. If you do not call this function you can select exactly
4315 * which formats you want to support, by using the individual registration
4318 * @see avcodec_register
4319 * @see av_register_codec_parser
4320 * @see av_register_bitstream_filter
4322 void avcodec_register_all(void);
4325 * Allocate an AVCodecContext and set its fields to default values. The
4326 * resulting struct should be freed with avcodec_free_context().
4328 * @param codec if non-NULL, allocate private data and initialize defaults
4329 * for the given codec. It is illegal to then call avcodec_open2()
4330 * with a different codec.
4331 * If NULL, then the codec-specific defaults won't be initialized,
4332 * which may result in suboptimal default settings (this is
4333 * important mainly for encoders, e.g. libx264).
4335 * @return An AVCodecContext filled with default values or NULL on failure.
4337 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4340 * Free the codec context and everything associated with it and write NULL to
4341 * the provided pointer.
4343 void avcodec_free_context(AVCodecContext **avctx);
4345 #if FF_API_GET_CONTEXT_DEFAULTS
4347 * @deprecated This function should not be used, as closing and opening a codec
4348 * context multiple time is not supported. A new codec context should be
4349 * allocated for each new use.
4351 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4355 * Get the AVClass for AVCodecContext. It can be used in combination with
4356 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4358 * @see av_opt_find().
4360 const AVClass *avcodec_get_class(void);
4362 #if FF_API_COPY_CONTEXT
4364 * Get the AVClass for AVFrame. It can be used in combination with
4365 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4367 * @see av_opt_find().
4369 const AVClass *avcodec_get_frame_class(void);
4372 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4373 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4375 * @see av_opt_find().
4377 const AVClass *avcodec_get_subtitle_rect_class(void);
4380 * Copy the settings of the source AVCodecContext into the destination
4381 * AVCodecContext. The resulting destination codec context will be
4382 * unopened, i.e. you are required to call avcodec_open2() before you
4383 * can use this AVCodecContext to decode/encode video/audio data.
4385 * @param dest target codec context, should be initialized with
4386 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4387 * @param src source codec context
4388 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4390 * @deprecated The semantics of this function are ill-defined and it should not
4391 * be used. If you need to transfer the stream parameters from one codec context
4392 * to another, use an intermediate AVCodecParameters instance and the
4393 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4396 attribute_deprecated
4397 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4401 * Allocate a new AVCodecParameters and set its fields to default values
4402 * (unknown/invalid/0). The returned struct must be freed with
4403 * avcodec_parameters_free().
4405 AVCodecParameters *avcodec_parameters_alloc(void);
4408 * Free an AVCodecParameters instance and everything associated with it and
4409 * write NULL to the supplied pointer.
4411 void avcodec_parameters_free(AVCodecParameters **par);
4414 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4415 * replaced with newly allocated duplicates of the corresponding fields in src.
4417 * @return >= 0 on success, a negative AVERROR code on failure.
4419 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4422 * Fill the parameters struct based on the values from the supplied codec
4423 * context. Any allocated fields in par are freed and replaced with duplicates
4424 * of the corresponding fields in codec.
4426 * @return >= 0 on success, a negative AVERROR code on failure
4428 int avcodec_parameters_from_context(AVCodecParameters *par,
4429 const AVCodecContext *codec);
4432 * Fill the codec context based on the values from the supplied codec
4433 * parameters. Any allocated fields in codec that have a corresponding field in
4434 * par are freed and replaced with duplicates of the corresponding field in par.
4435 * Fields in codec that do not have a counterpart in par are not touched.
4437 * @return >= 0 on success, a negative AVERROR code on failure.
4439 int avcodec_parameters_to_context(AVCodecContext *codec,
4440 const AVCodecParameters *par);
4443 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4444 * function the context has to be allocated with avcodec_alloc_context3().
4446 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4447 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4448 * retrieving a codec.
4450 * @warning This function is not thread safe!
4452 * @note Always call this function before using decoding routines (such as
4453 * @ref avcodec_receive_frame()).
4456 * avcodec_register_all();
4457 * av_dict_set(&opts, "b", "2.5M", 0);
4458 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4462 * context = avcodec_alloc_context3(codec);
4464 * if (avcodec_open2(context, codec, opts) < 0)
4468 * @param avctx The context to initialize.
4469 * @param codec The codec to open this context for. If a non-NULL codec has been
4470 * previously passed to avcodec_alloc_context3() or
4471 * for this context, then this parameter MUST be either NULL or
4472 * equal to the previously passed codec.
4473 * @param options A dictionary filled with AVCodecContext and codec-private options.
4474 * On return this object will be filled with options that were not found.
4476 * @return zero on success, a negative value on error
4477 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4478 * av_dict_set(), av_opt_find().
4480 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4483 * Close a given AVCodecContext and free all the data associated with it
4484 * (but not the AVCodecContext itself).
4486 * Calling this function on an AVCodecContext that hasn't been opened will free
4487 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4488 * codec. Subsequent calls will do nothing.
4490 * @note Do not use this function. Use avcodec_free_context() to destroy a
4491 * codec context (either open or closed). Opening and closing a codec context
4492 * multiple times is not supported anymore -- use multiple codec contexts
4495 int avcodec_close(AVCodecContext *avctx);
4498 * Free all allocated data in the given subtitle struct.
4500 * @param sub AVSubtitle to free.
4502 void avsubtitle_free(AVSubtitle *sub);
4509 * @addtogroup lavc_packet
4514 * Allocate an AVPacket and set its fields to default values. The resulting
4515 * struct must be freed using av_packet_free().
4517 * @return An AVPacket filled with default values or NULL on failure.
4519 * @note this only allocates the AVPacket itself, not the data buffers. Those
4520 * must be allocated through other means such as av_new_packet.
4522 * @see av_new_packet
4524 AVPacket *av_packet_alloc(void);
4527 * Create a new packet that references the same data as src.
4529 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4531 * @return newly created AVPacket on success, NULL on error.
4533 * @see av_packet_alloc
4534 * @see av_packet_ref
4536 AVPacket *av_packet_clone(const AVPacket *src);
4539 * Free the packet, if the packet is reference counted, it will be
4540 * unreferenced first.
4542 * @param pkt packet to be freed. The pointer will be set to NULL.
4543 * @note passing NULL is a no-op.
4545 void av_packet_free(AVPacket **pkt);
4548 * Initialize optional fields of a packet with default values.
4550 * Note, this does not touch the data and size members, which have to be
4551 * initialized separately.
4555 void av_init_packet(AVPacket *pkt);
4558 * Allocate the payload of a packet and initialize its fields with
4562 * @param size wanted payload size
4563 * @return 0 if OK, AVERROR_xxx otherwise
4565 int av_new_packet(AVPacket *pkt, int size);
4568 * Reduce packet size, correctly zeroing padding
4571 * @param size new size
4573 void av_shrink_packet(AVPacket *pkt, int size);
4576 * Increase packet size, correctly zeroing padding
4579 * @param grow_by number of bytes by which to increase the size of the packet
4581 int av_grow_packet(AVPacket *pkt, int grow_by);
4584 * Initialize a reference-counted packet from av_malloc()ed data.
4586 * @param pkt packet to be initialized. This function will set the data, size,
4587 * buf and destruct fields, all others are left untouched.
4588 * @param data Data allocated by av_malloc() to be used as packet data. If this
4589 * function returns successfully, the data is owned by the underlying AVBuffer.
4590 * The caller may not access the data through other means.
4591 * @param size size of data in bytes, without the padding. I.e. the full buffer
4592 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4594 * @return 0 on success, a negative AVERROR on error
4596 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4598 #if FF_API_AVPACKET_OLD_API
4600 * @warning This is a hack - the packet memory allocation stuff is broken. The
4601 * packet is allocated if it was not really allocated.
4603 * @deprecated Use av_packet_ref
4605 attribute_deprecated
4606 int av_dup_packet(AVPacket *pkt);
4608 * Copy packet, including contents
4610 * @return 0 on success, negative AVERROR on fail
4612 * @deprecated Use av_packet_ref
4614 attribute_deprecated
4615 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4618 * Copy packet side data
4620 * @return 0 on success, negative AVERROR on fail
4622 * @deprecated Use av_packet_copy_props
4624 attribute_deprecated
4625 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4630 * @deprecated Use av_packet_unref
4632 * @param pkt packet to free
4634 attribute_deprecated
4635 void av_free_packet(AVPacket *pkt);
4638 * Allocate new information of a packet.
4641 * @param type side information type
4642 * @param size side information size
4643 * @return pointer to fresh allocated data or NULL otherwise
4645 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4649 * Wrap an existing array as a packet side data.
4652 * @param type side information type
4653 * @param data the side data array. It must be allocated with the av_malloc()
4654 * family of functions. The ownership of the data is transferred to
4656 * @param size side information size
4657 * @return a non-negative number on success, a negative AVERROR code on
4658 * failure. On failure, the packet is unchanged and the data remains
4659 * owned by the caller.
4661 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4662 uint8_t *data, size_t size);
4665 * Shrink the already allocated side data buffer
4668 * @param type side information type
4669 * @param size new side information size
4670 * @return 0 on success, < 0 on failure
4672 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4676 * Get side information from packet.
4679 * @param type desired side information type
4680 * @param size pointer for side information size to store (optional)
4681 * @return pointer to data if present or NULL otherwise
4683 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4686 #if FF_API_MERGE_SD_API
4687 attribute_deprecated
4688 int av_packet_merge_side_data(AVPacket *pkt);
4690 attribute_deprecated
4691 int av_packet_split_side_data(AVPacket *pkt);
4694 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4697 * Pack a dictionary for use in side_data.
4699 * @param dict The dictionary to pack.
4700 * @param size pointer to store the size of the returned data
4701 * @return pointer to data if successful, NULL otherwise
4703 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4705 * Unpack a dictionary from side_data.
4707 * @param data data from side_data
4708 * @param size size of the data
4709 * @param dict the metadata storage dictionary
4710 * @return 0 on success, < 0 on failure
4712 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4716 * Convenience function to free all the side data stored.
4717 * All the other fields stay untouched.
4721 void av_packet_free_side_data(AVPacket *pkt);
4724 * Setup a new reference to the data described by a given packet
4726 * If src is reference-counted, setup dst as a new reference to the
4727 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4728 * data from src into it.
4730 * All the other fields are copied from src.
4732 * @see av_packet_unref
4734 * @param dst Destination packet
4735 * @param src Source packet
4737 * @return 0 on success, a negative AVERROR on error.
4739 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4744 * Unreference the buffer referenced by the packet and reset the
4745 * remaining packet fields to their default values.
4747 * @param pkt The packet to be unreferenced.
4749 void av_packet_unref(AVPacket *pkt);
4752 * Move every field in src to dst and reset src.
4754 * @see av_packet_unref
4756 * @param src Source packet, will be reset
4757 * @param dst Destination packet
4759 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4762 * Copy only "properties" fields from src to dst.
4764 * Properties for the purpose of this function are all the fields
4765 * beside those related to the packet data (buf, data, size)
4767 * @param dst Destination packet
4768 * @param src Source packet
4770 * @return 0 on success AVERROR on failure.
4772 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4775 * Convert valid timing fields (timestamps / durations) in a packet from one
4776 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4779 * @param pkt packet on which the conversion will be performed
4780 * @param tb_src source timebase, in which the timing fields in pkt are
4782 * @param tb_dst destination timebase, to which the timing fields will be
4785 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4792 * @addtogroup lavc_decoding
4797 * Find a registered decoder with a matching codec ID.
4799 * @param id AVCodecID of the requested decoder
4800 * @return A decoder if one was found, NULL otherwise.
4802 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4805 * Find a registered decoder with the specified name.
4807 * @param name name of the requested decoder
4808 * @return A decoder if one was found, NULL otherwise.
4810 AVCodec *avcodec_find_decoder_by_name(const char *name);
4813 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4814 * it can be called by custom get_buffer2() implementations for decoders without
4815 * AV_CODEC_CAP_DR1 set.
4817 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4821 * Return the amount of padding in pixels which the get_buffer callback must
4822 * provide around the edge of the image for codecs which do not have the
4823 * CODEC_FLAG_EMU_EDGE flag.
4825 * @return Required padding in pixels.
4827 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4830 attribute_deprecated
4831 unsigned avcodec_get_edge_width(void);
4835 * Modify width and height values so that they will result in a memory
4836 * buffer that is acceptable for the codec if you do not use any horizontal
4839 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4841 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4844 * Modify width and height values so that they will result in a memory
4845 * buffer that is acceptable for the codec if you also ensure that all
4846 * line sizes are a multiple of the respective linesize_align[i].
4848 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4850 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4851 int linesize_align[AV_NUM_DATA_POINTERS]);
4854 * Converts AVChromaLocation to swscale x/y chroma position.
4856 * The positions represent the chroma (0,0) position in a coordinates system
4857 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4859 * @param xpos horizontal chroma sample position
4860 * @param ypos vertical chroma sample position
4862 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4865 * Converts swscale x/y chroma position to AVChromaLocation.
4867 * The positions represent the chroma (0,0) position in a coordinates system
4868 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4870 * @param xpos horizontal chroma sample position
4871 * @param ypos vertical chroma sample position
4873 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4876 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4878 * Some decoders may support multiple frames in a single AVPacket. Such
4879 * decoders would then just decode the first frame and the return value would be
4880 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4881 * called again with an AVPacket containing the remaining data in order to
4882 * decode the second frame, etc... Even if no frames are returned, the packet
4883 * needs to be fed to the decoder with remaining data until it is completely
4884 * consumed or an error occurs.
4886 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4887 * and output. This means that for some packets they will not immediately
4888 * produce decoded output and need to be flushed at the end of decoding to get
4889 * all the decoded data. Flushing is done by calling this function with packets
4890 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4891 * returning samples. It is safe to flush even those decoders that are not
4892 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4894 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4895 * larger than the actual read bytes because some optimized bitstream
4896 * readers read 32 or 64 bits at once and could read over the end.
4898 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4899 * before packets may be fed to the decoder.
4901 * @param avctx the codec context
4902 * @param[out] frame The AVFrame in which to store decoded audio samples.
4903 * The decoder will allocate a buffer for the decoded frame by
4904 * calling the AVCodecContext.get_buffer2() callback.
4905 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4906 * reference counted and the returned reference belongs to the
4907 * caller. The caller must release the frame using av_frame_unref()
4908 * when the frame is no longer needed. The caller may safely write
4909 * to the frame if av_frame_is_writable() returns 1.
4910 * When AVCodecContext.refcounted_frames is set to 0, the returned
4911 * reference belongs to the decoder and is valid only until the
4912 * next call to this function or until closing or flushing the
4913 * decoder. The caller may not write to it.
4914 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4915 * non-zero. Note that this field being set to zero
4916 * does not mean that an error has occurred. For
4917 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4918 * call is guaranteed to produce a frame.
4919 * @param[in] avpkt The input AVPacket containing the input buffer.
4920 * At least avpkt->data and avpkt->size should be set. Some
4921 * decoders might also require additional fields to be set.
4922 * @return A negative error code is returned if an error occurred during
4923 * decoding, otherwise the number of bytes consumed from the input
4924 * AVPacket is returned.
4926 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4928 attribute_deprecated
4929 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4930 int *got_frame_ptr, const AVPacket *avpkt);
4933 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4934 * Some decoders may support multiple frames in a single AVPacket, such
4935 * decoders would then just decode the first frame.
4937 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4938 * the actual read bytes because some optimized bitstream readers read 32 or 64
4939 * bits at once and could read over the end.
4941 * @warning The end of the input buffer buf should be set to 0 to ensure that
4942 * no overreading happens for damaged MPEG streams.
4944 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4945 * between input and output, these need to be fed with avpkt->data=NULL,
4946 * avpkt->size=0 at the end to return the remaining frames.
4948 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4949 * before packets may be fed to the decoder.
4951 * @param avctx the codec context
4952 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4953 * Use av_frame_alloc() to get an AVFrame. The codec will
4954 * allocate memory for the actual bitmap by calling the
4955 * AVCodecContext.get_buffer2() callback.
4956 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4957 * reference counted and the returned reference belongs to the
4958 * caller. The caller must release the frame using av_frame_unref()
4959 * when the frame is no longer needed. The caller may safely write
4960 * to the frame if av_frame_is_writable() returns 1.
4961 * When AVCodecContext.refcounted_frames is set to 0, the returned
4962 * reference belongs to the decoder and is valid only until the
4963 * next call to this function or until closing or flushing the
4964 * decoder. The caller may not write to it.
4966 * @param[in] avpkt The input AVPacket containing the input buffer.
4967 * You can create such packet with av_init_packet() and by then setting
4968 * data and size, some decoders might in addition need other fields like
4969 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4971 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4972 * @return On error a negative value is returned, otherwise the number of bytes
4973 * used or zero if no frame could be decompressed.
4975 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4977 attribute_deprecated
4978 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4979 int *got_picture_ptr,
4980 const AVPacket *avpkt);
4983 * Decode a subtitle message.
4984 * Return a negative value on error, otherwise return the number of bytes used.
4985 * If no subtitle could be decompressed, got_sub_ptr is zero.
4986 * Otherwise, the subtitle is stored in *sub.
4987 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4988 * simplicity, because the performance difference is expect to be negligible
4989 * and reusing a get_buffer written for video codecs would probably perform badly
4990 * due to a potentially very different allocation pattern.
4992 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4993 * and output. This means that for some packets they will not immediately
4994 * produce decoded output and need to be flushed at the end of decoding to get
4995 * all the decoded data. Flushing is done by calling this function with packets
4996 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4997 * returning subtitles. It is safe to flush even those decoders that are not
4998 * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
5000 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
5001 * before packets may be fed to the decoder.
5003 * @param avctx the codec context
5004 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
5005 * must be freed with avsubtitle_free if *got_sub_ptr is set.
5006 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
5007 * @param[in] avpkt The input AVPacket containing the input buffer.
5009 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
5014 * Supply raw packet data as input to a decoder.
5016 * Internally, this call will copy relevant AVCodecContext fields, which can
5017 * influence decoding per-packet, and apply them when the packet is actually
5018 * decoded. (For example AVCodecContext.skip_frame, which might direct the
5019 * decoder to drop the frame contained by the packet sent with this function.)
5021 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
5022 * larger than the actual read bytes because some optimized bitstream
5023 * readers read 32 or 64 bits at once and could read over the end.
5025 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
5026 * on the same AVCodecContext. It will return unexpected results now
5027 * or in future libavcodec versions.
5029 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
5030 * before packets may be fed to the decoder.
5032 * @param avctx codec context
5033 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
5034 * frame, or several complete audio frames.
5035 * Ownership of the packet remains with the caller, and the
5036 * decoder will not write to the packet. The decoder may create
5037 * a reference to the packet data (or copy it if the packet is
5038 * not reference-counted).
5039 * Unlike with older APIs, the packet is always fully consumed,
5040 * and if it contains multiple frames (e.g. some audio codecs),
5041 * will require you to call avcodec_receive_frame() multiple
5042 * times afterwards before you can send a new packet.
5043 * It can be NULL (or an AVPacket with data set to NULL and
5044 * size set to 0); in this case, it is considered a flush
5045 * packet, which signals the end of the stream. Sending the
5046 * first flush packet will return success. Subsequent ones are
5047 * unnecessary and will return AVERROR_EOF. If the decoder
5048 * still has frames buffered, it will return them after sending
5051 * @return 0 on success, otherwise negative error code:
5052 * AVERROR(EAGAIN): input is not accepted in the current state - user
5053 * must read output with avcodec_receive_frame() (once
5054 * all output is read, the packet should be resent, and
5055 * the call will not fail with EAGAIN).
5056 * AVERROR_EOF: the decoder has been flushed, and no new packets can
5057 * be sent to it (also returned if more than 1 flush
5059 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
5060 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5061 * other errors: legitimate decoding errors
5063 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
5066 * Return decoded output data from a decoder.
5068 * @param avctx codec context
5069 * @param frame This will be set to a reference-counted video or audio
5070 * frame (depending on the decoder type) allocated by the
5071 * decoder. Note that the function will always call
5072 * av_frame_unref(frame) before doing anything else.
5075 * 0: success, a frame was returned
5076 * AVERROR(EAGAIN): output is not available in this state - user must try
5078 * AVERROR_EOF: the decoder has been fully flushed, and there will be
5079 * no more output frames
5080 * AVERROR(EINVAL): codec not opened, or it is an encoder
5081 * other negative values: legitimate decoding errors
5083 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
5086 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
5087 * to retrieve buffered output packets.
5089 * @param avctx codec context
5090 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
5091 * Ownership of the frame remains with the caller, and the
5092 * encoder will not write to the frame. The encoder may create
5093 * a reference to the frame data (or copy it if the frame is
5094 * not reference-counted).
5095 * It can be NULL, in which case it is considered a flush
5096 * packet. This signals the end of the stream. If the encoder
5097 * still has packets buffered, it will return them after this
5098 * call. Once flushing mode has been entered, additional flush
5099 * packets are ignored, and sending frames will return
5103 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5104 * can have any number of samples.
5105 * If it is not set, frame->nb_samples must be equal to
5106 * avctx->frame_size for all frames except the last.
5107 * The final frame may be smaller than avctx->frame_size.
5108 * @return 0 on success, otherwise negative error code:
5109 * AVERROR(EAGAIN): input is not accepted in the current state - user
5110 * must read output with avcodec_receive_packet() (once
5111 * all output is read, the packet should be resent, and
5112 * the call will not fail with EAGAIN).
5113 * AVERROR_EOF: the encoder has been flushed, and no new frames can
5115 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
5116 * decoder, or requires flush
5117 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
5118 * other errors: legitimate decoding errors
5120 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5123 * Read encoded data from the encoder.
5125 * @param avctx codec context
5126 * @param avpkt This will be set to a reference-counted packet allocated by the
5127 * encoder. Note that the function will always call
5128 * av_frame_unref(frame) before doing anything else.
5129 * @return 0 on success, otherwise negative error code:
5130 * AVERROR(EAGAIN): output is not available in the current state - user
5131 * must try to send input
5132 * AVERROR_EOF: the encoder has been fully flushed, and there will be
5133 * no more output packets
5134 * AVERROR(EINVAL): codec not opened, or it is an encoder
5135 * other errors: legitimate decoding errors
5137 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5141 * @defgroup lavc_parsing Frame parsing
5145 enum AVPictureStructure {
5146 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
5147 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
5148 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5149 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5152 typedef struct AVCodecParserContext {
5154 struct AVCodecParser *parser;
5155 int64_t frame_offset; /* offset of the current frame */
5156 int64_t cur_offset; /* current offset
5157 (incremented by each av_parser_parse()) */
5158 int64_t next_frame_offset; /* offset of the next frame */
5160 int pict_type; /* XXX: Put it back in AVCodecContext. */
5162 * This field is used for proper frame duration computation in lavf.
5163 * It signals, how much longer the frame duration of the current frame
5164 * is compared to normal frame duration.
5166 * frame_duration = (1 + repeat_pict) * time_base
5168 * It is used by codecs like H.264 to display telecined material.
5170 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5171 int64_t pts; /* pts of the current frame */
5172 int64_t dts; /* dts of the current frame */
5177 int fetch_timestamp;
5179 #define AV_PARSER_PTS_NB 4
5180 int cur_frame_start_index;
5181 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5182 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5183 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5186 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5187 #define PARSER_FLAG_ONCE 0x0002
5188 /// Set if the parser has a valid file offset
5189 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5190 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5192 int64_t offset; ///< byte offset from starting packet start
5193 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5196 * Set by parser to 1 for key frames and 0 for non-key frames.
5197 * It is initialized to -1, so if the parser doesn't set this flag,
5198 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5203 #if FF_API_CONVERGENCE_DURATION
5205 * @deprecated unused
5207 attribute_deprecated
5208 int64_t convergence_duration;
5211 // Timestamp generation support:
5213 * Synchronization point for start of timestamp generation.
5215 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5218 * For example, this corresponds to presence of H.264 buffering period
5224 * Offset of the current timestamp against last timestamp sync point in
5225 * units of AVCodecContext.time_base.
5227 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5228 * contain a valid timestamp offset.
5230 * Note that the timestamp of sync point has usually a nonzero
5231 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5232 * the next frame after timestamp sync point will be usually 1.
5234 * For example, this corresponds to H.264 cpb_removal_delay.
5236 int dts_ref_dts_delta;
5239 * Presentation delay of current frame in units of AVCodecContext.time_base.
5241 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5242 * contain valid non-negative timestamp delta (presentation time of a frame
5243 * must not lie in the past).
5245 * This delay represents the difference between decoding and presentation
5246 * time of the frame.
5248 * For example, this corresponds to H.264 dpb_output_delay.
5253 * Position of the packet in file.
5255 * Analogous to cur_frame_pts/dts
5257 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5260 * Byte position of currently parsed frame in stream.
5265 * Previous frame byte position.
5270 * Duration of the current frame.
5271 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5272 * For all other types, this is in units of AVCodecContext.time_base.
5276 enum AVFieldOrder field_order;
5279 * Indicate whether a picture is coded as a frame, top field or bottom field.
5281 * For example, H.264 field_pic_flag equal to 0 corresponds to
5282 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5283 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5284 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5286 enum AVPictureStructure picture_structure;
5289 * Picture number incremented in presentation or output order.
5290 * This field may be reinitialized at the first picture of a new sequence.
5292 * For example, this corresponds to H.264 PicOrderCnt.
5294 int output_picture_number;
5297 * Dimensions of the decoded video intended for presentation.
5303 * Dimensions of the coded video.
5309 * The format of the coded data, corresponds to enum AVPixelFormat for video
5310 * and for enum AVSampleFormat for audio.
5312 * Note that a decoder can have considerable freedom in how exactly it
5313 * decodes the data, so the format reported here might be different from the
5314 * one returned by a decoder.
5317 } AVCodecParserContext;
5319 typedef struct AVCodecParser {
5320 int codec_ids[5]; /* several codec IDs are permitted */
5322 int (*parser_init)(AVCodecParserContext *s);
5323 /* This callback never returns an error, a negative value means that
5324 * the frame start was in a previous packet. */
5325 int (*parser_parse)(AVCodecParserContext *s,
5326 AVCodecContext *avctx,
5327 const uint8_t **poutbuf, int *poutbuf_size,
5328 const uint8_t *buf, int buf_size);
5329 void (*parser_close)(AVCodecParserContext *s);
5330 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5331 struct AVCodecParser *next;
5334 AVCodecParser *av_parser_next(const AVCodecParser *c);
5336 void av_register_codec_parser(AVCodecParser *parser);
5337 AVCodecParserContext *av_parser_init(int codec_id);
5342 * @param s parser context.
5343 * @param avctx codec context.
5344 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5345 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5346 * @param buf input buffer.
5347 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5348 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5349 To signal EOF, this should be 0 (so that the last frame
5351 * @param pts input presentation timestamp.
5352 * @param dts input decoding timestamp.
5353 * @param pos input byte position in stream.
5354 * @return the number of bytes of the input bitstream used.
5359 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5366 * decode_frame(data, size);
5370 int av_parser_parse2(AVCodecParserContext *s,
5371 AVCodecContext *avctx,
5372 uint8_t **poutbuf, int *poutbuf_size,
5373 const uint8_t *buf, int buf_size,
5374 int64_t pts, int64_t dts,
5378 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5379 * @deprecated use AVBitStreamFilter
5381 int av_parser_change(AVCodecParserContext *s,
5382 AVCodecContext *avctx,
5383 uint8_t **poutbuf, int *poutbuf_size,
5384 const uint8_t *buf, int buf_size, int keyframe);
5385 void av_parser_close(AVCodecParserContext *s);
5393 * @addtogroup lavc_encoding
5398 * Find a registered encoder with a matching codec ID.
5400 * @param id AVCodecID of the requested encoder
5401 * @return An encoder if one was found, NULL otherwise.
5403 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5406 * Find a registered encoder with the specified name.
5408 * @param name name of the requested encoder
5409 * @return An encoder if one was found, NULL otherwise.
5411 AVCodec *avcodec_find_encoder_by_name(const char *name);
5414 * Encode a frame of audio.
5416 * Takes input samples from frame and writes the next output packet, if
5417 * available, to avpkt. The output packet does not necessarily contain data for
5418 * the most recent frame, as encoders can delay, split, and combine input frames
5419 * internally as needed.
5421 * @param avctx codec context
5422 * @param avpkt output AVPacket.
5423 * The user can supply an output buffer by setting
5424 * avpkt->data and avpkt->size prior to calling the
5425 * function, but if the size of the user-provided data is not
5426 * large enough, encoding will fail. If avpkt->data and
5427 * avpkt->size are set, avpkt->destruct must also be set. All
5428 * other AVPacket fields will be reset by the encoder using
5429 * av_init_packet(). If avpkt->data is NULL, the encoder will
5430 * allocate it. The encoder will set avpkt->size to the size
5431 * of the output packet.
5433 * If this function fails or produces no output, avpkt will be
5434 * freed using av_packet_unref().
5435 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5436 * May be NULL when flushing an encoder that has the
5437 * AV_CODEC_CAP_DELAY capability set.
5438 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5439 * can have any number of samples.
5440 * If it is not set, frame->nb_samples must be equal to
5441 * avctx->frame_size for all frames except the last.
5442 * The final frame may be smaller than avctx->frame_size.
5443 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5444 * output packet is non-empty, and to 0 if it is
5445 * empty. If the function returns an error, the
5446 * packet can be assumed to be invalid, and the
5447 * value of got_packet_ptr is undefined and should
5449 * @return 0 on success, negative error code on failure
5451 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5453 attribute_deprecated
5454 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5455 const AVFrame *frame, int *got_packet_ptr);
5458 * Encode a frame of video.
5460 * Takes input raw video data from frame and writes the next output packet, if
5461 * available, to avpkt. The output packet does not necessarily contain data for
5462 * the most recent frame, as encoders can delay and reorder input frames
5463 * internally as needed.
5465 * @param avctx codec context
5466 * @param avpkt output AVPacket.
5467 * The user can supply an output buffer by setting
5468 * avpkt->data and avpkt->size prior to calling the
5469 * function, but if the size of the user-provided data is not
5470 * large enough, encoding will fail. All other AVPacket fields
5471 * will be reset by the encoder using av_init_packet(). If
5472 * avpkt->data is NULL, the encoder will allocate it.
5473 * The encoder will set avpkt->size to the size of the
5474 * output packet. The returned data (if any) belongs to the
5475 * caller, he is responsible for freeing it.
5477 * If this function fails or produces no output, avpkt will be
5478 * freed using av_packet_unref().
5479 * @param[in] frame AVFrame containing the raw video data to be encoded.
5480 * May be NULL when flushing an encoder that has the
5481 * AV_CODEC_CAP_DELAY capability set.
5482 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5483 * output packet is non-empty, and to 0 if it is
5484 * empty. If the function returns an error, the
5485 * packet can be assumed to be invalid, and the
5486 * value of got_packet_ptr is undefined and should
5488 * @return 0 on success, negative error code on failure
5490 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5492 attribute_deprecated
5493 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5494 const AVFrame *frame, int *got_packet_ptr);
5496 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5497 const AVSubtitle *sub);
5504 #if FF_API_AVPICTURE
5506 * @addtogroup lavc_picture
5511 * @deprecated unused
5513 attribute_deprecated
5514 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5517 * @deprecated unused
5519 attribute_deprecated
5520 void avpicture_free(AVPicture *picture);
5523 * @deprecated use av_image_fill_arrays() instead.
5525 attribute_deprecated
5526 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5527 enum AVPixelFormat pix_fmt, int width, int height);
5530 * @deprecated use av_image_copy_to_buffer() instead.
5532 attribute_deprecated
5533 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5534 int width, int height,
5535 unsigned char *dest, int dest_size);
5538 * @deprecated use av_image_get_buffer_size() instead.
5540 attribute_deprecated
5541 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5544 * @deprecated av_image_copy() instead.
5546 attribute_deprecated
5547 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5548 enum AVPixelFormat pix_fmt, int width, int height);
5551 * @deprecated unused
5553 attribute_deprecated
5554 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5555 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5558 * @deprecated unused
5560 attribute_deprecated
5561 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5562 int padtop, int padbottom, int padleft, int padright, int *color);
5570 * @defgroup lavc_misc Utility functions
5573 * Miscellaneous utility functions related to both encoding and decoding
5579 * @defgroup lavc_misc_pixfmt Pixel formats
5581 * Functions for working with pixel formats.
5585 #if FF_API_GETCHROMA
5587 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5590 attribute_deprecated
5591 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5595 * Return a value representing the fourCC code associated to the
5596 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5599 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5602 * @deprecated see av_get_pix_fmt_loss()
5604 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5608 * Find the best pixel format to convert to given a certain source pixel
5609 * format. When converting from one pixel format to another, information loss
5610 * may occur. For example, when converting from RGB24 to GRAY, the color
5611 * information will be lost. Similarly, other losses occur when converting from
5612 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5613 * the given pixel formats should be used to suffer the least amount of loss.
5614 * The pixel formats from which it chooses one, are determined by the
5615 * pix_fmt_list parameter.
5618 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5619 * @param[in] src_pix_fmt source pixel format
5620 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5621 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5622 * @return The best pixel format to convert to or -1 if none was found.
5624 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5625 enum AVPixelFormat src_pix_fmt,
5626 int has_alpha, int *loss_ptr);
5629 * @deprecated see av_find_best_pix_fmt_of_2()
5631 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5632 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5634 attribute_deprecated
5635 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5636 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5638 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5644 #if FF_API_SET_DIMENSIONS
5646 * @deprecated this function is not supposed to be used from outside of lavc
5648 attribute_deprecated
5649 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5652 #if FF_API_TAG_STRING
5654 * Put a string representing the codec tag codec_tag in buf.
5656 * @param buf buffer to place codec tag in
5657 * @param buf_size size in bytes of buf
5658 * @param codec_tag codec tag to assign
5659 * @return the length of the string that would have been generated if
5660 * enough space had been available, excluding the trailing null
5662 * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5664 attribute_deprecated
5665 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5668 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5671 * Return a name for the specified profile, if available.
5673 * @param codec the codec that is searched for the given profile
5674 * @param profile the profile value for which a name is requested
5675 * @return A name for the profile if found, NULL otherwise.
5677 const char *av_get_profile_name(const AVCodec *codec, int profile);
5680 * Return a name for the specified profile, if available.
5682 * @param codec_id the ID of the codec to which the requested profile belongs
5683 * @param profile the profile value for which a name is requested
5684 * @return A name for the profile if found, NULL otherwise.
5686 * @note unlike av_get_profile_name(), which searches a list of profiles
5687 * supported by a specific decoder or encoder implementation, this
5688 * function searches the list of profiles from the AVCodecDescriptor
5690 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5692 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5693 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5694 //FIXME func typedef
5697 * Fill AVFrame audio data and linesize pointers.
5699 * The buffer buf must be a preallocated buffer with a size big enough
5700 * to contain the specified samples amount. The filled AVFrame data
5701 * pointers will point to this buffer.
5703 * AVFrame extended_data channel pointers are allocated if necessary for
5706 * @param frame the AVFrame
5707 * frame->nb_samples must be set prior to calling the
5708 * function. This function fills in frame->data,
5709 * frame->extended_data, frame->linesize[0].
5710 * @param nb_channels channel count
5711 * @param sample_fmt sample format
5712 * @param buf buffer to use for frame data
5713 * @param buf_size size of buffer
5714 * @param align plane size sample alignment (0 = default)
5715 * @return >=0 on success, negative error code on failure
5716 * @todo return the size in bytes required to store the samples in
5717 * case of success, at the next libavutil bump
5719 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5720 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5721 int buf_size, int align);
5724 * Reset the internal decoder state / flush internal buffers. Should be called
5725 * e.g. when seeking or when switching to a different stream.
5727 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5728 * this invalidates the frames previously returned from the decoder. When
5729 * refcounted frames are used, the decoder just releases any references it might
5730 * keep internally, but the caller's reference remains valid.
5732 void avcodec_flush_buffers(AVCodecContext *avctx);
5735 * Return codec bits per sample.
5737 * @param[in] codec_id the codec
5738 * @return Number of bits per sample or zero if unknown for the given codec.
5740 int av_get_bits_per_sample(enum AVCodecID codec_id);
5743 * Return the PCM codec associated with a sample format.
5744 * @param be endianness, 0 for little, 1 for big,
5745 * -1 (or anything else) for native
5746 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5748 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5751 * Return codec bits per sample.
5752 * Only return non-zero if the bits per sample is exactly correct, not an
5755 * @param[in] codec_id the codec
5756 * @return Number of bits per sample or zero if unknown for the given codec.
5758 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5761 * Return audio frame duration.
5763 * @param avctx codec context
5764 * @param frame_bytes size of the frame, or 0 if unknown
5765 * @return frame duration, in samples, if known. 0 if not able to
5768 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5771 * This function is the same as av_get_audio_frame_duration(), except it works
5772 * with AVCodecParameters instead of an AVCodecContext.
5774 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5777 typedef struct AVBitStreamFilterContext {
5779 const struct AVBitStreamFilter *filter;
5780 AVCodecParserContext *parser;
5781 struct AVBitStreamFilterContext *next;
5783 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5784 * Not for access by library users.
5787 } AVBitStreamFilterContext;
5790 typedef struct AVBSFInternal AVBSFInternal;
5793 * The bitstream filter state.
5795 * This struct must be allocated with av_bsf_alloc() and freed with
5798 * The fields in the struct will only be changed (by the caller or by the
5799 * filter) as described in their documentation, and are to be considered
5800 * immutable otherwise.
5802 typedef struct AVBSFContext {
5804 * A class for logging and AVOptions
5806 const AVClass *av_class;
5809 * The bitstream filter this context is an instance of.
5811 const struct AVBitStreamFilter *filter;
5814 * Opaque libavcodec internal data. Must not be touched by the caller in any
5817 AVBSFInternal *internal;
5820 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5821 * this is an AVOptions-enabled struct.
5826 * Parameters of the input stream. This field is allocated in
5827 * av_bsf_alloc(), it needs to be filled by the caller before
5830 AVCodecParameters *par_in;
5833 * Parameters of the output stream. This field is allocated in
5834 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5836 AVCodecParameters *par_out;
5839 * The timebase used for the timestamps of the input packets. Set by the
5840 * caller before av_bsf_init().
5842 AVRational time_base_in;
5845 * The timebase used for the timestamps of the output packets. Set by the
5846 * filter in av_bsf_init().
5848 AVRational time_base_out;
5851 typedef struct AVBitStreamFilter {
5855 * A list of codec ids supported by the filter, terminated by
5857 * May be NULL, in that case the bitstream filter works with any codec id.
5859 const enum AVCodecID *codec_ids;
5862 * A class for the private data, used to declare bitstream filter private
5863 * AVOptions. This field is NULL for bitstream filters that do not declare
5866 * If this field is non-NULL, the first member of the filter private data
5867 * must be a pointer to AVClass, which will be set by libavcodec generic
5868 * code to this class.
5870 const AVClass *priv_class;
5872 /*****************************************************************
5873 * No fields below this line are part of the public API. They
5874 * may not be used outside of libavcodec and can be changed and
5876 * New public fields should be added right above.
5877 *****************************************************************
5881 int (*init)(AVBSFContext *ctx);
5882 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5883 void (*close)(AVBSFContext *ctx);
5884 } AVBitStreamFilter;
5888 * Register a bitstream filter.
5890 * The filter will be accessible to the application code through
5891 * av_bitstream_filter_next() or can be directly initialized with
5892 * av_bitstream_filter_init().
5894 * @see avcodec_register_all()
5896 attribute_deprecated
5897 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5900 * Create and initialize a bitstream filter context given a bitstream
5903 * The returned context must be freed with av_bitstream_filter_close().
5905 * @param name the name of the bitstream filter
5906 * @return a bitstream filter context if a matching filter was found
5907 * and successfully initialized, NULL otherwise
5909 attribute_deprecated
5910 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5915 * This function filters the buffer buf with size buf_size, and places the
5916 * filtered buffer in the buffer pointed to by poutbuf.
5918 * The output buffer must be freed by the caller.
5920 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5921 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5922 * If specified, this must point to the encoder context of the
5923 * output stream the packet is sent to.
5924 * @param args arguments which specify the filter configuration, may be NULL
5925 * @param poutbuf pointer which is updated to point to the filtered buffer
5926 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5927 * @param buf buffer containing the data to filter
5928 * @param buf_size size in bytes of buf
5929 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5930 * @return >= 0 in case of success, or a negative error code in case of failure
5932 * If the return value is positive, an output buffer is allocated and
5933 * is available in *poutbuf, and is distinct from the input buffer.
5935 * If the return value is 0, the output buffer is not allocated and
5936 * should be considered identical to the input buffer, or in case
5937 * *poutbuf was set it points to the input buffer (not necessarily to
5938 * its starting address). A special case is if *poutbuf was set to NULL and
5939 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5941 attribute_deprecated
5942 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5943 AVCodecContext *avctx, const char *args,
5944 uint8_t **poutbuf, int *poutbuf_size,
5945 const uint8_t *buf, int buf_size, int keyframe);
5948 * Release bitstream filter context.
5950 * @param bsf the bitstream filter context created with
5951 * av_bitstream_filter_init(), can be NULL
5953 attribute_deprecated
5954 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5957 * If f is NULL, return the first registered bitstream filter,
5958 * if f is non-NULL, return the next registered bitstream filter
5959 * after f, or NULL if f is the last one.
5961 * This function can be used to iterate over all registered bitstream
5964 attribute_deprecated
5965 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5969 * @return a bitstream filter with the specified name or NULL if no such
5970 * bitstream filter exists.
5972 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5975 * Iterate over all registered bitstream filters.
5977 * @param opaque a pointer where libavcodec will store the iteration state. Must
5978 * point to NULL to start the iteration.
5980 * @return the next registered bitstream filter or NULL when the iteration is
5983 const AVBitStreamFilter *av_bsf_next(void **opaque);
5986 * Allocate a context for a given bitstream filter. The caller must fill in the
5987 * context parameters as described in the documentation and then call
5988 * av_bsf_init() before sending any data to the filter.
5990 * @param filter the filter for which to allocate an instance.
5991 * @param ctx a pointer into which the pointer to the newly-allocated context
5992 * will be written. It must be freed with av_bsf_free() after the
5993 * filtering is done.
5995 * @return 0 on success, a negative AVERROR code on failure
5997 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
6000 * Prepare the filter for use, after all the parameters and options have been
6003 int av_bsf_init(AVBSFContext *ctx);
6006 * Submit a packet for filtering.
6008 * After sending each packet, the filter must be completely drained by calling
6009 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
6012 * @param pkt the packet to filter. The bitstream filter will take ownership of
6013 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
6014 * This parameter may be NULL, which signals the end of the stream (i.e. no more
6015 * packets will be sent). That will cause the filter to output any packets it
6016 * may have buffered internally.
6018 * @return 0 on success, a negative AVERROR on error.
6020 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
6023 * Retrieve a filtered packet.
6025 * @param[out] pkt this struct will be filled with the contents of the filtered
6026 * packet. It is owned by the caller and must be freed using
6027 * av_packet_unref() when it is no longer needed.
6028 * This parameter should be "clean" (i.e. freshly allocated
6029 * with av_packet_alloc() or unreffed with av_packet_unref())
6030 * when this function is called. If this function returns
6031 * successfully, the contents of pkt will be completely
6032 * overwritten by the returned data. On failure, pkt is not
6035 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
6036 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
6037 * will be no further output from the filter. Another negative AVERROR value if
6040 * @note one input packet may result in several output packets, so after sending
6041 * a packet with av_bsf_send_packet(), this function needs to be called
6042 * repeatedly until it stops returning 0. It is also possible for a filter to
6043 * output fewer packets than were sent to it, so this function may return
6044 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6046 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6049 * Free a bitstream filter context and everything associated with it; write NULL
6050 * into the supplied pointer.
6052 void av_bsf_free(AVBSFContext **ctx);
6055 * Get the AVClass for AVBSFContext. It can be used in combination with
6056 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6058 * @see av_opt_find().
6060 const AVClass *av_bsf_get_class(void);
6063 * Structure for chain/list of bitstream filters.
6064 * Empty list can be allocated by av_bsf_list_alloc().
6066 typedef struct AVBSFList AVBSFList;
6069 * Allocate empty list of bitstream filters.
6070 * The list must be later freed by av_bsf_list_free()
6071 * or finalized by av_bsf_list_finalize().
6073 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6075 AVBSFList *av_bsf_list_alloc(void);
6078 * Free list of bitstream filters.
6080 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6082 void av_bsf_list_free(AVBSFList **lst);
6085 * Append bitstream filter to the list of bitstream filters.
6087 * @param lst List to append to
6088 * @param bsf Filter context to be appended
6090 * @return >=0 on success, negative AVERROR in case of failure
6092 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6095 * Construct new bitstream filter context given it's name and options
6096 * and append it to the list of bitstream filters.
6098 * @param lst List to append to
6099 * @param bsf_name Name of the bitstream filter
6100 * @param options Options for the bitstream filter, can be set to NULL
6102 * @return >=0 on success, negative AVERROR in case of failure
6104 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6106 * Finalize list of bitstream filters.
6108 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6109 * so the whole chain of bitstream filters can be treated as single filter
6110 * freshly allocated by av_bsf_alloc().
6111 * If the call is successful, @ref AVBSFList structure is freed and lst
6112 * will be set to NULL. In case of failure, caller is responsible for
6113 * freeing the structure by av_bsf_list_free()
6115 * @param lst Filter list structure to be transformed
6116 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6117 * representing the chain of bitstream filters
6119 * @return >=0 on success, negative AVERROR in case of failure
6121 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6124 * Parse string describing list of bitstream filters and create single
6125 * @ref AVBSFContext describing the whole chain of bitstream filters.
6126 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6127 * allocated by av_bsf_alloc().
6129 * @param str String describing chain of bitstream filters in format
6130 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6131 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6132 * representing the chain of bitstream filters
6134 * @return >=0 on success, negative AVERROR in case of failure
6136 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6139 * Get null/pass-through bitstream filter.
6141 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6145 int av_bsf_get_null_filter(AVBSFContext **bsf);
6150 * Same behaviour av_fast_malloc but the buffer has additional
6151 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6153 * In addition the whole buffer will initially and after resizes
6154 * be 0-initialized so that no uninitialized data will ever appear.
6156 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6159 * Same behaviour av_fast_padded_malloc except that buffer will always
6160 * be 0-initialized after call.
6162 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6165 * Encode extradata length to a buffer. Used by xiph codecs.
6167 * @param s buffer to write to; must be at least (v/255+1) bytes long
6168 * @param v size of extradata in bytes
6169 * @return number of bytes written to the buffer.
6171 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6174 * Register the hardware accelerator hwaccel.
6176 void av_register_hwaccel(AVHWAccel *hwaccel);
6179 * If hwaccel is NULL, returns the first registered hardware accelerator,
6180 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6181 * after hwaccel, or NULL if hwaccel is the last one.
6183 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6187 * Lock operation used by lockmgr
6190 AV_LOCK_CREATE, ///< Create a mutex
6191 AV_LOCK_OBTAIN, ///< Lock the mutex
6192 AV_LOCK_RELEASE, ///< Unlock the mutex
6193 AV_LOCK_DESTROY, ///< Free mutex resources
6197 * Register a user provided lock manager supporting the operations
6198 * specified by AVLockOp. The "mutex" argument to the function points
6199 * to a (void *) where the lockmgr should store/get a pointer to a user
6200 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6201 * value left by the last call for all other ops. If the lock manager is
6202 * unable to perform the op then it should leave the mutex in the same
6203 * state as when it was called and return a non-zero value. However,
6204 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6205 * have been successfully destroyed. If av_lockmgr_register succeeds
6206 * it will return a non-negative value, if it fails it will return a
6207 * negative value and destroy all mutex and unregister all callbacks.
6208 * av_lockmgr_register is not thread-safe, it must be called from a
6209 * single thread before any calls which make use of locking are used.
6211 * @param cb User defined callback. av_lockmgr_register invokes calls
6212 * to this callback and the previously registered callback.
6213 * The callback will be used to create more than one mutex
6214 * each of which must be backed by its own underlying locking
6215 * mechanism (i.e. do not use a single static object to
6216 * implement your lock manager). If cb is set to NULL the
6217 * lockmgr will be unregistered.
6219 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6222 * Get the type of the given codec.
6224 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6227 * Get the name of a codec.
6228 * @return a static string identifying the codec; never NULL
6230 const char *avcodec_get_name(enum AVCodecID id);
6233 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6234 * with no corresponding avcodec_close()), 0 otherwise.
6236 int avcodec_is_open(AVCodecContext *s);
6239 * @return a non-zero number if codec is an encoder, zero otherwise
6241 int av_codec_is_encoder(const AVCodec *codec);
6244 * @return a non-zero number if codec is a decoder, zero otherwise
6246 int av_codec_is_decoder(const AVCodec *codec);
6249 * @return descriptor for given codec ID or NULL if no descriptor exists.
6251 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6254 * Iterate over all codec descriptors known to libavcodec.
6256 * @param prev previous descriptor. NULL to get the first descriptor.
6258 * @return next descriptor or NULL after the last descriptor
6260 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6263 * @return codec descriptor with the given name or NULL if no such descriptor
6266 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6269 * Allocate a CPB properties structure and initialize its fields to default
6272 * @param size if non-NULL, the size of the allocated struct will be written
6273 * here. This is useful for embedding it in side data.
6275 * @return the newly allocated struct or NULL on failure
6277 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6283 #endif /* AVCODEC_AVCODEC_H */