2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav 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 * Libav 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 Libav; 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/dict.h"
37 #include "libavutil/frame.h"
38 #include "libavutil/log.h"
39 #include "libavutil/pixfmt.h"
40 #include "libavutil/rational.h"
44 #if FF_API_FAST_MALLOC
45 // to provide fast_*alloc
46 #include "libavutil/mem.h"
50 * @defgroup libavc Encoding/Decoding Library
53 * @defgroup lavc_decoding Decoding
57 * @defgroup lavc_encoding Encoding
61 * @defgroup lavc_codec Codecs
63 * @defgroup lavc_codec_native Native Codecs
66 * @defgroup lavc_codec_wrappers External library wrappers
69 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
73 * @defgroup lavc_internal Internal
81 * @defgroup lavc_core Core functions/structures.
84 * Basic definitions, functions for querying libavcodec capabilities,
85 * allocating core structures, etc.
91 * Identify the syntax and semantics of the bitstream.
92 * The principle is roughly:
93 * Two decoders with the same ID can decode the same streams.
94 * Two encoders with the same ID can encode compatible streams.
95 * There may be slight deviations from the principle due to implementation
98 * If you add a codec ID to this list, add it so that
99 * 1. no value of a existing codec ID changes (that would break ABI),
100 * 2. it is as close as possible to similar codecs.
102 * After adding new codec IDs, do not forget to add an entry to the codec
103 * descriptor list and bump libavcodec minor version.
109 AV_CODEC_ID_MPEG1VIDEO,
110 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
112 AV_CODEC_ID_MPEG2VIDEO_XVMC,
113 #endif /* FF_API_XVMC */
124 AV_CODEC_ID_RAWVIDEO,
125 AV_CODEC_ID_MSMPEG4V1,
126 AV_CODEC_ID_MSMPEG4V2,
127 AV_CODEC_ID_MSMPEG4V3,
150 AV_CODEC_ID_INTERPLAY_VIDEO,
157 AV_CODEC_ID_MSVIDEO1,
162 AV_CODEC_ID_TRUEMOTION1,
163 AV_CODEC_ID_VMDVIDEO,
188 AV_CODEC_ID_TRUEMOTION2,
194 AV_CODEC_ID_SMACKVIDEO,
199 AV_CODEC_ID_JPEG2000,
205 AV_CODEC_ID_DSICINVIDEO,
206 AV_CODEC_ID_TIERTEXSEQVIDEO,
214 AV_CODEC_ID_BETHSOFTVID,
226 AV_CODEC_ID_ESCAPE124,
230 AV_CODEC_ID_MOTIONPIXELS,
242 AV_CODEC_ID_FLASHSV2,
243 AV_CODEC_ID_CDGRAPHICS,
246 AV_CODEC_ID_BINKVIDEO,
247 AV_CODEC_ID_IFF_ILBM,
248 AV_CODEC_ID_IFF_BYTERUN1,
254 AV_CODEC_ID_A64_MULTI,
255 AV_CODEC_ID_A64_MULTI5,
258 AV_CODEC_ID_LAGARITH,
262 AV_CODEC_ID_WMV3IMAGE,
263 AV_CODEC_ID_VC1IMAGE,
265 AV_CODEC_ID_BMV_VIDEO,
272 AV_CODEC_ID_ZEROCODEC,
281 AV_CODEC_ID_ESCAPE130,
284 AV_CODEC_ID_HNM4_VIDEO,
287 AV_CODEC_ID_ALIAS_PIX,
288 AV_CODEC_ID_BRENDER_PIX,
289 AV_CODEC_ID_PAF_VIDEO,
302 AV_CODEC_ID_SCREENPRESSO,
305 /* various PCM "codecs" */
306 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
307 AV_CODEC_ID_PCM_S16LE = 0x10000,
308 AV_CODEC_ID_PCM_S16BE,
309 AV_CODEC_ID_PCM_U16LE,
310 AV_CODEC_ID_PCM_U16BE,
313 AV_CODEC_ID_PCM_MULAW,
314 AV_CODEC_ID_PCM_ALAW,
315 AV_CODEC_ID_PCM_S32LE,
316 AV_CODEC_ID_PCM_S32BE,
317 AV_CODEC_ID_PCM_U32LE,
318 AV_CODEC_ID_PCM_U32BE,
319 AV_CODEC_ID_PCM_S24LE,
320 AV_CODEC_ID_PCM_S24BE,
321 AV_CODEC_ID_PCM_U24LE,
322 AV_CODEC_ID_PCM_U24BE,
323 AV_CODEC_ID_PCM_S24DAUD,
324 AV_CODEC_ID_PCM_ZORK,
325 AV_CODEC_ID_PCM_S16LE_PLANAR,
327 AV_CODEC_ID_PCM_F32BE,
328 AV_CODEC_ID_PCM_F32LE,
329 AV_CODEC_ID_PCM_F64BE,
330 AV_CODEC_ID_PCM_F64LE,
331 AV_CODEC_ID_PCM_BLURAY,
334 AV_CODEC_ID_PCM_S8_PLANAR,
335 AV_CODEC_ID_PCM_S24LE_PLANAR,
336 AV_CODEC_ID_PCM_S32LE_PLANAR,
337 AV_CODEC_ID_PCM_S16BE_PLANAR,
339 /* various ADPCM codecs */
340 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
341 AV_CODEC_ID_ADPCM_IMA_WAV,
342 AV_CODEC_ID_ADPCM_IMA_DK3,
343 AV_CODEC_ID_ADPCM_IMA_DK4,
344 AV_CODEC_ID_ADPCM_IMA_WS,
345 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
346 AV_CODEC_ID_ADPCM_MS,
347 AV_CODEC_ID_ADPCM_4XM,
348 AV_CODEC_ID_ADPCM_XA,
349 AV_CODEC_ID_ADPCM_ADX,
350 AV_CODEC_ID_ADPCM_EA,
351 AV_CODEC_ID_ADPCM_G726,
352 AV_CODEC_ID_ADPCM_CT,
353 AV_CODEC_ID_ADPCM_SWF,
354 AV_CODEC_ID_ADPCM_YAMAHA,
355 AV_CODEC_ID_ADPCM_SBPRO_4,
356 AV_CODEC_ID_ADPCM_SBPRO_3,
357 AV_CODEC_ID_ADPCM_SBPRO_2,
358 AV_CODEC_ID_ADPCM_THP,
359 AV_CODEC_ID_ADPCM_IMA_AMV,
360 AV_CODEC_ID_ADPCM_EA_R1,
361 AV_CODEC_ID_ADPCM_EA_R3,
362 AV_CODEC_ID_ADPCM_EA_R2,
363 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
364 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
365 AV_CODEC_ID_ADPCM_EA_XAS,
366 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
367 AV_CODEC_ID_ADPCM_IMA_ISS,
368 AV_CODEC_ID_ADPCM_G722,
369 AV_CODEC_ID_ADPCM_IMA_APC,
370 AV_CODEC_ID_ADPCM_VIMA,
373 AV_CODEC_ID_AMR_NB = 0x12000,
376 /* RealAudio codecs*/
377 AV_CODEC_ID_RA_144 = 0x13000,
380 /* various DPCM codecs */
381 AV_CODEC_ID_ROQ_DPCM = 0x14000,
382 AV_CODEC_ID_INTERPLAY_DPCM,
383 AV_CODEC_ID_XAN_DPCM,
384 AV_CODEC_ID_SOL_DPCM,
387 AV_CODEC_ID_MP2 = 0x15000,
388 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
398 AV_CODEC_ID_VMDAUDIO,
404 AV_CODEC_ID_WESTWOOD_SND1,
405 AV_CODEC_ID_GSM, ///< as in Berlin toast format
408 AV_CODEC_ID_TRUESPEECH,
410 AV_CODEC_ID_SMACKAUDIO,
413 AV_CODEC_ID_DSICINAUDIO,
415 AV_CODEC_ID_MUSEPACK7,
417 AV_CODEC_ID_GSM_MS, /* as found in WAV */
423 AV_CODEC_ID_NELLYMOSER,
424 AV_CODEC_ID_MUSEPACK8,
426 AV_CODEC_ID_WMAVOICE,
428 AV_CODEC_ID_WMALOSSLESS,
437 AV_CODEC_ID_BINKAUDIO_RDFT,
438 AV_CODEC_ID_BINKAUDIO_DCT,
439 AV_CODEC_ID_AAC_LATM,
444 AV_CODEC_ID_8SVX_EXP,
445 AV_CODEC_ID_8SVX_FIB,
446 AV_CODEC_ID_BMV_AUDIO,
451 AV_CODEC_ID_COMFORT_NOISE,
453 AV_CODEC_ID_METASOUND,
454 AV_CODEC_ID_PAF_AUDIO,
458 /* subtitle codecs */
459 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
460 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
461 AV_CODEC_ID_DVB_SUBTITLE,
462 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
465 AV_CODEC_ID_MOV_TEXT,
466 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
467 AV_CODEC_ID_DVB_TELETEXT,
470 /* other specific kind of codecs (generally used for attachments) */
471 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
472 AV_CODEC_ID_TTF = 0x18000,
474 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
476 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
477 * stream (only used by libavformat) */
478 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
479 * stream (only used by libavformat) */
480 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
481 AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
485 * This struct describes the properties of a single codec described by an
487 * @see avcodec_descriptor_get()
489 typedef struct AVCodecDescriptor {
491 enum AVMediaType type;
493 * Name of the codec described by this descriptor. It is non-empty and
494 * unique for each codec descriptor. It should contain alphanumeric
495 * characters and '_' only.
499 * A more descriptive name for this codec. May be NULL.
501 const char *long_name;
503 * Codec properties, a combination of AV_CODEC_PROP_* flags.
509 * Codec uses only intra compression.
512 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
514 * Codec supports lossy compression. Audio and video codecs only.
515 * @note a codec may support both lossy and lossless
518 #define AV_CODEC_PROP_LOSSY (1 << 1)
520 * Codec supports lossless compression. Audio and video codecs only.
522 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
524 * Codec supports frame reordering. That is, the coded order (the order in which
525 * the encoded packets are output by the encoders / stored / input to the
526 * decoders) may be different from the presentation order of the corresponding
529 * For codecs that do not have this property set, PTS and DTS should always be
532 #define AV_CODEC_PROP_REORDER (1 << 3)
535 * @ingroup lavc_decoding
536 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
537 * This is mainly needed because some optimized bitstream readers read
538 * 32 or 64 bit at once and could read over the end.<br>
539 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
540 * MPEG bitstreams could cause overread and segfault.
542 #define AV_INPUT_BUFFER_PADDING_SIZE 8
545 * @ingroup lavc_encoding
546 * minimum encoding buffer size
547 * Used to avoid some checks during header writing.
549 #define AV_INPUT_BUFFER_MIN_SIZE 16384
551 #if FF_API_WITHOUT_PREFIX
553 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
555 #define FF_INPUT_BUFFER_PADDING_SIZE 8
558 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
560 #define FF_MIN_BUFFER_SIZE 16384
561 #endif /* FF_API_WITHOUT_PREFIX */
564 * @ingroup lavc_encoding
565 * motion estimation type.
566 * @deprecated use codec private option instead
568 #if FF_API_MOTION_EST
570 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
574 ME_EPZS, ///< enhanced predictive zonal search
575 ME_X1, ///< reserved for experiments
576 ME_HEX, ///< hexagon based search
577 ME_UMH, ///< uneven multi-hexagon search
578 ME_TESA, ///< transformed exhaustive search algorithm
583 * @ingroup lavc_decoding
586 /* We leave some space between them for extensions (drop some
587 * keyframes for intra-only or drop just some bidir frames). */
588 AVDISCARD_NONE =-16, ///< discard nothing
589 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
590 AVDISCARD_NONREF = 8, ///< discard all non reference
591 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
592 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
593 AVDISCARD_ALL = 48, ///< discard all
596 enum AVAudioServiceType {
597 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
598 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
599 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
600 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
601 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
602 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
603 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
604 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
605 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
606 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
610 * @ingroup lavc_encoding
612 typedef struct RcOverride{
615 int qscale; // If this is 0 then quality_factor will be used instead.
616 float quality_factor;
619 #if FF_API_MAX_BFRAMES
621 * @deprecated there is no libavcodec-wide limit on the number of B-frames
623 #define FF_MAX_B_FRAMES 16
627 These flags can be passed in AVCodecContext.flags before initialization.
628 Note: Not everything is supported yet.
632 * Allow decoders to produce frames with data planes that are not aligned
633 * to CPU requirements (e.g. due to cropping).
635 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
639 #define AV_CODEC_FLAG_QSCALE (1 << 1)
641 * 4 MV per MB allowed / advanced prediction for H.263.
643 #define AV_CODEC_FLAG_4MV (1 << 2)
645 * Output even those frames that might be corrupted.
647 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
651 #define AV_CODEC_FLAG_QPEL (1 << 4)
653 * Use internal 2pass ratecontrol in first pass mode.
655 #define AV_CODEC_FLAG_PASS1 (1 << 9)
657 * Use internal 2pass ratecontrol in second pass mode.
659 #define AV_CODEC_FLAG_PASS2 (1 << 10)
663 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
665 * Only decode/encode grayscale.
667 #define AV_CODEC_FLAG_GRAY (1 << 13)
669 * error[?] variables will be set during encoding.
671 #define AV_CODEC_FLAG_PSNR (1 << 15)
673 * Input bitstream might be truncated at a random location
674 * instead of only at frame boundaries.
676 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
678 * Use interlaced DCT.
680 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
684 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
686 * Place global headers in extradata instead of every keyframe.
688 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
690 * Use only bitexact stuff (except (I)DCT).
692 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
693 /* Fx : Flag for h263+ extra options */
695 * H.263 advanced intra coding / MPEG-4 AC prediction
697 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
699 * interlaced motion estimation
701 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
702 #define AV_CODEC_FLAG_CLOSED_GOP (1 << 31)
705 * Allow non spec compliant speedup tricks.
707 #define AV_CODEC_FLAG2_FAST (1 << 0)
709 * Skip bitstream encoding.
711 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
713 * Place global headers at every keyframe instead of in extradata.
715 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
717 * Input bitstream might be truncated at a packet boundaries
718 * instead of only at frame boundaries.
720 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
722 * Discard cropping information from SPS.
724 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
726 /* Unsupported options :
727 * Syntax Arithmetic coding (SAC)
728 * Reference Picture Selection
729 * Independent Segment Decoding */
731 /* codec capabilities */
734 * Decoder can use draw_horiz_band callback.
736 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
738 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
739 * If not set, it might not use get_buffer() at all or use operations that
740 * assume the buffer was allocated by avcodec_default_get_buffer.
742 #define AV_CODEC_CAP_DR1 (1 << 1)
743 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
745 * Encoder or decoder requires flushing with NULL input at the end in order to
746 * give the complete and correct output.
748 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
749 * with NULL data. The user can still send NULL data to the public encode
750 * or decode function, but libavcodec will not pass it along to the codec
751 * unless this flag is set.
754 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
755 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
759 * The encoder needs to be fed with NULL data at the end of encoding until the
760 * encoder no longer returns data.
762 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
763 * flag also means that the encoder must set the pts and duration for
764 * each output packet. If this flag is not set, the pts and duration will
765 * be determined by libavcodec from the input frame.
767 #define AV_CODEC_CAP_DELAY (1 << 5)
769 * Codec can be fed a final frame with a smaller size.
770 * This can be used to prevent truncation of the last audio samples.
772 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
774 * Codec can output multiple frames per AVPacket
775 * Normally demuxers return one frame at a time, demuxers which do not do
776 * are connected to a parser to split what they return into proper frames.
777 * This flag is reserved to the very rare category of codecs which have a
778 * bitstream that cannot be split into frames without timeconsuming
779 * operations like full decoding. Demuxers carring such bitstreams thus
780 * may return multiple frames in a packet. This has many disadvantages like
781 * prohibiting stream copy in many cases thus it should only be considered
784 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
786 * Codec is experimental and is thus avoided in favor of non experimental
789 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
791 * Codec should fill in channel configuration and samplerate instead of container
793 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
795 * Codec supports frame-level multithreading.
797 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
799 * Codec supports slice-based (or partition-based) multithreading.
801 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
803 * Codec supports changed parameters at any point.
805 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
807 * Codec supports avctx->thread_count == 0 (auto).
809 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
811 * Audio encoder supports receiving a different number of samples in each call.
813 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
815 #if FF_API_WITHOUT_PREFIX
817 * Allow decoders to produce frames with data planes that are not aligned
818 * to CPU requirements (e.g. due to cropping).
820 #define CODEC_FLAG_UNALIGNED 0x0001
821 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
822 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
823 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
824 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
827 * @deprecated use the "gmc" private option of the libxvid encoder
829 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
833 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
836 #define CODEC_FLAG_MV0 0x0040
838 #if FF_API_INPUT_PRESERVED
840 * @deprecated passing reference-counted frames to the encoders replaces this
843 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
845 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
846 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
847 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
850 * @deprecated edges are not used/required anymore. I.e. this flag is now always
853 #define CODEC_FLAG_EMU_EDGE 0x4000
855 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
856 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
857 location instead of only at frame boundaries. */
858 #if FF_API_NORMALIZE_AQP
860 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
863 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
865 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
866 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
867 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
868 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
869 /* Fx : Flag for h263+ extra options */
870 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
871 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
872 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
873 #define CODEC_FLAG_CLOSED_GOP 0x80000000
874 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
875 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
876 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
877 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
879 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
881 /* Unsupported options :
882 * Syntax Arithmetic coding (SAC)
883 * Reference Picture Selection
884 * Independent Segment Decoding */
886 /* codec capabilities */
888 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
890 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
891 * If not set, it might not use get_buffer() at all or use operations that
892 * assume the buffer was allocated by avcodec_default_get_buffer.
894 #define CODEC_CAP_DR1 0x0002
895 #define CODEC_CAP_TRUNCATED 0x0008
897 /* Codec can export data for HW decoding (XvMC). */
898 #define CODEC_CAP_HWACCEL 0x0010
899 #endif /* FF_API_XVMC */
901 * Encoder or decoder requires flushing with NULL input at the end in order to
902 * give the complete and correct output.
904 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
905 * with NULL data. The user can still send NULL data to the public encode
906 * or decode function, but libavcodec will not pass it along to the codec
907 * unless this flag is set.
910 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
911 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
915 * The encoder needs to be fed with NULL data at the end of encoding until the
916 * encoder no longer returns data.
918 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
919 * flag also means that the encoder must set the pts and duration for
920 * each output packet. If this flag is not set, the pts and duration will
921 * be determined by libavcodec from the input frame.
923 #define CODEC_CAP_DELAY 0x0020
925 * Codec can be fed a final frame with a smaller size.
926 * This can be used to prevent truncation of the last audio samples.
928 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
931 * Codec can export data for HW decoding (VDPAU).
933 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
936 * Codec can output multiple frames per AVPacket
937 * Normally demuxers return one frame at a time, demuxers which do not do
938 * are connected to a parser to split what they return into proper frames.
939 * This flag is reserved to the very rare category of codecs which have a
940 * bitstream that cannot be split into frames without timeconsuming
941 * operations like full decoding. Demuxers carring such bitstreams thus
942 * may return multiple frames in a packet. This has many disadvantages like
943 * prohibiting stream copy in many cases thus it should only be considered
946 #define CODEC_CAP_SUBFRAMES 0x0100
948 * Codec is experimental and is thus avoided in favor of non experimental
951 #define CODEC_CAP_EXPERIMENTAL 0x0200
953 * Codec should fill in channel configuration and samplerate instead of container
955 #define CODEC_CAP_CHANNEL_CONF 0x0400
956 #if FF_API_NEG_LINESIZES
958 * @deprecated no codecs use this capability
960 #define CODEC_CAP_NEG_LINESIZES 0x0800
963 * Codec supports frame-level multithreading.
965 #define CODEC_CAP_FRAME_THREADS 0x1000
967 * Codec supports slice-based (or partition-based) multithreading.
969 #define CODEC_CAP_SLICE_THREADS 0x2000
971 * Codec supports changed parameters at any point.
973 #define CODEC_CAP_PARAM_CHANGE 0x4000
975 * Codec supports avctx->thread_count == 0 (auto).
977 #define CODEC_CAP_AUTO_THREADS 0x8000
979 * Audio encoder supports receiving a different number of samples in each call.
981 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
982 #endif /* FF_API_WITHOUT_PREFIX */
985 //The following defines may change, don't expect compatibility if you use them.
986 #define MB_TYPE_INTRA4x4 0x0001
987 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
988 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
989 #define MB_TYPE_16x16 0x0008
990 #define MB_TYPE_16x8 0x0010
991 #define MB_TYPE_8x16 0x0020
992 #define MB_TYPE_8x8 0x0040
993 #define MB_TYPE_INTERLACED 0x0080
994 #define MB_TYPE_DIRECT2 0x0100 //FIXME
995 #define MB_TYPE_ACPRED 0x0200
996 #define MB_TYPE_GMC 0x0400
997 #define MB_TYPE_SKIP 0x0800
998 #define MB_TYPE_P0L0 0x1000
999 #define MB_TYPE_P1L0 0x2000
1000 #define MB_TYPE_P0L1 0x4000
1001 #define MB_TYPE_P1L1 0x8000
1002 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1003 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1004 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1005 #define MB_TYPE_QUANT 0x00010000
1006 #define MB_TYPE_CBP 0x00020000
1007 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
1012 * This specifies the area which should be displayed.
1013 * Note there may be multiple such areas for one frame.
1015 typedef struct AVPanScan{
1018 * - encoding: Set by user.
1019 * - decoding: Set by libavcodec.
1024 * width and height in 1/16 pel
1025 * - encoding: Set by user.
1026 * - decoding: Set by libavcodec.
1032 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1033 * - encoding: Set by user.
1034 * - decoding: Set by libavcodec.
1036 int16_t position[3][2];
1040 * This structure describes the bitrate properties of an encoded bitstream. It
1041 * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1042 * parameters for H.264/HEVC.
1044 typedef struct AVCPBProperties {
1046 * Maximum bitrate of the stream, in bits per second.
1047 * Zero if unknown or unspecified.
1051 * Minimum bitrate of the stream, in bits per second.
1052 * Zero if unknown or unspecified.
1056 * Average bitrate of the stream, in bits per second.
1057 * Zero if unknown or unspecified.
1062 * The size of the buffer to which the ratecontrol is applied, in bits.
1063 * Zero if unknown or unspecified.
1068 * The delay between the time the packet this structure is associated with
1069 * is received and the time when it should be decoded, in periods of a 27MHz
1072 * UINT64_MAX when unknown or unspecified.
1077 #if FF_API_QSCALE_TYPE
1078 #define FF_QSCALE_TYPE_MPEG1 0
1079 #define FF_QSCALE_TYPE_MPEG2 1
1080 #define FF_QSCALE_TYPE_H264 2
1081 #define FF_QSCALE_TYPE_VP56 3
1085 * The decoder will keep a reference to the frame and may reuse it later.
1087 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1090 * @defgroup lavc_packet AVPacket
1092 * Types and functions for working with AVPacket.
1095 enum AVPacketSideDataType {
1096 AV_PKT_DATA_PALETTE,
1097 AV_PKT_DATA_NEW_EXTRADATA,
1100 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1103 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1104 * s32le channel_count
1105 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1106 * u64le channel_layout
1107 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1109 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1114 AV_PKT_DATA_PARAM_CHANGE,
1117 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1118 * structures with info about macroblocks relevant to splitting the
1119 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1120 * That is, it does not necessarily contain info about all macroblocks,
1121 * as long as the distance between macroblocks in the info is smaller
1122 * than the target payload size.
1123 * Each MB info structure is 12 bytes, and is laid out as follows:
1125 * u32le bit offset from the start of the packet
1126 * u8 current quantizer at the start of the macroblock
1128 * u16le macroblock address within the GOB
1129 * u8 horizontal MV predictor
1130 * u8 vertical MV predictor
1131 * u8 horizontal MV predictor for block number 3
1132 * u8 vertical MV predictor for block number 3
1135 AV_PKT_DATA_H263_MB_INFO,
1138 * This side data should be associated with an audio stream and contains
1139 * ReplayGain information in form of the AVReplayGain struct.
1141 AV_PKT_DATA_REPLAYGAIN,
1144 * This side data contains a 3x3 transformation matrix describing an affine
1145 * transformation that needs to be applied to the decoded video frames for
1146 * correct presentation.
1148 * See libavutil/display.h for a detailed description of the data.
1150 AV_PKT_DATA_DISPLAYMATRIX,
1153 * This side data should be associated with a video stream and contains
1154 * Stereoscopic 3D information in form of the AVStereo3D struct.
1156 AV_PKT_DATA_STEREO3D,
1159 * This side data should be associated with an audio stream and corresponds
1160 * to enum AVAudioServiceType.
1162 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1165 * This side data contains an integer value representing the quality
1166 * factor of the compressed frame. Allowed range is between 1 (good)
1167 * and FF_LAMBDA_MAX (bad).
1169 AV_PKT_DATA_QUALITY_FACTOR,
1172 * This side data contains an integer value representing the stream index
1173 * of a "fallback" track. A fallback track indicates an alternate
1174 * track to use when the current track can not be decoded for some reason.
1175 * e.g. no decoder available for codec.
1177 AV_PKT_DATA_FALLBACK_TRACK,
1180 * This side data corresponds to the AVCPBProperties struct.
1182 AV_PKT_DATA_CPB_PROPERTIES,
1185 typedef struct AVPacketSideData {
1188 enum AVPacketSideDataType type;
1192 * This structure stores compressed data. It is typically exported by demuxers
1193 * and then passed as input to decoders, or received as output from encoders and
1194 * then passed to muxers.
1196 * For video, it should typically contain one compressed frame. For audio it may
1197 * contain several compressed frames. Encoders are allowed to output empty
1198 * packets, with no compressed data, containing only side data
1199 * (e.g. to update some stream parameters at the end of encoding).
1201 * AVPacket is one of the few structs in Libav, whose size is a part of public
1202 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1203 * without libavcodec and libavformat major bump.
1205 * The semantics of data ownership depends on the buf field.
1206 * If it is set, the packet data is dynamically allocated and is
1207 * valid indefinitely until a call to av_packet_unref() reduces the
1208 * reference count to 0.
1210 * If the buf field is not set av_packet_ref() would make a copy instead
1211 * of increasing the reference count.
1213 * The side data is always allocated with av_malloc(), copied by
1214 * av_packet_ref() and freed by av_packet_unref().
1216 * @see av_packet_ref
1217 * @see av_packet_unref
1219 typedef struct AVPacket {
1221 * A reference to the reference-counted buffer where the packet data is
1223 * May be NULL, then the packet data is not reference-counted.
1227 * Presentation timestamp in AVStream->time_base units; the time at which
1228 * the decompressed packet will be presented to the user.
1229 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1230 * pts MUST be larger or equal to dts as presentation cannot happen before
1231 * decompression, unless one wants to view hex dumps. Some formats misuse
1232 * the terms dts and pts/cts to mean something different. Such timestamps
1233 * must be converted to true pts/dts before they are stored in AVPacket.
1237 * Decompression timestamp in AVStream->time_base units; the time at which
1238 * the packet is decompressed.
1239 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1246 * A combination of AV_PKT_FLAG values
1250 * Additional packet data that can be provided by the container.
1251 * Packet can contain several types of side information.
1253 AVPacketSideData *side_data;
1254 int side_data_elems;
1257 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1258 * Equals next_pts - this_pts in presentation order.
1262 int64_t pos; ///< byte position in stream, -1 if unknown
1264 #if FF_API_CONVERGENCE_DURATION
1266 * @deprecated Same as the duration field, but as int64_t. This was required
1267 * for Matroska subtitles, whose duration values could overflow when the
1268 * duration field was still an int.
1270 attribute_deprecated
1271 int64_t convergence_duration;
1274 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1275 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1277 enum AVSideDataParamChangeFlags {
1278 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1279 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1280 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1281 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1287 struct AVCodecInternal;
1291 AV_FIELD_PROGRESSIVE,
1292 AV_FIELD_TT, //< Top coded_first, top displayed first
1293 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1294 AV_FIELD_TB, //< Top coded first, bottom displayed first
1295 AV_FIELD_BT, //< Bottom coded first, top displayed first
1299 * main external API structure.
1300 * New fields can be added to the end with minor version bumps.
1301 * Removal, reordering and changes to existing fields require a major
1303 * sizeof(AVCodecContext) must not be used outside libav*.
1305 typedef struct AVCodecContext {
1307 * information on struct for av_log
1308 * - set by avcodec_alloc_context3
1310 const AVClass *av_class;
1311 int log_level_offset;
1313 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1314 const struct AVCodec *codec;
1315 #if FF_API_CODEC_NAME
1317 * @deprecated this field is not used for anything in libavcodec
1319 attribute_deprecated
1320 char codec_name[32];
1322 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1325 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1326 * This is used to work around some encoder bugs.
1327 * A demuxer should set this to what is stored in the field used to identify the codec.
1328 * If there are multiple such fields in a container then the demuxer should choose the one
1329 * which maximizes the information about the used codec.
1330 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1331 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1332 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1334 * - encoding: Set by user, if not then the default based on codec_id will be used.
1335 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1337 unsigned int codec_tag;
1339 #if FF_API_STREAM_CODEC_TAG
1341 * @deprecated this field is unused
1343 attribute_deprecated
1344 unsigned int stream_codec_tag;
1350 * Private context used for internal data.
1352 * Unlike priv_data, this is not codec-specific. It is used in general
1353 * libavcodec functions.
1355 struct AVCodecInternal *internal;
1358 * Private data of the user, can be used to carry app specific stuff.
1359 * - encoding: Set by user.
1360 * - decoding: Set by user.
1365 * the average bitrate
1366 * - encoding: Set by user; unused for constant quantizer encoding.
1367 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1372 * number of bits the bitstream is allowed to diverge from the reference.
1373 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1374 * - encoding: Set by user; unused for constant quantizer encoding.
1375 * - decoding: unused
1377 int bit_rate_tolerance;
1380 * Global quality for codecs which cannot change it per frame.
1381 * This should be proportional to MPEG-1/2/4 qscale.
1382 * - encoding: Set by user.
1383 * - decoding: unused
1388 * - encoding: Set by user.
1389 * - decoding: unused
1391 int compression_level;
1392 #define FF_COMPRESSION_DEFAULT -1
1396 * - encoding: Set by user.
1397 * - decoding: Set by user.
1403 * - encoding: Set by user.
1404 * - decoding: Set by user.
1409 * some codecs need / can use extradata like Huffman tables.
1410 * mjpeg: Huffman tables
1411 * rv10: additional flags
1412 * mpeg4: global headers (they can be in the bitstream or here)
1413 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1414 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1415 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1416 * - encoding: Set/allocated/freed by libavcodec.
1417 * - decoding: Set/allocated/freed by user.
1423 * This is the fundamental unit of time (in seconds) in terms
1424 * of which frame timestamps are represented. For fixed-fps content,
1425 * timebase should be 1/framerate and timestamp increments should be
1427 * - encoding: MUST be set by user.
1428 * - decoding: the use of this field for decoding is deprecated.
1429 * Use framerate instead.
1431 AVRational time_base;
1434 * For some codecs, the time base is closer to the field rate than the frame rate.
1435 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1436 * if no telecine is used ...
1438 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1440 int ticks_per_frame;
1446 * Number of frames the decoded output will be delayed relative to the
1450 * For encoding, this field is unused (see initial_padding).
1452 * For decoding, this is the number of samples the decoder needs to
1453 * output before the decoder's output is valid. When seeking, you should
1454 * start decoding this many samples prior to your desired seek point.
1456 * - encoding: Set by libavcodec.
1457 * - decoding: Set by libavcodec.
1464 * picture width / height.
1466 * @note Those fields may not match the values of the last
1467 * AVFrame outputted by avcodec_decode_video2 due frame
1470 * - encoding: MUST be set by user.
1471 * - decoding: May be set by the user before opening the decoder if known e.g.
1472 * from the container. Some decoders will require the dimensions
1473 * to be set by the caller. During decoding, the decoder may
1474 * overwrite those values as required while parsing the data.
1479 * Bitstream width / height, may be different from width/height e.g. when
1480 * the decoded frame is cropped before being output.
1482 * @note Those field may not match the value of the last
1483 * AVFrame outputted by avcodec_decode_video2 due frame
1486 * - encoding: unused
1487 * - decoding: May be set by the user before opening the decoder if known
1488 * e.g. from the container. During decoding, the decoder may
1489 * overwrite those values as required while parsing the data.
1491 int coded_width, coded_height;
1493 #if FF_API_ASPECT_EXTENDED
1494 #define FF_ASPECT_EXTENDED 15
1498 * the number of pictures in a group of pictures, or 0 for intra_only
1499 * - encoding: Set by user.
1500 * - decoding: unused
1505 * Pixel format, see AV_PIX_FMT_xxx.
1506 * May be set by the demuxer if known from headers.
1507 * May be overriden by the decoder if it knows better.
1509 * @note This field may not match the value of the last
1510 * AVFrame outputted by avcodec_decode_video2 due frame
1513 * - encoding: Set by user.
1514 * - decoding: Set by user if known, overridden by libavcodec while
1517 enum AVPixelFormat pix_fmt;
1519 #if FF_API_MOTION_EST
1521 * This option does nothing
1522 * @deprecated use codec private options instead
1524 attribute_deprecated int me_method;
1528 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1529 * decoder to draw a horizontal band. It improves cache usage. Not
1530 * all codecs can do that. You must check the codec capabilities
1532 * When multithreading is used, it may be called from multiple threads
1533 * at the same time; threads might draw different parts of the same AVFrame,
1534 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1536 * The function is also used by hardware acceleration APIs.
1537 * It is called at least once during frame decoding to pass
1538 * the data needed for hardware render.
1539 * In that mode instead of pixel data, AVFrame points to
1540 * a structure specific to the acceleration API. The application
1541 * reads the structure and can change some fields to indicate progress
1543 * - encoding: unused
1544 * - decoding: Set by user.
1545 * @param height the height of the slice
1546 * @param y the y position of the slice
1547 * @param type 1->top field, 2->bottom field, 3->frame
1548 * @param offset offset into the AVFrame.data from which the slice should be read
1550 void (*draw_horiz_band)(struct AVCodecContext *s,
1551 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1552 int y, int type, int height);
1555 * callback to negotiate the pixelFormat
1556 * @param fmt is the list of formats which are supported by the codec,
1557 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1558 * The first is always the native one.
1559 * @note The callback may be called again immediately if initialization for
1560 * the selected (hardware-accelerated) pixel format failed.
1561 * @warning Behavior is undefined if the callback returns a value not
1562 * in the fmt list of formats.
1563 * @return the chosen format
1564 * - encoding: unused
1565 * - decoding: Set by user, if not set the native format will be chosen.
1567 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1570 * maximum number of B-frames between non-B-frames
1571 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1572 * - encoding: Set by user.
1573 * - decoding: unused
1578 * qscale factor between IP and B-frames
1579 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1580 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1581 * - encoding: Set by user.
1582 * - decoding: unused
1584 float b_quant_factor;
1586 #if FF_API_RC_STRATEGY
1587 /** @deprecated use codec private option instead */
1588 attribute_deprecated int rc_strategy;
1589 #define FF_RC_STRATEGY_XVID 1
1592 int b_frame_strategy;
1595 * qscale offset between IP and B-frames
1596 * - encoding: Set by user.
1597 * - decoding: unused
1599 float b_quant_offset;
1602 * Size of the frame reordering buffer in the decoder.
1603 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1604 * - encoding: Set by libavcodec.
1605 * - decoding: Set by libavcodec.
1610 * 0-> h263 quant 1-> mpeg quant
1611 * - encoding: Set by user.
1612 * - decoding: unused
1617 * qscale factor between P and I-frames
1618 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1619 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1620 * - encoding: Set by user.
1621 * - decoding: unused
1623 float i_quant_factor;
1626 * qscale offset between P and I-frames
1627 * - encoding: Set by user.
1628 * - decoding: unused
1630 float i_quant_offset;
1633 * luminance masking (0-> disabled)
1634 * - encoding: Set by user.
1635 * - decoding: unused
1640 * temporary complexity masking (0-> disabled)
1641 * - encoding: Set by user.
1642 * - decoding: unused
1644 float temporal_cplx_masking;
1647 * spatial complexity masking (0-> disabled)
1648 * - encoding: Set by user.
1649 * - decoding: unused
1651 float spatial_cplx_masking;
1654 * p block masking (0-> disabled)
1655 * - encoding: Set by user.
1656 * - decoding: unused
1661 * darkness masking (0-> disabled)
1662 * - encoding: Set by user.
1663 * - decoding: unused
1669 * - encoding: Set by libavcodec.
1670 * - decoding: Set by user (or 0).
1674 * prediction method (needed for huffyuv)
1675 * - encoding: Set by user.
1676 * - decoding: unused
1678 int prediction_method;
1679 #define FF_PRED_LEFT 0
1680 #define FF_PRED_PLANE 1
1681 #define FF_PRED_MEDIAN 2
1684 * slice offsets in the frame in bytes
1685 * - encoding: Set/allocated by libavcodec.
1686 * - decoding: Set/allocated by user (or NULL).
1691 * sample aspect ratio (0 if unknown)
1692 * That is the width of a pixel divided by the height of the pixel.
1693 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1694 * - encoding: Set by user.
1695 * - decoding: Set by libavcodec.
1697 AVRational sample_aspect_ratio;
1700 * motion estimation comparison function
1701 * - encoding: Set by user.
1702 * - decoding: unused
1706 * subpixel motion estimation comparison function
1707 * - encoding: Set by user.
1708 * - decoding: unused
1712 * macroblock comparison function (not supported yet)
1713 * - encoding: Set by user.
1714 * - decoding: unused
1718 * interlaced DCT comparison function
1719 * - encoding: Set by user.
1720 * - decoding: unused
1723 #define FF_CMP_SAD 0
1724 #define FF_CMP_SSE 1
1725 #define FF_CMP_SATD 2
1726 #define FF_CMP_DCT 3
1727 #define FF_CMP_PSNR 4
1728 #define FF_CMP_BIT 5
1730 #define FF_CMP_ZERO 7
1731 #define FF_CMP_VSAD 8
1732 #define FF_CMP_VSSE 9
1733 #define FF_CMP_NSSE 10
1734 #define FF_CMP_DCTMAX 13
1735 #define FF_CMP_DCT264 14
1736 #define FF_CMP_CHROMA 256
1739 * ME diamond size & shape
1740 * - encoding: Set by user.
1741 * - decoding: unused
1746 * amount of previous MV predictors (2a+1 x 2a+1 square)
1747 * - encoding: Set by user.
1748 * - decoding: unused
1750 int last_predictor_count;
1753 * prepass for motion estimation
1754 * - encoding: Set by user.
1755 * - decoding: unused
1760 * motion estimation prepass comparison function
1761 * - encoding: Set by user.
1762 * - decoding: unused
1767 * ME prepass diamond size & shape
1768 * - encoding: Set by user.
1769 * - decoding: unused
1775 * - encoding: Set by user.
1776 * - decoding: unused
1778 int me_subpel_quality;
1782 * DTG active format information (additional aspect ratio
1783 * information only used in DVB MPEG-2 transport streams)
1786 * - encoding: unused
1787 * - decoding: Set by decoder.
1788 * @deprecated Deprecated in favor of AVSideData
1790 attribute_deprecated int dtg_active_format;
1791 #define FF_DTG_AFD_SAME 8
1792 #define FF_DTG_AFD_4_3 9
1793 #define FF_DTG_AFD_16_9 10
1794 #define FF_DTG_AFD_14_9 11
1795 #define FF_DTG_AFD_4_3_SP_14_9 13
1796 #define FF_DTG_AFD_16_9_SP_14_9 14
1797 #define FF_DTG_AFD_SP_4_3 15
1798 #endif /* FF_API_AFD */
1801 * maximum motion estimation search range in subpel units
1802 * If 0 then no limit.
1804 * - encoding: Set by user.
1805 * - decoding: unused
1809 #if FF_API_QUANT_BIAS
1811 * @deprecated use encoder private option instead
1813 attribute_deprecated int intra_quant_bias;
1814 #define FF_DEFAULT_QUANT_BIAS 999999
1817 * @deprecated use encoder private option instead
1819 attribute_deprecated int inter_quant_bias;
1824 * - encoding: unused
1825 * - decoding: Set by user.
1828 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1829 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1830 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1834 * XVideo Motion Acceleration
1835 * - encoding: forbidden
1836 * - decoding: set by decoder
1837 * @deprecated XvMC support is slated for removal.
1839 attribute_deprecated int xvmc_acceleration;
1840 #endif /* FF_API_XVMC */
1843 * macroblock decision mode
1844 * - encoding: Set by user.
1845 * - decoding: unused
1848 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1849 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1850 #define FF_MB_DECISION_RD 2 ///< rate distortion
1853 * custom intra quantization matrix
1854 * - encoding: Set by user, can be NULL.
1855 * - decoding: Set by libavcodec.
1857 uint16_t *intra_matrix;
1860 * custom inter quantization matrix
1861 * - encoding: Set by user, can be NULL.
1862 * - decoding: Set by libavcodec.
1864 uint16_t *inter_matrix;
1867 * scene change detection threshold
1868 * 0 is default, larger means fewer detected scene changes.
1869 * - encoding: Set by user.
1870 * - decoding: unused
1872 int scenechange_threshold;
1875 * noise reduction strength
1876 * - encoding: Set by user.
1877 * - decoding: unused
1879 int noise_reduction;
1883 * @deprecated this field is unused
1885 attribute_deprecated
1889 * @deprecated this field is unused
1891 attribute_deprecated
1896 * precision of the intra DC coefficient - 8
1897 * - encoding: Set by user.
1898 * - decoding: unused
1900 int intra_dc_precision;
1903 * Number of macroblock rows at the top which are skipped.
1904 * - encoding: unused
1905 * - decoding: Set by user.
1910 * Number of macroblock rows at the bottom which are skipped.
1911 * - encoding: unused
1912 * - decoding: Set by user.
1918 * @deprecated use encoder private options instead
1920 attribute_deprecated
1921 float border_masking;
1925 * minimum MB lagrange multipler
1926 * - encoding: Set by user.
1927 * - decoding: unused
1932 * maximum MB lagrange multipler
1933 * - encoding: Set by user.
1934 * - decoding: unused
1940 * - encoding: Set by user.
1941 * - decoding: unused
1943 int me_penalty_compensation;
1947 * - encoding: Set by user.
1948 * - decoding: unused
1954 * - encoding: Set by user.
1955 * - decoding: unused
1961 * - encoding: Set by user.
1962 * - decoding: unused
1967 * number of reference frames
1968 * - encoding: Set by user.
1969 * - decoding: Set by lavc.
1974 * chroma qp offset from luma
1975 * - encoding: Set by user.
1976 * - decoding: unused
1980 #if FF_API_UNUSED_MEMBERS
1982 * Multiplied by qscale for each frame and added to scene_change_score.
1983 * - encoding: Set by user.
1984 * - decoding: unused
1986 attribute_deprecated int scenechange_factor;
1991 * Note: Value depends upon the compare function used for fullpel ME.
1992 * - encoding: Set by user.
1993 * - decoding: unused
1998 * Adjust sensitivity of b_frame_strategy 1.
1999 * - encoding: Set by user.
2000 * - decoding: unused
2005 * Chromaticity coordinates of the source primaries.
2006 * - encoding: Set by user
2007 * - decoding: Set by libavcodec
2009 enum AVColorPrimaries color_primaries;
2012 * Color Transfer Characteristic.
2013 * - encoding: Set by user
2014 * - decoding: Set by libavcodec
2016 enum AVColorTransferCharacteristic color_trc;
2019 * YUV colorspace type.
2020 * - encoding: Set by user
2021 * - decoding: Set by libavcodec
2023 enum AVColorSpace colorspace;
2026 * MPEG vs JPEG YUV range.
2027 * - encoding: Set by user
2028 * - decoding: Set by libavcodec
2030 enum AVColorRange color_range;
2033 * This defines the location of chroma samples.
2034 * - encoding: Set by user
2035 * - decoding: Set by libavcodec
2037 enum AVChromaLocation chroma_sample_location;
2041 * Indicates number of picture subdivisions. Used for parallelized
2043 * - encoding: Set by user
2044 * - decoding: unused
2049 * - encoding: set by libavcodec
2050 * - decoding: Set by libavcodec
2052 enum AVFieldOrder field_order;
2055 int sample_rate; ///< samples per second
2056 int channels; ///< number of audio channels
2059 * audio sample format
2060 * - encoding: Set by user.
2061 * - decoding: Set by libavcodec.
2063 enum AVSampleFormat sample_fmt; ///< sample format
2065 /* The following data should not be initialized. */
2067 * Number of samples per channel in an audio frame.
2069 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2070 * except the last must contain exactly frame_size samples per channel.
2071 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2072 * frame size is not restricted.
2073 * - decoding: may be set by some decoders to indicate constant frame size
2078 * Frame counter, set by libavcodec.
2080 * - decoding: total number of frames returned from the decoder so far.
2081 * - encoding: total number of frames passed to the encoder so far.
2083 * @note the counter is not incremented if encoding/decoding resulted in
2089 * number of bytes per packet if constant and known or 0
2090 * Used by some WAV based audio codecs.
2095 * Audio cutoff bandwidth (0 means "automatic")
2096 * - encoding: Set by user.
2097 * - decoding: unused
2102 * Audio channel layout.
2103 * - encoding: set by user.
2104 * - decoding: set by libavcodec.
2106 uint64_t channel_layout;
2109 * Request decoder to use this channel layout if it can (0 for default)
2110 * - encoding: unused
2111 * - decoding: Set by user.
2113 uint64_t request_channel_layout;
2116 * Type of service that the audio stream conveys.
2117 * - encoding: Set by user.
2118 * - decoding: Set by libavcodec.
2120 enum AVAudioServiceType audio_service_type;
2123 * Used to request a sample format from the decoder.
2124 * - encoding: unused.
2125 * - decoding: Set by user.
2127 enum AVSampleFormat request_sample_fmt;
2130 * This callback is called at the beginning of each frame to get data
2131 * buffer(s) for it. There may be one contiguous buffer for all the data or
2132 * there may be a buffer per each data plane or anything in between. What
2133 * this means is, you may set however many entries in buf[] you feel necessary.
2134 * Each buffer must be reference-counted using the AVBuffer API (see description
2137 * The following fields will be set in the frame before this callback is
2140 * - width, height (video only)
2141 * - sample_rate, channel_layout, nb_samples (audio only)
2142 * Their values may differ from the corresponding values in
2143 * AVCodecContext. This callback must use the frame values, not the codec
2144 * context values, to calculate the required buffer size.
2146 * This callback must fill the following fields in the frame:
2150 * * if the data is planar audio with more than 8 channels, then this
2151 * callback must allocate and fill extended_data to contain all pointers
2152 * to all data planes. data[] must hold as many pointers as it can.
2153 * extended_data must be allocated with av_malloc() and will be freed in
2155 * * otherwise exended_data must point to data
2156 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2157 * the frame's data and extended_data pointers must be contained in these. That
2158 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2159 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2160 * and av_buffer_ref().
2161 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2162 * this callback and filled with the extra buffers if there are more
2163 * buffers than buf[] can hold. extended_buf will be freed in
2166 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2167 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2170 * Each data plane must be aligned to the maximum required by the target
2173 * @see avcodec_default_get_buffer2()
2177 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2178 * (read and/or written to if it is writable) later by libavcodec.
2180 * avcodec_align_dimensions2() should be used to find the required width and
2181 * height, as they normally need to be rounded up to the next multiple of 16.
2183 * If frame multithreading is used and thread_safe_callbacks is set,
2184 * this callback may be called from a different thread, but not from more
2185 * than one at once. Does not need to be reentrant.
2187 * @see avcodec_align_dimensions2()
2191 * Decoders request a buffer of a particular size by setting
2192 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2193 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2194 * to a smaller value in the output frame.
2196 * As a convenience, av_samples_get_buffer_size() and
2197 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2198 * functions to find the required data size and to fill data pointers and
2199 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2200 * since all planes must be the same size.
2202 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2204 * - encoding: unused
2205 * - decoding: Set by libavcodec, user can override.
2207 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2210 * If non-zero, the decoded audio and video frames returned from
2211 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2212 * and are valid indefinitely. The caller must free them with
2213 * av_frame_unref() when they are not needed anymore.
2214 * Otherwise, the decoded frames must not be freed by the caller and are
2215 * only valid until the next decode call.
2217 * - encoding: unused
2218 * - decoding: set by the caller before avcodec_open2().
2220 int refcounted_frames;
2222 /* - encoding parameters */
2223 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2224 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2228 * - encoding: Set by user.
2229 * - decoding: unused
2235 * - encoding: Set by user.
2236 * - decoding: unused
2241 * maximum quantizer difference between frames
2242 * - encoding: Set by user.
2243 * - decoding: unused
2249 * @deprecated use encoder private options instead
2251 attribute_deprecated
2254 attribute_deprecated
2256 attribute_deprecated
2261 * decoder bitstream buffer size
2262 * - encoding: Set by user.
2263 * - decoding: unused
2268 * ratecontrol override, see RcOverride
2269 * - encoding: Allocated/set/freed by user.
2270 * - decoding: unused
2272 int rc_override_count;
2273 RcOverride *rc_override;
2277 * @deprecated use encoder private options instead
2279 attribute_deprecated
2285 * - encoding: Set by user.
2286 * - decoding: unused
2292 * - encoding: Set by user.
2293 * - decoding: unused
2299 * @deprecated use encoder private options instead
2301 attribute_deprecated
2302 float rc_buffer_aggressivity;
2304 attribute_deprecated
2305 float rc_initial_cplx;
2309 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2310 * - encoding: Set by user.
2311 * - decoding: unused.
2313 float rc_max_available_vbv_use;
2316 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2317 * - encoding: Set by user.
2318 * - decoding: unused.
2320 float rc_min_vbv_overflow_use;
2323 * Number of bits which should be loaded into the rc buffer before decoding starts.
2324 * - encoding: Set by user.
2325 * - decoding: unused
2327 int rc_initial_buffer_occupancy;
2329 #if FF_API_CODER_TYPE
2330 #define FF_CODER_TYPE_VLC 0
2331 #define FF_CODER_TYPE_AC 1
2332 #define FF_CODER_TYPE_RAW 2
2333 #define FF_CODER_TYPE_RLE 3
2334 #if FF_API_UNUSED_MEMBERS
2335 #define FF_CODER_TYPE_DEFLATE 4
2336 #endif /* FF_API_UNUSED_MEMBERS */
2338 * @deprecated use encoder private options instead
2340 attribute_deprecated
2342 #endif /* FF_API_CODER_TYPE */
2346 * - encoding: Set by user.
2347 * - decoding: unused
2353 * @deprecated use encoder private options instead
2355 attribute_deprecated
2359 * @deprecated use encoder private options instead
2361 attribute_deprecated
2366 * frame skip threshold
2367 * - encoding: Set by user.
2368 * - decoding: unused
2370 int frame_skip_threshold;
2374 * - encoding: Set by user.
2375 * - decoding: unused
2377 int frame_skip_factor;
2380 * frame skip exponent
2381 * - encoding: Set by user.
2382 * - decoding: unused
2387 * frame skip comparison function
2388 * - encoding: Set by user.
2389 * - decoding: unused
2394 * trellis RD quantization
2395 * - encoding: Set by user.
2396 * - decoding: unused
2401 * - encoding: Set by user.
2402 * - decoding: unused
2404 int min_prediction_order;
2407 * - encoding: Set by user.
2408 * - decoding: unused
2410 int max_prediction_order;
2413 * GOP timecode frame start number, in non drop frame format
2414 * - encoding: Set by user.
2415 * - decoding: unused
2417 int64_t timecode_frame_start;
2419 #if FF_API_RTP_CALLBACK
2421 * @deprecated unused
2423 /* The RTP callback: This function is called */
2424 /* every time the encoder has a packet to send. */
2425 /* It depends on the encoder if the data starts */
2426 /* with a Start Code (it should). H.263 does. */
2427 /* mb_nb contains the number of macroblocks */
2428 /* encoded in the RTP payload. */
2429 attribute_deprecated
2430 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2433 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2434 /* do its best to deliver a chunk with size */
2435 /* below rtp_payload_size, the chunk will start */
2436 /* with a start code on some codecs like H.263. */
2437 /* This doesn't take account of any particular */
2438 /* headers inside the transmitted RTP payload. */
2440 /* statistics, used for 2-pass encoding */
2451 * number of bits used for the previously encoded frame
2452 * - encoding: Set by libavcodec.
2453 * - decoding: unused
2458 * pass1 encoding statistics output buffer
2459 * - encoding: Set by libavcodec.
2460 * - decoding: unused
2465 * pass2 encoding statistics input buffer
2466 * Concatenated stuff from stats_out of pass1 should be placed here.
2467 * - encoding: Allocated/set/freed by user.
2468 * - decoding: unused
2473 * Work around bugs in encoders which sometimes cannot be detected automatically.
2474 * - encoding: Set by user
2475 * - decoding: Set by user
2477 int workaround_bugs;
2478 #define FF_BUG_AUTODETECT 1 ///< autodetection
2479 #if FF_API_OLD_MSMPEG4
2480 #define FF_BUG_OLD_MSMPEG4 2
2482 #define FF_BUG_XVID_ILACE 4
2483 #define FF_BUG_UMP4 8
2484 #define FF_BUG_NO_PADDING 16
2485 #define FF_BUG_AMV 32
2487 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2489 #define FF_BUG_QPEL_CHROMA 64
2490 #define FF_BUG_STD_QPEL 128
2491 #define FF_BUG_QPEL_CHROMA2 256
2492 #define FF_BUG_DIRECT_BLOCKSIZE 512
2493 #define FF_BUG_EDGE 1024
2494 #define FF_BUG_HPEL_CHROMA 2048
2495 #define FF_BUG_DC_CLIP 4096
2496 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2497 #define FF_BUG_TRUNCATED 16384
2500 * strictly follow the standard (MPEG4, ...).
2501 * - encoding: Set by user.
2502 * - decoding: Set by user.
2503 * Setting this to STRICT or higher means the encoder and decoder will
2504 * generally do stupid things, whereas setting it to unofficial or lower
2505 * will mean the encoder might produce output that is not supported by all
2506 * spec-compliant decoders. Decoders don't differentiate between normal,
2507 * unofficial and experimental (that is, they always try to decode things
2508 * when they can) unless they are explicitly asked to behave stupidly
2509 * (=strictly conform to the specs)
2511 int strict_std_compliance;
2512 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2513 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2514 #define FF_COMPLIANCE_NORMAL 0
2515 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2516 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2519 * error concealment flags
2520 * - encoding: unused
2521 * - decoding: Set by user.
2523 int error_concealment;
2524 #define FF_EC_GUESS_MVS 1
2525 #define FF_EC_DEBLOCK 2
2529 * - encoding: Set by user.
2530 * - decoding: Set by user.
2533 #define FF_DEBUG_PICT_INFO 1
2534 #define FF_DEBUG_RC 2
2535 #define FF_DEBUG_BITSTREAM 4
2536 #define FF_DEBUG_MB_TYPE 8
2537 #define FF_DEBUG_QP 16
2540 * @deprecated this option does nothing
2542 #define FF_DEBUG_MV 32
2544 #define FF_DEBUG_DCT_COEFF 0x00000040
2545 #define FF_DEBUG_SKIP 0x00000080
2546 #define FF_DEBUG_STARTCODE 0x00000100
2547 #if FF_API_UNUSED_MEMBERS
2548 #define FF_DEBUG_PTS 0x00000200
2549 #endif /* FF_API_UNUSED_MEMBERS */
2550 #define FF_DEBUG_ER 0x00000400
2551 #define FF_DEBUG_MMCO 0x00000800
2552 #define FF_DEBUG_BUGS 0x00001000
2554 #define FF_DEBUG_VIS_QP 0x00002000
2555 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2557 #define FF_DEBUG_BUFFERS 0x00008000
2558 #define FF_DEBUG_THREADS 0x00010000
2562 * @deprecated this option does not have any effect
2564 attribute_deprecated
2566 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2567 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2568 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2572 * Error recognition; may misdetect some more or less valid parts as errors.
2573 * - encoding: unused
2574 * - decoding: Set by user.
2576 int err_recognition;
2579 * Verify checksums embedded in the bitstream (could be of either encoded or
2580 * decoded data, depending on the codec) and print an error message on mismatch.
2581 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2582 * decoder returning an error.
2584 #define AV_EF_CRCCHECK (1<<0)
2585 #define AV_EF_BITSTREAM (1<<1)
2586 #define AV_EF_BUFFER (1<<2)
2587 #define AV_EF_EXPLODE (1<<3)
2590 * opaque 64bit number (generally a PTS) that will be reordered and
2591 * output in AVFrame.reordered_opaque
2592 * - encoding: unused
2593 * - decoding: Set by user.
2595 int64_t reordered_opaque;
2598 * Hardware accelerator in use
2599 * - encoding: unused.
2600 * - decoding: Set by libavcodec
2602 struct AVHWAccel *hwaccel;
2605 * Hardware accelerator context.
2606 * For some hardware accelerators, a global context needs to be
2607 * provided by the user. In that case, this holds display-dependent
2608 * data Libav cannot instantiate itself. Please refer to the
2609 * Libav HW accelerator documentation to know how to fill this
2610 * is. e.g. for VA API, this is a struct vaapi_context.
2611 * - encoding: unused
2612 * - decoding: Set by user
2614 void *hwaccel_context;
2618 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2619 * - decoding: unused
2621 uint64_t error[AV_NUM_DATA_POINTERS];
2624 * DCT algorithm, see FF_DCT_* below
2625 * - encoding: Set by user.
2626 * - decoding: unused
2629 #define FF_DCT_AUTO 0
2630 #define FF_DCT_FASTINT 1
2631 #define FF_DCT_INT 2
2632 #define FF_DCT_MMX 3
2633 #define FF_DCT_ALTIVEC 5
2634 #define FF_DCT_FAAN 6
2637 * IDCT algorithm, see FF_IDCT_* below.
2638 * - encoding: Set by user.
2639 * - decoding: Set by user.
2642 #define FF_IDCT_AUTO 0
2643 #define FF_IDCT_INT 1
2644 #define FF_IDCT_SIMPLE 2
2645 #define FF_IDCT_SIMPLEMMX 3
2646 #define FF_IDCT_ARM 7
2647 #define FF_IDCT_ALTIVEC 8
2649 #define FF_IDCT_SH4 9
2651 #define FF_IDCT_SIMPLEARM 10
2652 #if FF_API_UNUSED_MEMBERS
2653 #define FF_IDCT_IPP 13
2654 #endif /* FF_API_UNUSED_MEMBERS */
2655 #define FF_IDCT_XVID 14
2656 #if FF_API_IDCT_XVIDMMX
2657 #define FF_IDCT_XVIDMMX 14
2658 #endif /* FF_API_IDCT_XVIDMMX */
2659 #define FF_IDCT_SIMPLEARMV5TE 16
2660 #define FF_IDCT_SIMPLEARMV6 17
2661 #if FF_API_ARCH_SPARC
2662 #define FF_IDCT_SIMPLEVIS 18
2664 #define FF_IDCT_FAAN 20
2665 #define FF_IDCT_SIMPLENEON 22
2666 #if FF_API_ARCH_ALPHA
2667 #define FF_IDCT_SIMPLEALPHA 23
2671 * bits per sample/pixel from the demuxer (needed for huffyuv).
2672 * - encoding: Set by libavcodec.
2673 * - decoding: Set by user.
2675 int bits_per_coded_sample;
2678 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2679 * - encoding: set by user.
2680 * - decoding: set by libavcodec.
2682 int bits_per_raw_sample;
2686 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2687 * - encoding: unused
2688 * - decoding: Set by user.
2690 * @deprecated use decoder private options instead
2692 attribute_deprecated int lowres;
2695 #if FF_API_CODED_FRAME
2697 * the picture in the bitstream
2698 * - encoding: Set by libavcodec.
2699 * - decoding: unused
2701 * @deprecated use the quality factor packet side data instead
2703 attribute_deprecated AVFrame *coded_frame;
2708 * is used to decide how many independent tasks should be passed to execute()
2709 * - encoding: Set by user.
2710 * - decoding: Set by user.
2715 * Which multithreading methods to use.
2716 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2717 * so clients which cannot provide future frames should not use it.
2719 * - encoding: Set by user, otherwise the default is used.
2720 * - decoding: Set by user, otherwise the default is used.
2723 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2724 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2727 * Which multithreading methods are in use by the codec.
2728 * - encoding: Set by libavcodec.
2729 * - decoding: Set by libavcodec.
2731 int active_thread_type;
2734 * Set by the client if its custom get_buffer() callback can be called
2735 * synchronously from another thread, which allows faster multithreaded decoding.
2736 * draw_horiz_band() will be called from other threads regardless of this setting.
2737 * Ignored if the default get_buffer() is used.
2738 * - encoding: Set by user.
2739 * - decoding: Set by user.
2741 int thread_safe_callbacks;
2744 * The codec may call this to execute several independent things.
2745 * It will return only after finishing all tasks.
2746 * The user may replace this with some multithreaded implementation,
2747 * the default implementation will execute the parts serially.
2748 * @param count the number of things to execute
2749 * - encoding: Set by libavcodec, user can override.
2750 * - decoding: Set by libavcodec, user can override.
2752 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2755 * The codec may call this to execute several independent things.
2756 * It will return only after finishing all tasks.
2757 * The user may replace this with some multithreaded implementation,
2758 * the default implementation will execute the parts serially.
2759 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2760 * @param c context passed also to func
2761 * @param count the number of things to execute
2762 * @param arg2 argument passed unchanged to func
2763 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2764 * @param func function that will be called count times, with jobnr from 0 to count-1.
2765 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2766 * two instances of func executing at the same time will have the same threadnr.
2767 * @return always 0 currently, but code should handle a future improvement where when any call to func
2768 * returns < 0 no further calls to func may be done and < 0 is returned.
2769 * - encoding: Set by libavcodec, user can override.
2770 * - decoding: Set by libavcodec, user can override.
2772 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2775 * noise vs. sse weight for the nsse comparsion function
2776 * - encoding: Set by user.
2777 * - decoding: unused
2783 * - encoding: Set by user.
2784 * - decoding: Set by libavcodec.
2787 #define FF_PROFILE_UNKNOWN -99
2788 #define FF_PROFILE_RESERVED -100
2790 #define FF_PROFILE_AAC_MAIN 0
2791 #define FF_PROFILE_AAC_LOW 1
2792 #define FF_PROFILE_AAC_SSR 2
2793 #define FF_PROFILE_AAC_LTP 3
2794 #define FF_PROFILE_AAC_HE 4
2795 #define FF_PROFILE_AAC_HE_V2 28
2796 #define FF_PROFILE_AAC_LD 22
2797 #define FF_PROFILE_AAC_ELD 38
2798 #define FF_PROFILE_MPEG2_AAC_LOW 128
2799 #define FF_PROFILE_MPEG2_AAC_HE 131
2801 #define FF_PROFILE_DTS 20
2802 #define FF_PROFILE_DTS_ES 30
2803 #define FF_PROFILE_DTS_96_24 40
2804 #define FF_PROFILE_DTS_HD_HRA 50
2805 #define FF_PROFILE_DTS_HD_MA 60
2806 #define FF_PROFILE_DTS_EXPRESS 70
2808 #define FF_PROFILE_MPEG2_422 0
2809 #define FF_PROFILE_MPEG2_HIGH 1
2810 #define FF_PROFILE_MPEG2_SS 2
2811 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2812 #define FF_PROFILE_MPEG2_MAIN 4
2813 #define FF_PROFILE_MPEG2_SIMPLE 5
2815 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2816 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2818 #define FF_PROFILE_H264_BASELINE 66
2819 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2820 #define FF_PROFILE_H264_MAIN 77
2821 #define FF_PROFILE_H264_EXTENDED 88
2822 #define FF_PROFILE_H264_HIGH 100
2823 #define FF_PROFILE_H264_HIGH_10 110
2824 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2825 #define FF_PROFILE_H264_HIGH_422 122
2826 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2827 #define FF_PROFILE_H264_HIGH_444 144
2828 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2829 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2830 #define FF_PROFILE_H264_CAVLC_444 44
2832 #define FF_PROFILE_VC1_SIMPLE 0
2833 #define FF_PROFILE_VC1_MAIN 1
2834 #define FF_PROFILE_VC1_COMPLEX 2
2835 #define FF_PROFILE_VC1_ADVANCED 3
2837 #define FF_PROFILE_MPEG4_SIMPLE 0
2838 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2839 #define FF_PROFILE_MPEG4_CORE 2
2840 #define FF_PROFILE_MPEG4_MAIN 3
2841 #define FF_PROFILE_MPEG4_N_BIT 4
2842 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2843 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2844 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2845 #define FF_PROFILE_MPEG4_HYBRID 8
2846 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2847 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2848 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2849 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2850 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2851 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2852 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2854 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2855 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2856 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2857 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2858 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2860 #define FF_PROFILE_VP9_0 0
2861 #define FF_PROFILE_VP9_1 1
2862 #define FF_PROFILE_VP9_2 2
2863 #define FF_PROFILE_VP9_3 3
2865 #define FF_PROFILE_HEVC_MAIN 1
2866 #define FF_PROFILE_HEVC_MAIN_10 2
2867 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2871 * - encoding: Set by user.
2872 * - decoding: Set by libavcodec.
2875 #define FF_LEVEL_UNKNOWN -99
2879 * - encoding: unused
2880 * - decoding: Set by user.
2882 enum AVDiscard skip_loop_filter;
2886 * - encoding: unused
2887 * - decoding: Set by user.
2889 enum AVDiscard skip_idct;
2893 * - encoding: unused
2894 * - decoding: Set by user.
2896 enum AVDiscard skip_frame;
2899 * Header containing style information for text subtitles.
2900 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2901 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2902 * the Format line following. It shouldn't include any Dialogue line.
2903 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2904 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2906 uint8_t *subtitle_header;
2907 int subtitle_header_size;
2909 #if FF_API_ERROR_RATE
2911 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2914 attribute_deprecated
2918 #if FF_API_VBV_DELAY
2920 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2921 * Used for compliant TS muxing.
2922 * - encoding: Set by libavcodec.
2923 * - decoding: unused.
2924 * @deprecated this value is now exported as a part of
2925 * AV_PKT_DATA_CPB_PROPERTIES packet side data
2927 attribute_deprecated
2931 #if FF_API_SIDEDATA_ONLY_PKT
2933 * Encoding only and set by default. Allow encoders to output packets
2934 * that do not contain any encoded data, only side data.
2936 * Some encoders need to output such packets, e.g. to update some stream
2937 * parameters at the end of encoding.
2939 * @deprecated this field disables the default behaviour and
2940 * it is kept only for compatibility.
2942 attribute_deprecated
2943 int side_data_only_packets;
2947 * Audio only. The number of "priming" samples (padding) inserted by the
2948 * encoder at the beginning of the audio. I.e. this number of leading
2949 * decoded samples must be discarded by the caller to get the original audio
2950 * without leading padding.
2952 * - decoding: unused
2953 * - encoding: Set by libavcodec. The timestamps on the output packets are
2954 * adjusted by the encoder so that they always refer to the
2955 * first sample of the data actually contained in the packet,
2956 * including any added padding. E.g. if the timebase is
2957 * 1/samplerate and the timestamp of the first input sample is
2958 * 0, the timestamp of the first output packet will be
2961 int initial_padding;
2964 * - decoding: For codecs that store a framerate value in the compressed
2965 * bitstream, the decoder may export it here. { 0, 1} when
2967 * - encoding: unused
2969 AVRational framerate;
2972 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2973 * - encoding: unused.
2974 * - decoding: Set by libavcodec before calling get_format()
2976 enum AVPixelFormat sw_pix_fmt;
2979 * Additional data associated with the entire coded stream.
2981 * - decoding: unused
2982 * - encoding: may be set by libavcodec after avcodec_open2().
2984 AVPacketSideData *coded_side_data;
2985 int nb_coded_side_data;
2992 typedef struct AVProfile {
2994 const char *name; ///< short name for the profile
2997 typedef struct AVCodecDefault AVCodecDefault;
3004 typedef struct AVCodec {
3006 * Name of the codec implementation.
3007 * The name is globally unique among encoders and among decoders (but an
3008 * encoder and a decoder can share the same name).
3009 * This is the primary way to find a codec from the user perspective.
3013 * Descriptive name for the codec, meant to be more human readable than name.
3014 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3016 const char *long_name;
3017 enum AVMediaType type;
3020 * Codec capabilities.
3021 * see AV_CODEC_CAP_*
3024 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3025 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3026 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3027 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3028 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3030 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3032 const AVClass *priv_class; ///< AVClass for the private context
3033 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3035 /*****************************************************************
3036 * No fields below this line are part of the public API. They
3037 * may not be used outside of libavcodec and can be changed and
3039 * New public fields should be added right above.
3040 *****************************************************************
3043 struct AVCodec *next;
3045 * @name Frame-level threading support functions
3049 * If defined, called on thread contexts when they are created.
3050 * If the codec allocates writable tables in init(), re-allocate them here.
3051 * priv_data will be set to a copy of the original.
3053 int (*init_thread_copy)(AVCodecContext *);
3055 * Copy necessary context variables from a previous thread context to the current one.
3056 * If not defined, the next thread will start automatically; otherwise, the codec
3057 * must call ff_thread_finish_setup().
3059 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3061 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3065 * Private codec-specific defaults.
3067 const AVCodecDefault *defaults;
3070 * Initialize codec static data, called from avcodec_register().
3072 void (*init_static_data)(struct AVCodec *codec);
3074 int (*init)(AVCodecContext *);
3075 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3076 const struct AVSubtitle *sub);
3078 * Encode data to an AVPacket.
3080 * @param avctx codec context
3081 * @param avpkt output AVPacket (may contain a user-provided buffer)
3082 * @param[in] frame AVFrame containing the raw data to be encoded
3083 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3084 * non-empty packet was returned in avpkt.
3085 * @return 0 on success, negative error code on failure
3087 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3088 int *got_packet_ptr);
3089 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3090 int (*close)(AVCodecContext *);
3093 * Will be called when seeking
3095 void (*flush)(AVCodecContext *);
3097 * Internal codec capabilities.
3098 * See FF_CODEC_CAP_* in internal.h
3104 * @defgroup lavc_hwaccel AVHWAccel
3107 typedef struct AVHWAccel {
3109 * Name of the hardware accelerated codec.
3110 * The name is globally unique among encoders and among decoders (but an
3111 * encoder and a decoder can share the same name).
3116 * Type of codec implemented by the hardware accelerator.
3118 * See AVMEDIA_TYPE_xxx
3120 enum AVMediaType type;
3123 * Codec implemented by the hardware accelerator.
3125 * See AV_CODEC_ID_xxx
3130 * Supported pixel format.
3132 * Only hardware accelerated formats are supported here.
3134 enum AVPixelFormat pix_fmt;
3137 * Hardware accelerated codec capabilities.
3138 * see FF_HWACCEL_CODEC_CAP_*
3142 /*****************************************************************
3143 * No fields below this line are part of the public API. They
3144 * may not be used outside of libavcodec and can be changed and
3146 * New public fields should be added right above.
3147 *****************************************************************
3149 struct AVHWAccel *next;
3152 * Allocate a custom buffer
3154 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3157 * Called at the beginning of each frame or field picture.
3159 * Meaningful frame information (codec specific) is guaranteed to
3160 * be parsed at this point. This function is mandatory.
3162 * Note that buf can be NULL along with buf_size set to 0.
3163 * Otherwise, this means the whole frame is available at this point.
3165 * @param avctx the codec context
3166 * @param buf the frame data buffer base
3167 * @param buf_size the size of the frame in bytes
3168 * @return zero if successful, a negative value otherwise
3170 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3173 * Callback for each slice.
3175 * Meaningful slice information (codec specific) is guaranteed to
3176 * be parsed at this point. This function is mandatory.
3178 * @param avctx the codec context
3179 * @param buf the slice data buffer base
3180 * @param buf_size the size of the slice in bytes
3181 * @return zero if successful, a negative value otherwise
3183 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3186 * Called at the end of each frame or field picture.
3188 * The whole picture is parsed at this point and can now be sent
3189 * to the hardware accelerator. This function is mandatory.
3191 * @param avctx the codec context
3192 * @return zero if successful, a negative value otherwise
3194 int (*end_frame)(AVCodecContext *avctx);
3197 * Size of per-frame hardware accelerator private data.
3199 * Private data is allocated with av_mallocz() before
3200 * AVCodecContext.get_buffer() and deallocated after
3201 * AVCodecContext.release_buffer().
3203 int frame_priv_data_size;
3206 * Initialize the hwaccel private data.
3208 * This will be called from ff_get_format(), after hwaccel and
3209 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3212 int (*init)(AVCodecContext *avctx);
3215 * Uninitialize the hwaccel private data.
3217 * This will be called from get_format() or avcodec_close(), after hwaccel
3218 * and hwaccel_context are already uninitialized.
3220 int (*uninit)(AVCodecContext *avctx);
3223 * Size of the private data to allocate in
3224 * AVCodecInternal.hwaccel_priv_data.
3230 * Hardware acceleration should be used for decoding even if the codec level
3231 * used is unknown or higher than the maximum supported level reported by the
3234 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3237 * Hardware acceleration can output YUV pixel formats with a different chroma
3238 * sampling than 4:2:0 and/or other than 8 bits per component.
3240 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3246 #if FF_API_AVPICTURE
3248 * @defgroup lavc_picture AVPicture
3250 * Functions for working with AVPicture
3255 * four components are given, that's all.
3256 * the last component is alpha
3257 * @deprecated Use the imgutils functions
3259 typedef struct AVPicture {
3260 attribute_deprecated
3261 uint8_t *data[AV_NUM_DATA_POINTERS];
3262 attribute_deprecated
3263 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3271 #define AVPALETTE_SIZE 1024
3272 #define AVPALETTE_COUNT 256
3274 enum AVSubtitleType {
3277 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3280 * Plain text, the text field must be set by the decoder and is
3281 * authoritative. ass and pict fields may contain approximations.
3286 * Formatted text, the ass field must be set by the decoder and is
3287 * authoritative. pict and text fields may contain approximations.
3292 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3294 typedef struct AVSubtitleRect {
3295 int x; ///< top left corner of pict, undefined when pict is not set
3296 int y; ///< top left corner of pict, undefined when pict is not set
3297 int w; ///< width of pict, undefined when pict is not set
3298 int h; ///< height of pict, undefined when pict is not set
3299 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3301 #if FF_API_AVPICTURE
3303 * @deprecated unused
3305 attribute_deprecated
3309 * data+linesize for the bitmap of this subtitle.
3310 * Can be set for text/ass as well once they are rendered.
3315 enum AVSubtitleType type;
3317 char *text; ///< 0 terminated plain UTF-8 text
3320 * 0 terminated ASS/SSA compatible event line.
3321 * The pressentation of this is unaffected by the other values in this
3328 typedef struct AVSubtitle {
3329 uint16_t format; /* 0 = graphics */
3330 uint32_t start_display_time; /* relative to packet pts, in ms */
3331 uint32_t end_display_time; /* relative to packet pts, in ms */
3333 AVSubtitleRect **rects;
3334 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3338 * If c is NULL, returns the first registered codec,
3339 * if c is non-NULL, returns the next registered codec after c,
3340 * or NULL if c is the last one.
3342 AVCodec *av_codec_next(const AVCodec *c);
3345 * Return the LIBAVCODEC_VERSION_INT constant.
3347 unsigned avcodec_version(void);
3350 * Return the libavcodec build-time configuration.
3352 const char *avcodec_configuration(void);
3355 * Return the libavcodec license.
3357 const char *avcodec_license(void);
3360 * Register the codec codec and initialize libavcodec.
3362 * @warning either this function or avcodec_register_all() must be called
3363 * before any other libavcodec functions.
3365 * @see avcodec_register_all()
3367 void avcodec_register(AVCodec *codec);
3370 * Register all the codecs, parsers and bitstream filters which were enabled at
3371 * configuration time. If you do not call this function you can select exactly
3372 * which formats you want to support, by using the individual registration
3375 * @see avcodec_register
3376 * @see av_register_codec_parser
3377 * @see av_register_bitstream_filter
3379 void avcodec_register_all(void);
3382 * Allocate an AVCodecContext and set its fields to default values. The
3383 * resulting struct should be freed with avcodec_free_context().
3385 * @param codec if non-NULL, allocate private data and initialize defaults
3386 * for the given codec. It is illegal to then call avcodec_open2()
3387 * with a different codec.
3388 * If NULL, then the codec-specific defaults won't be initialized,
3389 * which may result in suboptimal default settings (this is
3390 * important mainly for encoders, e.g. libx264).
3392 * @return An AVCodecContext filled with default values or NULL on failure.
3393 * @see avcodec_get_context_defaults
3395 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3398 * Free the codec context and everything associated with it and write NULL to
3399 * the provided pointer.
3401 void avcodec_free_context(AVCodecContext **avctx);
3404 * Set the fields of the given AVCodecContext to default values corresponding
3405 * to the given codec (defaults may be codec-dependent).
3407 * Do not call this function if a non-NULL codec has been passed
3408 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3409 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3410 * different codec on this AVCodecContext.
3412 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3415 * Get the AVClass for AVCodecContext. It can be used in combination with
3416 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3418 * @see av_opt_find().
3420 const AVClass *avcodec_get_class(void);
3423 * Copy the settings of the source AVCodecContext into the destination
3424 * AVCodecContext. The resulting destination codec context will be
3425 * unopened, i.e. you are required to call avcodec_open2() before you
3426 * can use this AVCodecContext to decode/encode video/audio data.
3428 * @param dest target codec context, should be initialized with
3429 * avcodec_alloc_context3(), but otherwise uninitialized
3430 * @param src source codec context
3431 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3433 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3436 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3437 * function the context has to be allocated with avcodec_alloc_context3().
3439 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3440 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3441 * retrieving a codec.
3443 * @warning This function is not thread safe!
3445 * @note Always call this function before using decoding routines (such as
3446 * @ref avcodec_decode_video2()).
3449 * avcodec_register_all();
3450 * av_dict_set(&opts, "b", "2.5M", 0);
3451 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3455 * context = avcodec_alloc_context3(codec);
3457 * if (avcodec_open2(context, codec, opts) < 0)
3461 * @param avctx The context to initialize.
3462 * @param codec The codec to open this context for. If a non-NULL codec has been
3463 * previously passed to avcodec_alloc_context3() or
3464 * avcodec_get_context_defaults3() for this context, then this
3465 * parameter MUST be either NULL or equal to the previously passed
3467 * @param options A dictionary filled with AVCodecContext and codec-private options.
3468 * On return this object will be filled with options that were not found.
3470 * @return zero on success, a negative value on error
3471 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3472 * av_dict_set(), av_opt_find().
3474 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3477 * Close a given AVCodecContext and free all the data associated with it
3478 * (but not the AVCodecContext itself).
3480 * Calling this function on an AVCodecContext that hasn't been opened will free
3481 * the codec-specific data allocated in avcodec_alloc_context3() /
3482 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3485 int avcodec_close(AVCodecContext *avctx);
3488 * Free all allocated data in the given subtitle struct.
3490 * @param sub AVSubtitle to free.
3492 void avsubtitle_free(AVSubtitle *sub);
3499 * @addtogroup lavc_packet
3504 * Allocate an AVPacket and set its fields to default values. The resulting
3505 * struct must be freed using av_packet_free().
3507 * @return An AVPacket filled with default values or NULL on failure.
3509 * @note this only allocates the AVPacket itself, not the data buffers. Those
3510 * must be allocated through other means such as av_new_packet.
3512 * @see av_new_packet
3514 AVPacket *av_packet_alloc(void);
3517 * Create a new packet that references the same data as src.
3519 * This is a shortcut for av_packet_alloc()+av_packet_ref().
3521 * @return newly created AVPacket on success, NULL on error.
3523 * @see av_packet_alloc
3524 * @see av_packet_ref
3526 AVPacket *av_packet_clone(AVPacket *src);
3529 * Free the packet, if the packet is reference counted, it will be
3530 * unreferenced first.
3532 * @param packet packet to be freed. The pointer will be set to NULL.
3533 * @note passing NULL is a no-op.
3535 void av_packet_free(AVPacket **pkt);
3538 * Initialize optional fields of a packet with default values.
3540 * Note, this does not touch the data and size members, which have to be
3541 * initialized separately.
3545 void av_init_packet(AVPacket *pkt);
3548 * Allocate the payload of a packet and initialize its fields with
3552 * @param size wanted payload size
3553 * @return 0 if OK, AVERROR_xxx otherwise
3555 int av_new_packet(AVPacket *pkt, int size);
3558 * Reduce packet size, correctly zeroing padding
3561 * @param size new size
3563 void av_shrink_packet(AVPacket *pkt, int size);
3566 * Increase packet size, correctly zeroing padding
3569 * @param grow_by number of bytes by which to increase the size of the packet
3571 int av_grow_packet(AVPacket *pkt, int grow_by);
3574 * Initialize a reference-counted packet from av_malloc()ed data.
3576 * @param pkt packet to be initialized. This function will set the data, size,
3577 * buf and destruct fields, all others are left untouched.
3578 * @param data Data allocated by av_malloc() to be used as packet data. If this
3579 * function returns successfully, the data is owned by the underlying AVBuffer.
3580 * The caller may not access the data through other means.
3581 * @param size size of data in bytes, without the padding. I.e. the full buffer
3582 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
3584 * @return 0 on success, a negative AVERROR on error
3586 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3588 #if FF_API_AVPACKET_OLD_API
3590 * @warning This is a hack - the packet memory allocation stuff is broken. The
3591 * packet is allocated if it was not really allocated.
3593 * @deprecated Use av_packet_ref
3595 attribute_deprecated
3596 int av_dup_packet(AVPacket *pkt);
3600 * @deprecated Use av_packet_unref
3602 * @param pkt packet to free
3604 attribute_deprecated
3605 void av_free_packet(AVPacket *pkt);
3608 * Allocate new information of a packet.
3611 * @param type side information type
3612 * @param size side information size
3613 * @return pointer to fresh allocated data or NULL otherwise
3615 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3619 * Wrap an existing array as a packet side data.
3622 * @param type side information type
3623 * @param data the side data array. It must be allocated with the av_malloc()
3624 * family of functions. The ownership of the data is transferred to
3626 * @param size side information size
3627 * @return a non-negative number on success, a negative AVERROR code on
3628 * failure. On failure, the packet is unchanged and the data remains
3629 * owned by the caller.
3631 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3632 uint8_t *data, size_t size);
3635 * Shrink the already allocated side data buffer
3638 * @param type side information type
3639 * @param size new side information size
3640 * @return 0 on success, < 0 on failure
3642 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3646 * Get side information from packet.
3649 * @param type desired side information type
3650 * @param size pointer for side information size to store (optional)
3651 * @return pointer to data if present or NULL otherwise
3653 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3657 * Convenience function to free all the side data stored.
3658 * All the other fields stay untouched.
3662 void av_packet_free_side_data(AVPacket *pkt);
3665 * Setup a new reference to the data described by a given packet
3667 * If src is reference-counted, setup dst as a new reference to the
3668 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3669 * data from src into it.
3671 * All the other fields are copied from src.
3673 * @see av_packet_unref
3675 * @param dst Destination packet
3676 * @param src Source packet
3678 * @return 0 on success, a negative AVERROR on error.
3680 int av_packet_ref(AVPacket *dst, AVPacket *src);
3685 * Unreference the buffer referenced by the packet and reset the
3686 * remaining packet fields to their default values.
3688 * @param pkt The packet to be unreferenced.
3690 void av_packet_unref(AVPacket *pkt);
3693 * Move every field in src to dst and reset src.
3695 * @see av_packet_unref
3697 * @param src Source packet, will be reset
3698 * @param dst Destination packet
3700 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3703 * Copy only "properties" fields from src to dst.
3705 * Properties for the purpose of this function are all the fields
3706 * beside those related to the packet data (buf, data, size)
3708 * @param dst Destination packet
3709 * @param src Source packet
3711 * @return 0 on success AVERROR on failure.
3714 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3717 * Convert valid timing fields (timestamps / durations) in a packet from one
3718 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3721 * @param pkt packet on which the conversion will be performed
3722 * @param tb_src source timebase, in which the timing fields in pkt are
3724 * @param tb_dst destination timebase, to which the timing fields will be
3727 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
3734 * @addtogroup lavc_decoding
3739 * Find a registered decoder with a matching codec ID.
3741 * @param id AVCodecID of the requested decoder
3742 * @return A decoder if one was found, NULL otherwise.
3744 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3747 * Find a registered decoder with the specified name.
3749 * @param name name of the requested decoder
3750 * @return A decoder if one was found, NULL otherwise.
3752 AVCodec *avcodec_find_decoder_by_name(const char *name);
3755 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3756 * it can be called by custom get_buffer2() implementations for decoders without
3757 * AV_CODEC_CAP_DR1 set.
3759 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3763 * Return the amount of padding in pixels which the get_buffer callback must
3764 * provide around the edge of the image for codecs which do not have the
3765 * CODEC_FLAG_EMU_EDGE flag.
3767 * @return Required padding in pixels.
3769 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
3772 attribute_deprecated
3773 unsigned avcodec_get_edge_width(void);
3777 * Modify width and height values so that they will result in a memory
3778 * buffer that is acceptable for the codec if you do not use any horizontal
3781 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3783 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3786 * Modify width and height values so that they will result in a memory
3787 * buffer that is acceptable for the codec if you also ensure that all
3788 * line sizes are a multiple of the respective linesize_align[i].
3790 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3792 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3793 int linesize_align[AV_NUM_DATA_POINTERS]);
3796 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3798 * Some decoders may support multiple frames in a single AVPacket. Such
3799 * decoders would then just decode the first frame and the return value would be
3800 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3801 * called again with an AVPacket containing the remaining data in order to
3802 * decode the second frame, etc... Even if no frames are returned, the packet
3803 * needs to be fed to the decoder with remaining data until it is completely
3804 * consumed or an error occurs.
3806 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3807 * and output. This means that for some packets they will not immediately
3808 * produce decoded output and need to be flushed at the end of decoding to get
3809 * all the decoded data. Flushing is done by calling this function with packets
3810 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3811 * returning samples. It is safe to flush even those decoders that are not
3812 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
3814 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3815 * larger than the actual read bytes because some optimized bitstream
3816 * readers read 32 or 64 bits at once and could read over the end.
3818 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3819 * before packets may be fed to the decoder.
3821 * @param avctx the codec context
3822 * @param[out] frame The AVFrame in which to store decoded audio samples.
3823 * The decoder will allocate a buffer for the decoded frame by
3824 * calling the AVCodecContext.get_buffer2() callback.
3825 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3826 * reference counted and the returned reference belongs to the
3827 * caller. The caller must release the frame using av_frame_unref()
3828 * when the frame is no longer needed. The caller may safely write
3829 * to the frame if av_frame_is_writable() returns 1.
3830 * When AVCodecContext.refcounted_frames is set to 0, the returned
3831 * reference belongs to the decoder and is valid only until the
3832 * next call to this function or until closing or flushing the
3833 * decoder. The caller may not write to it.
3834 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3835 * non-zero. Note that this field being set to zero
3836 * does not mean that an error has occurred. For
3837 * decoders with AV_CODEC_CAP_DELAY set, no given decode
3838 * call is guaranteed to produce a frame.
3839 * @param[in] avpkt The input AVPacket containing the input buffer.
3840 * At least avpkt->data and avpkt->size should be set. Some
3841 * decoders might also require additional fields to be set.
3842 * @return A negative error code is returned if an error occurred during
3843 * decoding, otherwise the number of bytes consumed from the input
3844 * AVPacket is returned.
3846 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3847 int *got_frame_ptr, AVPacket *avpkt);
3850 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3851 * Some decoders may support multiple frames in a single AVPacket, such
3852 * decoders would then just decode the first frame.
3854 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
3855 * the actual read bytes because some optimized bitstream readers read 32 or 64
3856 * bits at once and could read over the end.
3858 * @warning The end of the input buffer buf should be set to 0 to ensure that
3859 * no overreading happens for damaged MPEG streams.
3861 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
3862 * between input and output, these need to be fed with avpkt->data=NULL,
3863 * avpkt->size=0 at the end to return the remaining frames.
3865 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3866 * before packets may be fed to the decoder.
3868 * @param avctx the codec context
3869 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3870 * Use av_frame_alloc() to get an AVFrame. The codec will
3871 * allocate memory for the actual bitmap by calling the
3872 * AVCodecContext.get_buffer2() callback.
3873 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3874 * reference counted and the returned reference belongs to the
3875 * caller. The caller must release the frame using av_frame_unref()
3876 * when the frame is no longer needed. The caller may safely write
3877 * to the frame if av_frame_is_writable() returns 1.
3878 * When AVCodecContext.refcounted_frames is set to 0, the returned
3879 * reference belongs to the decoder and is valid only until the
3880 * next call to this function or until closing or flushing the
3881 * decoder. The caller may not write to it.
3883 * @param[in] avpkt The input AVpacket containing the input buffer.
3884 * You can create such packet with av_init_packet() and by then setting
3885 * data and size, some decoders might in addition need other fields like
3886 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3888 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3889 * @return On error a negative value is returned, otherwise the number of bytes
3890 * used or zero if no frame could be decompressed.
3892 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3893 int *got_picture_ptr,
3897 * Decode a subtitle message.
3898 * Return a negative value on error, otherwise return the number of bytes used.
3899 * If no subtitle could be decompressed, got_sub_ptr is zero.
3900 * Otherwise, the subtitle is stored in *sub.
3901 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3902 * simplicity, because the performance difference is expect to be negligible
3903 * and reusing a get_buffer written for video codecs would probably perform badly
3904 * due to a potentially very different allocation pattern.
3906 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3907 * before packets may be fed to the decoder.
3909 * @param avctx the codec context
3910 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3911 freed with avsubtitle_free if *got_sub_ptr is set.
3912 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3913 * @param[in] avpkt The input AVPacket containing the input buffer.
3915 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3920 * @defgroup lavc_parsing Frame parsing
3924 enum AVPictureStructure {
3925 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3926 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3927 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3928 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3931 typedef struct AVCodecParserContext {
3933 struct AVCodecParser *parser;
3934 int64_t frame_offset; /* offset of the current frame */
3935 int64_t cur_offset; /* current offset
3936 (incremented by each av_parser_parse()) */
3937 int64_t next_frame_offset; /* offset of the next frame */
3939 int pict_type; /* XXX: Put it back in AVCodecContext. */
3941 * This field is used for proper frame duration computation in lavf.
3942 * It signals, how much longer the frame duration of the current frame
3943 * is compared to normal frame duration.
3945 * frame_duration = (1 + repeat_pict) * time_base
3947 * It is used by codecs like H.264 to display telecined material.
3949 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3950 int64_t pts; /* pts of the current frame */
3951 int64_t dts; /* dts of the current frame */
3956 int fetch_timestamp;
3958 #define AV_PARSER_PTS_NB 4
3959 int cur_frame_start_index;
3960 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3961 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3962 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3965 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3966 #define PARSER_FLAG_ONCE 0x0002
3967 /// Set if the parser has a valid file offset
3968 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3970 int64_t offset; ///< byte offset from starting packet start
3971 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3974 * Set by parser to 1 for key frames and 0 for non-key frames.
3975 * It is initialized to -1, so if the parser doesn't set this flag,
3976 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3981 #if FF_API_CONVERGENCE_DURATION
3983 * @deprecated unused
3985 attribute_deprecated
3986 int64_t convergence_duration;
3989 // Timestamp generation support:
3991 * Synchronization point for start of timestamp generation.
3993 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3996 * For example, this corresponds to presence of H.264 buffering period
4002 * Offset of the current timestamp against last timestamp sync point in
4003 * units of AVCodecContext.time_base.
4005 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4006 * contain a valid timestamp offset.
4008 * Note that the timestamp of sync point has usually a nonzero
4009 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4010 * the next frame after timestamp sync point will be usually 1.
4012 * For example, this corresponds to H.264 cpb_removal_delay.
4014 int dts_ref_dts_delta;
4017 * Presentation delay of current frame in units of AVCodecContext.time_base.
4019 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4020 * contain valid non-negative timestamp delta (presentation time of a frame
4021 * must not lie in the past).
4023 * This delay represents the difference between decoding and presentation
4024 * time of the frame.
4026 * For example, this corresponds to H.264 dpb_output_delay.
4031 * Position of the packet in file.
4033 * Analogous to cur_frame_pts/dts
4035 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4038 * Byte position of currently parsed frame in stream.
4043 * Previous frame byte position.
4048 * Duration of the current frame.
4049 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4050 * For all other types, this is in units of AVCodecContext.time_base.
4054 enum AVFieldOrder field_order;
4057 * Indicate whether a picture is coded as a frame, top field or bottom field.
4059 * For example, H.264 field_pic_flag equal to 0 corresponds to
4060 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4061 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4062 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4064 enum AVPictureStructure picture_structure;
4067 * Picture number incremented in presentation or output order.
4068 * This field may be reinitialized at the first picture of a new sequence.
4070 * For example, this corresponds to H.264 PicOrderCnt.
4072 int output_picture_number;
4075 * Dimensions of the decoded video intended for presentation.
4081 * Dimensions of the coded video.
4087 * The format of the coded data, corresponds to enum AVPixelFormat for video
4088 * and for enum AVSampleFormat for audio.
4090 * Note that a decoder can have considerable freedom in how exactly it
4091 * decodes the data, so the format reported here might be different from the
4092 * one returned by a decoder.
4095 } AVCodecParserContext;
4097 typedef struct AVCodecParser {
4098 int codec_ids[5]; /* several codec IDs are permitted */
4100 int (*parser_init)(AVCodecParserContext *s);
4101 /* This callback never returns an error, a negative value means that
4102 * the frame start was in a previous packet. */
4103 int (*parser_parse)(AVCodecParserContext *s,
4104 AVCodecContext *avctx,
4105 const uint8_t **poutbuf, int *poutbuf_size,
4106 const uint8_t *buf, int buf_size);
4107 void (*parser_close)(AVCodecParserContext *s);
4108 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4109 struct AVCodecParser *next;
4112 AVCodecParser *av_parser_next(const AVCodecParser *c);
4114 void av_register_codec_parser(AVCodecParser *parser);
4115 AVCodecParserContext *av_parser_init(int codec_id);
4120 * @param s parser context.
4121 * @param avctx codec context.
4122 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4123 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4124 * @param buf input buffer.
4125 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4126 * @param pts input presentation timestamp.
4127 * @param dts input decoding timestamp.
4128 * @param pos input byte position in stream.
4129 * @return the number of bytes of the input bitstream used.
4134 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4141 * decode_frame(data, size);
4145 int av_parser_parse2(AVCodecParserContext *s,
4146 AVCodecContext *avctx,
4147 uint8_t **poutbuf, int *poutbuf_size,
4148 const uint8_t *buf, int buf_size,
4149 int64_t pts, int64_t dts,
4153 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4154 * @deprecated use AVBitstreamFilter
4156 int av_parser_change(AVCodecParserContext *s,
4157 AVCodecContext *avctx,
4158 uint8_t **poutbuf, int *poutbuf_size,
4159 const uint8_t *buf, int buf_size, int keyframe);
4160 void av_parser_close(AVCodecParserContext *s);
4168 * @addtogroup lavc_encoding
4173 * Find a registered encoder with a matching codec ID.
4175 * @param id AVCodecID of the requested encoder
4176 * @return An encoder if one was found, NULL otherwise.
4178 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4181 * Find a registered encoder with the specified name.
4183 * @param name name of the requested encoder
4184 * @return An encoder if one was found, NULL otherwise.
4186 AVCodec *avcodec_find_encoder_by_name(const char *name);
4189 * Encode a frame of audio.
4191 * Takes input samples from frame and writes the next output packet, if
4192 * available, to avpkt. The output packet does not necessarily contain data for
4193 * the most recent frame, as encoders can delay, split, and combine input frames
4194 * internally as needed.
4196 * @param avctx codec context
4197 * @param avpkt output AVPacket.
4198 * The user can supply an output buffer by setting
4199 * avpkt->data and avpkt->size prior to calling the
4200 * function, but if the size of the user-provided data is not
4201 * large enough, encoding will fail. All other AVPacket fields
4202 * will be reset by the encoder using av_init_packet(). If
4203 * avpkt->data is NULL, the encoder will allocate it.
4204 * The encoder will set avpkt->size to the size of the
4207 * If this function fails or produces no output, avpkt will be
4208 * freed using av_packet_unref().
4209 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4210 * May be NULL when flushing an encoder that has the
4211 * AV_CODEC_CAP_DELAY capability set.
4212 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4213 * can have any number of samples.
4214 * If it is not set, frame->nb_samples must be equal to
4215 * avctx->frame_size for all frames except the last.
4216 * The final frame may be smaller than avctx->frame_size.
4217 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4218 * output packet is non-empty, and to 0 if it is
4219 * empty. If the function returns an error, the
4220 * packet can be assumed to be invalid, and the
4221 * value of got_packet_ptr is undefined and should
4223 * @return 0 on success, negative error code on failure
4225 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4226 const AVFrame *frame, int *got_packet_ptr);
4229 * Encode a frame of video.
4231 * Takes input raw video data from frame and writes the next output packet, if
4232 * available, to avpkt. The output packet does not necessarily contain data for
4233 * the most recent frame, as encoders can delay and reorder input frames
4234 * internally as needed.
4236 * @param avctx codec context
4237 * @param avpkt output AVPacket.
4238 * The user can supply an output buffer by setting
4239 * avpkt->data and avpkt->size prior to calling the
4240 * function, but if the size of the user-provided data is not
4241 * large enough, encoding will fail. All other AVPacket fields
4242 * will be reset by the encoder using av_init_packet(). If
4243 * avpkt->data is NULL, the encoder will allocate it.
4244 * The encoder will set avpkt->size to the size of the
4245 * output packet. The returned data (if any) belongs to the
4246 * caller, he is responsible for freeing it.
4248 * If this function fails or produces no output, avpkt will be
4249 * freed using av_packet_unref().
4250 * @param[in] frame AVFrame containing the raw video data to be encoded.
4251 * May be NULL when flushing an encoder that has the
4252 * AV_CODEC_CAP_DELAY capability set.
4253 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4254 * output packet is non-empty, and to 0 if it is
4255 * empty. If the function returns an error, the
4256 * packet can be assumed to be invalid, and the
4257 * value of got_packet_ptr is undefined and should
4259 * @return 0 on success, negative error code on failure
4261 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4262 const AVFrame *frame, int *got_packet_ptr);
4264 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4265 const AVSubtitle *sub);
4272 #if FF_API_AVPICTURE
4274 * @addtogroup lavc_picture
4279 * @deprecated unused
4281 attribute_deprecated
4282 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4285 * @deprecated unused
4287 attribute_deprecated
4288 void avpicture_free(AVPicture *picture);
4291 * @deprecated use av_image_fill_arrays() instead.
4293 attribute_deprecated
4294 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4295 enum AVPixelFormat pix_fmt, int width, int height);
4298 * @deprecated use av_image_copy_to_buffer() instead.
4300 attribute_deprecated
4301 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4302 int width, int height,
4303 unsigned char *dest, int dest_size);
4306 * @deprecated use av_image_get_buffer_size() instead.
4308 attribute_deprecated
4309 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4312 * @deprecated av_image_copy() instead.
4314 attribute_deprecated
4315 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4316 enum AVPixelFormat pix_fmt, int width, int height);
4319 * @deprecated unused
4321 attribute_deprecated
4322 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4323 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4326 * @deprecated unused
4328 attribute_deprecated
4329 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4330 int padtop, int padbottom, int padleft, int padright, int *color);
4338 * @defgroup lavc_misc Utility functions
4341 * Miscellaneous utility functions related to both encoding and decoding
4347 * @defgroup lavc_misc_pixfmt Pixel formats
4349 * Functions for working with pixel formats.
4354 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4357 void attribute_deprecated avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4360 * Return a value representing the fourCC code associated to the
4361 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4364 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4366 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4367 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4368 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4369 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4370 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4371 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4374 * Compute what kind of losses will occur when converting from one specific
4375 * pixel format to another.
4376 * When converting from one pixel format to another, information loss may occur.
4377 * For example, when converting from RGB24 to GRAY, the color information will
4378 * be lost. Similarly, other losses occur when converting from some formats to
4379 * other formats. These losses can involve loss of chroma, but also loss of
4380 * resolution, loss of color depth, loss due to the color space conversion, loss
4381 * of the alpha bits or loss due to color quantization.
4382 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4383 * which will occur when converting from one pixel format to another.
4385 * @param[in] dst_pix_fmt destination pixel format
4386 * @param[in] src_pix_fmt source pixel format
4387 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4388 * @return Combination of flags informing you what kind of losses will occur.
4390 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4394 * Find the best pixel format to convert to given a certain source pixel
4395 * format. When converting from one pixel format to another, information loss
4396 * may occur. For example, when converting from RGB24 to GRAY, the color
4397 * information will be lost. Similarly, other losses occur when converting from
4398 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4399 * the given pixel formats should be used to suffer the least amount of loss.
4400 * The pixel formats from which it chooses one, are determined by the
4401 * pix_fmt_list parameter.
4404 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4405 * @param[in] src_pix_fmt source pixel format
4406 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4407 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4408 * @return The best pixel format to convert to or -1 if none was found.
4410 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4411 enum AVPixelFormat src_pix_fmt,
4412 int has_alpha, int *loss_ptr);
4414 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4420 #if FF_API_SET_DIMENSIONS
4422 * @deprecated this function is not supposed to be used from outside of lavc
4424 attribute_deprecated
4425 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4429 * Put a string representing the codec tag codec_tag in buf.
4431 * @param buf buffer to place codec tag in
4432 * @param buf_size size in bytes of buf
4433 * @param codec_tag codec tag to assign
4434 * @return the length of the string that would have been generated if
4435 * enough space had been available, excluding the trailing null
4437 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4439 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4442 * Return a name for the specified profile, if available.
4444 * @param codec the codec that is searched for the given profile
4445 * @param profile the profile value for which a name is requested
4446 * @return A name for the profile if found, NULL otherwise.
4448 const char *av_get_profile_name(const AVCodec *codec, int profile);
4450 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4451 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4452 //FIXME func typedef
4455 * Fill audio frame data and linesize.
4456 * AVFrame extended_data channel pointers are allocated if necessary for
4459 * @param frame the AVFrame
4460 * frame->nb_samples must be set prior to calling the
4461 * function. This function fills in frame->data,
4462 * frame->extended_data, frame->linesize[0].
4463 * @param nb_channels channel count
4464 * @param sample_fmt sample format
4465 * @param buf buffer to use for frame data
4466 * @param buf_size size of buffer
4467 * @param align plane size sample alignment (0 = default)
4468 * @return 0 on success, negative error code on failure
4470 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4471 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4472 int buf_size, int align);
4475 * Reset the internal decoder state / flush internal buffers. Should be called
4476 * e.g. when seeking or when switching to a different stream.
4478 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4479 * this invalidates the frames previously returned from the decoder. When
4480 * refcounted frames are used, the decoder just releases any references it might
4481 * keep internally, but the caller's reference remains valid.
4483 void avcodec_flush_buffers(AVCodecContext *avctx);
4486 * Return codec bits per sample.
4488 * @param[in] codec_id the codec
4489 * @return Number of bits per sample or zero if unknown for the given codec.
4491 int av_get_bits_per_sample(enum AVCodecID codec_id);
4494 * Return codec bits per sample.
4495 * Only return non-zero if the bits per sample is exactly correct, not an
4498 * @param[in] codec_id the codec
4499 * @return Number of bits per sample or zero if unknown for the given codec.
4501 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4504 * Return audio frame duration.
4506 * @param avctx codec context
4507 * @param frame_bytes size of the frame, or 0 if unknown
4508 * @return frame duration, in samples, if known. 0 if not able to
4511 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4514 typedef struct AVBitStreamFilterContext {
4516 struct AVBitStreamFilter *filter;
4517 AVCodecParserContext *parser;
4518 struct AVBitStreamFilterContext *next;
4519 } AVBitStreamFilterContext;
4522 typedef struct AVBitStreamFilter {
4525 int (*filter)(AVBitStreamFilterContext *bsfc,
4526 AVCodecContext *avctx, const char *args,
4527 uint8_t **poutbuf, int *poutbuf_size,
4528 const uint8_t *buf, int buf_size, int keyframe);
4529 void (*close)(AVBitStreamFilterContext *bsfc);
4530 struct AVBitStreamFilter *next;
4531 } AVBitStreamFilter;
4533 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4534 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4535 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4536 AVCodecContext *avctx, const char *args,
4537 uint8_t **poutbuf, int *poutbuf_size,
4538 const uint8_t *buf, int buf_size, int keyframe);
4539 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4541 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
4546 * Allocate a buffer with padding, reusing the given one if large enough.
4548 * Same behaviour av_fast_malloc but the buffer has additional
4549 * AV_INPUT_PADDING_SIZE at the end which will always memset to 0.
4552 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4555 * Encode extradata length to a buffer. Used by xiph codecs.
4557 * @param s buffer to write to; must be at least (v/255+1) bytes long
4558 * @param v size of extradata in bytes
4559 * @return number of bytes written to the buffer.
4561 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4563 #if FF_API_MISSING_SAMPLE
4565 * Log a generic warning message about a missing feature. This function is
4566 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4567 * only, and would normally not be used by applications.
4568 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4569 * a pointer to an AVClass struct
4570 * @param[in] feature string containing the name of the missing feature
4571 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4572 * If want_sample is non-zero, additional verbage will be added to the log
4573 * message which tells the user how to report samples to the development
4575 * @deprecated Use avpriv_report_missing_feature() instead.
4577 attribute_deprecated
4578 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4581 * Log a generic warning message asking for a sample. This function is
4582 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4583 * only, and would normally not be used by applications.
4584 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4585 * a pointer to an AVClass struct
4586 * @param[in] msg string containing an optional message, or NULL if no message
4587 * @deprecated Use avpriv_request_sample() instead.
4589 attribute_deprecated
4590 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4591 #endif /* FF_API_MISSING_SAMPLE */
4594 * Register the hardware accelerator hwaccel.
4596 void av_register_hwaccel(AVHWAccel *hwaccel);
4599 * If hwaccel is NULL, returns the first registered hardware accelerator,
4600 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4601 * after hwaccel, or NULL if hwaccel is the last one.
4603 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
4607 * Lock operation used by lockmgr
4610 AV_LOCK_CREATE, ///< Create a mutex
4611 AV_LOCK_OBTAIN, ///< Lock the mutex
4612 AV_LOCK_RELEASE, ///< Unlock the mutex
4613 AV_LOCK_DESTROY, ///< Free mutex resources
4617 * Register a user provided lock manager supporting the operations
4618 * specified by AVLockOp. The "mutex" argument to the function points
4619 * to a (void *) where the lockmgr should store/get a pointer to a user
4620 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
4621 * value left by the last call for all other ops. If the lock manager is
4622 * unable to perform the op then it should leave the mutex in the same
4623 * state as when it was called and return a non-zero value. However,
4624 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
4625 * have been successfully destroyed. If av_lockmgr_register succeeds
4626 * it will return a non-negative value, if it fails it will return a
4627 * negative value and destroy all mutex and unregister all callbacks.
4628 * av_lockmgr_register is not thread-safe, it must be called from a
4629 * single thread before any calls which make use of locking are used.
4631 * @param cb User defined callback. av_lockmgr_register invokes calls
4632 * to this callback and the previously registered callback.
4633 * The callback will be used to create more than one mutex
4634 * each of which must be backed by its own underlying locking
4635 * mechanism (i.e. do not use a single static object to
4636 * implement your lock manager). If cb is set to NULL the
4637 * lockmgr will be unregistered.
4639 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4642 * Get the type of the given codec.
4644 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4647 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4648 * with no corresponding avcodec_close()), 0 otherwise.
4650 int avcodec_is_open(AVCodecContext *s);
4653 * @return a non-zero number if codec is an encoder, zero otherwise
4655 int av_codec_is_encoder(const AVCodec *codec);
4658 * @return a non-zero number if codec is a decoder, zero otherwise
4660 int av_codec_is_decoder(const AVCodec *codec);
4663 * @return descriptor for given codec ID or NULL if no descriptor exists.
4665 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4668 * Iterate over all codec descriptors known to libavcodec.
4670 * @param prev previous descriptor. NULL to get the first descriptor.
4672 * @return next descriptor or NULL after the last descriptor
4674 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4677 * @return codec descriptor with the given name or NULL if no such descriptor
4680 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4683 * Allocate a CPB properties structure and initialize its fields to default
4686 * @param size if non-NULL, the size of the allocated struct will be written
4687 * here. This is useful for embedding it in side data.
4689 * @return the newly allocated struct or NULL on failure
4691 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
4697 #endif /* AVCODEC_AVCODEC_H */