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,
303 /* various PCM "codecs" */
304 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
305 AV_CODEC_ID_PCM_S16LE = 0x10000,
306 AV_CODEC_ID_PCM_S16BE,
307 AV_CODEC_ID_PCM_U16LE,
308 AV_CODEC_ID_PCM_U16BE,
311 AV_CODEC_ID_PCM_MULAW,
312 AV_CODEC_ID_PCM_ALAW,
313 AV_CODEC_ID_PCM_S32LE,
314 AV_CODEC_ID_PCM_S32BE,
315 AV_CODEC_ID_PCM_U32LE,
316 AV_CODEC_ID_PCM_U32BE,
317 AV_CODEC_ID_PCM_S24LE,
318 AV_CODEC_ID_PCM_S24BE,
319 AV_CODEC_ID_PCM_U24LE,
320 AV_CODEC_ID_PCM_U24BE,
321 AV_CODEC_ID_PCM_S24DAUD,
322 AV_CODEC_ID_PCM_ZORK,
323 AV_CODEC_ID_PCM_S16LE_PLANAR,
325 AV_CODEC_ID_PCM_F32BE,
326 AV_CODEC_ID_PCM_F32LE,
327 AV_CODEC_ID_PCM_F64BE,
328 AV_CODEC_ID_PCM_F64LE,
329 AV_CODEC_ID_PCM_BLURAY,
332 AV_CODEC_ID_PCM_S8_PLANAR,
333 AV_CODEC_ID_PCM_S24LE_PLANAR,
334 AV_CODEC_ID_PCM_S32LE_PLANAR,
335 AV_CODEC_ID_PCM_S16BE_PLANAR,
337 /* various ADPCM codecs */
338 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
339 AV_CODEC_ID_ADPCM_IMA_WAV,
340 AV_CODEC_ID_ADPCM_IMA_DK3,
341 AV_CODEC_ID_ADPCM_IMA_DK4,
342 AV_CODEC_ID_ADPCM_IMA_WS,
343 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
344 AV_CODEC_ID_ADPCM_MS,
345 AV_CODEC_ID_ADPCM_4XM,
346 AV_CODEC_ID_ADPCM_XA,
347 AV_CODEC_ID_ADPCM_ADX,
348 AV_CODEC_ID_ADPCM_EA,
349 AV_CODEC_ID_ADPCM_G726,
350 AV_CODEC_ID_ADPCM_CT,
351 AV_CODEC_ID_ADPCM_SWF,
352 AV_CODEC_ID_ADPCM_YAMAHA,
353 AV_CODEC_ID_ADPCM_SBPRO_4,
354 AV_CODEC_ID_ADPCM_SBPRO_3,
355 AV_CODEC_ID_ADPCM_SBPRO_2,
356 AV_CODEC_ID_ADPCM_THP,
357 AV_CODEC_ID_ADPCM_IMA_AMV,
358 AV_CODEC_ID_ADPCM_EA_R1,
359 AV_CODEC_ID_ADPCM_EA_R3,
360 AV_CODEC_ID_ADPCM_EA_R2,
361 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
362 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
363 AV_CODEC_ID_ADPCM_EA_XAS,
364 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
365 AV_CODEC_ID_ADPCM_IMA_ISS,
366 AV_CODEC_ID_ADPCM_G722,
367 AV_CODEC_ID_ADPCM_IMA_APC,
368 AV_CODEC_ID_ADPCM_VIMA,
371 AV_CODEC_ID_AMR_NB = 0x12000,
374 /* RealAudio codecs*/
375 AV_CODEC_ID_RA_144 = 0x13000,
378 /* various DPCM codecs */
379 AV_CODEC_ID_ROQ_DPCM = 0x14000,
380 AV_CODEC_ID_INTERPLAY_DPCM,
381 AV_CODEC_ID_XAN_DPCM,
382 AV_CODEC_ID_SOL_DPCM,
385 AV_CODEC_ID_MP2 = 0x15000,
386 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
396 AV_CODEC_ID_VMDAUDIO,
402 AV_CODEC_ID_WESTWOOD_SND1,
403 AV_CODEC_ID_GSM, ///< as in Berlin toast format
406 AV_CODEC_ID_TRUESPEECH,
408 AV_CODEC_ID_SMACKAUDIO,
411 AV_CODEC_ID_DSICINAUDIO,
413 AV_CODEC_ID_MUSEPACK7,
415 AV_CODEC_ID_GSM_MS, /* as found in WAV */
421 AV_CODEC_ID_NELLYMOSER,
422 AV_CODEC_ID_MUSEPACK8,
424 AV_CODEC_ID_WMAVOICE,
426 AV_CODEC_ID_WMALOSSLESS,
435 AV_CODEC_ID_BINKAUDIO_RDFT,
436 AV_CODEC_ID_BINKAUDIO_DCT,
437 AV_CODEC_ID_AAC_LATM,
442 AV_CODEC_ID_8SVX_EXP,
443 AV_CODEC_ID_8SVX_FIB,
444 AV_CODEC_ID_BMV_AUDIO,
449 AV_CODEC_ID_COMFORT_NOISE,
451 AV_CODEC_ID_METASOUND,
452 AV_CODEC_ID_PAF_AUDIO,
456 /* subtitle codecs */
457 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
458 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
459 AV_CODEC_ID_DVB_SUBTITLE,
460 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
463 AV_CODEC_ID_MOV_TEXT,
464 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
465 AV_CODEC_ID_DVB_TELETEXT,
468 /* other specific kind of codecs (generally used for attachments) */
469 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
470 AV_CODEC_ID_TTF = 0x18000,
472 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
474 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
475 * stream (only used by libavformat) */
476 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
477 * stream (only used by libavformat) */
478 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
482 * This struct describes the properties of a single codec described by an
484 * @see avcodec_descriptor_get()
486 typedef struct AVCodecDescriptor {
488 enum AVMediaType type;
490 * Name of the codec described by this descriptor. It is non-empty and
491 * unique for each codec descriptor. It should contain alphanumeric
492 * characters and '_' only.
496 * A more descriptive name for this codec. May be NULL.
498 const char *long_name;
500 * Codec properties, a combination of AV_CODEC_PROP_* flags.
506 * Codec uses only intra compression.
509 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
511 * Codec supports lossy compression. Audio and video codecs only.
512 * @note a codec may support both lossy and lossless
515 #define AV_CODEC_PROP_LOSSY (1 << 1)
517 * Codec supports lossless compression. Audio and video codecs only.
519 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
521 * Codec supports frame reordering. That is, the coded order (the order in which
522 * the encoded packets are output by the encoders / stored / input to the
523 * decoders) may be different from the presentation order of the corresponding
526 * For codecs that do not have this property set, PTS and DTS should always be
529 #define AV_CODEC_PROP_REORDER (1 << 3)
532 * @ingroup lavc_decoding
533 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
534 * This is mainly needed because some optimized bitstream readers read
535 * 32 or 64 bit at once and could read over the end.<br>
536 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
537 * MPEG bitstreams could cause overread and segfault.
539 #define AV_INPUT_BUFFER_PADDING_SIZE 8
542 * @ingroup lavc_encoding
543 * minimum encoding buffer size
544 * Used to avoid some checks during header writing.
546 #define AV_INPUT_BUFFER_MIN_SIZE 16384
548 #if FF_API_WITHOUT_PREFIX
550 * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
552 #define FF_INPUT_BUFFER_PADDING_SIZE 8
555 * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
557 #define FF_MIN_BUFFER_SIZE 16384
558 #endif /* FF_API_WITHOUT_PREFIX */
561 * @ingroup lavc_encoding
562 * motion estimation type.
563 * @deprecated use codec private option instead
565 #if FF_API_MOTION_EST
567 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
571 ME_EPZS, ///< enhanced predictive zonal search
572 ME_X1, ///< reserved for experiments
573 ME_HEX, ///< hexagon based search
574 ME_UMH, ///< uneven multi-hexagon search
575 ME_TESA, ///< transformed exhaustive search algorithm
580 * @ingroup lavc_decoding
583 /* We leave some space between them for extensions (drop some
584 * keyframes for intra-only or drop just some bidir frames). */
585 AVDISCARD_NONE =-16, ///< discard nothing
586 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
587 AVDISCARD_NONREF = 8, ///< discard all non reference
588 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
589 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
590 AVDISCARD_ALL = 48, ///< discard all
593 enum AVAudioServiceType {
594 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
595 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
596 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
597 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
598 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
599 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
600 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
601 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
602 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
603 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
607 * @ingroup lavc_encoding
609 typedef struct RcOverride{
612 int qscale; // If this is 0 then quality_factor will be used instead.
613 float quality_factor;
616 #if FF_API_MAX_BFRAMES
618 * @deprecated there is no libavcodec-wide limit on the number of B-frames
620 #define FF_MAX_B_FRAMES 16
624 These flags can be passed in AVCodecContext.flags before initialization.
625 Note: Not everything is supported yet.
629 * Allow decoders to produce frames with data planes that are not aligned
630 * to CPU requirements (e.g. due to cropping).
632 #define AV_CODEC_FLAG_UNALIGNED (1 << 0)
636 #define AV_CODEC_FLAG_QSCALE (1 << 1)
638 * 4 MV per MB allowed / advanced prediction for H.263.
640 #define AV_CODEC_FLAG_4MV (1 << 2)
642 * Output even those frames that might be corrupted.
644 #define AV_CODEC_FLAG_OUTPUT_CORRUPT (1 << 3)
648 #define AV_CODEC_FLAG_QPEL (1 << 4)
650 * Use internal 2pass ratecontrol in first pass mode.
652 #define AV_CODEC_FLAG_PASS1 (1 << 9)
654 * Use internal 2pass ratecontrol in second pass mode.
656 #define AV_CODEC_FLAG_PASS2 (1 << 10)
660 #define AV_CODEC_FLAG_LOOP_FILTER (1 << 11)
662 * Only decode/encode grayscale.
664 #define AV_CODEC_FLAG_GRAY (1 << 13)
666 * error[?] variables will be set during encoding.
668 #define AV_CODEC_FLAG_PSNR (1 << 15)
670 * Input bitstream might be truncated at a random location
671 * instead of only at frame boundaries.
673 #define AV_CODEC_FLAG_TRUNCATED (1 << 16)
675 * Use interlaced DCT.
677 #define AV_CODEC_FLAG_INTERLACED_DCT (1 << 18)
681 #define AV_CODEC_FLAG_LOW_DELAY (1 << 19)
683 * Place global headers in extradata instead of every keyframe.
685 #define AV_CODEC_FLAG_GLOBAL_HEADER (1 << 22)
687 * Use only bitexact stuff (except (I)DCT).
689 #define AV_CODEC_FLAG_BITEXACT (1 << 23)
690 /* Fx : Flag for h263+ extra options */
692 * H.263 advanced intra coding / MPEG-4 AC prediction
694 #define AV_CODEC_FLAG_AC_PRED (1 << 24)
696 * interlaced motion estimation
698 #define AV_CODEC_FLAG_INTERLACED_ME (1 << 29)
700 * Allow non spec compliant speedup tricks.
702 #define AV_CODEC_FLAG_CLOSED_GOP (1 << 31)
704 #define AV_CODEC_FLAG2_FAST (1 << 0)
706 * Skip bitstream encoding.
708 #define AV_CODEC_FLAG2_NO_OUTPUT (1 << 2)
710 * Place global headers at every keyframe instead of in extradata.
712 #define AV_CODEC_FLAG2_LOCAL_HEADER (1 << 3)
714 * Input bitstream might be truncated at a packet boundaries
715 * instead of only at frame boundaries.
717 #define AV_CODEC_FLAG2_CHUNKS (1 << 15)
719 * Discard cropping information from SPS.
721 #define AV_CODEC_FLAG2_IGNORE_CROP (1 << 16)
723 /* Unsupported options :
724 * Syntax Arithmetic coding (SAC)
725 * Reference Picture Selection
726 * Independent Segment Decoding */
728 /* codec capabilities */
731 * Decoder can use draw_horiz_band callback.
733 #define AV_CODEC_CAP_DRAW_HORIZ_BAND (1 << 0)
735 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
736 * If not set, it might not use get_buffer() at all or use operations that
737 * assume the buffer was allocated by avcodec_default_get_buffer.
739 #define AV_CODEC_CAP_DR1 (1 << 1)
740 #define AV_CODEC_CAP_TRUNCATED (1 << 3)
742 * Encoder or decoder requires flushing with NULL input at the end in order to
743 * give the complete and correct output.
745 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
746 * with NULL data. The user can still send NULL data to the public encode
747 * or decode function, but libavcodec will not pass it along to the codec
748 * unless this flag is set.
751 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
752 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
756 * The encoder needs to be fed with NULL data at the end of encoding until the
757 * encoder no longer returns data.
759 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
760 * flag also means that the encoder must set the pts and duration for
761 * each output packet. If this flag is not set, the pts and duration will
762 * be determined by libavcodec from the input frame.
764 #define AV_CODEC_CAP_DELAY (1 << 5)
766 * Codec can be fed a final frame with a smaller size.
767 * This can be used to prevent truncation of the last audio samples.
769 #define AV_CODEC_CAP_SMALL_LAST_FRAME (1 << 6)
771 * Codec can output multiple frames per AVPacket
772 * Normally demuxers return one frame at a time, demuxers which do not do
773 * are connected to a parser to split what they return into proper frames.
774 * This flag is reserved to the very rare category of codecs which have a
775 * bitstream that cannot be split into frames without timeconsuming
776 * operations like full decoding. Demuxers carring such bitstreams thus
777 * may return multiple frames in a packet. This has many disadvantages like
778 * prohibiting stream copy in many cases thus it should only be considered
781 #define AV_CODEC_CAP_SUBFRAMES (1 << 8)
783 * Codec is experimental and is thus avoided in favor of non experimental
786 #define AV_CODEC_CAP_EXPERIMENTAL (1 << 9)
788 * Codec should fill in channel configuration and samplerate instead of container
790 #define AV_CODEC_CAP_CHANNEL_CONF (1 << 10)
792 * Codec supports frame-level multithreading.
794 #define AV_CODEC_CAP_FRAME_THREADS (1 << 12)
796 * Codec supports slice-based (or partition-based) multithreading.
798 #define AV_CODEC_CAP_SLICE_THREADS (1 << 13)
800 * Codec supports changed parameters at any point.
802 #define AV_CODEC_CAP_PARAM_CHANGE (1 << 14)
804 * Codec supports avctx->thread_count == 0 (auto).
806 #define AV_CODEC_CAP_AUTO_THREADS (1 << 15)
808 * Audio encoder supports receiving a different number of samples in each call.
810 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
812 #if FF_API_WITHOUT_PREFIX
814 * Allow decoders to produce frames with data planes that are not aligned
815 * to CPU requirements (e.g. due to cropping).
817 #define CODEC_FLAG_UNALIGNED 0x0001
818 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
819 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
820 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
821 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
824 * @deprecated use the "gmc" private option of the libxvid encoder
826 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
830 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
833 #define CODEC_FLAG_MV0 0x0040
835 #if FF_API_INPUT_PRESERVED
837 * @deprecated passing reference-counted frames to the encoders replaces this
840 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
842 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
843 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
844 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
847 * @deprecated edges are not used/required anymore. I.e. this flag is now always
850 #define CODEC_FLAG_EMU_EDGE 0x4000
852 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
853 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
854 location instead of only at frame boundaries. */
855 #if FF_API_NORMALIZE_AQP
857 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
860 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
862 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
863 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
864 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
865 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
866 /* Fx : Flag for h263+ extra options */
867 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
868 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
869 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
870 #define CODEC_FLAG_CLOSED_GOP 0x80000000
871 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
872 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
873 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
874 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
876 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
878 /* Unsupported options :
879 * Syntax Arithmetic coding (SAC)
880 * Reference Picture Selection
881 * Independent Segment Decoding */
883 /* codec capabilities */
885 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
887 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
888 * If not set, it might not use get_buffer() at all or use operations that
889 * assume the buffer was allocated by avcodec_default_get_buffer.
891 #define CODEC_CAP_DR1 0x0002
892 #define CODEC_CAP_TRUNCATED 0x0008
894 /* Codec can export data for HW decoding (XvMC). */
895 #define CODEC_CAP_HWACCEL 0x0010
896 #endif /* FF_API_XVMC */
898 * Encoder or decoder requires flushing with NULL input at the end in order to
899 * give the complete and correct output.
901 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
902 * with NULL data. The user can still send NULL data to the public encode
903 * or decode function, but libavcodec will not pass it along to the codec
904 * unless this flag is set.
907 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
908 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
912 * The encoder needs to be fed with NULL data at the end of encoding until the
913 * encoder no longer returns data.
915 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
916 * flag also means that the encoder must set the pts and duration for
917 * each output packet. If this flag is not set, the pts and duration will
918 * be determined by libavcodec from the input frame.
920 #define CODEC_CAP_DELAY 0x0020
922 * Codec can be fed a final frame with a smaller size.
923 * This can be used to prevent truncation of the last audio samples.
925 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
928 * Codec can export data for HW decoding (VDPAU).
930 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
933 * Codec can output multiple frames per AVPacket
934 * Normally demuxers return one frame at a time, demuxers which do not do
935 * are connected to a parser to split what they return into proper frames.
936 * This flag is reserved to the very rare category of codecs which have a
937 * bitstream that cannot be split into frames without timeconsuming
938 * operations like full decoding. Demuxers carring such bitstreams thus
939 * may return multiple frames in a packet. This has many disadvantages like
940 * prohibiting stream copy in many cases thus it should only be considered
943 #define CODEC_CAP_SUBFRAMES 0x0100
945 * Codec is experimental and is thus avoided in favor of non experimental
948 #define CODEC_CAP_EXPERIMENTAL 0x0200
950 * Codec should fill in channel configuration and samplerate instead of container
952 #define CODEC_CAP_CHANNEL_CONF 0x0400
953 #if FF_API_NEG_LINESIZES
955 * @deprecated no codecs use this capability
957 #define CODEC_CAP_NEG_LINESIZES 0x0800
960 * Codec supports frame-level multithreading.
962 #define CODEC_CAP_FRAME_THREADS 0x1000
964 * Codec supports slice-based (or partition-based) multithreading.
966 #define CODEC_CAP_SLICE_THREADS 0x2000
968 * Codec supports changed parameters at any point.
970 #define CODEC_CAP_PARAM_CHANGE 0x4000
972 * Codec supports avctx->thread_count == 0 (auto).
974 #define CODEC_CAP_AUTO_THREADS 0x8000
976 * Audio encoder supports receiving a different number of samples in each call.
978 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
979 #endif /* FF_API_WITHOUT_PREFIX */
982 //The following defines may change, don't expect compatibility if you use them.
983 #define MB_TYPE_INTRA4x4 0x0001
984 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
985 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
986 #define MB_TYPE_16x16 0x0008
987 #define MB_TYPE_16x8 0x0010
988 #define MB_TYPE_8x16 0x0020
989 #define MB_TYPE_8x8 0x0040
990 #define MB_TYPE_INTERLACED 0x0080
991 #define MB_TYPE_DIRECT2 0x0100 //FIXME
992 #define MB_TYPE_ACPRED 0x0200
993 #define MB_TYPE_GMC 0x0400
994 #define MB_TYPE_SKIP 0x0800
995 #define MB_TYPE_P0L0 0x1000
996 #define MB_TYPE_P1L0 0x2000
997 #define MB_TYPE_P0L1 0x4000
998 #define MB_TYPE_P1L1 0x8000
999 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1000 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1001 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
1002 #define MB_TYPE_QUANT 0x00010000
1003 #define MB_TYPE_CBP 0x00020000
1004 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
1009 * This specifies the area which should be displayed.
1010 * Note there may be multiple such areas for one frame.
1012 typedef struct AVPanScan{
1015 * - encoding: Set by user.
1016 * - decoding: Set by libavcodec.
1021 * width and height in 1/16 pel
1022 * - encoding: Set by user.
1023 * - decoding: Set by libavcodec.
1029 * position of the top left corner in 1/16 pel for up to 3 fields/frames
1030 * - encoding: Set by user.
1031 * - decoding: Set by libavcodec.
1033 int16_t position[3][2];
1036 #if FF_API_QSCALE_TYPE
1037 #define FF_QSCALE_TYPE_MPEG1 0
1038 #define FF_QSCALE_TYPE_MPEG2 1
1039 #define FF_QSCALE_TYPE_H264 2
1040 #define FF_QSCALE_TYPE_VP56 3
1044 * The decoder will keep a reference to the frame and may reuse it later.
1046 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1049 * @defgroup lavc_packet AVPacket
1051 * Types and functions for working with AVPacket.
1054 enum AVPacketSideDataType {
1055 AV_PKT_DATA_PALETTE,
1056 AV_PKT_DATA_NEW_EXTRADATA,
1059 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1062 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1063 * s32le channel_count
1064 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1065 * u64le channel_layout
1066 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1068 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1073 AV_PKT_DATA_PARAM_CHANGE,
1076 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1077 * structures with info about macroblocks relevant to splitting the
1078 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1079 * That is, it does not necessarily contain info about all macroblocks,
1080 * as long as the distance between macroblocks in the info is smaller
1081 * than the target payload size.
1082 * Each MB info structure is 12 bytes, and is laid out as follows:
1084 * u32le bit offset from the start of the packet
1085 * u8 current quantizer at the start of the macroblock
1087 * u16le macroblock address within the GOB
1088 * u8 horizontal MV predictor
1089 * u8 vertical MV predictor
1090 * u8 horizontal MV predictor for block number 3
1091 * u8 vertical MV predictor for block number 3
1094 AV_PKT_DATA_H263_MB_INFO,
1097 * This side data should be associated with an audio stream and contains
1098 * ReplayGain information in form of the AVReplayGain struct.
1100 AV_PKT_DATA_REPLAYGAIN,
1103 * This side data contains a 3x3 transformation matrix describing an affine
1104 * transformation that needs to be applied to the decoded video frames for
1105 * correct presentation.
1107 * See libavutil/display.h for a detailed description of the data.
1109 AV_PKT_DATA_DISPLAYMATRIX,
1112 * This side data should be associated with a video stream and contains
1113 * Stereoscopic 3D information in form of the AVStereo3D struct.
1115 AV_PKT_DATA_STEREO3D,
1118 * This side data should be associated with an audio stream and corresponds
1119 * to enum AVAudioServiceType.
1121 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1124 * This side data contains an integer value representing the quality
1125 * factor of the compressed frame. Allowed range is between 1 (good)
1126 * and FF_LAMBDA_MAX (bad).
1128 AV_PKT_DATA_QUALITY_FACTOR,
1131 typedef struct AVPacketSideData {
1134 enum AVPacketSideDataType type;
1138 * This structure stores compressed data. It is typically exported by demuxers
1139 * and then passed as input to decoders, or received as output from encoders and
1140 * then passed to muxers.
1142 * For video, it should typically contain one compressed frame. For audio it may
1143 * contain several compressed frames. Encoders are allowed to output empty
1144 * packets, with no compressed data, containing only side data
1145 * (e.g. to update some stream parameters at the end of encoding).
1147 * AVPacket is one of the few structs in Libav, whose size is a part of public
1148 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1149 * without libavcodec and libavformat major bump.
1151 * The semantics of data ownership depends on the buf or destruct (deprecated)
1152 * fields. If either is set, the packet data is dynamically allocated and is
1153 * valid indefinitely until av_free_packet() is called (which in turn calls
1154 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1155 * the packet data is typically backed by some static buffer somewhere and is
1156 * only valid for a limited time (e.g. until the next read call when demuxing).
1158 * The side data is always allocated with av_malloc() and is freed in
1161 typedef struct AVPacket {
1163 * A reference to the reference-counted buffer where the packet data is
1165 * May be NULL, then the packet data is not reference-counted.
1169 * Presentation timestamp in AVStream->time_base units; the time at which
1170 * the decompressed packet will be presented to the user.
1171 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1172 * pts MUST be larger or equal to dts as presentation cannot happen before
1173 * decompression, unless one wants to view hex dumps. Some formats misuse
1174 * the terms dts and pts/cts to mean something different. Such timestamps
1175 * must be converted to true pts/dts before they are stored in AVPacket.
1179 * Decompression timestamp in AVStream->time_base units; the time at which
1180 * the packet is decompressed.
1181 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1188 * A combination of AV_PKT_FLAG values
1192 * Additional packet data that can be provided by the container.
1193 * Packet can contain several types of side information.
1195 AVPacketSideData *side_data;
1196 int side_data_elems;
1199 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1200 * Equals next_pts - this_pts in presentation order.
1204 int64_t pos; ///< byte position in stream, -1 if unknown
1207 * Time difference in AVStream->time_base units from the pts of this
1208 * packet to the point at which the output from the decoder has converged
1209 * independent from the availability of previous frames. That is, the
1210 * frames are virtually identical no matter if decoding started from
1211 * the very first frame or from this keyframe.
1212 * Is AV_NOPTS_VALUE if unknown.
1213 * This field is not the display duration of the current packet.
1214 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1217 * The purpose of this field is to allow seeking in streams that have no
1218 * keyframes in the conventional sense. It corresponds to the
1219 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1220 * essential for some types of subtitle streams to ensure that all
1221 * subtitles are correctly displayed after seeking.
1223 int64_t convergence_duration;
1225 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1226 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1228 enum AVSideDataParamChangeFlags {
1229 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1230 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1231 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1232 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1238 struct AVCodecInternal;
1242 AV_FIELD_PROGRESSIVE,
1243 AV_FIELD_TT, //< Top coded_first, top displayed first
1244 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1245 AV_FIELD_TB, //< Top coded first, bottom displayed first
1246 AV_FIELD_BT, //< Bottom coded first, top displayed first
1250 * main external API structure.
1251 * New fields can be added to the end with minor version bumps.
1252 * Removal, reordering and changes to existing fields require a major
1254 * sizeof(AVCodecContext) must not be used outside libav*.
1256 typedef struct AVCodecContext {
1258 * information on struct for av_log
1259 * - set by avcodec_alloc_context3
1261 const AVClass *av_class;
1262 int log_level_offset;
1264 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1265 const struct AVCodec *codec;
1266 #if FF_API_CODEC_NAME
1268 * @deprecated this field is not used for anything in libavcodec
1270 attribute_deprecated
1271 char codec_name[32];
1273 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1276 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1277 * This is used to work around some encoder bugs.
1278 * A demuxer should set this to what is stored in the field used to identify the codec.
1279 * If there are multiple such fields in a container then the demuxer should choose the one
1280 * which maximizes the information about the used codec.
1281 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1282 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1283 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1285 * - encoding: Set by user, if not then the default based on codec_id will be used.
1286 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1288 unsigned int codec_tag;
1290 #if FF_API_STREAM_CODEC_TAG
1292 * @deprecated this field is unused
1294 attribute_deprecated
1295 unsigned int stream_codec_tag;
1301 * Private context used for internal data.
1303 * Unlike priv_data, this is not codec-specific. It is used in general
1304 * libavcodec functions.
1306 struct AVCodecInternal *internal;
1309 * Private data of the user, can be used to carry app specific stuff.
1310 * - encoding: Set by user.
1311 * - decoding: Set by user.
1316 * the average bitrate
1317 * - encoding: Set by user; unused for constant quantizer encoding.
1318 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1323 * number of bits the bitstream is allowed to diverge from the reference.
1324 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1325 * - encoding: Set by user; unused for constant quantizer encoding.
1326 * - decoding: unused
1328 int bit_rate_tolerance;
1331 * Global quality for codecs which cannot change it per frame.
1332 * This should be proportional to MPEG-1/2/4 qscale.
1333 * - encoding: Set by user.
1334 * - decoding: unused
1339 * - encoding: Set by user.
1340 * - decoding: unused
1342 int compression_level;
1343 #define FF_COMPRESSION_DEFAULT -1
1347 * - encoding: Set by user.
1348 * - decoding: Set by user.
1354 * - encoding: Set by user.
1355 * - decoding: Set by user.
1360 * some codecs need / can use extradata like Huffman tables.
1361 * mjpeg: Huffman tables
1362 * rv10: additional flags
1363 * mpeg4: global headers (they can be in the bitstream or here)
1364 * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1365 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1366 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1367 * - encoding: Set/allocated/freed by libavcodec.
1368 * - decoding: Set/allocated/freed by user.
1374 * This is the fundamental unit of time (in seconds) in terms
1375 * of which frame timestamps are represented. For fixed-fps content,
1376 * timebase should be 1/framerate and timestamp increments should be
1378 * - encoding: MUST be set by user.
1379 * - decoding: the use of this field for decoding is deprecated.
1380 * Use framerate instead.
1382 AVRational time_base;
1385 * For some codecs, the time base is closer to the field rate than the frame rate.
1386 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1387 * if no telecine is used ...
1389 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1391 int ticks_per_frame;
1397 * Number of frames the decoded output will be delayed relative to the
1401 * For encoding, this field is unused (see initial_padding).
1403 * For decoding, this is the number of samples the decoder needs to
1404 * output before the decoder's output is valid. When seeking, you should
1405 * start decoding this many samples prior to your desired seek point.
1407 * - encoding: Set by libavcodec.
1408 * - decoding: Set by libavcodec.
1415 * picture width / height.
1417 * @note Those fields may not match the values of the last
1418 * AVFrame outputted by avcodec_decode_video2 due frame
1421 * - encoding: MUST be set by user.
1422 * - decoding: May be set by the user before opening the decoder if known e.g.
1423 * from the container. Some decoders will require the dimensions
1424 * to be set by the caller. During decoding, the decoder may
1425 * overwrite those values as required while parsing the data.
1430 * Bitstream width / height, may be different from width/height e.g. when
1431 * the decoded frame is cropped before being output.
1433 * @note Those field may not match the value of the last
1434 * AVFrame outputted by avcodec_decode_video2 due frame
1437 * - encoding: unused
1438 * - decoding: May be set by the user before opening the decoder if known
1439 * e.g. from the container. During decoding, the decoder may
1440 * overwrite those values as required while parsing the data.
1442 int coded_width, coded_height;
1444 #if FF_API_ASPECT_EXTENDED
1445 #define FF_ASPECT_EXTENDED 15
1449 * the number of pictures in a group of pictures, or 0 for intra_only
1450 * - encoding: Set by user.
1451 * - decoding: unused
1456 * Pixel format, see AV_PIX_FMT_xxx.
1457 * May be set by the demuxer if known from headers.
1458 * May be overriden by the decoder if it knows better.
1460 * @note This field may not match the value of the last
1461 * AVFrame outputted by avcodec_decode_video2 due frame
1464 * - encoding: Set by user.
1465 * - decoding: Set by user if known, overridden by libavcodec while
1468 enum AVPixelFormat pix_fmt;
1470 #if FF_API_MOTION_EST
1472 * This option does nothing
1473 * @deprecated use codec private options instead
1475 attribute_deprecated int me_method;
1479 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1480 * decoder to draw a horizontal band. It improves cache usage. Not
1481 * all codecs can do that. You must check the codec capabilities
1483 * When multithreading is used, it may be called from multiple threads
1484 * at the same time; threads might draw different parts of the same AVFrame,
1485 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1487 * The function is also used by hardware acceleration APIs.
1488 * It is called at least once during frame decoding to pass
1489 * the data needed for hardware render.
1490 * In that mode instead of pixel data, AVFrame points to
1491 * a structure specific to the acceleration API. The application
1492 * reads the structure and can change some fields to indicate progress
1494 * - encoding: unused
1495 * - decoding: Set by user.
1496 * @param height the height of the slice
1497 * @param y the y position of the slice
1498 * @param type 1->top field, 2->bottom field, 3->frame
1499 * @param offset offset into the AVFrame.data from which the slice should be read
1501 void (*draw_horiz_band)(struct AVCodecContext *s,
1502 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1503 int y, int type, int height);
1506 * callback to negotiate the pixelFormat
1507 * @param fmt is the list of formats which are supported by the codec,
1508 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1509 * The first is always the native one.
1510 * @note The callback may be called again immediately if initialization for
1511 * the selected (hardware-accelerated) pixel format failed.
1512 * @warning Behavior is undefined if the callback returns a value not
1513 * in the fmt list of formats.
1514 * @return the chosen format
1515 * - encoding: unused
1516 * - decoding: Set by user, if not set the native format will be chosen.
1518 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1521 * maximum number of B-frames between non-B-frames
1522 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1523 * - encoding: Set by user.
1524 * - decoding: unused
1529 * qscale factor between IP and B-frames
1530 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1531 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1532 * - encoding: Set by user.
1533 * - decoding: unused
1535 float b_quant_factor;
1537 #if FF_API_RC_STRATEGY
1538 /** @deprecated use codec private option instead */
1539 attribute_deprecated int rc_strategy;
1540 #define FF_RC_STRATEGY_XVID 1
1543 int b_frame_strategy;
1546 * qscale offset between IP and B-frames
1547 * - encoding: Set by user.
1548 * - decoding: unused
1550 float b_quant_offset;
1553 * Size of the frame reordering buffer in the decoder.
1554 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1555 * - encoding: Set by libavcodec.
1556 * - decoding: Set by libavcodec.
1561 * 0-> h263 quant 1-> mpeg quant
1562 * - encoding: Set by user.
1563 * - decoding: unused
1568 * qscale factor between P and I-frames
1569 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1570 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1571 * - encoding: Set by user.
1572 * - decoding: unused
1574 float i_quant_factor;
1577 * qscale offset between P and I-frames
1578 * - encoding: Set by user.
1579 * - decoding: unused
1581 float i_quant_offset;
1584 * luminance masking (0-> disabled)
1585 * - encoding: Set by user.
1586 * - decoding: unused
1591 * temporary complexity masking (0-> disabled)
1592 * - encoding: Set by user.
1593 * - decoding: unused
1595 float temporal_cplx_masking;
1598 * spatial complexity masking (0-> disabled)
1599 * - encoding: Set by user.
1600 * - decoding: unused
1602 float spatial_cplx_masking;
1605 * p block masking (0-> disabled)
1606 * - encoding: Set by user.
1607 * - decoding: unused
1612 * darkness masking (0-> disabled)
1613 * - encoding: Set by user.
1614 * - decoding: unused
1620 * - encoding: Set by libavcodec.
1621 * - decoding: Set by user (or 0).
1625 * prediction method (needed for huffyuv)
1626 * - encoding: Set by user.
1627 * - decoding: unused
1629 int prediction_method;
1630 #define FF_PRED_LEFT 0
1631 #define FF_PRED_PLANE 1
1632 #define FF_PRED_MEDIAN 2
1635 * slice offsets in the frame in bytes
1636 * - encoding: Set/allocated by libavcodec.
1637 * - decoding: Set/allocated by user (or NULL).
1642 * sample aspect ratio (0 if unknown)
1643 * That is the width of a pixel divided by the height of the pixel.
1644 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1645 * - encoding: Set by user.
1646 * - decoding: Set by libavcodec.
1648 AVRational sample_aspect_ratio;
1651 * motion estimation comparison function
1652 * - encoding: Set by user.
1653 * - decoding: unused
1657 * subpixel motion estimation comparison function
1658 * - encoding: Set by user.
1659 * - decoding: unused
1663 * macroblock comparison function (not supported yet)
1664 * - encoding: Set by user.
1665 * - decoding: unused
1669 * interlaced DCT comparison function
1670 * - encoding: Set by user.
1671 * - decoding: unused
1674 #define FF_CMP_SAD 0
1675 #define FF_CMP_SSE 1
1676 #define FF_CMP_SATD 2
1677 #define FF_CMP_DCT 3
1678 #define FF_CMP_PSNR 4
1679 #define FF_CMP_BIT 5
1681 #define FF_CMP_ZERO 7
1682 #define FF_CMP_VSAD 8
1683 #define FF_CMP_VSSE 9
1684 #define FF_CMP_NSSE 10
1685 #define FF_CMP_DCTMAX 13
1686 #define FF_CMP_DCT264 14
1687 #define FF_CMP_CHROMA 256
1690 * ME diamond size & shape
1691 * - encoding: Set by user.
1692 * - decoding: unused
1697 * amount of previous MV predictors (2a+1 x 2a+1 square)
1698 * - encoding: Set by user.
1699 * - decoding: unused
1701 int last_predictor_count;
1704 * prepass for motion estimation
1705 * - encoding: Set by user.
1706 * - decoding: unused
1711 * motion estimation prepass comparison function
1712 * - encoding: Set by user.
1713 * - decoding: unused
1718 * ME prepass diamond size & shape
1719 * - encoding: Set by user.
1720 * - decoding: unused
1726 * - encoding: Set by user.
1727 * - decoding: unused
1729 int me_subpel_quality;
1733 * DTG active format information (additional aspect ratio
1734 * information only used in DVB MPEG-2 transport streams)
1737 * - encoding: unused
1738 * - decoding: Set by decoder.
1739 * @deprecated Deprecated in favor of AVSideData
1741 attribute_deprecated int dtg_active_format;
1742 #define FF_DTG_AFD_SAME 8
1743 #define FF_DTG_AFD_4_3 9
1744 #define FF_DTG_AFD_16_9 10
1745 #define FF_DTG_AFD_14_9 11
1746 #define FF_DTG_AFD_4_3_SP_14_9 13
1747 #define FF_DTG_AFD_16_9_SP_14_9 14
1748 #define FF_DTG_AFD_SP_4_3 15
1749 #endif /* FF_API_AFD */
1752 * maximum motion estimation search range in subpel units
1753 * If 0 then no limit.
1755 * - encoding: Set by user.
1756 * - decoding: unused
1760 #if FF_API_QUANT_BIAS
1762 * @deprecated use encoder private option instead
1764 attribute_deprecated int intra_quant_bias;
1765 #define FF_DEFAULT_QUANT_BIAS 999999
1768 * @deprecated use encoder private option instead
1770 attribute_deprecated int inter_quant_bias;
1775 * - encoding: unused
1776 * - decoding: Set by user.
1779 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1780 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1781 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1785 * XVideo Motion Acceleration
1786 * - encoding: forbidden
1787 * - decoding: set by decoder
1788 * @deprecated XvMC support is slated for removal.
1790 attribute_deprecated int xvmc_acceleration;
1791 #endif /* FF_API_XVMC */
1794 * macroblock decision mode
1795 * - encoding: Set by user.
1796 * - decoding: unused
1799 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1800 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1801 #define FF_MB_DECISION_RD 2 ///< rate distortion
1804 * custom intra quantization matrix
1805 * - encoding: Set by user, can be NULL.
1806 * - decoding: Set by libavcodec.
1808 uint16_t *intra_matrix;
1811 * custom inter quantization matrix
1812 * - encoding: Set by user, can be NULL.
1813 * - decoding: Set by libavcodec.
1815 uint16_t *inter_matrix;
1818 * scene change detection threshold
1819 * 0 is default, larger means fewer detected scene changes.
1820 * - encoding: Set by user.
1821 * - decoding: unused
1823 int scenechange_threshold;
1826 * noise reduction strength
1827 * - encoding: Set by user.
1828 * - decoding: unused
1830 int noise_reduction;
1834 * @deprecated this field is unused
1836 attribute_deprecated
1840 * @deprecated this field is unused
1842 attribute_deprecated
1847 * precision of the intra DC coefficient - 8
1848 * - encoding: Set by user.
1849 * - decoding: unused
1851 int intra_dc_precision;
1854 * Number of macroblock rows at the top which are skipped.
1855 * - encoding: unused
1856 * - decoding: Set by user.
1861 * Number of macroblock rows at the bottom which are skipped.
1862 * - encoding: unused
1863 * - decoding: Set by user.
1869 * @deprecated use encoder private options instead
1871 attribute_deprecated
1872 float border_masking;
1876 * minimum MB lagrange multipler
1877 * - encoding: Set by user.
1878 * - decoding: unused
1883 * maximum MB lagrange multipler
1884 * - encoding: Set by user.
1885 * - decoding: unused
1891 * - encoding: Set by user.
1892 * - decoding: unused
1894 int me_penalty_compensation;
1898 * - encoding: Set by user.
1899 * - decoding: unused
1905 * - encoding: Set by user.
1906 * - decoding: unused
1912 * - encoding: Set by user.
1913 * - decoding: unused
1918 * number of reference frames
1919 * - encoding: Set by user.
1920 * - decoding: Set by lavc.
1925 * chroma qp offset from luma
1926 * - encoding: Set by user.
1927 * - decoding: unused
1931 #if FF_API_UNUSED_MEMBERS
1933 * Multiplied by qscale for each frame and added to scene_change_score.
1934 * - encoding: Set by user.
1935 * - decoding: unused
1937 attribute_deprecated int scenechange_factor;
1942 * Note: Value depends upon the compare function used for fullpel ME.
1943 * - encoding: Set by user.
1944 * - decoding: unused
1949 * Adjust sensitivity of b_frame_strategy 1.
1950 * - encoding: Set by user.
1951 * - decoding: unused
1956 * Chromaticity coordinates of the source primaries.
1957 * - encoding: Set by user
1958 * - decoding: Set by libavcodec
1960 enum AVColorPrimaries color_primaries;
1963 * Color Transfer Characteristic.
1964 * - encoding: Set by user
1965 * - decoding: Set by libavcodec
1967 enum AVColorTransferCharacteristic color_trc;
1970 * YUV colorspace type.
1971 * - encoding: Set by user
1972 * - decoding: Set by libavcodec
1974 enum AVColorSpace colorspace;
1977 * MPEG vs JPEG YUV range.
1978 * - encoding: Set by user
1979 * - decoding: Set by libavcodec
1981 enum AVColorRange color_range;
1984 * This defines the location of chroma samples.
1985 * - encoding: Set by user
1986 * - decoding: Set by libavcodec
1988 enum AVChromaLocation chroma_sample_location;
1992 * Indicates number of picture subdivisions. Used for parallelized
1994 * - encoding: Set by user
1995 * - decoding: unused
2000 * - encoding: set by libavcodec
2001 * - decoding: Set by libavcodec
2003 enum AVFieldOrder field_order;
2006 int sample_rate; ///< samples per second
2007 int channels; ///< number of audio channels
2010 * audio sample format
2011 * - encoding: Set by user.
2012 * - decoding: Set by libavcodec.
2014 enum AVSampleFormat sample_fmt; ///< sample format
2016 /* The following data should not be initialized. */
2018 * Number of samples per channel in an audio frame.
2020 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2021 * except the last must contain exactly frame_size samples per channel.
2022 * May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2023 * frame size is not restricted.
2024 * - decoding: may be set by some decoders to indicate constant frame size
2029 * Frame counter, set by libavcodec.
2031 * - decoding: total number of frames returned from the decoder so far.
2032 * - encoding: total number of frames passed to the encoder so far.
2034 * @note the counter is not incremented if encoding/decoding resulted in
2040 * number of bytes per packet if constant and known or 0
2041 * Used by some WAV based audio codecs.
2046 * Audio cutoff bandwidth (0 means "automatic")
2047 * - encoding: Set by user.
2048 * - decoding: unused
2053 * Audio channel layout.
2054 * - encoding: set by user.
2055 * - decoding: set by libavcodec.
2057 uint64_t channel_layout;
2060 * Request decoder to use this channel layout if it can (0 for default)
2061 * - encoding: unused
2062 * - decoding: Set by user.
2064 uint64_t request_channel_layout;
2067 * Type of service that the audio stream conveys.
2068 * - encoding: Set by user.
2069 * - decoding: Set by libavcodec.
2071 enum AVAudioServiceType audio_service_type;
2074 * Used to request a sample format from the decoder.
2075 * - encoding: unused.
2076 * - decoding: Set by user.
2078 enum AVSampleFormat request_sample_fmt;
2081 * This callback is called at the beginning of each frame to get data
2082 * buffer(s) for it. There may be one contiguous buffer for all the data or
2083 * there may be a buffer per each data plane or anything in between. What
2084 * this means is, you may set however many entries in buf[] you feel necessary.
2085 * Each buffer must be reference-counted using the AVBuffer API (see description
2088 * The following fields will be set in the frame before this callback is
2091 * - width, height (video only)
2092 * - sample_rate, channel_layout, nb_samples (audio only)
2093 * Their values may differ from the corresponding values in
2094 * AVCodecContext. This callback must use the frame values, not the codec
2095 * context values, to calculate the required buffer size.
2097 * This callback must fill the following fields in the frame:
2101 * * if the data is planar audio with more than 8 channels, then this
2102 * callback must allocate and fill extended_data to contain all pointers
2103 * to all data planes. data[] must hold as many pointers as it can.
2104 * extended_data must be allocated with av_malloc() and will be freed in
2106 * * otherwise exended_data must point to data
2107 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2108 * the frame's data and extended_data pointers must be contained in these. That
2109 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2110 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2111 * and av_buffer_ref().
2112 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2113 * this callback and filled with the extra buffers if there are more
2114 * buffers than buf[] can hold. extended_buf will be freed in
2117 * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2118 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2121 * Each data plane must be aligned to the maximum required by the target
2124 * @see avcodec_default_get_buffer2()
2128 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2129 * (read and/or written to if it is writable) later by libavcodec.
2131 * avcodec_align_dimensions2() should be used to find the required width and
2132 * height, as they normally need to be rounded up to the next multiple of 16.
2134 * If frame multithreading is used and thread_safe_callbacks is set,
2135 * this callback may be called from a different thread, but not from more
2136 * than one at once. Does not need to be reentrant.
2138 * @see avcodec_align_dimensions2()
2142 * Decoders request a buffer of a particular size by setting
2143 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2144 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2145 * to a smaller value in the output frame.
2147 * As a convenience, av_samples_get_buffer_size() and
2148 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2149 * functions to find the required data size and to fill data pointers and
2150 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2151 * since all planes must be the same size.
2153 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2155 * - encoding: unused
2156 * - decoding: Set by libavcodec, user can override.
2158 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2161 * If non-zero, the decoded audio and video frames returned from
2162 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2163 * and are valid indefinitely. The caller must free them with
2164 * av_frame_unref() when they are not needed anymore.
2165 * Otherwise, the decoded frames must not be freed by the caller and are
2166 * only valid until the next decode call.
2168 * - encoding: unused
2169 * - decoding: set by the caller before avcodec_open2().
2171 int refcounted_frames;
2173 /* - encoding parameters */
2174 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2175 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2179 * - encoding: Set by user.
2180 * - decoding: unused
2186 * - encoding: Set by user.
2187 * - decoding: unused
2192 * maximum quantizer difference between frames
2193 * - encoding: Set by user.
2194 * - decoding: unused
2200 * @deprecated use encoder private options instead
2202 attribute_deprecated
2205 attribute_deprecated
2207 attribute_deprecated
2212 * decoder bitstream buffer size
2213 * - encoding: Set by user.
2214 * - decoding: unused
2219 * ratecontrol override, see RcOverride
2220 * - encoding: Allocated/set/freed by user.
2221 * - decoding: unused
2223 int rc_override_count;
2224 RcOverride *rc_override;
2228 * @deprecated use encoder private options instead
2230 attribute_deprecated
2236 * - encoding: Set by user.
2237 * - decoding: unused
2243 * - encoding: Set by user.
2244 * - decoding: unused
2250 * @deprecated use encoder private options instead
2252 attribute_deprecated
2253 float rc_buffer_aggressivity;
2255 attribute_deprecated
2256 float rc_initial_cplx;
2260 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2261 * - encoding: Set by user.
2262 * - decoding: unused.
2264 float rc_max_available_vbv_use;
2267 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2268 * - encoding: Set by user.
2269 * - decoding: unused.
2271 float rc_min_vbv_overflow_use;
2274 * Number of bits which should be loaded into the rc buffer before decoding starts.
2275 * - encoding: Set by user.
2276 * - decoding: unused
2278 int rc_initial_buffer_occupancy;
2280 #define FF_CODER_TYPE_VLC 0
2281 #define FF_CODER_TYPE_AC 1
2282 #define FF_CODER_TYPE_RAW 2
2283 #define FF_CODER_TYPE_RLE 3
2284 #if FF_API_UNUSED_MEMBERS
2285 #define FF_CODER_TYPE_DEFLATE 4
2286 #endif /* FF_API_UNUSED_MEMBERS */
2289 * - encoding: Set by user.
2290 * - decoding: unused
2296 * - encoding: Set by user.
2297 * - decoding: unused
2303 * @deprecated use encoder private options instead
2305 attribute_deprecated
2309 * @deprecated use encoder private options instead
2311 attribute_deprecated
2316 * frame skip threshold
2317 * - encoding: Set by user.
2318 * - decoding: unused
2320 int frame_skip_threshold;
2324 * - encoding: Set by user.
2325 * - decoding: unused
2327 int frame_skip_factor;
2330 * frame skip exponent
2331 * - encoding: Set by user.
2332 * - decoding: unused
2337 * frame skip comparison function
2338 * - encoding: Set by user.
2339 * - decoding: unused
2344 * trellis RD quantization
2345 * - encoding: Set by user.
2346 * - decoding: unused
2351 * - encoding: Set by user.
2352 * - decoding: unused
2354 int min_prediction_order;
2357 * - encoding: Set by user.
2358 * - decoding: unused
2360 int max_prediction_order;
2363 * GOP timecode frame start number, in non drop frame format
2364 * - encoding: Set by user.
2365 * - decoding: unused
2367 int64_t timecode_frame_start;
2369 /* The RTP callback: This function is called */
2370 /* every time the encoder has a packet to send. */
2371 /* It depends on the encoder if the data starts */
2372 /* with a Start Code (it should). H.263 does. */
2373 /* mb_nb contains the number of macroblocks */
2374 /* encoded in the RTP payload. */
2375 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2377 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2378 /* do its best to deliver a chunk with size */
2379 /* below rtp_payload_size, the chunk will start */
2380 /* with a start code on some codecs like H.263. */
2381 /* This doesn't take account of any particular */
2382 /* headers inside the transmitted RTP payload. */
2384 /* statistics, used for 2-pass encoding */
2395 * number of bits used for the previously encoded frame
2396 * - encoding: Set by libavcodec.
2397 * - decoding: unused
2402 * pass1 encoding statistics output buffer
2403 * - encoding: Set by libavcodec.
2404 * - decoding: unused
2409 * pass2 encoding statistics input buffer
2410 * Concatenated stuff from stats_out of pass1 should be placed here.
2411 * - encoding: Allocated/set/freed by user.
2412 * - decoding: unused
2417 * Work around bugs in encoders which sometimes cannot be detected automatically.
2418 * - encoding: Set by user
2419 * - decoding: Set by user
2421 int workaround_bugs;
2422 #define FF_BUG_AUTODETECT 1 ///< autodetection
2423 #if FF_API_OLD_MSMPEG4
2424 #define FF_BUG_OLD_MSMPEG4 2
2426 #define FF_BUG_XVID_ILACE 4
2427 #define FF_BUG_UMP4 8
2428 #define FF_BUG_NO_PADDING 16
2429 #define FF_BUG_AMV 32
2431 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2433 #define FF_BUG_QPEL_CHROMA 64
2434 #define FF_BUG_STD_QPEL 128
2435 #define FF_BUG_QPEL_CHROMA2 256
2436 #define FF_BUG_DIRECT_BLOCKSIZE 512
2437 #define FF_BUG_EDGE 1024
2438 #define FF_BUG_HPEL_CHROMA 2048
2439 #define FF_BUG_DC_CLIP 4096
2440 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2441 #define FF_BUG_TRUNCATED 16384
2444 * strictly follow the standard (MPEG4, ...).
2445 * - encoding: Set by user.
2446 * - decoding: Set by user.
2447 * Setting this to STRICT or higher means the encoder and decoder will
2448 * generally do stupid things, whereas setting it to unofficial or lower
2449 * will mean the encoder might produce output that is not supported by all
2450 * spec-compliant decoders. Decoders don't differentiate between normal,
2451 * unofficial and experimental (that is, they always try to decode things
2452 * when they can) unless they are explicitly asked to behave stupidly
2453 * (=strictly conform to the specs)
2455 int strict_std_compliance;
2456 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2457 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2458 #define FF_COMPLIANCE_NORMAL 0
2459 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2460 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2463 * error concealment flags
2464 * - encoding: unused
2465 * - decoding: Set by user.
2467 int error_concealment;
2468 #define FF_EC_GUESS_MVS 1
2469 #define FF_EC_DEBLOCK 2
2473 * - encoding: Set by user.
2474 * - decoding: Set by user.
2477 #define FF_DEBUG_PICT_INFO 1
2478 #define FF_DEBUG_RC 2
2479 #define FF_DEBUG_BITSTREAM 4
2480 #define FF_DEBUG_MB_TYPE 8
2481 #define FF_DEBUG_QP 16
2484 * @deprecated this option does nothing
2486 #define FF_DEBUG_MV 32
2488 #define FF_DEBUG_DCT_COEFF 0x00000040
2489 #define FF_DEBUG_SKIP 0x00000080
2490 #define FF_DEBUG_STARTCODE 0x00000100
2491 #if FF_API_UNUSED_MEMBERS
2492 #define FF_DEBUG_PTS 0x00000200
2493 #endif /* FF_API_UNUSED_MEMBERS */
2494 #define FF_DEBUG_ER 0x00000400
2495 #define FF_DEBUG_MMCO 0x00000800
2496 #define FF_DEBUG_BUGS 0x00001000
2498 #define FF_DEBUG_VIS_QP 0x00002000
2499 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2501 #define FF_DEBUG_BUFFERS 0x00008000
2502 #define FF_DEBUG_THREADS 0x00010000
2506 * @deprecated this option does not have any effect
2508 attribute_deprecated
2510 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2511 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2512 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2516 * Error recognition; may misdetect some more or less valid parts as errors.
2517 * - encoding: unused
2518 * - decoding: Set by user.
2520 int err_recognition;
2523 * Verify checksums embedded in the bitstream (could be of either encoded or
2524 * decoded data, depending on the codec) and print an error message on mismatch.
2525 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2526 * decoder returning an error.
2528 #define AV_EF_CRCCHECK (1<<0)
2529 #define AV_EF_BITSTREAM (1<<1)
2530 #define AV_EF_BUFFER (1<<2)
2531 #define AV_EF_EXPLODE (1<<3)
2534 * opaque 64bit number (generally a PTS) that will be reordered and
2535 * output in AVFrame.reordered_opaque
2536 * - encoding: unused
2537 * - decoding: Set by user.
2539 int64_t reordered_opaque;
2542 * Hardware accelerator in use
2543 * - encoding: unused.
2544 * - decoding: Set by libavcodec
2546 struct AVHWAccel *hwaccel;
2549 * Hardware accelerator context.
2550 * For some hardware accelerators, a global context needs to be
2551 * provided by the user. In that case, this holds display-dependent
2552 * data Libav cannot instantiate itself. Please refer to the
2553 * Libav HW accelerator documentation to know how to fill this
2554 * is. e.g. for VA API, this is a struct vaapi_context.
2555 * - encoding: unused
2556 * - decoding: Set by user
2558 void *hwaccel_context;
2562 * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2563 * - decoding: unused
2565 uint64_t error[AV_NUM_DATA_POINTERS];
2568 * DCT algorithm, see FF_DCT_* below
2569 * - encoding: Set by user.
2570 * - decoding: unused
2573 #define FF_DCT_AUTO 0
2574 #define FF_DCT_FASTINT 1
2575 #if FF_API_UNUSED_MEMBERS
2576 #define FF_DCT_INT 2
2577 #endif /* FF_API_UNUSED_MEMBERS */
2578 #define FF_DCT_MMX 3
2579 #define FF_DCT_ALTIVEC 5
2580 #define FF_DCT_FAAN 6
2583 * IDCT algorithm, see FF_IDCT_* below.
2584 * - encoding: Set by user.
2585 * - decoding: Set by user.
2588 #define FF_IDCT_AUTO 0
2589 #define FF_IDCT_INT 1
2590 #define FF_IDCT_SIMPLE 2
2591 #define FF_IDCT_SIMPLEMMX 3
2592 #define FF_IDCT_ARM 7
2593 #define FF_IDCT_ALTIVEC 8
2595 #define FF_IDCT_SH4 9
2597 #define FF_IDCT_SIMPLEARM 10
2598 #if FF_API_UNUSED_MEMBERS
2599 #define FF_IDCT_IPP 13
2600 #endif /* FF_API_UNUSED_MEMBERS */
2601 #define FF_IDCT_XVID 14
2602 #if FF_API_IDCT_XVIDMMX
2603 #define FF_IDCT_XVIDMMX 14
2604 #endif /* FF_API_IDCT_XVIDMMX */
2605 #define FF_IDCT_SIMPLEARMV5TE 16
2606 #define FF_IDCT_SIMPLEARMV6 17
2607 #if FF_API_ARCH_SPARC
2608 #define FF_IDCT_SIMPLEVIS 18
2610 #define FF_IDCT_FAAN 20
2611 #define FF_IDCT_SIMPLENEON 22
2612 #if FF_API_ARCH_ALPHA
2613 #define FF_IDCT_SIMPLEALPHA 23
2617 * bits per sample/pixel from the demuxer (needed for huffyuv).
2618 * - encoding: Set by libavcodec.
2619 * - decoding: Set by user.
2621 int bits_per_coded_sample;
2624 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2625 * - encoding: set by user.
2626 * - decoding: set by libavcodec.
2628 int bits_per_raw_sample;
2632 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2633 * - encoding: unused
2634 * - decoding: Set by user.
2636 * @deprecated use decoder private options instead
2638 attribute_deprecated int lowres;
2641 #if FF_API_CODED_FRAME
2643 * the picture in the bitstream
2644 * - encoding: Set by libavcodec.
2645 * - decoding: unused
2647 * @deprecated use the quality factor packet side data instead
2649 attribute_deprecated AVFrame *coded_frame;
2654 * is used to decide how many independent tasks should be passed to execute()
2655 * - encoding: Set by user.
2656 * - decoding: Set by user.
2661 * Which multithreading methods to use.
2662 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2663 * so clients which cannot provide future frames should not use it.
2665 * - encoding: Set by user, otherwise the default is used.
2666 * - decoding: Set by user, otherwise the default is used.
2669 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2670 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2673 * Which multithreading methods are in use by the codec.
2674 * - encoding: Set by libavcodec.
2675 * - decoding: Set by libavcodec.
2677 int active_thread_type;
2680 * Set by the client if its custom get_buffer() callback can be called
2681 * synchronously from another thread, which allows faster multithreaded decoding.
2682 * draw_horiz_band() will be called from other threads regardless of this setting.
2683 * Ignored if the default get_buffer() is used.
2684 * - encoding: Set by user.
2685 * - decoding: Set by user.
2687 int thread_safe_callbacks;
2690 * The codec may call this to execute several independent things.
2691 * It will return only after finishing all tasks.
2692 * The user may replace this with some multithreaded implementation,
2693 * the default implementation will execute the parts serially.
2694 * @param count the number of things to execute
2695 * - encoding: Set by libavcodec, user can override.
2696 * - decoding: Set by libavcodec, user can override.
2698 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2701 * The codec may call this to execute several independent things.
2702 * It will return only after finishing all tasks.
2703 * The user may replace this with some multithreaded implementation,
2704 * the default implementation will execute the parts serially.
2705 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2706 * @param c context passed also to func
2707 * @param count the number of things to execute
2708 * @param arg2 argument passed unchanged to func
2709 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2710 * @param func function that will be called count times, with jobnr from 0 to count-1.
2711 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2712 * two instances of func executing at the same time will have the same threadnr.
2713 * @return always 0 currently, but code should handle a future improvement where when any call to func
2714 * returns < 0 no further calls to func may be done and < 0 is returned.
2715 * - encoding: Set by libavcodec, user can override.
2716 * - decoding: Set by libavcodec, user can override.
2718 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2721 * noise vs. sse weight for the nsse comparsion function
2722 * - encoding: Set by user.
2723 * - decoding: unused
2729 * - encoding: Set by user.
2730 * - decoding: Set by libavcodec.
2733 #define FF_PROFILE_UNKNOWN -99
2734 #define FF_PROFILE_RESERVED -100
2736 #define FF_PROFILE_AAC_MAIN 0
2737 #define FF_PROFILE_AAC_LOW 1
2738 #define FF_PROFILE_AAC_SSR 2
2739 #define FF_PROFILE_AAC_LTP 3
2740 #define FF_PROFILE_AAC_HE 4
2741 #define FF_PROFILE_AAC_HE_V2 28
2742 #define FF_PROFILE_AAC_LD 22
2743 #define FF_PROFILE_AAC_ELD 38
2744 #define FF_PROFILE_MPEG2_AAC_LOW 128
2745 #define FF_PROFILE_MPEG2_AAC_HE 131
2747 #define FF_PROFILE_DTS 20
2748 #define FF_PROFILE_DTS_ES 30
2749 #define FF_PROFILE_DTS_96_24 40
2750 #define FF_PROFILE_DTS_HD_HRA 50
2751 #define FF_PROFILE_DTS_HD_MA 60
2752 #define FF_PROFILE_DTS_EXPRESS 70
2754 #define FF_PROFILE_MPEG2_422 0
2755 #define FF_PROFILE_MPEG2_HIGH 1
2756 #define FF_PROFILE_MPEG2_SS 2
2757 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2758 #define FF_PROFILE_MPEG2_MAIN 4
2759 #define FF_PROFILE_MPEG2_SIMPLE 5
2761 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2762 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2764 #define FF_PROFILE_H264_BASELINE 66
2765 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2766 #define FF_PROFILE_H264_MAIN 77
2767 #define FF_PROFILE_H264_EXTENDED 88
2768 #define FF_PROFILE_H264_HIGH 100
2769 #define FF_PROFILE_H264_HIGH_10 110
2770 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2771 #define FF_PROFILE_H264_HIGH_422 122
2772 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2773 #define FF_PROFILE_H264_HIGH_444 144
2774 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2775 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2776 #define FF_PROFILE_H264_CAVLC_444 44
2778 #define FF_PROFILE_VC1_SIMPLE 0
2779 #define FF_PROFILE_VC1_MAIN 1
2780 #define FF_PROFILE_VC1_COMPLEX 2
2781 #define FF_PROFILE_VC1_ADVANCED 3
2783 #define FF_PROFILE_MPEG4_SIMPLE 0
2784 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2785 #define FF_PROFILE_MPEG4_CORE 2
2786 #define FF_PROFILE_MPEG4_MAIN 3
2787 #define FF_PROFILE_MPEG4_N_BIT 4
2788 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2789 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2790 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2791 #define FF_PROFILE_MPEG4_HYBRID 8
2792 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2793 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2794 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2795 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2796 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2797 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2798 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2800 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2801 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2802 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2803 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2804 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2806 #define FF_PROFILE_VP9_0 0
2807 #define FF_PROFILE_VP9_1 1
2808 #define FF_PROFILE_VP9_2 2
2809 #define FF_PROFILE_VP9_3 3
2811 #define FF_PROFILE_HEVC_MAIN 1
2812 #define FF_PROFILE_HEVC_MAIN_10 2
2813 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2817 * - encoding: Set by user.
2818 * - decoding: Set by libavcodec.
2821 #define FF_LEVEL_UNKNOWN -99
2825 * - encoding: unused
2826 * - decoding: Set by user.
2828 enum AVDiscard skip_loop_filter;
2832 * - encoding: unused
2833 * - decoding: Set by user.
2835 enum AVDiscard skip_idct;
2839 * - encoding: unused
2840 * - decoding: Set by user.
2842 enum AVDiscard skip_frame;
2845 * Header containing style information for text subtitles.
2846 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2847 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2848 * the Format line following. It shouldn't include any Dialogue line.
2849 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2850 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2852 uint8_t *subtitle_header;
2853 int subtitle_header_size;
2855 #if FF_API_ERROR_RATE
2857 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2860 attribute_deprecated
2865 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2866 * Used for compliant TS muxing.
2867 * - encoding: Set by libavcodec.
2868 * - decoding: unused.
2872 #if FF_API_SIDEDATA_ONLY_PKT
2874 * Encoding only and set by default. Allow encoders to output packets
2875 * that do not contain any encoded data, only side data.
2877 * Some encoders need to output such packets, e.g. to update some stream
2878 * parameters at the end of encoding.
2880 * @deprecated this field disables the default behaviour and
2881 * it is kept only for compatibility.
2883 attribute_deprecated
2884 int side_data_only_packets;
2888 * Audio only. The number of "priming" samples (padding) inserted by the
2889 * encoder at the beginning of the audio. I.e. this number of leading
2890 * decoded samples must be discarded by the caller to get the original audio
2891 * without leading padding.
2893 * - decoding: unused
2894 * - encoding: Set by libavcodec. The timestamps on the output packets are
2895 * adjusted by the encoder so that they always refer to the
2896 * first sample of the data actually contained in the packet,
2897 * including any added padding. E.g. if the timebase is
2898 * 1/samplerate and the timestamp of the first input sample is
2899 * 0, the timestamp of the first output packet will be
2902 int initial_padding;
2905 * - decoding: For codecs that store a framerate value in the compressed
2906 * bitstream, the decoder may export it here. { 0, 1} when
2908 * - encoding: unused
2910 AVRational framerate;
2913 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2914 * - encoding: unused.
2915 * - decoding: Set by libavcodec before calling get_format()
2917 enum AVPixelFormat sw_pix_fmt;
2923 typedef struct AVProfile {
2925 const char *name; ///< short name for the profile
2928 typedef struct AVCodecDefault AVCodecDefault;
2935 typedef struct AVCodec {
2937 * Name of the codec implementation.
2938 * The name is globally unique among encoders and among decoders (but an
2939 * encoder and a decoder can share the same name).
2940 * This is the primary way to find a codec from the user perspective.
2944 * Descriptive name for the codec, meant to be more human readable than name.
2945 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2947 const char *long_name;
2948 enum AVMediaType type;
2951 * Codec capabilities.
2952 * see AV_CODEC_CAP_*
2955 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2956 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2957 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2958 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2959 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2961 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2963 const AVClass *priv_class; ///< AVClass for the private context
2964 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2966 /*****************************************************************
2967 * No fields below this line are part of the public API. They
2968 * may not be used outside of libavcodec and can be changed and
2970 * New public fields should be added right above.
2971 *****************************************************************
2974 struct AVCodec *next;
2976 * @name Frame-level threading support functions
2980 * If defined, called on thread contexts when they are created.
2981 * If the codec allocates writable tables in init(), re-allocate them here.
2982 * priv_data will be set to a copy of the original.
2984 int (*init_thread_copy)(AVCodecContext *);
2986 * Copy necessary context variables from a previous thread context to the current one.
2987 * If not defined, the next thread will start automatically; otherwise, the codec
2988 * must call ff_thread_finish_setup().
2990 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2992 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2996 * Private codec-specific defaults.
2998 const AVCodecDefault *defaults;
3001 * Initialize codec static data, called from avcodec_register().
3003 void (*init_static_data)(struct AVCodec *codec);
3005 int (*init)(AVCodecContext *);
3006 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3007 const struct AVSubtitle *sub);
3009 * Encode data to an AVPacket.
3011 * @param avctx codec context
3012 * @param avpkt output AVPacket (may contain a user-provided buffer)
3013 * @param[in] frame AVFrame containing the raw data to be encoded
3014 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3015 * non-empty packet was returned in avpkt.
3016 * @return 0 on success, negative error code on failure
3018 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3019 int *got_packet_ptr);
3020 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3021 int (*close)(AVCodecContext *);
3024 * Will be called when seeking
3026 void (*flush)(AVCodecContext *);
3028 * Internal codec capabilities.
3029 * See FF_CODEC_CAP_* in internal.h
3035 * @defgroup lavc_hwaccel AVHWAccel
3038 typedef struct AVHWAccel {
3040 * Name of the hardware accelerated codec.
3041 * The name is globally unique among encoders and among decoders (but an
3042 * encoder and a decoder can share the same name).
3047 * Type of codec implemented by the hardware accelerator.
3049 * See AVMEDIA_TYPE_xxx
3051 enum AVMediaType type;
3054 * Codec implemented by the hardware accelerator.
3056 * See AV_CODEC_ID_xxx
3061 * Supported pixel format.
3063 * Only hardware accelerated formats are supported here.
3065 enum AVPixelFormat pix_fmt;
3068 * Hardware accelerated codec capabilities.
3069 * see FF_HWACCEL_CODEC_CAP_*
3073 /*****************************************************************
3074 * No fields below this line are part of the public API. They
3075 * may not be used outside of libavcodec and can be changed and
3077 * New public fields should be added right above.
3078 *****************************************************************
3080 struct AVHWAccel *next;
3083 * Allocate a custom buffer
3085 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3088 * Called at the beginning of each frame or field picture.
3090 * Meaningful frame information (codec specific) is guaranteed to
3091 * be parsed at this point. This function is mandatory.
3093 * Note that buf can be NULL along with buf_size set to 0.
3094 * Otherwise, this means the whole frame is available at this point.
3096 * @param avctx the codec context
3097 * @param buf the frame data buffer base
3098 * @param buf_size the size of the frame in bytes
3099 * @return zero if successful, a negative value otherwise
3101 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3104 * Callback for each slice.
3106 * Meaningful slice information (codec specific) is guaranteed to
3107 * be parsed at this point. This function is mandatory.
3109 * @param avctx the codec context
3110 * @param buf the slice data buffer base
3111 * @param buf_size the size of the slice in bytes
3112 * @return zero if successful, a negative value otherwise
3114 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3117 * Called at the end of each frame or field picture.
3119 * The whole picture is parsed at this point and can now be sent
3120 * to the hardware accelerator. This function is mandatory.
3122 * @param avctx the codec context
3123 * @return zero if successful, a negative value otherwise
3125 int (*end_frame)(AVCodecContext *avctx);
3128 * Size of per-frame hardware accelerator private data.
3130 * Private data is allocated with av_mallocz() before
3131 * AVCodecContext.get_buffer() and deallocated after
3132 * AVCodecContext.release_buffer().
3134 int frame_priv_data_size;
3137 * Initialize the hwaccel private data.
3139 * This will be called from ff_get_format(), after hwaccel and
3140 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3143 int (*init)(AVCodecContext *avctx);
3146 * Uninitialize the hwaccel private data.
3148 * This will be called from get_format() or avcodec_close(), after hwaccel
3149 * and hwaccel_context are already uninitialized.
3151 int (*uninit)(AVCodecContext *avctx);
3154 * Size of the private data to allocate in
3155 * AVCodecInternal.hwaccel_priv_data.
3161 * Hardware acceleration should be used for decoding even if the codec level
3162 * used is unknown or higher than the maximum supported level reported by the
3165 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3168 * Hardware acceleration can output YUV pixel formats with a different chroma
3169 * sampling than 4:2:0 and/or other than 8 bits per component.
3171 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3178 * @defgroup lavc_picture AVPicture
3180 * Functions for working with AVPicture
3185 * four components are given, that's all.
3186 * the last component is alpha
3188 typedef struct AVPicture {
3189 uint8_t *data[AV_NUM_DATA_POINTERS];
3190 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3197 #define AVPALETTE_SIZE 1024
3198 #define AVPALETTE_COUNT 256
3200 enum AVSubtitleType {
3203 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3206 * Plain text, the text field must be set by the decoder and is
3207 * authoritative. ass and pict fields may contain approximations.
3212 * Formatted text, the ass field must be set by the decoder and is
3213 * authoritative. pict and text fields may contain approximations.
3218 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3220 typedef struct AVSubtitleRect {
3221 int x; ///< top left corner of pict, undefined when pict is not set
3222 int y; ///< top left corner of pict, undefined when pict is not set
3223 int w; ///< width of pict, undefined when pict is not set
3224 int h; ///< height of pict, undefined when pict is not set
3225 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3228 * data+linesize for the bitmap of this subtitle.
3229 * can be set for text/ass as well once they where rendered
3232 enum AVSubtitleType type;
3234 char *text; ///< 0 terminated plain UTF-8 text
3237 * 0 terminated ASS/SSA compatible event line.
3238 * The pressentation of this is unaffected by the other values in this
3245 typedef struct AVSubtitle {
3246 uint16_t format; /* 0 = graphics */
3247 uint32_t start_display_time; /* relative to packet pts, in ms */
3248 uint32_t end_display_time; /* relative to packet pts, in ms */
3250 AVSubtitleRect **rects;
3251 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3255 * If c is NULL, returns the first registered codec,
3256 * if c is non-NULL, returns the next registered codec after c,
3257 * or NULL if c is the last one.
3259 AVCodec *av_codec_next(const AVCodec *c);
3262 * Return the LIBAVCODEC_VERSION_INT constant.
3264 unsigned avcodec_version(void);
3267 * Return the libavcodec build-time configuration.
3269 const char *avcodec_configuration(void);
3272 * Return the libavcodec license.
3274 const char *avcodec_license(void);
3277 * Register the codec codec and initialize libavcodec.
3279 * @warning either this function or avcodec_register_all() must be called
3280 * before any other libavcodec functions.
3282 * @see avcodec_register_all()
3284 void avcodec_register(AVCodec *codec);
3287 * Register all the codecs, parsers and bitstream filters which were enabled at
3288 * configuration time. If you do not call this function you can select exactly
3289 * which formats you want to support, by using the individual registration
3292 * @see avcodec_register
3293 * @see av_register_codec_parser
3294 * @see av_register_bitstream_filter
3296 void avcodec_register_all(void);
3299 * Allocate an AVCodecContext and set its fields to default values. The
3300 * resulting struct should be freed with avcodec_free_context().
3302 * @param codec if non-NULL, allocate private data and initialize defaults
3303 * for the given codec. It is illegal to then call avcodec_open2()
3304 * with a different codec.
3305 * If NULL, then the codec-specific defaults won't be initialized,
3306 * which may result in suboptimal default settings (this is
3307 * important mainly for encoders, e.g. libx264).
3309 * @return An AVCodecContext filled with default values or NULL on failure.
3310 * @see avcodec_get_context_defaults
3312 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3315 * Free the codec context and everything associated with it and write NULL to
3316 * the provided pointer.
3318 void avcodec_free_context(AVCodecContext **avctx);
3321 * Set the fields of the given AVCodecContext to default values corresponding
3322 * to the given codec (defaults may be codec-dependent).
3324 * Do not call this function if a non-NULL codec has been passed
3325 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3326 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3327 * different codec on this AVCodecContext.
3329 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3332 * Get the AVClass for AVCodecContext. It can be used in combination with
3333 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3335 * @see av_opt_find().
3337 const AVClass *avcodec_get_class(void);
3340 * Copy the settings of the source AVCodecContext into the destination
3341 * AVCodecContext. The resulting destination codec context will be
3342 * unopened, i.e. you are required to call avcodec_open2() before you
3343 * can use this AVCodecContext to decode/encode video/audio data.
3345 * @param dest target codec context, should be initialized with
3346 * avcodec_alloc_context3(), but otherwise uninitialized
3347 * @param src source codec context
3348 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3350 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3353 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3354 * function the context has to be allocated with avcodec_alloc_context3().
3356 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3357 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3358 * retrieving a codec.
3360 * @warning This function is not thread safe!
3362 * @note Always call this function before using decoding routines (such as
3363 * @ref avcodec_decode_video2()).
3366 * avcodec_register_all();
3367 * av_dict_set(&opts, "b", "2.5M", 0);
3368 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3372 * context = avcodec_alloc_context3(codec);
3374 * if (avcodec_open2(context, codec, opts) < 0)
3378 * @param avctx The context to initialize.
3379 * @param codec The codec to open this context for. If a non-NULL codec has been
3380 * previously passed to avcodec_alloc_context3() or
3381 * avcodec_get_context_defaults3() for this context, then this
3382 * parameter MUST be either NULL or equal to the previously passed
3384 * @param options A dictionary filled with AVCodecContext and codec-private options.
3385 * On return this object will be filled with options that were not found.
3387 * @return zero on success, a negative value on error
3388 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3389 * av_dict_set(), av_opt_find().
3391 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3394 * Close a given AVCodecContext and free all the data associated with it
3395 * (but not the AVCodecContext itself).
3397 * Calling this function on an AVCodecContext that hasn't been opened will free
3398 * the codec-specific data allocated in avcodec_alloc_context3() /
3399 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3402 int avcodec_close(AVCodecContext *avctx);
3405 * Free all allocated data in the given subtitle struct.
3407 * @param sub AVSubtitle to free.
3409 void avsubtitle_free(AVSubtitle *sub);
3416 * @addtogroup lavc_packet
3421 * Initialize optional fields of a packet with default values.
3423 * Note, this does not touch the data and size members, which have to be
3424 * initialized separately.
3428 void av_init_packet(AVPacket *pkt);
3431 * Allocate the payload of a packet and initialize its fields with
3435 * @param size wanted payload size
3436 * @return 0 if OK, AVERROR_xxx otherwise
3438 int av_new_packet(AVPacket *pkt, int size);
3441 * Reduce packet size, correctly zeroing padding
3444 * @param size new size
3446 void av_shrink_packet(AVPacket *pkt, int size);
3449 * Increase packet size, correctly zeroing padding
3452 * @param grow_by number of bytes by which to increase the size of the packet
3454 int av_grow_packet(AVPacket *pkt, int grow_by);
3457 * Initialize a reference-counted packet from av_malloc()ed data.
3459 * @param pkt packet to be initialized. This function will set the data, size,
3460 * buf and destruct fields, all others are left untouched.
3461 * @param data Data allocated by av_malloc() to be used as packet data. If this
3462 * function returns successfully, the data is owned by the underlying AVBuffer.
3463 * The caller may not access the data through other means.
3464 * @param size size of data in bytes, without the padding. I.e. the full buffer
3465 * size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
3467 * @return 0 on success, a negative AVERROR on error
3469 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3472 * @warning This is a hack - the packet memory allocation stuff is broken. The
3473 * packet is allocated if it was not really allocated.
3475 int av_dup_packet(AVPacket *pkt);
3480 * @param pkt packet to free
3482 void av_free_packet(AVPacket *pkt);
3485 * Allocate new information of a packet.
3488 * @param type side information type
3489 * @param size side information size
3490 * @return pointer to fresh allocated data or NULL otherwise
3492 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3496 * Shrink the already allocated side data buffer
3499 * @param type side information type
3500 * @param size new side information size
3501 * @return 0 on success, < 0 on failure
3503 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3507 * Get side information from packet.
3510 * @param type desired side information type
3511 * @param size pointer for side information size to store (optional)
3512 * @return pointer to data if present or NULL otherwise
3514 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3518 * Convenience function to free all the side data stored.
3519 * All the other fields stay untouched.
3523 void av_packet_free_side_data(AVPacket *pkt);
3526 * Setup a new reference to the data described by a given packet
3528 * If src is reference-counted, setup dst as a new reference to the
3529 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3530 * data from src into it.
3532 * All the other fields are copied from src.
3534 * @see av_packet_unref
3536 * @param dst Destination packet
3537 * @param src Source packet
3539 * @return 0 on success, a negative AVERROR on error.
3541 int av_packet_ref(AVPacket *dst, AVPacket *src);
3546 * Unreference the buffer referenced by the packet and reset the
3547 * remaining packet fields to their default values.
3549 * @param pkt The packet to be unreferenced.
3551 void av_packet_unref(AVPacket *pkt);
3554 * Move every field in src to dst and reset src.
3556 * @see av_packet_unref
3558 * @param src Source packet, will be reset
3559 * @param dst Destination packet
3561 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3564 * Copy only "properties" fields from src to dst.
3566 * Properties for the purpose of this function are all the fields
3567 * beside those related to the packet data (buf, data, size)
3569 * @param dst Destination packet
3570 * @param src Source packet
3572 * @return 0 on success AVERROR on failure.
3575 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3578 * Convert valid timing fields (timestamps / durations) in a packet from one
3579 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3582 * @param pkt packet on which the conversion will be performed
3583 * @param tb_src source timebase, in which the timing fields in pkt are
3585 * @param tb_dst destination timebase, to which the timing fields will be
3588 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
3595 * @addtogroup lavc_decoding
3600 * Find a registered decoder with a matching codec ID.
3602 * @param id AVCodecID of the requested decoder
3603 * @return A decoder if one was found, NULL otherwise.
3605 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3608 * Find a registered decoder with the specified name.
3610 * @param name name of the requested decoder
3611 * @return A decoder if one was found, NULL otherwise.
3613 AVCodec *avcodec_find_decoder_by_name(const char *name);
3616 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3617 * it can be called by custom get_buffer2() implementations for decoders without
3618 * AV_CODEC_CAP_DR1 set.
3620 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3624 * Return the amount of padding in pixels which the get_buffer callback must
3625 * provide around the edge of the image for codecs which do not have the
3626 * CODEC_FLAG_EMU_EDGE flag.
3628 * @return Required padding in pixels.
3630 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
3633 attribute_deprecated
3634 unsigned avcodec_get_edge_width(void);
3638 * Modify width and height values so that they will result in a memory
3639 * buffer that is acceptable for the codec if you do not use any horizontal
3642 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3644 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3647 * Modify width and height values so that they will result in a memory
3648 * buffer that is acceptable for the codec if you also ensure that all
3649 * line sizes are a multiple of the respective linesize_align[i].
3651 * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3653 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3654 int linesize_align[AV_NUM_DATA_POINTERS]);
3657 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3659 * Some decoders may support multiple frames in a single AVPacket. Such
3660 * decoders would then just decode the first frame and the return value would be
3661 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3662 * called again with an AVPacket containing the remaining data in order to
3663 * decode the second frame, etc... Even if no frames are returned, the packet
3664 * needs to be fed to the decoder with remaining data until it is completely
3665 * consumed or an error occurs.
3667 * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3668 * and output. This means that for some packets they will not immediately
3669 * produce decoded output and need to be flushed at the end of decoding to get
3670 * all the decoded data. Flushing is done by calling this function with packets
3671 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3672 * returning samples. It is safe to flush even those decoders that are not
3673 * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
3675 * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3676 * larger than the actual read bytes because some optimized bitstream
3677 * readers read 32 or 64 bits at once and could read over the end.
3679 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3680 * before packets may be fed to the decoder.
3682 * @param avctx the codec context
3683 * @param[out] frame The AVFrame in which to store decoded audio samples.
3684 * The decoder will allocate a buffer for the decoded frame by
3685 * calling the AVCodecContext.get_buffer2() callback.
3686 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3687 * reference counted and the returned reference belongs to the
3688 * caller. The caller must release the frame using av_frame_unref()
3689 * when the frame is no longer needed. The caller may safely write
3690 * to the frame if av_frame_is_writable() returns 1.
3691 * When AVCodecContext.refcounted_frames is set to 0, the returned
3692 * reference belongs to the decoder and is valid only until the
3693 * next call to this function or until closing or flushing the
3694 * decoder. The caller may not write to it.
3695 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3696 * non-zero. Note that this field being set to zero
3697 * does not mean that an error has occurred. For
3698 * decoders with AV_CODEC_CAP_DELAY set, no given decode
3699 * call is guaranteed to produce a frame.
3700 * @param[in] avpkt The input AVPacket containing the input buffer.
3701 * At least avpkt->data and avpkt->size should be set. Some
3702 * decoders might also require additional fields to be set.
3703 * @return A negative error code is returned if an error occurred during
3704 * decoding, otherwise the number of bytes consumed from the input
3705 * AVPacket is returned.
3707 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3708 int *got_frame_ptr, AVPacket *avpkt);
3711 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3712 * Some decoders may support multiple frames in a single AVPacket, such
3713 * decoders would then just decode the first frame.
3715 * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
3716 * the actual read bytes because some optimized bitstream readers read 32 or 64
3717 * bits at once and could read over the end.
3719 * @warning The end of the input buffer buf should be set to 0 to ensure that
3720 * no overreading happens for damaged MPEG streams.
3722 * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
3723 * between input and output, these need to be fed with avpkt->data=NULL,
3724 * avpkt->size=0 at the end to return the remaining frames.
3726 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3727 * before packets may be fed to the decoder.
3729 * @param avctx the codec context
3730 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3731 * Use av_frame_alloc() to get an AVFrame. The codec will
3732 * allocate memory for the actual bitmap by calling the
3733 * AVCodecContext.get_buffer2() callback.
3734 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3735 * reference counted and the returned reference belongs to the
3736 * caller. The caller must release the frame using av_frame_unref()
3737 * when the frame is no longer needed. The caller may safely write
3738 * to the frame if av_frame_is_writable() returns 1.
3739 * When AVCodecContext.refcounted_frames is set to 0, the returned
3740 * reference belongs to the decoder and is valid only until the
3741 * next call to this function or until closing or flushing the
3742 * decoder. The caller may not write to it.
3744 * @param[in] avpkt The input AVpacket containing the input buffer.
3745 * You can create such packet with av_init_packet() and by then setting
3746 * data and size, some decoders might in addition need other fields like
3747 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3749 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3750 * @return On error a negative value is returned, otherwise the number of bytes
3751 * used or zero if no frame could be decompressed.
3753 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3754 int *got_picture_ptr,
3758 * Decode a subtitle message.
3759 * Return a negative value on error, otherwise return the number of bytes used.
3760 * If no subtitle could be decompressed, got_sub_ptr is zero.
3761 * Otherwise, the subtitle is stored in *sub.
3762 * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3763 * simplicity, because the performance difference is expect to be negligible
3764 * and reusing a get_buffer written for video codecs would probably perform badly
3765 * due to a potentially very different allocation pattern.
3767 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3768 * before packets may be fed to the decoder.
3770 * @param avctx the codec context
3771 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3772 freed with avsubtitle_free if *got_sub_ptr is set.
3773 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3774 * @param[in] avpkt The input AVPacket containing the input buffer.
3776 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3781 * @defgroup lavc_parsing Frame parsing
3785 enum AVPictureStructure {
3786 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3787 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3788 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3789 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3792 typedef struct AVCodecParserContext {
3794 struct AVCodecParser *parser;
3795 int64_t frame_offset; /* offset of the current frame */
3796 int64_t cur_offset; /* current offset
3797 (incremented by each av_parser_parse()) */
3798 int64_t next_frame_offset; /* offset of the next frame */
3800 int pict_type; /* XXX: Put it back in AVCodecContext. */
3802 * This field is used for proper frame duration computation in lavf.
3803 * It signals, how much longer the frame duration of the current frame
3804 * is compared to normal frame duration.
3806 * frame_duration = (1 + repeat_pict) * time_base
3808 * It is used by codecs like H.264 to display telecined material.
3810 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3811 int64_t pts; /* pts of the current frame */
3812 int64_t dts; /* dts of the current frame */
3817 int fetch_timestamp;
3819 #define AV_PARSER_PTS_NB 4
3820 int cur_frame_start_index;
3821 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3822 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3823 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3826 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3827 #define PARSER_FLAG_ONCE 0x0002
3828 /// Set if the parser has a valid file offset
3829 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3831 int64_t offset; ///< byte offset from starting packet start
3832 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3835 * Set by parser to 1 for key frames and 0 for non-key frames.
3836 * It is initialized to -1, so if the parser doesn't set this flag,
3837 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3843 * Time difference in stream time base units from the pts of this
3844 * packet to the point at which the output from the decoder has converged
3845 * independent from the availability of previous frames. That is, the
3846 * frames are virtually identical no matter if decoding started from
3847 * the very first frame or from this keyframe.
3848 * Is AV_NOPTS_VALUE if unknown.
3849 * This field is not the display duration of the current frame.
3850 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3853 * The purpose of this field is to allow seeking in streams that have no
3854 * keyframes in the conventional sense. It corresponds to the
3855 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3856 * essential for some types of subtitle streams to ensure that all
3857 * subtitles are correctly displayed after seeking.
3859 int64_t convergence_duration;
3861 // Timestamp generation support:
3863 * Synchronization point for start of timestamp generation.
3865 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3868 * For example, this corresponds to presence of H.264 buffering period
3874 * Offset of the current timestamp against last timestamp sync point in
3875 * units of AVCodecContext.time_base.
3877 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3878 * contain a valid timestamp offset.
3880 * Note that the timestamp of sync point has usually a nonzero
3881 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3882 * the next frame after timestamp sync point will be usually 1.
3884 * For example, this corresponds to H.264 cpb_removal_delay.
3886 int dts_ref_dts_delta;
3889 * Presentation delay of current frame in units of AVCodecContext.time_base.
3891 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3892 * contain valid non-negative timestamp delta (presentation time of a frame
3893 * must not lie in the past).
3895 * This delay represents the difference between decoding and presentation
3896 * time of the frame.
3898 * For example, this corresponds to H.264 dpb_output_delay.
3903 * Position of the packet in file.
3905 * Analogous to cur_frame_pts/dts
3907 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3910 * Byte position of currently parsed frame in stream.
3915 * Previous frame byte position.
3920 * Duration of the current frame.
3921 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3922 * For all other types, this is in units of AVCodecContext.time_base.
3926 enum AVFieldOrder field_order;
3929 * Indicate whether a picture is coded as a frame, top field or bottom field.
3931 * For example, H.264 field_pic_flag equal to 0 corresponds to
3932 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3933 * equal to 1 and bottom_field_flag equal to 0 corresponds to
3934 * AV_PICTURE_STRUCTURE_TOP_FIELD.
3936 enum AVPictureStructure picture_structure;
3939 * Picture number incremented in presentation or output order.
3940 * This field may be reinitialized at the first picture of a new sequence.
3942 * For example, this corresponds to H.264 PicOrderCnt.
3944 int output_picture_number;
3947 * Dimensions of the decoded video intended for presentation.
3953 * Dimensions of the coded video.
3959 * The format of the coded data, corresponds to enum AVPixelFormat for video
3960 * and for enum AVSampleFormat for audio.
3962 * Note that a decoder can have considerable freedom in how exactly it
3963 * decodes the data, so the format reported here might be different from the
3964 * one returned by a decoder.
3967 } AVCodecParserContext;
3969 typedef struct AVCodecParser {
3970 int codec_ids[5]; /* several codec IDs are permitted */
3972 int (*parser_init)(AVCodecParserContext *s);
3973 /* This callback never returns an error, a negative value means that
3974 * the frame start was in a previous packet. */
3975 int (*parser_parse)(AVCodecParserContext *s,
3976 AVCodecContext *avctx,
3977 const uint8_t **poutbuf, int *poutbuf_size,
3978 const uint8_t *buf, int buf_size);
3979 void (*parser_close)(AVCodecParserContext *s);
3980 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3981 struct AVCodecParser *next;
3984 AVCodecParser *av_parser_next(const AVCodecParser *c);
3986 void av_register_codec_parser(AVCodecParser *parser);
3987 AVCodecParserContext *av_parser_init(int codec_id);
3992 * @param s parser context.
3993 * @param avctx codec context.
3994 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3995 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3996 * @param buf input buffer.
3997 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3998 * @param pts input presentation timestamp.
3999 * @param dts input decoding timestamp.
4000 * @param pos input byte position in stream.
4001 * @return the number of bytes of the input bitstream used.
4006 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4013 * decode_frame(data, size);
4017 int av_parser_parse2(AVCodecParserContext *s,
4018 AVCodecContext *avctx,
4019 uint8_t **poutbuf, int *poutbuf_size,
4020 const uint8_t *buf, int buf_size,
4021 int64_t pts, int64_t dts,
4025 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4026 * @deprecated use AVBitstreamFilter
4028 int av_parser_change(AVCodecParserContext *s,
4029 AVCodecContext *avctx,
4030 uint8_t **poutbuf, int *poutbuf_size,
4031 const uint8_t *buf, int buf_size, int keyframe);
4032 void av_parser_close(AVCodecParserContext *s);
4040 * @addtogroup lavc_encoding
4045 * Find a registered encoder with a matching codec ID.
4047 * @param id AVCodecID of the requested encoder
4048 * @return An encoder if one was found, NULL otherwise.
4050 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4053 * Find a registered encoder with the specified name.
4055 * @param name name of the requested encoder
4056 * @return An encoder if one was found, NULL otherwise.
4058 AVCodec *avcodec_find_encoder_by_name(const char *name);
4061 * Encode a frame of audio.
4063 * Takes input samples from frame and writes the next output packet, if
4064 * available, to avpkt. The output packet does not necessarily contain data for
4065 * the most recent frame, as encoders can delay, split, and combine input frames
4066 * internally as needed.
4068 * @param avctx codec context
4069 * @param avpkt output AVPacket.
4070 * The user can supply an output buffer by setting
4071 * avpkt->data and avpkt->size prior to calling the
4072 * function, but if the size of the user-provided data is not
4073 * large enough, encoding will fail. All other AVPacket fields
4074 * will be reset by the encoder using av_init_packet(). If
4075 * avpkt->data is NULL, the encoder will allocate it.
4076 * The encoder will set avpkt->size to the size of the
4079 * If this function fails or produces no output, avpkt will be
4080 * freed using av_free_packet() (i.e. avpkt->destruct will be
4081 * called to free the user supplied buffer).
4082 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4083 * May be NULL when flushing an encoder that has the
4084 * AV_CODEC_CAP_DELAY capability set.
4085 * If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4086 * can have any number of samples.
4087 * If it is not set, frame->nb_samples must be equal to
4088 * avctx->frame_size for all frames except the last.
4089 * The final frame may be smaller than avctx->frame_size.
4090 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4091 * output packet is non-empty, and to 0 if it is
4092 * empty. If the function returns an error, the
4093 * packet can be assumed to be invalid, and the
4094 * value of got_packet_ptr is undefined and should
4096 * @return 0 on success, negative error code on failure
4098 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4099 const AVFrame *frame, int *got_packet_ptr);
4102 * Encode a frame of video.
4104 * Takes input raw video data from frame and writes the next output packet, if
4105 * available, to avpkt. The output packet does not necessarily contain data for
4106 * the most recent frame, as encoders can delay and reorder input frames
4107 * internally as needed.
4109 * @param avctx codec context
4110 * @param avpkt output AVPacket.
4111 * The user can supply an output buffer by setting
4112 * avpkt->data and avpkt->size prior to calling the
4113 * function, but if the size of the user-provided data is not
4114 * large enough, encoding will fail. All other AVPacket fields
4115 * will be reset by the encoder using av_init_packet(). If
4116 * avpkt->data is NULL, the encoder will allocate it.
4117 * The encoder will set avpkt->size to the size of the
4118 * output packet. The returned data (if any) belongs to the
4119 * caller, he is responsible for freeing it.
4121 * If this function fails or produces no output, avpkt will be
4122 * freed using av_free_packet() (i.e. avpkt->destruct will be
4123 * called to free the user supplied buffer).
4124 * @param[in] frame AVFrame containing the raw video data to be encoded.
4125 * May be NULL when flushing an encoder that has the
4126 * AV_CODEC_CAP_DELAY capability set.
4127 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4128 * output packet is non-empty, and to 0 if it is
4129 * empty. If the function returns an error, the
4130 * packet can be assumed to be invalid, and the
4131 * value of got_packet_ptr is undefined and should
4133 * @return 0 on success, negative error code on failure
4135 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4136 const AVFrame *frame, int *got_packet_ptr);
4138 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4139 const AVSubtitle *sub);
4147 * @addtogroup lavc_picture
4152 * Allocate memory for a picture. Call avpicture_free() to free it.
4154 * @see avpicture_fill()
4156 * @param picture the picture to be filled in
4157 * @param pix_fmt the format of the picture
4158 * @param width the width of the picture
4159 * @param height the height of the picture
4160 * @return zero if successful, a negative value if not
4162 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4165 * Free a picture previously allocated by avpicture_alloc().
4166 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4169 * @param picture the AVPicture to be freed
4171 void avpicture_free(AVPicture *picture);
4174 * Fill in the AVPicture fields, always assume a linesize alignment of 1.
4176 * @see av_image_fill_arrays().
4178 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4179 enum AVPixelFormat pix_fmt, int width, int height);
4182 * Copy pixel data from an AVPicture into a buffer, always assume a
4183 * linesize alignment of 1.
4185 * @see av_image_copy_to_buffer().
4187 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4188 int width, int height,
4189 unsigned char *dest, int dest_size);
4192 * Calculate the size in bytes that a picture of the given width and height
4193 * would occupy if stored in the given picture format.
4194 * Always assume a linesize alignment of 1.
4196 * @see av_image_get_buffer_size().
4198 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4201 * Copy image src to dst. Wraps av_picture_data_copy() above.
4203 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4204 enum AVPixelFormat pix_fmt, int width, int height);
4207 * Crop image top and left side.
4209 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4210 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4215 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4216 int padtop, int padbottom, int padleft, int padright, int *color);
4223 * @defgroup lavc_misc Utility functions
4226 * Miscellaneous utility functions related to both encoding and decoding
4232 * @defgroup lavc_misc_pixfmt Pixel formats
4234 * Functions for working with pixel formats.
4239 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4242 void attribute_deprecated avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4245 * Return a value representing the fourCC code associated to the
4246 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4249 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4251 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4252 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4253 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4254 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4255 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4256 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4259 * Compute what kind of losses will occur when converting from one specific
4260 * pixel format to another.
4261 * When converting from one pixel format to another, information loss may occur.
4262 * For example, when converting from RGB24 to GRAY, the color information will
4263 * be lost. Similarly, other losses occur when converting from some formats to
4264 * other formats. These losses can involve loss of chroma, but also loss of
4265 * resolution, loss of color depth, loss due to the color space conversion, loss
4266 * of the alpha bits or loss due to color quantization.
4267 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4268 * which will occur when converting from one pixel format to another.
4270 * @param[in] dst_pix_fmt destination pixel format
4271 * @param[in] src_pix_fmt source pixel format
4272 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4273 * @return Combination of flags informing you what kind of losses will occur.
4275 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4279 * Find the best pixel format to convert to given a certain source pixel
4280 * format. When converting from one pixel format to another, information loss
4281 * may occur. For example, when converting from RGB24 to GRAY, the color
4282 * information will be lost. Similarly, other losses occur when converting from
4283 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4284 * the given pixel formats should be used to suffer the least amount of loss.
4285 * The pixel formats from which it chooses one, are determined by the
4286 * pix_fmt_list parameter.
4289 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4290 * @param[in] src_pix_fmt source pixel format
4291 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4292 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4293 * @return The best pixel format to convert to or -1 if none was found.
4295 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4296 enum AVPixelFormat src_pix_fmt,
4297 int has_alpha, int *loss_ptr);
4299 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4305 #if FF_API_SET_DIMENSIONS
4307 * @deprecated this function is not supposed to be used from outside of lavc
4309 attribute_deprecated
4310 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4314 * Put a string representing the codec tag codec_tag in buf.
4316 * @param buf buffer to place codec tag in
4317 * @param buf_size size in bytes of buf
4318 * @param codec_tag codec tag to assign
4319 * @return the length of the string that would have been generated if
4320 * enough space had been available, excluding the trailing null
4322 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4324 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4327 * Return a name for the specified profile, if available.
4329 * @param codec the codec that is searched for the given profile
4330 * @param profile the profile value for which a name is requested
4331 * @return A name for the profile if found, NULL otherwise.
4333 const char *av_get_profile_name(const AVCodec *codec, int profile);
4335 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4336 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4337 //FIXME func typedef
4340 * Fill audio frame data and linesize.
4341 * AVFrame extended_data channel pointers are allocated if necessary for
4344 * @param frame the AVFrame
4345 * frame->nb_samples must be set prior to calling the
4346 * function. This function fills in frame->data,
4347 * frame->extended_data, frame->linesize[0].
4348 * @param nb_channels channel count
4349 * @param sample_fmt sample format
4350 * @param buf buffer to use for frame data
4351 * @param buf_size size of buffer
4352 * @param align plane size sample alignment (0 = default)
4353 * @return 0 on success, negative error code on failure
4355 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4356 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4357 int buf_size, int align);
4360 * Reset the internal decoder state / flush internal buffers. Should be called
4361 * e.g. when seeking or when switching to a different stream.
4363 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4364 * this invalidates the frames previously returned from the decoder. When
4365 * refcounted frames are used, the decoder just releases any references it might
4366 * keep internally, but the caller's reference remains valid.
4368 void avcodec_flush_buffers(AVCodecContext *avctx);
4371 * Return codec bits per sample.
4373 * @param[in] codec_id the codec
4374 * @return Number of bits per sample or zero if unknown for the given codec.
4376 int av_get_bits_per_sample(enum AVCodecID codec_id);
4379 * Return codec bits per sample.
4380 * Only return non-zero if the bits per sample is exactly correct, not an
4383 * @param[in] codec_id the codec
4384 * @return Number of bits per sample or zero if unknown for the given codec.
4386 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4389 * Return audio frame duration.
4391 * @param avctx codec context
4392 * @param frame_bytes size of the frame, or 0 if unknown
4393 * @return frame duration, in samples, if known. 0 if not able to
4396 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4399 typedef struct AVBitStreamFilterContext {
4401 struct AVBitStreamFilter *filter;
4402 AVCodecParserContext *parser;
4403 struct AVBitStreamFilterContext *next;
4404 } AVBitStreamFilterContext;
4407 typedef struct AVBitStreamFilter {
4410 int (*filter)(AVBitStreamFilterContext *bsfc,
4411 AVCodecContext *avctx, const char *args,
4412 uint8_t **poutbuf, int *poutbuf_size,
4413 const uint8_t *buf, int buf_size, int keyframe);
4414 void (*close)(AVBitStreamFilterContext *bsfc);
4415 struct AVBitStreamFilter *next;
4416 } AVBitStreamFilter;
4418 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4419 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4420 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4421 AVCodecContext *avctx, const char *args,
4422 uint8_t **poutbuf, int *poutbuf_size,
4423 const uint8_t *buf, int buf_size, int keyframe);
4424 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4426 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
4431 * Allocate a buffer with padding, reusing the given one if large enough.
4433 * Same behaviour av_fast_malloc but the buffer has additional
4434 * AV_INPUT_PADDING_SIZE at the end which will always memset to 0.
4437 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4440 * Encode extradata length to a buffer. Used by xiph codecs.
4442 * @param s buffer to write to; must be at least (v/255+1) bytes long
4443 * @param v size of extradata in bytes
4444 * @return number of bytes written to the buffer.
4446 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4448 #if FF_API_MISSING_SAMPLE
4450 * Log a generic warning message about a missing feature. This function is
4451 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4452 * only, and would normally not be used by applications.
4453 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4454 * a pointer to an AVClass struct
4455 * @param[in] feature string containing the name of the missing feature
4456 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4457 * If want_sample is non-zero, additional verbage will be added to the log
4458 * message which tells the user how to report samples to the development
4460 * @deprecated Use avpriv_report_missing_feature() instead.
4462 attribute_deprecated
4463 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4466 * Log a generic warning message asking for a sample. This function is
4467 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4468 * only, and would normally not be used by applications.
4469 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4470 * a pointer to an AVClass struct
4471 * @param[in] msg string containing an optional message, or NULL if no message
4472 * @deprecated Use avpriv_request_sample() instead.
4474 attribute_deprecated
4475 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4476 #endif /* FF_API_MISSING_SAMPLE */
4479 * Register the hardware accelerator hwaccel.
4481 void av_register_hwaccel(AVHWAccel *hwaccel);
4484 * If hwaccel is NULL, returns the first registered hardware accelerator,
4485 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4486 * after hwaccel, or NULL if hwaccel is the last one.
4488 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
4492 * Lock operation used by lockmgr
4495 AV_LOCK_CREATE, ///< Create a mutex
4496 AV_LOCK_OBTAIN, ///< Lock the mutex
4497 AV_LOCK_RELEASE, ///< Unlock the mutex
4498 AV_LOCK_DESTROY, ///< Free mutex resources
4502 * Register a user provided lock manager supporting the operations
4503 * specified by AVLockOp. The "mutex" argument to the function points
4504 * to a (void *) where the lockmgr should store/get a pointer to a user
4505 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
4506 * value left by the last call for all other ops. If the lock manager is
4507 * unable to perform the op then it should leave the mutex in the same
4508 * state as when it was called and return a non-zero value. However,
4509 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
4510 * have been successfully destroyed. If av_lockmgr_register succeeds
4511 * it will return a non-negative value, if it fails it will return a
4512 * negative value and destroy all mutex and unregister all callbacks.
4513 * av_lockmgr_register is not thread-safe, it must be called from a
4514 * single thread before any calls which make use of locking are used.
4516 * @param cb User defined callback. av_lockmgr_register invokes calls
4517 * to this callback and the previously registered callback.
4518 * The callback will be used to create more than one mutex
4519 * each of which must be backed by its own underlying locking
4520 * mechanism (i.e. do not use a single static object to
4521 * implement your lock manager). If cb is set to NULL the
4522 * lockmgr will be unregistered.
4524 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4527 * Get the type of the given codec.
4529 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4532 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4533 * with no corresponding avcodec_close()), 0 otherwise.
4535 int avcodec_is_open(AVCodecContext *s);
4538 * @return a non-zero number if codec is an encoder, zero otherwise
4540 int av_codec_is_encoder(const AVCodec *codec);
4543 * @return a non-zero number if codec is a decoder, zero otherwise
4545 int av_codec_is_decoder(const AVCodec *codec);
4548 * @return descriptor for given codec ID or NULL if no descriptor exists.
4550 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4553 * Iterate over all codec descriptors known to libavcodec.
4555 * @param prev previous descriptor. NULL to get the first descriptor.
4557 * @return next descriptor or NULL after the last descriptor
4559 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4562 * @return codec descriptor with the given name or NULL if no such descriptor
4565 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4571 #endif /* AVCODEC_AVCODEC_H */