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 /* various PCM "codecs" */
303 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
304 AV_CODEC_ID_PCM_S16LE = 0x10000,
305 AV_CODEC_ID_PCM_S16BE,
306 AV_CODEC_ID_PCM_U16LE,
307 AV_CODEC_ID_PCM_U16BE,
310 AV_CODEC_ID_PCM_MULAW,
311 AV_CODEC_ID_PCM_ALAW,
312 AV_CODEC_ID_PCM_S32LE,
313 AV_CODEC_ID_PCM_S32BE,
314 AV_CODEC_ID_PCM_U32LE,
315 AV_CODEC_ID_PCM_U32BE,
316 AV_CODEC_ID_PCM_S24LE,
317 AV_CODEC_ID_PCM_S24BE,
318 AV_CODEC_ID_PCM_U24LE,
319 AV_CODEC_ID_PCM_U24BE,
320 AV_CODEC_ID_PCM_S24DAUD,
321 AV_CODEC_ID_PCM_ZORK,
322 AV_CODEC_ID_PCM_S16LE_PLANAR,
324 AV_CODEC_ID_PCM_F32BE,
325 AV_CODEC_ID_PCM_F32LE,
326 AV_CODEC_ID_PCM_F64BE,
327 AV_CODEC_ID_PCM_F64LE,
328 AV_CODEC_ID_PCM_BLURAY,
331 AV_CODEC_ID_PCM_S8_PLANAR,
332 AV_CODEC_ID_PCM_S24LE_PLANAR,
333 AV_CODEC_ID_PCM_S32LE_PLANAR,
334 AV_CODEC_ID_PCM_S16BE_PLANAR,
336 /* various ADPCM codecs */
337 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
338 AV_CODEC_ID_ADPCM_IMA_WAV,
339 AV_CODEC_ID_ADPCM_IMA_DK3,
340 AV_CODEC_ID_ADPCM_IMA_DK4,
341 AV_CODEC_ID_ADPCM_IMA_WS,
342 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
343 AV_CODEC_ID_ADPCM_MS,
344 AV_CODEC_ID_ADPCM_4XM,
345 AV_CODEC_ID_ADPCM_XA,
346 AV_CODEC_ID_ADPCM_ADX,
347 AV_CODEC_ID_ADPCM_EA,
348 AV_CODEC_ID_ADPCM_G726,
349 AV_CODEC_ID_ADPCM_CT,
350 AV_CODEC_ID_ADPCM_SWF,
351 AV_CODEC_ID_ADPCM_YAMAHA,
352 AV_CODEC_ID_ADPCM_SBPRO_4,
353 AV_CODEC_ID_ADPCM_SBPRO_3,
354 AV_CODEC_ID_ADPCM_SBPRO_2,
355 AV_CODEC_ID_ADPCM_THP,
356 AV_CODEC_ID_ADPCM_IMA_AMV,
357 AV_CODEC_ID_ADPCM_EA_R1,
358 AV_CODEC_ID_ADPCM_EA_R3,
359 AV_CODEC_ID_ADPCM_EA_R2,
360 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
361 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
362 AV_CODEC_ID_ADPCM_EA_XAS,
363 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
364 AV_CODEC_ID_ADPCM_IMA_ISS,
365 AV_CODEC_ID_ADPCM_G722,
366 AV_CODEC_ID_ADPCM_IMA_APC,
367 AV_CODEC_ID_ADPCM_VIMA,
370 AV_CODEC_ID_AMR_NB = 0x12000,
373 /* RealAudio codecs*/
374 AV_CODEC_ID_RA_144 = 0x13000,
377 /* various DPCM codecs */
378 AV_CODEC_ID_ROQ_DPCM = 0x14000,
379 AV_CODEC_ID_INTERPLAY_DPCM,
380 AV_CODEC_ID_XAN_DPCM,
381 AV_CODEC_ID_SOL_DPCM,
384 AV_CODEC_ID_MP2 = 0x15000,
385 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
395 AV_CODEC_ID_VMDAUDIO,
401 AV_CODEC_ID_WESTWOOD_SND1,
402 AV_CODEC_ID_GSM, ///< as in Berlin toast format
405 AV_CODEC_ID_TRUESPEECH,
407 AV_CODEC_ID_SMACKAUDIO,
410 AV_CODEC_ID_DSICINAUDIO,
412 AV_CODEC_ID_MUSEPACK7,
414 AV_CODEC_ID_GSM_MS, /* as found in WAV */
420 AV_CODEC_ID_NELLYMOSER,
421 AV_CODEC_ID_MUSEPACK8,
423 AV_CODEC_ID_WMAVOICE,
425 AV_CODEC_ID_WMALOSSLESS,
434 AV_CODEC_ID_BINKAUDIO_RDFT,
435 AV_CODEC_ID_BINKAUDIO_DCT,
436 AV_CODEC_ID_AAC_LATM,
441 AV_CODEC_ID_8SVX_EXP,
442 AV_CODEC_ID_8SVX_FIB,
443 AV_CODEC_ID_BMV_AUDIO,
448 AV_CODEC_ID_COMFORT_NOISE,
450 AV_CODEC_ID_METASOUND,
451 AV_CODEC_ID_PAF_AUDIO,
455 /* subtitle codecs */
456 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
457 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
458 AV_CODEC_ID_DVB_SUBTITLE,
459 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
462 AV_CODEC_ID_MOV_TEXT,
463 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
464 AV_CODEC_ID_DVB_TELETEXT,
467 /* other specific kind of codecs (generally used for attachments) */
468 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
469 AV_CODEC_ID_TTF = 0x18000,
471 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
473 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
474 * stream (only used by libavformat) */
475 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
476 * stream (only used by libavformat) */
477 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
481 * This struct describes the properties of a single codec described by an
483 * @see avcodec_descriptor_get()
485 typedef struct AVCodecDescriptor {
487 enum AVMediaType type;
489 * Name of the codec described by this descriptor. It is non-empty and
490 * unique for each codec descriptor. It should contain alphanumeric
491 * characters and '_' only.
495 * A more descriptive name for this codec. May be NULL.
497 const char *long_name;
499 * Codec properties, a combination of AV_CODEC_PROP_* flags.
505 * Codec uses only intra compression.
508 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
510 * Codec supports lossy compression. Audio and video codecs only.
511 * @note a codec may support both lossy and lossless
514 #define AV_CODEC_PROP_LOSSY (1 << 1)
516 * Codec supports lossless compression. Audio and video codecs only.
518 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
520 * Codec supports frame reordering. That is, the coded order (the order in which
521 * the encoded packets are output by the encoders / stored / input to the
522 * decoders) may be different from the presentation order of the corresponding
525 * For codecs that do not have this property set, PTS and DTS should always be
528 #define AV_CODEC_PROP_REORDER (1 << 3)
531 * @ingroup lavc_decoding
532 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
533 * This is mainly needed because some optimized bitstream readers read
534 * 32 or 64 bit at once and could read over the end.<br>
535 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
536 * MPEG bitstreams could cause overread and segfault.
538 #define AV_INPUT_BUFFER_PADDING_SIZE 8
541 * @ingroup lavc_encoding
542 * minimum encoding buffer size
543 * Used to avoid some checks during header writing.
545 #define AV_INPUT_BUFFER_MIN_SIZE 16384
547 #if FF_API_WITHOUT_PREFIX
549 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
551 #define FF_INPUT_BUFFER_PADDING_SIZE 8
554 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
556 #define FF_MIN_BUFFER_SIZE 16384
557 #endif /* FF_API_WITHOUT_PREFIX */
560 * @ingroup lavc_encoding
561 * motion estimation type.
562 * @deprecated use codec private option instead
564 #if FF_API_MOTION_EST
566 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
570 ME_EPZS, ///< enhanced predictive zonal search
571 ME_X1, ///< reserved for experiments
572 ME_HEX, ///< hexagon based search
573 ME_UMH, ///< uneven multi-hexagon search
574 ME_TESA, ///< transformed exhaustive search algorithm
579 * @ingroup lavc_decoding
582 /* We leave some space between them for extensions (drop some
583 * keyframes for intra-only or drop just some bidir frames). */
584 AVDISCARD_NONE =-16, ///< discard nothing
585 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
586 AVDISCARD_NONREF = 8, ///< discard all non reference
587 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
588 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
589 AVDISCARD_ALL = 48, ///< discard all
592 enum AVAudioServiceType {
593 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
594 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
595 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
596 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
597 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
598 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
599 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
600 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
601 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
602 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
606 * @ingroup lavc_encoding
608 typedef struct RcOverride{
611 int qscale; // If this is 0 then quality_factor will be used instead.
612 float quality_factor;
615 #if FF_API_MAX_BFRAMES
617 * @deprecated there is no libavcodec-wide limit on the number of B-frames
619 #define FF_MAX_B_FRAMES 16
623 These flags can be passed in AVCodecContext.flags before initialization.
624 Note: Not everything is supported yet.
628 * Allow decoders to produce frames with data planes that are not aligned
629 * to CPU requirements (e.g. due to cropping).
631 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
635 #define AV_CODEC_FLAG_QSCALE (1 << 1)
637 * 4 MV per MB allowed / advanced prediction for H.263.
639 #define AV_CODEC_FLAG_4MV (1 << 2)
641 * Output even those frames that might be corrupted.
643 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
647 #define AV_CODEC_FLAG_QPEL (1 << 4)
649 * Use internal 2pass ratecontrol in first pass mode.
651 #define AV_CODEC_FLAG_PASS1 (1 << 9)
653 * Use internal 2pass ratecontrol in second pass mode.
655 #define AV_CODEC_FLAG_PASS2 (1 << 10)
659 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
661 * Only decode/encode grayscale.
663 #define AV_CODEC_FLAG_GRAY (1 << 13)
665 * error[?] variables will be set during encoding.
667 #define AV_CODEC_FLAG_PSNR (1 << 15)
669 * Input bitstream might be truncated at a random location
670 * instead of only at frame boundaries.
672 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
674 * Use interlaced DCT.
676 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
680 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
682 * Place global headers in extradata instead of every keyframe.
684 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
686 * Use only bitexact stuff (except (I)DCT).
688 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
689 /* Fx : Flag for h263+ extra options */
691 * H.263 advanced intra coding / MPEG-4 AC prediction
693 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
695 * interlaced motion estimation
697 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
699 * Allow non spec compliant speedup tricks.
701 #define AV_CODEC_FLAG_CLOSED_GOP (1 << 31)
703 #define AV_CODEC_FLAG2_FAST (1 << 0)
705 * Skip bitstream encoding.
707 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
709 * Place global headers at every keyframe instead of in extradata.
711 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
713 * Input bitstream might be truncated at a packet boundaries
714 * instead of only at frame boundaries.
716 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
718 * Discard cropping information from SPS.
720 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
722 /* Unsupported options :
723 * Syntax Arithmetic coding (SAC)
724 * Reference Picture Selection
725 * Independent Segment Decoding */
727 /* codec capabilities */
730 * Decoder can use draw_horiz_band callback.
732 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
734 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
735 * If not set, it might not use get_buffer() at all or use operations that
736 * assume the buffer was allocated by avcodec_default_get_buffer.
738 #define AV_CODEC_CAP_DR1 (1 << 1)
739 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
741 * Encoder or decoder requires flushing with NULL input at the end in order to
742 * give the complete and correct output.
744 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
745 * with NULL data. The user can still send NULL data to the public encode
746 * or decode function, but libavcodec will not pass it along to the codec
747 * unless this flag is set.
750 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
751 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
755 * The encoder needs to be fed with NULL data at the end of encoding until the
756 * encoder no longer returns data.
758 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
759 * flag also means that the encoder must set the pts and duration for
760 * each output packet. If this flag is not set, the pts and duration will
761 * be determined by libavcodec from the input frame.
763 #define AV_CODEC_CAP_DELAY (1 << 5)
765 * Codec can be fed a final frame with a smaller size.
766 * This can be used to prevent truncation of the last audio samples.
768 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
770 * Codec can output multiple frames per AVPacket
771 * Normally demuxers return one frame at a time, demuxers which do not do
772 * are connected to a parser to split what they return into proper frames.
773 * This flag is reserved to the very rare category of codecs which have a
774 * bitstream that cannot be split into frames without timeconsuming
775 * operations like full decoding. Demuxers carring such bitstreams thus
776 * may return multiple frames in a packet. This has many disadvantages like
777 * prohibiting stream copy in many cases thus it should only be considered
780 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
782 * Codec is experimental and is thus avoided in favor of non experimental
785 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
787 * Codec should fill in channel configuration and samplerate instead of container
789 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
791 * Codec supports frame-level multithreading.
793 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
795 * Codec supports slice-based (or partition-based) multithreading.
797 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
799 * Codec supports changed parameters at any point.
801 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
803 * Codec supports avctx->thread_count == 0 (auto).
805 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
807 * Audio encoder supports receiving a different number of samples in each call.
809 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
811 #if FF_API_WITHOUT_PREFIX
813 * Allow decoders to produce frames with data planes that are not aligned
814 * to CPU requirements (e.g. due to cropping).
816 #define CODEC_FLAG_UNALIGNED 0x0001
817 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
818 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
819 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
820 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
823 * @deprecated use the "gmc" private option of the libxvid encoder
825 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
829 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
832 #define CODEC_FLAG_MV0 0x0040
834 #if FF_API_INPUT_PRESERVED
836 * @deprecated passing reference-counted frames to the encoders replaces this
839 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
841 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
842 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
843 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
846 * @deprecated edges are not used/required anymore. I.e. this flag is now always
849 #define CODEC_FLAG_EMU_EDGE 0x4000
851 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
852 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
853 location instead of only at frame boundaries. */
854 #if FF_API_NORMALIZE_AQP
856 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
859 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
861 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
862 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
863 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
864 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
865 /* Fx : Flag for h263+ extra options */
866 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
867 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
868 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
869 #define CODEC_FLAG_CLOSED_GOP 0x80000000
870 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
871 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
872 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
873 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
875 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
877 /* Unsupported options :
878 * Syntax Arithmetic coding (SAC)
879 * Reference Picture Selection
880 * Independent Segment Decoding */
882 /* codec capabilities */
884 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
886 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
887 * If not set, it might not use get_buffer() at all or use operations that
888 * assume the buffer was allocated by avcodec_default_get_buffer.
890 #define CODEC_CAP_DR1 0x0002
891 #define CODEC_CAP_TRUNCATED 0x0008
893 /* Codec can export data for HW decoding (XvMC). */
894 #define CODEC_CAP_HWACCEL 0x0010
895 #endif /* FF_API_XVMC */
897 * Encoder or decoder requires flushing with NULL input at the end in order to
898 * give the complete and correct output.
900 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
901 * with NULL data. The user can still send NULL data to the public encode
902 * or decode function, but libavcodec will not pass it along to the codec
903 * unless this flag is set.
906 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
907 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
911 * The encoder needs to be fed with NULL data at the end of encoding until the
912 * encoder no longer returns data.
914 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
915 * flag also means that the encoder must set the pts and duration for
916 * each output packet. If this flag is not set, the pts and duration will
917 * be determined by libavcodec from the input frame.
919 #define CODEC_CAP_DELAY 0x0020
921 * Codec can be fed a final frame with a smaller size.
922 * This can be used to prevent truncation of the last audio samples.
924 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
927 * Codec can export data for HW decoding (VDPAU).
929 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
932 * Codec can output multiple frames per AVPacket
933 * Normally demuxers return one frame at a time, demuxers which do not do
934 * are connected to a parser to split what they return into proper frames.
935 * This flag is reserved to the very rare category of codecs which have a
936 * bitstream that cannot be split into frames without timeconsuming
937 * operations like full decoding. Demuxers carring such bitstreams thus
938 * may return multiple frames in a packet. This has many disadvantages like
939 * prohibiting stream copy in many cases thus it should only be considered
942 #define CODEC_CAP_SUBFRAMES 0x0100
944 * Codec is experimental and is thus avoided in favor of non experimental
947 #define CODEC_CAP_EXPERIMENTAL 0x0200
949 * Codec should fill in channel configuration and samplerate instead of container
951 #define CODEC_CAP_CHANNEL_CONF 0x0400
952 #if FF_API_NEG_LINESIZES
954 * @deprecated no codecs use this capability
956 #define CODEC_CAP_NEG_LINESIZES 0x0800
959 * Codec supports frame-level multithreading.
961 #define CODEC_CAP_FRAME_THREADS 0x1000
963 * Codec supports slice-based (or partition-based) multithreading.
965 #define CODEC_CAP_SLICE_THREADS 0x2000
967 * Codec supports changed parameters at any point.
969 #define CODEC_CAP_PARAM_CHANGE 0x4000
971 * Codec supports avctx->thread_count == 0 (auto).
973 #define CODEC_CAP_AUTO_THREADS 0x8000
975 * Audio encoder supports receiving a different number of samples in each call.
977 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
978 #endif /* FF_API_WITHOUT_PREFIX */
981 //The following defines may change, don't expect compatibility if you use them.
982 #define MB_TYPE_INTRA4x4 0x0001
983 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
984 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
985 #define MB_TYPE_16x16 0x0008
986 #define MB_TYPE_16x8 0x0010
987 #define MB_TYPE_8x16 0x0020
988 #define MB_TYPE_8x8 0x0040
989 #define MB_TYPE_INTERLACED 0x0080
990 #define MB_TYPE_DIRECT2 0x0100 //FIXME
991 #define MB_TYPE_ACPRED 0x0200
992 #define MB_TYPE_GMC 0x0400
993 #define MB_TYPE_SKIP 0x0800
994 #define MB_TYPE_P0L0 0x1000
995 #define MB_TYPE_P1L0 0x2000
996 #define MB_TYPE_P0L1 0x4000
997 #define MB_TYPE_P1L1 0x8000
998 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
999 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1000 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1001 #define MB_TYPE_QUANT 0x00010000
1002 #define MB_TYPE_CBP 0x00020000
1003 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
1008 * This specifies the area which should be displayed.
1009 * Note there may be multiple such areas for one frame.
1011 typedef struct AVPanScan{
1014 * - encoding: Set by user.
1015 * - decoding: Set by libavcodec.
1020 * width and height in 1/16 pel
1021 * - encoding: Set by user.
1022 * - decoding: Set by libavcodec.
1028 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1029 * - encoding: Set by user.
1030 * - decoding: Set by libavcodec.
1032 int16_t position[3][2];
1035 #if FF_API_QSCALE_TYPE
1036 #define FF_QSCALE_TYPE_MPEG1 0
1037 #define FF_QSCALE_TYPE_MPEG2 1
1038 #define FF_QSCALE_TYPE_H264 2
1039 #define FF_QSCALE_TYPE_VP56 3
1043 * The decoder will keep a reference to the frame and may reuse it later.
1045 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1048 * @defgroup lavc_packet AVPacket
1050 * Types and functions for working with AVPacket.
1053 enum AVPacketSideDataType {
1054 AV_PKT_DATA_PALETTE,
1055 AV_PKT_DATA_NEW_EXTRADATA,
1058 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1061 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1062 * s32le channel_count
1063 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1064 * u64le channel_layout
1065 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1067 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1072 AV_PKT_DATA_PARAM_CHANGE,
1075 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1076 * structures with info about macroblocks relevant to splitting the
1077 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1078 * That is, it does not necessarily contain info about all macroblocks,
1079 * as long as the distance between macroblocks in the info is smaller
1080 * than the target payload size.
1081 * Each MB info structure is 12 bytes, and is laid out as follows:
1083 * u32le bit offset from the start of the packet
1084 * u8 current quantizer at the start of the macroblock
1086 * u16le macroblock address within the GOB
1087 * u8 horizontal MV predictor
1088 * u8 vertical MV predictor
1089 * u8 horizontal MV predictor for block number 3
1090 * u8 vertical MV predictor for block number 3
1093 AV_PKT_DATA_H263_MB_INFO,
1096 * This side data should be associated with an audio stream and contains
1097 * ReplayGain information in form of the AVReplayGain struct.
1099 AV_PKT_DATA_REPLAYGAIN,
1102 * This side data contains a 3x3 transformation matrix describing an affine
1103 * transformation that needs to be applied to the decoded video frames for
1104 * correct presentation.
1106 * See libavutil/display.h for a detailed description of the data.
1108 AV_PKT_DATA_DISPLAYMATRIX,
1111 * This side data should be associated with a video stream and contains
1112 * Stereoscopic 3D information in form of the AVStereo3D struct.
1114 AV_PKT_DATA_STEREO3D,
1117 * This side data should be associated with an audio stream and corresponds
1118 * to enum AVAudioServiceType.
1120 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1123 * This side data contains an integer value representing the quality
1124 * factor of the compressed frame. Allowed range is between 1 (good)
1125 * and FF_LAMBDA_MAX (bad).
1127 AV_PKT_DATA_QUALITY_FACTOR,
1130 typedef struct AVPacketSideData {
1133 enum AVPacketSideDataType type;
1137 * This structure stores compressed data. It is typically exported by demuxers
1138 * and then passed as input to decoders, or received as output from encoders and
1139 * then passed to muxers.
1141 * For video, it should typically contain one compressed frame. For audio it may
1142 * contain several compressed frames.
1144 * AVPacket is one of the few structs in Libav, whose size is a part of public
1145 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1146 * without libavcodec and libavformat major bump.
1148 * The semantics of data ownership depends on the buf or destruct (deprecated)
1149 * fields. If either is set, the packet data is dynamically allocated and is
1150 * valid indefinitely until av_free_packet() is called (which in turn calls
1151 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1152 * the packet data is typically backed by some static buffer somewhere and is
1153 * only valid for a limited time (e.g. until the next read call when demuxing).
1155 * The side data is always allocated with av_malloc() and is freed in
1158 typedef struct AVPacket {
1160 * A reference to the reference-counted buffer where the packet data is
1162 * May be NULL, then the packet data is not reference-counted.
1166 * Presentation timestamp in AVStream->time_base units; the time at which
1167 * the decompressed packet will be presented to the user.
1168 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1169 * pts MUST be larger or equal to dts as presentation cannot happen before
1170 * decompression, unless one wants to view hex dumps. Some formats misuse
1171 * the terms dts and pts/cts to mean something different. Such timestamps
1172 * must be converted to true pts/dts before they are stored in AVPacket.
1176 * Decompression timestamp in AVStream->time_base units; the time at which
1177 * the packet is decompressed.
1178 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1185 * A combination of AV_PKT_FLAG values
1189 * Additional packet data that can be provided by the container.
1190 * Packet can contain several types of side information.
1192 AVPacketSideData *side_data;
1193 int side_data_elems;
1196 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1197 * Equals next_pts - this_pts in presentation order.
1201 int64_t pos; ///< byte position in stream, -1 if unknown
1204 * Time difference in AVStream->time_base units from the pts of this
1205 * packet to the point at which the output from the decoder has converged
1206 * independent from the availability of previous frames. That is, the
1207 * frames are virtually identical no matter if decoding started from
1208 * the very first frame or from this keyframe.
1209 * Is AV_NOPTS_VALUE if unknown.
1210 * This field is not the display duration of the current packet.
1211 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1214 * The purpose of this field is to allow seeking in streams that have no
1215 * keyframes in the conventional sense. It corresponds to the
1216 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1217 * essential for some types of subtitle streams to ensure that all
1218 * subtitles are correctly displayed after seeking.
1220 int64_t convergence_duration;
1222 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1223 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1225 enum AVSideDataParamChangeFlags {
1226 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1227 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1228 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1229 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1235 struct AVCodecInternal;
1239 AV_FIELD_PROGRESSIVE,
1240 AV_FIELD_TT, //< Top coded_first, top displayed first
1241 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1242 AV_FIELD_TB, //< Top coded first, bottom displayed first
1243 AV_FIELD_BT, //< Bottom coded first, top displayed first
1247 * main external API structure.
1248 * New fields can be added to the end with minor version bumps.
1249 * Removal, reordering and changes to existing fields require a major
1251 * sizeof(AVCodecContext) must not be used outside libav*.
1253 typedef struct AVCodecContext {
1255 * information on struct for av_log
1256 * - set by avcodec_alloc_context3
1258 const AVClass *av_class;
1259 int log_level_offset;
1261 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1262 const struct AVCodec *codec;
1263 #if FF_API_CODEC_NAME
1265 * @deprecated this field is not used for anything in libavcodec
1267 attribute_deprecated
1268 char codec_name[32];
1270 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1273 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1274 * This is used to work around some encoder bugs.
1275 * A demuxer should set this to what is stored in the field used to identify the codec.
1276 * If there are multiple such fields in a container then the demuxer should choose the one
1277 * which maximizes the information about the used codec.
1278 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1279 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1280 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1282 * - encoding: Set by user, if not then the default based on codec_id will be used.
1283 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1285 unsigned int codec_tag;
1287 #if FF_API_STREAM_CODEC_TAG
1289 * @deprecated this field is unused
1291 attribute_deprecated
1292 unsigned int stream_codec_tag;
1298 * Private context used for internal data.
1300 * Unlike priv_data, this is not codec-specific. It is used in general
1301 * libavcodec functions.
1303 struct AVCodecInternal *internal;
1306 * Private data of the user, can be used to carry app specific stuff.
1307 * - encoding: Set by user.
1308 * - decoding: Set by user.
1313 * the average bitrate
1314 * - encoding: Set by user; unused for constant quantizer encoding.
1315 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1320 * number of bits the bitstream is allowed to diverge from the reference.
1321 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1322 * - encoding: Set by user; unused for constant quantizer encoding.
1323 * - decoding: unused
1325 int bit_rate_tolerance;
1328 * Global quality for codecs which cannot change it per frame.
1329 * This should be proportional to MPEG-1/2/4 qscale.
1330 * - encoding: Set by user.
1331 * - decoding: unused
1336 * - encoding: Set by user.
1337 * - decoding: unused
1339 int compression_level;
1340 #define FF_COMPRESSION_DEFAULT -1
1344 * - encoding: Set by user.
1345 * - decoding: Set by user.
1351 * - encoding: Set by user.
1352 * - decoding: Set by user.
1357 * some codecs need / can use extradata like Huffman tables.
1358 * mjpeg: Huffman tables
1359 * rv10: additional flags
1360 * mpeg4: global headers (they can be in the bitstream or here)
1361 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1362 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1363 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1364 * - encoding: Set/allocated/freed by libavcodec.
1365 * - decoding: Set/allocated/freed by user.
1371 * This is the fundamental unit of time (in seconds) in terms
1372 * of which frame timestamps are represented. For fixed-fps content,
1373 * timebase should be 1/framerate and timestamp increments should be
1375 * - encoding: MUST be set by user.
1376 * - decoding: the use of this field for decoding is deprecated.
1377 * Use framerate instead.
1379 AVRational time_base;
1382 * For some codecs, the time base is closer to the field rate than the frame rate.
1383 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1384 * if no telecine is used ...
1386 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1388 int ticks_per_frame;
1394 * Number of frames the decoded output will be delayed relative to the
1398 * For encoding, this field is unused (see initial_padding).
1400 * For decoding, this is the number of samples the decoder needs to
1401 * output before the decoder's output is valid. When seeking, you should
1402 * start decoding this many samples prior to your desired seek point.
1404 * - encoding: Set by libavcodec.
1405 * - decoding: Set by libavcodec.
1412 * picture width / height.
1414 * @note Those fields may not match the values of the last
1415 * AVFrame outputted by avcodec_decode_video2 due frame
1418 * - encoding: MUST be set by user.
1419 * - decoding: May be set by the user before opening the decoder if known e.g.
1420 * from the container. Some decoders will require the dimensions
1421 * to be set by the caller. During decoding, the decoder may
1422 * overwrite those values as required while parsing the data.
1427 * Bitstream width / height, may be different from width/height e.g. when
1428 * the decoded frame is cropped before being output.
1430 * @note Those field may not match the value of the last
1431 * AVFrame outputted by avcodec_decode_video2 due frame
1434 * - encoding: unused
1435 * - decoding: May be set by the user before opening the decoder if known
1436 * e.g. from the container. During decoding, the decoder may
1437 * overwrite those values as required while parsing the data.
1439 int coded_width, coded_height;
1441 #if FF_API_ASPECT_EXTENDED
1442 #define FF_ASPECT_EXTENDED 15
1446 * the number of pictures in a group of pictures, or 0 for intra_only
1447 * - encoding: Set by user.
1448 * - decoding: unused
1453 * Pixel format, see AV_PIX_FMT_xxx.
1454 * May be set by the demuxer if known from headers.
1455 * May be overriden by the decoder if it knows better.
1457 * @note This field may not match the value of the last
1458 * AVFrame outputted by avcodec_decode_video2 due frame
1461 * - encoding: Set by user.
1462 * - decoding: Set by user if known, overridden by libavcodec while
1465 enum AVPixelFormat pix_fmt;
1467 #if FF_API_MOTION_EST
1469 * This option does nothing
1470 * @deprecated use codec private options instead
1472 attribute_deprecated int me_method;
1476 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1477 * decoder to draw a horizontal band. It improves cache usage. Not
1478 * all codecs can do that. You must check the codec capabilities
1480 * When multithreading is used, it may be called from multiple threads
1481 * at the same time; threads might draw different parts of the same AVFrame,
1482 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1484 * The function is also used by hardware acceleration APIs.
1485 * It is called at least once during frame decoding to pass
1486 * the data needed for hardware render.
1487 * In that mode instead of pixel data, AVFrame points to
1488 * a structure specific to the acceleration API. The application
1489 * reads the structure and can change some fields to indicate progress
1491 * - encoding: unused
1492 * - decoding: Set by user.
1493 * @param height the height of the slice
1494 * @param y the y position of the slice
1495 * @param type 1->top field, 2->bottom field, 3->frame
1496 * @param offset offset into the AVFrame.data from which the slice should be read
1498 void (*draw_horiz_band)(struct AVCodecContext *s,
1499 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1500 int y, int type, int height);
1503 * callback to negotiate the pixelFormat
1504 * @param fmt is the list of formats which are supported by the codec,
1505 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1506 * The first is always the native one.
1507 * @note The callback may be called again immediately if initialization for
1508 * the selected (hardware-accelerated) pixel format failed.
1509 * @warning Behavior is undefined if the callback returns a value not
1510 * in the fmt list of formats.
1511 * @return the chosen format
1512 * - encoding: unused
1513 * - decoding: Set by user, if not set the native format will be chosen.
1515 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1518 * maximum number of B-frames between non-B-frames
1519 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1520 * - encoding: Set by user.
1521 * - decoding: unused
1526 * qscale factor between IP and B-frames
1527 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1528 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1529 * - encoding: Set by user.
1530 * - decoding: unused
1532 float b_quant_factor;
1534 #if FF_API_RC_STRATEGY
1535 /** @deprecated use codec private option instead */
1536 attribute_deprecated int rc_strategy;
1537 #define FF_RC_STRATEGY_XVID 1
1540 int b_frame_strategy;
1543 * qscale offset between IP and B-frames
1544 * - encoding: Set by user.
1545 * - decoding: unused
1547 float b_quant_offset;
1550 * Size of the frame reordering buffer in the decoder.
1551 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1552 * - encoding: Set by libavcodec.
1553 * - decoding: Set by libavcodec.
1558 * 0-> h263 quant 1-> mpeg quant
1559 * - encoding: Set by user.
1560 * - decoding: unused
1565 * qscale factor between P and I-frames
1566 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1567 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1568 * - encoding: Set by user.
1569 * - decoding: unused
1571 float i_quant_factor;
1574 * qscale offset between P and I-frames
1575 * - encoding: Set by user.
1576 * - decoding: unused
1578 float i_quant_offset;
1581 * luminance masking (0-> disabled)
1582 * - encoding: Set by user.
1583 * - decoding: unused
1588 * temporary complexity masking (0-> disabled)
1589 * - encoding: Set by user.
1590 * - decoding: unused
1592 float temporal_cplx_masking;
1595 * spatial complexity masking (0-> disabled)
1596 * - encoding: Set by user.
1597 * - decoding: unused
1599 float spatial_cplx_masking;
1602 * p block masking (0-> disabled)
1603 * - encoding: Set by user.
1604 * - decoding: unused
1609 * darkness masking (0-> disabled)
1610 * - encoding: Set by user.
1611 * - decoding: unused
1617 * - encoding: Set by libavcodec.
1618 * - decoding: Set by user (or 0).
1622 * prediction method (needed for huffyuv)
1623 * - encoding: Set by user.
1624 * - decoding: unused
1626 int prediction_method;
1627 #define FF_PRED_LEFT 0
1628 #define FF_PRED_PLANE 1
1629 #define FF_PRED_MEDIAN 2
1632 * slice offsets in the frame in bytes
1633 * - encoding: Set/allocated by libavcodec.
1634 * - decoding: Set/allocated by user (or NULL).
1639 * sample aspect ratio (0 if unknown)
1640 * That is the width of a pixel divided by the height of the pixel.
1641 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1642 * - encoding: Set by user.
1643 * - decoding: Set by libavcodec.
1645 AVRational sample_aspect_ratio;
1648 * motion estimation comparison function
1649 * - encoding: Set by user.
1650 * - decoding: unused
1654 * subpixel motion estimation comparison function
1655 * - encoding: Set by user.
1656 * - decoding: unused
1660 * macroblock comparison function (not supported yet)
1661 * - encoding: Set by user.
1662 * - decoding: unused
1666 * interlaced DCT comparison function
1667 * - encoding: Set by user.
1668 * - decoding: unused
1671 #define FF_CMP_SAD 0
1672 #define FF_CMP_SSE 1
1673 #define FF_CMP_SATD 2
1674 #define FF_CMP_DCT 3
1675 #define FF_CMP_PSNR 4
1676 #define FF_CMP_BIT 5
1678 #define FF_CMP_ZERO 7
1679 #define FF_CMP_VSAD 8
1680 #define FF_CMP_VSSE 9
1681 #define FF_CMP_NSSE 10
1682 #define FF_CMP_DCTMAX 13
1683 #define FF_CMP_DCT264 14
1684 #define FF_CMP_CHROMA 256
1687 * ME diamond size & shape
1688 * - encoding: Set by user.
1689 * - decoding: unused
1694 * amount of previous MV predictors (2a+1 x 2a+1 square)
1695 * - encoding: Set by user.
1696 * - decoding: unused
1698 int last_predictor_count;
1701 * prepass for motion estimation
1702 * - encoding: Set by user.
1703 * - decoding: unused
1708 * motion estimation prepass comparison function
1709 * - encoding: Set by user.
1710 * - decoding: unused
1715 * ME prepass diamond size & shape
1716 * - encoding: Set by user.
1717 * - decoding: unused
1723 * - encoding: Set by user.
1724 * - decoding: unused
1726 int me_subpel_quality;
1730 * DTG active format information (additional aspect ratio
1731 * information only used in DVB MPEG-2 transport streams)
1734 * - encoding: unused
1735 * - decoding: Set by decoder.
1736 * @deprecated Deprecated in favor of AVSideData
1738 attribute_deprecated int dtg_active_format;
1739 #define FF_DTG_AFD_SAME 8
1740 #define FF_DTG_AFD_4_3 9
1741 #define FF_DTG_AFD_16_9 10
1742 #define FF_DTG_AFD_14_9 11
1743 #define FF_DTG_AFD_4_3_SP_14_9 13
1744 #define FF_DTG_AFD_16_9_SP_14_9 14
1745 #define FF_DTG_AFD_SP_4_3 15
1746 #endif /* FF_API_AFD */
1749 * maximum motion estimation search range in subpel units
1750 * If 0 then no limit.
1752 * - encoding: Set by user.
1753 * - decoding: unused
1757 #if FF_API_QUANT_BIAS
1759 * @deprecated use encoder private option instead
1761 attribute_deprecated int intra_quant_bias;
1762 #define FF_DEFAULT_QUANT_BIAS 999999
1765 * @deprecated use encoder private option instead
1767 attribute_deprecated int inter_quant_bias;
1772 * - encoding: unused
1773 * - decoding: Set by user.
1776 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1777 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1778 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1782 * XVideo Motion Acceleration
1783 * - encoding: forbidden
1784 * - decoding: set by decoder
1785 * @deprecated XvMC support is slated for removal.
1787 attribute_deprecated int xvmc_acceleration;
1788 #endif /* FF_API_XVMC */
1791 * macroblock decision mode
1792 * - encoding: Set by user.
1793 * - decoding: unused
1796 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1797 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1798 #define FF_MB_DECISION_RD 2 ///< rate distortion
1801 * custom intra quantization matrix
1802 * - encoding: Set by user, can be NULL.
1803 * - decoding: Set by libavcodec.
1805 uint16_t *intra_matrix;
1808 * custom inter quantization matrix
1809 * - encoding: Set by user, can be NULL.
1810 * - decoding: Set by libavcodec.
1812 uint16_t *inter_matrix;
1815 * scene change detection threshold
1816 * 0 is default, larger means fewer detected scene changes.
1817 * - encoding: Set by user.
1818 * - decoding: unused
1820 int scenechange_threshold;
1823 * noise reduction strength
1824 * - encoding: Set by user.
1825 * - decoding: unused
1827 int noise_reduction;
1831 * @deprecated this field is unused
1833 attribute_deprecated
1837 * @deprecated this field is unused
1839 attribute_deprecated
1844 * precision of the intra DC coefficient - 8
1845 * - encoding: Set by user.
1846 * - decoding: unused
1848 int intra_dc_precision;
1851 * Number of macroblock rows at the top which are skipped.
1852 * - encoding: unused
1853 * - decoding: Set by user.
1858 * Number of macroblock rows at the bottom which are skipped.
1859 * - encoding: unused
1860 * - decoding: Set by user.
1866 * @deprecated use encoder private options instead
1868 attribute_deprecated
1869 float border_masking;
1873 * minimum MB lagrange multipler
1874 * - encoding: Set by user.
1875 * - decoding: unused
1880 * maximum MB lagrange multipler
1881 * - encoding: Set by user.
1882 * - decoding: unused
1888 * - encoding: Set by user.
1889 * - decoding: unused
1891 int me_penalty_compensation;
1895 * - encoding: Set by user.
1896 * - decoding: unused
1902 * - encoding: Set by user.
1903 * - decoding: unused
1909 * - encoding: Set by user.
1910 * - decoding: unused
1915 * number of reference frames
1916 * - encoding: Set by user.
1917 * - decoding: Set by lavc.
1922 * chroma qp offset from luma
1923 * - encoding: Set by user.
1924 * - decoding: unused
1928 #if FF_API_UNUSED_MEMBERS
1930 * Multiplied by qscale for each frame and added to scene_change_score.
1931 * - encoding: Set by user.
1932 * - decoding: unused
1934 attribute_deprecated int scenechange_factor;
1939 * Note: Value depends upon the compare function used for fullpel ME.
1940 * - encoding: Set by user.
1941 * - decoding: unused
1946 * Adjust sensitivity of b_frame_strategy 1.
1947 * - encoding: Set by user.
1948 * - decoding: unused
1953 * Chromaticity coordinates of the source primaries.
1954 * - encoding: Set by user
1955 * - decoding: Set by libavcodec
1957 enum AVColorPrimaries color_primaries;
1960 * Color Transfer Characteristic.
1961 * - encoding: Set by user
1962 * - decoding: Set by libavcodec
1964 enum AVColorTransferCharacteristic color_trc;
1967 * YUV colorspace type.
1968 * - encoding: Set by user
1969 * - decoding: Set by libavcodec
1971 enum AVColorSpace colorspace;
1974 * MPEG vs JPEG YUV range.
1975 * - encoding: Set by user
1976 * - decoding: Set by libavcodec
1978 enum AVColorRange color_range;
1981 * This defines the location of chroma samples.
1982 * - encoding: Set by user
1983 * - decoding: Set by libavcodec
1985 enum AVChromaLocation chroma_sample_location;
1989 * Indicates number of picture subdivisions. Used for parallelized
1991 * - encoding: Set by user
1992 * - decoding: unused
1997 * - encoding: set by libavcodec
1998 * - decoding: Set by libavcodec
2000 enum AVFieldOrder field_order;
2003 int sample_rate; ///< samples per second
2004 int channels; ///< number of audio channels
2007 * audio sample format
2008 * - encoding: Set by user.
2009 * - decoding: Set by libavcodec.
2011 enum AVSampleFormat sample_fmt; ///< sample format
2013 /* The following data should not be initialized. */
2015 * Number of samples per channel in an audio frame.
2017 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2018 * except the last must contain exactly frame_size samples per channel.
2019 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2020 * frame size is not restricted.
2021 * - decoding: may be set by some decoders to indicate constant frame size
2026 * Frame counter, set by libavcodec.
2028 * - decoding: total number of frames returned from the decoder so far.
2029 * - encoding: total number of frames passed to the encoder so far.
2031 * @note the counter is not incremented if encoding/decoding resulted in
2037 * number of bytes per packet if constant and known or 0
2038 * Used by some WAV based audio codecs.
2043 * Audio cutoff bandwidth (0 means "automatic")
2044 * - encoding: Set by user.
2045 * - decoding: unused
2050 * Audio channel layout.
2051 * - encoding: set by user.
2052 * - decoding: set by libavcodec.
2054 uint64_t channel_layout;
2057 * Request decoder to use this channel layout if it can (0 for default)
2058 * - encoding: unused
2059 * - decoding: Set by user.
2061 uint64_t request_channel_layout;
2064 * Type of service that the audio stream conveys.
2065 * - encoding: Set by user.
2066 * - decoding: Set by libavcodec.
2068 enum AVAudioServiceType audio_service_type;
2071 * Used to request a sample format from the decoder.
2072 * - encoding: unused.
2073 * - decoding: Set by user.
2075 enum AVSampleFormat request_sample_fmt;
2078 * This callback is called at the beginning of each frame to get data
2079 * buffer(s) for it. There may be one contiguous buffer for all the data or
2080 * there may be a buffer per each data plane or anything in between. What
2081 * this means is, you may set however many entries in buf[] you feel necessary.
2082 * Each buffer must be reference-counted using the AVBuffer API (see description
2085 * The following fields will be set in the frame before this callback is
2088 * - width, height (video only)
2089 * - sample_rate, channel_layout, nb_samples (audio only)
2090 * Their values may differ from the corresponding values in
2091 * AVCodecContext. This callback must use the frame values, not the codec
2092 * context values, to calculate the required buffer size.
2094 * This callback must fill the following fields in the frame:
2098 * * if the data is planar audio with more than 8 channels, then this
2099 * callback must allocate and fill extended_data to contain all pointers
2100 * to all data planes. data[] must hold as many pointers as it can.
2101 * extended_data must be allocated with av_malloc() and will be freed in
2103 * * otherwise exended_data must point to data
2104 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2105 * the frame's data and extended_data pointers must be contained in these. That
2106 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2107 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2108 * and av_buffer_ref().
2109 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2110 * this callback and filled with the extra buffers if there are more
2111 * buffers than buf[] can hold. extended_buf will be freed in
2114 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2115 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2118 * Each data plane must be aligned to the maximum required by the target
2121 * @see avcodec_default_get_buffer2()
2125 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2126 * (read and/or written to if it is writable) later by libavcodec.
2128 * avcodec_align_dimensions2() should be used to find the required width and
2129 * height, as they normally need to be rounded up to the next multiple of 16.
2131 * If frame multithreading is used and thread_safe_callbacks is set,
2132 * this callback may be called from a different thread, but not from more
2133 * than one at once. Does not need to be reentrant.
2135 * @see avcodec_align_dimensions2()
2139 * Decoders request a buffer of a particular size by setting
2140 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2141 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2142 * to a smaller value in the output frame.
2144 * As a convenience, av_samples_get_buffer_size() and
2145 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2146 * functions to find the required data size and to fill data pointers and
2147 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2148 * since all planes must be the same size.
2150 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2152 * - encoding: unused
2153 * - decoding: Set by libavcodec, user can override.
2155 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2158 * If non-zero, the decoded audio and video frames returned from
2159 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2160 * and are valid indefinitely. The caller must free them with
2161 * av_frame_unref() when they are not needed anymore.
2162 * Otherwise, the decoded frames must not be freed by the caller and are
2163 * only valid until the next decode call.
2165 * - encoding: unused
2166 * - decoding: set by the caller before avcodec_open2().
2168 int refcounted_frames;
2170 /* - encoding parameters */
2171 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2172 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2176 * - encoding: Set by user.
2177 * - decoding: unused
2183 * - encoding: Set by user.
2184 * - decoding: unused
2189 * maximum quantizer difference between frames
2190 * - encoding: Set by user.
2191 * - decoding: unused
2197 * @deprecated use encoder private options instead
2199 attribute_deprecated
2202 attribute_deprecated
2204 attribute_deprecated
2209 * decoder bitstream buffer size
2210 * - encoding: Set by user.
2211 * - decoding: unused
2216 * ratecontrol override, see RcOverride
2217 * - encoding: Allocated/set/freed by user.
2218 * - decoding: unused
2220 int rc_override_count;
2221 RcOverride *rc_override;
2225 * @deprecated use encoder private options instead
2227 attribute_deprecated
2233 * - encoding: Set by user.
2234 * - decoding: unused
2240 * - encoding: Set by user.
2241 * - decoding: unused
2247 * @deprecated use encoder private options instead
2249 attribute_deprecated
2250 float rc_buffer_aggressivity;
2252 attribute_deprecated
2253 float rc_initial_cplx;
2257 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2258 * - encoding: Set by user.
2259 * - decoding: unused.
2261 float rc_max_available_vbv_use;
2264 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2265 * - encoding: Set by user.
2266 * - decoding: unused.
2268 float rc_min_vbv_overflow_use;
2271 * Number of bits which should be loaded into the rc buffer before decoding starts.
2272 * - encoding: Set by user.
2273 * - decoding: unused
2275 int rc_initial_buffer_occupancy;
2277 #define FF_CODER_TYPE_VLC 0
2278 #define FF_CODER_TYPE_AC 1
2279 #define FF_CODER_TYPE_RAW 2
2280 #define FF_CODER_TYPE_RLE 3
2281 #if FF_API_UNUSED_MEMBERS
2282 #define FF_CODER_TYPE_DEFLATE 4
2283 #endif /* FF_API_UNUSED_MEMBERS */
2286 * - encoding: Set by user.
2287 * - decoding: unused
2293 * - encoding: Set by user.
2294 * - decoding: unused
2300 * @deprecated use encoder private options instead
2302 attribute_deprecated
2306 * @deprecated use encoder private options instead
2308 attribute_deprecated
2313 * frame skip threshold
2314 * - encoding: Set by user.
2315 * - decoding: unused
2317 int frame_skip_threshold;
2321 * - encoding: Set by user.
2322 * - decoding: unused
2324 int frame_skip_factor;
2327 * frame skip exponent
2328 * - encoding: Set by user.
2329 * - decoding: unused
2334 * frame skip comparison function
2335 * - encoding: Set by user.
2336 * - decoding: unused
2341 * trellis RD quantization
2342 * - encoding: Set by user.
2343 * - decoding: unused
2348 * - encoding: Set by user.
2349 * - decoding: unused
2351 int min_prediction_order;
2354 * - encoding: Set by user.
2355 * - decoding: unused
2357 int max_prediction_order;
2360 * GOP timecode frame start number, in non drop frame format
2361 * - encoding: Set by user.
2362 * - decoding: unused
2364 int64_t timecode_frame_start;
2366 /* The RTP callback: This function is called */
2367 /* every time the encoder has a packet to send. */
2368 /* It depends on the encoder if the data starts */
2369 /* with a Start Code (it should). H.263 does. */
2370 /* mb_nb contains the number of macroblocks */
2371 /* encoded in the RTP payload. */
2372 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2374 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2375 /* do its best to deliver a chunk with size */
2376 /* below rtp_payload_size, the chunk will start */
2377 /* with a start code on some codecs like H.263. */
2378 /* This doesn't take account of any particular */
2379 /* headers inside the transmitted RTP payload. */
2381 /* statistics, used for 2-pass encoding */
2392 * number of bits used for the previously encoded frame
2393 * - encoding: Set by libavcodec.
2394 * - decoding: unused
2399 * pass1 encoding statistics output buffer
2400 * - encoding: Set by libavcodec.
2401 * - decoding: unused
2406 * pass2 encoding statistics input buffer
2407 * Concatenated stuff from stats_out of pass1 should be placed here.
2408 * - encoding: Allocated/set/freed by user.
2409 * - decoding: unused
2414 * Work around bugs in encoders which sometimes cannot be detected automatically.
2415 * - encoding: Set by user
2416 * - decoding: Set by user
2418 int workaround_bugs;
2419 #define FF_BUG_AUTODETECT 1 ///< autodetection
2420 #if FF_API_OLD_MSMPEG4
2421 #define FF_BUG_OLD_MSMPEG4 2
2423 #define FF_BUG_XVID_ILACE 4
2424 #define FF_BUG_UMP4 8
2425 #define FF_BUG_NO_PADDING 16
2426 #define FF_BUG_AMV 32
2428 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2430 #define FF_BUG_QPEL_CHROMA 64
2431 #define FF_BUG_STD_QPEL 128
2432 #define FF_BUG_QPEL_CHROMA2 256
2433 #define FF_BUG_DIRECT_BLOCKSIZE 512
2434 #define FF_BUG_EDGE 1024
2435 #define FF_BUG_HPEL_CHROMA 2048
2436 #define FF_BUG_DC_CLIP 4096
2437 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2438 #define FF_BUG_TRUNCATED 16384
2441 * strictly follow the standard (MPEG4, ...).
2442 * - encoding: Set by user.
2443 * - decoding: Set by user.
2444 * Setting this to STRICT or higher means the encoder and decoder will
2445 * generally do stupid things, whereas setting it to unofficial or lower
2446 * will mean the encoder might produce output that is not supported by all
2447 * spec-compliant decoders. Decoders don't differentiate between normal,
2448 * unofficial and experimental (that is, they always try to decode things
2449 * when they can) unless they are explicitly asked to behave stupidly
2450 * (=strictly conform to the specs)
2452 int strict_std_compliance;
2453 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2454 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2455 #define FF_COMPLIANCE_NORMAL 0
2456 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2457 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2460 * error concealment flags
2461 * - encoding: unused
2462 * - decoding: Set by user.
2464 int error_concealment;
2465 #define FF_EC_GUESS_MVS 1
2466 #define FF_EC_DEBLOCK 2
2470 * - encoding: Set by user.
2471 * - decoding: Set by user.
2474 #define FF_DEBUG_PICT_INFO 1
2475 #define FF_DEBUG_RC 2
2476 #define FF_DEBUG_BITSTREAM 4
2477 #define FF_DEBUG_MB_TYPE 8
2478 #define FF_DEBUG_QP 16
2481 * @deprecated this option does nothing
2483 #define FF_DEBUG_MV 32
2485 #define FF_DEBUG_DCT_COEFF 0x00000040
2486 #define FF_DEBUG_SKIP 0x00000080
2487 #define FF_DEBUG_STARTCODE 0x00000100
2488 #if FF_API_UNUSED_MEMBERS
2489 #define FF_DEBUG_PTS 0x00000200
2490 #endif /* FF_API_UNUSED_MEMBERS */
2491 #define FF_DEBUG_ER 0x00000400
2492 #define FF_DEBUG_MMCO 0x00000800
2493 #define FF_DEBUG_BUGS 0x00001000
2495 #define FF_DEBUG_VIS_QP 0x00002000
2496 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2498 #define FF_DEBUG_BUFFERS 0x00008000
2499 #define FF_DEBUG_THREADS 0x00010000
2503 * @deprecated this option does not have any effect
2505 attribute_deprecated
2507 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2508 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2509 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2513 * Error recognition; may misdetect some more or less valid parts as errors.
2514 * - encoding: unused
2515 * - decoding: Set by user.
2517 int err_recognition;
2520 * Verify checksums embedded in the bitstream (could be of either encoded or
2521 * decoded data, depending on the codec) and print an error message on mismatch.
2522 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2523 * decoder returning an error.
2525 #define AV_EF_CRCCHECK (1<<0)
2526 #define AV_EF_BITSTREAM (1<<1)
2527 #define AV_EF_BUFFER (1<<2)
2528 #define AV_EF_EXPLODE (1<<3)
2531 * opaque 64bit number (generally a PTS) that will be reordered and
2532 * output in AVFrame.reordered_opaque
2533 * - encoding: unused
2534 * - decoding: Set by user.
2536 int64_t reordered_opaque;
2539 * Hardware accelerator in use
2540 * - encoding: unused.
2541 * - decoding: Set by libavcodec
2543 struct AVHWAccel *hwaccel;
2546 * Hardware accelerator context.
2547 * For some hardware accelerators, a global context needs to be
2548 * provided by the user. In that case, this holds display-dependent
2549 * data Libav cannot instantiate itself. Please refer to the
2550 * Libav HW accelerator documentation to know how to fill this
2551 * is. e.g. for VA API, this is a struct vaapi_context.
2552 * - encoding: unused
2553 * - decoding: Set by user
2555 void *hwaccel_context;
2559 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2560 * - decoding: unused
2562 uint64_t error[AV_NUM_DATA_POINTERS];
2565 * DCT algorithm, see FF_DCT_* below
2566 * - encoding: Set by user.
2567 * - decoding: unused
2570 #define FF_DCT_AUTO 0
2571 #define FF_DCT_FASTINT 1
2572 #if FF_API_UNUSED_MEMBERS
2573 #define FF_DCT_INT 2
2574 #endif /* FF_API_UNUSED_MEMBERS */
2575 #define FF_DCT_MMX 3
2576 #define FF_DCT_ALTIVEC 5
2577 #define FF_DCT_FAAN 6
2580 * IDCT algorithm, see FF_IDCT_* below.
2581 * - encoding: Set by user.
2582 * - decoding: Set by user.
2585 #define FF_IDCT_AUTO 0
2586 #define FF_IDCT_INT 1
2587 #define FF_IDCT_SIMPLE 2
2588 #define FF_IDCT_SIMPLEMMX 3
2589 #define FF_IDCT_ARM 7
2590 #define FF_IDCT_ALTIVEC 8
2592 #define FF_IDCT_SH4 9
2594 #define FF_IDCT_SIMPLEARM 10
2595 #if FF_API_UNUSED_MEMBERS
2596 #define FF_IDCT_IPP 13
2597 #endif /* FF_API_UNUSED_MEMBERS */
2598 #define FF_IDCT_XVID 14
2599 #if FF_API_IDCT_XVIDMMX
2600 #define FF_IDCT_XVIDMMX 14
2601 #endif /* FF_API_IDCT_XVIDMMX */
2602 #define FF_IDCT_SIMPLEARMV5TE 16
2603 #define FF_IDCT_SIMPLEARMV6 17
2604 #if FF_API_ARCH_SPARC
2605 #define FF_IDCT_SIMPLEVIS 18
2607 #define FF_IDCT_FAAN 20
2608 #define FF_IDCT_SIMPLENEON 22
2609 #if FF_API_ARCH_ALPHA
2610 #define FF_IDCT_SIMPLEALPHA 23
2614 * bits per sample/pixel from the demuxer (needed for huffyuv).
2615 * - encoding: Set by libavcodec.
2616 * - decoding: Set by user.
2618 int bits_per_coded_sample;
2621 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2622 * - encoding: set by user.
2623 * - decoding: set by libavcodec.
2625 int bits_per_raw_sample;
2629 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2630 * - encoding: unused
2631 * - decoding: Set by user.
2633 * @deprecated use decoder private options instead
2635 attribute_deprecated int lowres;
2638 #if FF_API_CODED_FRAME
2640 * the picture in the bitstream
2641 * - encoding: Set by libavcodec.
2642 * - decoding: unused
2644 * @deprecated use the quality factor packet side data instead
2646 attribute_deprecated AVFrame *coded_frame;
2651 * is used to decide how many independent tasks should be passed to execute()
2652 * - encoding: Set by user.
2653 * - decoding: Set by user.
2658 * Which multithreading methods to use.
2659 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2660 * so clients which cannot provide future frames should not use it.
2662 * - encoding: Set by user, otherwise the default is used.
2663 * - decoding: Set by user, otherwise the default is used.
2666 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2667 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2670 * Which multithreading methods are in use by the codec.
2671 * - encoding: Set by libavcodec.
2672 * - decoding: Set by libavcodec.
2674 int active_thread_type;
2677 * Set by the client if its custom get_buffer() callback can be called
2678 * synchronously from another thread, which allows faster multithreaded decoding.
2679 * draw_horiz_band() will be called from other threads regardless of this setting.
2680 * Ignored if the default get_buffer() is used.
2681 * - encoding: Set by user.
2682 * - decoding: Set by user.
2684 int thread_safe_callbacks;
2687 * The codec may call this to execute several independent things.
2688 * It will return only after finishing all tasks.
2689 * The user may replace this with some multithreaded implementation,
2690 * the default implementation will execute the parts serially.
2691 * @param count the number of things to execute
2692 * - encoding: Set by libavcodec, user can override.
2693 * - decoding: Set by libavcodec, user can override.
2695 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2698 * The codec may call this to execute several independent things.
2699 * It will return only after finishing all tasks.
2700 * The user may replace this with some multithreaded implementation,
2701 * the default implementation will execute the parts serially.
2702 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2703 * @param c context passed also to func
2704 * @param count the number of things to execute
2705 * @param arg2 argument passed unchanged to func
2706 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2707 * @param func function that will be called count times, with jobnr from 0 to count-1.
2708 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2709 * two instances of func executing at the same time will have the same threadnr.
2710 * @return always 0 currently, but code should handle a future improvement where when any call to func
2711 * returns < 0 no further calls to func may be done and < 0 is returned.
2712 * - encoding: Set by libavcodec, user can override.
2713 * - decoding: Set by libavcodec, user can override.
2715 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2718 * noise vs. sse weight for the nsse comparsion function
2719 * - encoding: Set by user.
2720 * - decoding: unused
2726 * - encoding: Set by user.
2727 * - decoding: Set by libavcodec.
2730 #define FF_PROFILE_UNKNOWN -99
2731 #define FF_PROFILE_RESERVED -100
2733 #define FF_PROFILE_AAC_MAIN 0
2734 #define FF_PROFILE_AAC_LOW 1
2735 #define FF_PROFILE_AAC_SSR 2
2736 #define FF_PROFILE_AAC_LTP 3
2737 #define FF_PROFILE_AAC_HE 4
2738 #define FF_PROFILE_AAC_HE_V2 28
2739 #define FF_PROFILE_AAC_LD 22
2740 #define FF_PROFILE_AAC_ELD 38
2741 #define FF_PROFILE_MPEG2_AAC_LOW 128
2742 #define FF_PROFILE_MPEG2_AAC_HE 131
2744 #define FF_PROFILE_DTS 20
2745 #define FF_PROFILE_DTS_ES 30
2746 #define FF_PROFILE_DTS_96_24 40
2747 #define FF_PROFILE_DTS_HD_HRA 50
2748 #define FF_PROFILE_DTS_HD_MA 60
2749 #define FF_PROFILE_DTS_EXPRESS 70
2751 #define FF_PROFILE_MPEG2_422 0
2752 #define FF_PROFILE_MPEG2_HIGH 1
2753 #define FF_PROFILE_MPEG2_SS 2
2754 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2755 #define FF_PROFILE_MPEG2_MAIN 4
2756 #define FF_PROFILE_MPEG2_SIMPLE 5
2758 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2759 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2761 #define FF_PROFILE_H264_BASELINE 66
2762 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2763 #define FF_PROFILE_H264_MAIN 77
2764 #define FF_PROFILE_H264_EXTENDED 88
2765 #define FF_PROFILE_H264_HIGH 100
2766 #define FF_PROFILE_H264_HIGH_10 110
2767 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2768 #define FF_PROFILE_H264_HIGH_422 122
2769 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2770 #define FF_PROFILE_H264_HIGH_444 144
2771 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2772 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2773 #define FF_PROFILE_H264_CAVLC_444 44
2775 #define FF_PROFILE_VC1_SIMPLE 0
2776 #define FF_PROFILE_VC1_MAIN 1
2777 #define FF_PROFILE_VC1_COMPLEX 2
2778 #define FF_PROFILE_VC1_ADVANCED 3
2780 #define FF_PROFILE_MPEG4_SIMPLE 0
2781 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2782 #define FF_PROFILE_MPEG4_CORE 2
2783 #define FF_PROFILE_MPEG4_MAIN 3
2784 #define FF_PROFILE_MPEG4_N_BIT 4
2785 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2786 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2787 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2788 #define FF_PROFILE_MPEG4_HYBRID 8
2789 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2790 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2791 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2792 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2793 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2794 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2795 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2797 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2798 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2799 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2800 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2801 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2803 #define FF_PROFILE_VP9_0 0
2804 #define FF_PROFILE_VP9_1 1
2805 #define FF_PROFILE_VP9_2 2
2806 #define FF_PROFILE_VP9_3 3
2808 #define FF_PROFILE_HEVC_MAIN 1
2809 #define FF_PROFILE_HEVC_MAIN_10 2
2810 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2814 * - encoding: Set by user.
2815 * - decoding: Set by libavcodec.
2818 #define FF_LEVEL_UNKNOWN -99
2822 * - encoding: unused
2823 * - decoding: Set by user.
2825 enum AVDiscard skip_loop_filter;
2829 * - encoding: unused
2830 * - decoding: Set by user.
2832 enum AVDiscard skip_idct;
2836 * - encoding: unused
2837 * - decoding: Set by user.
2839 enum AVDiscard skip_frame;
2842 * Header containing style information for text subtitles.
2843 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2844 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2845 * the Format line following. It shouldn't include any Dialogue line.
2846 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2847 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2849 uint8_t *subtitle_header;
2850 int subtitle_header_size;
2852 #if FF_API_ERROR_RATE
2854 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2857 attribute_deprecated
2862 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2863 * Used for compliant TS muxing.
2864 * - encoding: Set by libavcodec.
2865 * - decoding: unused.
2870 * Encoding only. Allow encoders to output packets that do not contain any
2871 * encoded data, only side data.
2873 * Some encoders need to output such packets, e.g. to update some stream
2874 * parameters at the end of encoding.
2876 * All callers are strongly recommended to set this option to 1 and update
2877 * their code to deal with such packets, since this behaviour may become
2878 * always enabled in the future (then this option will be deprecated and
2879 * later removed). To avoid ABI issues when this happens, the callers should
2880 * use AVOptions to set this field.
2882 int side_data_only_packets;
2885 * Audio only. The number of "priming" samples (padding) inserted by the
2886 * encoder at the beginning of the audio. I.e. this number of leading
2887 * decoded samples must be discarded by the caller to get the original audio
2888 * without leading padding.
2890 * - decoding: unused
2891 * - encoding: Set by libavcodec. The timestamps on the output packets are
2892 * adjusted by the encoder so that they always refer to the
2893 * first sample of the data actually contained in the packet,
2894 * including any added padding. E.g. if the timebase is
2895 * 1/samplerate and the timestamp of the first input sample is
2896 * 0, the timestamp of the first output packet will be
2899 int initial_padding;
2902 * - decoding: For codecs that store a framerate value in the compressed
2903 * bitstream, the decoder may export it here. { 0, 1} when
2905 * - encoding: unused
2907 AVRational framerate;
2910 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2911 * - encoding: unused.
2912 * - decoding: Set by libavcodec before calling get_format()
2914 enum AVPixelFormat sw_pix_fmt;
2920 typedef struct AVProfile {
2922 const char *name; ///< short name for the profile
2925 typedef struct AVCodecDefault AVCodecDefault;
2932 typedef struct AVCodec {
2934 * Name of the codec implementation.
2935 * The name is globally unique among encoders and among decoders (but an
2936 * encoder and a decoder can share the same name).
2937 * This is the primary way to find a codec from the user perspective.
2941 * Descriptive name for the codec, meant to be more human readable than name.
2942 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2944 const char *long_name;
2945 enum AVMediaType type;
2948 * Codec capabilities.
2949 * see AV_CODEC_CAP_*
2952 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2953 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2954 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2955 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2956 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2958 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2960 const AVClass *priv_class; ///< AVClass for the private context
2961 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2963 /*****************************************************************
2964 * No fields below this line are part of the public API. They
2965 * may not be used outside of libavcodec and can be changed and
2967 * New public fields should be added right above.
2968 *****************************************************************
2971 struct AVCodec *next;
2973 * @name Frame-level threading support functions
2977 * If defined, called on thread contexts when they are created.
2978 * If the codec allocates writable tables in init(), re-allocate them here.
2979 * priv_data will be set to a copy of the original.
2981 int (*init_thread_copy)(AVCodecContext *);
2983 * Copy necessary context variables from a previous thread context to the current one.
2984 * If not defined, the next thread will start automatically; otherwise, the codec
2985 * must call ff_thread_finish_setup().
2987 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2989 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2993 * Private codec-specific defaults.
2995 const AVCodecDefault *defaults;
2998 * Initialize codec static data, called from avcodec_register().
3000 void (*init_static_data)(struct AVCodec *codec);
3002 int (*init)(AVCodecContext *);
3003 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3004 const struct AVSubtitle *sub);
3006 * Encode data to an AVPacket.
3008 * @param avctx codec context
3009 * @param avpkt output AVPacket (may contain a user-provided buffer)
3010 * @param[in] frame AVFrame containing the raw data to be encoded
3011 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3012 * non-empty packet was returned in avpkt.
3013 * @return 0 on success, negative error code on failure
3015 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3016 int *got_packet_ptr);
3017 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3018 int (*close)(AVCodecContext *);
3021 * Will be called when seeking
3023 void (*flush)(AVCodecContext *);
3025 * Internal codec capabilities.
3026 * See FF_CODEC_CAP_* in internal.h
3032 * @defgroup lavc_hwaccel AVHWAccel
3035 typedef struct AVHWAccel {
3037 * Name of the hardware accelerated codec.
3038 * The name is globally unique among encoders and among decoders (but an
3039 * encoder and a decoder can share the same name).
3044 * Type of codec implemented by the hardware accelerator.
3046 * See AVMEDIA_TYPE_xxx
3048 enum AVMediaType type;
3051 * Codec implemented by the hardware accelerator.
3053 * See AV_CODEC_ID_xxx
3058 * Supported pixel format.
3060 * Only hardware accelerated formats are supported here.
3062 enum AVPixelFormat pix_fmt;
3065 * Hardware accelerated codec capabilities.
3066 * see FF_HWACCEL_CODEC_CAP_*
3070 /*****************************************************************
3071 * No fields below this line are part of the public API. They
3072 * may not be used outside of libavcodec and can be changed and
3074 * New public fields should be added right above.
3075 *****************************************************************
3077 struct AVHWAccel *next;
3080 * Allocate a custom buffer
3082 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3085 * Called at the beginning of each frame or field picture.
3087 * Meaningful frame information (codec specific) is guaranteed to
3088 * be parsed at this point. This function is mandatory.
3090 * Note that buf can be NULL along with buf_size set to 0.
3091 * Otherwise, this means the whole frame is available at this point.
3093 * @param avctx the codec context
3094 * @param buf the frame data buffer base
3095 * @param buf_size the size of the frame in bytes
3096 * @return zero if successful, a negative value otherwise
3098 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3101 * Callback for each slice.
3103 * Meaningful slice information (codec specific) is guaranteed to
3104 * be parsed at this point. This function is mandatory.
3106 * @param avctx the codec context
3107 * @param buf the slice data buffer base
3108 * @param buf_size the size of the slice in bytes
3109 * @return zero if successful, a negative value otherwise
3111 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3114 * Called at the end of each frame or field picture.
3116 * The whole picture is parsed at this point and can now be sent
3117 * to the hardware accelerator. This function is mandatory.
3119 * @param avctx the codec context
3120 * @return zero if successful, a negative value otherwise
3122 int (*end_frame)(AVCodecContext *avctx);
3125 * Size of per-frame hardware accelerator private data.
3127 * Private data is allocated with av_mallocz() before
3128 * AVCodecContext.get_buffer() and deallocated after
3129 * AVCodecContext.release_buffer().
3131 int frame_priv_data_size;
3134 * Initialize the hwaccel private data.
3136 * This will be called from ff_get_format(), after hwaccel and
3137 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3140 int (*init)(AVCodecContext *avctx);
3143 * Uninitialize the hwaccel private data.
3145 * This will be called from get_format() or avcodec_close(), after hwaccel
3146 * and hwaccel_context are already uninitialized.
3148 int (*uninit)(AVCodecContext *avctx);
3151 * Size of the private data to allocate in
3152 * AVCodecInternal.hwaccel_priv_data.
3158 * Hardware acceleration should be used for decoding even if the codec level
3159 * used is unknown or higher than the maximum supported level reported by the
3162 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3165 * Hardware acceleration can output YUV pixel formats with a different chroma
3166 * sampling than 4:2:0 and/or other than 8 bits per component.
3168 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3175 * @defgroup lavc_picture AVPicture
3177 * Functions for working with AVPicture
3182 * four components are given, that's all.
3183 * the last component is alpha
3185 typedef struct AVPicture {
3186 uint8_t *data[AV_NUM_DATA_POINTERS];
3187 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3194 #define AVPALETTE_SIZE 1024
3195 #define AVPALETTE_COUNT 256
3197 enum AVSubtitleType {
3200 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3203 * Plain text, the text field must be set by the decoder and is
3204 * authoritative. ass and pict fields may contain approximations.
3209 * Formatted text, the ass field must be set by the decoder and is
3210 * authoritative. pict and text fields may contain approximations.
3215 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3217 typedef struct AVSubtitleRect {
3218 int x; ///< top left corner of pict, undefined when pict is not set
3219 int y; ///< top left corner of pict, undefined when pict is not set
3220 int w; ///< width of pict, undefined when pict is not set
3221 int h; ///< height of pict, undefined when pict is not set
3222 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3225 * data+linesize for the bitmap of this subtitle.
3226 * can be set for text/ass as well once they where rendered
3229 enum AVSubtitleType type;
3231 char *text; ///< 0 terminated plain UTF-8 text
3234 * 0 terminated ASS/SSA compatible event line.
3235 * The pressentation of this is unaffected by the other values in this
3242 typedef struct AVSubtitle {
3243 uint16_t format; /* 0 = graphics */
3244 uint32_t start_display_time; /* relative to packet pts, in ms */
3245 uint32_t end_display_time; /* relative to packet pts, in ms */
3247 AVSubtitleRect **rects;
3248 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3252 * If c is NULL, returns the first registered codec,
3253 * if c is non-NULL, returns the next registered codec after c,
3254 * or NULL if c is the last one.
3256 AVCodec *av_codec_next(const AVCodec *c);
3259 * Return the LIBAVCODEC_VERSION_INT constant.
3261 unsigned avcodec_version(void);
3264 * Return the libavcodec build-time configuration.
3266 const char *avcodec_configuration(void);
3269 * Return the libavcodec license.
3271 const char *avcodec_license(void);
3274 * Register the codec codec and initialize libavcodec.
3276 * @warning either this function or avcodec_register_all() must be called
3277 * before any other libavcodec functions.
3279 * @see avcodec_register_all()
3281 void avcodec_register(AVCodec *codec);
3284 * Register all the codecs, parsers and bitstream filters which were enabled at
3285 * configuration time. If you do not call this function you can select exactly
3286 * which formats you want to support, by using the individual registration
3289 * @see avcodec_register
3290 * @see av_register_codec_parser
3291 * @see av_register_bitstream_filter
3293 void avcodec_register_all(void);
3296 * Allocate an AVCodecContext and set its fields to default values. The
3297 * resulting struct should be freed with avcodec_free_context().
3299 * @param codec if non-NULL, allocate private data and initialize defaults
3300 * for the given codec. It is illegal to then call avcodec_open2()
3301 * with a different codec.
3302 * If NULL, then the codec-specific defaults won't be initialized,
3303 * which may result in suboptimal default settings (this is
3304 * important mainly for encoders, e.g. libx264).
3306 * @return An AVCodecContext filled with default values or NULL on failure.
3307 * @see avcodec_get_context_defaults
3309 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3312 * Free the codec context and everything associated with it and write NULL to
3313 * the provided pointer.
3315 void avcodec_free_context(AVCodecContext **avctx);
3318 * Set the fields of the given AVCodecContext to default values corresponding
3319 * to the given codec (defaults may be codec-dependent).
3321 * Do not call this function if a non-NULL codec has been passed
3322 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3323 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3324 * different codec on this AVCodecContext.
3326 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3329 * Get the AVClass for AVCodecContext. It can be used in combination with
3330 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3332 * @see av_opt_find().
3334 const AVClass *avcodec_get_class(void);
3337 * Copy the settings of the source AVCodecContext into the destination
3338 * AVCodecContext. The resulting destination codec context will be
3339 * unopened, i.e. you are required to call avcodec_open2() before you
3340 * can use this AVCodecContext to decode/encode video/audio data.
3342 * @param dest target codec context, should be initialized with
3343 * avcodec_alloc_context3(), but otherwise uninitialized
3344 * @param src source codec context
3345 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3347 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3349 #if FF_API_AVFRAME_LAVC
3351 * @deprecated use av_frame_alloc()
3353 attribute_deprecated
3354 AVFrame *avcodec_alloc_frame(void);
3357 * Set the fields of the given AVFrame to default values.
3359 * @param frame The AVFrame of which the fields should be set to default values.
3361 * @deprecated use av_frame_unref()
3363 attribute_deprecated
3364 void avcodec_get_frame_defaults(AVFrame *frame);
3367 * Free the frame and any dynamically allocated objects in it,
3368 * e.g. extended_data.
3370 * @param frame frame to be freed. The pointer will be set to NULL.
3372 * @warning this function does NOT free the data buffers themselves
3373 * (it does not know how, since they might have been allocated with
3374 * a custom get_buffer()).
3376 * @deprecated use av_frame_free()
3378 attribute_deprecated
3379 void avcodec_free_frame(AVFrame **frame);
3383 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3384 * function the context has to be allocated with avcodec_alloc_context3().
3386 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3387 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3388 * retrieving a codec.
3390 * @warning This function is not thread safe!
3392 * @note Always call this function before using decoding routines (such as
3393 * @ref avcodec_decode_video2()).
3396 * avcodec_register_all();
3397 * av_dict_set(&opts, "b", "2.5M", 0);
3398 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3402 * context = avcodec_alloc_context3(codec);
3404 * if (avcodec_open2(context, codec, opts) < 0)
3408 * @param avctx The context to initialize.
3409 * @param codec The codec to open this context for. If a non-NULL codec has been
3410 * previously passed to avcodec_alloc_context3() or
3411 * avcodec_get_context_defaults3() for this context, then this
3412 * parameter MUST be either NULL or equal to the previously passed
3414 * @param options A dictionary filled with AVCodecContext and codec-private options.
3415 * On return this object will be filled with options that were not found.
3417 * @return zero on success, a negative value on error
3418 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3419 * av_dict_set(), av_opt_find().
3421 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3424 * Close a given AVCodecContext and free all the data associated with it
3425 * (but not the AVCodecContext itself).
3427 * Calling this function on an AVCodecContext that hasn't been opened will free
3428 * the codec-specific data allocated in avcodec_alloc_context3() /
3429 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3432 int avcodec_close(AVCodecContext *avctx);
3435 * Free all allocated data in the given subtitle struct.
3437 * @param sub AVSubtitle to free.
3439 void avsubtitle_free(AVSubtitle *sub);
3446 * @addtogroup lavc_packet
3451 * Initialize optional fields of a packet with default values.
3453 * Note, this does not touch the data and size members, which have to be
3454 * initialized separately.
3458 void av_init_packet(AVPacket *pkt);
3461 * Allocate the payload of a packet and initialize its fields with
3465 * @param size wanted payload size
3466 * @return 0 if OK, AVERROR_xxx otherwise
3468 int av_new_packet(AVPacket *pkt, int size);
3471 * Reduce packet size, correctly zeroing padding
3474 * @param size new size
3476 void av_shrink_packet(AVPacket *pkt, int size);
3479 * Increase packet size, correctly zeroing padding
3482 * @param grow_by number of bytes by which to increase the size of the packet
3484 int av_grow_packet(AVPacket *pkt, int grow_by);
3487 * Initialize a reference-counted packet from av_malloc()ed data.
3489 * @param pkt packet to be initialized. This function will set the data, size,
3490 * buf and destruct fields, all others are left untouched.
3491 * @param data Data allocated by av_malloc() to be used as packet data. If this
3492 * function returns successfully, the data is owned by the underlying AVBuffer.
3493 * The caller may not access the data through other means.
3494 * @param size size of data in bytes, without the padding. I.e. the full buffer
3495 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
3497 * @return 0 on success, a negative AVERROR on error
3499 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3502 * @warning This is a hack - the packet memory allocation stuff is broken. The
3503 * packet is allocated if it was not really allocated.
3505 int av_dup_packet(AVPacket *pkt);
3510 * @param pkt packet to free
3512 void av_free_packet(AVPacket *pkt);
3515 * Allocate new information of a packet.
3518 * @param type side information type
3519 * @param size side information size
3520 * @return pointer to fresh allocated data or NULL otherwise
3522 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3526 * Shrink the already allocated side data buffer
3529 * @param type side information type
3530 * @param size new side information size
3531 * @return 0 on success, < 0 on failure
3533 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3537 * Get side information from packet.
3540 * @param type desired side information type
3541 * @param size pointer for side information size to store (optional)
3542 * @return pointer to data if present or NULL otherwise
3544 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3548 * Convenience function to free all the side data stored.
3549 * All the other fields stay untouched.
3553 void av_packet_free_side_data(AVPacket *pkt);
3556 * Setup a new reference to the data described by a given packet
3558 * If src is reference-counted, setup dst as a new reference to the
3559 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3560 * data from src into it.
3562 * All the other fields are copied from src.
3564 * @see av_packet_unref
3566 * @param dst Destination packet
3567 * @param src Source packet
3569 * @return 0 on success, a negative AVERROR on error.
3571 int av_packet_ref(AVPacket *dst, AVPacket *src);
3576 * Unreference the buffer referenced by the packet and reset the
3577 * remaining packet fields to their default values.
3579 * @param pkt The packet to be unreferenced.
3581 void av_packet_unref(AVPacket *pkt);
3584 * Move every field in src to dst and reset src.
3586 * @see av_packet_unref
3588 * @param src Source packet, will be reset
3589 * @param dst Destination packet
3591 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3594 * Copy only "properties" fields from src to dst.
3596 * Properties for the purpose of this function are all the fields
3597 * beside those related to the packet data (buf, data, size)
3599 * @param dst Destination packet
3600 * @param src Source packet
3602 * @return 0 on success AVERROR on failure.
3605 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3608 * Convert valid timing fields (timestamps / durations) in a packet from one
3609 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3612 * @param pkt packet on which the conversion will be performed
3613 * @param tb_src source timebase, in which the timing fields in pkt are
3615 * @param tb_dst destination timebase, to which the timing fields will be
3618 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
3625 * @addtogroup lavc_decoding
3630 * Find a registered decoder with a matching codec ID.
3632 * @param id AVCodecID of the requested decoder
3633 * @return A decoder if one was found, NULL otherwise.
3635 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3638 * Find a registered decoder with the specified name.
3640 * @param name name of the requested decoder
3641 * @return A decoder if one was found, NULL otherwise.
3643 AVCodec *avcodec_find_decoder_by_name(const char *name);
3646 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3647 * it can be called by custom get_buffer2() implementations for decoders without
3648 * AV_CODEC_CAP_DR1 set.
3650 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3654 * Return the amount of padding in pixels which the get_buffer callback must
3655 * provide around the edge of the image for codecs which do not have the
3656 * CODEC_FLAG_EMU_EDGE flag.
3658 * @return Required padding in pixels.
3660 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
3663 attribute_deprecated
3664 unsigned avcodec_get_edge_width(void);
3668 * Modify width and height values so that they will result in a memory
3669 * buffer that is acceptable for the codec if you do not use any horizontal
3672 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3674 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3677 * Modify width and height values so that they will result in a memory
3678 * buffer that is acceptable for the codec if you also ensure that all
3679 * line sizes are a multiple of the respective linesize_align[i].
3681 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3683 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3684 int linesize_align[AV_NUM_DATA_POINTERS]);
3687 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3689 * Some decoders may support multiple frames in a single AVPacket. Such
3690 * decoders would then just decode the first frame and the return value would be
3691 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3692 * called again with an AVPacket containing the remaining data in order to
3693 * decode the second frame, etc... Even if no frames are returned, the packet
3694 * needs to be fed to the decoder with remaining data until it is completely
3695 * consumed or an error occurs.
3697 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3698 * and output. This means that for some packets they will not immediately
3699 * produce decoded output and need to be flushed at the end of decoding to get
3700 * all the decoded data. Flushing is done by calling this function with packets
3701 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3702 * returning samples. It is safe to flush even those decoders that are not
3703 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
3705 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3706 * larger than the actual read bytes because some optimized bitstream
3707 * readers read 32 or 64 bits at once and could read over the end.
3709 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3710 * before packets may be fed to the decoder.
3712 * @param avctx the codec context
3713 * @param[out] frame The AVFrame in which to store decoded audio samples.
3714 * The decoder will allocate a buffer for the decoded frame by
3715 * calling the AVCodecContext.get_buffer2() callback.
3716 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3717 * reference counted and the returned reference belongs to the
3718 * caller. The caller must release the frame using av_frame_unref()
3719 * when the frame is no longer needed. The caller may safely write
3720 * to the frame if av_frame_is_writable() returns 1.
3721 * When AVCodecContext.refcounted_frames is set to 0, the returned
3722 * reference belongs to the decoder and is valid only until the
3723 * next call to this function or until closing or flushing the
3724 * decoder. The caller may not write to it.
3725 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3726 * non-zero. Note that this field being set to zero
3727 * does not mean that an error has occurred. For
3728 * decoders with AV_CODEC_CAP_DELAY set, no given decode
3729 * call is guaranteed to produce a frame.
3730 * @param[in] avpkt The input AVPacket containing the input buffer.
3731 * At least avpkt->data and avpkt->size should be set. Some
3732 * decoders might also require additional fields to be set.
3733 * @return A negative error code is returned if an error occurred during
3734 * decoding, otherwise the number of bytes consumed from the input
3735 * AVPacket is returned.
3737 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3738 int *got_frame_ptr, AVPacket *avpkt);
3741 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3742 * Some decoders may support multiple frames in a single AVPacket, such
3743 * decoders would then just decode the first frame.
3745 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
3746 * the actual read bytes because some optimized bitstream readers read 32 or 64
3747 * bits at once and could read over the end.
3749 * @warning The end of the input buffer buf should be set to 0 to ensure that
3750 * no overreading happens for damaged MPEG streams.
3752 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
3753 * between input and output, these need to be fed with avpkt->data=NULL,
3754 * avpkt->size=0 at the end to return the remaining frames.
3756 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3757 * before packets may be fed to the decoder.
3759 * @param avctx the codec context
3760 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3761 * Use av_frame_alloc() to get an AVFrame. The codec will
3762 * allocate memory for the actual bitmap by calling the
3763 * AVCodecContext.get_buffer2() callback.
3764 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3765 * reference counted and the returned reference belongs to the
3766 * caller. The caller must release the frame using av_frame_unref()
3767 * when the frame is no longer needed. The caller may safely write
3768 * to the frame if av_frame_is_writable() returns 1.
3769 * When AVCodecContext.refcounted_frames is set to 0, the returned
3770 * reference belongs to the decoder and is valid only until the
3771 * next call to this function or until closing or flushing the
3772 * decoder. The caller may not write to it.
3774 * @param[in] avpkt The input AVpacket containing the input buffer.
3775 * You can create such packet with av_init_packet() and by then setting
3776 * data and size, some decoders might in addition need other fields like
3777 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3779 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3780 * @return On error a negative value is returned, otherwise the number of bytes
3781 * used or zero if no frame could be decompressed.
3783 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3784 int *got_picture_ptr,
3788 * Decode a subtitle message.
3789 * Return a negative value on error, otherwise return the number of bytes used.
3790 * If no subtitle could be decompressed, got_sub_ptr is zero.
3791 * Otherwise, the subtitle is stored in *sub.
3792 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3793 * simplicity, because the performance difference is expect to be negligible
3794 * and reusing a get_buffer written for video codecs would probably perform badly
3795 * due to a potentially very different allocation pattern.
3797 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3798 * before packets may be fed to the decoder.
3800 * @param avctx the codec context
3801 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3802 freed with avsubtitle_free if *got_sub_ptr is set.
3803 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3804 * @param[in] avpkt The input AVPacket containing the input buffer.
3806 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3811 * @defgroup lavc_parsing Frame parsing
3815 enum AVPictureStructure {
3816 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3817 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3818 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3819 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3822 typedef struct AVCodecParserContext {
3824 struct AVCodecParser *parser;
3825 int64_t frame_offset; /* offset of the current frame */
3826 int64_t cur_offset; /* current offset
3827 (incremented by each av_parser_parse()) */
3828 int64_t next_frame_offset; /* offset of the next frame */
3830 int pict_type; /* XXX: Put it back in AVCodecContext. */
3832 * This field is used for proper frame duration computation in lavf.
3833 * It signals, how much longer the frame duration of the current frame
3834 * is compared to normal frame duration.
3836 * frame_duration = (1 + repeat_pict) * time_base
3838 * It is used by codecs like H.264 to display telecined material.
3840 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3841 int64_t pts; /* pts of the current frame */
3842 int64_t dts; /* dts of the current frame */
3847 int fetch_timestamp;
3849 #define AV_PARSER_PTS_NB 4
3850 int cur_frame_start_index;
3851 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3852 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3853 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3856 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3857 #define PARSER_FLAG_ONCE 0x0002
3858 /// Set if the parser has a valid file offset
3859 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3861 int64_t offset; ///< byte offset from starting packet start
3862 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3865 * Set by parser to 1 for key frames and 0 for non-key frames.
3866 * It is initialized to -1, so if the parser doesn't set this flag,
3867 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3873 * Time difference in stream time base units from the pts of this
3874 * packet to the point at which the output from the decoder has converged
3875 * independent from the availability of previous frames. That is, the
3876 * frames are virtually identical no matter if decoding started from
3877 * the very first frame or from this keyframe.
3878 * Is AV_NOPTS_VALUE if unknown.
3879 * This field is not the display duration of the current frame.
3880 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3883 * The purpose of this field is to allow seeking in streams that have no
3884 * keyframes in the conventional sense. It corresponds to the
3885 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3886 * essential for some types of subtitle streams to ensure that all
3887 * subtitles are correctly displayed after seeking.
3889 int64_t convergence_duration;
3891 // Timestamp generation support:
3893 * Synchronization point for start of timestamp generation.
3895 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3898 * For example, this corresponds to presence of H.264 buffering period
3904 * Offset of the current timestamp against last timestamp sync point in
3905 * units of AVCodecContext.time_base.
3907 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3908 * contain a valid timestamp offset.
3910 * Note that the timestamp of sync point has usually a nonzero
3911 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3912 * the next frame after timestamp sync point will be usually 1.
3914 * For example, this corresponds to H.264 cpb_removal_delay.
3916 int dts_ref_dts_delta;
3919 * Presentation delay of current frame in units of AVCodecContext.time_base.
3921 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3922 * contain valid non-negative timestamp delta (presentation time of a frame
3923 * must not lie in the past).
3925 * This delay represents the difference between decoding and presentation
3926 * time of the frame.
3928 * For example, this corresponds to H.264 dpb_output_delay.
3933 * Position of the packet in file.
3935 * Analogous to cur_frame_pts/dts
3937 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3940 * Byte position of currently parsed frame in stream.
3945 * Previous frame byte position.
3950 * Duration of the current frame.
3951 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3952 * For all other types, this is in units of AVCodecContext.time_base.
3956 enum AVFieldOrder field_order;
3959 * Indicate whether a picture is coded as a frame, top field or bottom field.
3961 * For example, H.264 field_pic_flag equal to 0 corresponds to
3962 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3963 * equal to 1 and bottom_field_flag equal to 0 corresponds to
3964 * AV_PICTURE_STRUCTURE_TOP_FIELD.
3966 enum AVPictureStructure picture_structure;
3969 * Picture number incremented in presentation or output order.
3970 * This field may be reinitialized at the first picture of a new sequence.
3972 * For example, this corresponds to H.264 PicOrderCnt.
3974 int output_picture_number;
3977 * Dimensions of the decoded video intended for presentation.
3983 * Dimensions of the coded video.
3989 * The format of the coded data, corresponds to enum AVPixelFormat for video
3990 * and for enum AVSampleFormat for audio.
3992 * Note that a decoder can have considerable freedom in how exactly it
3993 * decodes the data, so the format reported here might be different from the
3994 * one returned by a decoder.
3997 } AVCodecParserContext;
3999 typedef struct AVCodecParser {
4000 int codec_ids[5]; /* several codec IDs are permitted */
4002 int (*parser_init)(AVCodecParserContext *s);
4003 /* This callback never returns an error, a negative value means that
4004 * the frame start was in a previous packet. */
4005 int (*parser_parse)(AVCodecParserContext *s,
4006 AVCodecContext *avctx,
4007 const uint8_t **poutbuf, int *poutbuf_size,
4008 const uint8_t *buf, int buf_size);
4009 void (*parser_close)(AVCodecParserContext *s);
4010 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4011 struct AVCodecParser *next;
4014 AVCodecParser *av_parser_next(const AVCodecParser *c);
4016 void av_register_codec_parser(AVCodecParser *parser);
4017 AVCodecParserContext *av_parser_init(int codec_id);
4022 * @param s parser context.
4023 * @param avctx codec context.
4024 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4025 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4026 * @param buf input buffer.
4027 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4028 * @param pts input presentation timestamp.
4029 * @param dts input decoding timestamp.
4030 * @param pos input byte position in stream.
4031 * @return the number of bytes of the input bitstream used.
4036 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4043 * decode_frame(data, size);
4047 int av_parser_parse2(AVCodecParserContext *s,
4048 AVCodecContext *avctx,
4049 uint8_t **poutbuf, int *poutbuf_size,
4050 const uint8_t *buf, int buf_size,
4051 int64_t pts, int64_t dts,
4055 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4056 * @deprecated use AVBitstreamFilter
4058 int av_parser_change(AVCodecParserContext *s,
4059 AVCodecContext *avctx,
4060 uint8_t **poutbuf, int *poutbuf_size,
4061 const uint8_t *buf, int buf_size, int keyframe);
4062 void av_parser_close(AVCodecParserContext *s);
4070 * @addtogroup lavc_encoding
4075 * Find a registered encoder with a matching codec ID.
4077 * @param id AVCodecID of the requested encoder
4078 * @return An encoder if one was found, NULL otherwise.
4080 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4083 * Find a registered encoder with the specified name.
4085 * @param name name of the requested encoder
4086 * @return An encoder if one was found, NULL otherwise.
4088 AVCodec *avcodec_find_encoder_by_name(const char *name);
4091 * Encode a frame of audio.
4093 * Takes input samples from frame and writes the next output packet, if
4094 * available, to avpkt. The output packet does not necessarily contain data for
4095 * the most recent frame, as encoders can delay, split, and combine input frames
4096 * internally as needed.
4098 * @param avctx codec context
4099 * @param avpkt output AVPacket.
4100 * The user can supply an output buffer by setting
4101 * avpkt->data and avpkt->size prior to calling the
4102 * function, but if the size of the user-provided data is not
4103 * large enough, encoding will fail. All other AVPacket fields
4104 * will be reset by the encoder using av_init_packet(). If
4105 * avpkt->data is NULL, the encoder will allocate it.
4106 * The encoder will set avpkt->size to the size of the
4109 * If this function fails or produces no output, avpkt will be
4110 * freed using av_free_packet() (i.e. avpkt->destruct will be
4111 * called to free the user supplied buffer).
4112 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4113 * May be NULL when flushing an encoder that has the
4114 * AV_CODEC_CAP_DELAY capability set.
4115 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4116 * can have any number of samples.
4117 * If it is not set, frame->nb_samples must be equal to
4118 * avctx->frame_size for all frames except the last.
4119 * The final frame may be smaller than avctx->frame_size.
4120 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4121 * output packet is non-empty, and to 0 if it is
4122 * empty. If the function returns an error, the
4123 * packet can be assumed to be invalid, and the
4124 * value of got_packet_ptr is undefined and should
4126 * @return 0 on success, negative error code on failure
4128 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4129 const AVFrame *frame, int *got_packet_ptr);
4132 * Encode a frame of video.
4134 * Takes input raw video data from frame and writes the next output packet, if
4135 * available, to avpkt. The output packet does not necessarily contain data for
4136 * the most recent frame, as encoders can delay and reorder input frames
4137 * internally as needed.
4139 * @param avctx codec context
4140 * @param avpkt output AVPacket.
4141 * The user can supply an output buffer by setting
4142 * avpkt->data and avpkt->size prior to calling the
4143 * function, but if the size of the user-provided data is not
4144 * large enough, encoding will fail. All other AVPacket fields
4145 * will be reset by the encoder using av_init_packet(). If
4146 * avpkt->data is NULL, the encoder will allocate it.
4147 * The encoder will set avpkt->size to the size of the
4148 * output packet. The returned data (if any) belongs to the
4149 * caller, he is responsible for freeing it.
4151 * If this function fails or produces no output, avpkt will be
4152 * freed using av_free_packet() (i.e. avpkt->destruct will be
4153 * called to free the user supplied buffer).
4154 * @param[in] frame AVFrame containing the raw video data to be encoded.
4155 * May be NULL when flushing an encoder that has the
4156 * AV_CODEC_CAP_DELAY capability set.
4157 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4158 * output packet is non-empty, and to 0 if it is
4159 * empty. If the function returns an error, the
4160 * packet can be assumed to be invalid, and the
4161 * value of got_packet_ptr is undefined and should
4163 * @return 0 on success, negative error code on failure
4165 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4166 const AVFrame *frame, int *got_packet_ptr);
4168 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4169 const AVSubtitle *sub);
4177 * @addtogroup lavc_picture
4182 * Allocate memory for a picture. Call avpicture_free() to free it.
4184 * @see avpicture_fill()
4186 * @param picture the picture to be filled in
4187 * @param pix_fmt the format of the picture
4188 * @param width the width of the picture
4189 * @param height the height of the picture
4190 * @return zero if successful, a negative value if not
4192 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4195 * Free a picture previously allocated by avpicture_alloc().
4196 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4199 * @param picture the AVPicture to be freed
4201 void avpicture_free(AVPicture *picture);
4204 * Fill in the AVPicture fields, always assume a linesize alignment of 1.
4206 * @see av_image_fill_arrays().
4208 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4209 enum AVPixelFormat pix_fmt, int width, int height);
4212 * Copy pixel data from an AVPicture into a buffer, always assume a
4213 * linesize alignment of 1.
4215 * @see av_image_copy_to_buffer().
4217 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4218 int width, int height,
4219 unsigned char *dest, int dest_size);
4222 * Calculate the size in bytes that a picture of the given width and height
4223 * would occupy if stored in the given picture format.
4224 * Always assume a linesize alignment of 1.
4226 * @see av_image_get_buffer_size().
4228 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4231 * Copy image src to dst. Wraps av_picture_data_copy() above.
4233 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4234 enum AVPixelFormat pix_fmt, int width, int height);
4237 * Crop image top and left side.
4239 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4240 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4245 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4246 int padtop, int padbottom, int padleft, int padright, int *color);
4253 * @defgroup lavc_misc Utility functions
4256 * Miscellaneous utility functions related to both encoding and decoding
4262 * @defgroup lavc_misc_pixfmt Pixel formats
4264 * Functions for working with pixel formats.
4269 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4272 void attribute_deprecated avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4275 * Return a value representing the fourCC code associated to the
4276 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4279 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4281 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4282 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4283 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4284 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4285 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4286 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4289 * Compute what kind of losses will occur when converting from one specific
4290 * pixel format to another.
4291 * When converting from one pixel format to another, information loss may occur.
4292 * For example, when converting from RGB24 to GRAY, the color information will
4293 * be lost. Similarly, other losses occur when converting from some formats to
4294 * other formats. These losses can involve loss of chroma, but also loss of
4295 * resolution, loss of color depth, loss due to the color space conversion, loss
4296 * of the alpha bits or loss due to color quantization.
4297 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4298 * which will occur when converting from one pixel format to another.
4300 * @param[in] dst_pix_fmt destination pixel format
4301 * @param[in] src_pix_fmt source pixel format
4302 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4303 * @return Combination of flags informing you what kind of losses will occur.
4305 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4309 * Find the best pixel format to convert to given a certain source pixel
4310 * format. When converting from one pixel format to another, information loss
4311 * may occur. For example, when converting from RGB24 to GRAY, the color
4312 * information will be lost. Similarly, other losses occur when converting from
4313 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4314 * the given pixel formats should be used to suffer the least amount of loss.
4315 * The pixel formats from which it chooses one, are determined by the
4316 * pix_fmt_list parameter.
4319 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4320 * @param[in] src_pix_fmt source pixel format
4321 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4322 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4323 * @return The best pixel format to convert to or -1 if none was found.
4325 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4326 enum AVPixelFormat src_pix_fmt,
4327 int has_alpha, int *loss_ptr);
4329 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4335 #if FF_API_SET_DIMENSIONS
4337 * @deprecated this function is not supposed to be used from outside of lavc
4339 attribute_deprecated
4340 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4344 * Put a string representing the codec tag codec_tag in buf.
4346 * @param buf buffer to place codec tag in
4347 * @param buf_size size in bytes of buf
4348 * @param codec_tag codec tag to assign
4349 * @return the length of the string that would have been generated if
4350 * enough space had been available, excluding the trailing null
4352 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4354 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4357 * Return a name for the specified profile, if available.
4359 * @param codec the codec that is searched for the given profile
4360 * @param profile the profile value for which a name is requested
4361 * @return A name for the profile if found, NULL otherwise.
4363 const char *av_get_profile_name(const AVCodec *codec, int profile);
4365 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4366 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4367 //FIXME func typedef
4370 * Fill audio frame data and linesize.
4371 * AVFrame extended_data channel pointers are allocated if necessary for
4374 * @param frame the AVFrame
4375 * frame->nb_samples must be set prior to calling the
4376 * function. This function fills in frame->data,
4377 * frame->extended_data, frame->linesize[0].
4378 * @param nb_channels channel count
4379 * @param sample_fmt sample format
4380 * @param buf buffer to use for frame data
4381 * @param buf_size size of buffer
4382 * @param align plane size sample alignment (0 = default)
4383 * @return 0 on success, negative error code on failure
4385 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4386 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4387 int buf_size, int align);
4390 * Reset the internal decoder state / flush internal buffers. Should be called
4391 * e.g. when seeking or when switching to a different stream.
4393 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4394 * this invalidates the frames previously returned from the decoder. When
4395 * refcounted frames are used, the decoder just releases any references it might
4396 * keep internally, but the caller's reference remains valid.
4398 void avcodec_flush_buffers(AVCodecContext *avctx);
4401 * Return codec bits per sample.
4403 * @param[in] codec_id the codec
4404 * @return Number of bits per sample or zero if unknown for the given codec.
4406 int av_get_bits_per_sample(enum AVCodecID codec_id);
4409 * Return codec bits per sample.
4410 * Only return non-zero if the bits per sample is exactly correct, not an
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_exact_bits_per_sample(enum AVCodecID codec_id);
4419 * Return audio frame duration.
4421 * @param avctx codec context
4422 * @param frame_bytes size of the frame, or 0 if unknown
4423 * @return frame duration, in samples, if known. 0 if not able to
4426 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4429 typedef struct AVBitStreamFilterContext {
4431 struct AVBitStreamFilter *filter;
4432 AVCodecParserContext *parser;
4433 struct AVBitStreamFilterContext *next;
4434 } AVBitStreamFilterContext;
4437 typedef struct AVBitStreamFilter {
4440 int (*filter)(AVBitStreamFilterContext *bsfc,
4441 AVCodecContext *avctx, const char *args,
4442 uint8_t **poutbuf, int *poutbuf_size,
4443 const uint8_t *buf, int buf_size, int keyframe);
4444 void (*close)(AVBitStreamFilterContext *bsfc);
4445 struct AVBitStreamFilter *next;
4446 } AVBitStreamFilter;
4448 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4449 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4450 int av_bitstream_filter_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 av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4456 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
4461 * Allocate a buffer with padding, reusing the given one if large enough.
4463 * Same behaviour av_fast_malloc but the buffer has additional
4464 * AV_INPUT_PADDING_SIZE at the end which will always memset to 0.
4467 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4470 * Encode extradata length to a buffer. Used by xiph codecs.
4472 * @param s buffer to write to; must be at least (v/255+1) bytes long
4473 * @param v size of extradata in bytes
4474 * @return number of bytes written to the buffer.
4476 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4478 #if FF_API_MISSING_SAMPLE
4480 * Log a generic warning message about a missing feature. This function is
4481 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4482 * only, and would normally not be used by applications.
4483 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4484 * a pointer to an AVClass struct
4485 * @param[in] feature string containing the name of the missing feature
4486 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4487 * If want_sample is non-zero, additional verbage will be added to the log
4488 * message which tells the user how to report samples to the development
4490 * @deprecated Use avpriv_report_missing_feature() instead.
4492 attribute_deprecated
4493 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4496 * Log a generic warning message asking for a sample. This function is
4497 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4498 * only, and would normally not be used by applications.
4499 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4500 * a pointer to an AVClass struct
4501 * @param[in] msg string containing an optional message, or NULL if no message
4502 * @deprecated Use avpriv_request_sample() instead.
4504 attribute_deprecated
4505 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4506 #endif /* FF_API_MISSING_SAMPLE */
4509 * Register the hardware accelerator hwaccel.
4511 void av_register_hwaccel(AVHWAccel *hwaccel);
4514 * If hwaccel is NULL, returns the first registered hardware accelerator,
4515 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4516 * after hwaccel, or NULL if hwaccel is the last one.
4518 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
4522 * Lock operation used by lockmgr
4525 AV_LOCK_CREATE, ///< Create a mutex
4526 AV_LOCK_OBTAIN, ///< Lock the mutex
4527 AV_LOCK_RELEASE, ///< Unlock the mutex
4528 AV_LOCK_DESTROY, ///< Free mutex resources
4532 * Register a user provided lock manager supporting the operations
4533 * specified by AVLockOp. The "mutex" argument to the function points
4534 * to a (void *) where the lockmgr should store/get a pointer to a user
4535 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
4536 * value left by the last call for all other ops. If the lock manager is
4537 * unable to perform the op then it should leave the mutex in the same
4538 * state as when it was called and return a non-zero value. However,
4539 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
4540 * have been successfully destroyed. If av_lockmgr_register succeeds
4541 * it will return a non-negative value, if it fails it will return a
4542 * negative value and destroy all mutex and unregister all callbacks.
4543 * av_lockmgr_register is not thread-safe, it must be called from a
4544 * single thread before any calls which make use of locking are used.
4546 * @param cb User defined callback. av_lockmgr_register invokes calls
4547 * to this callback and the previously registered callback.
4548 * The callback will be used to create more than one mutex
4549 * each of which must be backed by its own underlying locking
4550 * mechanism (i.e. do not use a single static object to
4551 * implement your lock manager). If cb is set to NULL the
4552 * lockmgr will be unregistered.
4554 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4557 * Get the type of the given codec.
4559 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4562 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4563 * with no corresponding avcodec_close()), 0 otherwise.
4565 int avcodec_is_open(AVCodecContext *s);
4568 * @return a non-zero number if codec is an encoder, zero otherwise
4570 int av_codec_is_encoder(const AVCodec *codec);
4573 * @return a non-zero number if codec is a decoder, zero otherwise
4575 int av_codec_is_decoder(const AVCodec *codec);
4578 * @return descriptor for given codec ID or NULL if no descriptor exists.
4580 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4583 * Iterate over all codec descriptors known to libavcodec.
4585 * @param prev previous descriptor. NULL to get the first descriptor.
4587 * @return next descriptor or NULL after the last descriptor
4589 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4592 * @return codec descriptor with the given name or NULL if no such descriptor
4595 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4601 #endif /* AVCODEC_AVCODEC_H */