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,
297 /* various PCM "codecs" */
298 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
299 AV_CODEC_ID_PCM_S16LE = 0x10000,
300 AV_CODEC_ID_PCM_S16BE,
301 AV_CODEC_ID_PCM_U16LE,
302 AV_CODEC_ID_PCM_U16BE,
305 AV_CODEC_ID_PCM_MULAW,
306 AV_CODEC_ID_PCM_ALAW,
307 AV_CODEC_ID_PCM_S32LE,
308 AV_CODEC_ID_PCM_S32BE,
309 AV_CODEC_ID_PCM_U32LE,
310 AV_CODEC_ID_PCM_U32BE,
311 AV_CODEC_ID_PCM_S24LE,
312 AV_CODEC_ID_PCM_S24BE,
313 AV_CODEC_ID_PCM_U24LE,
314 AV_CODEC_ID_PCM_U24BE,
315 AV_CODEC_ID_PCM_S24DAUD,
316 AV_CODEC_ID_PCM_ZORK,
317 AV_CODEC_ID_PCM_S16LE_PLANAR,
319 AV_CODEC_ID_PCM_F32BE,
320 AV_CODEC_ID_PCM_F32LE,
321 AV_CODEC_ID_PCM_F64BE,
322 AV_CODEC_ID_PCM_F64LE,
323 AV_CODEC_ID_PCM_BLURAY,
326 AV_CODEC_ID_PCM_S8_PLANAR,
327 AV_CODEC_ID_PCM_S24LE_PLANAR,
328 AV_CODEC_ID_PCM_S32LE_PLANAR,
330 /* various ADPCM codecs */
331 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
332 AV_CODEC_ID_ADPCM_IMA_WAV,
333 AV_CODEC_ID_ADPCM_IMA_DK3,
334 AV_CODEC_ID_ADPCM_IMA_DK4,
335 AV_CODEC_ID_ADPCM_IMA_WS,
336 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
337 AV_CODEC_ID_ADPCM_MS,
338 AV_CODEC_ID_ADPCM_4XM,
339 AV_CODEC_ID_ADPCM_XA,
340 AV_CODEC_ID_ADPCM_ADX,
341 AV_CODEC_ID_ADPCM_EA,
342 AV_CODEC_ID_ADPCM_G726,
343 AV_CODEC_ID_ADPCM_CT,
344 AV_CODEC_ID_ADPCM_SWF,
345 AV_CODEC_ID_ADPCM_YAMAHA,
346 AV_CODEC_ID_ADPCM_SBPRO_4,
347 AV_CODEC_ID_ADPCM_SBPRO_3,
348 AV_CODEC_ID_ADPCM_SBPRO_2,
349 AV_CODEC_ID_ADPCM_THP,
350 AV_CODEC_ID_ADPCM_IMA_AMV,
351 AV_CODEC_ID_ADPCM_EA_R1,
352 AV_CODEC_ID_ADPCM_EA_R3,
353 AV_CODEC_ID_ADPCM_EA_R2,
354 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
355 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
356 AV_CODEC_ID_ADPCM_EA_XAS,
357 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
358 AV_CODEC_ID_ADPCM_IMA_ISS,
359 AV_CODEC_ID_ADPCM_G722,
360 AV_CODEC_ID_ADPCM_IMA_APC,
361 AV_CODEC_ID_ADPCM_VIMA,
364 AV_CODEC_ID_AMR_NB = 0x12000,
367 /* RealAudio codecs*/
368 AV_CODEC_ID_RA_144 = 0x13000,
371 /* various DPCM codecs */
372 AV_CODEC_ID_ROQ_DPCM = 0x14000,
373 AV_CODEC_ID_INTERPLAY_DPCM,
374 AV_CODEC_ID_XAN_DPCM,
375 AV_CODEC_ID_SOL_DPCM,
378 AV_CODEC_ID_MP2 = 0x15000,
379 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
389 AV_CODEC_ID_VMDAUDIO,
395 AV_CODEC_ID_WESTWOOD_SND1,
396 AV_CODEC_ID_GSM, ///< as in Berlin toast format
399 AV_CODEC_ID_TRUESPEECH,
401 AV_CODEC_ID_SMACKAUDIO,
404 AV_CODEC_ID_DSICINAUDIO,
406 AV_CODEC_ID_MUSEPACK7,
408 AV_CODEC_ID_GSM_MS, /* as found in WAV */
414 AV_CODEC_ID_NELLYMOSER,
415 AV_CODEC_ID_MUSEPACK8,
417 AV_CODEC_ID_WMAVOICE,
419 AV_CODEC_ID_WMALOSSLESS,
428 AV_CODEC_ID_BINKAUDIO_RDFT,
429 AV_CODEC_ID_BINKAUDIO_DCT,
430 AV_CODEC_ID_AAC_LATM,
435 AV_CODEC_ID_8SVX_EXP,
436 AV_CODEC_ID_8SVX_FIB,
437 AV_CODEC_ID_BMV_AUDIO,
442 AV_CODEC_ID_COMFORT_NOISE,
444 AV_CODEC_ID_METASOUND,
445 AV_CODEC_ID_PAF_AUDIO,
448 /* subtitle codecs */
449 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
450 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
451 AV_CODEC_ID_DVB_SUBTITLE,
452 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
455 AV_CODEC_ID_MOV_TEXT,
456 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
457 AV_CODEC_ID_DVB_TELETEXT,
460 /* other specific kind of codecs (generally used for attachments) */
461 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
462 AV_CODEC_ID_TTF = 0x18000,
464 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
466 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
467 * stream (only used by libavformat) */
468 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
469 * stream (only used by libavformat) */
470 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
474 * This struct describes the properties of a single codec described by an
476 * @see avcodec_descriptor_get()
478 typedef struct AVCodecDescriptor {
480 enum AVMediaType type;
482 * Name of the codec described by this descriptor. It is non-empty and
483 * unique for each codec descriptor. It should contain alphanumeric
484 * characters and '_' only.
488 * A more descriptive name for this codec. May be NULL.
490 const char *long_name;
492 * Codec properties, a combination of AV_CODEC_PROP_* flags.
498 * Codec uses only intra compression.
501 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
503 * Codec supports lossy compression. Audio and video codecs only.
504 * @note a codec may support both lossy and lossless
507 #define AV_CODEC_PROP_LOSSY (1 << 1)
509 * Codec supports lossless compression. Audio and video codecs only.
511 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
513 * Codec supports frame reordering. That is, the coded order (the order in which
514 * the encoded packets are output by the encoders / stored / input to the
515 * decoders) may be different from the presentation order of the corresponding
518 * For codecs that do not have this property set, PTS and DTS should always be
521 #define AV_CODEC_PROP_REORDER (1 << 3)
524 * @ingroup lavc_decoding
525 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
526 * This is mainly needed because some optimized bitstream readers read
527 * 32 or 64 bit at once and could read over the end.<br>
528 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
529 * MPEG bitstreams could cause overread and segfault.
531 #define FF_INPUT_BUFFER_PADDING_SIZE 8
534 * @ingroup lavc_encoding
535 * minimum encoding buffer size
536 * Used to avoid some checks during header writing.
538 #define FF_MIN_BUFFER_SIZE 16384
542 * @ingroup lavc_encoding
543 * motion estimation type.
546 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
550 ME_EPZS, ///< enhanced predictive zonal search
551 ME_X1, ///< reserved for experiments
552 ME_HEX, ///< hexagon based search
553 ME_UMH, ///< uneven multi-hexagon search
554 ME_TESA, ///< transformed exhaustive search algorithm
558 * @ingroup lavc_decoding
561 /* We leave some space between them for extensions (drop some
562 * keyframes for intra-only or drop just some bidir frames). */
563 AVDISCARD_NONE =-16, ///< discard nothing
564 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
565 AVDISCARD_NONREF = 8, ///< discard all non reference
566 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
567 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
568 AVDISCARD_ALL = 48, ///< discard all
571 enum AVAudioServiceType {
572 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
573 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
574 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
575 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
576 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
577 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
578 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
579 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
580 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
581 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
585 * @ingroup lavc_encoding
587 typedef struct RcOverride{
590 int qscale; // If this is 0 then quality_factor will be used instead.
591 float quality_factor;
594 #if FF_API_MAX_BFRAMES
596 * @deprecated there is no libavcodec-wide limit on the number of B-frames
598 #define FF_MAX_B_FRAMES 16
602 These flags can be passed in AVCodecContext.flags before initialization.
603 Note: Not everything is supported yet.
607 * Allow decoders to produce frames with data planes that are not aligned
608 * to CPU requirements (e.g. due to cropping).
610 #define CODEC_FLAG_UNALIGNED 0x0001
611 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
612 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
613 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
614 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
617 * @deprecated use the "gmc" private option of the libxvid encoder
619 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
623 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
626 #define CODEC_FLAG_MV0 0x0040
628 #if FF_API_INPUT_PRESERVED
630 * @deprecated passing reference-counted frames to the encoders replaces this
633 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
635 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
636 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
637 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
640 * @deprecated edges are not used/required anymore. I.e. this flag is now always
643 #define CODEC_FLAG_EMU_EDGE 0x4000
645 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
646 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
647 location instead of only at frame boundaries. */
648 #if FF_API_NORMALIZE_AQP
650 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
653 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
655 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
656 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
657 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
658 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
659 /* Fx : Flag for h263+ extra options */
660 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
661 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
662 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
663 #define CODEC_FLAG_CLOSED_GOP 0x80000000
664 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
665 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
666 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
667 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
669 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
671 /* Unsupported options :
672 * Syntax Arithmetic coding (SAC)
673 * Reference Picture Selection
674 * Independent Segment Decoding */
676 /* codec capabilities */
678 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
680 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
681 * If not set, it might not use get_buffer() at all or use operations that
682 * assume the buffer was allocated by avcodec_default_get_buffer.
684 #define CODEC_CAP_DR1 0x0002
685 #define CODEC_CAP_TRUNCATED 0x0008
687 /* Codec can export data for HW decoding (XvMC). */
688 #define CODEC_CAP_HWACCEL 0x0010
689 #endif /* FF_API_XVMC */
691 * Encoder or decoder requires flushing with NULL input at the end in order to
692 * give the complete and correct output.
694 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
695 * with NULL data. The user can still send NULL data to the public encode
696 * or decode function, but libavcodec will not pass it along to the codec
697 * unless this flag is set.
700 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
701 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
705 * The encoder needs to be fed with NULL data at the end of encoding until the
706 * encoder no longer returns data.
708 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
709 * flag also means that the encoder must set the pts and duration for
710 * each output packet. If this flag is not set, the pts and duration will
711 * be determined by libavcodec from the input frame.
713 #define CODEC_CAP_DELAY 0x0020
715 * Codec can be fed a final frame with a smaller size.
716 * This can be used to prevent truncation of the last audio samples.
718 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
721 * Codec can export data for HW decoding (VDPAU).
723 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
726 * Codec can output multiple frames per AVPacket
727 * Normally demuxers return one frame at a time, demuxers which do not do
728 * are connected to a parser to split what they return into proper frames.
729 * This flag is reserved to the very rare category of codecs which have a
730 * bitstream that cannot be split into frames without timeconsuming
731 * operations like full decoding. Demuxers carring such bitstreams thus
732 * may return multiple frames in a packet. This has many disadvantages like
733 * prohibiting stream copy in many cases thus it should only be considered
736 #define CODEC_CAP_SUBFRAMES 0x0100
738 * Codec is experimental and is thus avoided in favor of non experimental
741 #define CODEC_CAP_EXPERIMENTAL 0x0200
743 * Codec should fill in channel configuration and samplerate instead of container
745 #define CODEC_CAP_CHANNEL_CONF 0x0400
746 #if FF_API_NEG_LINESIZES
748 * @deprecated no codecs use this capability
750 #define CODEC_CAP_NEG_LINESIZES 0x0800
753 * Codec supports frame-level multithreading.
755 #define CODEC_CAP_FRAME_THREADS 0x1000
757 * Codec supports slice-based (or partition-based) multithreading.
759 #define CODEC_CAP_SLICE_THREADS 0x2000
761 * Codec supports changed parameters at any point.
763 #define CODEC_CAP_PARAM_CHANGE 0x4000
765 * Codec supports avctx->thread_count == 0 (auto).
767 #define CODEC_CAP_AUTO_THREADS 0x8000
769 * Audio encoder supports receiving a different number of samples in each call.
771 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
774 //The following defines may change, don't expect compatibility if you use them.
775 #define MB_TYPE_INTRA4x4 0x0001
776 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
777 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
778 #define MB_TYPE_16x16 0x0008
779 #define MB_TYPE_16x8 0x0010
780 #define MB_TYPE_8x16 0x0020
781 #define MB_TYPE_8x8 0x0040
782 #define MB_TYPE_INTERLACED 0x0080
783 #define MB_TYPE_DIRECT2 0x0100 //FIXME
784 #define MB_TYPE_ACPRED 0x0200
785 #define MB_TYPE_GMC 0x0400
786 #define MB_TYPE_SKIP 0x0800
787 #define MB_TYPE_P0L0 0x1000
788 #define MB_TYPE_P1L0 0x2000
789 #define MB_TYPE_P0L1 0x4000
790 #define MB_TYPE_P1L1 0x8000
791 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
792 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
793 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
794 #define MB_TYPE_QUANT 0x00010000
795 #define MB_TYPE_CBP 0x00020000
796 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
801 * This specifies the area which should be displayed.
802 * Note there may be multiple such areas for one frame.
804 typedef struct AVPanScan{
807 * - encoding: Set by user.
808 * - decoding: Set by libavcodec.
813 * width and height in 1/16 pel
814 * - encoding: Set by user.
815 * - decoding: Set by libavcodec.
821 * position of the top left corner in 1/16 pel for up to 3 fields/frames
822 * - encoding: Set by user.
823 * - decoding: Set by libavcodec.
825 int16_t position[3][2];
828 #if FF_API_QSCALE_TYPE
829 #define FF_QSCALE_TYPE_MPEG1 0
830 #define FF_QSCALE_TYPE_MPEG2 1
831 #define FF_QSCALE_TYPE_H264 2
832 #define FF_QSCALE_TYPE_VP56 3
835 #if FF_API_GET_BUFFER
836 #define FF_BUFFER_TYPE_INTERNAL 1
837 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
838 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
839 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
841 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
842 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
843 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
844 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
848 * The decoder will keep a reference to the frame and may reuse it later.
850 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
853 * @defgroup lavc_packet AVPacket
855 * Types and functions for working with AVPacket.
858 enum AVPacketSideDataType {
860 AV_PKT_DATA_NEW_EXTRADATA,
863 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
866 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
867 * s32le channel_count
868 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
869 * u64le channel_layout
870 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
872 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
877 AV_PKT_DATA_PARAM_CHANGE,
880 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
881 * structures with info about macroblocks relevant to splitting the
882 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
883 * That is, it does not necessarily contain info about all macroblocks,
884 * as long as the distance between macroblocks in the info is smaller
885 * than the target payload size.
886 * Each MB info structure is 12 bytes, and is laid out as follows:
888 * u32le bit offset from the start of the packet
889 * u8 current quantizer at the start of the macroblock
891 * u16le macroblock address within the GOB
892 * u8 horizontal MV predictor
893 * u8 vertical MV predictor
894 * u8 horizontal MV predictor for block number 3
895 * u8 vertical MV predictor for block number 3
898 AV_PKT_DATA_H263_MB_INFO,
901 * This side data should be associated with an audio stream and contains
902 * ReplayGain information in form of the AVReplayGain struct.
904 AV_PKT_DATA_REPLAYGAIN,
907 * This side data contains a 3x3 transformation matrix describing an affine
908 * transformation that needs to be applied to the decoded video frames for
909 * correct presentation.
911 * See libavutil/display.h for a detailed description of the data.
913 AV_PKT_DATA_DISPLAYMATRIX,
916 * This side data should be associated with a video stream and contains
917 * Stereoscopic 3D information in form of the AVStereo3D struct.
919 AV_PKT_DATA_STEREO3D,
922 typedef struct AVPacketSideData {
925 enum AVPacketSideDataType type;
929 * This structure stores compressed data. It is typically exported by demuxers
930 * and then passed as input to decoders, or received as output from encoders and
931 * then passed to muxers.
933 * For video, it should typically contain one compressed frame. For audio it may
934 * contain several compressed frames.
936 * AVPacket is one of the few structs in Libav, whose size is a part of public
937 * ABI. Thus it may be allocated on stack and no new fields can be added to it
938 * without libavcodec and libavformat major bump.
940 * The semantics of data ownership depends on the buf or destruct (deprecated)
941 * fields. If either is set, the packet data is dynamically allocated and is
942 * valid indefinitely until av_free_packet() is called (which in turn calls
943 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
944 * the packet data is typically backed by some static buffer somewhere and is
945 * only valid for a limited time (e.g. until the next read call when demuxing).
947 * The side data is always allocated with av_malloc() and is freed in
950 typedef struct AVPacket {
952 * A reference to the reference-counted buffer where the packet data is
954 * May be NULL, then the packet data is not reference-counted.
958 * Presentation timestamp in AVStream->time_base units; the time at which
959 * the decompressed packet will be presented to the user.
960 * Can be AV_NOPTS_VALUE if it is not stored in the file.
961 * pts MUST be larger or equal to dts as presentation cannot happen before
962 * decompression, unless one wants to view hex dumps. Some formats misuse
963 * the terms dts and pts/cts to mean something different. Such timestamps
964 * must be converted to true pts/dts before they are stored in AVPacket.
968 * Decompression timestamp in AVStream->time_base units; the time at which
969 * the packet is decompressed.
970 * Can be AV_NOPTS_VALUE if it is not stored in the file.
977 * A combination of AV_PKT_FLAG values
981 * Additional packet data that can be provided by the container.
982 * Packet can contain several types of side information.
984 AVPacketSideData *side_data;
988 * Duration of this packet in AVStream->time_base units, 0 if unknown.
989 * Equals next_pts - this_pts in presentation order.
992 #if FF_API_DESTRUCT_PACKET
994 void (*destruct)(struct AVPacket *);
998 int64_t pos; ///< byte position in stream, -1 if unknown
1001 * Time difference in AVStream->time_base units from the pts of this
1002 * packet to the point at which the output from the decoder has converged
1003 * independent from the availability of previous frames. That is, the
1004 * frames are virtually identical no matter if decoding started from
1005 * the very first frame or from this keyframe.
1006 * Is AV_NOPTS_VALUE if unknown.
1007 * This field is not the display duration of the current packet.
1008 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1011 * The purpose of this field is to allow seeking in streams that have no
1012 * keyframes in the conventional sense. It corresponds to the
1013 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1014 * essential for some types of subtitle streams to ensure that all
1015 * subtitles are correctly displayed after seeking.
1017 int64_t convergence_duration;
1019 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1020 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1022 enum AVSideDataParamChangeFlags {
1023 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1024 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1025 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1026 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1032 struct AVCodecInternal;
1036 AV_FIELD_PROGRESSIVE,
1037 AV_FIELD_TT, //< Top coded_first, top displayed first
1038 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1039 AV_FIELD_TB, //< Top coded first, bottom displayed first
1040 AV_FIELD_BT, //< Bottom coded first, top displayed first
1044 * main external API structure.
1045 * New fields can be added to the end with minor version bumps.
1046 * Removal, reordering and changes to existing fields require a major
1048 * sizeof(AVCodecContext) must not be used outside libav*.
1050 typedef struct AVCodecContext {
1052 * information on struct for av_log
1053 * - set by avcodec_alloc_context3
1055 const AVClass *av_class;
1056 int log_level_offset;
1058 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1059 const struct AVCodec *codec;
1060 #if FF_API_CODEC_NAME
1062 * @deprecated this field is not used for anything in libavcodec
1064 attribute_deprecated
1065 char codec_name[32];
1067 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1070 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1071 * This is used to work around some encoder bugs.
1072 * A demuxer should set this to what is stored in the field used to identify the codec.
1073 * If there are multiple such fields in a container then the demuxer should choose the one
1074 * which maximizes the information about the used codec.
1075 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1076 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1077 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1079 * - encoding: Set by user, if not then the default based on codec_id will be used.
1080 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1082 unsigned int codec_tag;
1085 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1086 * This is used to work around some encoder bugs.
1087 * - encoding: unused
1088 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1090 unsigned int stream_codec_tag;
1095 * Private context used for internal data.
1097 * Unlike priv_data, this is not codec-specific. It is used in general
1098 * libavcodec functions.
1100 struct AVCodecInternal *internal;
1103 * Private data of the user, can be used to carry app specific stuff.
1104 * - encoding: Set by user.
1105 * - decoding: Set by user.
1110 * the average bitrate
1111 * - encoding: Set by user; unused for constant quantizer encoding.
1112 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1117 * number of bits the bitstream is allowed to diverge from the reference.
1118 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1119 * - encoding: Set by user; unused for constant quantizer encoding.
1120 * - decoding: unused
1122 int bit_rate_tolerance;
1125 * Global quality for codecs which cannot change it per frame.
1126 * This should be proportional to MPEG-1/2/4 qscale.
1127 * - encoding: Set by user.
1128 * - decoding: unused
1133 * - encoding: Set by user.
1134 * - decoding: unused
1136 int compression_level;
1137 #define FF_COMPRESSION_DEFAULT -1
1141 * - encoding: Set by user.
1142 * - decoding: Set by user.
1148 * - encoding: Set by user.
1149 * - decoding: Set by user.
1154 * some codecs need / can use extradata like Huffman tables.
1155 * mjpeg: Huffman tables
1156 * rv10: additional flags
1157 * mpeg4: global headers (they can be in the bitstream or here)
1158 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1159 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1160 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1161 * - encoding: Set/allocated/freed by libavcodec.
1162 * - decoding: Set/allocated/freed by user.
1168 * This is the fundamental unit of time (in seconds) in terms
1169 * of which frame timestamps are represented. For fixed-fps content,
1170 * timebase should be 1/framerate and timestamp increments should be
1172 * - encoding: MUST be set by user.
1173 * - decoding: the use of this field for decoding is deprecated.
1174 * Use framerate instead.
1176 AVRational time_base;
1179 * For some codecs, the time base is closer to the field rate than the frame rate.
1180 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1181 * if no telecine is used ...
1183 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1185 int ticks_per_frame;
1191 * Number of frames the decoded output will be delayed relative to the
1195 * For encoding, this field is unused (see initial_padding).
1197 * For decoding, this is the number of samples the decoder needs to
1198 * output before the decoder's output is valid. When seeking, you should
1199 * start decoding this many samples prior to your desired seek point.
1201 * - encoding: Set by libavcodec.
1202 * - decoding: Set by libavcodec.
1209 * picture width / height.
1210 * - encoding: MUST be set by user.
1211 * - decoding: May be set by the user before opening the decoder if known e.g.
1212 * from the container. Some decoders will require the dimensions
1213 * to be set by the caller. During decoding, the decoder may
1214 * overwrite those values as required.
1219 * Bitstream width / height, may be different from width/height e.g. when
1220 * the decoded frame is cropped before being output.
1221 * - encoding: unused
1222 * - decoding: May be set by the user before opening the decoder if known
1223 * e.g. from the container. During decoding, the decoder may
1224 * overwrite those values as required.
1226 int coded_width, coded_height;
1228 #if FF_API_ASPECT_EXTENDED
1229 #define FF_ASPECT_EXTENDED 15
1233 * the number of pictures in a group of pictures, or 0 for intra_only
1234 * - encoding: Set by user.
1235 * - decoding: unused
1240 * Pixel format, see AV_PIX_FMT_xxx.
1241 * May be set by the demuxer if known from headers.
1242 * May be overriden by the decoder if it knows better.
1243 * - encoding: Set by user.
1244 * - decoding: Set by user if known, overridden by libavcodec if known
1246 enum AVPixelFormat pix_fmt;
1249 * Motion estimation algorithm used for video coding.
1250 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1251 * 8 (umh), 10 (tesa) [7, 8, 10 are x264 specific]
1252 * - encoding: MUST be set by user.
1253 * - decoding: unused
1258 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1259 * decoder to draw a horizontal band. It improves cache usage. Not
1260 * all codecs can do that. You must check the codec capabilities
1262 * When multithreading is used, it may be called from multiple threads
1263 * at the same time; threads might draw different parts of the same AVFrame,
1264 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1266 * The function is also used by hardware acceleration APIs.
1267 * It is called at least once during frame decoding to pass
1268 * the data needed for hardware render.
1269 * In that mode instead of pixel data, AVFrame points to
1270 * a structure specific to the acceleration API. The application
1271 * reads the structure and can change some fields to indicate progress
1273 * - encoding: unused
1274 * - decoding: Set by user.
1275 * @param height the height of the slice
1276 * @param y the y position of the slice
1277 * @param type 1->top field, 2->bottom field, 3->frame
1278 * @param offset offset into the AVFrame.data from which the slice should be read
1280 void (*draw_horiz_band)(struct AVCodecContext *s,
1281 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1282 int y, int type, int height);
1285 * callback to negotiate the pixelFormat
1286 * @param fmt is the list of formats which are supported by the codec,
1287 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1288 * The first is always the native one.
1289 * @note The callback may be called again immediately if initialization for
1290 * the selected (hardware-accelerated) pixel format failed.
1291 * @warning Behavior is undefined if the callback returns a value not
1292 * in the fmt list of formats.
1293 * @return the chosen format
1294 * - encoding: unused
1295 * - decoding: Set by user, if not set the native format will be chosen.
1297 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1300 * maximum number of B-frames between non-B-frames
1301 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1302 * - encoding: Set by user.
1303 * - decoding: unused
1308 * qscale factor between IP and B-frames
1309 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1310 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1311 * - encoding: Set by user.
1312 * - decoding: unused
1314 float b_quant_factor;
1316 /** obsolete FIXME remove */
1318 #define FF_RC_STRATEGY_XVID 1
1320 int b_frame_strategy;
1323 * qscale offset between IP and B-frames
1324 * - encoding: Set by user.
1325 * - decoding: unused
1327 float b_quant_offset;
1330 * Size of the frame reordering buffer in the decoder.
1331 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1332 * - encoding: Set by libavcodec.
1333 * - decoding: Set by libavcodec.
1338 * 0-> h263 quant 1-> mpeg quant
1339 * - encoding: Set by user.
1340 * - decoding: unused
1345 * qscale factor between P and I-frames
1346 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1347 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1348 * - encoding: Set by user.
1349 * - decoding: unused
1351 float i_quant_factor;
1354 * qscale offset between P and I-frames
1355 * - encoding: Set by user.
1356 * - decoding: unused
1358 float i_quant_offset;
1361 * luminance masking (0-> disabled)
1362 * - encoding: Set by user.
1363 * - decoding: unused
1368 * temporary complexity masking (0-> disabled)
1369 * - encoding: Set by user.
1370 * - decoding: unused
1372 float temporal_cplx_masking;
1375 * spatial complexity masking (0-> disabled)
1376 * - encoding: Set by user.
1377 * - decoding: unused
1379 float spatial_cplx_masking;
1382 * p block masking (0-> disabled)
1383 * - encoding: Set by user.
1384 * - decoding: unused
1389 * darkness masking (0-> disabled)
1390 * - encoding: Set by user.
1391 * - decoding: unused
1397 * - encoding: Set by libavcodec.
1398 * - decoding: Set by user (or 0).
1402 * prediction method (needed for huffyuv)
1403 * - encoding: Set by user.
1404 * - decoding: unused
1406 int prediction_method;
1407 #define FF_PRED_LEFT 0
1408 #define FF_PRED_PLANE 1
1409 #define FF_PRED_MEDIAN 2
1412 * slice offsets in the frame in bytes
1413 * - encoding: Set/allocated by libavcodec.
1414 * - decoding: Set/allocated by user (or NULL).
1419 * sample aspect ratio (0 if unknown)
1420 * That is the width of a pixel divided by the height of the pixel.
1421 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1422 * - encoding: Set by user.
1423 * - decoding: Set by libavcodec.
1425 AVRational sample_aspect_ratio;
1428 * motion estimation comparison function
1429 * - encoding: Set by user.
1430 * - decoding: unused
1434 * subpixel motion estimation comparison function
1435 * - encoding: Set by user.
1436 * - decoding: unused
1440 * macroblock comparison function (not supported yet)
1441 * - encoding: Set by user.
1442 * - decoding: unused
1446 * interlaced DCT comparison function
1447 * - encoding: Set by user.
1448 * - decoding: unused
1451 #define FF_CMP_SAD 0
1452 #define FF_CMP_SSE 1
1453 #define FF_CMP_SATD 2
1454 #define FF_CMP_DCT 3
1455 #define FF_CMP_PSNR 4
1456 #define FF_CMP_BIT 5
1458 #define FF_CMP_ZERO 7
1459 #define FF_CMP_VSAD 8
1460 #define FF_CMP_VSSE 9
1461 #define FF_CMP_NSSE 10
1462 #define FF_CMP_DCTMAX 13
1463 #define FF_CMP_DCT264 14
1464 #define FF_CMP_CHROMA 256
1467 * ME diamond size & shape
1468 * - encoding: Set by user.
1469 * - decoding: unused
1474 * amount of previous MV predictors (2a+1 x 2a+1 square)
1475 * - encoding: Set by user.
1476 * - decoding: unused
1478 int last_predictor_count;
1481 * prepass for motion estimation
1482 * - encoding: Set by user.
1483 * - decoding: unused
1488 * motion estimation prepass comparison function
1489 * - encoding: Set by user.
1490 * - decoding: unused
1495 * ME prepass diamond size & shape
1496 * - encoding: Set by user.
1497 * - decoding: unused
1503 * - encoding: Set by user.
1504 * - decoding: unused
1506 int me_subpel_quality;
1510 * DTG active format information (additional aspect ratio
1511 * information only used in DVB MPEG-2 transport streams)
1514 * - encoding: unused
1515 * - decoding: Set by decoder.
1516 * @deprecated Deprecated in favor of AVSideData
1518 attribute_deprecated int dtg_active_format;
1519 #define FF_DTG_AFD_SAME 8
1520 #define FF_DTG_AFD_4_3 9
1521 #define FF_DTG_AFD_16_9 10
1522 #define FF_DTG_AFD_14_9 11
1523 #define FF_DTG_AFD_4_3_SP_14_9 13
1524 #define FF_DTG_AFD_16_9_SP_14_9 14
1525 #define FF_DTG_AFD_SP_4_3 15
1526 #endif /* FF_API_AFD */
1529 * maximum motion estimation search range in subpel units
1530 * If 0 then no limit.
1532 * - encoding: Set by user.
1533 * - decoding: unused
1538 * intra quantizer bias
1539 * - encoding: Set by user.
1540 * - decoding: unused
1542 int intra_quant_bias;
1543 #define FF_DEFAULT_QUANT_BIAS 999999
1546 * inter quantizer bias
1547 * - encoding: Set by user.
1548 * - decoding: unused
1550 int inter_quant_bias;
1554 * - encoding: unused
1555 * - decoding: Set by user.
1558 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1559 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1560 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1564 * XVideo Motion Acceleration
1565 * - encoding: forbidden
1566 * - decoding: set by decoder
1567 * @deprecated XvMC support is slated for removal.
1569 attribute_deprecated int xvmc_acceleration;
1570 #endif /* FF_API_XVMC */
1573 * macroblock decision mode
1574 * - encoding: Set by user.
1575 * - decoding: unused
1578 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1579 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1580 #define FF_MB_DECISION_RD 2 ///< rate distortion
1583 * custom intra quantization matrix
1584 * - encoding: Set by user, can be NULL.
1585 * - decoding: Set by libavcodec.
1587 uint16_t *intra_matrix;
1590 * custom inter quantization matrix
1591 * - encoding: Set by user, can be NULL.
1592 * - decoding: Set by libavcodec.
1594 uint16_t *inter_matrix;
1597 * scene change detection threshold
1598 * 0 is default, larger means fewer detected scene changes.
1599 * - encoding: Set by user.
1600 * - decoding: unused
1602 int scenechange_threshold;
1605 * noise reduction strength
1606 * - encoding: Set by user.
1607 * - decoding: unused
1609 int noise_reduction;
1613 * @deprecated this field is unused
1615 attribute_deprecated
1619 * @deprecated this field is unused
1621 attribute_deprecated
1626 * precision of the intra DC coefficient - 8
1627 * - encoding: Set by user.
1628 * - decoding: unused
1630 int intra_dc_precision;
1633 * Number of macroblock rows at the top which are skipped.
1634 * - encoding: unused
1635 * - decoding: Set by user.
1640 * Number of macroblock rows at the bottom which are skipped.
1641 * - encoding: unused
1642 * - decoding: Set by user.
1648 * @deprecated use encoder private options instead
1650 attribute_deprecated
1651 float border_masking;
1655 * minimum MB lagrange multipler
1656 * - encoding: Set by user.
1657 * - decoding: unused
1662 * maximum MB lagrange multipler
1663 * - encoding: Set by user.
1664 * - decoding: unused
1670 * - encoding: Set by user.
1671 * - decoding: unused
1673 int me_penalty_compensation;
1677 * - encoding: Set by user.
1678 * - decoding: unused
1684 * - encoding: Set by user.
1685 * - decoding: unused
1691 * - encoding: Set by user.
1692 * - decoding: unused
1697 * number of reference frames
1698 * - encoding: Set by user.
1699 * - decoding: Set by lavc.
1704 * chroma qp offset from luma
1705 * - encoding: Set by user.
1706 * - decoding: unused
1710 #if FF_API_UNUSED_MEMBERS
1712 * Multiplied by qscale for each frame and added to scene_change_score.
1713 * - encoding: Set by user.
1714 * - decoding: unused
1716 attribute_deprecated int scenechange_factor;
1721 * Note: Value depends upon the compare function used for fullpel ME.
1722 * - encoding: Set by user.
1723 * - decoding: unused
1728 * Adjust sensitivity of b_frame_strategy 1.
1729 * - encoding: Set by user.
1730 * - decoding: unused
1735 * Chromaticity coordinates of the source primaries.
1736 * - encoding: Set by user
1737 * - decoding: Set by libavcodec
1739 enum AVColorPrimaries color_primaries;
1742 * Color Transfer Characteristic.
1743 * - encoding: Set by user
1744 * - decoding: Set by libavcodec
1746 enum AVColorTransferCharacteristic color_trc;
1749 * YUV colorspace type.
1750 * - encoding: Set by user
1751 * - decoding: Set by libavcodec
1753 enum AVColorSpace colorspace;
1756 * MPEG vs JPEG YUV range.
1757 * - encoding: Set by user
1758 * - decoding: Set by libavcodec
1760 enum AVColorRange color_range;
1763 * This defines the location of chroma samples.
1764 * - encoding: Set by user
1765 * - decoding: Set by libavcodec
1767 enum AVChromaLocation chroma_sample_location;
1771 * Indicates number of picture subdivisions. Used for parallelized
1773 * - encoding: Set by user
1774 * - decoding: unused
1779 * - encoding: set by libavcodec
1780 * - decoding: Set by libavcodec
1782 enum AVFieldOrder field_order;
1785 int sample_rate; ///< samples per second
1786 int channels; ///< number of audio channels
1789 * audio sample format
1790 * - encoding: Set by user.
1791 * - decoding: Set by libavcodec.
1793 enum AVSampleFormat sample_fmt; ///< sample format
1795 /* The following data should not be initialized. */
1797 * Number of samples per channel in an audio frame.
1799 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1800 * except the last must contain exactly frame_size samples per channel.
1801 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1802 * frame size is not restricted.
1803 * - decoding: may be set by some decoders to indicate constant frame size
1808 * Frame counter, set by libavcodec.
1810 * - decoding: total number of frames returned from the decoder so far.
1811 * - encoding: total number of frames passed to the encoder so far.
1813 * @note the counter is not incremented if encoding/decoding resulted in
1819 * number of bytes per packet if constant and known or 0
1820 * Used by some WAV based audio codecs.
1825 * Audio cutoff bandwidth (0 means "automatic")
1826 * - encoding: Set by user.
1827 * - decoding: unused
1831 #if FF_API_REQUEST_CHANNELS
1833 * Decoder should decode to this many channels if it can (0 for default)
1834 * - encoding: unused
1835 * - decoding: Set by user.
1836 * @deprecated Deprecated in favor of request_channel_layout.
1838 attribute_deprecated int request_channels;
1842 * Audio channel layout.
1843 * - encoding: set by user.
1844 * - decoding: set by libavcodec.
1846 uint64_t channel_layout;
1849 * Request decoder to use this channel layout if it can (0 for default)
1850 * - encoding: unused
1851 * - decoding: Set by user.
1853 uint64_t request_channel_layout;
1856 * Type of service that the audio stream conveys.
1857 * - encoding: Set by user.
1858 * - decoding: Set by libavcodec.
1860 enum AVAudioServiceType audio_service_type;
1863 * Used to request a sample format from the decoder.
1864 * - encoding: unused.
1865 * - decoding: Set by user.
1867 enum AVSampleFormat request_sample_fmt;
1869 #if FF_API_GET_BUFFER
1871 * Called at the beginning of each frame to get a buffer for it.
1873 * The function will set AVFrame.data[], AVFrame.linesize[].
1874 * AVFrame.extended_data[] must also be set, but it should be the same as
1875 * AVFrame.data[] except for planar audio with more channels than can fit
1876 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1877 * many data pointers as it can hold.
1879 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1880 * avcodec_default_get_buffer() instead of providing buffers allocated by
1883 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1884 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1885 * but if get_buffer() is overridden then alignment considerations should
1886 * be taken into account.
1888 * @see avcodec_default_get_buffer()
1892 * If pic.reference is set then the frame will be read later by libavcodec.
1893 * avcodec_align_dimensions2() should be used to find the required width and
1894 * height, as they normally need to be rounded up to the next multiple of 16.
1896 * If frame multithreading is used and thread_safe_callbacks is set,
1897 * it may be called from a different thread, but not from more than one at
1898 * once. Does not need to be reentrant.
1900 * @see release_buffer(), reget_buffer()
1901 * @see avcodec_align_dimensions2()
1905 * Decoders request a buffer of a particular size by setting
1906 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1907 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1908 * to a smaller value in the output frame.
1910 * Decoders cannot use the buffer after returning from
1911 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1912 * is assumed to be released immediately upon return. In some rare cases,
1913 * a decoder may need to call get_buffer() more than once in a single
1914 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
1915 * called again after it has already been called once, the previously
1916 * acquired buffer is assumed to be released at that time and may not be
1917 * reused by the decoder.
1919 * As a convenience, av_samples_get_buffer_size() and
1920 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1921 * functions to find the required data size and to fill data pointers and
1922 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1923 * since all planes must be the same size.
1925 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1927 * - encoding: unused
1928 * - decoding: Set by libavcodec, user can override.
1930 * @deprecated use get_buffer2()
1932 attribute_deprecated
1933 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1936 * Called to release buffers which were allocated with get_buffer.
1937 * A released buffer can be reused in get_buffer().
1938 * pic.data[*] must be set to NULL.
1939 * May be called from a different thread if frame multithreading is used,
1940 * but not by more than one thread at once, so does not need to be reentrant.
1941 * - encoding: unused
1942 * - decoding: Set by libavcodec, user can override.
1944 * @deprecated custom freeing callbacks should be set from get_buffer2()
1946 attribute_deprecated
1947 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1950 * Called at the beginning of a frame to get cr buffer for it.
1951 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1952 * libavcodec will pass previous buffer in pic, function should return
1953 * same buffer or new buffer with old frame "painted" into it.
1954 * If pic.data[0] == NULL must behave like get_buffer().
1955 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
1956 * avcodec_default_reget_buffer() instead of providing buffers allocated by
1958 * - encoding: unused
1959 * - decoding: Set by libavcodec, user can override.
1961 attribute_deprecated
1962 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1966 * This callback is called at the beginning of each frame to get data
1967 * buffer(s) for it. There may be one contiguous buffer for all the data or
1968 * there may be a buffer per each data plane or anything in between. What
1969 * this means is, you may set however many entries in buf[] you feel necessary.
1970 * Each buffer must be reference-counted using the AVBuffer API (see description
1973 * The following fields will be set in the frame before this callback is
1976 * - width, height (video only)
1977 * - sample_rate, channel_layout, nb_samples (audio only)
1978 * Their values may differ from the corresponding values in
1979 * AVCodecContext. This callback must use the frame values, not the codec
1980 * context values, to calculate the required buffer size.
1982 * This callback must fill the following fields in the frame:
1986 * * if the data is planar audio with more than 8 channels, then this
1987 * callback must allocate and fill extended_data to contain all pointers
1988 * to all data planes. data[] must hold as many pointers as it can.
1989 * extended_data must be allocated with av_malloc() and will be freed in
1991 * * otherwise exended_data must point to data
1992 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1993 * the frame's data and extended_data pointers must be contained in these. That
1994 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1995 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1996 * and av_buffer_ref().
1997 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1998 * this callback and filled with the extra buffers if there are more
1999 * buffers than buf[] can hold. extended_buf will be freed in
2002 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2003 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2006 * Each data plane must be aligned to the maximum required by the target
2009 * @see avcodec_default_get_buffer2()
2013 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2014 * (read and/or written to if it is writable) later by libavcodec.
2016 * avcodec_align_dimensions2() should be used to find the required width and
2017 * height, as they normally need to be rounded up to the next multiple of 16.
2019 * If frame multithreading is used and thread_safe_callbacks is set,
2020 * this callback may be called from a different thread, but not from more
2021 * than one at once. Does not need to be reentrant.
2023 * @see avcodec_align_dimensions2()
2027 * Decoders request a buffer of a particular size by setting
2028 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2029 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2030 * to a smaller value in the output frame.
2032 * As a convenience, av_samples_get_buffer_size() and
2033 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2034 * functions to find the required data size and to fill data pointers and
2035 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2036 * since all planes must be the same size.
2038 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2040 * - encoding: unused
2041 * - decoding: Set by libavcodec, user can override.
2043 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2046 * If non-zero, the decoded audio and video frames returned from
2047 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2048 * and are valid indefinitely. The caller must free them with
2049 * av_frame_unref() when they are not needed anymore.
2050 * Otherwise, the decoded frames must not be freed by the caller and are
2051 * only valid until the next decode call.
2053 * - encoding: unused
2054 * - decoding: set by the caller before avcodec_open2().
2056 int refcounted_frames;
2058 /* - encoding parameters */
2059 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2060 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2064 * - encoding: Set by user.
2065 * - decoding: unused
2071 * - encoding: Set by user.
2072 * - decoding: unused
2077 * maximum quantizer difference between frames
2078 * - encoding: Set by user.
2079 * - decoding: unused
2085 * @deprecated use encoder private options instead
2087 attribute_deprecated
2090 attribute_deprecated
2092 attribute_deprecated
2097 * decoder bitstream buffer size
2098 * - encoding: Set by user.
2099 * - decoding: unused
2104 * ratecontrol override, see RcOverride
2105 * - encoding: Allocated/set/freed by user.
2106 * - decoding: unused
2108 int rc_override_count;
2109 RcOverride *rc_override;
2113 * @deprecated use encoder private options instead
2115 attribute_deprecated
2121 * - encoding: Set by user.
2122 * - decoding: unused
2128 * - encoding: Set by user.
2129 * - decoding: unused
2135 * @deprecated use encoder private options instead
2137 attribute_deprecated
2138 float rc_buffer_aggressivity;
2140 attribute_deprecated
2141 float rc_initial_cplx;
2145 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2146 * - encoding: Set by user.
2147 * - decoding: unused.
2149 float rc_max_available_vbv_use;
2152 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2153 * - encoding: Set by user.
2154 * - decoding: unused.
2156 float rc_min_vbv_overflow_use;
2159 * Number of bits which should be loaded into the rc buffer before decoding starts.
2160 * - encoding: Set by user.
2161 * - decoding: unused
2163 int rc_initial_buffer_occupancy;
2165 #define FF_CODER_TYPE_VLC 0
2166 #define FF_CODER_TYPE_AC 1
2167 #define FF_CODER_TYPE_RAW 2
2168 #define FF_CODER_TYPE_RLE 3
2169 #if FF_API_UNUSED_MEMBERS
2170 #define FF_CODER_TYPE_DEFLATE 4
2171 #endif /* FF_API_UNUSED_MEMBERS */
2174 * - encoding: Set by user.
2175 * - decoding: unused
2181 * - encoding: Set by user.
2182 * - decoding: unused
2188 * @deprecated use encoder private options instead
2190 attribute_deprecated
2194 * @deprecated use encoder private options instead
2196 attribute_deprecated
2201 * frame skip threshold
2202 * - encoding: Set by user.
2203 * - decoding: unused
2205 int frame_skip_threshold;
2209 * - encoding: Set by user.
2210 * - decoding: unused
2212 int frame_skip_factor;
2215 * frame skip exponent
2216 * - encoding: Set by user.
2217 * - decoding: unused
2222 * frame skip comparison function
2223 * - encoding: Set by user.
2224 * - decoding: unused
2229 * trellis RD quantization
2230 * - encoding: Set by user.
2231 * - decoding: unused
2236 * - encoding: Set by user.
2237 * - decoding: unused
2239 int min_prediction_order;
2242 * - encoding: Set by user.
2243 * - decoding: unused
2245 int max_prediction_order;
2248 * GOP timecode frame start number, in non drop frame format
2249 * - encoding: Set by user.
2250 * - decoding: unused
2252 int64_t timecode_frame_start;
2254 /* The RTP callback: This function is called */
2255 /* every time the encoder has a packet to send. */
2256 /* It depends on the encoder if the data starts */
2257 /* with a Start Code (it should). H.263 does. */
2258 /* mb_nb contains the number of macroblocks */
2259 /* encoded in the RTP payload. */
2260 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2262 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2263 /* do its best to deliver a chunk with size */
2264 /* below rtp_payload_size, the chunk will start */
2265 /* with a start code on some codecs like H.263. */
2266 /* This doesn't take account of any particular */
2267 /* headers inside the transmitted RTP payload. */
2269 /* statistics, used for 2-pass encoding */
2280 * number of bits used for the previously encoded frame
2281 * - encoding: Set by libavcodec.
2282 * - decoding: unused
2287 * pass1 encoding statistics output buffer
2288 * - encoding: Set by libavcodec.
2289 * - decoding: unused
2294 * pass2 encoding statistics input buffer
2295 * Concatenated stuff from stats_out of pass1 should be placed here.
2296 * - encoding: Allocated/set/freed by user.
2297 * - decoding: unused
2302 * Work around bugs in encoders which sometimes cannot be detected automatically.
2303 * - encoding: Set by user
2304 * - decoding: Set by user
2306 int workaround_bugs;
2307 #define FF_BUG_AUTODETECT 1 ///< autodetection
2308 #if FF_API_OLD_MSMPEG4
2309 #define FF_BUG_OLD_MSMPEG4 2
2311 #define FF_BUG_XVID_ILACE 4
2312 #define FF_BUG_UMP4 8
2313 #define FF_BUG_NO_PADDING 16
2314 #define FF_BUG_AMV 32
2316 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2318 #define FF_BUG_QPEL_CHROMA 64
2319 #define FF_BUG_STD_QPEL 128
2320 #define FF_BUG_QPEL_CHROMA2 256
2321 #define FF_BUG_DIRECT_BLOCKSIZE 512
2322 #define FF_BUG_EDGE 1024
2323 #define FF_BUG_HPEL_CHROMA 2048
2324 #define FF_BUG_DC_CLIP 4096
2325 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2326 #define FF_BUG_TRUNCATED 16384
2329 * strictly follow the standard (MPEG4, ...).
2330 * - encoding: Set by user.
2331 * - decoding: Set by user.
2332 * Setting this to STRICT or higher means the encoder and decoder will
2333 * generally do stupid things, whereas setting it to unofficial or lower
2334 * will mean the encoder might produce output that is not supported by all
2335 * spec-compliant decoders. Decoders don't differentiate between normal,
2336 * unofficial and experimental (that is, they always try to decode things
2337 * when they can) unless they are explicitly asked to behave stupidly
2338 * (=strictly conform to the specs)
2340 int strict_std_compliance;
2341 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2342 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2343 #define FF_COMPLIANCE_NORMAL 0
2344 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2345 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2348 * error concealment flags
2349 * - encoding: unused
2350 * - decoding: Set by user.
2352 int error_concealment;
2353 #define FF_EC_GUESS_MVS 1
2354 #define FF_EC_DEBLOCK 2
2358 * - encoding: Set by user.
2359 * - decoding: Set by user.
2362 #define FF_DEBUG_PICT_INFO 1
2363 #define FF_DEBUG_RC 2
2364 #define FF_DEBUG_BITSTREAM 4
2365 #define FF_DEBUG_MB_TYPE 8
2366 #define FF_DEBUG_QP 16
2369 * @deprecated this option does nothing
2371 #define FF_DEBUG_MV 32
2373 #define FF_DEBUG_DCT_COEFF 0x00000040
2374 #define FF_DEBUG_SKIP 0x00000080
2375 #define FF_DEBUG_STARTCODE 0x00000100
2376 #if FF_API_UNUSED_MEMBERS
2377 #define FF_DEBUG_PTS 0x00000200
2378 #endif /* FF_API_UNUSED_MEMBERS */
2379 #define FF_DEBUG_ER 0x00000400
2380 #define FF_DEBUG_MMCO 0x00000800
2381 #define FF_DEBUG_BUGS 0x00001000
2383 #define FF_DEBUG_VIS_QP 0x00002000
2384 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2386 #define FF_DEBUG_BUFFERS 0x00008000
2387 #define FF_DEBUG_THREADS 0x00010000
2391 * @deprecated this option does not have any effect
2393 attribute_deprecated
2395 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2396 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2397 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2401 * Error recognition; may misdetect some more or less valid parts as errors.
2402 * - encoding: unused
2403 * - decoding: Set by user.
2405 int err_recognition;
2408 * Verify checksums embedded in the bitstream (could be of either encoded or
2409 * decoded data, depending on the codec) and print an error message on mismatch.
2410 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2411 * decoder returning an error.
2413 #define AV_EF_CRCCHECK (1<<0)
2414 #define AV_EF_BITSTREAM (1<<1)
2415 #define AV_EF_BUFFER (1<<2)
2416 #define AV_EF_EXPLODE (1<<3)
2419 * opaque 64bit number (generally a PTS) that will be reordered and
2420 * output in AVFrame.reordered_opaque
2421 * - encoding: unused
2422 * - decoding: Set by user.
2424 int64_t reordered_opaque;
2427 * Hardware accelerator in use
2428 * - encoding: unused.
2429 * - decoding: Set by libavcodec
2431 struct AVHWAccel *hwaccel;
2434 * Hardware accelerator context.
2435 * For some hardware accelerators, a global context needs to be
2436 * provided by the user. In that case, this holds display-dependent
2437 * data Libav cannot instantiate itself. Please refer to the
2438 * Libav HW accelerator documentation to know how to fill this
2439 * is. e.g. for VA API, this is a struct vaapi_context.
2440 * - encoding: unused
2441 * - decoding: Set by user
2443 void *hwaccel_context;
2447 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2448 * - decoding: unused
2450 uint64_t error[AV_NUM_DATA_POINTERS];
2453 * DCT algorithm, see FF_DCT_* below
2454 * - encoding: Set by user.
2455 * - decoding: unused
2458 #define FF_DCT_AUTO 0
2459 #define FF_DCT_FASTINT 1
2460 #if FF_API_UNUSED_MEMBERS
2461 #define FF_DCT_INT 2
2462 #endif /* FF_API_UNUSED_MEMBERS */
2463 #define FF_DCT_MMX 3
2464 #define FF_DCT_ALTIVEC 5
2465 #define FF_DCT_FAAN 6
2468 * IDCT algorithm, see FF_IDCT_* below.
2469 * - encoding: Set by user.
2470 * - decoding: Set by user.
2473 #define FF_IDCT_AUTO 0
2474 #define FF_IDCT_INT 1
2475 #define FF_IDCT_SIMPLE 2
2476 #define FF_IDCT_SIMPLEMMX 3
2477 #define FF_IDCT_ARM 7
2478 #define FF_IDCT_ALTIVEC 8
2480 #define FF_IDCT_SH4 9
2482 #define FF_IDCT_SIMPLEARM 10
2483 #if FF_API_UNUSED_MEMBERS
2484 #define FF_IDCT_IPP 13
2485 #endif /* FF_API_UNUSED_MEMBERS */
2486 #define FF_IDCT_XVID 14
2487 #if FF_API_IDCT_XVIDMMX
2488 #define FF_IDCT_XVIDMMX 14
2489 #endif /* FF_API_IDCT_XVIDMMX */
2490 #define FF_IDCT_SIMPLEARMV5TE 16
2491 #define FF_IDCT_SIMPLEARMV6 17
2492 #if FF_API_ARCH_SPARC
2493 #define FF_IDCT_SIMPLEVIS 18
2495 #define FF_IDCT_FAAN 20
2496 #define FF_IDCT_SIMPLENEON 22
2497 #if FF_API_ARCH_ALPHA
2498 #define FF_IDCT_SIMPLEALPHA 23
2502 * bits per sample/pixel from the demuxer (needed for huffyuv).
2503 * - encoding: Set by libavcodec.
2504 * - decoding: Set by user.
2506 int bits_per_coded_sample;
2509 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2510 * - encoding: set by user.
2511 * - decoding: set by libavcodec.
2513 int bits_per_raw_sample;
2517 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2518 * - encoding: unused
2519 * - decoding: Set by user.
2521 * @deprecated use decoder private options instead
2523 attribute_deprecated int lowres;
2527 * the picture in the bitstream
2528 * - encoding: Set by libavcodec.
2529 * - decoding: unused
2531 AVFrame *coded_frame;
2535 * is used to decide how many independent tasks should be passed to execute()
2536 * - encoding: Set by user.
2537 * - decoding: Set by user.
2542 * Which multithreading methods to use.
2543 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2544 * so clients which cannot provide future frames should not use it.
2546 * - encoding: Set by user, otherwise the default is used.
2547 * - decoding: Set by user, otherwise the default is used.
2550 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2551 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2554 * Which multithreading methods are in use by the codec.
2555 * - encoding: Set by libavcodec.
2556 * - decoding: Set by libavcodec.
2558 int active_thread_type;
2561 * Set by the client if its custom get_buffer() callback can be called
2562 * synchronously from another thread, which allows faster multithreaded decoding.
2563 * draw_horiz_band() will be called from other threads regardless of this setting.
2564 * Ignored if the default get_buffer() is used.
2565 * - encoding: Set by user.
2566 * - decoding: Set by user.
2568 int thread_safe_callbacks;
2571 * The codec may call this to execute several independent things.
2572 * It will return only after finishing all tasks.
2573 * The user may replace this with some multithreaded implementation,
2574 * the default implementation will execute the parts serially.
2575 * @param count the number of things to execute
2576 * - encoding: Set by libavcodec, user can override.
2577 * - decoding: Set by libavcodec, user can override.
2579 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2582 * The codec may call this to execute several independent things.
2583 * It will return only after finishing all tasks.
2584 * The user may replace this with some multithreaded implementation,
2585 * the default implementation will execute the parts serially.
2586 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2587 * @param c context passed also to func
2588 * @param count the number of things to execute
2589 * @param arg2 argument passed unchanged to func
2590 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2591 * @param func function that will be called count times, with jobnr from 0 to count-1.
2592 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2593 * two instances of func executing at the same time will have the same threadnr.
2594 * @return always 0 currently, but code should handle a future improvement where when any call to func
2595 * returns < 0 no further calls to func may be done and < 0 is returned.
2596 * - encoding: Set by libavcodec, user can override.
2597 * - decoding: Set by libavcodec, user can override.
2599 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2601 #if FF_API_THREAD_OPAQUE
2603 * @deprecated this field should not be used from outside of lavc
2605 attribute_deprecated
2606 void *thread_opaque;
2610 * noise vs. sse weight for the nsse comparsion function
2611 * - encoding: Set by user.
2612 * - decoding: unused
2618 * - encoding: Set by user.
2619 * - decoding: Set by libavcodec.
2622 #define FF_PROFILE_UNKNOWN -99
2623 #define FF_PROFILE_RESERVED -100
2625 #define FF_PROFILE_AAC_MAIN 0
2626 #define FF_PROFILE_AAC_LOW 1
2627 #define FF_PROFILE_AAC_SSR 2
2628 #define FF_PROFILE_AAC_LTP 3
2629 #define FF_PROFILE_AAC_HE 4
2630 #define FF_PROFILE_AAC_HE_V2 28
2631 #define FF_PROFILE_AAC_LD 22
2632 #define FF_PROFILE_AAC_ELD 38
2633 #define FF_PROFILE_MPEG2_AAC_LOW 128
2634 #define FF_PROFILE_MPEG2_AAC_HE 131
2636 #define FF_PROFILE_DTS 20
2637 #define FF_PROFILE_DTS_ES 30
2638 #define FF_PROFILE_DTS_96_24 40
2639 #define FF_PROFILE_DTS_HD_HRA 50
2640 #define FF_PROFILE_DTS_HD_MA 60
2642 #define FF_PROFILE_MPEG2_422 0
2643 #define FF_PROFILE_MPEG2_HIGH 1
2644 #define FF_PROFILE_MPEG2_SS 2
2645 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2646 #define FF_PROFILE_MPEG2_MAIN 4
2647 #define FF_PROFILE_MPEG2_SIMPLE 5
2649 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2650 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2652 #define FF_PROFILE_H264_BASELINE 66
2653 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2654 #define FF_PROFILE_H264_MAIN 77
2655 #define FF_PROFILE_H264_EXTENDED 88
2656 #define FF_PROFILE_H264_HIGH 100
2657 #define FF_PROFILE_H264_HIGH_10 110
2658 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2659 #define FF_PROFILE_H264_HIGH_422 122
2660 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2661 #define FF_PROFILE_H264_HIGH_444 144
2662 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2663 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2664 #define FF_PROFILE_H264_CAVLC_444 44
2666 #define FF_PROFILE_VC1_SIMPLE 0
2667 #define FF_PROFILE_VC1_MAIN 1
2668 #define FF_PROFILE_VC1_COMPLEX 2
2669 #define FF_PROFILE_VC1_ADVANCED 3
2671 #define FF_PROFILE_MPEG4_SIMPLE 0
2672 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2673 #define FF_PROFILE_MPEG4_CORE 2
2674 #define FF_PROFILE_MPEG4_MAIN 3
2675 #define FF_PROFILE_MPEG4_N_BIT 4
2676 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2677 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2678 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2679 #define FF_PROFILE_MPEG4_HYBRID 8
2680 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2681 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2682 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2683 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2684 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2685 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2686 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2688 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2689 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2690 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2691 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2692 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2695 #define FF_PROFILE_HEVC_MAIN 1
2696 #define FF_PROFILE_HEVC_MAIN_10 2
2697 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2701 * - encoding: Set by user.
2702 * - decoding: Set by libavcodec.
2705 #define FF_LEVEL_UNKNOWN -99
2709 * - encoding: unused
2710 * - decoding: Set by user.
2712 enum AVDiscard skip_loop_filter;
2716 * - encoding: unused
2717 * - decoding: Set by user.
2719 enum AVDiscard skip_idct;
2723 * - encoding: unused
2724 * - decoding: Set by user.
2726 enum AVDiscard skip_frame;
2729 * Header containing style information for text subtitles.
2730 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2731 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2732 * the Format line following. It shouldn't include any Dialogue line.
2733 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2734 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2736 uint8_t *subtitle_header;
2737 int subtitle_header_size;
2739 #if FF_API_ERROR_RATE
2741 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2744 attribute_deprecated
2748 #if FF_API_CODEC_PKT
2750 * @deprecated this field is not supposed to be accessed from outside lavc
2752 attribute_deprecated
2757 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2758 * Used for compliant TS muxing.
2759 * - encoding: Set by libavcodec.
2760 * - decoding: unused.
2765 * Encoding only. Allow encoders to output packets that do not contain any
2766 * encoded data, only side data.
2768 * Some encoders need to output such packets, e.g. to update some stream
2769 * parameters at the end of encoding.
2771 * All callers are strongly recommended to set this option to 1 and update
2772 * their code to deal with such packets, since this behaviour may become
2773 * always enabled in the future (then this option will be deprecated and
2774 * later removed). To avoid ABI issues when this happens, the callers should
2775 * use AVOptions to set this field.
2777 int side_data_only_packets;
2780 * Audio only. The number of "priming" samples (padding) inserted by the
2781 * encoder at the beginning of the audio. I.e. this number of leading
2782 * decoded samples must be discarded by the caller to get the original audio
2783 * without leading padding.
2785 * - decoding: unused
2786 * - encoding: Set by libavcodec. The timestamps on the output packets are
2787 * adjusted by the encoder so that they always refer to the
2788 * first sample of the data actually contained in the packet,
2789 * including any added padding. E.g. if the timebase is
2790 * 1/samplerate and the timestamp of the first input sample is
2791 * 0, the timestamp of the first output packet will be
2794 int initial_padding;
2797 * - decoding: For codecs that store a framerate value in the compressed
2798 * bitstream, the decoder may export it here. { 0, 1} when
2800 * - encoding: unused
2802 AVRational framerate;
2808 typedef struct AVProfile {
2810 const char *name; ///< short name for the profile
2813 typedef struct AVCodecDefault AVCodecDefault;
2820 typedef struct AVCodec {
2822 * Name of the codec implementation.
2823 * The name is globally unique among encoders and among decoders (but an
2824 * encoder and a decoder can share the same name).
2825 * This is the primary way to find a codec from the user perspective.
2829 * Descriptive name for the codec, meant to be more human readable than name.
2830 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2832 const char *long_name;
2833 enum AVMediaType type;
2836 * Codec capabilities.
2840 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2841 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2842 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2843 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2844 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2846 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2848 const AVClass *priv_class; ///< AVClass for the private context
2849 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2851 /*****************************************************************
2852 * No fields below this line are part of the public API. They
2853 * may not be used outside of libavcodec and can be changed and
2855 * New public fields should be added right above.
2856 *****************************************************************
2859 struct AVCodec *next;
2861 * @name Frame-level threading support functions
2865 * If defined, called on thread contexts when they are created.
2866 * If the codec allocates writable tables in init(), re-allocate them here.
2867 * priv_data will be set to a copy of the original.
2869 int (*init_thread_copy)(AVCodecContext *);
2871 * Copy necessary context variables from a previous thread context to the current one.
2872 * If not defined, the next thread will start automatically; otherwise, the codec
2873 * must call ff_thread_finish_setup().
2875 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2877 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2881 * Private codec-specific defaults.
2883 const AVCodecDefault *defaults;
2886 * Initialize codec static data, called from avcodec_register().
2888 void (*init_static_data)(struct AVCodec *codec);
2890 int (*init)(AVCodecContext *);
2891 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2892 const struct AVSubtitle *sub);
2894 * Encode data to an AVPacket.
2896 * @param avctx codec context
2897 * @param avpkt output AVPacket (may contain a user-provided buffer)
2898 * @param[in] frame AVFrame containing the raw data to be encoded
2899 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2900 * non-empty packet was returned in avpkt.
2901 * @return 0 on success, negative error code on failure
2903 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2904 int *got_packet_ptr);
2905 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2906 int (*close)(AVCodecContext *);
2909 * Will be called when seeking
2911 void (*flush)(AVCodecContext *);
2915 * @defgroup lavc_hwaccel AVHWAccel
2918 typedef struct AVHWAccel {
2920 * Name of the hardware accelerated codec.
2921 * The name is globally unique among encoders and among decoders (but an
2922 * encoder and a decoder can share the same name).
2927 * Type of codec implemented by the hardware accelerator.
2929 * See AVMEDIA_TYPE_xxx
2931 enum AVMediaType type;
2934 * Codec implemented by the hardware accelerator.
2936 * See AV_CODEC_ID_xxx
2941 * Supported pixel format.
2943 * Only hardware accelerated formats are supported here.
2945 enum AVPixelFormat pix_fmt;
2948 * Hardware accelerated codec capabilities.
2949 * see FF_HWACCEL_CODEC_CAP_*
2953 /*****************************************************************
2954 * No fields below this line are part of the public API. They
2955 * may not be used outside of libavcodec and can be changed and
2957 * New public fields should be added right above.
2958 *****************************************************************
2960 struct AVHWAccel *next;
2963 * Allocate a custom buffer
2965 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
2968 * Called at the beginning of each frame or field picture.
2970 * Meaningful frame information (codec specific) is guaranteed to
2971 * be parsed at this point. This function is mandatory.
2973 * Note that buf can be NULL along with buf_size set to 0.
2974 * Otherwise, this means the whole frame is available at this point.
2976 * @param avctx the codec context
2977 * @param buf the frame data buffer base
2978 * @param buf_size the size of the frame in bytes
2979 * @return zero if successful, a negative value otherwise
2981 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2984 * Callback for each slice.
2986 * Meaningful slice information (codec specific) is guaranteed to
2987 * be parsed at this point. This function is mandatory.
2989 * @param avctx the codec context
2990 * @param buf the slice data buffer base
2991 * @param buf_size the size of the slice in bytes
2992 * @return zero if successful, a negative value otherwise
2994 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2997 * Called at the end of each frame or field picture.
2999 * The whole picture is parsed at this point and can now be sent
3000 * to the hardware accelerator. This function is mandatory.
3002 * @param avctx the codec context
3003 * @return zero if successful, a negative value otherwise
3005 int (*end_frame)(AVCodecContext *avctx);
3008 * Size of per-frame hardware accelerator private data.
3010 * Private data is allocated with av_mallocz() before
3011 * AVCodecContext.get_buffer() and deallocated after
3012 * AVCodecContext.release_buffer().
3014 int frame_priv_data_size;
3017 * Initialize the hwaccel private data.
3019 * This will be called from ff_get_format(), after hwaccel and
3020 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3023 int (*init)(AVCodecContext *avctx);
3026 * Uninitialize the hwaccel private data.
3028 * This will be called from get_format() or avcodec_close(), after hwaccel
3029 * and hwaccel_context are already uninitialized.
3031 int (*uninit)(AVCodecContext *avctx);
3034 * Size of the private data to allocate in
3035 * AVCodecInternal.hwaccel_priv_data.
3041 * Hardware acceleration should be used for decoding even if the codec level
3042 * used is unknown or higher than the maximum supported level reported by the
3045 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3052 * @defgroup lavc_picture AVPicture
3054 * Functions for working with AVPicture
3059 * four components are given, that's all.
3060 * the last component is alpha
3062 typedef struct AVPicture {
3063 uint8_t *data[AV_NUM_DATA_POINTERS];
3064 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3071 #define AVPALETTE_SIZE 1024
3072 #define AVPALETTE_COUNT 256
3074 enum AVSubtitleType {
3077 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3080 * Plain text, the text field must be set by the decoder and is
3081 * authoritative. ass and pict fields may contain approximations.
3086 * Formatted text, the ass field must be set by the decoder and is
3087 * authoritative. pict and text fields may contain approximations.
3092 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3094 typedef struct AVSubtitleRect {
3095 int x; ///< top left corner of pict, undefined when pict is not set
3096 int y; ///< top left corner of pict, undefined when pict is not set
3097 int w; ///< width of pict, undefined when pict is not set
3098 int h; ///< height of pict, undefined when pict is not set
3099 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3102 * data+linesize for the bitmap of this subtitle.
3103 * can be set for text/ass as well once they where rendered
3106 enum AVSubtitleType type;
3108 char *text; ///< 0 terminated plain UTF-8 text
3111 * 0 terminated ASS/SSA compatible event line.
3112 * The pressentation of this is unaffected by the other values in this
3119 typedef struct AVSubtitle {
3120 uint16_t format; /* 0 = graphics */
3121 uint32_t start_display_time; /* relative to packet pts, in ms */
3122 uint32_t end_display_time; /* relative to packet pts, in ms */
3124 AVSubtitleRect **rects;
3125 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3129 * If c is NULL, returns the first registered codec,
3130 * if c is non-NULL, returns the next registered codec after c,
3131 * or NULL if c is the last one.
3133 AVCodec *av_codec_next(const AVCodec *c);
3136 * Return the LIBAVCODEC_VERSION_INT constant.
3138 unsigned avcodec_version(void);
3141 * Return the libavcodec build-time configuration.
3143 const char *avcodec_configuration(void);
3146 * Return the libavcodec license.
3148 const char *avcodec_license(void);
3151 * Register the codec codec and initialize libavcodec.
3153 * @warning either this function or avcodec_register_all() must be called
3154 * before any other libavcodec functions.
3156 * @see avcodec_register_all()
3158 void avcodec_register(AVCodec *codec);
3161 * Register all the codecs, parsers and bitstream filters which were enabled at
3162 * configuration time. If you do not call this function you can select exactly
3163 * which formats you want to support, by using the individual registration
3166 * @see avcodec_register
3167 * @see av_register_codec_parser
3168 * @see av_register_bitstream_filter
3170 void avcodec_register_all(void);
3173 * Allocate an AVCodecContext and set its fields to default values. The
3174 * resulting struct should be freed with avcodec_free_context().
3176 * @param codec if non-NULL, allocate private data and initialize defaults
3177 * for the given codec. It is illegal to then call avcodec_open2()
3178 * with a different codec.
3179 * If NULL, then the codec-specific defaults won't be initialized,
3180 * which may result in suboptimal default settings (this is
3181 * important mainly for encoders, e.g. libx264).
3183 * @return An AVCodecContext filled with default values or NULL on failure.
3184 * @see avcodec_get_context_defaults
3186 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3189 * Free the codec context and everything associated with it and write NULL to
3190 * the provided pointer.
3192 void avcodec_free_context(AVCodecContext **avctx);
3195 * Set the fields of the given AVCodecContext to default values corresponding
3196 * to the given codec (defaults may be codec-dependent).
3198 * Do not call this function if a non-NULL codec has been passed
3199 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3200 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3201 * different codec on this AVCodecContext.
3203 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3206 * Get the AVClass for AVCodecContext. It can be used in combination with
3207 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3209 * @see av_opt_find().
3211 const AVClass *avcodec_get_class(void);
3214 * Copy the settings of the source AVCodecContext into the destination
3215 * AVCodecContext. The resulting destination codec context will be
3216 * unopened, i.e. you are required to call avcodec_open2() before you
3217 * can use this AVCodecContext to decode/encode video/audio data.
3219 * @param dest target codec context, should be initialized with
3220 * avcodec_alloc_context3(), but otherwise uninitialized
3221 * @param src source codec context
3222 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3224 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3226 #if FF_API_AVFRAME_LAVC
3228 * @deprecated use av_frame_alloc()
3230 attribute_deprecated
3231 AVFrame *avcodec_alloc_frame(void);
3234 * Set the fields of the given AVFrame to default values.
3236 * @param frame The AVFrame of which the fields should be set to default values.
3238 * @deprecated use av_frame_unref()
3240 attribute_deprecated
3241 void avcodec_get_frame_defaults(AVFrame *frame);
3244 * Free the frame and any dynamically allocated objects in it,
3245 * e.g. extended_data.
3247 * @param frame frame to be freed. The pointer will be set to NULL.
3249 * @warning this function does NOT free the data buffers themselves
3250 * (it does not know how, since they might have been allocated with
3251 * a custom get_buffer()).
3253 * @deprecated use av_frame_free()
3255 attribute_deprecated
3256 void avcodec_free_frame(AVFrame **frame);
3260 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3261 * function the context has to be allocated with avcodec_alloc_context3().
3263 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3264 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3265 * retrieving a codec.
3267 * @warning This function is not thread safe!
3270 * avcodec_register_all();
3271 * av_dict_set(&opts, "b", "2.5M", 0);
3272 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3276 * context = avcodec_alloc_context3(codec);
3278 * if (avcodec_open2(context, codec, opts) < 0)
3282 * @param avctx The context to initialize.
3283 * @param codec The codec to open this context for. If a non-NULL codec has been
3284 * previously passed to avcodec_alloc_context3() or
3285 * avcodec_get_context_defaults3() for this context, then this
3286 * parameter MUST be either NULL or equal to the previously passed
3288 * @param options A dictionary filled with AVCodecContext and codec-private options.
3289 * On return this object will be filled with options that were not found.
3291 * @return zero on success, a negative value on error
3292 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3293 * av_dict_set(), av_opt_find().
3295 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3298 * Close a given AVCodecContext and free all the data associated with it
3299 * (but not the AVCodecContext itself).
3301 * Calling this function on an AVCodecContext that hasn't been opened will free
3302 * the codec-specific data allocated in avcodec_alloc_context3() /
3303 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3306 int avcodec_close(AVCodecContext *avctx);
3309 * Free all allocated data in the given subtitle struct.
3311 * @param sub AVSubtitle to free.
3313 void avsubtitle_free(AVSubtitle *sub);
3320 * @addtogroup lavc_packet
3324 #if FF_API_DESTRUCT_PACKET
3326 * Default packet destructor.
3327 * @deprecated use the AVBuffer API instead
3329 attribute_deprecated
3330 void av_destruct_packet(AVPacket *pkt);
3334 * Initialize optional fields of a packet with default values.
3336 * Note, this does not touch the data and size members, which have to be
3337 * initialized separately.
3341 void av_init_packet(AVPacket *pkt);
3344 * Allocate the payload of a packet and initialize its fields with
3348 * @param size wanted payload size
3349 * @return 0 if OK, AVERROR_xxx otherwise
3351 int av_new_packet(AVPacket *pkt, int size);
3354 * Reduce packet size, correctly zeroing padding
3357 * @param size new size
3359 void av_shrink_packet(AVPacket *pkt, int size);
3362 * Increase packet size, correctly zeroing padding
3365 * @param grow_by number of bytes by which to increase the size of the packet
3367 int av_grow_packet(AVPacket *pkt, int grow_by);
3370 * Initialize a reference-counted packet from av_malloc()ed data.
3372 * @param pkt packet to be initialized. This function will set the data, size,
3373 * buf and destruct fields, all others are left untouched.
3374 * @param data Data allocated by av_malloc() to be used as packet data. If this
3375 * function returns successfully, the data is owned by the underlying AVBuffer.
3376 * The caller may not access the data through other means.
3377 * @param size size of data in bytes, without the padding. I.e. the full buffer
3378 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3380 * @return 0 on success, a negative AVERROR on error
3382 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3385 * @warning This is a hack - the packet memory allocation stuff is broken. The
3386 * packet is allocated if it was not really allocated.
3388 int av_dup_packet(AVPacket *pkt);
3393 * @param pkt packet to free
3395 void av_free_packet(AVPacket *pkt);
3398 * Allocate new information of a packet.
3401 * @param type side information type
3402 * @param size side information size
3403 * @return pointer to fresh allocated data or NULL otherwise
3405 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3409 * Shrink the already allocated side data buffer
3412 * @param type side information type
3413 * @param size new side information size
3414 * @return 0 on success, < 0 on failure
3416 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3420 * Get side information from packet.
3423 * @param type desired side information type
3424 * @param size pointer for side information size to store (optional)
3425 * @return pointer to data if present or NULL otherwise
3427 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3431 * Convenience function to free all the side data stored.
3432 * All the other fields stay untouched.
3436 void av_packet_free_side_data(AVPacket *pkt);
3439 * Setup a new reference to the data described by a given packet
3441 * If src is reference-counted, setup dst as a new reference to the
3442 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3443 * data from src into it.
3445 * All the other fields are copied from src.
3447 * @see av_packet_unref
3449 * @param dst Destination packet
3450 * @param src Source packet
3452 * @return 0 on success, a negative AVERROR on error.
3454 int av_packet_ref(AVPacket *dst, AVPacket *src);
3459 * Unreference the buffer referenced by the packet and reset the
3460 * remaining packet fields to their default values.
3462 * @param pkt The packet to be unreferenced.
3464 void av_packet_unref(AVPacket *pkt);
3467 * Move every field in src to dst and reset src.
3469 * @see av_packet_unref
3471 * @param src Source packet, will be reset
3472 * @param dst Destination packet
3474 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3477 * Copy only "properties" fields from src to dst.
3479 * Properties for the purpose of this function are all the fields
3480 * beside those related to the packet data (buf, data, size)
3482 * @param dst Destination packet
3483 * @param src Source packet
3485 * @return 0 on success AVERROR on failure.
3488 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3491 * Convert valid timing fields (timestamps / durations) in a packet from one
3492 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3495 * @param pkt packet on which the conversion will be performed
3496 * @param tb_src source timebase, in which the timing fields in pkt are
3498 * @param tb_dst destination timebase, to which the timing fields will be
3501 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
3508 * @addtogroup lavc_decoding
3513 * Find a registered decoder with a matching codec ID.
3515 * @param id AVCodecID of the requested decoder
3516 * @return A decoder if one was found, NULL otherwise.
3518 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3521 * Find a registered decoder with the specified name.
3523 * @param name name of the requested decoder
3524 * @return A decoder if one was found, NULL otherwise.
3526 AVCodec *avcodec_find_decoder_by_name(const char *name);
3528 #if FF_API_GET_BUFFER
3529 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3530 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3531 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3535 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3536 * it can be called by custom get_buffer2() implementations for decoders without
3537 * CODEC_CAP_DR1 set.
3539 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3543 * Return the amount of padding in pixels which the get_buffer callback must
3544 * provide around the edge of the image for codecs which do not have the
3545 * CODEC_FLAG_EMU_EDGE flag.
3547 * @return Required padding in pixels.
3549 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
3552 attribute_deprecated
3553 unsigned avcodec_get_edge_width(void);
3557 * Modify width and height values so that they will result in a memory
3558 * buffer that is acceptable for the codec if you do not use any horizontal
3561 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3563 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3566 * Modify width and height values so that they will result in a memory
3567 * buffer that is acceptable for the codec if you also ensure that all
3568 * line sizes are a multiple of the respective linesize_align[i].
3570 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3572 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3573 int linesize_align[AV_NUM_DATA_POINTERS]);
3576 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3578 * Some decoders may support multiple frames in a single AVPacket. Such
3579 * decoders would then just decode the first frame and the return value would be
3580 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3581 * called again with an AVPacket containing the remaining data in order to
3582 * decode the second frame, etc... Even if no frames are returned, the packet
3583 * needs to be fed to the decoder with remaining data until it is completely
3584 * consumed or an error occurs.
3586 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3587 * and output. This means that for some packets they will not immediately
3588 * produce decoded output and need to be flushed at the end of decoding to get
3589 * all the decoded data. Flushing is done by calling this function with packets
3590 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3591 * returning samples. It is safe to flush even those decoders that are not
3592 * marked with CODEC_CAP_DELAY, then no samples will be returned.
3594 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3595 * larger than the actual read bytes because some optimized bitstream
3596 * readers read 32 or 64 bits at once and could read over the end.
3598 * @param avctx the codec context
3599 * @param[out] frame The AVFrame in which to store decoded audio samples.
3600 * The decoder will allocate a buffer for the decoded frame by
3601 * calling the AVCodecContext.get_buffer2() callback.
3602 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3603 * reference counted and the returned reference belongs to the
3604 * caller. The caller must release the frame using av_frame_unref()
3605 * when the frame is no longer needed. The caller may safely write
3606 * to the frame if av_frame_is_writable() returns 1.
3607 * When AVCodecContext.refcounted_frames is set to 0, the returned
3608 * reference belongs to the decoder and is valid only until the
3609 * next call to this function or until closing or flushing the
3610 * decoder. The caller may not write to it.
3611 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3612 * non-zero. Note that this field being set to zero
3613 * does not mean that an error has occurred. For
3614 * decoders with CODEC_CAP_DELAY set, no given decode
3615 * call is guaranteed to produce a frame.
3616 * @param[in] avpkt The input AVPacket containing the input buffer.
3617 * At least avpkt->data and avpkt->size should be set. Some
3618 * decoders might also require additional fields to be set.
3619 * @return A negative error code is returned if an error occurred during
3620 * decoding, otherwise the number of bytes consumed from the input
3621 * AVPacket is returned.
3623 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3624 int *got_frame_ptr, AVPacket *avpkt);
3627 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3628 * Some decoders may support multiple frames in a single AVPacket, such
3629 * decoders would then just decode the first frame.
3631 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3632 * the actual read bytes because some optimized bitstream readers read 32 or 64
3633 * bits at once and could read over the end.
3635 * @warning The end of the input buffer buf should be set to 0 to ensure that
3636 * no overreading happens for damaged MPEG streams.
3638 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3639 * between input and output, these need to be fed with avpkt->data=NULL,
3640 * avpkt->size=0 at the end to return the remaining frames.
3642 * @param avctx the codec context
3643 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3644 * Use av_frame_alloc() to get an AVFrame. The codec will
3645 * allocate memory for the actual bitmap by calling the
3646 * AVCodecContext.get_buffer2() callback.
3647 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3648 * reference counted and the returned reference belongs to the
3649 * caller. The caller must release the frame using av_frame_unref()
3650 * when the frame is no longer needed. The caller may safely write
3651 * to the frame if av_frame_is_writable() returns 1.
3652 * When AVCodecContext.refcounted_frames is set to 0, the returned
3653 * reference belongs to the decoder and is valid only until the
3654 * next call to this function or until closing or flushing the
3655 * decoder. The caller may not write to it.
3657 * @param[in] avpkt The input AVpacket containing the input buffer.
3658 * You can create such packet with av_init_packet() and by then setting
3659 * data and size, some decoders might in addition need other fields like
3660 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3662 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3663 * @return On error a negative value is returned, otherwise the number of bytes
3664 * used or zero if no frame could be decompressed.
3666 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3667 int *got_picture_ptr,
3671 * Decode a subtitle message.
3672 * Return a negative value on error, otherwise return the number of bytes used.
3673 * If no subtitle could be decompressed, got_sub_ptr is zero.
3674 * Otherwise, the subtitle is stored in *sub.
3675 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3676 * simplicity, because the performance difference is expect to be negligible
3677 * and reusing a get_buffer written for video codecs would probably perform badly
3678 * due to a potentially very different allocation pattern.
3680 * @param avctx the codec context
3681 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3682 freed with avsubtitle_free if *got_sub_ptr is set.
3683 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3684 * @param[in] avpkt The input AVPacket containing the input buffer.
3686 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3691 * @defgroup lavc_parsing Frame parsing
3695 enum AVPictureStructure {
3696 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3697 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3698 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3699 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3702 typedef struct AVCodecParserContext {
3704 struct AVCodecParser *parser;
3705 int64_t frame_offset; /* offset of the current frame */
3706 int64_t cur_offset; /* current offset
3707 (incremented by each av_parser_parse()) */
3708 int64_t next_frame_offset; /* offset of the next frame */
3710 int pict_type; /* XXX: Put it back in AVCodecContext. */
3712 * This field is used for proper frame duration computation in lavf.
3713 * It signals, how much longer the frame duration of the current frame
3714 * is compared to normal frame duration.
3716 * frame_duration = (1 + repeat_pict) * time_base
3718 * It is used by codecs like H.264 to display telecined material.
3720 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3721 int64_t pts; /* pts of the current frame */
3722 int64_t dts; /* dts of the current frame */
3727 int fetch_timestamp;
3729 #define AV_PARSER_PTS_NB 4
3730 int cur_frame_start_index;
3731 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3732 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3733 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3736 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3737 #define PARSER_FLAG_ONCE 0x0002
3738 /// Set if the parser has a valid file offset
3739 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3741 int64_t offset; ///< byte offset from starting packet start
3742 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3745 * Set by parser to 1 for key frames and 0 for non-key frames.
3746 * It is initialized to -1, so if the parser doesn't set this flag,
3747 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3753 * Time difference in stream time base units from the pts of this
3754 * packet to the point at which the output from the decoder has converged
3755 * independent from the availability of previous frames. That is, the
3756 * frames are virtually identical no matter if decoding started from
3757 * the very first frame or from this keyframe.
3758 * Is AV_NOPTS_VALUE if unknown.
3759 * This field is not the display duration of the current frame.
3760 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3763 * The purpose of this field is to allow seeking in streams that have no
3764 * keyframes in the conventional sense. It corresponds to the
3765 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3766 * essential for some types of subtitle streams to ensure that all
3767 * subtitles are correctly displayed after seeking.
3769 int64_t convergence_duration;
3771 // Timestamp generation support:
3773 * Synchronization point for start of timestamp generation.
3775 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3778 * For example, this corresponds to presence of H.264 buffering period
3784 * Offset of the current timestamp against last timestamp sync point in
3785 * units of AVCodecContext.time_base.
3787 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3788 * contain a valid timestamp offset.
3790 * Note that the timestamp of sync point has usually a nonzero
3791 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3792 * the next frame after timestamp sync point will be usually 1.
3794 * For example, this corresponds to H.264 cpb_removal_delay.
3796 int dts_ref_dts_delta;
3799 * Presentation delay of current frame in units of AVCodecContext.time_base.
3801 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3802 * contain valid non-negative timestamp delta (presentation time of a frame
3803 * must not lie in the past).
3805 * This delay represents the difference between decoding and presentation
3806 * time of the frame.
3808 * For example, this corresponds to H.264 dpb_output_delay.
3813 * Position of the packet in file.
3815 * Analogous to cur_frame_pts/dts
3817 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3820 * Byte position of currently parsed frame in stream.
3825 * Previous frame byte position.
3830 * Duration of the current frame.
3831 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3832 * For all other types, this is in units of AVCodecContext.time_base.
3836 enum AVFieldOrder field_order;
3839 * Indicate whether a picture is coded as a frame, top field or bottom field.
3841 * For example, H.264 field_pic_flag equal to 0 corresponds to
3842 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3843 * equal to 1 and bottom_field_flag equal to 0 corresponds to
3844 * AV_PICTURE_STRUCTURE_TOP_FIELD.
3846 enum AVPictureStructure picture_structure;
3849 * Picture number incremented in presentation or output order.
3850 * This field may be reinitialized at the first picture of a new sequence.
3852 * For example, this corresponds to H.264 PicOrderCnt.
3854 int output_picture_number;
3855 } AVCodecParserContext;
3857 typedef struct AVCodecParser {
3858 int codec_ids[5]; /* several codec IDs are permitted */
3860 int (*parser_init)(AVCodecParserContext *s);
3861 int (*parser_parse)(AVCodecParserContext *s,
3862 AVCodecContext *avctx,
3863 const uint8_t **poutbuf, int *poutbuf_size,
3864 const uint8_t *buf, int buf_size);
3865 void (*parser_close)(AVCodecParserContext *s);
3866 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3867 struct AVCodecParser *next;
3870 AVCodecParser *av_parser_next(const AVCodecParser *c);
3872 void av_register_codec_parser(AVCodecParser *parser);
3873 AVCodecParserContext *av_parser_init(int codec_id);
3878 * @param s parser context.
3879 * @param avctx codec context.
3880 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3881 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3882 * @param buf input buffer.
3883 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3884 * @param pts input presentation timestamp.
3885 * @param dts input decoding timestamp.
3886 * @param pos input byte position in stream.
3887 * @return the number of bytes of the input bitstream used.
3892 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3899 * decode_frame(data, size);
3903 int av_parser_parse2(AVCodecParserContext *s,
3904 AVCodecContext *avctx,
3905 uint8_t **poutbuf, int *poutbuf_size,
3906 const uint8_t *buf, int buf_size,
3907 int64_t pts, int64_t dts,
3911 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3912 * @deprecated use AVBitstreamFilter
3914 int av_parser_change(AVCodecParserContext *s,
3915 AVCodecContext *avctx,
3916 uint8_t **poutbuf, int *poutbuf_size,
3917 const uint8_t *buf, int buf_size, int keyframe);
3918 void av_parser_close(AVCodecParserContext *s);
3926 * @addtogroup lavc_encoding
3931 * Find a registered encoder with a matching codec ID.
3933 * @param id AVCodecID of the requested encoder
3934 * @return An encoder if one was found, NULL otherwise.
3936 AVCodec *avcodec_find_encoder(enum AVCodecID id);
3939 * Find a registered encoder with the specified name.
3941 * @param name name of the requested encoder
3942 * @return An encoder if one was found, NULL otherwise.
3944 AVCodec *avcodec_find_encoder_by_name(const char *name);
3947 * Encode a frame of audio.
3949 * Takes input samples from frame and writes the next output packet, if
3950 * available, to avpkt. The output packet does not necessarily contain data for
3951 * the most recent frame, as encoders can delay, split, and combine input frames
3952 * internally as needed.
3954 * @param avctx codec context
3955 * @param avpkt output AVPacket.
3956 * The user can supply an output buffer by setting
3957 * avpkt->data and avpkt->size prior to calling the
3958 * function, but if the size of the user-provided data is not
3959 * large enough, encoding will fail. All other AVPacket fields
3960 * will be reset by the encoder using av_init_packet(). If
3961 * avpkt->data is NULL, the encoder will allocate it.
3962 * The encoder will set avpkt->size to the size of the
3965 * If this function fails or produces no output, avpkt will be
3966 * freed using av_free_packet() (i.e. avpkt->destruct will be
3967 * called to free the user supplied buffer).
3968 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3969 * May be NULL when flushing an encoder that has the
3970 * CODEC_CAP_DELAY capability set.
3971 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3972 * can have any number of samples.
3973 * If it is not set, frame->nb_samples must be equal to
3974 * avctx->frame_size for all frames except the last.
3975 * The final frame may be smaller than avctx->frame_size.
3976 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3977 * output packet is non-empty, and to 0 if it is
3978 * empty. If the function returns an error, the
3979 * packet can be assumed to be invalid, and the
3980 * value of got_packet_ptr is undefined and should
3982 * @return 0 on success, negative error code on failure
3984 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3985 const AVFrame *frame, int *got_packet_ptr);
3988 * Encode a frame of video.
3990 * Takes input raw video data from frame and writes the next output packet, if
3991 * available, to avpkt. The output packet does not necessarily contain data for
3992 * the most recent frame, as encoders can delay and reorder input frames
3993 * internally as needed.
3995 * @param avctx codec context
3996 * @param avpkt output AVPacket.
3997 * The user can supply an output buffer by setting
3998 * avpkt->data and avpkt->size prior to calling the
3999 * function, but if the size of the user-provided data is not
4000 * large enough, encoding will fail. All other AVPacket fields
4001 * will be reset by the encoder using av_init_packet(). If
4002 * avpkt->data is NULL, the encoder will allocate it.
4003 * The encoder will set avpkt->size to the size of the
4004 * output packet. The returned data (if any) belongs to the
4005 * caller, he is responsible for freeing it.
4007 * If this function fails or produces no output, avpkt will be
4008 * freed using av_free_packet() (i.e. avpkt->destruct will be
4009 * called to free the user supplied buffer).
4010 * @param[in] frame AVFrame containing the raw video data to be encoded.
4011 * May be NULL when flushing an encoder that has the
4012 * CODEC_CAP_DELAY capability set.
4013 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4014 * output packet is non-empty, and to 0 if it is
4015 * empty. If the function returns an error, the
4016 * packet can be assumed to be invalid, and the
4017 * value of got_packet_ptr is undefined and should
4019 * @return 0 on success, negative error code on failure
4021 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4022 const AVFrame *frame, int *got_packet_ptr);
4024 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4025 const AVSubtitle *sub);
4033 * @addtogroup lavc_picture
4038 * Allocate memory for a picture. Call avpicture_free() to free it.
4040 * @see avpicture_fill()
4042 * @param picture the picture to be filled in
4043 * @param pix_fmt the format of the picture
4044 * @param width the width of the picture
4045 * @param height the height of the picture
4046 * @return zero if successful, a negative value if not
4048 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4051 * Free a picture previously allocated by avpicture_alloc().
4052 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4055 * @param picture the AVPicture to be freed
4057 void avpicture_free(AVPicture *picture);
4060 * Fill in the AVPicture fields.
4061 * The fields of the given AVPicture are filled in by using the 'ptr' address
4062 * which points to the image data buffer. Depending on the specified picture
4063 * format, one or multiple image data pointers and line sizes will be set.
4064 * If a planar format is specified, several pointers will be set pointing to
4065 * the different picture planes and the line sizes of the different planes
4066 * will be stored in the lines_sizes array.
4067 * Call with ptr == NULL to get the required size for the ptr buffer.
4069 * To allocate the buffer and fill in the AVPicture fields in one call,
4070 * use avpicture_alloc().
4072 * @param picture AVPicture whose fields are to be filled in
4073 * @param ptr Buffer which will contain or contains the actual image data
4074 * @param pix_fmt The format in which the picture data is stored.
4075 * @param width the width of the image in pixels
4076 * @param height the height of the image in pixels
4077 * @return size of the image data in bytes
4079 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4080 enum AVPixelFormat pix_fmt, int width, int height);
4083 * Copy pixel data from an AVPicture into a buffer.
4084 * The data is stored compactly, without any gaps for alignment or padding
4085 * which may be applied by avpicture_fill().
4087 * @see avpicture_get_size()
4089 * @param[in] src AVPicture containing image data
4090 * @param[in] pix_fmt The format in which the picture data is stored.
4091 * @param[in] width the width of the image in pixels.
4092 * @param[in] height the height of the image in pixels.
4093 * @param[out] dest A buffer into which picture data will be copied.
4094 * @param[in] dest_size The size of 'dest'.
4095 * @return The number of bytes written to dest, or a negative value (error code) on error.
4097 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4098 int width, int height,
4099 unsigned char *dest, int dest_size);
4102 * Calculate the size in bytes that a picture of the given width and height
4103 * would occupy if stored in the given picture format.
4104 * Note that this returns the size of a compact representation as generated
4105 * by avpicture_layout(), which can be smaller than the size required for e.g.
4108 * @param pix_fmt the given picture format
4109 * @param width the width of the image
4110 * @param height the height of the image
4111 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
4113 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4115 #if FF_API_DEINTERLACE
4117 * deinterlace - if not supported return -1
4119 * @deprecated - use yadif (in libavfilter) instead
4121 attribute_deprecated
4122 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4123 enum AVPixelFormat pix_fmt, int width, int height);
4126 * Copy image src to dst. Wraps av_picture_data_copy() above.
4128 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4129 enum AVPixelFormat pix_fmt, int width, int height);
4132 * Crop image top and left side.
4134 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4135 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4140 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4141 int padtop, int padbottom, int padleft, int padright, int *color);
4148 * @defgroup lavc_misc Utility functions
4151 * Miscellaneous utility functions related to both encoding and decoding
4157 * @defgroup lavc_misc_pixfmt Pixel formats
4159 * Functions for working with pixel formats.
4164 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4167 void attribute_deprecated avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4170 * Return a value representing the fourCC code associated to the
4171 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4174 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4176 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4177 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4178 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4179 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4180 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4181 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4184 * Compute what kind of losses will occur when converting from one specific
4185 * pixel format to another.
4186 * When converting from one pixel format to another, information loss may occur.
4187 * For example, when converting from RGB24 to GRAY, the color information will
4188 * be lost. Similarly, other losses occur when converting from some formats to
4189 * other formats. These losses can involve loss of chroma, but also loss of
4190 * resolution, loss of color depth, loss due to the color space conversion, loss
4191 * of the alpha bits or loss due to color quantization.
4192 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4193 * which will occur when converting from one pixel format to another.
4195 * @param[in] dst_pix_fmt destination pixel format
4196 * @param[in] src_pix_fmt source pixel format
4197 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4198 * @return Combination of flags informing you what kind of losses will occur.
4200 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4204 * Find the best pixel format to convert to given a certain source pixel
4205 * format. When converting from one pixel format to another, information loss
4206 * may occur. For example, when converting from RGB24 to GRAY, the color
4207 * information will be lost. Similarly, other losses occur when converting from
4208 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4209 * the given pixel formats should be used to suffer the least amount of loss.
4210 * The pixel formats from which it chooses one, are determined by the
4211 * pix_fmt_list parameter.
4214 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4215 * @param[in] src_pix_fmt source pixel format
4216 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4217 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4218 * @return The best pixel format to convert to or -1 if none was found.
4220 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4221 enum AVPixelFormat src_pix_fmt,
4222 int has_alpha, int *loss_ptr);
4224 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4230 #if FF_API_SET_DIMENSIONS
4232 * @deprecated this function is not supposed to be used from outside of lavc
4234 attribute_deprecated
4235 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4239 * Put a string representing the codec tag codec_tag in buf.
4241 * @param buf buffer to place codec tag in
4242 * @param buf_size size in bytes of buf
4243 * @param codec_tag codec tag to assign
4244 * @return the length of the string that would have been generated if
4245 * enough space had been available, excluding the trailing null
4247 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4249 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4252 * Return a name for the specified profile, if available.
4254 * @param codec the codec that is searched for the given profile
4255 * @param profile the profile value for which a name is requested
4256 * @return A name for the profile if found, NULL otherwise.
4258 const char *av_get_profile_name(const AVCodec *codec, int profile);
4260 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4261 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4262 //FIXME func typedef
4265 * Fill audio frame data and linesize.
4266 * AVFrame extended_data channel pointers are allocated if necessary for
4269 * @param frame the AVFrame
4270 * frame->nb_samples must be set prior to calling the
4271 * function. This function fills in frame->data,
4272 * frame->extended_data, frame->linesize[0].
4273 * @param nb_channels channel count
4274 * @param sample_fmt sample format
4275 * @param buf buffer to use for frame data
4276 * @param buf_size size of buffer
4277 * @param align plane size sample alignment (0 = default)
4278 * @return 0 on success, negative error code on failure
4280 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4281 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4282 int buf_size, int align);
4285 * Reset the internal decoder state / flush internal buffers. Should be called
4286 * e.g. when seeking or when switching to a different stream.
4288 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4289 * this invalidates the frames previously returned from the decoder. When
4290 * refcounted frames are used, the decoder just releases any references it might
4291 * keep internally, but the caller's reference remains valid.
4293 void avcodec_flush_buffers(AVCodecContext *avctx);
4296 * Return codec bits per sample.
4298 * @param[in] codec_id the codec
4299 * @return Number of bits per sample or zero if unknown for the given codec.
4301 int av_get_bits_per_sample(enum AVCodecID codec_id);
4304 * Return codec bits per sample.
4305 * Only return non-zero if the bits per sample is exactly correct, not an
4308 * @param[in] codec_id the codec
4309 * @return Number of bits per sample or zero if unknown for the given codec.
4311 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4314 * Return audio frame duration.
4316 * @param avctx codec context
4317 * @param frame_bytes size of the frame, or 0 if unknown
4318 * @return frame duration, in samples, if known. 0 if not able to
4321 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4324 typedef struct AVBitStreamFilterContext {
4326 struct AVBitStreamFilter *filter;
4327 AVCodecParserContext *parser;
4328 struct AVBitStreamFilterContext *next;
4329 } AVBitStreamFilterContext;
4332 typedef struct AVBitStreamFilter {
4335 int (*filter)(AVBitStreamFilterContext *bsfc,
4336 AVCodecContext *avctx, const char *args,
4337 uint8_t **poutbuf, int *poutbuf_size,
4338 const uint8_t *buf, int buf_size, int keyframe);
4339 void (*close)(AVBitStreamFilterContext *bsfc);
4340 struct AVBitStreamFilter *next;
4341 } AVBitStreamFilter;
4343 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4344 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4345 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4346 AVCodecContext *avctx, const char *args,
4347 uint8_t **poutbuf, int *poutbuf_size,
4348 const uint8_t *buf, int buf_size, int keyframe);
4349 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4351 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
4356 * Allocate a buffer with padding, reusing the given one if large enough.
4358 * Same behaviour av_fast_malloc but the buffer has additional
4359 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4362 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4365 * Encode extradata length to a buffer. Used by xiph codecs.
4367 * @param s buffer to write to; must be at least (v/255+1) bytes long
4368 * @param v size of extradata in bytes
4369 * @return number of bytes written to the buffer.
4371 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4373 #if FF_API_MISSING_SAMPLE
4375 * Log a generic warning message about a missing feature. This function is
4376 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4377 * only, and would normally not be used by applications.
4378 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4379 * a pointer to an AVClass struct
4380 * @param[in] feature string containing the name of the missing feature
4381 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4382 * If want_sample is non-zero, additional verbage will be added to the log
4383 * message which tells the user how to report samples to the development
4385 * @deprecated Use avpriv_report_missing_feature() instead.
4387 attribute_deprecated
4388 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4391 * Log a generic warning message asking for a sample. This function is
4392 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4393 * only, and would normally not be used by applications.
4394 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4395 * a pointer to an AVClass struct
4396 * @param[in] msg string containing an optional message, or NULL if no message
4397 * @deprecated Use avpriv_request_sample() instead.
4399 attribute_deprecated
4400 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4401 #endif /* FF_API_MISSING_SAMPLE */
4404 * Register the hardware accelerator hwaccel.
4406 void av_register_hwaccel(AVHWAccel *hwaccel);
4409 * If hwaccel is NULL, returns the first registered hardware accelerator,
4410 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4411 * after hwaccel, or NULL if hwaccel is the last one.
4413 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
4417 * Lock operation used by lockmgr
4420 AV_LOCK_CREATE, ///< Create a mutex
4421 AV_LOCK_OBTAIN, ///< Lock the mutex
4422 AV_LOCK_RELEASE, ///< Unlock the mutex
4423 AV_LOCK_DESTROY, ///< Free mutex resources
4427 * Register a user provided lock manager supporting the operations
4428 * specified by AVLockOp. The "mutex" argument to the function points
4429 * to a (void *) where the lockmgr should store/get a pointer to a user
4430 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
4431 * value left by the last call for all other ops. If the lock manager is
4432 * unable to perform the op then it should leave the mutex in the same
4433 * state as when it was called and return a non-zero value. However,
4434 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
4435 * have been successfully destroyed. If av_lockmgr_register succeeds
4436 * it will return a non-negative value, if it fails it will return a
4437 * negative value and destroy all mutex and unregister all callbacks.
4438 * av_lockmgr_register is not thread-safe, it must be called from a
4439 * single thread before any calls which make use of locking are used.
4441 * @param cb User defined callback. av_lockmgr_register invokes calls
4442 * to this callback and the previously registered callback.
4443 * The callback will be used to create more than one mutex
4444 * each of which must be backed by its own underlying locking
4445 * mechanism (i.e. do not use a single static object to
4446 * implement your lock manager). If cb is set to NULL the
4447 * lockmgr will be unregistered.
4449 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4452 * Get the type of the given codec.
4454 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4457 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4458 * with no corresponding avcodec_close()), 0 otherwise.
4460 int avcodec_is_open(AVCodecContext *s);
4463 * @return a non-zero number if codec is an encoder, zero otherwise
4465 int av_codec_is_encoder(const AVCodec *codec);
4468 * @return a non-zero number if codec is a decoder, zero otherwise
4470 int av_codec_is_decoder(const AVCodec *codec);
4473 * @return descriptor for given codec ID or NULL if no descriptor exists.
4475 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4478 * Iterate over all codec descriptors known to libavcodec.
4480 * @param prev previous descriptor. NULL to get the first descriptor.
4482 * @return next descriptor or NULL after the last descriptor
4484 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4487 * @return codec descriptor with the given name or NULL if no such descriptor
4490 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4496 #endif /* AVCODEC_AVCODEC_H */