2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/log.h"
40 #include "libavutil/pixfmt.h"
41 #include "libavutil/rational.h"
46 * @defgroup libavc Encoding/Decoding Library
49 * @defgroup lavc_decoding Decoding
53 * @defgroup lavc_encoding Encoding
57 * @defgroup lavc_codec Codecs
59 * @defgroup lavc_codec_native Native Codecs
62 * @defgroup lavc_codec_wrappers External library wrappers
65 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
69 * @defgroup lavc_internal Internal
77 * @defgroup lavc_core Core functions/structures.
80 * Basic definitions, functions for querying libavcodec capabilities,
81 * allocating core structures, etc.
87 * Identify the syntax and semantics of the bitstream.
88 * The principle is roughly:
89 * Two decoders with the same ID can decode the same streams.
90 * Two encoders with the same ID can encode compatible streams.
91 * There may be slight deviations from the principle due to implementation
94 * If you add a codec ID to this list, add it so that
95 * 1. no value of a existing codec ID changes (that would break ABI),
96 * 2. it is as close as possible to similar codecs
98 * After adding new codec IDs, do not forget to add an entry to the codec
99 * descriptor list and bump libavcodec minor version.
105 AV_CODEC_ID_MPEG1VIDEO,
106 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
108 AV_CODEC_ID_MPEG2VIDEO_XVMC,
109 #endif /* FF_API_XVMC */
120 AV_CODEC_ID_RAWVIDEO,
121 AV_CODEC_ID_MSMPEG4V1,
122 AV_CODEC_ID_MSMPEG4V2,
123 AV_CODEC_ID_MSMPEG4V3,
146 AV_CODEC_ID_INTERPLAY_VIDEO,
153 AV_CODEC_ID_MSVIDEO1,
158 AV_CODEC_ID_TRUEMOTION1,
159 AV_CODEC_ID_VMDVIDEO,
184 AV_CODEC_ID_TRUEMOTION2,
190 AV_CODEC_ID_SMACKVIDEO,
195 AV_CODEC_ID_JPEG2000,
201 AV_CODEC_ID_DSICINVIDEO,
202 AV_CODEC_ID_TIERTEXSEQVIDEO,
210 AV_CODEC_ID_BETHSOFTVID,
222 AV_CODEC_ID_ESCAPE124,
226 AV_CODEC_ID_MOTIONPIXELS,
238 AV_CODEC_ID_FLASHSV2,
239 AV_CODEC_ID_CDGRAPHICS,
242 AV_CODEC_ID_BINKVIDEO,
243 AV_CODEC_ID_IFF_ILBM,
244 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
250 AV_CODEC_ID_A64_MULTI,
251 AV_CODEC_ID_A64_MULTI5,
254 AV_CODEC_ID_LAGARITH,
258 AV_CODEC_ID_WMV3IMAGE,
259 AV_CODEC_ID_VC1IMAGE,
261 AV_CODEC_ID_BMV_VIDEO,
268 AV_CODEC_ID_ZEROCODEC,
277 AV_CODEC_ID_ESCAPE130,
280 AV_CODEC_ID_HNM4_VIDEO,
282 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
284 AV_CODEC_ID_ALIAS_PIX,
285 AV_CODEC_ID_BRENDER_PIX,
286 AV_CODEC_ID_PAF_VIDEO,
299 AV_CODEC_ID_SCREENPRESSO,
301 AV_CODEC_ID_Y41P = 0x8000,
306 AV_CODEC_ID_TARGA_Y216,
317 /* various PCM "codecs" */
318 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
319 AV_CODEC_ID_PCM_S16LE = 0x10000,
320 AV_CODEC_ID_PCM_S16BE,
321 AV_CODEC_ID_PCM_U16LE,
322 AV_CODEC_ID_PCM_U16BE,
325 AV_CODEC_ID_PCM_MULAW,
326 AV_CODEC_ID_PCM_ALAW,
327 AV_CODEC_ID_PCM_S32LE,
328 AV_CODEC_ID_PCM_S32BE,
329 AV_CODEC_ID_PCM_U32LE,
330 AV_CODEC_ID_PCM_U32BE,
331 AV_CODEC_ID_PCM_S24LE,
332 AV_CODEC_ID_PCM_S24BE,
333 AV_CODEC_ID_PCM_U24LE,
334 AV_CODEC_ID_PCM_U24BE,
335 AV_CODEC_ID_PCM_S24DAUD,
336 AV_CODEC_ID_PCM_ZORK,
337 AV_CODEC_ID_PCM_S16LE_PLANAR,
339 AV_CODEC_ID_PCM_F32BE,
340 AV_CODEC_ID_PCM_F32LE,
341 AV_CODEC_ID_PCM_F64BE,
342 AV_CODEC_ID_PCM_F64LE,
343 AV_CODEC_ID_PCM_BLURAY,
346 AV_CODEC_ID_PCM_S8_PLANAR,
347 AV_CODEC_ID_PCM_S24LE_PLANAR,
348 AV_CODEC_ID_PCM_S32LE_PLANAR,
349 AV_CODEC_ID_PCM_S16BE_PLANAR,
350 /* new PCM "codecs" should be added right below this line starting with
351 * an explicit value of for example 0x10800
354 /* various ADPCM codecs */
355 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
356 AV_CODEC_ID_ADPCM_IMA_WAV,
357 AV_CODEC_ID_ADPCM_IMA_DK3,
358 AV_CODEC_ID_ADPCM_IMA_DK4,
359 AV_CODEC_ID_ADPCM_IMA_WS,
360 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
361 AV_CODEC_ID_ADPCM_MS,
362 AV_CODEC_ID_ADPCM_4XM,
363 AV_CODEC_ID_ADPCM_XA,
364 AV_CODEC_ID_ADPCM_ADX,
365 AV_CODEC_ID_ADPCM_EA,
366 AV_CODEC_ID_ADPCM_G726,
367 AV_CODEC_ID_ADPCM_CT,
368 AV_CODEC_ID_ADPCM_SWF,
369 AV_CODEC_ID_ADPCM_YAMAHA,
370 AV_CODEC_ID_ADPCM_SBPRO_4,
371 AV_CODEC_ID_ADPCM_SBPRO_3,
372 AV_CODEC_ID_ADPCM_SBPRO_2,
373 AV_CODEC_ID_ADPCM_THP,
374 AV_CODEC_ID_ADPCM_IMA_AMV,
375 AV_CODEC_ID_ADPCM_EA_R1,
376 AV_CODEC_ID_ADPCM_EA_R3,
377 AV_CODEC_ID_ADPCM_EA_R2,
378 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
379 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
380 AV_CODEC_ID_ADPCM_EA_XAS,
381 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
382 AV_CODEC_ID_ADPCM_IMA_ISS,
383 AV_CODEC_ID_ADPCM_G722,
384 AV_CODEC_ID_ADPCM_IMA_APC,
385 AV_CODEC_ID_ADPCM_VIMA,
386 #if FF_API_VIMA_DECODER
387 AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
390 AV_CODEC_ID_ADPCM_AFC = 0x11800,
391 AV_CODEC_ID_ADPCM_IMA_OKI,
392 AV_CODEC_ID_ADPCM_DTK,
393 AV_CODEC_ID_ADPCM_IMA_RAD,
394 AV_CODEC_ID_ADPCM_G726LE,
395 AV_CODEC_ID_ADPCM_THP_LE,
398 AV_CODEC_ID_AMR_NB = 0x12000,
401 /* RealAudio codecs*/
402 AV_CODEC_ID_RA_144 = 0x13000,
405 /* various DPCM codecs */
406 AV_CODEC_ID_ROQ_DPCM = 0x14000,
407 AV_CODEC_ID_INTERPLAY_DPCM,
408 AV_CODEC_ID_XAN_DPCM,
409 AV_CODEC_ID_SOL_DPCM,
412 AV_CODEC_ID_MP2 = 0x15000,
413 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
423 AV_CODEC_ID_VMDAUDIO,
429 AV_CODEC_ID_WESTWOOD_SND1,
430 AV_CODEC_ID_GSM, ///< as in Berlin toast format
433 AV_CODEC_ID_TRUESPEECH,
435 AV_CODEC_ID_SMACKAUDIO,
438 AV_CODEC_ID_DSICINAUDIO,
440 AV_CODEC_ID_MUSEPACK7,
442 AV_CODEC_ID_GSM_MS, /* as found in WAV */
448 AV_CODEC_ID_NELLYMOSER,
449 AV_CODEC_ID_MUSEPACK8,
451 AV_CODEC_ID_WMAVOICE,
453 AV_CODEC_ID_WMALOSSLESS,
462 AV_CODEC_ID_BINKAUDIO_RDFT,
463 AV_CODEC_ID_BINKAUDIO_DCT,
464 AV_CODEC_ID_AAC_LATM,
469 AV_CODEC_ID_8SVX_EXP,
470 AV_CODEC_ID_8SVX_FIB,
471 AV_CODEC_ID_BMV_AUDIO,
476 AV_CODEC_ID_COMFORT_NOISE,
478 AV_CODEC_ID_METASOUND,
479 AV_CODEC_ID_PAF_AUDIO,
483 AV_CODEC_ID_FFWAVESYNTH = 0x15800,
485 AV_CODEC_ID_SONIC_LS,
488 AV_CODEC_ID_DSD_LSBF,
489 AV_CODEC_ID_DSD_MSBF,
490 AV_CODEC_ID_DSD_LSBF_PLANAR,
491 AV_CODEC_ID_DSD_MSBF_PLANAR,
494 /* subtitle codecs */
495 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
496 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
497 AV_CODEC_ID_DVB_SUBTITLE,
498 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
501 AV_CODEC_ID_MOV_TEXT,
502 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
503 AV_CODEC_ID_DVB_TELETEXT,
506 AV_CODEC_ID_MICRODVD = 0x17800,
510 AV_CODEC_ID_REALTEXT,
512 AV_CODEC_ID_SUBVIEWER1,
513 AV_CODEC_ID_SUBVIEWER,
520 AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
522 /* other specific kind of codecs (generally used for attachments) */
523 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
524 AV_CODEC_ID_TTF = 0x18000,
526 AV_CODEC_ID_BINTEXT = 0x18800,
530 AV_CODEC_ID_SMPTE_KLV,
532 AV_CODEC_ID_TIMED_ID3,
533 AV_CODEC_ID_BIN_DATA,
536 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
538 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
539 * stream (only used by libavformat) */
540 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
541 * stream (only used by libavformat) */
542 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
543 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
547 * This struct describes the properties of a single codec described by an
549 * @see avcodec_descriptor_get()
551 typedef struct AVCodecDescriptor {
553 enum AVMediaType type;
555 * Name of the codec described by this descriptor. It is non-empty and
556 * unique for each codec descriptor. It should contain alphanumeric
557 * characters and '_' only.
561 * A more descriptive name for this codec. May be NULL.
563 const char *long_name;
565 * Codec properties, a combination of AV_CODEC_PROP_* flags.
570 * MIME type(s) associated with the codec.
571 * May be NULL; if not, a NULL-terminated array of MIME types.
572 * The first item is always non-NULL and is the preferred MIME type.
574 const char *const *mime_types;
578 * Codec uses only intra compression.
581 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
583 * Codec supports lossy compression. Audio and video codecs only.
584 * @note a codec may support both lossy and lossless
587 #define AV_CODEC_PROP_LOSSY (1 << 1)
589 * Codec supports lossless compression. Audio and video codecs only.
591 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
593 * Codec supports frame reordering. That is, the coded order (the order in which
594 * the encoded packets are output by the encoders / stored / input to the
595 * decoders) may be different from the presentation order of the corresponding
598 * For codecs that do not have this property set, PTS and DTS should always be
601 #define AV_CODEC_PROP_REORDER (1 << 3)
603 * Subtitle codec is bitmap based
604 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
606 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
608 * Subtitle codec is text based.
609 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
611 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
614 * @ingroup lavc_decoding
615 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
616 * This is mainly needed because some optimized bitstream readers read
617 * 32 or 64 bit at once and could read over the end.<br>
618 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
619 * MPEG bitstreams could cause overread and segfault.
621 #define AV_INPUT_BUFFER_PADDING_SIZE 32
624 * @ingroup lavc_encoding
625 * minimum encoding buffer size
626 * Used to avoid some checks during header writing.
628 #define AV_INPUT_BUFFER_MIN_SIZE 16384
630 #if FF_API_WITHOUT_PREFIX
632 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
634 #define FF_INPUT_BUFFER_PADDING_SIZE 32
637 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
639 #define FF_MIN_BUFFER_SIZE 16384
640 #endif /* FF_API_WITHOUT_PREFIX */
643 * @ingroup lavc_encoding
644 * motion estimation type.
645 * @deprecated use codec private option instead
647 #if FF_API_MOTION_EST
649 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
653 ME_EPZS, ///< enhanced predictive zonal search
654 ME_X1, ///< reserved for experiments
655 ME_HEX, ///< hexagon based search
656 ME_UMH, ///< uneven multi-hexagon search
657 ME_TESA, ///< transformed exhaustive search algorithm
658 ME_ITER=50, ///< iterative search
663 * @ingroup lavc_decoding
666 /* We leave some space between them for extensions (drop some
667 * keyframes for intra-only or drop just some bidir frames). */
668 AVDISCARD_NONE =-16, ///< discard nothing
669 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
670 AVDISCARD_NONREF = 8, ///< discard all non reference
671 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
672 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
673 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
674 AVDISCARD_ALL = 48, ///< discard all
677 enum AVAudioServiceType {
678 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
679 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
680 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
681 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
682 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
683 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
684 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
685 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
686 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
687 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
691 * @ingroup lavc_encoding
693 typedef struct RcOverride{
696 int qscale; // If this is 0 then quality_factor will be used instead.
697 float quality_factor;
700 #if FF_API_MAX_BFRAMES
702 * @deprecated there is no libavcodec-wide limit on the number of B-frames
704 #define FF_MAX_B_FRAMES 16
708 These flags can be passed in AVCodecContext.flags before initialization.
709 Note: Not everything is supported yet.
713 * Allow decoders to produce frames with data planes that are not aligned
714 * to CPU requirements (e.g. due to cropping).
716 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
720 #define AV_CODEC_FLAG_QSCALE (1 << 1)
722 * 4 MV per MB allowed / advanced prediction for H.263.
724 #define AV_CODEC_FLAG_4MV (1 << 2)
726 * Output even those frames that might be corrupted.
728 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
732 #define AV_CODEC_FLAG_QPEL (1 << 4)
734 * Use internal 2pass ratecontrol in first pass mode.
736 #define AV_CODEC_FLAG_PASS1 (1 << 9)
738 * Use internal 2pass ratecontrol in second pass mode.
740 #define AV_CODEC_FLAG_PASS2 (1 << 10)
744 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
746 * Only decode/encode grayscale.
748 #define AV_CODEC_FLAG_GRAY (1 << 13)
750 * error[?] variables will be set during encoding.
752 #define AV_CODEC_FLAG_PSNR (1 << 15)
754 * Input bitstream might be truncated at a random location
755 * instead of only at frame boundaries.
757 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
759 * Use interlaced DCT.
761 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
765 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
767 * Place global headers in extradata instead of every keyframe.
769 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
771 * Use only bitexact stuff (except (I)DCT).
773 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
774 /* Fx : Flag for h263+ extra options */
776 * H.263 advanced intra coding / MPEG-4 AC prediction
778 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
780 * interlaced motion estimation
782 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
784 * Allow non spec compliant speedup tricks.
786 #define AV_CODEC_FLAG_CLOSED_GOP (1U << 31)
788 #define AV_CODEC_FLAG2_FAST (1 << 0)
790 * Skip bitstream encoding.
792 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
794 * Place global headers at every keyframe instead of in extradata.
796 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
799 * timecode is in drop frame format. DEPRECATED!!!!
801 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
804 * Input bitstream might be truncated at a packet boundaries
805 * instead of only at frame boundaries.
807 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
809 * Discard cropping information from SPS.
811 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
814 * Show all frames before the first keyframe
816 #define AV_CODEC_FLAG2_SHOW_ALL (1 << 22)
818 * Export motion vectors through frame side data
820 #define AV_CODEC_FLAG2_EXPORT_MVS (1 << 28)
822 * Do not skip samples and export skip information as frame side data
824 #define AV_CODEC_FLAG2_SKIP_MANUAL (1 << 29)
826 /* Unsupported options :
827 * Syntax Arithmetic coding (SAC)
828 * Reference Picture Selection
829 * Independent Segment Decoding */
831 /* codec capabilities */
834 * Decoder can use draw_horiz_band callback.
836 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
838 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
839 * If not set, it might not use get_buffer() at all or use operations that
840 * assume the buffer was allocated by avcodec_default_get_buffer.
842 #define AV_CODEC_CAP_DR1 (1 << 1)
843 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
845 * Encoder or decoder requires flushing with NULL input at the end in order to
846 * give the complete and correct output.
848 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
849 * with NULL data. The user can still send NULL data to the public encode
850 * or decode function, but libavcodec will not pass it along to the codec
851 * unless this flag is set.
854 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
855 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
859 * The encoder needs to be fed with NULL data at the end of encoding until the
860 * encoder no longer returns data.
862 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
863 * flag also means that the encoder must set the pts and duration for
864 * each output packet. If this flag is not set, the pts and duration will
865 * be determined by libavcodec from the input frame.
867 #define AV_CODEC_CAP_DELAY (1 << 5)
869 * Codec can be fed a final frame with a smaller size.
870 * This can be used to prevent truncation of the last audio samples.
872 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
876 * Codec can export data for HW decoding (VDPAU).
878 #define AV_CODEC_CAP_HWACCEL_VDPAU (1 << 7)
882 * Codec can output multiple frames per AVPacket
883 * Normally demuxers return one frame at a time, demuxers which do not do
884 * are connected to a parser to split what they return into proper frames.
885 * This flag is reserved to the very rare category of codecs which have a
886 * bitstream that cannot be split into frames without timeconsuming
887 * operations like full decoding. Demuxers carring such bitstreams thus
888 * may return multiple frames in a packet. This has many disadvantages like
889 * prohibiting stream copy in many cases thus it should only be considered
892 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
894 * Codec is experimental and is thus avoided in favor of non experimental
897 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
899 * Codec should fill in channel configuration and samplerate instead of container
901 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
903 * Codec supports frame-level multithreading.
905 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
907 * Codec supports slice-based (or partition-based) multithreading.
909 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
911 * Codec supports changed parameters at any point.
913 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
915 * Codec supports avctx->thread_count == 0 (auto).
917 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
919 * Audio encoder supports receiving a different number of samples in each call.
921 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
923 * Codec is intra only.
925 #define AV_CODEC_CAP_INTRA_ONLY 0x40000000
929 #define AV_CODEC_CAP_LOSSLESS 0x80000000
932 #if FF_API_WITHOUT_PREFIX
934 * Allow decoders to produce frames with data planes that are not aligned
935 * to CPU requirements (e.g. due to cropping).
937 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
938 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
939 #define CODEC_FLAG_4MV AV_CODEC_FLAG_4MV
940 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
941 #define CODEC_FLAG_QPEL AV_CODEC_FLAG_QPEL
944 * @deprecated use the "gmc" private option of the libxvid encoder
946 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
950 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
953 #define CODEC_FLAG_MV0 0x0040
955 #if FF_API_INPUT_PRESERVED
957 * @deprecated passing reference-counted frames to the encoders replaces this
960 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
962 #define CODEC_FLAG_PASS1 AV_CODEC_FLAG_PASS1
963 #define CODEC_FLAG_PASS2 AV_CODEC_FLAG_PASS2
964 #define CODEC_FLAG_GRAY AV_CODEC_FLAG_GRAY
967 * @deprecated edges are not used/required anymore. I.e. this flag is now always
970 #define CODEC_FLAG_EMU_EDGE 0x4000
972 #define CODEC_FLAG_PSNR AV_CODEC_FLAG_PSNR
973 #define CODEC_FLAG_TRUNCATED AV_CODEC_FLAG_TRUNCATED
975 #if FF_API_NORMALIZE_AQP
977 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
980 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
982 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
983 #define CODEC_FLAG_LOW_DELAY AV_CODEC_FLAG_LOW_DELAY
984 #define CODEC_FLAG_GLOBAL_HEADER AV_CODEC_FLAG_GLOBAL_HEADER
985 #define CODEC_FLAG_BITEXACT AV_CODEC_FLAG_BITEXACT
986 #define CODEC_FLAG_AC_PRED AV_CODEC_FLAG_AC_PRED
987 #define CODEC_FLAG_LOOP_FILTER AV_CODEC_FLAG_LOOP_FILTER
988 #define CODEC_FLAG_INTERLACED_ME AV_CODEC_FLAG_INTERLACED_ME
989 #define CODEC_FLAG_CLOSED_GOP AV_CODEC_FLAG_CLOSED_GOP
990 #define CODEC_FLAG2_FAST AV_CODEC_FLAG2_FAST
991 #define CODEC_FLAG2_NO_OUTPUT AV_CODEC_FLAG2_NO_OUTPUT
992 #define CODEC_FLAG2_LOCAL_HEADER AV_CODEC_FLAG2_LOCAL_HEADER
993 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
994 #define CODEC_FLAG2_IGNORE_CROP AV_CODEC_FLAG2_IGNORE_CROP
996 #define CODEC_FLAG2_CHUNKS AV_CODEC_FLAG2_CHUNKS
997 #define CODEC_FLAG2_SHOW_ALL AV_CODEC_FLAG2_SHOW_ALL
998 #define CODEC_FLAG2_EXPORT_MVS AV_CODEC_FLAG2_EXPORT_MVS
999 #define CODEC_FLAG2_SKIP_MANUAL AV_CODEC_FLAG2_SKIP_MANUAL
1001 /* Unsupported options :
1002 * Syntax Arithmetic coding (SAC)
1003 * Reference Picture Selection
1004 * Independent Segment Decoding */
1006 /* codec capabilities */
1008 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1010 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1011 * If not set, it might not use get_buffer() at all or use operations that
1012 * assume the buffer was allocated by avcodec_default_get_buffer.
1014 #define CODEC_CAP_DR1 AV_CODEC_CAP_DR1
1015 #define CODEC_CAP_TRUNCATED AV_CODEC_CAP_TRUNCATED
1017 /* Codec can export data for HW decoding. This flag indicates that
1018 * the codec would call get_format() with list that might contain HW accelerated
1019 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1020 * including raw image format.
1021 * The application can use the passed context to determine bitstream version,
1022 * chroma format, resolution etc.
1024 #define CODEC_CAP_HWACCEL 0x0010
1025 #endif /* FF_API_XVMC */
1027 * Encoder or decoder requires flushing with NULL input at the end in order to
1028 * give the complete and correct output.
1030 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1031 * with NULL data. The user can still send NULL data to the public encode
1032 * or decode function, but libavcodec will not pass it along to the codec
1033 * unless this flag is set.
1036 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1037 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1041 * The encoder needs to be fed with NULL data at the end of encoding until the
1042 * encoder no longer returns data.
1044 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1045 * flag also means that the encoder must set the pts and duration for
1046 * each output packet. If this flag is not set, the pts and duration will
1047 * be determined by libavcodec from the input frame.
1049 #define CODEC_CAP_DELAY AV_CODEC_CAP_DELAY
1051 * Codec can be fed a final frame with a smaller size.
1052 * This can be used to prevent truncation of the last audio samples.
1054 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1055 #if FF_API_CAP_VDPAU
1057 * Codec can export data for HW decoding (VDPAU).
1059 #define CODEC_CAP_HWACCEL_VDPAU AV_CODEC_CAP_HWACCEL_VDPAU
1062 * Codec can output multiple frames per AVPacket
1063 * Normally demuxers return one frame at a time, demuxers which do not do
1064 * are connected to a parser to split what they return into proper frames.
1065 * This flag is reserved to the very rare category of codecs which have a
1066 * bitstream that cannot be split into frames without timeconsuming
1067 * operations like full decoding. Demuxers carring such bitstreams thus
1068 * may return multiple frames in a packet. This has many disadvantages like
1069 * prohibiting stream copy in many cases thus it should only be considered
1072 #define CODEC_CAP_SUBFRAMES AV_CODEC_CAP_SUBFRAMES
1074 * Codec is experimental and is thus avoided in favor of non experimental
1077 #define CODEC_CAP_EXPERIMENTAL AV_CODEC_CAP_EXPERIMENTAL
1079 * Codec should fill in channel configuration and samplerate instead of container
1081 #define CODEC_CAP_CHANNEL_CONF AV_CODEC_CAP_CHANNEL_CONF
1082 #if FF_API_NEG_LINESIZES
1084 * @deprecated no codecs use this capability
1086 #define CODEC_CAP_NEG_LINESIZES 0x0800
1089 * Codec supports frame-level multithreading.
1091 #define CODEC_CAP_FRAME_THREADS AV_CODEC_CAP_FRAME_THREADS
1093 * Codec supports slice-based (or partition-based) multithreading.
1095 #define CODEC_CAP_SLICE_THREADS AV_CODEC_CAP_SLICE_THREADS
1097 * Codec supports changed parameters at any point.
1099 #define CODEC_CAP_PARAM_CHANGE AV_CODEC_CAP_PARAM_CHANGE
1101 * Codec supports avctx->thread_count == 0 (auto).
1103 #define CODEC_CAP_AUTO_THREADS AV_CODEC_CAP_AUTO_THREADS
1105 * Audio encoder supports receiving a different number of samples in each call.
1107 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1109 * Codec is intra only.
1111 #define CODEC_CAP_INTRA_ONLY AV_CODEC_CAP_INTRA_ONLY
1113 * Codec is lossless.
1115 #define CODEC_CAP_LOSSLESS AV_CODEC_CAP_LOSSLESS
1118 * HWAccel is experimental and is thus avoided in favor of non experimental
1121 #define HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
1122 #endif /* FF_API_WITHOUT_PREFIX */
1125 //The following defines may change, don't expect compatibility if you use them.
1126 #define MB_TYPE_INTRA4x4 0x0001
1127 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1128 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
1129 #define MB_TYPE_16x16 0x0008
1130 #define MB_TYPE_16x8 0x0010
1131 #define MB_TYPE_8x16 0x0020
1132 #define MB_TYPE_8x8 0x0040
1133 #define MB_TYPE_INTERLACED 0x0080
1134 #define MB_TYPE_DIRECT2 0x0100 //FIXME
1135 #define MB_TYPE_ACPRED 0x0200
1136 #define MB_TYPE_GMC 0x0400
1137 #define MB_TYPE_SKIP 0x0800
1138 #define MB_TYPE_P0L0 0x1000
1139 #define MB_TYPE_P1L0 0x2000
1140 #define MB_TYPE_P0L1 0x4000
1141 #define MB_TYPE_P1L1 0x8000
1142 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1143 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1144 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1145 #define MB_TYPE_QUANT 0x00010000
1146 #define MB_TYPE_CBP 0x00020000
1147 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
1152 * This specifies the area which should be displayed.
1153 * Note there may be multiple such areas for one frame.
1155 typedef struct AVPanScan{
1158 * - encoding: Set by user.
1159 * - decoding: Set by libavcodec.
1164 * width and height in 1/16 pel
1165 * - encoding: Set by user.
1166 * - decoding: Set by libavcodec.
1172 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1173 * - encoding: Set by user.
1174 * - decoding: Set by libavcodec.
1176 int16_t position[3][2];
1179 #if FF_API_QSCALE_TYPE
1180 #define FF_QSCALE_TYPE_MPEG1 0
1181 #define FF_QSCALE_TYPE_MPEG2 1
1182 #define FF_QSCALE_TYPE_H264 2
1183 #define FF_QSCALE_TYPE_VP56 3
1187 * The decoder will keep a reference to the frame and may reuse it later.
1189 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1192 * @defgroup lavc_packet AVPacket
1194 * Types and functions for working with AVPacket.
1197 enum AVPacketSideDataType {
1198 AV_PKT_DATA_PALETTE,
1199 AV_PKT_DATA_NEW_EXTRADATA,
1202 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1205 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1206 * s32le channel_count
1207 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1208 * u64le channel_layout
1209 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1211 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1216 AV_PKT_DATA_PARAM_CHANGE,
1219 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1220 * structures with info about macroblocks relevant to splitting the
1221 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1222 * That is, it does not necessarily contain info about all macroblocks,
1223 * as long as the distance between macroblocks in the info is smaller
1224 * than the target payload size.
1225 * Each MB info structure is 12 bytes, and is laid out as follows:
1227 * u32le bit offset from the start of the packet
1228 * u8 current quantizer at the start of the macroblock
1230 * u16le macroblock address within the GOB
1231 * u8 horizontal MV predictor
1232 * u8 vertical MV predictor
1233 * u8 horizontal MV predictor for block number 3
1234 * u8 vertical MV predictor for block number 3
1237 AV_PKT_DATA_H263_MB_INFO,
1240 * This side data should be associated with an audio stream and contains
1241 * ReplayGain information in form of the AVReplayGain struct.
1243 AV_PKT_DATA_REPLAYGAIN,
1246 * This side data contains a 3x3 transformation matrix describing an affine
1247 * transformation that needs to be applied to the decoded video frames for
1248 * correct presentation.
1250 * See libavutil/display.h for a detailed description of the data.
1252 AV_PKT_DATA_DISPLAYMATRIX,
1255 * This side data should be associated with a video stream and contains
1256 * Stereoscopic 3D information in form of the AVStereo3D struct.
1258 AV_PKT_DATA_STEREO3D,
1261 * This side data should be associated with an audio stream and corresponds
1262 * to enum AVAudioServiceType.
1264 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1267 * This side data contains quality related information from the encoder.
1269 * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1273 * u64le[error count] sum of squared differences between encoder in and output
1276 AV_PKT_DATA_QUALITY_STATS,
1279 * Recommmends skipping the specified number of samples
1281 * u32le number of samples to skip from start of this packet
1282 * u32le number of samples to skip from end of this packet
1283 * u8 reason for start skip
1284 * u8 reason for end skip (0=padding silence, 1=convergence)
1287 AV_PKT_DATA_SKIP_SAMPLES=70,
1290 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1291 * the packet may contain "dual mono" audio specific to Japanese DTV
1292 * and if it is true, recommends only the selected channel to be used.
1294 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1297 AV_PKT_DATA_JP_DUALMONO,
1300 * A list of zero terminated key/value strings. There is no end marker for
1301 * the list, so it is required to rely on the side data size to stop.
1303 AV_PKT_DATA_STRINGS_METADATA,
1306 * Subtitle event position
1314 AV_PKT_DATA_SUBTITLE_POSITION,
1317 * Data found in BlockAdditional element of matroska container. There is
1318 * no end marker for the data, so it is required to rely on the side data
1319 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1322 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1325 * The optional first identifier line of a WebVTT cue.
1327 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1330 * The optional settings (rendering instructions) that immediately
1331 * follow the timestamp specifier of a WebVTT cue.
1333 AV_PKT_DATA_WEBVTT_SETTINGS,
1336 * A list of zero terminated key/value strings. There is no end marker for
1337 * the list, so it is required to rely on the side data size to stop. This
1338 * side data includes updated metadata which appeared in the stream.
1340 AV_PKT_DATA_METADATA_UPDATE,
1343 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1345 typedef struct AVPacketSideData {
1348 enum AVPacketSideDataType type;
1352 * This structure stores compressed data. It is typically exported by demuxers
1353 * and then passed as input to decoders, or received as output from encoders and
1354 * then passed to muxers.
1356 * For video, it should typically contain one compressed frame. For audio it may
1357 * contain several compressed frames. Encoders are allowed to output empty
1358 * packets, with no compressed data, containing only side data
1359 * (e.g. to update some stream parameters at the end of encoding).
1361 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1362 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1363 * without libavcodec and libavformat major bump.
1365 * The semantics of data ownership depends on the buf or destruct (deprecated)
1366 * fields. If either is set, the packet data is dynamically allocated and is
1367 * valid indefinitely until av_free_packet() is called (which in turn calls
1368 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1369 * the packet data is typically backed by some static buffer somewhere and is
1370 * only valid for a limited time (e.g. until the next read call when demuxing).
1372 * The side data is always allocated with av_malloc() and is freed in
1375 typedef struct AVPacket {
1377 * A reference to the reference-counted buffer where the packet data is
1379 * May be NULL, then the packet data is not reference-counted.
1383 * Presentation timestamp in AVStream->time_base units; the time at which
1384 * the decompressed packet will be presented to the user.
1385 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1386 * pts MUST be larger or equal to dts as presentation cannot happen before
1387 * decompression, unless one wants to view hex dumps. Some formats misuse
1388 * the terms dts and pts/cts to mean something different. Such timestamps
1389 * must be converted to true pts/dts before they are stored in AVPacket.
1393 * Decompression timestamp in AVStream->time_base units; the time at which
1394 * the packet is decompressed.
1395 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1402 * A combination of AV_PKT_FLAG values
1406 * Additional packet data that can be provided by the container.
1407 * Packet can contain several types of side information.
1409 AVPacketSideData *side_data;
1410 int side_data_elems;
1413 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1414 * Equals next_pts - this_pts in presentation order.
1418 int64_t pos; ///< byte position in stream, -1 if unknown
1420 #if FF_API_CONVERGENCE_DURATION
1422 * @deprecated Same as the duration field, but as int64_t. This was required
1423 * for Matroska subtitles, whose duration values could overflow when the
1424 * duration field was still an int.
1426 attribute_deprecated
1427 int64_t convergence_duration;
1430 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1431 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1433 enum AVSideDataParamChangeFlags {
1434 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1435 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1436 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1437 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1443 struct AVCodecInternal;
1447 AV_FIELD_PROGRESSIVE,
1448 AV_FIELD_TT, //< Top coded_first, top displayed first
1449 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1450 AV_FIELD_TB, //< Top coded first, bottom displayed first
1451 AV_FIELD_BT, //< Bottom coded first, top displayed first
1455 * main external API structure.
1456 * New fields can be added to the end with minor version bumps.
1457 * Removal, reordering and changes to existing fields require a major
1459 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1461 * sizeof(AVCodecContext) must not be used outside libav*.
1463 typedef struct AVCodecContext {
1465 * information on struct for av_log
1466 * - set by avcodec_alloc_context3
1468 const AVClass *av_class;
1469 int log_level_offset;
1471 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1472 const struct AVCodec *codec;
1473 #if FF_API_CODEC_NAME
1475 * @deprecated this field is not used for anything in libavcodec
1477 attribute_deprecated
1478 char codec_name[32];
1480 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1483 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1484 * This is used to work around some encoder bugs.
1485 * A demuxer should set this to what is stored in the field used to identify the codec.
1486 * If there are multiple such fields in a container then the demuxer should choose the one
1487 * which maximizes the information about the used codec.
1488 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1489 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1490 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1492 * - encoding: Set by user, if not then the default based on codec_id will be used.
1493 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1495 unsigned int codec_tag;
1497 #if FF_API_STREAM_CODEC_TAG
1499 * @deprecated this field is unused
1501 attribute_deprecated
1502 unsigned int stream_codec_tag;
1508 * Private context used for internal data.
1510 * Unlike priv_data, this is not codec-specific. It is used in general
1511 * libavcodec functions.
1513 struct AVCodecInternal *internal;
1516 * Private data of the user, can be used to carry app specific stuff.
1517 * - encoding: Set by user.
1518 * - decoding: Set by user.
1523 * the average bitrate
1524 * - encoding: Set by user; unused for constant quantizer encoding.
1525 * - decoding: Set by user, may be overwritten by libavcodec
1526 * if this info is available in the stream
1531 * number of bits the bitstream is allowed to diverge from the reference.
1532 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1533 * - encoding: Set by user; unused for constant quantizer encoding.
1534 * - decoding: unused
1536 int bit_rate_tolerance;
1539 * Global quality for codecs which cannot change it per frame.
1540 * This should be proportional to MPEG-1/2/4 qscale.
1541 * - encoding: Set by user.
1542 * - decoding: unused
1547 * - encoding: Set by user.
1548 * - decoding: unused
1550 int compression_level;
1551 #define FF_COMPRESSION_DEFAULT -1
1555 * - encoding: Set by user.
1556 * - decoding: Set by user.
1562 * - encoding: Set by user.
1563 * - decoding: Set by user.
1568 * some codecs need / can use extradata like Huffman tables.
1569 * mjpeg: Huffman tables
1570 * rv10: additional flags
1571 * mpeg4: global headers (they can be in the bitstream or here)
1572 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1573 * than extradata_size to avoid problems if it is read with the bitstream reader.
1574 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1575 * - encoding: Set/allocated/freed by libavcodec.
1576 * - decoding: Set/allocated/freed by user.
1582 * This is the fundamental unit of time (in seconds) in terms
1583 * of which frame timestamps are represented. For fixed-fps content,
1584 * timebase should be 1/framerate and timestamp increments should be
1586 * This often, but not always is the inverse of the frame rate or field rate
1588 * - encoding: MUST be set by user.
1589 * - decoding: the use of this field for decoding is deprecated.
1590 * Use framerate instead.
1592 AVRational time_base;
1595 * For some codecs, the time base is closer to the field rate than the frame rate.
1596 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1597 * if no telecine is used ...
1599 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1601 int ticks_per_frame;
1606 * Encoding: Number of frames delay there will be from the encoder input to
1607 * the decoder output. (we assume the decoder matches the spec)
1608 * Decoding: Number of frames delay in addition to what a standard decoder
1609 * as specified in the spec would produce.
1612 * Number of frames the decoded output will be delayed relative to the
1616 * For encoding, this field is unused (see initial_padding).
1618 * For decoding, this is the number of samples the decoder needs to
1619 * output before the decoder's output is valid. When seeking, you should
1620 * start decoding this many samples prior to your desired seek point.
1622 * - encoding: Set by libavcodec.
1623 * - decoding: Set by libavcodec.
1630 * picture width / height.
1632 * @note Those fields may not match the values of the last
1633 * AVFrame outputted by avcodec_decode_video2 due frame
1636 * - encoding: MUST be set by user.
1637 * - decoding: May be set by the user before opening the decoder if known e.g.
1638 * from the container. Some decoders will require the dimensions
1639 * to be set by the caller. During decoding, the decoder may
1640 * overwrite those values as required while parsing the data.
1645 * Bitstream width / height, may be different from width/height e.g. when
1646 * the decoded frame is cropped before being output or lowres is enabled.
1648 * @note Those field may not match the value of the last
1649 * AVFrame outputted by avcodec_decode_video2 due frame
1652 * - encoding: unused
1653 * - decoding: May be set by the user before opening the decoder if known
1654 * e.g. from the container. During decoding, the decoder may
1655 * overwrite those values as required while parsing the data.
1657 int coded_width, coded_height;
1659 #if FF_API_ASPECT_EXTENDED
1660 #define FF_ASPECT_EXTENDED 15
1664 * the number of pictures in a group of pictures, or 0 for intra_only
1665 * - encoding: Set by user.
1666 * - decoding: unused
1671 * Pixel format, see AV_PIX_FMT_xxx.
1672 * May be set by the demuxer if known from headers.
1673 * May be overridden by the decoder if it knows better.
1675 * @note This field may not match the value of the last
1676 * AVFrame outputted by avcodec_decode_video2 due frame
1679 * - encoding: Set by user.
1680 * - decoding: Set by user if known, overridden by libavcodec while
1683 enum AVPixelFormat pix_fmt;
1685 #if FF_API_MOTION_EST
1687 * This option does nothing
1688 * @deprecated use codec private options instead
1690 attribute_deprecated int me_method;
1694 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1695 * decoder to draw a horizontal band. It improves cache usage. Not
1696 * all codecs can do that. You must check the codec capabilities
1698 * When multithreading is used, it may be called from multiple threads
1699 * at the same time; threads might draw different parts of the same AVFrame,
1700 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1702 * The function is also used by hardware acceleration APIs.
1703 * It is called at least once during frame decoding to pass
1704 * the data needed for hardware render.
1705 * In that mode instead of pixel data, AVFrame points to
1706 * a structure specific to the acceleration API. The application
1707 * reads the structure and can change some fields to indicate progress
1709 * - encoding: unused
1710 * - decoding: Set by user.
1711 * @param height the height of the slice
1712 * @param y the y position of the slice
1713 * @param type 1->top field, 2->bottom field, 3->frame
1714 * @param offset offset into the AVFrame.data from which the slice should be read
1716 void (*draw_horiz_band)(struct AVCodecContext *s,
1717 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1718 int y, int type, int height);
1721 * callback to negotiate the pixelFormat
1722 * @param fmt is the list of formats which are supported by the codec,
1723 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1724 * The first is always the native one.
1725 * @note The callback may be called again immediately if initialization for
1726 * the selected (hardware-accelerated) pixel format failed.
1727 * @warning Behavior is undefined if the callback returns a value not
1728 * in the fmt list of formats.
1729 * @return the chosen format
1730 * - encoding: unused
1731 * - decoding: Set by user, if not set the native format will be chosen.
1733 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1736 * maximum number of B-frames between non-B-frames
1737 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1738 * - encoding: Set by user.
1739 * - decoding: unused
1744 * qscale factor between IP and B-frames
1745 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1746 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1747 * - encoding: Set by user.
1748 * - decoding: unused
1750 float b_quant_factor;
1752 #if FF_API_RC_STRATEGY
1753 /** @deprecated use codec private option instead */
1754 attribute_deprecated int rc_strategy;
1755 #define FF_RC_STRATEGY_XVID 1
1758 int b_frame_strategy;
1761 * qscale offset between IP and B-frames
1762 * - encoding: Set by user.
1763 * - decoding: unused
1765 float b_quant_offset;
1768 * Size of the frame reordering buffer in the decoder.
1769 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1770 * - encoding: Set by libavcodec.
1771 * - decoding: Set by libavcodec.
1776 * 0-> h263 quant 1-> mpeg quant
1777 * - encoding: Set by user.
1778 * - decoding: unused
1783 * qscale factor between P and I-frames
1784 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1785 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1786 * - encoding: Set by user.
1787 * - decoding: unused
1789 float i_quant_factor;
1792 * qscale offset between P and I-frames
1793 * - encoding: Set by user.
1794 * - decoding: unused
1796 float i_quant_offset;
1799 * luminance masking (0-> disabled)
1800 * - encoding: Set by user.
1801 * - decoding: unused
1806 * temporary complexity masking (0-> disabled)
1807 * - encoding: Set by user.
1808 * - decoding: unused
1810 float temporal_cplx_masking;
1813 * spatial complexity masking (0-> disabled)
1814 * - encoding: Set by user.
1815 * - decoding: unused
1817 float spatial_cplx_masking;
1820 * p block masking (0-> disabled)
1821 * - encoding: Set by user.
1822 * - decoding: unused
1827 * darkness masking (0-> disabled)
1828 * - encoding: Set by user.
1829 * - decoding: unused
1835 * - encoding: Set by libavcodec.
1836 * - decoding: Set by user (or 0).
1840 * prediction method (needed for huffyuv)
1841 * - encoding: Set by user.
1842 * - decoding: unused
1844 int prediction_method;
1845 #define FF_PRED_LEFT 0
1846 #define FF_PRED_PLANE 1
1847 #define FF_PRED_MEDIAN 2
1850 * slice offsets in the frame in bytes
1851 * - encoding: Set/allocated by libavcodec.
1852 * - decoding: Set/allocated by user (or NULL).
1857 * sample aspect ratio (0 if unknown)
1858 * That is the width of a pixel divided by the height of the pixel.
1859 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1860 * - encoding: Set by user.
1861 * - decoding: Set by libavcodec.
1863 AVRational sample_aspect_ratio;
1866 * motion estimation comparison function
1867 * - encoding: Set by user.
1868 * - decoding: unused
1872 * subpixel motion estimation comparison function
1873 * - encoding: Set by user.
1874 * - decoding: unused
1878 * macroblock comparison function (not supported yet)
1879 * - encoding: Set by user.
1880 * - decoding: unused
1884 * interlaced DCT comparison function
1885 * - encoding: Set by user.
1886 * - decoding: unused
1889 #define FF_CMP_SAD 0
1890 #define FF_CMP_SSE 1
1891 #define FF_CMP_SATD 2
1892 #define FF_CMP_DCT 3
1893 #define FF_CMP_PSNR 4
1894 #define FF_CMP_BIT 5
1896 #define FF_CMP_ZERO 7
1897 #define FF_CMP_VSAD 8
1898 #define FF_CMP_VSSE 9
1899 #define FF_CMP_NSSE 10
1900 #define FF_CMP_W53 11
1901 #define FF_CMP_W97 12
1902 #define FF_CMP_DCTMAX 13
1903 #define FF_CMP_DCT264 14
1904 #define FF_CMP_CHROMA 256
1907 * ME diamond size & shape
1908 * - encoding: Set by user.
1909 * - decoding: unused
1914 * amount of previous MV predictors (2a+1 x 2a+1 square)
1915 * - encoding: Set by user.
1916 * - decoding: unused
1918 int last_predictor_count;
1921 * prepass for motion estimation
1922 * - encoding: Set by user.
1923 * - decoding: unused
1928 * motion estimation prepass comparison function
1929 * - encoding: Set by user.
1930 * - decoding: unused
1935 * ME prepass diamond size & shape
1936 * - encoding: Set by user.
1937 * - decoding: unused
1943 * - encoding: Set by user.
1944 * - decoding: unused
1946 int me_subpel_quality;
1950 * DTG active format information (additional aspect ratio
1951 * information only used in DVB MPEG-2 transport streams)
1954 * - encoding: unused
1955 * - decoding: Set by decoder.
1956 * @deprecated Deprecated in favor of AVSideData
1958 attribute_deprecated int dtg_active_format;
1959 #define FF_DTG_AFD_SAME 8
1960 #define FF_DTG_AFD_4_3 9
1961 #define FF_DTG_AFD_16_9 10
1962 #define FF_DTG_AFD_14_9 11
1963 #define FF_DTG_AFD_4_3_SP_14_9 13
1964 #define FF_DTG_AFD_16_9_SP_14_9 14
1965 #define FF_DTG_AFD_SP_4_3 15
1966 #endif /* FF_API_AFD */
1969 * maximum motion estimation search range in subpel units
1970 * If 0 then no limit.
1972 * - encoding: Set by user.
1973 * - decoding: unused
1977 #if FF_API_QUANT_BIAS
1979 * @deprecated use encoder private option instead
1981 attribute_deprecated int intra_quant_bias;
1982 #define FF_DEFAULT_QUANT_BIAS 999999
1985 * @deprecated use encoder private option instead
1987 attribute_deprecated int inter_quant_bias;
1992 * - encoding: unused
1993 * - decoding: Set by user.
1996 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1997 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1998 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2002 * XVideo Motion Acceleration
2003 * - encoding: forbidden
2004 * - decoding: set by decoder
2005 * @deprecated XvMC doesn't need it anymore.
2007 attribute_deprecated int xvmc_acceleration;
2008 #endif /* FF_API_XVMC */
2011 * macroblock decision mode
2012 * - encoding: Set by user.
2013 * - decoding: unused
2016 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2017 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2018 #define FF_MB_DECISION_RD 2 ///< rate distortion
2021 * custom intra quantization matrix
2022 * - encoding: Set by user, can be NULL.
2023 * - decoding: Set by libavcodec.
2025 uint16_t *intra_matrix;
2028 * custom inter quantization matrix
2029 * - encoding: Set by user, can be NULL.
2030 * - decoding: Set by libavcodec.
2032 uint16_t *inter_matrix;
2035 * scene change detection threshold
2036 * 0 is default, larger means fewer detected scene changes.
2037 * - encoding: Set by user.
2038 * - decoding: unused
2040 int scenechange_threshold;
2043 * noise reduction strength
2044 * - encoding: Set by user.
2045 * - decoding: unused
2047 int noise_reduction;
2051 * @deprecated this field is unused
2053 attribute_deprecated
2057 * @deprecated this field is unused
2059 attribute_deprecated
2064 * precision of the intra DC coefficient - 8
2065 * - encoding: Set by user.
2066 * - decoding: Set by libavcodec
2068 int intra_dc_precision;
2071 * Number of macroblock rows at the top which are skipped.
2072 * - encoding: unused
2073 * - decoding: Set by user.
2078 * Number of macroblock rows at the bottom which are skipped.
2079 * - encoding: unused
2080 * - decoding: Set by user.
2086 * @deprecated use encoder private options instead
2088 attribute_deprecated
2089 float border_masking;
2093 * minimum MB lagrange multipler
2094 * - encoding: Set by user.
2095 * - decoding: unused
2100 * maximum MB lagrange multipler
2101 * - encoding: Set by user.
2102 * - decoding: unused
2108 * - encoding: Set by user.
2109 * - decoding: unused
2111 int me_penalty_compensation;
2115 * - encoding: Set by user.
2116 * - decoding: unused
2122 * - encoding: Set by user.
2123 * - decoding: unused
2129 * - encoding: Set by user.
2130 * - decoding: unused
2135 * number of reference frames
2136 * - encoding: Set by user.
2137 * - decoding: Set by lavc.
2142 * chroma qp offset from luma
2143 * - encoding: Set by user.
2144 * - decoding: unused
2148 #if FF_API_UNUSED_MEMBERS
2150 * Multiplied by qscale for each frame and added to scene_change_score.
2151 * - encoding: Set by user.
2152 * - decoding: unused
2154 attribute_deprecated int scenechange_factor;
2159 * Note: Value depends upon the compare function used for fullpel ME.
2160 * - encoding: Set by user.
2161 * - decoding: unused
2166 * Adjust sensitivity of b_frame_strategy 1.
2167 * - encoding: Set by user.
2168 * - decoding: unused
2173 * Chromaticity coordinates of the source primaries.
2174 * - encoding: Set by user
2175 * - decoding: Set by libavcodec
2177 enum AVColorPrimaries color_primaries;
2180 * Color Transfer Characteristic.
2181 * - encoding: Set by user
2182 * - decoding: Set by libavcodec
2184 enum AVColorTransferCharacteristic color_trc;
2187 * YUV colorspace type.
2188 * - encoding: Set by user
2189 * - decoding: Set by libavcodec
2191 enum AVColorSpace colorspace;
2194 * MPEG vs JPEG YUV range.
2195 * - encoding: Set by user
2196 * - decoding: Set by libavcodec
2198 enum AVColorRange color_range;
2201 * This defines the location of chroma samples.
2202 * - encoding: Set by user
2203 * - decoding: Set by libavcodec
2205 enum AVChromaLocation chroma_sample_location;
2209 * Indicates number of picture subdivisions. Used for parallelized
2211 * - encoding: Set by user
2212 * - decoding: unused
2217 * - encoding: set by libavcodec
2218 * - decoding: Set by user.
2220 enum AVFieldOrder field_order;
2223 int sample_rate; ///< samples per second
2224 int channels; ///< number of audio channels
2227 * audio sample format
2228 * - encoding: Set by user.
2229 * - decoding: Set by libavcodec.
2231 enum AVSampleFormat sample_fmt; ///< sample format
2233 /* The following data should not be initialized. */
2235 * Number of samples per channel in an audio frame.
2237 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2238 * except the last must contain exactly frame_size samples per channel.
2239 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2240 * frame size is not restricted.
2241 * - decoding: may be set by some decoders to indicate constant frame size
2246 * Frame counter, set by libavcodec.
2248 * - decoding: total number of frames returned from the decoder so far.
2249 * - encoding: total number of frames passed to the encoder so far.
2251 * @note the counter is not incremented if encoding/decoding resulted in
2257 * number of bytes per packet if constant and known or 0
2258 * Used by some WAV based audio codecs.
2263 * Audio cutoff bandwidth (0 means "automatic")
2264 * - encoding: Set by user.
2265 * - decoding: unused
2270 * Audio channel layout.
2271 * - encoding: set by user.
2272 * - decoding: set by user, may be overwritten by libavcodec.
2274 uint64_t channel_layout;
2277 * Request decoder to use this channel layout if it can (0 for default)
2278 * - encoding: unused
2279 * - decoding: Set by user.
2281 uint64_t request_channel_layout;
2284 * Type of service that the audio stream conveys.
2285 * - encoding: Set by user.
2286 * - decoding: Set by libavcodec.
2288 enum AVAudioServiceType audio_service_type;
2291 * desired sample format
2292 * - encoding: Not used.
2293 * - decoding: Set by user.
2294 * Decoder will decode to this format if it can.
2296 enum AVSampleFormat request_sample_fmt;
2299 * This callback is called at the beginning of each frame to get data
2300 * buffer(s) for it. There may be one contiguous buffer for all the data or
2301 * there may be a buffer per each data plane or anything in between. What
2302 * this means is, you may set however many entries in buf[] you feel necessary.
2303 * Each buffer must be reference-counted using the AVBuffer API (see description
2306 * The following fields will be set in the frame before this callback is
2309 * - width, height (video only)
2310 * - sample_rate, channel_layout, nb_samples (audio only)
2311 * Their values may differ from the corresponding values in
2312 * AVCodecContext. This callback must use the frame values, not the codec
2313 * context values, to calculate the required buffer size.
2315 * This callback must fill the following fields in the frame:
2319 * * if the data is planar audio with more than 8 channels, then this
2320 * callback must allocate and fill extended_data to contain all pointers
2321 * to all data planes. data[] must hold as many pointers as it can.
2322 * extended_data must be allocated with av_malloc() and will be freed in
2324 * * otherwise exended_data must point to data
2325 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2326 * the frame's data and extended_data pointers must be contained in these. That
2327 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2328 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2329 * and av_buffer_ref().
2330 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2331 * this callback and filled with the extra buffers if there are more
2332 * buffers than buf[] can hold. extended_buf will be freed in
2335 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2336 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2339 * Each data plane must be aligned to the maximum required by the target
2342 * @see avcodec_default_get_buffer2()
2346 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2347 * (read and/or written to if it is writable) later by libavcodec.
2349 * avcodec_align_dimensions2() should be used to find the required width and
2350 * height, as they normally need to be rounded up to the next multiple of 16.
2352 * Some decoders do not support linesizes changing between frames.
2354 * If frame multithreading is used and thread_safe_callbacks is set,
2355 * this callback may be called from a different thread, but not from more
2356 * than one at once. Does not need to be reentrant.
2358 * @see avcodec_align_dimensions2()
2362 * Decoders request a buffer of a particular size by setting
2363 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2364 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2365 * to a smaller value in the output frame.
2367 * As a convenience, av_samples_get_buffer_size() and
2368 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2369 * functions to find the required data size and to fill data pointers and
2370 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2371 * since all planes must be the same size.
2373 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2375 * - encoding: unused
2376 * - decoding: Set by libavcodec, user can override.
2378 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2381 * If non-zero, the decoded audio and video frames returned from
2382 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2383 * and are valid indefinitely. The caller must free them with
2384 * av_frame_unref() when they are not needed anymore.
2385 * Otherwise, the decoded frames must not be freed by the caller and are
2386 * only valid until the next decode call.
2388 * - encoding: unused
2389 * - decoding: set by the caller before avcodec_open2().
2391 int refcounted_frames;
2393 /* - encoding parameters */
2394 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2395 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2399 * - encoding: Set by user.
2400 * - decoding: unused
2406 * - encoding: Set by user.
2407 * - decoding: unused
2412 * maximum quantizer difference between frames
2413 * - encoding: Set by user.
2414 * - decoding: unused
2420 * @deprecated use encoder private options instead
2422 attribute_deprecated
2425 attribute_deprecated
2427 attribute_deprecated
2432 * decoder bitstream buffer size
2433 * - encoding: Set by user.
2434 * - decoding: unused
2439 * ratecontrol override, see RcOverride
2440 * - encoding: Allocated/set/freed by user.
2441 * - decoding: unused
2443 int rc_override_count;
2444 RcOverride *rc_override;
2448 * @deprecated use encoder private options instead
2450 attribute_deprecated
2456 * - encoding: Set by user.
2457 * - decoding: Set by user, may be overwritten by libavcodec.
2459 int64_t rc_max_rate;
2463 * - encoding: Set by user.
2464 * - decoding: unused
2466 int64_t rc_min_rate;
2470 * @deprecated use encoder private options instead
2472 attribute_deprecated
2473 float rc_buffer_aggressivity;
2475 attribute_deprecated
2476 float rc_initial_cplx;
2480 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2481 * - encoding: Set by user.
2482 * - decoding: unused.
2484 float rc_max_available_vbv_use;
2487 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2488 * - encoding: Set by user.
2489 * - decoding: unused.
2491 float rc_min_vbv_overflow_use;
2494 * Number of bits which should be loaded into the rc buffer before decoding starts.
2495 * - encoding: Set by user.
2496 * - decoding: unused
2498 int rc_initial_buffer_occupancy;
2500 #define FF_CODER_TYPE_VLC 0
2501 #define FF_CODER_TYPE_AC 1
2502 #define FF_CODER_TYPE_RAW 2
2503 #define FF_CODER_TYPE_RLE 3
2504 #if FF_API_UNUSED_MEMBERS
2505 #define FF_CODER_TYPE_DEFLATE 4
2506 #endif /* FF_API_UNUSED_MEMBERS */
2509 * - encoding: Set by user.
2510 * - decoding: unused
2516 * - encoding: Set by user.
2517 * - decoding: unused
2523 * @deprecated use encoder private options instead
2525 attribute_deprecated
2529 * @deprecated use encoder private options instead
2531 attribute_deprecated
2536 * frame skip threshold
2537 * - encoding: Set by user.
2538 * - decoding: unused
2540 int frame_skip_threshold;
2544 * - encoding: Set by user.
2545 * - decoding: unused
2547 int frame_skip_factor;
2550 * frame skip exponent
2551 * - encoding: Set by user.
2552 * - decoding: unused
2557 * frame skip comparison function
2558 * - encoding: Set by user.
2559 * - decoding: unused
2564 * trellis RD quantization
2565 * - encoding: Set by user.
2566 * - decoding: unused
2571 * - encoding: Set by user.
2572 * - decoding: unused
2574 int min_prediction_order;
2577 * - encoding: Set by user.
2578 * - decoding: unused
2580 int max_prediction_order;
2583 * GOP timecode frame start number
2584 * - encoding: Set by user, in non drop frame format
2585 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2587 int64_t timecode_frame_start;
2589 /* The RTP callback: This function is called */
2590 /* every time the encoder has a packet to send. */
2591 /* It depends on the encoder if the data starts */
2592 /* with a Start Code (it should). H.263 does. */
2593 /* mb_nb contains the number of macroblocks */
2594 /* encoded in the RTP payload. */
2595 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2597 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2598 /* do its best to deliver a chunk with size */
2599 /* below rtp_payload_size, the chunk will start */
2600 /* with a start code on some codecs like H.263. */
2601 /* This doesn't take account of any particular */
2602 /* headers inside the transmitted RTP payload. */
2604 /* statistics, used for 2-pass encoding */
2615 * number of bits used for the previously encoded frame
2616 * - encoding: Set by libavcodec.
2617 * - decoding: unused
2622 * pass1 encoding statistics output buffer
2623 * - encoding: Set by libavcodec.
2624 * - decoding: unused
2629 * pass2 encoding statistics input buffer
2630 * Concatenated stuff from stats_out of pass1 should be placed here.
2631 * - encoding: Allocated/set/freed by user.
2632 * - decoding: unused
2637 * Work around bugs in encoders which sometimes cannot be detected automatically.
2638 * - encoding: Set by user
2639 * - decoding: Set by user
2641 int workaround_bugs;
2642 #define FF_BUG_AUTODETECT 1 ///< autodetection
2643 #if FF_API_OLD_MSMPEG4
2644 #define FF_BUG_OLD_MSMPEG4 2
2646 #define FF_BUG_XVID_ILACE 4
2647 #define FF_BUG_UMP4 8
2648 #define FF_BUG_NO_PADDING 16
2649 #define FF_BUG_AMV 32
2651 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2653 #define FF_BUG_QPEL_CHROMA 64
2654 #define FF_BUG_STD_QPEL 128
2655 #define FF_BUG_QPEL_CHROMA2 256
2656 #define FF_BUG_DIRECT_BLOCKSIZE 512
2657 #define FF_BUG_EDGE 1024
2658 #define FF_BUG_HPEL_CHROMA 2048
2659 #define FF_BUG_DC_CLIP 4096
2660 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2661 #define FF_BUG_TRUNCATED 16384
2664 * strictly follow the standard (MPEG4, ...).
2665 * - encoding: Set by user.
2666 * - decoding: Set by user.
2667 * Setting this to STRICT or higher means the encoder and decoder will
2668 * generally do stupid things, whereas setting it to unofficial or lower
2669 * will mean the encoder might produce output that is not supported by all
2670 * spec-compliant decoders. Decoders don't differentiate between normal,
2671 * unofficial and experimental (that is, they always try to decode things
2672 * when they can) unless they are explicitly asked to behave stupidly
2673 * (=strictly conform to the specs)
2675 int strict_std_compliance;
2676 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2677 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2678 #define FF_COMPLIANCE_NORMAL 0
2679 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2680 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2683 * error concealment flags
2684 * - encoding: unused
2685 * - decoding: Set by user.
2687 int error_concealment;
2688 #define FF_EC_GUESS_MVS 1
2689 #define FF_EC_DEBLOCK 2
2690 #define FF_EC_FAVOR_INTER 256
2694 * - encoding: Set by user.
2695 * - decoding: Set by user.
2698 #define FF_DEBUG_PICT_INFO 1
2699 #define FF_DEBUG_RC 2
2700 #define FF_DEBUG_BITSTREAM 4
2701 #define FF_DEBUG_MB_TYPE 8
2702 #define FF_DEBUG_QP 16
2705 * @deprecated this option does nothing
2707 #define FF_DEBUG_MV 32
2709 #define FF_DEBUG_DCT_COEFF 0x00000040
2710 #define FF_DEBUG_SKIP 0x00000080
2711 #define FF_DEBUG_STARTCODE 0x00000100
2712 #if FF_API_UNUSED_MEMBERS
2713 #define FF_DEBUG_PTS 0x00000200
2714 #endif /* FF_API_UNUSED_MEMBERS */
2715 #define FF_DEBUG_ER 0x00000400
2716 #define FF_DEBUG_MMCO 0x00000800
2717 #define FF_DEBUG_BUGS 0x00001000
2719 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2720 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2722 #define FF_DEBUG_BUFFERS 0x00008000
2723 #define FF_DEBUG_THREADS 0x00010000
2724 #define FF_DEBUG_GREEN_MD 0x00800000
2725 #define FF_DEBUG_NOMC 0x01000000
2730 * Code outside libavcodec should access this field using AVOptions
2731 * - encoding: Set by user.
2732 * - decoding: Set by user.
2735 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2736 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2737 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2741 * Error recognition; may misdetect some more or less valid parts as errors.
2742 * - encoding: unused
2743 * - decoding: Set by user.
2745 int err_recognition;
2748 * Verify checksums embedded in the bitstream (could be of either encoded or
2749 * decoded data, depending on the codec) and print an error message on mismatch.
2750 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2751 * decoder returning an error.
2753 #define AV_EF_CRCCHECK (1<<0)
2754 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2755 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2756 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2758 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2759 #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
2760 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2761 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2765 * opaque 64bit number (generally a PTS) that will be reordered and
2766 * output in AVFrame.reordered_opaque
2767 * - encoding: unused
2768 * - decoding: Set by user.
2770 int64_t reordered_opaque;
2773 * Hardware accelerator in use
2774 * - encoding: unused.
2775 * - decoding: Set by libavcodec
2777 struct AVHWAccel *hwaccel;
2780 * Hardware accelerator context.
2781 * For some hardware accelerators, a global context needs to be
2782 * provided by the user. In that case, this holds display-dependent
2783 * data FFmpeg cannot instantiate itself. Please refer to the
2784 * FFmpeg HW accelerator documentation to know how to fill this
2785 * is. e.g. for VA API, this is a struct vaapi_context.
2786 * - encoding: unused
2787 * - decoding: Set by user
2789 void *hwaccel_context;
2793 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2794 * - decoding: unused
2796 uint64_t error[AV_NUM_DATA_POINTERS];
2799 * DCT algorithm, see FF_DCT_* below
2800 * - encoding: Set by user.
2801 * - decoding: unused
2804 #define FF_DCT_AUTO 0
2805 #define FF_DCT_FASTINT 1
2806 #define FF_DCT_INT 2
2807 #define FF_DCT_MMX 3
2808 #define FF_DCT_ALTIVEC 5
2809 #define FF_DCT_FAAN 6
2812 * IDCT algorithm, see FF_IDCT_* below.
2813 * - encoding: Set by user.
2814 * - decoding: Set by user.
2817 #define FF_IDCT_AUTO 0
2818 #define FF_IDCT_INT 1
2819 #define FF_IDCT_SIMPLE 2
2820 #define FF_IDCT_SIMPLEMMX 3
2821 #define FF_IDCT_ARM 7
2822 #define FF_IDCT_ALTIVEC 8
2824 #define FF_IDCT_SH4 9
2826 #define FF_IDCT_SIMPLEARM 10
2827 #if FF_API_UNUSED_MEMBERS
2828 #define FF_IDCT_IPP 13
2829 #endif /* FF_API_UNUSED_MEMBERS */
2830 #define FF_IDCT_XVID 14
2831 #if FF_API_IDCT_XVIDMMX
2832 #define FF_IDCT_XVIDMMX 14
2833 #endif /* FF_API_IDCT_XVIDMMX */
2834 #define FF_IDCT_SIMPLEARMV5TE 16
2835 #define FF_IDCT_SIMPLEARMV6 17
2836 #if FF_API_ARCH_SPARC
2837 #define FF_IDCT_SIMPLEVIS 18
2839 #define FF_IDCT_FAAN 20
2840 #define FF_IDCT_SIMPLENEON 22
2841 #if FF_API_ARCH_ALPHA
2842 #define FF_IDCT_SIMPLEALPHA 23
2844 #define FF_IDCT_SIMPLEAUTO 128
2847 * bits per sample/pixel from the demuxer (needed for huffyuv).
2848 * - encoding: Set by libavcodec.
2849 * - decoding: Set by user.
2851 int bits_per_coded_sample;
2854 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2855 * - encoding: set by user.
2856 * - decoding: set by libavcodec.
2858 int bits_per_raw_sample;
2862 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2863 * - encoding: unused
2864 * - decoding: Set by user.
2865 * Code outside libavcodec should access this field using:
2866 * av_codec_{get,set}_lowres(avctx)
2871 #if FF_API_CODED_FRAME
2873 * the picture in the bitstream
2874 * - encoding: Set by libavcodec.
2875 * - decoding: unused
2877 * @deprecated use the quality factor packet side data instead
2879 attribute_deprecated AVFrame *coded_frame;
2884 * is used to decide how many independent tasks should be passed to execute()
2885 * - encoding: Set by user.
2886 * - decoding: Set by user.
2891 * Which multithreading methods to use.
2892 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2893 * so clients which cannot provide future frames should not use it.
2895 * - encoding: Set by user, otherwise the default is used.
2896 * - decoding: Set by user, otherwise the default is used.
2899 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2900 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2903 * Which multithreading methods are in use by the codec.
2904 * - encoding: Set by libavcodec.
2905 * - decoding: Set by libavcodec.
2907 int active_thread_type;
2910 * Set by the client if its custom get_buffer() callback can be called
2911 * synchronously from another thread, which allows faster multithreaded decoding.
2912 * draw_horiz_band() will be called from other threads regardless of this setting.
2913 * Ignored if the default get_buffer() is used.
2914 * - encoding: Set by user.
2915 * - decoding: Set by user.
2917 int thread_safe_callbacks;
2920 * The codec may call this to execute several independent things.
2921 * It will return only after finishing all tasks.
2922 * The user may replace this with some multithreaded implementation,
2923 * the default implementation will execute the parts serially.
2924 * @param count the number of things to execute
2925 * - encoding: Set by libavcodec, user can override.
2926 * - decoding: Set by libavcodec, user can override.
2928 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2931 * The codec may call this to execute several independent things.
2932 * It will return only after finishing all tasks.
2933 * The user may replace this with some multithreaded implementation,
2934 * the default implementation will execute the parts serially.
2935 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2936 * @param c context passed also to func
2937 * @param count the number of things to execute
2938 * @param arg2 argument passed unchanged to func
2939 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2940 * @param func function that will be called count times, with jobnr from 0 to count-1.
2941 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2942 * two instances of func executing at the same time will have the same threadnr.
2943 * @return always 0 currently, but code should handle a future improvement where when any call to func
2944 * returns < 0 no further calls to func may be done and < 0 is returned.
2945 * - encoding: Set by libavcodec, user can override.
2946 * - decoding: Set by libavcodec, user can override.
2948 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2951 * noise vs. sse weight for the nsse comparison function
2952 * - encoding: Set by user.
2953 * - decoding: unused
2959 * - encoding: Set by user.
2960 * - decoding: Set by libavcodec.
2963 #define FF_PROFILE_UNKNOWN -99
2964 #define FF_PROFILE_RESERVED -100
2966 #define FF_PROFILE_AAC_MAIN 0
2967 #define FF_PROFILE_AAC_LOW 1
2968 #define FF_PROFILE_AAC_SSR 2
2969 #define FF_PROFILE_AAC_LTP 3
2970 #define FF_PROFILE_AAC_HE 4
2971 #define FF_PROFILE_AAC_HE_V2 28
2972 #define FF_PROFILE_AAC_LD 22
2973 #define FF_PROFILE_AAC_ELD 38
2974 #define FF_PROFILE_MPEG2_AAC_LOW 128
2975 #define FF_PROFILE_MPEG2_AAC_HE 131
2977 #define FF_PROFILE_DTS 20
2978 #define FF_PROFILE_DTS_ES 30
2979 #define FF_PROFILE_DTS_96_24 40
2980 #define FF_PROFILE_DTS_HD_HRA 50
2981 #define FF_PROFILE_DTS_HD_MA 60
2982 #define FF_PROFILE_DTS_EXPRESS 70
2984 #define FF_PROFILE_MPEG2_422 0
2985 #define FF_PROFILE_MPEG2_HIGH 1
2986 #define FF_PROFILE_MPEG2_SS 2
2987 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2988 #define FF_PROFILE_MPEG2_MAIN 4
2989 #define FF_PROFILE_MPEG2_SIMPLE 5
2991 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2992 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2994 #define FF_PROFILE_H264_BASELINE 66
2995 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2996 #define FF_PROFILE_H264_MAIN 77
2997 #define FF_PROFILE_H264_EXTENDED 88
2998 #define FF_PROFILE_H264_HIGH 100
2999 #define FF_PROFILE_H264_HIGH_10 110
3000 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3001 #define FF_PROFILE_H264_HIGH_422 122
3002 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3003 #define FF_PROFILE_H264_HIGH_444 144
3004 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3005 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3006 #define FF_PROFILE_H264_CAVLC_444 44
3008 #define FF_PROFILE_VC1_SIMPLE 0
3009 #define FF_PROFILE_VC1_MAIN 1
3010 #define FF_PROFILE_VC1_COMPLEX 2
3011 #define FF_PROFILE_VC1_ADVANCED 3
3013 #define FF_PROFILE_MPEG4_SIMPLE 0
3014 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3015 #define FF_PROFILE_MPEG4_CORE 2
3016 #define FF_PROFILE_MPEG4_MAIN 3
3017 #define FF_PROFILE_MPEG4_N_BIT 4
3018 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3019 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3020 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3021 #define FF_PROFILE_MPEG4_HYBRID 8
3022 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3023 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3024 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3025 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3026 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3027 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3028 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3030 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
3031 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
3032 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
3033 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
3034 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
3036 #define FF_PROFILE_VP9_0 0
3037 #define FF_PROFILE_VP9_1 1
3038 #define FF_PROFILE_VP9_2 2
3039 #define FF_PROFILE_VP9_3 3
3041 #define FF_PROFILE_HEVC_MAIN 1
3042 #define FF_PROFILE_HEVC_MAIN_10 2
3043 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
3044 #define FF_PROFILE_HEVC_REXT 4
3048 * - encoding: Set by user.
3049 * - decoding: Set by libavcodec.
3052 #define FF_LEVEL_UNKNOWN -99
3055 * Skip loop filtering for selected frames.
3056 * - encoding: unused
3057 * - decoding: Set by user.
3059 enum AVDiscard skip_loop_filter;
3062 * Skip IDCT/dequantization for selected frames.
3063 * - encoding: unused
3064 * - decoding: Set by user.
3066 enum AVDiscard skip_idct;
3069 * Skip decoding for selected frames.
3070 * - encoding: unused
3071 * - decoding: Set by user.
3073 enum AVDiscard skip_frame;
3076 * Header containing style information for text subtitles.
3077 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3078 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3079 * the Format line following. It shouldn't include any Dialogue line.
3080 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3081 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3083 uint8_t *subtitle_header;
3084 int subtitle_header_size;
3086 #if FF_API_ERROR_RATE
3088 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3091 attribute_deprecated
3096 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3097 * Used for compliant TS muxing.
3098 * - encoding: Set by libavcodec.
3099 * - decoding: unused.
3103 #if FF_API_SIDEDATA_ONLY_PKT
3105 * Encoding only and set by default. Allow encoders to output packets
3106 * that do not contain any encoded data, only side data.
3108 * Some encoders need to output such packets, e.g. to update some stream
3109 * parameters at the end of encoding.
3111 * @deprecated this field disables the default behaviour and
3112 * it is kept only for compatibility.
3114 attribute_deprecated
3115 int side_data_only_packets;
3119 * Audio only. The number of "priming" samples (padding) inserted by the
3120 * encoder at the beginning of the audio. I.e. this number of leading
3121 * decoded samples must be discarded by the caller to get the original audio
3122 * without leading padding.
3124 * - decoding: unused
3125 * - encoding: Set by libavcodec. The timestamps on the output packets are
3126 * adjusted by the encoder so that they always refer to the
3127 * first sample of the data actually contained in the packet,
3128 * including any added padding. E.g. if the timebase is
3129 * 1/samplerate and the timestamp of the first input sample is
3130 * 0, the timestamp of the first output packet will be
3133 int initial_padding;
3136 * - decoding: For codecs that store a framerate value in the compressed
3137 * bitstream, the decoder may export it here. { 0, 1} when
3139 * - encoding: unused
3141 AVRational framerate;
3144 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3145 * - encoding: unused.
3146 * - decoding: Set by libavcodec before calling get_format()
3148 enum AVPixelFormat sw_pix_fmt;
3151 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3152 * Code outside libavcodec should access this field using:
3153 * av_codec_{get,set}_pkt_timebase(avctx)
3154 * - encoding unused.
3155 * - decoding set by user.
3157 AVRational pkt_timebase;
3161 * Code outside libavcodec should access this field using:
3162 * av_codec_{get,set}_codec_descriptor(avctx)
3163 * - encoding: unused.
3164 * - decoding: set by libavcodec.
3166 const AVCodecDescriptor *codec_descriptor;
3170 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3171 * - encoding: unused
3172 * - decoding: Set by user.
3173 * Code outside libavcodec should access this field using:
3174 * av_codec_{get,set}_lowres(avctx)
3180 * Current statistics for PTS correction.
3181 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3182 * - encoding: unused
3184 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3185 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3186 int64_t pts_correction_last_pts; /// PTS of the last frame
3187 int64_t pts_correction_last_dts; /// DTS of the last frame
3190 * Character encoding of the input subtitles file.
3191 * - decoding: set by user
3192 * - encoding: unused
3197 * Subtitles character encoding mode. Formats or codecs might be adjusting
3198 * this setting (if they are doing the conversion themselves for instance).
3199 * - decoding: set by libavcodec
3200 * - encoding: unused
3202 int sub_charenc_mode;
3203 #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)
3204 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3205 #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
3208 * Skip processing alpha if supported by codec.
3209 * Note that if the format uses pre-multiplied alpha (common with VP6,
3210 * and recommended due to better video quality/compression)
3211 * the image will look as if alpha-blended onto a black background.
3212 * However for formats that do not use pre-multiplied alpha
3213 * there might be serious artefacts (though e.g. libswscale currently
3214 * assumes pre-multiplied alpha anyway).
3215 * Code outside libavcodec should access this field using AVOptions
3217 * - decoding: set by user
3218 * - encoding: unused
3223 * Number of samples to skip after a discontinuity
3224 * - decoding: unused
3225 * - encoding: set by libavcodec
3229 #if !FF_API_DEBUG_MV
3231 * debug motion vectors
3232 * Code outside libavcodec should access this field using AVOptions
3233 * - encoding: Set by user.
3234 * - decoding: Set by user.
3237 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3238 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3239 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3243 * custom intra quantization matrix
3244 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3245 * - encoding: Set by user, can be NULL.
3246 * - decoding: unused.
3248 uint16_t *chroma_intra_matrix;
3251 * dump format separator.
3252 * can be ", " or "\n " or anything else
3253 * Code outside libavcodec should access this field using AVOptions
3254 * (NO direct access).
3255 * - encoding: Set by user.
3256 * - decoding: Set by user.
3258 uint8_t *dump_separator;
3261 * ',' separated list of allowed decoders.
3262 * If NULL then all are allowed
3263 * - encoding: unused
3264 * - decoding: set by user through AVOPtions (NO direct access)
3266 char *codec_whitelist;
3269 * Properties of the stream that gets decoded
3270 * To be accessed through av_codec_get_properties() (NO direct access)
3271 * - encoding: unused
3272 * - decoding: set by libavcodec
3274 unsigned properties;
3275 #define FF_CODEC_PROPERTY_LOSSLESS 0x00000001
3276 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3279 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3280 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3282 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3283 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3285 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3287 int av_codec_get_lowres(const AVCodecContext *avctx);
3288 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3290 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3291 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3293 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3294 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3299 typedef struct AVProfile {
3301 const char *name; ///< short name for the profile
3304 typedef struct AVCodecDefault AVCodecDefault;
3311 typedef struct AVCodec {
3313 * Name of the codec implementation.
3314 * The name is globally unique among encoders and among decoders (but an
3315 * encoder and a decoder can share the same name).
3316 * This is the primary way to find a codec from the user perspective.
3320 * Descriptive name for the codec, meant to be more human readable than name.
3321 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3323 const char *long_name;
3324 enum AVMediaType type;
3327 * Codec capabilities.
3328 * see AV_CODEC_CAP_*
3331 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3332 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3333 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3334 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3335 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3336 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3337 const AVClass *priv_class; ///< AVClass for the private context
3338 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3340 /*****************************************************************
3341 * No fields below this line are part of the public API. They
3342 * may not be used outside of libavcodec and can be changed and
3344 * New public fields should be added right above.
3345 *****************************************************************
3348 struct AVCodec *next;
3350 * @name Frame-level threading support functions
3354 * If defined, called on thread contexts when they are created.
3355 * If the codec allocates writable tables in init(), re-allocate them here.
3356 * priv_data will be set to a copy of the original.
3358 int (*init_thread_copy)(AVCodecContext *);
3360 * Copy necessary context variables from a previous thread context to the current one.
3361 * If not defined, the next thread will start automatically; otherwise, the codec
3362 * must call ff_thread_finish_setup().
3364 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3366 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3370 * Private codec-specific defaults.
3372 const AVCodecDefault *defaults;
3375 * Initialize codec static data, called from avcodec_register().
3377 void (*init_static_data)(struct AVCodec *codec);
3379 int (*init)(AVCodecContext *);
3380 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3381 const struct AVSubtitle *sub);
3383 * Encode data to an AVPacket.
3385 * @param avctx codec context
3386 * @param avpkt output AVPacket (may contain a user-provided buffer)
3387 * @param[in] frame AVFrame containing the raw data to be encoded
3388 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3389 * non-empty packet was returned in avpkt.
3390 * @return 0 on success, negative error code on failure
3392 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3393 int *got_packet_ptr);
3394 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3395 int (*close)(AVCodecContext *);
3398 * Will be called when seeking
3400 void (*flush)(AVCodecContext *);
3402 * Internal codec capabilities.
3403 * See FF_CODEC_CAP_* in internal.h
3408 int av_codec_get_max_lowres(const AVCodec *codec);
3410 struct MpegEncContext;
3413 * @defgroup lavc_hwaccel AVHWAccel
3416 typedef struct AVHWAccel {
3418 * Name of the hardware accelerated codec.
3419 * The name is globally unique among encoders and among decoders (but an
3420 * encoder and a decoder can share the same name).
3425 * Type of codec implemented by the hardware accelerator.
3427 * See AVMEDIA_TYPE_xxx
3429 enum AVMediaType type;
3432 * Codec implemented by the hardware accelerator.
3434 * See AV_CODEC_ID_xxx
3439 * Supported pixel format.
3441 * Only hardware accelerated formats are supported here.
3443 enum AVPixelFormat pix_fmt;
3446 * Hardware accelerated codec capabilities.
3447 * see HWACCEL_CODEC_CAP_*
3451 /*****************************************************************
3452 * No fields below this line are part of the public API. They
3453 * may not be used outside of libavcodec and can be changed and
3455 * New public fields should be added right above.
3456 *****************************************************************
3458 struct AVHWAccel *next;
3461 * Allocate a custom buffer
3463 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3466 * Called at the beginning of each frame or field picture.
3468 * Meaningful frame information (codec specific) is guaranteed to
3469 * be parsed at this point. This function is mandatory.
3471 * Note that buf can be NULL along with buf_size set to 0.
3472 * Otherwise, this means the whole frame is available at this point.
3474 * @param avctx the codec context
3475 * @param buf the frame data buffer base
3476 * @param buf_size the size of the frame in bytes
3477 * @return zero if successful, a negative value otherwise
3479 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3482 * Callback for each slice.
3484 * Meaningful slice information (codec specific) is guaranteed to
3485 * be parsed at this point. This function is mandatory.
3486 * The only exception is XvMC, that works on MB level.
3488 * @param avctx the codec context
3489 * @param buf the slice data buffer base
3490 * @param buf_size the size of the slice in bytes
3491 * @return zero if successful, a negative value otherwise
3493 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3496 * Called at the end of each frame or field picture.
3498 * The whole picture is parsed at this point and can now be sent
3499 * to the hardware accelerator. This function is mandatory.
3501 * @param avctx the codec context
3502 * @return zero if successful, a negative value otherwise
3504 int (*end_frame)(AVCodecContext *avctx);
3507 * Size of per-frame hardware accelerator private data.
3509 * Private data is allocated with av_mallocz() before
3510 * AVCodecContext.get_buffer() and deallocated after
3511 * AVCodecContext.release_buffer().
3513 int frame_priv_data_size;
3516 * Called for every Macroblock in a slice.
3518 * XvMC uses it to replace the ff_mpv_decode_mb().
3519 * Instead of decoding to raw picture, MB parameters are
3520 * stored in an array provided by the video driver.
3522 * @param s the mpeg context
3524 void (*decode_mb)(struct MpegEncContext *s);
3527 * Initialize the hwaccel private data.
3529 * This will be called from ff_get_format(), after hwaccel and
3530 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3533 int (*init)(AVCodecContext *avctx);
3536 * Uninitialize the hwaccel private data.
3538 * This will be called from get_format() or avcodec_close(), after hwaccel
3539 * and hwaccel_context are already uninitialized.
3541 int (*uninit)(AVCodecContext *avctx);
3544 * Size of the private data to allocate in
3545 * AVCodecInternal.hwaccel_priv_data.
3551 * Hardware acceleration should be used for decoding even if the codec level
3552 * used is unknown or higher than the maximum supported level reported by the
3555 * It's generally a good idea to pass this flag unless you have a specific
3556 * reason not to, as hardware tends to under-report supported levels.
3558 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3561 * Hardware acceleration can output YUV pixel formats with a different chroma
3562 * sampling than 4:2:0 and/or other than 8 bits per component.
3564 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3571 * @defgroup lavc_picture AVPicture
3573 * Functions for working with AVPicture
3578 * Picture data structure.
3580 * Up to four components can be stored into it, the last component is
3583 typedef struct AVPicture {
3584 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3585 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3592 enum AVSubtitleType {
3595 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3598 * Plain text, the text field must be set by the decoder and is
3599 * authoritative. ass and pict fields may contain approximations.
3604 * Formatted text, the ass field must be set by the decoder and is
3605 * authoritative. pict and text fields may contain approximations.
3610 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3612 typedef struct AVSubtitleRect {
3613 int x; ///< top left corner of pict, undefined when pict is not set
3614 int y; ///< top left corner of pict, undefined when pict is not set
3615 int w; ///< width of pict, undefined when pict is not set
3616 int h; ///< height of pict, undefined when pict is not set
3617 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3620 * data+linesize for the bitmap of this subtitle.
3621 * can be set for text/ass as well once they are rendered
3624 enum AVSubtitleType type;
3626 char *text; ///< 0 terminated plain UTF-8 text
3629 * 0 terminated ASS/SSA compatible event line.
3630 * The presentation of this is unaffected by the other values in this
3638 typedef struct AVSubtitle {
3639 uint16_t format; /* 0 = graphics */
3640 uint32_t start_display_time; /* relative to packet pts, in ms */
3641 uint32_t end_display_time; /* relative to packet pts, in ms */
3643 AVSubtitleRect **rects;
3644 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3648 * If c is NULL, returns the first registered codec,
3649 * if c is non-NULL, returns the next registered codec after c,
3650 * or NULL if c is the last one.
3652 AVCodec *av_codec_next(const AVCodec *c);
3655 * Return the LIBAVCODEC_VERSION_INT constant.
3657 unsigned avcodec_version(void);
3660 * Return the libavcodec build-time configuration.
3662 const char *avcodec_configuration(void);
3665 * Return the libavcodec license.
3667 const char *avcodec_license(void);
3670 * Register the codec codec and initialize libavcodec.
3672 * @warning either this function or avcodec_register_all() must be called
3673 * before any other libavcodec functions.
3675 * @see avcodec_register_all()
3677 void avcodec_register(AVCodec *codec);
3680 * Register all the codecs, parsers and bitstream filters which were enabled at
3681 * configuration time. If you do not call this function you can select exactly
3682 * which formats you want to support, by using the individual registration
3685 * @see avcodec_register
3686 * @see av_register_codec_parser
3687 * @see av_register_bitstream_filter
3689 void avcodec_register_all(void);
3692 * Allocate an AVCodecContext and set its fields to default values. The
3693 * resulting struct should be freed with avcodec_free_context().
3695 * @param codec if non-NULL, allocate private data and initialize defaults
3696 * for the given codec. It is illegal to then call avcodec_open2()
3697 * with a different codec.
3698 * If NULL, then the codec-specific defaults won't be initialized,
3699 * which may result in suboptimal default settings (this is
3700 * important mainly for encoders, e.g. libx264).
3702 * @return An AVCodecContext filled with default values or NULL on failure.
3703 * @see avcodec_get_context_defaults
3705 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3708 * Free the codec context and everything associated with it and write NULL to
3709 * the provided pointer.
3711 void avcodec_free_context(AVCodecContext **avctx);
3714 * Set the fields of the given AVCodecContext to default values corresponding
3715 * to the given codec (defaults may be codec-dependent).
3717 * Do not call this function if a non-NULL codec has been passed
3718 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3719 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3720 * different codec on this AVCodecContext.
3722 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3725 * Get the AVClass for AVCodecContext. It can be used in combination with
3726 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3728 * @see av_opt_find().
3730 const AVClass *avcodec_get_class(void);
3733 * Get the AVClass for AVFrame. It can be used in combination with
3734 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3736 * @see av_opt_find().
3738 const AVClass *avcodec_get_frame_class(void);
3741 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3742 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3744 * @see av_opt_find().
3746 const AVClass *avcodec_get_subtitle_rect_class(void);
3749 * Copy the settings of the source AVCodecContext into the destination
3750 * AVCodecContext. The resulting destination codec context will be
3751 * unopened, i.e. you are required to call avcodec_open2() before you
3752 * can use this AVCodecContext to decode/encode video/audio data.
3754 * @param dest target codec context, should be initialized with
3755 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3756 * @param src source codec context
3757 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3759 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3762 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3763 * function the context has to be allocated with avcodec_alloc_context3().
3765 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3766 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3767 * retrieving a codec.
3769 * @warning This function is not thread safe!
3771 * @note Always call this function before using decoding routines (such as
3772 * @ref avcodec_decode_video2()).
3775 * avcodec_register_all();
3776 * av_dict_set(&opts, "b", "2.5M", 0);
3777 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3781 * context = avcodec_alloc_context3(codec);
3783 * if (avcodec_open2(context, codec, opts) < 0)
3787 * @param avctx The context to initialize.
3788 * @param codec The codec to open this context for. If a non-NULL codec has been
3789 * previously passed to avcodec_alloc_context3() or
3790 * avcodec_get_context_defaults3() for this context, then this
3791 * parameter MUST be either NULL or equal to the previously passed
3793 * @param options A dictionary filled with AVCodecContext and codec-private options.
3794 * On return this object will be filled with options that were not found.
3796 * @return zero on success, a negative value on error
3797 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3798 * av_dict_set(), av_opt_find().
3800 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3803 * Close a given AVCodecContext and free all the data associated with it
3804 * (but not the AVCodecContext itself).
3806 * Calling this function on an AVCodecContext that hasn't been opened will free
3807 * the codec-specific data allocated in avcodec_alloc_context3() /
3808 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3811 int avcodec_close(AVCodecContext *avctx);
3814 * Free all allocated data in the given subtitle struct.
3816 * @param sub AVSubtitle to free.
3818 void avsubtitle_free(AVSubtitle *sub);
3825 * @addtogroup lavc_packet
3830 * Initialize optional fields of a packet with default values.
3832 * Note, this does not touch the data and size members, which have to be
3833 * initialized separately.
3837 void av_init_packet(AVPacket *pkt);
3840 * Allocate the payload of a packet and initialize its fields with
3844 * @param size wanted payload size
3845 * @return 0 if OK, AVERROR_xxx otherwise
3847 int av_new_packet(AVPacket *pkt, int size);
3850 * Reduce packet size, correctly zeroing padding
3853 * @param size new size
3855 void av_shrink_packet(AVPacket *pkt, int size);
3858 * Increase packet size, correctly zeroing padding
3861 * @param grow_by number of bytes by which to increase the size of the packet
3863 int av_grow_packet(AVPacket *pkt, int grow_by);
3866 * Initialize a reference-counted packet from av_malloc()ed data.
3868 * @param pkt packet to be initialized. This function will set the data, size,
3869 * buf and destruct fields, all others are left untouched.
3870 * @param data Data allocated by av_malloc() to be used as packet data. If this
3871 * function returns successfully, the data is owned by the underlying AVBuffer.
3872 * The caller may not access the data through other means.
3873 * @param size size of data in bytes, without the padding. I.e. the full buffer
3874 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
3876 * @return 0 on success, a negative AVERROR on error
3878 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3881 * @warning This is a hack - the packet memory allocation stuff is broken. The
3882 * packet is allocated if it was not really allocated.
3884 int av_dup_packet(AVPacket *pkt);
3887 * Copy packet, including contents
3889 * @return 0 on success, negative AVERROR on fail
3891 int av_copy_packet(AVPacket *dst, const AVPacket *src);
3894 * Copy packet side data
3896 * @return 0 on success, negative AVERROR on fail
3898 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
3903 * @param pkt packet to free
3905 void av_free_packet(AVPacket *pkt);
3908 * Allocate new information of a packet.
3911 * @param type side information type
3912 * @param size side information size
3913 * @return pointer to fresh allocated data or NULL otherwise
3915 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3919 * Shrink the already allocated side data buffer
3922 * @param type side information type
3923 * @param size new side information size
3924 * @return 0 on success, < 0 on failure
3926 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3930 * Get side information from packet.
3933 * @param type desired side information type
3934 * @param size pointer for side information size to store (optional)
3935 * @return pointer to data if present or NULL otherwise
3937 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3940 int av_packet_merge_side_data(AVPacket *pkt);
3942 int av_packet_split_side_data(AVPacket *pkt);
3944 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
3947 * Pack a dictionary for use in side_data.
3949 * @param dict The dictionary to pack.
3950 * @param size pointer to store the size of the returned data
3951 * @return pointer to data if successful, NULL otherwise
3953 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
3955 * Unpack a dictionary from side_data.
3957 * @param data data from side_data
3958 * @param size size of the data
3959 * @param dict the metadata storage dictionary
3960 * @return 0 on success, < 0 on failure
3962 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
3966 * Convenience function to free all the side data stored.
3967 * All the other fields stay untouched.
3971 void av_packet_free_side_data(AVPacket *pkt);
3974 * Setup a new reference to the data described by a given packet
3976 * If src is reference-counted, setup dst as a new reference to the
3977 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3978 * data from src into it.
3980 * All the other fields are copied from src.
3982 * @see av_packet_unref
3984 * @param dst Destination packet
3985 * @param src Source packet
3987 * @return 0 on success, a negative AVERROR on error.
3989 int av_packet_ref(AVPacket *dst, const AVPacket *src);
3994 * Unreference the buffer referenced by the packet and reset the
3995 * remaining packet fields to their default values.
3997 * @param pkt The packet to be unreferenced.
3999 void av_packet_unref(AVPacket *pkt);
4002 * Move every field in src to dst and reset src.
4004 * @see av_packet_unref
4006 * @param src Source packet, will be reset
4007 * @param dst Destination packet
4009 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4012 * Copy only "properties" fields from src to dst.
4014 * Properties for the purpose of this function are all the fields
4015 * beside those related to the packet data (buf, data, size)
4017 * @param dst Destination packet
4018 * @param src Source packet
4020 * @return 0 on success AVERROR on failure.
4023 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4026 * Convert valid timing fields (timestamps / durations) in a packet from one
4027 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4030 * @param pkt packet on which the conversion will be performed
4031 * @param tb_src source timebase, in which the timing fields in pkt are
4033 * @param tb_dst destination timebase, to which the timing fields will be
4036 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4043 * @addtogroup lavc_decoding
4048 * Find a registered decoder with a matching codec ID.
4050 * @param id AVCodecID of the requested decoder
4051 * @return A decoder if one was found, NULL otherwise.
4053 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4056 * Find a registered decoder with the specified name.
4058 * @param name name of the requested decoder
4059 * @return A decoder if one was found, NULL otherwise.
4061 AVCodec *avcodec_find_decoder_by_name(const char *name);
4064 * The default callback for AVCodecContext.get_buffer2(). It is made public so
4065 * it can be called by custom get_buffer2() implementations for decoders without
4066 * AV_CODEC_CAP_DR1 set.
4068 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4072 * Return the amount of padding in pixels which the get_buffer callback must
4073 * provide around the edge of the image for codecs which do not have the
4074 * CODEC_FLAG_EMU_EDGE flag.
4076 * @return Required padding in pixels.
4078 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4081 attribute_deprecated
4082 unsigned avcodec_get_edge_width(void);
4086 * Modify width and height values so that they will result in a memory
4087 * buffer that is acceptable for the codec if you do not use any horizontal
4090 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4092 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4095 * Modify width and height values so that they will result in a memory
4096 * buffer that is acceptable for the codec if you also ensure that all
4097 * line sizes are a multiple of the respective linesize_align[i].
4099 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4101 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4102 int linesize_align[AV_NUM_DATA_POINTERS]);
4105 * Converts AVChromaLocation to swscale x/y chroma position.
4107 * The positions represent the chroma (0,0) position in a coordinates system
4108 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4110 * @param xpos horizontal chroma sample position
4111 * @param ypos vertical chroma sample position
4113 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4116 * Converts swscale x/y chroma position to AVChromaLocation.
4118 * The positions represent the chroma (0,0) position in a coordinates system
4119 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4121 * @param xpos horizontal chroma sample position
4122 * @param ypos vertical chroma sample position
4124 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4127 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4129 * Some decoders may support multiple frames in a single AVPacket. Such
4130 * decoders would then just decode the first frame and the return value would be
4131 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4132 * called again with an AVPacket containing the remaining data in order to
4133 * decode the second frame, etc... Even if no frames are returned, the packet
4134 * needs to be fed to the decoder with remaining data until it is completely
4135 * consumed or an error occurs.
4137 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4138 * and output. This means that for some packets they will not immediately
4139 * produce decoded output and need to be flushed at the end of decoding to get
4140 * all the decoded data. Flushing is done by calling this function with packets
4141 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4142 * returning samples. It is safe to flush even those decoders that are not
4143 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4145 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4146 * larger than the actual read bytes because some optimized bitstream
4147 * readers read 32 or 64 bits at once and could read over the end.
4149 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4150 * before packets may be fed to the decoder.
4152 * @param avctx the codec context
4153 * @param[out] frame The AVFrame in which to store decoded audio samples.
4154 * The decoder will allocate a buffer for the decoded frame by
4155 * calling the AVCodecContext.get_buffer2() callback.
4156 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4157 * reference counted and the returned reference belongs to the
4158 * caller. The caller must release the frame using av_frame_unref()
4159 * when the frame is no longer needed. The caller may safely write
4160 * to the frame if av_frame_is_writable() returns 1.
4161 * When AVCodecContext.refcounted_frames is set to 0, the returned
4162 * reference belongs to the decoder and is valid only until the
4163 * next call to this function or until closing or flushing the
4164 * decoder. The caller may not write to it.
4165 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4166 * non-zero. Note that this field being set to zero
4167 * does not mean that an error has occurred. For
4168 * decoders with AV_CODEC_CAP_DELAY set, no given decode
4169 * call is guaranteed to produce a frame.
4170 * @param[in] avpkt The input AVPacket containing the input buffer.
4171 * At least avpkt->data and avpkt->size should be set. Some
4172 * decoders might also require additional fields to be set.
4173 * @return A negative error code is returned if an error occurred during
4174 * decoding, otherwise the number of bytes consumed from the input
4175 * AVPacket is returned.
4177 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4178 int *got_frame_ptr, const AVPacket *avpkt);
4181 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4182 * Some decoders may support multiple frames in a single AVPacket, such
4183 * decoders would then just decode the first frame.
4185 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4186 * the actual read bytes because some optimized bitstream readers read 32 or 64
4187 * bits at once and could read over the end.
4189 * @warning The end of the input buffer buf should be set to 0 to ensure that
4190 * no overreading happens for damaged MPEG streams.
4192 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4193 * between input and output, these need to be fed with avpkt->data=NULL,
4194 * avpkt->size=0 at the end to return the remaining frames.
4196 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4197 * before packets may be fed to the decoder.
4199 * @param avctx the codec context
4200 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4201 * Use av_frame_alloc() to get an AVFrame. The codec will
4202 * allocate memory for the actual bitmap by calling the
4203 * AVCodecContext.get_buffer2() callback.
4204 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4205 * reference counted and the returned reference belongs to the
4206 * caller. The caller must release the frame using av_frame_unref()
4207 * when the frame is no longer needed. The caller may safely write
4208 * to the frame if av_frame_is_writable() returns 1.
4209 * When AVCodecContext.refcounted_frames is set to 0, the returned
4210 * reference belongs to the decoder and is valid only until the
4211 * next call to this function or until closing or flushing the
4212 * decoder. The caller may not write to it.
4214 * @param[in] avpkt The input AVPacket containing the input buffer.
4215 * You can create such packet with av_init_packet() and by then setting
4216 * data and size, some decoders might in addition need other fields like
4217 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4219 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4220 * @return On error a negative value is returned, otherwise the number of bytes
4221 * used or zero if no frame could be decompressed.
4223 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4224 int *got_picture_ptr,
4225 const AVPacket *avpkt);
4228 * Decode a subtitle message.
4229 * Return a negative value on error, otherwise return the number of bytes used.
4230 * If no subtitle could be decompressed, got_sub_ptr is zero.
4231 * Otherwise, the subtitle is stored in *sub.
4232 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4233 * simplicity, because the performance difference is expect to be negligible
4234 * and reusing a get_buffer written for video codecs would probably perform badly
4235 * due to a potentially very different allocation pattern.
4237 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4238 * and output. This means that for some packets they will not immediately
4239 * produce decoded output and need to be flushed at the end of decoding to get
4240 * all the decoded data. Flushing is done by calling this function with packets
4241 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4242 * returning subtitles. It is safe to flush even those decoders that are not
4243 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4245 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4246 * before packets may be fed to the decoder.
4248 * @param avctx the codec context
4249 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4250 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4251 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4252 * @param[in] avpkt The input AVPacket containing the input buffer.
4254 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4259 * @defgroup lavc_parsing Frame parsing
4263 enum AVPictureStructure {
4264 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4265 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4266 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4267 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4270 typedef struct AVCodecParserContext {
4272 struct AVCodecParser *parser;
4273 int64_t frame_offset; /* offset of the current frame */
4274 int64_t cur_offset; /* current offset
4275 (incremented by each av_parser_parse()) */
4276 int64_t next_frame_offset; /* offset of the next frame */
4278 int pict_type; /* XXX: Put it back in AVCodecContext. */
4280 * This field is used for proper frame duration computation in lavf.
4281 * It signals, how much longer the frame duration of the current frame
4282 * is compared to normal frame duration.
4284 * frame_duration = (1 + repeat_pict) * time_base
4286 * It is used by codecs like H.264 to display telecined material.
4288 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4289 int64_t pts; /* pts of the current frame */
4290 int64_t dts; /* dts of the current frame */
4295 int fetch_timestamp;
4297 #define AV_PARSER_PTS_NB 4
4298 int cur_frame_start_index;
4299 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4300 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4301 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4304 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4305 #define PARSER_FLAG_ONCE 0x0002
4306 /// Set if the parser has a valid file offset
4307 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4308 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4310 int64_t offset; ///< byte offset from starting packet start
4311 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4314 * Set by parser to 1 for key frames and 0 for non-key frames.
4315 * It is initialized to -1, so if the parser doesn't set this flag,
4316 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4321 #if FF_API_CONVERGENCE_DURATION
4323 * @deprecated unused
4325 attribute_deprecated
4326 int64_t convergence_duration;
4329 // Timestamp generation support:
4331 * Synchronization point for start of timestamp generation.
4333 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4336 * For example, this corresponds to presence of H.264 buffering period
4342 * Offset of the current timestamp against last timestamp sync point in
4343 * units of AVCodecContext.time_base.
4345 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4346 * contain a valid timestamp offset.
4348 * Note that the timestamp of sync point has usually a nonzero
4349 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4350 * the next frame after timestamp sync point will be usually 1.
4352 * For example, this corresponds to H.264 cpb_removal_delay.
4354 int dts_ref_dts_delta;
4357 * Presentation delay of current frame in units of AVCodecContext.time_base.
4359 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4360 * contain valid non-negative timestamp delta (presentation time of a frame
4361 * must not lie in the past).
4363 * This delay represents the difference between decoding and presentation
4364 * time of the frame.
4366 * For example, this corresponds to H.264 dpb_output_delay.
4371 * Position of the packet in file.
4373 * Analogous to cur_frame_pts/dts
4375 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4378 * Byte position of currently parsed frame in stream.
4383 * Previous frame byte position.
4388 * Duration of the current frame.
4389 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4390 * For all other types, this is in units of AVCodecContext.time_base.
4394 enum AVFieldOrder field_order;
4397 * Indicate whether a picture is coded as a frame, top field or bottom field.
4399 * For example, H.264 field_pic_flag equal to 0 corresponds to
4400 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4401 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4402 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4404 enum AVPictureStructure picture_structure;
4407 * Picture number incremented in presentation or output order.
4408 * This field may be reinitialized at the first picture of a new sequence.
4410 * For example, this corresponds to H.264 PicOrderCnt.
4412 int output_picture_number;
4415 * Dimensions of the decoded video intended for presentation.
4421 * Dimensions of the coded video.
4427 * The format of the coded data, corresponds to enum AVPixelFormat for video
4428 * and for enum AVSampleFormat for audio.
4430 * Note that a decoder can have considerable freedom in how exactly it
4431 * decodes the data, so the format reported here might be different from the
4432 * one returned by a decoder.
4435 } AVCodecParserContext;
4437 typedef struct AVCodecParser {
4438 int codec_ids[5]; /* several codec IDs are permitted */
4440 int (*parser_init)(AVCodecParserContext *s);
4441 /* This callback never returns an error, a negative value means that
4442 * the frame start was in a previous packet. */
4443 int (*parser_parse)(AVCodecParserContext *s,
4444 AVCodecContext *avctx,
4445 const uint8_t **poutbuf, int *poutbuf_size,
4446 const uint8_t *buf, int buf_size);
4447 void (*parser_close)(AVCodecParserContext *s);
4448 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4449 struct AVCodecParser *next;
4452 AVCodecParser *av_parser_next(const AVCodecParser *c);
4454 void av_register_codec_parser(AVCodecParser *parser);
4455 AVCodecParserContext *av_parser_init(int codec_id);
4460 * @param s parser context.
4461 * @param avctx codec context.
4462 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4463 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4464 * @param buf input buffer.
4465 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4466 * @param pts input presentation timestamp.
4467 * @param dts input decoding timestamp.
4468 * @param pos input byte position in stream.
4469 * @return the number of bytes of the input bitstream used.
4474 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4481 * decode_frame(data, size);
4485 int av_parser_parse2(AVCodecParserContext *s,
4486 AVCodecContext *avctx,
4487 uint8_t **poutbuf, int *poutbuf_size,
4488 const uint8_t *buf, int buf_size,
4489 int64_t pts, int64_t dts,
4493 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4494 * @deprecated use AVBitStreamFilter
4496 int av_parser_change(AVCodecParserContext *s,
4497 AVCodecContext *avctx,
4498 uint8_t **poutbuf, int *poutbuf_size,
4499 const uint8_t *buf, int buf_size, int keyframe);
4500 void av_parser_close(AVCodecParserContext *s);
4508 * @addtogroup lavc_encoding
4513 * Find a registered encoder with a matching codec ID.
4515 * @param id AVCodecID of the requested encoder
4516 * @return An encoder if one was found, NULL otherwise.
4518 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4521 * Find a registered encoder with the specified name.
4523 * @param name name of the requested encoder
4524 * @return An encoder if one was found, NULL otherwise.
4526 AVCodec *avcodec_find_encoder_by_name(const char *name);
4529 * Encode a frame of audio.
4531 * Takes input samples from frame and writes the next output packet, if
4532 * available, to avpkt. The output packet does not necessarily contain data for
4533 * the most recent frame, as encoders can delay, split, and combine input frames
4534 * internally as needed.
4536 * @param avctx codec context
4537 * @param avpkt output AVPacket.
4538 * The user can supply an output buffer by setting
4539 * avpkt->data and avpkt->size prior to calling the
4540 * function, but if the size of the user-provided data is not
4541 * large enough, encoding will fail. If avpkt->data and
4542 * avpkt->size are set, avpkt->destruct must also be set. All
4543 * other AVPacket fields will be reset by the encoder using
4544 * av_init_packet(). If avpkt->data is NULL, the encoder will
4545 * allocate it. The encoder will set avpkt->size to the size
4546 * of the output packet.
4548 * If this function fails or produces no output, avpkt will be
4549 * freed using av_free_packet() (i.e. avpkt->destruct will be
4550 * called to free the user supplied buffer).
4551 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4552 * May be NULL when flushing an encoder that has the
4553 * AV_CODEC_CAP_DELAY capability set.
4554 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4555 * can have any number of samples.
4556 * If it is not set, frame->nb_samples must be equal to
4557 * avctx->frame_size for all frames except the last.
4558 * The final frame may be smaller than avctx->frame_size.
4559 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4560 * output packet is non-empty, and to 0 if it is
4561 * empty. If the function returns an error, the
4562 * packet can be assumed to be invalid, and the
4563 * value of got_packet_ptr is undefined and should
4565 * @return 0 on success, negative error code on failure
4567 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4568 const AVFrame *frame, int *got_packet_ptr);
4571 * Encode a frame of video.
4573 * Takes input raw video data from frame and writes the next output packet, if
4574 * available, to avpkt. The output packet does not necessarily contain data for
4575 * the most recent frame, as encoders can delay and reorder input frames
4576 * internally as needed.
4578 * @param avctx codec context
4579 * @param avpkt output AVPacket.
4580 * The user can supply an output buffer by setting
4581 * avpkt->data and avpkt->size prior to calling the
4582 * function, but if the size of the user-provided data is not
4583 * large enough, encoding will fail. All other AVPacket fields
4584 * will be reset by the encoder using av_init_packet(). If
4585 * avpkt->data is NULL, the encoder will allocate it.
4586 * The encoder will set avpkt->size to the size of the
4587 * output packet. The returned data (if any) belongs to the
4588 * caller, he is responsible for freeing it.
4590 * If this function fails or produces no output, avpkt will be
4591 * freed using av_free_packet() (i.e. avpkt->destruct will be
4592 * called to free the user supplied buffer).
4593 * @param[in] frame AVFrame containing the raw video data to be encoded.
4594 * May be NULL when flushing an encoder that has the
4595 * AV_CODEC_CAP_DELAY capability set.
4596 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4597 * output packet is non-empty, and to 0 if it is
4598 * empty. If the function returns an error, the
4599 * packet can be assumed to be invalid, and the
4600 * value of got_packet_ptr is undefined and should
4602 * @return 0 on success, negative error code on failure
4604 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4605 const AVFrame *frame, int *got_packet_ptr);
4607 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4608 const AVSubtitle *sub);
4615 #if FF_API_AVCODEC_RESAMPLE
4617 * @defgroup lavc_resample Audio resampling
4619 * @deprecated use libswresample instead
4623 struct ReSampleContext;
4624 struct AVResampleContext;
4626 typedef struct ReSampleContext ReSampleContext;
4629 * Initialize audio resampling context.
4631 * @param output_channels number of output channels
4632 * @param input_channels number of input channels
4633 * @param output_rate output sample rate
4634 * @param input_rate input sample rate
4635 * @param sample_fmt_out requested output sample format
4636 * @param sample_fmt_in input sample format
4637 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4638 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4639 * @param linear if 1 then the used FIR filter will be linearly interpolated
4640 between the 2 closest, if 0 the closest will be used
4641 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4642 * @return allocated ReSampleContext, NULL if error occurred
4644 attribute_deprecated
4645 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4646 int output_rate, int input_rate,
4647 enum AVSampleFormat sample_fmt_out,
4648 enum AVSampleFormat sample_fmt_in,
4649 int filter_length, int log2_phase_count,
4650 int linear, double cutoff);
4652 attribute_deprecated
4653 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4656 * Free resample context.
4658 * @param s a non-NULL pointer to a resample context previously
4659 * created with av_audio_resample_init()
4661 attribute_deprecated
4662 void audio_resample_close(ReSampleContext *s);
4666 * Initialize an audio resampler.
4667 * Note, if either rate is not an integer then simply scale both rates up so they are.
4668 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4669 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4670 * @param linear If 1 then the used FIR filter will be linearly interpolated
4671 between the 2 closest, if 0 the closest will be used
4672 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4674 attribute_deprecated
4675 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4678 * Resample an array of samples using a previously configured context.
4679 * @param src an array of unconsumed samples
4680 * @param consumed the number of samples of src which have been consumed are returned here
4681 * @param src_size the number of unconsumed samples available
4682 * @param dst_size the amount of space in samples available in dst
4683 * @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.
4684 * @return the number of samples written in dst or -1 if an error occurred
4686 attribute_deprecated
4687 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4691 * Compensate samplerate/timestamp drift. The compensation is done by changing
4692 * the resampler parameters, so no audible clicks or similar distortions occur
4693 * @param compensation_distance distance in output samples over which the compensation should be performed
4694 * @param sample_delta number of output samples which should be output less
4696 * example: av_resample_compensate(c, 10, 500)
4697 * here instead of 510 samples only 500 samples would be output
4699 * note, due to rounding the actual compensation might be slightly different,
4700 * especially if the compensation_distance is large and the in_rate used during init is small
4702 attribute_deprecated
4703 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4704 attribute_deprecated
4705 void av_resample_close(struct AVResampleContext *c);
4713 * @addtogroup lavc_picture
4718 * Allocate memory for the pixels of a picture and setup the AVPicture
4721 * Call avpicture_free() to free it.
4723 * @param picture the picture structure to be filled in
4724 * @param pix_fmt the pixel format of the picture
4725 * @param width the width of the picture
4726 * @param height the height of the picture
4727 * @return zero if successful, a negative error code otherwise
4729 * @see av_image_alloc(), avpicture_fill()
4731 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4734 * Free a picture previously allocated by avpicture_alloc().
4735 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4738 * @param picture the AVPicture to be freed
4740 void avpicture_free(AVPicture *picture);
4743 * Setup the picture fields based on the specified image parameters
4744 * and the provided image data buffer.
4746 * The picture fields are filled in by using the image data buffer
4747 * pointed to by ptr.
4749 * If ptr is NULL, the function will fill only the picture linesize
4750 * array and return the required size for the image buffer.
4752 * To allocate an image buffer and fill the picture data in one call,
4753 * use avpicture_alloc().
4755 * @param picture the picture to be filled in
4756 * @param ptr buffer where the image data is stored, or NULL
4757 * @param pix_fmt the pixel format of the image
4758 * @param width the width of the image in pixels
4759 * @param height the height of the image in pixels
4760 * @return the size in bytes required for src, a negative error code
4761 * in case of failure
4763 * @see av_image_fill_arrays()
4765 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4766 enum AVPixelFormat pix_fmt, int width, int height);
4769 * Copy pixel data from an AVPicture into a buffer.
4771 * avpicture_get_size() can be used to compute the required size for
4772 * the buffer to fill.
4774 * @param src source picture with filled data
4775 * @param pix_fmt picture pixel format
4776 * @param width picture width
4777 * @param height picture height
4778 * @param dest destination buffer
4779 * @param dest_size destination buffer size in bytes
4780 * @return the number of bytes written to dest, or a negative value
4781 * (error code) on error, for example if the destination buffer is not
4784 * @see av_image_copy_to_buffer()
4786 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4787 int width, int height,
4788 unsigned char *dest, int dest_size);
4791 * Calculate the size in bytes that a picture of the given width and height
4792 * would occupy if stored in the given picture format.
4794 * @param pix_fmt picture pixel format
4795 * @param width picture width
4796 * @param height picture height
4797 * @return the computed picture buffer size or a negative error code
4800 * @see av_image_get_buffer_size().
4802 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4805 * Copy image src to dst. Wraps av_image_copy().
4807 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4808 enum AVPixelFormat pix_fmt, int width, int height);
4811 * Crop image top and left side.
4813 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4814 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4819 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4820 int padtop, int padbottom, int padleft, int padright, int *color);
4827 * @defgroup lavc_misc Utility functions
4830 * Miscellaneous utility functions related to both encoding and decoding
4836 * @defgroup lavc_misc_pixfmt Pixel formats
4838 * Functions for working with pixel formats.
4843 * Utility function to access log2_chroma_w log2_chroma_h from
4844 * the pixel format AVPixFmtDescriptor.
4846 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4847 * for one that returns a failure code and continues in case of invalid
4850 * @param[in] pix_fmt the pixel format
4851 * @param[out] h_shift store log2_chroma_w
4852 * @param[out] v_shift store log2_chroma_h
4854 * @see av_pix_fmt_get_chroma_sub_sample
4857 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4860 * Return a value representing the fourCC code associated to the
4861 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4864 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4867 * @deprecated see av_get_pix_fmt_loss()
4869 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4873 * Find the best pixel format to convert to given a certain source pixel
4874 * format. When converting from one pixel format to another, information loss
4875 * may occur. For example, when converting from RGB24 to GRAY, the color
4876 * information will be lost. Similarly, other losses occur when converting from
4877 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4878 * the given pixel formats should be used to suffer the least amount of loss.
4879 * The pixel formats from which it chooses one, are determined by the
4880 * pix_fmt_list parameter.
4883 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4884 * @param[in] src_pix_fmt source pixel format
4885 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4886 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4887 * @return The best pixel format to convert to or -1 if none was found.
4889 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4890 enum AVPixelFormat src_pix_fmt,
4891 int has_alpha, int *loss_ptr);
4894 * @deprecated see av_find_best_pix_fmt_of_2()
4896 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4897 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4899 attribute_deprecated
4900 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
4901 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
4902 enum AVPixelFormat src_pix_fmt,
4903 int has_alpha, int *loss_ptr);
4905 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4906 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4910 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4916 #if FF_API_SET_DIMENSIONS
4918 * @deprecated this function is not supposed to be used from outside of lavc
4920 attribute_deprecated
4921 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4925 * Put a string representing the codec tag codec_tag in buf.
4927 * @param buf buffer to place codec tag in
4928 * @param buf_size size in bytes of buf
4929 * @param codec_tag codec tag to assign
4930 * @return the length of the string that would have been generated if
4931 * enough space had been available, excluding the trailing null
4933 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4935 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4938 * Return a name for the specified profile, if available.
4940 * @param codec the codec that is searched for the given profile
4941 * @param profile the profile value for which a name is requested
4942 * @return A name for the profile if found, NULL otherwise.
4944 const char *av_get_profile_name(const AVCodec *codec, int profile);
4946 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4947 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4948 //FIXME func typedef
4951 * Fill AVFrame audio data and linesize pointers.
4953 * The buffer buf must be a preallocated buffer with a size big enough
4954 * to contain the specified samples amount. The filled AVFrame data
4955 * pointers will point to this buffer.
4957 * AVFrame extended_data channel pointers are allocated if necessary for
4960 * @param frame the AVFrame
4961 * frame->nb_samples must be set prior to calling the
4962 * function. This function fills in frame->data,
4963 * frame->extended_data, frame->linesize[0].
4964 * @param nb_channels channel count
4965 * @param sample_fmt sample format
4966 * @param buf buffer to use for frame data
4967 * @param buf_size size of buffer
4968 * @param align plane size sample alignment (0 = default)
4969 * @return >=0 on success, negative error code on failure
4970 * @todo return the size in bytes required to store the samples in
4971 * case of success, at the next libavutil bump
4973 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4974 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4975 int buf_size, int align);
4978 * Reset the internal decoder state / flush internal buffers. Should be called
4979 * e.g. when seeking or when switching to a different stream.
4981 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4982 * this invalidates the frames previously returned from the decoder. When
4983 * refcounted frames are used, the decoder just releases any references it might
4984 * keep internally, but the caller's reference remains valid.
4986 void avcodec_flush_buffers(AVCodecContext *avctx);
4989 * Return codec bits per sample.
4991 * @param[in] codec_id the codec
4992 * @return Number of bits per sample or zero if unknown for the given codec.
4994 int av_get_bits_per_sample(enum AVCodecID codec_id);
4997 * Return the PCM codec associated with a sample format.
4998 * @param be endianness, 0 for little, 1 for big,
4999 * -1 (or anything else) for native
5000 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5002 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5005 * Return codec bits per sample.
5006 * Only return non-zero if the bits per sample is exactly correct, not an
5009 * @param[in] codec_id the codec
5010 * @return Number of bits per sample or zero if unknown for the given codec.
5012 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5015 * Return audio frame duration.
5017 * @param avctx codec context
5018 * @param frame_bytes size of the frame, or 0 if unknown
5019 * @return frame duration, in samples, if known. 0 if not able to
5022 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5025 typedef struct AVBitStreamFilterContext {
5027 struct AVBitStreamFilter *filter;
5028 AVCodecParserContext *parser;
5029 struct AVBitStreamFilterContext *next;
5031 * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5032 * Not for access by library users.
5035 } AVBitStreamFilterContext;
5038 typedef struct AVBitStreamFilter {
5041 int (*filter)(AVBitStreamFilterContext *bsfc,
5042 AVCodecContext *avctx, const char *args,
5043 uint8_t **poutbuf, int *poutbuf_size,
5044 const uint8_t *buf, int buf_size, int keyframe);
5045 void (*close)(AVBitStreamFilterContext *bsfc);
5046 struct AVBitStreamFilter *next;
5047 } AVBitStreamFilter;
5050 * Register a bitstream filter.
5052 * The filter will be accessible to the application code through
5053 * av_bitstream_filter_next() or can be directly initialized with
5054 * av_bitstream_filter_init().
5056 * @see avcodec_register_all()
5058 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5061 * Create and initialize a bitstream filter context given a bitstream
5064 * The returned context must be freed with av_bitstream_filter_close().
5066 * @param name the name of the bitstream filter
5067 * @return a bitstream filter context if a matching filter was found
5068 * and successfully initialized, NULL otherwise
5070 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5075 * This function filters the buffer buf with size buf_size, and places the
5076 * filtered buffer in the buffer pointed to by poutbuf.
5078 * The output buffer must be freed by the caller.
5080 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5081 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5082 * If specified, this must point to the encoder context of the
5083 * output stream the packet is sent to.
5084 * @param args arguments which specify the filter configuration, may be NULL
5085 * @param poutbuf pointer which is updated to point to the filtered buffer
5086 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5087 * @param buf buffer containing the data to filter
5088 * @param buf_size size in bytes of buf
5089 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5090 * @return >= 0 in case of success, or a negative error code in case of failure
5092 * If the return value is positive, an output buffer is allocated and
5093 * is available in *poutbuf, and is distinct from the input buffer.
5095 * If the return value is 0, the output buffer is not allocated and
5096 * should be considered identical to the input buffer, or in case
5097 * *poutbuf was set it points to the input buffer (not necessarily to
5098 * its starting address).
5100 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5101 AVCodecContext *avctx, const char *args,
5102 uint8_t **poutbuf, int *poutbuf_size,
5103 const uint8_t *buf, int buf_size, int keyframe);
5106 * Release bitstream filter context.
5108 * @param bsf the bitstream filter context created with
5109 * av_bitstream_filter_init(), can be NULL
5111 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5114 * If f is NULL, return the first registered bitstream filter,
5115 * if f is non-NULL, return the next registered bitstream filter
5116 * after f, or NULL if f is the last one.
5118 * This function can be used to iterate over all registered bitstream
5121 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5126 * Same behaviour av_fast_malloc but the buffer has additional
5127 * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5129 * In addition the whole buffer will initially and after resizes
5130 * be 0-initialized so that no uninitialized data will ever appear.
5132 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5135 * Same behaviour av_fast_padded_malloc except that buffer will always
5136 * be 0-initialized after call.
5138 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5141 * Encode extradata length to a buffer. Used by xiph codecs.
5143 * @param s buffer to write to; must be at least (v/255+1) bytes long
5144 * @param v size of extradata in bytes
5145 * @return number of bytes written to the buffer.
5147 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5149 #if FF_API_MISSING_SAMPLE
5151 * Log a generic warning message about a missing feature. This function is
5152 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5153 * only, and would normally not be used by applications.
5154 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5155 * a pointer to an AVClass struct
5156 * @param[in] feature string containing the name of the missing feature
5157 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5158 * If want_sample is non-zero, additional verbage will be added to the log
5159 * message which tells the user how to report samples to the development
5161 * @deprecated Use avpriv_report_missing_feature() instead.
5163 attribute_deprecated
5164 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5167 * Log a generic warning message asking for a sample. This function is
5168 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5169 * only, and would normally not be used by applications.
5170 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5171 * a pointer to an AVClass struct
5172 * @param[in] msg string containing an optional message, or NULL if no message
5173 * @deprecated Use avpriv_request_sample() instead.
5175 attribute_deprecated
5176 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5177 #endif /* FF_API_MISSING_SAMPLE */
5180 * Register the hardware accelerator hwaccel.
5182 void av_register_hwaccel(AVHWAccel *hwaccel);
5185 * If hwaccel is NULL, returns the first registered hardware accelerator,
5186 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5187 * after hwaccel, or NULL if hwaccel is the last one.
5189 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5193 * Lock operation used by lockmgr
5196 AV_LOCK_CREATE, ///< Create a mutex
5197 AV_LOCK_OBTAIN, ///< Lock the mutex
5198 AV_LOCK_RELEASE, ///< Unlock the mutex
5199 AV_LOCK_DESTROY, ///< Free mutex resources
5203 * Register a user provided lock manager supporting the operations
5204 * specified by AVLockOp. The "mutex" argument to the function points
5205 * to a (void *) where the lockmgr should store/get a pointer to a user
5206 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5207 * value left by the last call for all other ops. If the lock manager is
5208 * unable to perform the op then it should leave the mutex in the same
5209 * state as when it was called and return a non-zero value. However,
5210 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5211 * have been successfully destroyed. If av_lockmgr_register succeeds
5212 * it will return a non-negative value, if it fails it will return a
5213 * negative value and destroy all mutex and unregister all callbacks.
5214 * av_lockmgr_register is not thread-safe, it must be called from a
5215 * single thread before any calls which make use of locking are used.
5217 * @param cb User defined callback. av_lockmgr_register invokes calls
5218 * to this callback and the previously registered callback.
5219 * The callback will be used to create more than one mutex
5220 * each of which must be backed by its own underlying locking
5221 * mechanism (i.e. do not use a single static object to
5222 * implement your lock manager). If cb is set to NULL the
5223 * lockmgr will be unregistered.
5225 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5228 * Get the type of the given codec.
5230 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5233 * Get the name of a codec.
5234 * @return a static string identifying the codec; never NULL
5236 const char *avcodec_get_name(enum AVCodecID id);
5239 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5240 * with no corresponding avcodec_close()), 0 otherwise.
5242 int avcodec_is_open(AVCodecContext *s);
5245 * @return a non-zero number if codec is an encoder, zero otherwise
5247 int av_codec_is_encoder(const AVCodec *codec);
5250 * @return a non-zero number if codec is a decoder, zero otherwise
5252 int av_codec_is_decoder(const AVCodec *codec);
5255 * @return descriptor for given codec ID or NULL if no descriptor exists.
5257 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5260 * Iterate over all codec descriptors known to libavcodec.
5262 * @param prev previous descriptor. NULL to get the first descriptor.
5264 * @return next descriptor or NULL after the last descriptor
5266 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5269 * @return codec descriptor with the given name or NULL if no such descriptor
5272 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5278 #endif /* AVCODEC_AVCODEC_H */