2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav 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 * Libav 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 Libav; 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/dict.h"
37 #include "libavutil/frame.h"
38 #include "libavutil/log.h"
39 #include "libavutil/pixfmt.h"
40 #include "libavutil/rational.h"
45 * @defgroup libavc Encoding/Decoding Library
48 * @defgroup lavc_decoding Decoding
52 * @defgroup lavc_encoding Encoding
56 * @defgroup lavc_codec Codecs
58 * @defgroup lavc_codec_native Native Codecs
61 * @defgroup lavc_codec_wrappers External library wrappers
64 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
68 * @defgroup lavc_internal Internal
76 * @defgroup lavc_encdec send/receive encoding and decoding API overview
79 * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
80 * avcodec_receive_packet() functions provide an encode/decode API, which
81 * decouples input and output.
83 * The API is very similar for encoding/decoding and audio/video, and works as
85 * - Set up and open the AVCodecContext as usual.
87 * - For decoding, call avcodec_send_packet() to give the decoder raw
88 * compressed data in an AVPacket.
89 * - For encoding, call avcodec_send_frame() to give the decoder an AVFrame
90 * containing uncompressed audio or video.
91 * In both cases, it is recommended that AVPackets and AVFrames are
92 * refcounted, or libavcodec might have to copy the input data. (libavformat
93 * always returns refcounted AVPackets, and av_frame_get_buffer() allocates
94 * refcounted AVFrames.)
95 * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
96 * functions and process their output:
97 * - For decoding, call avcodec_receive_frame(). On success, it will return
98 * an AVFrame containing uncompressed audio or video data.
99 * - For encoding, call avcodec_receive_packet(). On success, it will return
100 * an AVPacket with a compressed frame.
101 * Repeat this call until it returns AVERROR(EAGAIN) or an error. The
102 * AVERROR(EAGAIN) return value means that new input data is required to
103 * return new output. In this case, continue with sending input. For each
104 * input frame/packet, the codec will typically return 1 output frame/packet,
105 * but it can also be 0 or more than 1.
107 * At the beginning of decoding or encoding, the codec might accept multiple
108 * input frames/packets without returning a frame, until its internal buffers
109 * are filled. This situation is handled transparently if you follow the steps
112 * In theory, sending input can result in EAGAIN - this should happen only if
113 * not all output was received. You can use this to structure alternative decode
114 * or encode loops other than the one suggested above. For example, you could
115 * try sending new input on each iteration, and try to receive output if that
118 * End of stream situations. These require "flushing" (aka draining) the codec,
119 * as the codec might buffer multiple frames or packets internally for
120 * performance or out of necessity (consider B-frames).
121 * This is handled as follows:
122 * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
123 * or avcodec_send_frame() (encoding) functions. This will enter draining
125 * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
126 * (encoding) in a loop until AVERROR_EOF is returned. The functions will
127 * not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
128 * - Before decoding can be resumed again, the codec has to be reset with
129 * avcodec_flush_buffers().
131 * Using the API as outlined above is highly recommended. But it is also
132 * possible to call functions outside of this rigid schema. For example, you can
133 * call avcodec_send_packet() repeatedly without calling
134 * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
135 * until the codec's internal buffer has been filled up (which is typically of
136 * size 1 per output frame, after initial input), and then reject input with
137 * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
138 * read at least some output.
140 * Not all codecs will follow a rigid and predictable dataflow; the only
141 * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
142 * one end implies that a receive/send call on the other end will succeed. In
143 * general, no codec will permit unlimited buffering of input or output.
145 * This API replaces the following legacy functions:
146 * - avcodec_decode_video2() and avcodec_decode_audio4():
147 * Use avcodec_send_packet() to feed input to the decoder, then use
148 * avcodec_receive_frame() to receive decoded frames after each packet.
149 * Unlike with the old video decoding API, multiple frames might result from
150 * a packet. For audio, splitting the input packet into frames by partially
151 * decoding packets becomes transparent to the API user. You never need to
152 * feed an AVPacket to the API twice (unless it is rejected with EAGAIN - then
153 * no data was read from the packet).
154 * Additionally, sending a flush/draining packet is required only once.
155 * - avcodec_encode_video2()/avcodec_encode_audio2():
156 * Use avcodec_send_frame() to feed input to the encoder, then use
157 * avcodec_receive_packet() to receive encoded packets.
158 * Providing user-allocated buffers for avcodec_receive_packet() is not
160 * - The new API does not handle subtitles yet.
162 * Mixing new and old function calls on the same AVCodecContext is not allowed,
163 * and will result in arbitrary behavior.
165 * Some codecs might require using the new API; using the old API will return
166 * an error when calling it. All codecs support the new API.
168 * A codec is not allowed to return EAGAIN for both sending and receiving. This
169 * would be an invalid state, which could put the codec user into an endless
170 * loop. The API has no concept of time either: it cannot happen that trying to
171 * do avcodec_send_packet() results in EAGAIN, but a repeated call 1 second
172 * later accepts the packet (with no other receive/flush API calls involved).
173 * The API is a strict state machine, and the passage of time is not supposed
174 * to influence it. Some timing-dependent behavior might still be deemed
175 * acceptable in certain cases. But it must never result in both send/receive
176 * returning EAGAIN at the same time at any point. It must also absolutely be
177 * avoided that the current state is "unstable" and can "flip-flop" between
178 * the send/receive APIs allowing progress. For example, it's not allowed that
179 * the codec randomly decides that it actually wants to consume a packet now
180 * instead of returning a frame, after it just returned EAGAIN on an
181 * avcodec_send_packet() call.
186 * @defgroup lavc_core Core functions/structures.
189 * Basic definitions, functions for querying libavcodec capabilities,
190 * allocating core structures, etc.
196 * Identify the syntax and semantics of the bitstream.
197 * The principle is roughly:
198 * Two decoders with the same ID can decode the same streams.
199 * Two encoders with the same ID can encode compatible streams.
200 * There may be slight deviations from the principle due to implementation
203 * If you add a codec ID to this list, add it so that
204 * 1. no value of a existing codec ID changes (that would break ABI),
205 * 2. it is as close as possible to similar codecs.
207 * After adding new codec IDs, do not forget to add an entry to the codec
208 * descriptor list and bump libavcodec minor version.
214 AV_CODEC_ID_MPEG1VIDEO,
215 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
226 AV_CODEC_ID_RAWVIDEO,
227 AV_CODEC_ID_MSMPEG4V1,
228 AV_CODEC_ID_MSMPEG4V2,
229 AV_CODEC_ID_MSMPEG4V3,
252 AV_CODEC_ID_INTERPLAY_VIDEO,
259 AV_CODEC_ID_MSVIDEO1,
264 AV_CODEC_ID_TRUEMOTION1,
265 AV_CODEC_ID_VMDVIDEO,
290 AV_CODEC_ID_TRUEMOTION2,
296 AV_CODEC_ID_SMACKVIDEO,
301 AV_CODEC_ID_JPEG2000,
307 AV_CODEC_ID_DSICINVIDEO,
308 AV_CODEC_ID_TIERTEXSEQVIDEO,
316 AV_CODEC_ID_BETHSOFTVID,
328 AV_CODEC_ID_ESCAPE124,
332 AV_CODEC_ID_MOTIONPIXELS,
344 AV_CODEC_ID_FLASHSV2,
345 AV_CODEC_ID_CDGRAPHICS,
348 AV_CODEC_ID_BINKVIDEO,
349 AV_CODEC_ID_IFF_ILBM,
350 AV_CODEC_ID_IFF_BYTERUN1,
356 AV_CODEC_ID_A64_MULTI,
357 AV_CODEC_ID_A64_MULTI5,
360 AV_CODEC_ID_LAGARITH,
364 AV_CODEC_ID_WMV3IMAGE,
365 AV_CODEC_ID_VC1IMAGE,
367 AV_CODEC_ID_BMV_VIDEO,
374 AV_CODEC_ID_ZEROCODEC,
383 AV_CODEC_ID_ESCAPE130,
386 AV_CODEC_ID_HNM4_VIDEO,
389 AV_CODEC_ID_ALIAS_PIX,
390 AV_CODEC_ID_BRENDER_PIX,
391 AV_CODEC_ID_PAF_VIDEO,
404 AV_CODEC_ID_SCREENPRESSO,
406 AV_CODEC_ID_MAGICYUV,
407 AV_CODEC_ID_TRUEMOTION2RT,
412 /* various PCM "codecs" */
413 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
414 AV_CODEC_ID_PCM_S16LE = 0x10000,
415 AV_CODEC_ID_PCM_S16BE,
416 AV_CODEC_ID_PCM_U16LE,
417 AV_CODEC_ID_PCM_U16BE,
420 AV_CODEC_ID_PCM_MULAW,
421 AV_CODEC_ID_PCM_ALAW,
422 AV_CODEC_ID_PCM_S32LE,
423 AV_CODEC_ID_PCM_S32BE,
424 AV_CODEC_ID_PCM_U32LE,
425 AV_CODEC_ID_PCM_U32BE,
426 AV_CODEC_ID_PCM_S24LE,
427 AV_CODEC_ID_PCM_S24BE,
428 AV_CODEC_ID_PCM_U24LE,
429 AV_CODEC_ID_PCM_U24BE,
430 AV_CODEC_ID_PCM_S24DAUD,
431 AV_CODEC_ID_PCM_ZORK,
432 AV_CODEC_ID_PCM_S16LE_PLANAR,
434 AV_CODEC_ID_PCM_F32BE,
435 AV_CODEC_ID_PCM_F32LE,
436 AV_CODEC_ID_PCM_F64BE,
437 AV_CODEC_ID_PCM_F64LE,
438 AV_CODEC_ID_PCM_BLURAY,
441 AV_CODEC_ID_PCM_S8_PLANAR,
442 AV_CODEC_ID_PCM_S24LE_PLANAR,
443 AV_CODEC_ID_PCM_S32LE_PLANAR,
444 AV_CODEC_ID_PCM_S16BE_PLANAR,
446 /* various ADPCM codecs */
447 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
448 AV_CODEC_ID_ADPCM_IMA_WAV,
449 AV_CODEC_ID_ADPCM_IMA_DK3,
450 AV_CODEC_ID_ADPCM_IMA_DK4,
451 AV_CODEC_ID_ADPCM_IMA_WS,
452 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
453 AV_CODEC_ID_ADPCM_MS,
454 AV_CODEC_ID_ADPCM_4XM,
455 AV_CODEC_ID_ADPCM_XA,
456 AV_CODEC_ID_ADPCM_ADX,
457 AV_CODEC_ID_ADPCM_EA,
458 AV_CODEC_ID_ADPCM_G726,
459 AV_CODEC_ID_ADPCM_CT,
460 AV_CODEC_ID_ADPCM_SWF,
461 AV_CODEC_ID_ADPCM_YAMAHA,
462 AV_CODEC_ID_ADPCM_SBPRO_4,
463 AV_CODEC_ID_ADPCM_SBPRO_3,
464 AV_CODEC_ID_ADPCM_SBPRO_2,
465 AV_CODEC_ID_ADPCM_THP,
466 AV_CODEC_ID_ADPCM_IMA_AMV,
467 AV_CODEC_ID_ADPCM_EA_R1,
468 AV_CODEC_ID_ADPCM_EA_R3,
469 AV_CODEC_ID_ADPCM_EA_R2,
470 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
471 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
472 AV_CODEC_ID_ADPCM_EA_XAS,
473 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
474 AV_CODEC_ID_ADPCM_IMA_ISS,
475 AV_CODEC_ID_ADPCM_G722,
476 AV_CODEC_ID_ADPCM_IMA_APC,
477 AV_CODEC_ID_ADPCM_VIMA,
480 AV_CODEC_ID_AMR_NB = 0x12000,
483 /* RealAudio codecs*/
484 AV_CODEC_ID_RA_144 = 0x13000,
487 /* various DPCM codecs */
488 AV_CODEC_ID_ROQ_DPCM = 0x14000,
489 AV_CODEC_ID_INTERPLAY_DPCM,
490 AV_CODEC_ID_XAN_DPCM,
491 AV_CODEC_ID_SOL_DPCM,
494 AV_CODEC_ID_MP2 = 0x15000,
495 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
505 AV_CODEC_ID_VMDAUDIO,
511 AV_CODEC_ID_WESTWOOD_SND1,
512 AV_CODEC_ID_GSM, ///< as in Berlin toast format
515 AV_CODEC_ID_TRUESPEECH,
517 AV_CODEC_ID_SMACKAUDIO,
520 AV_CODEC_ID_DSICINAUDIO,
522 AV_CODEC_ID_MUSEPACK7,
524 AV_CODEC_ID_GSM_MS, /* as found in WAV */
527 AV_CODEC_ID_NELLYMOSER,
528 AV_CODEC_ID_MUSEPACK8,
530 AV_CODEC_ID_WMAVOICE,
532 AV_CODEC_ID_WMALOSSLESS,
541 AV_CODEC_ID_BINKAUDIO_RDFT,
542 AV_CODEC_ID_BINKAUDIO_DCT,
543 AV_CODEC_ID_AAC_LATM,
548 AV_CODEC_ID_8SVX_EXP,
549 AV_CODEC_ID_8SVX_FIB,
550 AV_CODEC_ID_BMV_AUDIO,
555 AV_CODEC_ID_COMFORT_NOISE,
557 AV_CODEC_ID_METASOUND,
558 AV_CODEC_ID_PAF_AUDIO,
562 /* subtitle codecs */
563 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
564 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
565 AV_CODEC_ID_DVB_SUBTITLE,
566 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
569 AV_CODEC_ID_MOV_TEXT,
570 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
571 AV_CODEC_ID_DVB_TELETEXT,
574 /* other specific kind of codecs (generally used for attachments) */
575 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
576 AV_CODEC_ID_TTF = 0x18000,
578 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
580 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
581 * stream (only used by libavformat) */
582 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
583 * stream (only used by libavformat) */
584 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
585 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
589 * This struct describes the properties of a single codec described by an
591 * @see avcodec_descriptor_get()
593 typedef struct AVCodecDescriptor {
595 enum AVMediaType type;
597 * Name of the codec described by this descriptor. It is non-empty and
598 * unique for each codec descriptor. It should contain alphanumeric
599 * characters and '_' only.
603 * A more descriptive name for this codec. May be NULL.
605 const char *long_name;
607 * Codec properties, a combination of AV_CODEC_PROP_* flags.
611 * If non-NULL, an array of profiles recognized for this codec.
612 * Terminated with FF_PROFILE_UNKNOWN.
614 const struct AVProfile *profiles;
618 * Codec uses only intra compression.
621 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
623 * Codec supports lossy compression. Audio and video codecs only.
624 * @note a codec may support both lossy and lossless
627 #define AV_CODEC_PROP_LOSSY (1 << 1)
629 * Codec supports lossless compression. Audio and video codecs only.
631 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
633 * Codec supports frame reordering. That is, the coded order (the order in which
634 * the encoded packets are output by the encoders / stored / input to the
635 * decoders) may be different from the presentation order of the corresponding
638 * For codecs that do not have this property set, PTS and DTS should always be
641 #define AV_CODEC_PROP_REORDER (1 << 3)
644 * @ingroup lavc_decoding
645 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
646 * This is mainly needed because some optimized bitstream readers read
647 * 32 or 64 bit at once and could read over the end.<br>
648 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
649 * MPEG bitstreams could cause overread and segfault.
651 #define AV_INPUT_BUFFER_PADDING_SIZE 8
654 * @ingroup lavc_encoding
655 * minimum encoding buffer size
656 * Used to avoid some checks during header writing.
658 #define AV_INPUT_BUFFER_MIN_SIZE 16384
661 * @ingroup lavc_decoding
664 /* We leave some space between them for extensions (drop some
665 * keyframes for intra-only or drop just some bidir frames). */
666 AVDISCARD_NONE =-16, ///< discard nothing
667 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
668 AVDISCARD_NONREF = 8, ///< discard all non reference
669 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
670 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
671 AVDISCARD_ALL = 48, ///< discard all
674 enum AVAudioServiceType {
675 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
676 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
677 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
678 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
679 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
680 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
681 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
682 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
683 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
684 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
688 * @ingroup lavc_encoding
690 typedef struct RcOverride{
693 int qscale; // If this is 0 then quality_factor will be used instead.
694 float quality_factor;
698 These flags can be passed in AVCodecContext.flags before initialization.
699 Note: Not everything is supported yet.
703 * Allow decoders to produce frames with data planes that are not aligned
704 * to CPU requirements (e.g. due to cropping).
706 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
710 #define AV_CODEC_FLAG_QSCALE (1 << 1)
712 * 4 MV per MB allowed / advanced prediction for H.263.
714 #define AV_CODEC_FLAG_4MV (1 << 2)
716 * Output even those frames that might be corrupted.
718 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
722 #define AV_CODEC_FLAG_QPEL (1 << 4)
724 * Use internal 2pass ratecontrol in first pass mode.
726 #define AV_CODEC_FLAG_PASS1 (1 << 9)
728 * Use internal 2pass ratecontrol in second pass mode.
730 #define AV_CODEC_FLAG_PASS2 (1 << 10)
734 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
736 * Only decode/encode grayscale.
738 #define AV_CODEC_FLAG_GRAY (1 << 13)
740 * error[?] variables will be set during encoding.
742 #define AV_CODEC_FLAG_PSNR (1 << 15)
744 * Input bitstream might be truncated at a random location
745 * instead of only at frame boundaries.
747 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
749 * Use interlaced DCT.
751 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
755 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
757 * Place global headers in extradata instead of every keyframe.
759 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
761 * Use only bitexact stuff (except (I)DCT).
763 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
764 /* Fx : Flag for H.263+ extra options */
766 * H.263 advanced intra coding / MPEG-4 AC prediction
768 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
770 * interlaced motion estimation
772 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
773 #define AV_CODEC_FLAG_CLOSED_GOP (1 << 31)
776 * Allow non spec compliant speedup tricks.
778 #define AV_CODEC_FLAG2_FAST (1 << 0)
780 * Skip bitstream encoding.
782 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
784 * Place global headers at every keyframe instead of in extradata.
786 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
788 * Input bitstream might be truncated at a packet boundaries
789 * instead of only at frame boundaries.
791 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
793 * Discard cropping information from SPS.
795 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
797 /* Unsupported options :
798 * Syntax Arithmetic coding (SAC)
799 * Reference Picture Selection
800 * Independent Segment Decoding */
802 /* codec capabilities */
805 * Decoder can use draw_horiz_band callback.
807 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
809 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
810 * If not set, it might not use get_buffer() at all or use operations that
811 * assume the buffer was allocated by avcodec_default_get_buffer.
813 #define AV_CODEC_CAP_DR1 (1 << 1)
814 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
816 * Encoder or decoder requires flushing with NULL input at the end in order to
817 * give the complete and correct output.
819 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
820 * with NULL data. The user can still send NULL data to the public encode
821 * or decode function, but libavcodec will not pass it along to the codec
822 * unless this flag is set.
825 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
826 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
830 * The encoder needs to be fed with NULL data at the end of encoding until the
831 * encoder no longer returns data.
833 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
834 * flag also means that the encoder must set the pts and duration for
835 * each output packet. If this flag is not set, the pts and duration will
836 * be determined by libavcodec from the input frame.
838 #define AV_CODEC_CAP_DELAY (1 << 5)
840 * Codec can be fed a final frame with a smaller size.
841 * This can be used to prevent truncation of the last audio samples.
843 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
845 * Codec can output multiple frames per AVPacket
846 * Normally demuxers return one frame at a time, demuxers which do not do
847 * are connected to a parser to split what they return into proper frames.
848 * This flag is reserved to the very rare category of codecs which have a
849 * bitstream that cannot be split into frames without timeconsuming
850 * operations like full decoding. Demuxers carrying such bitstreams thus
851 * may return multiple frames in a packet. This has many disadvantages like
852 * prohibiting stream copy in many cases thus it should only be considered
855 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
857 * Codec is experimental and is thus avoided in favor of non experimental
860 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
862 * Codec should fill in channel configuration and samplerate instead of container
864 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
866 * Codec supports frame-level multithreading.
868 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
870 * Codec supports slice-based (or partition-based) multithreading.
872 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
874 * Codec supports changed parameters at any point.
876 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
878 * Codec supports avctx->thread_count == 0 (auto).
880 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
882 * Audio encoder supports receiving a different number of samples in each call.
884 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
888 * This specifies the area which should be displayed.
889 * Note there may be multiple such areas for one frame.
891 typedef struct AVPanScan{
894 * - encoding: Set by user.
895 * - decoding: Set by libavcodec.
900 * width and height in 1/16 pel
901 * - encoding: Set by user.
902 * - decoding: Set by libavcodec.
908 * position of the top left corner in 1/16 pel for up to 3 fields/frames
909 * - encoding: Set by user.
910 * - decoding: Set by libavcodec.
912 int16_t position[3][2];
916 * This structure describes the bitrate properties of an encoded bitstream. It
917 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
918 * parameters for H.264/HEVC.
920 typedef struct AVCPBProperties {
922 * Maximum bitrate of the stream, in bits per second.
923 * Zero if unknown or unspecified.
927 * Minimum bitrate of the stream, in bits per second.
928 * Zero if unknown or unspecified.
932 * Average bitrate of the stream, in bits per second.
933 * Zero if unknown or unspecified.
938 * The size of the buffer to which the ratecontrol is applied, in bits.
939 * Zero if unknown or unspecified.
944 * The delay between the time the packet this structure is associated with
945 * is received and the time when it should be decoded, in periods of a 27MHz
948 * UINT64_MAX when unknown or unspecified.
954 * The decoder will keep a reference to the frame and may reuse it later.
956 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
959 * @defgroup lavc_packet AVPacket
961 * Types and functions for working with AVPacket.
964 enum AVPacketSideDataType {
966 * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
967 * bytes worth of palette. This side data signals that a new palette is
973 * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
974 * that the extradata buffer was changed and the receiving side should
975 * act upon it appropriately. The new extradata is embedded in the side
976 * data buffer and should be immediately used for processing the current
979 AV_PKT_DATA_NEW_EXTRADATA,
982 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
985 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
986 * s32le channel_count
987 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
988 * u64le channel_layout
989 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
991 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
996 AV_PKT_DATA_PARAM_CHANGE,
999 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1000 * structures with info about macroblocks relevant to splitting the
1001 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1002 * That is, it does not necessarily contain info about all macroblocks,
1003 * as long as the distance between macroblocks in the info is smaller
1004 * than the target payload size.
1005 * Each MB info structure is 12 bytes, and is laid out as follows:
1007 * u32le bit offset from the start of the packet
1008 * u8 current quantizer at the start of the macroblock
1010 * u16le macroblock address within the GOB
1011 * u8 horizontal MV predictor
1012 * u8 vertical MV predictor
1013 * u8 horizontal MV predictor for block number 3
1014 * u8 vertical MV predictor for block number 3
1017 AV_PKT_DATA_H263_MB_INFO,
1020 * This side data should be associated with an audio stream and contains
1021 * ReplayGain information in form of the AVReplayGain struct.
1023 AV_PKT_DATA_REPLAYGAIN,
1026 * This side data contains a 3x3 transformation matrix describing an affine
1027 * transformation that needs to be applied to the decoded video frames for
1028 * correct presentation.
1030 * See libavutil/display.h for a detailed description of the data.
1032 AV_PKT_DATA_DISPLAYMATRIX,
1035 * This side data should be associated with a video stream and contains
1036 * Stereoscopic 3D information in form of the AVStereo3D struct.
1038 AV_PKT_DATA_STEREO3D,
1041 * This side data should be associated with an audio stream and corresponds
1042 * to enum AVAudioServiceType.
1044 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1047 * This side data contains an integer value representing the quality
1048 * factor of the compressed frame. Allowed range is between 1 (good)
1049 * and FF_LAMBDA_MAX (bad).
1051 AV_PKT_DATA_QUALITY_FACTOR,
1054 * This side data contains an integer value representing the stream index
1055 * of a "fallback" track. A fallback track indicates an alternate
1056 * track to use when the current track can not be decoded for some reason.
1057 * e.g. no decoder available for codec.
1059 AV_PKT_DATA_FALLBACK_TRACK,
1062 * This side data corresponds to the AVCPBProperties struct.
1064 AV_PKT_DATA_CPB_PROPERTIES,
1067 * This side data should be associated with a video stream and corresponds
1068 * to the AVSphericalMapping structure.
1070 AV_PKT_DATA_SPHERICAL,
1073 typedef struct AVPacketSideData {
1076 enum AVPacketSideDataType type;
1080 * This structure stores compressed data. It is typically exported by demuxers
1081 * and then passed as input to decoders, or received as output from encoders and
1082 * then passed to muxers.
1084 * For video, it should typically contain one compressed frame. For audio it may
1085 * contain several compressed frames. Encoders are allowed to output empty
1086 * packets, with no compressed data, containing only side data
1087 * (e.g. to update some stream parameters at the end of encoding).
1089 * AVPacket is one of the few structs in Libav, whose size is a part of public
1090 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1091 * without libavcodec and libavformat major bump.
1093 * The semantics of data ownership depends on the buf field.
1094 * If it is set, the packet data is dynamically allocated and is
1095 * valid indefinitely until a call to av_packet_unref() reduces the
1096 * reference count to 0.
1098 * If the buf field is not set av_packet_ref() would make a copy instead
1099 * of increasing the reference count.
1101 * The side data is always allocated with av_malloc(), copied by
1102 * av_packet_ref() and freed by av_packet_unref().
1104 * @see av_packet_ref
1105 * @see av_packet_unref
1107 typedef struct AVPacket {
1109 * A reference to the reference-counted buffer where the packet data is
1111 * May be NULL, then the packet data is not reference-counted.
1115 * Presentation timestamp in AVStream->time_base units; the time at which
1116 * the decompressed packet will be presented to the user.
1117 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1118 * pts MUST be larger or equal to dts as presentation cannot happen before
1119 * decompression, unless one wants to view hex dumps. Some formats misuse
1120 * the terms dts and pts/cts to mean something different. Such timestamps
1121 * must be converted to true pts/dts before they are stored in AVPacket.
1125 * Decompression timestamp in AVStream->time_base units; the time at which
1126 * the packet is decompressed.
1127 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1134 * A combination of AV_PKT_FLAG values
1138 * Additional packet data that can be provided by the container.
1139 * Packet can contain several types of side information.
1141 AVPacketSideData *side_data;
1142 int side_data_elems;
1145 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1146 * Equals next_pts - this_pts in presentation order.
1150 int64_t pos; ///< byte position in stream, -1 if unknown
1152 #if FF_API_CONVERGENCE_DURATION
1154 * @deprecated Same as the duration field, but as int64_t. This was required
1155 * for Matroska subtitles, whose duration values could overflow when the
1156 * duration field was still an int.
1158 attribute_deprecated
1159 int64_t convergence_duration;
1162 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1163 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1165 enum AVSideDataParamChangeFlags {
1166 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1167 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1168 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1169 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1175 struct AVCodecInternal;
1179 AV_FIELD_PROGRESSIVE,
1180 AV_FIELD_TT, //< Top coded_first, top displayed first
1181 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1182 AV_FIELD_TB, //< Top coded first, bottom displayed first
1183 AV_FIELD_BT, //< Bottom coded first, top displayed first
1187 * main external API structure.
1188 * New fields can be added to the end with minor version bumps.
1189 * Removal, reordering and changes to existing fields require a major
1191 * sizeof(AVCodecContext) must not be used outside libav*.
1193 typedef struct AVCodecContext {
1195 * information on struct for av_log
1196 * - set by avcodec_alloc_context3
1198 const AVClass *av_class;
1199 int log_level_offset;
1201 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1202 const struct AVCodec *codec;
1203 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1206 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1207 * This is used to work around some encoder bugs.
1208 * A demuxer should set this to what is stored in the field used to identify the codec.
1209 * If there are multiple such fields in a container then the demuxer should choose the one
1210 * which maximizes the information about the used codec.
1211 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1212 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1213 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1215 * - encoding: Set by user, if not then the default based on codec_id will be used.
1216 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1218 unsigned int codec_tag;
1223 * Private context used for internal data.
1225 * Unlike priv_data, this is not codec-specific. It is used in general
1226 * libavcodec functions.
1228 struct AVCodecInternal *internal;
1231 * Private data of the user, can be used to carry app specific stuff.
1232 * - encoding: Set by user.
1233 * - decoding: Set by user.
1238 * the average bitrate
1239 * - encoding: Set by user; unused for constant quantizer encoding.
1240 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1245 * number of bits the bitstream is allowed to diverge from the reference.
1246 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1247 * - encoding: Set by user; unused for constant quantizer encoding.
1248 * - decoding: unused
1250 int bit_rate_tolerance;
1253 * Global quality for codecs which cannot change it per frame.
1254 * This should be proportional to MPEG-1/2/4 qscale.
1255 * - encoding: Set by user.
1256 * - decoding: unused
1261 * - encoding: Set by user.
1262 * - decoding: unused
1264 int compression_level;
1265 #define FF_COMPRESSION_DEFAULT -1
1269 * - encoding: Set by user.
1270 * - decoding: Set by user.
1276 * - encoding: Set by user.
1277 * - decoding: Set by user.
1282 * some codecs need / can use extradata like Huffman tables.
1283 * MJPEG: Huffman tables
1284 * rv10: additional flags
1285 * MPEG-4: global headers (they can be in the bitstream or here)
1286 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1287 * than extradata_size to avoid problems if it is read with the bitstream reader.
1288 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1289 * - encoding: Set/allocated/freed by libavcodec.
1290 * - decoding: Set/allocated/freed by user.
1296 * This is the fundamental unit of time (in seconds) in terms
1297 * of which frame timestamps are represented. For fixed-fps content,
1298 * timebase should be 1/framerate and timestamp increments should be
1300 * - encoding: MUST be set by user.
1301 * - decoding: the use of this field for decoding is deprecated.
1302 * Use framerate instead.
1304 AVRational time_base;
1307 * For some codecs, the time base is closer to the field rate than the frame rate.
1308 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1309 * if no telecine is used ...
1311 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1313 int ticks_per_frame;
1319 * Number of frames the decoded output will be delayed relative to the
1323 * For encoding, this field is unused (see initial_padding).
1325 * For decoding, this is the number of samples the decoder needs to
1326 * output before the decoder's output is valid. When seeking, you should
1327 * start decoding this many samples prior to your desired seek point.
1329 * - encoding: Set by libavcodec.
1330 * - decoding: Set by libavcodec.
1337 * picture width / height.
1339 * @note Those fields may not match the values of the last
1340 * AVFrame output by avcodec_decode_video2 due frame
1343 * - encoding: MUST be set by user.
1344 * - decoding: May be set by the user before opening the decoder if known e.g.
1345 * from the container. Some decoders will require the dimensions
1346 * to be set by the caller. During decoding, the decoder may
1347 * overwrite those values as required while parsing the data.
1352 * Bitstream width / height, may be different from width/height e.g. when
1353 * the decoded frame is cropped before being output.
1355 * @note Those field may not match the value of the last
1356 * AVFrame output by avcodec_receive_frame() due frame
1359 * - encoding: unused
1360 * - decoding: May be set by the user before opening the decoder if known
1361 * e.g. from the container. During decoding, the decoder may
1362 * overwrite those values as required while parsing the data.
1364 int coded_width, coded_height;
1367 * the number of pictures in a group of pictures, or 0 for intra_only
1368 * - encoding: Set by user.
1369 * - decoding: unused
1374 * Pixel format, see AV_PIX_FMT_xxx.
1375 * May be set by the demuxer if known from headers.
1376 * May be overridden by the decoder if it knows better.
1378 * @note This field may not match the value of the last
1379 * AVFrame output by avcodec_receive_frame() due frame
1382 * - encoding: Set by user.
1383 * - decoding: Set by user if known, overridden by libavcodec while
1386 enum AVPixelFormat pix_fmt;
1389 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1390 * decoder to draw a horizontal band. It improves cache usage. Not
1391 * all codecs can do that. You must check the codec capabilities
1393 * When multithreading is used, it may be called from multiple threads
1394 * at the same time; threads might draw different parts of the same AVFrame,
1395 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1397 * The function is also used by hardware acceleration APIs.
1398 * It is called at least once during frame decoding to pass
1399 * the data needed for hardware render.
1400 * In that mode instead of pixel data, AVFrame points to
1401 * a structure specific to the acceleration API. The application
1402 * reads the structure and can change some fields to indicate progress
1404 * - encoding: unused
1405 * - decoding: Set by user.
1406 * @param height the height of the slice
1407 * @param y the y position of the slice
1408 * @param type 1->top field, 2->bottom field, 3->frame
1409 * @param offset offset into the AVFrame.data from which the slice should be read
1411 void (*draw_horiz_band)(struct AVCodecContext *s,
1412 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1413 int y, int type, int height);
1416 * callback to negotiate the pixelFormat
1417 * @param fmt is the list of formats which are supported by the codec,
1418 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1419 * The first is always the native one.
1420 * @note The callback may be called again immediately if initialization for
1421 * the selected (hardware-accelerated) pixel format failed.
1422 * @warning Behavior is undefined if the callback returns a value not
1423 * in the fmt list of formats.
1424 * @return the chosen format
1425 * - encoding: unused
1426 * - decoding: Set by user, if not set the native format will be chosen.
1428 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1431 * maximum number of B-frames between non-B-frames
1432 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1433 * - encoding: Set by user.
1434 * - decoding: unused
1439 * qscale factor between IP and B-frames
1440 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1441 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1442 * - encoding: Set by user.
1443 * - decoding: unused
1445 float b_quant_factor;
1447 #if FF_API_PRIVATE_OPT
1448 /** @deprecated use encoder private options instead */
1449 attribute_deprecated
1450 int b_frame_strategy;
1454 * qscale offset between IP and B-frames
1455 * - encoding: Set by user.
1456 * - decoding: unused
1458 float b_quant_offset;
1461 * Size of the frame reordering buffer in the decoder.
1462 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1463 * - encoding: Set by libavcodec.
1464 * - decoding: Set by libavcodec.
1468 #if FF_API_PRIVATE_OPT
1469 /** @deprecated use encoder private options instead */
1470 attribute_deprecated
1475 * qscale factor between P- and I-frames
1476 * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1477 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1478 * - encoding: Set by user.
1479 * - decoding: unused
1481 float i_quant_factor;
1484 * qscale offset between P and I-frames
1485 * - encoding: Set by user.
1486 * - decoding: unused
1488 float i_quant_offset;
1491 * luminance masking (0-> disabled)
1492 * - encoding: Set by user.
1493 * - decoding: unused
1498 * temporary complexity masking (0-> disabled)
1499 * - encoding: Set by user.
1500 * - decoding: unused
1502 float temporal_cplx_masking;
1505 * spatial complexity masking (0-> disabled)
1506 * - encoding: Set by user.
1507 * - decoding: unused
1509 float spatial_cplx_masking;
1512 * p block masking (0-> disabled)
1513 * - encoding: Set by user.
1514 * - decoding: unused
1519 * darkness masking (0-> disabled)
1520 * - encoding: Set by user.
1521 * - decoding: unused
1527 * - encoding: Set by libavcodec.
1528 * - decoding: Set by user (or 0).
1532 #if FF_API_PRIVATE_OPT
1533 /** @deprecated use encoder private options instead */
1534 attribute_deprecated
1535 int prediction_method;
1536 #define FF_PRED_LEFT 0
1537 #define FF_PRED_PLANE 1
1538 #define FF_PRED_MEDIAN 2
1542 * slice offsets in the frame in bytes
1543 * - encoding: Set/allocated by libavcodec.
1544 * - decoding: Set/allocated by user (or NULL).
1549 * sample aspect ratio (0 if unknown)
1550 * That is the width of a pixel divided by the height of the pixel.
1551 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1552 * - encoding: Set by user.
1553 * - decoding: Set by libavcodec.
1555 AVRational sample_aspect_ratio;
1558 * motion estimation comparison function
1559 * - encoding: Set by user.
1560 * - decoding: unused
1564 * subpixel motion estimation comparison function
1565 * - encoding: Set by user.
1566 * - decoding: unused
1570 * macroblock comparison function (not supported yet)
1571 * - encoding: Set by user.
1572 * - decoding: unused
1576 * interlaced DCT comparison function
1577 * - encoding: Set by user.
1578 * - decoding: unused
1581 #define FF_CMP_SAD 0
1582 #define FF_CMP_SSE 1
1583 #define FF_CMP_SATD 2
1584 #define FF_CMP_DCT 3
1585 #define FF_CMP_PSNR 4
1586 #define FF_CMP_BIT 5
1588 #define FF_CMP_ZERO 7
1589 #define FF_CMP_VSAD 8
1590 #define FF_CMP_VSSE 9
1591 #define FF_CMP_NSSE 10
1592 #define FF_CMP_DCTMAX 13
1593 #define FF_CMP_DCT264 14
1594 #define FF_CMP_CHROMA 256
1597 * ME diamond size & shape
1598 * - encoding: Set by user.
1599 * - decoding: unused
1604 * amount of previous MV predictors (2a+1 x 2a+1 square)
1605 * - encoding: Set by user.
1606 * - decoding: unused
1608 int last_predictor_count;
1610 #if FF_API_PRIVATE_OPT
1611 /** @deprecated use encoder private options instead */
1612 attribute_deprecated
1617 * motion estimation prepass comparison function
1618 * - encoding: Set by user.
1619 * - decoding: unused
1624 * ME prepass diamond size & shape
1625 * - encoding: Set by user.
1626 * - decoding: unused
1632 * - encoding: Set by user.
1633 * - decoding: unused
1635 int me_subpel_quality;
1638 * maximum motion estimation search range in subpel units
1639 * If 0 then no limit.
1641 * - encoding: Set by user.
1642 * - decoding: unused
1648 * - encoding: unused
1649 * - decoding: Set by user.
1652 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1653 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1654 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1657 * macroblock decision mode
1658 * - encoding: Set by user.
1659 * - decoding: unused
1662 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1663 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1664 #define FF_MB_DECISION_RD 2 ///< rate distortion
1667 * custom intra quantization matrix
1668 * - encoding: Set by user, can be NULL.
1669 * - decoding: Set by libavcodec.
1671 uint16_t *intra_matrix;
1674 * custom inter quantization matrix
1675 * - encoding: Set by user, can be NULL.
1676 * - decoding: Set by libavcodec.
1678 uint16_t *inter_matrix;
1680 #if FF_API_PRIVATE_OPT
1681 /** @deprecated use encoder private options instead */
1682 attribute_deprecated
1683 int scenechange_threshold;
1685 /** @deprecated use encoder private options instead */
1686 attribute_deprecated
1687 int noise_reduction;
1691 * precision of the intra DC coefficient - 8
1692 * - encoding: Set by user.
1693 * - decoding: unused
1695 int intra_dc_precision;
1698 * Number of macroblock rows at the top which are skipped.
1699 * - encoding: unused
1700 * - decoding: Set by user.
1705 * Number of macroblock rows at the bottom which are skipped.
1706 * - encoding: unused
1707 * - decoding: Set by user.
1712 * minimum MB Lagrange multiplier
1713 * - encoding: Set by user.
1714 * - decoding: unused
1719 * maximum MB Lagrange multiplier
1720 * - encoding: Set by user.
1721 * - decoding: unused
1725 #if FF_API_PRIVATE_OPT
1727 * @deprecated use encoder private options instead
1729 attribute_deprecated
1730 int me_penalty_compensation;
1734 * - encoding: Set by user.
1735 * - decoding: unused
1739 #if FF_API_PRIVATE_OPT
1740 /** @deprecated use encoder private options instead */
1741 attribute_deprecated
1747 * - encoding: Set by user.
1748 * - decoding: unused
1753 * number of reference frames
1754 * - encoding: Set by user.
1755 * - decoding: Set by lavc.
1759 #if FF_API_PRIVATE_OPT
1760 /** @deprecated use encoder private options instead */
1761 attribute_deprecated
1766 * Note: Value depends upon the compare function used for fullpel ME.
1767 * - encoding: Set by user.
1768 * - decoding: unused
1772 #if FF_API_PRIVATE_OPT
1773 /** @deprecated use encoder private options instead */
1774 attribute_deprecated
1779 * Chromaticity coordinates of the source primaries.
1780 * - encoding: Set by user
1781 * - decoding: Set by libavcodec
1783 enum AVColorPrimaries color_primaries;
1786 * Color Transfer Characteristic.
1787 * - encoding: Set by user
1788 * - decoding: Set by libavcodec
1790 enum AVColorTransferCharacteristic color_trc;
1793 * YUV colorspace type.
1794 * - encoding: Set by user
1795 * - decoding: Set by libavcodec
1797 enum AVColorSpace colorspace;
1800 * MPEG vs JPEG YUV range.
1801 * - encoding: Set by user
1802 * - decoding: Set by libavcodec
1804 enum AVColorRange color_range;
1807 * This defines the location of chroma samples.
1808 * - encoding: Set by user
1809 * - decoding: Set by libavcodec
1811 enum AVChromaLocation chroma_sample_location;
1815 * Indicates number of picture subdivisions. Used for parallelized
1817 * - encoding: Set by user
1818 * - decoding: unused
1823 * - encoding: set by libavcodec
1824 * - decoding: Set by libavcodec
1826 enum AVFieldOrder field_order;
1829 int sample_rate; ///< samples per second
1830 int channels; ///< number of audio channels
1833 * audio sample format
1834 * - encoding: Set by user.
1835 * - decoding: Set by libavcodec.
1837 enum AVSampleFormat sample_fmt; ///< sample format
1839 /* The following data should not be initialized. */
1841 * Number of samples per channel in an audio frame.
1843 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1844 * except the last must contain exactly frame_size samples per channel.
1845 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1846 * frame size is not restricted.
1847 * - decoding: may be set by some decoders to indicate constant frame size
1852 * Frame counter, set by libavcodec.
1854 * - decoding: total number of frames returned from the decoder so far.
1855 * - encoding: total number of frames passed to the encoder so far.
1857 * @note the counter is not incremented if encoding/decoding resulted in
1863 * number of bytes per packet if constant and known or 0
1864 * Used by some WAV based audio codecs.
1869 * Audio cutoff bandwidth (0 means "automatic")
1870 * - encoding: Set by user.
1871 * - decoding: unused
1876 * Audio channel layout.
1877 * - encoding: set by user.
1878 * - decoding: set by libavcodec.
1880 uint64_t channel_layout;
1883 * Request decoder to use this channel layout if it can (0 for default)
1884 * - encoding: unused
1885 * - decoding: Set by user.
1887 uint64_t request_channel_layout;
1890 * Type of service that the audio stream conveys.
1891 * - encoding: Set by user.
1892 * - decoding: Set by libavcodec.
1894 enum AVAudioServiceType audio_service_type;
1897 * Used to request a sample format from the decoder.
1898 * - encoding: unused.
1899 * - decoding: Set by user.
1901 enum AVSampleFormat request_sample_fmt;
1904 * This callback is called at the beginning of each frame to get data
1905 * buffer(s) for it. There may be one contiguous buffer for all the data or
1906 * there may be a buffer per each data plane or anything in between. What
1907 * this means is, you may set however many entries in buf[] you feel necessary.
1908 * Each buffer must be reference-counted using the AVBuffer API (see description
1911 * The following fields will be set in the frame before this callback is
1914 * - width, height (video only)
1915 * - sample_rate, channel_layout, nb_samples (audio only)
1916 * Their values may differ from the corresponding values in
1917 * AVCodecContext. This callback must use the frame values, not the codec
1918 * context values, to calculate the required buffer size.
1920 * This callback must fill the following fields in the frame:
1924 * * if the data is planar audio with more than 8 channels, then this
1925 * callback must allocate and fill extended_data to contain all pointers
1926 * to all data planes. data[] must hold as many pointers as it can.
1927 * extended_data must be allocated with av_malloc() and will be freed in
1929 * * otherwise extended_data must point to data
1930 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1931 * the frame's data and extended_data pointers must be contained in these. That
1932 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1933 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1934 * and av_buffer_ref().
1935 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1936 * this callback and filled with the extra buffers if there are more
1937 * buffers than buf[] can hold. extended_buf will be freed in
1940 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
1941 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1944 * Each data plane must be aligned to the maximum required by the target
1947 * @see avcodec_default_get_buffer2()
1951 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1952 * (read and/or written to if it is writable) later by libavcodec.
1954 * avcodec_align_dimensions2() should be used to find the required width and
1955 * height, as they normally need to be rounded up to the next multiple of 16.
1957 * If frame multithreading is used and thread_safe_callbacks is set,
1958 * this callback may be called from a different thread, but not from more
1959 * than one at once. Does not need to be reentrant.
1961 * @see avcodec_align_dimensions2()
1965 * Decoders request a buffer of a particular size by setting
1966 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1967 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1968 * to a smaller value in the output frame.
1970 * As a convenience, av_samples_get_buffer_size() and
1971 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1972 * functions to find the required data size and to fill data pointers and
1973 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1974 * since all planes must be the same size.
1976 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1978 * - encoding: unused
1979 * - decoding: Set by libavcodec, user can override.
1981 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
1984 * If non-zero, the decoded audio and video frames returned from
1985 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
1986 * and are valid indefinitely. The caller must free them with
1987 * av_frame_unref() when they are not needed anymore.
1988 * Otherwise, the decoded frames must not be freed by the caller and are
1989 * only valid until the next decode call.
1991 * This is always automatically enabled if avcodec_receive_frame() is used.
1993 * - encoding: unused
1994 * - decoding: set by the caller before avcodec_open2().
1996 attribute_deprecated int refcounted_frames;
1998 /* - encoding parameters */
1999 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2000 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2004 * - encoding: Set by user.
2005 * - decoding: unused
2011 * - encoding: Set by user.
2012 * - decoding: unused
2017 * maximum quantizer difference between frames
2018 * - encoding: Set by user.
2019 * - decoding: unused
2024 * decoder bitstream buffer size
2025 * - encoding: Set by user.
2026 * - decoding: unused
2031 * ratecontrol override, see RcOverride
2032 * - encoding: Allocated/set/freed by user.
2033 * - decoding: unused
2035 int rc_override_count;
2036 RcOverride *rc_override;
2040 * - encoding: Set by user.
2041 * - decoding: unused
2047 * - encoding: Set by user.
2048 * - decoding: unused
2053 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2054 * - encoding: Set by user.
2055 * - decoding: unused.
2057 float rc_max_available_vbv_use;
2060 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2061 * - encoding: Set by user.
2062 * - decoding: unused.
2064 float rc_min_vbv_overflow_use;
2067 * Number of bits which should be loaded into the rc buffer before decoding starts.
2068 * - encoding: Set by user.
2069 * - decoding: unused
2071 int rc_initial_buffer_occupancy;
2073 #if FF_API_CODER_TYPE
2074 #define FF_CODER_TYPE_VLC 0
2075 #define FF_CODER_TYPE_AC 1
2076 #define FF_CODER_TYPE_RAW 2
2077 #define FF_CODER_TYPE_RLE 3
2079 * @deprecated use encoder private options instead
2081 attribute_deprecated
2083 #endif /* FF_API_CODER_TYPE */
2085 #if FF_API_PRIVATE_OPT
2086 /** @deprecated use encoder private options instead */
2087 attribute_deprecated
2091 #if FF_API_PRIVATE_OPT
2092 /** @deprecated use encoder private options instead */
2093 attribute_deprecated
2094 int frame_skip_threshold;
2096 /** @deprecated use encoder private options instead */
2097 attribute_deprecated
2098 int frame_skip_factor;
2100 /** @deprecated use encoder private options instead */
2101 attribute_deprecated
2104 /** @deprecated use encoder private options instead */
2105 attribute_deprecated
2107 #endif /* FF_API_PRIVATE_OPT */
2110 * trellis RD quantization
2111 * - encoding: Set by user.
2112 * - decoding: unused
2116 #if FF_API_PRIVATE_OPT
2117 /** @deprecated use encoder private options instead */
2118 attribute_deprecated
2119 int min_prediction_order;
2121 /** @deprecated use encoder private options instead */
2122 attribute_deprecated
2123 int max_prediction_order;
2125 /** @deprecated use encoder private options instead */
2126 attribute_deprecated
2127 int64_t timecode_frame_start;
2130 #if FF_API_RTP_CALLBACK
2132 * @deprecated unused
2134 /* The RTP callback: This function is called */
2135 /* every time the encoder has a packet to send. */
2136 /* It depends on the encoder if the data starts */
2137 /* with a Start Code (it should). H.263 does. */
2138 /* mb_nb contains the number of macroblocks */
2139 /* encoded in the RTP payload. */
2140 attribute_deprecated
2141 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2144 #if FF_API_PRIVATE_OPT
2145 /** @deprecated use encoder private options instead */
2146 attribute_deprecated
2147 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2148 /* do its best to deliver a chunk with size */
2149 /* below rtp_payload_size, the chunk will start */
2150 /* with a start code on some codecs like H.263. */
2151 /* This doesn't take account of any particular */
2152 /* headers inside the transmitted RTP payload. */
2155 #if FF_API_STAT_BITS
2156 /* statistics, used for 2-pass encoding */
2157 attribute_deprecated
2159 attribute_deprecated
2161 attribute_deprecated
2163 attribute_deprecated
2165 attribute_deprecated
2167 attribute_deprecated
2169 attribute_deprecated
2171 attribute_deprecated
2174 /** @deprecated this field is unused */
2175 attribute_deprecated
2180 * pass1 encoding statistics output buffer
2181 * - encoding: Set by libavcodec.
2182 * - decoding: unused
2187 * pass2 encoding statistics input buffer
2188 * Concatenated stuff from stats_out of pass1 should be placed here.
2189 * - encoding: Allocated/set/freed by user.
2190 * - decoding: unused
2195 * Work around bugs in encoders which sometimes cannot be detected automatically.
2196 * - encoding: Set by user
2197 * - decoding: Set by user
2199 int workaround_bugs;
2200 #define FF_BUG_AUTODETECT 1 ///< autodetection
2201 #define FF_BUG_XVID_ILACE 4
2202 #define FF_BUG_UMP4 8
2203 #define FF_BUG_NO_PADDING 16
2204 #define FF_BUG_AMV 32
2205 #define FF_BUG_QPEL_CHROMA 64
2206 #define FF_BUG_STD_QPEL 128
2207 #define FF_BUG_QPEL_CHROMA2 256
2208 #define FF_BUG_DIRECT_BLOCKSIZE 512
2209 #define FF_BUG_EDGE 1024
2210 #define FF_BUG_HPEL_CHROMA 2048
2211 #define FF_BUG_DC_CLIP 4096
2212 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2213 #define FF_BUG_TRUNCATED 16384
2216 * strictly follow the standard (MPEG-4, ...).
2217 * - encoding: Set by user.
2218 * - decoding: Set by user.
2219 * Setting this to STRICT or higher means the encoder and decoder will
2220 * generally do stupid things, whereas setting it to unofficial or lower
2221 * will mean the encoder might produce output that is not supported by all
2222 * spec-compliant decoders. Decoders don't differentiate between normal,
2223 * unofficial and experimental (that is, they always try to decode things
2224 * when they can) unless they are explicitly asked to behave stupidly
2225 * (=strictly conform to the specs)
2227 int strict_std_compliance;
2228 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2229 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2230 #define FF_COMPLIANCE_NORMAL 0
2231 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2232 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2235 * error concealment flags
2236 * - encoding: unused
2237 * - decoding: Set by user.
2239 int error_concealment;
2240 #define FF_EC_GUESS_MVS 1
2241 #define FF_EC_DEBLOCK 2
2245 * - encoding: Set by user.
2246 * - decoding: Set by user.
2249 #define FF_DEBUG_PICT_INFO 1
2250 #define FF_DEBUG_RC 2
2251 #define FF_DEBUG_BITSTREAM 4
2252 #define FF_DEBUG_MB_TYPE 8
2253 #define FF_DEBUG_QP 16
2254 #define FF_DEBUG_DCT_COEFF 0x00000040
2255 #define FF_DEBUG_SKIP 0x00000080
2256 #define FF_DEBUG_STARTCODE 0x00000100
2257 #define FF_DEBUG_ER 0x00000400
2258 #define FF_DEBUG_MMCO 0x00000800
2259 #define FF_DEBUG_BUGS 0x00001000
2260 #define FF_DEBUG_BUFFERS 0x00008000
2261 #define FF_DEBUG_THREADS 0x00010000
2264 * Error recognition; may misdetect some more or less valid parts as errors.
2265 * - encoding: unused
2266 * - decoding: Set by user.
2268 int err_recognition;
2271 * Verify checksums embedded in the bitstream (could be of either encoded or
2272 * decoded data, depending on the codec) and print an error message on mismatch.
2273 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2274 * decoder returning an error.
2276 #define AV_EF_CRCCHECK (1<<0)
2277 #define AV_EF_BITSTREAM (1<<1)
2278 #define AV_EF_BUFFER (1<<2)
2279 #define AV_EF_EXPLODE (1<<3)
2282 * opaque 64-bit number (generally a PTS) that will be reordered and
2283 * output in AVFrame.reordered_opaque
2284 * - encoding: unused
2285 * - decoding: Set by user.
2287 int64_t reordered_opaque;
2290 * Hardware accelerator in use
2291 * - encoding: unused.
2292 * - decoding: Set by libavcodec
2294 struct AVHWAccel *hwaccel;
2297 * Hardware accelerator context.
2298 * For some hardware accelerators, a global context needs to be
2299 * provided by the user. In that case, this holds display-dependent
2300 * data Libav cannot instantiate itself. Please refer to the
2301 * Libav HW accelerator documentation to know how to fill this
2302 * is. e.g. for VA API, this is a struct vaapi_context.
2303 * - encoding: unused
2304 * - decoding: Set by user
2306 void *hwaccel_context;
2310 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2311 * - decoding: unused
2313 uint64_t error[AV_NUM_DATA_POINTERS];
2316 * DCT algorithm, see FF_DCT_* below
2317 * - encoding: Set by user.
2318 * - decoding: unused
2321 #define FF_DCT_AUTO 0
2322 #define FF_DCT_FASTINT 1
2323 #define FF_DCT_INT 2
2324 #define FF_DCT_MMX 3
2325 #define FF_DCT_ALTIVEC 5
2326 #define FF_DCT_FAAN 6
2329 * IDCT algorithm, see FF_IDCT_* below.
2330 * - encoding: Set by user.
2331 * - decoding: Set by user.
2334 #define FF_IDCT_AUTO 0
2335 #define FF_IDCT_INT 1
2336 #define FF_IDCT_SIMPLE 2
2337 #define FF_IDCT_SIMPLEMMX 3
2338 #define FF_IDCT_ARM 7
2339 #define FF_IDCT_ALTIVEC 8
2340 #define FF_IDCT_SIMPLEARM 10
2341 #define FF_IDCT_XVID 14
2342 #define FF_IDCT_SIMPLEARMV5TE 16
2343 #define FF_IDCT_SIMPLEARMV6 17
2344 #define FF_IDCT_FAAN 20
2345 #define FF_IDCT_SIMPLENEON 22
2348 * bits per sample/pixel from the demuxer (needed for huffyuv).
2349 * - encoding: Set by libavcodec.
2350 * - decoding: Set by user.
2352 int bits_per_coded_sample;
2355 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2356 * - encoding: set by user.
2357 * - decoding: set by libavcodec.
2359 int bits_per_raw_sample;
2361 #if FF_API_CODED_FRAME
2363 * the picture in the bitstream
2364 * - encoding: Set by libavcodec.
2365 * - decoding: unused
2367 * @deprecated use the quality factor packet side data instead
2369 attribute_deprecated AVFrame *coded_frame;
2374 * is used to decide how many independent tasks should be passed to execute()
2375 * - encoding: Set by user.
2376 * - decoding: Set by user.
2381 * Which multithreading methods to use.
2382 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2383 * so clients which cannot provide future frames should not use it.
2385 * - encoding: Set by user, otherwise the default is used.
2386 * - decoding: Set by user, otherwise the default is used.
2389 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2390 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2393 * Which multithreading methods are in use by the codec.
2394 * - encoding: Set by libavcodec.
2395 * - decoding: Set by libavcodec.
2397 int active_thread_type;
2400 * Set by the client if its custom get_buffer() callback can be called
2401 * synchronously from another thread, which allows faster multithreaded decoding.
2402 * draw_horiz_band() will be called from other threads regardless of this setting.
2403 * Ignored if the default get_buffer() is used.
2404 * - encoding: Set by user.
2405 * - decoding: Set by user.
2407 int thread_safe_callbacks;
2410 * The codec may call this to execute several independent things.
2411 * It will return only after finishing all tasks.
2412 * The user may replace this with some multithreaded implementation,
2413 * the default implementation will execute the parts serially.
2414 * @param count the number of things to execute
2415 * - encoding: Set by libavcodec, user can override.
2416 * - decoding: Set by libavcodec, user can override.
2418 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2421 * The codec may call this to execute several independent things.
2422 * It will return only after finishing all tasks.
2423 * The user may replace this with some multithreaded implementation,
2424 * the default implementation will execute the parts serially.
2425 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2426 * @param c context passed also to func
2427 * @param count the number of things to execute
2428 * @param arg2 argument passed unchanged to func
2429 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2430 * @param func function that will be called count times, with jobnr from 0 to count-1.
2431 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2432 * two instances of func executing at the same time will have the same threadnr.
2433 * @return always 0 currently, but code should handle a future improvement where when any call to func
2434 * returns < 0 no further calls to func may be done and < 0 is returned.
2435 * - encoding: Set by libavcodec, user can override.
2436 * - decoding: Set by libavcodec, user can override.
2438 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2441 * noise vs. sse weight for the nsse comparison function
2442 * - encoding: Set by user.
2443 * - decoding: unused
2449 * - encoding: Set by user.
2450 * - decoding: Set by libavcodec.
2453 #define FF_PROFILE_UNKNOWN -99
2454 #define FF_PROFILE_RESERVED -100
2456 #define FF_PROFILE_AAC_MAIN 0
2457 #define FF_PROFILE_AAC_LOW 1
2458 #define FF_PROFILE_AAC_SSR 2
2459 #define FF_PROFILE_AAC_LTP 3
2460 #define FF_PROFILE_AAC_HE 4
2461 #define FF_PROFILE_AAC_HE_V2 28
2462 #define FF_PROFILE_AAC_LD 22
2463 #define FF_PROFILE_AAC_ELD 38
2464 #define FF_PROFILE_MPEG2_AAC_LOW 128
2465 #define FF_PROFILE_MPEG2_AAC_HE 131
2467 #define FF_PROFILE_DTS 20
2468 #define FF_PROFILE_DTS_ES 30
2469 #define FF_PROFILE_DTS_96_24 40
2470 #define FF_PROFILE_DTS_HD_HRA 50
2471 #define FF_PROFILE_DTS_HD_MA 60
2472 #define FF_PROFILE_DTS_EXPRESS 70
2474 #define FF_PROFILE_MPEG2_422 0
2475 #define FF_PROFILE_MPEG2_HIGH 1
2476 #define FF_PROFILE_MPEG2_SS 2
2477 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2478 #define FF_PROFILE_MPEG2_MAIN 4
2479 #define FF_PROFILE_MPEG2_SIMPLE 5
2481 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2482 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2484 #define FF_PROFILE_H264_BASELINE 66
2485 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2486 #define FF_PROFILE_H264_MAIN 77
2487 #define FF_PROFILE_H264_EXTENDED 88
2488 #define FF_PROFILE_H264_HIGH 100
2489 #define FF_PROFILE_H264_HIGH_10 110
2490 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2491 #define FF_PROFILE_H264_MULTIVIEW_HIGH 118
2492 #define FF_PROFILE_H264_HIGH_422 122
2493 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2494 #define FF_PROFILE_H264_STEREO_HIGH 128
2495 #define FF_PROFILE_H264_HIGH_444 144
2496 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2497 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2498 #define FF_PROFILE_H264_CAVLC_444 44
2500 #define FF_PROFILE_VC1_SIMPLE 0
2501 #define FF_PROFILE_VC1_MAIN 1
2502 #define FF_PROFILE_VC1_COMPLEX 2
2503 #define FF_PROFILE_VC1_ADVANCED 3
2505 #define FF_PROFILE_MPEG4_SIMPLE 0
2506 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2507 #define FF_PROFILE_MPEG4_CORE 2
2508 #define FF_PROFILE_MPEG4_MAIN 3
2509 #define FF_PROFILE_MPEG4_N_BIT 4
2510 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2511 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2512 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2513 #define FF_PROFILE_MPEG4_HYBRID 8
2514 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2515 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2516 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2517 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2518 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2519 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2520 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2522 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 1
2523 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 2
2524 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 32768
2525 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2526 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2528 #define FF_PROFILE_VP9_0 0
2529 #define FF_PROFILE_VP9_1 1
2530 #define FF_PROFILE_VP9_2 2
2531 #define FF_PROFILE_VP9_3 3
2533 #define FF_PROFILE_HEVC_MAIN 1
2534 #define FF_PROFILE_HEVC_MAIN_10 2
2535 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2536 #define FF_PROFILE_HEVC_REXT 4
2540 * - encoding: Set by user.
2541 * - decoding: Set by libavcodec.
2544 #define FF_LEVEL_UNKNOWN -99
2547 * - encoding: unused
2548 * - decoding: Set by user.
2550 enum AVDiscard skip_loop_filter;
2553 * - encoding: unused
2554 * - decoding: Set by user.
2556 enum AVDiscard skip_idct;
2559 * - encoding: unused
2560 * - decoding: Set by user.
2562 enum AVDiscard skip_frame;
2565 * Header containing style information for text subtitles.
2566 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2567 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2568 * the Format line following. It shouldn't include any Dialogue line.
2569 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2570 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2572 uint8_t *subtitle_header;
2573 int subtitle_header_size;
2575 #if FF_API_VBV_DELAY
2577 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2578 * Used for compliant TS muxing.
2579 * - encoding: Set by libavcodec.
2580 * - decoding: unused.
2581 * @deprecated this value is now exported as a part of
2582 * AV_PKT_DATA_CPB_PROPERTIES packet side data
2584 attribute_deprecated
2588 #if FF_API_SIDEDATA_ONLY_PKT
2590 * Encoding only and set by default. Allow encoders to output packets
2591 * that do not contain any encoded data, only side data.
2593 * Some encoders need to output such packets, e.g. to update some stream
2594 * parameters at the end of encoding.
2596 * @deprecated this field disables the default behaviour and
2597 * it is kept only for compatibility.
2599 attribute_deprecated
2600 int side_data_only_packets;
2604 * Audio only. The number of "priming" samples (padding) inserted by the
2605 * encoder at the beginning of the audio. I.e. this number of leading
2606 * decoded samples must be discarded by the caller to get the original audio
2607 * without leading padding.
2609 * - decoding: unused
2610 * - encoding: Set by libavcodec. The timestamps on the output packets are
2611 * adjusted by the encoder so that they always refer to the
2612 * first sample of the data actually contained in the packet,
2613 * including any added padding. E.g. if the timebase is
2614 * 1/samplerate and the timestamp of the first input sample is
2615 * 0, the timestamp of the first output packet will be
2618 int initial_padding;
2621 * - decoding: For codecs that store a framerate value in the compressed
2622 * bitstream, the decoder may export it here. { 0, 1} when
2624 * - encoding: May be used to signal the framerate of CFR content to an
2627 AVRational framerate;
2630 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2631 * - encoding: unused.
2632 * - decoding: Set by libavcodec before calling get_format()
2634 enum AVPixelFormat sw_pix_fmt;
2637 * Additional data associated with the entire coded stream.
2639 * - decoding: unused
2640 * - encoding: may be set by libavcodec after avcodec_open2().
2642 AVPacketSideData *coded_side_data;
2643 int nb_coded_side_data;
2646 * A reference to the AVHWFramesContext describing the input (for encoding)
2647 * or output (decoding) frames. The reference is set by the caller and
2648 * afterwards owned (and freed) by libavcodec - it should never be read by
2649 * the caller after being set.
2651 * - decoding: This field should be set by the caller from the get_format()
2652 * callback. The previous reference (if any) will always be
2653 * unreffed by libavcodec before the get_format() call.
2655 * If the default get_buffer2() is used with a hwaccel pixel
2656 * format, then this AVHWFramesContext will be used for
2657 * allocating the frame buffers.
2659 * - encoding: For hardware encoders configured to use a hwaccel pixel
2660 * format, this field should be set by the caller to a reference
2661 * to the AVHWFramesContext describing input frames.
2662 * AVHWFramesContext.format must be equal to
2663 * AVCodecContext.pix_fmt.
2665 * This field should be set before avcodec_open2() is called.
2667 AVBufferRef *hw_frames_ctx;
2670 * Video decoding only. Certain video codecs support cropping, meaning that
2671 * only a sub-rectangle of the decoded frame is intended for display. This
2672 * option controls how cropping is handled by libavcodec.
2674 * When set to 1 (the default), libavcodec will apply cropping internally.
2675 * I.e. it will modify the output frame width/height fields and offset the
2676 * data pointers (only by as much as possible while preserving alignment, or
2677 * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
2678 * the frames output by the decoder refer only to the cropped area. The
2679 * crop_* fields of the output frames will be zero.
2681 * When set to 0, the width/height fields of the output frames will be set
2682 * to the coded dimensions and the crop_* fields will describe the cropping
2683 * rectangle. Applying the cropping is left to the caller.
2685 * @warning When hardware acceleration with opaque output frames is used,
2686 * libavcodec is unable to apply cropping from the top/left border.
2688 * @note when this option is set to zero, the width/height fields of the
2689 * AVCodecContext and output AVFrames have different meanings. The codec
2690 * context fields store display dimensions (with the coded dimensions in
2691 * coded_width/height), while the frame fields store the coded dimensions
2692 * (with the display dimensions being determined by the crop_* fields).
2697 * A reference to the AVHWDeviceContext describing the device which will
2698 * be used by a hardware encoder/decoder. The reference is set by the
2699 * caller and afterwards owned (and freed) by libavcodec.
2701 * This should be used if either the codec device does not require
2702 * hardware frames or any that are used are to be allocated internally by
2703 * libavcodec. If the user wishes to supply any of the frames used as
2704 * encoder input or decoder output then hw_frames_ctx should be used
2705 * instead. When hw_frames_ctx is set in get_format() for a decoder, this
2706 * field will be ignored while decoding the associated stream segment, but
2707 * may again be used on a following one after another get_format() call.
2709 * For both encoders and decoders this field should be set before
2710 * avcodec_open2() is called and must not be written to thereafter.
2712 * Note that some decoders may require this field to be set initially in
2713 * order to support hw_frames_ctx at all - in that case, all frames
2714 * contexts used must be created on the same device.
2716 AVBufferRef *hw_device_ctx;
2719 * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
2720 * decoding (if active).
2721 * - encoding: unused
2722 * - decoding: Set by user (either before avcodec_open2(), or in the
2723 * AVCodecContext.get_format callback)
2731 typedef struct AVProfile {
2733 const char *name; ///< short name for the profile
2736 typedef struct AVCodecDefault AVCodecDefault;
2743 typedef struct AVCodec {
2745 * Name of the codec implementation.
2746 * The name is globally unique among encoders and among decoders (but an
2747 * encoder and a decoder can share the same name).
2748 * This is the primary way to find a codec from the user perspective.
2752 * Descriptive name for the codec, meant to be more human readable than name.
2753 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2755 const char *long_name;
2756 enum AVMediaType type;
2759 * Codec capabilities.
2760 * see AV_CODEC_CAP_*
2763 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2764 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2765 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2766 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2767 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2768 const AVClass *priv_class; ///< AVClass for the private context
2769 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2771 /*****************************************************************
2772 * No fields below this line are part of the public API. They
2773 * may not be used outside of libavcodec and can be changed and
2775 * New public fields should be added right above.
2776 *****************************************************************
2779 struct AVCodec *next;
2781 * @name Frame-level threading support functions
2785 * If defined, called on thread contexts when they are created.
2786 * If the codec allocates writable tables in init(), re-allocate them here.
2787 * priv_data will be set to a copy of the original.
2789 int (*init_thread_copy)(AVCodecContext *);
2791 * Copy necessary context variables from a previous thread context to the current one.
2792 * If not defined, the next thread will start automatically; otherwise, the codec
2793 * must call ff_thread_finish_setup().
2795 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2797 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2801 * Private codec-specific defaults.
2803 const AVCodecDefault *defaults;
2806 * Initialize codec static data, called from avcodec_register().
2808 void (*init_static_data)(struct AVCodec *codec);
2810 int (*init)(AVCodecContext *);
2811 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2812 const struct AVSubtitle *sub);
2814 * Encode data to an AVPacket.
2816 * @param avctx codec context
2817 * @param avpkt output AVPacket (may contain a user-provided buffer)
2818 * @param[in] frame AVFrame containing the raw data to be encoded
2819 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2820 * non-empty packet was returned in avpkt.
2821 * @return 0 on success, negative error code on failure
2823 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2824 int *got_packet_ptr);
2825 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2826 int (*close)(AVCodecContext *);
2828 * Encode API with decoupled packet/frame dataflow. The API is the
2829 * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
2831 * - never called if the codec is closed or the wrong type,
2832 * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
2833 * - only one drain frame is ever passed down,
2835 int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
2836 int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
2839 * Decode API with decoupled packet/frame dataflow. This function is called
2840 * to get one output frame. It should call ff_decode_get_packet() to obtain
2843 int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
2846 * Will be called when seeking
2848 void (*flush)(AVCodecContext *);
2850 * Internal codec capabilities.
2851 * See FF_CODEC_CAP_* in internal.h
2856 * Decoding only, a comma-separated list of bitstream filters to apply to
2857 * packets before decoding.
2863 * @defgroup lavc_hwaccel AVHWAccel
2866 typedef struct AVHWAccel {
2868 * Name of the hardware accelerated codec.
2869 * The name is globally unique among encoders and among decoders (but an
2870 * encoder and a decoder can share the same name).
2875 * Type of codec implemented by the hardware accelerator.
2877 * See AVMEDIA_TYPE_xxx
2879 enum AVMediaType type;
2882 * Codec implemented by the hardware accelerator.
2884 * See AV_CODEC_ID_xxx
2889 * Supported pixel format.
2891 * Only hardware accelerated formats are supported here.
2893 enum AVPixelFormat pix_fmt;
2896 * Hardware accelerated codec capabilities.
2897 * see FF_HWACCEL_CODEC_CAP_*
2901 /*****************************************************************
2902 * No fields below this line are part of the public API. They
2903 * may not be used outside of libavcodec and can be changed and
2905 * New public fields should be added right above.
2906 *****************************************************************
2908 struct AVHWAccel *next;
2911 * Allocate a custom buffer
2913 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
2916 * Called at the beginning of each frame or field picture.
2918 * Meaningful frame information (codec specific) is guaranteed to
2919 * be parsed at this point. This function is mandatory.
2921 * Note that buf can be NULL along with buf_size set to 0.
2922 * Otherwise, this means the whole frame is available at this point.
2924 * @param avctx the codec context
2925 * @param buf the frame data buffer base
2926 * @param buf_size the size of the frame in bytes
2927 * @return zero if successful, a negative value otherwise
2929 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2932 * Callback for each slice.
2934 * Meaningful slice information (codec specific) is guaranteed to
2935 * be parsed at this point. This function is mandatory.
2937 * @param avctx the codec context
2938 * @param buf the slice data buffer base
2939 * @param buf_size the size of the slice in bytes
2940 * @return zero if successful, a negative value otherwise
2942 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2945 * Called at the end of each frame or field picture.
2947 * The whole picture is parsed at this point and can now be sent
2948 * to the hardware accelerator. This function is mandatory.
2950 * @param avctx the codec context
2951 * @return zero if successful, a negative value otherwise
2953 int (*end_frame)(AVCodecContext *avctx);
2956 * Size of per-frame hardware accelerator private data.
2958 * Private data is allocated with av_mallocz() before
2959 * AVCodecContext.get_buffer() and deallocated after
2960 * AVCodecContext.release_buffer().
2962 int frame_priv_data_size;
2965 * Initialize the hwaccel private data.
2967 * This will be called from ff_get_format(), after hwaccel and
2968 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
2971 int (*init)(AVCodecContext *avctx);
2974 * Uninitialize the hwaccel private data.
2976 * This will be called from get_format() or avcodec_close(), after hwaccel
2977 * and hwaccel_context are already uninitialized.
2979 int (*uninit)(AVCodecContext *avctx);
2982 * Size of the private data to allocate in
2983 * AVCodecInternal.hwaccel_priv_data.
2988 * Internal hwaccel capabilities.
2994 * Hardware acceleration should be used for decoding even if the codec level
2995 * used is unknown or higher than the maximum supported level reported by the
2998 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3001 * Hardware acceleration can output YUV pixel formats with a different chroma
3002 * sampling than 4:2:0 and/or other than 8 bits per component.
3004 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3010 #if FF_API_AVPICTURE
3012 * @defgroup lavc_picture AVPicture
3014 * Functions for working with AVPicture
3019 * four components are given, that's all.
3020 * the last component is alpha
3021 * @deprecated Use the imgutils functions
3023 typedef struct AVPicture {
3024 attribute_deprecated
3025 uint8_t *data[AV_NUM_DATA_POINTERS];
3026 attribute_deprecated
3027 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3035 #define AVPALETTE_SIZE 1024
3036 #define AVPALETTE_COUNT 256
3038 enum AVSubtitleType {
3041 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3044 * Plain text, the text field must be set by the decoder and is
3045 * authoritative. ass and pict fields may contain approximations.
3050 * Formatted text, the ass field must be set by the decoder and is
3051 * authoritative. pict and text fields may contain approximations.
3056 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3058 typedef struct AVSubtitleRect {
3059 int x; ///< top left corner of pict, undefined when pict is not set
3060 int y; ///< top left corner of pict, undefined when pict is not set
3061 int w; ///< width of pict, undefined when pict is not set
3062 int h; ///< height of pict, undefined when pict is not set
3063 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3065 #if FF_API_AVPICTURE
3067 * @deprecated unused
3069 attribute_deprecated
3073 * data+linesize for the bitmap of this subtitle.
3074 * Can be set for text/ass as well once they are rendered.
3079 enum AVSubtitleType type;
3081 char *text; ///< 0 terminated plain UTF-8 text
3084 * 0 terminated ASS/SSA compatible event line.
3085 * The presentation of this is unaffected by the other values in this
3092 typedef struct AVSubtitle {
3093 uint16_t format; /* 0 = graphics */
3094 uint32_t start_display_time; /* relative to packet pts, in ms */
3095 uint32_t end_display_time; /* relative to packet pts, in ms */
3097 AVSubtitleRect **rects;
3098 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3102 * This struct describes the properties of an encoded stream.
3104 * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3105 * be allocated with avcodec_parameters_alloc() and freed with
3106 * avcodec_parameters_free().
3108 typedef struct AVCodecParameters {
3110 * General type of the encoded data.
3112 enum AVMediaType codec_type;
3114 * Specific type of the encoded data (the codec used).
3116 enum AVCodecID codec_id;
3118 * Additional information about the codec (corresponds to the AVI FOURCC).
3123 * Extra binary data needed for initializing the decoder, codec-dependent.
3125 * Must be allocated with av_malloc() and will be freed by
3126 * avcodec_parameters_free(). The allocated size of extradata must be at
3127 * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3132 * Size of the extradata content in bytes.
3137 * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3138 * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3143 * The average bitrate of the encoded data (in bits per second).
3147 int bits_per_coded_sample;
3150 * Codec-specific bitstream restrictions that the stream conforms to.
3156 * Video only. The dimensions of the video frame in pixels.
3162 * Video only. The aspect ratio (width / height) which a single pixel
3163 * should have when displayed.
3165 * When the aspect ratio is unknown / undefined, the numerator should be
3166 * set to 0 (the denominator may have any value).
3168 AVRational sample_aspect_ratio;
3171 * Video only. The order of the fields in interlaced video.
3173 enum AVFieldOrder field_order;
3176 * Video only. Additional colorspace characteristics.
3178 enum AVColorRange color_range;
3179 enum AVColorPrimaries color_primaries;
3180 enum AVColorTransferCharacteristic color_trc;
3181 enum AVColorSpace color_space;
3182 enum AVChromaLocation chroma_location;
3185 * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3186 * unknown or unspecified, otherwise the number of bits set must be equal to
3187 * the channels field.
3189 uint64_t channel_layout;
3191 * Audio only. The number of audio channels.
3195 * Audio only. The number of audio samples per second.
3199 * Audio only. The number of bytes per coded audio frame, required by some
3202 * Corresponds to nBlockAlign in WAVEFORMATEX.
3207 * Audio only. The amount of padding (in samples) inserted by the encoder at
3208 * the beginning of the audio. I.e. this number of leading decoded samples
3209 * must be discarded by the caller to get the original audio without leading
3212 int initial_padding;
3214 * Audio only. The amount of padding (in samples) appended by the encoder to
3215 * the end of the audio. I.e. this number of decoded samples must be
3216 * discarded by the caller from the end of the stream to get the original
3217 * audio without any trailing padding.
3219 int trailing_padding;
3220 } AVCodecParameters;
3223 * If c is NULL, returns the first registered codec,
3224 * if c is non-NULL, returns the next registered codec after c,
3225 * or NULL if c is the last one.
3227 AVCodec *av_codec_next(const AVCodec *c);
3230 * Return the LIBAVCODEC_VERSION_INT constant.
3232 unsigned avcodec_version(void);
3235 * Return the libavcodec build-time configuration.
3237 const char *avcodec_configuration(void);
3240 * Return the libavcodec license.
3242 const char *avcodec_license(void);
3245 * Register the codec codec and initialize libavcodec.
3247 * @warning either this function or avcodec_register_all() must be called
3248 * before any other libavcodec functions.
3250 * @see avcodec_register_all()
3252 void avcodec_register(AVCodec *codec);
3255 * Register all the codecs, parsers and bitstream filters which were enabled at
3256 * configuration time. If you do not call this function you can select exactly
3257 * which formats you want to support, by using the individual registration
3260 * @see avcodec_register
3261 * @see av_register_codec_parser
3262 * @see av_register_bitstream_filter
3264 void avcodec_register_all(void);
3267 * Allocate an AVCodecContext and set its fields to default values. The
3268 * resulting struct should be freed with avcodec_free_context().
3270 * @param codec if non-NULL, allocate private data and initialize defaults
3271 * for the given codec. It is illegal to then call avcodec_open2()
3272 * with a different codec.
3273 * If NULL, then the codec-specific defaults won't be initialized,
3274 * which may result in suboptimal default settings (this is
3275 * important mainly for encoders, e.g. libx264).
3277 * @return An AVCodecContext filled with default values or NULL on failure.
3279 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3282 * Free the codec context and everything associated with it and write NULL to
3283 * the provided pointer.
3285 void avcodec_free_context(AVCodecContext **avctx);
3287 #if FF_API_GET_CONTEXT_DEFAULTS
3289 * @deprecated This function should not be used, as closing and opening a codec
3290 * context multiple time is not supported. A new codec context should be
3291 * allocated for each new use.
3293 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3297 * Get the AVClass for AVCodecContext. It can be used in combination with
3298 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3300 * @see av_opt_find().
3302 const AVClass *avcodec_get_class(void);
3304 #if FF_API_COPY_CONTEXT
3306 * Copy the settings of the source AVCodecContext into the destination
3307 * AVCodecContext. The resulting destination codec context will be
3308 * unopened, i.e. you are required to call avcodec_open2() before you
3309 * can use this AVCodecContext to decode/encode video/audio data.
3311 * @param dest target codec context, should be initialized with
3312 * avcodec_alloc_context3(), but otherwise uninitialized
3313 * @param src source codec context
3314 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3316 * @deprecated The semantics of this function are ill-defined and it should not
3317 * be used. If you need to transfer the stream parameters from one codec context
3318 * to another, use an intermediate AVCodecParameters instance and the
3319 * avcodec_parameters_from_context() / avcodec_parameters_to_context()
3322 attribute_deprecated
3323 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3327 * Allocate a new AVCodecParameters and set its fields to default values
3328 * (unknown/invalid/0). The returned struct must be freed with
3329 * avcodec_parameters_free().
3331 AVCodecParameters *avcodec_parameters_alloc(void);
3334 * Free an AVCodecParameters instance and everything associated with it and
3335 * write NULL to the supplied pointer.
3337 void avcodec_parameters_free(AVCodecParameters **par);
3340 * Copy the contents of src to dst. Any allocated fields in dst are freed and
3341 * replaced with newly allocated duplicates of the corresponding fields in src.
3343 * @return >= 0 on success, a negative AVERROR code on failure.
3345 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
3348 * Fill the parameters struct based on the values from the supplied codec
3349 * context. Any allocated fields in par are freed and replaced with duplicates
3350 * of the corresponding fields in codec.
3352 * @return >= 0 on success, a negative AVERROR code on failure
3354 int avcodec_parameters_from_context(AVCodecParameters *par,
3355 const AVCodecContext *codec);
3358 * Fill the codec context based on the values from the supplied codec
3359 * parameters. Any allocated fields in codec that have a corresponding field in
3360 * par are freed and replaced with duplicates of the corresponding field in par.
3361 * Fields in codec that do not have a counterpart in par are not touched.
3363 * @return >= 0 on success, a negative AVERROR code on failure.
3365 int avcodec_parameters_to_context(AVCodecContext *codec,
3366 const AVCodecParameters *par);
3369 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3370 * function the context has to be allocated with avcodec_alloc_context3().
3372 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3373 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3374 * retrieving a codec.
3376 * @warning This function is not thread safe!
3378 * @note Always call this function before using decoding routines (such as
3379 * @ref avcodec_receive_frame()).
3382 * avcodec_register_all();
3383 * av_dict_set(&opts, "b", "2.5M", 0);
3384 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3388 * context = avcodec_alloc_context3(codec);
3390 * if (avcodec_open2(context, codec, opts) < 0)
3394 * @param avctx The context to initialize.
3395 * @param codec The codec to open this context for. If a non-NULL codec has been
3396 * previously passed to avcodec_alloc_context3() or
3397 * for this context, then this parameter MUST be either NULL or
3398 * equal to the previously passed codec.
3399 * @param options A dictionary filled with AVCodecContext and codec-private options.
3400 * On return this object will be filled with options that were not found.
3402 * @return zero on success, a negative value on error
3403 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3404 * av_dict_set(), av_opt_find().
3406 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3409 * Close a given AVCodecContext and free all the data associated with it
3410 * (but not the AVCodecContext itself).
3412 * Calling this function on an AVCodecContext that hasn't been opened will free
3413 * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
3414 * codec. Subsequent calls will do nothing.
3416 * @note Do not use this function. Use avcodec_free_context() to destroy a
3417 * codec context (either open or closed). Opening and closing a codec context
3418 * multiple times is not supported anymore -- use multiple codec contexts
3421 int avcodec_close(AVCodecContext *avctx);
3424 * Free all allocated data in the given subtitle struct.
3426 * @param sub AVSubtitle to free.
3428 void avsubtitle_free(AVSubtitle *sub);
3435 * @addtogroup lavc_packet
3440 * Allocate an AVPacket and set its fields to default values. The resulting
3441 * struct must be freed using av_packet_free().
3443 * @return An AVPacket filled with default values or NULL on failure.
3445 * @note this only allocates the AVPacket itself, not the data buffers. Those
3446 * must be allocated through other means such as av_new_packet.
3448 * @see av_new_packet
3450 AVPacket *av_packet_alloc(void);
3453 * Create a new packet that references the same data as src.
3455 * This is a shortcut for av_packet_alloc()+av_packet_ref().
3457 * @return newly created AVPacket on success, NULL on error.
3459 * @see av_packet_alloc
3460 * @see av_packet_ref
3462 AVPacket *av_packet_clone(const AVPacket *src);
3465 * Free the packet, if the packet is reference counted, it will be
3466 * unreferenced first.
3468 * @param pkt packet to be freed. The pointer will be set to NULL.
3469 * @note passing NULL is a no-op.
3471 void av_packet_free(AVPacket **pkt);
3474 * Initialize optional fields of a packet with default values.
3476 * Note, this does not touch the data and size members, which have to be
3477 * initialized separately.
3481 void av_init_packet(AVPacket *pkt);
3484 * Allocate the payload of a packet and initialize its fields with
3488 * @param size wanted payload size
3489 * @return 0 if OK, AVERROR_xxx otherwise
3491 int av_new_packet(AVPacket *pkt, int size);
3494 * Reduce packet size, correctly zeroing padding
3497 * @param size new size
3499 void av_shrink_packet(AVPacket *pkt, int size);
3502 * Increase packet size, correctly zeroing padding
3505 * @param grow_by number of bytes by which to increase the size of the packet
3507 int av_grow_packet(AVPacket *pkt, int grow_by);
3510 * Initialize a reference-counted packet from av_malloc()ed data.
3512 * @param pkt packet to be initialized. This function will set the data, size,
3513 * buf and destruct fields, all others are left untouched.
3514 * @param data Data allocated by av_malloc() to be used as packet data. If this
3515 * function returns successfully, the data is owned by the underlying AVBuffer.
3516 * The caller may not access the data through other means.
3517 * @param size size of data in bytes, without the padding. I.e. the full buffer
3518 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
3520 * @return 0 on success, a negative AVERROR on error
3522 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3524 #if FF_API_AVPACKET_OLD_API
3526 * @warning This is a hack - the packet memory allocation stuff is broken. The
3527 * packet is allocated if it was not really allocated.
3529 * @deprecated Use av_packet_ref
3531 attribute_deprecated
3532 int av_dup_packet(AVPacket *pkt);
3536 * @deprecated Use av_packet_unref
3538 * @param pkt packet to free
3540 attribute_deprecated
3541 void av_free_packet(AVPacket *pkt);
3544 * Allocate new information of a packet.
3547 * @param type side information type
3548 * @param size side information size
3549 * @return pointer to fresh allocated data or NULL otherwise
3551 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3555 * Wrap an existing array as a packet side data.
3558 * @param type side information type
3559 * @param data the side data array. It must be allocated with the av_malloc()
3560 * family of functions. The ownership of the data is transferred to
3562 * @param size side information size
3563 * @return a non-negative number on success, a negative AVERROR code on
3564 * failure. On failure, the packet is unchanged and the data remains
3565 * owned by the caller.
3567 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3568 uint8_t *data, size_t size);
3571 * Shrink the already allocated side data buffer
3574 * @param type side information type
3575 * @param size new side information size
3576 * @return 0 on success, < 0 on failure
3578 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3582 * Get side information from packet.
3585 * @param type desired side information type
3586 * @param size pointer for side information size to store (optional)
3587 * @return pointer to data if present or NULL otherwise
3589 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3593 * Convenience function to free all the side data stored.
3594 * All the other fields stay untouched.
3598 void av_packet_free_side_data(AVPacket *pkt);
3601 * Setup a new reference to the data described by a given packet
3603 * If src is reference-counted, setup dst as a new reference to the
3604 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3605 * data from src into it.
3607 * All the other fields are copied from src.
3609 * @see av_packet_unref
3611 * @param dst Destination packet
3612 * @param src Source packet
3614 * @return 0 on success, a negative AVERROR on error.
3616 int av_packet_ref(AVPacket *dst, const AVPacket *src);
3621 * Unreference the buffer referenced by the packet and reset the
3622 * remaining packet fields to their default values.
3624 * @param pkt The packet to be unreferenced.
3626 void av_packet_unref(AVPacket *pkt);
3629 * Move every field in src to dst and reset src.
3631 * @see av_packet_unref
3633 * @param src Source packet, will be reset
3634 * @param dst Destination packet
3636 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3639 * Copy only "properties" fields from src to dst.
3641 * Properties for the purpose of this function are all the fields
3642 * beside those related to the packet data (buf, data, size)
3644 * @param dst Destination packet
3645 * @param src Source packet
3647 * @return 0 on success AVERROR on failure.
3649 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3652 * Convert valid timing fields (timestamps / durations) in a packet from one
3653 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3656 * @param pkt packet on which the conversion will be performed
3657 * @param tb_src source timebase, in which the timing fields in pkt are
3659 * @param tb_dst destination timebase, to which the timing fields will be
3662 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
3669 * @addtogroup lavc_decoding
3674 * Find a registered decoder with a matching codec ID.
3676 * @param id AVCodecID of the requested decoder
3677 * @return A decoder if one was found, NULL otherwise.
3679 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3682 * Find a registered decoder with the specified name.
3684 * @param name name of the requested decoder
3685 * @return A decoder if one was found, NULL otherwise.
3687 AVCodec *avcodec_find_decoder_by_name(const char *name);
3690 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3691 * it can be called by custom get_buffer2() implementations for decoders without
3692 * AV_CODEC_CAP_DR1 set.
3694 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3697 * Modify width and height values so that they will result in a memory
3698 * buffer that is acceptable for the codec if you do not use any horizontal
3701 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3703 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3706 * Modify width and height values so that they will result in a memory
3707 * buffer that is acceptable for the codec if you also ensure that all
3708 * line sizes are a multiple of the respective linesize_align[i].
3710 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3712 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3713 int linesize_align[AV_NUM_DATA_POINTERS]);
3716 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3718 * Some decoders may support multiple frames in a single AVPacket. Such
3719 * decoders would then just decode the first frame and the return value would be
3720 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3721 * called again with an AVPacket containing the remaining data in order to
3722 * decode the second frame, etc... Even if no frames are returned, the packet
3723 * needs to be fed to the decoder with remaining data until it is completely
3724 * consumed or an error occurs.
3726 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3727 * and output. This means that for some packets they will not immediately
3728 * produce decoded output and need to be flushed at the end of decoding to get
3729 * all the decoded data. Flushing is done by calling this function with packets
3730 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3731 * returning samples. It is safe to flush even those decoders that are not
3732 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
3734 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3735 * larger than the actual read bytes because some optimized bitstream
3736 * readers read 32 or 64 bits at once and could read over the end.
3738 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3739 * before packets may be fed to the decoder.
3741 * @param avctx the codec context
3742 * @param[out] frame The AVFrame in which to store decoded audio samples.
3743 * The decoder will allocate a buffer for the decoded frame by
3744 * calling the AVCodecContext.get_buffer2() callback.
3745 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3746 * reference counted and the returned reference belongs to the
3747 * caller. The caller must release the frame using av_frame_unref()
3748 * when the frame is no longer needed. The caller may safely write
3749 * to the frame if av_frame_is_writable() returns 1.
3750 * When AVCodecContext.refcounted_frames is set to 0, the returned
3751 * reference belongs to the decoder and is valid only until the
3752 * next call to this function or until closing or flushing the
3753 * decoder. The caller may not write to it.
3754 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3755 * non-zero. Note that this field being set to zero
3756 * does not mean that an error has occurred. For
3757 * decoders with AV_CODEC_CAP_DELAY set, no given decode
3758 * call is guaranteed to produce a frame.
3759 * @param[in] avpkt The input AVPacket containing the input buffer.
3760 * At least avpkt->data and avpkt->size should be set. Some
3761 * decoders might also require additional fields to be set.
3762 * @return A negative error code is returned if an error occurred during
3763 * decoding, otherwise the number of bytes consumed from the input
3764 * AVPacket is returned.
3766 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3768 attribute_deprecated
3769 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3770 int *got_frame_ptr, AVPacket *avpkt);
3773 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3774 * Some decoders may support multiple frames in a single AVPacket, such
3775 * decoders would then just decode the first frame.
3777 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
3778 * the actual read bytes because some optimized bitstream readers read 32 or 64
3779 * bits at once and could read over the end.
3781 * @warning The end of the input buffer buf should be set to 0 to ensure that
3782 * no overreading happens for damaged MPEG streams.
3784 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
3785 * between input and output, these need to be fed with avpkt->data=NULL,
3786 * avpkt->size=0 at the end to return the remaining frames.
3788 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3789 * before packets may be fed to the decoder.
3791 * @param avctx the codec context
3792 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3793 * Use av_frame_alloc() to get an AVFrame. The codec will
3794 * allocate memory for the actual bitmap by calling the
3795 * AVCodecContext.get_buffer2() callback.
3796 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3797 * reference counted and the returned reference belongs to the
3798 * caller. The caller must release the frame using av_frame_unref()
3799 * when the frame is no longer needed. The caller may safely write
3800 * to the frame if av_frame_is_writable() returns 1.
3801 * When AVCodecContext.refcounted_frames is set to 0, the returned
3802 * reference belongs to the decoder and is valid only until the
3803 * next call to this function or until closing or flushing the
3804 * decoder. The caller may not write to it.
3806 * @param[in] avpkt The input AVPacket containing the input buffer.
3807 * You can create such packet with av_init_packet() and by then setting
3808 * data and size, some decoders might in addition need other fields like
3809 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3811 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3812 * @return On error a negative value is returned, otherwise the number of bytes
3813 * used or zero if no frame could be decompressed.
3815 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3817 attribute_deprecated
3818 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3819 int *got_picture_ptr,
3823 * Decode a subtitle message.
3824 * Return a negative value on error, otherwise return the number of bytes used.
3825 * If no subtitle could be decompressed, got_sub_ptr is zero.
3826 * Otherwise, the subtitle is stored in *sub.
3827 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3828 * simplicity, because the performance difference is expect to be negligible
3829 * and reusing a get_buffer written for video codecs would probably perform badly
3830 * due to a potentially very different allocation pattern.
3832 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3833 * before packets may be fed to the decoder.
3835 * @param avctx the codec context
3836 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3837 freed with avsubtitle_free if *got_sub_ptr is set.
3838 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3839 * @param[in] avpkt The input AVPacket containing the input buffer.
3841 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3846 * Supply raw packet data as input to a decoder.
3848 * Internally, this call will copy relevant AVCodecContext fields, which can
3849 * influence decoding per-packet, and apply them when the packet is actually
3850 * decoded. (For example AVCodecContext.skip_frame, which might direct the
3851 * decoder to drop the frame contained by the packet sent with this function.)
3853 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3854 * larger than the actual read bytes because some optimized bitstream
3855 * readers read 32 or 64 bits at once and could read over the end.
3857 * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
3858 * on the same AVCodecContext. It will return unexpected results now
3859 * or in future libavcodec versions.
3861 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3862 * before packets may be fed to the decoder.
3864 * @param avctx codec context
3865 * @param[in] avpkt The input AVPacket. Usually, this will be a single video
3866 * frame, or several complete audio frames.
3867 * Ownership of the packet remains with the caller, and the
3868 * decoder will not write to the packet. The decoder may create
3869 * a reference to the packet data (or copy it if the packet is
3870 * not reference-counted).
3871 * Unlike with older APIs, the packet is always fully consumed,
3872 * and if it contains multiple frames (e.g. some audio codecs),
3873 * will require you to call avcodec_receive_frame() multiple
3874 * times afterwards before you can send a new packet.
3875 * It can be NULL (or an AVPacket with data set to NULL and
3876 * size set to 0); in this case, it is considered a flush
3877 * packet, which signals the end of the stream. Sending the
3878 * first flush packet will return success. Subsequent ones are
3879 * unnecessary and will return AVERROR_EOF. If the decoder
3880 * still has frames buffered, it will return them after sending
3883 * @return 0 on success, otherwise negative error code:
3884 * AVERROR(EAGAIN): input is not accepted in the current state - user
3885 * must read output with avcodec_receive_frame() (once
3886 * all output is read, the packet should be resent, and
3887 * the call will not fail with EAGAIN).
3888 * AVERROR_EOF: the decoder has been flushed, and no new packets can
3889 * be sent to it (also returned if more than 1 flush
3891 * AVERROR(EINVAL): codec not opened, it is an encoder, or requires flush
3892 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
3893 * other errors: legitimate decoding errors
3895 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
3898 * Return decoded output data from a decoder.
3900 * @param avctx codec context
3901 * @param frame This will be set to a reference-counted video or audio
3902 * frame (depending on the decoder type) allocated by the
3903 * decoder. Note that the function will always call
3904 * av_frame_unref(frame) before doing anything else.
3907 * 0: success, a frame was returned
3908 * AVERROR(EAGAIN): output is not available in this state - user must try
3910 * AVERROR_EOF: the decoder has been fully flushed, and there will be
3911 * no more output frames
3912 * AVERROR(EINVAL): codec not opened, or it is an encoder
3913 * other negative values: legitimate decoding errors
3915 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
3918 * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
3919 * to retrieve buffered output packets.
3921 * @param avctx codec context
3922 * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
3923 * Ownership of the frame remains with the caller, and the
3924 * encoder will not write to the frame. The encoder may create
3925 * a reference to the frame data (or copy it if the frame is
3926 * not reference-counted).
3927 * It can be NULL, in which case it is considered a flush
3928 * packet. This signals the end of the stream. If the encoder
3929 * still has packets buffered, it will return them after this
3930 * call. Once flushing mode has been entered, additional flush
3931 * packets are ignored, and sending frames will return
3935 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3936 * can have any number of samples.
3937 * If it is not set, frame->nb_samples must be equal to
3938 * avctx->frame_size for all frames except the last.
3939 * The final frame may be smaller than avctx->frame_size.
3940 * @return 0 on success, otherwise negative error code:
3941 * AVERROR(EAGAIN): input is not accepted in the current state - user
3942 * must read output with avcodec_receive_packet() (once
3943 * all output is read, the packet should be resent, and
3944 * the call will not fail with EAGAIN).
3945 * AVERROR_EOF: the encoder has been flushed, and no new frames can
3947 * AVERROR(EINVAL): codec not opened, refcounted_frames not set, it is a
3948 * decoder, or requires flush
3949 * AVERROR(ENOMEM): failed to add packet to internal queue, or similar
3950 * other errors: legitimate decoding errors
3952 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
3955 * Read encoded data from the encoder.
3957 * @param avctx codec context
3958 * @param avpkt This will be set to a reference-counted packet allocated by the
3959 * encoder. Note that the function will always call
3960 * av_frame_unref(frame) before doing anything else.
3961 * @return 0 on success, otherwise negative error code:
3962 * AVERROR(EAGAIN): output is not available in the current state - user
3963 * must try to send input
3964 * AVERROR_EOF: the encoder has been fully flushed, and there will be
3965 * no more output packets
3966 * AVERROR(EINVAL): codec not opened, or it is an encoder
3967 * other errors: legitimate decoding errors
3969 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
3973 * @defgroup lavc_parsing Frame parsing
3977 enum AVPictureStructure {
3978 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3979 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3980 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3981 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3984 typedef struct AVCodecParserContext {
3986 struct AVCodecParser *parser;
3987 int64_t frame_offset; /* offset of the current frame */
3988 int64_t cur_offset; /* current offset
3989 (incremented by each av_parser_parse()) */
3990 int64_t next_frame_offset; /* offset of the next frame */
3992 int pict_type; /* XXX: Put it back in AVCodecContext. */
3994 * This field is used for proper frame duration computation in lavf.
3995 * It signals, how much longer the frame duration of the current frame
3996 * is compared to normal frame duration.
3998 * frame_duration = (1 + repeat_pict) * time_base
4000 * It is used by codecs like H.264 to display telecined material.
4002 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4003 int64_t pts; /* pts of the current frame */
4004 int64_t dts; /* dts of the current frame */
4009 int fetch_timestamp;
4011 #define AV_PARSER_PTS_NB 4
4012 int cur_frame_start_index;
4013 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4014 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4015 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4018 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4019 #define PARSER_FLAG_ONCE 0x0002
4020 /// Set if the parser has a valid file offset
4021 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4023 int64_t offset; ///< byte offset from starting packet start
4024 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4027 * Set by parser to 1 for key frames and 0 for non-key frames.
4028 * It is initialized to -1, so if the parser doesn't set this flag,
4029 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4034 #if FF_API_CONVERGENCE_DURATION
4036 * @deprecated unused
4038 attribute_deprecated
4039 int64_t convergence_duration;
4042 // Timestamp generation support:
4044 * Synchronization point for start of timestamp generation.
4046 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4049 * For example, this corresponds to presence of H.264 buffering period
4055 * Offset of the current timestamp against last timestamp sync point in
4056 * units of AVCodecContext.time_base.
4058 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4059 * contain a valid timestamp offset.
4061 * Note that the timestamp of sync point has usually a nonzero
4062 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4063 * the next frame after timestamp sync point will be usually 1.
4065 * For example, this corresponds to H.264 cpb_removal_delay.
4067 int dts_ref_dts_delta;
4070 * Presentation delay of current frame in units of AVCodecContext.time_base.
4072 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4073 * contain valid non-negative timestamp delta (presentation time of a frame
4074 * must not lie in the past).
4076 * This delay represents the difference between decoding and presentation
4077 * time of the frame.
4079 * For example, this corresponds to H.264 dpb_output_delay.
4084 * Position of the packet in file.
4086 * Analogous to cur_frame_pts/dts
4088 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4091 * Byte position of currently parsed frame in stream.
4096 * Previous frame byte position.
4101 * Duration of the current frame.
4102 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4103 * For all other types, this is in units of AVCodecContext.time_base.
4107 enum AVFieldOrder field_order;
4110 * Indicate whether a picture is coded as a frame, top field or bottom field.
4112 * For example, H.264 field_pic_flag equal to 0 corresponds to
4113 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4114 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4115 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4117 enum AVPictureStructure picture_structure;
4120 * Picture number incremented in presentation or output order.
4121 * This field may be reinitialized at the first picture of a new sequence.
4123 * For example, this corresponds to H.264 PicOrderCnt.
4125 int output_picture_number;
4128 * Dimensions of the decoded video intended for presentation.
4134 * Dimensions of the coded video.
4140 * The format of the coded data, corresponds to enum AVPixelFormat for video
4141 * and for enum AVSampleFormat for audio.
4143 * Note that a decoder can have considerable freedom in how exactly it
4144 * decodes the data, so the format reported here might be different from the
4145 * one returned by a decoder.
4148 } AVCodecParserContext;
4150 typedef struct AVCodecParser {
4151 int codec_ids[5]; /* several codec IDs are permitted */
4153 int (*parser_init)(AVCodecParserContext *s);
4154 /* This callback never returns an error, a negative value means that
4155 * the frame start was in a previous packet. */
4156 int (*parser_parse)(AVCodecParserContext *s,
4157 AVCodecContext *avctx,
4158 const uint8_t **poutbuf, int *poutbuf_size,
4159 const uint8_t *buf, int buf_size);
4160 void (*parser_close)(AVCodecParserContext *s);
4161 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4162 struct AVCodecParser *next;
4165 AVCodecParser *av_parser_next(const AVCodecParser *c);
4167 void av_register_codec_parser(AVCodecParser *parser);
4168 AVCodecParserContext *av_parser_init(int codec_id);
4173 * @param s parser context.
4174 * @param avctx codec context.
4175 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4176 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4177 * @param buf input buffer.
4178 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4179 * @param pts input presentation timestamp.
4180 * @param dts input decoding timestamp.
4181 * @param pos input byte position in stream.
4182 * @return the number of bytes of the input bitstream used.
4187 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4194 * decode_frame(data, size);
4198 int av_parser_parse2(AVCodecParserContext *s,
4199 AVCodecContext *avctx,
4200 uint8_t **poutbuf, int *poutbuf_size,
4201 const uint8_t *buf, int buf_size,
4202 int64_t pts, int64_t dts,
4206 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4207 * @deprecated use AVBitstreamFilter
4209 int av_parser_change(AVCodecParserContext *s,
4210 AVCodecContext *avctx,
4211 uint8_t **poutbuf, int *poutbuf_size,
4212 const uint8_t *buf, int buf_size, int keyframe);
4213 void av_parser_close(AVCodecParserContext *s);
4221 * @addtogroup lavc_encoding
4226 * Find a registered encoder with a matching codec ID.
4228 * @param id AVCodecID of the requested encoder
4229 * @return An encoder if one was found, NULL otherwise.
4231 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4234 * Find a registered encoder with the specified name.
4236 * @param name name of the requested encoder
4237 * @return An encoder if one was found, NULL otherwise.
4239 AVCodec *avcodec_find_encoder_by_name(const char *name);
4242 * Encode a frame of audio.
4244 * Takes input samples from frame and writes the next output packet, if
4245 * available, to avpkt. The output packet does not necessarily contain data for
4246 * the most recent frame, as encoders can delay, split, and combine input frames
4247 * internally as needed.
4249 * @param avctx codec context
4250 * @param avpkt output AVPacket.
4251 * The user can supply an output buffer by setting
4252 * avpkt->data and avpkt->size prior to calling the
4253 * function, but if the size of the user-provided data is not
4254 * large enough, encoding will fail. All other AVPacket fields
4255 * will be reset by the encoder using av_init_packet(). If
4256 * avpkt->data is NULL, the encoder will allocate it.
4257 * The encoder will set avpkt->size to the size of the
4260 * If this function fails or produces no output, avpkt will be
4261 * freed using av_packet_unref().
4262 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4263 * May be NULL when flushing an encoder that has the
4264 * AV_CODEC_CAP_DELAY capability set.
4265 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4266 * can have any number of samples.
4267 * If it is not set, frame->nb_samples must be equal to
4268 * avctx->frame_size for all frames except the last.
4269 * The final frame may be smaller than avctx->frame_size.
4270 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4271 * output packet is non-empty, and to 0 if it is
4272 * empty. If the function returns an error, the
4273 * packet can be assumed to be invalid, and the
4274 * value of got_packet_ptr is undefined and should
4276 * @return 0 on success, negative error code on failure
4278 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4280 attribute_deprecated
4281 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4282 const AVFrame *frame, int *got_packet_ptr);
4285 * Encode a frame of video.
4287 * Takes input raw video data from frame and writes the next output packet, if
4288 * available, to avpkt. The output packet does not necessarily contain data for
4289 * the most recent frame, as encoders can delay and reorder input frames
4290 * internally as needed.
4292 * @param avctx codec context
4293 * @param avpkt output AVPacket.
4294 * The user can supply an output buffer by setting
4295 * avpkt->data and avpkt->size prior to calling the
4296 * function, but if the size of the user-provided data is not
4297 * large enough, encoding will fail. All other AVPacket fields
4298 * will be reset by the encoder using av_init_packet(). If
4299 * avpkt->data is NULL, the encoder will allocate it.
4300 * The encoder will set avpkt->size to the size of the
4301 * output packet. The returned data (if any) belongs to the
4302 * caller, he is responsible for freeing it.
4304 * If this function fails or produces no output, avpkt will be
4305 * freed using av_packet_unref().
4306 * @param[in] frame AVFrame containing the raw video data to be encoded.
4307 * May be NULL when flushing an encoder that has the
4308 * AV_CODEC_CAP_DELAY capability set.
4309 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4310 * output packet is non-empty, and to 0 if it is
4311 * empty. If the function returns an error, the
4312 * packet can be assumed to be invalid, and the
4313 * value of got_packet_ptr is undefined and should
4315 * @return 0 on success, negative error code on failure
4317 * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4319 attribute_deprecated
4320 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4321 const AVFrame *frame, int *got_packet_ptr);
4323 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4324 const AVSubtitle *sub);
4331 #if FF_API_AVPICTURE
4333 * @addtogroup lavc_picture
4338 * @deprecated unused
4340 attribute_deprecated
4341 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4344 * @deprecated unused
4346 attribute_deprecated
4347 void avpicture_free(AVPicture *picture);
4350 * @deprecated use av_image_fill_arrays() instead.
4352 attribute_deprecated
4353 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4354 enum AVPixelFormat pix_fmt, int width, int height);
4357 * @deprecated use av_image_copy_to_buffer() instead.
4359 attribute_deprecated
4360 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4361 int width, int height,
4362 unsigned char *dest, int dest_size);
4365 * @deprecated use av_image_get_buffer_size() instead.
4367 attribute_deprecated
4368 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4371 * @deprecated av_image_copy() instead.
4373 attribute_deprecated
4374 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4375 enum AVPixelFormat pix_fmt, int width, int height);
4378 * @deprecated unused
4380 attribute_deprecated
4381 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4382 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4385 * @deprecated unused
4387 attribute_deprecated
4388 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4389 int padtop, int padbottom, int padleft, int padright, int *color);
4397 * @defgroup lavc_misc Utility functions
4400 * Miscellaneous utility functions related to both encoding and decoding
4406 * @defgroup lavc_misc_pixfmt Pixel formats
4408 * Functions for working with pixel formats.
4413 * Return a value representing the fourCC code associated to the
4414 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4417 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4419 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4420 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4421 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4422 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4423 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4424 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4427 * Compute what kind of losses will occur when converting from one specific
4428 * pixel format to another.
4429 * When converting from one pixel format to another, information loss may occur.
4430 * For example, when converting from RGB24 to GRAY, the color information will
4431 * be lost. Similarly, other losses occur when converting from some formats to
4432 * other formats. These losses can involve loss of chroma, but also loss of
4433 * resolution, loss of color depth, loss due to the color space conversion, loss
4434 * of the alpha bits or loss due to color quantization.
4435 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4436 * which will occur when converting from one pixel format to another.
4438 * @param[in] dst_pix_fmt destination pixel format
4439 * @param[in] src_pix_fmt source pixel format
4440 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4441 * @return Combination of flags informing you what kind of losses will occur.
4443 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4447 * Find the best pixel format to convert to given a certain source pixel
4448 * format. When converting from one pixel format to another, information loss
4449 * may occur. For example, when converting from RGB24 to GRAY, the color
4450 * information will be lost. Similarly, other losses occur when converting from
4451 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4452 * the given pixel formats should be used to suffer the least amount of loss.
4453 * The pixel formats from which it chooses one, are determined by the
4454 * pix_fmt_list parameter.
4457 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4458 * @param[in] src_pix_fmt source pixel format
4459 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4460 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4461 * @return The best pixel format to convert to or -1 if none was found.
4463 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4464 enum AVPixelFormat src_pix_fmt,
4465 int has_alpha, int *loss_ptr);
4467 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4474 * Put a string representing the codec tag codec_tag in buf.
4476 * @param buf buffer to place codec tag in
4477 * @param buf_size size in bytes of buf
4478 * @param codec_tag codec tag to assign
4479 * @return the length of the string that would have been generated if
4480 * enough space had been available, excluding the trailing null
4482 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4484 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4487 * Return a name for the specified profile, if available.
4489 * @param codec the codec that is searched for the given profile
4490 * @param profile the profile value for which a name is requested
4491 * @return A name for the profile if found, NULL otherwise.
4493 const char *av_get_profile_name(const AVCodec *codec, int profile);
4496 * Return a name for the specified profile, if available.
4498 * @param codec_id the ID of the codec to which the requested profile belongs
4499 * @param profile the profile value for which a name is requested
4500 * @return A name for the profile if found, NULL otherwise.
4502 * @note unlike av_get_profile_name(), which searches a list of profiles
4503 * supported by a specific decoder or encoder implementation, this
4504 * function searches the list of profiles from the AVCodecDescriptor
4506 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
4508 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4509 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4510 //FIXME func typedef
4513 * Fill audio frame data and linesize.
4514 * AVFrame extended_data channel pointers are allocated if necessary for
4517 * @param frame the AVFrame
4518 * frame->nb_samples must be set prior to calling the
4519 * function. This function fills in frame->data,
4520 * frame->extended_data, frame->linesize[0].
4521 * @param nb_channels channel count
4522 * @param sample_fmt sample format
4523 * @param buf buffer to use for frame data
4524 * @param buf_size size of buffer
4525 * @param align plane size sample alignment (0 = default)
4526 * @return 0 on success, negative error code on failure
4528 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4529 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4530 int buf_size, int align);
4533 * Reset the internal decoder state / flush internal buffers. Should be called
4534 * e.g. when seeking or when switching to a different stream.
4536 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4537 * this invalidates the frames previously returned from the decoder. When
4538 * refcounted frames are used, the decoder just releases any references it might
4539 * keep internally, but the caller's reference remains valid.
4541 void avcodec_flush_buffers(AVCodecContext *avctx);
4544 * Return codec bits per sample.
4546 * @param[in] codec_id the codec
4547 * @return Number of bits per sample or zero if unknown for the given codec.
4549 int av_get_bits_per_sample(enum AVCodecID codec_id);
4552 * Return codec bits per sample.
4553 * Only return non-zero if the bits per sample is exactly correct, not an
4556 * @param[in] codec_id the codec
4557 * @return Number of bits per sample or zero if unknown for the given codec.
4559 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4562 * Return audio frame duration.
4564 * @param avctx codec context
4565 * @param frame_bytes size of the frame, or 0 if unknown
4566 * @return frame duration, in samples, if known. 0 if not able to
4569 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4572 * This function is the same as av_get_audio_frame_duration(), except it works
4573 * with AVCodecParameters instead of an AVCodecContext.
4575 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
4578 typedef struct AVBitStreamFilterContext {
4580 struct AVBitStreamFilter *filter;
4581 AVCodecParserContext *parser;
4582 struct AVBitStreamFilterContext *next;
4583 } AVBitStreamFilterContext;
4586 typedef struct AVBSFInternal AVBSFInternal;
4589 * The bitstream filter state.
4591 * This struct must be allocated with av_bsf_alloc() and freed with
4594 * The fields in the struct will only be changed (by the caller or by the
4595 * filter) as described in their documentation, and are to be considered
4596 * immutable otherwise.
4598 typedef struct AVBSFContext {
4600 * A class for logging and AVOptions
4602 const AVClass *av_class;
4605 * The bitstream filter this context is an instance of.
4607 const struct AVBitStreamFilter *filter;
4610 * Opaque libavcodec internal data. Must not be touched by the caller in any
4613 AVBSFInternal *internal;
4616 * Opaque filter-specific private data. If filter->priv_class is non-NULL,
4617 * this is an AVOptions-enabled struct.
4622 * Parameters of the input stream. This field is allocated in
4623 * av_bsf_alloc(), it needs to be filled by the caller before
4626 AVCodecParameters *par_in;
4629 * Parameters of the output stream. This field is allocated in
4630 * av_bsf_alloc(), it is set by the filter in av_bsf_init().
4632 AVCodecParameters *par_out;
4635 * The timebase used for the timestamps of the input packets. Set by the
4636 * caller before av_bsf_init().
4638 AVRational time_base_in;
4641 * The timebase used for the timestamps of the output packets. Set by the
4642 * filter in av_bsf_init().
4644 AVRational time_base_out;
4647 typedef struct AVBitStreamFilter {
4651 * A list of codec ids supported by the filter, terminated by
4653 * May be NULL, in that case the bitstream filter works with any codec id.
4655 const enum AVCodecID *codec_ids;
4658 * A class for the private data, used to declare bitstream filter private
4659 * AVOptions. This field is NULL for bitstream filters that do not declare
4662 * If this field is non-NULL, the first member of the filter private data
4663 * must be a pointer to AVClass, which will be set by libavcodec generic
4664 * code to this class.
4666 const AVClass *priv_class;
4668 /*****************************************************************
4669 * No fields below this line are part of the public API. They
4670 * may not be used outside of libavcodec and can be changed and
4672 * New public fields should be added right above.
4673 *****************************************************************
4677 int (*init)(AVBSFContext *ctx);
4678 int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
4679 void (*close)(AVBSFContext *ctx);
4680 } AVBitStreamFilter;
4684 * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
4685 * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
4687 attribute_deprecated
4688 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4689 attribute_deprecated
4690 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4691 attribute_deprecated
4692 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4693 AVCodecContext *avctx, const char *args,
4694 uint8_t **poutbuf, int *poutbuf_size,
4695 const uint8_t *buf, int buf_size, int keyframe);
4696 attribute_deprecated
4697 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4698 attribute_deprecated
4699 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
4703 * @return a bitstream filter with the specified name or NULL if no such
4704 * bitstream filter exists.
4706 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
4709 * Iterate over all registered bitstream filters.
4711 * @param opaque a pointer where libavcodec will store the iteration state. Must
4712 * point to NULL to start the iteration.
4714 * @return the next registered bitstream filter or NULL when the iteration is
4717 const AVBitStreamFilter *av_bsf_next(void **opaque);
4720 * Allocate a context for a given bitstream filter. The caller must fill in the
4721 * context parameters as described in the documentation and then call
4722 * av_bsf_init() before sending any data to the filter.
4724 * @param filter the filter for which to allocate an instance.
4725 * @param ctx a pointer into which the pointer to the newly-allocated context
4726 * will be written. It must be freed with av_bsf_free() after the
4727 * filtering is done.
4729 * @return 0 on success, a negative AVERROR code on failure
4731 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
4734 * Prepare the filter for use, after all the parameters and options have been
4737 int av_bsf_init(AVBSFContext *ctx);
4740 * Submit a packet for filtering.
4742 * After sending each packet, the filter must be completely drained by calling
4743 * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
4746 * @param pkt the packet to filter. The bitstream filter will take ownership of
4747 * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
4748 * This parameter may be NULL, which signals the end of the stream (i.e. no more
4749 * packets will be sent). That will cause the filter to output any packets it
4750 * may have buffered internally.
4752 * @return 0 on success, a negative AVERROR on error.
4754 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
4757 * Retrieve a filtered packet.
4759 * @param[out] pkt this struct will be filled with the contents of the filtered
4760 * packet. It is owned by the caller and must be freed using
4761 * av_packet_unref() when it is no longer needed.
4762 * This parameter should be "clean" (i.e. freshly allocated
4763 * with av_packet_alloc() or unreffed with av_packet_unref())
4764 * when this function is called. If this function returns
4765 * successfully, the contents of pkt will be completely
4766 * overwritten by the returned data. On failure, pkt is not
4769 * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
4770 * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
4771 * will be no further output from the filter. Another negative AVERROR value if
4774 * @note one input packet may result in several output packets, so after sending
4775 * a packet with av_bsf_send_packet(), this function needs to be called
4776 * repeatedly until it stops returning 0. It is also possible for a filter to
4777 * output fewer packets than were sent to it, so this function may return
4778 * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
4780 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
4783 * Free a bitstream filter context and everything associated with it; write NULL
4784 * into the supplied pointer.
4786 void av_bsf_free(AVBSFContext **ctx);
4789 * Get the AVClass for AVBSFContext. It can be used in combination with
4790 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4792 * @see av_opt_find().
4794 const AVClass *av_bsf_get_class(void);
4799 * Allocate a buffer with padding, reusing the given one if large enough.
4801 * Same behaviour av_fast_malloc but the buffer has additional
4802 * AV_INPUT_PADDING_SIZE at the end which will always memset to 0.
4804 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4807 * Encode extradata length to a buffer. Used by xiph codecs.
4809 * @param s buffer to write to; must be at least (v/255+1) bytes long
4810 * @param v size of extradata in bytes
4811 * @return number of bytes written to the buffer.
4813 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4816 * Register the hardware accelerator hwaccel.
4818 void av_register_hwaccel(AVHWAccel *hwaccel);
4821 * If hwaccel is NULL, returns the first registered hardware accelerator,
4822 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4823 * after hwaccel, or NULL if hwaccel is the last one.
4825 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
4829 * Lock operation used by lockmgr
4832 AV_LOCK_CREATE, ///< Create a mutex
4833 AV_LOCK_OBTAIN, ///< Lock the mutex
4834 AV_LOCK_RELEASE, ///< Unlock the mutex
4835 AV_LOCK_DESTROY, ///< Free mutex resources
4839 * Register a user provided lock manager supporting the operations
4840 * specified by AVLockOp. The "mutex" argument to the function points
4841 * to a (void *) where the lockmgr should store/get a pointer to a user
4842 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
4843 * value left by the last call for all other ops. If the lock manager is
4844 * unable to perform the op then it should leave the mutex in the same
4845 * state as when it was called and return a non-zero value. However,
4846 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
4847 * have been successfully destroyed. If av_lockmgr_register succeeds
4848 * it will return a non-negative value, if it fails it will return a
4849 * negative value and destroy all mutex and unregister all callbacks.
4850 * av_lockmgr_register is not thread-safe, it must be called from a
4851 * single thread before any calls which make use of locking are used.
4853 * @param cb User defined callback. av_lockmgr_register invokes calls
4854 * to this callback and the previously registered callback.
4855 * The callback will be used to create more than one mutex
4856 * each of which must be backed by its own underlying locking
4857 * mechanism (i.e. do not use a single static object to
4858 * implement your lock manager). If cb is set to NULL the
4859 * lockmgr will be unregistered.
4861 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4864 * Get the type of the given codec.
4866 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4869 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4870 * with no corresponding avcodec_close()), 0 otherwise.
4872 int avcodec_is_open(AVCodecContext *s);
4875 * @return a non-zero number if codec is an encoder, zero otherwise
4877 int av_codec_is_encoder(const AVCodec *codec);
4880 * @return a non-zero number if codec is a decoder, zero otherwise
4882 int av_codec_is_decoder(const AVCodec *codec);
4885 * @return descriptor for given codec ID or NULL if no descriptor exists.
4887 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4890 * Iterate over all codec descriptors known to libavcodec.
4892 * @param prev previous descriptor. NULL to get the first descriptor.
4894 * @return next descriptor or NULL after the last descriptor
4896 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4899 * @return codec descriptor with the given name or NULL if no such descriptor
4902 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4905 * Allocate a CPB properties structure and initialize its fields to default
4908 * @param size if non-NULL, the size of the allocated struct will be written
4909 * here. This is useful for embedding it in side data.
4911 * @return the newly allocated struct or NULL on failure
4913 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
4919 #endif /* AVCODEC_AVCODEC_H */