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 * End of stream situations. These require "flushing" (aka draining) the codec,
116 * as the codec might buffer multiple frames or packets internally for
117 * performance or out of necessity (consider B-frames).
118 * This is handled as follows:
119 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
120 * or avcodec_send_frame() (encoding) functions. This will enter draining
122 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
123 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
124 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
125 * - Before decoding can be resumed again, the codec has to be reset with
126 * avcodec_flush_buffers().
128 * Using the API as outlined above is highly recommended. But it is also
129 * possible to call functions outside of this rigid schema. For example, you can
130 * call avcodec_send_packet() repeatedly without calling
131 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
132 * until the codec's internal buffer has been filled up (which is typically of
133 * size 1 per output frame, after initial input), and then reject input with
134 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
135 * read at least some output.
137 * Not all codecs will follow a rigid and predictable dataflow; the only
138 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
139 * one end implies that a receive/send call on the other end will succeed. In
140 * general, no codec will permit unlimited buffering of input or output.
142 * This API replaces the following legacy functions:
143 * - avcodec_decode_video2() and avcodec_decode_audio4():
144 * Use avcodec_send_packet() to feed input to the decoder, then use
145 * avcodec_receive_frame() to receive decoded frames after each packet.
146 * Unlike with the old video decoding API, multiple frames might result from
147 * a packet. For audio, splitting the input packet into frames by partially
148 * decoding packets becomes transparent to the API user. You never need to
149 * feed an AVPacket to the API twice.
150 * Additionally, sending a flush/draining packet is required only once.
151 * - avcodec_encode_video2()/avcodec_encode_audio2():
152 * Use avcodec_send_frame() to feed input to the encoder, then use
153 * avcodec_receive_packet() to receive encoded packets.
154 * Providing user-allocated buffers for avcodec_receive_packet() is not
156 * - The new API does not handle subtitles yet.
158 * Mixing new and old function calls on the same AVCodecContext is not allowed,
159 * and will result in undefined behavior.
161 * Some codecs might require using the new API; using the old API will return
162 * an error when calling it.
167 * @defgroup lavc_core Core functions/structures.
170 * Basic definitions, functions for querying libavcodec capabilities,
171 * allocating core structures, etc.
177 * Identify the syntax and semantics of the bitstream.
178 * The principle is roughly:
179 * Two decoders with the same ID can decode the same streams.
180 * Two encoders with the same ID can encode compatible streams.
181 * There may be slight deviations from the principle due to implementation
184 * If you add a codec ID to this list, add it so that
185 * 1. no value of an existing codec ID changes (that would break ABI),
186 * 2. it is as close as possible to similar codecs
188 * After adding new codec IDs, do not forget to add an entry to the codec
189 * descriptor list and bump libavcodec minor version.
195 AV_CODEC_ID_MPEG1VIDEO,
196 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
198 AV_CODEC_ID_MPEG2VIDEO_XVMC,
199 #endif /* FF_API_XVMC */
210 AV_CODEC_ID_RAWVIDEO,
211 AV_CODEC_ID_MSMPEG4V1,
212 AV_CODEC_ID_MSMPEG4V2,
213 AV_CODEC_ID_MSMPEG4V3,
236 AV_CODEC_ID_INTERPLAY_VIDEO,
243 AV_CODEC_ID_MSVIDEO1,
248 AV_CODEC_ID_TRUEMOTION1,
249 AV_CODEC_ID_VMDVIDEO,
274 AV_CODEC_ID_TRUEMOTION2,
280 AV_CODEC_ID_SMACKVIDEO,
285 AV_CODEC_ID_JPEG2000,
291 AV_CODEC_ID_DSICINVIDEO,
292 AV_CODEC_ID_TIERTEXSEQVIDEO,
300 AV_CODEC_ID_BETHSOFTVID,
312 AV_CODEC_ID_ESCAPE124,
316 AV_CODEC_ID_MOTIONPIXELS,
328 AV_CODEC_ID_FLASHSV2,
329 AV_CODEC_ID_CDGRAPHICS,
332 AV_CODEC_ID_BINKVIDEO,
333 AV_CODEC_ID_IFF_ILBM,
334 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
340 AV_CODEC_ID_A64_MULTI,
341 AV_CODEC_ID_A64_MULTI5,
344 AV_CODEC_ID_LAGARITH,
348 AV_CODEC_ID_WMV3IMAGE,
349 AV_CODEC_ID_VC1IMAGE,
351 AV_CODEC_ID_BMV_VIDEO,
358 AV_CODEC_ID_ZEROCODEC,
367 AV_CODEC_ID_ESCAPE130,
370 AV_CODEC_ID_HNM4_VIDEO,
372 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
374 AV_CODEC_ID_ALIAS_PIX,
375 AV_CODEC_ID_BRENDER_PIX,
376 AV_CODEC_ID_PAF_VIDEO,
389 AV_CODEC_ID_SCREENPRESSO,
392 AV_CODEC_ID_Y41P = 0x8000,
397 AV_CODEC_ID_TARGA_Y216,
409 AV_CODEC_ID_TRUEMOTION2RT,
411 AV_CODEC_ID_MAGICYUV,
412 AV_CODEC_ID_SHEERVIDEO,
418 /* various PCM "codecs" */
419 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
420 AV_CODEC_ID_PCM_S16LE = 0x10000,
421 AV_CODEC_ID_PCM_S16BE,
422 AV_CODEC_ID_PCM_U16LE,
423 AV_CODEC_ID_PCM_U16BE,
426 AV_CODEC_ID_PCM_MULAW,
427 AV_CODEC_ID_PCM_ALAW,
428 AV_CODEC_ID_PCM_S32LE,
429 AV_CODEC_ID_PCM_S32BE,
430 AV_CODEC_ID_PCM_U32LE,
431 AV_CODEC_ID_PCM_U32BE,
432 AV_CODEC_ID_PCM_S24LE,
433 AV_CODEC_ID_PCM_S24BE,
434 AV_CODEC_ID_PCM_U24LE,
435 AV_CODEC_ID_PCM_U24BE,
436 AV_CODEC_ID_PCM_S24DAUD,
437 AV_CODEC_ID_PCM_ZORK,
438 AV_CODEC_ID_PCM_S16LE_PLANAR,
440 AV_CODEC_ID_PCM_F32BE,
441 AV_CODEC_ID_PCM_F32LE,
442 AV_CODEC_ID_PCM_F64BE,
443 AV_CODEC_ID_PCM_F64LE,
444 AV_CODEC_ID_PCM_BLURAY,
447 AV_CODEC_ID_PCM_S8_PLANAR,
448 AV_CODEC_ID_PCM_S24LE_PLANAR,
449 AV_CODEC_ID_PCM_S32LE_PLANAR,
450 AV_CODEC_ID_PCM_S16BE_PLANAR,
452 AV_CODEC_ID_PCM_S64LE = 0x10800,
453 AV_CODEC_ID_PCM_S64BE,
454 AV_CODEC_ID_PCM_F16LE,
455 AV_CODEC_ID_PCM_F24LE,
457 /* various ADPCM codecs */
458 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
459 AV_CODEC_ID_ADPCM_IMA_WAV,
460 AV_CODEC_ID_ADPCM_IMA_DK3,
461 AV_CODEC_ID_ADPCM_IMA_DK4,
462 AV_CODEC_ID_ADPCM_IMA_WS,
463 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
464 AV_CODEC_ID_ADPCM_MS,
465 AV_CODEC_ID_ADPCM_4XM,
466 AV_CODEC_ID_ADPCM_XA,
467 AV_CODEC_ID_ADPCM_ADX,
468 AV_CODEC_ID_ADPCM_EA,
469 AV_CODEC_ID_ADPCM_G726,
470 AV_CODEC_ID_ADPCM_CT,
471 AV_CODEC_ID_ADPCM_SWF,
472 AV_CODEC_ID_ADPCM_YAMAHA,
473 AV_CODEC_ID_ADPCM_SBPRO_4,
474 AV_CODEC_ID_ADPCM_SBPRO_3,
475 AV_CODEC_ID_ADPCM_SBPRO_2,
476 AV_CODEC_ID_ADPCM_THP,
477 AV_CODEC_ID_ADPCM_IMA_AMV,
478 AV_CODEC_ID_ADPCM_EA_R1,
479 AV_CODEC_ID_ADPCM_EA_R3,
480 AV_CODEC_ID_ADPCM_EA_R2,
481 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
482 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
483 AV_CODEC_ID_ADPCM_EA_XAS,
484 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
485 AV_CODEC_ID_ADPCM_IMA_ISS,
486 AV_CODEC_ID_ADPCM_G722,
487 AV_CODEC_ID_ADPCM_IMA_APC,
488 AV_CODEC_ID_ADPCM_VIMA,
489 #if FF_API_VIMA_DECODER
490 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
493 AV_CODEC_ID_ADPCM_AFC = 0x11800,
494 AV_CODEC_ID_ADPCM_IMA_OKI,
495 AV_CODEC_ID_ADPCM_DTK,
496 AV_CODEC_ID_ADPCM_IMA_RAD,
497 AV_CODEC_ID_ADPCM_G726LE,
498 AV_CODEC_ID_ADPCM_THP_LE,
499 AV_CODEC_ID_ADPCM_PSX,
500 AV_CODEC_ID_ADPCM_AICA,
501 AV_CODEC_ID_ADPCM_IMA_DAT4,
502 AV_CODEC_ID_ADPCM_MTAF,
505 AV_CODEC_ID_AMR_NB = 0x12000,
508 /* RealAudio codecs*/
509 AV_CODEC_ID_RA_144 = 0x13000,
512 /* various DPCM codecs */
513 AV_CODEC_ID_ROQ_DPCM = 0x14000,
514 AV_CODEC_ID_INTERPLAY_DPCM,
515 AV_CODEC_ID_XAN_DPCM,
516 AV_CODEC_ID_SOL_DPCM,
518 AV_CODEC_ID_SDX2_DPCM = 0x14800,
521 AV_CODEC_ID_MP2 = 0x15000,
522 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
532 AV_CODEC_ID_VMDAUDIO,
538 AV_CODEC_ID_WESTWOOD_SND1,
539 AV_CODEC_ID_GSM, ///< as in Berlin toast format
542 AV_CODEC_ID_TRUESPEECH,
544 AV_CODEC_ID_SMACKAUDIO,
547 AV_CODEC_ID_DSICINAUDIO,
549 AV_CODEC_ID_MUSEPACK7,
551 AV_CODEC_ID_GSM_MS, /* as found in WAV */
557 AV_CODEC_ID_NELLYMOSER,
558 AV_CODEC_ID_MUSEPACK8,
560 AV_CODEC_ID_WMAVOICE,
562 AV_CODEC_ID_WMALOSSLESS,
571 AV_CODEC_ID_BINKAUDIO_RDFT,
572 AV_CODEC_ID_BINKAUDIO_DCT,
573 AV_CODEC_ID_AAC_LATM,
578 AV_CODEC_ID_8SVX_EXP,
579 AV_CODEC_ID_8SVX_FIB,
580 AV_CODEC_ID_BMV_AUDIO,
585 AV_CODEC_ID_COMFORT_NOISE,
587 AV_CODEC_ID_METASOUND,
588 AV_CODEC_ID_PAF_AUDIO,
592 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
594 AV_CODEC_ID_SONIC_LS,
597 AV_CODEC_ID_DSD_LSBF,
598 AV_CODEC_ID_DSD_MSBF,
599 AV_CODEC_ID_DSD_LSBF_PLANAR,
600 AV_CODEC_ID_DSD_MSBF_PLANAR,
602 AV_CODEC_ID_INTERPLAY_ACM,
607 /* subtitle codecs */
608 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
609 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
610 AV_CODEC_ID_DVB_SUBTITLE,
611 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
614 AV_CODEC_ID_MOV_TEXT,
615 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
616 AV_CODEC_ID_DVB_TELETEXT,
619 AV_CODEC_ID_MICRODVD = 0x17800,
623 AV_CODEC_ID_REALTEXT,
625 AV_CODEC_ID_SUBVIEWER1,
626 AV_CODEC_ID_SUBVIEWER,
633 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
635 /* other specific kind of codecs (generally used for attachments) */
636 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
637 AV_CODEC_ID_TTF = 0x18000,
639 AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
640 AV_CODEC_ID_BINTEXT = 0x18800,
644 AV_CODEC_ID_SMPTE_KLV,
646 AV_CODEC_ID_TIMED_ID3,
647 AV_CODEC_ID_BIN_DATA,
650 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
652 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
653 * stream (only used by libavformat) */
654 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
655 * stream (only used by libavformat) */
656 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
657 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
661 * This struct describes the properties of a single codec described by an
663 * @see avcodec_descriptor_get()
665 typedef struct AVCodecDescriptor {
667 enum AVMediaType type;
669 * Name of the codec described by this descriptor. It is non-empty and
670 * unique for each codec descriptor. It should contain alphanumeric
671 * characters and '_' only.
675 * A more descriptive name for this codec. May be NULL.
677 const char *long_name;
679 * Codec properties, a combination of AV_CODEC_PROP_* flags.
683 * MIME type(s) associated with the codec.
684 * May be NULL; if not, a NULL-terminated array of MIME types.
685 * The first item is always non-NULL and is the preferred MIME type.
687 const char *const *mime_types;
689 * If non-NULL, an array of profiles recognized for this codec.
690 * Terminated with FF_PROFILE_UNKNOWN.
692 const struct AVProfile *profiles;
696 * Codec uses only intra compression.
699 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
701 * Codec supports lossy compression. Audio and video codecs only.
702 * @note a codec may support both lossy and lossless
705 #define AV_CODEC_PROP_LOSSY (1 << 1)
707 * Codec supports lossless compression. Audio and video codecs only.
709 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
711 * Codec supports frame reordering. That is, the coded order (the order in which
712 * the encoded packets are output by the encoders / stored / input to the
713 * decoders) may be different from the presentation order of the corresponding
716 * For codecs that do not have this property set, PTS and DTS should always be
719 #define AV_CODEC_PROP_REORDER (1 << 3)
721 * Subtitle codec is bitmap based
722 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
724 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
726 * Subtitle codec is text based.
727 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
729 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
732 * @ingroup lavc_decoding
733 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
734 * This is mainly needed because some optimized bitstream readers read
735 * 32 or 64 bit at once and could read over the end.<br>
736 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
737 * MPEG bitstreams could cause overread and segfault.
739 #define AV_INPUT_BUFFER_PADDING_SIZE 32
742 * @ingroup lavc_encoding
743 * minimum encoding buffer size
744 * Used to avoid some checks during header writing.
746 #define AV_INPUT_BUFFER_MIN_SIZE 16384
748 #if FF_API_WITHOUT_PREFIX
750 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
752 #define FF_INPUT_BUFFER_PADDING_SIZE 32
755 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
757 #define FF_MIN_BUFFER_SIZE 16384
758 #endif /* FF_API_WITHOUT_PREFIX */
761 * @ingroup lavc_encoding
762 * motion estimation type.
763 * @deprecated use codec private option instead
765 #if FF_API_MOTION_EST
767 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
771 ME_EPZS, ///< enhanced predictive zonal search
772 ME_X1, ///< reserved for experiments
773 ME_HEX, ///< hexagon based search
774 ME_UMH, ///< uneven multi-hexagon search
775 ME_TESA, ///< transformed exhaustive search algorithm
776 ME_ITER=50, ///< iterative search
781 * @ingroup lavc_decoding
784 /* We leave some space between them for extensions (drop some
785 * keyframes for intra-only or drop just some bidir frames). */
786 AVDISCARD_NONE =-16, ///< discard nothing
787 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
788 AVDISCARD_NONREF = 8, ///< discard all non reference
789 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
790 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
791 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
792 AVDISCARD_ALL = 48, ///< discard all
795 enum AVAudioServiceType {
796 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
797 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
798 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
799 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
800 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
801 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
802 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
803 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
804 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
805 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
809 * @ingroup lavc_encoding
811 typedef struct RcOverride{
814 int qscale; // If this is 0 then quality_factor will be used instead.
815 float quality_factor;
818 #if FF_API_MAX_BFRAMES
820 * @deprecated there is no libavcodec-wide limit on the number of B-frames
822 #define FF_MAX_B_FRAMES 16
826 These flags can be passed in AVCodecContext.flags before initialization.
827 Note: Not everything is supported yet.
831 * Allow decoders to produce frames with data planes that are not aligned
832 * to CPU requirements (e.g. due to cropping).
834 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
838 #define AV_CODEC_FLAG_QSCALE (1 << 1)
840 * 4 MV per MB allowed / advanced prediction for H.263.
842 #define AV_CODEC_FLAG_4MV (1 << 2)
844 * Output even those frames that might be corrupted.
846 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
850 #define AV_CODEC_FLAG_QPEL (1 << 4)
852 * Use internal 2pass ratecontrol in first pass mode.
854 #define AV_CODEC_FLAG_PASS1 (1 << 9)
856 * Use internal 2pass ratecontrol in second pass mode.
858 #define AV_CODEC_FLAG_PASS2 (1 << 10)
862 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
864 * Only decode/encode grayscale.
866 #define AV_CODEC_FLAG_GRAY (1 << 13)
868 * error[?] variables will be set during encoding.
870 #define AV_CODEC_FLAG_PSNR (1 << 15)
872 * Input bitstream might be truncated at a random location
873 * instead of only at frame boundaries.
875 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
877 * Use interlaced DCT.
879 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
883 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
885 * Place global headers in extradata instead of every keyframe.
887 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
889 * Use only bitexact stuff (except (I)DCT).
891 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
892 /* Fx : Flag for H.263+ extra options */
894 * H.263 advanced intra coding / MPEG-4 AC prediction
896 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
898 * interlaced motion estimation
900 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
901 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
904 * Allow non spec compliant speedup tricks.
906 #define AV_CODEC_FLAG2_FAST (1 << 0)
908 * Skip bitstream encoding.
910 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
912 * Place global headers at every keyframe instead of in extradata.
914 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
917 * timecode is in drop frame format. DEPRECATED!!!!
919 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
922 * Input bitstream might be truncated at a packet boundaries
923 * instead of only at frame boundaries.
925 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
927 * Discard cropping information from SPS.
929 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
932 * Show all frames before the first keyframe
934 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
936 * Export motion vectors through frame side data
938 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
940 * Do not skip samples and export skip information as frame side data
942 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
944 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
946 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
948 /* Unsupported options :
949 * Syntax Arithmetic coding (SAC)
950 * Reference Picture Selection
951 * Independent Segment Decoding */
953 /* codec capabilities */
956 * Decoder can use draw_horiz_band callback.
958 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
960 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
961 * If not set, it might not use get_buffer() at all or use operations that
962 * assume the buffer was allocated by avcodec_default_get_buffer.
964 #define AV_CODEC_CAP_DR1 (1 << 1)
965 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
967 * Encoder or decoder requires flushing with NULL input at the end in order to
968 * give the complete and correct output.
970 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
971 * with NULL data. The user can still send NULL data to the public encode
972 * or decode function, but libavcodec will not pass it along to the codec
973 * unless this flag is set.
976 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
977 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
981 * The encoder needs to be fed with NULL data at the end of encoding until the
982 * encoder no longer returns data.
984 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
985 * flag also means that the encoder must set the pts and duration for
986 * each output packet. If this flag is not set, the pts and duration will
987 * be determined by libavcodec from the input frame.
989 #define AV_CODEC_CAP_DELAY (1 << 5)
991 * Codec can be fed a final frame with a smaller size.
992 * This can be used to prevent truncation of the last audio samples.
994 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
998 * Codec can export data for HW decoding (VDPAU).
1000 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
1004 * Codec can output multiple frames per AVPacket
1005 * Normally demuxers return one frame at a time, demuxers which do not do
1006 * are connected to a parser to split what they return into proper frames.
1007 * This flag is reserved to the very rare category of codecs which have a
1008 * bitstream that cannot be split into frames without timeconsuming
1009 * operations like full decoding. Demuxers carrying such bitstreams thus
1010 * may return multiple frames in a packet. This has many disadvantages like
1011 * prohibiting stream copy in many cases thus it should only be considered
1014 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
1016 * Codec is experimental and is thus avoided in favor of non experimental
1019 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
1021 * Codec should fill in channel configuration and samplerate instead of container
1023 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
1025 * Codec supports frame-level multithreading.
1027 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
1029 * Codec supports slice-based (or partition-based) multithreading.
1031 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
1033 * Codec supports changed parameters at any point.
1035 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
1037 * Codec supports avctx->thread_count == 0 (auto).
1039 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
1041 * Audio encoder supports receiving a different number of samples in each call.
1043 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1045 * Decoder is not a preferred choice for probing.
1046 * This indicates that the decoder is not a good choice for probing.
1047 * It could for example be an expensive to spin up hardware decoder,
1048 * or it could simply not provide a lot of useful information about
1050 * A decoder marked with this flag should only be used as last resort
1051 * choice for probing.
1053 #define AV_CODEC_CAP_AVOID_PROBING (1 << 17)
1055 * Codec is intra only.
1057 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
1059 * Codec is lossless.
1061 #define AV_CODEC_CAP_LOSSLESS 0x80000000
1064 #if FF_API_WITHOUT_PREFIX
1066 * Allow decoders to produce frames with data planes that are not aligned
1067 * to CPU requirements (e.g. due to cropping).
1069 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1070 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1071 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
1072 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1073 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
1076 * @deprecated use the "gmc" private option of the libxvid encoder
1078 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
1082 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1083 * mpegvideo encoders
1085 #define CODEC_FLAG_MV0 0x0040
1087 #if FF_API_INPUT_PRESERVED
1089 * @deprecated passing reference-counted frames to the encoders replaces this
1092 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1094 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
1095 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
1096 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
1099 * @deprecated edges are not used/required anymore. I.e. this flag is now always
1102 #define CODEC_FLAG_EMU_EDGE 0x4000
1104 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
1105 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
1107 #if FF_API_NORMALIZE_AQP
1109 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1110 * mpegvideo encoders
1112 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
1114 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1115 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1116 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1117 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1118 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1119 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1120 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1121 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1122 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1123 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1124 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1125 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1126 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1128 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1129 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1130 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1131 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1133 /* Unsupported options :
1134 * Syntax Arithmetic coding (SAC)
1135 * Reference Picture Selection
1136 * Independent Segment Decoding */
1138 /* codec capabilities */
1140 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1142 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1143 * If not set, it might not use get_buffer() at all or use operations that
1144 * assume the buffer was allocated by avcodec_default_get_buffer.
1146 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1147 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1149 /* Codec can export data for HW decoding. This flag indicates that
1150 * the codec would call get_format() with list that might contain HW accelerated
1151 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1152 * including raw image format.
1153 * The application can use the passed context to determine bitstream version,
1154 * chroma format, resolution etc.
1156 #define CODEC_CAP_HWACCEL 0x0010
1157 #endif /* FF_API_XVMC */
1159 * Encoder or decoder requires flushing with NULL input at the end in order to
1160 * give the complete and correct output.
1162 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1163 * with NULL data. The user can still send NULL data to the public encode
1164 * or decode function, but libavcodec will not pass it along to the codec
1165 * unless this flag is set.
1168 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1169 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1173 * The encoder needs to be fed with NULL data at the end of encoding until the
1174 * encoder no longer returns data.
1176 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1177 * flag also means that the encoder must set the pts and duration for
1178 * each output packet. If this flag is not set, the pts and duration will
1179 * be determined by libavcodec from the input frame.
1181 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1183 * Codec can be fed a final frame with a smaller size.
1184 * This can be used to prevent truncation of the last audio samples.
1186 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1187 #if FF_API_CAP_VDPAU
1189 * Codec can export data for HW decoding (VDPAU).
1191 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1194 * Codec can output multiple frames per AVPacket
1195 * Normally demuxers return one frame at a time, demuxers which do not do
1196 * are connected to a parser to split what they return into proper frames.
1197 * This flag is reserved to the very rare category of codecs which have a
1198 * bitstream that cannot be split into frames without timeconsuming
1199 * operations like full decoding. Demuxers carrying such bitstreams thus
1200 * may return multiple frames in a packet. This has many disadvantages like
1201 * prohibiting stream copy in many cases thus it should only be considered
1204 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1206 * Codec is experimental and is thus avoided in favor of non experimental
1209 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1211 * Codec should fill in channel configuration and samplerate instead of container
1213 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1214 #if FF_API_NEG_LINESIZES
1216 * @deprecated no codecs use this capability
1218 #define CODEC_CAP_NEG_LINESIZES 0x0800
1221 * Codec supports frame-level multithreading.
1223 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1225 * Codec supports slice-based (or partition-based) multithreading.
1227 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1229 * Codec supports changed parameters at any point.
1231 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1233 * Codec supports avctx->thread_count == 0 (auto).
1235 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1237 * Audio encoder supports receiving a different number of samples in each call.
1239 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1241 * Codec is intra only.
1243 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1245 * Codec is lossless.
1247 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1250 * HWAccel is experimental and is thus avoided in favor of non experimental
1253 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1254 #endif /* FF_API_WITHOUT_PREFIX */
1257 //The following defines may change, don't expect compatibility if you use them.
1258 #define MB_TYPE_INTRA4x4 0x0001
1259 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1260 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1261 #define MB_TYPE_16x16 0x0008
1262 #define MB_TYPE_16x8 0x0010
1263 #define MB_TYPE_8x16 0x0020
1264 #define MB_TYPE_8x8 0x0040
1265 #define MB_TYPE_INTERLACED 0x0080
1266 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1267 #define MB_TYPE_ACPRED 0x0200
1268 #define MB_TYPE_GMC 0x0400
1269 #define MB_TYPE_SKIP 0x0800
1270 #define MB_TYPE_P0L0 0x1000
1271 #define MB_TYPE_P1L0 0x2000
1272 #define MB_TYPE_P0L1 0x4000
1273 #define MB_TYPE_P1L1 0x8000
1274 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1275 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1276 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1277 #define MB_TYPE_QUANT 0x00010000
1278 #define MB_TYPE_CBP 0x00020000
1279 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1284 * This specifies the area which should be displayed.
1285 * Note there may be multiple such areas for one frame.
1287 typedef struct AVPanScan{
1290 * - encoding: Set by user.
1291 * - decoding: Set by libavcodec.
1296 * width and height in 1/16 pel
1297 * - encoding: Set by user.
1298 * - decoding: Set by libavcodec.
1304 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1305 * - encoding: Set by user.
1306 * - decoding: Set by libavcodec.
1308 int16_t position[3][2];
1312 * This structure describes the bitrate properties of an encoded bitstream. It
1313 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1314 * parameters for H.264/HEVC.
1316 typedef struct AVCPBProperties {
1318 * Maximum bitrate of the stream, in bits per second.
1319 * Zero if unknown or unspecified.
1323 * Minimum bitrate of the stream, in bits per second.
1324 * Zero if unknown or unspecified.
1328 * Average bitrate of the stream, in bits per second.
1329 * Zero if unknown or unspecified.
1334 * The size of the buffer to which the ratecontrol is applied, in bits.
1335 * Zero if unknown or unspecified.
1340 * The delay between the time the packet this structure is associated with
1341 * is received and the time when it should be decoded, in periods of a 27MHz
1344 * UINT64_MAX when unknown or unspecified.
1349 #if FF_API_QSCALE_TYPE
1350 #define FF_QSCALE_TYPE_MPEG1 0
1351 #define FF_QSCALE_TYPE_MPEG2 1
1352 #define FF_QSCALE_TYPE_H264 2
1353 #define FF_QSCALE_TYPE_VP56 3
1357 * The decoder will keep a reference to the frame and may reuse it later.
1359 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1362 * @defgroup lavc_packet AVPacket
1364 * Types and functions for working with AVPacket.
1367 enum AVPacketSideDataType {
1368 AV_PKT_DATA_PALETTE,
1371 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1372 * that the extradata buffer was changed and the receiving side should
1373 * act upon it appropriately. The new extradata is embedded in the side
1374 * data buffer and should be immediately used for processing the current
1377 AV_PKT_DATA_NEW_EXTRADATA,
1380 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1383 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1384 * s32le channel_count
1385 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1386 * u64le channel_layout
1387 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1389 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1394 AV_PKT_DATA_PARAM_CHANGE,
1397 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1398 * structures with info about macroblocks relevant to splitting the
1399 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1400 * That is, it does not necessarily contain info about all macroblocks,
1401 * as long as the distance between macroblocks in the info is smaller
1402 * than the target payload size.
1403 * Each MB info structure is 12 bytes, and is laid out as follows:
1405 * u32le bit offset from the start of the packet
1406 * u8 current quantizer at the start of the macroblock
1408 * u16le macroblock address within the GOB
1409 * u8 horizontal MV predictor
1410 * u8 vertical MV predictor
1411 * u8 horizontal MV predictor for block number 3
1412 * u8 vertical MV predictor for block number 3
1415 AV_PKT_DATA_H263_MB_INFO,
1418 * This side data should be associated with an audio stream and contains
1419 * ReplayGain information in form of the AVReplayGain struct.
1421 AV_PKT_DATA_REPLAYGAIN,
1424 * This side data contains a 3x3 transformation matrix describing an affine
1425 * transformation that needs to be applied to the decoded video frames for
1426 * correct presentation.
1428 * See libavutil/display.h for a detailed description of the data.
1430 AV_PKT_DATA_DISPLAYMATRIX,
1433 * This side data should be associated with a video stream and contains
1434 * Stereoscopic 3D information in form of the AVStereo3D struct.
1436 AV_PKT_DATA_STEREO3D,
1439 * This side data should be associated with an audio stream and corresponds
1440 * to enum AVAudioServiceType.
1442 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1445 * This side data contains quality related information from the encoder.
1447 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1451 * u64le[error count] sum of squared differences between encoder in and output
1454 AV_PKT_DATA_QUALITY_STATS,
1457 * This side data contains an integer value representing the stream index
1458 * of a "fallback" track. A fallback track indicates an alternate
1459 * track to use when the current track can not be decoded for some reason.
1460 * e.g. no decoder available for codec.
1462 AV_PKT_DATA_FALLBACK_TRACK,
1465 * This side data corresponds to the AVCPBProperties struct.
1467 AV_PKT_DATA_CPB_PROPERTIES,
1470 * Recommmends skipping the specified number of samples
1472 * u32le number of samples to skip from start of this packet
1473 * u32le number of samples to skip from end of this packet
1474 * u8 reason for start skip
1475 * u8 reason for end skip (0=padding silence, 1=convergence)
1478 AV_PKT_DATA_SKIP_SAMPLES=70,
1481 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1482 * the packet may contain "dual mono" audio specific to Japanese DTV
1483 * and if it is true, recommends only the selected channel to be used.
1485 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1488 AV_PKT_DATA_JP_DUALMONO,
1491 * A list of zero terminated key/value strings. There is no end marker for
1492 * the list, so it is required to rely on the side data size to stop.
1494 AV_PKT_DATA_STRINGS_METADATA,
1497 * Subtitle event position
1505 AV_PKT_DATA_SUBTITLE_POSITION,
1508 * Data found in BlockAdditional element of matroska container. There is
1509 * no end marker for the data, so it is required to rely on the side data
1510 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1513 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1516 * The optional first identifier line of a WebVTT cue.
1518 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1521 * The optional settings (rendering instructions) that immediately
1522 * follow the timestamp specifier of a WebVTT cue.
1524 AV_PKT_DATA_WEBVTT_SETTINGS,
1527 * A list of zero terminated key/value strings. There is no end marker for
1528 * the list, so it is required to rely on the side data size to stop. This
1529 * side data includes updated metadata which appeared in the stream.
1531 AV_PKT_DATA_METADATA_UPDATE,
1534 * MPEGTS stream ID, this is required to pass the stream ID
1535 * information from the demuxer to the corresponding muxer.
1537 AV_PKT_DATA_MPEGTS_STREAM_ID,
1540 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1541 * should be associated with a video stream and containts data in the form
1542 * of the AVMasteringDisplayMetadata struct.
1544 AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1547 * This side data should be associated with a video stream and corresponds
1548 * to the AVSphericalMapping structure.
1550 AV_PKT_DATA_SPHERICAL,
1553 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1555 typedef struct AVPacketSideData {
1558 enum AVPacketSideDataType type;
1562 * This structure stores compressed data. It is typically exported by demuxers
1563 * and then passed as input to decoders, or received as output from encoders and
1564 * then passed to muxers.
1566 * For video, it should typically contain one compressed frame. For audio it may
1567 * contain several compressed frames. Encoders are allowed to output empty
1568 * packets, with no compressed data, containing only side data
1569 * (e.g. to update some stream parameters at the end of encoding).
1571 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1572 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1573 * without libavcodec and libavformat major bump.
1575 * The semantics of data ownership depends on the buf field.
1576 * If it is set, the packet data is dynamically allocated and is
1577 * valid indefinitely until a call to av_packet_unref() reduces the
1578 * reference count to 0.
1580 * If the buf field is not set av_packet_ref() would make a copy instead
1581 * of increasing the reference count.
1583 * The side data is always allocated with av_malloc(), copied by
1584 * av_packet_ref() and freed by av_packet_unref().
1586 * @see av_packet_ref
1587 * @see av_packet_unref
1589 typedef struct AVPacket {
1591 * A reference to the reference-counted buffer where the packet data is
1593 * May be NULL, then the packet data is not reference-counted.
1597 * Presentation timestamp in AVStream->time_base units; the time at which
1598 * the decompressed packet will be presented to the user.
1599 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1600 * pts MUST be larger or equal to dts as presentation cannot happen before
1601 * decompression, unless one wants to view hex dumps. Some formats misuse
1602 * the terms dts and pts/cts to mean something different. Such timestamps
1603 * must be converted to true pts/dts before they are stored in AVPacket.
1607 * Decompression timestamp in AVStream->time_base units; the time at which
1608 * the packet is decompressed.
1609 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1616 * A combination of AV_PKT_FLAG values
1620 * Additional packet data that can be provided by the container.
1621 * Packet can contain several types of side information.
1623 AVPacketSideData *side_data;
1624 int side_data_elems;
1627 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1628 * Equals next_pts - this_pts in presentation order.
1632 int64_t pos; ///< byte position in stream, -1 if unknown
1634 #if FF_API_CONVERGENCE_DURATION
1636 * @deprecated Same as the duration field, but as int64_t. This was required
1637 * for Matroska subtitles, whose duration values could overflow when the
1638 * duration field was still an int.
1640 attribute_deprecated
1641 int64_t convergence_duration;
1644 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1645 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1647 * Flag is used to discard packets which are required to maintain valid
1648 * decoder state but are not required for output and should be dropped
1651 #define AV_PKT_FLAG_DISCARD 0x0004
1653 enum AVSideDataParamChangeFlags {
1654 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1655 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1656 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1657 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1663 struct AVCodecInternal;
1667 AV_FIELD_PROGRESSIVE,
1668 AV_FIELD_TT, //< Top coded_first, top displayed first
1669 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1670 AV_FIELD_TB, //< Top coded first, bottom displayed first
1671 AV_FIELD_BT, //< Bottom coded first, top displayed first
1675 * main external API structure.
1676 * New fields can be added to the end with minor version bumps.
1677 * Removal, reordering and changes to existing fields require a major
1679 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1681 * The name string for AVOptions options matches the associated command line
1682 * parameter name and can be found in libavcodec/options_table.h
1683 * The AVOption/command line parameter names differ in some cases from the C
1684 * structure field names for historic reasons or brevity.
1685 * sizeof(AVCodecContext) must not be used outside libav*.
1687 typedef struct AVCodecContext {
1689 * information on struct for av_log
1690 * - set by avcodec_alloc_context3
1692 const AVClass *av_class;
1693 int log_level_offset;
1695 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1696 const struct AVCodec *codec;
1697 #if FF_API_CODEC_NAME
1699 * @deprecated this field is not used for anything in libavcodec
1701 attribute_deprecated
1702 char codec_name[32];
1704 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1707 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1708 * This is used to work around some encoder bugs.
1709 * A demuxer should set this to what is stored in the field used to identify the codec.
1710 * If there are multiple such fields in a container then the demuxer should choose the one
1711 * which maximizes the information about the used codec.
1712 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1713 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1714 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1716 * - encoding: Set by user, if not then the default based on codec_id will be used.
1717 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1719 unsigned int codec_tag;
1721 #if FF_API_STREAM_CODEC_TAG
1723 * @deprecated this field is unused
1725 attribute_deprecated
1726 unsigned int stream_codec_tag;
1732 * Private context used for internal data.
1734 * Unlike priv_data, this is not codec-specific. It is used in general
1735 * libavcodec functions.
1737 struct AVCodecInternal *internal;
1740 * Private data of the user, can be used to carry app specific stuff.
1741 * - encoding: Set by user.
1742 * - decoding: Set by user.
1747 * the average bitrate
1748 * - encoding: Set by user; unused for constant quantizer encoding.
1749 * - decoding: Set by user, may be overwritten by libavcodec
1750 * if this info is available in the stream
1755 * number of bits the bitstream is allowed to diverge from the reference.
1756 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1757 * - encoding: Set by user; unused for constant quantizer encoding.
1758 * - decoding: unused
1760 int bit_rate_tolerance;
1763 * Global quality for codecs which cannot change it per frame.
1764 * This should be proportional to MPEG-1/2/4 qscale.
1765 * - encoding: Set by user.
1766 * - decoding: unused
1771 * - encoding: Set by user.
1772 * - decoding: unused
1774 int compression_level;
1775 #define FF_COMPRESSION_DEFAULT -1
1779 * - encoding: Set by user.
1780 * - decoding: Set by user.
1786 * - encoding: Set by user.
1787 * - decoding: Set by user.
1792 * some codecs need / can use extradata like Huffman tables.
1793 * MJPEG: Huffman tables
1794 * rv10: additional flags
1795 * MPEG-4: global headers (they can be in the bitstream or here)
1796 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1797 * than extradata_size to avoid problems if it is read with the bitstream reader.
1798 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1799 * - encoding: Set/allocated/freed by libavcodec.
1800 * - decoding: Set/allocated/freed by user.
1806 * This is the fundamental unit of time (in seconds) in terms
1807 * of which frame timestamps are represented. For fixed-fps content,
1808 * timebase should be 1/framerate and timestamp increments should be
1810 * This often, but not always is the inverse of the frame rate or field rate
1811 * for video. 1/time_base is not the average frame rate if the frame rate is not
1814 * Like containers, elementary streams also can store timestamps, 1/time_base
1815 * is the unit in which these timestamps are specified.
1816 * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1817 * vop_time_increment_resolution and fixed_vop_rate
1818 * (fixed_vop_rate == 0 implies that it is different from the framerate)
1820 * - encoding: MUST be set by user.
1821 * - decoding: the use of this field for decoding is deprecated.
1822 * Use framerate instead.
1824 AVRational time_base;
1827 * For some codecs, the time base is closer to the field rate than the frame rate.
1828 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1829 * if no telecine is used ...
1831 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1833 int ticks_per_frame;
1838 * Encoding: Number of frames delay there will be from the encoder input to
1839 * the decoder output. (we assume the decoder matches the spec)
1840 * Decoding: Number of frames delay in addition to what a standard decoder
1841 * as specified in the spec would produce.
1844 * Number of frames the decoded output will be delayed relative to the
1848 * For encoding, this field is unused (see initial_padding).
1850 * For decoding, this is the number of samples the decoder needs to
1851 * output before the decoder's output is valid. When seeking, you should
1852 * start decoding this many samples prior to your desired seek point.
1854 * - encoding: Set by libavcodec.
1855 * - decoding: Set by libavcodec.
1862 * picture width / height.
1864 * @note Those fields may not match the values of the last
1865 * AVFrame output by avcodec_decode_video2 due frame
1868 * - encoding: MUST be set by user.
1869 * - decoding: May be set by the user before opening the decoder if known e.g.
1870 * from the container. Some decoders will require the dimensions
1871 * to be set by the caller. During decoding, the decoder may
1872 * overwrite those values as required while parsing the data.
1877 * Bitstream width / height, may be different from width/height e.g. when
1878 * the decoded frame is cropped before being output or lowres is enabled.
1880 * @note Those field may not match the value of the last
1881 * AVFrame output by avcodec_receive_frame() due frame
1884 * - encoding: unused
1885 * - decoding: May be set by the user before opening the decoder if known
1886 * e.g. from the container. During decoding, the decoder may
1887 * overwrite those values as required while parsing the data.
1889 int coded_width, coded_height;
1891 #if FF_API_ASPECT_EXTENDED
1892 #define FF_ASPECT_EXTENDED 15
1896 * the number of pictures in a group of pictures, or 0 for intra_only
1897 * - encoding: Set by user.
1898 * - decoding: unused
1903 * Pixel format, see AV_PIX_FMT_xxx.
1904 * May be set by the demuxer if known from headers.
1905 * May be overridden by the decoder if it knows better.
1907 * @note This field may not match the value of the last
1908 * AVFrame output by avcodec_receive_frame() due frame
1911 * - encoding: Set by user.
1912 * - decoding: Set by user if known, overridden by libavcodec while
1915 enum AVPixelFormat pix_fmt;
1917 #if FF_API_MOTION_EST
1919 * This option does nothing
1920 * @deprecated use codec private options instead
1922 attribute_deprecated int me_method;
1926 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1927 * decoder to draw a horizontal band. It improves cache usage. Not
1928 * all codecs can do that. You must check the codec capabilities
1930 * When multithreading is used, it may be called from multiple threads
1931 * at the same time; threads might draw different parts of the same AVFrame,
1932 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1934 * The function is also used by hardware acceleration APIs.
1935 * It is called at least once during frame decoding to pass
1936 * the data needed for hardware render.
1937 * In that mode instead of pixel data, AVFrame points to
1938 * a structure specific to the acceleration API. The application
1939 * reads the structure and can change some fields to indicate progress
1941 * - encoding: unused
1942 * - decoding: Set by user.
1943 * @param height the height of the slice
1944 * @param y the y position of the slice
1945 * @param type 1->top field, 2->bottom field, 3->frame
1946 * @param offset offset into the AVFrame.data from which the slice should be read
1948 void (*draw_horiz_band)(struct AVCodecContext *s,
1949 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1950 int y, int type, int height);
1953 * callback to negotiate the pixelFormat
1954 * @param fmt is the list of formats which are supported by the codec,
1955 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1956 * The first is always the native one.
1957 * @note The callback may be called again immediately if initialization for
1958 * the selected (hardware-accelerated) pixel format failed.
1959 * @warning Behavior is undefined if the callback returns a value not
1960 * in the fmt list of formats.
1961 * @return the chosen format
1962 * - encoding: unused
1963 * - decoding: Set by user, if not set the native format will be chosen.
1965 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1968 * maximum number of B-frames between non-B-frames
1969 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1970 * - encoding: Set by user.
1971 * - decoding: unused
1976 * qscale factor between IP and B-frames
1977 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1978 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1979 * - encoding: Set by user.
1980 * - decoding: unused
1982 float b_quant_factor;
1984 #if FF_API_RC_STRATEGY
1985 /** @deprecated use codec private option instead */
1986 attribute_deprecated int rc_strategy;
1987 #define FF_RC_STRATEGY_XVID 1
1990 #if FF_API_PRIVATE_OPT
1991 /** @deprecated use encoder private options instead */
1992 attribute_deprecated
1993 int b_frame_strategy;
1997 * qscale offset between IP and B-frames
1998 * - encoding: Set by user.
1999 * - decoding: unused
2001 float b_quant_offset;
2004 * Size of the frame reordering buffer in the decoder.
2005 * For MPEG-2 it is 1 IPB or 0 low delay IP.
2006 * - encoding: Set by libavcodec.
2007 * - decoding: Set by libavcodec.
2011 #if FF_API_PRIVATE_OPT
2012 /** @deprecated use encoder private options instead */
2013 attribute_deprecated
2018 * qscale factor between P- and I-frames
2019 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2020 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2021 * - encoding: Set by user.
2022 * - decoding: unused
2024 float i_quant_factor;
2027 * qscale offset between P and I-frames
2028 * - encoding: Set by user.
2029 * - decoding: unused
2031 float i_quant_offset;
2034 * luminance masking (0-> disabled)
2035 * - encoding: Set by user.
2036 * - decoding: unused
2041 * temporary complexity masking (0-> disabled)
2042 * - encoding: Set by user.
2043 * - decoding: unused
2045 float temporal_cplx_masking;
2048 * spatial complexity masking (0-> disabled)
2049 * - encoding: Set by user.
2050 * - decoding: unused
2052 float spatial_cplx_masking;
2055 * p block masking (0-> disabled)
2056 * - encoding: Set by user.
2057 * - decoding: unused
2062 * darkness masking (0-> disabled)
2063 * - encoding: Set by user.
2064 * - decoding: unused
2070 * - encoding: Set by libavcodec.
2071 * - decoding: Set by user (or 0).
2075 #if FF_API_PRIVATE_OPT
2076 /** @deprecated use encoder private options instead */
2077 attribute_deprecated
2078 int prediction_method;
2079 #define FF_PRED_LEFT 0
2080 #define FF_PRED_PLANE 1
2081 #define FF_PRED_MEDIAN 2
2085 * slice offsets in the frame in bytes
2086 * - encoding: Set/allocated by libavcodec.
2087 * - decoding: Set/allocated by user (or NULL).
2092 * sample aspect ratio (0 if unknown)
2093 * That is the width of a pixel divided by the height of the pixel.
2094 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2095 * - encoding: Set by user.
2096 * - decoding: Set by libavcodec.
2098 AVRational sample_aspect_ratio;
2101 * motion estimation comparison function
2102 * - encoding: Set by user.
2103 * - decoding: unused
2107 * subpixel motion estimation comparison function
2108 * - encoding: Set by user.
2109 * - decoding: unused
2113 * macroblock comparison function (not supported yet)
2114 * - encoding: Set by user.
2115 * - decoding: unused
2119 * interlaced DCT comparison function
2120 * - encoding: Set by user.
2121 * - decoding: unused
2124 #define FF_CMP_SAD 0
2125 #define FF_CMP_SSE 1
2126 #define FF_CMP_SATD 2
2127 #define FF_CMP_DCT 3
2128 #define FF_CMP_PSNR 4
2129 #define FF_CMP_BIT 5
2131 #define FF_CMP_ZERO 7
2132 #define FF_CMP_VSAD 8
2133 #define FF_CMP_VSSE 9
2134 #define FF_CMP_NSSE 10
2135 #define FF_CMP_W53 11
2136 #define FF_CMP_W97 12
2137 #define FF_CMP_DCTMAX 13
2138 #define FF_CMP_DCT264 14
2139 #define FF_CMP_MEDIAN_SAD 15
2140 #define FF_CMP_CHROMA 256
2143 * ME diamond size & shape
2144 * - encoding: Set by user.
2145 * - decoding: unused
2150 * amount of previous MV predictors (2a+1 x 2a+1 square)
2151 * - encoding: Set by user.
2152 * - decoding: unused
2154 int last_predictor_count;
2156 #if FF_API_PRIVATE_OPT
2157 /** @deprecated use encoder private options instead */
2158 attribute_deprecated
2163 * motion estimation prepass comparison function
2164 * - encoding: Set by user.
2165 * - decoding: unused
2170 * ME prepass diamond size & shape
2171 * - encoding: Set by user.
2172 * - decoding: unused
2178 * - encoding: Set by user.
2179 * - decoding: unused
2181 int me_subpel_quality;
2185 * DTG active format information (additional aspect ratio
2186 * information only used in DVB MPEG-2 transport streams)
2189 * - encoding: unused
2190 * - decoding: Set by decoder.
2191 * @deprecated Deprecated in favor of AVSideData
2193 attribute_deprecated int dtg_active_format;
2194 #define FF_DTG_AFD_SAME 8
2195 #define FF_DTG_AFD_4_3 9
2196 #define FF_DTG_AFD_16_9 10
2197 #define FF_DTG_AFD_14_9 11
2198 #define FF_DTG_AFD_4_3_SP_14_9 13
2199 #define FF_DTG_AFD_16_9_SP_14_9 14
2200 #define FF_DTG_AFD_SP_4_3 15
2201 #endif /* FF_API_AFD */
2204 * maximum motion estimation search range in subpel units
2205 * If 0 then no limit.
2207 * - encoding: Set by user.
2208 * - decoding: unused
2212 #if FF_API_QUANT_BIAS
2214 * @deprecated use encoder private option instead
2216 attribute_deprecated int intra_quant_bias;
2217 #define FF_DEFAULT_QUANT_BIAS 999999
2220 * @deprecated use encoder private option instead
2222 attribute_deprecated int inter_quant_bias;
2227 * - encoding: unused
2228 * - decoding: Set by user.
2231 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2232 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2233 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2237 * XVideo Motion Acceleration
2238 * - encoding: forbidden
2239 * - decoding: set by decoder
2240 * @deprecated XvMC doesn't need it anymore.
2242 attribute_deprecated int xvmc_acceleration;
2243 #endif /* FF_API_XVMC */
2246 * macroblock decision mode
2247 * - encoding: Set by user.
2248 * - decoding: unused
2251 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2252 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2253 #define FF_MB_DECISION_RD 2 ///< rate distortion
2256 * custom intra quantization matrix
2257 * - encoding: Set by user, can be NULL.
2258 * - decoding: Set by libavcodec.
2260 uint16_t *intra_matrix;
2263 * custom inter quantization matrix
2264 * - encoding: Set by user, can be NULL.
2265 * - decoding: Set by libavcodec.
2267 uint16_t *inter_matrix;
2269 #if FF_API_PRIVATE_OPT
2270 /** @deprecated use encoder private options instead */
2271 attribute_deprecated
2272 int scenechange_threshold;
2274 /** @deprecated use encoder private options instead */
2275 attribute_deprecated
2276 int noise_reduction;
2281 * @deprecated this field is unused
2283 attribute_deprecated
2287 * @deprecated this field is unused
2289 attribute_deprecated
2294 * precision of the intra DC coefficient - 8
2295 * - encoding: Set by user.
2296 * - decoding: Set by libavcodec
2298 int intra_dc_precision;
2301 * Number of macroblock rows at the top which are skipped.
2302 * - encoding: unused
2303 * - decoding: Set by user.
2308 * Number of macroblock rows at the bottom which are skipped.
2309 * - encoding: unused
2310 * - decoding: Set by user.
2316 * @deprecated use encoder private options instead
2318 attribute_deprecated
2319 float border_masking;
2323 * minimum MB Lagrange multiplier
2324 * - encoding: Set by user.
2325 * - decoding: unused
2330 * maximum MB Lagrange multiplier
2331 * - encoding: Set by user.
2332 * - decoding: unused
2336 #if FF_API_PRIVATE_OPT
2338 * @deprecated use encoder private options instead
2340 attribute_deprecated
2341 int me_penalty_compensation;
2345 * - encoding: Set by user.
2346 * - decoding: unused
2350 #if FF_API_PRIVATE_OPT
2351 /** @deprecated use encoder private options instead */
2352 attribute_deprecated
2358 * - encoding: Set by user.
2359 * - decoding: unused
2364 * number of reference frames
2365 * - encoding: Set by user.
2366 * - decoding: Set by lavc.
2370 #if FF_API_PRIVATE_OPT
2371 /** @deprecated use encoder private options instead */
2372 attribute_deprecated
2376 #if FF_API_UNUSED_MEMBERS
2378 * Multiplied by qscale for each frame and added to scene_change_score.
2379 * - encoding: Set by user.
2380 * - decoding: unused
2382 attribute_deprecated int scenechange_factor;
2386 * Note: Value depends upon the compare function used for fullpel ME.
2387 * - encoding: Set by user.
2388 * - decoding: unused
2392 #if FF_API_PRIVATE_OPT
2393 /** @deprecated use encoder private options instead */
2394 attribute_deprecated
2399 * Chromaticity coordinates of the source primaries.
2400 * - encoding: Set by user
2401 * - decoding: Set by libavcodec
2403 enum AVColorPrimaries color_primaries;
2406 * Color Transfer Characteristic.
2407 * - encoding: Set by user
2408 * - decoding: Set by libavcodec
2410 enum AVColorTransferCharacteristic color_trc;
2413 * YUV colorspace type.
2414 * - encoding: Set by user
2415 * - decoding: Set by libavcodec
2417 enum AVColorSpace colorspace;
2420 * MPEG vs JPEG YUV range.
2421 * - encoding: Set by user
2422 * - decoding: Set by libavcodec
2424 enum AVColorRange color_range;
2427 * This defines the location of chroma samples.
2428 * - encoding: Set by user
2429 * - decoding: Set by libavcodec
2431 enum AVChromaLocation chroma_sample_location;
2435 * Indicates number of picture subdivisions. Used for parallelized
2437 * - encoding: Set by user
2438 * - decoding: unused
2443 * - encoding: set by libavcodec
2444 * - decoding: Set by user.
2446 enum AVFieldOrder field_order;
2449 int sample_rate; ///< samples per second
2450 int channels; ///< number of audio channels
2453 * audio sample format
2454 * - encoding: Set by user.
2455 * - decoding: Set by libavcodec.
2457 enum AVSampleFormat sample_fmt; ///< sample format
2459 /* The following data should not be initialized. */
2461 * Number of samples per channel in an audio frame.
2463 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2464 * except the last must contain exactly frame_size samples per channel.
2465 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2466 * frame size is not restricted.
2467 * - decoding: may be set by some decoders to indicate constant frame size
2472 * Frame counter, set by libavcodec.
2474 * - decoding: total number of frames returned from the decoder so far.
2475 * - encoding: total number of frames passed to the encoder so far.
2477 * @note the counter is not incremented if encoding/decoding resulted in
2483 * number of bytes per packet if constant and known or 0
2484 * Used by some WAV based audio codecs.
2489 * Audio cutoff bandwidth (0 means "automatic")
2490 * - encoding: Set by user.
2491 * - decoding: unused
2496 * Audio channel layout.
2497 * - encoding: set by user.
2498 * - decoding: set by user, may be overwritten by libavcodec.
2500 uint64_t channel_layout;
2503 * Request decoder to use this channel layout if it can (0 for default)
2504 * - encoding: unused
2505 * - decoding: Set by user.
2507 uint64_t request_channel_layout;
2510 * Type of service that the audio stream conveys.
2511 * - encoding: Set by user.
2512 * - decoding: Set by libavcodec.
2514 enum AVAudioServiceType audio_service_type;
2517 * desired sample format
2518 * - encoding: Not used.
2519 * - decoding: Set by user.
2520 * Decoder will decode to this format if it can.
2522 enum AVSampleFormat request_sample_fmt;
2525 * This callback is called at the beginning of each frame to get data
2526 * buffer(s) for it. There may be one contiguous buffer for all the data or
2527 * there may be a buffer per each data plane or anything in between. What
2528 * this means is, you may set however many entries in buf[] you feel necessary.
2529 * Each buffer must be reference-counted using the AVBuffer API (see description
2532 * The following fields will be set in the frame before this callback is
2535 * - width, height (video only)
2536 * - sample_rate, channel_layout, nb_samples (audio only)
2537 * Their values may differ from the corresponding values in
2538 * AVCodecContext. This callback must use the frame values, not the codec
2539 * context values, to calculate the required buffer size.
2541 * This callback must fill the following fields in the frame:
2545 * * if the data is planar audio with more than 8 channels, then this
2546 * callback must allocate and fill extended_data to contain all pointers
2547 * to all data planes. data[] must hold as many pointers as it can.
2548 * extended_data must be allocated with av_malloc() and will be freed in
2550 * * otherwise extended_data must point to data
2551 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2552 * the frame's data and extended_data pointers must be contained in these. That
2553 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2554 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2555 * and av_buffer_ref().
2556 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2557 * this callback and filled with the extra buffers if there are more
2558 * buffers than buf[] can hold. extended_buf will be freed in
2561 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2562 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2565 * Each data plane must be aligned to the maximum required by the target
2568 * @see avcodec_default_get_buffer2()
2572 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2573 * (read and/or written to if it is writable) later by libavcodec.
2575 * avcodec_align_dimensions2() should be used to find the required width and
2576 * height, as they normally need to be rounded up to the next multiple of 16.
2578 * Some decoders do not support linesizes changing between frames.
2580 * If frame multithreading is used and thread_safe_callbacks is set,
2581 * this callback may be called from a different thread, but not from more
2582 * than one at once. Does not need to be reentrant.
2584 * @see avcodec_align_dimensions2()
2588 * Decoders request a buffer of a particular size by setting
2589 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2590 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2591 * to a smaller value in the output frame.
2593 * As a convenience, av_samples_get_buffer_size() and
2594 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2595 * functions to find the required data size and to fill data pointers and
2596 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2597 * since all planes must be the same size.
2599 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2601 * - encoding: unused
2602 * - decoding: Set by libavcodec, user can override.
2604 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2607 * If non-zero, the decoded audio and video frames returned from
2608 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2609 * and are valid indefinitely. The caller must free them with
2610 * av_frame_unref() when they are not needed anymore.
2611 * Otherwise, the decoded frames must not be freed by the caller and are
2612 * only valid until the next decode call.
2614 * This is always automatically enabled if avcodec_receive_frame() is used.
2616 * - encoding: unused
2617 * - decoding: set by the caller before avcodec_open2().
2619 int refcounted_frames;
2621 /* - encoding parameters */
2622 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2623 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2627 * - encoding: Set by user.
2628 * - decoding: unused
2634 * - encoding: Set by user.
2635 * - decoding: unused
2640 * maximum quantizer difference between frames
2641 * - encoding: Set by user.
2642 * - decoding: unused
2648 * @deprecated use encoder private options instead
2650 attribute_deprecated
2653 attribute_deprecated
2655 attribute_deprecated
2660 * decoder bitstream buffer size
2661 * - encoding: Set by user.
2662 * - decoding: unused
2667 * ratecontrol override, see RcOverride
2668 * - encoding: Allocated/set/freed by user.
2669 * - decoding: unused
2671 int rc_override_count;
2672 RcOverride *rc_override;
2676 * @deprecated use encoder private options instead
2678 attribute_deprecated
2684 * - encoding: Set by user.
2685 * - decoding: Set by user, may be overwritten by libavcodec.
2687 int64_t rc_max_rate;
2691 * - encoding: Set by user.
2692 * - decoding: unused
2694 int64_t rc_min_rate;
2698 * @deprecated use encoder private options instead
2700 attribute_deprecated
2701 float rc_buffer_aggressivity;
2703 attribute_deprecated
2704 float rc_initial_cplx;
2708 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2709 * - encoding: Set by user.
2710 * - decoding: unused.
2712 float rc_max_available_vbv_use;
2715 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2716 * - encoding: Set by user.
2717 * - decoding: unused.
2719 float rc_min_vbv_overflow_use;
2722 * Number of bits which should be loaded into the rc buffer before decoding starts.
2723 * - encoding: Set by user.
2724 * - decoding: unused
2726 int rc_initial_buffer_occupancy;
2728 #if FF_API_CODER_TYPE
2729 #define FF_CODER_TYPE_VLC 0
2730 #define FF_CODER_TYPE_AC 1
2731 #define FF_CODER_TYPE_RAW 2
2732 #define FF_CODER_TYPE_RLE 3
2733 #if FF_API_UNUSED_MEMBERS
2734 #define FF_CODER_TYPE_DEFLATE 4
2735 #endif /* FF_API_UNUSED_MEMBERS */
2737 * @deprecated use encoder private options instead
2739 attribute_deprecated
2741 #endif /* FF_API_CODER_TYPE */
2743 #if FF_API_PRIVATE_OPT
2744 /** @deprecated use encoder private options instead */
2745 attribute_deprecated
2751 * @deprecated use encoder private options instead
2753 attribute_deprecated
2757 * @deprecated use encoder private options instead
2759 attribute_deprecated
2763 #if FF_API_PRIVATE_OPT
2764 /** @deprecated use encoder private options instead */
2765 attribute_deprecated
2766 int frame_skip_threshold;
2768 /** @deprecated use encoder private options instead */
2769 attribute_deprecated
2770 int frame_skip_factor;
2772 /** @deprecated use encoder private options instead */
2773 attribute_deprecated
2776 /** @deprecated use encoder private options instead */
2777 attribute_deprecated
2779 #endif /* FF_API_PRIVATE_OPT */
2782 * trellis RD quantization
2783 * - encoding: Set by user.
2784 * - decoding: unused
2788 #if FF_API_PRIVATE_OPT
2789 /** @deprecated use encoder private options instead */
2790 attribute_deprecated
2791 int min_prediction_order;
2793 /** @deprecated use encoder private options instead */
2794 attribute_deprecated
2795 int max_prediction_order;
2797 /** @deprecated use encoder private options instead */
2798 attribute_deprecated
2799 int64_t timecode_frame_start;
2802 #if FF_API_RTP_CALLBACK
2804 * @deprecated unused
2806 /* The RTP callback: This function is called */
2807 /* every time the encoder has a packet to send. */
2808 /* It depends on the encoder if the data starts */
2809 /* with a Start Code (it should). H.263 does. */
2810 /* mb_nb contains the number of macroblocks */
2811 /* encoded in the RTP payload. */
2812 attribute_deprecated
2813 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2816 #if FF_API_PRIVATE_OPT
2817 /** @deprecated use encoder private options instead */
2818 attribute_deprecated
2819 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2820 /* do its best to deliver a chunk with size */
2821 /* below rtp_payload_size, the chunk will start */
2822 /* with a start code on some codecs like H.263. */
2823 /* This doesn't take account of any particular */
2824 /* headers inside the transmitted RTP payload. */
2827 #if FF_API_STAT_BITS
2828 /* statistics, used for 2-pass encoding */
2829 attribute_deprecated
2831 attribute_deprecated
2833 attribute_deprecated
2835 attribute_deprecated
2837 attribute_deprecated
2839 attribute_deprecated
2841 attribute_deprecated
2843 attribute_deprecated
2846 /** @deprecated this field is unused */
2847 attribute_deprecated
2852 * pass1 encoding statistics output buffer
2853 * - encoding: Set by libavcodec.
2854 * - decoding: unused
2859 * pass2 encoding statistics input buffer
2860 * Concatenated stuff from stats_out of pass1 should be placed here.
2861 * - encoding: Allocated/set/freed by user.
2862 * - decoding: unused
2867 * Work around bugs in encoders which sometimes cannot be detected automatically.
2868 * - encoding: Set by user
2869 * - decoding: Set by user
2871 int workaround_bugs;
2872 #define FF_BUG_AUTODETECT 1 ///< autodetection
2873 #if FF_API_OLD_MSMPEG4
2874 #define FF_BUG_OLD_MSMPEG4 2
2876 #define FF_BUG_XVID_ILACE 4
2877 #define FF_BUG_UMP4 8
2878 #define FF_BUG_NO_PADDING 16
2879 #define FF_BUG_AMV 32
2881 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2883 #define FF_BUG_QPEL_CHROMA 64
2884 #define FF_BUG_STD_QPEL 128
2885 #define FF_BUG_QPEL_CHROMA2 256
2886 #define FF_BUG_DIRECT_BLOCKSIZE 512
2887 #define FF_BUG_EDGE 1024
2888 #define FF_BUG_HPEL_CHROMA 2048
2889 #define FF_BUG_DC_CLIP 4096
2890 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2891 #define FF_BUG_TRUNCATED 16384
2892 #define FF_BUG_IEDGE 32768
2895 * strictly follow the standard (MPEG-4, ...).
2896 * - encoding: Set by user.
2897 * - decoding: Set by user.
2898 * Setting this to STRICT or higher means the encoder and decoder will
2899 * generally do stupid things, whereas setting it to unofficial or lower
2900 * will mean the encoder might produce output that is not supported by all
2901 * spec-compliant decoders. Decoders don't differentiate between normal,
2902 * unofficial and experimental (that is, they always try to decode things
2903 * when they can) unless they are explicitly asked to behave stupidly
2904 * (=strictly conform to the specs)
2906 int strict_std_compliance;
2907 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2908 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2909 #define FF_COMPLIANCE_NORMAL 0
2910 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2911 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2914 * error concealment flags
2915 * - encoding: unused
2916 * - decoding: Set by user.
2918 int error_concealment;
2919 #define FF_EC_GUESS_MVS 1
2920 #define FF_EC_DEBLOCK 2
2921 #define FF_EC_FAVOR_INTER 256
2925 * - encoding: Set by user.
2926 * - decoding: Set by user.
2929 #define FF_DEBUG_PICT_INFO 1
2930 #define FF_DEBUG_RC 2
2931 #define FF_DEBUG_BITSTREAM 4
2932 #define FF_DEBUG_MB_TYPE 8
2933 #define FF_DEBUG_QP 16
2936 * @deprecated this option does nothing
2938 #define FF_DEBUG_MV 32
2940 #define FF_DEBUG_DCT_COEFF 0x00000040
2941 #define FF_DEBUG_SKIP 0x00000080
2942 #define FF_DEBUG_STARTCODE 0x00000100
2943 #if FF_API_UNUSED_MEMBERS
2944 #define FF_DEBUG_PTS 0x00000200
2945 #endif /* FF_API_UNUSED_MEMBERS */
2946 #define FF_DEBUG_ER 0x00000400
2947 #define FF_DEBUG_MMCO 0x00000800
2948 #define FF_DEBUG_BUGS 0x00001000
2950 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2951 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2953 #define FF_DEBUG_BUFFERS 0x00008000
2954 #define FF_DEBUG_THREADS 0x00010000
2955 #define FF_DEBUG_GREEN_MD 0x00800000
2956 #define FF_DEBUG_NOMC 0x01000000
2961 * Code outside libavcodec should access this field using AVOptions
2962 * - encoding: Set by user.
2963 * - decoding: Set by user.
2966 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 // visualize forward predicted MVs of P-frames
2967 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 // visualize forward predicted MVs of B-frames
2968 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2972 * Error recognition; may misdetect some more or less valid parts as errors.
2973 * - encoding: unused
2974 * - decoding: Set by user.
2976 int err_recognition;
2979 * Verify checksums embedded in the bitstream (could be of either encoded or
2980 * decoded data, depending on the codec) and print an error message on mismatch.
2981 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2982 * decoder returning an error.
2984 #define AV_EF_CRCCHECK (1<<0)
2985 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2986 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2987 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2989 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2990 #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
2991 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2992 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2996 * opaque 64-bit number (generally a PTS) that will be reordered and
2997 * output in AVFrame.reordered_opaque
2998 * - encoding: unused
2999 * - decoding: Set by user.
3001 int64_t reordered_opaque;
3004 * Hardware accelerator in use
3005 * - encoding: unused.
3006 * - decoding: Set by libavcodec
3008 struct AVHWAccel *hwaccel;
3011 * Hardware accelerator context.
3012 * For some hardware accelerators, a global context needs to be
3013 * provided by the user. In that case, this holds display-dependent
3014 * data FFmpeg cannot instantiate itself. Please refer to the
3015 * FFmpeg HW accelerator documentation to know how to fill this
3016 * is. e.g. for VA API, this is a struct vaapi_context.
3017 * - encoding: unused
3018 * - decoding: Set by user
3020 void *hwaccel_context;
3024 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3025 * - decoding: unused
3027 uint64_t error[AV_NUM_DATA_POINTERS];
3030 * DCT algorithm, see FF_DCT_* below
3031 * - encoding: Set by user.
3032 * - decoding: unused
3035 #define FF_DCT_AUTO 0
3036 #define FF_DCT_FASTINT 1
3037 #define FF_DCT_INT 2
3038 #define FF_DCT_MMX 3
3039 #define FF_DCT_ALTIVEC 5
3040 #define FF_DCT_FAAN 6
3043 * IDCT algorithm, see FF_IDCT_* below.
3044 * - encoding: Set by user.
3045 * - decoding: Set by user.
3048 #define FF_IDCT_AUTO 0
3049 #define FF_IDCT_INT 1
3050 #define FF_IDCT_SIMPLE 2
3051 #define FF_IDCT_SIMPLEMMX 3
3052 #define FF_IDCT_ARM 7
3053 #define FF_IDCT_ALTIVEC 8
3055 #define FF_IDCT_SH4 9
3057 #define FF_IDCT_SIMPLEARM 10
3058 #if FF_API_UNUSED_MEMBERS
3059 #define FF_IDCT_IPP 13
3060 #endif /* FF_API_UNUSED_MEMBERS */
3061 #define FF_IDCT_XVID 14
3062 #if FF_API_IDCT_XVIDMMX
3063 #define FF_IDCT_XVIDMMX 14
3064 #endif /* FF_API_IDCT_XVIDMMX */
3065 #define FF_IDCT_SIMPLEARMV5TE 16
3066 #define FF_IDCT_SIMPLEARMV6 17
3067 #if FF_API_ARCH_SPARC
3068 #define FF_IDCT_SIMPLEVIS 18
3070 #define FF_IDCT_FAAN 20
3071 #define FF_IDCT_SIMPLENEON 22
3072 #if FF_API_ARCH_ALPHA
3073 #define FF_IDCT_SIMPLEALPHA 23
3075 #define FF_IDCT_SIMPLEAUTO 128
3078 * bits per sample/pixel from the demuxer (needed for huffyuv).
3079 * - encoding: Set by libavcodec.
3080 * - decoding: Set by user.
3082 int bits_per_coded_sample;
3085 * Bits per sample/pixel of internal libavcodec pixel/sample format.
3086 * - encoding: set by user.
3087 * - decoding: set by libavcodec.
3089 int bits_per_raw_sample;
3093 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3094 * - encoding: unused
3095 * - decoding: Set by user.
3096 * Code outside libavcodec should access this field using:
3097 * av_codec_{get,set}_lowres(avctx)
3102 #if FF_API_CODED_FRAME
3104 * the picture in the bitstream
3105 * - encoding: Set by libavcodec.
3106 * - decoding: unused
3108 * @deprecated use the quality factor packet side data instead
3110 attribute_deprecated AVFrame *coded_frame;
3115 * is used to decide how many independent tasks should be passed to execute()
3116 * - encoding: Set by user.
3117 * - decoding: Set by user.
3122 * Which multithreading methods to use.
3123 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3124 * so clients which cannot provide future frames should not use it.
3126 * - encoding: Set by user, otherwise the default is used.
3127 * - decoding: Set by user, otherwise the default is used.
3130 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3131 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3134 * Which multithreading methods are in use by the codec.
3135 * - encoding: Set by libavcodec.
3136 * - decoding: Set by libavcodec.
3138 int active_thread_type;
3141 * Set by the client if its custom get_buffer() callback can be called
3142 * synchronously from another thread, which allows faster multithreaded decoding.
3143 * draw_horiz_band() will be called from other threads regardless of this setting.
3144 * Ignored if the default get_buffer() is used.
3145 * - encoding: Set by user.
3146 * - decoding: Set by user.
3148 int thread_safe_callbacks;
3151 * The codec may call this to execute several independent things.
3152 * It will return only after finishing all tasks.
3153 * The user may replace this with some multithreaded implementation,
3154 * the default implementation will execute the parts serially.
3155 * @param count the number of things to execute
3156 * - encoding: Set by libavcodec, user can override.
3157 * - decoding: Set by libavcodec, user can override.
3159 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3162 * The codec may call this to execute several independent things.
3163 * It will return only after finishing all tasks.
3164 * The user may replace this with some multithreaded implementation,
3165 * the default implementation will execute the parts serially.
3166 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3167 * @param c context passed also to func
3168 * @param count the number of things to execute
3169 * @param arg2 argument passed unchanged to func
3170 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3171 * @param func function that will be called count times, with jobnr from 0 to count-1.
3172 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3173 * two instances of func executing at the same time will have the same threadnr.
3174 * @return always 0 currently, but code should handle a future improvement where when any call to func
3175 * returns < 0 no further calls to func may be done and < 0 is returned.
3176 * - encoding: Set by libavcodec, user can override.
3177 * - decoding: Set by libavcodec, user can override.
3179 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3182 * noise vs. sse weight for the nsse comparison function
3183 * - encoding: Set by user.
3184 * - decoding: unused
3190 * - encoding: Set by user.
3191 * - decoding: Set by libavcodec.
3194 #define FF_PROFILE_UNKNOWN -99
3195 #define FF_PROFILE_RESERVED -100
3197 #define FF_PROFILE_AAC_MAIN 0
3198 #define FF_PROFILE_AAC_LOW 1
3199 #define FF_PROFILE_AAC_SSR 2
3200 #define FF_PROFILE_AAC_LTP 3
3201 #define FF_PROFILE_AAC_HE 4
3202 #define FF_PROFILE_AAC_HE_V2 28
3203 #define FF_PROFILE_AAC_LD 22
3204 #define FF_PROFILE_AAC_ELD 38
3205 #define FF_PROFILE_MPEG2_AAC_LOW 128
3206 #define FF_PROFILE_MPEG2_AAC_HE 131
3208 #define FF_PROFILE_DNXHD 0
3209 #define FF_PROFILE_DNXHR_LB 1
3210 #define FF_PROFILE_DNXHR_SQ 2
3211 #define FF_PROFILE_DNXHR_HQ 3
3212 #define FF_PROFILE_DNXHR_HQX 4
3213 #define FF_PROFILE_DNXHR_444 5
3215 #define FF_PROFILE_DTS 20
3216 #define FF_PROFILE_DTS_ES 30
3217 #define FF_PROFILE_DTS_96_24 40
3218 #define FF_PROFILE_DTS_HD_HRA 50
3219 #define FF_PROFILE_DTS_HD_MA 60
3220 #define FF_PROFILE_DTS_EXPRESS 70
3222 #define FF_PROFILE_MPEG2_422 0
3223 #define FF_PROFILE_MPEG2_HIGH 1
3224 #define FF_PROFILE_MPEG2_SS 2
3225 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3226 #define FF_PROFILE_MPEG2_MAIN 4
3227 #define FF_PROFILE_MPEG2_SIMPLE 5
3229 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3230 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3232 #define FF_PROFILE_H264_BASELINE 66
3233 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3234 #define FF_PROFILE_H264_MAIN 77
3235 #define FF_PROFILE_H264_EXTENDED 88
3236 #define FF_PROFILE_H264_HIGH 100
3237 #define FF_PROFILE_H264_HIGH_10 110
3238 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3239 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
3240 #define FF_PROFILE_H264_HIGH_422 122
3241 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3242 #define FF_PROFILE_H264_STEREO_HIGH 128
3243 #define FF_PROFILE_H264_HIGH_444 144
3244 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3245 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3246 #define FF_PROFILE_H264_CAVLC_444 44
3248 #define FF_PROFILE_VC1_SIMPLE 0
3249 #define FF_PROFILE_VC1_MAIN 1
3250 #define FF_PROFILE_VC1_COMPLEX 2
3251 #define FF_PROFILE_VC1_ADVANCED 3
3253 #define FF_PROFILE_MPEG4_SIMPLE 0
3254 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3255 #define FF_PROFILE_MPEG4_CORE 2
3256 #define FF_PROFILE_MPEG4_MAIN 3
3257 #define FF_PROFILE_MPEG4_N_BIT 4
3258 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3259 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3260 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3261 #define FF_PROFILE_MPEG4_HYBRID 8
3262 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3263 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3264 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3265 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3266 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3267 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3268 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3270 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
3271 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
3272 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
3273 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3274 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3276 #define FF_PROFILE_VP9_0 0
3277 #define FF_PROFILE_VP9_1 1
3278 #define FF_PROFILE_VP9_2 2
3279 #define FF_PROFILE_VP9_3 3
3281 #define FF_PROFILE_HEVC_MAIN 1
3282 #define FF_PROFILE_HEVC_MAIN_10 2
3283 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3284 #define FF_PROFILE_HEVC_REXT 4
3288 * - encoding: Set by user.
3289 * - decoding: Set by libavcodec.
3292 #define FF_LEVEL_UNKNOWN -99
3295 * Skip loop filtering for selected frames.
3296 * - encoding: unused
3297 * - decoding: Set by user.
3299 enum AVDiscard skip_loop_filter;
3302 * Skip IDCT/dequantization for selected frames.
3303 * - encoding: unused
3304 * - decoding: Set by user.
3306 enum AVDiscard skip_idct;
3309 * Skip decoding for selected frames.
3310 * - encoding: unused
3311 * - decoding: Set by user.
3313 enum AVDiscard skip_frame;
3316 * Header containing style information for text subtitles.
3317 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3318 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3319 * the Format line following. It shouldn't include any Dialogue line.
3320 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3321 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3323 uint8_t *subtitle_header;
3324 int subtitle_header_size;
3326 #if FF_API_ERROR_RATE
3328 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3331 attribute_deprecated
3335 #if FF_API_VBV_DELAY
3337 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3338 * Used for compliant TS muxing.
3339 * - encoding: Set by libavcodec.
3340 * - decoding: unused.
3341 * @deprecated this value is now exported as a part of
3342 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3344 attribute_deprecated
3348 #if FF_API_SIDEDATA_ONLY_PKT
3350 * Encoding only and set by default. Allow encoders to output packets
3351 * that do not contain any encoded data, only side data.
3353 * Some encoders need to output such packets, e.g. to update some stream
3354 * parameters at the end of encoding.
3356 * @deprecated this field disables the default behaviour and
3357 * it is kept only for compatibility.
3359 attribute_deprecated
3360 int side_data_only_packets;
3364 * Audio only. The number of "priming" samples (padding) inserted by the
3365 * encoder at the beginning of the audio. I.e. this number of leading
3366 * decoded samples must be discarded by the caller to get the original audio
3367 * without leading padding.
3369 * - decoding: unused
3370 * - encoding: Set by libavcodec. The timestamps on the output packets are
3371 * adjusted by the encoder so that they always refer to the
3372 * first sample of the data actually contained in the packet,
3373 * including any added padding. E.g. if the timebase is
3374 * 1/samplerate and the timestamp of the first input sample is
3375 * 0, the timestamp of the first output packet will be
3378 int initial_padding;
3381 * - decoding: For codecs that store a framerate value in the compressed
3382 * bitstream, the decoder may export it here. { 0, 1} when
3384 * - encoding: May be used to signal the framerate of CFR content to an
3387 AVRational framerate;
3390 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3391 * - encoding: unused.
3392 * - decoding: Set by libavcodec before calling get_format()
3394 enum AVPixelFormat sw_pix_fmt;
3397 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3398 * Code outside libavcodec should access this field using:
3399 * av_codec_{get,set}_pkt_timebase(avctx)
3400 * - encoding unused.
3401 * - decoding set by user.
3403 AVRational pkt_timebase;
3407 * Code outside libavcodec should access this field using:
3408 * av_codec_{get,set}_codec_descriptor(avctx)
3409 * - encoding: unused.
3410 * - decoding: set by libavcodec.
3412 const AVCodecDescriptor *codec_descriptor;
3416 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3417 * - encoding: unused
3418 * - decoding: Set by user.
3419 * Code outside libavcodec should access this field using:
3420 * av_codec_{get,set}_lowres(avctx)
3426 * Current statistics for PTS correction.
3427 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3428 * - encoding: unused
3430 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3431 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3432 int64_t pts_correction_last_pts; /// PTS of the last frame
3433 int64_t pts_correction_last_dts; /// DTS of the last frame
3436 * Character encoding of the input subtitles file.
3437 * - decoding: set by user
3438 * - encoding: unused
3443 * Subtitles character encoding mode. Formats or codecs might be adjusting
3444 * this setting (if they are doing the conversion themselves for instance).
3445 * - decoding: set by libavcodec
3446 * - encoding: unused
3448 int sub_charenc_mode;
3449 #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)
3450 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3451 #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
3454 * Skip processing alpha if supported by codec.
3455 * Note that if the format uses pre-multiplied alpha (common with VP6,
3456 * and recommended due to better video quality/compression)
3457 * the image will look as if alpha-blended onto a black background.
3458 * However for formats that do not use pre-multiplied alpha
3459 * there might be serious artefacts (though e.g. libswscale currently
3460 * assumes pre-multiplied alpha anyway).
3461 * Code outside libavcodec should access this field using AVOptions
3463 * - decoding: set by user
3464 * - encoding: unused
3469 * Number of samples to skip after a discontinuity
3470 * - decoding: unused
3471 * - encoding: set by libavcodec
3475 #if !FF_API_DEBUG_MV
3477 * debug motion vectors
3478 * Code outside libavcodec should access this field using AVOptions
3479 * - encoding: Set by user.
3480 * - decoding: Set by user.
3483 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3484 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3485 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3489 * custom intra quantization matrix
3490 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3491 * - encoding: Set by user, can be NULL.
3492 * - decoding: unused.
3494 uint16_t *chroma_intra_matrix;
3497 * dump format separator.
3498 * can be ", " or "\n " or anything else
3499 * Code outside libavcodec should access this field using AVOptions
3500 * (NO direct access).
3501 * - encoding: Set by user.
3502 * - decoding: Set by user.
3504 uint8_t *dump_separator;
3507 * ',' separated list of allowed decoders.
3508 * If NULL then all are allowed
3509 * - encoding: unused
3510 * - decoding: set by user through AVOPtions (NO direct access)
3512 char *codec_whitelist;
3515 * Properties of the stream that gets decoded
3516 * To be accessed through av_codec_get_properties() (NO direct access)
3517 * - encoding: unused
3518 * - decoding: set by libavcodec
3520 unsigned properties;
3521 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3522 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3525 * Additional data associated with the entire coded stream.
3527 * - decoding: unused
3528 * - encoding: may be set by libavcodec after avcodec_open2().
3530 AVPacketSideData *coded_side_data;
3531 int nb_coded_side_data;
3534 * A reference to the AVHWFramesContext describing the input (for encoding)
3535 * or output (decoding) frames. The reference is set by the caller and
3536 * afterwards owned (and freed) by libavcodec.
3538 * - decoding: This field should be set by the caller from the get_format()
3539 * callback. The previous reference (if any) will always be
3540 * unreffed by libavcodec before the get_format() call.
3542 * If the default get_buffer2() is used with a hwaccel pixel
3543 * format, then this AVHWFramesContext will be used for
3544 * allocating the frame buffers.
3546 * - encoding: For hardware encoders configured to use a hwaccel pixel
3547 * format, this field should be set by the caller to a reference
3548 * to the AVHWFramesContext describing input frames.
3549 * AVHWFramesContext.format must be equal to
3550 * AVCodecContext.pix_fmt.
3552 * This field should be set before avcodec_open2() is called.
3554 AVBufferRef *hw_frames_ctx;
3557 * Control the form of AVSubtitle.rects[N]->ass
3558 * - decoding: set by user
3559 * - encoding: unused
3561 int sub_text_format;
3562 #define FF_SUB_TEXT_FMT_ASS 0
3563 #if FF_API_ASS_TIMING
3564 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3568 * Audio only. The amount of padding (in samples) appended by the encoder to
3569 * the end of the audio. I.e. this number of decoded samples must be
3570 * discarded by the caller from the end of the stream to get the original
3571 * audio without any trailing padding.
3573 * - decoding: unused
3574 * - encoding: unused
3576 int trailing_padding;
3579 * The number of pixels per image to maximally accept.
3581 * - decoding: set by user
3582 * - encoding: set by user
3588 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3589 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3591 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3592 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3594 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3596 int av_codec_get_lowres(const AVCodecContext *avctx);
3597 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3599 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3600 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3602 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3603 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3608 typedef struct AVProfile {
3610 const char *name; ///< short name for the profile
3613 typedef struct AVCodecDefault AVCodecDefault;
3620 typedef struct AVCodec {
3622 * Name of the codec implementation.
3623 * The name is globally unique among encoders and among decoders (but an
3624 * encoder and a decoder can share the same name).
3625 * This is the primary way to find a codec from the user perspective.
3629 * Descriptive name for the codec, meant to be more human readable than name.
3630 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3632 const char *long_name;
3633 enum AVMediaType type;
3636 * Codec capabilities.
3637 * see AV_CODEC_CAP_*
3640 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3641 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3642 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3643 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3644 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3645 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3646 const AVClass *priv_class; ///< AVClass for the private context
3647 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3649 /*****************************************************************
3650 * No fields below this line are part of the public API. They
3651 * may not be used outside of libavcodec and can be changed and
3653 * New public fields should be added right above.
3654 *****************************************************************
3657 struct AVCodec *next;
3659 * @name Frame-level threading support functions
3663 * If defined, called on thread contexts when they are created.
3664 * If the codec allocates writable tables in init(), re-allocate them here.
3665 * priv_data will be set to a copy of the original.
3667 int (*init_thread_copy)(AVCodecContext *);
3669 * Copy necessary context variables from a previous thread context to the current one.
3670 * If not defined, the next thread will start automatically; otherwise, the codec
3671 * must call ff_thread_finish_setup().
3673 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3675 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3679 * Private codec-specific defaults.
3681 const AVCodecDefault *defaults;
3684 * Initialize codec static data, called from avcodec_register().
3686 void (*init_static_data)(struct AVCodec *codec);
3688 int (*init)(AVCodecContext *);
3689 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3690 const struct AVSubtitle *sub);
3692 * Encode data to an AVPacket.
3694 * @param avctx codec context
3695 * @param avpkt output AVPacket (may contain a user-provided buffer)
3696 * @param[in] frame AVFrame containing the raw data to be encoded
3697 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3698 * non-empty packet was returned in avpkt.
3699 * @return 0 on success, negative error code on failure
3701 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3702 int *got_packet_ptr);
3703 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3704 int (*close)(AVCodecContext *);
3706 * Decode/encode API with decoupled packet/frame dataflow. The API is the
3707 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3709 * - never called if the codec is closed or the wrong type,
3710 * - AVPacket parameter change side data is applied right before calling
3711 * AVCodec->send_packet,
3712 * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3713 * - only one drain packet is ever passed down (until the next flush()),
3714 * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3716 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3717 int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3718 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3719 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3722 * Will be called when seeking
3724 void (*flush)(AVCodecContext *);
3726 * Internal codec capabilities.
3727 * See FF_CODEC_CAP_* in internal.h
3732 int av_codec_get_max_lowres(const AVCodec *codec);
3734 struct MpegEncContext;
3737 * @defgroup lavc_hwaccel AVHWAccel
3740 typedef struct AVHWAccel {
3742 * Name of the hardware accelerated codec.
3743 * The name is globally unique among encoders and among decoders (but an
3744 * encoder and a decoder can share the same name).
3749 * Type of codec implemented by the hardware accelerator.
3751 * See AVMEDIA_TYPE_xxx
3753 enum AVMediaType type;
3756 * Codec implemented by the hardware accelerator.
3758 * See AV_CODEC_ID_xxx
3763 * Supported pixel format.
3765 * Only hardware accelerated formats are supported here.
3767 enum AVPixelFormat pix_fmt;
3770 * Hardware accelerated codec capabilities.
3771 * see HWACCEL_CODEC_CAP_*
3775 /*****************************************************************
3776 * No fields below this line are part of the public API. They
3777 * may not be used outside of libavcodec and can be changed and
3779 * New public fields should be added right above.
3780 *****************************************************************
3782 struct AVHWAccel *next;
3785 * Allocate a custom buffer
3787 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3790 * Called at the beginning of each frame or field picture.
3792 * Meaningful frame information (codec specific) is guaranteed to
3793 * be parsed at this point. This function is mandatory.
3795 * Note that buf can be NULL along with buf_size set to 0.
3796 * Otherwise, this means the whole frame is available at this point.
3798 * @param avctx the codec context
3799 * @param buf the frame data buffer base
3800 * @param buf_size the size of the frame in bytes
3801 * @return zero if successful, a negative value otherwise
3803 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3806 * Callback for each slice.
3808 * Meaningful slice information (codec specific) is guaranteed to
3809 * be parsed at this point. This function is mandatory.
3810 * The only exception is XvMC, that works on MB level.
3812 * @param avctx the codec context
3813 * @param buf the slice data buffer base
3814 * @param buf_size the size of the slice in bytes
3815 * @return zero if successful, a negative value otherwise
3817 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3820 * Called at the end of each frame or field picture.
3822 * The whole picture is parsed at this point and can now be sent
3823 * to the hardware accelerator. This function is mandatory.
3825 * @param avctx the codec context
3826 * @return zero if successful, a negative value otherwise
3828 int (*end_frame)(AVCodecContext *avctx);
3831 * Size of per-frame hardware accelerator private data.
3833 * Private data is allocated with av_mallocz() before
3834 * AVCodecContext.get_buffer() and deallocated after
3835 * AVCodecContext.release_buffer().
3837 int frame_priv_data_size;
3840 * Called for every Macroblock in a slice.
3842 * XvMC uses it to replace the ff_mpv_decode_mb().
3843 * Instead of decoding to raw picture, MB parameters are
3844 * stored in an array provided by the video driver.
3846 * @param s the mpeg context
3848 void (*decode_mb)(struct MpegEncContext *s);
3851 * Initialize the hwaccel private data.
3853 * This will be called from ff_get_format(), after hwaccel and
3854 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3857 int (*init)(AVCodecContext *avctx);
3860 * Uninitialize the hwaccel private data.
3862 * This will be called from get_format() or avcodec_close(), after hwaccel
3863 * and hwaccel_context are already uninitialized.
3865 int (*uninit)(AVCodecContext *avctx);
3868 * Size of the private data to allocate in
3869 * AVCodecInternal.hwaccel_priv_data.
3875 * Hardware acceleration should be used for decoding even if the codec level
3876 * used is unknown or higher than the maximum supported level reported by the
3879 * It's generally a good idea to pass this flag unless you have a specific
3880 * reason not to, as hardware tends to under-report supported levels.
3882 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3885 * Hardware acceleration can output YUV pixel formats with a different chroma
3886 * sampling than 4:2:0 and/or other than 8 bits per component.
3888 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3894 #if FF_API_AVPICTURE
3896 * @defgroup lavc_picture AVPicture
3898 * Functions for working with AVPicture
3903 * Picture data structure.
3905 * Up to four components can be stored into it, the last component is
3907 * @deprecated use AVFrame or imgutils functions instead
3909 typedef struct AVPicture {
3910 attribute_deprecated
3911 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3912 attribute_deprecated
3913 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3921 enum AVSubtitleType {
3924 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3927 * Plain text, the text field must be set by the decoder and is
3928 * authoritative. ass and pict fields may contain approximations.
3933 * Formatted text, the ass field must be set by the decoder and is
3934 * authoritative. pict and text fields may contain approximations.
3939 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3941 typedef struct AVSubtitleRect {
3942 int x; ///< top left corner of pict, undefined when pict is not set
3943 int y; ///< top left corner of pict, undefined when pict is not set
3944 int w; ///< width of pict, undefined when pict is not set
3945 int h; ///< height of pict, undefined when pict is not set
3946 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3948 #if FF_API_AVPICTURE
3950 * @deprecated unused
3952 attribute_deprecated
3956 * data+linesize for the bitmap of this subtitle.
3957 * Can be set for text/ass as well once they are rendered.
3962 enum AVSubtitleType type;
3964 char *text; ///< 0 terminated plain UTF-8 text
3967 * 0 terminated ASS/SSA compatible event line.
3968 * The presentation of this is unaffected by the other values in this
3976 typedef struct AVSubtitle {
3977 uint16_t format; /* 0 = graphics */
3978 uint32_t start_display_time; /* relative to packet pts, in ms */
3979 uint32_t end_display_time; /* relative to packet pts, in ms */
3981 AVSubtitleRect **rects;
3982 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3986 * This struct describes the properties of an encoded stream.
3988 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3989 * be allocated with avcodec_parameters_alloc() and freed with
3990 * avcodec_parameters_free().
3992 typedef struct AVCodecParameters {
3994 * General type of the encoded data.
3996 enum AVMediaType codec_type;
3998 * Specific type of the encoded data (the codec used).
4000 enum AVCodecID codec_id;
4002 * Additional information about the codec (corresponds to the AVI FOURCC).
4007 * Extra binary data needed for initializing the decoder, codec-dependent.
4009 * Must be allocated with av_malloc() and will be freed by
4010 * avcodec_parameters_free(). The allocated size of extradata must be at
4011 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4016 * Size of the extradata content in bytes.
4021 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4022 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4027 * The average bitrate of the encoded data (in bits per second).
4032 * The number of bits per sample in the codedwords.
4034 * This is basically the bitrate per sample. It is mandatory for a bunch of
4035 * formats to actually decode them. It's the number of bits for one sample in
4036 * the actual coded bitstream.
4038 * This could be for example 4 for ADPCM
4039 * For PCM formats this matches bits_per_raw_sample
4042 int bits_per_coded_sample;
4045 * This is the number of valid bits in each output sample. If the
4046 * sample format has more bits, the least significant bits are additional
4047 * padding bits, which are always 0. Use right shifts to reduce the sample
4048 * to its actual size. For example, audio formats with 24 bit samples will
4049 * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4050 * To get the original sample use "(int32_t)sample >> 8"."
4052 * For ADPCM this might be 12 or 16 or similar
4055 int bits_per_raw_sample;
4058 * Codec-specific bitstream restrictions that the stream conforms to.
4064 * Video only. The dimensions of the video frame in pixels.
4070 * Video only. The aspect ratio (width / height) which a single pixel
4071 * should have when displayed.
4073 * When the aspect ratio is unknown / undefined, the numerator should be
4074 * set to 0 (the denominator may have any value).
4076 AVRational sample_aspect_ratio;
4079 * Video only. The order of the fields in interlaced video.
4081 enum AVFieldOrder field_order;
4084 * Video only. Additional colorspace characteristics.
4086 enum AVColorRange color_range;
4087 enum AVColorPrimaries color_primaries;
4088 enum AVColorTransferCharacteristic color_trc;
4089 enum AVColorSpace color_space;
4090 enum AVChromaLocation chroma_location;
4093 * Video only. Number of delayed frames.
4098 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4099 * unknown or unspecified, otherwise the number of bits set must be equal to
4100 * the channels field.
4102 uint64_t channel_layout;
4104 * Audio only. The number of audio channels.
4108 * Audio only. The number of audio samples per second.
4112 * Audio only. The number of bytes per coded audio frame, required by some
4115 * Corresponds to nBlockAlign in WAVEFORMATEX.
4119 * Audio only. Audio frame size, if known. Required by some formats to be static.
4124 * Audio only. The amount of padding (in samples) inserted by the encoder at
4125 * the beginning of the audio. I.e. this number of leading decoded samples
4126 * must be discarded by the caller to get the original audio without leading
4129 int initial_padding;
4131 * Audio only. The amount of padding (in samples) appended by the encoder to
4132 * the end of the audio. I.e. this number of decoded samples must be
4133 * discarded by the caller from the end of the stream to get the original
4134 * audio without any trailing padding.
4136 int trailing_padding;
4138 * Audio only. Number of samples to skip after a discontinuity.
4141 } AVCodecParameters;
4144 * If c is NULL, returns the first registered codec,
4145 * if c is non-NULL, returns the next registered codec after c,
4146 * or NULL if c is the last one.
4148 AVCodec *av_codec_next(const AVCodec *c);
4151 * Return the LIBAVCODEC_VERSION_INT constant.
4153 unsigned avcodec_version(void);
4156 * Return the libavcodec build-time configuration.
4158 const char *avcodec_configuration(void);
4161 * Return the libavcodec license.
4163 const char *avcodec_license(void);
4166 * Register the codec codec and initialize libavcodec.
4168 * @warning either this function or avcodec_register_all() must be called
4169 * before any other libavcodec functions.
4171 * @see avcodec_register_all()
4173 void avcodec_register(AVCodec *codec);
4176 * Register all the codecs, parsers and bitstream filters which were enabled at
4177 * configuration time. If you do not call this function you can select exactly
4178 * which formats you want to support, by using the individual registration
4181 * @see avcodec_register
4182 * @see av_register_codec_parser
4183 * @see av_register_bitstream_filter
4185 void avcodec_register_all(void);
4188 * Allocate an AVCodecContext and set its fields to default values. The
4189 * resulting struct should be freed with avcodec_free_context().
4191 * @param codec if non-NULL, allocate private data and initialize defaults
4192 * for the given codec. It is illegal to then call avcodec_open2()
4193 * with a different codec.
4194 * If NULL, then the codec-specific defaults won't be initialized,
4195 * which may result in suboptimal default settings (this is
4196 * important mainly for encoders, e.g. libx264).
4198 * @return An AVCodecContext filled with default values or NULL on failure.
4200 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4203 * Free the codec context and everything associated with it and write NULL to
4204 * the provided pointer.
4206 void avcodec_free_context(AVCodecContext **avctx);
4208 #if FF_API_GET_CONTEXT_DEFAULTS
4210 * @deprecated This function should not be used, as closing and opening a codec
4211 * context multiple time is not supported. A new codec context should be
4212 * allocated for each new use.
4214 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4218 * Get the AVClass for AVCodecContext. It can be used in combination with
4219 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4221 * @see av_opt_find().
4223 const AVClass *avcodec_get_class(void);
4225 #if FF_API_COPY_CONTEXT
4227 * Get the AVClass for AVFrame. It can be used in combination with
4228 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4230 * @see av_opt_find().
4232 const AVClass *avcodec_get_frame_class(void);
4235 * Get the AVClass for AVSubtitleRect. It can be used in combination with
4236 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4238 * @see av_opt_find().
4240 const AVClass *avcodec_get_subtitle_rect_class(void);
4243 * Copy the settings of the source AVCodecContext into the destination
4244 * AVCodecContext. The resulting destination codec context will be
4245 * unopened, i.e. you are required to call avcodec_open2() before you
4246 * can use this AVCodecContext to decode/encode video/audio data.
4248 * @param dest target codec context, should be initialized with
4249 * avcodec_alloc_context3(NULL), but otherwise uninitialized
4250 * @param src source codec context
4251 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4253 * @deprecated The semantics of this function are ill-defined and it should not
4254 * be used. If you need to transfer the stream parameters from one codec context
4255 * to another, use an intermediate AVCodecParameters instance and the
4256 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4259 attribute_deprecated
4260 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4264 * Allocate a new AVCodecParameters and set its fields to default values
4265 * (unknown/invalid/0). The returned struct must be freed with
4266 * avcodec_parameters_free().
4268 AVCodecParameters *avcodec_parameters_alloc(void);
4271 * Free an AVCodecParameters instance and everything associated with it and
4272 * write NULL to the supplied pointer.
4274 void avcodec_parameters_free(AVCodecParameters **par);
4277 * Copy the contents of src to dst. Any allocated fields in dst are freed and
4278 * replaced with newly allocated duplicates of the corresponding fields in src.
4280 * @return >= 0 on success, a negative AVERROR code on failure.
4282 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4285 * Fill the parameters struct based on the values from the supplied codec
4286 * context. Any allocated fields in par are freed and replaced with duplicates
4287 * of the corresponding fields in codec.
4289 * @return >= 0 on success, a negative AVERROR code on failure
4291 int avcodec_parameters_from_context(AVCodecParameters *par,
4292 const AVCodecContext *codec);
4295 * Fill the codec context based on the values from the supplied codec
4296 * parameters. Any allocated fields in codec that have a corresponding field in
4297 * par are freed and replaced with duplicates of the corresponding field in par.
4298 * Fields in codec that do not have a counterpart in par are not touched.
4300 * @return >= 0 on success, a negative AVERROR code on failure.
4302 int avcodec_parameters_to_context(AVCodecContext *codec,
4303 const AVCodecParameters *par);
4306 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4307 * function the context has to be allocated with avcodec_alloc_context3().
4309 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4310 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4311 * retrieving a codec.
4313 * @warning This function is not thread safe!
4315 * @note Always call this function before using decoding routines (such as
4316 * @ref avcodec_receive_frame()).
4319 * avcodec_register_all();
4320 * av_dict_set(&opts, "b", "2.5M", 0);
4321 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4325 * context = avcodec_alloc_context3(codec);
4327 * if (avcodec_open2(context, codec, opts) < 0)
4331 * @param avctx The context to initialize.
4332 * @param codec The codec to open this context for. If a non-NULL codec has been
4333 * previously passed to avcodec_alloc_context3() or
4334 * for this context, then this parameter MUST be either NULL or
4335 * equal to the previously passed codec.
4336 * @param options A dictionary filled with AVCodecContext and codec-private options.
4337 * On return this object will be filled with options that were not found.
4339 * @return zero on success, a negative value on error
4340 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4341 * av_dict_set(), av_opt_find().
4343 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4346 * Close a given AVCodecContext and free all the data associated with it
4347 * (but not the AVCodecContext itself).
4349 * Calling this function on an AVCodecContext that hasn't been opened will free
4350 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4351 * codec. Subsequent calls will do nothing.
4353 * @note Do not use this function. Use avcodec_free_context() to destroy a
4354 * codec context (either open or closed). Opening and closing a codec context
4355 * multiple times is not supported anymore -- use multiple codec contexts
4358 int avcodec_close(AVCodecContext *avctx);
4361 * Free all allocated data in the given subtitle struct.
4363 * @param sub AVSubtitle to free.
4365 void avsubtitle_free(AVSubtitle *sub);
4372 * @addtogroup lavc_packet
4377 * Allocate an AVPacket and set its fields to default values. The resulting
4378 * struct must be freed using av_packet_free().
4380 * @return An AVPacket filled with default values or NULL on failure.
4382 * @note this only allocates the AVPacket itself, not the data buffers. Those
4383 * must be allocated through other means such as av_new_packet.
4385 * @see av_new_packet
4387 AVPacket *av_packet_alloc(void);
4390 * Create a new packet that references the same data as src.
4392 * This is a shortcut for av_packet_alloc()+av_packet_ref().
4394 * @return newly created AVPacket on success, NULL on error.
4396 * @see av_packet_alloc
4397 * @see av_packet_ref
4399 AVPacket *av_packet_clone(AVPacket *src);
4402 * Free the packet, if the packet is reference counted, it will be
4403 * unreferenced first.
4405 * @param packet packet to be freed. The pointer will be set to NULL.
4406 * @note passing NULL is a no-op.
4408 void av_packet_free(AVPacket **pkt);
4411 * Initialize optional fields of a packet with default values.
4413 * Note, this does not touch the data and size members, which have to be
4414 * initialized separately.
4418 void av_init_packet(AVPacket *pkt);
4421 * Allocate the payload of a packet and initialize its fields with
4425 * @param size wanted payload size
4426 * @return 0 if OK, AVERROR_xxx otherwise
4428 int av_new_packet(AVPacket *pkt, int size);
4431 * Reduce packet size, correctly zeroing padding
4434 * @param size new size
4436 void av_shrink_packet(AVPacket *pkt, int size);
4439 * Increase packet size, correctly zeroing padding
4442 * @param grow_by number of bytes by which to increase the size of the packet
4444 int av_grow_packet(AVPacket *pkt, int grow_by);
4447 * Initialize a reference-counted packet from av_malloc()ed data.
4449 * @param pkt packet to be initialized. This function will set the data, size,
4450 * buf and destruct fields, all others are left untouched.
4451 * @param data Data allocated by av_malloc() to be used as packet data. If this
4452 * function returns successfully, the data is owned by the underlying AVBuffer.
4453 * The caller may not access the data through other means.
4454 * @param size size of data in bytes, without the padding. I.e. the full buffer
4455 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4457 * @return 0 on success, a negative AVERROR on error
4459 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4461 #if FF_API_AVPACKET_OLD_API
4463 * @warning This is a hack - the packet memory allocation stuff is broken. The
4464 * packet is allocated if it was not really allocated.
4466 * @deprecated Use av_packet_ref
4468 attribute_deprecated
4469 int av_dup_packet(AVPacket *pkt);
4471 * Copy packet, including contents
4473 * @return 0 on success, negative AVERROR on fail
4475 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4478 * Copy packet side data
4480 * @return 0 on success, negative AVERROR on fail
4482 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4487 * @deprecated Use av_packet_unref
4489 * @param pkt packet to free
4491 attribute_deprecated
4492 void av_free_packet(AVPacket *pkt);
4495 * Allocate new information of a packet.
4498 * @param type side information type
4499 * @param size side information size
4500 * @return pointer to fresh allocated data or NULL otherwise
4502 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4506 * Wrap an existing array as a packet side data.
4509 * @param type side information type
4510 * @param data the side data array. It must be allocated with the av_malloc()
4511 * family of functions. The ownership of the data is transferred to
4513 * @param size side information size
4514 * @return a non-negative number on success, a negative AVERROR code on
4515 * failure. On failure, the packet is unchanged and the data remains
4516 * owned by the caller.
4518 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4519 uint8_t *data, size_t size);
4522 * Shrink the already allocated side data buffer
4525 * @param type side information type
4526 * @param size new side information size
4527 * @return 0 on success, < 0 on failure
4529 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4533 * Get side information from packet.
4536 * @param type desired side information type
4537 * @param size pointer for side information size to store (optional)
4538 * @return pointer to data if present or NULL otherwise
4540 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4543 int av_packet_merge_side_data(AVPacket *pkt);
4545 int av_packet_split_side_data(AVPacket *pkt);
4547 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4550 * Pack a dictionary for use in side_data.
4552 * @param dict The dictionary to pack.
4553 * @param size pointer to store the size of the returned data
4554 * @return pointer to data if successful, NULL otherwise
4556 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4558 * Unpack a dictionary from side_data.
4560 * @param data data from side_data
4561 * @param size size of the data
4562 * @param dict the metadata storage dictionary
4563 * @return 0 on success, < 0 on failure
4565 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4569 * Convenience function to free all the side data stored.
4570 * All the other fields stay untouched.
4574 void av_packet_free_side_data(AVPacket *pkt);
4577 * Setup a new reference to the data described by a given packet
4579 * If src is reference-counted, setup dst as a new reference to the
4580 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4581 * data from src into it.
4583 * All the other fields are copied from src.
4585 * @see av_packet_unref
4587 * @param dst Destination packet
4588 * @param src Source packet
4590 * @return 0 on success, a negative AVERROR on error.
4592 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4597 * Unreference the buffer referenced by the packet and reset the
4598 * remaining packet fields to their default values.
4600 * @param pkt The packet to be unreferenced.
4602 void av_packet_unref(AVPacket *pkt);
4605 * Move every field in src to dst and reset src.
4607 * @see av_packet_unref
4609 * @param src Source packet, will be reset
4610 * @param dst Destination packet
4612 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4615 * Copy only "properties" fields from src to dst.
4617 * Properties for the purpose of this function are all the fields
4618 * beside those related to the packet data (buf, data, size)
4620 * @param dst Destination packet
4621 * @param src Source packet
4623 * @return 0 on success AVERROR on failure.
4625 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4628 * Convert valid timing fields (timestamps / durations) in a packet from one
4629 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4632 * @param pkt packet on which the conversion will be performed
4633 * @param tb_src source timebase, in which the timing fields in pkt are
4635 * @param tb_dst destination timebase, to which the timing fields will be
4638 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4645 * @addtogroup lavc_decoding
4650 * Find a registered decoder with a matching codec ID.
4652 * @param id AVCodecID of the requested decoder
4653 * @return A decoder if one was found, NULL otherwise.
4655 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4658 * Find a registered decoder with the specified name.
4660 * @param name name of the requested decoder
4661 * @return A decoder if one was found, NULL otherwise.
4663 AVCodec *avcodec_find_decoder_by_name(const char *name);
4666 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4667 * it can be called by custom get_buffer2() implementations for decoders without
4668 * AV_CODEC_CAP_DR1 set.
4670 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4674 * Return the amount of padding in pixels which the get_buffer callback must
4675 * provide around the edge of the image for codecs which do not have the
4676 * CODEC_FLAG_EMU_EDGE flag.
4678 * @return Required padding in pixels.
4680 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4683 attribute_deprecated
4684 unsigned avcodec_get_edge_width(void);
4688 * Modify width and height values so that they will result in a memory
4689 * buffer that is acceptable for the codec if you do not use any horizontal
4692 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4694 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4697 * Modify width and height values so that they will result in a memory
4698 * buffer that is acceptable for the codec if you also ensure that all
4699 * line sizes are a multiple of the respective linesize_align[i].
4701 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4703 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4704 int linesize_align[AV_NUM_DATA_POINTERS]);
4707 * Converts AVChromaLocation to swscale x/y chroma position.
4709 * The positions represent the chroma (0,0) position in a coordinates system
4710 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4712 * @param xpos horizontal chroma sample position
4713 * @param ypos vertical chroma sample position
4715 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4718 * Converts swscale x/y chroma position to AVChromaLocation.
4720 * The positions represent the chroma (0,0) position in a coordinates system
4721 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4723 * @param xpos horizontal chroma sample position
4724 * @param ypos vertical chroma sample position
4726 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4729 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4731 * Some decoders may support multiple frames in a single AVPacket. Such
4732 * decoders would then just decode the first frame and the return value would be
4733 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4734 * called again with an AVPacket containing the remaining data in order to
4735 * decode the second frame, etc... Even if no frames are returned, the packet
4736 * needs to be fed to the decoder with remaining data until it is completely
4737 * consumed or an error occurs.
4739 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4740 * and output. This means that for some packets they will not immediately
4741 * produce decoded output and need to be flushed at the end of decoding to get
4742 * all the decoded data. Flushing is done by calling this function with packets
4743 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4744 * returning samples. It is safe to flush even those decoders that are not
4745 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4747 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4748 * larger than the actual read bytes because some optimized bitstream
4749 * readers read 32 or 64 bits at once and could read over the end.
4751 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4752 * before packets may be fed to the decoder.
4754 * @param avctx the codec context
4755 * @param[out] frame The AVFrame in which to store decoded audio samples.
4756 * The decoder will allocate a buffer for the decoded frame by
4757 * calling the AVCodecContext.get_buffer2() callback.
4758 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4759 * reference counted and the returned reference belongs to the
4760 * caller. The caller must release the frame using av_frame_unref()
4761 * when the frame is no longer needed. The caller may safely write
4762 * to the frame if av_frame_is_writable() returns 1.
4763 * When AVCodecContext.refcounted_frames is set to 0, the returned
4764 * reference belongs to the decoder and is valid only until the
4765 * next call to this function or until closing or flushing the
4766 * decoder. The caller may not write to it.
4767 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4768 * non-zero. Note that this field being set to zero
4769 * does not mean that an error has occurred. For
4770 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4771 * call is guaranteed to produce a frame.
4772 * @param[in] avpkt The input AVPacket containing the input buffer.
4773 * At least avpkt->data and avpkt->size should be set. Some
4774 * decoders might also require additional fields to be set.
4775 * @return A negative error code is returned if an error occurred during
4776 * decoding, otherwise the number of bytes consumed from the input
4777 * AVPacket is returned.
4779 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4781 attribute_deprecated
4782 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4783 int *got_frame_ptr, const AVPacket *avpkt);
4786 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4787 * Some decoders may support multiple frames in a single AVPacket, such
4788 * decoders would then just decode the first frame.
4790 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4791 * the actual read bytes because some optimized bitstream readers read 32 or 64
4792 * bits at once and could read over the end.
4794 * @warning The end of the input buffer buf should be set to 0 to ensure that
4795 * no overreading happens for damaged MPEG streams.
4797 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4798 * between input and output, these need to be fed with avpkt->data=NULL,
4799 * avpkt->size=0 at the end to return the remaining frames.
4801 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4802 * before packets may be fed to the decoder.
4804 * @param avctx the codec context
4805 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4806 * Use av_frame_alloc() to get an AVFrame. The codec will
4807 * allocate memory for the actual bitmap by calling the
4808 * AVCodecContext.get_buffer2() callback.
4809 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4810 * reference counted and the returned reference belongs to the
4811 * caller. The caller must release the frame using av_frame_unref()
4812 * when the frame is no longer needed. The caller may safely write
4813 * to the frame if av_frame_is_writable() returns 1.
4814 * When AVCodecContext.refcounted_frames is set to 0, the returned
4815 * reference belongs to the decoder and is valid only until the
4816 * next call to this function or until closing or flushing the
4817 * decoder. The caller may not write to it.
4819 * @param[in] avpkt The input AVPacket containing the input buffer.
4820 * You can create such packet with av_init_packet() and by then setting
4821 * data and size, some decoders might in addition need other fields like
4822 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4824 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4825 * @return On error a negative value is returned, otherwise the number of bytes
4826 * used or zero if no frame could be decompressed.
4828 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4830 attribute_deprecated
4831 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4832 int *got_picture_ptr,
4833 const AVPacket *avpkt);
4836 * Decode a subtitle message.
4837 * Return a negative value on error, otherwise return the number of bytes used.
4838 * If no subtitle could be decompressed, got_sub_ptr is zero.
4839 * Otherwise, the subtitle is stored in *sub.
4840 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4841 * simplicity, because the performance difference is expect to be negligible
4842 * and reusing a get_buffer written for video codecs would probably perform badly
4843 * due to a potentially very different allocation pattern.
4845 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4846 * and output. This means that for some packets they will not immediately
4847 * produce decoded output and need to be flushed at the end of decoding to get
4848 * all the decoded data. Flushing is done by calling this function with packets
4849 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4850 * returning subtitles. It is safe to flush even those decoders that are not
4851 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4853 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4854 * before packets may be fed to the decoder.
4856 * @param avctx the codec context
4857 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4858 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4859 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4860 * @param[in] avpkt The input AVPacket containing the input buffer.
4862 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4867 * Supply raw packet data as input to a decoder.
4869 * Internally, this call will copy relevant AVCodecContext fields, which can
4870 * influence decoding per-packet, and apply them when the packet is actually
4871 * decoded. (For example AVCodecContext.skip_frame, which might direct the
4872 * decoder to drop the frame contained by the packet sent with this function.)
4874 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4875 * larger than the actual read bytes because some optimized bitstream
4876 * readers read 32 or 64 bits at once and could read over the end.
4878 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4879 * on the same AVCodecContext. It will return unexpected results now
4880 * or in future libavcodec versions.
4882 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4883 * before packets may be fed to the decoder.
4885 * @param avctx codec context
4886 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4887 * frame, or several complete audio frames.
4888 * Ownership of the packet remains with the caller, and the
4889 * decoder will not write to the packet. The decoder may create
4890 * a reference to the packet data (or copy it if the packet is
4891 * not reference-counted).
4892 * Unlike with older APIs, the packet is always fully consumed,
4893 * and if it contains multiple frames (e.g. some audio codecs),
4894 * will require you to call avcodec_receive_frame() multiple
4895 * times afterwards before you can send a new packet.
4896 * It can be NULL (or an AVPacket with data set to NULL and
4897 * size set to 0); in this case, it is considered a flush
4898 * packet, which signals the end of the stream. Sending the
4899 * first flush packet will return success. Subsequent ones are
4900 * unnecessary and will return AVERROR_EOF. If the decoder
4901 * still has frames buffered, it will return them after sending
4904 * @return 0 on success, otherwise negative error code:
4905 * AVERROR(EAGAIN): input is not accepted right now - the packet must be
4906 * resent after trying to read output
4907 * AVERROR_EOF: the decoder has been flushed, and no new packets can
4908 * be sent to it (also returned if more than 1 flush
4910 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
4911 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4912 * other errors: legitimate decoding errors
4914 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4917 * Return decoded output data from a decoder.
4919 * @param avctx codec context
4920 * @param frame This will be set to a reference-counted video or audio
4921 * frame (depending on the decoder type) allocated by the
4922 * decoder. Note that the function will always call
4923 * av_frame_unref(frame) before doing anything else.
4926 * 0: success, a frame was returned
4927 * AVERROR(EAGAIN): output is not available right now - user must try
4929 * AVERROR_EOF: the decoder has been fully flushed, and there will be
4930 * no more output frames
4931 * AVERROR(EINVAL): codec not opened, or it is an encoder
4932 * other negative values: legitimate decoding errors
4934 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4937 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4938 * to retrieve buffered output packets.
4940 * @param avctx codec context
4941 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4942 * Ownership of the frame remains with the caller, and the
4943 * encoder will not write to the frame. The encoder may create
4944 * a reference to the frame data (or copy it if the frame is
4945 * not reference-counted).
4946 * It can be NULL, in which case it is considered a flush
4947 * packet. This signals the end of the stream. If the encoder
4948 * still has packets buffered, it will return them after this
4949 * call. Once flushing mode has been entered, additional flush
4950 * packets are ignored, and sending frames will return
4954 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4955 * can have any number of samples.
4956 * If it is not set, frame->nb_samples must be equal to
4957 * avctx->frame_size for all frames except the last.
4958 * The final frame may be smaller than avctx->frame_size.
4959 * @return 0 on success, otherwise negative error code:
4960 * AVERROR(EAGAIN): input is not accepted right now - the frame must be
4961 * resent after trying to read output packets
4962 * AVERROR_EOF: the encoder has been flushed, and no new frames can
4964 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
4965 * decoder, or requires flush
4966 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
4967 * other errors: legitimate decoding errors
4969 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4972 * Read encoded data from the encoder.
4974 * @param avctx codec context
4975 * @param avpkt This will be set to a reference-counted packet allocated by the
4976 * encoder. Note that the function will always call
4977 * av_frame_unref(frame) before doing anything else.
4978 * @return 0 on success, otherwise negative error code:
4979 * AVERROR(EAGAIN): output is not available right now - user must try
4981 * AVERROR_EOF: the encoder has been fully flushed, and there will be
4982 * no more output packets
4983 * AVERROR(EINVAL): codec not opened, or it is an encoder
4984 * other errors: legitimate decoding errors
4986 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4990 * @defgroup lavc_parsing Frame parsing
4994 enum AVPictureStructure {
4995 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4996 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4997 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4998 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
5001 typedef struct AVCodecParserContext {
5003 struct AVCodecParser *parser;
5004 int64_t frame_offset; /* offset of the current frame */
5005 int64_t cur_offset; /* current offset
5006 (incremented by each av_parser_parse()) */
5007 int64_t next_frame_offset; /* offset of the next frame */
5009 int pict_type; /* XXX: Put it back in AVCodecContext. */
5011 * This field is used for proper frame duration computation in lavf.
5012 * It signals, how much longer the frame duration of the current frame
5013 * is compared to normal frame duration.
5015 * frame_duration = (1 + repeat_pict) * time_base
5017 * It is used by codecs like H.264 to display telecined material.
5019 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5020 int64_t pts; /* pts of the current frame */
5021 int64_t dts; /* dts of the current frame */
5026 int fetch_timestamp;
5028 #define AV_PARSER_PTS_NB 4
5029 int cur_frame_start_index;
5030 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5031 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5032 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5035 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
5036 #define PARSER_FLAG_ONCE 0x0002
5037 /// Set if the parser has a valid file offset
5038 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
5039 #define PARSER_FLAG_USE_CODEC_TS 0x1000
5041 int64_t offset; ///< byte offset from starting packet start
5042 int64_t cur_frame_end[AV_PARSER_PTS_NB];
5045 * Set by parser to 1 for key frames and 0 for non-key frames.
5046 * It is initialized to -1, so if the parser doesn't set this flag,
5047 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5052 #if FF_API_CONVERGENCE_DURATION
5054 * @deprecated unused
5056 attribute_deprecated
5057 int64_t convergence_duration;
5060 // Timestamp generation support:
5062 * Synchronization point for start of timestamp generation.
5064 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5067 * For example, this corresponds to presence of H.264 buffering period
5073 * Offset of the current timestamp against last timestamp sync point in
5074 * units of AVCodecContext.time_base.
5076 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5077 * contain a valid timestamp offset.
5079 * Note that the timestamp of sync point has usually a nonzero
5080 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5081 * the next frame after timestamp sync point will be usually 1.
5083 * For example, this corresponds to H.264 cpb_removal_delay.
5085 int dts_ref_dts_delta;
5088 * Presentation delay of current frame in units of AVCodecContext.time_base.
5090 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5091 * contain valid non-negative timestamp delta (presentation time of a frame
5092 * must not lie in the past).
5094 * This delay represents the difference between decoding and presentation
5095 * time of the frame.
5097 * For example, this corresponds to H.264 dpb_output_delay.
5102 * Position of the packet in file.
5104 * Analogous to cur_frame_pts/dts
5106 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5109 * Byte position of currently parsed frame in stream.
5114 * Previous frame byte position.
5119 * Duration of the current frame.
5120 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5121 * For all other types, this is in units of AVCodecContext.time_base.
5125 enum AVFieldOrder field_order;
5128 * Indicate whether a picture is coded as a frame, top field or bottom field.
5130 * For example, H.264 field_pic_flag equal to 0 corresponds to
5131 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5132 * equal to 1 and bottom_field_flag equal to 0 corresponds to
5133 * AV_PICTURE_STRUCTURE_TOP_FIELD.
5135 enum AVPictureStructure picture_structure;
5138 * Picture number incremented in presentation or output order.
5139 * This field may be reinitialized at the first picture of a new sequence.
5141 * For example, this corresponds to H.264 PicOrderCnt.
5143 int output_picture_number;
5146 * Dimensions of the decoded video intended for presentation.
5152 * Dimensions of the coded video.
5158 * The format of the coded data, corresponds to enum AVPixelFormat for video
5159 * and for enum AVSampleFormat for audio.
5161 * Note that a decoder can have considerable freedom in how exactly it
5162 * decodes the data, so the format reported here might be different from the
5163 * one returned by a decoder.
5166 } AVCodecParserContext;
5168 typedef struct AVCodecParser {
5169 int codec_ids[5]; /* several codec IDs are permitted */
5171 int (*parser_init)(AVCodecParserContext *s);
5172 /* This callback never returns an error, a negative value means that
5173 * the frame start was in a previous packet. */
5174 int (*parser_parse)(AVCodecParserContext *s,
5175 AVCodecContext *avctx,
5176 const uint8_t **poutbuf, int *poutbuf_size,
5177 const uint8_t *buf, int buf_size);
5178 void (*parser_close)(AVCodecParserContext *s);
5179 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5180 struct AVCodecParser *next;
5183 AVCodecParser *av_parser_next(const AVCodecParser *c);
5185 void av_register_codec_parser(AVCodecParser *parser);
5186 AVCodecParserContext *av_parser_init(int codec_id);
5191 * @param s parser context.
5192 * @param avctx codec context.
5193 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
5194 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
5195 * @param buf input buffer.
5196 * @param buf_size buffer size in bytes without the padding. I.e. the full buffer
5197 size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5198 To signal EOF, this should be 0 (so that the last frame
5200 * @param pts input presentation timestamp.
5201 * @param dts input decoding timestamp.
5202 * @param pos input byte position in stream.
5203 * @return the number of bytes of the input bitstream used.
5208 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5215 * decode_frame(data, size);
5219 int av_parser_parse2(AVCodecParserContext *s,
5220 AVCodecContext *avctx,
5221 uint8_t **poutbuf, int *poutbuf_size,
5222 const uint8_t *buf, int buf_size,
5223 int64_t pts, int64_t dts,
5227 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5228 * @deprecated use AVBitStreamFilter
5230 int av_parser_change(AVCodecParserContext *s,
5231 AVCodecContext *avctx,
5232 uint8_t **poutbuf, int *poutbuf_size,
5233 const uint8_t *buf, int buf_size, int keyframe);
5234 void av_parser_close(AVCodecParserContext *s);
5242 * @addtogroup lavc_encoding
5247 * Find a registered encoder with a matching codec ID.
5249 * @param id AVCodecID of the requested encoder
5250 * @return An encoder if one was found, NULL otherwise.
5252 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5255 * Find a registered encoder with the specified name.
5257 * @param name name of the requested encoder
5258 * @return An encoder if one was found, NULL otherwise.
5260 AVCodec *avcodec_find_encoder_by_name(const char *name);
5263 * Encode a frame of audio.
5265 * Takes input samples from frame and writes the next output packet, if
5266 * available, to avpkt. The output packet does not necessarily contain data for
5267 * the most recent frame, as encoders can delay, split, and combine input frames
5268 * internally as needed.
5270 * @param avctx codec context
5271 * @param avpkt output AVPacket.
5272 * The user can supply an output buffer by setting
5273 * avpkt->data and avpkt->size prior to calling the
5274 * function, but if the size of the user-provided data is not
5275 * large enough, encoding will fail. If avpkt->data and
5276 * avpkt->size are set, avpkt->destruct must also be set. All
5277 * other AVPacket fields will be reset by the encoder using
5278 * av_init_packet(). If avpkt->data is NULL, the encoder will
5279 * allocate it. The encoder will set avpkt->size to the size
5280 * of the output packet.
5282 * If this function fails or produces no output, avpkt will be
5283 * freed using av_packet_unref().
5284 * @param[in] frame AVFrame containing the raw audio data to be encoded.
5285 * May be NULL when flushing an encoder that has the
5286 * AV_CODEC_CAP_DELAY capability set.
5287 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5288 * can have any number of samples.
5289 * If it is not set, frame->nb_samples must be equal to
5290 * avctx->frame_size for all frames except the last.
5291 * The final frame may be smaller than avctx->frame_size.
5292 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5293 * output packet is non-empty, and to 0 if it is
5294 * empty. If the function returns an error, the
5295 * packet can be assumed to be invalid, and the
5296 * value of got_packet_ptr is undefined and should
5298 * @return 0 on success, negative error code on failure
5300 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5302 attribute_deprecated
5303 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5304 const AVFrame *frame, int *got_packet_ptr);
5307 * Encode a frame of video.
5309 * Takes input raw video data from frame and writes the next output packet, if
5310 * available, to avpkt. The output packet does not necessarily contain data for
5311 * the most recent frame, as encoders can delay and reorder input frames
5312 * internally as needed.
5314 * @param avctx codec context
5315 * @param avpkt output AVPacket.
5316 * The user can supply an output buffer by setting
5317 * avpkt->data and avpkt->size prior to calling the
5318 * function, but if the size of the user-provided data is not
5319 * large enough, encoding will fail. All other AVPacket fields
5320 * will be reset by the encoder using av_init_packet(). If
5321 * avpkt->data is NULL, the encoder will allocate it.
5322 * The encoder will set avpkt->size to the size of the
5323 * output packet. The returned data (if any) belongs to the
5324 * caller, he is responsible for freeing it.
5326 * If this function fails or produces no output, avpkt will be
5327 * freed using av_packet_unref().
5328 * @param[in] frame AVFrame containing the raw video data to be encoded.
5329 * May be NULL when flushing an encoder that has the
5330 * AV_CODEC_CAP_DELAY capability set.
5331 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5332 * output packet is non-empty, and to 0 if it is
5333 * empty. If the function returns an error, the
5334 * packet can be assumed to be invalid, and the
5335 * value of got_packet_ptr is undefined and should
5337 * @return 0 on success, negative error code on failure
5339 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5341 attribute_deprecated
5342 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5343 const AVFrame *frame, int *got_packet_ptr);
5345 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5346 const AVSubtitle *sub);
5353 #if FF_API_AVCODEC_RESAMPLE
5355 * @defgroup lavc_resample Audio resampling
5357 * @deprecated use libswresample instead
5361 struct ReSampleContext;
5362 struct AVResampleContext;
5364 typedef struct ReSampleContext ReSampleContext;
5367 * Initialize audio resampling context.
5369 * @param output_channels number of output channels
5370 * @param input_channels number of input channels
5371 * @param output_rate output sample rate
5372 * @param input_rate input sample rate
5373 * @param sample_fmt_out requested output sample format
5374 * @param sample_fmt_in input sample format
5375 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
5376 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5377 * @param linear if 1 then the used FIR filter will be linearly interpolated
5378 between the 2 closest, if 0 the closest will be used
5379 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5380 * @return allocated ReSampleContext, NULL if error occurred
5382 attribute_deprecated
5383 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5384 int output_rate, int input_rate,
5385 enum AVSampleFormat sample_fmt_out,
5386 enum AVSampleFormat sample_fmt_in,
5387 int filter_length, int log2_phase_count,
5388 int linear, double cutoff);
5390 attribute_deprecated
5391 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5394 * Free resample context.
5396 * @param s a non-NULL pointer to a resample context previously
5397 * created with av_audio_resample_init()
5399 attribute_deprecated
5400 void audio_resample_close(ReSampleContext *s);
5404 * Initialize an audio resampler.
5405 * Note, if either rate is not an integer then simply scale both rates up so they are.
5406 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5407 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5408 * @param linear If 1 then the used FIR filter will be linearly interpolated
5409 between the 2 closest, if 0 the closest will be used
5410 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5412 attribute_deprecated
5413 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5416 * Resample an array of samples using a previously configured context.
5417 * @param src an array of unconsumed samples
5418 * @param consumed the number of samples of src which have been consumed are returned here
5419 * @param src_size the number of unconsumed samples available
5420 * @param dst_size the amount of space in samples available in dst
5421 * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
5422 * @return the number of samples written in dst or -1 if an error occurred
5424 attribute_deprecated
5425 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5429 * Compensate samplerate/timestamp drift. The compensation is done by changing
5430 * the resampler parameters, so no audible clicks or similar distortions occur
5431 * @param compensation_distance distance in output samples over which the compensation should be performed
5432 * @param sample_delta number of output samples which should be output less
5434 * example: av_resample_compensate(c, 10, 500)
5435 * here instead of 510 samples only 500 samples would be output
5437 * note, due to rounding the actual compensation might be slightly different,
5438 * especially if the compensation_distance is large and the in_rate used during init is small
5440 attribute_deprecated
5441 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5442 attribute_deprecated
5443 void av_resample_close(struct AVResampleContext *c);
5450 #if FF_API_AVPICTURE
5452 * @addtogroup lavc_picture
5457 * @deprecated unused
5459 attribute_deprecated
5460 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5463 * @deprecated unused
5465 attribute_deprecated
5466 void avpicture_free(AVPicture *picture);
5469 * @deprecated use av_image_fill_arrays() instead.
5471 attribute_deprecated
5472 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5473 enum AVPixelFormat pix_fmt, int width, int height);
5476 * @deprecated use av_image_copy_to_buffer() instead.
5478 attribute_deprecated
5479 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5480 int width, int height,
5481 unsigned char *dest, int dest_size);
5484 * @deprecated use av_image_get_buffer_size() instead.
5486 attribute_deprecated
5487 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5490 * @deprecated av_image_copy() instead.
5492 attribute_deprecated
5493 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5494 enum AVPixelFormat pix_fmt, int width, int height);
5497 * @deprecated unused
5499 attribute_deprecated
5500 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5501 enum AVPixelFormat pix_fmt, int top_band, int left_band);
5504 * @deprecated unused
5506 attribute_deprecated
5507 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5508 int padtop, int padbottom, int padleft, int padright, int *color);
5516 * @defgroup lavc_misc Utility functions
5519 * Miscellaneous utility functions related to both encoding and decoding
5525 * @defgroup lavc_misc_pixfmt Pixel formats
5527 * Functions for working with pixel formats.
5532 * Utility function to access log2_chroma_w log2_chroma_h from
5533 * the pixel format AVPixFmtDescriptor.
5535 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5536 * for one that returns a failure code and continues in case of invalid
5539 * @param[in] pix_fmt the pixel format
5540 * @param[out] h_shift store log2_chroma_w
5541 * @param[out] v_shift store log2_chroma_h
5543 * @see av_pix_fmt_get_chroma_sub_sample
5546 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5549 * Return a value representing the fourCC code associated to the
5550 * pixel format pix_fmt, or 0 if no associated fourCC code can be
5553 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5556 * @deprecated see av_get_pix_fmt_loss()
5558 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5562 * Find the best pixel format to convert to given a certain source pixel
5563 * format. When converting from one pixel format to another, information loss
5564 * may occur. For example, when converting from RGB24 to GRAY, the color
5565 * information will be lost. Similarly, other losses occur when converting from
5566 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5567 * the given pixel formats should be used to suffer the least amount of loss.
5568 * The pixel formats from which it chooses one, are determined by the
5569 * pix_fmt_list parameter.
5572 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5573 * @param[in] src_pix_fmt source pixel format
5574 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5575 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5576 * @return The best pixel format to convert to or -1 if none was found.
5578 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5579 enum AVPixelFormat src_pix_fmt,
5580 int has_alpha, int *loss_ptr);
5583 * @deprecated see av_find_best_pix_fmt_of_2()
5585 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5586 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5588 attribute_deprecated
5589 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5590 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5592 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5598 #if FF_API_SET_DIMENSIONS
5600 * @deprecated this function is not supposed to be used from outside of lavc
5602 attribute_deprecated
5603 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5607 * Put a string representing the codec tag codec_tag in buf.
5609 * @param buf buffer to place codec tag in
5610 * @param buf_size size in bytes of buf
5611 * @param codec_tag codec tag to assign
5612 * @return the length of the string that would have been generated if
5613 * enough space had been available, excluding the trailing null
5615 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5617 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5620 * Return a name for the specified profile, if available.
5622 * @param codec the codec that is searched for the given profile
5623 * @param profile the profile value for which a name is requested
5624 * @return A name for the profile if found, NULL otherwise.
5626 const char *av_get_profile_name(const AVCodec *codec, int profile);
5629 * Return a name for the specified profile, if available.
5631 * @param codec_id the ID of the codec to which the requested profile belongs
5632 * @param profile the profile value for which a name is requested
5633 * @return A name for the profile if found, NULL otherwise.
5635 * @note unlike av_get_profile_name(), which searches a list of profiles
5636 * supported by a specific decoder or encoder implementation, this
5637 * function searches the list of profiles from the AVCodecDescriptor
5639 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5641 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5642 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5643 //FIXME func typedef
5646 * Fill AVFrame audio data and linesize pointers.
5648 * The buffer buf must be a preallocated buffer with a size big enough
5649 * to contain the specified samples amount. The filled AVFrame data
5650 * pointers will point to this buffer.
5652 * AVFrame extended_data channel pointers are allocated if necessary for
5655 * @param frame the AVFrame
5656 * frame->nb_samples must be set prior to calling the
5657 * function. This function fills in frame->data,
5658 * frame->extended_data, frame->linesize[0].
5659 * @param nb_channels channel count
5660 * @param sample_fmt sample format
5661 * @param buf buffer to use for frame data
5662 * @param buf_size size of buffer
5663 * @param align plane size sample alignment (0 = default)
5664 * @return >=0 on success, negative error code on failure
5665 * @todo return the size in bytes required to store the samples in
5666 * case of success, at the next libavutil bump
5668 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5669 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5670 int buf_size, int align);
5673 * Reset the internal decoder state / flush internal buffers. Should be called
5674 * e.g. when seeking or when switching to a different stream.
5676 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5677 * this invalidates the frames previously returned from the decoder. When
5678 * refcounted frames are used, the decoder just releases any references it might
5679 * keep internally, but the caller's reference remains valid.
5681 void avcodec_flush_buffers(AVCodecContext *avctx);
5684 * Return codec bits per sample.
5686 * @param[in] codec_id the codec
5687 * @return Number of bits per sample or zero if unknown for the given codec.
5689 int av_get_bits_per_sample(enum AVCodecID codec_id);
5692 * Return the PCM codec associated with a sample format.
5693 * @param be endianness, 0 for little, 1 for big,
5694 * -1 (or anything else) for native
5695 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5697 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5700 * Return codec bits per sample.
5701 * Only return non-zero if the bits per sample is exactly correct, not an
5704 * @param[in] codec_id the codec
5705 * @return Number of bits per sample or zero if unknown for the given codec.
5707 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5710 * Return audio frame duration.
5712 * @param avctx codec context
5713 * @param frame_bytes size of the frame, or 0 if unknown
5714 * @return frame duration, in samples, if known. 0 if not able to
5717 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5720 * This function is the same as av_get_audio_frame_duration(), except it works
5721 * with AVCodecParameters instead of an AVCodecContext.
5723 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5726 typedef struct AVBitStreamFilterContext {
5728 struct AVBitStreamFilter *filter;
5729 AVCodecParserContext *parser;
5730 struct AVBitStreamFilterContext *next;
5732 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5733 * Not for access by library users.
5736 } AVBitStreamFilterContext;
5739 typedef struct AVBSFInternal AVBSFInternal;
5742 * The bitstream filter state.
5744 * This struct must be allocated with av_bsf_alloc() and freed with
5747 * The fields in the struct will only be changed (by the caller or by the
5748 * filter) as described in their documentation, and are to be considered
5749 * immutable otherwise.
5751 typedef struct AVBSFContext {
5753 * A class for logging and AVOptions
5755 const AVClass *av_class;
5758 * The bitstream filter this context is an instance of.
5760 const struct AVBitStreamFilter *filter;
5763 * Opaque libavcodec internal data. Must not be touched by the caller in any
5766 AVBSFInternal *internal;
5769 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5770 * this is an AVOptions-enabled struct.
5775 * Parameters of the input stream. Set by the caller before av_bsf_init().
5777 AVCodecParameters *par_in;
5780 * Parameters of the output stream. Set by the filter in av_bsf_init().
5782 AVCodecParameters *par_out;
5785 * The timebase used for the timestamps of the input packets. Set by the
5786 * caller before av_bsf_init().
5788 AVRational time_base_in;
5791 * The timebase used for the timestamps of the output packets. Set by the
5792 * filter in av_bsf_init().
5794 AVRational time_base_out;
5797 typedef struct AVBitStreamFilter {
5801 * A list of codec ids supported by the filter, terminated by
5803 * May be NULL, in that case the bitstream filter works with any codec id.
5805 const enum AVCodecID *codec_ids;
5808 * A class for the private data, used to declare bitstream filter private
5809 * AVOptions. This field is NULL for bitstream filters that do not declare
5812 * If this field is non-NULL, the first member of the filter private data
5813 * must be a pointer to AVClass, which will be set by libavcodec generic
5814 * code to this class.
5816 const AVClass *priv_class;
5818 /*****************************************************************
5819 * No fields below this line are part of the public API. They
5820 * may not be used outside of libavcodec and can be changed and
5822 * New public fields should be added right above.
5823 *****************************************************************
5827 int (*init)(AVBSFContext *ctx);
5828 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5829 void (*close)(AVBSFContext *ctx);
5830 } AVBitStreamFilter;
5834 * Register a bitstream filter.
5836 * The filter will be accessible to the application code through
5837 * av_bitstream_filter_next() or can be directly initialized with
5838 * av_bitstream_filter_init().
5840 * @see avcodec_register_all()
5842 attribute_deprecated
5843 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5846 * Create and initialize a bitstream filter context given a bitstream
5849 * The returned context must be freed with av_bitstream_filter_close().
5851 * @param name the name of the bitstream filter
5852 * @return a bitstream filter context if a matching filter was found
5853 * and successfully initialized, NULL otherwise
5855 attribute_deprecated
5856 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5861 * This function filters the buffer buf with size buf_size, and places the
5862 * filtered buffer in the buffer pointed to by poutbuf.
5864 * The output buffer must be freed by the caller.
5866 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5867 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5868 * If specified, this must point to the encoder context of the
5869 * output stream the packet is sent to.
5870 * @param args arguments which specify the filter configuration, may be NULL
5871 * @param poutbuf pointer which is updated to point to the filtered buffer
5872 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5873 * @param buf buffer containing the data to filter
5874 * @param buf_size size in bytes of buf
5875 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5876 * @return >= 0 in case of success, or a negative error code in case of failure
5878 * If the return value is positive, an output buffer is allocated and
5879 * is available in *poutbuf, and is distinct from the input buffer.
5881 * If the return value is 0, the output buffer is not allocated and
5882 * should be considered identical to the input buffer, or in case
5883 * *poutbuf was set it points to the input buffer (not necessarily to
5884 * its starting address). A special case is if *poutbuf was set to NULL and
5885 * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5887 attribute_deprecated
5888 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5889 AVCodecContext *avctx, const char *args,
5890 uint8_t **poutbuf, int *poutbuf_size,
5891 const uint8_t *buf, int buf_size, int keyframe);
5894 * Release bitstream filter context.
5896 * @param bsf the bitstream filter context created with
5897 * av_bitstream_filter_init(), can be NULL
5899 attribute_deprecated
5900 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5903 * If f is NULL, return the first registered bitstream filter,
5904 * if f is non-NULL, return the next registered bitstream filter
5905 * after f, or NULL if f is the last one.
5907 * This function can be used to iterate over all registered bitstream
5910 attribute_deprecated
5911 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5915 * @return a bitstream filter with the specified name or NULL if no such
5916 * bitstream filter exists.
5918 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5921 * Iterate over all registered bitstream filters.
5923 * @param opaque a pointer where libavcodec will store the iteration state. Must
5924 * point to NULL to start the iteration.
5926 * @return the next registered bitstream filter or NULL when the iteration is
5929 const AVBitStreamFilter *av_bsf_next(void **opaque);
5932 * Allocate a context for a given bitstream filter. The caller must fill in the
5933 * context parameters as described in the documentation and then call
5934 * av_bsf_init() before sending any data to the filter.
5936 * @param filter the filter for which to allocate an instance.
5937 * @param ctx a pointer into which the pointer to the newly-allocated context
5938 * will be written. It must be freed with av_bsf_free() after the
5939 * filtering is done.
5941 * @return 0 on success, a negative AVERROR code on failure
5943 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5946 * Prepare the filter for use, after all the parameters and options have been
5949 int av_bsf_init(AVBSFContext *ctx);
5952 * Submit a packet for filtering.
5954 * After sending each packet, the filter must be completely drained by calling
5955 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5958 * @param pkt the packet to filter. pkt must contain some payload (i.e data or
5959 * side data must be present in pkt). The bitstream filter will take ownership of
5960 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5961 * This parameter may be NULL, which signals the end of the stream (i.e. no more
5962 * packets will be sent). That will cause the filter to output any packets it
5963 * may have buffered internally.
5965 * @return 0 on success, a negative AVERROR on error.
5967 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5970 * Retrieve a filtered packet.
5972 * @param[out] pkt this struct will be filled with the contents of the filtered
5973 * packet. It is owned by the caller and must be freed using
5974 * av_packet_unref() when it is no longer needed.
5975 * This parameter should be "clean" (i.e. freshly allocated
5976 * with av_packet_alloc() or unreffed with av_packet_unref())
5977 * when this function is called. If this function returns
5978 * successfully, the contents of pkt will be completely
5979 * overwritten by the returned data. On failure, pkt is not
5982 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5983 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5984 * will be no further output from the filter. Another negative AVERROR value if
5987 * @note one input packet may result in several output packets, so after sending
5988 * a packet with av_bsf_send_packet(), this function needs to be called
5989 * repeatedly until it stops returning 0. It is also possible for a filter to
5990 * output fewer packets than were sent to it, so this function may return
5991 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5993 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5996 * Free a bitstream filter context and everything associated with it; write NULL
5997 * into the supplied pointer.
5999 void av_bsf_free(AVBSFContext **ctx);
6002 * Get the AVClass for AVBSFContext. It can be used in combination with
6003 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6005 * @see av_opt_find().
6007 const AVClass *av_bsf_get_class(void);
6010 * Structure for chain/list of bitstream filters.
6011 * Empty list can be allocated by av_bsf_list_alloc().
6013 typedef struct AVBSFList AVBSFList;
6016 * Allocate empty list of bitstream filters.
6017 * The list must be later freed by av_bsf_list_free()
6018 * or finalized by av_bsf_list_finalize().
6020 * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6022 AVBSFList *av_bsf_list_alloc(void);
6025 * Free list of bitstream filters.
6027 * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6029 void av_bsf_list_free(AVBSFList **lst);
6032 * Append bitstream filter to the list of bitstream filters.
6034 * @param lst List to append to
6035 * @param bsf Filter context to be appended
6037 * @return >=0 on success, negative AVERROR in case of failure
6039 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6042 * Construct new bitstream filter context given it's name and options
6043 * and append it to the list of bitstream filters.
6045 * @param lst List to append to
6046 * @param bsf_name Name of the bitstream filter
6047 * @param options Options for the bitstream filter, can be set to NULL
6049 * @return >=0 on success, negative AVERROR in case of failure
6051 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6053 * Finalize list of bitstream filters.
6055 * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6056 * so the whole chain of bitstream filters can be treated as single filter
6057 * freshly allocated by av_bsf_alloc().
6058 * If the call is successful, @ref AVBSFList structure is freed and lst
6059 * will be set to NULL. In case of failure, caller is responsible for
6060 * freeing the structure by av_bsf_list_free()
6062 * @param lst Filter list structure to be transformed
6063 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6064 * representing the chain of bitstream filters
6066 * @return >=0 on success, negative AVERROR in case of failure
6068 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6071 * Parse string describing list of bitstream filters and create single
6072 * @ref AVBSFContext describing the whole chain of bitstream filters.
6073 * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6074 * allocated by av_bsf_alloc().
6076 * @param str String describing chain of bitstream filters in format
6077 * `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6078 * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6079 * representing the chain of bitstream filters
6081 * @return >=0 on success, negative AVERROR in case of failure
6083 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6086 * Get null/pass-through bitstream filter.
6088 * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6092 int av_bsf_get_null_filter(AVBSFContext **bsf);
6097 * Same behaviour av_fast_malloc but the buffer has additional
6098 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6100 * In addition the whole buffer will initially and after resizes
6101 * be 0-initialized so that no uninitialized data will ever appear.
6103 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6106 * Same behaviour av_fast_padded_malloc except that buffer will always
6107 * be 0-initialized after call.
6109 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6112 * Encode extradata length to a buffer. Used by xiph codecs.
6114 * @param s buffer to write to; must be at least (v/255+1) bytes long
6115 * @param v size of extradata in bytes
6116 * @return number of bytes written to the buffer.
6118 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6120 #if FF_API_MISSING_SAMPLE
6122 * Log a generic warning message about a missing feature. This function is
6123 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6124 * only, and would normally not be used by applications.
6125 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6126 * a pointer to an AVClass struct
6127 * @param[in] feature string containing the name of the missing feature
6128 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
6129 * If want_sample is non-zero, additional verbiage will be added to the log
6130 * message which tells the user how to report samples to the development
6132 * @deprecated Use avpriv_report_missing_feature() instead.
6134 attribute_deprecated
6135 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
6138 * Log a generic warning message asking for a sample. This function is
6139 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
6140 * only, and would normally not be used by applications.
6141 * @param[in] avc a pointer to an arbitrary struct of which the first field is
6142 * a pointer to an AVClass struct
6143 * @param[in] msg string containing an optional message, or NULL if no message
6144 * @deprecated Use avpriv_request_sample() instead.
6146 attribute_deprecated
6147 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
6148 #endif /* FF_API_MISSING_SAMPLE */
6151 * Register the hardware accelerator hwaccel.
6153 void av_register_hwaccel(AVHWAccel *hwaccel);
6156 * If hwaccel is NULL, returns the first registered hardware accelerator,
6157 * if hwaccel is non-NULL, returns the next registered hardware accelerator
6158 * after hwaccel, or NULL if hwaccel is the last one.
6160 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6164 * Lock operation used by lockmgr
6167 AV_LOCK_CREATE, ///< Create a mutex
6168 AV_LOCK_OBTAIN, ///< Lock the mutex
6169 AV_LOCK_RELEASE, ///< Unlock the mutex
6170 AV_LOCK_DESTROY, ///< Free mutex resources
6174 * Register a user provided lock manager supporting the operations
6175 * specified by AVLockOp. The "mutex" argument to the function points
6176 * to a (void *) where the lockmgr should store/get a pointer to a user
6177 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6178 * value left by the last call for all other ops. If the lock manager is
6179 * unable to perform the op then it should leave the mutex in the same
6180 * state as when it was called and return a non-zero value. However,
6181 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6182 * have been successfully destroyed. If av_lockmgr_register succeeds
6183 * it will return a non-negative value, if it fails it will return a
6184 * negative value and destroy all mutex and unregister all callbacks.
6185 * av_lockmgr_register is not thread-safe, it must be called from a
6186 * single thread before any calls which make use of locking are used.
6188 * @param cb User defined callback. av_lockmgr_register invokes calls
6189 * to this callback and the previously registered callback.
6190 * The callback will be used to create more than one mutex
6191 * each of which must be backed by its own underlying locking
6192 * mechanism (i.e. do not use a single static object to
6193 * implement your lock manager). If cb is set to NULL the
6194 * lockmgr will be unregistered.
6196 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6199 * Get the type of the given codec.
6201 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6204 * Get the name of a codec.
6205 * @return a static string identifying the codec; never NULL
6207 const char *avcodec_get_name(enum AVCodecID id);
6210 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6211 * with no corresponding avcodec_close()), 0 otherwise.
6213 int avcodec_is_open(AVCodecContext *s);
6216 * @return a non-zero number if codec is an encoder, zero otherwise
6218 int av_codec_is_encoder(const AVCodec *codec);
6221 * @return a non-zero number if codec is a decoder, zero otherwise
6223 int av_codec_is_decoder(const AVCodec *codec);
6226 * @return descriptor for given codec ID or NULL if no descriptor exists.
6228 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6231 * Iterate over all codec descriptors known to libavcodec.
6233 * @param prev previous descriptor. NULL to get the first descriptor.
6235 * @return next descriptor or NULL after the last descriptor
6237 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6240 * @return codec descriptor with the given name or NULL if no such descriptor
6243 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6246 * Allocate a CPB properties structure and initialize its fields to default
6249 * @param size if non-NULL, the size of the allocated struct will be written
6250 * here. This is useful for embedding it in side data.
6252 * @return the newly allocated struct or NULL on failure
6254 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6260 #endif /* AVCODEC_AVCODEC_H */