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.
1357 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1358 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1359 * without libavcodec and libavformat major bump.
1361 * The semantics of data ownership depends on the buf or destruct (deprecated)
1362 * fields. If either is set, the packet data is dynamically allocated and is
1363 * valid indefinitely until av_free_packet() is called (which in turn calls
1364 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1365 * the packet data is typically backed by some static buffer somewhere and is
1366 * only valid for a limited time (e.g. until the next read call when demuxing).
1368 * The side data is always allocated with av_malloc() and is freed in
1371 typedef struct AVPacket {
1373 * A reference to the reference-counted buffer where the packet data is
1375 * May be NULL, then the packet data is not reference-counted.
1379 * Presentation timestamp in AVStream->time_base units; the time at which
1380 * the decompressed packet will be presented to the user.
1381 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1382 * pts MUST be larger or equal to dts as presentation cannot happen before
1383 * decompression, unless one wants to view hex dumps. Some formats misuse
1384 * the terms dts and pts/cts to mean something different. Such timestamps
1385 * must be converted to true pts/dts before they are stored in AVPacket.
1389 * Decompression timestamp in AVStream->time_base units; the time at which
1390 * the packet is decompressed.
1391 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1398 * A combination of AV_PKT_FLAG values
1402 * Additional packet data that can be provided by the container.
1403 * Packet can contain several types of side information.
1405 AVPacketSideData *side_data;
1406 int side_data_elems;
1409 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1410 * Equals next_pts - this_pts in presentation order.
1414 int64_t pos; ///< byte position in stream, -1 if unknown
1417 * Time difference in AVStream->time_base units from the pts of this
1418 * packet to the point at which the output from the decoder has converged
1419 * independent from the availability of previous frames. That is, the
1420 * frames are virtually identical no matter if decoding started from
1421 * the very first frame or from this keyframe.
1422 * Is AV_NOPTS_VALUE if unknown.
1423 * This field is not the display duration of the current packet.
1424 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1427 * The purpose of this field is to allow seeking in streams that have no
1428 * keyframes in the conventional sense. It corresponds to the
1429 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1430 * essential for some types of subtitle streams to ensure that all
1431 * subtitles are correctly displayed after seeking.
1433 int64_t convergence_duration;
1435 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1436 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1438 enum AVSideDataParamChangeFlags {
1439 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1440 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1441 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1442 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1448 struct AVCodecInternal;
1452 AV_FIELD_PROGRESSIVE,
1453 AV_FIELD_TT, //< Top coded_first, top displayed first
1454 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1455 AV_FIELD_TB, //< Top coded first, bottom displayed first
1456 AV_FIELD_BT, //< Bottom coded first, top displayed first
1460 * main external API structure.
1461 * New fields can be added to the end with minor version bumps.
1462 * Removal, reordering and changes to existing fields require a major
1464 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1466 * sizeof(AVCodecContext) must not be used outside libav*.
1468 typedef struct AVCodecContext {
1470 * information on struct for av_log
1471 * - set by avcodec_alloc_context3
1473 const AVClass *av_class;
1474 int log_level_offset;
1476 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1477 const struct AVCodec *codec;
1478 #if FF_API_CODEC_NAME
1480 * @deprecated this field is not used for anything in libavcodec
1482 attribute_deprecated
1483 char codec_name[32];
1485 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1488 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1489 * This is used to work around some encoder bugs.
1490 * A demuxer should set this to what is stored in the field used to identify the codec.
1491 * If there are multiple such fields in a container then the demuxer should choose the one
1492 * which maximizes the information about the used codec.
1493 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1494 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1495 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1497 * - encoding: Set by user, if not then the default based on codec_id will be used.
1498 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1500 unsigned int codec_tag;
1502 #if FF_API_STREAM_CODEC_TAG
1504 * @deprecated this field is unused
1506 attribute_deprecated
1507 unsigned int stream_codec_tag;
1513 * Private context used for internal data.
1515 * Unlike priv_data, this is not codec-specific. It is used in general
1516 * libavcodec functions.
1518 struct AVCodecInternal *internal;
1521 * Private data of the user, can be used to carry app specific stuff.
1522 * - encoding: Set by user.
1523 * - decoding: Set by user.
1528 * the average bitrate
1529 * - encoding: Set by user; unused for constant quantizer encoding.
1530 * - decoding: Set by user, may be overwritten by libavcodec
1531 * if this info is available in the stream
1536 * number of bits the bitstream is allowed to diverge from the reference.
1537 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1538 * - encoding: Set by user; unused for constant quantizer encoding.
1539 * - decoding: unused
1541 int bit_rate_tolerance;
1544 * Global quality for codecs which cannot change it per frame.
1545 * This should be proportional to MPEG-1/2/4 qscale.
1546 * - encoding: Set by user.
1547 * - decoding: unused
1552 * - encoding: Set by user.
1553 * - decoding: unused
1555 int compression_level;
1556 #define FF_COMPRESSION_DEFAULT -1
1560 * - encoding: Set by user.
1561 * - decoding: Set by user.
1567 * - encoding: Set by user.
1568 * - decoding: Set by user.
1573 * some codecs need / can use extradata like Huffman tables.
1574 * mjpeg: Huffman tables
1575 * rv10: additional flags
1576 * mpeg4: global headers (they can be in the bitstream or here)
1577 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1578 * than extradata_size to avoid problems if it is read with the bitstream reader.
1579 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1580 * - encoding: Set/allocated/freed by libavcodec.
1581 * - decoding: Set/allocated/freed by user.
1587 * This is the fundamental unit of time (in seconds) in terms
1588 * of which frame timestamps are represented. For fixed-fps content,
1589 * timebase should be 1/framerate and timestamp increments should be
1591 * This often, but not always is the inverse of the frame rate or field rate
1593 * - encoding: MUST be set by user.
1594 * - decoding: the use of this field for decoding is deprecated.
1595 * Use framerate instead.
1597 AVRational time_base;
1600 * For some codecs, the time base is closer to the field rate than the frame rate.
1601 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1602 * if no telecine is used ...
1604 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1606 int ticks_per_frame;
1611 * Encoding: Number of frames delay there will be from the encoder input to
1612 * the decoder output. (we assume the decoder matches the spec)
1613 * Decoding: Number of frames delay in addition to what a standard decoder
1614 * as specified in the spec would produce.
1617 * Number of frames the decoded output will be delayed relative to the
1621 * For encoding, this field is unused (see initial_padding).
1623 * For decoding, this is the number of samples the decoder needs to
1624 * output before the decoder's output is valid. When seeking, you should
1625 * start decoding this many samples prior to your desired seek point.
1627 * - encoding: Set by libavcodec.
1628 * - decoding: Set by libavcodec.
1635 * picture width / height.
1637 * @note Those fields may not match the values of the last
1638 * AVFrame outputted by avcodec_decode_video2 due frame
1641 * - encoding: MUST be set by user.
1642 * - decoding: May be set by the user before opening the decoder if known e.g.
1643 * from the container. Some decoders will require the dimensions
1644 * to be set by the caller. During decoding, the decoder may
1645 * overwrite those values as required while parsing the data.
1650 * Bitstream width / height, may be different from width/height e.g. when
1651 * the decoded frame is cropped before being output or lowres is enabled.
1653 * @note Those field may not match the value of the last
1654 * AVFrame outputted by avcodec_decode_video2 due frame
1657 * - encoding: unused
1658 * - decoding: May be set by the user before opening the decoder if known
1659 * e.g. from the container. During decoding, the decoder may
1660 * overwrite those values as required while parsing the data.
1662 int coded_width, coded_height;
1664 #if FF_API_ASPECT_EXTENDED
1665 #define FF_ASPECT_EXTENDED 15
1669 * the number of pictures in a group of pictures, or 0 for intra_only
1670 * - encoding: Set by user.
1671 * - decoding: unused
1676 * Pixel format, see AV_PIX_FMT_xxx.
1677 * May be set by the demuxer if known from headers.
1678 * May be overridden by the decoder if it knows better.
1680 * @note This field may not match the value of the last
1681 * AVFrame outputted by avcodec_decode_video2 due frame
1684 * - encoding: Set by user.
1685 * - decoding: Set by user if known, overridden by libavcodec while
1688 enum AVPixelFormat pix_fmt;
1690 #if FF_API_MOTION_EST
1692 * This option does nothing
1693 * @deprecated use codec private options instead
1695 attribute_deprecated int me_method;
1699 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1700 * decoder to draw a horizontal band. It improves cache usage. Not
1701 * all codecs can do that. You must check the codec capabilities
1703 * When multithreading is used, it may be called from multiple threads
1704 * at the same time; threads might draw different parts of the same AVFrame,
1705 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1707 * The function is also used by hardware acceleration APIs.
1708 * It is called at least once during frame decoding to pass
1709 * the data needed for hardware render.
1710 * In that mode instead of pixel data, AVFrame points to
1711 * a structure specific to the acceleration API. The application
1712 * reads the structure and can change some fields to indicate progress
1714 * - encoding: unused
1715 * - decoding: Set by user.
1716 * @param height the height of the slice
1717 * @param y the y position of the slice
1718 * @param type 1->top field, 2->bottom field, 3->frame
1719 * @param offset offset into the AVFrame.data from which the slice should be read
1721 void (*draw_horiz_band)(struct AVCodecContext *s,
1722 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1723 int y, int type, int height);
1726 * callback to negotiate the pixelFormat
1727 * @param fmt is the list of formats which are supported by the codec,
1728 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1729 * The first is always the native one.
1730 * @note The callback may be called again immediately if initialization for
1731 * the selected (hardware-accelerated) pixel format failed.
1732 * @warning Behavior is undefined if the callback returns a value not
1733 * in the fmt list of formats.
1734 * @return the chosen format
1735 * - encoding: unused
1736 * - decoding: Set by user, if not set the native format will be chosen.
1738 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1741 * maximum number of B-frames between non-B-frames
1742 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1743 * - encoding: Set by user.
1744 * - decoding: unused
1749 * qscale factor between IP and B-frames
1750 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1751 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1752 * - encoding: Set by user.
1753 * - decoding: unused
1755 float b_quant_factor;
1757 #if FF_API_RC_STRATEGY
1758 /** @deprecated use codec private option instead */
1759 attribute_deprecated int rc_strategy;
1760 #define FF_RC_STRATEGY_XVID 1
1763 int b_frame_strategy;
1766 * qscale offset between IP and B-frames
1767 * - encoding: Set by user.
1768 * - decoding: unused
1770 float b_quant_offset;
1773 * Size of the frame reordering buffer in the decoder.
1774 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1775 * - encoding: Set by libavcodec.
1776 * - decoding: Set by libavcodec.
1781 * 0-> h263 quant 1-> mpeg quant
1782 * - encoding: Set by user.
1783 * - decoding: unused
1788 * qscale factor between P and I-frames
1789 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1790 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1791 * - encoding: Set by user.
1792 * - decoding: unused
1794 float i_quant_factor;
1797 * qscale offset between P and I-frames
1798 * - encoding: Set by user.
1799 * - decoding: unused
1801 float i_quant_offset;
1804 * luminance masking (0-> disabled)
1805 * - encoding: Set by user.
1806 * - decoding: unused
1811 * temporary complexity masking (0-> disabled)
1812 * - encoding: Set by user.
1813 * - decoding: unused
1815 float temporal_cplx_masking;
1818 * spatial complexity masking (0-> disabled)
1819 * - encoding: Set by user.
1820 * - decoding: unused
1822 float spatial_cplx_masking;
1825 * p block masking (0-> disabled)
1826 * - encoding: Set by user.
1827 * - decoding: unused
1832 * darkness masking (0-> disabled)
1833 * - encoding: Set by user.
1834 * - decoding: unused
1840 * - encoding: Set by libavcodec.
1841 * - decoding: Set by user (or 0).
1845 * prediction method (needed for huffyuv)
1846 * - encoding: Set by user.
1847 * - decoding: unused
1849 int prediction_method;
1850 #define FF_PRED_LEFT 0
1851 #define FF_PRED_PLANE 1
1852 #define FF_PRED_MEDIAN 2
1855 * slice offsets in the frame in bytes
1856 * - encoding: Set/allocated by libavcodec.
1857 * - decoding: Set/allocated by user (or NULL).
1862 * sample aspect ratio (0 if unknown)
1863 * That is the width of a pixel divided by the height of the pixel.
1864 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1865 * - encoding: Set by user.
1866 * - decoding: Set by libavcodec.
1868 AVRational sample_aspect_ratio;
1871 * motion estimation comparison function
1872 * - encoding: Set by user.
1873 * - decoding: unused
1877 * subpixel motion estimation comparison function
1878 * - encoding: Set by user.
1879 * - decoding: unused
1883 * macroblock comparison function (not supported yet)
1884 * - encoding: Set by user.
1885 * - decoding: unused
1889 * interlaced DCT comparison function
1890 * - encoding: Set by user.
1891 * - decoding: unused
1894 #define FF_CMP_SAD 0
1895 #define FF_CMP_SSE 1
1896 #define FF_CMP_SATD 2
1897 #define FF_CMP_DCT 3
1898 #define FF_CMP_PSNR 4
1899 #define FF_CMP_BIT 5
1901 #define FF_CMP_ZERO 7
1902 #define FF_CMP_VSAD 8
1903 #define FF_CMP_VSSE 9
1904 #define FF_CMP_NSSE 10
1905 #define FF_CMP_W53 11
1906 #define FF_CMP_W97 12
1907 #define FF_CMP_DCTMAX 13
1908 #define FF_CMP_DCT264 14
1909 #define FF_CMP_CHROMA 256
1912 * ME diamond size & shape
1913 * - encoding: Set by user.
1914 * - decoding: unused
1919 * amount of previous MV predictors (2a+1 x 2a+1 square)
1920 * - encoding: Set by user.
1921 * - decoding: unused
1923 int last_predictor_count;
1926 * prepass for motion estimation
1927 * - encoding: Set by user.
1928 * - decoding: unused
1933 * motion estimation prepass comparison function
1934 * - encoding: Set by user.
1935 * - decoding: unused
1940 * ME prepass diamond size & shape
1941 * - encoding: Set by user.
1942 * - decoding: unused
1948 * - encoding: Set by user.
1949 * - decoding: unused
1951 int me_subpel_quality;
1955 * DTG active format information (additional aspect ratio
1956 * information only used in DVB MPEG-2 transport streams)
1959 * - encoding: unused
1960 * - decoding: Set by decoder.
1961 * @deprecated Deprecated in favor of AVSideData
1963 attribute_deprecated int dtg_active_format;
1964 #define FF_DTG_AFD_SAME 8
1965 #define FF_DTG_AFD_4_3 9
1966 #define FF_DTG_AFD_16_9 10
1967 #define FF_DTG_AFD_14_9 11
1968 #define FF_DTG_AFD_4_3_SP_14_9 13
1969 #define FF_DTG_AFD_16_9_SP_14_9 14
1970 #define FF_DTG_AFD_SP_4_3 15
1971 #endif /* FF_API_AFD */
1974 * maximum motion estimation search range in subpel units
1975 * If 0 then no limit.
1977 * - encoding: Set by user.
1978 * - decoding: unused
1982 #if FF_API_QUANT_BIAS
1984 * @deprecated use encoder private option instead
1986 attribute_deprecated int intra_quant_bias;
1987 #define FF_DEFAULT_QUANT_BIAS 999999
1990 * @deprecated use encoder private option instead
1992 attribute_deprecated int inter_quant_bias;
1997 * - encoding: unused
1998 * - decoding: Set by user.
2001 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2002 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2003 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2007 * XVideo Motion Acceleration
2008 * - encoding: forbidden
2009 * - decoding: set by decoder
2010 * @deprecated XvMC doesn't need it anymore.
2012 attribute_deprecated int xvmc_acceleration;
2013 #endif /* FF_API_XVMC */
2016 * macroblock decision mode
2017 * - encoding: Set by user.
2018 * - decoding: unused
2021 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2022 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2023 #define FF_MB_DECISION_RD 2 ///< rate distortion
2026 * custom intra quantization matrix
2027 * - encoding: Set by user, can be NULL.
2028 * - decoding: Set by libavcodec.
2030 uint16_t *intra_matrix;
2033 * custom inter quantization matrix
2034 * - encoding: Set by user, can be NULL.
2035 * - decoding: Set by libavcodec.
2037 uint16_t *inter_matrix;
2040 * scene change detection threshold
2041 * 0 is default, larger means fewer detected scene changes.
2042 * - encoding: Set by user.
2043 * - decoding: unused
2045 int scenechange_threshold;
2048 * noise reduction strength
2049 * - encoding: Set by user.
2050 * - decoding: unused
2052 int noise_reduction;
2056 * @deprecated this field is unused
2058 attribute_deprecated
2062 * @deprecated this field is unused
2064 attribute_deprecated
2069 * precision of the intra DC coefficient - 8
2070 * - encoding: Set by user.
2071 * - decoding: Set by libavcodec
2073 int intra_dc_precision;
2076 * Number of macroblock rows at the top which are skipped.
2077 * - encoding: unused
2078 * - decoding: Set by user.
2083 * Number of macroblock rows at the bottom which are skipped.
2084 * - encoding: unused
2085 * - decoding: Set by user.
2091 * @deprecated use encoder private options instead
2093 attribute_deprecated
2094 float border_masking;
2098 * minimum MB lagrange multipler
2099 * - encoding: Set by user.
2100 * - decoding: unused
2105 * maximum MB lagrange multipler
2106 * - encoding: Set by user.
2107 * - decoding: unused
2113 * - encoding: Set by user.
2114 * - decoding: unused
2116 int me_penalty_compensation;
2120 * - encoding: Set by user.
2121 * - decoding: unused
2127 * - encoding: Set by user.
2128 * - decoding: unused
2134 * - encoding: Set by user.
2135 * - decoding: unused
2140 * number of reference frames
2141 * - encoding: Set by user.
2142 * - decoding: Set by lavc.
2147 * chroma qp offset from luma
2148 * - encoding: Set by user.
2149 * - decoding: unused
2153 #if FF_API_UNUSED_MEMBERS
2155 * Multiplied by qscale for each frame and added to scene_change_score.
2156 * - encoding: Set by user.
2157 * - decoding: unused
2159 attribute_deprecated int scenechange_factor;
2164 * Note: Value depends upon the compare function used for fullpel ME.
2165 * - encoding: Set by user.
2166 * - decoding: unused
2171 * Adjust sensitivity of b_frame_strategy 1.
2172 * - encoding: Set by user.
2173 * - decoding: unused
2178 * Chromaticity coordinates of the source primaries.
2179 * - encoding: Set by user
2180 * - decoding: Set by libavcodec
2182 enum AVColorPrimaries color_primaries;
2185 * Color Transfer Characteristic.
2186 * - encoding: Set by user
2187 * - decoding: Set by libavcodec
2189 enum AVColorTransferCharacteristic color_trc;
2192 * YUV colorspace type.
2193 * - encoding: Set by user
2194 * - decoding: Set by libavcodec
2196 enum AVColorSpace colorspace;
2199 * MPEG vs JPEG YUV range.
2200 * - encoding: Set by user
2201 * - decoding: Set by libavcodec
2203 enum AVColorRange color_range;
2206 * This defines the location of chroma samples.
2207 * - encoding: Set by user
2208 * - decoding: Set by libavcodec
2210 enum AVChromaLocation chroma_sample_location;
2214 * Indicates number of picture subdivisions. Used for parallelized
2216 * - encoding: Set by user
2217 * - decoding: unused
2222 * - encoding: set by libavcodec
2223 * - decoding: Set by user.
2225 enum AVFieldOrder field_order;
2228 int sample_rate; ///< samples per second
2229 int channels; ///< number of audio channels
2232 * audio sample format
2233 * - encoding: Set by user.
2234 * - decoding: Set by libavcodec.
2236 enum AVSampleFormat sample_fmt; ///< sample format
2238 /* The following data should not be initialized. */
2240 * Number of samples per channel in an audio frame.
2242 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2243 * except the last must contain exactly frame_size samples per channel.
2244 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2245 * frame size is not restricted.
2246 * - decoding: may be set by some decoders to indicate constant frame size
2251 * Frame counter, set by libavcodec.
2253 * - decoding: total number of frames returned from the decoder so far.
2254 * - encoding: total number of frames passed to the encoder so far.
2256 * @note the counter is not incremented if encoding/decoding resulted in
2262 * number of bytes per packet if constant and known or 0
2263 * Used by some WAV based audio codecs.
2268 * Audio cutoff bandwidth (0 means "automatic")
2269 * - encoding: Set by user.
2270 * - decoding: unused
2275 * Audio channel layout.
2276 * - encoding: set by user.
2277 * - decoding: set by user, may be overwritten by libavcodec.
2279 uint64_t channel_layout;
2282 * Request decoder to use this channel layout if it can (0 for default)
2283 * - encoding: unused
2284 * - decoding: Set by user.
2286 uint64_t request_channel_layout;
2289 * Type of service that the audio stream conveys.
2290 * - encoding: Set by user.
2291 * - decoding: Set by libavcodec.
2293 enum AVAudioServiceType audio_service_type;
2296 * desired sample format
2297 * - encoding: Not used.
2298 * - decoding: Set by user.
2299 * Decoder will decode to this format if it can.
2301 enum AVSampleFormat request_sample_fmt;
2304 * This callback is called at the beginning of each frame to get data
2305 * buffer(s) for it. There may be one contiguous buffer for all the data or
2306 * there may be a buffer per each data plane or anything in between. What
2307 * this means is, you may set however many entries in buf[] you feel necessary.
2308 * Each buffer must be reference-counted using the AVBuffer API (see description
2311 * The following fields will be set in the frame before this callback is
2314 * - width, height (video only)
2315 * - sample_rate, channel_layout, nb_samples (audio only)
2316 * Their values may differ from the corresponding values in
2317 * AVCodecContext. This callback must use the frame values, not the codec
2318 * context values, to calculate the required buffer size.
2320 * This callback must fill the following fields in the frame:
2324 * * if the data is planar audio with more than 8 channels, then this
2325 * callback must allocate and fill extended_data to contain all pointers
2326 * to all data planes. data[] must hold as many pointers as it can.
2327 * extended_data must be allocated with av_malloc() and will be freed in
2329 * * otherwise exended_data must point to data
2330 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2331 * the frame's data and extended_data pointers must be contained in these. That
2332 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2333 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2334 * and av_buffer_ref().
2335 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2336 * this callback and filled with the extra buffers if there are more
2337 * buffers than buf[] can hold. extended_buf will be freed in
2340 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2341 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2344 * Each data plane must be aligned to the maximum required by the target
2347 * @see avcodec_default_get_buffer2()
2351 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2352 * (read and/or written to if it is writable) later by libavcodec.
2354 * avcodec_align_dimensions2() should be used to find the required width and
2355 * height, as they normally need to be rounded up to the next multiple of 16.
2357 * Some decoders do not support linesizes changing between frames.
2359 * If frame multithreading is used and thread_safe_callbacks is set,
2360 * this callback may be called from a different thread, but not from more
2361 * than one at once. Does not need to be reentrant.
2363 * @see avcodec_align_dimensions2()
2367 * Decoders request a buffer of a particular size by setting
2368 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2369 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2370 * to a smaller value in the output frame.
2372 * As a convenience, av_samples_get_buffer_size() and
2373 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2374 * functions to find the required data size and to fill data pointers and
2375 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2376 * since all planes must be the same size.
2378 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2380 * - encoding: unused
2381 * - decoding: Set by libavcodec, user can override.
2383 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2386 * If non-zero, the decoded audio and video frames returned from
2387 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2388 * and are valid indefinitely. The caller must free them with
2389 * av_frame_unref() when they are not needed anymore.
2390 * Otherwise, the decoded frames must not be freed by the caller and are
2391 * only valid until the next decode call.
2393 * - encoding: unused
2394 * - decoding: set by the caller before avcodec_open2().
2396 int refcounted_frames;
2398 /* - encoding parameters */
2399 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2400 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2404 * - encoding: Set by user.
2405 * - decoding: unused
2411 * - encoding: Set by user.
2412 * - decoding: unused
2417 * maximum quantizer difference between frames
2418 * - encoding: Set by user.
2419 * - decoding: unused
2425 * @deprecated use encoder private options instead
2427 attribute_deprecated
2430 attribute_deprecated
2432 attribute_deprecated
2437 * decoder bitstream buffer size
2438 * - encoding: Set by user.
2439 * - decoding: unused
2444 * ratecontrol override, see RcOverride
2445 * - encoding: Allocated/set/freed by user.
2446 * - decoding: unused
2448 int rc_override_count;
2449 RcOverride *rc_override;
2453 * @deprecated use encoder private options instead
2455 attribute_deprecated
2461 * - encoding: Set by user.
2462 * - decoding: Set by user, may be overwritten by libavcodec.
2468 * - encoding: Set by user.
2469 * - decoding: unused
2475 * @deprecated use encoder private options instead
2477 attribute_deprecated
2478 float rc_buffer_aggressivity;
2480 attribute_deprecated
2481 float rc_initial_cplx;
2485 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2486 * - encoding: Set by user.
2487 * - decoding: unused.
2489 float rc_max_available_vbv_use;
2492 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2493 * - encoding: Set by user.
2494 * - decoding: unused.
2496 float rc_min_vbv_overflow_use;
2499 * Number of bits which should be loaded into the rc buffer before decoding starts.
2500 * - encoding: Set by user.
2501 * - decoding: unused
2503 int rc_initial_buffer_occupancy;
2505 #define FF_CODER_TYPE_VLC 0
2506 #define FF_CODER_TYPE_AC 1
2507 #define FF_CODER_TYPE_RAW 2
2508 #define FF_CODER_TYPE_RLE 3
2509 #if FF_API_UNUSED_MEMBERS
2510 #define FF_CODER_TYPE_DEFLATE 4
2511 #endif /* FF_API_UNUSED_MEMBERS */
2514 * - encoding: Set by user.
2515 * - decoding: unused
2521 * - encoding: Set by user.
2522 * - decoding: unused
2528 * @deprecated use encoder private options instead
2530 attribute_deprecated
2534 * @deprecated use encoder private options instead
2536 attribute_deprecated
2541 * frame skip threshold
2542 * - encoding: Set by user.
2543 * - decoding: unused
2545 int frame_skip_threshold;
2549 * - encoding: Set by user.
2550 * - decoding: unused
2552 int frame_skip_factor;
2555 * frame skip exponent
2556 * - encoding: Set by user.
2557 * - decoding: unused
2562 * frame skip comparison function
2563 * - encoding: Set by user.
2564 * - decoding: unused
2569 * trellis RD quantization
2570 * - encoding: Set by user.
2571 * - decoding: unused
2576 * - encoding: Set by user.
2577 * - decoding: unused
2579 int min_prediction_order;
2582 * - encoding: Set by user.
2583 * - decoding: unused
2585 int max_prediction_order;
2588 * GOP timecode frame start number
2589 * - encoding: Set by user, in non drop frame format
2590 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2592 int64_t timecode_frame_start;
2594 /* The RTP callback: This function is called */
2595 /* every time the encoder has a packet to send. */
2596 /* It depends on the encoder if the data starts */
2597 /* with a Start Code (it should). H.263 does. */
2598 /* mb_nb contains the number of macroblocks */
2599 /* encoded in the RTP payload. */
2600 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2602 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2603 /* do its best to deliver a chunk with size */
2604 /* below rtp_payload_size, the chunk will start */
2605 /* with a start code on some codecs like H.263. */
2606 /* This doesn't take account of any particular */
2607 /* headers inside the transmitted RTP payload. */
2609 /* statistics, used for 2-pass encoding */
2620 * number of bits used for the previously encoded frame
2621 * - encoding: Set by libavcodec.
2622 * - decoding: unused
2627 * pass1 encoding statistics output buffer
2628 * - encoding: Set by libavcodec.
2629 * - decoding: unused
2634 * pass2 encoding statistics input buffer
2635 * Concatenated stuff from stats_out of pass1 should be placed here.
2636 * - encoding: Allocated/set/freed by user.
2637 * - decoding: unused
2642 * Work around bugs in encoders which sometimes cannot be detected automatically.
2643 * - encoding: Set by user
2644 * - decoding: Set by user
2646 int workaround_bugs;
2647 #define FF_BUG_AUTODETECT 1 ///< autodetection
2648 #if FF_API_OLD_MSMPEG4
2649 #define FF_BUG_OLD_MSMPEG4 2
2651 #define FF_BUG_XVID_ILACE 4
2652 #define FF_BUG_UMP4 8
2653 #define FF_BUG_NO_PADDING 16
2654 #define FF_BUG_AMV 32
2656 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2658 #define FF_BUG_QPEL_CHROMA 64
2659 #define FF_BUG_STD_QPEL 128
2660 #define FF_BUG_QPEL_CHROMA2 256
2661 #define FF_BUG_DIRECT_BLOCKSIZE 512
2662 #define FF_BUG_EDGE 1024
2663 #define FF_BUG_HPEL_CHROMA 2048
2664 #define FF_BUG_DC_CLIP 4096
2665 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2666 #define FF_BUG_TRUNCATED 16384
2669 * strictly follow the standard (MPEG4, ...).
2670 * - encoding: Set by user.
2671 * - decoding: Set by user.
2672 * Setting this to STRICT or higher means the encoder and decoder will
2673 * generally do stupid things, whereas setting it to unofficial or lower
2674 * will mean the encoder might produce output that is not supported by all
2675 * spec-compliant decoders. Decoders don't differentiate between normal,
2676 * unofficial and experimental (that is, they always try to decode things
2677 * when they can) unless they are explicitly asked to behave stupidly
2678 * (=strictly conform to the specs)
2680 int strict_std_compliance;
2681 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2682 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2683 #define FF_COMPLIANCE_NORMAL 0
2684 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2685 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2688 * error concealment flags
2689 * - encoding: unused
2690 * - decoding: Set by user.
2692 int error_concealment;
2693 #define FF_EC_GUESS_MVS 1
2694 #define FF_EC_DEBLOCK 2
2695 #define FF_EC_FAVOR_INTER 256
2699 * - encoding: Set by user.
2700 * - decoding: Set by user.
2703 #define FF_DEBUG_PICT_INFO 1
2704 #define FF_DEBUG_RC 2
2705 #define FF_DEBUG_BITSTREAM 4
2706 #define FF_DEBUG_MB_TYPE 8
2707 #define FF_DEBUG_QP 16
2710 * @deprecated this option does nothing
2712 #define FF_DEBUG_MV 32
2714 #define FF_DEBUG_DCT_COEFF 0x00000040
2715 #define FF_DEBUG_SKIP 0x00000080
2716 #define FF_DEBUG_STARTCODE 0x00000100
2717 #if FF_API_UNUSED_MEMBERS
2718 #define FF_DEBUG_PTS 0x00000200
2719 #endif /* FF_API_UNUSED_MEMBERS */
2720 #define FF_DEBUG_ER 0x00000400
2721 #define FF_DEBUG_MMCO 0x00000800
2722 #define FF_DEBUG_BUGS 0x00001000
2724 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2725 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2727 #define FF_DEBUG_BUFFERS 0x00008000
2728 #define FF_DEBUG_THREADS 0x00010000
2729 #define FF_DEBUG_GREEN_MD 0x00800000
2730 #define FF_DEBUG_NOMC 0x01000000
2735 * Code outside libavcodec should access this field using AVOptions
2736 * - encoding: Set by user.
2737 * - decoding: Set by user.
2740 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2741 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2742 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2746 * Error recognition; may misdetect some more or less valid parts as errors.
2747 * - encoding: unused
2748 * - decoding: Set by user.
2750 int err_recognition;
2753 * Verify checksums embedded in the bitstream (could be of either encoded or
2754 * decoded data, depending on the codec) and print an error message on mismatch.
2755 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2756 * decoder returning an error.
2758 #define AV_EF_CRCCHECK (1<<0)
2759 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2760 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2761 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2763 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2764 #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
2765 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2766 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2770 * opaque 64bit number (generally a PTS) that will be reordered and
2771 * output in AVFrame.reordered_opaque
2772 * - encoding: unused
2773 * - decoding: Set by user.
2775 int64_t reordered_opaque;
2778 * Hardware accelerator in use
2779 * - encoding: unused.
2780 * - decoding: Set by libavcodec
2782 struct AVHWAccel *hwaccel;
2785 * Hardware accelerator context.
2786 * For some hardware accelerators, a global context needs to be
2787 * provided by the user. In that case, this holds display-dependent
2788 * data FFmpeg cannot instantiate itself. Please refer to the
2789 * FFmpeg HW accelerator documentation to know how to fill this
2790 * is. e.g. for VA API, this is a struct vaapi_context.
2791 * - encoding: unused
2792 * - decoding: Set by user
2794 void *hwaccel_context;
2798 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2799 * - decoding: unused
2801 uint64_t error[AV_NUM_DATA_POINTERS];
2804 * DCT algorithm, see FF_DCT_* below
2805 * - encoding: Set by user.
2806 * - decoding: unused
2809 #define FF_DCT_AUTO 0
2810 #define FF_DCT_FASTINT 1
2811 #define FF_DCT_INT 2
2812 #define FF_DCT_MMX 3
2813 #define FF_DCT_ALTIVEC 5
2814 #define FF_DCT_FAAN 6
2817 * IDCT algorithm, see FF_IDCT_* below.
2818 * - encoding: Set by user.
2819 * - decoding: Set by user.
2822 #define FF_IDCT_AUTO 0
2823 #define FF_IDCT_INT 1
2824 #define FF_IDCT_SIMPLE 2
2825 #define FF_IDCT_SIMPLEMMX 3
2826 #define FF_IDCT_ARM 7
2827 #define FF_IDCT_ALTIVEC 8
2829 #define FF_IDCT_SH4 9
2831 #define FF_IDCT_SIMPLEARM 10
2832 #if FF_API_UNUSED_MEMBERS
2833 #define FF_IDCT_IPP 13
2834 #endif /* FF_API_UNUSED_MEMBERS */
2835 #define FF_IDCT_XVID 14
2836 #if FF_API_IDCT_XVIDMMX
2837 #define FF_IDCT_XVIDMMX 14
2838 #endif /* FF_API_IDCT_XVIDMMX */
2839 #define FF_IDCT_SIMPLEARMV5TE 16
2840 #define FF_IDCT_SIMPLEARMV6 17
2841 #if FF_API_ARCH_SPARC
2842 #define FF_IDCT_SIMPLEVIS 18
2844 #define FF_IDCT_FAAN 20
2845 #define FF_IDCT_SIMPLENEON 22
2846 #if FF_API_ARCH_ALPHA
2847 #define FF_IDCT_SIMPLEALPHA 23
2849 #define FF_IDCT_SIMPLEAUTO 128
2852 * bits per sample/pixel from the demuxer (needed for huffyuv).
2853 * - encoding: Set by libavcodec.
2854 * - decoding: Set by user.
2856 int bits_per_coded_sample;
2859 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2860 * - encoding: set by user.
2861 * - decoding: set by libavcodec.
2863 int bits_per_raw_sample;
2867 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2868 * - encoding: unused
2869 * - decoding: Set by user.
2870 * Code outside libavcodec should access this field using:
2871 * av_codec_{get,set}_lowres(avctx)
2876 #if FF_API_CODED_FRAME
2878 * the picture in the bitstream
2879 * - encoding: Set by libavcodec.
2880 * - decoding: unused
2882 * @deprecated use the quality factor packet side data instead
2884 attribute_deprecated AVFrame *coded_frame;
2889 * is used to decide how many independent tasks should be passed to execute()
2890 * - encoding: Set by user.
2891 * - decoding: Set by user.
2896 * Which multithreading methods to use.
2897 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2898 * so clients which cannot provide future frames should not use it.
2900 * - encoding: Set by user, otherwise the default is used.
2901 * - decoding: Set by user, otherwise the default is used.
2904 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2905 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2908 * Which multithreading methods are in use by the codec.
2909 * - encoding: Set by libavcodec.
2910 * - decoding: Set by libavcodec.
2912 int active_thread_type;
2915 * Set by the client if its custom get_buffer() callback can be called
2916 * synchronously from another thread, which allows faster multithreaded decoding.
2917 * draw_horiz_band() will be called from other threads regardless of this setting.
2918 * Ignored if the default get_buffer() is used.
2919 * - encoding: Set by user.
2920 * - decoding: Set by user.
2922 int thread_safe_callbacks;
2925 * The codec may call this to execute several independent things.
2926 * It will return only after finishing all tasks.
2927 * The user may replace this with some multithreaded implementation,
2928 * the default implementation will execute the parts serially.
2929 * @param count the number of things to execute
2930 * - encoding: Set by libavcodec, user can override.
2931 * - decoding: Set by libavcodec, user can override.
2933 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2936 * The codec may call this to execute several independent things.
2937 * It will return only after finishing all tasks.
2938 * The user may replace this with some multithreaded implementation,
2939 * the default implementation will execute the parts serially.
2940 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2941 * @param c context passed also to func
2942 * @param count the number of things to execute
2943 * @param arg2 argument passed unchanged to func
2944 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2945 * @param func function that will be called count times, with jobnr from 0 to count-1.
2946 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2947 * two instances of func executing at the same time will have the same threadnr.
2948 * @return always 0 currently, but code should handle a future improvement where when any call to func
2949 * returns < 0 no further calls to func may be done and < 0 is returned.
2950 * - encoding: Set by libavcodec, user can override.
2951 * - decoding: Set by libavcodec, user can override.
2953 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2956 * noise vs. sse weight for the nsse comparison function
2957 * - encoding: Set by user.
2958 * - decoding: unused
2964 * - encoding: Set by user.
2965 * - decoding: Set by libavcodec.
2968 #define FF_PROFILE_UNKNOWN -99
2969 #define FF_PROFILE_RESERVED -100
2971 #define FF_PROFILE_AAC_MAIN 0
2972 #define FF_PROFILE_AAC_LOW 1
2973 #define FF_PROFILE_AAC_SSR 2
2974 #define FF_PROFILE_AAC_LTP 3
2975 #define FF_PROFILE_AAC_HE 4
2976 #define FF_PROFILE_AAC_HE_V2 28
2977 #define FF_PROFILE_AAC_LD 22
2978 #define FF_PROFILE_AAC_ELD 38
2979 #define FF_PROFILE_MPEG2_AAC_LOW 128
2980 #define FF_PROFILE_MPEG2_AAC_HE 131
2982 #define FF_PROFILE_DTS 20
2983 #define FF_PROFILE_DTS_ES 30
2984 #define FF_PROFILE_DTS_96_24 40
2985 #define FF_PROFILE_DTS_HD_HRA 50
2986 #define FF_PROFILE_DTS_HD_MA 60
2987 #define FF_PROFILE_DTS_EXPRESS 70
2989 #define FF_PROFILE_MPEG2_422 0
2990 #define FF_PROFILE_MPEG2_HIGH 1
2991 #define FF_PROFILE_MPEG2_SS 2
2992 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2993 #define FF_PROFILE_MPEG2_MAIN 4
2994 #define FF_PROFILE_MPEG2_SIMPLE 5
2996 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2997 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2999 #define FF_PROFILE_H264_BASELINE 66
3000 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3001 #define FF_PROFILE_H264_MAIN 77
3002 #define FF_PROFILE_H264_EXTENDED 88
3003 #define FF_PROFILE_H264_HIGH 100
3004 #define FF_PROFILE_H264_HIGH_10 110
3005 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3006 #define FF_PROFILE_H264_HIGH_422 122
3007 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3008 #define FF_PROFILE_H264_HIGH_444 144
3009 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3010 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3011 #define FF_PROFILE_H264_CAVLC_444 44
3013 #define FF_PROFILE_VC1_SIMPLE 0
3014 #define FF_PROFILE_VC1_MAIN 1
3015 #define FF_PROFILE_VC1_COMPLEX 2
3016 #define FF_PROFILE_VC1_ADVANCED 3
3018 #define FF_PROFILE_MPEG4_SIMPLE 0
3019 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3020 #define FF_PROFILE_MPEG4_CORE 2
3021 #define FF_PROFILE_MPEG4_MAIN 3
3022 #define FF_PROFILE_MPEG4_N_BIT 4
3023 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3024 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3025 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3026 #define FF_PROFILE_MPEG4_HYBRID 8
3027 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3028 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3029 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3030 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3031 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3032 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3033 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3035 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
3036 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
3037 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
3038 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3039 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3041 #define FF_PROFILE_VP9_0 0
3042 #define FF_PROFILE_VP9_1 1
3043 #define FF_PROFILE_VP9_2 2
3044 #define FF_PROFILE_VP9_3 3
3046 #define FF_PROFILE_HEVC_MAIN 1
3047 #define FF_PROFILE_HEVC_MAIN_10 2
3048 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3049 #define FF_PROFILE_HEVC_REXT 4
3053 * - encoding: Set by user.
3054 * - decoding: Set by libavcodec.
3057 #define FF_LEVEL_UNKNOWN -99
3060 * Skip loop filtering for selected frames.
3061 * - encoding: unused
3062 * - decoding: Set by user.
3064 enum AVDiscard skip_loop_filter;
3067 * Skip IDCT/dequantization for selected frames.
3068 * - encoding: unused
3069 * - decoding: Set by user.
3071 enum AVDiscard skip_idct;
3074 * Skip decoding for selected frames.
3075 * - encoding: unused
3076 * - decoding: Set by user.
3078 enum AVDiscard skip_frame;
3081 * Header containing style information for text subtitles.
3082 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3083 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3084 * the Format line following. It shouldn't include any Dialogue line.
3085 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3086 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3088 uint8_t *subtitle_header;
3089 int subtitle_header_size;
3091 #if FF_API_ERROR_RATE
3093 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3096 attribute_deprecated
3101 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3102 * Used for compliant TS muxing.
3103 * - encoding: Set by libavcodec.
3104 * - decoding: unused.
3109 * Encoding only. Allow encoders to output packets that do not contain any
3110 * encoded data, only side data.
3112 * Some encoders need to output such packets, e.g. to update some stream
3113 * parameters at the end of encoding.
3115 * All callers are strongly recommended to set this option to 1 and update
3116 * their code to deal with such packets, since this behaviour may become
3117 * always enabled in the future (then this option will be deprecated and
3118 * later removed). To avoid ABI issues when this happens, the callers should
3119 * use AVOptions to set this field.
3121 int side_data_only_packets;
3124 * Audio only. The number of "priming" samples (padding) inserted by the
3125 * encoder at the beginning of the audio. I.e. this number of leading
3126 * decoded samples must be discarded by the caller to get the original audio
3127 * without leading padding.
3129 * - decoding: unused
3130 * - encoding: Set by libavcodec. The timestamps on the output packets are
3131 * adjusted by the encoder so that they always refer to the
3132 * first sample of the data actually contained in the packet,
3133 * including any added padding. E.g. if the timebase is
3134 * 1/samplerate and the timestamp of the first input sample is
3135 * 0, the timestamp of the first output packet will be
3138 int initial_padding;
3141 * - decoding: For codecs that store a framerate value in the compressed
3142 * bitstream, the decoder may export it here. { 0, 1} when
3144 * - encoding: unused
3146 AVRational framerate;
3149 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3150 * - encoding: unused.
3151 * - decoding: Set by libavcodec before calling get_format()
3153 enum AVPixelFormat sw_pix_fmt;
3156 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3157 * Code outside libavcodec should access this field using:
3158 * av_codec_{get,set}_pkt_timebase(avctx)
3159 * - encoding unused.
3160 * - decoding set by user.
3162 AVRational pkt_timebase;
3166 * Code outside libavcodec should access this field using:
3167 * av_codec_{get,set}_codec_descriptor(avctx)
3168 * - encoding: unused.
3169 * - decoding: set by libavcodec.
3171 const AVCodecDescriptor *codec_descriptor;
3175 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3176 * - encoding: unused
3177 * - decoding: Set by user.
3178 * Code outside libavcodec should access this field using:
3179 * av_codec_{get,set}_lowres(avctx)
3185 * Current statistics for PTS correction.
3186 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3187 * - encoding: unused
3189 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3190 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3191 int64_t pts_correction_last_pts; /// PTS of the last frame
3192 int64_t pts_correction_last_dts; /// DTS of the last frame
3195 * Character encoding of the input subtitles file.
3196 * - decoding: set by user
3197 * - encoding: unused
3202 * Subtitles character encoding mode. Formats or codecs might be adjusting
3203 * this setting (if they are doing the conversion themselves for instance).
3204 * - decoding: set by libavcodec
3205 * - encoding: unused
3207 int sub_charenc_mode;
3208 #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)
3209 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3210 #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
3213 * Skip processing alpha if supported by codec.
3214 * Note that if the format uses pre-multiplied alpha (common with VP6,
3215 * and recommended due to better video quality/compression)
3216 * the image will look as if alpha-blended onto a black background.
3217 * However for formats that do not use pre-multiplied alpha
3218 * there might be serious artefacts (though e.g. libswscale currently
3219 * assumes pre-multiplied alpha anyway).
3220 * Code outside libavcodec should access this field using AVOptions
3222 * - decoding: set by user
3223 * - encoding: unused
3228 * Number of samples to skip after a discontinuity
3229 * - decoding: unused
3230 * - encoding: set by libavcodec
3234 #if !FF_API_DEBUG_MV
3236 * debug motion vectors
3237 * Code outside libavcodec should access this field using AVOptions
3238 * - encoding: Set by user.
3239 * - decoding: Set by user.
3242 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3243 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3244 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3248 * custom intra quantization matrix
3249 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3250 * - encoding: Set by user, can be NULL.
3251 * - decoding: unused.
3253 uint16_t *chroma_intra_matrix;
3256 * dump format separator.
3257 * can be ", " or "\n " or anything else
3258 * Code outside libavcodec should access this field using AVOptions
3259 * (NO direct access).
3260 * - encoding: Set by user.
3261 * - decoding: Set by user.
3263 uint8_t *dump_separator;
3266 * ',' separated list of allowed decoders.
3267 * If NULL then all are allowed
3268 * - encoding: unused
3269 * - decoding: set by user through AVOPtions (NO direct access)
3271 char *codec_whitelist;
3274 * Properties of the stream that gets decoded
3275 * To be accessed through av_codec_get_properties() (NO direct access)
3276 * - encoding: unused
3277 * - decoding: set by libavcodec
3279 unsigned properties;
3280 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3281 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3284 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3285 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3287 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3288 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3290 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3292 int av_codec_get_lowres(const AVCodecContext *avctx);
3293 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3295 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3296 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3298 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3299 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3304 typedef struct AVProfile {
3306 const char *name; ///< short name for the profile
3309 typedef struct AVCodecDefault AVCodecDefault;
3316 typedef struct AVCodec {
3318 * Name of the codec implementation.
3319 * The name is globally unique among encoders and among decoders (but an
3320 * encoder and a decoder can share the same name).
3321 * This is the primary way to find a codec from the user perspective.
3325 * Descriptive name for the codec, meant to be more human readable than name.
3326 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3328 const char *long_name;
3329 enum AVMediaType type;
3332 * Codec capabilities.
3333 * see AV_CODEC_CAP_*
3336 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3337 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3338 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3339 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3340 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3341 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3342 const AVClass *priv_class; ///< AVClass for the private context
3343 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3345 /*****************************************************************
3346 * No fields below this line are part of the public API. They
3347 * may not be used outside of libavcodec and can be changed and
3349 * New public fields should be added right above.
3350 *****************************************************************
3353 struct AVCodec *next;
3355 * @name Frame-level threading support functions
3359 * If defined, called on thread contexts when they are created.
3360 * If the codec allocates writable tables in init(), re-allocate them here.
3361 * priv_data will be set to a copy of the original.
3363 int (*init_thread_copy)(AVCodecContext *);
3365 * Copy necessary context variables from a previous thread context to the current one.
3366 * If not defined, the next thread will start automatically; otherwise, the codec
3367 * must call ff_thread_finish_setup().
3369 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3371 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3375 * Private codec-specific defaults.
3377 const AVCodecDefault *defaults;
3380 * Initialize codec static data, called from avcodec_register().
3382 void (*init_static_data)(struct AVCodec *codec);
3384 int (*init)(AVCodecContext *);
3385 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3386 const struct AVSubtitle *sub);
3388 * Encode data to an AVPacket.
3390 * @param avctx codec context
3391 * @param avpkt output AVPacket (may contain a user-provided buffer)
3392 * @param[in] frame AVFrame containing the raw data to be encoded
3393 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3394 * non-empty packet was returned in avpkt.
3395 * @return 0 on success, negative error code on failure
3397 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3398 int *got_packet_ptr);
3399 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3400 int (*close)(AVCodecContext *);
3403 * Will be called when seeking
3405 void (*flush)(AVCodecContext *);
3407 * Internal codec capabilities.
3408 * See FF_CODEC_CAP_* in internal.h
3413 int av_codec_get_max_lowres(const AVCodec *codec);
3415 struct MpegEncContext;
3418 * @defgroup lavc_hwaccel AVHWAccel
3421 typedef struct AVHWAccel {
3423 * Name of the hardware accelerated codec.
3424 * The name is globally unique among encoders and among decoders (but an
3425 * encoder and a decoder can share the same name).
3430 * Type of codec implemented by the hardware accelerator.
3432 * See AVMEDIA_TYPE_xxx
3434 enum AVMediaType type;
3437 * Codec implemented by the hardware accelerator.
3439 * See AV_CODEC_ID_xxx
3444 * Supported pixel format.
3446 * Only hardware accelerated formats are supported here.
3448 enum AVPixelFormat pix_fmt;
3451 * Hardware accelerated codec capabilities.
3452 * see HWACCEL_CODEC_CAP_*
3456 /*****************************************************************
3457 * No fields below this line are part of the public API. They
3458 * may not be used outside of libavcodec and can be changed and
3460 * New public fields should be added right above.
3461 *****************************************************************
3463 struct AVHWAccel *next;
3466 * Allocate a custom buffer
3468 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3471 * Called at the beginning of each frame or field picture.
3473 * Meaningful frame information (codec specific) is guaranteed to
3474 * be parsed at this point. This function is mandatory.
3476 * Note that buf can be NULL along with buf_size set to 0.
3477 * Otherwise, this means the whole frame is available at this point.
3479 * @param avctx the codec context
3480 * @param buf the frame data buffer base
3481 * @param buf_size the size of the frame in bytes
3482 * @return zero if successful, a negative value otherwise
3484 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3487 * Callback for each slice.
3489 * Meaningful slice information (codec specific) is guaranteed to
3490 * be parsed at this point. This function is mandatory.
3491 * The only exception is XvMC, that works on MB level.
3493 * @param avctx the codec context
3494 * @param buf the slice data buffer base
3495 * @param buf_size the size of the slice in bytes
3496 * @return zero if successful, a negative value otherwise
3498 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3501 * Called at the end of each frame or field picture.
3503 * The whole picture is parsed at this point and can now be sent
3504 * to the hardware accelerator. This function is mandatory.
3506 * @param avctx the codec context
3507 * @return zero if successful, a negative value otherwise
3509 int (*end_frame)(AVCodecContext *avctx);
3512 * Size of per-frame hardware accelerator private data.
3514 * Private data is allocated with av_mallocz() before
3515 * AVCodecContext.get_buffer() and deallocated after
3516 * AVCodecContext.release_buffer().
3518 int frame_priv_data_size;
3521 * Called for every Macroblock in a slice.
3523 * XvMC uses it to replace the ff_mpv_decode_mb().
3524 * Instead of decoding to raw picture, MB parameters are
3525 * stored in an array provided by the video driver.
3527 * @param s the mpeg context
3529 void (*decode_mb)(struct MpegEncContext *s);
3532 * Initialize the hwaccel private data.
3534 * This will be called from ff_get_format(), after hwaccel and
3535 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3538 int (*init)(AVCodecContext *avctx);
3541 * Uninitialize the hwaccel private data.
3543 * This will be called from get_format() or avcodec_close(), after hwaccel
3544 * and hwaccel_context are already uninitialized.
3546 int (*uninit)(AVCodecContext *avctx);
3549 * Size of the private data to allocate in
3550 * AVCodecInternal.hwaccel_priv_data.
3556 * Hardware acceleration should be used for decoding even if the codec level
3557 * used is unknown or higher than the maximum supported level reported by the
3560 * It's generally a good idea to pass this flag unless you have a specific
3561 * reason not to, as hardware tends to under-report supported levels.
3563 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3566 * Hardware acceleration can output YUV pixel formats with a different chroma
3567 * sampling than 4:2:0 and/or other than 8 bits per component.
3569 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3576 * @defgroup lavc_picture AVPicture
3578 * Functions for working with AVPicture
3583 * Picture data structure.
3585 * Up to four components can be stored into it, the last component is
3588 typedef struct AVPicture {
3589 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3590 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3597 enum AVSubtitleType {
3600 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3603 * Plain text, the text field must be set by the decoder and is
3604 * authoritative. ass and pict fields may contain approximations.
3609 * Formatted text, the ass field must be set by the decoder and is
3610 * authoritative. pict and text fields may contain approximations.
3615 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3617 typedef struct AVSubtitleRect {
3618 int x; ///< top left corner of pict, undefined when pict is not set
3619 int y; ///< top left corner of pict, undefined when pict is not set
3620 int w; ///< width of pict, undefined when pict is not set
3621 int h; ///< height of pict, undefined when pict is not set
3622 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3625 * data+linesize for the bitmap of this subtitle.
3626 * can be set for text/ass as well once they are rendered
3629 enum AVSubtitleType type;
3631 char *text; ///< 0 terminated plain UTF-8 text
3634 * 0 terminated ASS/SSA compatible event line.
3635 * The presentation of this is unaffected by the other values in this
3643 typedef struct AVSubtitle {
3644 uint16_t format; /* 0 = graphics */
3645 uint32_t start_display_time; /* relative to packet pts, in ms */
3646 uint32_t end_display_time; /* relative to packet pts, in ms */
3648 AVSubtitleRect **rects;
3649 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3653 * If c is NULL, returns the first registered codec,
3654 * if c is non-NULL, returns the next registered codec after c,
3655 * or NULL if c is the last one.
3657 AVCodec *av_codec_next(const AVCodec *c);
3660 * Return the LIBAVCODEC_VERSION_INT constant.
3662 unsigned avcodec_version(void);
3665 * Return the libavcodec build-time configuration.
3667 const char *avcodec_configuration(void);
3670 * Return the libavcodec license.
3672 const char *avcodec_license(void);
3675 * Register the codec codec and initialize libavcodec.
3677 * @warning either this function or avcodec_register_all() must be called
3678 * before any other libavcodec functions.
3680 * @see avcodec_register_all()
3682 void avcodec_register(AVCodec *codec);
3685 * Register all the codecs, parsers and bitstream filters which were enabled at
3686 * configuration time. If you do not call this function you can select exactly
3687 * which formats you want to support, by using the individual registration
3690 * @see avcodec_register
3691 * @see av_register_codec_parser
3692 * @see av_register_bitstream_filter
3694 void avcodec_register_all(void);
3697 * Allocate an AVCodecContext and set its fields to default values. The
3698 * resulting struct should be freed with avcodec_free_context().
3700 * @param codec if non-NULL, allocate private data and initialize defaults
3701 * for the given codec. It is illegal to then call avcodec_open2()
3702 * with a different codec.
3703 * If NULL, then the codec-specific defaults won't be initialized,
3704 * which may result in suboptimal default settings (this is
3705 * important mainly for encoders, e.g. libx264).
3707 * @return An AVCodecContext filled with default values or NULL on failure.
3708 * @see avcodec_get_context_defaults
3710 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3713 * Free the codec context and everything associated with it and write NULL to
3714 * the provided pointer.
3716 void avcodec_free_context(AVCodecContext **avctx);
3719 * Set the fields of the given AVCodecContext to default values corresponding
3720 * to the given codec (defaults may be codec-dependent).
3722 * Do not call this function if a non-NULL codec has been passed
3723 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3724 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3725 * different codec on this AVCodecContext.
3727 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3730 * Get the AVClass for AVCodecContext. It can be used in combination with
3731 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3733 * @see av_opt_find().
3735 const AVClass *avcodec_get_class(void);
3738 * Get the AVClass for AVFrame. It can be used in combination with
3739 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3741 * @see av_opt_find().
3743 const AVClass *avcodec_get_frame_class(void);
3746 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3747 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3749 * @see av_opt_find().
3751 const AVClass *avcodec_get_subtitle_rect_class(void);
3754 * Copy the settings of the source AVCodecContext into the destination
3755 * AVCodecContext. The resulting destination codec context will be
3756 * unopened, i.e. you are required to call avcodec_open2() before you
3757 * can use this AVCodecContext to decode/encode video/audio data.
3759 * @param dest target codec context, should be initialized with
3760 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3761 * @param src source codec context
3762 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3764 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3767 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3768 * function the context has to be allocated with avcodec_alloc_context3().
3770 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3771 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3772 * retrieving a codec.
3774 * @warning This function is not thread safe!
3776 * @note Always call this function before using decoding routines (such as
3777 * @ref avcodec_decode_video2()).
3780 * avcodec_register_all();
3781 * av_dict_set(&opts, "b", "2.5M", 0);
3782 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3786 * context = avcodec_alloc_context3(codec);
3788 * if (avcodec_open2(context, codec, opts) < 0)
3792 * @param avctx The context to initialize.
3793 * @param codec The codec to open this context for. If a non-NULL codec has been
3794 * previously passed to avcodec_alloc_context3() or
3795 * avcodec_get_context_defaults3() for this context, then this
3796 * parameter MUST be either NULL or equal to the previously passed
3798 * @param options A dictionary filled with AVCodecContext and codec-private options.
3799 * On return this object will be filled with options that were not found.
3801 * @return zero on success, a negative value on error
3802 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3803 * av_dict_set(), av_opt_find().
3805 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3808 * Close a given AVCodecContext and free all the data associated with it
3809 * (but not the AVCodecContext itself).
3811 * Calling this function on an AVCodecContext that hasn't been opened will free
3812 * the codec-specific data allocated in avcodec_alloc_context3() /
3813 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3816 int avcodec_close(AVCodecContext *avctx);
3819 * Free all allocated data in the given subtitle struct.
3821 * @param sub AVSubtitle to free.
3823 void avsubtitle_free(AVSubtitle *sub);
3830 * @addtogroup lavc_packet
3835 * Initialize optional fields of a packet with default values.
3837 * Note, this does not touch the data and size members, which have to be
3838 * initialized separately.
3842 void av_init_packet(AVPacket *pkt);
3845 * Allocate the payload of a packet and initialize its fields with
3849 * @param size wanted payload size
3850 * @return 0 if OK, AVERROR_xxx otherwise
3852 int av_new_packet(AVPacket *pkt, int size);
3855 * Reduce packet size, correctly zeroing padding
3858 * @param size new size
3860 void av_shrink_packet(AVPacket *pkt, int size);
3863 * Increase packet size, correctly zeroing padding
3866 * @param grow_by number of bytes by which to increase the size of the packet
3868 int av_grow_packet(AVPacket *pkt, int grow_by);
3871 * Initialize a reference-counted packet from av_malloc()ed data.
3873 * @param pkt packet to be initialized. This function will set the data, size,
3874 * buf and destruct fields, all others are left untouched.
3875 * @param data Data allocated by av_malloc() to be used as packet data. If this
3876 * function returns successfully, the data is owned by the underlying AVBuffer.
3877 * The caller may not access the data through other means.
3878 * @param size size of data in bytes, without the padding. I.e. the full buffer
3879 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
3881 * @return 0 on success, a negative AVERROR on error
3883 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3886 * @warning This is a hack - the packet memory allocation stuff is broken. The
3887 * packet is allocated if it was not really allocated.
3889 int av_dup_packet(AVPacket *pkt);
3892 * Copy packet, including contents
3894 * @return 0 on success, negative AVERROR on fail
3896 int av_copy_packet(AVPacket *dst, const AVPacket *src);
3899 * Copy packet side data
3901 * @return 0 on success, negative AVERROR on fail
3903 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
3908 * @param pkt packet to free
3910 void av_free_packet(AVPacket *pkt);
3913 * Allocate new information of a packet.
3916 * @param type side information type
3917 * @param size side information size
3918 * @return pointer to fresh allocated data or NULL otherwise
3920 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3924 * Shrink the already allocated side data buffer
3927 * @param type side information type
3928 * @param size new side information size
3929 * @return 0 on success, < 0 on failure
3931 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3935 * Get side information from packet.
3938 * @param type desired side information type
3939 * @param size pointer for side information size to store (optional)
3940 * @return pointer to data if present or NULL otherwise
3942 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3945 int av_packet_merge_side_data(AVPacket *pkt);
3947 int av_packet_split_side_data(AVPacket *pkt);
3949 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
3952 * Pack a dictionary for use in side_data.
3954 * @param dict The dictionary to pack.
3955 * @param size pointer to store the size of the returned data
3956 * @return pointer to data if successful, NULL otherwise
3958 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
3960 * Unpack a dictionary from side_data.
3962 * @param data data from side_data
3963 * @param size size of the data
3964 * @param dict the metadata storage dictionary
3965 * @return 0 on success, < 0 on failure
3967 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
3971 * Convenience function to free all the side data stored.
3972 * All the other fields stay untouched.
3976 void av_packet_free_side_data(AVPacket *pkt);
3979 * Setup a new reference to the data described by a given packet
3981 * If src is reference-counted, setup dst as a new reference to the
3982 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3983 * data from src into it.
3985 * All the other fields are copied from src.
3987 * @see av_packet_unref
3989 * @param dst Destination packet
3990 * @param src Source packet
3992 * @return 0 on success, a negative AVERROR on error.
3994 int av_packet_ref(AVPacket *dst, const AVPacket *src);
3999 * Unreference the buffer referenced by the packet and reset the
4000 * remaining packet fields to their default values.
4002 * @param pkt The packet to be unreferenced.
4004 void av_packet_unref(AVPacket *pkt);
4007 * Move every field in src to dst and reset src.
4009 * @see av_packet_unref
4011 * @param src Source packet, will be reset
4012 * @param dst Destination packet
4014 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4017 * Copy only "properties" fields from src to dst.
4019 * Properties for the purpose of this function are all the fields
4020 * beside those related to the packet data (buf, data, size)
4022 * @param dst Destination packet
4023 * @param src Source packet
4025 * @return 0 on success AVERROR on failure.
4028 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4031 * Convert valid timing fields (timestamps / durations) in a packet from one
4032 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4035 * @param pkt packet on which the conversion will be performed
4036 * @param tb_src source timebase, in which the timing fields in pkt are
4038 * @param tb_dst destination timebase, to which the timing fields will be
4041 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4048 * @addtogroup lavc_decoding
4053 * Find a registered decoder with a matching codec ID.
4055 * @param id AVCodecID of the requested decoder
4056 * @return A decoder if one was found, NULL otherwise.
4058 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4061 * Find a registered decoder with the specified name.
4063 * @param name name of the requested decoder
4064 * @return A decoder if one was found, NULL otherwise.
4066 AVCodec *avcodec_find_decoder_by_name(const char *name);
4069 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4070 * it can be called by custom get_buffer2() implementations for decoders without
4071 * AV_CODEC_CAP_DR1 set.
4073 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4077 * Return the amount of padding in pixels which the get_buffer callback must
4078 * provide around the edge of the image for codecs which do not have the
4079 * CODEC_FLAG_EMU_EDGE flag.
4081 * @return Required padding in pixels.
4083 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4086 attribute_deprecated
4087 unsigned avcodec_get_edge_width(void);
4091 * Modify width and height values so that they will result in a memory
4092 * buffer that is acceptable for the codec if you do not use any horizontal
4095 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4097 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4100 * Modify width and height values so that they will result in a memory
4101 * buffer that is acceptable for the codec if you also ensure that all
4102 * line sizes are a multiple of the respective linesize_align[i].
4104 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4106 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4107 int linesize_align[AV_NUM_DATA_POINTERS]);
4110 * Converts AVChromaLocation to swscale x/y chroma position.
4112 * The positions represent the chroma (0,0) position in a coordinates system
4113 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4115 * @param xpos horizontal chroma sample position
4116 * @param ypos vertical chroma sample position
4118 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4121 * Converts swscale x/y chroma position to AVChromaLocation.
4123 * The positions represent the chroma (0,0) position in a coordinates system
4124 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4126 * @param xpos horizontal chroma sample position
4127 * @param ypos vertical chroma sample position
4129 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4132 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4134 * Some decoders may support multiple frames in a single AVPacket. Such
4135 * decoders would then just decode the first frame and the return value would be
4136 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4137 * called again with an AVPacket containing the remaining data in order to
4138 * decode the second frame, etc... Even if no frames are returned, the packet
4139 * needs to be fed to the decoder with remaining data until it is completely
4140 * consumed or an error occurs.
4142 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4143 * and output. This means that for some packets they will not immediately
4144 * produce decoded output and need to be flushed at the end of decoding to get
4145 * all the decoded data. Flushing is done by calling this function with packets
4146 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4147 * returning samples. It is safe to flush even those decoders that are not
4148 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4150 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4151 * larger than the actual read bytes because some optimized bitstream
4152 * readers read 32 or 64 bits at once and could read over the end.
4154 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4155 * before packets may be fed to the decoder.
4157 * @param avctx the codec context
4158 * @param[out] frame The AVFrame in which to store decoded audio samples.
4159 * The decoder will allocate a buffer for the decoded frame by
4160 * calling the AVCodecContext.get_buffer2() callback.
4161 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4162 * reference counted and the returned reference belongs to the
4163 * caller. The caller must release the frame using av_frame_unref()
4164 * when the frame is no longer needed. The caller may safely write
4165 * to the frame if av_frame_is_writable() returns 1.
4166 * When AVCodecContext.refcounted_frames is set to 0, the returned
4167 * reference belongs to the decoder and is valid only until the
4168 * next call to this function or until closing or flushing the
4169 * decoder. The caller may not write to it.
4170 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4171 * non-zero. Note that this field being set to zero
4172 * does not mean that an error has occurred. For
4173 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4174 * call is guaranteed to produce a frame.
4175 * @param[in] avpkt The input AVPacket containing the input buffer.
4176 * At least avpkt->data and avpkt->size should be set. Some
4177 * decoders might also require additional fields to be set.
4178 * @return A negative error code is returned if an error occurred during
4179 * decoding, otherwise the number of bytes consumed from the input
4180 * AVPacket is returned.
4182 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4183 int *got_frame_ptr, const AVPacket *avpkt);
4186 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4187 * Some decoders may support multiple frames in a single AVPacket, such
4188 * decoders would then just decode the first frame.
4190 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4191 * the actual read bytes because some optimized bitstream readers read 32 or 64
4192 * bits at once and could read over the end.
4194 * @warning The end of the input buffer buf should be set to 0 to ensure that
4195 * no overreading happens for damaged MPEG streams.
4197 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4198 * between input and output, these need to be fed with avpkt->data=NULL,
4199 * avpkt->size=0 at the end to return the remaining frames.
4201 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4202 * before packets may be fed to the decoder.
4204 * @param avctx the codec context
4205 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4206 * Use av_frame_alloc() to get an AVFrame. The codec will
4207 * allocate memory for the actual bitmap by calling the
4208 * AVCodecContext.get_buffer2() callback.
4209 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4210 * reference counted and the returned reference belongs to the
4211 * caller. The caller must release the frame using av_frame_unref()
4212 * when the frame is no longer needed. The caller may safely write
4213 * to the frame if av_frame_is_writable() returns 1.
4214 * When AVCodecContext.refcounted_frames is set to 0, the returned
4215 * reference belongs to the decoder and is valid only until the
4216 * next call to this function or until closing or flushing the
4217 * decoder. The caller may not write to it.
4219 * @param[in] avpkt The input AVPacket containing the input buffer.
4220 * You can create such packet with av_init_packet() and by then setting
4221 * data and size, some decoders might in addition need other fields like
4222 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4224 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4225 * @return On error a negative value is returned, otherwise the number of bytes
4226 * used or zero if no frame could be decompressed.
4228 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4229 int *got_picture_ptr,
4230 const AVPacket *avpkt);
4233 * Decode a subtitle message.
4234 * Return a negative value on error, otherwise return the number of bytes used.
4235 * If no subtitle could be decompressed, got_sub_ptr is zero.
4236 * Otherwise, the subtitle is stored in *sub.
4237 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4238 * simplicity, because the performance difference is expect to be negligible
4239 * and reusing a get_buffer written for video codecs would probably perform badly
4240 * due to a potentially very different allocation pattern.
4242 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4243 * and output. This means that for some packets they will not immediately
4244 * produce decoded output and need to be flushed at the end of decoding to get
4245 * all the decoded data. Flushing is done by calling this function with packets
4246 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4247 * returning subtitles. It is safe to flush even those decoders that are not
4248 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4250 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4251 * before packets may be fed to the decoder.
4253 * @param avctx the codec context
4254 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4255 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4256 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4257 * @param[in] avpkt The input AVPacket containing the input buffer.
4259 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4264 * @defgroup lavc_parsing Frame parsing
4268 enum AVPictureStructure {
4269 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4270 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4271 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4272 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4275 typedef struct AVCodecParserContext {
4277 struct AVCodecParser *parser;
4278 int64_t frame_offset; /* offset of the current frame */
4279 int64_t cur_offset; /* current offset
4280 (incremented by each av_parser_parse()) */
4281 int64_t next_frame_offset; /* offset of the next frame */
4283 int pict_type; /* XXX: Put it back in AVCodecContext. */
4285 * This field is used for proper frame duration computation in lavf.
4286 * It signals, how much longer the frame duration of the current frame
4287 * is compared to normal frame duration.
4289 * frame_duration = (1 + repeat_pict) * time_base
4291 * It is used by codecs like H.264 to display telecined material.
4293 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4294 int64_t pts; /* pts of the current frame */
4295 int64_t dts; /* dts of the current frame */
4300 int fetch_timestamp;
4302 #define AV_PARSER_PTS_NB 4
4303 int cur_frame_start_index;
4304 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4305 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4306 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4309 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4310 #define PARSER_FLAG_ONCE 0x0002
4311 /// Set if the parser has a valid file offset
4312 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4313 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4315 int64_t offset; ///< byte offset from starting packet start
4316 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4319 * Set by parser to 1 for key frames and 0 for non-key frames.
4320 * It is initialized to -1, so if the parser doesn't set this flag,
4321 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4327 * Time difference in stream time base units from the pts of this
4328 * packet to the point at which the output from the decoder has converged
4329 * independent from the availability of previous frames. That is, the
4330 * frames are virtually identical no matter if decoding started from
4331 * the very first frame or from this keyframe.
4332 * Is AV_NOPTS_VALUE if unknown.
4333 * This field is not the display duration of the current frame.
4334 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4337 * The purpose of this field is to allow seeking in streams that have no
4338 * keyframes in the conventional sense. It corresponds to the
4339 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4340 * essential for some types of subtitle streams to ensure that all
4341 * subtitles are correctly displayed after seeking.
4343 int64_t convergence_duration;
4345 // Timestamp generation support:
4347 * Synchronization point for start of timestamp generation.
4349 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4352 * For example, this corresponds to presence of H.264 buffering period
4358 * Offset of the current timestamp against last timestamp sync point in
4359 * units of AVCodecContext.time_base.
4361 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4362 * contain a valid timestamp offset.
4364 * Note that the timestamp of sync point has usually a nonzero
4365 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4366 * the next frame after timestamp sync point will be usually 1.
4368 * For example, this corresponds to H.264 cpb_removal_delay.
4370 int dts_ref_dts_delta;
4373 * Presentation delay of current frame in units of AVCodecContext.time_base.
4375 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4376 * contain valid non-negative timestamp delta (presentation time of a frame
4377 * must not lie in the past).
4379 * This delay represents the difference between decoding and presentation
4380 * time of the frame.
4382 * For example, this corresponds to H.264 dpb_output_delay.
4387 * Position of the packet in file.
4389 * Analogous to cur_frame_pts/dts
4391 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4394 * Byte position of currently parsed frame in stream.
4399 * Previous frame byte position.
4404 * Duration of the current frame.
4405 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4406 * For all other types, this is in units of AVCodecContext.time_base.
4410 enum AVFieldOrder field_order;
4413 * Indicate whether a picture is coded as a frame, top field or bottom field.
4415 * For example, H.264 field_pic_flag equal to 0 corresponds to
4416 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4417 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4418 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4420 enum AVPictureStructure picture_structure;
4423 * Picture number incremented in presentation or output order.
4424 * This field may be reinitialized at the first picture of a new sequence.
4426 * For example, this corresponds to H.264 PicOrderCnt.
4428 int output_picture_number;
4431 * Dimensions of the decoded video intended for presentation.
4437 * Dimensions of the coded video.
4443 * The format of the coded data, corresponds to enum AVPixelFormat for video
4444 * and for enum AVSampleFormat for audio.
4446 * Note that a decoder can have considerable freedom in how exactly it
4447 * decodes the data, so the format reported here might be different from the
4448 * one returned by a decoder.
4451 } AVCodecParserContext;
4453 typedef struct AVCodecParser {
4454 int codec_ids[5]; /* several codec IDs are permitted */
4456 int (*parser_init)(AVCodecParserContext *s);
4457 /* This callback never returns an error, a negative value means that
4458 * the frame start was in a previous packet. */
4459 int (*parser_parse)(AVCodecParserContext *s,
4460 AVCodecContext *avctx,
4461 const uint8_t **poutbuf, int *poutbuf_size,
4462 const uint8_t *buf, int buf_size);
4463 void (*parser_close)(AVCodecParserContext *s);
4464 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4465 struct AVCodecParser *next;
4468 AVCodecParser *av_parser_next(const AVCodecParser *c);
4470 void av_register_codec_parser(AVCodecParser *parser);
4471 AVCodecParserContext *av_parser_init(int codec_id);
4476 * @param s parser context.
4477 * @param avctx codec context.
4478 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4479 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4480 * @param buf input buffer.
4481 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4482 * @param pts input presentation timestamp.
4483 * @param dts input decoding timestamp.
4484 * @param pos input byte position in stream.
4485 * @return the number of bytes of the input bitstream used.
4490 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4497 * decode_frame(data, size);
4501 int av_parser_parse2(AVCodecParserContext *s,
4502 AVCodecContext *avctx,
4503 uint8_t **poutbuf, int *poutbuf_size,
4504 const uint8_t *buf, int buf_size,
4505 int64_t pts, int64_t dts,
4509 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4510 * @deprecated use AVBitStreamFilter
4512 int av_parser_change(AVCodecParserContext *s,
4513 AVCodecContext *avctx,
4514 uint8_t **poutbuf, int *poutbuf_size,
4515 const uint8_t *buf, int buf_size, int keyframe);
4516 void av_parser_close(AVCodecParserContext *s);
4524 * @addtogroup lavc_encoding
4529 * Find a registered encoder with a matching codec ID.
4531 * @param id AVCodecID of the requested encoder
4532 * @return An encoder if one was found, NULL otherwise.
4534 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4537 * Find a registered encoder with the specified name.
4539 * @param name name of the requested encoder
4540 * @return An encoder if one was found, NULL otherwise.
4542 AVCodec *avcodec_find_encoder_by_name(const char *name);
4545 * Encode a frame of audio.
4547 * Takes input samples from frame and writes the next output packet, if
4548 * available, to avpkt. The output packet does not necessarily contain data for
4549 * the most recent frame, as encoders can delay, split, and combine input frames
4550 * internally as needed.
4552 * @param avctx codec context
4553 * @param avpkt output AVPacket.
4554 * The user can supply an output buffer by setting
4555 * avpkt->data and avpkt->size prior to calling the
4556 * function, but if the size of the user-provided data is not
4557 * large enough, encoding will fail. If avpkt->data and
4558 * avpkt->size are set, avpkt->destruct must also be set. All
4559 * other AVPacket fields will be reset by the encoder using
4560 * av_init_packet(). If avpkt->data is NULL, the encoder will
4561 * allocate it. The encoder will set avpkt->size to the size
4562 * of the output packet.
4564 * If this function fails or produces no output, avpkt will be
4565 * freed using av_free_packet() (i.e. avpkt->destruct will be
4566 * called to free the user supplied buffer).
4567 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4568 * May be NULL when flushing an encoder that has the
4569 * AV_CODEC_CAP_DELAY capability set.
4570 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4571 * can have any number of samples.
4572 * If it is not set, frame->nb_samples must be equal to
4573 * avctx->frame_size for all frames except the last.
4574 * The final frame may be smaller than avctx->frame_size.
4575 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4576 * output packet is non-empty, and to 0 if it is
4577 * empty. If the function returns an error, the
4578 * packet can be assumed to be invalid, and the
4579 * value of got_packet_ptr is undefined and should
4581 * @return 0 on success, negative error code on failure
4583 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4584 const AVFrame *frame, int *got_packet_ptr);
4587 * Encode a frame of video.
4589 * Takes input raw video data from frame and writes the next output packet, if
4590 * available, to avpkt. The output packet does not necessarily contain data for
4591 * the most recent frame, as encoders can delay and reorder input frames
4592 * internally as needed.
4594 * @param avctx codec context
4595 * @param avpkt output AVPacket.
4596 * The user can supply an output buffer by setting
4597 * avpkt->data and avpkt->size prior to calling the
4598 * function, but if the size of the user-provided data is not
4599 * large enough, encoding will fail. All other AVPacket fields
4600 * will be reset by the encoder using av_init_packet(). If
4601 * avpkt->data is NULL, the encoder will allocate it.
4602 * The encoder will set avpkt->size to the size of the
4603 * output packet. The returned data (if any) belongs to the
4604 * caller, he is responsible for freeing it.
4606 * If this function fails or produces no output, avpkt will be
4607 * freed using av_free_packet() (i.e. avpkt->destruct will be
4608 * called to free the user supplied buffer).
4609 * @param[in] frame AVFrame containing the raw video data to be encoded.
4610 * May be NULL when flushing an encoder that has the
4611 * AV_CODEC_CAP_DELAY capability set.
4612 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4613 * output packet is non-empty, and to 0 if it is
4614 * empty. If the function returns an error, the
4615 * packet can be assumed to be invalid, and the
4616 * value of got_packet_ptr is undefined and should
4618 * @return 0 on success, negative error code on failure
4620 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4621 const AVFrame *frame, int *got_packet_ptr);
4623 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4624 const AVSubtitle *sub);
4631 #if FF_API_AVCODEC_RESAMPLE
4633 * @defgroup lavc_resample Audio resampling
4635 * @deprecated use libswresample instead
4639 struct ReSampleContext;
4640 struct AVResampleContext;
4642 typedef struct ReSampleContext ReSampleContext;
4645 * Initialize audio resampling context.
4647 * @param output_channels number of output channels
4648 * @param input_channels number of input channels
4649 * @param output_rate output sample rate
4650 * @param input_rate input sample rate
4651 * @param sample_fmt_out requested output sample format
4652 * @param sample_fmt_in input sample format
4653 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4654 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4655 * @param linear if 1 then the used FIR filter will be linearly interpolated
4656 between the 2 closest, if 0 the closest will be used
4657 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4658 * @return allocated ReSampleContext, NULL if error occurred
4660 attribute_deprecated
4661 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4662 int output_rate, int input_rate,
4663 enum AVSampleFormat sample_fmt_out,
4664 enum AVSampleFormat sample_fmt_in,
4665 int filter_length, int log2_phase_count,
4666 int linear, double cutoff);
4668 attribute_deprecated
4669 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4672 * Free resample context.
4674 * @param s a non-NULL pointer to a resample context previously
4675 * created with av_audio_resample_init()
4677 attribute_deprecated
4678 void audio_resample_close(ReSampleContext *s);
4682 * Initialize an audio resampler.
4683 * Note, if either rate is not an integer then simply scale both rates up so they are.
4684 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4685 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4686 * @param linear If 1 then the used FIR filter will be linearly interpolated
4687 between the 2 closest, if 0 the closest will be used
4688 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4690 attribute_deprecated
4691 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4694 * Resample an array of samples using a previously configured context.
4695 * @param src an array of unconsumed samples
4696 * @param consumed the number of samples of src which have been consumed are returned here
4697 * @param src_size the number of unconsumed samples available
4698 * @param dst_size the amount of space in samples available in dst
4699 * @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.
4700 * @return the number of samples written in dst or -1 if an error occurred
4702 attribute_deprecated
4703 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4707 * Compensate samplerate/timestamp drift. The compensation is done by changing
4708 * the resampler parameters, so no audible clicks or similar distortions occur
4709 * @param compensation_distance distance in output samples over which the compensation should be performed
4710 * @param sample_delta number of output samples which should be output less
4712 * example: av_resample_compensate(c, 10, 500)
4713 * here instead of 510 samples only 500 samples would be output
4715 * note, due to rounding the actual compensation might be slightly different,
4716 * especially if the compensation_distance is large and the in_rate used during init is small
4718 attribute_deprecated
4719 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4720 attribute_deprecated
4721 void av_resample_close(struct AVResampleContext *c);
4729 * @addtogroup lavc_picture
4734 * Allocate memory for the pixels of a picture and setup the AVPicture
4737 * Call avpicture_free() to free it.
4739 * @param picture the picture structure to be filled in
4740 * @param pix_fmt the pixel format of the picture
4741 * @param width the width of the picture
4742 * @param height the height of the picture
4743 * @return zero if successful, a negative error code otherwise
4745 * @see av_image_alloc(), avpicture_fill()
4747 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4750 * Free a picture previously allocated by avpicture_alloc().
4751 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4754 * @param picture the AVPicture to be freed
4756 void avpicture_free(AVPicture *picture);
4759 * Setup the picture fields based on the specified image parameters
4760 * and the provided image data buffer.
4762 * The picture fields are filled in by using the image data buffer
4763 * pointed to by ptr.
4765 * If ptr is NULL, the function will fill only the picture linesize
4766 * array and return the required size for the image buffer.
4768 * To allocate an image buffer and fill the picture data in one call,
4769 * use avpicture_alloc().
4771 * @param picture the picture to be filled in
4772 * @param ptr buffer where the image data is stored, or NULL
4773 * @param pix_fmt the pixel format of the image
4774 * @param width the width of the image in pixels
4775 * @param height the height of the image in pixels
4776 * @return the size in bytes required for src, a negative error code
4777 * in case of failure
4779 * @see av_image_fill_arrays()
4781 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4782 enum AVPixelFormat pix_fmt, int width, int height);
4785 * Copy pixel data from an AVPicture into a buffer.
4787 * avpicture_get_size() can be used to compute the required size for
4788 * the buffer to fill.
4790 * @param src source picture with filled data
4791 * @param pix_fmt picture pixel format
4792 * @param width picture width
4793 * @param height picture height
4794 * @param dest destination buffer
4795 * @param dest_size destination buffer size in bytes
4796 * @return the number of bytes written to dest, or a negative value
4797 * (error code) on error, for example if the destination buffer is not
4800 * @see av_image_copy_to_buffer()
4802 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4803 int width, int height,
4804 unsigned char *dest, int dest_size);
4807 * Calculate the size in bytes that a picture of the given width and height
4808 * would occupy if stored in the given picture format.
4810 * @param pix_fmt picture pixel format
4811 * @param width picture width
4812 * @param height picture height
4813 * @return the computed picture buffer size or a negative error code
4816 * @see av_image_get_buffer_size().
4818 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4821 * Copy image src to dst. Wraps av_image_copy().
4823 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4824 enum AVPixelFormat pix_fmt, int width, int height);
4827 * Crop image top and left side.
4829 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4830 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4835 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4836 int padtop, int padbottom, int padleft, int padright, int *color);
4843 * @defgroup lavc_misc Utility functions
4846 * Miscellaneous utility functions related to both encoding and decoding
4852 * @defgroup lavc_misc_pixfmt Pixel formats
4854 * Functions for working with pixel formats.
4859 * Utility function to access log2_chroma_w log2_chroma_h from
4860 * the pixel format AVPixFmtDescriptor.
4862 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4863 * for one that returns a failure code and continues in case of invalid
4866 * @param[in] pix_fmt the pixel format
4867 * @param[out] h_shift store log2_chroma_w
4868 * @param[out] v_shift store log2_chroma_h
4870 * @see av_pix_fmt_get_chroma_sub_sample
4873 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4876 * Return a value representing the fourCC code associated to the
4877 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4880 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4883 * @deprecated see av_get_pix_fmt_loss()
4885 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4889 * Find the best pixel format to convert to given a certain source pixel
4890 * format. When converting from one pixel format to another, information loss
4891 * may occur. For example, when converting from RGB24 to GRAY, the color
4892 * information will be lost. Similarly, other losses occur when converting from
4893 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4894 * the given pixel formats should be used to suffer the least amount of loss.
4895 * The pixel formats from which it chooses one, are determined by the
4896 * pix_fmt_list parameter.
4899 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4900 * @param[in] src_pix_fmt source pixel format
4901 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4902 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4903 * @return The best pixel format to convert to or -1 if none was found.
4905 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4906 enum AVPixelFormat src_pix_fmt,
4907 int has_alpha, int *loss_ptr);
4910 * @deprecated see av_find_best_pix_fmt_of_2()
4912 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4913 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4915 attribute_deprecated
4916 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
4917 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
4918 enum AVPixelFormat src_pix_fmt,
4919 int has_alpha, int *loss_ptr);
4921 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4922 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4926 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4932 #if FF_API_SET_DIMENSIONS
4934 * @deprecated this function is not supposed to be used from outside of lavc
4936 attribute_deprecated
4937 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4941 * Put a string representing the codec tag codec_tag in buf.
4943 * @param buf buffer to place codec tag in
4944 * @param buf_size size in bytes of buf
4945 * @param codec_tag codec tag to assign
4946 * @return the length of the string that would have been generated if
4947 * enough space had been available, excluding the trailing null
4949 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4951 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4954 * Return a name for the specified profile, if available.
4956 * @param codec the codec that is searched for the given profile
4957 * @param profile the profile value for which a name is requested
4958 * @return A name for the profile if found, NULL otherwise.
4960 const char *av_get_profile_name(const AVCodec *codec, int profile);
4962 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4963 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4964 //FIXME func typedef
4967 * Fill AVFrame audio data and linesize pointers.
4969 * The buffer buf must be a preallocated buffer with a size big enough
4970 * to contain the specified samples amount. The filled AVFrame data
4971 * pointers will point to this buffer.
4973 * AVFrame extended_data channel pointers are allocated if necessary for
4976 * @param frame the AVFrame
4977 * frame->nb_samples must be set prior to calling the
4978 * function. This function fills in frame->data,
4979 * frame->extended_data, frame->linesize[0].
4980 * @param nb_channels channel count
4981 * @param sample_fmt sample format
4982 * @param buf buffer to use for frame data
4983 * @param buf_size size of buffer
4984 * @param align plane size sample alignment (0 = default)
4985 * @return >=0 on success, negative error code on failure
4986 * @todo return the size in bytes required to store the samples in
4987 * case of success, at the next libavutil bump
4989 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4990 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4991 int buf_size, int align);
4994 * Reset the internal decoder state / flush internal buffers. Should be called
4995 * e.g. when seeking or when switching to a different stream.
4997 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4998 * this invalidates the frames previously returned from the decoder. When
4999 * refcounted frames are used, the decoder just releases any references it might
5000 * keep internally, but the caller's reference remains valid.
5002 void avcodec_flush_buffers(AVCodecContext *avctx);
5005 * Return codec bits per sample.
5007 * @param[in] codec_id the codec
5008 * @return Number of bits per sample or zero if unknown for the given codec.
5010 int av_get_bits_per_sample(enum AVCodecID codec_id);
5013 * Return the PCM codec associated with a sample format.
5014 * @param be endianness, 0 for little, 1 for big,
5015 * -1 (or anything else) for native
5016 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5018 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5021 * Return codec bits per sample.
5022 * Only return non-zero if the bits per sample is exactly correct, not an
5025 * @param[in] codec_id the codec
5026 * @return Number of bits per sample or zero if unknown for the given codec.
5028 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5031 * Return audio frame duration.
5033 * @param avctx codec context
5034 * @param frame_bytes size of the frame, or 0 if unknown
5035 * @return frame duration, in samples, if known. 0 if not able to
5038 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5041 typedef struct AVBitStreamFilterContext {
5043 struct AVBitStreamFilter *filter;
5044 AVCodecParserContext *parser;
5045 struct AVBitStreamFilterContext *next;
5046 } AVBitStreamFilterContext;
5049 typedef struct AVBitStreamFilter {
5052 int (*filter)(AVBitStreamFilterContext *bsfc,
5053 AVCodecContext *avctx, const char *args,
5054 uint8_t **poutbuf, int *poutbuf_size,
5055 const uint8_t *buf, int buf_size, int keyframe);
5056 void (*close)(AVBitStreamFilterContext *bsfc);
5057 struct AVBitStreamFilter *next;
5058 } AVBitStreamFilter;
5061 * Register a bitstream filter.
5063 * The filter will be accessible to the application code through
5064 * av_bitstream_filter_next() or can be directly initialized with
5065 * av_bitstream_filter_init().
5067 * @see avcodec_register_all()
5069 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5072 * Create and initialize a bitstream filter context given a bitstream
5075 * The returned context must be freed with av_bitstream_filter_close().
5077 * @param name the name of the bitstream filter
5078 * @return a bitstream filter context if a matching filter was found
5079 * and successfully initialized, NULL otherwise
5081 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5086 * This function filters the buffer buf with size buf_size, and places the
5087 * filtered buffer in the buffer pointed to by poutbuf.
5089 * The output buffer must be freed by the caller.
5091 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5092 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5093 * If specified, this must point to the encoder context of the
5094 * output stream the packet is sent to.
5095 * @param args arguments which specify the filter configuration, may be NULL
5096 * @param poutbuf pointer which is updated to point to the filtered buffer
5097 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5098 * @param buf buffer containing the data to filter
5099 * @param buf_size size in bytes of buf
5100 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5101 * @return >= 0 in case of success, or a negative error code in case of failure
5103 * If the return value is positive, an output buffer is allocated and
5104 * is available in *poutbuf, and is distinct from the input buffer.
5106 * If the return value is 0, the output buffer is not allocated and
5107 * should be considered identical to the input buffer, or in case
5108 * *poutbuf was set it points to the input buffer (not necessarily to
5109 * its starting address).
5111 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5112 AVCodecContext *avctx, const char *args,
5113 uint8_t **poutbuf, int *poutbuf_size,
5114 const uint8_t *buf, int buf_size, int keyframe);
5117 * Release bitstream filter context.
5119 * @param bsf the bitstream filter context created with
5120 * av_bitstream_filter_init(), can be NULL
5122 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5125 * If f is NULL, return the first registered bitstream filter,
5126 * if f is non-NULL, return the next registered bitstream filter
5127 * after f, or NULL if f is the last one.
5129 * This function can be used to iterate over all registered bitstream
5132 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5137 * Same behaviour av_fast_malloc but the buffer has additional
5138 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5140 * In addition the whole buffer will initially and after resizes
5141 * be 0-initialized so that no uninitialized data will ever appear.
5143 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5146 * Same behaviour av_fast_padded_malloc except that buffer will always
5147 * be 0-initialized after call.
5149 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5152 * Encode extradata length to a buffer. Used by xiph codecs.
5154 * @param s buffer to write to; must be at least (v/255+1) bytes long
5155 * @param v size of extradata in bytes
5156 * @return number of bytes written to the buffer.
5158 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5160 #if FF_API_MISSING_SAMPLE
5162 * Log a generic warning message about a missing feature. This function is
5163 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5164 * only, and would normally not be used by applications.
5165 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5166 * a pointer to an AVClass struct
5167 * @param[in] feature string containing the name of the missing feature
5168 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5169 * If want_sample is non-zero, additional verbage will be added to the log
5170 * message which tells the user how to report samples to the development
5172 * @deprecated Use avpriv_report_missing_feature() instead.
5174 attribute_deprecated
5175 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5178 * Log a generic warning message asking for a sample. This function is
5179 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5180 * only, and would normally not be used by applications.
5181 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5182 * a pointer to an AVClass struct
5183 * @param[in] msg string containing an optional message, or NULL if no message
5184 * @deprecated Use avpriv_request_sample() instead.
5186 attribute_deprecated
5187 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5188 #endif /* FF_API_MISSING_SAMPLE */
5191 * Register the hardware accelerator hwaccel.
5193 void av_register_hwaccel(AVHWAccel *hwaccel);
5196 * If hwaccel is NULL, returns the first registered hardware accelerator,
5197 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5198 * after hwaccel, or NULL if hwaccel is the last one.
5200 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5204 * Lock operation used by lockmgr
5207 AV_LOCK_CREATE, ///< Create a mutex
5208 AV_LOCK_OBTAIN, ///< Lock the mutex
5209 AV_LOCK_RELEASE, ///< Unlock the mutex
5210 AV_LOCK_DESTROY, ///< Free mutex resources
5214 * Register a user provided lock manager supporting the operations
5215 * specified by AVLockOp. The "mutex" argument to the function points
5216 * to a (void *) where the lockmgr should store/get a pointer to a user
5217 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5218 * value left by the last call for all other ops. If the lock manager is
5219 * unable to perform the op then it should leave the mutex in the same
5220 * state as when it was called and return a non-zero value. However,
5221 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5222 * have been successfully destroyed. If av_lockmgr_register succeeds
5223 * it will return a non-negative value, if it fails it will return a
5224 * negative value and destroy all mutex and unregister all callbacks.
5225 * av_lockmgr_register is not thread-safe, it must be called from a
5226 * single thread before any calls which make use of locking are used.
5228 * @param cb User defined callback. av_lockmgr_register invokes calls
5229 * to this callback and the previously registered callback.
5230 * The callback will be used to create more than one mutex
5231 * each of which must be backed by its own underlying locking
5232 * mechanism (i.e. do not use a single static object to
5233 * implement your lock manager). If cb is set to NULL the
5234 * lockmgr will be unregistered.
5236 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5239 * Get the type of the given codec.
5241 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5244 * Get the name of a codec.
5245 * @return a static string identifying the codec; never NULL
5247 const char *avcodec_get_name(enum AVCodecID id);
5250 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5251 * with no corresponding avcodec_close()), 0 otherwise.
5253 int avcodec_is_open(AVCodecContext *s);
5256 * @return a non-zero number if codec is an encoder, zero otherwise
5258 int av_codec_is_encoder(const AVCodec *codec);
5261 * @return a non-zero number if codec is a decoder, zero otherwise
5263 int av_codec_is_decoder(const AVCodec *codec);
5266 * @return descriptor for given codec ID or NULL if no descriptor exists.
5268 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5271 * Iterate over all codec descriptors known to libavcodec.
5273 * @param prev previous descriptor. NULL to get the first descriptor.
5275 * @return next descriptor or NULL after the last descriptor
5277 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5280 * @return codec descriptor with the given name or NULL if no such descriptor
5283 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5289 #endif /* AVCODEC_AVCODEC_H */