2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/log.h"
40 #include "libavutil/pixfmt.h"
41 #include "libavutil/rational.h"
46 * @defgroup libavc Encoding/Decoding Library
49 * @defgroup lavc_decoding Decoding
53 * @defgroup lavc_encoding Encoding
57 * @defgroup lavc_codec Codecs
59 * @defgroup lavc_codec_native Native Codecs
62 * @defgroup lavc_codec_wrappers External library wrappers
65 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
69 * @defgroup lavc_internal Internal
77 * @defgroup lavc_core Core functions/structures.
80 * Basic definitions, functions for querying libavcodec capabilities,
81 * allocating core structures, etc.
87 * Identify the syntax and semantics of the bitstream.
88 * The principle is roughly:
89 * Two decoders with the same ID can decode the same streams.
90 * Two encoders with the same ID can encode compatible streams.
91 * There may be slight deviations from the principle due to implementation
94 * If you add a codec ID to this list, add it so that
95 * 1. no value of a existing codec ID changes (that would break ABI),
96 * 2. it is as close as possible to similar codecs
98 * After adding new codec IDs, do not forget to add an entry to the codec
99 * descriptor list and bump libavcodec minor version.
105 AV_CODEC_ID_MPEG1VIDEO,
106 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
108 AV_CODEC_ID_MPEG2VIDEO_XVMC,
109 #endif /* FF_API_XVMC */
120 AV_CODEC_ID_RAWVIDEO,
121 AV_CODEC_ID_MSMPEG4V1,
122 AV_CODEC_ID_MSMPEG4V2,
123 AV_CODEC_ID_MSMPEG4V3,
146 AV_CODEC_ID_INTERPLAY_VIDEO,
153 AV_CODEC_ID_MSVIDEO1,
158 AV_CODEC_ID_TRUEMOTION1,
159 AV_CODEC_ID_VMDVIDEO,
184 AV_CODEC_ID_TRUEMOTION2,
190 AV_CODEC_ID_SMACKVIDEO,
195 AV_CODEC_ID_JPEG2000,
201 AV_CODEC_ID_DSICINVIDEO,
202 AV_CODEC_ID_TIERTEXSEQVIDEO,
210 AV_CODEC_ID_BETHSOFTVID,
222 AV_CODEC_ID_ESCAPE124,
226 AV_CODEC_ID_MOTIONPIXELS,
238 AV_CODEC_ID_FLASHSV2,
239 AV_CODEC_ID_CDGRAPHICS,
242 AV_CODEC_ID_BINKVIDEO,
243 AV_CODEC_ID_IFF_ILBM,
244 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
250 AV_CODEC_ID_A64_MULTI,
251 AV_CODEC_ID_A64_MULTI5,
254 AV_CODEC_ID_LAGARITH,
258 AV_CODEC_ID_WMV3IMAGE,
259 AV_CODEC_ID_VC1IMAGE,
261 AV_CODEC_ID_BMV_VIDEO,
268 AV_CODEC_ID_ZEROCODEC,
277 AV_CODEC_ID_ESCAPE130,
280 AV_CODEC_ID_HNM4_VIDEO,
282 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
284 AV_CODEC_ID_ALIAS_PIX,
285 AV_CODEC_ID_BRENDER_PIX,
286 AV_CODEC_ID_PAF_VIDEO,
299 AV_CODEC_ID_SCREENPRESSO,
302 AV_CODEC_ID_Y41P = 0x8000,
307 AV_CODEC_ID_TARGA_Y216,
320 /* various PCM "codecs" */
321 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
322 AV_CODEC_ID_PCM_S16LE = 0x10000,
323 AV_CODEC_ID_PCM_S16BE,
324 AV_CODEC_ID_PCM_U16LE,
325 AV_CODEC_ID_PCM_U16BE,
328 AV_CODEC_ID_PCM_MULAW,
329 AV_CODEC_ID_PCM_ALAW,
330 AV_CODEC_ID_PCM_S32LE,
331 AV_CODEC_ID_PCM_S32BE,
332 AV_CODEC_ID_PCM_U32LE,
333 AV_CODEC_ID_PCM_U32BE,
334 AV_CODEC_ID_PCM_S24LE,
335 AV_CODEC_ID_PCM_S24BE,
336 AV_CODEC_ID_PCM_U24LE,
337 AV_CODEC_ID_PCM_U24BE,
338 AV_CODEC_ID_PCM_S24DAUD,
339 AV_CODEC_ID_PCM_ZORK,
340 AV_CODEC_ID_PCM_S16LE_PLANAR,
342 AV_CODEC_ID_PCM_F32BE,
343 AV_CODEC_ID_PCM_F32LE,
344 AV_CODEC_ID_PCM_F64BE,
345 AV_CODEC_ID_PCM_F64LE,
346 AV_CODEC_ID_PCM_BLURAY,
349 AV_CODEC_ID_PCM_S8_PLANAR,
350 AV_CODEC_ID_PCM_S24LE_PLANAR,
351 AV_CODEC_ID_PCM_S32LE_PLANAR,
352 AV_CODEC_ID_PCM_S16BE_PLANAR,
353 /* new PCM "codecs" should be added right below this line starting with
354 * an explicit value of for example 0x10800
357 /* various ADPCM codecs */
358 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
359 AV_CODEC_ID_ADPCM_IMA_WAV,
360 AV_CODEC_ID_ADPCM_IMA_DK3,
361 AV_CODEC_ID_ADPCM_IMA_DK4,
362 AV_CODEC_ID_ADPCM_IMA_WS,
363 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
364 AV_CODEC_ID_ADPCM_MS,
365 AV_CODEC_ID_ADPCM_4XM,
366 AV_CODEC_ID_ADPCM_XA,
367 AV_CODEC_ID_ADPCM_ADX,
368 AV_CODEC_ID_ADPCM_EA,
369 AV_CODEC_ID_ADPCM_G726,
370 AV_CODEC_ID_ADPCM_CT,
371 AV_CODEC_ID_ADPCM_SWF,
372 AV_CODEC_ID_ADPCM_YAMAHA,
373 AV_CODEC_ID_ADPCM_SBPRO_4,
374 AV_CODEC_ID_ADPCM_SBPRO_3,
375 AV_CODEC_ID_ADPCM_SBPRO_2,
376 AV_CODEC_ID_ADPCM_THP,
377 AV_CODEC_ID_ADPCM_IMA_AMV,
378 AV_CODEC_ID_ADPCM_EA_R1,
379 AV_CODEC_ID_ADPCM_EA_R3,
380 AV_CODEC_ID_ADPCM_EA_R2,
381 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
382 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
383 AV_CODEC_ID_ADPCM_EA_XAS,
384 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
385 AV_CODEC_ID_ADPCM_IMA_ISS,
386 AV_CODEC_ID_ADPCM_G722,
387 AV_CODEC_ID_ADPCM_IMA_APC,
388 AV_CODEC_ID_ADPCM_VIMA,
389 #if FF_API_VIMA_DECODER
390 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
393 AV_CODEC_ID_ADPCM_AFC = 0x11800,
394 AV_CODEC_ID_ADPCM_IMA_OKI,
395 AV_CODEC_ID_ADPCM_DTK,
396 AV_CODEC_ID_ADPCM_IMA_RAD,
397 AV_CODEC_ID_ADPCM_G726LE,
398 AV_CODEC_ID_ADPCM_THP_LE,
399 AV_CODEC_ID_ADPCM_PSX,
400 AV_CODEC_ID_ADPCM_AICA,
403 AV_CODEC_ID_AMR_NB = 0x12000,
406 /* RealAudio codecs*/
407 AV_CODEC_ID_RA_144 = 0x13000,
410 /* various DPCM codecs */
411 AV_CODEC_ID_ROQ_DPCM = 0x14000,
412 AV_CODEC_ID_INTERPLAY_DPCM,
413 AV_CODEC_ID_XAN_DPCM,
414 AV_CODEC_ID_SOL_DPCM,
416 AV_CODEC_ID_SDX2_DPCM = 0x14800,
419 AV_CODEC_ID_MP2 = 0x15000,
420 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
430 AV_CODEC_ID_VMDAUDIO,
436 AV_CODEC_ID_WESTWOOD_SND1,
437 AV_CODEC_ID_GSM, ///< as in Berlin toast format
440 AV_CODEC_ID_TRUESPEECH,
442 AV_CODEC_ID_SMACKAUDIO,
445 AV_CODEC_ID_DSICINAUDIO,
447 AV_CODEC_ID_MUSEPACK7,
449 AV_CODEC_ID_GSM_MS, /* as found in WAV */
455 AV_CODEC_ID_NELLYMOSER,
456 AV_CODEC_ID_MUSEPACK8,
458 AV_CODEC_ID_WMAVOICE,
460 AV_CODEC_ID_WMALOSSLESS,
469 AV_CODEC_ID_BINKAUDIO_RDFT,
470 AV_CODEC_ID_BINKAUDIO_DCT,
471 AV_CODEC_ID_AAC_LATM,
476 AV_CODEC_ID_8SVX_EXP,
477 AV_CODEC_ID_8SVX_FIB,
478 AV_CODEC_ID_BMV_AUDIO,
483 AV_CODEC_ID_COMFORT_NOISE,
485 AV_CODEC_ID_METASOUND,
486 AV_CODEC_ID_PAF_AUDIO,
490 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
492 AV_CODEC_ID_SONIC_LS,
495 AV_CODEC_ID_DSD_LSBF,
496 AV_CODEC_ID_DSD_MSBF,
497 AV_CODEC_ID_DSD_LSBF_PLANAR,
498 AV_CODEC_ID_DSD_MSBF_PLANAR,
500 AV_CODEC_ID_INTERPLAY_ACM,
504 /* subtitle codecs */
505 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
506 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
507 AV_CODEC_ID_DVB_SUBTITLE,
508 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
511 AV_CODEC_ID_MOV_TEXT,
512 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
513 AV_CODEC_ID_DVB_TELETEXT,
516 AV_CODEC_ID_MICRODVD = 0x17800,
520 AV_CODEC_ID_REALTEXT,
522 AV_CODEC_ID_SUBVIEWER1,
523 AV_CODEC_ID_SUBVIEWER,
530 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
532 /* other specific kind of codecs (generally used for attachments) */
533 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
534 AV_CODEC_ID_TTF = 0x18000,
536 AV_CODEC_ID_BINTEXT = 0x18800,
540 AV_CODEC_ID_SMPTE_KLV,
542 AV_CODEC_ID_TIMED_ID3,
543 AV_CODEC_ID_BIN_DATA,
546 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
548 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
549 * stream (only used by libavformat) */
550 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
551 * stream (only used by libavformat) */
552 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
553 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
557 * This struct describes the properties of a single codec described by an
559 * @see avcodec_descriptor_get()
561 typedef struct AVCodecDescriptor {
563 enum AVMediaType type;
565 * Name of the codec described by this descriptor. It is non-empty and
566 * unique for each codec descriptor. It should contain alphanumeric
567 * characters and '_' only.
571 * A more descriptive name for this codec. May be NULL.
573 const char *long_name;
575 * Codec properties, a combination of AV_CODEC_PROP_* flags.
579 * MIME type(s) associated with the codec.
580 * May be NULL; if not, a NULL-terminated array of MIME types.
581 * The first item is always non-NULL and is the preferred MIME type.
583 const char *const *mime_types;
585 * If non-NULL, an array of profiles recognized for this codec.
586 * Terminated with FF_PROFILE_UNKNOWN.
588 const struct AVProfile *profiles;
592 * Codec uses only intra compression.
595 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
597 * Codec supports lossy compression. Audio and video codecs only.
598 * @note a codec may support both lossy and lossless
601 #define AV_CODEC_PROP_LOSSY (1 << 1)
603 * Codec supports lossless compression. Audio and video codecs only.
605 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
607 * Codec supports frame reordering. That is, the coded order (the order in which
608 * the encoded packets are output by the encoders / stored / input to the
609 * decoders) may be different from the presentation order of the corresponding
612 * For codecs that do not have this property set, PTS and DTS should always be
615 #define AV_CODEC_PROP_REORDER (1 << 3)
617 * Subtitle codec is bitmap based
618 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
620 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
622 * Subtitle codec is text based.
623 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
625 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
628 * @ingroup lavc_decoding
629 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
630 * This is mainly needed because some optimized bitstream readers read
631 * 32 or 64 bit at once and could read over the end.<br>
632 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
633 * MPEG bitstreams could cause overread and segfault.
635 #define AV_INPUT_BUFFER_PADDING_SIZE 32
638 * @ingroup lavc_encoding
639 * minimum encoding buffer size
640 * Used to avoid some checks during header writing.
642 #define AV_INPUT_BUFFER_MIN_SIZE 16384
644 #if FF_API_WITHOUT_PREFIX
646 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
648 #define FF_INPUT_BUFFER_PADDING_SIZE 32
651 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
653 #define FF_MIN_BUFFER_SIZE 16384
654 #endif /* FF_API_WITHOUT_PREFIX */
657 * @ingroup lavc_encoding
658 * motion estimation type.
659 * @deprecated use codec private option instead
661 #if FF_API_MOTION_EST
663 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
667 ME_EPZS, ///< enhanced predictive zonal search
668 ME_X1, ///< reserved for experiments
669 ME_HEX, ///< hexagon based search
670 ME_UMH, ///< uneven multi-hexagon search
671 ME_TESA, ///< transformed exhaustive search algorithm
672 ME_ITER=50, ///< iterative search
677 * @ingroup lavc_decoding
680 /* We leave some space between them for extensions (drop some
681 * keyframes for intra-only or drop just some bidir frames). */
682 AVDISCARD_NONE =-16, ///< discard nothing
683 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
684 AVDISCARD_NONREF = 8, ///< discard all non reference
685 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
686 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
687 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
688 AVDISCARD_ALL = 48, ///< discard all
691 enum AVAudioServiceType {
692 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
693 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
694 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
695 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
696 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
697 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
698 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
699 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
700 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
701 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
705 * @ingroup lavc_encoding
707 typedef struct RcOverride{
710 int qscale; // If this is 0 then quality_factor will be used instead.
711 float quality_factor;
714 #if FF_API_MAX_BFRAMES
716 * @deprecated there is no libavcodec-wide limit on the number of B-frames
718 #define FF_MAX_B_FRAMES 16
722 These flags can be passed in AVCodecContext.flags before initialization.
723 Note: Not everything is supported yet.
727 * Allow decoders to produce frames with data planes that are not aligned
728 * to CPU requirements (e.g. due to cropping).
730 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
734 #define AV_CODEC_FLAG_QSCALE (1 << 1)
736 * 4 MV per MB allowed / advanced prediction for H.263.
738 #define AV_CODEC_FLAG_4MV (1 << 2)
740 * Output even those frames that might be corrupted.
742 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
746 #define AV_CODEC_FLAG_QPEL (1 << 4)
748 * Use internal 2pass ratecontrol in first pass mode.
750 #define AV_CODEC_FLAG_PASS1 (1 << 9)
752 * Use internal 2pass ratecontrol in second pass mode.
754 #define AV_CODEC_FLAG_PASS2 (1 << 10)
758 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
760 * Only decode/encode grayscale.
762 #define AV_CODEC_FLAG_GRAY (1 << 13)
764 * error[?] variables will be set during encoding.
766 #define AV_CODEC_FLAG_PSNR (1 << 15)
768 * Input bitstream might be truncated at a random location
769 * instead of only at frame boundaries.
771 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
773 * Use interlaced DCT.
775 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
779 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
781 * Place global headers in extradata instead of every keyframe.
783 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
785 * Use only bitexact stuff (except (I)DCT).
787 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
788 /* Fx : Flag for h263+ extra options */
790 * H.263 advanced intra coding / MPEG-4 AC prediction
792 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
794 * interlaced motion estimation
796 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
797 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
800 * Allow non spec compliant speedup tricks.
802 #define AV_CODEC_FLAG2_FAST (1 << 0)
804 * Skip bitstream encoding.
806 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
808 * Place global headers at every keyframe instead of in extradata.
810 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
813 * timecode is in drop frame format. DEPRECATED!!!!
815 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
818 * Input bitstream might be truncated at a packet boundaries
819 * instead of only at frame boundaries.
821 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
823 * Discard cropping information from SPS.
825 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
828 * Show all frames before the first keyframe
830 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
832 * Export motion vectors through frame side data
834 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
836 * Do not skip samples and export skip information as frame side data
838 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
840 /* Unsupported options :
841 * Syntax Arithmetic coding (SAC)
842 * Reference Picture Selection
843 * Independent Segment Decoding */
845 /* codec capabilities */
848 * Decoder can use draw_horiz_band callback.
850 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
852 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
853 * If not set, it might not use get_buffer() at all or use operations that
854 * assume the buffer was allocated by avcodec_default_get_buffer.
856 #define AV_CODEC_CAP_DR1 (1 << 1)
857 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
859 * Encoder or decoder requires flushing with NULL input at the end in order to
860 * give the complete and correct output.
862 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
863 * with NULL data. The user can still send NULL data to the public encode
864 * or decode function, but libavcodec will not pass it along to the codec
865 * unless this flag is set.
868 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
869 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
873 * The encoder needs to be fed with NULL data at the end of encoding until the
874 * encoder no longer returns data.
876 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
877 * flag also means that the encoder must set the pts and duration for
878 * each output packet. If this flag is not set, the pts and duration will
879 * be determined by libavcodec from the input frame.
881 #define AV_CODEC_CAP_DELAY (1 << 5)
883 * Codec can be fed a final frame with a smaller size.
884 * This can be used to prevent truncation of the last audio samples.
886 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
890 * Codec can export data for HW decoding (VDPAU).
892 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
896 * Codec can output multiple frames per AVPacket
897 * Normally demuxers return one frame at a time, demuxers which do not do
898 * are connected to a parser to split what they return into proper frames.
899 * This flag is reserved to the very rare category of codecs which have a
900 * bitstream that cannot be split into frames without timeconsuming
901 * operations like full decoding. Demuxers carring such bitstreams thus
902 * may return multiple frames in a packet. This has many disadvantages like
903 * prohibiting stream copy in many cases thus it should only be considered
906 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
908 * Codec is experimental and is thus avoided in favor of non experimental
911 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
913 * Codec should fill in channel configuration and samplerate instead of container
915 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
917 * Codec supports frame-level multithreading.
919 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
921 * Codec supports slice-based (or partition-based) multithreading.
923 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
925 * Codec supports changed parameters at any point.
927 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
929 * Codec supports avctx->thread_count == 0 (auto).
931 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
933 * Audio encoder supports receiving a different number of samples in each call.
935 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
937 * Codec is intra only.
939 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
943 #define AV_CODEC_CAP_LOSSLESS 0x80000000
946 #if FF_API_WITHOUT_PREFIX
948 * Allow decoders to produce frames with data planes that are not aligned
949 * to CPU requirements (e.g. due to cropping).
951 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
952 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
953 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
954 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
955 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
958 * @deprecated use the "gmc" private option of the libxvid encoder
960 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
964 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
967 #define CODEC_FLAG_MV0 0x0040
969 #if FF_API_INPUT_PRESERVED
971 * @deprecated passing reference-counted frames to the encoders replaces this
974 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
976 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
977 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
978 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
981 * @deprecated edges are not used/required anymore. I.e. this flag is now always
984 #define CODEC_FLAG_EMU_EDGE 0x4000
986 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
987 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
989 #if FF_API_NORMALIZE_AQP
991 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
994 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
996 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
997 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
998 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
999 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1000 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1001 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1002 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1003 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1004 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1005 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1006 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1007 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1008 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1010 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1011 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1012 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1013 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1015 /* Unsupported options :
1016 * Syntax Arithmetic coding (SAC)
1017 * Reference Picture Selection
1018 * Independent Segment Decoding */
1020 /* codec capabilities */
1022 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1024 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1025 * If not set, it might not use get_buffer() at all or use operations that
1026 * assume the buffer was allocated by avcodec_default_get_buffer.
1028 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1029 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1031 /* Codec can export data for HW decoding. This flag indicates that
1032 * the codec would call get_format() with list that might contain HW accelerated
1033 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1034 * including raw image format.
1035 * The application can use the passed context to determine bitstream version,
1036 * chroma format, resolution etc.
1038 #define CODEC_CAP_HWACCEL 0x0010
1039 #endif /* FF_API_XVMC */
1041 * Encoder or decoder requires flushing with NULL input at the end in order to
1042 * give the complete and correct output.
1044 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1045 * with NULL data. The user can still send NULL data to the public encode
1046 * or decode function, but libavcodec will not pass it along to the codec
1047 * unless this flag is set.
1050 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1051 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1055 * The encoder needs to be fed with NULL data at the end of encoding until the
1056 * encoder no longer returns data.
1058 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1059 * flag also means that the encoder must set the pts and duration for
1060 * each output packet. If this flag is not set, the pts and duration will
1061 * be determined by libavcodec from the input frame.
1063 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1065 * Codec can be fed a final frame with a smaller size.
1066 * This can be used to prevent truncation of the last audio samples.
1068 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1069 #if FF_API_CAP_VDPAU
1071 * Codec can export data for HW decoding (VDPAU).
1073 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1076 * Codec can output multiple frames per AVPacket
1077 * Normally demuxers return one frame at a time, demuxers which do not do
1078 * are connected to a parser to split what they return into proper frames.
1079 * This flag is reserved to the very rare category of codecs which have a
1080 * bitstream that cannot be split into frames without timeconsuming
1081 * operations like full decoding. Demuxers carring such bitstreams thus
1082 * may return multiple frames in a packet. This has many disadvantages like
1083 * prohibiting stream copy in many cases thus it should only be considered
1086 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1088 * Codec is experimental and is thus avoided in favor of non experimental
1091 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1093 * Codec should fill in channel configuration and samplerate instead of container
1095 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1096 #if FF_API_NEG_LINESIZES
1098 * @deprecated no codecs use this capability
1100 #define CODEC_CAP_NEG_LINESIZES 0x0800
1103 * Codec supports frame-level multithreading.
1105 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1107 * Codec supports slice-based (or partition-based) multithreading.
1109 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1111 * Codec supports changed parameters at any point.
1113 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1115 * Codec supports avctx->thread_count == 0 (auto).
1117 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1119 * Audio encoder supports receiving a different number of samples in each call.
1121 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1123 * Codec is intra only.
1125 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1127 * Codec is lossless.
1129 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1132 * HWAccel is experimental and is thus avoided in favor of non experimental
1135 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1136 #endif /* FF_API_WITHOUT_PREFIX */
1139 //The following defines may change, don't expect compatibility if you use them.
1140 #define MB_TYPE_INTRA4x4 0x0001
1141 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1142 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1143 #define MB_TYPE_16x16 0x0008
1144 #define MB_TYPE_16x8 0x0010
1145 #define MB_TYPE_8x16 0x0020
1146 #define MB_TYPE_8x8 0x0040
1147 #define MB_TYPE_INTERLACED 0x0080
1148 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1149 #define MB_TYPE_ACPRED 0x0200
1150 #define MB_TYPE_GMC 0x0400
1151 #define MB_TYPE_SKIP 0x0800
1152 #define MB_TYPE_P0L0 0x1000
1153 #define MB_TYPE_P1L0 0x2000
1154 #define MB_TYPE_P0L1 0x4000
1155 #define MB_TYPE_P1L1 0x8000
1156 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1157 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1158 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1159 #define MB_TYPE_QUANT 0x00010000
1160 #define MB_TYPE_CBP 0x00020000
1161 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
1166 * This specifies the area which should be displayed.
1167 * Note there may be multiple such areas for one frame.
1169 typedef struct AVPanScan{
1172 * - encoding: Set by user.
1173 * - decoding: Set by libavcodec.
1178 * width and height in 1/16 pel
1179 * - encoding: Set by user.
1180 * - decoding: Set by libavcodec.
1186 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1187 * - encoding: Set by user.
1188 * - decoding: Set by libavcodec.
1190 int16_t position[3][2];
1194 * This structure describes the bitrate properties of an encoded bitstream. It
1195 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1196 * parameters for H.264/HEVC.
1198 typedef struct AVCPBProperties {
1200 * Maximum bitrate of the stream, in bits per second.
1201 * Zero if unknown or unspecified.
1205 * Minimum bitrate of the stream, in bits per second.
1206 * Zero if unknown or unspecified.
1210 * Average bitrate of the stream, in bits per second.
1211 * Zero if unknown or unspecified.
1216 * The size of the buffer to which the ratecontrol is applied, in bits.
1217 * Zero if unknown or unspecified.
1222 * The delay between the time the packet this structure is associated with
1223 * is received and the time when it should be decoded, in periods of a 27MHz
1226 * UINT64_MAX when unknown or unspecified.
1231 #if FF_API_QSCALE_TYPE
1232 #define FF_QSCALE_TYPE_MPEG1 0
1233 #define FF_QSCALE_TYPE_MPEG2 1
1234 #define FF_QSCALE_TYPE_H264 2
1235 #define FF_QSCALE_TYPE_VP56 3
1239 * The decoder will keep a reference to the frame and may reuse it later.
1241 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1244 * @defgroup lavc_packet AVPacket
1246 * Types and functions for working with AVPacket.
1249 enum AVPacketSideDataType {
1250 AV_PKT_DATA_PALETTE,
1251 AV_PKT_DATA_NEW_EXTRADATA,
1254 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1257 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1258 * s32le channel_count
1259 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1260 * u64le channel_layout
1261 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1263 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1268 AV_PKT_DATA_PARAM_CHANGE,
1271 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1272 * structures with info about macroblocks relevant to splitting the
1273 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1274 * That is, it does not necessarily contain info about all macroblocks,
1275 * as long as the distance between macroblocks in the info is smaller
1276 * than the target payload size.
1277 * Each MB info structure is 12 bytes, and is laid out as follows:
1279 * u32le bit offset from the start of the packet
1280 * u8 current quantizer at the start of the macroblock
1282 * u16le macroblock address within the GOB
1283 * u8 horizontal MV predictor
1284 * u8 vertical MV predictor
1285 * u8 horizontal MV predictor for block number 3
1286 * u8 vertical MV predictor for block number 3
1289 AV_PKT_DATA_H263_MB_INFO,
1292 * This side data should be associated with an audio stream and contains
1293 * ReplayGain information in form of the AVReplayGain struct.
1295 AV_PKT_DATA_REPLAYGAIN,
1298 * This side data contains a 3x3 transformation matrix describing an affine
1299 * transformation that needs to be applied to the decoded video frames for
1300 * correct presentation.
1302 * See libavutil/display.h for a detailed description of the data.
1304 AV_PKT_DATA_DISPLAYMATRIX,
1307 * This side data should be associated with a video stream and contains
1308 * Stereoscopic 3D information in form of the AVStereo3D struct.
1310 AV_PKT_DATA_STEREO3D,
1313 * This side data should be associated with an audio stream and corresponds
1314 * to enum AVAudioServiceType.
1316 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1319 * This side data contains quality related information from the encoder.
1321 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1325 * u64le[error count] sum of squared differences between encoder in and output
1328 AV_PKT_DATA_QUALITY_STATS,
1331 * This side data contains an integer value representing the stream index
1332 * of a "fallback" track. A fallback track indicates an alternate
1333 * track to use when the current track can not be decoded for some reason.
1334 * e.g. no decoder available for codec.
1336 AV_PKT_DATA_FALLBACK_TRACK,
1339 * This side data corresponds to the AVCPBProperties struct.
1341 AV_PKT_DATA_CPB_PROPERTIES,
1344 * Recommmends skipping the specified number of samples
1346 * u32le number of samples to skip from start of this packet
1347 * u32le number of samples to skip from end of this packet
1348 * u8 reason for start skip
1349 * u8 reason for end skip (0=padding silence, 1=convergence)
1352 AV_PKT_DATA_SKIP_SAMPLES=70,
1355 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1356 * the packet may contain "dual mono" audio specific to Japanese DTV
1357 * and if it is true, recommends only the selected channel to be used.
1359 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1362 AV_PKT_DATA_JP_DUALMONO,
1365 * A list of zero terminated key/value strings. There is no end marker for
1366 * the list, so it is required to rely on the side data size to stop.
1368 AV_PKT_DATA_STRINGS_METADATA,
1371 * Subtitle event position
1379 AV_PKT_DATA_SUBTITLE_POSITION,
1382 * Data found in BlockAdditional element of matroska container. There is
1383 * no end marker for the data, so it is required to rely on the side data
1384 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1387 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1390 * The optional first identifier line of a WebVTT cue.
1392 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1395 * The optional settings (rendering instructions) that immediately
1396 * follow the timestamp specifier of a WebVTT cue.
1398 AV_PKT_DATA_WEBVTT_SETTINGS,
1401 * A list of zero terminated key/value strings. There is no end marker for
1402 * the list, so it is required to rely on the side data size to stop. This
1403 * side data includes updated metadata which appeared in the stream.
1405 AV_PKT_DATA_METADATA_UPDATE,
1408 * The number of side data elements (in fact a bit more than it).
1409 * This is not part of the public API/ABI in the sense that it may
1410 * change when new side data types are added.
1411 * This must stay the last enum value.
1412 * If its value becomes huge, some code using it
1413 * needs to be updated as it assumes it to be smaller than other limits.
1418 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1420 typedef struct AVPacketSideData {
1423 enum AVPacketSideDataType type;
1427 * This structure stores compressed data. It is typically exported by demuxers
1428 * and then passed as input to decoders, or received as output from encoders and
1429 * then passed to muxers.
1431 * For video, it should typically contain one compressed frame. For audio it may
1432 * contain several compressed frames. Encoders are allowed to output empty
1433 * packets, with no compressed data, containing only side data
1434 * (e.g. to update some stream parameters at the end of encoding).
1436 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1437 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1438 * without libavcodec and libavformat major bump.
1440 * The semantics of data ownership depends on the buf field.
1441 * If it is set, the packet data is dynamically allocated and is
1442 * valid indefinitely until a call to av_packet_unref() reduces the
1443 * reference count to 0.
1445 * If the buf field is not set av_packet_ref() would make a copy instead
1446 * of increasing the reference count.
1448 * The side data is always allocated with av_malloc(), copied by
1449 * av_packet_ref() and freed by av_packet_unref().
1451 * @see av_packet_ref
1452 * @see av_packet_unref
1454 typedef struct AVPacket {
1456 * A reference to the reference-counted buffer where the packet data is
1458 * May be NULL, then the packet data is not reference-counted.
1462 * Presentation timestamp in AVStream->time_base units; the time at which
1463 * the decompressed packet will be presented to the user.
1464 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1465 * pts MUST be larger or equal to dts as presentation cannot happen before
1466 * decompression, unless one wants to view hex dumps. Some formats misuse
1467 * the terms dts and pts/cts to mean something different. Such timestamps
1468 * must be converted to true pts/dts before they are stored in AVPacket.
1472 * Decompression timestamp in AVStream->time_base units; the time at which
1473 * the packet is decompressed.
1474 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1481 * A combination of AV_PKT_FLAG values
1485 * Additional packet data that can be provided by the container.
1486 * Packet can contain several types of side information.
1488 AVPacketSideData *side_data;
1489 int side_data_elems;
1492 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1493 * Equals next_pts - this_pts in presentation order.
1497 int64_t pos; ///< byte position in stream, -1 if unknown
1499 #if FF_API_CONVERGENCE_DURATION
1501 * @deprecated Same as the duration field, but as int64_t. This was required
1502 * for Matroska subtitles, whose duration values could overflow when the
1503 * duration field was still an int.
1505 attribute_deprecated
1506 int64_t convergence_duration;
1509 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1510 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1512 enum AVSideDataParamChangeFlags {
1513 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1514 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1515 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1516 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1522 struct AVCodecInternal;
1526 AV_FIELD_PROGRESSIVE,
1527 AV_FIELD_TT, //< Top coded_first, top displayed first
1528 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1529 AV_FIELD_TB, //< Top coded first, bottom displayed first
1530 AV_FIELD_BT, //< Bottom coded first, top displayed first
1534 * main external API structure.
1535 * New fields can be added to the end with minor version bumps.
1536 * Removal, reordering and changes to existing fields require a major
1538 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1540 * sizeof(AVCodecContext) must not be used outside libav*.
1542 typedef struct AVCodecContext {
1544 * information on struct for av_log
1545 * - set by avcodec_alloc_context3
1547 const AVClass *av_class;
1548 int log_level_offset;
1550 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1551 const struct AVCodec *codec;
1552 #if FF_API_CODEC_NAME
1554 * @deprecated this field is not used for anything in libavcodec
1556 attribute_deprecated
1557 char codec_name[32];
1559 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1562 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1563 * This is used to work around some encoder bugs.
1564 * A demuxer should set this to what is stored in the field used to identify the codec.
1565 * If there are multiple such fields in a container then the demuxer should choose the one
1566 * which maximizes the information about the used codec.
1567 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1568 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1569 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1571 * - encoding: Set by user, if not then the default based on codec_id will be used.
1572 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1574 unsigned int codec_tag;
1576 #if FF_API_STREAM_CODEC_TAG
1578 * @deprecated this field is unused
1580 attribute_deprecated
1581 unsigned int stream_codec_tag;
1587 * Private context used for internal data.
1589 * Unlike priv_data, this is not codec-specific. It is used in general
1590 * libavcodec functions.
1592 struct AVCodecInternal *internal;
1595 * Private data of the user, can be used to carry app specific stuff.
1596 * - encoding: Set by user.
1597 * - decoding: Set by user.
1602 * the average bitrate
1603 * - encoding: Set by user; unused for constant quantizer encoding.
1604 * - decoding: Set by user, may be overwritten by libavcodec
1605 * if this info is available in the stream
1610 * number of bits the bitstream is allowed to diverge from the reference.
1611 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1612 * - encoding: Set by user; unused for constant quantizer encoding.
1613 * - decoding: unused
1615 int bit_rate_tolerance;
1618 * Global quality for codecs which cannot change it per frame.
1619 * This should be proportional to MPEG-1/2/4 qscale.
1620 * - encoding: Set by user.
1621 * - decoding: unused
1626 * - encoding: Set by user.
1627 * - decoding: unused
1629 int compression_level;
1630 #define FF_COMPRESSION_DEFAULT -1
1634 * - encoding: Set by user.
1635 * - decoding: Set by user.
1641 * - encoding: Set by user.
1642 * - decoding: Set by user.
1647 * some codecs need / can use extradata like Huffman tables.
1648 * mjpeg: Huffman tables
1649 * rv10: additional flags
1650 * mpeg4: global headers (they can be in the bitstream or here)
1651 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1652 * than extradata_size to avoid problems if it is read with the bitstream reader.
1653 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1654 * - encoding: Set/allocated/freed by libavcodec.
1655 * - decoding: Set/allocated/freed by user.
1661 * This is the fundamental unit of time (in seconds) in terms
1662 * of which frame timestamps are represented. For fixed-fps content,
1663 * timebase should be 1/framerate and timestamp increments should be
1665 * This often, but not always is the inverse of the frame rate or field rate
1667 * - encoding: MUST be set by user.
1668 * - decoding: the use of this field for decoding is deprecated.
1669 * Use framerate instead.
1671 AVRational time_base;
1674 * For some codecs, the time base is closer to the field rate than the frame rate.
1675 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1676 * if no telecine is used ...
1678 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1680 int ticks_per_frame;
1685 * Encoding: Number of frames delay there will be from the encoder input to
1686 * the decoder output. (we assume the decoder matches the spec)
1687 * Decoding: Number of frames delay in addition to what a standard decoder
1688 * as specified in the spec would produce.
1691 * Number of frames the decoded output will be delayed relative to the
1695 * For encoding, this field is unused (see initial_padding).
1697 * For decoding, this is the number of samples the decoder needs to
1698 * output before the decoder's output is valid. When seeking, you should
1699 * start decoding this many samples prior to your desired seek point.
1701 * - encoding: Set by libavcodec.
1702 * - decoding: Set by libavcodec.
1709 * picture width / height.
1711 * @note Those fields may not match the values of the last
1712 * AVFrame outputted by avcodec_decode_video2 due frame
1715 * - encoding: MUST be set by user.
1716 * - decoding: May be set by the user before opening the decoder if known e.g.
1717 * from the container. Some decoders will require the dimensions
1718 * to be set by the caller. During decoding, the decoder may
1719 * overwrite those values as required while parsing the data.
1724 * Bitstream width / height, may be different from width/height e.g. when
1725 * the decoded frame is cropped before being output or lowres is enabled.
1727 * @note Those field may not match the value of the last
1728 * AVFrame outputted by avcodec_decode_video2 due frame
1731 * - encoding: unused
1732 * - decoding: May be set by the user before opening the decoder if known
1733 * e.g. from the container. During decoding, the decoder may
1734 * overwrite those values as required while parsing the data.
1736 int coded_width, coded_height;
1738 #if FF_API_ASPECT_EXTENDED
1739 #define FF_ASPECT_EXTENDED 15
1743 * the number of pictures in a group of pictures, or 0 for intra_only
1744 * - encoding: Set by user.
1745 * - decoding: unused
1750 * Pixel format, see AV_PIX_FMT_xxx.
1751 * May be set by the demuxer if known from headers.
1752 * May be overridden by the decoder if it knows better.
1754 * @note This field may not match the value of the last
1755 * AVFrame outputted by avcodec_decode_video2 due frame
1758 * - encoding: Set by user.
1759 * - decoding: Set by user if known, overridden by libavcodec while
1762 enum AVPixelFormat pix_fmt;
1764 #if FF_API_MOTION_EST
1766 * This option does nothing
1767 * @deprecated use codec private options instead
1769 attribute_deprecated int me_method;
1773 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1774 * decoder to draw a horizontal band. It improves cache usage. Not
1775 * all codecs can do that. You must check the codec capabilities
1777 * When multithreading is used, it may be called from multiple threads
1778 * at the same time; threads might draw different parts of the same AVFrame,
1779 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1781 * The function is also used by hardware acceleration APIs.
1782 * It is called at least once during frame decoding to pass
1783 * the data needed for hardware render.
1784 * In that mode instead of pixel data, AVFrame points to
1785 * a structure specific to the acceleration API. The application
1786 * reads the structure and can change some fields to indicate progress
1788 * - encoding: unused
1789 * - decoding: Set by user.
1790 * @param height the height of the slice
1791 * @param y the y position of the slice
1792 * @param type 1->top field, 2->bottom field, 3->frame
1793 * @param offset offset into the AVFrame.data from which the slice should be read
1795 void (*draw_horiz_band)(struct AVCodecContext *s,
1796 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1797 int y, int type, int height);
1800 * callback to negotiate the pixelFormat
1801 * @param fmt is the list of formats which are supported by the codec,
1802 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1803 * The first is always the native one.
1804 * @note The callback may be called again immediately if initialization for
1805 * the selected (hardware-accelerated) pixel format failed.
1806 * @warning Behavior is undefined if the callback returns a value not
1807 * in the fmt list of formats.
1808 * @return the chosen format
1809 * - encoding: unused
1810 * - decoding: Set by user, if not set the native format will be chosen.
1812 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1815 * maximum number of B-frames between non-B-frames
1816 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1817 * - encoding: Set by user.
1818 * - decoding: unused
1823 * qscale factor between IP and B-frames
1824 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1825 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1826 * - encoding: Set by user.
1827 * - decoding: unused
1829 float b_quant_factor;
1831 #if FF_API_RC_STRATEGY
1832 /** @deprecated use codec private option instead */
1833 attribute_deprecated int rc_strategy;
1834 #define FF_RC_STRATEGY_XVID 1
1837 #if FF_API_PRIVATE_OPT
1838 /** @deprecated use encoder private options instead */
1839 attribute_deprecated
1840 int b_frame_strategy;
1844 * qscale offset between IP and B-frames
1845 * - encoding: Set by user.
1846 * - decoding: unused
1848 float b_quant_offset;
1851 * Size of the frame reordering buffer in the decoder.
1852 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1853 * - encoding: Set by libavcodec.
1854 * - decoding: Set by libavcodec.
1858 #if FF_API_PRIVATE_OPT
1859 /** @deprecated use encoder private options instead */
1860 attribute_deprecated
1865 * qscale factor between P and I-frames
1866 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1867 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1868 * - encoding: Set by user.
1869 * - decoding: unused
1871 float i_quant_factor;
1874 * qscale offset between P and I-frames
1875 * - encoding: Set by user.
1876 * - decoding: unused
1878 float i_quant_offset;
1881 * luminance masking (0-> disabled)
1882 * - encoding: Set by user.
1883 * - decoding: unused
1888 * temporary complexity masking (0-> disabled)
1889 * - encoding: Set by user.
1890 * - decoding: unused
1892 float temporal_cplx_masking;
1895 * spatial complexity masking (0-> disabled)
1896 * - encoding: Set by user.
1897 * - decoding: unused
1899 float spatial_cplx_masking;
1902 * p block masking (0-> disabled)
1903 * - encoding: Set by user.
1904 * - decoding: unused
1909 * darkness masking (0-> disabled)
1910 * - encoding: Set by user.
1911 * - decoding: unused
1917 * - encoding: Set by libavcodec.
1918 * - decoding: Set by user (or 0).
1922 #if FF_API_PRIVATE_OPT
1923 /** @deprecated use encoder private options instead */
1924 attribute_deprecated
1925 int prediction_method;
1926 #define FF_PRED_LEFT 0
1927 #define FF_PRED_PLANE 1
1928 #define FF_PRED_MEDIAN 2
1932 * slice offsets in the frame in bytes
1933 * - encoding: Set/allocated by libavcodec.
1934 * - decoding: Set/allocated by user (or NULL).
1939 * sample aspect ratio (0 if unknown)
1940 * That is the width of a pixel divided by the height of the pixel.
1941 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1942 * - encoding: Set by user.
1943 * - decoding: Set by libavcodec.
1945 AVRational sample_aspect_ratio;
1948 * motion estimation comparison function
1949 * - encoding: Set by user.
1950 * - decoding: unused
1954 * subpixel motion estimation comparison function
1955 * - encoding: Set by user.
1956 * - decoding: unused
1960 * macroblock comparison function (not supported yet)
1961 * - encoding: Set by user.
1962 * - decoding: unused
1966 * interlaced DCT comparison function
1967 * - encoding: Set by user.
1968 * - decoding: unused
1971 #define FF_CMP_SAD 0
1972 #define FF_CMP_SSE 1
1973 #define FF_CMP_SATD 2
1974 #define FF_CMP_DCT 3
1975 #define FF_CMP_PSNR 4
1976 #define FF_CMP_BIT 5
1978 #define FF_CMP_ZERO 7
1979 #define FF_CMP_VSAD 8
1980 #define FF_CMP_VSSE 9
1981 #define FF_CMP_NSSE 10
1982 #define FF_CMP_W53 11
1983 #define FF_CMP_W97 12
1984 #define FF_CMP_DCTMAX 13
1985 #define FF_CMP_DCT264 14
1986 #define FF_CMP_CHROMA 256
1989 * ME diamond size & shape
1990 * - encoding: Set by user.
1991 * - decoding: unused
1996 * amount of previous MV predictors (2a+1 x 2a+1 square)
1997 * - encoding: Set by user.
1998 * - decoding: unused
2000 int last_predictor_count;
2002 #if FF_API_PRIVATE_OPT
2003 /** @deprecated use encoder private options instead */
2004 attribute_deprecated
2009 * motion estimation prepass comparison function
2010 * - encoding: Set by user.
2011 * - decoding: unused
2016 * ME prepass diamond size & shape
2017 * - encoding: Set by user.
2018 * - decoding: unused
2024 * - encoding: Set by user.
2025 * - decoding: unused
2027 int me_subpel_quality;
2031 * DTG active format information (additional aspect ratio
2032 * information only used in DVB MPEG-2 transport streams)
2035 * - encoding: unused
2036 * - decoding: Set by decoder.
2037 * @deprecated Deprecated in favor of AVSideData
2039 attribute_deprecated int dtg_active_format;
2040 #define FF_DTG_AFD_SAME 8
2041 #define FF_DTG_AFD_4_3 9
2042 #define FF_DTG_AFD_16_9 10
2043 #define FF_DTG_AFD_14_9 11
2044 #define FF_DTG_AFD_4_3_SP_14_9 13
2045 #define FF_DTG_AFD_16_9_SP_14_9 14
2046 #define FF_DTG_AFD_SP_4_3 15
2047 #endif /* FF_API_AFD */
2050 * maximum motion estimation search range in subpel units
2051 * If 0 then no limit.
2053 * - encoding: Set by user.
2054 * - decoding: unused
2058 #if FF_API_QUANT_BIAS
2060 * @deprecated use encoder private option instead
2062 attribute_deprecated int intra_quant_bias;
2063 #define FF_DEFAULT_QUANT_BIAS 999999
2066 * @deprecated use encoder private option instead
2068 attribute_deprecated int inter_quant_bias;
2073 * - encoding: unused
2074 * - decoding: Set by user.
2077 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2078 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2079 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2083 * XVideo Motion Acceleration
2084 * - encoding: forbidden
2085 * - decoding: set by decoder
2086 * @deprecated XvMC doesn't need it anymore.
2088 attribute_deprecated int xvmc_acceleration;
2089 #endif /* FF_API_XVMC */
2092 * macroblock decision mode
2093 * - encoding: Set by user.
2094 * - decoding: unused
2097 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2098 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2099 #define FF_MB_DECISION_RD 2 ///< rate distortion
2102 * custom intra quantization matrix
2103 * - encoding: Set by user, can be NULL.
2104 * - decoding: Set by libavcodec.
2106 uint16_t *intra_matrix;
2109 * custom inter quantization matrix
2110 * - encoding: Set by user, can be NULL.
2111 * - decoding: Set by libavcodec.
2113 uint16_t *inter_matrix;
2115 #if FF_API_PRIVATE_OPT
2116 /** @deprecated use encoder private options instead */
2117 attribute_deprecated
2118 int scenechange_threshold;
2120 /** @deprecated use encoder private options instead */
2121 attribute_deprecated
2122 int noise_reduction;
2127 * @deprecated this field is unused
2129 attribute_deprecated
2133 * @deprecated this field is unused
2135 attribute_deprecated
2140 * precision of the intra DC coefficient - 8
2141 * - encoding: Set by user.
2142 * - decoding: Set by libavcodec
2144 int intra_dc_precision;
2147 * Number of macroblock rows at the top which are skipped.
2148 * - encoding: unused
2149 * - decoding: Set by user.
2154 * Number of macroblock rows at the bottom which are skipped.
2155 * - encoding: unused
2156 * - decoding: Set by user.
2162 * @deprecated use encoder private options instead
2164 attribute_deprecated
2165 float border_masking;
2169 * minimum MB lagrange multipler
2170 * - encoding: Set by user.
2171 * - decoding: unused
2176 * maximum MB lagrange multipler
2177 * - encoding: Set by user.
2178 * - decoding: unused
2182 #if FF_API_PRIVATE_OPT
2184 * @deprecated use encoder private options instead
2186 attribute_deprecated
2187 int me_penalty_compensation;
2192 * - encoding: Set by user.
2193 * - decoding: unused
2197 #if FF_API_PRIVATE_OPT
2198 /** @deprecated use encoder private options instead */
2199 attribute_deprecated
2205 * - encoding: Set by user.
2206 * - decoding: unused
2211 * number of reference frames
2212 * - encoding: Set by user.
2213 * - decoding: Set by lavc.
2217 #if FF_API_PRIVATE_OPT
2218 /** @deprecated use encoder private options instead */
2219 attribute_deprecated
2223 #if FF_API_UNUSED_MEMBERS
2225 * Multiplied by qscale for each frame and added to scene_change_score.
2226 * - encoding: Set by user.
2227 * - decoding: unused
2229 attribute_deprecated int scenechange_factor;
2234 * Note: Value depends upon the compare function used for fullpel ME.
2235 * - encoding: Set by user.
2236 * - decoding: unused
2240 #if FF_API_PRIVATE_OPT
2241 /** @deprecated use encoder private options instead */
2242 attribute_deprecated
2247 * Chromaticity coordinates of the source primaries.
2248 * - encoding: Set by user
2249 * - decoding: Set by libavcodec
2251 enum AVColorPrimaries color_primaries;
2254 * Color Transfer Characteristic.
2255 * - encoding: Set by user
2256 * - decoding: Set by libavcodec
2258 enum AVColorTransferCharacteristic color_trc;
2261 * YUV colorspace type.
2262 * - encoding: Set by user
2263 * - decoding: Set by libavcodec
2265 enum AVColorSpace colorspace;
2268 * MPEG vs JPEG YUV range.
2269 * - encoding: Set by user
2270 * - decoding: Set by libavcodec
2272 enum AVColorRange color_range;
2275 * This defines the location of chroma samples.
2276 * - encoding: Set by user
2277 * - decoding: Set by libavcodec
2279 enum AVChromaLocation chroma_sample_location;
2283 * Indicates number of picture subdivisions. Used for parallelized
2285 * - encoding: Set by user
2286 * - decoding: unused
2291 * - encoding: set by libavcodec
2292 * - decoding: Set by user.
2294 enum AVFieldOrder field_order;
2297 int sample_rate; ///< samples per second
2298 int channels; ///< number of audio channels
2301 * audio sample format
2302 * - encoding: Set by user.
2303 * - decoding: Set by libavcodec.
2305 enum AVSampleFormat sample_fmt; ///< sample format
2307 /* The following data should not be initialized. */
2309 * Number of samples per channel in an audio frame.
2311 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2312 * except the last must contain exactly frame_size samples per channel.
2313 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2314 * frame size is not restricted.
2315 * - decoding: may be set by some decoders to indicate constant frame size
2320 * Frame counter, set by libavcodec.
2322 * - decoding: total number of frames returned from the decoder so far.
2323 * - encoding: total number of frames passed to the encoder so far.
2325 * @note the counter is not incremented if encoding/decoding resulted in
2331 * number of bytes per packet if constant and known or 0
2332 * Used by some WAV based audio codecs.
2337 * Audio cutoff bandwidth (0 means "automatic")
2338 * - encoding: Set by user.
2339 * - decoding: unused
2344 * Audio channel layout.
2345 * - encoding: set by user.
2346 * - decoding: set by user, may be overwritten by libavcodec.
2348 uint64_t channel_layout;
2351 * Request decoder to use this channel layout if it can (0 for default)
2352 * - encoding: unused
2353 * - decoding: Set by user.
2355 uint64_t request_channel_layout;
2358 * Type of service that the audio stream conveys.
2359 * - encoding: Set by user.
2360 * - decoding: Set by libavcodec.
2362 enum AVAudioServiceType audio_service_type;
2365 * desired sample format
2366 * - encoding: Not used.
2367 * - decoding: Set by user.
2368 * Decoder will decode to this format if it can.
2370 enum AVSampleFormat request_sample_fmt;
2373 * This callback is called at the beginning of each frame to get data
2374 * buffer(s) for it. There may be one contiguous buffer for all the data or
2375 * there may be a buffer per each data plane or anything in between. What
2376 * this means is, you may set however many entries in buf[] you feel necessary.
2377 * Each buffer must be reference-counted using the AVBuffer API (see description
2380 * The following fields will be set in the frame before this callback is
2383 * - width, height (video only)
2384 * - sample_rate, channel_layout, nb_samples (audio only)
2385 * Their values may differ from the corresponding values in
2386 * AVCodecContext. This callback must use the frame values, not the codec
2387 * context values, to calculate the required buffer size.
2389 * This callback must fill the following fields in the frame:
2393 * * if the data is planar audio with more than 8 channels, then this
2394 * callback must allocate and fill extended_data to contain all pointers
2395 * to all data planes. data[] must hold as many pointers as it can.
2396 * extended_data must be allocated with av_malloc() and will be freed in
2398 * * otherwise exended_data must point to data
2399 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2400 * the frame's data and extended_data pointers must be contained in these. That
2401 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2402 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2403 * and av_buffer_ref().
2404 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2405 * this callback and filled with the extra buffers if there are more
2406 * buffers than buf[] can hold. extended_buf will be freed in
2409 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2410 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2413 * Each data plane must be aligned to the maximum required by the target
2416 * @see avcodec_default_get_buffer2()
2420 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2421 * (read and/or written to if it is writable) later by libavcodec.
2423 * avcodec_align_dimensions2() should be used to find the required width and
2424 * height, as they normally need to be rounded up to the next multiple of 16.
2426 * Some decoders do not support linesizes changing between frames.
2428 * If frame multithreading is used and thread_safe_callbacks is set,
2429 * this callback may be called from a different thread, but not from more
2430 * than one at once. Does not need to be reentrant.
2432 * @see avcodec_align_dimensions2()
2436 * Decoders request a buffer of a particular size by setting
2437 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2438 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2439 * to a smaller value in the output frame.
2441 * As a convenience, av_samples_get_buffer_size() and
2442 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2443 * functions to find the required data size and to fill data pointers and
2444 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2445 * since all planes must be the same size.
2447 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2449 * - encoding: unused
2450 * - decoding: Set by libavcodec, user can override.
2452 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2455 * If non-zero, the decoded audio and video frames returned from
2456 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2457 * and are valid indefinitely. The caller must free them with
2458 * av_frame_unref() when they are not needed anymore.
2459 * Otherwise, the decoded frames must not be freed by the caller and are
2460 * only valid until the next decode call.
2462 * - encoding: unused
2463 * - decoding: set by the caller before avcodec_open2().
2465 int refcounted_frames;
2467 /* - encoding parameters */
2468 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2469 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2473 * - encoding: Set by user.
2474 * - decoding: unused
2480 * - encoding: Set by user.
2481 * - decoding: unused
2486 * maximum quantizer difference between frames
2487 * - encoding: Set by user.
2488 * - decoding: unused
2494 * @deprecated use encoder private options instead
2496 attribute_deprecated
2499 attribute_deprecated
2501 attribute_deprecated
2506 * decoder bitstream buffer size
2507 * - encoding: Set by user.
2508 * - decoding: unused
2513 * ratecontrol override, see RcOverride
2514 * - encoding: Allocated/set/freed by user.
2515 * - decoding: unused
2517 int rc_override_count;
2518 RcOverride *rc_override;
2522 * @deprecated use encoder private options instead
2524 attribute_deprecated
2530 * - encoding: Set by user.
2531 * - decoding: Set by user, may be overwritten by libavcodec.
2533 int64_t rc_max_rate;
2537 * - encoding: Set by user.
2538 * - decoding: unused
2540 int64_t rc_min_rate;
2544 * @deprecated use encoder private options instead
2546 attribute_deprecated
2547 float rc_buffer_aggressivity;
2549 attribute_deprecated
2550 float rc_initial_cplx;
2554 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2555 * - encoding: Set by user.
2556 * - decoding: unused.
2558 float rc_max_available_vbv_use;
2561 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2562 * - encoding: Set by user.
2563 * - decoding: unused.
2565 float rc_min_vbv_overflow_use;
2568 * Number of bits which should be loaded into the rc buffer before decoding starts.
2569 * - encoding: Set by user.
2570 * - decoding: unused
2572 int rc_initial_buffer_occupancy;
2574 #if FF_API_CODER_TYPE
2575 #define FF_CODER_TYPE_VLC 0
2576 #define FF_CODER_TYPE_AC 1
2577 #define FF_CODER_TYPE_RAW 2
2578 #define FF_CODER_TYPE_RLE 3
2579 #if FF_API_UNUSED_MEMBERS
2580 #define FF_CODER_TYPE_DEFLATE 4
2581 #endif /* FF_API_UNUSED_MEMBERS */
2583 * @deprecated use encoder private options instead
2585 attribute_deprecated
2587 #endif /* FF_API_CODER_TYPE */
2589 #if FF_API_PRIVATE_OPT
2590 /** @deprecated use encoder private options instead */
2591 attribute_deprecated
2597 * @deprecated use encoder private options instead
2599 attribute_deprecated
2603 * @deprecated use encoder private options instead
2605 attribute_deprecated
2609 #if FF_API_PRIVATE_OPT
2610 /** @deprecated use encoder private options instead */
2611 attribute_deprecated
2612 int frame_skip_threshold;
2614 /** @deprecated use encoder private options instead */
2615 attribute_deprecated
2616 int frame_skip_factor;
2618 /** @deprecated use encoder private options instead */
2619 attribute_deprecated
2622 /** @deprecated use encoder private options instead */
2623 attribute_deprecated
2625 #endif /* FF_API_PRIVATE_OPT */
2628 * trellis RD quantization
2629 * - encoding: Set by user.
2630 * - decoding: unused
2634 #if FF_API_PRIVATE_OPT
2635 /** @deprecated use encoder private options instead */
2636 attribute_deprecated
2637 int min_prediction_order;
2639 /** @deprecated use encoder private options instead */
2640 attribute_deprecated
2641 int max_prediction_order;
2643 /** @deprecated use encoder private options instead */
2644 attribute_deprecated
2645 int64_t timecode_frame_start;
2648 #if FF_API_RTP_CALLBACK
2650 * @deprecated unused
2652 /* The RTP callback: This function is called */
2653 /* every time the encoder has a packet to send. */
2654 /* It depends on the encoder if the data starts */
2655 /* with a Start Code (it should). H.263 does. */
2656 /* mb_nb contains the number of macroblocks */
2657 /* encoded in the RTP payload. */
2658 attribute_deprecated
2659 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2662 #if FF_API_PRIVATE_OPT
2663 /** @deprecated use encoder private options instead */
2664 attribute_deprecated
2665 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2666 /* do its best to deliver a chunk with size */
2667 /* below rtp_payload_size, the chunk will start */
2668 /* with a start code on some codecs like H.263. */
2669 /* This doesn't take account of any particular */
2670 /* headers inside the transmitted RTP payload. */
2673 #if FF_API_STAT_BITS
2674 /* statistics, used for 2-pass encoding */
2675 attribute_deprecated
2677 attribute_deprecated
2679 attribute_deprecated
2681 attribute_deprecated
2683 attribute_deprecated
2685 attribute_deprecated
2687 attribute_deprecated
2689 attribute_deprecated
2692 /** @deprecated this field is unused */
2693 attribute_deprecated
2698 * pass1 encoding statistics output buffer
2699 * - encoding: Set by libavcodec.
2700 * - decoding: unused
2705 * pass2 encoding statistics input buffer
2706 * Concatenated stuff from stats_out of pass1 should be placed here.
2707 * - encoding: Allocated/set/freed by user.
2708 * - decoding: unused
2713 * Work around bugs in encoders which sometimes cannot be detected automatically.
2714 * - encoding: Set by user
2715 * - decoding: Set by user
2717 int workaround_bugs;
2718 #define FF_BUG_AUTODETECT 1 ///< autodetection
2719 #if FF_API_OLD_MSMPEG4
2720 #define FF_BUG_OLD_MSMPEG4 2
2722 #define FF_BUG_XVID_ILACE 4
2723 #define FF_BUG_UMP4 8
2724 #define FF_BUG_NO_PADDING 16
2725 #define FF_BUG_AMV 32
2727 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2729 #define FF_BUG_QPEL_CHROMA 64
2730 #define FF_BUG_STD_QPEL 128
2731 #define FF_BUG_QPEL_CHROMA2 256
2732 #define FF_BUG_DIRECT_BLOCKSIZE 512
2733 #define FF_BUG_EDGE 1024
2734 #define FF_BUG_HPEL_CHROMA 2048
2735 #define FF_BUG_DC_CLIP 4096
2736 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2737 #define FF_BUG_TRUNCATED 16384
2740 * strictly follow the standard (MPEG4, ...).
2741 * - encoding: Set by user.
2742 * - decoding: Set by user.
2743 * Setting this to STRICT or higher means the encoder and decoder will
2744 * generally do stupid things, whereas setting it to unofficial or lower
2745 * will mean the encoder might produce output that is not supported by all
2746 * spec-compliant decoders. Decoders don't differentiate between normal,
2747 * unofficial and experimental (that is, they always try to decode things
2748 * when they can) unless they are explicitly asked to behave stupidly
2749 * (=strictly conform to the specs)
2751 int strict_std_compliance;
2752 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2753 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2754 #define FF_COMPLIANCE_NORMAL 0
2755 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2756 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2759 * error concealment flags
2760 * - encoding: unused
2761 * - decoding: Set by user.
2763 int error_concealment;
2764 #define FF_EC_GUESS_MVS 1
2765 #define FF_EC_DEBLOCK 2
2766 #define FF_EC_FAVOR_INTER 256
2770 * - encoding: Set by user.
2771 * - decoding: Set by user.
2774 #define FF_DEBUG_PICT_INFO 1
2775 #define FF_DEBUG_RC 2
2776 #define FF_DEBUG_BITSTREAM 4
2777 #define FF_DEBUG_MB_TYPE 8
2778 #define FF_DEBUG_QP 16
2781 * @deprecated this option does nothing
2783 #define FF_DEBUG_MV 32
2785 #define FF_DEBUG_DCT_COEFF 0x00000040
2786 #define FF_DEBUG_SKIP 0x00000080
2787 #define FF_DEBUG_STARTCODE 0x00000100
2788 #if FF_API_UNUSED_MEMBERS
2789 #define FF_DEBUG_PTS 0x00000200
2790 #endif /* FF_API_UNUSED_MEMBERS */
2791 #define FF_DEBUG_ER 0x00000400
2792 #define FF_DEBUG_MMCO 0x00000800
2793 #define FF_DEBUG_BUGS 0x00001000
2795 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2796 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2798 #define FF_DEBUG_BUFFERS 0x00008000
2799 #define FF_DEBUG_THREADS 0x00010000
2800 #define FF_DEBUG_GREEN_MD 0x00800000
2801 #define FF_DEBUG_NOMC 0x01000000
2806 * Code outside libavcodec should access this field using AVOptions
2807 * - encoding: Set by user.
2808 * - decoding: Set by user.
2811 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2812 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2813 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2817 * Error recognition; may misdetect some more or less valid parts as errors.
2818 * - encoding: unused
2819 * - decoding: Set by user.
2821 int err_recognition;
2824 * Verify checksums embedded in the bitstream (could be of either encoded or
2825 * decoded data, depending on the codec) and print an error message on mismatch.
2826 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2827 * decoder returning an error.
2829 #define AV_EF_CRCCHECK (1<<0)
2830 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2831 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2832 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2834 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2835 #define AV_EF_CAREFUL (1<<16) ///< consider things that violate the spec, are fast to calculate and have not been seen in the wild as errors
2836 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2837 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2841 * opaque 64bit number (generally a PTS) that will be reordered and
2842 * output in AVFrame.reordered_opaque
2843 * - encoding: unused
2844 * - decoding: Set by user.
2846 int64_t reordered_opaque;
2849 * Hardware accelerator in use
2850 * - encoding: unused.
2851 * - decoding: Set by libavcodec
2853 struct AVHWAccel *hwaccel;
2856 * Hardware accelerator context.
2857 * For some hardware accelerators, a global context needs to be
2858 * provided by the user. In that case, this holds display-dependent
2859 * data FFmpeg cannot instantiate itself. Please refer to the
2860 * FFmpeg HW accelerator documentation to know how to fill this
2861 * is. e.g. for VA API, this is a struct vaapi_context.
2862 * - encoding: unused
2863 * - decoding: Set by user
2865 void *hwaccel_context;
2869 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2870 * - decoding: unused
2872 uint64_t error[AV_NUM_DATA_POINTERS];
2875 * DCT algorithm, see FF_DCT_* below
2876 * - encoding: Set by user.
2877 * - decoding: unused
2880 #define FF_DCT_AUTO 0
2881 #define FF_DCT_FASTINT 1
2882 #define FF_DCT_INT 2
2883 #define FF_DCT_MMX 3
2884 #define FF_DCT_ALTIVEC 5
2885 #define FF_DCT_FAAN 6
2888 * IDCT algorithm, see FF_IDCT_* below.
2889 * - encoding: Set by user.
2890 * - decoding: Set by user.
2893 #define FF_IDCT_AUTO 0
2894 #define FF_IDCT_INT 1
2895 #define FF_IDCT_SIMPLE 2
2896 #define FF_IDCT_SIMPLEMMX 3
2897 #define FF_IDCT_ARM 7
2898 #define FF_IDCT_ALTIVEC 8
2900 #define FF_IDCT_SH4 9
2902 #define FF_IDCT_SIMPLEARM 10
2903 #if FF_API_UNUSED_MEMBERS
2904 #define FF_IDCT_IPP 13
2905 #endif /* FF_API_UNUSED_MEMBERS */
2906 #define FF_IDCT_XVID 14
2907 #if FF_API_IDCT_XVIDMMX
2908 #define FF_IDCT_XVIDMMX 14
2909 #endif /* FF_API_IDCT_XVIDMMX */
2910 #define FF_IDCT_SIMPLEARMV5TE 16
2911 #define FF_IDCT_SIMPLEARMV6 17
2912 #if FF_API_ARCH_SPARC
2913 #define FF_IDCT_SIMPLEVIS 18
2915 #define FF_IDCT_FAAN 20
2916 #define FF_IDCT_SIMPLENEON 22
2917 #if FF_API_ARCH_ALPHA
2918 #define FF_IDCT_SIMPLEALPHA 23
2920 #define FF_IDCT_SIMPLEAUTO 128
2923 * bits per sample/pixel from the demuxer (needed for huffyuv).
2924 * - encoding: Set by libavcodec.
2925 * - decoding: Set by user.
2927 int bits_per_coded_sample;
2930 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2931 * - encoding: set by user.
2932 * - decoding: set by libavcodec.
2934 int bits_per_raw_sample;
2938 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2939 * - encoding: unused
2940 * - decoding: Set by user.
2941 * Code outside libavcodec should access this field using:
2942 * av_codec_{get,set}_lowres(avctx)
2947 #if FF_API_CODED_FRAME
2949 * the picture in the bitstream
2950 * - encoding: Set by libavcodec.
2951 * - decoding: unused
2953 * @deprecated use the quality factor packet side data instead
2955 attribute_deprecated AVFrame *coded_frame;
2960 * is used to decide how many independent tasks should be passed to execute()
2961 * - encoding: Set by user.
2962 * - decoding: Set by user.
2967 * Which multithreading methods to use.
2968 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2969 * so clients which cannot provide future frames should not use it.
2971 * - encoding: Set by user, otherwise the default is used.
2972 * - decoding: Set by user, otherwise the default is used.
2975 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2976 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2979 * Which multithreading methods are in use by the codec.
2980 * - encoding: Set by libavcodec.
2981 * - decoding: Set by libavcodec.
2983 int active_thread_type;
2986 * Set by the client if its custom get_buffer() callback can be called
2987 * synchronously from another thread, which allows faster multithreaded decoding.
2988 * draw_horiz_band() will be called from other threads regardless of this setting.
2989 * Ignored if the default get_buffer() is used.
2990 * - encoding: Set by user.
2991 * - decoding: Set by user.
2993 int thread_safe_callbacks;
2996 * The codec may call this to execute several independent things.
2997 * It will return only after finishing all tasks.
2998 * The user may replace this with some multithreaded implementation,
2999 * the default implementation will execute the parts serially.
3000 * @param count the number of things to execute
3001 * - encoding: Set by libavcodec, user can override.
3002 * - decoding: Set by libavcodec, user can override.
3004 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3007 * The codec may call this to execute several independent things.
3008 * It will return only after finishing all tasks.
3009 * The user may replace this with some multithreaded implementation,
3010 * the default implementation will execute the parts serially.
3011 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3012 * @param c context passed also to func
3013 * @param count the number of things to execute
3014 * @param arg2 argument passed unchanged to func
3015 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3016 * @param func function that will be called count times, with jobnr from 0 to count-1.
3017 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3018 * two instances of func executing at the same time will have the same threadnr.
3019 * @return always 0 currently, but code should handle a future improvement where when any call to func
3020 * returns < 0 no further calls to func may be done and < 0 is returned.
3021 * - encoding: Set by libavcodec, user can override.
3022 * - decoding: Set by libavcodec, user can override.
3024 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3027 * noise vs. sse weight for the nsse comparison function
3028 * - encoding: Set by user.
3029 * - decoding: unused
3035 * - encoding: Set by user.
3036 * - decoding: Set by libavcodec.
3039 #define FF_PROFILE_UNKNOWN -99
3040 #define FF_PROFILE_RESERVED -100
3042 #define FF_PROFILE_AAC_MAIN 0
3043 #define FF_PROFILE_AAC_LOW 1
3044 #define FF_PROFILE_AAC_SSR 2
3045 #define FF_PROFILE_AAC_LTP 3
3046 #define FF_PROFILE_AAC_HE 4
3047 #define FF_PROFILE_AAC_HE_V2 28
3048 #define FF_PROFILE_AAC_LD 22
3049 #define FF_PROFILE_AAC_ELD 38
3050 #define FF_PROFILE_MPEG2_AAC_LOW 128
3051 #define FF_PROFILE_MPEG2_AAC_HE 131
3053 #define FF_PROFILE_DTS 20
3054 #define FF_PROFILE_DTS_ES 30
3055 #define FF_PROFILE_DTS_96_24 40
3056 #define FF_PROFILE_DTS_HD_HRA 50
3057 #define FF_PROFILE_DTS_HD_MA 60
3058 #define FF_PROFILE_DTS_EXPRESS 70
3060 #define FF_PROFILE_MPEG2_422 0
3061 #define FF_PROFILE_MPEG2_HIGH 1
3062 #define FF_PROFILE_MPEG2_SS 2
3063 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3064 #define FF_PROFILE_MPEG2_MAIN 4
3065 #define FF_PROFILE_MPEG2_SIMPLE 5
3067 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3068 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3070 #define FF_PROFILE_H264_BASELINE 66
3071 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3072 #define FF_PROFILE_H264_MAIN 77
3073 #define FF_PROFILE_H264_EXTENDED 88
3074 #define FF_PROFILE_H264_HIGH 100
3075 #define FF_PROFILE_H264_HIGH_10 110
3076 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3077 #define FF_PROFILE_H264_HIGH_422 122
3078 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3079 #define FF_PROFILE_H264_HIGH_444 144
3080 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3081 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3082 #define FF_PROFILE_H264_CAVLC_444 44
3084 #define FF_PROFILE_VC1_SIMPLE 0
3085 #define FF_PROFILE_VC1_MAIN 1
3086 #define FF_PROFILE_VC1_COMPLEX 2
3087 #define FF_PROFILE_VC1_ADVANCED 3
3089 #define FF_PROFILE_MPEG4_SIMPLE 0
3090 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3091 #define FF_PROFILE_MPEG4_CORE 2
3092 #define FF_PROFILE_MPEG4_MAIN 3
3093 #define FF_PROFILE_MPEG4_N_BIT 4
3094 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3095 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3096 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3097 #define FF_PROFILE_MPEG4_HYBRID 8
3098 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3099 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3100 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3101 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3102 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3103 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3104 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3106 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
3107 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
3108 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
3109 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3110 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3112 #define FF_PROFILE_VP9_0 0
3113 #define FF_PROFILE_VP9_1 1
3114 #define FF_PROFILE_VP9_2 2
3115 #define FF_PROFILE_VP9_3 3
3117 #define FF_PROFILE_HEVC_MAIN 1
3118 #define FF_PROFILE_HEVC_MAIN_10 2
3119 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3120 #define FF_PROFILE_HEVC_REXT 4
3124 * - encoding: Set by user.
3125 * - decoding: Set by libavcodec.
3128 #define FF_LEVEL_UNKNOWN -99
3131 * Skip loop filtering for selected frames.
3132 * - encoding: unused
3133 * - decoding: Set by user.
3135 enum AVDiscard skip_loop_filter;
3138 * Skip IDCT/dequantization for selected frames.
3139 * - encoding: unused
3140 * - decoding: Set by user.
3142 enum AVDiscard skip_idct;
3145 * Skip decoding for selected frames.
3146 * - encoding: unused
3147 * - decoding: Set by user.
3149 enum AVDiscard skip_frame;
3152 * Header containing style information for text subtitles.
3153 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3154 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3155 * the Format line following. It shouldn't include any Dialogue line.
3156 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3157 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3159 uint8_t *subtitle_header;
3160 int subtitle_header_size;
3162 #if FF_API_ERROR_RATE
3164 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3167 attribute_deprecated
3171 #if FF_API_VBV_DELAY
3173 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3174 * Used for compliant TS muxing.
3175 * - encoding: Set by libavcodec.
3176 * - decoding: unused.
3177 * @deprecated this value is now exported as a part of
3178 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3180 attribute_deprecated
3184 #if FF_API_SIDEDATA_ONLY_PKT
3186 * Encoding only and set by default. Allow encoders to output packets
3187 * that do not contain any encoded data, only side data.
3189 * Some encoders need to output such packets, e.g. to update some stream
3190 * parameters at the end of encoding.
3192 * @deprecated this field disables the default behaviour and
3193 * it is kept only for compatibility.
3195 attribute_deprecated
3196 int side_data_only_packets;
3200 * Audio only. The number of "priming" samples (padding) inserted by the
3201 * encoder at the beginning of the audio. I.e. this number of leading
3202 * decoded samples must be discarded by the caller to get the original audio
3203 * without leading padding.
3205 * - decoding: unused
3206 * - encoding: Set by libavcodec. The timestamps on the output packets are
3207 * adjusted by the encoder so that they always refer to the
3208 * first sample of the data actually contained in the packet,
3209 * including any added padding. E.g. if the timebase is
3210 * 1/samplerate and the timestamp of the first input sample is
3211 * 0, the timestamp of the first output packet will be
3214 int initial_padding;
3217 * - decoding: For codecs that store a framerate value in the compressed
3218 * bitstream, the decoder may export it here. { 0, 1} when
3220 * - encoding: unused
3222 AVRational framerate;
3225 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3226 * - encoding: unused.
3227 * - decoding: Set by libavcodec before calling get_format()
3229 enum AVPixelFormat sw_pix_fmt;
3232 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3233 * Code outside libavcodec should access this field using:
3234 * av_codec_{get,set}_pkt_timebase(avctx)
3235 * - encoding unused.
3236 * - decoding set by user.
3238 AVRational pkt_timebase;
3242 * Code outside libavcodec should access this field using:
3243 * av_codec_{get,set}_codec_descriptor(avctx)
3244 * - encoding: unused.
3245 * - decoding: set by libavcodec.
3247 const AVCodecDescriptor *codec_descriptor;
3251 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3252 * - encoding: unused
3253 * - decoding: Set by user.
3254 * Code outside libavcodec should access this field using:
3255 * av_codec_{get,set}_lowres(avctx)
3261 * Current statistics for PTS correction.
3262 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3263 * - encoding: unused
3265 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3266 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3267 int64_t pts_correction_last_pts; /// PTS of the last frame
3268 int64_t pts_correction_last_dts; /// DTS of the last frame
3271 * Character encoding of the input subtitles file.
3272 * - decoding: set by user
3273 * - encoding: unused
3278 * Subtitles character encoding mode. Formats or codecs might be adjusting
3279 * this setting (if they are doing the conversion themselves for instance).
3280 * - decoding: set by libavcodec
3281 * - encoding: unused
3283 int sub_charenc_mode;
3284 #define FF_SUB_CHARENC_MODE_DO_NOTHING -1 ///< do nothing (demuxer outputs a stream supposed to be already in UTF-8, or the codec is bitmap for instance)
3285 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3286 #define FF_SUB_CHARENC_MODE_PRE_DECODER 1 ///< the AVPacket data needs to be recoded to UTF-8 before being fed to the decoder, requires iconv
3289 * Skip processing alpha if supported by codec.
3290 * Note that if the format uses pre-multiplied alpha (common with VP6,
3291 * and recommended due to better video quality/compression)
3292 * the image will look as if alpha-blended onto a black background.
3293 * However for formats that do not use pre-multiplied alpha
3294 * there might be serious artefacts (though e.g. libswscale currently
3295 * assumes pre-multiplied alpha anyway).
3296 * Code outside libavcodec should access this field using AVOptions
3298 * - decoding: set by user
3299 * - encoding: unused
3304 * Number of samples to skip after a discontinuity
3305 * - decoding: unused
3306 * - encoding: set by libavcodec
3310 #if !FF_API_DEBUG_MV
3312 * debug motion vectors
3313 * Code outside libavcodec should access this field using AVOptions
3314 * - encoding: Set by user.
3315 * - decoding: Set by user.
3318 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3319 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3320 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3324 * custom intra quantization matrix
3325 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3326 * - encoding: Set by user, can be NULL.
3327 * - decoding: unused.
3329 uint16_t *chroma_intra_matrix;
3332 * dump format separator.
3333 * can be ", " or "\n " or anything else
3334 * Code outside libavcodec should access this field using AVOptions
3335 * (NO direct access).
3336 * - encoding: Set by user.
3337 * - decoding: Set by user.
3339 uint8_t *dump_separator;
3342 * ',' separated list of allowed decoders.
3343 * If NULL then all are allowed
3344 * - encoding: unused
3345 * - decoding: set by user through AVOPtions (NO direct access)
3347 char *codec_whitelist;
3350 * Properties of the stream that gets decoded
3351 * To be accessed through av_codec_get_properties() (NO direct access)
3352 * - encoding: unused
3353 * - decoding: set by libavcodec
3355 unsigned properties;
3356 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3357 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3360 * Additional data associated with the entire coded stream.
3362 * - decoding: unused
3363 * - encoding: may be set by libavcodec after avcodec_open2().
3365 AVPacketSideData *coded_side_data;
3366 int nb_coded_side_data;
3370 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3371 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3373 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3374 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3376 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3378 int av_codec_get_lowres(const AVCodecContext *avctx);
3379 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3381 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3382 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3384 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3385 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3390 typedef struct AVProfile {
3392 const char *name; ///< short name for the profile
3395 typedef struct AVCodecDefault AVCodecDefault;
3402 typedef struct AVCodec {
3404 * Name of the codec implementation.
3405 * The name is globally unique among encoders and among decoders (but an
3406 * encoder and a decoder can share the same name).
3407 * This is the primary way to find a codec from the user perspective.
3411 * Descriptive name for the codec, meant to be more human readable than name.
3412 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3414 const char *long_name;
3415 enum AVMediaType type;
3418 * Codec capabilities.
3419 * see AV_CODEC_CAP_*
3422 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3423 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3424 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3425 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3426 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3427 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3428 const AVClass *priv_class; ///< AVClass for the private context
3429 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3431 /*****************************************************************
3432 * No fields below this line are part of the public API. They
3433 * may not be used outside of libavcodec and can be changed and
3435 * New public fields should be added right above.
3436 *****************************************************************
3439 struct AVCodec *next;
3441 * @name Frame-level threading support functions
3445 * If defined, called on thread contexts when they are created.
3446 * If the codec allocates writable tables in init(), re-allocate them here.
3447 * priv_data will be set to a copy of the original.
3449 int (*init_thread_copy)(AVCodecContext *);
3451 * Copy necessary context variables from a previous thread context to the current one.
3452 * If not defined, the next thread will start automatically; otherwise, the codec
3453 * must call ff_thread_finish_setup().
3455 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3457 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3461 * Private codec-specific defaults.
3463 const AVCodecDefault *defaults;
3466 * Initialize codec static data, called from avcodec_register().
3468 void (*init_static_data)(struct AVCodec *codec);
3470 int (*init)(AVCodecContext *);
3471 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3472 const struct AVSubtitle *sub);
3474 * Encode data to an AVPacket.
3476 * @param avctx codec context
3477 * @param avpkt output AVPacket (may contain a user-provided buffer)
3478 * @param[in] frame AVFrame containing the raw data to be encoded
3479 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3480 * non-empty packet was returned in avpkt.
3481 * @return 0 on success, negative error code on failure
3483 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3484 int *got_packet_ptr);
3485 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3486 int (*close)(AVCodecContext *);
3489 * Will be called when seeking
3491 void (*flush)(AVCodecContext *);
3493 * Internal codec capabilities.
3494 * See FF_CODEC_CAP_* in internal.h
3499 int av_codec_get_max_lowres(const AVCodec *codec);
3501 struct MpegEncContext;
3504 * @defgroup lavc_hwaccel AVHWAccel
3507 typedef struct AVHWAccel {
3509 * Name of the hardware accelerated codec.
3510 * The name is globally unique among encoders and among decoders (but an
3511 * encoder and a decoder can share the same name).
3516 * Type of codec implemented by the hardware accelerator.
3518 * See AVMEDIA_TYPE_xxx
3520 enum AVMediaType type;
3523 * Codec implemented by the hardware accelerator.
3525 * See AV_CODEC_ID_xxx
3530 * Supported pixel format.
3532 * Only hardware accelerated formats are supported here.
3534 enum AVPixelFormat pix_fmt;
3537 * Hardware accelerated codec capabilities.
3538 * see HWACCEL_CODEC_CAP_*
3542 /*****************************************************************
3543 * No fields below this line are part of the public API. They
3544 * may not be used outside of libavcodec and can be changed and
3546 * New public fields should be added right above.
3547 *****************************************************************
3549 struct AVHWAccel *next;
3552 * Allocate a custom buffer
3554 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3557 * Called at the beginning of each frame or field picture.
3559 * Meaningful frame information (codec specific) is guaranteed to
3560 * be parsed at this point. This function is mandatory.
3562 * Note that buf can be NULL along with buf_size set to 0.
3563 * Otherwise, this means the whole frame is available at this point.
3565 * @param avctx the codec context
3566 * @param buf the frame data buffer base
3567 * @param buf_size the size of the frame in bytes
3568 * @return zero if successful, a negative value otherwise
3570 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3573 * Callback for each slice.
3575 * Meaningful slice information (codec specific) is guaranteed to
3576 * be parsed at this point. This function is mandatory.
3577 * The only exception is XvMC, that works on MB level.
3579 * @param avctx the codec context
3580 * @param buf the slice data buffer base
3581 * @param buf_size the size of the slice in bytes
3582 * @return zero if successful, a negative value otherwise
3584 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3587 * Called at the end of each frame or field picture.
3589 * The whole picture is parsed at this point and can now be sent
3590 * to the hardware accelerator. This function is mandatory.
3592 * @param avctx the codec context
3593 * @return zero if successful, a negative value otherwise
3595 int (*end_frame)(AVCodecContext *avctx);
3598 * Size of per-frame hardware accelerator private data.
3600 * Private data is allocated with av_mallocz() before
3601 * AVCodecContext.get_buffer() and deallocated after
3602 * AVCodecContext.release_buffer().
3604 int frame_priv_data_size;
3607 * Called for every Macroblock in a slice.
3609 * XvMC uses it to replace the ff_mpv_decode_mb().
3610 * Instead of decoding to raw picture, MB parameters are
3611 * stored in an array provided by the video driver.
3613 * @param s the mpeg context
3615 void (*decode_mb)(struct MpegEncContext *s);
3618 * Initialize the hwaccel private data.
3620 * This will be called from ff_get_format(), after hwaccel and
3621 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3624 int (*init)(AVCodecContext *avctx);
3627 * Uninitialize the hwaccel private data.
3629 * This will be called from get_format() or avcodec_close(), after hwaccel
3630 * and hwaccel_context are already uninitialized.
3632 int (*uninit)(AVCodecContext *avctx);
3635 * Size of the private data to allocate in
3636 * AVCodecInternal.hwaccel_priv_data.
3642 * Hardware acceleration should be used for decoding even if the codec level
3643 * used is unknown or higher than the maximum supported level reported by the
3646 * It's generally a good idea to pass this flag unless you have a specific
3647 * reason not to, as hardware tends to under-report supported levels.
3649 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3652 * Hardware acceleration can output YUV pixel formats with a different chroma
3653 * sampling than 4:2:0 and/or other than 8 bits per component.
3655 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3661 #if FF_API_AVPICTURE
3663 * @defgroup lavc_picture AVPicture
3665 * Functions for working with AVPicture
3670 * Picture data structure.
3672 * Up to four components can be stored into it, the last component is
3674 * @deprecated use AVFrame or imgutils functions instead
3676 typedef struct AVPicture {
3677 attribute_deprecated
3678 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3679 attribute_deprecated
3680 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3688 enum AVSubtitleType {
3691 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3694 * Plain text, the text field must be set by the decoder and is
3695 * authoritative. ass and pict fields may contain approximations.
3700 * Formatted text, the ass field must be set by the decoder and is
3701 * authoritative. pict and text fields may contain approximations.
3706 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3708 typedef struct AVSubtitleRect {
3709 int x; ///< top left corner of pict, undefined when pict is not set
3710 int y; ///< top left corner of pict, undefined when pict is not set
3711 int w; ///< width of pict, undefined when pict is not set
3712 int h; ///< height of pict, undefined when pict is not set
3713 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3715 #if FF_API_AVPICTURE
3717 * @deprecated unused
3719 attribute_deprecated
3723 * data+linesize for the bitmap of this subtitle.
3724 * Can be set for text/ass as well once they are rendered.
3729 enum AVSubtitleType type;
3731 char *text; ///< 0 terminated plain UTF-8 text
3734 * 0 terminated ASS/SSA compatible event line.
3735 * The presentation of this is unaffected by the other values in this
3743 typedef struct AVSubtitle {
3744 uint16_t format; /* 0 = graphics */
3745 uint32_t start_display_time; /* relative to packet pts, in ms */
3746 uint32_t end_display_time; /* relative to packet pts, in ms */
3748 AVSubtitleRect **rects;
3749 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3753 * If c is NULL, returns the first registered codec,
3754 * if c is non-NULL, returns the next registered codec after c,
3755 * or NULL if c is the last one.
3757 AVCodec *av_codec_next(const AVCodec *c);
3760 * Return the LIBAVCODEC_VERSION_INT constant.
3762 unsigned avcodec_version(void);
3765 * Return the libavcodec build-time configuration.
3767 const char *avcodec_configuration(void);
3770 * Return the libavcodec license.
3772 const char *avcodec_license(void);
3775 * Register the codec codec and initialize libavcodec.
3777 * @warning either this function or avcodec_register_all() must be called
3778 * before any other libavcodec functions.
3780 * @see avcodec_register_all()
3782 void avcodec_register(AVCodec *codec);
3785 * Register all the codecs, parsers and bitstream filters which were enabled at
3786 * configuration time. If you do not call this function you can select exactly
3787 * which formats you want to support, by using the individual registration
3790 * @see avcodec_register
3791 * @see av_register_codec_parser
3792 * @see av_register_bitstream_filter
3794 void avcodec_register_all(void);
3797 * Allocate an AVCodecContext and set its fields to default values. The
3798 * resulting struct should be freed with avcodec_free_context().
3800 * @param codec if non-NULL, allocate private data and initialize defaults
3801 * for the given codec. It is illegal to then call avcodec_open2()
3802 * with a different codec.
3803 * If NULL, then the codec-specific defaults won't be initialized,
3804 * which may result in suboptimal default settings (this is
3805 * important mainly for encoders, e.g. libx264).
3807 * @return An AVCodecContext filled with default values or NULL on failure.
3808 * @see avcodec_get_context_defaults
3810 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3813 * Free the codec context and everything associated with it and write NULL to
3814 * the provided pointer.
3816 void avcodec_free_context(AVCodecContext **avctx);
3819 * Set the fields of the given AVCodecContext to default values corresponding
3820 * to the given codec (defaults may be codec-dependent).
3822 * Do not call this function if a non-NULL codec has been passed
3823 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3824 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3825 * different codec on this AVCodecContext.
3827 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3830 * Get the AVClass for AVCodecContext. It can be used in combination with
3831 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3833 * @see av_opt_find().
3835 const AVClass *avcodec_get_class(void);
3838 * Get the AVClass for AVFrame. It can be used in combination with
3839 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3841 * @see av_opt_find().
3843 const AVClass *avcodec_get_frame_class(void);
3846 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3847 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3849 * @see av_opt_find().
3851 const AVClass *avcodec_get_subtitle_rect_class(void);
3854 * Copy the settings of the source AVCodecContext into the destination
3855 * AVCodecContext. The resulting destination codec context will be
3856 * unopened, i.e. you are required to call avcodec_open2() before you
3857 * can use this AVCodecContext to decode/encode video/audio data.
3859 * @param dest target codec context, should be initialized with
3860 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3861 * @param src source codec context
3862 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3864 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3867 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3868 * function the context has to be allocated with avcodec_alloc_context3().
3870 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3871 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3872 * retrieving a codec.
3874 * @warning This function is not thread safe!
3876 * @note Always call this function before using decoding routines (such as
3877 * @ref avcodec_decode_video2()).
3880 * avcodec_register_all();
3881 * av_dict_set(&opts, "b", "2.5M", 0);
3882 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3886 * context = avcodec_alloc_context3(codec);
3888 * if (avcodec_open2(context, codec, opts) < 0)
3892 * @param avctx The context to initialize.
3893 * @param codec The codec to open this context for. If a non-NULL codec has been
3894 * previously passed to avcodec_alloc_context3() or
3895 * avcodec_get_context_defaults3() for this context, then this
3896 * parameter MUST be either NULL or equal to the previously passed
3898 * @param options A dictionary filled with AVCodecContext and codec-private options.
3899 * On return this object will be filled with options that were not found.
3901 * @return zero on success, a negative value on error
3902 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3903 * av_dict_set(), av_opt_find().
3905 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3908 * Close a given AVCodecContext and free all the data associated with it
3909 * (but not the AVCodecContext itself).
3911 * Calling this function on an AVCodecContext that hasn't been opened will free
3912 * the codec-specific data allocated in avcodec_alloc_context3() /
3913 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3916 int avcodec_close(AVCodecContext *avctx);
3919 * Free all allocated data in the given subtitle struct.
3921 * @param sub AVSubtitle to free.
3923 void avsubtitle_free(AVSubtitle *sub);
3930 * @addtogroup lavc_packet
3935 * Allocate an AVPacket and set its fields to default values. The resulting
3936 * struct must be freed using av_packet_free().
3938 * @return An AVPacket filled with default values or NULL on failure.
3940 * @note this only allocates the AVPacket itself, not the data buffers. Those
3941 * must be allocated through other means such as av_new_packet.
3943 * @see av_new_packet
3945 AVPacket *av_packet_alloc(void);
3948 * Create a new packet that references the same data as src.
3950 * This is a shortcut for av_packet_alloc()+av_packet_ref().
3952 * @return newly created AVPacket on success, NULL on error.
3954 * @see av_packet_alloc
3955 * @see av_packet_ref
3957 AVPacket *av_packet_clone(AVPacket *src);
3960 * Free the packet, if the packet is reference counted, it will be
3961 * unreferenced first.
3963 * @param packet packet to be freed. The pointer will be set to NULL.
3964 * @note passing NULL is a no-op.
3966 void av_packet_free(AVPacket **pkt);
3969 * Initialize optional fields of a packet with default values.
3971 * Note, this does not touch the data and size members, which have to be
3972 * initialized separately.
3976 void av_init_packet(AVPacket *pkt);
3979 * Allocate the payload of a packet and initialize its fields with
3983 * @param size wanted payload size
3984 * @return 0 if OK, AVERROR_xxx otherwise
3986 int av_new_packet(AVPacket *pkt, int size);
3989 * Reduce packet size, correctly zeroing padding
3992 * @param size new size
3994 void av_shrink_packet(AVPacket *pkt, int size);
3997 * Increase packet size, correctly zeroing padding
4000 * @param grow_by number of bytes by which to increase the size of the packet
4002 int av_grow_packet(AVPacket *pkt, int grow_by);
4005 * Initialize a reference-counted packet from av_malloc()ed data.
4007 * @param pkt packet to be initialized. This function will set the data, size,
4008 * buf and destruct fields, all others are left untouched.
4009 * @param data Data allocated by av_malloc() to be used as packet data. If this
4010 * function returns successfully, the data is owned by the underlying AVBuffer.
4011 * The caller may not access the data through other means.
4012 * @param size size of data in bytes, without the padding. I.e. the full buffer
4013 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4015 * @return 0 on success, a negative AVERROR on error
4017 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4019 #if FF_API_AVPACKET_OLD_API
4021 * @warning This is a hack - the packet memory allocation stuff is broken. The
4022 * packet is allocated if it was not really allocated.
4024 * @deprecated Use av_packet_ref
4026 attribute_deprecated
4027 int av_dup_packet(AVPacket *pkt);
4029 * Copy packet, including contents
4031 * @return 0 on success, negative AVERROR on fail
4033 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4036 * Copy packet side data
4038 * @return 0 on success, negative AVERROR on fail
4040 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4045 * @deprecated Use av_packet_unref
4047 * @param pkt packet to free
4049 attribute_deprecated
4050 void av_free_packet(AVPacket *pkt);
4053 * Allocate new information of a packet.
4056 * @param type side information type
4057 * @param size side information size
4058 * @return pointer to fresh allocated data or NULL otherwise
4060 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4064 * Wrap an existing array as a packet side data.
4067 * @param type side information type
4068 * @param data the side data array. It must be allocated with the av_malloc()
4069 * family of functions. The ownership of the data is transferred to
4071 * @param size side information size
4072 * @return a non-negative number on success, a negative AVERROR code on
4073 * failure. On failure, the packet is unchanged and the data remains
4074 * owned by the caller.
4076 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4077 uint8_t *data, size_t size);
4080 * Shrink the already allocated side data buffer
4083 * @param type side information type
4084 * @param size new side information size
4085 * @return 0 on success, < 0 on failure
4087 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4091 * Get side information from packet.
4094 * @param type desired side information type
4095 * @param size pointer for side information size to store (optional)
4096 * @return pointer to data if present or NULL otherwise
4098 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4101 int av_packet_merge_side_data(AVPacket *pkt);
4103 int av_packet_split_side_data(AVPacket *pkt);
4105 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4108 * Pack a dictionary for use in side_data.
4110 * @param dict The dictionary to pack.
4111 * @param size pointer to store the size of the returned data
4112 * @return pointer to data if successful, NULL otherwise
4114 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4116 * Unpack a dictionary from side_data.
4118 * @param data data from side_data
4119 * @param size size of the data
4120 * @param dict the metadata storage dictionary
4121 * @return 0 on success, < 0 on failure
4123 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4127 * Convenience function to free all the side data stored.
4128 * All the other fields stay untouched.
4132 void av_packet_free_side_data(AVPacket *pkt);
4135 * Setup a new reference to the data described by a given packet
4137 * If src is reference-counted, setup dst as a new reference to the
4138 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4139 * data from src into it.
4141 * All the other fields are copied from src.
4143 * @see av_packet_unref
4145 * @param dst Destination packet
4146 * @param src Source packet
4148 * @return 0 on success, a negative AVERROR on error.
4150 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4155 * Unreference the buffer referenced by the packet and reset the
4156 * remaining packet fields to their default values.
4158 * @param pkt The packet to be unreferenced.
4160 void av_packet_unref(AVPacket *pkt);
4163 * Move every field in src to dst and reset src.
4165 * @see av_packet_unref
4167 * @param src Source packet, will be reset
4168 * @param dst Destination packet
4170 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4173 * Copy only "properties" fields from src to dst.
4175 * Properties for the purpose of this function are all the fields
4176 * beside those related to the packet data (buf, data, size)
4178 * @param dst Destination packet
4179 * @param src Source packet
4181 * @return 0 on success AVERROR on failure.
4184 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4187 * Convert valid timing fields (timestamps / durations) in a packet from one
4188 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4191 * @param pkt packet on which the conversion will be performed
4192 * @param tb_src source timebase, in which the timing fields in pkt are
4194 * @param tb_dst destination timebase, to which the timing fields will be
4197 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4204 * @addtogroup lavc_decoding
4209 * Find a registered decoder with a matching codec ID.
4211 * @param id AVCodecID of the requested decoder
4212 * @return A decoder if one was found, NULL otherwise.
4214 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4217 * Find a registered decoder with the specified name.
4219 * @param name name of the requested decoder
4220 * @return A decoder if one was found, NULL otherwise.
4222 AVCodec *avcodec_find_decoder_by_name(const char *name);
4225 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4226 * it can be called by custom get_buffer2() implementations for decoders without
4227 * AV_CODEC_CAP_DR1 set.
4229 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4233 * Return the amount of padding in pixels which the get_buffer callback must
4234 * provide around the edge of the image for codecs which do not have the
4235 * CODEC_FLAG_EMU_EDGE flag.
4237 * @return Required padding in pixels.
4239 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4242 attribute_deprecated
4243 unsigned avcodec_get_edge_width(void);
4247 * Modify width and height values so that they will result in a memory
4248 * buffer that is acceptable for the codec if you do not use any horizontal
4251 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4253 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4256 * Modify width and height values so that they will result in a memory
4257 * buffer that is acceptable for the codec if you also ensure that all
4258 * line sizes are a multiple of the respective linesize_align[i].
4260 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4262 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4263 int linesize_align[AV_NUM_DATA_POINTERS]);
4266 * Converts AVChromaLocation to swscale x/y chroma position.
4268 * The positions represent the chroma (0,0) position in a coordinates system
4269 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4271 * @param xpos horizontal chroma sample position
4272 * @param ypos vertical chroma sample position
4274 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4277 * Converts swscale x/y chroma position to AVChromaLocation.
4279 * The positions represent the chroma (0,0) position in a coordinates system
4280 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4282 * @param xpos horizontal chroma sample position
4283 * @param ypos vertical chroma sample position
4285 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4288 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4290 * Some decoders may support multiple frames in a single AVPacket. Such
4291 * decoders would then just decode the first frame and the return value would be
4292 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4293 * called again with an AVPacket containing the remaining data in order to
4294 * decode the second frame, etc... Even if no frames are returned, the packet
4295 * needs to be fed to the decoder with remaining data until it is completely
4296 * consumed or an error occurs.
4298 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4299 * and output. This means that for some packets they will not immediately
4300 * produce decoded output and need to be flushed at the end of decoding to get
4301 * all the decoded data. Flushing is done by calling this function with packets
4302 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4303 * returning samples. It is safe to flush even those decoders that are not
4304 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4306 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4307 * larger than the actual read bytes because some optimized bitstream
4308 * readers read 32 or 64 bits at once and could read over the end.
4310 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4311 * before packets may be fed to the decoder.
4313 * @param avctx the codec context
4314 * @param[out] frame The AVFrame in which to store decoded audio samples.
4315 * The decoder will allocate a buffer for the decoded frame by
4316 * calling the AVCodecContext.get_buffer2() callback.
4317 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4318 * reference counted and the returned reference belongs to the
4319 * caller. The caller must release the frame using av_frame_unref()
4320 * when the frame is no longer needed. The caller may safely write
4321 * to the frame if av_frame_is_writable() returns 1.
4322 * When AVCodecContext.refcounted_frames is set to 0, the returned
4323 * reference belongs to the decoder and is valid only until the
4324 * next call to this function or until closing or flushing the
4325 * decoder. The caller may not write to it.
4326 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4327 * non-zero. Note that this field being set to zero
4328 * does not mean that an error has occurred. For
4329 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4330 * call is guaranteed to produce a frame.
4331 * @param[in] avpkt The input AVPacket containing the input buffer.
4332 * At least avpkt->data and avpkt->size should be set. Some
4333 * decoders might also require additional fields to be set.
4334 * @return A negative error code is returned if an error occurred during
4335 * decoding, otherwise the number of bytes consumed from the input
4336 * AVPacket is returned.
4338 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4339 int *got_frame_ptr, const AVPacket *avpkt);
4342 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4343 * Some decoders may support multiple frames in a single AVPacket, such
4344 * decoders would then just decode the first frame.
4346 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4347 * the actual read bytes because some optimized bitstream readers read 32 or 64
4348 * bits at once and could read over the end.
4350 * @warning The end of the input buffer buf should be set to 0 to ensure that
4351 * no overreading happens for damaged MPEG streams.
4353 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4354 * between input and output, these need to be fed with avpkt->data=NULL,
4355 * avpkt->size=0 at the end to return the remaining frames.
4357 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4358 * before packets may be fed to the decoder.
4360 * @param avctx the codec context
4361 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4362 * Use av_frame_alloc() to get an AVFrame. The codec will
4363 * allocate memory for the actual bitmap by calling the
4364 * AVCodecContext.get_buffer2() callback.
4365 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4366 * reference counted and the returned reference belongs to the
4367 * caller. The caller must release the frame using av_frame_unref()
4368 * when the frame is no longer needed. The caller may safely write
4369 * to the frame if av_frame_is_writable() returns 1.
4370 * When AVCodecContext.refcounted_frames is set to 0, the returned
4371 * reference belongs to the decoder and is valid only until the
4372 * next call to this function or until closing or flushing the
4373 * decoder. The caller may not write to it.
4375 * @param[in] avpkt The input AVPacket containing the input buffer.
4376 * You can create such packet with av_init_packet() and by then setting
4377 * data and size, some decoders might in addition need other fields like
4378 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4380 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4381 * @return On error a negative value is returned, otherwise the number of bytes
4382 * used or zero if no frame could be decompressed.
4384 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4385 int *got_picture_ptr,
4386 const AVPacket *avpkt);
4389 * Decode a subtitle message.
4390 * Return a negative value on error, otherwise return the number of bytes used.
4391 * If no subtitle could be decompressed, got_sub_ptr is zero.
4392 * Otherwise, the subtitle is stored in *sub.
4393 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4394 * simplicity, because the performance difference is expect to be negligible
4395 * and reusing a get_buffer written for video codecs would probably perform badly
4396 * due to a potentially very different allocation pattern.
4398 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4399 * and output. This means that for some packets they will not immediately
4400 * produce decoded output and need to be flushed at the end of decoding to get
4401 * all the decoded data. Flushing is done by calling this function with packets
4402 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4403 * returning subtitles. It is safe to flush even those decoders that are not
4404 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4406 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4407 * before packets may be fed to the decoder.
4409 * @param avctx the codec context
4410 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4411 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4412 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4413 * @param[in] avpkt The input AVPacket containing the input buffer.
4415 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4420 * @defgroup lavc_parsing Frame parsing
4424 enum AVPictureStructure {
4425 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4426 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4427 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4428 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4431 typedef struct AVCodecParserContext {
4433 struct AVCodecParser *parser;
4434 int64_t frame_offset; /* offset of the current frame */
4435 int64_t cur_offset; /* current offset
4436 (incremented by each av_parser_parse()) */
4437 int64_t next_frame_offset; /* offset of the next frame */
4439 int pict_type; /* XXX: Put it back in AVCodecContext. */
4441 * This field is used for proper frame duration computation in lavf.
4442 * It signals, how much longer the frame duration of the current frame
4443 * is compared to normal frame duration.
4445 * frame_duration = (1 + repeat_pict) * time_base
4447 * It is used by codecs like H.264 to display telecined material.
4449 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4450 int64_t pts; /* pts of the current frame */
4451 int64_t dts; /* dts of the current frame */
4456 int fetch_timestamp;
4458 #define AV_PARSER_PTS_NB 4
4459 int cur_frame_start_index;
4460 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4461 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4462 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4465 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4466 #define PARSER_FLAG_ONCE 0x0002
4467 /// Set if the parser has a valid file offset
4468 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4469 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4471 int64_t offset; ///< byte offset from starting packet start
4472 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4475 * Set by parser to 1 for key frames and 0 for non-key frames.
4476 * It is initialized to -1, so if the parser doesn't set this flag,
4477 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4482 #if FF_API_CONVERGENCE_DURATION
4484 * @deprecated unused
4486 attribute_deprecated
4487 int64_t convergence_duration;
4490 // Timestamp generation support:
4492 * Synchronization point for start of timestamp generation.
4494 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4497 * For example, this corresponds to presence of H.264 buffering period
4503 * Offset of the current timestamp against last timestamp sync point in
4504 * units of AVCodecContext.time_base.
4506 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4507 * contain a valid timestamp offset.
4509 * Note that the timestamp of sync point has usually a nonzero
4510 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4511 * the next frame after timestamp sync point will be usually 1.
4513 * For example, this corresponds to H.264 cpb_removal_delay.
4515 int dts_ref_dts_delta;
4518 * Presentation delay of current frame in units of AVCodecContext.time_base.
4520 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4521 * contain valid non-negative timestamp delta (presentation time of a frame
4522 * must not lie in the past).
4524 * This delay represents the difference between decoding and presentation
4525 * time of the frame.
4527 * For example, this corresponds to H.264 dpb_output_delay.
4532 * Position of the packet in file.
4534 * Analogous to cur_frame_pts/dts
4536 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4539 * Byte position of currently parsed frame in stream.
4544 * Previous frame byte position.
4549 * Duration of the current frame.
4550 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4551 * For all other types, this is in units of AVCodecContext.time_base.
4555 enum AVFieldOrder field_order;
4558 * Indicate whether a picture is coded as a frame, top field or bottom field.
4560 * For example, H.264 field_pic_flag equal to 0 corresponds to
4561 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4562 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4563 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4565 enum AVPictureStructure picture_structure;
4568 * Picture number incremented in presentation or output order.
4569 * This field may be reinitialized at the first picture of a new sequence.
4571 * For example, this corresponds to H.264 PicOrderCnt.
4573 int output_picture_number;
4576 * Dimensions of the decoded video intended for presentation.
4582 * Dimensions of the coded video.
4588 * The format of the coded data, corresponds to enum AVPixelFormat for video
4589 * and for enum AVSampleFormat for audio.
4591 * Note that a decoder can have considerable freedom in how exactly it
4592 * decodes the data, so the format reported here might be different from the
4593 * one returned by a decoder.
4596 } AVCodecParserContext;
4598 typedef struct AVCodecParser {
4599 int codec_ids[5]; /* several codec IDs are permitted */
4601 int (*parser_init)(AVCodecParserContext *s);
4602 /* This callback never returns an error, a negative value means that
4603 * the frame start was in a previous packet. */
4604 int (*parser_parse)(AVCodecParserContext *s,
4605 AVCodecContext *avctx,
4606 const uint8_t **poutbuf, int *poutbuf_size,
4607 const uint8_t *buf, int buf_size);
4608 void (*parser_close)(AVCodecParserContext *s);
4609 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4610 struct AVCodecParser *next;
4613 AVCodecParser *av_parser_next(const AVCodecParser *c);
4615 void av_register_codec_parser(AVCodecParser *parser);
4616 AVCodecParserContext *av_parser_init(int codec_id);
4621 * @param s parser context.
4622 * @param avctx codec context.
4623 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4624 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4625 * @param buf input buffer.
4626 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4627 * @param pts input presentation timestamp.
4628 * @param dts input decoding timestamp.
4629 * @param pos input byte position in stream.
4630 * @return the number of bytes of the input bitstream used.
4635 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4642 * decode_frame(data, size);
4646 int av_parser_parse2(AVCodecParserContext *s,
4647 AVCodecContext *avctx,
4648 uint8_t **poutbuf, int *poutbuf_size,
4649 const uint8_t *buf, int buf_size,
4650 int64_t pts, int64_t dts,
4654 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4655 * @deprecated use AVBitStreamFilter
4657 int av_parser_change(AVCodecParserContext *s,
4658 AVCodecContext *avctx,
4659 uint8_t **poutbuf, int *poutbuf_size,
4660 const uint8_t *buf, int buf_size, int keyframe);
4661 void av_parser_close(AVCodecParserContext *s);
4669 * @addtogroup lavc_encoding
4674 * Find a registered encoder with a matching codec ID.
4676 * @param id AVCodecID of the requested encoder
4677 * @return An encoder if one was found, NULL otherwise.
4679 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4682 * Find a registered encoder with the specified name.
4684 * @param name name of the requested encoder
4685 * @return An encoder if one was found, NULL otherwise.
4687 AVCodec *avcodec_find_encoder_by_name(const char *name);
4690 * Encode a frame of audio.
4692 * Takes input samples from frame and writes the next output packet, if
4693 * available, to avpkt. The output packet does not necessarily contain data for
4694 * the most recent frame, as encoders can delay, split, and combine input frames
4695 * internally as needed.
4697 * @param avctx codec context
4698 * @param avpkt output AVPacket.
4699 * The user can supply an output buffer by setting
4700 * avpkt->data and avpkt->size prior to calling the
4701 * function, but if the size of the user-provided data is not
4702 * large enough, encoding will fail. If avpkt->data and
4703 * avpkt->size are set, avpkt->destruct must also be set. All
4704 * other AVPacket fields will be reset by the encoder using
4705 * av_init_packet(). If avpkt->data is NULL, the encoder will
4706 * allocate it. The encoder will set avpkt->size to the size
4707 * of the output packet.
4709 * If this function fails or produces no output, avpkt will be
4710 * freed using av_packet_unref().
4711 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4712 * May be NULL when flushing an encoder that has the
4713 * AV_CODEC_CAP_DELAY capability set.
4714 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4715 * can have any number of samples.
4716 * If it is not set, frame->nb_samples must be equal to
4717 * avctx->frame_size for all frames except the last.
4718 * The final frame may be smaller than avctx->frame_size.
4719 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4720 * output packet is non-empty, and to 0 if it is
4721 * empty. If the function returns an error, the
4722 * packet can be assumed to be invalid, and the
4723 * value of got_packet_ptr is undefined and should
4725 * @return 0 on success, negative error code on failure
4727 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4728 const AVFrame *frame, int *got_packet_ptr);
4731 * Encode a frame of video.
4733 * Takes input raw video data from frame and writes the next output packet, if
4734 * available, to avpkt. The output packet does not necessarily contain data for
4735 * the most recent frame, as encoders can delay and reorder input frames
4736 * internally as needed.
4738 * @param avctx codec context
4739 * @param avpkt output AVPacket.
4740 * The user can supply an output buffer by setting
4741 * avpkt->data and avpkt->size prior to calling the
4742 * function, but if the size of the user-provided data is not
4743 * large enough, encoding will fail. All other AVPacket fields
4744 * will be reset by the encoder using av_init_packet(). If
4745 * avpkt->data is NULL, the encoder will allocate it.
4746 * The encoder will set avpkt->size to the size of the
4747 * output packet. The returned data (if any) belongs to the
4748 * caller, he is responsible for freeing it.
4750 * If this function fails or produces no output, avpkt will be
4751 * freed using av_packet_unref().
4752 * @param[in] frame AVFrame containing the raw video data to be encoded.
4753 * May be NULL when flushing an encoder that has the
4754 * AV_CODEC_CAP_DELAY capability set.
4755 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4756 * output packet is non-empty, and to 0 if it is
4757 * empty. If the function returns an error, the
4758 * packet can be assumed to be invalid, and the
4759 * value of got_packet_ptr is undefined and should
4761 * @return 0 on success, negative error code on failure
4763 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4764 const AVFrame *frame, int *got_packet_ptr);
4766 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4767 const AVSubtitle *sub);
4774 #if FF_API_AVCODEC_RESAMPLE
4776 * @defgroup lavc_resample Audio resampling
4778 * @deprecated use libswresample instead
4782 struct ReSampleContext;
4783 struct AVResampleContext;
4785 typedef struct ReSampleContext ReSampleContext;
4788 * Initialize audio resampling context.
4790 * @param output_channels number of output channels
4791 * @param input_channels number of input channels
4792 * @param output_rate output sample rate
4793 * @param input_rate input sample rate
4794 * @param sample_fmt_out requested output sample format
4795 * @param sample_fmt_in input sample format
4796 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4797 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4798 * @param linear if 1 then the used FIR filter will be linearly interpolated
4799 between the 2 closest, if 0 the closest will be used
4800 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4801 * @return allocated ReSampleContext, NULL if error occurred
4803 attribute_deprecated
4804 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4805 int output_rate, int input_rate,
4806 enum AVSampleFormat sample_fmt_out,
4807 enum AVSampleFormat sample_fmt_in,
4808 int filter_length, int log2_phase_count,
4809 int linear, double cutoff);
4811 attribute_deprecated
4812 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4815 * Free resample context.
4817 * @param s a non-NULL pointer to a resample context previously
4818 * created with av_audio_resample_init()
4820 attribute_deprecated
4821 void audio_resample_close(ReSampleContext *s);
4825 * Initialize an audio resampler.
4826 * Note, if either rate is not an integer then simply scale both rates up so they are.
4827 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4828 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4829 * @param linear If 1 then the used FIR filter will be linearly interpolated
4830 between the 2 closest, if 0 the closest will be used
4831 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4833 attribute_deprecated
4834 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4837 * Resample an array of samples using a previously configured context.
4838 * @param src an array of unconsumed samples
4839 * @param consumed the number of samples of src which have been consumed are returned here
4840 * @param src_size the number of unconsumed samples available
4841 * @param dst_size the amount of space in samples available in dst
4842 * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
4843 * @return the number of samples written in dst or -1 if an error occurred
4845 attribute_deprecated
4846 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4850 * Compensate samplerate/timestamp drift. The compensation is done by changing
4851 * the resampler parameters, so no audible clicks or similar distortions occur
4852 * @param compensation_distance distance in output samples over which the compensation should be performed
4853 * @param sample_delta number of output samples which should be output less
4855 * example: av_resample_compensate(c, 10, 500)
4856 * here instead of 510 samples only 500 samples would be output
4858 * note, due to rounding the actual compensation might be slightly different,
4859 * especially if the compensation_distance is large and the in_rate used during init is small
4861 attribute_deprecated
4862 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4863 attribute_deprecated
4864 void av_resample_close(struct AVResampleContext *c);
4871 #if FF_API_AVPICTURE
4873 * @addtogroup lavc_picture
4878 * @deprecated unused
4880 attribute_deprecated
4881 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4884 * @deprecated unused
4886 attribute_deprecated
4887 void avpicture_free(AVPicture *picture);
4890 * @deprecated use av_image_fill_arrays() instead.
4892 attribute_deprecated
4893 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4894 enum AVPixelFormat pix_fmt, int width, int height);
4897 * @deprecated use av_image_copy_to_buffer() instead.
4899 attribute_deprecated
4900 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4901 int width, int height,
4902 unsigned char *dest, int dest_size);
4905 * @deprecated use av_image_get_buffer_size() instead.
4907 attribute_deprecated
4908 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4911 * @deprecated av_image_copy() instead.
4913 attribute_deprecated
4914 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4915 enum AVPixelFormat pix_fmt, int width, int height);
4918 * @deprecated unused
4920 attribute_deprecated
4921 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4922 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4925 * @deprecated unused
4927 attribute_deprecated
4928 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4929 int padtop, int padbottom, int padleft, int padright, int *color);
4937 * @defgroup lavc_misc Utility functions
4940 * Miscellaneous utility functions related to both encoding and decoding
4946 * @defgroup lavc_misc_pixfmt Pixel formats
4948 * Functions for working with pixel formats.
4953 * Utility function to access log2_chroma_w log2_chroma_h from
4954 * the pixel format AVPixFmtDescriptor.
4956 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4957 * for one that returns a failure code and continues in case of invalid
4960 * @param[in] pix_fmt the pixel format
4961 * @param[out] h_shift store log2_chroma_w
4962 * @param[out] v_shift store log2_chroma_h
4964 * @see av_pix_fmt_get_chroma_sub_sample
4967 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4970 * Return a value representing the fourCC code associated to the
4971 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4974 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4977 * @deprecated see av_get_pix_fmt_loss()
4979 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4983 * Find the best pixel format to convert to given a certain source pixel
4984 * format. When converting from one pixel format to another, information loss
4985 * may occur. For example, when converting from RGB24 to GRAY, the color
4986 * information will be lost. Similarly, other losses occur when converting from
4987 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4988 * the given pixel formats should be used to suffer the least amount of loss.
4989 * The pixel formats from which it chooses one, are determined by the
4990 * pix_fmt_list parameter.
4993 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4994 * @param[in] src_pix_fmt source pixel format
4995 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4996 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4997 * @return The best pixel format to convert to or -1 if none was found.
4999 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5000 enum AVPixelFormat src_pix_fmt,
5001 int has_alpha, int *loss_ptr);
5004 * @deprecated see av_find_best_pix_fmt_of_2()
5006 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5007 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5009 attribute_deprecated
5010 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
5011 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
5012 enum AVPixelFormat src_pix_fmt,
5013 int has_alpha, int *loss_ptr);
5015 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5016 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5020 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5026 #if FF_API_SET_DIMENSIONS
5028 * @deprecated this function is not supposed to be used from outside of lavc
5030 attribute_deprecated
5031 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5035 * Put a string representing the codec tag codec_tag in buf.
5037 * @param buf buffer to place codec tag in
5038 * @param buf_size size in bytes of buf
5039 * @param codec_tag codec tag to assign
5040 * @return the length of the string that would have been generated if
5041 * enough space had been available, excluding the trailing null
5043 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5045 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5048 * Return a name for the specified profile, if available.
5050 * @param codec the codec that is searched for the given profile
5051 * @param profile the profile value for which a name is requested
5052 * @return A name for the profile if found, NULL otherwise.
5054 const char *av_get_profile_name(const AVCodec *codec, int profile);
5057 * Return a name for the specified profile, if available.
5059 * @param codec_id the ID of the codec to which the requested profile belongs
5060 * @param profile the profile value for which a name is requested
5061 * @return A name for the profile if found, NULL otherwise.
5063 * @note unlike av_get_profile_name(), which searches a list of profiles
5064 * supported by a specific decoder or encoder implementation, this
5065 * function searches the list of profiles from the AVCodecDescriptor
5067 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5069 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5070 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5071 //FIXME func typedef
5074 * Fill AVFrame audio data and linesize pointers.
5076 * The buffer buf must be a preallocated buffer with a size big enough
5077 * to contain the specified samples amount. The filled AVFrame data
5078 * pointers will point to this buffer.
5080 * AVFrame extended_data channel pointers are allocated if necessary for
5083 * @param frame the AVFrame
5084 * frame->nb_samples must be set prior to calling the
5085 * function. This function fills in frame->data,
5086 * frame->extended_data, frame->linesize[0].
5087 * @param nb_channels channel count
5088 * @param sample_fmt sample format
5089 * @param buf buffer to use for frame data
5090 * @param buf_size size of buffer
5091 * @param align plane size sample alignment (0 = default)
5092 * @return >=0 on success, negative error code on failure
5093 * @todo return the size in bytes required to store the samples in
5094 * case of success, at the next libavutil bump
5096 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5097 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5098 int buf_size, int align);
5101 * Reset the internal decoder state / flush internal buffers. Should be called
5102 * e.g. when seeking or when switching to a different stream.
5104 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5105 * this invalidates the frames previously returned from the decoder. When
5106 * refcounted frames are used, the decoder just releases any references it might
5107 * keep internally, but the caller's reference remains valid.
5109 void avcodec_flush_buffers(AVCodecContext *avctx);
5112 * Return codec bits per sample.
5114 * @param[in] codec_id the codec
5115 * @return Number of bits per sample or zero if unknown for the given codec.
5117 int av_get_bits_per_sample(enum AVCodecID codec_id);
5120 * Return the PCM codec associated with a sample format.
5121 * @param be endianness, 0 for little, 1 for big,
5122 * -1 (or anything else) for native
5123 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5125 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5128 * Return codec bits per sample.
5129 * Only return non-zero if the bits per sample is exactly correct, not an
5132 * @param[in] codec_id the codec
5133 * @return Number of bits per sample or zero if unknown for the given codec.
5135 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5138 * Return audio frame duration.
5140 * @param avctx codec context
5141 * @param frame_bytes size of the frame, or 0 if unknown
5142 * @return frame duration, in samples, if known. 0 if not able to
5145 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5148 typedef struct AVBitStreamFilterContext {
5150 struct AVBitStreamFilter *filter;
5151 AVCodecParserContext *parser;
5152 struct AVBitStreamFilterContext *next;
5154 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5155 * Not for access by library users.
5158 } AVBitStreamFilterContext;
5161 typedef struct AVBitStreamFilter {
5164 int (*filter)(AVBitStreamFilterContext *bsfc,
5165 AVCodecContext *avctx, const char *args,
5166 uint8_t **poutbuf, int *poutbuf_size,
5167 const uint8_t *buf, int buf_size, int keyframe);
5168 void (*close)(AVBitStreamFilterContext *bsfc);
5169 struct AVBitStreamFilter *next;
5170 } AVBitStreamFilter;
5173 * Register a bitstream filter.
5175 * The filter will be accessible to the application code through
5176 * av_bitstream_filter_next() or can be directly initialized with
5177 * av_bitstream_filter_init().
5179 * @see avcodec_register_all()
5181 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5184 * Create and initialize a bitstream filter context given a bitstream
5187 * The returned context must be freed with av_bitstream_filter_close().
5189 * @param name the name of the bitstream filter
5190 * @return a bitstream filter context if a matching filter was found
5191 * and successfully initialized, NULL otherwise
5193 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5198 * This function filters the buffer buf with size buf_size, and places the
5199 * filtered buffer in the buffer pointed to by poutbuf.
5201 * The output buffer must be freed by the caller.
5203 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5204 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5205 * If specified, this must point to the encoder context of the
5206 * output stream the packet is sent to.
5207 * @param args arguments which specify the filter configuration, may be NULL
5208 * @param poutbuf pointer which is updated to point to the filtered buffer
5209 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5210 * @param buf buffer containing the data to filter
5211 * @param buf_size size in bytes of buf
5212 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5213 * @return >= 0 in case of success, or a negative error code in case of failure
5215 * If the return value is positive, an output buffer is allocated and
5216 * is available in *poutbuf, and is distinct from the input buffer.
5218 * If the return value is 0, the output buffer is not allocated and
5219 * should be considered identical to the input buffer, or in case
5220 * *poutbuf was set it points to the input buffer (not necessarily to
5221 * its starting address).
5223 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5224 AVCodecContext *avctx, const char *args,
5225 uint8_t **poutbuf, int *poutbuf_size,
5226 const uint8_t *buf, int buf_size, int keyframe);
5229 * Release bitstream filter context.
5231 * @param bsf the bitstream filter context created with
5232 * av_bitstream_filter_init(), can be NULL
5234 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5237 * If f is NULL, return the first registered bitstream filter,
5238 * if f is non-NULL, return the next registered bitstream filter
5239 * after f, or NULL if f is the last one.
5241 * This function can be used to iterate over all registered bitstream
5244 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5249 * Same behaviour av_fast_malloc but the buffer has additional
5250 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5252 * In addition the whole buffer will initially and after resizes
5253 * be 0-initialized so that no uninitialized data will ever appear.
5255 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5258 * Same behaviour av_fast_padded_malloc except that buffer will always
5259 * be 0-initialized after call.
5261 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5264 * Encode extradata length to a buffer. Used by xiph codecs.
5266 * @param s buffer to write to; must be at least (v/255+1) bytes long
5267 * @param v size of extradata in bytes
5268 * @return number of bytes written to the buffer.
5270 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5272 #if FF_API_MISSING_SAMPLE
5274 * Log a generic warning message about a missing feature. This function is
5275 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5276 * only, and would normally not be used by applications.
5277 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5278 * a pointer to an AVClass struct
5279 * @param[in] feature string containing the name of the missing feature
5280 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5281 * If want_sample is non-zero, additional verbage will be added to the log
5282 * message which tells the user how to report samples to the development
5284 * @deprecated Use avpriv_report_missing_feature() instead.
5286 attribute_deprecated
5287 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5290 * Log a generic warning message asking for a sample. This function is
5291 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5292 * only, and would normally not be used by applications.
5293 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5294 * a pointer to an AVClass struct
5295 * @param[in] msg string containing an optional message, or NULL if no message
5296 * @deprecated Use avpriv_request_sample() instead.
5298 attribute_deprecated
5299 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5300 #endif /* FF_API_MISSING_SAMPLE */
5303 * Register the hardware accelerator hwaccel.
5305 void av_register_hwaccel(AVHWAccel *hwaccel);
5308 * If hwaccel is NULL, returns the first registered hardware accelerator,
5309 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5310 * after hwaccel, or NULL if hwaccel is the last one.
5312 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5316 * Lock operation used by lockmgr
5319 AV_LOCK_CREATE, ///< Create a mutex
5320 AV_LOCK_OBTAIN, ///< Lock the mutex
5321 AV_LOCK_RELEASE, ///< Unlock the mutex
5322 AV_LOCK_DESTROY, ///< Free mutex resources
5326 * Register a user provided lock manager supporting the operations
5327 * specified by AVLockOp. The "mutex" argument to the function points
5328 * to a (void *) where the lockmgr should store/get a pointer to a user
5329 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5330 * value left by the last call for all other ops. If the lock manager is
5331 * unable to perform the op then it should leave the mutex in the same
5332 * state as when it was called and return a non-zero value. However,
5333 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5334 * have been successfully destroyed. If av_lockmgr_register succeeds
5335 * it will return a non-negative value, if it fails it will return a
5336 * negative value and destroy all mutex and unregister all callbacks.
5337 * av_lockmgr_register is not thread-safe, it must be called from a
5338 * single thread before any calls which make use of locking are used.
5340 * @param cb User defined callback. av_lockmgr_register invokes calls
5341 * to this callback and the previously registered callback.
5342 * The callback will be used to create more than one mutex
5343 * each of which must be backed by its own underlying locking
5344 * mechanism (i.e. do not use a single static object to
5345 * implement your lock manager). If cb is set to NULL the
5346 * lockmgr will be unregistered.
5348 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5351 * Get the type of the given codec.
5353 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5356 * Get the name of a codec.
5357 * @return a static string identifying the codec; never NULL
5359 const char *avcodec_get_name(enum AVCodecID id);
5362 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5363 * with no corresponding avcodec_close()), 0 otherwise.
5365 int avcodec_is_open(AVCodecContext *s);
5368 * @return a non-zero number if codec is an encoder, zero otherwise
5370 int av_codec_is_encoder(const AVCodec *codec);
5373 * @return a non-zero number if codec is a decoder, zero otherwise
5375 int av_codec_is_decoder(const AVCodec *codec);
5378 * @return descriptor for given codec ID or NULL if no descriptor exists.
5380 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5383 * Iterate over all codec descriptors known to libavcodec.
5385 * @param prev previous descriptor. NULL to get the first descriptor.
5387 * @return next descriptor or NULL after the last descriptor
5389 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5392 * @return codec descriptor with the given name or NULL if no such descriptor
5395 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5398 * Allocate a CPB properties structure and initialize its fields to default
5401 * @param size if non-NULL, the size of the allocated struct will be written
5402 * here. This is useful for embedding it in side data.
5404 * @return the newly allocated struct or NULL on failure
5406 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
5412 #endif /* AVCODEC_AVCODEC_H */