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
76 * @defgroup lavc_core Core functions/structures.
79 * Basic definitions, functions for querying libavcodec capabilities,
80 * allocating core structures, etc.
86 * Identify the syntax and semantics of the bitstream.
87 * The principle is roughly:
88 * Two decoders with the same ID can decode the same streams.
89 * Two encoders with the same ID can encode compatible streams.
90 * There may be slight deviations from the principle due to implementation
93 * If you add a codec ID to this list, add it so that
94 * 1. no value of a existing codec ID changes (that would break ABI),
95 * 2. it is as close as possible to similar codecs
97 * After adding new codec IDs, do not forget to add an entry to the codec
98 * descriptor list and bump libavcodec minor version.
104 AV_CODEC_ID_MPEG1VIDEO,
105 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
107 AV_CODEC_ID_MPEG2VIDEO_XVMC,
108 #endif /* FF_API_XVMC */
119 AV_CODEC_ID_RAWVIDEO,
120 AV_CODEC_ID_MSMPEG4V1,
121 AV_CODEC_ID_MSMPEG4V2,
122 AV_CODEC_ID_MSMPEG4V3,
145 AV_CODEC_ID_INTERPLAY_VIDEO,
152 AV_CODEC_ID_MSVIDEO1,
157 AV_CODEC_ID_TRUEMOTION1,
158 AV_CODEC_ID_VMDVIDEO,
183 AV_CODEC_ID_TRUEMOTION2,
189 AV_CODEC_ID_SMACKVIDEO,
194 AV_CODEC_ID_JPEG2000,
200 AV_CODEC_ID_DSICINVIDEO,
201 AV_CODEC_ID_TIERTEXSEQVIDEO,
209 AV_CODEC_ID_BETHSOFTVID,
221 AV_CODEC_ID_ESCAPE124,
225 AV_CODEC_ID_MOTIONPIXELS,
237 AV_CODEC_ID_FLASHSV2,
238 AV_CODEC_ID_CDGRAPHICS,
241 AV_CODEC_ID_BINKVIDEO,
242 AV_CODEC_ID_IFF_ILBM,
243 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
249 AV_CODEC_ID_A64_MULTI,
250 AV_CODEC_ID_A64_MULTI5,
253 AV_CODEC_ID_LAGARITH,
257 AV_CODEC_ID_WMV3IMAGE,
258 AV_CODEC_ID_VC1IMAGE,
260 AV_CODEC_ID_BMV_VIDEO,
267 AV_CODEC_ID_ZEROCODEC,
276 AV_CODEC_ID_ESCAPE130,
279 AV_CODEC_ID_HNM4_VIDEO,
281 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
283 AV_CODEC_ID_ALIAS_PIX,
284 AV_CODEC_ID_BRENDER_PIX,
285 AV_CODEC_ID_PAF_VIDEO,
298 AV_CODEC_ID_SCREENPRESSO,
301 AV_CODEC_ID_Y41P = 0x8000,
306 AV_CODEC_ID_TARGA_Y216,
319 /* various PCM "codecs" */
320 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
321 AV_CODEC_ID_PCM_S16LE = 0x10000,
322 AV_CODEC_ID_PCM_S16BE,
323 AV_CODEC_ID_PCM_U16LE,
324 AV_CODEC_ID_PCM_U16BE,
327 AV_CODEC_ID_PCM_MULAW,
328 AV_CODEC_ID_PCM_ALAW,
329 AV_CODEC_ID_PCM_S32LE,
330 AV_CODEC_ID_PCM_S32BE,
331 AV_CODEC_ID_PCM_U32LE,
332 AV_CODEC_ID_PCM_U32BE,
333 AV_CODEC_ID_PCM_S24LE,
334 AV_CODEC_ID_PCM_S24BE,
335 AV_CODEC_ID_PCM_U24LE,
336 AV_CODEC_ID_PCM_U24BE,
337 AV_CODEC_ID_PCM_S24DAUD,
338 AV_CODEC_ID_PCM_ZORK,
339 AV_CODEC_ID_PCM_S16LE_PLANAR,
341 AV_CODEC_ID_PCM_F32BE,
342 AV_CODEC_ID_PCM_F32LE,
343 AV_CODEC_ID_PCM_F64BE,
344 AV_CODEC_ID_PCM_F64LE,
345 AV_CODEC_ID_PCM_BLURAY,
348 AV_CODEC_ID_PCM_S8_PLANAR,
349 AV_CODEC_ID_PCM_S24LE_PLANAR,
350 AV_CODEC_ID_PCM_S32LE_PLANAR,
351 AV_CODEC_ID_PCM_S16BE_PLANAR,
352 /* new PCM "codecs" should be added right below this line starting with
353 * an explicit value of for example 0x10800
356 /* various ADPCM codecs */
357 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
358 AV_CODEC_ID_ADPCM_IMA_WAV,
359 AV_CODEC_ID_ADPCM_IMA_DK3,
360 AV_CODEC_ID_ADPCM_IMA_DK4,
361 AV_CODEC_ID_ADPCM_IMA_WS,
362 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
363 AV_CODEC_ID_ADPCM_MS,
364 AV_CODEC_ID_ADPCM_4XM,
365 AV_CODEC_ID_ADPCM_XA,
366 AV_CODEC_ID_ADPCM_ADX,
367 AV_CODEC_ID_ADPCM_EA,
368 AV_CODEC_ID_ADPCM_G726,
369 AV_CODEC_ID_ADPCM_CT,
370 AV_CODEC_ID_ADPCM_SWF,
371 AV_CODEC_ID_ADPCM_YAMAHA,
372 AV_CODEC_ID_ADPCM_SBPRO_4,
373 AV_CODEC_ID_ADPCM_SBPRO_3,
374 AV_CODEC_ID_ADPCM_SBPRO_2,
375 AV_CODEC_ID_ADPCM_THP,
376 AV_CODEC_ID_ADPCM_IMA_AMV,
377 AV_CODEC_ID_ADPCM_EA_R1,
378 AV_CODEC_ID_ADPCM_EA_R3,
379 AV_CODEC_ID_ADPCM_EA_R2,
380 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
381 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
382 AV_CODEC_ID_ADPCM_EA_XAS,
383 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
384 AV_CODEC_ID_ADPCM_IMA_ISS,
385 AV_CODEC_ID_ADPCM_G722,
386 AV_CODEC_ID_ADPCM_IMA_APC,
387 AV_CODEC_ID_ADPCM_VIMA,
388 #if FF_API_VIMA_DECODER
389 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
392 AV_CODEC_ID_ADPCM_AFC = 0x11800,
393 AV_CODEC_ID_ADPCM_IMA_OKI,
394 AV_CODEC_ID_ADPCM_DTK,
395 AV_CODEC_ID_ADPCM_IMA_RAD,
396 AV_CODEC_ID_ADPCM_G726LE,
397 AV_CODEC_ID_ADPCM_THP_LE,
398 AV_CODEC_ID_ADPCM_PSX,
399 AV_CODEC_ID_ADPCM_AICA,
402 AV_CODEC_ID_AMR_NB = 0x12000,
405 /* RealAudio codecs*/
406 AV_CODEC_ID_RA_144 = 0x13000,
409 /* various DPCM codecs */
410 AV_CODEC_ID_ROQ_DPCM = 0x14000,
411 AV_CODEC_ID_INTERPLAY_DPCM,
412 AV_CODEC_ID_XAN_DPCM,
413 AV_CODEC_ID_SOL_DPCM,
415 AV_CODEC_ID_SDX2_DPCM = 0x14800,
418 AV_CODEC_ID_MP2 = 0x15000,
419 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
429 AV_CODEC_ID_VMDAUDIO,
435 AV_CODEC_ID_WESTWOOD_SND1,
436 AV_CODEC_ID_GSM, ///< as in Berlin toast format
439 AV_CODEC_ID_TRUESPEECH,
441 AV_CODEC_ID_SMACKAUDIO,
444 AV_CODEC_ID_DSICINAUDIO,
446 AV_CODEC_ID_MUSEPACK7,
448 AV_CODEC_ID_GSM_MS, /* as found in WAV */
454 AV_CODEC_ID_NELLYMOSER,
455 AV_CODEC_ID_MUSEPACK8,
457 AV_CODEC_ID_WMAVOICE,
459 AV_CODEC_ID_WMALOSSLESS,
468 AV_CODEC_ID_BINKAUDIO_RDFT,
469 AV_CODEC_ID_BINKAUDIO_DCT,
470 AV_CODEC_ID_AAC_LATM,
475 AV_CODEC_ID_8SVX_EXP,
476 AV_CODEC_ID_8SVX_FIB,
477 AV_CODEC_ID_BMV_AUDIO,
482 AV_CODEC_ID_COMFORT_NOISE,
484 AV_CODEC_ID_METASOUND,
485 AV_CODEC_ID_PAF_AUDIO,
489 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
491 AV_CODEC_ID_SONIC_LS,
494 AV_CODEC_ID_DSD_LSBF,
495 AV_CODEC_ID_DSD_MSBF,
496 AV_CODEC_ID_DSD_LSBF_PLANAR,
497 AV_CODEC_ID_DSD_MSBF_PLANAR,
499 AV_CODEC_ID_INTERPLAY_ACM,
503 /* subtitle codecs */
504 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
505 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
506 AV_CODEC_ID_DVB_SUBTITLE,
507 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
510 AV_CODEC_ID_MOV_TEXT,
511 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
512 AV_CODEC_ID_DVB_TELETEXT,
515 AV_CODEC_ID_MICRODVD = 0x17800,
519 AV_CODEC_ID_REALTEXT,
521 AV_CODEC_ID_SUBVIEWER1,
522 AV_CODEC_ID_SUBVIEWER,
529 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
531 /* other specific kind of codecs (generally used for attachments) */
532 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
533 AV_CODEC_ID_TTF = 0x18000,
535 AV_CODEC_ID_BINTEXT = 0x18800,
539 AV_CODEC_ID_SMPTE_KLV,
541 AV_CODEC_ID_TIMED_ID3,
542 AV_CODEC_ID_BIN_DATA,
545 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
547 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
548 * stream (only used by libavformat) */
549 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
550 * stream (only used by libavformat) */
551 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
552 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
556 * This struct describes the properties of a single codec described by an
558 * @see avcodec_descriptor_get()
560 typedef struct AVCodecDescriptor {
562 enum AVMediaType type;
564 * Name of the codec described by this descriptor. It is non-empty and
565 * unique for each codec descriptor. It should contain alphanumeric
566 * characters and '_' only.
570 * A more descriptive name for this codec. May be NULL.
572 const char *long_name;
574 * Codec properties, a combination of AV_CODEC_PROP_* flags.
578 * MIME type(s) associated with the codec.
579 * May be NULL; if not, a NULL-terminated array of MIME types.
580 * The first item is always non-NULL and is the preferred MIME type.
582 const char *const *mime_types;
584 * If non-NULL, an array of profiles recognized for this codec.
585 * Terminated with FF_PROFILE_UNKNOWN.
587 const struct AVProfile *profiles;
591 * Codec uses only intra compression.
594 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
596 * Codec supports lossy compression. Audio and video codecs only.
597 * @note a codec may support both lossy and lossless
600 #define AV_CODEC_PROP_LOSSY (1 << 1)
602 * Codec supports lossless compression. Audio and video codecs only.
604 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
606 * Codec supports frame reordering. That is, the coded order (the order in which
607 * the encoded packets are output by the encoders / stored / input to the
608 * decoders) may be different from the presentation order of the corresponding
611 * For codecs that do not have this property set, PTS and DTS should always be
614 #define AV_CODEC_PROP_REORDER (1 << 3)
616 * Subtitle codec is bitmap based
617 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
619 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
621 * Subtitle codec is text based.
622 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
624 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
627 * @ingroup lavc_decoding
628 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
629 * This is mainly needed because some optimized bitstream readers read
630 * 32 or 64 bit at once and could read over the end.<br>
631 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
632 * MPEG bitstreams could cause overread and segfault.
634 #define AV_INPUT_BUFFER_PADDING_SIZE 32
637 * @ingroup lavc_encoding
638 * minimum encoding buffer size
639 * Used to avoid some checks during header writing.
641 #define AV_INPUT_BUFFER_MIN_SIZE 16384
643 #if FF_API_WITHOUT_PREFIX
645 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
647 #define FF_INPUT_BUFFER_PADDING_SIZE 32
650 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
652 #define FF_MIN_BUFFER_SIZE 16384
653 #endif /* FF_API_WITHOUT_PREFIX */
656 * @ingroup lavc_encoding
657 * motion estimation type.
658 * @deprecated use codec private option instead
660 #if FF_API_MOTION_EST
662 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
666 ME_EPZS, ///< enhanced predictive zonal search
667 ME_X1, ///< reserved for experiments
668 ME_HEX, ///< hexagon based search
669 ME_UMH, ///< uneven multi-hexagon search
670 ME_TESA, ///< transformed exhaustive search algorithm
671 ME_ITER=50, ///< iterative search
676 * @ingroup lavc_decoding
679 /* We leave some space between them for extensions (drop some
680 * keyframes for intra-only or drop just some bidir frames). */
681 AVDISCARD_NONE =-16, ///< discard nothing
682 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
683 AVDISCARD_NONREF = 8, ///< discard all non reference
684 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
685 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
686 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
687 AVDISCARD_ALL = 48, ///< discard all
690 enum AVAudioServiceType {
691 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
692 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
693 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
694 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
695 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
696 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
697 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
698 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
699 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
700 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
704 * @ingroup lavc_encoding
706 typedef struct RcOverride{
709 int qscale; // If this is 0 then quality_factor will be used instead.
710 float quality_factor;
713 #if FF_API_MAX_BFRAMES
715 * @deprecated there is no libavcodec-wide limit on the number of B-frames
717 #define FF_MAX_B_FRAMES 16
721 These flags can be passed in AVCodecContext.flags before initialization.
722 Note: Not everything is supported yet.
726 * Allow decoders to produce frames with data planes that are not aligned
727 * to CPU requirements (e.g. due to cropping).
729 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
733 #define AV_CODEC_FLAG_QSCALE (1 << 1)
735 * 4 MV per MB allowed / advanced prediction for H.263.
737 #define AV_CODEC_FLAG_4MV (1 << 2)
739 * Output even those frames that might be corrupted.
741 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
745 #define AV_CODEC_FLAG_QPEL (1 << 4)
747 * Use internal 2pass ratecontrol in first pass mode.
749 #define AV_CODEC_FLAG_PASS1 (1 << 9)
751 * Use internal 2pass ratecontrol in second pass mode.
753 #define AV_CODEC_FLAG_PASS2 (1 << 10)
757 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
759 * Only decode/encode grayscale.
761 #define AV_CODEC_FLAG_GRAY (1 << 13)
763 * error[?] variables will be set during encoding.
765 #define AV_CODEC_FLAG_PSNR (1 << 15)
767 * Input bitstream might be truncated at a random location
768 * instead of only at frame boundaries.
770 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
772 * Use interlaced DCT.
774 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
778 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
780 * Place global headers in extradata instead of every keyframe.
782 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
784 * Use only bitexact stuff (except (I)DCT).
786 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
787 /* Fx : Flag for h263+ extra options */
789 * H.263 advanced intra coding / MPEG-4 AC prediction
791 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
793 * interlaced motion estimation
795 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
796 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
799 * Allow non spec compliant speedup tricks.
801 #define AV_CODEC_FLAG2_FAST (1 << 0)
803 * Skip bitstream encoding.
805 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
807 * Place global headers at every keyframe instead of in extradata.
809 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
812 * timecode is in drop frame format. DEPRECATED!!!!
814 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
817 * Input bitstream might be truncated at a packet boundaries
818 * instead of only at frame boundaries.
820 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
822 * Discard cropping information from SPS.
824 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
827 * Show all frames before the first keyframe
829 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
831 * Export motion vectors through frame side data
833 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
835 * Do not skip samples and export skip information as frame side data
837 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
839 * Do not reset ASS ReadOrder field on flush (subtitles decoding)
841 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP (1 << 30)
843 /* Unsupported options :
844 * Syntax Arithmetic coding (SAC)
845 * Reference Picture Selection
846 * Independent Segment Decoding */
848 /* codec capabilities */
851 * Decoder can use draw_horiz_band callback.
853 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
855 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
856 * If not set, it might not use get_buffer() at all or use operations that
857 * assume the buffer was allocated by avcodec_default_get_buffer.
859 #define AV_CODEC_CAP_DR1 (1 << 1)
860 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
862 * Encoder or decoder requires flushing with NULL input at the end in order to
863 * give the complete and correct output.
865 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
866 * with NULL data. The user can still send NULL data to the public encode
867 * or decode function, but libavcodec will not pass it along to the codec
868 * unless this flag is set.
871 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
872 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
876 * The encoder needs to be fed with NULL data at the end of encoding until the
877 * encoder no longer returns data.
879 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
880 * flag also means that the encoder must set the pts and duration for
881 * each output packet. If this flag is not set, the pts and duration will
882 * be determined by libavcodec from the input frame.
884 #define AV_CODEC_CAP_DELAY (1 << 5)
886 * Codec can be fed a final frame with a smaller size.
887 * This can be used to prevent truncation of the last audio samples.
889 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
893 * Codec can export data for HW decoding (VDPAU).
895 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
899 * Codec can output multiple frames per AVPacket
900 * Normally demuxers return one frame at a time, demuxers which do not do
901 * are connected to a parser to split what they return into proper frames.
902 * This flag is reserved to the very rare category of codecs which have a
903 * bitstream that cannot be split into frames without timeconsuming
904 * operations like full decoding. Demuxers carring such bitstreams thus
905 * may return multiple frames in a packet. This has many disadvantages like
906 * prohibiting stream copy in many cases thus it should only be considered
909 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
911 * Codec is experimental and is thus avoided in favor of non experimental
914 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
916 * Codec should fill in channel configuration and samplerate instead of container
918 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
920 * Codec supports frame-level multithreading.
922 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
924 * Codec supports slice-based (or partition-based) multithreading.
926 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
928 * Codec supports changed parameters at any point.
930 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
932 * Codec supports avctx->thread_count == 0 (auto).
934 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
936 * Audio encoder supports receiving a different number of samples in each call.
938 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
940 * Codec is intra only.
942 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
946 #define AV_CODEC_CAP_LOSSLESS 0x80000000
949 #if FF_API_WITHOUT_PREFIX
951 * Allow decoders to produce frames with data planes that are not aligned
952 * to CPU requirements (e.g. due to cropping).
954 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
955 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
956 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
957 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
958 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
961 * @deprecated use the "gmc" private option of the libxvid encoder
963 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
967 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
970 #define CODEC_FLAG_MV0 0x0040
972 #if FF_API_INPUT_PRESERVED
974 * @deprecated passing reference-counted frames to the encoders replaces this
977 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
979 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
980 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
981 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
984 * @deprecated edges are not used/required anymore. I.e. this flag is now always
987 #define CODEC_FLAG_EMU_EDGE 0x4000
989 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
990 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
992 #if FF_API_NORMALIZE_AQP
994 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
997 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
999 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1000 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
1001 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
1002 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
1003 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
1004 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
1005 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
1006 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
1007 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
1008 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
1009 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
1010 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1011 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
1013 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
1014 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
1015 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
1016 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1018 /* Unsupported options :
1019 * Syntax Arithmetic coding (SAC)
1020 * Reference Picture Selection
1021 * Independent Segment Decoding */
1023 /* codec capabilities */
1025 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1027 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1028 * If not set, it might not use get_buffer() at all or use operations that
1029 * assume the buffer was allocated by avcodec_default_get_buffer.
1031 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1032 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1034 /* Codec can export data for HW decoding. This flag indicates that
1035 * the codec would call get_format() with list that might contain HW accelerated
1036 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1037 * including raw image format.
1038 * The application can use the passed context to determine bitstream version,
1039 * chroma format, resolution etc.
1041 #define CODEC_CAP_HWACCEL 0x0010
1042 #endif /* FF_API_XVMC */
1044 * Encoder or decoder requires flushing with NULL input at the end in order to
1045 * give the complete and correct output.
1047 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1048 * with NULL data. The user can still send NULL data to the public encode
1049 * or decode function, but libavcodec will not pass it along to the codec
1050 * unless this flag is set.
1053 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1054 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1058 * The encoder needs to be fed with NULL data at the end of encoding until the
1059 * encoder no longer returns data.
1061 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1062 * flag also means that the encoder must set the pts and duration for
1063 * each output packet. If this flag is not set, the pts and duration will
1064 * be determined by libavcodec from the input frame.
1066 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1068 * Codec can be fed a final frame with a smaller size.
1069 * This can be used to prevent truncation of the last audio samples.
1071 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1072 #if FF_API_CAP_VDPAU
1074 * Codec can export data for HW decoding (VDPAU).
1076 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1079 * Codec can output multiple frames per AVPacket
1080 * Normally demuxers return one frame at a time, demuxers which do not do
1081 * are connected to a parser to split what they return into proper frames.
1082 * This flag is reserved to the very rare category of codecs which have a
1083 * bitstream that cannot be split into frames without timeconsuming
1084 * operations like full decoding. Demuxers carring such bitstreams thus
1085 * may return multiple frames in a packet. This has many disadvantages like
1086 * prohibiting stream copy in many cases thus it should only be considered
1089 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1091 * Codec is experimental and is thus avoided in favor of non experimental
1094 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1096 * Codec should fill in channel configuration and samplerate instead of container
1098 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1099 #if FF_API_NEG_LINESIZES
1101 * @deprecated no codecs use this capability
1103 #define CODEC_CAP_NEG_LINESIZES 0x0800
1106 * Codec supports frame-level multithreading.
1108 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1110 * Codec supports slice-based (or partition-based) multithreading.
1112 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1114 * Codec supports changed parameters at any point.
1116 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1118 * Codec supports avctx->thread_count == 0 (auto).
1120 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1122 * Audio encoder supports receiving a different number of samples in each call.
1124 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1126 * Codec is intra only.
1128 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1130 * Codec is lossless.
1132 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1135 * HWAccel is experimental and is thus avoided in favor of non experimental
1138 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1139 #endif /* FF_API_WITHOUT_PREFIX */
1142 //The following defines may change, don't expect compatibility if you use them.
1143 #define MB_TYPE_INTRA4x4 0x0001
1144 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1145 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1146 #define MB_TYPE_16x16 0x0008
1147 #define MB_TYPE_16x8 0x0010
1148 #define MB_TYPE_8x16 0x0020
1149 #define MB_TYPE_8x8 0x0040
1150 #define MB_TYPE_INTERLACED 0x0080
1151 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1152 #define MB_TYPE_ACPRED 0x0200
1153 #define MB_TYPE_GMC 0x0400
1154 #define MB_TYPE_SKIP 0x0800
1155 #define MB_TYPE_P0L0 0x1000
1156 #define MB_TYPE_P1L0 0x2000
1157 #define MB_TYPE_P0L1 0x4000
1158 #define MB_TYPE_P1L1 0x8000
1159 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1160 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1161 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1162 #define MB_TYPE_QUANT 0x00010000
1163 #define MB_TYPE_CBP 0x00020000
1164 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
1169 * This specifies the area which should be displayed.
1170 * Note there may be multiple such areas for one frame.
1172 typedef struct AVPanScan{
1175 * - encoding: Set by user.
1176 * - decoding: Set by libavcodec.
1181 * width and height in 1/16 pel
1182 * - encoding: Set by user.
1183 * - decoding: Set by libavcodec.
1189 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1190 * - encoding: Set by user.
1191 * - decoding: Set by libavcodec.
1193 int16_t position[3][2];
1197 * This structure describes the bitrate properties of an encoded bitstream. It
1198 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1199 * parameters for H.264/HEVC.
1201 typedef struct AVCPBProperties {
1203 * Maximum bitrate of the stream, in bits per second.
1204 * Zero if unknown or unspecified.
1208 * Minimum bitrate of the stream, in bits per second.
1209 * Zero if unknown or unspecified.
1213 * Average bitrate of the stream, in bits per second.
1214 * Zero if unknown or unspecified.
1219 * The size of the buffer to which the ratecontrol is applied, in bits.
1220 * Zero if unknown or unspecified.
1225 * The delay between the time the packet this structure is associated with
1226 * is received and the time when it should be decoded, in periods of a 27MHz
1229 * UINT64_MAX when unknown or unspecified.
1234 #if FF_API_QSCALE_TYPE
1235 #define FF_QSCALE_TYPE_MPEG1 0
1236 #define FF_QSCALE_TYPE_MPEG2 1
1237 #define FF_QSCALE_TYPE_H264 2
1238 #define FF_QSCALE_TYPE_VP56 3
1242 * The decoder will keep a reference to the frame and may reuse it later.
1244 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1247 * @defgroup lavc_packet AVPacket
1249 * Types and functions for working with AVPacket.
1252 enum AVPacketSideDataType {
1253 AV_PKT_DATA_PALETTE,
1254 AV_PKT_DATA_NEW_EXTRADATA,
1257 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1260 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1261 * s32le channel_count
1262 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1263 * u64le channel_layout
1264 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1266 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1271 AV_PKT_DATA_PARAM_CHANGE,
1274 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1275 * structures with info about macroblocks relevant to splitting the
1276 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1277 * That is, it does not necessarily contain info about all macroblocks,
1278 * as long as the distance between macroblocks in the info is smaller
1279 * than the target payload size.
1280 * Each MB info structure is 12 bytes, and is laid out as follows:
1282 * u32le bit offset from the start of the packet
1283 * u8 current quantizer at the start of the macroblock
1285 * u16le macroblock address within the GOB
1286 * u8 horizontal MV predictor
1287 * u8 vertical MV predictor
1288 * u8 horizontal MV predictor for block number 3
1289 * u8 vertical MV predictor for block number 3
1292 AV_PKT_DATA_H263_MB_INFO,
1295 * This side data should be associated with an audio stream and contains
1296 * ReplayGain information in form of the AVReplayGain struct.
1298 AV_PKT_DATA_REPLAYGAIN,
1301 * This side data contains a 3x3 transformation matrix describing an affine
1302 * transformation that needs to be applied to the decoded video frames for
1303 * correct presentation.
1305 * See libavutil/display.h for a detailed description of the data.
1307 AV_PKT_DATA_DISPLAYMATRIX,
1310 * This side data should be associated with a video stream and contains
1311 * Stereoscopic 3D information in form of the AVStereo3D struct.
1313 AV_PKT_DATA_STEREO3D,
1316 * This side data should be associated with an audio stream and corresponds
1317 * to enum AVAudioServiceType.
1319 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1322 * This side data contains quality related information from the encoder.
1324 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1328 * u64le[error count] sum of squared differences between encoder in and output
1331 AV_PKT_DATA_QUALITY_STATS,
1334 * This side data contains an integer value representing the stream index
1335 * of a "fallback" track. A fallback track indicates an alternate
1336 * track to use when the current track can not be decoded for some reason.
1337 * e.g. no decoder available for codec.
1339 AV_PKT_DATA_FALLBACK_TRACK,
1342 * This side data corresponds to the AVCPBProperties struct.
1344 AV_PKT_DATA_CPB_PROPERTIES,
1347 * Recommmends skipping the specified number of samples
1349 * u32le number of samples to skip from start of this packet
1350 * u32le number of samples to skip from end of this packet
1351 * u8 reason for start skip
1352 * u8 reason for end skip (0=padding silence, 1=convergence)
1355 AV_PKT_DATA_SKIP_SAMPLES=70,
1358 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1359 * the packet may contain "dual mono" audio specific to Japanese DTV
1360 * and if it is true, recommends only the selected channel to be used.
1362 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1365 AV_PKT_DATA_JP_DUALMONO,
1368 * A list of zero terminated key/value strings. There is no end marker for
1369 * the list, so it is required to rely on the side data size to stop.
1371 AV_PKT_DATA_STRINGS_METADATA,
1374 * Subtitle event position
1382 AV_PKT_DATA_SUBTITLE_POSITION,
1385 * Data found in BlockAdditional element of matroska container. There is
1386 * no end marker for the data, so it is required to rely on the side data
1387 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1390 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1393 * The optional first identifier line of a WebVTT cue.
1395 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1398 * The optional settings (rendering instructions) that immediately
1399 * follow the timestamp specifier of a WebVTT cue.
1401 AV_PKT_DATA_WEBVTT_SETTINGS,
1404 * A list of zero terminated key/value strings. There is no end marker for
1405 * the list, so it is required to rely on the side data size to stop. This
1406 * side data includes updated metadata which appeared in the stream.
1408 AV_PKT_DATA_METADATA_UPDATE,
1411 * MPEGTS stream ID, this is required to pass the stream ID
1412 * information from the demuxer to the corresponding muxer.
1414 AV_PKT_DATA_MPEGTS_STREAM_ID,
1417 * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1418 * should be associated with a video stream and containts data in the form
1419 * of the AVMasteringDisplayMetadata struct.
1421 AV_PKT_DATA_MASTERING_DISPLAY_METADATA
1424 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1426 typedef struct AVPacketSideData {
1429 enum AVPacketSideDataType type;
1433 * This structure stores compressed data. It is typically exported by demuxers
1434 * and then passed as input to decoders, or received as output from encoders and
1435 * then passed to muxers.
1437 * For video, it should typically contain one compressed frame. For audio it may
1438 * contain several compressed frames. Encoders are allowed to output empty
1439 * packets, with no compressed data, containing only side data
1440 * (e.g. to update some stream parameters at the end of encoding).
1442 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1443 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1444 * without libavcodec and libavformat major bump.
1446 * The semantics of data ownership depends on the buf field.
1447 * If it is set, the packet data is dynamically allocated and is
1448 * valid indefinitely until a call to av_packet_unref() reduces the
1449 * reference count to 0.
1451 * If the buf field is not set av_packet_ref() would make a copy instead
1452 * of increasing the reference count.
1454 * The side data is always allocated with av_malloc(), copied by
1455 * av_packet_ref() and freed by av_packet_unref().
1457 * @see av_packet_ref
1458 * @see av_packet_unref
1460 typedef struct AVPacket {
1462 * A reference to the reference-counted buffer where the packet data is
1464 * May be NULL, then the packet data is not reference-counted.
1468 * Presentation timestamp in AVStream->time_base units; the time at which
1469 * the decompressed packet will be presented to the user.
1470 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1471 * pts MUST be larger or equal to dts as presentation cannot happen before
1472 * decompression, unless one wants to view hex dumps. Some formats misuse
1473 * the terms dts and pts/cts to mean something different. Such timestamps
1474 * must be converted to true pts/dts before they are stored in AVPacket.
1478 * Decompression timestamp in AVStream->time_base units; the time at which
1479 * the packet is decompressed.
1480 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1487 * A combination of AV_PKT_FLAG values
1491 * Additional packet data that can be provided by the container.
1492 * Packet can contain several types of side information.
1494 AVPacketSideData *side_data;
1495 int side_data_elems;
1498 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1499 * Equals next_pts - this_pts in presentation order.
1503 int64_t pos; ///< byte position in stream, -1 if unknown
1505 #if FF_API_CONVERGENCE_DURATION
1507 * @deprecated Same as the duration field, but as int64_t. This was required
1508 * for Matroska subtitles, whose duration values could overflow when the
1509 * duration field was still an int.
1511 attribute_deprecated
1512 int64_t convergence_duration;
1515 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1516 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1518 enum AVSideDataParamChangeFlags {
1519 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1520 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1521 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1522 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1528 struct AVCodecInternal;
1532 AV_FIELD_PROGRESSIVE,
1533 AV_FIELD_TT, //< Top coded_first, top displayed first
1534 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1535 AV_FIELD_TB, //< Top coded first, bottom displayed first
1536 AV_FIELD_BT, //< Bottom coded first, top displayed first
1540 * main external API structure.
1541 * New fields can be added to the end with minor version bumps.
1542 * Removal, reordering and changes to existing fields require a major
1544 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1546 * sizeof(AVCodecContext) must not be used outside libav*.
1548 typedef struct AVCodecContext {
1550 * information on struct for av_log
1551 * - set by avcodec_alloc_context3
1553 const AVClass *av_class;
1554 int log_level_offset;
1556 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1557 const struct AVCodec *codec;
1558 #if FF_API_CODEC_NAME
1560 * @deprecated this field is not used for anything in libavcodec
1562 attribute_deprecated
1563 char codec_name[32];
1565 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1568 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1569 * This is used to work around some encoder bugs.
1570 * A demuxer should set this to what is stored in the field used to identify the codec.
1571 * If there are multiple such fields in a container then the demuxer should choose the one
1572 * which maximizes the information about the used codec.
1573 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1574 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1575 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1577 * - encoding: Set by user, if not then the default based on codec_id will be used.
1578 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1580 unsigned int codec_tag;
1582 #if FF_API_STREAM_CODEC_TAG
1584 * @deprecated this field is unused
1586 attribute_deprecated
1587 unsigned int stream_codec_tag;
1593 * Private context used for internal data.
1595 * Unlike priv_data, this is not codec-specific. It is used in general
1596 * libavcodec functions.
1598 struct AVCodecInternal *internal;
1601 * Private data of the user, can be used to carry app specific stuff.
1602 * - encoding: Set by user.
1603 * - decoding: Set by user.
1608 * the average bitrate
1609 * - encoding: Set by user; unused for constant quantizer encoding.
1610 * - decoding: Set by user, may be overwritten by libavcodec
1611 * if this info is available in the stream
1616 * number of bits the bitstream is allowed to diverge from the reference.
1617 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1618 * - encoding: Set by user; unused for constant quantizer encoding.
1619 * - decoding: unused
1621 int bit_rate_tolerance;
1624 * Global quality for codecs which cannot change it per frame.
1625 * This should be proportional to MPEG-1/2/4 qscale.
1626 * - encoding: Set by user.
1627 * - decoding: unused
1632 * - encoding: Set by user.
1633 * - decoding: unused
1635 int compression_level;
1636 #define FF_COMPRESSION_DEFAULT -1
1640 * - encoding: Set by user.
1641 * - decoding: Set by user.
1647 * - encoding: Set by user.
1648 * - decoding: Set by user.
1653 * some codecs need / can use extradata like Huffman tables.
1654 * mjpeg: Huffman tables
1655 * rv10: additional flags
1656 * mpeg4: global headers (they can be in the bitstream or here)
1657 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1658 * than extradata_size to avoid problems if it is read with the bitstream reader.
1659 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1660 * - encoding: Set/allocated/freed by libavcodec.
1661 * - decoding: Set/allocated/freed by user.
1667 * This is the fundamental unit of time (in seconds) in terms
1668 * of which frame timestamps are represented. For fixed-fps content,
1669 * timebase should be 1/framerate and timestamp increments should be
1671 * This often, but not always is the inverse of the frame rate or field rate
1673 * - encoding: MUST be set by user.
1674 * - decoding: the use of this field for decoding is deprecated.
1675 * Use framerate instead.
1677 AVRational time_base;
1680 * For some codecs, the time base is closer to the field rate than the frame rate.
1681 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1682 * if no telecine is used ...
1684 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1686 int ticks_per_frame;
1691 * Encoding: Number of frames delay there will be from the encoder input to
1692 * the decoder output. (we assume the decoder matches the spec)
1693 * Decoding: Number of frames delay in addition to what a standard decoder
1694 * as specified in the spec would produce.
1697 * Number of frames the decoded output will be delayed relative to the
1701 * For encoding, this field is unused (see initial_padding).
1703 * For decoding, this is the number of samples the decoder needs to
1704 * output before the decoder's output is valid. When seeking, you should
1705 * start decoding this many samples prior to your desired seek point.
1707 * - encoding: Set by libavcodec.
1708 * - decoding: Set by libavcodec.
1715 * picture width / height.
1717 * @note Those fields may not match the values of the last
1718 * AVFrame outputted by avcodec_decode_video2 due frame
1721 * - encoding: MUST be set by user.
1722 * - decoding: May be set by the user before opening the decoder if known e.g.
1723 * from the container. Some decoders will require the dimensions
1724 * to be set by the caller. During decoding, the decoder may
1725 * overwrite those values as required while parsing the data.
1730 * Bitstream width / height, may be different from width/height e.g. when
1731 * the decoded frame is cropped before being output or lowres is enabled.
1733 * @note Those field may not match the value of the last
1734 * AVFrame outputted by avcodec_decode_video2 due frame
1737 * - encoding: unused
1738 * - decoding: May be set by the user before opening the decoder if known
1739 * e.g. from the container. During decoding, the decoder may
1740 * overwrite those values as required while parsing the data.
1742 int coded_width, coded_height;
1744 #if FF_API_ASPECT_EXTENDED
1745 #define FF_ASPECT_EXTENDED 15
1749 * the number of pictures in a group of pictures, or 0 for intra_only
1750 * - encoding: Set by user.
1751 * - decoding: unused
1756 * Pixel format, see AV_PIX_FMT_xxx.
1757 * May be set by the demuxer if known from headers.
1758 * May be overridden by the decoder if it knows better.
1760 * @note This field may not match the value of the last
1761 * AVFrame outputted by avcodec_decode_video2 due frame
1764 * - encoding: Set by user.
1765 * - decoding: Set by user if known, overridden by libavcodec while
1768 enum AVPixelFormat pix_fmt;
1770 #if FF_API_MOTION_EST
1772 * This option does nothing
1773 * @deprecated use codec private options instead
1775 attribute_deprecated int me_method;
1779 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1780 * decoder to draw a horizontal band. It improves cache usage. Not
1781 * all codecs can do that. You must check the codec capabilities
1783 * When multithreading is used, it may be called from multiple threads
1784 * at the same time; threads might draw different parts of the same AVFrame,
1785 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1787 * The function is also used by hardware acceleration APIs.
1788 * It is called at least once during frame decoding to pass
1789 * the data needed for hardware render.
1790 * In that mode instead of pixel data, AVFrame points to
1791 * a structure specific to the acceleration API. The application
1792 * reads the structure and can change some fields to indicate progress
1794 * - encoding: unused
1795 * - decoding: Set by user.
1796 * @param height the height of the slice
1797 * @param y the y position of the slice
1798 * @param type 1->top field, 2->bottom field, 3->frame
1799 * @param offset offset into the AVFrame.data from which the slice should be read
1801 void (*draw_horiz_band)(struct AVCodecContext *s,
1802 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1803 int y, int type, int height);
1806 * callback to negotiate the pixelFormat
1807 * @param fmt is the list of formats which are supported by the codec,
1808 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1809 * The first is always the native one.
1810 * @note The callback may be called again immediately if initialization for
1811 * the selected (hardware-accelerated) pixel format failed.
1812 * @warning Behavior is undefined if the callback returns a value not
1813 * in the fmt list of formats.
1814 * @return the chosen format
1815 * - encoding: unused
1816 * - decoding: Set by user, if not set the native format will be chosen.
1818 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1821 * maximum number of B-frames between non-B-frames
1822 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1823 * - encoding: Set by user.
1824 * - decoding: unused
1829 * qscale factor between IP and B-frames
1830 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1831 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1832 * - encoding: Set by user.
1833 * - decoding: unused
1835 float b_quant_factor;
1837 #if FF_API_RC_STRATEGY
1838 /** @deprecated use codec private option instead */
1839 attribute_deprecated int rc_strategy;
1840 #define FF_RC_STRATEGY_XVID 1
1843 #if FF_API_PRIVATE_OPT
1844 /** @deprecated use encoder private options instead */
1845 attribute_deprecated
1846 int b_frame_strategy;
1850 * qscale offset between IP and B-frames
1851 * - encoding: Set by user.
1852 * - decoding: unused
1854 float b_quant_offset;
1857 * Size of the frame reordering buffer in the decoder.
1858 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1859 * - encoding: Set by libavcodec.
1860 * - decoding: Set by libavcodec.
1864 #if FF_API_PRIVATE_OPT
1865 /** @deprecated use encoder private options instead */
1866 attribute_deprecated
1871 * qscale factor between P and I-frames
1872 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1873 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1874 * - encoding: Set by user.
1875 * - decoding: unused
1877 float i_quant_factor;
1880 * qscale offset between P and I-frames
1881 * - encoding: Set by user.
1882 * - decoding: unused
1884 float i_quant_offset;
1887 * luminance masking (0-> disabled)
1888 * - encoding: Set by user.
1889 * - decoding: unused
1894 * temporary complexity masking (0-> disabled)
1895 * - encoding: Set by user.
1896 * - decoding: unused
1898 float temporal_cplx_masking;
1901 * spatial complexity masking (0-> disabled)
1902 * - encoding: Set by user.
1903 * - decoding: unused
1905 float spatial_cplx_masking;
1908 * p block masking (0-> disabled)
1909 * - encoding: Set by user.
1910 * - decoding: unused
1915 * darkness masking (0-> disabled)
1916 * - encoding: Set by user.
1917 * - decoding: unused
1923 * - encoding: Set by libavcodec.
1924 * - decoding: Set by user (or 0).
1928 #if FF_API_PRIVATE_OPT
1929 /** @deprecated use encoder private options instead */
1930 attribute_deprecated
1931 int prediction_method;
1932 #define FF_PRED_LEFT 0
1933 #define FF_PRED_PLANE 1
1934 #define FF_PRED_MEDIAN 2
1938 * slice offsets in the frame in bytes
1939 * - encoding: Set/allocated by libavcodec.
1940 * - decoding: Set/allocated by user (or NULL).
1945 * sample aspect ratio (0 if unknown)
1946 * That is the width of a pixel divided by the height of the pixel.
1947 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1948 * - encoding: Set by user.
1949 * - decoding: Set by libavcodec.
1951 AVRational sample_aspect_ratio;
1954 * motion estimation comparison function
1955 * - encoding: Set by user.
1956 * - decoding: unused
1960 * subpixel motion estimation comparison function
1961 * - encoding: Set by user.
1962 * - decoding: unused
1966 * macroblock comparison function (not supported yet)
1967 * - encoding: Set by user.
1968 * - decoding: unused
1972 * interlaced DCT comparison function
1973 * - encoding: Set by user.
1974 * - decoding: unused
1977 #define FF_CMP_SAD 0
1978 #define FF_CMP_SSE 1
1979 #define FF_CMP_SATD 2
1980 #define FF_CMP_DCT 3
1981 #define FF_CMP_PSNR 4
1982 #define FF_CMP_BIT 5
1984 #define FF_CMP_ZERO 7
1985 #define FF_CMP_VSAD 8
1986 #define FF_CMP_VSSE 9
1987 #define FF_CMP_NSSE 10
1988 #define FF_CMP_W53 11
1989 #define FF_CMP_W97 12
1990 #define FF_CMP_DCTMAX 13
1991 #define FF_CMP_DCT264 14
1992 #define FF_CMP_CHROMA 256
1995 * ME diamond size & shape
1996 * - encoding: Set by user.
1997 * - decoding: unused
2002 * amount of previous MV predictors (2a+1 x 2a+1 square)
2003 * - encoding: Set by user.
2004 * - decoding: unused
2006 int last_predictor_count;
2008 #if FF_API_PRIVATE_OPT
2009 /** @deprecated use encoder private options instead */
2010 attribute_deprecated
2015 * motion estimation prepass comparison function
2016 * - encoding: Set by user.
2017 * - decoding: unused
2022 * ME prepass diamond size & shape
2023 * - encoding: Set by user.
2024 * - decoding: unused
2030 * - encoding: Set by user.
2031 * - decoding: unused
2033 int me_subpel_quality;
2037 * DTG active format information (additional aspect ratio
2038 * information only used in DVB MPEG-2 transport streams)
2041 * - encoding: unused
2042 * - decoding: Set by decoder.
2043 * @deprecated Deprecated in favor of AVSideData
2045 attribute_deprecated int dtg_active_format;
2046 #define FF_DTG_AFD_SAME 8
2047 #define FF_DTG_AFD_4_3 9
2048 #define FF_DTG_AFD_16_9 10
2049 #define FF_DTG_AFD_14_9 11
2050 #define FF_DTG_AFD_4_3_SP_14_9 13
2051 #define FF_DTG_AFD_16_9_SP_14_9 14
2052 #define FF_DTG_AFD_SP_4_3 15
2053 #endif /* FF_API_AFD */
2056 * maximum motion estimation search range in subpel units
2057 * If 0 then no limit.
2059 * - encoding: Set by user.
2060 * - decoding: unused
2064 #if FF_API_QUANT_BIAS
2066 * @deprecated use encoder private option instead
2068 attribute_deprecated int intra_quant_bias;
2069 #define FF_DEFAULT_QUANT_BIAS 999999
2072 * @deprecated use encoder private option instead
2074 attribute_deprecated int inter_quant_bias;
2079 * - encoding: unused
2080 * - decoding: Set by user.
2083 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2084 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2085 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2089 * XVideo Motion Acceleration
2090 * - encoding: forbidden
2091 * - decoding: set by decoder
2092 * @deprecated XvMC doesn't need it anymore.
2094 attribute_deprecated int xvmc_acceleration;
2095 #endif /* FF_API_XVMC */
2098 * macroblock decision mode
2099 * - encoding: Set by user.
2100 * - decoding: unused
2103 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2104 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2105 #define FF_MB_DECISION_RD 2 ///< rate distortion
2108 * custom intra quantization matrix
2109 * - encoding: Set by user, can be NULL.
2110 * - decoding: Set by libavcodec.
2112 uint16_t *intra_matrix;
2115 * custom inter quantization matrix
2116 * - encoding: Set by user, can be NULL.
2117 * - decoding: Set by libavcodec.
2119 uint16_t *inter_matrix;
2121 #if FF_API_PRIVATE_OPT
2122 /** @deprecated use encoder private options instead */
2123 attribute_deprecated
2124 int scenechange_threshold;
2126 /** @deprecated use encoder private options instead */
2127 attribute_deprecated
2128 int noise_reduction;
2133 * @deprecated this field is unused
2135 attribute_deprecated
2139 * @deprecated this field is unused
2141 attribute_deprecated
2146 * precision of the intra DC coefficient - 8
2147 * - encoding: Set by user.
2148 * - decoding: Set by libavcodec
2150 int intra_dc_precision;
2153 * Number of macroblock rows at the top which are skipped.
2154 * - encoding: unused
2155 * - decoding: Set by user.
2160 * Number of macroblock rows at the bottom which are skipped.
2161 * - encoding: unused
2162 * - decoding: Set by user.
2168 * @deprecated use encoder private options instead
2170 attribute_deprecated
2171 float border_masking;
2175 * minimum MB lagrange multipler
2176 * - encoding: Set by user.
2177 * - decoding: unused
2182 * maximum MB lagrange multipler
2183 * - encoding: Set by user.
2184 * - decoding: unused
2188 #if FF_API_PRIVATE_OPT
2190 * @deprecated use encoder private options instead
2192 attribute_deprecated
2193 int me_penalty_compensation;
2197 * - encoding: Set by user.
2198 * - decoding: unused
2202 #if FF_API_PRIVATE_OPT
2203 /** @deprecated use encoder private options instead */
2204 attribute_deprecated
2210 * - encoding: Set by user.
2211 * - decoding: unused
2216 * number of reference frames
2217 * - encoding: Set by user.
2218 * - decoding: Set by lavc.
2222 #if FF_API_PRIVATE_OPT
2223 /** @deprecated use encoder private options instead */
2224 attribute_deprecated
2228 #if FF_API_UNUSED_MEMBERS
2230 * Multiplied by qscale for each frame and added to scene_change_score.
2231 * - encoding: Set by user.
2232 * - decoding: unused
2234 attribute_deprecated int scenechange_factor;
2238 * Note: Value depends upon the compare function used for fullpel ME.
2239 * - encoding: Set by user.
2240 * - decoding: unused
2244 #if FF_API_PRIVATE_OPT
2245 /** @deprecated use encoder private options instead */
2246 attribute_deprecated
2251 * Chromaticity coordinates of the source primaries.
2252 * - encoding: Set by user
2253 * - decoding: Set by libavcodec
2255 enum AVColorPrimaries color_primaries;
2258 * Color Transfer Characteristic.
2259 * - encoding: Set by user
2260 * - decoding: Set by libavcodec
2262 enum AVColorTransferCharacteristic color_trc;
2265 * YUV colorspace type.
2266 * - encoding: Set by user
2267 * - decoding: Set by libavcodec
2269 enum AVColorSpace colorspace;
2272 * MPEG vs JPEG YUV range.
2273 * - encoding: Set by user
2274 * - decoding: Set by libavcodec
2276 enum AVColorRange color_range;
2279 * This defines the location of chroma samples.
2280 * - encoding: Set by user
2281 * - decoding: Set by libavcodec
2283 enum AVChromaLocation chroma_sample_location;
2287 * Indicates number of picture subdivisions. Used for parallelized
2289 * - encoding: Set by user
2290 * - decoding: unused
2295 * - encoding: set by libavcodec
2296 * - decoding: Set by user.
2298 enum AVFieldOrder field_order;
2301 int sample_rate; ///< samples per second
2302 int channels; ///< number of audio channels
2305 * audio sample format
2306 * - encoding: Set by user.
2307 * - decoding: Set by libavcodec.
2309 enum AVSampleFormat sample_fmt; ///< sample format
2311 /* The following data should not be initialized. */
2313 * Number of samples per channel in an audio frame.
2315 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2316 * except the last must contain exactly frame_size samples per channel.
2317 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2318 * frame size is not restricted.
2319 * - decoding: may be set by some decoders to indicate constant frame size
2324 * Frame counter, set by libavcodec.
2326 * - decoding: total number of frames returned from the decoder so far.
2327 * - encoding: total number of frames passed to the encoder so far.
2329 * @note the counter is not incremented if encoding/decoding resulted in
2335 * number of bytes per packet if constant and known or 0
2336 * Used by some WAV based audio codecs.
2341 * Audio cutoff bandwidth (0 means "automatic")
2342 * - encoding: Set by user.
2343 * - decoding: unused
2348 * Audio channel layout.
2349 * - encoding: set by user.
2350 * - decoding: set by user, may be overwritten by libavcodec.
2352 uint64_t channel_layout;
2355 * Request decoder to use this channel layout if it can (0 for default)
2356 * - encoding: unused
2357 * - decoding: Set by user.
2359 uint64_t request_channel_layout;
2362 * Type of service that the audio stream conveys.
2363 * - encoding: Set by user.
2364 * - decoding: Set by libavcodec.
2366 enum AVAudioServiceType audio_service_type;
2369 * desired sample format
2370 * - encoding: Not used.
2371 * - decoding: Set by user.
2372 * Decoder will decode to this format if it can.
2374 enum AVSampleFormat request_sample_fmt;
2377 * This callback is called at the beginning of each frame to get data
2378 * buffer(s) for it. There may be one contiguous buffer for all the data or
2379 * there may be a buffer per each data plane or anything in between. What
2380 * this means is, you may set however many entries in buf[] you feel necessary.
2381 * Each buffer must be reference-counted using the AVBuffer API (see description
2384 * The following fields will be set in the frame before this callback is
2387 * - width, height (video only)
2388 * - sample_rate, channel_layout, nb_samples (audio only)
2389 * Their values may differ from the corresponding values in
2390 * AVCodecContext. This callback must use the frame values, not the codec
2391 * context values, to calculate the required buffer size.
2393 * This callback must fill the following fields in the frame:
2397 * * if the data is planar audio with more than 8 channels, then this
2398 * callback must allocate and fill extended_data to contain all pointers
2399 * to all data planes. data[] must hold as many pointers as it can.
2400 * extended_data must be allocated with av_malloc() and will be freed in
2402 * * otherwise exended_data must point to data
2403 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2404 * the frame's data and extended_data pointers must be contained in these. That
2405 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2406 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2407 * and av_buffer_ref().
2408 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2409 * this callback and filled with the extra buffers if there are more
2410 * buffers than buf[] can hold. extended_buf will be freed in
2413 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2414 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2417 * Each data plane must be aligned to the maximum required by the target
2420 * @see avcodec_default_get_buffer2()
2424 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2425 * (read and/or written to if it is writable) later by libavcodec.
2427 * avcodec_align_dimensions2() should be used to find the required width and
2428 * height, as they normally need to be rounded up to the next multiple of 16.
2430 * Some decoders do not support linesizes changing between frames.
2432 * If frame multithreading is used and thread_safe_callbacks is set,
2433 * this callback may be called from a different thread, but not from more
2434 * than one at once. Does not need to be reentrant.
2436 * @see avcodec_align_dimensions2()
2440 * Decoders request a buffer of a particular size by setting
2441 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2442 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2443 * to a smaller value in the output frame.
2445 * As a convenience, av_samples_get_buffer_size() and
2446 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2447 * functions to find the required data size and to fill data pointers and
2448 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2449 * since all planes must be the same size.
2451 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2453 * - encoding: unused
2454 * - decoding: Set by libavcodec, user can override.
2456 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2459 * If non-zero, the decoded audio and video frames returned from
2460 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2461 * and are valid indefinitely. The caller must free them with
2462 * av_frame_unref() when they are not needed anymore.
2463 * Otherwise, the decoded frames must not be freed by the caller and are
2464 * only valid until the next decode call.
2466 * - encoding: unused
2467 * - decoding: set by the caller before avcodec_open2().
2469 int refcounted_frames;
2471 /* - encoding parameters */
2472 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2473 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2477 * - encoding: Set by user.
2478 * - decoding: unused
2484 * - encoding: Set by user.
2485 * - decoding: unused
2490 * maximum quantizer difference between frames
2491 * - encoding: Set by user.
2492 * - decoding: unused
2498 * @deprecated use encoder private options instead
2500 attribute_deprecated
2503 attribute_deprecated
2505 attribute_deprecated
2510 * decoder bitstream buffer size
2511 * - encoding: Set by user.
2512 * - decoding: unused
2517 * ratecontrol override, see RcOverride
2518 * - encoding: Allocated/set/freed by user.
2519 * - decoding: unused
2521 int rc_override_count;
2522 RcOverride *rc_override;
2526 * @deprecated use encoder private options instead
2528 attribute_deprecated
2534 * - encoding: Set by user.
2535 * - decoding: Set by user, may be overwritten by libavcodec.
2537 int64_t rc_max_rate;
2541 * - encoding: Set by user.
2542 * - decoding: unused
2544 int64_t rc_min_rate;
2548 * @deprecated use encoder private options instead
2550 attribute_deprecated
2551 float rc_buffer_aggressivity;
2553 attribute_deprecated
2554 float rc_initial_cplx;
2558 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2559 * - encoding: Set by user.
2560 * - decoding: unused.
2562 float rc_max_available_vbv_use;
2565 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2566 * - encoding: Set by user.
2567 * - decoding: unused.
2569 float rc_min_vbv_overflow_use;
2572 * Number of bits which should be loaded into the rc buffer before decoding starts.
2573 * - encoding: Set by user.
2574 * - decoding: unused
2576 int rc_initial_buffer_occupancy;
2578 #if FF_API_CODER_TYPE
2579 #define FF_CODER_TYPE_VLC 0
2580 #define FF_CODER_TYPE_AC 1
2581 #define FF_CODER_TYPE_RAW 2
2582 #define FF_CODER_TYPE_RLE 3
2583 #if FF_API_UNUSED_MEMBERS
2584 #define FF_CODER_TYPE_DEFLATE 4
2585 #endif /* FF_API_UNUSED_MEMBERS */
2587 * @deprecated use encoder private options instead
2589 attribute_deprecated
2591 #endif /* FF_API_CODER_TYPE */
2593 #if FF_API_PRIVATE_OPT
2594 /** @deprecated use encoder private options instead */
2595 attribute_deprecated
2601 * @deprecated use encoder private options instead
2603 attribute_deprecated
2607 * @deprecated use encoder private options instead
2609 attribute_deprecated
2613 #if FF_API_PRIVATE_OPT
2614 /** @deprecated use encoder private options instead */
2615 attribute_deprecated
2616 int frame_skip_threshold;
2618 /** @deprecated use encoder private options instead */
2619 attribute_deprecated
2620 int frame_skip_factor;
2622 /** @deprecated use encoder private options instead */
2623 attribute_deprecated
2626 /** @deprecated use encoder private options instead */
2627 attribute_deprecated
2629 #endif /* FF_API_PRIVATE_OPT */
2632 * trellis RD quantization
2633 * - encoding: Set by user.
2634 * - decoding: unused
2638 #if FF_API_PRIVATE_OPT
2639 /** @deprecated use encoder private options instead */
2640 attribute_deprecated
2641 int min_prediction_order;
2643 /** @deprecated use encoder private options instead */
2644 attribute_deprecated
2645 int max_prediction_order;
2647 /** @deprecated use encoder private options instead */
2648 attribute_deprecated
2649 int64_t timecode_frame_start;
2652 #if FF_API_RTP_CALLBACK
2654 * @deprecated unused
2656 /* The RTP callback: This function is called */
2657 /* every time the encoder has a packet to send. */
2658 /* It depends on the encoder if the data starts */
2659 /* with a Start Code (it should). H.263 does. */
2660 /* mb_nb contains the number of macroblocks */
2661 /* encoded in the RTP payload. */
2662 attribute_deprecated
2663 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2666 #if FF_API_PRIVATE_OPT
2667 /** @deprecated use encoder private options instead */
2668 attribute_deprecated
2669 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2670 /* do its best to deliver a chunk with size */
2671 /* below rtp_payload_size, the chunk will start */
2672 /* with a start code on some codecs like H.263. */
2673 /* This doesn't take account of any particular */
2674 /* headers inside the transmitted RTP payload. */
2677 #if FF_API_STAT_BITS
2678 /* statistics, used for 2-pass encoding */
2679 attribute_deprecated
2681 attribute_deprecated
2683 attribute_deprecated
2685 attribute_deprecated
2687 attribute_deprecated
2689 attribute_deprecated
2691 attribute_deprecated
2693 attribute_deprecated
2696 /** @deprecated this field is unused */
2697 attribute_deprecated
2702 * pass1 encoding statistics output buffer
2703 * - encoding: Set by libavcodec.
2704 * - decoding: unused
2709 * pass2 encoding statistics input buffer
2710 * Concatenated stuff from stats_out of pass1 should be placed here.
2711 * - encoding: Allocated/set/freed by user.
2712 * - decoding: unused
2717 * Work around bugs in encoders which sometimes cannot be detected automatically.
2718 * - encoding: Set by user
2719 * - decoding: Set by user
2721 int workaround_bugs;
2722 #define FF_BUG_AUTODETECT 1 ///< autodetection
2723 #if FF_API_OLD_MSMPEG4
2724 #define FF_BUG_OLD_MSMPEG4 2
2726 #define FF_BUG_XVID_ILACE 4
2727 #define FF_BUG_UMP4 8
2728 #define FF_BUG_NO_PADDING 16
2729 #define FF_BUG_AMV 32
2731 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2733 #define FF_BUG_QPEL_CHROMA 64
2734 #define FF_BUG_STD_QPEL 128
2735 #define FF_BUG_QPEL_CHROMA2 256
2736 #define FF_BUG_DIRECT_BLOCKSIZE 512
2737 #define FF_BUG_EDGE 1024
2738 #define FF_BUG_HPEL_CHROMA 2048
2739 #define FF_BUG_DC_CLIP 4096
2740 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2741 #define FF_BUG_TRUNCATED 16384
2744 * strictly follow the standard (MPEG4, ...).
2745 * - encoding: Set by user.
2746 * - decoding: Set by user.
2747 * Setting this to STRICT or higher means the encoder and decoder will
2748 * generally do stupid things, whereas setting it to unofficial or lower
2749 * will mean the encoder might produce output that is not supported by all
2750 * spec-compliant decoders. Decoders don't differentiate between normal,
2751 * unofficial and experimental (that is, they always try to decode things
2752 * when they can) unless they are explicitly asked to behave stupidly
2753 * (=strictly conform to the specs)
2755 int strict_std_compliance;
2756 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2757 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2758 #define FF_COMPLIANCE_NORMAL 0
2759 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2760 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2763 * error concealment flags
2764 * - encoding: unused
2765 * - decoding: Set by user.
2767 int error_concealment;
2768 #define FF_EC_GUESS_MVS 1
2769 #define FF_EC_DEBLOCK 2
2770 #define FF_EC_FAVOR_INTER 256
2774 * - encoding: Set by user.
2775 * - decoding: Set by user.
2778 #define FF_DEBUG_PICT_INFO 1
2779 #define FF_DEBUG_RC 2
2780 #define FF_DEBUG_BITSTREAM 4
2781 #define FF_DEBUG_MB_TYPE 8
2782 #define FF_DEBUG_QP 16
2785 * @deprecated this option does nothing
2787 #define FF_DEBUG_MV 32
2789 #define FF_DEBUG_DCT_COEFF 0x00000040
2790 #define FF_DEBUG_SKIP 0x00000080
2791 #define FF_DEBUG_STARTCODE 0x00000100
2792 #if FF_API_UNUSED_MEMBERS
2793 #define FF_DEBUG_PTS 0x00000200
2794 #endif /* FF_API_UNUSED_MEMBERS */
2795 #define FF_DEBUG_ER 0x00000400
2796 #define FF_DEBUG_MMCO 0x00000800
2797 #define FF_DEBUG_BUGS 0x00001000
2799 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2800 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2802 #define FF_DEBUG_BUFFERS 0x00008000
2803 #define FF_DEBUG_THREADS 0x00010000
2804 #define FF_DEBUG_GREEN_MD 0x00800000
2805 #define FF_DEBUG_NOMC 0x01000000
2810 * Code outside libavcodec should access this field using AVOptions
2811 * - encoding: Set by user.
2812 * - decoding: Set by user.
2815 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2816 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2817 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2821 * Error recognition; may misdetect some more or less valid parts as errors.
2822 * - encoding: unused
2823 * - decoding: Set by user.
2825 int err_recognition;
2828 * Verify checksums embedded in the bitstream (could be of either encoded or
2829 * decoded data, depending on the codec) and print an error message on mismatch.
2830 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2831 * decoder returning an error.
2833 #define AV_EF_CRCCHECK (1<<0)
2834 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2835 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2836 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2838 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2839 #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
2840 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2841 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2845 * opaque 64bit number (generally a PTS) that will be reordered and
2846 * output in AVFrame.reordered_opaque
2847 * - encoding: unused
2848 * - decoding: Set by user.
2850 int64_t reordered_opaque;
2853 * Hardware accelerator in use
2854 * - encoding: unused.
2855 * - decoding: Set by libavcodec
2857 struct AVHWAccel *hwaccel;
2860 * Hardware accelerator context.
2861 * For some hardware accelerators, a global context needs to be
2862 * provided by the user. In that case, this holds display-dependent
2863 * data FFmpeg cannot instantiate itself. Please refer to the
2864 * FFmpeg HW accelerator documentation to know how to fill this
2865 * is. e.g. for VA API, this is a struct vaapi_context.
2866 * - encoding: unused
2867 * - decoding: Set by user
2869 void *hwaccel_context;
2873 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2874 * - decoding: unused
2876 uint64_t error[AV_NUM_DATA_POINTERS];
2879 * DCT algorithm, see FF_DCT_* below
2880 * - encoding: Set by user.
2881 * - decoding: unused
2884 #define FF_DCT_AUTO 0
2885 #define FF_DCT_FASTINT 1
2886 #define FF_DCT_INT 2
2887 #define FF_DCT_MMX 3
2888 #define FF_DCT_ALTIVEC 5
2889 #define FF_DCT_FAAN 6
2892 * IDCT algorithm, see FF_IDCT_* below.
2893 * - encoding: Set by user.
2894 * - decoding: Set by user.
2897 #define FF_IDCT_AUTO 0
2898 #define FF_IDCT_INT 1
2899 #define FF_IDCT_SIMPLE 2
2900 #define FF_IDCT_SIMPLEMMX 3
2901 #define FF_IDCT_ARM 7
2902 #define FF_IDCT_ALTIVEC 8
2904 #define FF_IDCT_SH4 9
2906 #define FF_IDCT_SIMPLEARM 10
2907 #if FF_API_UNUSED_MEMBERS
2908 #define FF_IDCT_IPP 13
2909 #endif /* FF_API_UNUSED_MEMBERS */
2910 #define FF_IDCT_XVID 14
2911 #if FF_API_IDCT_XVIDMMX
2912 #define FF_IDCT_XVIDMMX 14
2913 #endif /* FF_API_IDCT_XVIDMMX */
2914 #define FF_IDCT_SIMPLEARMV5TE 16
2915 #define FF_IDCT_SIMPLEARMV6 17
2916 #if FF_API_ARCH_SPARC
2917 #define FF_IDCT_SIMPLEVIS 18
2919 #define FF_IDCT_FAAN 20
2920 #define FF_IDCT_SIMPLENEON 22
2921 #if FF_API_ARCH_ALPHA
2922 #define FF_IDCT_SIMPLEALPHA 23
2924 #define FF_IDCT_SIMPLEAUTO 128
2927 * bits per sample/pixel from the demuxer (needed for huffyuv).
2928 * - encoding: Set by libavcodec.
2929 * - decoding: Set by user.
2931 int bits_per_coded_sample;
2934 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2935 * - encoding: set by user.
2936 * - decoding: set by libavcodec.
2938 int bits_per_raw_sample;
2942 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2943 * - encoding: unused
2944 * - decoding: Set by user.
2945 * Code outside libavcodec should access this field using:
2946 * av_codec_{get,set}_lowres(avctx)
2951 #if FF_API_CODED_FRAME
2953 * the picture in the bitstream
2954 * - encoding: Set by libavcodec.
2955 * - decoding: unused
2957 * @deprecated use the quality factor packet side data instead
2959 attribute_deprecated AVFrame *coded_frame;
2964 * is used to decide how many independent tasks should be passed to execute()
2965 * - encoding: Set by user.
2966 * - decoding: Set by user.
2971 * Which multithreading methods to use.
2972 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2973 * so clients which cannot provide future frames should not use it.
2975 * - encoding: Set by user, otherwise the default is used.
2976 * - decoding: Set by user, otherwise the default is used.
2979 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2980 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2983 * Which multithreading methods are in use by the codec.
2984 * - encoding: Set by libavcodec.
2985 * - decoding: Set by libavcodec.
2987 int active_thread_type;
2990 * Set by the client if its custom get_buffer() callback can be called
2991 * synchronously from another thread, which allows faster multithreaded decoding.
2992 * draw_horiz_band() will be called from other threads regardless of this setting.
2993 * Ignored if the default get_buffer() is used.
2994 * - encoding: Set by user.
2995 * - decoding: Set by user.
2997 int thread_safe_callbacks;
3000 * The codec may call this to execute several independent things.
3001 * It will return only after finishing all tasks.
3002 * The user may replace this with some multithreaded implementation,
3003 * the default implementation will execute the parts serially.
3004 * @param count the number of things to execute
3005 * - encoding: Set by libavcodec, user can override.
3006 * - decoding: Set by libavcodec, user can override.
3008 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3011 * The codec may call this to execute several independent things.
3012 * It will return only after finishing all tasks.
3013 * The user may replace this with some multithreaded implementation,
3014 * the default implementation will execute the parts serially.
3015 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3016 * @param c context passed also to func
3017 * @param count the number of things to execute
3018 * @param arg2 argument passed unchanged to func
3019 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3020 * @param func function that will be called count times, with jobnr from 0 to count-1.
3021 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3022 * two instances of func executing at the same time will have the same threadnr.
3023 * @return always 0 currently, but code should handle a future improvement where when any call to func
3024 * returns < 0 no further calls to func may be done and < 0 is returned.
3025 * - encoding: Set by libavcodec, user can override.
3026 * - decoding: Set by libavcodec, user can override.
3028 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3031 * noise vs. sse weight for the nsse comparison function
3032 * - encoding: Set by user.
3033 * - decoding: unused
3039 * - encoding: Set by user.
3040 * - decoding: Set by libavcodec.
3043 #define FF_PROFILE_UNKNOWN -99
3044 #define FF_PROFILE_RESERVED -100
3046 #define FF_PROFILE_AAC_MAIN 0
3047 #define FF_PROFILE_AAC_LOW 1
3048 #define FF_PROFILE_AAC_SSR 2
3049 #define FF_PROFILE_AAC_LTP 3
3050 #define FF_PROFILE_AAC_HE 4
3051 #define FF_PROFILE_AAC_HE_V2 28
3052 #define FF_PROFILE_AAC_LD 22
3053 #define FF_PROFILE_AAC_ELD 38
3054 #define FF_PROFILE_MPEG2_AAC_LOW 128
3055 #define FF_PROFILE_MPEG2_AAC_HE 131
3057 #define FF_PROFILE_DTS 20
3058 #define FF_PROFILE_DTS_ES 30
3059 #define FF_PROFILE_DTS_96_24 40
3060 #define FF_PROFILE_DTS_HD_HRA 50
3061 #define FF_PROFILE_DTS_HD_MA 60
3062 #define FF_PROFILE_DTS_EXPRESS 70
3064 #define FF_PROFILE_MPEG2_422 0
3065 #define FF_PROFILE_MPEG2_HIGH 1
3066 #define FF_PROFILE_MPEG2_SS 2
3067 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3068 #define FF_PROFILE_MPEG2_MAIN 4
3069 #define FF_PROFILE_MPEG2_SIMPLE 5
3071 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3072 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3074 #define FF_PROFILE_H264_BASELINE 66
3075 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3076 #define FF_PROFILE_H264_MAIN 77
3077 #define FF_PROFILE_H264_EXTENDED 88
3078 #define FF_PROFILE_H264_HIGH 100
3079 #define FF_PROFILE_H264_HIGH_10 110
3080 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3081 #define FF_PROFILE_H264_HIGH_422 122
3082 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3083 #define FF_PROFILE_H264_HIGH_444 144
3084 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3085 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3086 #define FF_PROFILE_H264_CAVLC_444 44
3088 #define FF_PROFILE_VC1_SIMPLE 0
3089 #define FF_PROFILE_VC1_MAIN 1
3090 #define FF_PROFILE_VC1_COMPLEX 2
3091 #define FF_PROFILE_VC1_ADVANCED 3
3093 #define FF_PROFILE_MPEG4_SIMPLE 0
3094 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3095 #define FF_PROFILE_MPEG4_CORE 2
3096 #define FF_PROFILE_MPEG4_MAIN 3
3097 #define FF_PROFILE_MPEG4_N_BIT 4
3098 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3099 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3100 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3101 #define FF_PROFILE_MPEG4_HYBRID 8
3102 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3103 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3104 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3105 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3106 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3107 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3108 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3110 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
3111 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
3112 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
3113 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3114 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3116 #define FF_PROFILE_VP9_0 0
3117 #define FF_PROFILE_VP9_1 1
3118 #define FF_PROFILE_VP9_2 2
3119 #define FF_PROFILE_VP9_3 3
3121 #define FF_PROFILE_HEVC_MAIN 1
3122 #define FF_PROFILE_HEVC_MAIN_10 2
3123 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3124 #define FF_PROFILE_HEVC_REXT 4
3128 * - encoding: Set by user.
3129 * - decoding: Set by libavcodec.
3132 #define FF_LEVEL_UNKNOWN -99
3135 * Skip loop filtering for selected frames.
3136 * - encoding: unused
3137 * - decoding: Set by user.
3139 enum AVDiscard skip_loop_filter;
3142 * Skip IDCT/dequantization for selected frames.
3143 * - encoding: unused
3144 * - decoding: Set by user.
3146 enum AVDiscard skip_idct;
3149 * Skip decoding for selected frames.
3150 * - encoding: unused
3151 * - decoding: Set by user.
3153 enum AVDiscard skip_frame;
3156 * Header containing style information for text subtitles.
3157 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3158 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3159 * the Format line following. It shouldn't include any Dialogue line.
3160 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3161 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3163 uint8_t *subtitle_header;
3164 int subtitle_header_size;
3166 #if FF_API_ERROR_RATE
3168 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3171 attribute_deprecated
3175 #if FF_API_VBV_DELAY
3177 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3178 * Used for compliant TS muxing.
3179 * - encoding: Set by libavcodec.
3180 * - decoding: unused.
3181 * @deprecated this value is now exported as a part of
3182 * AV_PKT_DATA_CPB_PROPERTIES packet side data
3184 attribute_deprecated
3188 #if FF_API_SIDEDATA_ONLY_PKT
3190 * Encoding only and set by default. Allow encoders to output packets
3191 * that do not contain any encoded data, only side data.
3193 * Some encoders need to output such packets, e.g. to update some stream
3194 * parameters at the end of encoding.
3196 * @deprecated this field disables the default behaviour and
3197 * it is kept only for compatibility.
3199 attribute_deprecated
3200 int side_data_only_packets;
3204 * Audio only. The number of "priming" samples (padding) inserted by the
3205 * encoder at the beginning of the audio. I.e. this number of leading
3206 * decoded samples must be discarded by the caller to get the original audio
3207 * without leading padding.
3209 * - decoding: unused
3210 * - encoding: Set by libavcodec. The timestamps on the output packets are
3211 * adjusted by the encoder so that they always refer to the
3212 * first sample of the data actually contained in the packet,
3213 * including any added padding. E.g. if the timebase is
3214 * 1/samplerate and the timestamp of the first input sample is
3215 * 0, the timestamp of the first output packet will be
3218 int initial_padding;
3221 * - decoding: For codecs that store a framerate value in the compressed
3222 * bitstream, the decoder may export it here. { 0, 1} when
3224 * - encoding: unused
3226 AVRational framerate;
3229 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3230 * - encoding: unused.
3231 * - decoding: Set by libavcodec before calling get_format()
3233 enum AVPixelFormat sw_pix_fmt;
3236 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3237 * Code outside libavcodec should access this field using:
3238 * av_codec_{get,set}_pkt_timebase(avctx)
3239 * - encoding unused.
3240 * - decoding set by user.
3242 AVRational pkt_timebase;
3246 * Code outside libavcodec should access this field using:
3247 * av_codec_{get,set}_codec_descriptor(avctx)
3248 * - encoding: unused.
3249 * - decoding: set by libavcodec.
3251 const AVCodecDescriptor *codec_descriptor;
3255 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3256 * - encoding: unused
3257 * - decoding: Set by user.
3258 * Code outside libavcodec should access this field using:
3259 * av_codec_{get,set}_lowres(avctx)
3265 * Current statistics for PTS correction.
3266 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3267 * - encoding: unused
3269 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3270 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3271 int64_t pts_correction_last_pts; /// PTS of the last frame
3272 int64_t pts_correction_last_dts; /// DTS of the last frame
3275 * Character encoding of the input subtitles file.
3276 * - decoding: set by user
3277 * - encoding: unused
3282 * Subtitles character encoding mode. Formats or codecs might be adjusting
3283 * this setting (if they are doing the conversion themselves for instance).
3284 * - decoding: set by libavcodec
3285 * - encoding: unused
3287 int sub_charenc_mode;
3288 #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)
3289 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3290 #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
3292 int sub_text_format;
3293 #define FF_SUB_TEXT_FMT_ASS 0
3294 #if FF_API_ASS_TIMING
3295 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3299 * Skip processing alpha if supported by codec.
3300 * Note that if the format uses pre-multiplied alpha (common with VP6,
3301 * and recommended due to better video quality/compression)
3302 * the image will look as if alpha-blended onto a black background.
3303 * However for formats that do not use pre-multiplied alpha
3304 * there might be serious artefacts (though e.g. libswscale currently
3305 * assumes pre-multiplied alpha anyway).
3306 * Code outside libavcodec should access this field using AVOptions
3308 * - decoding: set by user
3309 * - encoding: unused
3314 * Number of samples to skip after a discontinuity
3315 * - decoding: unused
3316 * - encoding: set by libavcodec
3320 #if !FF_API_DEBUG_MV
3322 * debug motion vectors
3323 * Code outside libavcodec should access this field using AVOptions
3324 * - encoding: Set by user.
3325 * - decoding: Set by user.
3328 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3329 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3330 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3334 * custom intra quantization matrix
3335 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3336 * - encoding: Set by user, can be NULL.
3337 * - decoding: unused.
3339 uint16_t *chroma_intra_matrix;
3342 * dump format separator.
3343 * can be ", " or "\n " or anything else
3344 * Code outside libavcodec should access this field using AVOptions
3345 * (NO direct access).
3346 * - encoding: Set by user.
3347 * - decoding: Set by user.
3349 uint8_t *dump_separator;
3352 * ',' separated list of allowed decoders.
3353 * If NULL then all are allowed
3354 * - encoding: unused
3355 * - decoding: set by user through AVOPtions (NO direct access)
3357 char *codec_whitelist;
3360 * Properties of the stream that gets decoded
3361 * To be accessed through av_codec_get_properties() (NO direct access)
3362 * - encoding: unused
3363 * - decoding: set by libavcodec
3365 unsigned properties;
3366 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3367 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3370 * Additional data associated with the entire coded stream.
3372 * - decoding: unused
3373 * - encoding: may be set by libavcodec after avcodec_open2().
3375 AVPacketSideData *coded_side_data;
3376 int nb_coded_side_data;
3381 * For hardware encoders configured to use a hwaccel pixel format, this
3382 * field should be set by the caller to a reference to the AVHWFramesContext
3383 * describing input frames. AVHWFramesContext.format must be equal to
3384 * AVCodecContext.pix_fmt.
3386 * This field should be set before avcodec_open2() is called and is
3387 * afterwards owned and managed by libavcodec.
3389 AVBufferRef *hw_frames_ctx;
3392 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3393 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3395 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3396 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3398 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3400 int av_codec_get_lowres(const AVCodecContext *avctx);
3401 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3403 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3404 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3406 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3407 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3412 typedef struct AVProfile {
3414 const char *name; ///< short name for the profile
3417 typedef struct AVCodecDefault AVCodecDefault;
3424 typedef struct AVCodec {
3426 * Name of the codec implementation.
3427 * The name is globally unique among encoders and among decoders (but an
3428 * encoder and a decoder can share the same name).
3429 * This is the primary way to find a codec from the user perspective.
3433 * Descriptive name for the codec, meant to be more human readable than name.
3434 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3436 const char *long_name;
3437 enum AVMediaType type;
3440 * Codec capabilities.
3441 * see AV_CODEC_CAP_*
3444 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3445 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3446 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3447 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3448 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3449 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3450 const AVClass *priv_class; ///< AVClass for the private context
3451 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3453 /*****************************************************************
3454 * No fields below this line are part of the public API. They
3455 * may not be used outside of libavcodec and can be changed and
3457 * New public fields should be added right above.
3458 *****************************************************************
3461 struct AVCodec *next;
3463 * @name Frame-level threading support functions
3467 * If defined, called on thread contexts when they are created.
3468 * If the codec allocates writable tables in init(), re-allocate them here.
3469 * priv_data will be set to a copy of the original.
3471 int (*init_thread_copy)(AVCodecContext *);
3473 * Copy necessary context variables from a previous thread context to the current one.
3474 * If not defined, the next thread will start automatically; otherwise, the codec
3475 * must call ff_thread_finish_setup().
3477 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3479 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3483 * Private codec-specific defaults.
3485 const AVCodecDefault *defaults;
3488 * Initialize codec static data, called from avcodec_register().
3490 void (*init_static_data)(struct AVCodec *codec);
3492 int (*init)(AVCodecContext *);
3493 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3494 const struct AVSubtitle *sub);
3496 * Encode data to an AVPacket.
3498 * @param avctx codec context
3499 * @param avpkt output AVPacket (may contain a user-provided buffer)
3500 * @param[in] frame AVFrame containing the raw data to be encoded
3501 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3502 * non-empty packet was returned in avpkt.
3503 * @return 0 on success, negative error code on failure
3505 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3506 int *got_packet_ptr);
3507 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3508 int (*close)(AVCodecContext *);
3511 * Will be called when seeking
3513 void (*flush)(AVCodecContext *);
3515 * Internal codec capabilities.
3516 * See FF_CODEC_CAP_* in internal.h
3521 int av_codec_get_max_lowres(const AVCodec *codec);
3523 struct MpegEncContext;
3526 * @defgroup lavc_hwaccel AVHWAccel
3529 typedef struct AVHWAccel {
3531 * Name of the hardware accelerated codec.
3532 * The name is globally unique among encoders and among decoders (but an
3533 * encoder and a decoder can share the same name).
3538 * Type of codec implemented by the hardware accelerator.
3540 * See AVMEDIA_TYPE_xxx
3542 enum AVMediaType type;
3545 * Codec implemented by the hardware accelerator.
3547 * See AV_CODEC_ID_xxx
3552 * Supported pixel format.
3554 * Only hardware accelerated formats are supported here.
3556 enum AVPixelFormat pix_fmt;
3559 * Hardware accelerated codec capabilities.
3560 * see HWACCEL_CODEC_CAP_*
3564 /*****************************************************************
3565 * No fields below this line are part of the public API. They
3566 * may not be used outside of libavcodec and can be changed and
3568 * New public fields should be added right above.
3569 *****************************************************************
3571 struct AVHWAccel *next;
3574 * Allocate a custom buffer
3576 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3579 * Called at the beginning of each frame or field picture.
3581 * Meaningful frame information (codec specific) is guaranteed to
3582 * be parsed at this point. This function is mandatory.
3584 * Note that buf can be NULL along with buf_size set to 0.
3585 * Otherwise, this means the whole frame is available at this point.
3587 * @param avctx the codec context
3588 * @param buf the frame data buffer base
3589 * @param buf_size the size of the frame in bytes
3590 * @return zero if successful, a negative value otherwise
3592 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3595 * Callback for each slice.
3597 * Meaningful slice information (codec specific) is guaranteed to
3598 * be parsed at this point. This function is mandatory.
3599 * The only exception is XvMC, that works on MB level.
3601 * @param avctx the codec context
3602 * @param buf the slice data buffer base
3603 * @param buf_size the size of the slice in bytes
3604 * @return zero if successful, a negative value otherwise
3606 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3609 * Called at the end of each frame or field picture.
3611 * The whole picture is parsed at this point and can now be sent
3612 * to the hardware accelerator. This function is mandatory.
3614 * @param avctx the codec context
3615 * @return zero if successful, a negative value otherwise
3617 int (*end_frame)(AVCodecContext *avctx);
3620 * Size of per-frame hardware accelerator private data.
3622 * Private data is allocated with av_mallocz() before
3623 * AVCodecContext.get_buffer() and deallocated after
3624 * AVCodecContext.release_buffer().
3626 int frame_priv_data_size;
3629 * Called for every Macroblock in a slice.
3631 * XvMC uses it to replace the ff_mpv_decode_mb().
3632 * Instead of decoding to raw picture, MB parameters are
3633 * stored in an array provided by the video driver.
3635 * @param s the mpeg context
3637 void (*decode_mb)(struct MpegEncContext *s);
3640 * Initialize the hwaccel private data.
3642 * This will be called from ff_get_format(), after hwaccel and
3643 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3646 int (*init)(AVCodecContext *avctx);
3649 * Uninitialize the hwaccel private data.
3651 * This will be called from get_format() or avcodec_close(), after hwaccel
3652 * and hwaccel_context are already uninitialized.
3654 int (*uninit)(AVCodecContext *avctx);
3657 * Size of the private data to allocate in
3658 * AVCodecInternal.hwaccel_priv_data.
3664 * Hardware acceleration should be used for decoding even if the codec level
3665 * used is unknown or higher than the maximum supported level reported by the
3668 * It's generally a good idea to pass this flag unless you have a specific
3669 * reason not to, as hardware tends to under-report supported levels.
3671 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3674 * Hardware acceleration can output YUV pixel formats with a different chroma
3675 * sampling than 4:2:0 and/or other than 8 bits per component.
3677 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3683 #if FF_API_AVPICTURE
3685 * @defgroup lavc_picture AVPicture
3687 * Functions for working with AVPicture
3692 * Picture data structure.
3694 * Up to four components can be stored into it, the last component is
3696 * @deprecated use AVFrame or imgutils functions instead
3698 typedef struct AVPicture {
3699 attribute_deprecated
3700 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3701 attribute_deprecated
3702 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3710 enum AVSubtitleType {
3713 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3716 * Plain text, the text field must be set by the decoder and is
3717 * authoritative. ass and pict fields may contain approximations.
3722 * Formatted text, the ass field must be set by the decoder and is
3723 * authoritative. pict and text fields may contain approximations.
3728 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3730 typedef struct AVSubtitleRect {
3731 int x; ///< top left corner of pict, undefined when pict is not set
3732 int y; ///< top left corner of pict, undefined when pict is not set
3733 int w; ///< width of pict, undefined when pict is not set
3734 int h; ///< height of pict, undefined when pict is not set
3735 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3737 #if FF_API_AVPICTURE
3739 * @deprecated unused
3741 attribute_deprecated
3745 * data+linesize for the bitmap of this subtitle.
3746 * Can be set for text/ass as well once they are rendered.
3751 enum AVSubtitleType type;
3753 char *text; ///< 0 terminated plain UTF-8 text
3756 * 0 terminated ASS/SSA compatible event line.
3757 * The presentation of this is unaffected by the other values in this
3765 typedef struct AVSubtitle {
3766 uint16_t format; /* 0 = graphics */
3767 uint32_t start_display_time; /* relative to packet pts, in ms */
3768 uint32_t end_display_time; /* relative to packet pts, in ms */
3770 AVSubtitleRect **rects;
3771 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3775 * If c is NULL, returns the first registered codec,
3776 * if c is non-NULL, returns the next registered codec after c,
3777 * or NULL if c is the last one.
3779 AVCodec *av_codec_next(const AVCodec *c);
3782 * Return the LIBAVCODEC_VERSION_INT constant.
3784 unsigned avcodec_version(void);
3787 * Return the libavcodec build-time configuration.
3789 const char *avcodec_configuration(void);
3792 * Return the libavcodec license.
3794 const char *avcodec_license(void);
3797 * Register the codec codec and initialize libavcodec.
3799 * @warning either this function or avcodec_register_all() must be called
3800 * before any other libavcodec functions.
3802 * @see avcodec_register_all()
3804 void avcodec_register(AVCodec *codec);
3807 * Register all the codecs, parsers and bitstream filters which were enabled at
3808 * configuration time. If you do not call this function you can select exactly
3809 * which formats you want to support, by using the individual registration
3812 * @see avcodec_register
3813 * @see av_register_codec_parser
3814 * @see av_register_bitstream_filter
3816 void avcodec_register_all(void);
3819 * Allocate an AVCodecContext and set its fields to default values. The
3820 * resulting struct should be freed with avcodec_free_context().
3822 * @param codec if non-NULL, allocate private data and initialize defaults
3823 * for the given codec. It is illegal to then call avcodec_open2()
3824 * with a different codec.
3825 * If NULL, then the codec-specific defaults won't be initialized,
3826 * which may result in suboptimal default settings (this is
3827 * important mainly for encoders, e.g. libx264).
3829 * @return An AVCodecContext filled with default values or NULL on failure.
3830 * @see avcodec_get_context_defaults
3832 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3835 * Free the codec context and everything associated with it and write NULL to
3836 * the provided pointer.
3838 void avcodec_free_context(AVCodecContext **avctx);
3841 * Set the fields of the given AVCodecContext to default values corresponding
3842 * to the given codec (defaults may be codec-dependent).
3844 * Do not call this function if a non-NULL codec has been passed
3845 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3846 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3847 * different codec on this AVCodecContext.
3849 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3852 * Get the AVClass for AVCodecContext. It can be used in combination with
3853 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3855 * @see av_opt_find().
3857 const AVClass *avcodec_get_class(void);
3860 * Get the AVClass for AVFrame. It can be used in combination with
3861 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3863 * @see av_opt_find().
3865 const AVClass *avcodec_get_frame_class(void);
3868 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3869 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3871 * @see av_opt_find().
3873 const AVClass *avcodec_get_subtitle_rect_class(void);
3876 * Copy the settings of the source AVCodecContext into the destination
3877 * AVCodecContext. The resulting destination codec context will be
3878 * unopened, i.e. you are required to call avcodec_open2() before you
3879 * can use this AVCodecContext to decode/encode video/audio data.
3881 * @param dest target codec context, should be initialized with
3882 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3883 * @param src source codec context
3884 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3886 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3889 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3890 * function the context has to be allocated with avcodec_alloc_context3().
3892 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3893 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3894 * retrieving a codec.
3896 * @warning This function is not thread safe!
3898 * @note Always call this function before using decoding routines (such as
3899 * @ref avcodec_decode_video2()).
3902 * avcodec_register_all();
3903 * av_dict_set(&opts, "b", "2.5M", 0);
3904 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3908 * context = avcodec_alloc_context3(codec);
3910 * if (avcodec_open2(context, codec, opts) < 0)
3914 * @param avctx The context to initialize.
3915 * @param codec The codec to open this context for. If a non-NULL codec has been
3916 * previously passed to avcodec_alloc_context3() or
3917 * avcodec_get_context_defaults3() for this context, then this
3918 * parameter MUST be either NULL or equal to the previously passed
3920 * @param options A dictionary filled with AVCodecContext and codec-private options.
3921 * On return this object will be filled with options that were not found.
3923 * @return zero on success, a negative value on error
3924 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3925 * av_dict_set(), av_opt_find().
3927 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3930 * Close a given AVCodecContext and free all the data associated with it
3931 * (but not the AVCodecContext itself).
3933 * Calling this function on an AVCodecContext that hasn't been opened will free
3934 * the codec-specific data allocated in avcodec_alloc_context3() /
3935 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3938 int avcodec_close(AVCodecContext *avctx);
3941 * Free all allocated data in the given subtitle struct.
3943 * @param sub AVSubtitle to free.
3945 void avsubtitle_free(AVSubtitle *sub);
3952 * @addtogroup lavc_packet
3957 * Allocate an AVPacket and set its fields to default values. The resulting
3958 * struct must be freed using av_packet_free().
3960 * @return An AVPacket filled with default values or NULL on failure.
3962 * @note this only allocates the AVPacket itself, not the data buffers. Those
3963 * must be allocated through other means such as av_new_packet.
3965 * @see av_new_packet
3967 AVPacket *av_packet_alloc(void);
3970 * Create a new packet that references the same data as src.
3972 * This is a shortcut for av_packet_alloc()+av_packet_ref().
3974 * @return newly created AVPacket on success, NULL on error.
3976 * @see av_packet_alloc
3977 * @see av_packet_ref
3979 AVPacket *av_packet_clone(AVPacket *src);
3982 * Free the packet, if the packet is reference counted, it will be
3983 * unreferenced first.
3985 * @param packet packet to be freed. The pointer will be set to NULL.
3986 * @note passing NULL is a no-op.
3988 void av_packet_free(AVPacket **pkt);
3991 * Initialize optional fields of a packet with default values.
3993 * Note, this does not touch the data and size members, which have to be
3994 * initialized separately.
3998 void av_init_packet(AVPacket *pkt);
4001 * Allocate the payload of a packet and initialize its fields with
4005 * @param size wanted payload size
4006 * @return 0 if OK, AVERROR_xxx otherwise
4008 int av_new_packet(AVPacket *pkt, int size);
4011 * Reduce packet size, correctly zeroing padding
4014 * @param size new size
4016 void av_shrink_packet(AVPacket *pkt, int size);
4019 * Increase packet size, correctly zeroing padding
4022 * @param grow_by number of bytes by which to increase the size of the packet
4024 int av_grow_packet(AVPacket *pkt, int grow_by);
4027 * Initialize a reference-counted packet from av_malloc()ed data.
4029 * @param pkt packet to be initialized. This function will set the data, size,
4030 * buf and destruct fields, all others are left untouched.
4031 * @param data Data allocated by av_malloc() to be used as packet data. If this
4032 * function returns successfully, the data is owned by the underlying AVBuffer.
4033 * The caller may not access the data through other means.
4034 * @param size size of data in bytes, without the padding. I.e. the full buffer
4035 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4037 * @return 0 on success, a negative AVERROR on error
4039 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4041 #if FF_API_AVPACKET_OLD_API
4043 * @warning This is a hack - the packet memory allocation stuff is broken. The
4044 * packet is allocated if it was not really allocated.
4046 * @deprecated Use av_packet_ref
4048 attribute_deprecated
4049 int av_dup_packet(AVPacket *pkt);
4051 * Copy packet, including contents
4053 * @return 0 on success, negative AVERROR on fail
4055 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4058 * Copy packet side data
4060 * @return 0 on success, negative AVERROR on fail
4062 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4067 * @deprecated Use av_packet_unref
4069 * @param pkt packet to free
4071 attribute_deprecated
4072 void av_free_packet(AVPacket *pkt);
4075 * Allocate new information of a packet.
4078 * @param type side information type
4079 * @param size side information size
4080 * @return pointer to fresh allocated data or NULL otherwise
4082 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4086 * Wrap an existing array as a packet side data.
4089 * @param type side information type
4090 * @param data the side data array. It must be allocated with the av_malloc()
4091 * family of functions. The ownership of the data is transferred to
4093 * @param size side information size
4094 * @return a non-negative number on success, a negative AVERROR code on
4095 * failure. On failure, the packet is unchanged and the data remains
4096 * owned by the caller.
4098 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4099 uint8_t *data, size_t size);
4102 * Shrink the already allocated side data buffer
4105 * @param type side information type
4106 * @param size new side information size
4107 * @return 0 on success, < 0 on failure
4109 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4113 * Get side information from packet.
4116 * @param type desired side information type
4117 * @param size pointer for side information size to store (optional)
4118 * @return pointer to data if present or NULL otherwise
4120 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4123 int av_packet_merge_side_data(AVPacket *pkt);
4125 int av_packet_split_side_data(AVPacket *pkt);
4127 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4130 * Pack a dictionary for use in side_data.
4132 * @param dict The dictionary to pack.
4133 * @param size pointer to store the size of the returned data
4134 * @return pointer to data if successful, NULL otherwise
4136 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4138 * Unpack a dictionary from side_data.
4140 * @param data data from side_data
4141 * @param size size of the data
4142 * @param dict the metadata storage dictionary
4143 * @return 0 on success, < 0 on failure
4145 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4149 * Convenience function to free all the side data stored.
4150 * All the other fields stay untouched.
4154 void av_packet_free_side_data(AVPacket *pkt);
4157 * Setup a new reference to the data described by a given packet
4159 * If src is reference-counted, setup dst as a new reference to the
4160 * buffer in src. Otherwise allocate a new buffer in dst and copy the
4161 * data from src into it.
4163 * All the other fields are copied from src.
4165 * @see av_packet_unref
4167 * @param dst Destination packet
4168 * @param src Source packet
4170 * @return 0 on success, a negative AVERROR on error.
4172 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4177 * Unreference the buffer referenced by the packet and reset the
4178 * remaining packet fields to their default values.
4180 * @param pkt The packet to be unreferenced.
4182 void av_packet_unref(AVPacket *pkt);
4185 * Move every field in src to dst and reset src.
4187 * @see av_packet_unref
4189 * @param src Source packet, will be reset
4190 * @param dst Destination packet
4192 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4195 * Copy only "properties" fields from src to dst.
4197 * Properties for the purpose of this function are all the fields
4198 * beside those related to the packet data (buf, data, size)
4200 * @param dst Destination packet
4201 * @param src Source packet
4203 * @return 0 on success AVERROR on failure.
4205 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4208 * Convert valid timing fields (timestamps / durations) in a packet from one
4209 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4212 * @param pkt packet on which the conversion will be performed
4213 * @param tb_src source timebase, in which the timing fields in pkt are
4215 * @param tb_dst destination timebase, to which the timing fields will be
4218 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4225 * @addtogroup lavc_decoding
4230 * Find a registered decoder with a matching codec ID.
4232 * @param id AVCodecID of the requested decoder
4233 * @return A decoder if one was found, NULL otherwise.
4235 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4238 * Find a registered decoder with the specified name.
4240 * @param name name of the requested decoder
4241 * @return A decoder if one was found, NULL otherwise.
4243 AVCodec *avcodec_find_decoder_by_name(const char *name);
4246 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4247 * it can be called by custom get_buffer2() implementations for decoders without
4248 * AV_CODEC_CAP_DR1 set.
4250 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4254 * Return the amount of padding in pixels which the get_buffer callback must
4255 * provide around the edge of the image for codecs which do not have the
4256 * CODEC_FLAG_EMU_EDGE flag.
4258 * @return Required padding in pixels.
4260 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4263 attribute_deprecated
4264 unsigned avcodec_get_edge_width(void);
4268 * Modify width and height values so that they will result in a memory
4269 * buffer that is acceptable for the codec if you do not use any horizontal
4272 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4274 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4277 * Modify width and height values so that they will result in a memory
4278 * buffer that is acceptable for the codec if you also ensure that all
4279 * line sizes are a multiple of the respective linesize_align[i].
4281 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4283 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4284 int linesize_align[AV_NUM_DATA_POINTERS]);
4287 * Converts AVChromaLocation to swscale x/y chroma position.
4289 * The positions represent the chroma (0,0) position in a coordinates system
4290 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4292 * @param xpos horizontal chroma sample position
4293 * @param ypos vertical chroma sample position
4295 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4298 * Converts swscale x/y chroma position to AVChromaLocation.
4300 * The positions represent the chroma (0,0) position in a coordinates system
4301 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4303 * @param xpos horizontal chroma sample position
4304 * @param ypos vertical chroma sample position
4306 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4309 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4311 * Some decoders may support multiple frames in a single AVPacket. Such
4312 * decoders would then just decode the first frame and the return value would be
4313 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4314 * called again with an AVPacket containing the remaining data in order to
4315 * decode the second frame, etc... Even if no frames are returned, the packet
4316 * needs to be fed to the decoder with remaining data until it is completely
4317 * consumed or an error occurs.
4319 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4320 * and output. This means that for some packets they will not immediately
4321 * produce decoded output and need to be flushed at the end of decoding to get
4322 * all the decoded data. Flushing is done by calling this function with packets
4323 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4324 * returning samples. It is safe to flush even those decoders that are not
4325 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4327 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4328 * larger than the actual read bytes because some optimized bitstream
4329 * readers read 32 or 64 bits at once and could read over the end.
4331 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4332 * before packets may be fed to the decoder.
4334 * @param avctx the codec context
4335 * @param[out] frame The AVFrame in which to store decoded audio samples.
4336 * The decoder will allocate a buffer for the decoded frame by
4337 * calling the AVCodecContext.get_buffer2() callback.
4338 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4339 * reference counted and the returned reference belongs to the
4340 * caller. The caller must release the frame using av_frame_unref()
4341 * when the frame is no longer needed. The caller may safely write
4342 * to the frame if av_frame_is_writable() returns 1.
4343 * When AVCodecContext.refcounted_frames is set to 0, the returned
4344 * reference belongs to the decoder and is valid only until the
4345 * next call to this function or until closing or flushing the
4346 * decoder. The caller may not write to it.
4347 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4348 * non-zero. Note that this field being set to zero
4349 * does not mean that an error has occurred. For
4350 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4351 * call is guaranteed to produce a frame.
4352 * @param[in] avpkt The input AVPacket containing the input buffer.
4353 * At least avpkt->data and avpkt->size should be set. Some
4354 * decoders might also require additional fields to be set.
4355 * @return A negative error code is returned if an error occurred during
4356 * decoding, otherwise the number of bytes consumed from the input
4357 * AVPacket is returned.
4359 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4360 int *got_frame_ptr, const AVPacket *avpkt);
4363 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4364 * Some decoders may support multiple frames in a single AVPacket, such
4365 * decoders would then just decode the first frame.
4367 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4368 * the actual read bytes because some optimized bitstream readers read 32 or 64
4369 * bits at once and could read over the end.
4371 * @warning The end of the input buffer buf should be set to 0 to ensure that
4372 * no overreading happens for damaged MPEG streams.
4374 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4375 * between input and output, these need to be fed with avpkt->data=NULL,
4376 * avpkt->size=0 at the end to return the remaining frames.
4378 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4379 * before packets may be fed to the decoder.
4381 * @param avctx the codec context
4382 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4383 * Use av_frame_alloc() to get an AVFrame. The codec will
4384 * allocate memory for the actual bitmap by calling the
4385 * AVCodecContext.get_buffer2() callback.
4386 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4387 * reference counted and the returned reference belongs to the
4388 * caller. The caller must release the frame using av_frame_unref()
4389 * when the frame is no longer needed. The caller may safely write
4390 * to the frame if av_frame_is_writable() returns 1.
4391 * When AVCodecContext.refcounted_frames is set to 0, the returned
4392 * reference belongs to the decoder and is valid only until the
4393 * next call to this function or until closing or flushing the
4394 * decoder. The caller may not write to it.
4396 * @param[in] avpkt The input AVPacket containing the input buffer.
4397 * You can create such packet with av_init_packet() and by then setting
4398 * data and size, some decoders might in addition need other fields like
4399 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4401 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4402 * @return On error a negative value is returned, otherwise the number of bytes
4403 * used or zero if no frame could be decompressed.
4405 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4406 int *got_picture_ptr,
4407 const AVPacket *avpkt);
4410 * Decode a subtitle message.
4411 * Return a negative value on error, otherwise return the number of bytes used.
4412 * If no subtitle could be decompressed, got_sub_ptr is zero.
4413 * Otherwise, the subtitle is stored in *sub.
4414 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4415 * simplicity, because the performance difference is expect to be negligible
4416 * and reusing a get_buffer written for video codecs would probably perform badly
4417 * due to a potentially very different allocation pattern.
4419 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4420 * and output. This means that for some packets they will not immediately
4421 * produce decoded output and need to be flushed at the end of decoding to get
4422 * all the decoded data. Flushing is done by calling this function with packets
4423 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4424 * returning subtitles. It is safe to flush even those decoders that are not
4425 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4427 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4428 * before packets may be fed to the decoder.
4430 * @param avctx the codec context
4431 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4432 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4433 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4434 * @param[in] avpkt The input AVPacket containing the input buffer.
4436 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4441 * @defgroup lavc_parsing Frame parsing
4445 enum AVPictureStructure {
4446 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4447 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4448 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4449 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4452 typedef struct AVCodecParserContext {
4454 struct AVCodecParser *parser;
4455 int64_t frame_offset; /* offset of the current frame */
4456 int64_t cur_offset; /* current offset
4457 (incremented by each av_parser_parse()) */
4458 int64_t next_frame_offset; /* offset of the next frame */
4460 int pict_type; /* XXX: Put it back in AVCodecContext. */
4462 * This field is used for proper frame duration computation in lavf.
4463 * It signals, how much longer the frame duration of the current frame
4464 * is compared to normal frame duration.
4466 * frame_duration = (1 + repeat_pict) * time_base
4468 * It is used by codecs like H.264 to display telecined material.
4470 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4471 int64_t pts; /* pts of the current frame */
4472 int64_t dts; /* dts of the current frame */
4477 int fetch_timestamp;
4479 #define AV_PARSER_PTS_NB 4
4480 int cur_frame_start_index;
4481 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4482 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4483 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4486 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4487 #define PARSER_FLAG_ONCE 0x0002
4488 /// Set if the parser has a valid file offset
4489 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4490 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4492 int64_t offset; ///< byte offset from starting packet start
4493 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4496 * Set by parser to 1 for key frames and 0 for non-key frames.
4497 * It is initialized to -1, so if the parser doesn't set this flag,
4498 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4503 #if FF_API_CONVERGENCE_DURATION
4505 * @deprecated unused
4507 attribute_deprecated
4508 int64_t convergence_duration;
4511 // Timestamp generation support:
4513 * Synchronization point for start of timestamp generation.
4515 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4518 * For example, this corresponds to presence of H.264 buffering period
4524 * Offset of the current timestamp against last timestamp sync point in
4525 * units of AVCodecContext.time_base.
4527 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4528 * contain a valid timestamp offset.
4530 * Note that the timestamp of sync point has usually a nonzero
4531 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4532 * the next frame after timestamp sync point will be usually 1.
4534 * For example, this corresponds to H.264 cpb_removal_delay.
4536 int dts_ref_dts_delta;
4539 * Presentation delay of current frame in units of AVCodecContext.time_base.
4541 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4542 * contain valid non-negative timestamp delta (presentation time of a frame
4543 * must not lie in the past).
4545 * This delay represents the difference between decoding and presentation
4546 * time of the frame.
4548 * For example, this corresponds to H.264 dpb_output_delay.
4553 * Position of the packet in file.
4555 * Analogous to cur_frame_pts/dts
4557 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4560 * Byte position of currently parsed frame in stream.
4565 * Previous frame byte position.
4570 * Duration of the current frame.
4571 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4572 * For all other types, this is in units of AVCodecContext.time_base.
4576 enum AVFieldOrder field_order;
4579 * Indicate whether a picture is coded as a frame, top field or bottom field.
4581 * For example, H.264 field_pic_flag equal to 0 corresponds to
4582 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4583 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4584 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4586 enum AVPictureStructure picture_structure;
4589 * Picture number incremented in presentation or output order.
4590 * This field may be reinitialized at the first picture of a new sequence.
4592 * For example, this corresponds to H.264 PicOrderCnt.
4594 int output_picture_number;
4597 * Dimensions of the decoded video intended for presentation.
4603 * Dimensions of the coded video.
4609 * The format of the coded data, corresponds to enum AVPixelFormat for video
4610 * and for enum AVSampleFormat for audio.
4612 * Note that a decoder can have considerable freedom in how exactly it
4613 * decodes the data, so the format reported here might be different from the
4614 * one returned by a decoder.
4617 } AVCodecParserContext;
4619 typedef struct AVCodecParser {
4620 int codec_ids[5]; /* several codec IDs are permitted */
4622 int (*parser_init)(AVCodecParserContext *s);
4623 /* This callback never returns an error, a negative value means that
4624 * the frame start was in a previous packet. */
4625 int (*parser_parse)(AVCodecParserContext *s,
4626 AVCodecContext *avctx,
4627 const uint8_t **poutbuf, int *poutbuf_size,
4628 const uint8_t *buf, int buf_size);
4629 void (*parser_close)(AVCodecParserContext *s);
4630 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4631 struct AVCodecParser *next;
4634 AVCodecParser *av_parser_next(const AVCodecParser *c);
4636 void av_register_codec_parser(AVCodecParser *parser);
4637 AVCodecParserContext *av_parser_init(int codec_id);
4642 * @param s parser context.
4643 * @param avctx codec context.
4644 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4645 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4646 * @param buf input buffer.
4647 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4648 * @param pts input presentation timestamp.
4649 * @param dts input decoding timestamp.
4650 * @param pos input byte position in stream.
4651 * @return the number of bytes of the input bitstream used.
4656 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4663 * decode_frame(data, size);
4667 int av_parser_parse2(AVCodecParserContext *s,
4668 AVCodecContext *avctx,
4669 uint8_t **poutbuf, int *poutbuf_size,
4670 const uint8_t *buf, int buf_size,
4671 int64_t pts, int64_t dts,
4675 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4676 * @deprecated use AVBitStreamFilter
4678 int av_parser_change(AVCodecParserContext *s,
4679 AVCodecContext *avctx,
4680 uint8_t **poutbuf, int *poutbuf_size,
4681 const uint8_t *buf, int buf_size, int keyframe);
4682 void av_parser_close(AVCodecParserContext *s);
4690 * @addtogroup lavc_encoding
4695 * Find a registered encoder with a matching codec ID.
4697 * @param id AVCodecID of the requested encoder
4698 * @return An encoder if one was found, NULL otherwise.
4700 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4703 * Find a registered encoder with the specified name.
4705 * @param name name of the requested encoder
4706 * @return An encoder if one was found, NULL otherwise.
4708 AVCodec *avcodec_find_encoder_by_name(const char *name);
4711 * Encode a frame of audio.
4713 * Takes input samples from frame and writes the next output packet, if
4714 * available, to avpkt. The output packet does not necessarily contain data for
4715 * the most recent frame, as encoders can delay, split, and combine input frames
4716 * internally as needed.
4718 * @param avctx codec context
4719 * @param avpkt output AVPacket.
4720 * The user can supply an output buffer by setting
4721 * avpkt->data and avpkt->size prior to calling the
4722 * function, but if the size of the user-provided data is not
4723 * large enough, encoding will fail. If avpkt->data and
4724 * avpkt->size are set, avpkt->destruct must also be set. All
4725 * other AVPacket fields will be reset by the encoder using
4726 * av_init_packet(). If avpkt->data is NULL, the encoder will
4727 * allocate it. The encoder will set avpkt->size to the size
4728 * of the output packet.
4730 * If this function fails or produces no output, avpkt will be
4731 * freed using av_packet_unref().
4732 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4733 * May be NULL when flushing an encoder that has the
4734 * AV_CODEC_CAP_DELAY capability set.
4735 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4736 * can have any number of samples.
4737 * If it is not set, frame->nb_samples must be equal to
4738 * avctx->frame_size for all frames except the last.
4739 * The final frame may be smaller than avctx->frame_size.
4740 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4741 * output packet is non-empty, and to 0 if it is
4742 * empty. If the function returns an error, the
4743 * packet can be assumed to be invalid, and the
4744 * value of got_packet_ptr is undefined and should
4746 * @return 0 on success, negative error code on failure
4748 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4749 const AVFrame *frame, int *got_packet_ptr);
4752 * Encode a frame of video.
4754 * Takes input raw video data from frame and writes the next output packet, if
4755 * available, to avpkt. The output packet does not necessarily contain data for
4756 * the most recent frame, as encoders can delay and reorder input frames
4757 * internally as needed.
4759 * @param avctx codec context
4760 * @param avpkt output AVPacket.
4761 * The user can supply an output buffer by setting
4762 * avpkt->data and avpkt->size prior to calling the
4763 * function, but if the size of the user-provided data is not
4764 * large enough, encoding will fail. All other AVPacket fields
4765 * will be reset by the encoder using av_init_packet(). If
4766 * avpkt->data is NULL, the encoder will allocate it.
4767 * The encoder will set avpkt->size to the size of the
4768 * output packet. The returned data (if any) belongs to the
4769 * caller, he is responsible for freeing it.
4771 * If this function fails or produces no output, avpkt will be
4772 * freed using av_packet_unref().
4773 * @param[in] frame AVFrame containing the raw video data to be encoded.
4774 * May be NULL when flushing an encoder that has the
4775 * AV_CODEC_CAP_DELAY capability set.
4776 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4777 * output packet is non-empty, and to 0 if it is
4778 * empty. If the function returns an error, the
4779 * packet can be assumed to be invalid, and the
4780 * value of got_packet_ptr is undefined and should
4782 * @return 0 on success, negative error code on failure
4784 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4785 const AVFrame *frame, int *got_packet_ptr);
4787 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4788 const AVSubtitle *sub);
4795 #if FF_API_AVCODEC_RESAMPLE
4797 * @defgroup lavc_resample Audio resampling
4799 * @deprecated use libswresample instead
4803 struct ReSampleContext;
4804 struct AVResampleContext;
4806 typedef struct ReSampleContext ReSampleContext;
4809 * Initialize audio resampling context.
4811 * @param output_channels number of output channels
4812 * @param input_channels number of input channels
4813 * @param output_rate output sample rate
4814 * @param input_rate input sample rate
4815 * @param sample_fmt_out requested output sample format
4816 * @param sample_fmt_in input sample format
4817 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4818 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4819 * @param linear if 1 then the used FIR filter will be linearly interpolated
4820 between the 2 closest, if 0 the closest will be used
4821 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4822 * @return allocated ReSampleContext, NULL if error occurred
4824 attribute_deprecated
4825 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4826 int output_rate, int input_rate,
4827 enum AVSampleFormat sample_fmt_out,
4828 enum AVSampleFormat sample_fmt_in,
4829 int filter_length, int log2_phase_count,
4830 int linear, double cutoff);
4832 attribute_deprecated
4833 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4836 * Free resample context.
4838 * @param s a non-NULL pointer to a resample context previously
4839 * created with av_audio_resample_init()
4841 attribute_deprecated
4842 void audio_resample_close(ReSampleContext *s);
4846 * Initialize an audio resampler.
4847 * Note, if either rate is not an integer then simply scale both rates up so they are.
4848 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4849 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4850 * @param linear If 1 then the used FIR filter will be linearly interpolated
4851 between the 2 closest, if 0 the closest will be used
4852 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4854 attribute_deprecated
4855 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4858 * Resample an array of samples using a previously configured context.
4859 * @param src an array of unconsumed samples
4860 * @param consumed the number of samples of src which have been consumed are returned here
4861 * @param src_size the number of unconsumed samples available
4862 * @param dst_size the amount of space in samples available in dst
4863 * @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.
4864 * @return the number of samples written in dst or -1 if an error occurred
4866 attribute_deprecated
4867 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4871 * Compensate samplerate/timestamp drift. The compensation is done by changing
4872 * the resampler parameters, so no audible clicks or similar distortions occur
4873 * @param compensation_distance distance in output samples over which the compensation should be performed
4874 * @param sample_delta number of output samples which should be output less
4876 * example: av_resample_compensate(c, 10, 500)
4877 * here instead of 510 samples only 500 samples would be output
4879 * note, due to rounding the actual compensation might be slightly different,
4880 * especially if the compensation_distance is large and the in_rate used during init is small
4882 attribute_deprecated
4883 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4884 attribute_deprecated
4885 void av_resample_close(struct AVResampleContext *c);
4892 #if FF_API_AVPICTURE
4894 * @addtogroup lavc_picture
4899 * @deprecated unused
4901 attribute_deprecated
4902 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4905 * @deprecated unused
4907 attribute_deprecated
4908 void avpicture_free(AVPicture *picture);
4911 * @deprecated use av_image_fill_arrays() instead.
4913 attribute_deprecated
4914 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4915 enum AVPixelFormat pix_fmt, int width, int height);
4918 * @deprecated use av_image_copy_to_buffer() instead.
4920 attribute_deprecated
4921 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4922 int width, int height,
4923 unsigned char *dest, int dest_size);
4926 * @deprecated use av_image_get_buffer_size() instead.
4928 attribute_deprecated
4929 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4932 * @deprecated av_image_copy() instead.
4934 attribute_deprecated
4935 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4936 enum AVPixelFormat pix_fmt, int width, int height);
4939 * @deprecated unused
4941 attribute_deprecated
4942 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4943 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4946 * @deprecated unused
4948 attribute_deprecated
4949 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4950 int padtop, int padbottom, int padleft, int padright, int *color);
4958 * @defgroup lavc_misc Utility functions
4961 * Miscellaneous utility functions related to both encoding and decoding
4967 * @defgroup lavc_misc_pixfmt Pixel formats
4969 * Functions for working with pixel formats.
4974 * Utility function to access log2_chroma_w log2_chroma_h from
4975 * the pixel format AVPixFmtDescriptor.
4977 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4978 * for one that returns a failure code and continues in case of invalid
4981 * @param[in] pix_fmt the pixel format
4982 * @param[out] h_shift store log2_chroma_w
4983 * @param[out] v_shift store log2_chroma_h
4985 * @see av_pix_fmt_get_chroma_sub_sample
4988 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4991 * Return a value representing the fourCC code associated to the
4992 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4995 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4998 * @deprecated see av_get_pix_fmt_loss()
5000 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5004 * Find the best pixel format to convert to given a certain source pixel
5005 * format. When converting from one pixel format to another, information loss
5006 * may occur. For example, when converting from RGB24 to GRAY, the color
5007 * information will be lost. Similarly, other losses occur when converting from
5008 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5009 * the given pixel formats should be used to suffer the least amount of loss.
5010 * The pixel formats from which it chooses one, are determined by the
5011 * pix_fmt_list parameter.
5014 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5015 * @param[in] src_pix_fmt source pixel format
5016 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5017 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5018 * @return The best pixel format to convert to or -1 if none was found.
5020 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5021 enum AVPixelFormat src_pix_fmt,
5022 int has_alpha, int *loss_ptr);
5025 * @deprecated see av_find_best_pix_fmt_of_2()
5027 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5028 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5030 attribute_deprecated
5031 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
5032 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
5033 enum AVPixelFormat src_pix_fmt,
5034 int has_alpha, int *loss_ptr);
5036 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5037 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5041 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5047 #if FF_API_SET_DIMENSIONS
5049 * @deprecated this function is not supposed to be used from outside of lavc
5051 attribute_deprecated
5052 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5056 * Put a string representing the codec tag codec_tag in buf.
5058 * @param buf buffer to place codec tag in
5059 * @param buf_size size in bytes of buf
5060 * @param codec_tag codec tag to assign
5061 * @return the length of the string that would have been generated if
5062 * enough space had been available, excluding the trailing null
5064 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5066 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5069 * Return a name for the specified profile, if available.
5071 * @param codec the codec that is searched for the given profile
5072 * @param profile the profile value for which a name is requested
5073 * @return A name for the profile if found, NULL otherwise.
5075 const char *av_get_profile_name(const AVCodec *codec, int profile);
5078 * Return a name for the specified profile, if available.
5080 * @param codec_id the ID of the codec to which the requested profile belongs
5081 * @param profile the profile value for which a name is requested
5082 * @return A name for the profile if found, NULL otherwise.
5084 * @note unlike av_get_profile_name(), which searches a list of profiles
5085 * supported by a specific decoder or encoder implementation, this
5086 * function searches the list of profiles from the AVCodecDescriptor
5088 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5090 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5091 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5092 //FIXME func typedef
5095 * Fill AVFrame audio data and linesize pointers.
5097 * The buffer buf must be a preallocated buffer with a size big enough
5098 * to contain the specified samples amount. The filled AVFrame data
5099 * pointers will point to this buffer.
5101 * AVFrame extended_data channel pointers are allocated if necessary for
5104 * @param frame the AVFrame
5105 * frame->nb_samples must be set prior to calling the
5106 * function. This function fills in frame->data,
5107 * frame->extended_data, frame->linesize[0].
5108 * @param nb_channels channel count
5109 * @param sample_fmt sample format
5110 * @param buf buffer to use for frame data
5111 * @param buf_size size of buffer
5112 * @param align plane size sample alignment (0 = default)
5113 * @return >=0 on success, negative error code on failure
5114 * @todo return the size in bytes required to store the samples in
5115 * case of success, at the next libavutil bump
5117 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5118 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5119 int buf_size, int align);
5122 * Reset the internal decoder state / flush internal buffers. Should be called
5123 * e.g. when seeking or when switching to a different stream.
5125 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5126 * this invalidates the frames previously returned from the decoder. When
5127 * refcounted frames are used, the decoder just releases any references it might
5128 * keep internally, but the caller's reference remains valid.
5130 void avcodec_flush_buffers(AVCodecContext *avctx);
5133 * Return codec bits per sample.
5135 * @param[in] codec_id the codec
5136 * @return Number of bits per sample or zero if unknown for the given codec.
5138 int av_get_bits_per_sample(enum AVCodecID codec_id);
5141 * Return the PCM codec associated with a sample format.
5142 * @param be endianness, 0 for little, 1 for big,
5143 * -1 (or anything else) for native
5144 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5146 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5149 * Return codec bits per sample.
5150 * Only return non-zero if the bits per sample is exactly correct, not an
5153 * @param[in] codec_id the codec
5154 * @return Number of bits per sample or zero if unknown for the given codec.
5156 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5159 * Return audio frame duration.
5161 * @param avctx codec context
5162 * @param frame_bytes size of the frame, or 0 if unknown
5163 * @return frame duration, in samples, if known. 0 if not able to
5166 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5169 typedef struct AVBitStreamFilterContext {
5171 struct AVBitStreamFilter *filter;
5172 AVCodecParserContext *parser;
5173 struct AVBitStreamFilterContext *next;
5175 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5176 * Not for access by library users.
5179 } AVBitStreamFilterContext;
5182 typedef struct AVBitStreamFilter {
5185 int (*filter)(AVBitStreamFilterContext *bsfc,
5186 AVCodecContext *avctx, const char *args,
5187 uint8_t **poutbuf, int *poutbuf_size,
5188 const uint8_t *buf, int buf_size, int keyframe);
5189 void (*close)(AVBitStreamFilterContext *bsfc);
5190 struct AVBitStreamFilter *next;
5191 } AVBitStreamFilter;
5194 * Register a bitstream filter.
5196 * The filter will be accessible to the application code through
5197 * av_bitstream_filter_next() or can be directly initialized with
5198 * av_bitstream_filter_init().
5200 * @see avcodec_register_all()
5202 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5205 * Create and initialize a bitstream filter context given a bitstream
5208 * The returned context must be freed with av_bitstream_filter_close().
5210 * @param name the name of the bitstream filter
5211 * @return a bitstream filter context if a matching filter was found
5212 * and successfully initialized, NULL otherwise
5214 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5219 * This function filters the buffer buf with size buf_size, and places the
5220 * filtered buffer in the buffer pointed to by poutbuf.
5222 * The output buffer must be freed by the caller.
5224 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5225 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5226 * If specified, this must point to the encoder context of the
5227 * output stream the packet is sent to.
5228 * @param args arguments which specify the filter configuration, may be NULL
5229 * @param poutbuf pointer which is updated to point to the filtered buffer
5230 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5231 * @param buf buffer containing the data to filter
5232 * @param buf_size size in bytes of buf
5233 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5234 * @return >= 0 in case of success, or a negative error code in case of failure
5236 * If the return value is positive, an output buffer is allocated and
5237 * is available in *poutbuf, and is distinct from the input buffer.
5239 * If the return value is 0, the output buffer is not allocated and
5240 * should be considered identical to the input buffer, or in case
5241 * *poutbuf was set it points to the input buffer (not necessarily to
5242 * its starting address).
5244 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5245 AVCodecContext *avctx, const char *args,
5246 uint8_t **poutbuf, int *poutbuf_size,
5247 const uint8_t *buf, int buf_size, int keyframe);
5250 * Release bitstream filter context.
5252 * @param bsf the bitstream filter context created with
5253 * av_bitstream_filter_init(), can be NULL
5255 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5258 * If f is NULL, return the first registered bitstream filter,
5259 * if f is non-NULL, return the next registered bitstream filter
5260 * after f, or NULL if f is the last one.
5262 * This function can be used to iterate over all registered bitstream
5265 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5270 * Same behaviour av_fast_malloc but the buffer has additional
5271 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5273 * In addition the whole buffer will initially and after resizes
5274 * be 0-initialized so that no uninitialized data will ever appear.
5276 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5279 * Same behaviour av_fast_padded_malloc except that buffer will always
5280 * be 0-initialized after call.
5282 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5285 * Encode extradata length to a buffer. Used by xiph codecs.
5287 * @param s buffer to write to; must be at least (v/255+1) bytes long
5288 * @param v size of extradata in bytes
5289 * @return number of bytes written to the buffer.
5291 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5293 #if FF_API_MISSING_SAMPLE
5295 * Log a generic warning message about a missing feature. This function is
5296 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5297 * only, and would normally not be used by applications.
5298 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5299 * a pointer to an AVClass struct
5300 * @param[in] feature string containing the name of the missing feature
5301 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5302 * If want_sample is non-zero, additional verbage will be added to the log
5303 * message which tells the user how to report samples to the development
5305 * @deprecated Use avpriv_report_missing_feature() instead.
5307 attribute_deprecated
5308 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5311 * Log a generic warning message asking for a sample. This function is
5312 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5313 * only, and would normally not be used by applications.
5314 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5315 * a pointer to an AVClass struct
5316 * @param[in] msg string containing an optional message, or NULL if no message
5317 * @deprecated Use avpriv_request_sample() instead.
5319 attribute_deprecated
5320 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5321 #endif /* FF_API_MISSING_SAMPLE */
5324 * Register the hardware accelerator hwaccel.
5326 void av_register_hwaccel(AVHWAccel *hwaccel);
5329 * If hwaccel is NULL, returns the first registered hardware accelerator,
5330 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5331 * after hwaccel, or NULL if hwaccel is the last one.
5333 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5337 * Lock operation used by lockmgr
5340 AV_LOCK_CREATE, ///< Create a mutex
5341 AV_LOCK_OBTAIN, ///< Lock the mutex
5342 AV_LOCK_RELEASE, ///< Unlock the mutex
5343 AV_LOCK_DESTROY, ///< Free mutex resources
5347 * Register a user provided lock manager supporting the operations
5348 * specified by AVLockOp. The "mutex" argument to the function points
5349 * to a (void *) where the lockmgr should store/get a pointer to a user
5350 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5351 * value left by the last call for all other ops. If the lock manager is
5352 * unable to perform the op then it should leave the mutex in the same
5353 * state as when it was called and return a non-zero value. However,
5354 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5355 * have been successfully destroyed. If av_lockmgr_register succeeds
5356 * it will return a non-negative value, if it fails it will return a
5357 * negative value and destroy all mutex and unregister all callbacks.
5358 * av_lockmgr_register is not thread-safe, it must be called from a
5359 * single thread before any calls which make use of locking are used.
5361 * @param cb User defined callback. av_lockmgr_register invokes calls
5362 * to this callback and the previously registered callback.
5363 * The callback will be used to create more than one mutex
5364 * each of which must be backed by its own underlying locking
5365 * mechanism (i.e. do not use a single static object to
5366 * implement your lock manager). If cb is set to NULL the
5367 * lockmgr will be unregistered.
5369 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5372 * Get the type of the given codec.
5374 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5377 * Get the name of a codec.
5378 * @return a static string identifying the codec; never NULL
5380 const char *avcodec_get_name(enum AVCodecID id);
5383 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5384 * with no corresponding avcodec_close()), 0 otherwise.
5386 int avcodec_is_open(AVCodecContext *s);
5389 * @return a non-zero number if codec is an encoder, zero otherwise
5391 int av_codec_is_encoder(const AVCodec *codec);
5394 * @return a non-zero number if codec is a decoder, zero otherwise
5396 int av_codec_is_decoder(const AVCodec *codec);
5399 * @return descriptor for given codec ID or NULL if no descriptor exists.
5401 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5404 * Iterate over all codec descriptors known to libavcodec.
5406 * @param prev previous descriptor. NULL to get the first descriptor.
5408 * @return next descriptor or NULL after the last descriptor
5410 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5413 * @return codec descriptor with the given name or NULL if no such descriptor
5416 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5419 * Allocate a CPB properties structure and initialize its fields to default
5422 * @param size if non-NULL, the size of the allocated struct will be written
5423 * here. This is useful for embedding it in side data.
5425 * @return the newly allocated struct or NULL on failure
5427 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
5433 #endif /* AVCODEC_AVCODEC_H */