2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/log.h"
40 #include "libavutil/pixfmt.h"
41 #include "libavutil/rational.h"
46 * @defgroup libavc Encoding/Decoding Library
49 * @defgroup lavc_decoding Decoding
53 * @defgroup lavc_encoding Encoding
57 * @defgroup lavc_codec Codecs
59 * @defgroup lavc_codec_native Native Codecs
62 * @defgroup lavc_codec_wrappers External library wrappers
65 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
69 * @defgroup lavc_internal Internal
77 * @defgroup lavc_core Core functions/structures.
80 * Basic definitions, functions for querying libavcodec capabilities,
81 * allocating core structures, etc.
87 * Identify the syntax and semantics of the bitstream.
88 * The principle is roughly:
89 * Two decoders with the same ID can decode the same streams.
90 * Two encoders with the same ID can encode compatible streams.
91 * There may be slight deviations from the principle due to implementation
94 * If you add a codec ID to this list, add it so that
95 * 1. no value of a existing codec ID changes (that would break ABI),
96 * 2. it is as close as possible to similar codecs
98 * After adding new codec IDs, do not forget to add an entry to the codec
99 * descriptor list and bump libavcodec minor version.
105 AV_CODEC_ID_MPEG1VIDEO,
106 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
108 AV_CODEC_ID_MPEG2VIDEO_XVMC,
109 #endif /* FF_API_XVMC */
120 AV_CODEC_ID_RAWVIDEO,
121 AV_CODEC_ID_MSMPEG4V1,
122 AV_CODEC_ID_MSMPEG4V2,
123 AV_CODEC_ID_MSMPEG4V3,
146 AV_CODEC_ID_INTERPLAY_VIDEO,
153 AV_CODEC_ID_MSVIDEO1,
158 AV_CODEC_ID_TRUEMOTION1,
159 AV_CODEC_ID_VMDVIDEO,
184 AV_CODEC_ID_TRUEMOTION2,
190 AV_CODEC_ID_SMACKVIDEO,
195 AV_CODEC_ID_JPEG2000,
201 AV_CODEC_ID_DSICINVIDEO,
202 AV_CODEC_ID_TIERTEXSEQVIDEO,
210 AV_CODEC_ID_BETHSOFTVID,
222 AV_CODEC_ID_ESCAPE124,
226 AV_CODEC_ID_MOTIONPIXELS,
238 AV_CODEC_ID_FLASHSV2,
239 AV_CODEC_ID_CDGRAPHICS,
242 AV_CODEC_ID_BINKVIDEO,
243 AV_CODEC_ID_IFF_ILBM,
244 AV_CODEC_ID_IFF_BYTERUN1,
250 AV_CODEC_ID_A64_MULTI,
251 AV_CODEC_ID_A64_MULTI5,
254 AV_CODEC_ID_LAGARITH,
258 AV_CODEC_ID_WMV3IMAGE,
259 AV_CODEC_ID_VC1IMAGE,
261 AV_CODEC_ID_BMV_VIDEO,
268 AV_CODEC_ID_ZEROCODEC,
277 AV_CODEC_ID_ESCAPE130,
280 AV_CODEC_ID_HNM4_VIDEO,
282 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
284 AV_CODEC_ID_ALIAS_PIX,
285 AV_CODEC_ID_BRENDER_PIX,
286 AV_CODEC_ID_PAF_VIDEO,
300 AV_CODEC_ID_Y41P = 0x8000,
305 AV_CODEC_ID_TARGA_Y216,
316 /* various PCM "codecs" */
317 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
318 AV_CODEC_ID_PCM_S16LE = 0x10000,
319 AV_CODEC_ID_PCM_S16BE,
320 AV_CODEC_ID_PCM_U16LE,
321 AV_CODEC_ID_PCM_U16BE,
324 AV_CODEC_ID_PCM_MULAW,
325 AV_CODEC_ID_PCM_ALAW,
326 AV_CODEC_ID_PCM_S32LE,
327 AV_CODEC_ID_PCM_S32BE,
328 AV_CODEC_ID_PCM_U32LE,
329 AV_CODEC_ID_PCM_U32BE,
330 AV_CODEC_ID_PCM_S24LE,
331 AV_CODEC_ID_PCM_S24BE,
332 AV_CODEC_ID_PCM_U24LE,
333 AV_CODEC_ID_PCM_U24BE,
334 AV_CODEC_ID_PCM_S24DAUD,
335 AV_CODEC_ID_PCM_ZORK,
336 AV_CODEC_ID_PCM_S16LE_PLANAR,
338 AV_CODEC_ID_PCM_F32BE,
339 AV_CODEC_ID_PCM_F32LE,
340 AV_CODEC_ID_PCM_F64BE,
341 AV_CODEC_ID_PCM_F64LE,
342 AV_CODEC_ID_PCM_BLURAY,
345 AV_CODEC_ID_PCM_S8_PLANAR,
346 AV_CODEC_ID_PCM_S24LE_PLANAR,
347 AV_CODEC_ID_PCM_S32LE_PLANAR,
348 AV_CODEC_ID_PCM_S16BE_PLANAR,
349 /* new PCM "codecs" should be added right below this line starting with
350 * an explicit value of for example 0x10800
353 /* various ADPCM codecs */
354 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
355 AV_CODEC_ID_ADPCM_IMA_WAV,
356 AV_CODEC_ID_ADPCM_IMA_DK3,
357 AV_CODEC_ID_ADPCM_IMA_DK4,
358 AV_CODEC_ID_ADPCM_IMA_WS,
359 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
360 AV_CODEC_ID_ADPCM_MS,
361 AV_CODEC_ID_ADPCM_4XM,
362 AV_CODEC_ID_ADPCM_XA,
363 AV_CODEC_ID_ADPCM_ADX,
364 AV_CODEC_ID_ADPCM_EA,
365 AV_CODEC_ID_ADPCM_G726,
366 AV_CODEC_ID_ADPCM_CT,
367 AV_CODEC_ID_ADPCM_SWF,
368 AV_CODEC_ID_ADPCM_YAMAHA,
369 AV_CODEC_ID_ADPCM_SBPRO_4,
370 AV_CODEC_ID_ADPCM_SBPRO_3,
371 AV_CODEC_ID_ADPCM_SBPRO_2,
372 AV_CODEC_ID_ADPCM_THP,
373 AV_CODEC_ID_ADPCM_IMA_AMV,
374 AV_CODEC_ID_ADPCM_EA_R1,
375 AV_CODEC_ID_ADPCM_EA_R3,
376 AV_CODEC_ID_ADPCM_EA_R2,
377 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
378 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
379 AV_CODEC_ID_ADPCM_EA_XAS,
380 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
381 AV_CODEC_ID_ADPCM_IMA_ISS,
382 AV_CODEC_ID_ADPCM_G722,
383 AV_CODEC_ID_ADPCM_IMA_APC,
384 AV_CODEC_ID_ADPCM_VIMA,
385 #if FF_API_VIMA_DECODER
386 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
389 AV_CODEC_ID_ADPCM_AFC = 0x11800,
390 AV_CODEC_ID_ADPCM_IMA_OKI,
391 AV_CODEC_ID_ADPCM_DTK,
392 AV_CODEC_ID_ADPCM_IMA_RAD,
393 AV_CODEC_ID_ADPCM_G726LE,
394 AV_CODEC_ID_ADPCM_THP_LE,
397 AV_CODEC_ID_AMR_NB = 0x12000,
400 /* RealAudio codecs*/
401 AV_CODEC_ID_RA_144 = 0x13000,
404 /* various DPCM codecs */
405 AV_CODEC_ID_ROQ_DPCM = 0x14000,
406 AV_CODEC_ID_INTERPLAY_DPCM,
407 AV_CODEC_ID_XAN_DPCM,
408 AV_CODEC_ID_SOL_DPCM,
411 AV_CODEC_ID_MP2 = 0x15000,
412 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
422 AV_CODEC_ID_VMDAUDIO,
428 AV_CODEC_ID_WESTWOOD_SND1,
429 AV_CODEC_ID_GSM, ///< as in Berlin toast format
432 AV_CODEC_ID_TRUESPEECH,
434 AV_CODEC_ID_SMACKAUDIO,
437 AV_CODEC_ID_DSICINAUDIO,
439 AV_CODEC_ID_MUSEPACK7,
441 AV_CODEC_ID_GSM_MS, /* as found in WAV */
447 AV_CODEC_ID_NELLYMOSER,
448 AV_CODEC_ID_MUSEPACK8,
450 AV_CODEC_ID_WMAVOICE,
452 AV_CODEC_ID_WMALOSSLESS,
461 AV_CODEC_ID_BINKAUDIO_RDFT,
462 AV_CODEC_ID_BINKAUDIO_DCT,
463 AV_CODEC_ID_AAC_LATM,
468 AV_CODEC_ID_8SVX_EXP,
469 AV_CODEC_ID_8SVX_FIB,
470 AV_CODEC_ID_BMV_AUDIO,
475 AV_CODEC_ID_COMFORT_NOISE,
477 AV_CODEC_ID_METASOUND,
478 AV_CODEC_ID_PAF_AUDIO,
482 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
484 AV_CODEC_ID_SONIC_LS,
487 AV_CODEC_ID_DSD_LSBF,
488 AV_CODEC_ID_DSD_MSBF,
489 AV_CODEC_ID_DSD_LSBF_PLANAR,
490 AV_CODEC_ID_DSD_MSBF_PLANAR,
493 /* subtitle codecs */
494 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
495 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
496 AV_CODEC_ID_DVB_SUBTITLE,
497 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
500 AV_CODEC_ID_MOV_TEXT,
501 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
502 AV_CODEC_ID_DVB_TELETEXT,
505 AV_CODEC_ID_MICRODVD = 0x17800,
509 AV_CODEC_ID_REALTEXT,
511 AV_CODEC_ID_SUBVIEWER1,
512 AV_CODEC_ID_SUBVIEWER,
519 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
521 /* other specific kind of codecs (generally used for attachments) */
522 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
523 AV_CODEC_ID_TTF = 0x18000,
525 AV_CODEC_ID_BINTEXT = 0x18800,
529 AV_CODEC_ID_SMPTE_KLV,
531 AV_CODEC_ID_TIMED_ID3,
532 AV_CODEC_ID_BIN_DATA,
535 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
537 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
538 * stream (only used by libavformat) */
539 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
540 * stream (only used by libavformat) */
541 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
545 * This struct describes the properties of a single codec described by an
547 * @see avcodec_descriptor_get()
549 typedef struct AVCodecDescriptor {
551 enum AVMediaType type;
553 * Name of the codec described by this descriptor. It is non-empty and
554 * unique for each codec descriptor. It should contain alphanumeric
555 * characters and '_' only.
559 * A more descriptive name for this codec. May be NULL.
561 const char *long_name;
563 * Codec properties, a combination of AV_CODEC_PROP_* flags.
568 * MIME type(s) associated with the codec.
569 * May be NULL; if not, a NULL-terminated array of MIME types.
570 * The first item is always non-NULL and is the preferred MIME type.
572 const char *const *mime_types;
576 * Codec uses only intra compression.
579 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
581 * Codec supports lossy compression. Audio and video codecs only.
582 * @note a codec may support both lossy and lossless
585 #define AV_CODEC_PROP_LOSSY (1 << 1)
587 * Codec supports lossless compression. Audio and video codecs only.
589 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
591 * Codec supports frame reordering. That is, the coded order (the order in which
592 * the encoded packets are output by the encoders / stored / input to the
593 * decoders) may be different from the presentation order of the corresponding
596 * For codecs that do not have this property set, PTS and DTS should always be
599 #define AV_CODEC_PROP_REORDER (1 << 3)
601 * Subtitle codec is bitmap based
602 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
604 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
606 * Subtitle codec is text based.
607 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
609 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
612 * @ingroup lavc_decoding
613 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
614 * This is mainly needed because some optimized bitstream readers read
615 * 32 or 64 bit at once and could read over the end.<br>
616 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
617 * MPEG bitstreams could cause overread and segfault.
619 #define AV_INPUT_BUFFER_PADDING_SIZE 32
622 * @ingroup lavc_encoding
623 * minimum encoding buffer size
624 * Used to avoid some checks during header writing.
626 #define AV_INPUT_BUFFER_MIN_SIZE 16384
628 #if FF_API_WITHOUT_PREFIX
630 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
632 #define FF_INPUT_BUFFER_PADDING_SIZE 32
635 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
637 #define FF_MIN_BUFFER_SIZE 16384
638 #endif /* FF_API_WITHOUT_PREFIX */
641 * @ingroup lavc_encoding
642 * motion estimation type.
643 * @deprecated use codec private option instead
645 #if FF_API_MOTION_EST
647 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
651 ME_EPZS, ///< enhanced predictive zonal search
652 ME_X1, ///< reserved for experiments
653 ME_HEX, ///< hexagon based search
654 ME_UMH, ///< uneven multi-hexagon search
655 ME_TESA, ///< transformed exhaustive search algorithm
656 ME_ITER=50, ///< iterative search
661 * @ingroup lavc_decoding
664 /* We leave some space between them for extensions (drop some
665 * keyframes for intra-only or drop just some bidir frames). */
666 AVDISCARD_NONE =-16, ///< discard nothing
667 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
668 AVDISCARD_NONREF = 8, ///< discard all non reference
669 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
670 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
671 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
672 AVDISCARD_ALL = 48, ///< discard all
675 enum AVAudioServiceType {
676 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
677 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
678 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
679 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
680 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
681 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
682 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
683 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
684 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
685 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
689 * @ingroup lavc_encoding
691 typedef struct RcOverride{
694 int qscale; // If this is 0 then quality_factor will be used instead.
695 float quality_factor;
698 #if FF_API_MAX_BFRAMES
700 * @deprecated there is no libavcodec-wide limit on the number of B-frames
702 #define FF_MAX_B_FRAMES 16
706 These flags can be passed in AVCodecContext.flags before initialization.
707 Note: Not everything is supported yet.
711 * Allow decoders to produce frames with data planes that are not aligned
712 * to CPU requirements (e.g. due to cropping).
714 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
718 #define AV_CODEC_FLAG_QSCALE (1 << 1)
720 * 4 MV per MB allowed / advanced prediction for H.263.
722 #define AV_CODEC_FLAG_4MV (1 << 2)
724 * Output even those frames that might be corrupted.
726 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
730 #define AV_CODEC_FLAG_QPEL (1 << 4)
732 * Use internal 2pass ratecontrol in first pass mode.
734 #define AV_CODEC_FLAG_PASS1 (1 << 9)
736 * Use internal 2pass ratecontrol in second pass mode.
738 #define AV_CODEC_FLAG_PASS2 (1 << 10)
742 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
744 * Only decode/encode grayscale.
746 #define AV_CODEC_FLAG_GRAY (1 << 13)
748 * error[?] variables will be set during encoding.
750 #define AV_CODEC_FLAG_PSNR (1 << 15)
752 * Input bitstream might be truncated at a random location
753 * instead of only at frame boundaries.
755 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
757 * Use interlaced DCT.
759 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
763 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
765 * Place global headers in extradata instead of every keyframe.
767 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
769 * Use only bitexact stuff (except (I)DCT).
771 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
772 /* Fx : Flag for h263+ extra options */
774 * H.263 advanced intra coding / MPEG-4 AC prediction
776 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
778 * interlaced motion estimation
780 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
782 * Allow non spec compliant speedup tricks.
784 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
786 #define AV_CODEC_FLAG2_FAST (1 << 0)
788 * Skip bitstream encoding.
790 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
792 * Place global headers at every keyframe instead of in extradata.
794 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
797 * timecode is in drop frame format. DEPRECATED!!!!
799 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
802 * Input bitstream might be truncated at a packet boundaries
803 * instead of only at frame boundaries.
805 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
807 * Discard cropping information from SPS.
809 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
812 * Show all frames before the first keyframe
814 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
816 * Export motion vectors through frame side data
818 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
820 * Do not skip samples and export skip information as frame side data
822 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
824 /* Unsupported options :
825 * Syntax Arithmetic coding (SAC)
826 * Reference Picture Selection
827 * Independent Segment Decoding */
829 /* codec capabilities */
832 * Decoder can use draw_horiz_band callback.
834 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
836 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
837 * If not set, it might not use get_buffer() at all or use operations that
838 * assume the buffer was allocated by avcodec_default_get_buffer.
840 #define AV_CODEC_CAP_DR1 (1 << 1)
841 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
843 * Encoder or decoder requires flushing with NULL input at the end in order to
844 * give the complete and correct output.
846 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
847 * with NULL data. The user can still send NULL data to the public encode
848 * or decode function, but libavcodec will not pass it along to the codec
849 * unless this flag is set.
852 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
853 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
857 * The encoder needs to be fed with NULL data at the end of encoding until the
858 * encoder no longer returns data.
860 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
861 * flag also means that the encoder must set the pts and duration for
862 * each output packet. If this flag is not set, the pts and duration will
863 * be determined by libavcodec from the input frame.
865 #define AV_CODEC_CAP_DELAY (1 << 5)
867 * Codec can be fed a final frame with a smaller size.
868 * This can be used to prevent truncation of the last audio samples.
870 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
874 * Codec can export data for HW decoding (VDPAU).
876 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
880 * Codec can output multiple frames per AVPacket
881 * Normally demuxers return one frame at a time, demuxers which do not do
882 * are connected to a parser to split what they return into proper frames.
883 * This flag is reserved to the very rare category of codecs which have a
884 * bitstream that cannot be split into frames without timeconsuming
885 * operations like full decoding. Demuxers carring such bitstreams thus
886 * may return multiple frames in a packet. This has many disadvantages like
887 * prohibiting stream copy in many cases thus it should only be considered
890 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
892 * Codec is experimental and is thus avoided in favor of non experimental
895 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
897 * Codec should fill in channel configuration and samplerate instead of container
899 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
901 * Codec supports frame-level multithreading.
903 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
905 * Codec supports slice-based (or partition-based) multithreading.
907 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
909 * Codec supports changed parameters at any point.
911 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
913 * Codec supports avctx->thread_count == 0 (auto).
915 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
917 * Audio encoder supports receiving a different number of samples in each call.
919 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
921 * Codec is intra only.
923 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
927 #define AV_CODEC_CAP_LOSSLESS 0x80000000
930 #if FF_API_WITHOUT_PREFIX
932 * Allow decoders to produce frames with data planes that are not aligned
933 * to CPU requirements (e.g. due to cropping).
935 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
936 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
937 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
938 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
939 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
942 * @deprecated use the "gmc" private option of the libxvid encoder
944 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
948 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
951 #define CODEC_FLAG_MV0 0x0040
953 #if FF_API_INPUT_PRESERVED
955 * @deprecated passing reference-counted frames to the encoders replaces this
958 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
960 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
961 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
962 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
965 * @deprecated edges are not used/required anymore. I.e. this flag is now always
968 #define CODEC_FLAG_EMU_EDGE 0x4000
970 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
971 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
973 #if FF_API_NORMALIZE_AQP
975 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
978 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
980 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
981 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
982 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
983 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
984 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
985 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
986 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
987 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
988 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
989 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
990 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
991 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
992 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
994 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
995 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
996 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
997 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
999 /* Unsupported options :
1000 * Syntax Arithmetic coding (SAC)
1001 * Reference Picture Selection
1002 * Independent Segment Decoding */
1004 /* codec capabilities */
1006 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1008 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1009 * If not set, it might not use get_buffer() at all or use operations that
1010 * assume the buffer was allocated by avcodec_default_get_buffer.
1012 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1013 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1015 /* Codec can export data for HW decoding. This flag indicates that
1016 * the codec would call get_format() with list that might contain HW accelerated
1017 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1018 * including raw image format.
1019 * The application can use the passed context to determine bitstream version,
1020 * chroma format, resolution etc.
1022 #define CODEC_CAP_HWACCEL 0x0010
1023 #endif /* FF_API_XVMC */
1025 * Encoder or decoder requires flushing with NULL input at the end in order to
1026 * give the complete and correct output.
1028 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1029 * with NULL data. The user can still send NULL data to the public encode
1030 * or decode function, but libavcodec will not pass it along to the codec
1031 * unless this flag is set.
1034 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1035 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1039 * The encoder needs to be fed with NULL data at the end of encoding until the
1040 * encoder no longer returns data.
1042 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1043 * flag also means that the encoder must set the pts and duration for
1044 * each output packet. If this flag is not set, the pts and duration will
1045 * be determined by libavcodec from the input frame.
1047 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1049 * Codec can be fed a final frame with a smaller size.
1050 * This can be used to prevent truncation of the last audio samples.
1052 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1053 #if FF_API_CAP_VDPAU
1055 * Codec can export data for HW decoding (VDPAU).
1057 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1060 * Codec can output multiple frames per AVPacket
1061 * Normally demuxers return one frame at a time, demuxers which do not do
1062 * are connected to a parser to split what they return into proper frames.
1063 * This flag is reserved to the very rare category of codecs which have a
1064 * bitstream that cannot be split into frames without timeconsuming
1065 * operations like full decoding. Demuxers carring such bitstreams thus
1066 * may return multiple frames in a packet. This has many disadvantages like
1067 * prohibiting stream copy in many cases thus it should only be considered
1070 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1072 * Codec is experimental and is thus avoided in favor of non experimental
1075 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1077 * Codec should fill in channel configuration and samplerate instead of container
1079 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1080 #if FF_API_NEG_LINESIZES
1082 * @deprecated no codecs use this capability
1084 #define CODEC_CAP_NEG_LINESIZES 0x0800
1087 * Codec supports frame-level multithreading.
1089 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1091 * Codec supports slice-based (or partition-based) multithreading.
1093 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1095 * Codec supports changed parameters at any point.
1097 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1099 * Codec supports avctx->thread_count == 0 (auto).
1101 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1103 * Audio encoder supports receiving a different number of samples in each call.
1105 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1107 * Codec is intra only.
1109 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1111 * Codec is lossless.
1113 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1116 * HWAccel is experimental and is thus avoided in favor of non experimental
1119 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1120 #endif /* FF_API_WITHOUT_PREFIX */
1123 //The following defines may change, don't expect compatibility if you use them.
1124 #define MB_TYPE_INTRA4x4 0x0001
1125 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1126 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1127 #define MB_TYPE_16x16 0x0008
1128 #define MB_TYPE_16x8 0x0010
1129 #define MB_TYPE_8x16 0x0020
1130 #define MB_TYPE_8x8 0x0040
1131 #define MB_TYPE_INTERLACED 0x0080
1132 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1133 #define MB_TYPE_ACPRED 0x0200
1134 #define MB_TYPE_GMC 0x0400
1135 #define MB_TYPE_SKIP 0x0800
1136 #define MB_TYPE_P0L0 0x1000
1137 #define MB_TYPE_P1L0 0x2000
1138 #define MB_TYPE_P0L1 0x4000
1139 #define MB_TYPE_P1L1 0x8000
1140 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1141 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1142 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1143 #define MB_TYPE_QUANT 0x00010000
1144 #define MB_TYPE_CBP 0x00020000
1145 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
1150 * This specifies the area which should be displayed.
1151 * Note there may be multiple such areas for one frame.
1153 typedef struct AVPanScan{
1156 * - encoding: Set by user.
1157 * - decoding: Set by libavcodec.
1162 * width and height in 1/16 pel
1163 * - encoding: Set by user.
1164 * - decoding: Set by libavcodec.
1170 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1171 * - encoding: Set by user.
1172 * - decoding: Set by libavcodec.
1174 int16_t position[3][2];
1177 #if FF_API_QSCALE_TYPE
1178 #define FF_QSCALE_TYPE_MPEG1 0
1179 #define FF_QSCALE_TYPE_MPEG2 1
1180 #define FF_QSCALE_TYPE_H264 2
1181 #define FF_QSCALE_TYPE_VP56 3
1185 * The decoder will keep a reference to the frame and may reuse it later.
1187 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1190 * @defgroup lavc_packet AVPacket
1192 * Types and functions for working with AVPacket.
1195 enum AVPacketSideDataType {
1196 AV_PKT_DATA_PALETTE,
1197 AV_PKT_DATA_NEW_EXTRADATA,
1200 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1203 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1204 * s32le channel_count
1205 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1206 * u64le channel_layout
1207 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1209 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1214 AV_PKT_DATA_PARAM_CHANGE,
1217 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1218 * structures with info about macroblocks relevant to splitting the
1219 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1220 * That is, it does not necessarily contain info about all macroblocks,
1221 * as long as the distance between macroblocks in the info is smaller
1222 * than the target payload size.
1223 * Each MB info structure is 12 bytes, and is laid out as follows:
1225 * u32le bit offset from the start of the packet
1226 * u8 current quantizer at the start of the macroblock
1228 * u16le macroblock address within the GOB
1229 * u8 horizontal MV predictor
1230 * u8 vertical MV predictor
1231 * u8 horizontal MV predictor for block number 3
1232 * u8 vertical MV predictor for block number 3
1235 AV_PKT_DATA_H263_MB_INFO,
1238 * This side data should be associated with an audio stream and contains
1239 * ReplayGain information in form of the AVReplayGain struct.
1241 AV_PKT_DATA_REPLAYGAIN,
1244 * This side data contains a 3x3 transformation matrix describing an affine
1245 * transformation that needs to be applied to the decoded video frames for
1246 * correct presentation.
1248 * See libavutil/display.h for a detailed description of the data.
1250 AV_PKT_DATA_DISPLAYMATRIX,
1253 * This side data should be associated with a video stream and contains
1254 * Stereoscopic 3D information in form of the AVStereo3D struct.
1256 AV_PKT_DATA_STEREO3D,
1259 * This side data should be associated with an audio stream and corresponds
1260 * to enum AVAudioServiceType.
1262 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1265 * This side data contains quality related information from the encoder.
1267 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1271 * u64le[error count] sum of squared differences between encoder in and output
1274 AV_PKT_DATA_QUALITY_STATS,
1277 * Recommmends skipping the specified number of samples
1279 * u32le number of samples to skip from start of this packet
1280 * u32le number of samples to skip from end of this packet
1281 * u8 reason for start skip
1282 * u8 reason for end skip (0=padding silence, 1=convergence)
1285 AV_PKT_DATA_SKIP_SAMPLES=70,
1288 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1289 * the packet may contain "dual mono" audio specific to Japanese DTV
1290 * and if it is true, recommends only the selected channel to be used.
1292 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1295 AV_PKT_DATA_JP_DUALMONO,
1298 * A list of zero terminated key/value strings. There is no end marker for
1299 * the list, so it is required to rely on the side data size to stop.
1301 AV_PKT_DATA_STRINGS_METADATA,
1304 * Subtitle event position
1312 AV_PKT_DATA_SUBTITLE_POSITION,
1315 * Data found in BlockAdditional element of matroska container. There is
1316 * no end marker for the data, so it is required to rely on the side data
1317 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1320 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1323 * The optional first identifier line of a WebVTT cue.
1325 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1328 * The optional settings (rendering instructions) that immediately
1329 * follow the timestamp specifier of a WebVTT cue.
1331 AV_PKT_DATA_WEBVTT_SETTINGS,
1334 * A list of zero terminated key/value strings. There is no end marker for
1335 * the list, so it is required to rely on the side data size to stop. This
1336 * side data includes updated metadata which appeared in the stream.
1338 AV_PKT_DATA_METADATA_UPDATE,
1341 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1343 typedef struct AVPacketSideData {
1346 enum AVPacketSideDataType type;
1350 * This structure stores compressed data. It is typically exported by demuxers
1351 * and then passed as input to decoders, or received as output from encoders and
1352 * then passed to muxers.
1354 * For video, it should typically contain one compressed frame. For audio it may
1355 * contain several compressed frames. Encoders are allowed to output empty
1356 * packets, with no compressed data, containing only side data
1357 * (e.g. to update some stream parameters at the end of encoding).
1359 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1360 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1361 * without libavcodec and libavformat major bump.
1363 * The semantics of data ownership depends on the buf or destruct (deprecated)
1364 * fields. If either is set, the packet data is dynamically allocated and is
1365 * valid indefinitely until av_free_packet() is called (which in turn calls
1366 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1367 * the packet data is typically backed by some static buffer somewhere and is
1368 * only valid for a limited time (e.g. until the next read call when demuxing).
1370 * The side data is always allocated with av_malloc() and is freed in
1373 typedef struct AVPacket {
1375 * A reference to the reference-counted buffer where the packet data is
1377 * May be NULL, then the packet data is not reference-counted.
1381 * Presentation timestamp in AVStream->time_base units; the time at which
1382 * the decompressed packet will be presented to the user.
1383 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1384 * pts MUST be larger or equal to dts as presentation cannot happen before
1385 * decompression, unless one wants to view hex dumps. Some formats misuse
1386 * the terms dts and pts/cts to mean something different. Such timestamps
1387 * must be converted to true pts/dts before they are stored in AVPacket.
1391 * Decompression timestamp in AVStream->time_base units; the time at which
1392 * the packet is decompressed.
1393 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1400 * A combination of AV_PKT_FLAG values
1404 * Additional packet data that can be provided by the container.
1405 * Packet can contain several types of side information.
1407 AVPacketSideData *side_data;
1408 int side_data_elems;
1411 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1412 * Equals next_pts - this_pts in presentation order.
1416 int64_t pos; ///< byte position in stream, -1 if unknown
1419 * Time difference in AVStream->time_base units from the pts of this
1420 * packet to the point at which the output from the decoder has converged
1421 * independent from the availability of previous frames. That is, the
1422 * frames are virtually identical no matter if decoding started from
1423 * the very first frame or from this keyframe.
1424 * Is AV_NOPTS_VALUE if unknown.
1425 * This field is not the display duration of the current packet.
1426 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1429 * The purpose of this field is to allow seeking in streams that have no
1430 * keyframes in the conventional sense. It corresponds to the
1431 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1432 * essential for some types of subtitle streams to ensure that all
1433 * subtitles are correctly displayed after seeking.
1435 int64_t convergence_duration;
1437 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1438 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1440 enum AVSideDataParamChangeFlags {
1441 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1442 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1443 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1444 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1450 struct AVCodecInternal;
1454 AV_FIELD_PROGRESSIVE,
1455 AV_FIELD_TT, //< Top coded_first, top displayed first
1456 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1457 AV_FIELD_TB, //< Top coded first, bottom displayed first
1458 AV_FIELD_BT, //< Bottom coded first, top displayed first
1462 * main external API structure.
1463 * New fields can be added to the end with minor version bumps.
1464 * Removal, reordering and changes to existing fields require a major
1466 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1468 * sizeof(AVCodecContext) must not be used outside libav*.
1470 typedef struct AVCodecContext {
1472 * information on struct for av_log
1473 * - set by avcodec_alloc_context3
1475 const AVClass *av_class;
1476 int log_level_offset;
1478 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1479 const struct AVCodec *codec;
1480 #if FF_API_CODEC_NAME
1482 * @deprecated this field is not used for anything in libavcodec
1484 attribute_deprecated
1485 char codec_name[32];
1487 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1490 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1491 * This is used to work around some encoder bugs.
1492 * A demuxer should set this to what is stored in the field used to identify the codec.
1493 * If there are multiple such fields in a container then the demuxer should choose the one
1494 * which maximizes the information about the used codec.
1495 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1496 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1497 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1499 * - encoding: Set by user, if not then the default based on codec_id will be used.
1500 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1502 unsigned int codec_tag;
1504 #if FF_API_STREAM_CODEC_TAG
1506 * @deprecated this field is unused
1508 attribute_deprecated
1509 unsigned int stream_codec_tag;
1515 * Private context used for internal data.
1517 * Unlike priv_data, this is not codec-specific. It is used in general
1518 * libavcodec functions.
1520 struct AVCodecInternal *internal;
1523 * Private data of the user, can be used to carry app specific stuff.
1524 * - encoding: Set by user.
1525 * - decoding: Set by user.
1530 * the average bitrate
1531 * - encoding: Set by user; unused for constant quantizer encoding.
1532 * - decoding: Set by user, may be overwritten by libavcodec
1533 * if this info is available in the stream
1538 * number of bits the bitstream is allowed to diverge from the reference.
1539 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1540 * - encoding: Set by user; unused for constant quantizer encoding.
1541 * - decoding: unused
1543 int bit_rate_tolerance;
1546 * Global quality for codecs which cannot change it per frame.
1547 * This should be proportional to MPEG-1/2/4 qscale.
1548 * - encoding: Set by user.
1549 * - decoding: unused
1554 * - encoding: Set by user.
1555 * - decoding: unused
1557 int compression_level;
1558 #define FF_COMPRESSION_DEFAULT -1
1562 * - encoding: Set by user.
1563 * - decoding: Set by user.
1569 * - encoding: Set by user.
1570 * - decoding: Set by user.
1575 * some codecs need / can use extradata like Huffman tables.
1576 * mjpeg: Huffman tables
1577 * rv10: additional flags
1578 * mpeg4: global headers (they can be in the bitstream or here)
1579 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1580 * than extradata_size to avoid problems if it is read with the bitstream reader.
1581 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1582 * - encoding: Set/allocated/freed by libavcodec.
1583 * - decoding: Set/allocated/freed by user.
1589 * This is the fundamental unit of time (in seconds) in terms
1590 * of which frame timestamps are represented. For fixed-fps content,
1591 * timebase should be 1/framerate and timestamp increments should be
1593 * This often, but not always is the inverse of the frame rate or field rate
1595 * - encoding: MUST be set by user.
1596 * - decoding: the use of this field for decoding is deprecated.
1597 * Use framerate instead.
1599 AVRational time_base;
1602 * For some codecs, the time base is closer to the field rate than the frame rate.
1603 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1604 * if no telecine is used ...
1606 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1608 int ticks_per_frame;
1613 * Encoding: Number of frames delay there will be from the encoder input to
1614 * the decoder output. (we assume the decoder matches the spec)
1615 * Decoding: Number of frames delay in addition to what a standard decoder
1616 * as specified in the spec would produce.
1619 * Number of frames the decoded output will be delayed relative to the
1623 * For encoding, this field is unused (see initial_padding).
1625 * For decoding, this is the number of samples the decoder needs to
1626 * output before the decoder's output is valid. When seeking, you should
1627 * start decoding this many samples prior to your desired seek point.
1629 * - encoding: Set by libavcodec.
1630 * - decoding: Set by libavcodec.
1637 * picture width / height.
1639 * @note Those fields may not match the values of the last
1640 * AVFrame outputted by avcodec_decode_video2 due frame
1643 * - encoding: MUST be set by user.
1644 * - decoding: May be set by the user before opening the decoder if known e.g.
1645 * from the container. Some decoders will require the dimensions
1646 * to be set by the caller. During decoding, the decoder may
1647 * overwrite those values as required while parsing the data.
1652 * Bitstream width / height, may be different from width/height e.g. when
1653 * the decoded frame is cropped before being output or lowres is enabled.
1655 * @note Those field may not match the value of the last
1656 * AVFrame outputted by avcodec_decode_video2 due frame
1659 * - encoding: unused
1660 * - decoding: May be set by the user before opening the decoder if known
1661 * e.g. from the container. During decoding, the decoder may
1662 * overwrite those values as required while parsing the data.
1664 int coded_width, coded_height;
1666 #if FF_API_ASPECT_EXTENDED
1667 #define FF_ASPECT_EXTENDED 15
1671 * the number of pictures in a group of pictures, or 0 for intra_only
1672 * - encoding: Set by user.
1673 * - decoding: unused
1678 * Pixel format, see AV_PIX_FMT_xxx.
1679 * May be set by the demuxer if known from headers.
1680 * May be overridden by the decoder if it knows better.
1682 * @note This field may not match the value of the last
1683 * AVFrame outputted by avcodec_decode_video2 due frame
1686 * - encoding: Set by user.
1687 * - decoding: Set by user if known, overridden by libavcodec while
1690 enum AVPixelFormat pix_fmt;
1692 #if FF_API_MOTION_EST
1694 * This option does nothing
1695 * @deprecated use codec private options instead
1697 attribute_deprecated int me_method;
1701 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1702 * decoder to draw a horizontal band. It improves cache usage. Not
1703 * all codecs can do that. You must check the codec capabilities
1705 * When multithreading is used, it may be called from multiple threads
1706 * at the same time; threads might draw different parts of the same AVFrame,
1707 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1709 * The function is also used by hardware acceleration APIs.
1710 * It is called at least once during frame decoding to pass
1711 * the data needed for hardware render.
1712 * In that mode instead of pixel data, AVFrame points to
1713 * a structure specific to the acceleration API. The application
1714 * reads the structure and can change some fields to indicate progress
1716 * - encoding: unused
1717 * - decoding: Set by user.
1718 * @param height the height of the slice
1719 * @param y the y position of the slice
1720 * @param type 1->top field, 2->bottom field, 3->frame
1721 * @param offset offset into the AVFrame.data from which the slice should be read
1723 void (*draw_horiz_band)(struct AVCodecContext *s,
1724 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1725 int y, int type, int height);
1728 * callback to negotiate the pixelFormat
1729 * @param fmt is the list of formats which are supported by the codec,
1730 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1731 * The first is always the native one.
1732 * @note The callback may be called again immediately if initialization for
1733 * the selected (hardware-accelerated) pixel format failed.
1734 * @warning Behavior is undefined if the callback returns a value not
1735 * in the fmt list of formats.
1736 * @return the chosen format
1737 * - encoding: unused
1738 * - decoding: Set by user, if not set the native format will be chosen.
1740 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1743 * maximum number of B-frames between non-B-frames
1744 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1745 * - encoding: Set by user.
1746 * - decoding: unused
1751 * qscale factor between IP and B-frames
1752 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1753 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1754 * - encoding: Set by user.
1755 * - decoding: unused
1757 float b_quant_factor;
1759 #if FF_API_RC_STRATEGY
1760 /** @deprecated use codec private option instead */
1761 attribute_deprecated int rc_strategy;
1762 #define FF_RC_STRATEGY_XVID 1
1765 int b_frame_strategy;
1768 * qscale offset between IP and B-frames
1769 * - encoding: Set by user.
1770 * - decoding: unused
1772 float b_quant_offset;
1775 * Size of the frame reordering buffer in the decoder.
1776 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1777 * - encoding: Set by libavcodec.
1778 * - decoding: Set by libavcodec.
1783 * 0-> h263 quant 1-> mpeg quant
1784 * - encoding: Set by user.
1785 * - decoding: unused
1790 * qscale factor between P and I-frames
1791 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1792 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1793 * - encoding: Set by user.
1794 * - decoding: unused
1796 float i_quant_factor;
1799 * qscale offset between P and I-frames
1800 * - encoding: Set by user.
1801 * - decoding: unused
1803 float i_quant_offset;
1806 * luminance masking (0-> disabled)
1807 * - encoding: Set by user.
1808 * - decoding: unused
1813 * temporary complexity masking (0-> disabled)
1814 * - encoding: Set by user.
1815 * - decoding: unused
1817 float temporal_cplx_masking;
1820 * spatial complexity masking (0-> disabled)
1821 * - encoding: Set by user.
1822 * - decoding: unused
1824 float spatial_cplx_masking;
1827 * p block masking (0-> disabled)
1828 * - encoding: Set by user.
1829 * - decoding: unused
1834 * darkness masking (0-> disabled)
1835 * - encoding: Set by user.
1836 * - decoding: unused
1842 * - encoding: Set by libavcodec.
1843 * - decoding: Set by user (or 0).
1847 * prediction method (needed for huffyuv)
1848 * - encoding: Set by user.
1849 * - decoding: unused
1851 int prediction_method;
1852 #define FF_PRED_LEFT 0
1853 #define FF_PRED_PLANE 1
1854 #define FF_PRED_MEDIAN 2
1857 * slice offsets in the frame in bytes
1858 * - encoding: Set/allocated by libavcodec.
1859 * - decoding: Set/allocated by user (or NULL).
1864 * sample aspect ratio (0 if unknown)
1865 * That is the width of a pixel divided by the height of the pixel.
1866 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1867 * - encoding: Set by user.
1868 * - decoding: Set by libavcodec.
1870 AVRational sample_aspect_ratio;
1873 * motion estimation comparison function
1874 * - encoding: Set by user.
1875 * - decoding: unused
1879 * subpixel motion estimation comparison function
1880 * - encoding: Set by user.
1881 * - decoding: unused
1885 * macroblock comparison function (not supported yet)
1886 * - encoding: Set by user.
1887 * - decoding: unused
1891 * interlaced DCT comparison function
1892 * - encoding: Set by user.
1893 * - decoding: unused
1896 #define FF_CMP_SAD 0
1897 #define FF_CMP_SSE 1
1898 #define FF_CMP_SATD 2
1899 #define FF_CMP_DCT 3
1900 #define FF_CMP_PSNR 4
1901 #define FF_CMP_BIT 5
1903 #define FF_CMP_ZERO 7
1904 #define FF_CMP_VSAD 8
1905 #define FF_CMP_VSSE 9
1906 #define FF_CMP_NSSE 10
1907 #define FF_CMP_W53 11
1908 #define FF_CMP_W97 12
1909 #define FF_CMP_DCTMAX 13
1910 #define FF_CMP_DCT264 14
1911 #define FF_CMP_CHROMA 256
1914 * ME diamond size & shape
1915 * - encoding: Set by user.
1916 * - decoding: unused
1921 * amount of previous MV predictors (2a+1 x 2a+1 square)
1922 * - encoding: Set by user.
1923 * - decoding: unused
1925 int last_predictor_count;
1928 * prepass for motion estimation
1929 * - encoding: Set by user.
1930 * - decoding: unused
1935 * motion estimation prepass comparison function
1936 * - encoding: Set by user.
1937 * - decoding: unused
1942 * ME prepass diamond size & shape
1943 * - encoding: Set by user.
1944 * - decoding: unused
1950 * - encoding: Set by user.
1951 * - decoding: unused
1953 int me_subpel_quality;
1957 * DTG active format information (additional aspect ratio
1958 * information only used in DVB MPEG-2 transport streams)
1961 * - encoding: unused
1962 * - decoding: Set by decoder.
1963 * @deprecated Deprecated in favor of AVSideData
1965 attribute_deprecated int dtg_active_format;
1966 #define FF_DTG_AFD_SAME 8
1967 #define FF_DTG_AFD_4_3 9
1968 #define FF_DTG_AFD_16_9 10
1969 #define FF_DTG_AFD_14_9 11
1970 #define FF_DTG_AFD_4_3_SP_14_9 13
1971 #define FF_DTG_AFD_16_9_SP_14_9 14
1972 #define FF_DTG_AFD_SP_4_3 15
1973 #endif /* FF_API_AFD */
1976 * maximum motion estimation search range in subpel units
1977 * If 0 then no limit.
1979 * - encoding: Set by user.
1980 * - decoding: unused
1984 #if FF_API_QUANT_BIAS
1986 * @deprecated use encoder private option instead
1988 attribute_deprecated int intra_quant_bias;
1989 #define FF_DEFAULT_QUANT_BIAS 999999
1992 * @deprecated use encoder private option instead
1994 attribute_deprecated int inter_quant_bias;
1999 * - encoding: unused
2000 * - decoding: Set by user.
2003 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2004 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2005 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2009 * XVideo Motion Acceleration
2010 * - encoding: forbidden
2011 * - decoding: set by decoder
2012 * @deprecated XvMC doesn't need it anymore.
2014 attribute_deprecated int xvmc_acceleration;
2015 #endif /* FF_API_XVMC */
2018 * macroblock decision mode
2019 * - encoding: Set by user.
2020 * - decoding: unused
2023 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2024 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2025 #define FF_MB_DECISION_RD 2 ///< rate distortion
2028 * custom intra quantization matrix
2029 * - encoding: Set by user, can be NULL.
2030 * - decoding: Set by libavcodec.
2032 uint16_t *intra_matrix;
2035 * custom inter quantization matrix
2036 * - encoding: Set by user, can be NULL.
2037 * - decoding: Set by libavcodec.
2039 uint16_t *inter_matrix;
2042 * scene change detection threshold
2043 * 0 is default, larger means fewer detected scene changes.
2044 * - encoding: Set by user.
2045 * - decoding: unused
2047 int scenechange_threshold;
2050 * noise reduction strength
2051 * - encoding: Set by user.
2052 * - decoding: unused
2054 int noise_reduction;
2058 * @deprecated this field is unused
2060 attribute_deprecated
2064 * @deprecated this field is unused
2066 attribute_deprecated
2071 * precision of the intra DC coefficient - 8
2072 * - encoding: Set by user.
2073 * - decoding: Set by libavcodec
2075 int intra_dc_precision;
2078 * Number of macroblock rows at the top which are skipped.
2079 * - encoding: unused
2080 * - decoding: Set by user.
2085 * Number of macroblock rows at the bottom which are skipped.
2086 * - encoding: unused
2087 * - decoding: Set by user.
2093 * @deprecated use encoder private options instead
2095 attribute_deprecated
2096 float border_masking;
2100 * minimum MB lagrange multipler
2101 * - encoding: Set by user.
2102 * - decoding: unused
2107 * maximum MB lagrange multipler
2108 * - encoding: Set by user.
2109 * - decoding: unused
2115 * - encoding: Set by user.
2116 * - decoding: unused
2118 int me_penalty_compensation;
2122 * - encoding: Set by user.
2123 * - decoding: unused
2129 * - encoding: Set by user.
2130 * - decoding: unused
2136 * - encoding: Set by user.
2137 * - decoding: unused
2142 * number of reference frames
2143 * - encoding: Set by user.
2144 * - decoding: Set by lavc.
2149 * chroma qp offset from luma
2150 * - encoding: Set by user.
2151 * - decoding: unused
2155 #if FF_API_UNUSED_MEMBERS
2157 * Multiplied by qscale for each frame and added to scene_change_score.
2158 * - encoding: Set by user.
2159 * - decoding: unused
2161 attribute_deprecated int scenechange_factor;
2166 * Note: Value depends upon the compare function used for fullpel ME.
2167 * - encoding: Set by user.
2168 * - decoding: unused
2173 * Adjust sensitivity of b_frame_strategy 1.
2174 * - encoding: Set by user.
2175 * - decoding: unused
2180 * Chromaticity coordinates of the source primaries.
2181 * - encoding: Set by user
2182 * - decoding: Set by libavcodec
2184 enum AVColorPrimaries color_primaries;
2187 * Color Transfer Characteristic.
2188 * - encoding: Set by user
2189 * - decoding: Set by libavcodec
2191 enum AVColorTransferCharacteristic color_trc;
2194 * YUV colorspace type.
2195 * - encoding: Set by user
2196 * - decoding: Set by libavcodec
2198 enum AVColorSpace colorspace;
2201 * MPEG vs JPEG YUV range.
2202 * - encoding: Set by user
2203 * - decoding: Set by libavcodec
2205 enum AVColorRange color_range;
2208 * This defines the location of chroma samples.
2209 * - encoding: Set by user
2210 * - decoding: Set by libavcodec
2212 enum AVChromaLocation chroma_sample_location;
2216 * Indicates number of picture subdivisions. Used for parallelized
2218 * - encoding: Set by user
2219 * - decoding: unused
2224 * - encoding: set by libavcodec
2225 * - decoding: Set by user.
2227 enum AVFieldOrder field_order;
2230 int sample_rate; ///< samples per second
2231 int channels; ///< number of audio channels
2234 * audio sample format
2235 * - encoding: Set by user.
2236 * - decoding: Set by libavcodec.
2238 enum AVSampleFormat sample_fmt; ///< sample format
2240 /* The following data should not be initialized. */
2242 * Number of samples per channel in an audio frame.
2244 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2245 * except the last must contain exactly frame_size samples per channel.
2246 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2247 * frame size is not restricted.
2248 * - decoding: may be set by some decoders to indicate constant frame size
2253 * Frame counter, set by libavcodec.
2255 * - decoding: total number of frames returned from the decoder so far.
2256 * - encoding: total number of frames passed to the encoder so far.
2258 * @note the counter is not incremented if encoding/decoding resulted in
2264 * number of bytes per packet if constant and known or 0
2265 * Used by some WAV based audio codecs.
2270 * Audio cutoff bandwidth (0 means "automatic")
2271 * - encoding: Set by user.
2272 * - decoding: unused
2277 * Audio channel layout.
2278 * - encoding: set by user.
2279 * - decoding: set by user, may be overwritten by libavcodec.
2281 uint64_t channel_layout;
2284 * Request decoder to use this channel layout if it can (0 for default)
2285 * - encoding: unused
2286 * - decoding: Set by user.
2288 uint64_t request_channel_layout;
2291 * Type of service that the audio stream conveys.
2292 * - encoding: Set by user.
2293 * - decoding: Set by libavcodec.
2295 enum AVAudioServiceType audio_service_type;
2298 * desired sample format
2299 * - encoding: Not used.
2300 * - decoding: Set by user.
2301 * Decoder will decode to this format if it can.
2303 enum AVSampleFormat request_sample_fmt;
2306 * This callback is called at the beginning of each frame to get data
2307 * buffer(s) for it. There may be one contiguous buffer for all the data or
2308 * there may be a buffer per each data plane or anything in between. What
2309 * this means is, you may set however many entries in buf[] you feel necessary.
2310 * Each buffer must be reference-counted using the AVBuffer API (see description
2313 * The following fields will be set in the frame before this callback is
2316 * - width, height (video only)
2317 * - sample_rate, channel_layout, nb_samples (audio only)
2318 * Their values may differ from the corresponding values in
2319 * AVCodecContext. This callback must use the frame values, not the codec
2320 * context values, to calculate the required buffer size.
2322 * This callback must fill the following fields in the frame:
2326 * * if the data is planar audio with more than 8 channels, then this
2327 * callback must allocate and fill extended_data to contain all pointers
2328 * to all data planes. data[] must hold as many pointers as it can.
2329 * extended_data must be allocated with av_malloc() and will be freed in
2331 * * otherwise exended_data must point to data
2332 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2333 * the frame's data and extended_data pointers must be contained in these. That
2334 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2335 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2336 * and av_buffer_ref().
2337 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2338 * this callback and filled with the extra buffers if there are more
2339 * buffers than buf[] can hold. extended_buf will be freed in
2342 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2343 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2346 * Each data plane must be aligned to the maximum required by the target
2349 * @see avcodec_default_get_buffer2()
2353 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2354 * (read and/or written to if it is writable) later by libavcodec.
2356 * avcodec_align_dimensions2() should be used to find the required width and
2357 * height, as they normally need to be rounded up to the next multiple of 16.
2359 * Some decoders do not support linesizes changing between frames.
2361 * If frame multithreading is used and thread_safe_callbacks is set,
2362 * this callback may be called from a different thread, but not from more
2363 * than one at once. Does not need to be reentrant.
2365 * @see avcodec_align_dimensions2()
2369 * Decoders request a buffer of a particular size by setting
2370 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2371 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2372 * to a smaller value in the output frame.
2374 * As a convenience, av_samples_get_buffer_size() and
2375 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2376 * functions to find the required data size and to fill data pointers and
2377 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2378 * since all planes must be the same size.
2380 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2382 * - encoding: unused
2383 * - decoding: Set by libavcodec, user can override.
2385 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2388 * If non-zero, the decoded audio and video frames returned from
2389 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2390 * and are valid indefinitely. The caller must free them with
2391 * av_frame_unref() when they are not needed anymore.
2392 * Otherwise, the decoded frames must not be freed by the caller and are
2393 * only valid until the next decode call.
2395 * - encoding: unused
2396 * - decoding: set by the caller before avcodec_open2().
2398 int refcounted_frames;
2400 /* - encoding parameters */
2401 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2402 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2406 * - encoding: Set by user.
2407 * - decoding: unused
2413 * - encoding: Set by user.
2414 * - decoding: unused
2419 * maximum quantizer difference between frames
2420 * - encoding: Set by user.
2421 * - decoding: unused
2427 * @deprecated use encoder private options instead
2429 attribute_deprecated
2432 attribute_deprecated
2434 attribute_deprecated
2439 * decoder bitstream buffer size
2440 * - encoding: Set by user.
2441 * - decoding: unused
2446 * ratecontrol override, see RcOverride
2447 * - encoding: Allocated/set/freed by user.
2448 * - decoding: unused
2450 int rc_override_count;
2451 RcOverride *rc_override;
2455 * @deprecated use encoder private options instead
2457 attribute_deprecated
2463 * - encoding: Set by user.
2464 * - decoding: Set by user, may be overwritten by libavcodec.
2466 int64_t rc_max_rate;
2470 * - encoding: Set by user.
2471 * - decoding: unused
2473 int64_t rc_min_rate;
2477 * @deprecated use encoder private options instead
2479 attribute_deprecated
2480 float rc_buffer_aggressivity;
2482 attribute_deprecated
2483 float rc_initial_cplx;
2487 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2488 * - encoding: Set by user.
2489 * - decoding: unused.
2491 float rc_max_available_vbv_use;
2494 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2495 * - encoding: Set by user.
2496 * - decoding: unused.
2498 float rc_min_vbv_overflow_use;
2501 * Number of bits which should be loaded into the rc buffer before decoding starts.
2502 * - encoding: Set by user.
2503 * - decoding: unused
2505 int rc_initial_buffer_occupancy;
2507 #define FF_CODER_TYPE_VLC 0
2508 #define FF_CODER_TYPE_AC 1
2509 #define FF_CODER_TYPE_RAW 2
2510 #define FF_CODER_TYPE_RLE 3
2511 #if FF_API_UNUSED_MEMBERS
2512 #define FF_CODER_TYPE_DEFLATE 4
2513 #endif /* FF_API_UNUSED_MEMBERS */
2516 * - encoding: Set by user.
2517 * - decoding: unused
2523 * - encoding: Set by user.
2524 * - decoding: unused
2530 * @deprecated use encoder private options instead
2532 attribute_deprecated
2536 * @deprecated use encoder private options instead
2538 attribute_deprecated
2543 * frame skip threshold
2544 * - encoding: Set by user.
2545 * - decoding: unused
2547 int frame_skip_threshold;
2551 * - encoding: Set by user.
2552 * - decoding: unused
2554 int frame_skip_factor;
2557 * frame skip exponent
2558 * - encoding: Set by user.
2559 * - decoding: unused
2564 * frame skip comparison function
2565 * - encoding: Set by user.
2566 * - decoding: unused
2571 * trellis RD quantization
2572 * - encoding: Set by user.
2573 * - decoding: unused
2578 * - encoding: Set by user.
2579 * - decoding: unused
2581 int min_prediction_order;
2584 * - encoding: Set by user.
2585 * - decoding: unused
2587 int max_prediction_order;
2590 * GOP timecode frame start number
2591 * - encoding: Set by user, in non drop frame format
2592 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2594 int64_t timecode_frame_start;
2596 /* The RTP callback: This function is called */
2597 /* every time the encoder has a packet to send. */
2598 /* It depends on the encoder if the data starts */
2599 /* with a Start Code (it should). H.263 does. */
2600 /* mb_nb contains the number of macroblocks */
2601 /* encoded in the RTP payload. */
2602 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2604 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2605 /* do its best to deliver a chunk with size */
2606 /* below rtp_payload_size, the chunk will start */
2607 /* with a start code on some codecs like H.263. */
2608 /* This doesn't take account of any particular */
2609 /* headers inside the transmitted RTP payload. */
2611 /* statistics, used for 2-pass encoding */
2622 * number of bits used for the previously encoded frame
2623 * - encoding: Set by libavcodec.
2624 * - decoding: unused
2629 * pass1 encoding statistics output buffer
2630 * - encoding: Set by libavcodec.
2631 * - decoding: unused
2636 * pass2 encoding statistics input buffer
2637 * Concatenated stuff from stats_out of pass1 should be placed here.
2638 * - encoding: Allocated/set/freed by user.
2639 * - decoding: unused
2644 * Work around bugs in encoders which sometimes cannot be detected automatically.
2645 * - encoding: Set by user
2646 * - decoding: Set by user
2648 int workaround_bugs;
2649 #define FF_BUG_AUTODETECT 1 ///< autodetection
2650 #if FF_API_OLD_MSMPEG4
2651 #define FF_BUG_OLD_MSMPEG4 2
2653 #define FF_BUG_XVID_ILACE 4
2654 #define FF_BUG_UMP4 8
2655 #define FF_BUG_NO_PADDING 16
2656 #define FF_BUG_AMV 32
2658 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2660 #define FF_BUG_QPEL_CHROMA 64
2661 #define FF_BUG_STD_QPEL 128
2662 #define FF_BUG_QPEL_CHROMA2 256
2663 #define FF_BUG_DIRECT_BLOCKSIZE 512
2664 #define FF_BUG_EDGE 1024
2665 #define FF_BUG_HPEL_CHROMA 2048
2666 #define FF_BUG_DC_CLIP 4096
2667 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2668 #define FF_BUG_TRUNCATED 16384
2671 * strictly follow the standard (MPEG4, ...).
2672 * - encoding: Set by user.
2673 * - decoding: Set by user.
2674 * Setting this to STRICT or higher means the encoder and decoder will
2675 * generally do stupid things, whereas setting it to unofficial or lower
2676 * will mean the encoder might produce output that is not supported by all
2677 * spec-compliant decoders. Decoders don't differentiate between normal,
2678 * unofficial and experimental (that is, they always try to decode things
2679 * when they can) unless they are explicitly asked to behave stupidly
2680 * (=strictly conform to the specs)
2682 int strict_std_compliance;
2683 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2684 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2685 #define FF_COMPLIANCE_NORMAL 0
2686 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2687 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2690 * error concealment flags
2691 * - encoding: unused
2692 * - decoding: Set by user.
2694 int error_concealment;
2695 #define FF_EC_GUESS_MVS 1
2696 #define FF_EC_DEBLOCK 2
2697 #define FF_EC_FAVOR_INTER 256
2701 * - encoding: Set by user.
2702 * - decoding: Set by user.
2705 #define FF_DEBUG_PICT_INFO 1
2706 #define FF_DEBUG_RC 2
2707 #define FF_DEBUG_BITSTREAM 4
2708 #define FF_DEBUG_MB_TYPE 8
2709 #define FF_DEBUG_QP 16
2712 * @deprecated this option does nothing
2714 #define FF_DEBUG_MV 32
2716 #define FF_DEBUG_DCT_COEFF 0x00000040
2717 #define FF_DEBUG_SKIP 0x00000080
2718 #define FF_DEBUG_STARTCODE 0x00000100
2719 #if FF_API_UNUSED_MEMBERS
2720 #define FF_DEBUG_PTS 0x00000200
2721 #endif /* FF_API_UNUSED_MEMBERS */
2722 #define FF_DEBUG_ER 0x00000400
2723 #define FF_DEBUG_MMCO 0x00000800
2724 #define FF_DEBUG_BUGS 0x00001000
2726 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2727 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2729 #define FF_DEBUG_BUFFERS 0x00008000
2730 #define FF_DEBUG_THREADS 0x00010000
2731 #define FF_DEBUG_GREEN_MD 0x00800000
2732 #define FF_DEBUG_NOMC 0x01000000
2737 * Code outside libavcodec should access this field using AVOptions
2738 * - encoding: Set by user.
2739 * - decoding: Set by user.
2742 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2743 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2744 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2748 * Error recognition; may misdetect some more or less valid parts as errors.
2749 * - encoding: unused
2750 * - decoding: Set by user.
2752 int err_recognition;
2755 * Verify checksums embedded in the bitstream (could be of either encoded or
2756 * decoded data, depending on the codec) and print an error message on mismatch.
2757 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2758 * decoder returning an error.
2760 #define AV_EF_CRCCHECK (1<<0)
2761 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2762 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2763 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2765 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2766 #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
2767 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2768 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2772 * opaque 64bit number (generally a PTS) that will be reordered and
2773 * output in AVFrame.reordered_opaque
2774 * - encoding: unused
2775 * - decoding: Set by user.
2777 int64_t reordered_opaque;
2780 * Hardware accelerator in use
2781 * - encoding: unused.
2782 * - decoding: Set by libavcodec
2784 struct AVHWAccel *hwaccel;
2787 * Hardware accelerator context.
2788 * For some hardware accelerators, a global context needs to be
2789 * provided by the user. In that case, this holds display-dependent
2790 * data FFmpeg cannot instantiate itself. Please refer to the
2791 * FFmpeg HW accelerator documentation to know how to fill this
2792 * is. e.g. for VA API, this is a struct vaapi_context.
2793 * - encoding: unused
2794 * - decoding: Set by user
2796 void *hwaccel_context;
2800 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2801 * - decoding: unused
2803 uint64_t error[AV_NUM_DATA_POINTERS];
2806 * DCT algorithm, see FF_DCT_* below
2807 * - encoding: Set by user.
2808 * - decoding: unused
2811 #define FF_DCT_AUTO 0
2812 #define FF_DCT_FASTINT 1
2813 #define FF_DCT_INT 2
2814 #define FF_DCT_MMX 3
2815 #define FF_DCT_ALTIVEC 5
2816 #define FF_DCT_FAAN 6
2819 * IDCT algorithm, see FF_IDCT_* below.
2820 * - encoding: Set by user.
2821 * - decoding: Set by user.
2824 #define FF_IDCT_AUTO 0
2825 #define FF_IDCT_INT 1
2826 #define FF_IDCT_SIMPLE 2
2827 #define FF_IDCT_SIMPLEMMX 3
2828 #define FF_IDCT_ARM 7
2829 #define FF_IDCT_ALTIVEC 8
2831 #define FF_IDCT_SH4 9
2833 #define FF_IDCT_SIMPLEARM 10
2834 #if FF_API_UNUSED_MEMBERS
2835 #define FF_IDCT_IPP 13
2836 #endif /* FF_API_UNUSED_MEMBERS */
2837 #define FF_IDCT_XVID 14
2838 #if FF_API_IDCT_XVIDMMX
2839 #define FF_IDCT_XVIDMMX 14
2840 #endif /* FF_API_IDCT_XVIDMMX */
2841 #define FF_IDCT_SIMPLEARMV5TE 16
2842 #define FF_IDCT_SIMPLEARMV6 17
2843 #if FF_API_ARCH_SPARC
2844 #define FF_IDCT_SIMPLEVIS 18
2846 #define FF_IDCT_FAAN 20
2847 #define FF_IDCT_SIMPLENEON 22
2848 #if FF_API_ARCH_ALPHA
2849 #define FF_IDCT_SIMPLEALPHA 23
2851 #define FF_IDCT_SIMPLEAUTO 128
2854 * bits per sample/pixel from the demuxer (needed for huffyuv).
2855 * - encoding: Set by libavcodec.
2856 * - decoding: Set by user.
2858 int bits_per_coded_sample;
2861 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2862 * - encoding: set by user.
2863 * - decoding: set by libavcodec.
2865 int bits_per_raw_sample;
2869 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2870 * - encoding: unused
2871 * - decoding: Set by user.
2872 * Code outside libavcodec should access this field using:
2873 * av_codec_{get,set}_lowres(avctx)
2878 #if FF_API_CODED_FRAME
2880 * the picture in the bitstream
2881 * - encoding: Set by libavcodec.
2882 * - decoding: unused
2884 * @deprecated use the quality factor packet side data instead
2886 attribute_deprecated AVFrame *coded_frame;
2891 * is used to decide how many independent tasks should be passed to execute()
2892 * - encoding: Set by user.
2893 * - decoding: Set by user.
2898 * Which multithreading methods to use.
2899 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2900 * so clients which cannot provide future frames should not use it.
2902 * - encoding: Set by user, otherwise the default is used.
2903 * - decoding: Set by user, otherwise the default is used.
2906 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2907 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2910 * Which multithreading methods are in use by the codec.
2911 * - encoding: Set by libavcodec.
2912 * - decoding: Set by libavcodec.
2914 int active_thread_type;
2917 * Set by the client if its custom get_buffer() callback can be called
2918 * synchronously from another thread, which allows faster multithreaded decoding.
2919 * draw_horiz_band() will be called from other threads regardless of this setting.
2920 * Ignored if the default get_buffer() is used.
2921 * - encoding: Set by user.
2922 * - decoding: Set by user.
2924 int thread_safe_callbacks;
2927 * The codec may call this to execute several independent things.
2928 * It will return only after finishing all tasks.
2929 * The user may replace this with some multithreaded implementation,
2930 * the default implementation will execute the parts serially.
2931 * @param count the number of things to execute
2932 * - encoding: Set by libavcodec, user can override.
2933 * - decoding: Set by libavcodec, user can override.
2935 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2938 * The codec may call this to execute several independent things.
2939 * It will return only after finishing all tasks.
2940 * The user may replace this with some multithreaded implementation,
2941 * the default implementation will execute the parts serially.
2942 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2943 * @param c context passed also to func
2944 * @param count the number of things to execute
2945 * @param arg2 argument passed unchanged to func
2946 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2947 * @param func function that will be called count times, with jobnr from 0 to count-1.
2948 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2949 * two instances of func executing at the same time will have the same threadnr.
2950 * @return always 0 currently, but code should handle a future improvement where when any call to func
2951 * returns < 0 no further calls to func may be done and < 0 is returned.
2952 * - encoding: Set by libavcodec, user can override.
2953 * - decoding: Set by libavcodec, user can override.
2955 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2958 * noise vs. sse weight for the nsse comparison function
2959 * - encoding: Set by user.
2960 * - decoding: unused
2966 * - encoding: Set by user.
2967 * - decoding: Set by libavcodec.
2970 #define FF_PROFILE_UNKNOWN -99
2971 #define FF_PROFILE_RESERVED -100
2973 #define FF_PROFILE_AAC_MAIN 0
2974 #define FF_PROFILE_AAC_LOW 1
2975 #define FF_PROFILE_AAC_SSR 2
2976 #define FF_PROFILE_AAC_LTP 3
2977 #define FF_PROFILE_AAC_HE 4
2978 #define FF_PROFILE_AAC_HE_V2 28
2979 #define FF_PROFILE_AAC_LD 22
2980 #define FF_PROFILE_AAC_ELD 38
2981 #define FF_PROFILE_MPEG2_AAC_LOW 128
2982 #define FF_PROFILE_MPEG2_AAC_HE 131
2984 #define FF_PROFILE_DTS 20
2985 #define FF_PROFILE_DTS_ES 30
2986 #define FF_PROFILE_DTS_96_24 40
2987 #define FF_PROFILE_DTS_HD_HRA 50
2988 #define FF_PROFILE_DTS_HD_MA 60
2989 #define FF_PROFILE_DTS_EXPRESS 70
2991 #define FF_PROFILE_MPEG2_422 0
2992 #define FF_PROFILE_MPEG2_HIGH 1
2993 #define FF_PROFILE_MPEG2_SS 2
2994 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2995 #define FF_PROFILE_MPEG2_MAIN 4
2996 #define FF_PROFILE_MPEG2_SIMPLE 5
2998 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2999 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3001 #define FF_PROFILE_H264_BASELINE 66
3002 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3003 #define FF_PROFILE_H264_MAIN 77
3004 #define FF_PROFILE_H264_EXTENDED 88
3005 #define FF_PROFILE_H264_HIGH 100
3006 #define FF_PROFILE_H264_HIGH_10 110
3007 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3008 #define FF_PROFILE_H264_HIGH_422 122
3009 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3010 #define FF_PROFILE_H264_HIGH_444 144
3011 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3012 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3013 #define FF_PROFILE_H264_CAVLC_444 44
3015 #define FF_PROFILE_VC1_SIMPLE 0
3016 #define FF_PROFILE_VC1_MAIN 1
3017 #define FF_PROFILE_VC1_COMPLEX 2
3018 #define FF_PROFILE_VC1_ADVANCED 3
3020 #define FF_PROFILE_MPEG4_SIMPLE 0
3021 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3022 #define FF_PROFILE_MPEG4_CORE 2
3023 #define FF_PROFILE_MPEG4_MAIN 3
3024 #define FF_PROFILE_MPEG4_N_BIT 4
3025 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3026 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3027 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3028 #define FF_PROFILE_MPEG4_HYBRID 8
3029 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3030 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3031 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3032 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3033 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3034 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3035 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3037 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
3038 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
3039 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
3040 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3041 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3043 #define FF_PROFILE_VP9_0 0
3044 #define FF_PROFILE_VP9_1 1
3045 #define FF_PROFILE_VP9_2 2
3046 #define FF_PROFILE_VP9_3 3
3048 #define FF_PROFILE_HEVC_MAIN 1
3049 #define FF_PROFILE_HEVC_MAIN_10 2
3050 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3051 #define FF_PROFILE_HEVC_REXT 4
3055 * - encoding: Set by user.
3056 * - decoding: Set by libavcodec.
3059 #define FF_LEVEL_UNKNOWN -99
3062 * Skip loop filtering for selected frames.
3063 * - encoding: unused
3064 * - decoding: Set by user.
3066 enum AVDiscard skip_loop_filter;
3069 * Skip IDCT/dequantization for selected frames.
3070 * - encoding: unused
3071 * - decoding: Set by user.
3073 enum AVDiscard skip_idct;
3076 * Skip decoding for selected frames.
3077 * - encoding: unused
3078 * - decoding: Set by user.
3080 enum AVDiscard skip_frame;
3083 * Header containing style information for text subtitles.
3084 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3085 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3086 * the Format line following. It shouldn't include any Dialogue line.
3087 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3088 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3090 uint8_t *subtitle_header;
3091 int subtitle_header_size;
3093 #if FF_API_ERROR_RATE
3095 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3098 attribute_deprecated
3103 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3104 * Used for compliant TS muxing.
3105 * - encoding: Set by libavcodec.
3106 * - decoding: unused.
3110 #if FF_API_SIDEDATA_ONLY_PKT
3112 * Encoding only and set by default. Allow encoders to output packets
3113 * that do not contain any encoded data, only side data.
3115 * Some encoders need to output such packets, e.g. to update some stream
3116 * parameters at the end of encoding.
3118 * @deprecated this field disables the default behaviour and
3119 * it is kept only for compatibility.
3121 attribute_deprecated
3122 int side_data_only_packets;
3126 * Audio only. The number of "priming" samples (padding) inserted by the
3127 * encoder at the beginning of the audio. I.e. this number of leading
3128 * decoded samples must be discarded by the caller to get the original audio
3129 * without leading padding.
3131 * - decoding: unused
3132 * - encoding: Set by libavcodec. The timestamps on the output packets are
3133 * adjusted by the encoder so that they always refer to the
3134 * first sample of the data actually contained in the packet,
3135 * including any added padding. E.g. if the timebase is
3136 * 1/samplerate and the timestamp of the first input sample is
3137 * 0, the timestamp of the first output packet will be
3140 int initial_padding;
3143 * - decoding: For codecs that store a framerate value in the compressed
3144 * bitstream, the decoder may export it here. { 0, 1} when
3146 * - encoding: unused
3148 AVRational framerate;
3151 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3152 * - encoding: unused.
3153 * - decoding: Set by libavcodec before calling get_format()
3155 enum AVPixelFormat sw_pix_fmt;
3158 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3159 * Code outside libavcodec should access this field using:
3160 * av_codec_{get,set}_pkt_timebase(avctx)
3161 * - encoding unused.
3162 * - decoding set by user.
3164 AVRational pkt_timebase;
3168 * Code outside libavcodec should access this field using:
3169 * av_codec_{get,set}_codec_descriptor(avctx)
3170 * - encoding: unused.
3171 * - decoding: set by libavcodec.
3173 const AVCodecDescriptor *codec_descriptor;
3177 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3178 * - encoding: unused
3179 * - decoding: Set by user.
3180 * Code outside libavcodec should access this field using:
3181 * av_codec_{get,set}_lowres(avctx)
3187 * Current statistics for PTS correction.
3188 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3189 * - encoding: unused
3191 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3192 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3193 int64_t pts_correction_last_pts; /// PTS of the last frame
3194 int64_t pts_correction_last_dts; /// DTS of the last frame
3197 * Character encoding of the input subtitles file.
3198 * - decoding: set by user
3199 * - encoding: unused
3204 * Subtitles character encoding mode. Formats or codecs might be adjusting
3205 * this setting (if they are doing the conversion themselves for instance).
3206 * - decoding: set by libavcodec
3207 * - encoding: unused
3209 int sub_charenc_mode;
3210 #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)
3211 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3212 #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
3215 * Skip processing alpha if supported by codec.
3216 * Note that if the format uses pre-multiplied alpha (common with VP6,
3217 * and recommended due to better video quality/compression)
3218 * the image will look as if alpha-blended onto a black background.
3219 * However for formats that do not use pre-multiplied alpha
3220 * there might be serious artefacts (though e.g. libswscale currently
3221 * assumes pre-multiplied alpha anyway).
3222 * Code outside libavcodec should access this field using AVOptions
3224 * - decoding: set by user
3225 * - encoding: unused
3230 * Number of samples to skip after a discontinuity
3231 * - decoding: unused
3232 * - encoding: set by libavcodec
3236 #if !FF_API_DEBUG_MV
3238 * debug motion vectors
3239 * Code outside libavcodec should access this field using AVOptions
3240 * - encoding: Set by user.
3241 * - decoding: Set by user.
3244 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3245 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3246 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3250 * custom intra quantization matrix
3251 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3252 * - encoding: Set by user, can be NULL.
3253 * - decoding: unused.
3255 uint16_t *chroma_intra_matrix;
3258 * dump format separator.
3259 * can be ", " or "\n " or anything else
3260 * Code outside libavcodec should access this field using AVOptions
3261 * (NO direct access).
3262 * - encoding: Set by user.
3263 * - decoding: Set by user.
3265 uint8_t *dump_separator;
3268 * ',' separated list of allowed decoders.
3269 * If NULL then all are allowed
3270 * - encoding: unused
3271 * - decoding: set by user through AVOPtions (NO direct access)
3273 char *codec_whitelist;
3276 * Properties of the stream that gets decoded
3277 * To be accessed through av_codec_get_properties() (NO direct access)
3278 * - encoding: unused
3279 * - decoding: set by libavcodec
3281 unsigned properties;
3282 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3283 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3286 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3287 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3289 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3290 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3292 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3294 int av_codec_get_lowres(const AVCodecContext *avctx);
3295 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3297 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3298 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3300 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3301 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3306 typedef struct AVProfile {
3308 const char *name; ///< short name for the profile
3311 typedef struct AVCodecDefault AVCodecDefault;
3318 typedef struct AVCodec {
3320 * Name of the codec implementation.
3321 * The name is globally unique among encoders and among decoders (but an
3322 * encoder and a decoder can share the same name).
3323 * This is the primary way to find a codec from the user perspective.
3327 * Descriptive name for the codec, meant to be more human readable than name.
3328 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3330 const char *long_name;
3331 enum AVMediaType type;
3334 * Codec capabilities.
3335 * see AV_CODEC_CAP_*
3338 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3339 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3340 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3341 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3342 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3343 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3344 const AVClass *priv_class; ///< AVClass for the private context
3345 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3347 /*****************************************************************
3348 * No fields below this line are part of the public API. They
3349 * may not be used outside of libavcodec and can be changed and
3351 * New public fields should be added right above.
3352 *****************************************************************
3355 struct AVCodec *next;
3357 * @name Frame-level threading support functions
3361 * If defined, called on thread contexts when they are created.
3362 * If the codec allocates writable tables in init(), re-allocate them here.
3363 * priv_data will be set to a copy of the original.
3365 int (*init_thread_copy)(AVCodecContext *);
3367 * Copy necessary context variables from a previous thread context to the current one.
3368 * If not defined, the next thread will start automatically; otherwise, the codec
3369 * must call ff_thread_finish_setup().
3371 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3373 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3377 * Private codec-specific defaults.
3379 const AVCodecDefault *defaults;
3382 * Initialize codec static data, called from avcodec_register().
3384 void (*init_static_data)(struct AVCodec *codec);
3386 int (*init)(AVCodecContext *);
3387 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3388 const struct AVSubtitle *sub);
3390 * Encode data to an AVPacket.
3392 * @param avctx codec context
3393 * @param avpkt output AVPacket (may contain a user-provided buffer)
3394 * @param[in] frame AVFrame containing the raw data to be encoded
3395 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3396 * non-empty packet was returned in avpkt.
3397 * @return 0 on success, negative error code on failure
3399 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3400 int *got_packet_ptr);
3401 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3402 int (*close)(AVCodecContext *);
3405 * Will be called when seeking
3407 void (*flush)(AVCodecContext *);
3409 * Internal codec capabilities.
3410 * See FF_CODEC_CAP_* in internal.h
3415 int av_codec_get_max_lowres(const AVCodec *codec);
3417 struct MpegEncContext;
3420 * @defgroup lavc_hwaccel AVHWAccel
3423 typedef struct AVHWAccel {
3425 * Name of the hardware accelerated codec.
3426 * The name is globally unique among encoders and among decoders (but an
3427 * encoder and a decoder can share the same name).
3432 * Type of codec implemented by the hardware accelerator.
3434 * See AVMEDIA_TYPE_xxx
3436 enum AVMediaType type;
3439 * Codec implemented by the hardware accelerator.
3441 * See AV_CODEC_ID_xxx
3446 * Supported pixel format.
3448 * Only hardware accelerated formats are supported here.
3450 enum AVPixelFormat pix_fmt;
3453 * Hardware accelerated codec capabilities.
3454 * see HWACCEL_CODEC_CAP_*
3458 /*****************************************************************
3459 * No fields below this line are part of the public API. They
3460 * may not be used outside of libavcodec and can be changed and
3462 * New public fields should be added right above.
3463 *****************************************************************
3465 struct AVHWAccel *next;
3468 * Allocate a custom buffer
3470 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3473 * Called at the beginning of each frame or field picture.
3475 * Meaningful frame information (codec specific) is guaranteed to
3476 * be parsed at this point. This function is mandatory.
3478 * Note that buf can be NULL along with buf_size set to 0.
3479 * Otherwise, this means the whole frame is available at this point.
3481 * @param avctx the codec context
3482 * @param buf the frame data buffer base
3483 * @param buf_size the size of the frame in bytes
3484 * @return zero if successful, a negative value otherwise
3486 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3489 * Callback for each slice.
3491 * Meaningful slice information (codec specific) is guaranteed to
3492 * be parsed at this point. This function is mandatory.
3493 * The only exception is XvMC, that works on MB level.
3495 * @param avctx the codec context
3496 * @param buf the slice data buffer base
3497 * @param buf_size the size of the slice in bytes
3498 * @return zero if successful, a negative value otherwise
3500 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3503 * Called at the end of each frame or field picture.
3505 * The whole picture is parsed at this point and can now be sent
3506 * to the hardware accelerator. This function is mandatory.
3508 * @param avctx the codec context
3509 * @return zero if successful, a negative value otherwise
3511 int (*end_frame)(AVCodecContext *avctx);
3514 * Size of per-frame hardware accelerator private data.
3516 * Private data is allocated with av_mallocz() before
3517 * AVCodecContext.get_buffer() and deallocated after
3518 * AVCodecContext.release_buffer().
3520 int frame_priv_data_size;
3523 * Called for every Macroblock in a slice.
3525 * XvMC uses it to replace the ff_mpv_decode_mb().
3526 * Instead of decoding to raw picture, MB parameters are
3527 * stored in an array provided by the video driver.
3529 * @param s the mpeg context
3531 void (*decode_mb)(struct MpegEncContext *s);
3534 * Initialize the hwaccel private data.
3536 * This will be called from ff_get_format(), after hwaccel and
3537 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3540 int (*init)(AVCodecContext *avctx);
3543 * Uninitialize the hwaccel private data.
3545 * This will be called from get_format() or avcodec_close(), after hwaccel
3546 * and hwaccel_context are already uninitialized.
3548 int (*uninit)(AVCodecContext *avctx);
3551 * Size of the private data to allocate in
3552 * AVCodecInternal.hwaccel_priv_data.
3558 * Hardware acceleration should be used for decoding even if the codec level
3559 * used is unknown or higher than the maximum supported level reported by the
3562 * It's generally a good idea to pass this flag unless you have a specific
3563 * reason not to, as hardware tends to under-report supported levels.
3565 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3568 * Hardware acceleration can output YUV pixel formats with a different chroma
3569 * sampling than 4:2:0 and/or other than 8 bits per component.
3571 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3578 * @defgroup lavc_picture AVPicture
3580 * Functions for working with AVPicture
3585 * Picture data structure.
3587 * Up to four components can be stored into it, the last component is
3590 typedef struct AVPicture {
3591 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3592 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3599 enum AVSubtitleType {
3602 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3605 * Plain text, the text field must be set by the decoder and is
3606 * authoritative. ass and pict fields may contain approximations.
3611 * Formatted text, the ass field must be set by the decoder and is
3612 * authoritative. pict and text fields may contain approximations.
3617 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3619 typedef struct AVSubtitleRect {
3620 int x; ///< top left corner of pict, undefined when pict is not set
3621 int y; ///< top left corner of pict, undefined when pict is not set
3622 int w; ///< width of pict, undefined when pict is not set
3623 int h; ///< height of pict, undefined when pict is not set
3624 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3627 * data+linesize for the bitmap of this subtitle.
3628 * can be set for text/ass as well once they are rendered
3631 enum AVSubtitleType type;
3633 char *text; ///< 0 terminated plain UTF-8 text
3636 * 0 terminated ASS/SSA compatible event line.
3637 * The presentation of this is unaffected by the other values in this
3645 typedef struct AVSubtitle {
3646 uint16_t format; /* 0 = graphics */
3647 uint32_t start_display_time; /* relative to packet pts, in ms */
3648 uint32_t end_display_time; /* relative to packet pts, in ms */
3650 AVSubtitleRect **rects;
3651 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3655 * If c is NULL, returns the first registered codec,
3656 * if c is non-NULL, returns the next registered codec after c,
3657 * or NULL if c is the last one.
3659 AVCodec *av_codec_next(const AVCodec *c);
3662 * Return the LIBAVCODEC_VERSION_INT constant.
3664 unsigned avcodec_version(void);
3667 * Return the libavcodec build-time configuration.
3669 const char *avcodec_configuration(void);
3672 * Return the libavcodec license.
3674 const char *avcodec_license(void);
3677 * Register the codec codec and initialize libavcodec.
3679 * @warning either this function or avcodec_register_all() must be called
3680 * before any other libavcodec functions.
3682 * @see avcodec_register_all()
3684 void avcodec_register(AVCodec *codec);
3687 * Register all the codecs, parsers and bitstream filters which were enabled at
3688 * configuration time. If you do not call this function you can select exactly
3689 * which formats you want to support, by using the individual registration
3692 * @see avcodec_register
3693 * @see av_register_codec_parser
3694 * @see av_register_bitstream_filter
3696 void avcodec_register_all(void);
3699 * Allocate an AVCodecContext and set its fields to default values. The
3700 * resulting struct should be freed with avcodec_free_context().
3702 * @param codec if non-NULL, allocate private data and initialize defaults
3703 * for the given codec. It is illegal to then call avcodec_open2()
3704 * with a different codec.
3705 * If NULL, then the codec-specific defaults won't be initialized,
3706 * which may result in suboptimal default settings (this is
3707 * important mainly for encoders, e.g. libx264).
3709 * @return An AVCodecContext filled with default values or NULL on failure.
3710 * @see avcodec_get_context_defaults
3712 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3715 * Free the codec context and everything associated with it and write NULL to
3716 * the provided pointer.
3718 void avcodec_free_context(AVCodecContext **avctx);
3721 * Set the fields of the given AVCodecContext to default values corresponding
3722 * to the given codec (defaults may be codec-dependent).
3724 * Do not call this function if a non-NULL codec has been passed
3725 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3726 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3727 * different codec on this AVCodecContext.
3729 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3732 * Get the AVClass for AVCodecContext. It can be used in combination with
3733 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3735 * @see av_opt_find().
3737 const AVClass *avcodec_get_class(void);
3740 * Get the AVClass for AVFrame. It can be used in combination with
3741 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3743 * @see av_opt_find().
3745 const AVClass *avcodec_get_frame_class(void);
3748 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3749 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3751 * @see av_opt_find().
3753 const AVClass *avcodec_get_subtitle_rect_class(void);
3756 * Copy the settings of the source AVCodecContext into the destination
3757 * AVCodecContext. The resulting destination codec context will be
3758 * unopened, i.e. you are required to call avcodec_open2() before you
3759 * can use this AVCodecContext to decode/encode video/audio data.
3761 * @param dest target codec context, should be initialized with
3762 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3763 * @param src source codec context
3764 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3766 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3769 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3770 * function the context has to be allocated with avcodec_alloc_context3().
3772 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3773 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3774 * retrieving a codec.
3776 * @warning This function is not thread safe!
3778 * @note Always call this function before using decoding routines (such as
3779 * @ref avcodec_decode_video2()).
3782 * avcodec_register_all();
3783 * av_dict_set(&opts, "b", "2.5M", 0);
3784 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3788 * context = avcodec_alloc_context3(codec);
3790 * if (avcodec_open2(context, codec, opts) < 0)
3794 * @param avctx The context to initialize.
3795 * @param codec The codec to open this context for. If a non-NULL codec has been
3796 * previously passed to avcodec_alloc_context3() or
3797 * avcodec_get_context_defaults3() for this context, then this
3798 * parameter MUST be either NULL or equal to the previously passed
3800 * @param options A dictionary filled with AVCodecContext and codec-private options.
3801 * On return this object will be filled with options that were not found.
3803 * @return zero on success, a negative value on error
3804 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3805 * av_dict_set(), av_opt_find().
3807 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3810 * Close a given AVCodecContext and free all the data associated with it
3811 * (but not the AVCodecContext itself).
3813 * Calling this function on an AVCodecContext that hasn't been opened will free
3814 * the codec-specific data allocated in avcodec_alloc_context3() /
3815 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3818 int avcodec_close(AVCodecContext *avctx);
3821 * Free all allocated data in the given subtitle struct.
3823 * @param sub AVSubtitle to free.
3825 void avsubtitle_free(AVSubtitle *sub);
3832 * @addtogroup lavc_packet
3837 * Initialize optional fields of a packet with default values.
3839 * Note, this does not touch the data and size members, which have to be
3840 * initialized separately.
3844 void av_init_packet(AVPacket *pkt);
3847 * Allocate the payload of a packet and initialize its fields with
3851 * @param size wanted payload size
3852 * @return 0 if OK, AVERROR_xxx otherwise
3854 int av_new_packet(AVPacket *pkt, int size);
3857 * Reduce packet size, correctly zeroing padding
3860 * @param size new size
3862 void av_shrink_packet(AVPacket *pkt, int size);
3865 * Increase packet size, correctly zeroing padding
3868 * @param grow_by number of bytes by which to increase the size of the packet
3870 int av_grow_packet(AVPacket *pkt, int grow_by);
3873 * Initialize a reference-counted packet from av_malloc()ed data.
3875 * @param pkt packet to be initialized. This function will set the data, size,
3876 * buf and destruct fields, all others are left untouched.
3877 * @param data Data allocated by av_malloc() to be used as packet data. If this
3878 * function returns successfully, the data is owned by the underlying AVBuffer.
3879 * The caller may not access the data through other means.
3880 * @param size size of data in bytes, without the padding. I.e. the full buffer
3881 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
3883 * @return 0 on success, a negative AVERROR on error
3885 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3888 * @warning This is a hack - the packet memory allocation stuff is broken. The
3889 * packet is allocated if it was not really allocated.
3891 int av_dup_packet(AVPacket *pkt);
3894 * Copy packet, including contents
3896 * @return 0 on success, negative AVERROR on fail
3898 int av_copy_packet(AVPacket *dst, const AVPacket *src);
3901 * Copy packet side data
3903 * @return 0 on success, negative AVERROR on fail
3905 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
3910 * @param pkt packet to free
3912 void av_free_packet(AVPacket *pkt);
3915 * Allocate new information of a packet.
3918 * @param type side information type
3919 * @param size side information size
3920 * @return pointer to fresh allocated data or NULL otherwise
3922 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3926 * Shrink the already allocated side data buffer
3929 * @param type side information type
3930 * @param size new side information size
3931 * @return 0 on success, < 0 on failure
3933 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3937 * Get side information from packet.
3940 * @param type desired side information type
3941 * @param size pointer for side information size to store (optional)
3942 * @return pointer to data if present or NULL otherwise
3944 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3947 int av_packet_merge_side_data(AVPacket *pkt);
3949 int av_packet_split_side_data(AVPacket *pkt);
3951 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
3954 * Pack a dictionary for use in side_data.
3956 * @param dict The dictionary to pack.
3957 * @param size pointer to store the size of the returned data
3958 * @return pointer to data if successful, NULL otherwise
3960 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
3962 * Unpack a dictionary from side_data.
3964 * @param data data from side_data
3965 * @param size size of the data
3966 * @param dict the metadata storage dictionary
3967 * @return 0 on success, < 0 on failure
3969 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
3973 * Convenience function to free all the side data stored.
3974 * All the other fields stay untouched.
3978 void av_packet_free_side_data(AVPacket *pkt);
3981 * Setup a new reference to the data described by a given packet
3983 * If src is reference-counted, setup dst as a new reference to the
3984 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3985 * data from src into it.
3987 * All the other fields are copied from src.
3989 * @see av_packet_unref
3991 * @param dst Destination packet
3992 * @param src Source packet
3994 * @return 0 on success, a negative AVERROR on error.
3996 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4001 * Unreference the buffer referenced by the packet and reset the
4002 * remaining packet fields to their default values.
4004 * @param pkt The packet to be unreferenced.
4006 void av_packet_unref(AVPacket *pkt);
4009 * Move every field in src to dst and reset src.
4011 * @see av_packet_unref
4013 * @param src Source packet, will be reset
4014 * @param dst Destination packet
4016 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4019 * Copy only "properties" fields from src to dst.
4021 * Properties for the purpose of this function are all the fields
4022 * beside those related to the packet data (buf, data, size)
4024 * @param dst Destination packet
4025 * @param src Source packet
4027 * @return 0 on success AVERROR on failure.
4030 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4033 * Convert valid timing fields (timestamps / durations) in a packet from one
4034 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4037 * @param pkt packet on which the conversion will be performed
4038 * @param tb_src source timebase, in which the timing fields in pkt are
4040 * @param tb_dst destination timebase, to which the timing fields will be
4043 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4050 * @addtogroup lavc_decoding
4055 * Find a registered decoder with a matching codec ID.
4057 * @param id AVCodecID of the requested decoder
4058 * @return A decoder if one was found, NULL otherwise.
4060 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4063 * Find a registered decoder with the specified name.
4065 * @param name name of the requested decoder
4066 * @return A decoder if one was found, NULL otherwise.
4068 AVCodec *avcodec_find_decoder_by_name(const char *name);
4071 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4072 * it can be called by custom get_buffer2() implementations for decoders without
4073 * AV_CODEC_CAP_DR1 set.
4075 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4079 * Return the amount of padding in pixels which the get_buffer callback must
4080 * provide around the edge of the image for codecs which do not have the
4081 * CODEC_FLAG_EMU_EDGE flag.
4083 * @return Required padding in pixels.
4085 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4088 attribute_deprecated
4089 unsigned avcodec_get_edge_width(void);
4093 * Modify width and height values so that they will result in a memory
4094 * buffer that is acceptable for the codec if you do not use any horizontal
4097 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4099 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4102 * Modify width and height values so that they will result in a memory
4103 * buffer that is acceptable for the codec if you also ensure that all
4104 * line sizes are a multiple of the respective linesize_align[i].
4106 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4108 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4109 int linesize_align[AV_NUM_DATA_POINTERS]);
4112 * Converts AVChromaLocation to swscale x/y chroma position.
4114 * The positions represent the chroma (0,0) position in a coordinates system
4115 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4117 * @param xpos horizontal chroma sample position
4118 * @param ypos vertical chroma sample position
4120 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4123 * Converts swscale x/y chroma position to AVChromaLocation.
4125 * The positions represent the chroma (0,0) position in a coordinates system
4126 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4128 * @param xpos horizontal chroma sample position
4129 * @param ypos vertical chroma sample position
4131 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4134 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4136 * Some decoders may support multiple frames in a single AVPacket. Such
4137 * decoders would then just decode the first frame and the return value would be
4138 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4139 * called again with an AVPacket containing the remaining data in order to
4140 * decode the second frame, etc... Even if no frames are returned, the packet
4141 * needs to be fed to the decoder with remaining data until it is completely
4142 * consumed or an error occurs.
4144 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4145 * and output. This means that for some packets they will not immediately
4146 * produce decoded output and need to be flushed at the end of decoding to get
4147 * all the decoded data. Flushing is done by calling this function with packets
4148 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4149 * returning samples. It is safe to flush even those decoders that are not
4150 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4152 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4153 * larger than the actual read bytes because some optimized bitstream
4154 * readers read 32 or 64 bits at once and could read over the end.
4156 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4157 * before packets may be fed to the decoder.
4159 * @param avctx the codec context
4160 * @param[out] frame The AVFrame in which to store decoded audio samples.
4161 * The decoder will allocate a buffer for the decoded frame by
4162 * calling the AVCodecContext.get_buffer2() callback.
4163 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4164 * reference counted and the returned reference belongs to the
4165 * caller. The caller must release the frame using av_frame_unref()
4166 * when the frame is no longer needed. The caller may safely write
4167 * to the frame if av_frame_is_writable() returns 1.
4168 * When AVCodecContext.refcounted_frames is set to 0, the returned
4169 * reference belongs to the decoder and is valid only until the
4170 * next call to this function or until closing or flushing the
4171 * decoder. The caller may not write to it.
4172 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4173 * non-zero. Note that this field being set to zero
4174 * does not mean that an error has occurred. For
4175 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4176 * call is guaranteed to produce a frame.
4177 * @param[in] avpkt The input AVPacket containing the input buffer.
4178 * At least avpkt->data and avpkt->size should be set. Some
4179 * decoders might also require additional fields to be set.
4180 * @return A negative error code is returned if an error occurred during
4181 * decoding, otherwise the number of bytes consumed from the input
4182 * AVPacket is returned.
4184 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4185 int *got_frame_ptr, const AVPacket *avpkt);
4188 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4189 * Some decoders may support multiple frames in a single AVPacket, such
4190 * decoders would then just decode the first frame.
4192 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4193 * the actual read bytes because some optimized bitstream readers read 32 or 64
4194 * bits at once and could read over the end.
4196 * @warning The end of the input buffer buf should be set to 0 to ensure that
4197 * no overreading happens for damaged MPEG streams.
4199 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4200 * between input and output, these need to be fed with avpkt->data=NULL,
4201 * avpkt->size=0 at the end to return the remaining frames.
4203 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4204 * before packets may be fed to the decoder.
4206 * @param avctx the codec context
4207 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4208 * Use av_frame_alloc() to get an AVFrame. The codec will
4209 * allocate memory for the actual bitmap by calling the
4210 * AVCodecContext.get_buffer2() callback.
4211 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4212 * reference counted and the returned reference belongs to the
4213 * caller. The caller must release the frame using av_frame_unref()
4214 * when the frame is no longer needed. The caller may safely write
4215 * to the frame if av_frame_is_writable() returns 1.
4216 * When AVCodecContext.refcounted_frames is set to 0, the returned
4217 * reference belongs to the decoder and is valid only until the
4218 * next call to this function or until closing or flushing the
4219 * decoder. The caller may not write to it.
4221 * @param[in] avpkt The input AVPacket containing the input buffer.
4222 * You can create such packet with av_init_packet() and by then setting
4223 * data and size, some decoders might in addition need other fields like
4224 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4226 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4227 * @return On error a negative value is returned, otherwise the number of bytes
4228 * used or zero if no frame could be decompressed.
4230 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4231 int *got_picture_ptr,
4232 const AVPacket *avpkt);
4235 * Decode a subtitle message.
4236 * Return a negative value on error, otherwise return the number of bytes used.
4237 * If no subtitle could be decompressed, got_sub_ptr is zero.
4238 * Otherwise, the subtitle is stored in *sub.
4239 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4240 * simplicity, because the performance difference is expect to be negligible
4241 * and reusing a get_buffer written for video codecs would probably perform badly
4242 * due to a potentially very different allocation pattern.
4244 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4245 * and output. This means that for some packets they will not immediately
4246 * produce decoded output and need to be flushed at the end of decoding to get
4247 * all the decoded data. Flushing is done by calling this function with packets
4248 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4249 * returning subtitles. It is safe to flush even those decoders that are not
4250 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4252 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4253 * before packets may be fed to the decoder.
4255 * @param avctx the codec context
4256 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4257 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4258 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4259 * @param[in] avpkt The input AVPacket containing the input buffer.
4261 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4266 * @defgroup lavc_parsing Frame parsing
4270 enum AVPictureStructure {
4271 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4272 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4273 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4274 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4277 typedef struct AVCodecParserContext {
4279 struct AVCodecParser *parser;
4280 int64_t frame_offset; /* offset of the current frame */
4281 int64_t cur_offset; /* current offset
4282 (incremented by each av_parser_parse()) */
4283 int64_t next_frame_offset; /* offset of the next frame */
4285 int pict_type; /* XXX: Put it back in AVCodecContext. */
4287 * This field is used for proper frame duration computation in lavf.
4288 * It signals, how much longer the frame duration of the current frame
4289 * is compared to normal frame duration.
4291 * frame_duration = (1 + repeat_pict) * time_base
4293 * It is used by codecs like H.264 to display telecined material.
4295 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4296 int64_t pts; /* pts of the current frame */
4297 int64_t dts; /* dts of the current frame */
4302 int fetch_timestamp;
4304 #define AV_PARSER_PTS_NB 4
4305 int cur_frame_start_index;
4306 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4307 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4308 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4311 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4312 #define PARSER_FLAG_ONCE 0x0002
4313 /// Set if the parser has a valid file offset
4314 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4315 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4317 int64_t offset; ///< byte offset from starting packet start
4318 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4321 * Set by parser to 1 for key frames and 0 for non-key frames.
4322 * It is initialized to -1, so if the parser doesn't set this flag,
4323 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4329 * Time difference in stream time base units from the pts of this
4330 * packet to the point at which the output from the decoder has converged
4331 * independent from the availability of previous frames. That is, the
4332 * frames are virtually identical no matter if decoding started from
4333 * the very first frame or from this keyframe.
4334 * Is AV_NOPTS_VALUE if unknown.
4335 * This field is not the display duration of the current frame.
4336 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4339 * The purpose of this field is to allow seeking in streams that have no
4340 * keyframes in the conventional sense. It corresponds to the
4341 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4342 * essential for some types of subtitle streams to ensure that all
4343 * subtitles are correctly displayed after seeking.
4345 int64_t convergence_duration;
4347 // Timestamp generation support:
4349 * Synchronization point for start of timestamp generation.
4351 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4354 * For example, this corresponds to presence of H.264 buffering period
4360 * Offset of the current timestamp against last timestamp sync point in
4361 * units of AVCodecContext.time_base.
4363 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4364 * contain a valid timestamp offset.
4366 * Note that the timestamp of sync point has usually a nonzero
4367 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4368 * the next frame after timestamp sync point will be usually 1.
4370 * For example, this corresponds to H.264 cpb_removal_delay.
4372 int dts_ref_dts_delta;
4375 * Presentation delay of current frame in units of AVCodecContext.time_base.
4377 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4378 * contain valid non-negative timestamp delta (presentation time of a frame
4379 * must not lie in the past).
4381 * This delay represents the difference between decoding and presentation
4382 * time of the frame.
4384 * For example, this corresponds to H.264 dpb_output_delay.
4389 * Position of the packet in file.
4391 * Analogous to cur_frame_pts/dts
4393 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4396 * Byte position of currently parsed frame in stream.
4401 * Previous frame byte position.
4406 * Duration of the current frame.
4407 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4408 * For all other types, this is in units of AVCodecContext.time_base.
4412 enum AVFieldOrder field_order;
4415 * Indicate whether a picture is coded as a frame, top field or bottom field.
4417 * For example, H.264 field_pic_flag equal to 0 corresponds to
4418 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4419 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4420 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4422 enum AVPictureStructure picture_structure;
4425 * Picture number incremented in presentation or output order.
4426 * This field may be reinitialized at the first picture of a new sequence.
4428 * For example, this corresponds to H.264 PicOrderCnt.
4430 int output_picture_number;
4433 * Dimensions of the decoded video intended for presentation.
4439 * Dimensions of the coded video.
4445 * The format of the coded data, corresponds to enum AVPixelFormat for video
4446 * and for enum AVSampleFormat for audio.
4448 * Note that a decoder can have considerable freedom in how exactly it
4449 * decodes the data, so the format reported here might be different from the
4450 * one returned by a decoder.
4453 } AVCodecParserContext;
4455 typedef struct AVCodecParser {
4456 int codec_ids[5]; /* several codec IDs are permitted */
4458 int (*parser_init)(AVCodecParserContext *s);
4459 /* This callback never returns an error, a negative value means that
4460 * the frame start was in a previous packet. */
4461 int (*parser_parse)(AVCodecParserContext *s,
4462 AVCodecContext *avctx,
4463 const uint8_t **poutbuf, int *poutbuf_size,
4464 const uint8_t *buf, int buf_size);
4465 void (*parser_close)(AVCodecParserContext *s);
4466 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4467 struct AVCodecParser *next;
4470 AVCodecParser *av_parser_next(const AVCodecParser *c);
4472 void av_register_codec_parser(AVCodecParser *parser);
4473 AVCodecParserContext *av_parser_init(int codec_id);
4478 * @param s parser context.
4479 * @param avctx codec context.
4480 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4481 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4482 * @param buf input buffer.
4483 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4484 * @param pts input presentation timestamp.
4485 * @param dts input decoding timestamp.
4486 * @param pos input byte position in stream.
4487 * @return the number of bytes of the input bitstream used.
4492 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4499 * decode_frame(data, size);
4503 int av_parser_parse2(AVCodecParserContext *s,
4504 AVCodecContext *avctx,
4505 uint8_t **poutbuf, int *poutbuf_size,
4506 const uint8_t *buf, int buf_size,
4507 int64_t pts, int64_t dts,
4511 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4512 * @deprecated use AVBitStreamFilter
4514 int av_parser_change(AVCodecParserContext *s,
4515 AVCodecContext *avctx,
4516 uint8_t **poutbuf, int *poutbuf_size,
4517 const uint8_t *buf, int buf_size, int keyframe);
4518 void av_parser_close(AVCodecParserContext *s);
4526 * @addtogroup lavc_encoding
4531 * Find a registered encoder with a matching codec ID.
4533 * @param id AVCodecID of the requested encoder
4534 * @return An encoder if one was found, NULL otherwise.
4536 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4539 * Find a registered encoder with the specified name.
4541 * @param name name of the requested encoder
4542 * @return An encoder if one was found, NULL otherwise.
4544 AVCodec *avcodec_find_encoder_by_name(const char *name);
4547 * Encode a frame of audio.
4549 * Takes input samples from frame and writes the next output packet, if
4550 * available, to avpkt. The output packet does not necessarily contain data for
4551 * the most recent frame, as encoders can delay, split, and combine input frames
4552 * internally as needed.
4554 * @param avctx codec context
4555 * @param avpkt output AVPacket.
4556 * The user can supply an output buffer by setting
4557 * avpkt->data and avpkt->size prior to calling the
4558 * function, but if the size of the user-provided data is not
4559 * large enough, encoding will fail. If avpkt->data and
4560 * avpkt->size are set, avpkt->destruct must also be set. All
4561 * other AVPacket fields will be reset by the encoder using
4562 * av_init_packet(). If avpkt->data is NULL, the encoder will
4563 * allocate it. The encoder will set avpkt->size to the size
4564 * of the output packet.
4566 * If this function fails or produces no output, avpkt will be
4567 * freed using av_free_packet() (i.e. avpkt->destruct will be
4568 * called to free the user supplied buffer).
4569 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4570 * May be NULL when flushing an encoder that has the
4571 * AV_CODEC_CAP_DELAY capability set.
4572 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4573 * can have any number of samples.
4574 * If it is not set, frame->nb_samples must be equal to
4575 * avctx->frame_size for all frames except the last.
4576 * The final frame may be smaller than avctx->frame_size.
4577 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4578 * output packet is non-empty, and to 0 if it is
4579 * empty. If the function returns an error, the
4580 * packet can be assumed to be invalid, and the
4581 * value of got_packet_ptr is undefined and should
4583 * @return 0 on success, negative error code on failure
4585 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4586 const AVFrame *frame, int *got_packet_ptr);
4589 * Encode a frame of video.
4591 * Takes input raw video data from frame and writes the next output packet, if
4592 * available, to avpkt. The output packet does not necessarily contain data for
4593 * the most recent frame, as encoders can delay and reorder input frames
4594 * internally as needed.
4596 * @param avctx codec context
4597 * @param avpkt output AVPacket.
4598 * The user can supply an output buffer by setting
4599 * avpkt->data and avpkt->size prior to calling the
4600 * function, but if the size of the user-provided data is not
4601 * large enough, encoding will fail. All other AVPacket fields
4602 * will be reset by the encoder using av_init_packet(). If
4603 * avpkt->data is NULL, the encoder will allocate it.
4604 * The encoder will set avpkt->size to the size of the
4605 * output packet. The returned data (if any) belongs to the
4606 * caller, he is responsible for freeing it.
4608 * If this function fails or produces no output, avpkt will be
4609 * freed using av_free_packet() (i.e. avpkt->destruct will be
4610 * called to free the user supplied buffer).
4611 * @param[in] frame AVFrame containing the raw video data to be encoded.
4612 * May be NULL when flushing an encoder that has the
4613 * AV_CODEC_CAP_DELAY capability set.
4614 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4615 * output packet is non-empty, and to 0 if it is
4616 * empty. If the function returns an error, the
4617 * packet can be assumed to be invalid, and the
4618 * value of got_packet_ptr is undefined and should
4620 * @return 0 on success, negative error code on failure
4622 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4623 const AVFrame *frame, int *got_packet_ptr);
4625 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4626 const AVSubtitle *sub);
4633 #if FF_API_AVCODEC_RESAMPLE
4635 * @defgroup lavc_resample Audio resampling
4637 * @deprecated use libswresample instead
4641 struct ReSampleContext;
4642 struct AVResampleContext;
4644 typedef struct ReSampleContext ReSampleContext;
4647 * Initialize audio resampling context.
4649 * @param output_channels number of output channels
4650 * @param input_channels number of input channels
4651 * @param output_rate output sample rate
4652 * @param input_rate input sample rate
4653 * @param sample_fmt_out requested output sample format
4654 * @param sample_fmt_in input sample format
4655 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4656 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4657 * @param linear if 1 then the used FIR filter will be linearly interpolated
4658 between the 2 closest, if 0 the closest will be used
4659 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4660 * @return allocated ReSampleContext, NULL if error occurred
4662 attribute_deprecated
4663 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4664 int output_rate, int input_rate,
4665 enum AVSampleFormat sample_fmt_out,
4666 enum AVSampleFormat sample_fmt_in,
4667 int filter_length, int log2_phase_count,
4668 int linear, double cutoff);
4670 attribute_deprecated
4671 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4674 * Free resample context.
4676 * @param s a non-NULL pointer to a resample context previously
4677 * created with av_audio_resample_init()
4679 attribute_deprecated
4680 void audio_resample_close(ReSampleContext *s);
4684 * Initialize an audio resampler.
4685 * Note, if either rate is not an integer then simply scale both rates up so they are.
4686 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4687 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4688 * @param linear If 1 then the used FIR filter will be linearly interpolated
4689 between the 2 closest, if 0 the closest will be used
4690 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4692 attribute_deprecated
4693 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4696 * Resample an array of samples using a previously configured context.
4697 * @param src an array of unconsumed samples
4698 * @param consumed the number of samples of src which have been consumed are returned here
4699 * @param src_size the number of unconsumed samples available
4700 * @param dst_size the amount of space in samples available in dst
4701 * @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.
4702 * @return the number of samples written in dst or -1 if an error occurred
4704 attribute_deprecated
4705 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4709 * Compensate samplerate/timestamp drift. The compensation is done by changing
4710 * the resampler parameters, so no audible clicks or similar distortions occur
4711 * @param compensation_distance distance in output samples over which the compensation should be performed
4712 * @param sample_delta number of output samples which should be output less
4714 * example: av_resample_compensate(c, 10, 500)
4715 * here instead of 510 samples only 500 samples would be output
4717 * note, due to rounding the actual compensation might be slightly different,
4718 * especially if the compensation_distance is large and the in_rate used during init is small
4720 attribute_deprecated
4721 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4722 attribute_deprecated
4723 void av_resample_close(struct AVResampleContext *c);
4731 * @addtogroup lavc_picture
4736 * Allocate memory for the pixels of a picture and setup the AVPicture
4739 * Call avpicture_free() to free it.
4741 * @param picture the picture structure to be filled in
4742 * @param pix_fmt the pixel format of the picture
4743 * @param width the width of the picture
4744 * @param height the height of the picture
4745 * @return zero if successful, a negative error code otherwise
4747 * @see av_image_alloc(), avpicture_fill()
4749 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4752 * Free a picture previously allocated by avpicture_alloc().
4753 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4756 * @param picture the AVPicture to be freed
4758 void avpicture_free(AVPicture *picture);
4761 * Setup the picture fields based on the specified image parameters
4762 * and the provided image data buffer.
4764 * The picture fields are filled in by using the image data buffer
4765 * pointed to by ptr.
4767 * If ptr is NULL, the function will fill only the picture linesize
4768 * array and return the required size for the image buffer.
4770 * To allocate an image buffer and fill the picture data in one call,
4771 * use avpicture_alloc().
4773 * @param picture the picture to be filled in
4774 * @param ptr buffer where the image data is stored, or NULL
4775 * @param pix_fmt the pixel format of the image
4776 * @param width the width of the image in pixels
4777 * @param height the height of the image in pixels
4778 * @return the size in bytes required for src, a negative error code
4779 * in case of failure
4781 * @see av_image_fill_arrays()
4783 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4784 enum AVPixelFormat pix_fmt, int width, int height);
4787 * Copy pixel data from an AVPicture into a buffer.
4789 * avpicture_get_size() can be used to compute the required size for
4790 * the buffer to fill.
4792 * @param src source picture with filled data
4793 * @param pix_fmt picture pixel format
4794 * @param width picture width
4795 * @param height picture height
4796 * @param dest destination buffer
4797 * @param dest_size destination buffer size in bytes
4798 * @return the number of bytes written to dest, or a negative value
4799 * (error code) on error, for example if the destination buffer is not
4802 * @see av_image_copy_to_buffer()
4804 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4805 int width, int height,
4806 unsigned char *dest, int dest_size);
4809 * Calculate the size in bytes that a picture of the given width and height
4810 * would occupy if stored in the given picture format.
4812 * @param pix_fmt picture pixel format
4813 * @param width picture width
4814 * @param height picture height
4815 * @return the computed picture buffer size or a negative error code
4818 * @see av_image_get_buffer_size().
4820 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4823 * Copy image src to dst. Wraps av_image_copy().
4825 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4826 enum AVPixelFormat pix_fmt, int width, int height);
4829 * Crop image top and left side.
4831 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4832 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4837 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4838 int padtop, int padbottom, int padleft, int padright, int *color);
4845 * @defgroup lavc_misc Utility functions
4848 * Miscellaneous utility functions related to both encoding and decoding
4854 * @defgroup lavc_misc_pixfmt Pixel formats
4856 * Functions for working with pixel formats.
4861 * Utility function to access log2_chroma_w log2_chroma_h from
4862 * the pixel format AVPixFmtDescriptor.
4864 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4865 * for one that returns a failure code and continues in case of invalid
4868 * @param[in] pix_fmt the pixel format
4869 * @param[out] h_shift store log2_chroma_w
4870 * @param[out] v_shift store log2_chroma_h
4872 * @see av_pix_fmt_get_chroma_sub_sample
4875 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4878 * Return a value representing the fourCC code associated to the
4879 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4882 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4885 * @deprecated see av_get_pix_fmt_loss()
4887 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4891 * Find the best pixel format to convert to given a certain source pixel
4892 * format. When converting from one pixel format to another, information loss
4893 * may occur. For example, when converting from RGB24 to GRAY, the color
4894 * information will be lost. Similarly, other losses occur when converting from
4895 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4896 * the given pixel formats should be used to suffer the least amount of loss.
4897 * The pixel formats from which it chooses one, are determined by the
4898 * pix_fmt_list parameter.
4901 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4902 * @param[in] src_pix_fmt source pixel format
4903 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4904 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4905 * @return The best pixel format to convert to or -1 if none was found.
4907 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4908 enum AVPixelFormat src_pix_fmt,
4909 int has_alpha, int *loss_ptr);
4912 * @deprecated see av_find_best_pix_fmt_of_2()
4914 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4915 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4917 attribute_deprecated
4918 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
4919 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
4920 enum AVPixelFormat src_pix_fmt,
4921 int has_alpha, int *loss_ptr);
4923 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4924 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4928 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4934 #if FF_API_SET_DIMENSIONS
4936 * @deprecated this function is not supposed to be used from outside of lavc
4938 attribute_deprecated
4939 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4943 * Put a string representing the codec tag codec_tag in buf.
4945 * @param buf buffer to place codec tag in
4946 * @param buf_size size in bytes of buf
4947 * @param codec_tag codec tag to assign
4948 * @return the length of the string that would have been generated if
4949 * enough space had been available, excluding the trailing null
4951 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4953 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4956 * Return a name for the specified profile, if available.
4958 * @param codec the codec that is searched for the given profile
4959 * @param profile the profile value for which a name is requested
4960 * @return A name for the profile if found, NULL otherwise.
4962 const char *av_get_profile_name(const AVCodec *codec, int profile);
4964 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4965 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4966 //FIXME func typedef
4969 * Fill AVFrame audio data and linesize pointers.
4971 * The buffer buf must be a preallocated buffer with a size big enough
4972 * to contain the specified samples amount. The filled AVFrame data
4973 * pointers will point to this buffer.
4975 * AVFrame extended_data channel pointers are allocated if necessary for
4978 * @param frame the AVFrame
4979 * frame->nb_samples must be set prior to calling the
4980 * function. This function fills in frame->data,
4981 * frame->extended_data, frame->linesize[0].
4982 * @param nb_channels channel count
4983 * @param sample_fmt sample format
4984 * @param buf buffer to use for frame data
4985 * @param buf_size size of buffer
4986 * @param align plane size sample alignment (0 = default)
4987 * @return >=0 on success, negative error code on failure
4988 * @todo return the size in bytes required to store the samples in
4989 * case of success, at the next libavutil bump
4991 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4992 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4993 int buf_size, int align);
4996 * Reset the internal decoder state / flush internal buffers. Should be called
4997 * e.g. when seeking or when switching to a different stream.
4999 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5000 * this invalidates the frames previously returned from the decoder. When
5001 * refcounted frames are used, the decoder just releases any references it might
5002 * keep internally, but the caller's reference remains valid.
5004 void avcodec_flush_buffers(AVCodecContext *avctx);
5007 * Return codec bits per sample.
5009 * @param[in] codec_id the codec
5010 * @return Number of bits per sample or zero if unknown for the given codec.
5012 int av_get_bits_per_sample(enum AVCodecID codec_id);
5015 * Return the PCM codec associated with a sample format.
5016 * @param be endianness, 0 for little, 1 for big,
5017 * -1 (or anything else) for native
5018 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5020 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5023 * Return codec bits per sample.
5024 * Only return non-zero if the bits per sample is exactly correct, not an
5027 * @param[in] codec_id the codec
5028 * @return Number of bits per sample or zero if unknown for the given codec.
5030 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5033 * Return audio frame duration.
5035 * @param avctx codec context
5036 * @param frame_bytes size of the frame, or 0 if unknown
5037 * @return frame duration, in samples, if known. 0 if not able to
5040 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5043 typedef struct AVBitStreamFilterContext {
5045 struct AVBitStreamFilter *filter;
5046 AVCodecParserContext *parser;
5047 struct AVBitStreamFilterContext *next;
5048 } AVBitStreamFilterContext;
5051 typedef struct AVBitStreamFilter {
5054 int (*filter)(AVBitStreamFilterContext *bsfc,
5055 AVCodecContext *avctx, const char *args,
5056 uint8_t **poutbuf, int *poutbuf_size,
5057 const uint8_t *buf, int buf_size, int keyframe);
5058 void (*close)(AVBitStreamFilterContext *bsfc);
5059 struct AVBitStreamFilter *next;
5060 } AVBitStreamFilter;
5063 * Register a bitstream filter.
5065 * The filter will be accessible to the application code through
5066 * av_bitstream_filter_next() or can be directly initialized with
5067 * av_bitstream_filter_init().
5069 * @see avcodec_register_all()
5071 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5074 * Create and initialize a bitstream filter context given a bitstream
5077 * The returned context must be freed with av_bitstream_filter_close().
5079 * @param name the name of the bitstream filter
5080 * @return a bitstream filter context if a matching filter was found
5081 * and successfully initialized, NULL otherwise
5083 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5088 * This function filters the buffer buf with size buf_size, and places the
5089 * filtered buffer in the buffer pointed to by poutbuf.
5091 * The output buffer must be freed by the caller.
5093 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5094 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5095 * If specified, this must point to the encoder context of the
5096 * output stream the packet is sent to.
5097 * @param args arguments which specify the filter configuration, may be NULL
5098 * @param poutbuf pointer which is updated to point to the filtered buffer
5099 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5100 * @param buf buffer containing the data to filter
5101 * @param buf_size size in bytes of buf
5102 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5103 * @return >= 0 in case of success, or a negative error code in case of failure
5105 * If the return value is positive, an output buffer is allocated and
5106 * is available in *poutbuf, and is distinct from the input buffer.
5108 * If the return value is 0, the output buffer is not allocated and
5109 * should be considered identical to the input buffer, or in case
5110 * *poutbuf was set it points to the input buffer (not necessarily to
5111 * its starting address).
5113 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5114 AVCodecContext *avctx, const char *args,
5115 uint8_t **poutbuf, int *poutbuf_size,
5116 const uint8_t *buf, int buf_size, int keyframe);
5119 * Release bitstream filter context.
5121 * @param bsf the bitstream filter context created with
5122 * av_bitstream_filter_init(), can be NULL
5124 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5127 * If f is NULL, return the first registered bitstream filter,
5128 * if f is non-NULL, return the next registered bitstream filter
5129 * after f, or NULL if f is the last one.
5131 * This function can be used to iterate over all registered bitstream
5134 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5139 * Same behaviour av_fast_malloc but the buffer has additional
5140 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5142 * In addition the whole buffer will initially and after resizes
5143 * be 0-initialized so that no uninitialized data will ever appear.
5145 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5148 * Same behaviour av_fast_padded_malloc except that buffer will always
5149 * be 0-initialized after call.
5151 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5154 * Encode extradata length to a buffer. Used by xiph codecs.
5156 * @param s buffer to write to; must be at least (v/255+1) bytes long
5157 * @param v size of extradata in bytes
5158 * @return number of bytes written to the buffer.
5160 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5162 #if FF_API_MISSING_SAMPLE
5164 * Log a generic warning message about a missing feature. This function is
5165 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5166 * only, and would normally not be used by applications.
5167 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5168 * a pointer to an AVClass struct
5169 * @param[in] feature string containing the name of the missing feature
5170 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5171 * If want_sample is non-zero, additional verbage will be added to the log
5172 * message which tells the user how to report samples to the development
5174 * @deprecated Use avpriv_report_missing_feature() instead.
5176 attribute_deprecated
5177 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5180 * Log a generic warning message asking for a sample. This function is
5181 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5182 * only, and would normally not be used by applications.
5183 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5184 * a pointer to an AVClass struct
5185 * @param[in] msg string containing an optional message, or NULL if no message
5186 * @deprecated Use avpriv_request_sample() instead.
5188 attribute_deprecated
5189 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5190 #endif /* FF_API_MISSING_SAMPLE */
5193 * Register the hardware accelerator hwaccel.
5195 void av_register_hwaccel(AVHWAccel *hwaccel);
5198 * If hwaccel is NULL, returns the first registered hardware accelerator,
5199 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5200 * after hwaccel, or NULL if hwaccel is the last one.
5202 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5206 * Lock operation used by lockmgr
5209 AV_LOCK_CREATE, ///< Create a mutex
5210 AV_LOCK_OBTAIN, ///< Lock the mutex
5211 AV_LOCK_RELEASE, ///< Unlock the mutex
5212 AV_LOCK_DESTROY, ///< Free mutex resources
5216 * Register a user provided lock manager supporting the operations
5217 * specified by AVLockOp. The "mutex" argument to the function points
5218 * to a (void *) where the lockmgr should store/get a pointer to a user
5219 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5220 * value left by the last call for all other ops. If the lock manager is
5221 * unable to perform the op then it should leave the mutex in the same
5222 * state as when it was called and return a non-zero value. However,
5223 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5224 * have been successfully destroyed. If av_lockmgr_register succeeds
5225 * it will return a non-negative value, if it fails it will return a
5226 * negative value and destroy all mutex and unregister all callbacks.
5227 * av_lockmgr_register is not thread-safe, it must be called from a
5228 * single thread before any calls which make use of locking are used.
5230 * @param cb User defined callback. av_lockmgr_register invokes calls
5231 * to this callback and the previously registered callback.
5232 * The callback will be used to create more than one mutex
5233 * each of which must be backed by its own underlying locking
5234 * mechanism (i.e. do not use a single static object to
5235 * implement your lock manager). If cb is set to NULL the
5236 * lockmgr will be unregistered.
5238 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5241 * Get the type of the given codec.
5243 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5246 * Get the name of a codec.
5247 * @return a static string identifying the codec; never NULL
5249 const char *avcodec_get_name(enum AVCodecID id);
5252 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5253 * with no corresponding avcodec_close()), 0 otherwise.
5255 int avcodec_is_open(AVCodecContext *s);
5258 * @return a non-zero number if codec is an encoder, zero otherwise
5260 int av_codec_is_encoder(const AVCodec *codec);
5263 * @return a non-zero number if codec is a decoder, zero otherwise
5265 int av_codec_is_decoder(const AVCodec *codec);
5268 * @return descriptor for given codec ID or NULL if no descriptor exists.
5270 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5273 * Iterate over all codec descriptors known to libavcodec.
5275 * @param prev previous descriptor. NULL to get the first descriptor.
5277 * @return next descriptor or NULL after the last descriptor
5279 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5282 * @return codec descriptor with the given name or NULL if no such descriptor
5285 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5291 #endif /* AVCODEC_AVCODEC_H */