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];
1039 #if FF_API_QSCALE_TYPE
1040 #define FF_QSCALE_TYPE_MPEG1 0
1041 #define FF_QSCALE_TYPE_MPEG2 1
1042 #define FF_QSCALE_TYPE_H264 2
1043 #define FF_QSCALE_TYPE_VP56 3
1047 * The decoder will keep a reference to the frame and may reuse it later.
1049 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1052 * @defgroup lavc_packet AVPacket
1054 * Types and functions for working with AVPacket.
1057 enum AVPacketSideDataType {
1058 AV_PKT_DATA_PALETTE,
1059 AV_PKT_DATA_NEW_EXTRADATA,
1062 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1065 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1066 * s32le channel_count
1067 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1068 * u64le channel_layout
1069 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1071 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1076 AV_PKT_DATA_PARAM_CHANGE,
1079 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1080 * structures with info about macroblocks relevant to splitting the
1081 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1082 * That is, it does not necessarily contain info about all macroblocks,
1083 * as long as the distance between macroblocks in the info is smaller
1084 * than the target payload size.
1085 * Each MB info structure is 12 bytes, and is laid out as follows:
1087 * u32le bit offset from the start of the packet
1088 * u8 current quantizer at the start of the macroblock
1090 * u16le macroblock address within the GOB
1091 * u8 horizontal MV predictor
1092 * u8 vertical MV predictor
1093 * u8 horizontal MV predictor for block number 3
1094 * u8 vertical MV predictor for block number 3
1097 AV_PKT_DATA_H263_MB_INFO,
1100 * This side data should be associated with an audio stream and contains
1101 * ReplayGain information in form of the AVReplayGain struct.
1103 AV_PKT_DATA_REPLAYGAIN,
1106 * This side data contains a 3x3 transformation matrix describing an affine
1107 * transformation that needs to be applied to the decoded video frames for
1108 * correct presentation.
1110 * See libavutil/display.h for a detailed description of the data.
1112 AV_PKT_DATA_DISPLAYMATRIX,
1115 * This side data should be associated with a video stream and contains
1116 * Stereoscopic 3D information in form of the AVStereo3D struct.
1118 AV_PKT_DATA_STEREO3D,
1121 * This side data should be associated with an audio stream and corresponds
1122 * to enum AVAudioServiceType.
1124 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1127 * This side data contains an integer value representing the quality
1128 * factor of the compressed frame. Allowed range is between 1 (good)
1129 * and FF_LAMBDA_MAX (bad).
1131 AV_PKT_DATA_QUALITY_FACTOR,
1134 * This side data contains an integer value representing the stream index
1135 * of a "fallback" track. A fallback track indicates an alternate
1136 * track to use when the current track can not be decoded for some reason.
1137 * e.g. no decoder available for codec.
1139 AV_PKT_DATA_FALLBACK_TRACK,
1142 typedef struct AVPacketSideData {
1145 enum AVPacketSideDataType type;
1149 * This structure stores compressed data. It is typically exported by demuxers
1150 * and then passed as input to decoders, or received as output from encoders and
1151 * then passed to muxers.
1153 * For video, it should typically contain one compressed frame. For audio it may
1154 * contain several compressed frames. Encoders are allowed to output empty
1155 * packets, with no compressed data, containing only side data
1156 * (e.g. to update some stream parameters at the end of encoding).
1158 * AVPacket is one of the few structs in Libav, whose size is a part of public
1159 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1160 * without libavcodec and libavformat major bump.
1162 * The semantics of data ownership depends on the buf field.
1163 * If it is set, the packet data is dynamically allocated and is
1164 * valid indefinitely until a call to av_packet_unref() reduces the
1165 * reference count to 0.
1167 * If the buf field is not set av_packet_ref() would make a copy instead
1168 * of increasing the reference count.
1170 * The side data is always allocated with av_malloc(), copied by
1171 * av_packet_ref() and freed by av_packet_unref().
1173 * @see av_packet_ref
1174 * @see av_packet_unref
1176 typedef struct AVPacket {
1178 * A reference to the reference-counted buffer where the packet data is
1180 * May be NULL, then the packet data is not reference-counted.
1184 * Presentation timestamp in AVStream->time_base units; the time at which
1185 * the decompressed packet will be presented to the user.
1186 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1187 * pts MUST be larger or equal to dts as presentation cannot happen before
1188 * decompression, unless one wants to view hex dumps. Some formats misuse
1189 * the terms dts and pts/cts to mean something different. Such timestamps
1190 * must be converted to true pts/dts before they are stored in AVPacket.
1194 * Decompression timestamp in AVStream->time_base units; the time at which
1195 * the packet is decompressed.
1196 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1203 * A combination of AV_PKT_FLAG values
1207 * Additional packet data that can be provided by the container.
1208 * Packet can contain several types of side information.
1210 AVPacketSideData *side_data;
1211 int side_data_elems;
1214 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1215 * Equals next_pts - this_pts in presentation order.
1219 int64_t pos; ///< byte position in stream, -1 if unknown
1221 #if FF_API_CONVERGENCE_DURATION
1223 * @deprecated Same as the duration field, but as int64_t. This was required
1224 * for Matroska subtitles, whose duration values could overflow when the
1225 * duration field was still an int.
1227 attribute_deprecated
1228 int64_t convergence_duration;
1231 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1232 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1234 enum AVSideDataParamChangeFlags {
1235 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1236 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1237 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1238 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1244 struct AVCodecInternal;
1248 AV_FIELD_PROGRESSIVE,
1249 AV_FIELD_TT, //< Top coded_first, top displayed first
1250 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1251 AV_FIELD_TB, //< Top coded first, bottom displayed first
1252 AV_FIELD_BT, //< Bottom coded first, top displayed first
1256 * main external API structure.
1257 * New fields can be added to the end with minor version bumps.
1258 * Removal, reordering and changes to existing fields require a major
1260 * sizeof(AVCodecContext) must not be used outside libav*.
1262 typedef struct AVCodecContext {
1264 * information on struct for av_log
1265 * - set by avcodec_alloc_context3
1267 const AVClass *av_class;
1268 int log_level_offset;
1270 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1271 const struct AVCodec *codec;
1272 #if FF_API_CODEC_NAME
1274 * @deprecated this field is not used for anything in libavcodec
1276 attribute_deprecated
1277 char codec_name[32];
1279 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1282 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1283 * This is used to work around some encoder bugs.
1284 * A demuxer should set this to what is stored in the field used to identify the codec.
1285 * If there are multiple such fields in a container then the demuxer should choose the one
1286 * which maximizes the information about the used codec.
1287 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1288 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1289 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1291 * - encoding: Set by user, if not then the default based on codec_id will be used.
1292 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1294 unsigned int codec_tag;
1296 #if FF_API_STREAM_CODEC_TAG
1298 * @deprecated this field is unused
1300 attribute_deprecated
1301 unsigned int stream_codec_tag;
1307 * Private context used for internal data.
1309 * Unlike priv_data, this is not codec-specific. It is used in general
1310 * libavcodec functions.
1312 struct AVCodecInternal *internal;
1315 * Private data of the user, can be used to carry app specific stuff.
1316 * - encoding: Set by user.
1317 * - decoding: Set by user.
1322 * the average bitrate
1323 * - encoding: Set by user; unused for constant quantizer encoding.
1324 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1329 * number of bits the bitstream is allowed to diverge from the reference.
1330 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1331 * - encoding: Set by user; unused for constant quantizer encoding.
1332 * - decoding: unused
1334 int bit_rate_tolerance;
1337 * Global quality for codecs which cannot change it per frame.
1338 * This should be proportional to MPEG-1/2/4 qscale.
1339 * - encoding: Set by user.
1340 * - decoding: unused
1345 * - encoding: Set by user.
1346 * - decoding: unused
1348 int compression_level;
1349 #define FF_COMPRESSION_DEFAULT -1
1353 * - encoding: Set by user.
1354 * - decoding: Set by user.
1360 * - encoding: Set by user.
1361 * - decoding: Set by user.
1366 * some codecs need / can use extradata like Huffman tables.
1367 * mjpeg: Huffman tables
1368 * rv10: additional flags
1369 * mpeg4: global headers (they can be in the bitstream or here)
1370 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1371 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1372 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1373 * - encoding: Set/allocated/freed by libavcodec.
1374 * - decoding: Set/allocated/freed by user.
1380 * This is the fundamental unit of time (in seconds) in terms
1381 * of which frame timestamps are represented. For fixed-fps content,
1382 * timebase should be 1/framerate and timestamp increments should be
1384 * - encoding: MUST be set by user.
1385 * - decoding: the use of this field for decoding is deprecated.
1386 * Use framerate instead.
1388 AVRational time_base;
1391 * For some codecs, the time base is closer to the field rate than the frame rate.
1392 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1393 * if no telecine is used ...
1395 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1397 int ticks_per_frame;
1403 * Number of frames the decoded output will be delayed relative to the
1407 * For encoding, this field is unused (see initial_padding).
1409 * For decoding, this is the number of samples the decoder needs to
1410 * output before the decoder's output is valid. When seeking, you should
1411 * start decoding this many samples prior to your desired seek point.
1413 * - encoding: Set by libavcodec.
1414 * - decoding: Set by libavcodec.
1421 * picture width / height.
1423 * @note Those fields may not match the values of the last
1424 * AVFrame outputted by avcodec_decode_video2 due frame
1427 * - encoding: MUST be set by user.
1428 * - decoding: May be set by the user before opening the decoder if known e.g.
1429 * from the container. Some decoders will require the dimensions
1430 * to be set by the caller. During decoding, the decoder may
1431 * overwrite those values as required while parsing the data.
1436 * Bitstream width / height, may be different from width/height e.g. when
1437 * the decoded frame is cropped before being output.
1439 * @note Those field may not match the value of the last
1440 * AVFrame outputted by avcodec_decode_video2 due frame
1443 * - encoding: unused
1444 * - decoding: May be set by the user before opening the decoder if known
1445 * e.g. from the container. During decoding, the decoder may
1446 * overwrite those values as required while parsing the data.
1448 int coded_width, coded_height;
1450 #if FF_API_ASPECT_EXTENDED
1451 #define FF_ASPECT_EXTENDED 15
1455 * the number of pictures in a group of pictures, or 0 for intra_only
1456 * - encoding: Set by user.
1457 * - decoding: unused
1462 * Pixel format, see AV_PIX_FMT_xxx.
1463 * May be set by the demuxer if known from headers.
1464 * May be overriden by the decoder if it knows better.
1466 * @note This field may not match the value of the last
1467 * AVFrame outputted by avcodec_decode_video2 due frame
1470 * - encoding: Set by user.
1471 * - decoding: Set by user if known, overridden by libavcodec while
1474 enum AVPixelFormat pix_fmt;
1476 #if FF_API_MOTION_EST
1478 * This option does nothing
1479 * @deprecated use codec private options instead
1481 attribute_deprecated int me_method;
1485 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1486 * decoder to draw a horizontal band. It improves cache usage. Not
1487 * all codecs can do that. You must check the codec capabilities
1489 * When multithreading is used, it may be called from multiple threads
1490 * at the same time; threads might draw different parts of the same AVFrame,
1491 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1493 * The function is also used by hardware acceleration APIs.
1494 * It is called at least once during frame decoding to pass
1495 * the data needed for hardware render.
1496 * In that mode instead of pixel data, AVFrame points to
1497 * a structure specific to the acceleration API. The application
1498 * reads the structure and can change some fields to indicate progress
1500 * - encoding: unused
1501 * - decoding: Set by user.
1502 * @param height the height of the slice
1503 * @param y the y position of the slice
1504 * @param type 1->top field, 2->bottom field, 3->frame
1505 * @param offset offset into the AVFrame.data from which the slice should be read
1507 void (*draw_horiz_band)(struct AVCodecContext *s,
1508 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1509 int y, int type, int height);
1512 * callback to negotiate the pixelFormat
1513 * @param fmt is the list of formats which are supported by the codec,
1514 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1515 * The first is always the native one.
1516 * @note The callback may be called again immediately if initialization for
1517 * the selected (hardware-accelerated) pixel format failed.
1518 * @warning Behavior is undefined if the callback returns a value not
1519 * in the fmt list of formats.
1520 * @return the chosen format
1521 * - encoding: unused
1522 * - decoding: Set by user, if not set the native format will be chosen.
1524 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1527 * maximum number of B-frames between non-B-frames
1528 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1529 * - encoding: Set by user.
1530 * - decoding: unused
1535 * qscale factor between IP and B-frames
1536 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1537 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1538 * - encoding: Set by user.
1539 * - decoding: unused
1541 float b_quant_factor;
1543 #if FF_API_RC_STRATEGY
1544 /** @deprecated use codec private option instead */
1545 attribute_deprecated int rc_strategy;
1546 #define FF_RC_STRATEGY_XVID 1
1549 int b_frame_strategy;
1552 * qscale offset between IP and B-frames
1553 * - encoding: Set by user.
1554 * - decoding: unused
1556 float b_quant_offset;
1559 * Size of the frame reordering buffer in the decoder.
1560 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1561 * - encoding: Set by libavcodec.
1562 * - decoding: Set by libavcodec.
1567 * 0-> h263 quant 1-> mpeg quant
1568 * - encoding: Set by user.
1569 * - decoding: unused
1574 * qscale factor between P and I-frames
1575 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1576 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1577 * - encoding: Set by user.
1578 * - decoding: unused
1580 float i_quant_factor;
1583 * qscale offset between P and I-frames
1584 * - encoding: Set by user.
1585 * - decoding: unused
1587 float i_quant_offset;
1590 * luminance masking (0-> disabled)
1591 * - encoding: Set by user.
1592 * - decoding: unused
1597 * temporary complexity masking (0-> disabled)
1598 * - encoding: Set by user.
1599 * - decoding: unused
1601 float temporal_cplx_masking;
1604 * spatial complexity masking (0-> disabled)
1605 * - encoding: Set by user.
1606 * - decoding: unused
1608 float spatial_cplx_masking;
1611 * p block masking (0-> disabled)
1612 * - encoding: Set by user.
1613 * - decoding: unused
1618 * darkness masking (0-> disabled)
1619 * - encoding: Set by user.
1620 * - decoding: unused
1626 * - encoding: Set by libavcodec.
1627 * - decoding: Set by user (or 0).
1631 * prediction method (needed for huffyuv)
1632 * - encoding: Set by user.
1633 * - decoding: unused
1635 int prediction_method;
1636 #define FF_PRED_LEFT 0
1637 #define FF_PRED_PLANE 1
1638 #define FF_PRED_MEDIAN 2
1641 * slice offsets in the frame in bytes
1642 * - encoding: Set/allocated by libavcodec.
1643 * - decoding: Set/allocated by user (or NULL).
1648 * sample aspect ratio (0 if unknown)
1649 * That is the width of a pixel divided by the height of the pixel.
1650 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1651 * - encoding: Set by user.
1652 * - decoding: Set by libavcodec.
1654 AVRational sample_aspect_ratio;
1657 * motion estimation comparison function
1658 * - encoding: Set by user.
1659 * - decoding: unused
1663 * subpixel motion estimation comparison function
1664 * - encoding: Set by user.
1665 * - decoding: unused
1669 * macroblock comparison function (not supported yet)
1670 * - encoding: Set by user.
1671 * - decoding: unused
1675 * interlaced DCT comparison function
1676 * - encoding: Set by user.
1677 * - decoding: unused
1680 #define FF_CMP_SAD 0
1681 #define FF_CMP_SSE 1
1682 #define FF_CMP_SATD 2
1683 #define FF_CMP_DCT 3
1684 #define FF_CMP_PSNR 4
1685 #define FF_CMP_BIT 5
1687 #define FF_CMP_ZERO 7
1688 #define FF_CMP_VSAD 8
1689 #define FF_CMP_VSSE 9
1690 #define FF_CMP_NSSE 10
1691 #define FF_CMP_DCTMAX 13
1692 #define FF_CMP_DCT264 14
1693 #define FF_CMP_CHROMA 256
1696 * ME diamond size & shape
1697 * - encoding: Set by user.
1698 * - decoding: unused
1703 * amount of previous MV predictors (2a+1 x 2a+1 square)
1704 * - encoding: Set by user.
1705 * - decoding: unused
1707 int last_predictor_count;
1710 * prepass for motion estimation
1711 * - encoding: Set by user.
1712 * - decoding: unused
1717 * motion estimation prepass comparison function
1718 * - encoding: Set by user.
1719 * - decoding: unused
1724 * ME prepass diamond size & shape
1725 * - encoding: Set by user.
1726 * - decoding: unused
1732 * - encoding: Set by user.
1733 * - decoding: unused
1735 int me_subpel_quality;
1739 * DTG active format information (additional aspect ratio
1740 * information only used in DVB MPEG-2 transport streams)
1743 * - encoding: unused
1744 * - decoding: Set by decoder.
1745 * @deprecated Deprecated in favor of AVSideData
1747 attribute_deprecated int dtg_active_format;
1748 #define FF_DTG_AFD_SAME 8
1749 #define FF_DTG_AFD_4_3 9
1750 #define FF_DTG_AFD_16_9 10
1751 #define FF_DTG_AFD_14_9 11
1752 #define FF_DTG_AFD_4_3_SP_14_9 13
1753 #define FF_DTG_AFD_16_9_SP_14_9 14
1754 #define FF_DTG_AFD_SP_4_3 15
1755 #endif /* FF_API_AFD */
1758 * maximum motion estimation search range in subpel units
1759 * If 0 then no limit.
1761 * - encoding: Set by user.
1762 * - decoding: unused
1766 #if FF_API_QUANT_BIAS
1768 * @deprecated use encoder private option instead
1770 attribute_deprecated int intra_quant_bias;
1771 #define FF_DEFAULT_QUANT_BIAS 999999
1774 * @deprecated use encoder private option instead
1776 attribute_deprecated int inter_quant_bias;
1781 * - encoding: unused
1782 * - decoding: Set by user.
1785 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1786 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1787 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1791 * XVideo Motion Acceleration
1792 * - encoding: forbidden
1793 * - decoding: set by decoder
1794 * @deprecated XvMC support is slated for removal.
1796 attribute_deprecated int xvmc_acceleration;
1797 #endif /* FF_API_XVMC */
1800 * macroblock decision mode
1801 * - encoding: Set by user.
1802 * - decoding: unused
1805 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1806 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1807 #define FF_MB_DECISION_RD 2 ///< rate distortion
1810 * custom intra quantization matrix
1811 * - encoding: Set by user, can be NULL.
1812 * - decoding: Set by libavcodec.
1814 uint16_t *intra_matrix;
1817 * custom inter quantization matrix
1818 * - encoding: Set by user, can be NULL.
1819 * - decoding: Set by libavcodec.
1821 uint16_t *inter_matrix;
1824 * scene change detection threshold
1825 * 0 is default, larger means fewer detected scene changes.
1826 * - encoding: Set by user.
1827 * - decoding: unused
1829 int scenechange_threshold;
1832 * noise reduction strength
1833 * - encoding: Set by user.
1834 * - decoding: unused
1836 int noise_reduction;
1840 * @deprecated this field is unused
1842 attribute_deprecated
1846 * @deprecated this field is unused
1848 attribute_deprecated
1853 * precision of the intra DC coefficient - 8
1854 * - encoding: Set by user.
1855 * - decoding: unused
1857 int intra_dc_precision;
1860 * Number of macroblock rows at the top which are skipped.
1861 * - encoding: unused
1862 * - decoding: Set by user.
1867 * Number of macroblock rows at the bottom which are skipped.
1868 * - encoding: unused
1869 * - decoding: Set by user.
1875 * @deprecated use encoder private options instead
1877 attribute_deprecated
1878 float border_masking;
1882 * minimum MB lagrange multipler
1883 * - encoding: Set by user.
1884 * - decoding: unused
1889 * maximum MB lagrange multipler
1890 * - encoding: Set by user.
1891 * - decoding: unused
1897 * - encoding: Set by user.
1898 * - decoding: unused
1900 int me_penalty_compensation;
1904 * - encoding: Set by user.
1905 * - decoding: unused
1911 * - encoding: Set by user.
1912 * - decoding: unused
1918 * - encoding: Set by user.
1919 * - decoding: unused
1924 * number of reference frames
1925 * - encoding: Set by user.
1926 * - decoding: Set by lavc.
1931 * chroma qp offset from luma
1932 * - encoding: Set by user.
1933 * - decoding: unused
1937 #if FF_API_UNUSED_MEMBERS
1939 * Multiplied by qscale for each frame and added to scene_change_score.
1940 * - encoding: Set by user.
1941 * - decoding: unused
1943 attribute_deprecated int scenechange_factor;
1948 * Note: Value depends upon the compare function used for fullpel ME.
1949 * - encoding: Set by user.
1950 * - decoding: unused
1955 * Adjust sensitivity of b_frame_strategy 1.
1956 * - encoding: Set by user.
1957 * - decoding: unused
1962 * Chromaticity coordinates of the source primaries.
1963 * - encoding: Set by user
1964 * - decoding: Set by libavcodec
1966 enum AVColorPrimaries color_primaries;
1969 * Color Transfer Characteristic.
1970 * - encoding: Set by user
1971 * - decoding: Set by libavcodec
1973 enum AVColorTransferCharacteristic color_trc;
1976 * YUV colorspace type.
1977 * - encoding: Set by user
1978 * - decoding: Set by libavcodec
1980 enum AVColorSpace colorspace;
1983 * MPEG vs JPEG YUV range.
1984 * - encoding: Set by user
1985 * - decoding: Set by libavcodec
1987 enum AVColorRange color_range;
1990 * This defines the location of chroma samples.
1991 * - encoding: Set by user
1992 * - decoding: Set by libavcodec
1994 enum AVChromaLocation chroma_sample_location;
1998 * Indicates number of picture subdivisions. Used for parallelized
2000 * - encoding: Set by user
2001 * - decoding: unused
2006 * - encoding: set by libavcodec
2007 * - decoding: Set by libavcodec
2009 enum AVFieldOrder field_order;
2012 int sample_rate; ///< samples per second
2013 int channels; ///< number of audio channels
2016 * audio sample format
2017 * - encoding: Set by user.
2018 * - decoding: Set by libavcodec.
2020 enum AVSampleFormat sample_fmt; ///< sample format
2022 /* The following data should not be initialized. */
2024 * Number of samples per channel in an audio frame.
2026 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2027 * except the last must contain exactly frame_size samples per channel.
2028 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2029 * frame size is not restricted.
2030 * - decoding: may be set by some decoders to indicate constant frame size
2035 * Frame counter, set by libavcodec.
2037 * - decoding: total number of frames returned from the decoder so far.
2038 * - encoding: total number of frames passed to the encoder so far.
2040 * @note the counter is not incremented if encoding/decoding resulted in
2046 * number of bytes per packet if constant and known or 0
2047 * Used by some WAV based audio codecs.
2052 * Audio cutoff bandwidth (0 means "automatic")
2053 * - encoding: Set by user.
2054 * - decoding: unused
2059 * Audio channel layout.
2060 * - encoding: set by user.
2061 * - decoding: set by libavcodec.
2063 uint64_t channel_layout;
2066 * Request decoder to use this channel layout if it can (0 for default)
2067 * - encoding: unused
2068 * - decoding: Set by user.
2070 uint64_t request_channel_layout;
2073 * Type of service that the audio stream conveys.
2074 * - encoding: Set by user.
2075 * - decoding: Set by libavcodec.
2077 enum AVAudioServiceType audio_service_type;
2080 * Used to request a sample format from the decoder.
2081 * - encoding: unused.
2082 * - decoding: Set by user.
2084 enum AVSampleFormat request_sample_fmt;
2087 * This callback is called at the beginning of each frame to get data
2088 * buffer(s) for it. There may be one contiguous buffer for all the data or
2089 * there may be a buffer per each data plane or anything in between. What
2090 * this means is, you may set however many entries in buf[] you feel necessary.
2091 * Each buffer must be reference-counted using the AVBuffer API (see description
2094 * The following fields will be set in the frame before this callback is
2097 * - width, height (video only)
2098 * - sample_rate, channel_layout, nb_samples (audio only)
2099 * Their values may differ from the corresponding values in
2100 * AVCodecContext. This callback must use the frame values, not the codec
2101 * context values, to calculate the required buffer size.
2103 * This callback must fill the following fields in the frame:
2107 * * if the data is planar audio with more than 8 channels, then this
2108 * callback must allocate and fill extended_data to contain all pointers
2109 * to all data planes. data[] must hold as many pointers as it can.
2110 * extended_data must be allocated with av_malloc() and will be freed in
2112 * * otherwise exended_data must point to data
2113 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2114 * the frame's data and extended_data pointers must be contained in these. That
2115 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2116 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2117 * and av_buffer_ref().
2118 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2119 * this callback and filled with the extra buffers if there are more
2120 * buffers than buf[] can hold. extended_buf will be freed in
2123 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2124 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2127 * Each data plane must be aligned to the maximum required by the target
2130 * @see avcodec_default_get_buffer2()
2134 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2135 * (read and/or written to if it is writable) later by libavcodec.
2137 * avcodec_align_dimensions2() should be used to find the required width and
2138 * height, as they normally need to be rounded up to the next multiple of 16.
2140 * If frame multithreading is used and thread_safe_callbacks is set,
2141 * this callback may be called from a different thread, but not from more
2142 * than one at once. Does not need to be reentrant.
2144 * @see avcodec_align_dimensions2()
2148 * Decoders request a buffer of a particular size by setting
2149 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2150 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2151 * to a smaller value in the output frame.
2153 * As a convenience, av_samples_get_buffer_size() and
2154 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2155 * functions to find the required data size and to fill data pointers and
2156 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2157 * since all planes must be the same size.
2159 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2161 * - encoding: unused
2162 * - decoding: Set by libavcodec, user can override.
2164 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2167 * If non-zero, the decoded audio and video frames returned from
2168 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2169 * and are valid indefinitely. The caller must free them with
2170 * av_frame_unref() when they are not needed anymore.
2171 * Otherwise, the decoded frames must not be freed by the caller and are
2172 * only valid until the next decode call.
2174 * - encoding: unused
2175 * - decoding: set by the caller before avcodec_open2().
2177 int refcounted_frames;
2179 /* - encoding parameters */
2180 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2181 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2185 * - encoding: Set by user.
2186 * - decoding: unused
2192 * - encoding: Set by user.
2193 * - decoding: unused
2198 * maximum quantizer difference between frames
2199 * - encoding: Set by user.
2200 * - decoding: unused
2206 * @deprecated use encoder private options instead
2208 attribute_deprecated
2211 attribute_deprecated
2213 attribute_deprecated
2218 * decoder bitstream buffer size
2219 * - encoding: Set by user.
2220 * - decoding: unused
2225 * ratecontrol override, see RcOverride
2226 * - encoding: Allocated/set/freed by user.
2227 * - decoding: unused
2229 int rc_override_count;
2230 RcOverride *rc_override;
2234 * @deprecated use encoder private options instead
2236 attribute_deprecated
2242 * - encoding: Set by user.
2243 * - decoding: unused
2249 * - encoding: Set by user.
2250 * - decoding: unused
2256 * @deprecated use encoder private options instead
2258 attribute_deprecated
2259 float rc_buffer_aggressivity;
2261 attribute_deprecated
2262 float rc_initial_cplx;
2266 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2267 * - encoding: Set by user.
2268 * - decoding: unused.
2270 float rc_max_available_vbv_use;
2273 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2274 * - encoding: Set by user.
2275 * - decoding: unused.
2277 float rc_min_vbv_overflow_use;
2280 * Number of bits which should be loaded into the rc buffer before decoding starts.
2281 * - encoding: Set by user.
2282 * - decoding: unused
2284 int rc_initial_buffer_occupancy;
2286 #define FF_CODER_TYPE_VLC 0
2287 #define FF_CODER_TYPE_AC 1
2288 #define FF_CODER_TYPE_RAW 2
2289 #define FF_CODER_TYPE_RLE 3
2290 #if FF_API_UNUSED_MEMBERS
2291 #define FF_CODER_TYPE_DEFLATE 4
2292 #endif /* FF_API_UNUSED_MEMBERS */
2295 * - encoding: Set by user.
2296 * - decoding: unused
2302 * - encoding: Set by user.
2303 * - decoding: unused
2309 * @deprecated use encoder private options instead
2311 attribute_deprecated
2315 * @deprecated use encoder private options instead
2317 attribute_deprecated
2322 * frame skip threshold
2323 * - encoding: Set by user.
2324 * - decoding: unused
2326 int frame_skip_threshold;
2330 * - encoding: Set by user.
2331 * - decoding: unused
2333 int frame_skip_factor;
2336 * frame skip exponent
2337 * - encoding: Set by user.
2338 * - decoding: unused
2343 * frame skip comparison function
2344 * - encoding: Set by user.
2345 * - decoding: unused
2350 * trellis RD quantization
2351 * - encoding: Set by user.
2352 * - decoding: unused
2357 * - encoding: Set by user.
2358 * - decoding: unused
2360 int min_prediction_order;
2363 * - encoding: Set by user.
2364 * - decoding: unused
2366 int max_prediction_order;
2369 * GOP timecode frame start number, in non drop frame format
2370 * - encoding: Set by user.
2371 * - decoding: unused
2373 int64_t timecode_frame_start;
2375 #if FF_API_RTP_CALLBACK
2377 * @deprecated unused
2379 /* The RTP callback: This function is called */
2380 /* every time the encoder has a packet to send. */
2381 /* It depends on the encoder if the data starts */
2382 /* with a Start Code (it should). H.263 does. */
2383 /* mb_nb contains the number of macroblocks */
2384 /* encoded in the RTP payload. */
2385 attribute_deprecated
2386 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2389 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2390 /* do its best to deliver a chunk with size */
2391 /* below rtp_payload_size, the chunk will start */
2392 /* with a start code on some codecs like H.263. */
2393 /* This doesn't take account of any particular */
2394 /* headers inside the transmitted RTP payload. */
2396 /* statistics, used for 2-pass encoding */
2407 * number of bits used for the previously encoded frame
2408 * - encoding: Set by libavcodec.
2409 * - decoding: unused
2414 * pass1 encoding statistics output buffer
2415 * - encoding: Set by libavcodec.
2416 * - decoding: unused
2421 * pass2 encoding statistics input buffer
2422 * Concatenated stuff from stats_out of pass1 should be placed here.
2423 * - encoding: Allocated/set/freed by user.
2424 * - decoding: unused
2429 * Work around bugs in encoders which sometimes cannot be detected automatically.
2430 * - encoding: Set by user
2431 * - decoding: Set by user
2433 int workaround_bugs;
2434 #define FF_BUG_AUTODETECT 1 ///< autodetection
2435 #if FF_API_OLD_MSMPEG4
2436 #define FF_BUG_OLD_MSMPEG4 2
2438 #define FF_BUG_XVID_ILACE 4
2439 #define FF_BUG_UMP4 8
2440 #define FF_BUG_NO_PADDING 16
2441 #define FF_BUG_AMV 32
2443 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2445 #define FF_BUG_QPEL_CHROMA 64
2446 #define FF_BUG_STD_QPEL 128
2447 #define FF_BUG_QPEL_CHROMA2 256
2448 #define FF_BUG_DIRECT_BLOCKSIZE 512
2449 #define FF_BUG_EDGE 1024
2450 #define FF_BUG_HPEL_CHROMA 2048
2451 #define FF_BUG_DC_CLIP 4096
2452 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2453 #define FF_BUG_TRUNCATED 16384
2456 * strictly follow the standard (MPEG4, ...).
2457 * - encoding: Set by user.
2458 * - decoding: Set by user.
2459 * Setting this to STRICT or higher means the encoder and decoder will
2460 * generally do stupid things, whereas setting it to unofficial or lower
2461 * will mean the encoder might produce output that is not supported by all
2462 * spec-compliant decoders. Decoders don't differentiate between normal,
2463 * unofficial and experimental (that is, they always try to decode things
2464 * when they can) unless they are explicitly asked to behave stupidly
2465 * (=strictly conform to the specs)
2467 int strict_std_compliance;
2468 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2469 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2470 #define FF_COMPLIANCE_NORMAL 0
2471 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2472 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2475 * error concealment flags
2476 * - encoding: unused
2477 * - decoding: Set by user.
2479 int error_concealment;
2480 #define FF_EC_GUESS_MVS 1
2481 #define FF_EC_DEBLOCK 2
2485 * - encoding: Set by user.
2486 * - decoding: Set by user.
2489 #define FF_DEBUG_PICT_INFO 1
2490 #define FF_DEBUG_RC 2
2491 #define FF_DEBUG_BITSTREAM 4
2492 #define FF_DEBUG_MB_TYPE 8
2493 #define FF_DEBUG_QP 16
2496 * @deprecated this option does nothing
2498 #define FF_DEBUG_MV 32
2500 #define FF_DEBUG_DCT_COEFF 0x00000040
2501 #define FF_DEBUG_SKIP 0x00000080
2502 #define FF_DEBUG_STARTCODE 0x00000100
2503 #if FF_API_UNUSED_MEMBERS
2504 #define FF_DEBUG_PTS 0x00000200
2505 #endif /* FF_API_UNUSED_MEMBERS */
2506 #define FF_DEBUG_ER 0x00000400
2507 #define FF_DEBUG_MMCO 0x00000800
2508 #define FF_DEBUG_BUGS 0x00001000
2510 #define FF_DEBUG_VIS_QP 0x00002000
2511 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2513 #define FF_DEBUG_BUFFERS 0x00008000
2514 #define FF_DEBUG_THREADS 0x00010000
2518 * @deprecated this option does not have any effect
2520 attribute_deprecated
2522 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2523 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2524 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2528 * Error recognition; may misdetect some more or less valid parts as errors.
2529 * - encoding: unused
2530 * - decoding: Set by user.
2532 int err_recognition;
2535 * Verify checksums embedded in the bitstream (could be of either encoded or
2536 * decoded data, depending on the codec) and print an error message on mismatch.
2537 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2538 * decoder returning an error.
2540 #define AV_EF_CRCCHECK (1<<0)
2541 #define AV_EF_BITSTREAM (1<<1)
2542 #define AV_EF_BUFFER (1<<2)
2543 #define AV_EF_EXPLODE (1<<3)
2546 * opaque 64bit number (generally a PTS) that will be reordered and
2547 * output in AVFrame.reordered_opaque
2548 * - encoding: unused
2549 * - decoding: Set by user.
2551 int64_t reordered_opaque;
2554 * Hardware accelerator in use
2555 * - encoding: unused.
2556 * - decoding: Set by libavcodec
2558 struct AVHWAccel *hwaccel;
2561 * Hardware accelerator context.
2562 * For some hardware accelerators, a global context needs to be
2563 * provided by the user. In that case, this holds display-dependent
2564 * data Libav cannot instantiate itself. Please refer to the
2565 * Libav HW accelerator documentation to know how to fill this
2566 * is. e.g. for VA API, this is a struct vaapi_context.
2567 * - encoding: unused
2568 * - decoding: Set by user
2570 void *hwaccel_context;
2574 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2575 * - decoding: unused
2577 uint64_t error[AV_NUM_DATA_POINTERS];
2580 * DCT algorithm, see FF_DCT_* below
2581 * - encoding: Set by user.
2582 * - decoding: unused
2585 #define FF_DCT_AUTO 0
2586 #define FF_DCT_FASTINT 1
2587 #define FF_DCT_INT 2
2588 #define FF_DCT_MMX 3
2589 #define FF_DCT_ALTIVEC 5
2590 #define FF_DCT_FAAN 6
2593 * IDCT algorithm, see FF_IDCT_* below.
2594 * - encoding: Set by user.
2595 * - decoding: Set by user.
2598 #define FF_IDCT_AUTO 0
2599 #define FF_IDCT_INT 1
2600 #define FF_IDCT_SIMPLE 2
2601 #define FF_IDCT_SIMPLEMMX 3
2602 #define FF_IDCT_ARM 7
2603 #define FF_IDCT_ALTIVEC 8
2605 #define FF_IDCT_SH4 9
2607 #define FF_IDCT_SIMPLEARM 10
2608 #if FF_API_UNUSED_MEMBERS
2609 #define FF_IDCT_IPP 13
2610 #endif /* FF_API_UNUSED_MEMBERS */
2611 #define FF_IDCT_XVID 14
2612 #if FF_API_IDCT_XVIDMMX
2613 #define FF_IDCT_XVIDMMX 14
2614 #endif /* FF_API_IDCT_XVIDMMX */
2615 #define FF_IDCT_SIMPLEARMV5TE 16
2616 #define FF_IDCT_SIMPLEARMV6 17
2617 #if FF_API_ARCH_SPARC
2618 #define FF_IDCT_SIMPLEVIS 18
2620 #define FF_IDCT_FAAN 20
2621 #define FF_IDCT_SIMPLENEON 22
2622 #if FF_API_ARCH_ALPHA
2623 #define FF_IDCT_SIMPLEALPHA 23
2627 * bits per sample/pixel from the demuxer (needed for huffyuv).
2628 * - encoding: Set by libavcodec.
2629 * - decoding: Set by user.
2631 int bits_per_coded_sample;
2634 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2635 * - encoding: set by user.
2636 * - decoding: set by libavcodec.
2638 int bits_per_raw_sample;
2642 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2643 * - encoding: unused
2644 * - decoding: Set by user.
2646 * @deprecated use decoder private options instead
2648 attribute_deprecated int lowres;
2651 #if FF_API_CODED_FRAME
2653 * the picture in the bitstream
2654 * - encoding: Set by libavcodec.
2655 * - decoding: unused
2657 * @deprecated use the quality factor packet side data instead
2659 attribute_deprecated AVFrame *coded_frame;
2664 * is used to decide how many independent tasks should be passed to execute()
2665 * - encoding: Set by user.
2666 * - decoding: Set by user.
2671 * Which multithreading methods to use.
2672 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2673 * so clients which cannot provide future frames should not use it.
2675 * - encoding: Set by user, otherwise the default is used.
2676 * - decoding: Set by user, otherwise the default is used.
2679 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2680 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2683 * Which multithreading methods are in use by the codec.
2684 * - encoding: Set by libavcodec.
2685 * - decoding: Set by libavcodec.
2687 int active_thread_type;
2690 * Set by the client if its custom get_buffer() callback can be called
2691 * synchronously from another thread, which allows faster multithreaded decoding.
2692 * draw_horiz_band() will be called from other threads regardless of this setting.
2693 * Ignored if the default get_buffer() is used.
2694 * - encoding: Set by user.
2695 * - decoding: Set by user.
2697 int thread_safe_callbacks;
2700 * The codec may call this to execute several independent things.
2701 * It will return only after finishing all tasks.
2702 * The user may replace this with some multithreaded implementation,
2703 * the default implementation will execute the parts serially.
2704 * @param count the number of things to execute
2705 * - encoding: Set by libavcodec, user can override.
2706 * - decoding: Set by libavcodec, user can override.
2708 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2711 * The codec may call this to execute several independent things.
2712 * It will return only after finishing all tasks.
2713 * The user may replace this with some multithreaded implementation,
2714 * the default implementation will execute the parts serially.
2715 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2716 * @param c context passed also to func
2717 * @param count the number of things to execute
2718 * @param arg2 argument passed unchanged to func
2719 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2720 * @param func function that will be called count times, with jobnr from 0 to count-1.
2721 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2722 * two instances of func executing at the same time will have the same threadnr.
2723 * @return always 0 currently, but code should handle a future improvement where when any call to func
2724 * returns < 0 no further calls to func may be done and < 0 is returned.
2725 * - encoding: Set by libavcodec, user can override.
2726 * - decoding: Set by libavcodec, user can override.
2728 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2731 * noise vs. sse weight for the nsse comparsion function
2732 * - encoding: Set by user.
2733 * - decoding: unused
2739 * - encoding: Set by user.
2740 * - decoding: Set by libavcodec.
2743 #define FF_PROFILE_UNKNOWN -99
2744 #define FF_PROFILE_RESERVED -100
2746 #define FF_PROFILE_AAC_MAIN 0
2747 #define FF_PROFILE_AAC_LOW 1
2748 #define FF_PROFILE_AAC_SSR 2
2749 #define FF_PROFILE_AAC_LTP 3
2750 #define FF_PROFILE_AAC_HE 4
2751 #define FF_PROFILE_AAC_HE_V2 28
2752 #define FF_PROFILE_AAC_LD 22
2753 #define FF_PROFILE_AAC_ELD 38
2754 #define FF_PROFILE_MPEG2_AAC_LOW 128
2755 #define FF_PROFILE_MPEG2_AAC_HE 131
2757 #define FF_PROFILE_DTS 20
2758 #define FF_PROFILE_DTS_ES 30
2759 #define FF_PROFILE_DTS_96_24 40
2760 #define FF_PROFILE_DTS_HD_HRA 50
2761 #define FF_PROFILE_DTS_HD_MA 60
2762 #define FF_PROFILE_DTS_EXPRESS 70
2764 #define FF_PROFILE_MPEG2_422 0
2765 #define FF_PROFILE_MPEG2_HIGH 1
2766 #define FF_PROFILE_MPEG2_SS 2
2767 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2768 #define FF_PROFILE_MPEG2_MAIN 4
2769 #define FF_PROFILE_MPEG2_SIMPLE 5
2771 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2772 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2774 #define FF_PROFILE_H264_BASELINE 66
2775 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2776 #define FF_PROFILE_H264_MAIN 77
2777 #define FF_PROFILE_H264_EXTENDED 88
2778 #define FF_PROFILE_H264_HIGH 100
2779 #define FF_PROFILE_H264_HIGH_10 110
2780 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2781 #define FF_PROFILE_H264_HIGH_422 122
2782 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2783 #define FF_PROFILE_H264_HIGH_444 144
2784 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2785 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2786 #define FF_PROFILE_H264_CAVLC_444 44
2788 #define FF_PROFILE_VC1_SIMPLE 0
2789 #define FF_PROFILE_VC1_MAIN 1
2790 #define FF_PROFILE_VC1_COMPLEX 2
2791 #define FF_PROFILE_VC1_ADVANCED 3
2793 #define FF_PROFILE_MPEG4_SIMPLE 0
2794 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2795 #define FF_PROFILE_MPEG4_CORE 2
2796 #define FF_PROFILE_MPEG4_MAIN 3
2797 #define FF_PROFILE_MPEG4_N_BIT 4
2798 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2799 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2800 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2801 #define FF_PROFILE_MPEG4_HYBRID 8
2802 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2803 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2804 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2805 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2806 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2807 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2808 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2810 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2811 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2812 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2813 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2814 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2816 #define FF_PROFILE_VP9_0 0
2817 #define FF_PROFILE_VP9_1 1
2818 #define FF_PROFILE_VP9_2 2
2819 #define FF_PROFILE_VP9_3 3
2821 #define FF_PROFILE_HEVC_MAIN 1
2822 #define FF_PROFILE_HEVC_MAIN_10 2
2823 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2827 * - encoding: Set by user.
2828 * - decoding: Set by libavcodec.
2831 #define FF_LEVEL_UNKNOWN -99
2835 * - encoding: unused
2836 * - decoding: Set by user.
2838 enum AVDiscard skip_loop_filter;
2842 * - encoding: unused
2843 * - decoding: Set by user.
2845 enum AVDiscard skip_idct;
2849 * - encoding: unused
2850 * - decoding: Set by user.
2852 enum AVDiscard skip_frame;
2855 * Header containing style information for text subtitles.
2856 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2857 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2858 * the Format line following. It shouldn't include any Dialogue line.
2859 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2860 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2862 uint8_t *subtitle_header;
2863 int subtitle_header_size;
2865 #if FF_API_ERROR_RATE
2867 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2870 attribute_deprecated
2875 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2876 * Used for compliant TS muxing.
2877 * - encoding: Set by libavcodec.
2878 * - decoding: unused.
2882 #if FF_API_SIDEDATA_ONLY_PKT
2884 * Encoding only and set by default. Allow encoders to output packets
2885 * that do not contain any encoded data, only side data.
2887 * Some encoders need to output such packets, e.g. to update some stream
2888 * parameters at the end of encoding.
2890 * @deprecated this field disables the default behaviour and
2891 * it is kept only for compatibility.
2893 attribute_deprecated
2894 int side_data_only_packets;
2898 * Audio only. The number of "priming" samples (padding) inserted by the
2899 * encoder at the beginning of the audio. I.e. this number of leading
2900 * decoded samples must be discarded by the caller to get the original audio
2901 * without leading padding.
2903 * - decoding: unused
2904 * - encoding: Set by libavcodec. The timestamps on the output packets are
2905 * adjusted by the encoder so that they always refer to the
2906 * first sample of the data actually contained in the packet,
2907 * including any added padding. E.g. if the timebase is
2908 * 1/samplerate and the timestamp of the first input sample is
2909 * 0, the timestamp of the first output packet will be
2912 int initial_padding;
2915 * - decoding: For codecs that store a framerate value in the compressed
2916 * bitstream, the decoder may export it here. { 0, 1} when
2918 * - encoding: unused
2920 AVRational framerate;
2923 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2924 * - encoding: unused.
2925 * - decoding: Set by libavcodec before calling get_format()
2927 enum AVPixelFormat sw_pix_fmt;
2933 typedef struct AVProfile {
2935 const char *name; ///< short name for the profile
2938 typedef struct AVCodecDefault AVCodecDefault;
2945 typedef struct AVCodec {
2947 * Name of the codec implementation.
2948 * The name is globally unique among encoders and among decoders (but an
2949 * encoder and a decoder can share the same name).
2950 * This is the primary way to find a codec from the user perspective.
2954 * Descriptive name for the codec, meant to be more human readable than name.
2955 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2957 const char *long_name;
2958 enum AVMediaType type;
2961 * Codec capabilities.
2962 * see AV_CODEC_CAP_*
2965 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2966 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2967 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2968 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2969 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2971 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2973 const AVClass *priv_class; ///< AVClass for the private context
2974 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2976 /*****************************************************************
2977 * No fields below this line are part of the public API. They
2978 * may not be used outside of libavcodec and can be changed and
2980 * New public fields should be added right above.
2981 *****************************************************************
2984 struct AVCodec *next;
2986 * @name Frame-level threading support functions
2990 * If defined, called on thread contexts when they are created.
2991 * If the codec allocates writable tables in init(), re-allocate them here.
2992 * priv_data will be set to a copy of the original.
2994 int (*init_thread_copy)(AVCodecContext *);
2996 * Copy necessary context variables from a previous thread context to the current one.
2997 * If not defined, the next thread will start automatically; otherwise, the codec
2998 * must call ff_thread_finish_setup().
3000 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3002 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3006 * Private codec-specific defaults.
3008 const AVCodecDefault *defaults;
3011 * Initialize codec static data, called from avcodec_register().
3013 void (*init_static_data)(struct AVCodec *codec);
3015 int (*init)(AVCodecContext *);
3016 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3017 const struct AVSubtitle *sub);
3019 * Encode data to an AVPacket.
3021 * @param avctx codec context
3022 * @param avpkt output AVPacket (may contain a user-provided buffer)
3023 * @param[in] frame AVFrame containing the raw data to be encoded
3024 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3025 * non-empty packet was returned in avpkt.
3026 * @return 0 on success, negative error code on failure
3028 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3029 int *got_packet_ptr);
3030 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3031 int (*close)(AVCodecContext *);
3034 * Will be called when seeking
3036 void (*flush)(AVCodecContext *);
3038 * Internal codec capabilities.
3039 * See FF_CODEC_CAP_* in internal.h
3045 * @defgroup lavc_hwaccel AVHWAccel
3048 typedef struct AVHWAccel {
3050 * Name of the hardware accelerated codec.
3051 * The name is globally unique among encoders and among decoders (but an
3052 * encoder and a decoder can share the same name).
3057 * Type of codec implemented by the hardware accelerator.
3059 * See AVMEDIA_TYPE_xxx
3061 enum AVMediaType type;
3064 * Codec implemented by the hardware accelerator.
3066 * See AV_CODEC_ID_xxx
3071 * Supported pixel format.
3073 * Only hardware accelerated formats are supported here.
3075 enum AVPixelFormat pix_fmt;
3078 * Hardware accelerated codec capabilities.
3079 * see FF_HWACCEL_CODEC_CAP_*
3083 /*****************************************************************
3084 * No fields below this line are part of the public API. They
3085 * may not be used outside of libavcodec and can be changed and
3087 * New public fields should be added right above.
3088 *****************************************************************
3090 struct AVHWAccel *next;
3093 * Allocate a custom buffer
3095 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3098 * Called at the beginning of each frame or field picture.
3100 * Meaningful frame information (codec specific) is guaranteed to
3101 * be parsed at this point. This function is mandatory.
3103 * Note that buf can be NULL along with buf_size set to 0.
3104 * Otherwise, this means the whole frame is available at this point.
3106 * @param avctx the codec context
3107 * @param buf the frame data buffer base
3108 * @param buf_size the size of the frame in bytes
3109 * @return zero if successful, a negative value otherwise
3111 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3114 * Callback for each slice.
3116 * Meaningful slice information (codec specific) is guaranteed to
3117 * be parsed at this point. This function is mandatory.
3119 * @param avctx the codec context
3120 * @param buf the slice data buffer base
3121 * @param buf_size the size of the slice in bytes
3122 * @return zero if successful, a negative value otherwise
3124 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3127 * Called at the end of each frame or field picture.
3129 * The whole picture is parsed at this point and can now be sent
3130 * to the hardware accelerator. This function is mandatory.
3132 * @param avctx the codec context
3133 * @return zero if successful, a negative value otherwise
3135 int (*end_frame)(AVCodecContext *avctx);
3138 * Size of per-frame hardware accelerator private data.
3140 * Private data is allocated with av_mallocz() before
3141 * AVCodecContext.get_buffer() and deallocated after
3142 * AVCodecContext.release_buffer().
3144 int frame_priv_data_size;
3147 * Initialize the hwaccel private data.
3149 * This will be called from ff_get_format(), after hwaccel and
3150 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3153 int (*init)(AVCodecContext *avctx);
3156 * Uninitialize the hwaccel private data.
3158 * This will be called from get_format() or avcodec_close(), after hwaccel
3159 * and hwaccel_context are already uninitialized.
3161 int (*uninit)(AVCodecContext *avctx);
3164 * Size of the private data to allocate in
3165 * AVCodecInternal.hwaccel_priv_data.
3171 * Hardware acceleration should be used for decoding even if the codec level
3172 * used is unknown or higher than the maximum supported level reported by the
3175 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3178 * Hardware acceleration can output YUV pixel formats with a different chroma
3179 * sampling than 4:2:0 and/or other than 8 bits per component.
3181 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3187 #if FF_API_AVPICTURE
3189 * @defgroup lavc_picture AVPicture
3191 * Functions for working with AVPicture
3196 * four components are given, that's all.
3197 * the last component is alpha
3198 * @deprecated Use the imgutils functions
3200 typedef struct AVPicture {
3201 attribute_deprecated
3202 uint8_t *data[AV_NUM_DATA_POINTERS];
3203 attribute_deprecated
3204 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3212 #define AVPALETTE_SIZE 1024
3213 #define AVPALETTE_COUNT 256
3215 enum AVSubtitleType {
3218 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3221 * Plain text, the text field must be set by the decoder and is
3222 * authoritative. ass and pict fields may contain approximations.
3227 * Formatted text, the ass field must be set by the decoder and is
3228 * authoritative. pict and text fields may contain approximations.
3233 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3235 typedef struct AVSubtitleRect {
3236 int x; ///< top left corner of pict, undefined when pict is not set
3237 int y; ///< top left corner of pict, undefined when pict is not set
3238 int w; ///< width of pict, undefined when pict is not set
3239 int h; ///< height of pict, undefined when pict is not set
3240 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3242 #if FF_API_AVPICTURE
3244 * @deprecated unused
3246 attribute_deprecated
3250 * data+linesize for the bitmap of this subtitle.
3251 * Can be set for text/ass as well once they are rendered.
3256 enum AVSubtitleType type;
3258 char *text; ///< 0 terminated plain UTF-8 text
3261 * 0 terminated ASS/SSA compatible event line.
3262 * The pressentation of this is unaffected by the other values in this
3269 typedef struct AVSubtitle {
3270 uint16_t format; /* 0 = graphics */
3271 uint32_t start_display_time; /* relative to packet pts, in ms */
3272 uint32_t end_display_time; /* relative to packet pts, in ms */
3274 AVSubtitleRect **rects;
3275 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3279 * If c is NULL, returns the first registered codec,
3280 * if c is non-NULL, returns the next registered codec after c,
3281 * or NULL if c is the last one.
3283 AVCodec *av_codec_next(const AVCodec *c);
3286 * Return the LIBAVCODEC_VERSION_INT constant.
3288 unsigned avcodec_version(void);
3291 * Return the libavcodec build-time configuration.
3293 const char *avcodec_configuration(void);
3296 * Return the libavcodec license.
3298 const char *avcodec_license(void);
3301 * Register the codec codec and initialize libavcodec.
3303 * @warning either this function or avcodec_register_all() must be called
3304 * before any other libavcodec functions.
3306 * @see avcodec_register_all()
3308 void avcodec_register(AVCodec *codec);
3311 * Register all the codecs, parsers and bitstream filters which were enabled at
3312 * configuration time. If you do not call this function you can select exactly
3313 * which formats you want to support, by using the individual registration
3316 * @see avcodec_register
3317 * @see av_register_codec_parser
3318 * @see av_register_bitstream_filter
3320 void avcodec_register_all(void);
3323 * Allocate an AVCodecContext and set its fields to default values. The
3324 * resulting struct should be freed with avcodec_free_context().
3326 * @param codec if non-NULL, allocate private data and initialize defaults
3327 * for the given codec. It is illegal to then call avcodec_open2()
3328 * with a different codec.
3329 * If NULL, then the codec-specific defaults won't be initialized,
3330 * which may result in suboptimal default settings (this is
3331 * important mainly for encoders, e.g. libx264).
3333 * @return An AVCodecContext filled with default values or NULL on failure.
3334 * @see avcodec_get_context_defaults
3336 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3339 * Free the codec context and everything associated with it and write NULL to
3340 * the provided pointer.
3342 void avcodec_free_context(AVCodecContext **avctx);
3345 * Set the fields of the given AVCodecContext to default values corresponding
3346 * to the given codec (defaults may be codec-dependent).
3348 * Do not call this function if a non-NULL codec has been passed
3349 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3350 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3351 * different codec on this AVCodecContext.
3353 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3356 * Get the AVClass for AVCodecContext. It can be used in combination with
3357 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3359 * @see av_opt_find().
3361 const AVClass *avcodec_get_class(void);
3364 * Copy the settings of the source AVCodecContext into the destination
3365 * AVCodecContext. The resulting destination codec context will be
3366 * unopened, i.e. you are required to call avcodec_open2() before you
3367 * can use this AVCodecContext to decode/encode video/audio data.
3369 * @param dest target codec context, should be initialized with
3370 * avcodec_alloc_context3(), but otherwise uninitialized
3371 * @param src source codec context
3372 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3374 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3377 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3378 * function the context has to be allocated with avcodec_alloc_context3().
3380 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3381 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3382 * retrieving a codec.
3384 * @warning This function is not thread safe!
3386 * @note Always call this function before using decoding routines (such as
3387 * @ref avcodec_decode_video2()).
3390 * avcodec_register_all();
3391 * av_dict_set(&opts, "b", "2.5M", 0);
3392 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3396 * context = avcodec_alloc_context3(codec);
3398 * if (avcodec_open2(context, codec, opts) < 0)
3402 * @param avctx The context to initialize.
3403 * @param codec The codec to open this context for. If a non-NULL codec has been
3404 * previously passed to avcodec_alloc_context3() or
3405 * avcodec_get_context_defaults3() for this context, then this
3406 * parameter MUST be either NULL or equal to the previously passed
3408 * @param options A dictionary filled with AVCodecContext and codec-private options.
3409 * On return this object will be filled with options that were not found.
3411 * @return zero on success, a negative value on error
3412 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3413 * av_dict_set(), av_opt_find().
3415 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3418 * Close a given AVCodecContext and free all the data associated with it
3419 * (but not the AVCodecContext itself).
3421 * Calling this function on an AVCodecContext that hasn't been opened will free
3422 * the codec-specific data allocated in avcodec_alloc_context3() /
3423 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3426 int avcodec_close(AVCodecContext *avctx);
3429 * Free all allocated data in the given subtitle struct.
3431 * @param sub AVSubtitle to free.
3433 void avsubtitle_free(AVSubtitle *sub);
3440 * @addtogroup lavc_packet
3445 * Allocate an AVPacket and set its fields to default values. The resulting
3446 * struct must be freed using av_packet_free().
3448 * @return An AVPacket filled with default values or NULL on failure.
3450 * @note this only allocates the AVPacket itself, not the data buffers. Those
3451 * must be allocated through other means such as av_new_packet.
3453 * @see av_new_packet
3455 AVPacket *av_packet_alloc(void);
3458 * Create a new packet that references the same data as src.
3460 * This is a shortcut for av_packet_alloc()+av_packet_ref().
3462 * @return newly created AVPacket on success, NULL on error.
3464 * @see av_packet_alloc
3465 * @see av_packet_ref
3467 AVPacket *av_packet_clone(AVPacket *src);
3470 * Free the packet, if the packet is reference counted, it will be
3471 * unreferenced first.
3473 * @param packet packet to be freed. The pointer will be set to NULL.
3474 * @note passing NULL is a no-op.
3476 void av_packet_free(AVPacket **pkt);
3479 * Initialize optional fields of a packet with default values.
3481 * Note, this does not touch the data and size members, which have to be
3482 * initialized separately.
3486 void av_init_packet(AVPacket *pkt);
3489 * Allocate the payload of a packet and initialize its fields with
3493 * @param size wanted payload size
3494 * @return 0 if OK, AVERROR_xxx otherwise
3496 int av_new_packet(AVPacket *pkt, int size);
3499 * Reduce packet size, correctly zeroing padding
3502 * @param size new size
3504 void av_shrink_packet(AVPacket *pkt, int size);
3507 * Increase packet size, correctly zeroing padding
3510 * @param grow_by number of bytes by which to increase the size of the packet
3512 int av_grow_packet(AVPacket *pkt, int grow_by);
3515 * Initialize a reference-counted packet from av_malloc()ed data.
3517 * @param pkt packet to be initialized. This function will set the data, size,
3518 * buf and destruct fields, all others are left untouched.
3519 * @param data Data allocated by av_malloc() to be used as packet data. If this
3520 * function returns successfully, the data is owned by the underlying AVBuffer.
3521 * The caller may not access the data through other means.
3522 * @param size size of data in bytes, without the padding. I.e. the full buffer
3523 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
3525 * @return 0 on success, a negative AVERROR on error
3527 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3529 #if FF_API_AVPACKET_OLD_API
3531 * @warning This is a hack - the packet memory allocation stuff is broken. The
3532 * packet is allocated if it was not really allocated.
3534 * @deprecated Use av_packet_ref
3536 attribute_deprecated
3537 int av_dup_packet(AVPacket *pkt);
3541 * @deprecated Use av_packet_unref
3543 * @param pkt packet to free
3545 attribute_deprecated
3546 void av_free_packet(AVPacket *pkt);
3549 * Allocate new information of a packet.
3552 * @param type side information type
3553 * @param size side information size
3554 * @return pointer to fresh allocated data or NULL otherwise
3556 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3560 * Shrink the already allocated side data buffer
3563 * @param type side information type
3564 * @param size new side information size
3565 * @return 0 on success, < 0 on failure
3567 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3571 * Get side information from packet.
3574 * @param type desired side information type
3575 * @param size pointer for side information size to store (optional)
3576 * @return pointer to data if present or NULL otherwise
3578 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3582 * Convenience function to free all the side data stored.
3583 * All the other fields stay untouched.
3587 void av_packet_free_side_data(AVPacket *pkt);
3590 * Setup a new reference to the data described by a given packet
3592 * If src is reference-counted, setup dst as a new reference to the
3593 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3594 * data from src into it.
3596 * All the other fields are copied from src.
3598 * @see av_packet_unref
3600 * @param dst Destination packet
3601 * @param src Source packet
3603 * @return 0 on success, a negative AVERROR on error.
3605 int av_packet_ref(AVPacket *dst, AVPacket *src);
3610 * Unreference the buffer referenced by the packet and reset the
3611 * remaining packet fields to their default values.
3613 * @param pkt The packet to be unreferenced.
3615 void av_packet_unref(AVPacket *pkt);
3618 * Move every field in src to dst and reset src.
3620 * @see av_packet_unref
3622 * @param src Source packet, will be reset
3623 * @param dst Destination packet
3625 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3628 * Copy only "properties" fields from src to dst.
3630 * Properties for the purpose of this function are all the fields
3631 * beside those related to the packet data (buf, data, size)
3633 * @param dst Destination packet
3634 * @param src Source packet
3636 * @return 0 on success AVERROR on failure.
3639 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3642 * Convert valid timing fields (timestamps / durations) in a packet from one
3643 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3646 * @param pkt packet on which the conversion will be performed
3647 * @param tb_src source timebase, in which the timing fields in pkt are
3649 * @param tb_dst destination timebase, to which the timing fields will be
3652 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
3659 * @addtogroup lavc_decoding
3664 * Find a registered decoder with a matching codec ID.
3666 * @param id AVCodecID of the requested decoder
3667 * @return A decoder if one was found, NULL otherwise.
3669 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3672 * Find a registered decoder with the specified name.
3674 * @param name name of the requested decoder
3675 * @return A decoder if one was found, NULL otherwise.
3677 AVCodec *avcodec_find_decoder_by_name(const char *name);
3680 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3681 * it can be called by custom get_buffer2() implementations for decoders without
3682 * AV_CODEC_CAP_DR1 set.
3684 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3688 * Return the amount of padding in pixels which the get_buffer callback must
3689 * provide around the edge of the image for codecs which do not have the
3690 * CODEC_FLAG_EMU_EDGE flag.
3692 * @return Required padding in pixels.
3694 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
3697 attribute_deprecated
3698 unsigned avcodec_get_edge_width(void);
3702 * Modify width and height values so that they will result in a memory
3703 * buffer that is acceptable for the codec if you do not use any horizontal
3706 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3708 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3711 * Modify width and height values so that they will result in a memory
3712 * buffer that is acceptable for the codec if you also ensure that all
3713 * line sizes are a multiple of the respective linesize_align[i].
3715 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3717 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3718 int linesize_align[AV_NUM_DATA_POINTERS]);
3721 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3723 * Some decoders may support multiple frames in a single AVPacket. Such
3724 * decoders would then just decode the first frame and the return value would be
3725 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3726 * called again with an AVPacket containing the remaining data in order to
3727 * decode the second frame, etc... Even if no frames are returned, the packet
3728 * needs to be fed to the decoder with remaining data until it is completely
3729 * consumed or an error occurs.
3731 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3732 * and output. This means that for some packets they will not immediately
3733 * produce decoded output and need to be flushed at the end of decoding to get
3734 * all the decoded data. Flushing is done by calling this function with packets
3735 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3736 * returning samples. It is safe to flush even those decoders that are not
3737 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
3739 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3740 * larger than the actual read bytes because some optimized bitstream
3741 * readers read 32 or 64 bits at once and could read over the end.
3743 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3744 * before packets may be fed to the decoder.
3746 * @param avctx the codec context
3747 * @param[out] frame The AVFrame in which to store decoded audio samples.
3748 * The decoder will allocate a buffer for the decoded frame by
3749 * calling the AVCodecContext.get_buffer2() callback.
3750 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3751 * reference counted and the returned reference belongs to the
3752 * caller. The caller must release the frame using av_frame_unref()
3753 * when the frame is no longer needed. The caller may safely write
3754 * to the frame if av_frame_is_writable() returns 1.
3755 * When AVCodecContext.refcounted_frames is set to 0, the returned
3756 * reference belongs to the decoder and is valid only until the
3757 * next call to this function or until closing or flushing the
3758 * decoder. The caller may not write to it.
3759 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3760 * non-zero. Note that this field being set to zero
3761 * does not mean that an error has occurred. For
3762 * decoders with AV_CODEC_CAP_DELAY set, no given decode
3763 * call is guaranteed to produce a frame.
3764 * @param[in] avpkt The input AVPacket containing the input buffer.
3765 * At least avpkt->data and avpkt->size should be set. Some
3766 * decoders might also require additional fields to be set.
3767 * @return A negative error code is returned if an error occurred during
3768 * decoding, otherwise the number of bytes consumed from the input
3769 * AVPacket is returned.
3771 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3772 int *got_frame_ptr, AVPacket *avpkt);
3775 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3776 * Some decoders may support multiple frames in a single AVPacket, such
3777 * decoders would then just decode the first frame.
3779 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
3780 * the actual read bytes because some optimized bitstream readers read 32 or 64
3781 * bits at once and could read over the end.
3783 * @warning The end of the input buffer buf should be set to 0 to ensure that
3784 * no overreading happens for damaged MPEG streams.
3786 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
3787 * between input and output, these need to be fed with avpkt->data=NULL,
3788 * avpkt->size=0 at the end to return the remaining frames.
3790 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3791 * before packets may be fed to the decoder.
3793 * @param avctx the codec context
3794 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3795 * Use av_frame_alloc() to get an AVFrame. The codec will
3796 * allocate memory for the actual bitmap by calling the
3797 * AVCodecContext.get_buffer2() callback.
3798 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3799 * reference counted and the returned reference belongs to the
3800 * caller. The caller must release the frame using av_frame_unref()
3801 * when the frame is no longer needed. The caller may safely write
3802 * to the frame if av_frame_is_writable() returns 1.
3803 * When AVCodecContext.refcounted_frames is set to 0, the returned
3804 * reference belongs to the decoder and is valid only until the
3805 * next call to this function or until closing or flushing the
3806 * decoder. The caller may not write to it.
3808 * @param[in] avpkt The input AVpacket containing the input buffer.
3809 * You can create such packet with av_init_packet() and by then setting
3810 * data and size, some decoders might in addition need other fields like
3811 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3813 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3814 * @return On error a negative value is returned, otherwise the number of bytes
3815 * used or zero if no frame could be decompressed.
3817 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3818 int *got_picture_ptr,
3822 * Decode a subtitle message.
3823 * Return a negative value on error, otherwise return the number of bytes used.
3824 * If no subtitle could be decompressed, got_sub_ptr is zero.
3825 * Otherwise, the subtitle is stored in *sub.
3826 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3827 * simplicity, because the performance difference is expect to be negligible
3828 * and reusing a get_buffer written for video codecs would probably perform badly
3829 * due to a potentially very different allocation pattern.
3831 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3832 * before packets may be fed to the decoder.
3834 * @param avctx the codec context
3835 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3836 freed with avsubtitle_free if *got_sub_ptr is set.
3837 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3838 * @param[in] avpkt The input AVPacket containing the input buffer.
3840 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3845 * @defgroup lavc_parsing Frame parsing
3849 enum AVPictureStructure {
3850 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3851 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3852 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3853 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3856 typedef struct AVCodecParserContext {
3858 struct AVCodecParser *parser;
3859 int64_t frame_offset; /* offset of the current frame */
3860 int64_t cur_offset; /* current offset
3861 (incremented by each av_parser_parse()) */
3862 int64_t next_frame_offset; /* offset of the next frame */
3864 int pict_type; /* XXX: Put it back in AVCodecContext. */
3866 * This field is used for proper frame duration computation in lavf.
3867 * It signals, how much longer the frame duration of the current frame
3868 * is compared to normal frame duration.
3870 * frame_duration = (1 + repeat_pict) * time_base
3872 * It is used by codecs like H.264 to display telecined material.
3874 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3875 int64_t pts; /* pts of the current frame */
3876 int64_t dts; /* dts of the current frame */
3881 int fetch_timestamp;
3883 #define AV_PARSER_PTS_NB 4
3884 int cur_frame_start_index;
3885 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3886 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3887 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3890 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3891 #define PARSER_FLAG_ONCE 0x0002
3892 /// Set if the parser has a valid file offset
3893 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3895 int64_t offset; ///< byte offset from starting packet start
3896 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3899 * Set by parser to 1 for key frames and 0 for non-key frames.
3900 * It is initialized to -1, so if the parser doesn't set this flag,
3901 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3906 #if FF_API_CONVERGENCE_DURATION
3908 * @deprecated unused
3910 attribute_deprecated
3911 int64_t convergence_duration;
3914 // Timestamp generation support:
3916 * Synchronization point for start of timestamp generation.
3918 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3921 * For example, this corresponds to presence of H.264 buffering period
3927 * Offset of the current timestamp against last timestamp sync point in
3928 * units of AVCodecContext.time_base.
3930 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3931 * contain a valid timestamp offset.
3933 * Note that the timestamp of sync point has usually a nonzero
3934 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3935 * the next frame after timestamp sync point will be usually 1.
3937 * For example, this corresponds to H.264 cpb_removal_delay.
3939 int dts_ref_dts_delta;
3942 * Presentation delay of current frame in units of AVCodecContext.time_base.
3944 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3945 * contain valid non-negative timestamp delta (presentation time of a frame
3946 * must not lie in the past).
3948 * This delay represents the difference between decoding and presentation
3949 * time of the frame.
3951 * For example, this corresponds to H.264 dpb_output_delay.
3956 * Position of the packet in file.
3958 * Analogous to cur_frame_pts/dts
3960 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3963 * Byte position of currently parsed frame in stream.
3968 * Previous frame byte position.
3973 * Duration of the current frame.
3974 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3975 * For all other types, this is in units of AVCodecContext.time_base.
3979 enum AVFieldOrder field_order;
3982 * Indicate whether a picture is coded as a frame, top field or bottom field.
3984 * For example, H.264 field_pic_flag equal to 0 corresponds to
3985 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3986 * equal to 1 and bottom_field_flag equal to 0 corresponds to
3987 * AV_PICTURE_STRUCTURE_TOP_FIELD.
3989 enum AVPictureStructure picture_structure;
3992 * Picture number incremented in presentation or output order.
3993 * This field may be reinitialized at the first picture of a new sequence.
3995 * For example, this corresponds to H.264 PicOrderCnt.
3997 int output_picture_number;
4000 * Dimensions of the decoded video intended for presentation.
4006 * Dimensions of the coded video.
4012 * The format of the coded data, corresponds to enum AVPixelFormat for video
4013 * and for enum AVSampleFormat for audio.
4015 * Note that a decoder can have considerable freedom in how exactly it
4016 * decodes the data, so the format reported here might be different from the
4017 * one returned by a decoder.
4020 } AVCodecParserContext;
4022 typedef struct AVCodecParser {
4023 int codec_ids[5]; /* several codec IDs are permitted */
4025 int (*parser_init)(AVCodecParserContext *s);
4026 /* This callback never returns an error, a negative value means that
4027 * the frame start was in a previous packet. */
4028 int (*parser_parse)(AVCodecParserContext *s,
4029 AVCodecContext *avctx,
4030 const uint8_t **poutbuf, int *poutbuf_size,
4031 const uint8_t *buf, int buf_size);
4032 void (*parser_close)(AVCodecParserContext *s);
4033 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4034 struct AVCodecParser *next;
4037 AVCodecParser *av_parser_next(const AVCodecParser *c);
4039 void av_register_codec_parser(AVCodecParser *parser);
4040 AVCodecParserContext *av_parser_init(int codec_id);
4045 * @param s parser context.
4046 * @param avctx codec context.
4047 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4048 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4049 * @param buf input buffer.
4050 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4051 * @param pts input presentation timestamp.
4052 * @param dts input decoding timestamp.
4053 * @param pos input byte position in stream.
4054 * @return the number of bytes of the input bitstream used.
4059 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4066 * decode_frame(data, size);
4070 int av_parser_parse2(AVCodecParserContext *s,
4071 AVCodecContext *avctx,
4072 uint8_t **poutbuf, int *poutbuf_size,
4073 const uint8_t *buf, int buf_size,
4074 int64_t pts, int64_t dts,
4078 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4079 * @deprecated use AVBitstreamFilter
4081 int av_parser_change(AVCodecParserContext *s,
4082 AVCodecContext *avctx,
4083 uint8_t **poutbuf, int *poutbuf_size,
4084 const uint8_t *buf, int buf_size, int keyframe);
4085 void av_parser_close(AVCodecParserContext *s);
4093 * @addtogroup lavc_encoding
4098 * Find a registered encoder with a matching codec ID.
4100 * @param id AVCodecID of the requested encoder
4101 * @return An encoder if one was found, NULL otherwise.
4103 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4106 * Find a registered encoder with the specified name.
4108 * @param name name of the requested encoder
4109 * @return An encoder if one was found, NULL otherwise.
4111 AVCodec *avcodec_find_encoder_by_name(const char *name);
4114 * Encode a frame of audio.
4116 * Takes input samples from frame and writes the next output packet, if
4117 * available, to avpkt. The output packet does not necessarily contain data for
4118 * the most recent frame, as encoders can delay, split, and combine input frames
4119 * internally as needed.
4121 * @param avctx codec context
4122 * @param avpkt output AVPacket.
4123 * The user can supply an output buffer by setting
4124 * avpkt->data and avpkt->size prior to calling the
4125 * function, but if the size of the user-provided data is not
4126 * large enough, encoding will fail. All other AVPacket fields
4127 * will be reset by the encoder using av_init_packet(). If
4128 * avpkt->data is NULL, the encoder will allocate it.
4129 * The encoder will set avpkt->size to the size of the
4132 * If this function fails or produces no output, avpkt will be
4133 * freed using av_packet_unref().
4134 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4135 * May be NULL when flushing an encoder that has the
4136 * AV_CODEC_CAP_DELAY capability set.
4137 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4138 * can have any number of samples.
4139 * If it is not set, frame->nb_samples must be equal to
4140 * avctx->frame_size for all frames except the last.
4141 * The final frame may be smaller than avctx->frame_size.
4142 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4143 * output packet is non-empty, and to 0 if it is
4144 * empty. If the function returns an error, the
4145 * packet can be assumed to be invalid, and the
4146 * value of got_packet_ptr is undefined and should
4148 * @return 0 on success, negative error code on failure
4150 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4151 const AVFrame *frame, int *got_packet_ptr);
4154 * Encode a frame of video.
4156 * Takes input raw video data from frame and writes the next output packet, if
4157 * available, to avpkt. The output packet does not necessarily contain data for
4158 * the most recent frame, as encoders can delay and reorder input frames
4159 * internally as needed.
4161 * @param avctx codec context
4162 * @param avpkt output AVPacket.
4163 * The user can supply an output buffer by setting
4164 * avpkt->data and avpkt->size prior to calling the
4165 * function, but if the size of the user-provided data is not
4166 * large enough, encoding will fail. All other AVPacket fields
4167 * will be reset by the encoder using av_init_packet(). If
4168 * avpkt->data is NULL, the encoder will allocate it.
4169 * The encoder will set avpkt->size to the size of the
4170 * output packet. The returned data (if any) belongs to the
4171 * caller, he is responsible for freeing it.
4173 * If this function fails or produces no output, avpkt will be
4174 * freed using av_packet_unref().
4175 * @param[in] frame AVFrame containing the raw video data to be encoded.
4176 * May be NULL when flushing an encoder that has the
4177 * AV_CODEC_CAP_DELAY capability set.
4178 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4179 * output packet is non-empty, and to 0 if it is
4180 * empty. If the function returns an error, the
4181 * packet can be assumed to be invalid, and the
4182 * value of got_packet_ptr is undefined and should
4184 * @return 0 on success, negative error code on failure
4186 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4187 const AVFrame *frame, int *got_packet_ptr);
4189 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4190 const AVSubtitle *sub);
4197 #if FF_API_AVPICTURE
4199 * @addtogroup lavc_picture
4204 * @deprecated unused
4206 attribute_deprecated
4207 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4210 * @deprecated unused
4212 attribute_deprecated
4213 void avpicture_free(AVPicture *picture);
4216 * @deprecated use av_image_fill_arrays() instead.
4218 attribute_deprecated
4219 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4220 enum AVPixelFormat pix_fmt, int width, int height);
4223 * @deprecated use av_image_copy_to_buffer() instead.
4225 attribute_deprecated
4226 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4227 int width, int height,
4228 unsigned char *dest, int dest_size);
4231 * @deprecated use av_image_get_buffer_size() instead.
4233 attribute_deprecated
4234 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4237 * @deprecated av_image_copy() instead.
4239 attribute_deprecated
4240 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4241 enum AVPixelFormat pix_fmt, int width, int height);
4244 * @deprecated unused
4246 attribute_deprecated
4247 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4248 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4251 * @deprecated unused
4253 attribute_deprecated
4254 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4255 int padtop, int padbottom, int padleft, int padright, int *color);
4263 * @defgroup lavc_misc Utility functions
4266 * Miscellaneous utility functions related to both encoding and decoding
4272 * @defgroup lavc_misc_pixfmt Pixel formats
4274 * Functions for working with pixel formats.
4279 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4282 void attribute_deprecated avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4285 * Return a value representing the fourCC code associated to the
4286 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4289 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4291 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4292 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4293 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4294 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4295 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4296 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4299 * Compute what kind of losses will occur when converting from one specific
4300 * pixel format to another.
4301 * When converting from one pixel format to another, information loss may occur.
4302 * For example, when converting from RGB24 to GRAY, the color information will
4303 * be lost. Similarly, other losses occur when converting from some formats to
4304 * other formats. These losses can involve loss of chroma, but also loss of
4305 * resolution, loss of color depth, loss due to the color space conversion, loss
4306 * of the alpha bits or loss due to color quantization.
4307 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4308 * which will occur when converting from one pixel format to another.
4310 * @param[in] dst_pix_fmt destination pixel format
4311 * @param[in] src_pix_fmt source pixel format
4312 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4313 * @return Combination of flags informing you what kind of losses will occur.
4315 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4319 * Find the best pixel format to convert to given a certain source pixel
4320 * format. When converting from one pixel format to another, information loss
4321 * may occur. For example, when converting from RGB24 to GRAY, the color
4322 * information will be lost. Similarly, other losses occur when converting from
4323 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4324 * the given pixel formats should be used to suffer the least amount of loss.
4325 * The pixel formats from which it chooses one, are determined by the
4326 * pix_fmt_list parameter.
4329 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4330 * @param[in] src_pix_fmt source pixel format
4331 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4332 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4333 * @return The best pixel format to convert to or -1 if none was found.
4335 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4336 enum AVPixelFormat src_pix_fmt,
4337 int has_alpha, int *loss_ptr);
4339 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4345 #if FF_API_SET_DIMENSIONS
4347 * @deprecated this function is not supposed to be used from outside of lavc
4349 attribute_deprecated
4350 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4354 * Put a string representing the codec tag codec_tag in buf.
4356 * @param buf buffer to place codec tag in
4357 * @param buf_size size in bytes of buf
4358 * @param codec_tag codec tag to assign
4359 * @return the length of the string that would have been generated if
4360 * enough space had been available, excluding the trailing null
4362 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4364 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4367 * Return a name for the specified profile, if available.
4369 * @param codec the codec that is searched for the given profile
4370 * @param profile the profile value for which a name is requested
4371 * @return A name for the profile if found, NULL otherwise.
4373 const char *av_get_profile_name(const AVCodec *codec, int profile);
4375 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4376 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4377 //FIXME func typedef
4380 * Fill audio frame data and linesize.
4381 * AVFrame extended_data channel pointers are allocated if necessary for
4384 * @param frame the AVFrame
4385 * frame->nb_samples must be set prior to calling the
4386 * function. This function fills in frame->data,
4387 * frame->extended_data, frame->linesize[0].
4388 * @param nb_channels channel count
4389 * @param sample_fmt sample format
4390 * @param buf buffer to use for frame data
4391 * @param buf_size size of buffer
4392 * @param align plane size sample alignment (0 = default)
4393 * @return 0 on success, negative error code on failure
4395 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4396 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4397 int buf_size, int align);
4400 * Reset the internal decoder state / flush internal buffers. Should be called
4401 * e.g. when seeking or when switching to a different stream.
4403 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4404 * this invalidates the frames previously returned from the decoder. When
4405 * refcounted frames are used, the decoder just releases any references it might
4406 * keep internally, but the caller's reference remains valid.
4408 void avcodec_flush_buffers(AVCodecContext *avctx);
4411 * Return codec bits per sample.
4413 * @param[in] codec_id the codec
4414 * @return Number of bits per sample or zero if unknown for the given codec.
4416 int av_get_bits_per_sample(enum AVCodecID codec_id);
4419 * Return codec bits per sample.
4420 * Only return non-zero if the bits per sample is exactly correct, not an
4423 * @param[in] codec_id the codec
4424 * @return Number of bits per sample or zero if unknown for the given codec.
4426 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4429 * Return audio frame duration.
4431 * @param avctx codec context
4432 * @param frame_bytes size of the frame, or 0 if unknown
4433 * @return frame duration, in samples, if known. 0 if not able to
4436 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4439 typedef struct AVBitStreamFilterContext {
4441 struct AVBitStreamFilter *filter;
4442 AVCodecParserContext *parser;
4443 struct AVBitStreamFilterContext *next;
4444 } AVBitStreamFilterContext;
4447 typedef struct AVBitStreamFilter {
4450 int (*filter)(AVBitStreamFilterContext *bsfc,
4451 AVCodecContext *avctx, const char *args,
4452 uint8_t **poutbuf, int *poutbuf_size,
4453 const uint8_t *buf, int buf_size, int keyframe);
4454 void (*close)(AVBitStreamFilterContext *bsfc);
4455 struct AVBitStreamFilter *next;
4456 } AVBitStreamFilter;
4458 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4459 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4460 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4461 AVCodecContext *avctx, const char *args,
4462 uint8_t **poutbuf, int *poutbuf_size,
4463 const uint8_t *buf, int buf_size, int keyframe);
4464 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4466 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
4471 * Allocate a buffer with padding, reusing the given one if large enough.
4473 * Same behaviour av_fast_malloc but the buffer has additional
4474 * AV_INPUT_PADDING_SIZE at the end which will always memset to 0.
4477 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4480 * Encode extradata length to a buffer. Used by xiph codecs.
4482 * @param s buffer to write to; must be at least (v/255+1) bytes long
4483 * @param v size of extradata in bytes
4484 * @return number of bytes written to the buffer.
4486 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4488 #if FF_API_MISSING_SAMPLE
4490 * Log a generic warning message about a missing feature. This function is
4491 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4492 * only, and would normally not be used by applications.
4493 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4494 * a pointer to an AVClass struct
4495 * @param[in] feature string containing the name of the missing feature
4496 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4497 * If want_sample is non-zero, additional verbage will be added to the log
4498 * message which tells the user how to report samples to the development
4500 * @deprecated Use avpriv_report_missing_feature() instead.
4502 attribute_deprecated
4503 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4506 * Log a generic warning message asking for a sample. This function is
4507 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4508 * only, and would normally not be used by applications.
4509 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4510 * a pointer to an AVClass struct
4511 * @param[in] msg string containing an optional message, or NULL if no message
4512 * @deprecated Use avpriv_request_sample() instead.
4514 attribute_deprecated
4515 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4516 #endif /* FF_API_MISSING_SAMPLE */
4519 * Register the hardware accelerator hwaccel.
4521 void av_register_hwaccel(AVHWAccel *hwaccel);
4524 * If hwaccel is NULL, returns the first registered hardware accelerator,
4525 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4526 * after hwaccel, or NULL if hwaccel is the last one.
4528 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
4532 * Lock operation used by lockmgr
4535 AV_LOCK_CREATE, ///< Create a mutex
4536 AV_LOCK_OBTAIN, ///< Lock the mutex
4537 AV_LOCK_RELEASE, ///< Unlock the mutex
4538 AV_LOCK_DESTROY, ///< Free mutex resources
4542 * Register a user provided lock manager supporting the operations
4543 * specified by AVLockOp. The "mutex" argument to the function points
4544 * to a (void *) where the lockmgr should store/get a pointer to a user
4545 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
4546 * value left by the last call for all other ops. If the lock manager is
4547 * unable to perform the op then it should leave the mutex in the same
4548 * state as when it was called and return a non-zero value. However,
4549 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
4550 * have been successfully destroyed. If av_lockmgr_register succeeds
4551 * it will return a non-negative value, if it fails it will return a
4552 * negative value and destroy all mutex and unregister all callbacks.
4553 * av_lockmgr_register is not thread-safe, it must be called from a
4554 * single thread before any calls which make use of locking are used.
4556 * @param cb User defined callback. av_lockmgr_register invokes calls
4557 * to this callback and the previously registered callback.
4558 * The callback will be used to create more than one mutex
4559 * each of which must be backed by its own underlying locking
4560 * mechanism (i.e. do not use a single static object to
4561 * implement your lock manager). If cb is set to NULL the
4562 * lockmgr will be unregistered.
4564 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4567 * Get the type of the given codec.
4569 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4572 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4573 * with no corresponding avcodec_close()), 0 otherwise.
4575 int avcodec_is_open(AVCodecContext *s);
4578 * @return a non-zero number if codec is an encoder, zero otherwise
4580 int av_codec_is_encoder(const AVCodec *codec);
4583 * @return a non-zero number if codec is a decoder, zero otherwise
4585 int av_codec_is_decoder(const AVCodec *codec);
4588 * @return descriptor for given codec ID or NULL if no descriptor exists.
4590 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4593 * Iterate over all codec descriptors known to libavcodec.
4595 * @param prev previous descriptor. NULL to get the first descriptor.
4597 * @return next descriptor or NULL after the last descriptor
4599 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4602 * @return codec descriptor with the given name or NULL if no such descriptor
4605 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4611 #endif /* AVCODEC_AVCODEC_H */