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;
1612 * Motion estimation threshold below which no motion estimation is
1613 * performed, but instead the user specified motion vectors are used.
1615 * - encoding: Set by user.
1616 * - decoding: unused
1621 * Macroblock threshold below which the user specified macroblock types will be used.
1622 * - encoding: Set by user.
1623 * - decoding: unused
1628 * precision of the intra DC coefficient - 8
1629 * - encoding: Set by user.
1630 * - decoding: unused
1632 int intra_dc_precision;
1635 * Number of macroblock rows at the top which are skipped.
1636 * - encoding: unused
1637 * - decoding: Set by user.
1642 * Number of macroblock rows at the bottom which are skipped.
1643 * - encoding: unused
1644 * - decoding: Set by user.
1649 * Border processing masking, raises the quantizer for mbs on the borders
1651 * - encoding: Set by user.
1652 * - decoding: unused
1654 float border_masking;
1657 * minimum MB lagrange multipler
1658 * - encoding: Set by user.
1659 * - decoding: unused
1664 * maximum MB lagrange multipler
1665 * - encoding: Set by user.
1666 * - decoding: unused
1672 * - encoding: Set by user.
1673 * - decoding: unused
1675 int me_penalty_compensation;
1679 * - encoding: Set by user.
1680 * - decoding: unused
1686 * - encoding: Set by user.
1687 * - decoding: unused
1693 * - encoding: Set by user.
1694 * - decoding: unused
1699 * number of reference frames
1700 * - encoding: Set by user.
1701 * - decoding: Set by lavc.
1706 * chroma qp offset from luma
1707 * - encoding: Set by user.
1708 * - decoding: unused
1712 #if FF_API_UNUSED_MEMBERS
1714 * Multiplied by qscale for each frame and added to scene_change_score.
1715 * - encoding: Set by user.
1716 * - decoding: unused
1718 attribute_deprecated int scenechange_factor;
1723 * Note: Value depends upon the compare function used for fullpel ME.
1724 * - encoding: Set by user.
1725 * - decoding: unused
1730 * Adjust sensitivity of b_frame_strategy 1.
1731 * - encoding: Set by user.
1732 * - decoding: unused
1737 * Chromaticity coordinates of the source primaries.
1738 * - encoding: Set by user
1739 * - decoding: Set by libavcodec
1741 enum AVColorPrimaries color_primaries;
1744 * Color Transfer Characteristic.
1745 * - encoding: Set by user
1746 * - decoding: Set by libavcodec
1748 enum AVColorTransferCharacteristic color_trc;
1751 * YUV colorspace type.
1752 * - encoding: Set by user
1753 * - decoding: Set by libavcodec
1755 enum AVColorSpace colorspace;
1758 * MPEG vs JPEG YUV range.
1759 * - encoding: Set by user
1760 * - decoding: Set by libavcodec
1762 enum AVColorRange color_range;
1765 * This defines the location of chroma samples.
1766 * - encoding: Set by user
1767 * - decoding: Set by libavcodec
1769 enum AVChromaLocation chroma_sample_location;
1773 * Indicates number of picture subdivisions. Used for parallelized
1775 * - encoding: Set by user
1776 * - decoding: unused
1781 * - encoding: set by libavcodec
1782 * - decoding: Set by libavcodec
1784 enum AVFieldOrder field_order;
1787 int sample_rate; ///< samples per second
1788 int channels; ///< number of audio channels
1791 * audio sample format
1792 * - encoding: Set by user.
1793 * - decoding: Set by libavcodec.
1795 enum AVSampleFormat sample_fmt; ///< sample format
1797 /* The following data should not be initialized. */
1799 * Number of samples per channel in an audio frame.
1801 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1802 * except the last must contain exactly frame_size samples per channel.
1803 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1804 * frame size is not restricted.
1805 * - decoding: may be set by some decoders to indicate constant frame size
1810 * Frame counter, set by libavcodec.
1812 * - decoding: total number of frames returned from the decoder so far.
1813 * - encoding: total number of frames passed to the encoder so far.
1815 * @note the counter is not incremented if encoding/decoding resulted in
1821 * number of bytes per packet if constant and known or 0
1822 * Used by some WAV based audio codecs.
1827 * Audio cutoff bandwidth (0 means "automatic")
1828 * - encoding: Set by user.
1829 * - decoding: unused
1833 #if FF_API_REQUEST_CHANNELS
1835 * Decoder should decode to this many channels if it can (0 for default)
1836 * - encoding: unused
1837 * - decoding: Set by user.
1838 * @deprecated Deprecated in favor of request_channel_layout.
1840 attribute_deprecated int request_channels;
1844 * Audio channel layout.
1845 * - encoding: set by user.
1846 * - decoding: set by libavcodec.
1848 uint64_t channel_layout;
1851 * Request decoder to use this channel layout if it can (0 for default)
1852 * - encoding: unused
1853 * - decoding: Set by user.
1855 uint64_t request_channel_layout;
1858 * Type of service that the audio stream conveys.
1859 * - encoding: Set by user.
1860 * - decoding: Set by libavcodec.
1862 enum AVAudioServiceType audio_service_type;
1865 * Used to request a sample format from the decoder.
1866 * - encoding: unused.
1867 * - decoding: Set by user.
1869 enum AVSampleFormat request_sample_fmt;
1871 #if FF_API_GET_BUFFER
1873 * Called at the beginning of each frame to get a buffer for it.
1875 * The function will set AVFrame.data[], AVFrame.linesize[].
1876 * AVFrame.extended_data[] must also be set, but it should be the same as
1877 * AVFrame.data[] except for planar audio with more channels than can fit
1878 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1879 * many data pointers as it can hold.
1881 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1882 * avcodec_default_get_buffer() instead of providing buffers allocated by
1885 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1886 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1887 * but if get_buffer() is overridden then alignment considerations should
1888 * be taken into account.
1890 * @see avcodec_default_get_buffer()
1894 * If pic.reference is set then the frame will be read later by libavcodec.
1895 * avcodec_align_dimensions2() should be used to find the required width and
1896 * height, as they normally need to be rounded up to the next multiple of 16.
1898 * If frame multithreading is used and thread_safe_callbacks is set,
1899 * it may be called from a different thread, but not from more than one at
1900 * once. Does not need to be reentrant.
1902 * @see release_buffer(), reget_buffer()
1903 * @see avcodec_align_dimensions2()
1907 * Decoders request a buffer of a particular size by setting
1908 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1909 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1910 * to a smaller value in the output frame.
1912 * Decoders cannot use the buffer after returning from
1913 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1914 * is assumed to be released immediately upon return. In some rare cases,
1915 * a decoder may need to call get_buffer() more than once in a single
1916 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
1917 * called again after it has already been called once, the previously
1918 * acquired buffer is assumed to be released at that time and may not be
1919 * reused by the decoder.
1921 * As a convenience, av_samples_get_buffer_size() and
1922 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1923 * functions to find the required data size and to fill data pointers and
1924 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1925 * since all planes must be the same size.
1927 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1929 * - encoding: unused
1930 * - decoding: Set by libavcodec, user can override.
1932 * @deprecated use get_buffer2()
1934 attribute_deprecated
1935 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1938 * Called to release buffers which were allocated with get_buffer.
1939 * A released buffer can be reused in get_buffer().
1940 * pic.data[*] must be set to NULL.
1941 * May be called from a different thread if frame multithreading is used,
1942 * but not by more than one thread at once, so does not need to be reentrant.
1943 * - encoding: unused
1944 * - decoding: Set by libavcodec, user can override.
1946 * @deprecated custom freeing callbacks should be set from get_buffer2()
1948 attribute_deprecated
1949 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1952 * Called at the beginning of a frame to get cr buffer for it.
1953 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1954 * libavcodec will pass previous buffer in pic, function should return
1955 * same buffer or new buffer with old frame "painted" into it.
1956 * If pic.data[0] == NULL must behave like get_buffer().
1957 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
1958 * avcodec_default_reget_buffer() instead of providing buffers allocated by
1960 * - encoding: unused
1961 * - decoding: Set by libavcodec, user can override.
1963 attribute_deprecated
1964 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1968 * This callback is called at the beginning of each frame to get data
1969 * buffer(s) for it. There may be one contiguous buffer for all the data or
1970 * there may be a buffer per each data plane or anything in between. What
1971 * this means is, you may set however many entries in buf[] you feel necessary.
1972 * Each buffer must be reference-counted using the AVBuffer API (see description
1975 * The following fields will be set in the frame before this callback is
1978 * - width, height (video only)
1979 * - sample_rate, channel_layout, nb_samples (audio only)
1980 * Their values may differ from the corresponding values in
1981 * AVCodecContext. This callback must use the frame values, not the codec
1982 * context values, to calculate the required buffer size.
1984 * This callback must fill the following fields in the frame:
1988 * * if the data is planar audio with more than 8 channels, then this
1989 * callback must allocate and fill extended_data to contain all pointers
1990 * to all data planes. data[] must hold as many pointers as it can.
1991 * extended_data must be allocated with av_malloc() and will be freed in
1993 * * otherwise exended_data must point to data
1994 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1995 * the frame's data and extended_data pointers must be contained in these. That
1996 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1997 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1998 * and av_buffer_ref().
1999 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2000 * this callback and filled with the extra buffers if there are more
2001 * buffers than buf[] can hold. extended_buf will be freed in
2004 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2005 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2008 * Each data plane must be aligned to the maximum required by the target
2011 * @see avcodec_default_get_buffer2()
2015 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2016 * (read and/or written to if it is writable) later by libavcodec.
2018 * avcodec_align_dimensions2() should be used to find the required width and
2019 * height, as they normally need to be rounded up to the next multiple of 16.
2021 * If frame multithreading is used and thread_safe_callbacks is set,
2022 * this callback may be called from a different thread, but not from more
2023 * than one at once. Does not need to be reentrant.
2025 * @see avcodec_align_dimensions2()
2029 * Decoders request a buffer of a particular size by setting
2030 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2031 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2032 * to a smaller value in the output frame.
2034 * As a convenience, av_samples_get_buffer_size() and
2035 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2036 * functions to find the required data size and to fill data pointers and
2037 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2038 * since all planes must be the same size.
2040 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2042 * - encoding: unused
2043 * - decoding: Set by libavcodec, user can override.
2045 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2048 * If non-zero, the decoded audio and video frames returned from
2049 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2050 * and are valid indefinitely. The caller must free them with
2051 * av_frame_unref() when they are not needed anymore.
2052 * Otherwise, the decoded frames must not be freed by the caller and are
2053 * only valid until the next decode call.
2055 * - encoding: unused
2056 * - decoding: set by the caller before avcodec_open2().
2058 int refcounted_frames;
2060 /* - encoding parameters */
2061 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2062 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2066 * - encoding: Set by user.
2067 * - decoding: unused
2073 * - encoding: Set by user.
2074 * - decoding: unused
2079 * maximum quantizer difference between frames
2080 * - encoding: Set by user.
2081 * - decoding: unused
2087 * @deprecated use encoder private options instead
2089 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;
2112 * rate control equation
2113 * - encoding: Set by user
2114 * - decoding: unused
2120 * - encoding: Set by user.
2121 * - decoding: unused
2127 * - encoding: Set by user.
2128 * - decoding: unused
2132 float rc_buffer_aggressivity;
2135 * initial complexity for pass1 ratecontrol
2136 * - encoding: Set by user.
2137 * - decoding: unused
2139 float rc_initial_cplx;
2142 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2143 * - encoding: Set by user.
2144 * - decoding: unused.
2146 float rc_max_available_vbv_use;
2149 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2150 * - encoding: Set by user.
2151 * - decoding: unused.
2153 float rc_min_vbv_overflow_use;
2156 * Number of bits which should be loaded into the rc buffer before decoding starts.
2157 * - encoding: Set by user.
2158 * - decoding: unused
2160 int rc_initial_buffer_occupancy;
2162 #define FF_CODER_TYPE_VLC 0
2163 #define FF_CODER_TYPE_AC 1
2164 #define FF_CODER_TYPE_RAW 2
2165 #define FF_CODER_TYPE_RLE 3
2166 #if FF_API_UNUSED_MEMBERS
2167 #define FF_CODER_TYPE_DEFLATE 4
2168 #endif /* FF_API_UNUSED_MEMBERS */
2171 * - encoding: Set by user.
2172 * - decoding: unused
2178 * - encoding: Set by user.
2179 * - decoding: unused
2184 * minimum Lagrange multipler
2185 * - encoding: Set by user.
2186 * - decoding: unused
2191 * maximum Lagrange multipler
2192 * - encoding: Set by user.
2193 * - decoding: unused
2198 * frame skip threshold
2199 * - encoding: Set by user.
2200 * - decoding: unused
2202 int frame_skip_threshold;
2206 * - encoding: Set by user.
2207 * - decoding: unused
2209 int frame_skip_factor;
2212 * frame skip exponent
2213 * - encoding: Set by user.
2214 * - decoding: unused
2219 * frame skip comparison function
2220 * - encoding: Set by user.
2221 * - decoding: unused
2226 * trellis RD quantization
2227 * - encoding: Set by user.
2228 * - decoding: unused
2233 * - encoding: Set by user.
2234 * - decoding: unused
2236 int min_prediction_order;
2239 * - encoding: Set by user.
2240 * - decoding: unused
2242 int max_prediction_order;
2245 * GOP timecode frame start number, in non drop frame format
2246 * - encoding: Set by user.
2247 * - decoding: unused
2249 int64_t timecode_frame_start;
2251 /* The RTP callback: This function is called */
2252 /* every time the encoder has a packet to send. */
2253 /* It depends on the encoder if the data starts */
2254 /* with a Start Code (it should). H.263 does. */
2255 /* mb_nb contains the number of macroblocks */
2256 /* encoded in the RTP payload. */
2257 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2259 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2260 /* do its best to deliver a chunk with size */
2261 /* below rtp_payload_size, the chunk will start */
2262 /* with a start code on some codecs like H.263. */
2263 /* This doesn't take account of any particular */
2264 /* headers inside the transmitted RTP payload. */
2266 /* statistics, used for 2-pass encoding */
2277 * number of bits used for the previously encoded frame
2278 * - encoding: Set by libavcodec.
2279 * - decoding: unused
2284 * pass1 encoding statistics output buffer
2285 * - encoding: Set by libavcodec.
2286 * - decoding: unused
2291 * pass2 encoding statistics input buffer
2292 * Concatenated stuff from stats_out of pass1 should be placed here.
2293 * - encoding: Allocated/set/freed by user.
2294 * - decoding: unused
2299 * Work around bugs in encoders which sometimes cannot be detected automatically.
2300 * - encoding: Set by user
2301 * - decoding: Set by user
2303 int workaround_bugs;
2304 #define FF_BUG_AUTODETECT 1 ///< autodetection
2305 #if FF_API_OLD_MSMPEG4
2306 #define FF_BUG_OLD_MSMPEG4 2
2308 #define FF_BUG_XVID_ILACE 4
2309 #define FF_BUG_UMP4 8
2310 #define FF_BUG_NO_PADDING 16
2311 #define FF_BUG_AMV 32
2313 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2315 #define FF_BUG_QPEL_CHROMA 64
2316 #define FF_BUG_STD_QPEL 128
2317 #define FF_BUG_QPEL_CHROMA2 256
2318 #define FF_BUG_DIRECT_BLOCKSIZE 512
2319 #define FF_BUG_EDGE 1024
2320 #define FF_BUG_HPEL_CHROMA 2048
2321 #define FF_BUG_DC_CLIP 4096
2322 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2323 #define FF_BUG_TRUNCATED 16384
2326 * strictly follow the standard (MPEG4, ...).
2327 * - encoding: Set by user.
2328 * - decoding: Set by user.
2329 * Setting this to STRICT or higher means the encoder and decoder will
2330 * generally do stupid things, whereas setting it to unofficial or lower
2331 * will mean the encoder might produce output that is not supported by all
2332 * spec-compliant decoders. Decoders don't differentiate between normal,
2333 * unofficial and experimental (that is, they always try to decode things
2334 * when they can) unless they are explicitly asked to behave stupidly
2335 * (=strictly conform to the specs)
2337 int strict_std_compliance;
2338 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2339 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2340 #define FF_COMPLIANCE_NORMAL 0
2341 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2342 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2345 * error concealment flags
2346 * - encoding: unused
2347 * - decoding: Set by user.
2349 int error_concealment;
2350 #define FF_EC_GUESS_MVS 1
2351 #define FF_EC_DEBLOCK 2
2355 * - encoding: Set by user.
2356 * - decoding: Set by user.
2359 #define FF_DEBUG_PICT_INFO 1
2360 #define FF_DEBUG_RC 2
2361 #define FF_DEBUG_BITSTREAM 4
2362 #define FF_DEBUG_MB_TYPE 8
2363 #define FF_DEBUG_QP 16
2366 * @deprecated this option does nothing
2368 #define FF_DEBUG_MV 32
2370 #define FF_DEBUG_DCT_COEFF 0x00000040
2371 #define FF_DEBUG_SKIP 0x00000080
2372 #define FF_DEBUG_STARTCODE 0x00000100
2373 #if FF_API_UNUSED_MEMBERS
2374 #define FF_DEBUG_PTS 0x00000200
2375 #endif /* FF_API_UNUSED_MEMBERS */
2376 #define FF_DEBUG_ER 0x00000400
2377 #define FF_DEBUG_MMCO 0x00000800
2378 #define FF_DEBUG_BUGS 0x00001000
2380 #define FF_DEBUG_VIS_QP 0x00002000
2381 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2383 #define FF_DEBUG_BUFFERS 0x00008000
2384 #define FF_DEBUG_THREADS 0x00010000
2388 * @deprecated this option does not have any effect
2390 attribute_deprecated
2392 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2393 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2394 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2398 * Error recognition; may misdetect some more or less valid parts as errors.
2399 * - encoding: unused
2400 * - decoding: Set by user.
2402 int err_recognition;
2405 * Verify checksums embedded in the bitstream (could be of either encoded or
2406 * decoded data, depending on the codec) and print an error message on mismatch.
2407 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2408 * decoder returning an error.
2410 #define AV_EF_CRCCHECK (1<<0)
2411 #define AV_EF_BITSTREAM (1<<1)
2412 #define AV_EF_BUFFER (1<<2)
2413 #define AV_EF_EXPLODE (1<<3)
2416 * opaque 64bit number (generally a PTS) that will be reordered and
2417 * output in AVFrame.reordered_opaque
2418 * - encoding: unused
2419 * - decoding: Set by user.
2421 int64_t reordered_opaque;
2424 * Hardware accelerator in use
2425 * - encoding: unused.
2426 * - decoding: Set by libavcodec
2428 struct AVHWAccel *hwaccel;
2431 * Hardware accelerator context.
2432 * For some hardware accelerators, a global context needs to be
2433 * provided by the user. In that case, this holds display-dependent
2434 * data Libav cannot instantiate itself. Please refer to the
2435 * Libav HW accelerator documentation to know how to fill this
2436 * is. e.g. for VA API, this is a struct vaapi_context.
2437 * - encoding: unused
2438 * - decoding: Set by user
2440 void *hwaccel_context;
2444 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2445 * - decoding: unused
2447 uint64_t error[AV_NUM_DATA_POINTERS];
2450 * DCT algorithm, see FF_DCT_* below
2451 * - encoding: Set by user.
2452 * - decoding: unused
2455 #define FF_DCT_AUTO 0
2456 #define FF_DCT_FASTINT 1
2457 #if FF_API_UNUSED_MEMBERS
2458 #define FF_DCT_INT 2
2459 #endif /* FF_API_UNUSED_MEMBERS */
2460 #define FF_DCT_MMX 3
2461 #define FF_DCT_ALTIVEC 5
2462 #define FF_DCT_FAAN 6
2465 * IDCT algorithm, see FF_IDCT_* below.
2466 * - encoding: Set by user.
2467 * - decoding: Set by user.
2470 #define FF_IDCT_AUTO 0
2471 #define FF_IDCT_INT 1
2472 #define FF_IDCT_SIMPLE 2
2473 #define FF_IDCT_SIMPLEMMX 3
2474 #define FF_IDCT_ARM 7
2475 #define FF_IDCT_ALTIVEC 8
2477 #define FF_IDCT_SH4 9
2479 #define FF_IDCT_SIMPLEARM 10
2480 #if FF_API_UNUSED_MEMBERS
2481 #define FF_IDCT_IPP 13
2482 #endif /* FF_API_UNUSED_MEMBERS */
2483 #define FF_IDCT_XVID 14
2484 #if FF_API_IDCT_XVIDMMX
2485 #define FF_IDCT_XVIDMMX 14
2486 #endif /* FF_API_IDCT_XVIDMMX */
2487 #define FF_IDCT_SIMPLEARMV5TE 16
2488 #define FF_IDCT_SIMPLEARMV6 17
2489 #if FF_API_ARCH_SPARC
2490 #define FF_IDCT_SIMPLEVIS 18
2492 #define FF_IDCT_FAAN 20
2493 #define FF_IDCT_SIMPLENEON 22
2494 #if FF_API_ARCH_ALPHA
2495 #define FF_IDCT_SIMPLEALPHA 23
2499 * bits per sample/pixel from the demuxer (needed for huffyuv).
2500 * - encoding: Set by libavcodec.
2501 * - decoding: Set by user.
2503 int bits_per_coded_sample;
2506 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2507 * - encoding: set by user.
2508 * - decoding: set by libavcodec.
2510 int bits_per_raw_sample;
2514 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2515 * - encoding: unused
2516 * - decoding: Set by user.
2518 * @deprecated use decoder private options instead
2520 attribute_deprecated int lowres;
2524 * the picture in the bitstream
2525 * - encoding: Set by libavcodec.
2526 * - decoding: unused
2528 AVFrame *coded_frame;
2532 * is used to decide how many independent tasks should be passed to execute()
2533 * - encoding: Set by user.
2534 * - decoding: Set by user.
2539 * Which multithreading methods to use.
2540 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2541 * so clients which cannot provide future frames should not use it.
2543 * - encoding: Set by user, otherwise the default is used.
2544 * - decoding: Set by user, otherwise the default is used.
2547 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2548 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2551 * Which multithreading methods are in use by the codec.
2552 * - encoding: Set by libavcodec.
2553 * - decoding: Set by libavcodec.
2555 int active_thread_type;
2558 * Set by the client if its custom get_buffer() callback can be called
2559 * synchronously from another thread, which allows faster multithreaded decoding.
2560 * draw_horiz_band() will be called from other threads regardless of this setting.
2561 * Ignored if the default get_buffer() is used.
2562 * - encoding: Set by user.
2563 * - decoding: Set by user.
2565 int thread_safe_callbacks;
2568 * The codec may call this to execute several independent things.
2569 * It will return only after finishing all tasks.
2570 * The user may replace this with some multithreaded implementation,
2571 * the default implementation will execute the parts serially.
2572 * @param count the number of things to execute
2573 * - encoding: Set by libavcodec, user can override.
2574 * - decoding: Set by libavcodec, user can override.
2576 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2579 * The codec may call this to execute several independent things.
2580 * It will return only after finishing all tasks.
2581 * The user may replace this with some multithreaded implementation,
2582 * the default implementation will execute the parts serially.
2583 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2584 * @param c context passed also to func
2585 * @param count the number of things to execute
2586 * @param arg2 argument passed unchanged to func
2587 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2588 * @param func function that will be called count times, with jobnr from 0 to count-1.
2589 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2590 * two instances of func executing at the same time will have the same threadnr.
2591 * @return always 0 currently, but code should handle a future improvement where when any call to func
2592 * returns < 0 no further calls to func may be done and < 0 is returned.
2593 * - encoding: Set by libavcodec, user can override.
2594 * - decoding: Set by libavcodec, user can override.
2596 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2598 #if FF_API_THREAD_OPAQUE
2600 * @deprecated this field should not be used from outside of lavc
2602 attribute_deprecated
2603 void *thread_opaque;
2607 * noise vs. sse weight for the nsse comparsion function
2608 * - encoding: Set by user.
2609 * - decoding: unused
2615 * - encoding: Set by user.
2616 * - decoding: Set by libavcodec.
2619 #define FF_PROFILE_UNKNOWN -99
2620 #define FF_PROFILE_RESERVED -100
2622 #define FF_PROFILE_AAC_MAIN 0
2623 #define FF_PROFILE_AAC_LOW 1
2624 #define FF_PROFILE_AAC_SSR 2
2625 #define FF_PROFILE_AAC_LTP 3
2626 #define FF_PROFILE_AAC_HE 4
2627 #define FF_PROFILE_AAC_HE_V2 28
2628 #define FF_PROFILE_AAC_LD 22
2629 #define FF_PROFILE_AAC_ELD 38
2630 #define FF_PROFILE_MPEG2_AAC_LOW 128
2631 #define FF_PROFILE_MPEG2_AAC_HE 131
2633 #define FF_PROFILE_DTS 20
2634 #define FF_PROFILE_DTS_ES 30
2635 #define FF_PROFILE_DTS_96_24 40
2636 #define FF_PROFILE_DTS_HD_HRA 50
2637 #define FF_PROFILE_DTS_HD_MA 60
2639 #define FF_PROFILE_MPEG2_422 0
2640 #define FF_PROFILE_MPEG2_HIGH 1
2641 #define FF_PROFILE_MPEG2_SS 2
2642 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2643 #define FF_PROFILE_MPEG2_MAIN 4
2644 #define FF_PROFILE_MPEG2_SIMPLE 5
2646 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2647 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2649 #define FF_PROFILE_H264_BASELINE 66
2650 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2651 #define FF_PROFILE_H264_MAIN 77
2652 #define FF_PROFILE_H264_EXTENDED 88
2653 #define FF_PROFILE_H264_HIGH 100
2654 #define FF_PROFILE_H264_HIGH_10 110
2655 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2656 #define FF_PROFILE_H264_HIGH_422 122
2657 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2658 #define FF_PROFILE_H264_HIGH_444 144
2659 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2660 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2661 #define FF_PROFILE_H264_CAVLC_444 44
2663 #define FF_PROFILE_VC1_SIMPLE 0
2664 #define FF_PROFILE_VC1_MAIN 1
2665 #define FF_PROFILE_VC1_COMPLEX 2
2666 #define FF_PROFILE_VC1_ADVANCED 3
2668 #define FF_PROFILE_MPEG4_SIMPLE 0
2669 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2670 #define FF_PROFILE_MPEG4_CORE 2
2671 #define FF_PROFILE_MPEG4_MAIN 3
2672 #define FF_PROFILE_MPEG4_N_BIT 4
2673 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2674 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2675 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2676 #define FF_PROFILE_MPEG4_HYBRID 8
2677 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2678 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2679 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2680 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2681 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2682 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2683 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2685 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2686 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2687 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2688 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2689 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2692 #define FF_PROFILE_HEVC_MAIN 1
2693 #define FF_PROFILE_HEVC_MAIN_10 2
2694 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2698 * - encoding: Set by user.
2699 * - decoding: Set by libavcodec.
2702 #define FF_LEVEL_UNKNOWN -99
2706 * - encoding: unused
2707 * - decoding: Set by user.
2709 enum AVDiscard skip_loop_filter;
2713 * - encoding: unused
2714 * - decoding: Set by user.
2716 enum AVDiscard skip_idct;
2720 * - encoding: unused
2721 * - decoding: Set by user.
2723 enum AVDiscard skip_frame;
2726 * Header containing style information for text subtitles.
2727 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2728 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2729 * the Format line following. It shouldn't include any Dialogue line.
2730 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2731 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2733 uint8_t *subtitle_header;
2734 int subtitle_header_size;
2736 #if FF_API_ERROR_RATE
2738 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2741 attribute_deprecated
2745 #if FF_API_CODEC_PKT
2747 * @deprecated this field is not supposed to be accessed from outside lavc
2749 attribute_deprecated
2754 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2755 * Used for compliant TS muxing.
2756 * - encoding: Set by libavcodec.
2757 * - decoding: unused.
2762 * Encoding only. Allow encoders to output packets that do not contain any
2763 * encoded data, only side data.
2765 * Some encoders need to output such packets, e.g. to update some stream
2766 * parameters at the end of encoding.
2768 * All callers are strongly recommended to set this option to 1 and update
2769 * their code to deal with such packets, since this behaviour may become
2770 * always enabled in the future (then this option will be deprecated and
2771 * later removed). To avoid ABI issues when this happens, the callers should
2772 * use AVOptions to set this field.
2774 int side_data_only_packets;
2777 * Audio only. The number of "priming" samples (padding) inserted by the
2778 * encoder at the beginning of the audio. I.e. this number of leading
2779 * decoded samples must be discarded by the caller to get the original audio
2780 * without leading padding.
2782 * - decoding: unused
2783 * - encoding: Set by libavcodec. The timestamps on the output packets are
2784 * adjusted by the encoder so that they always refer to the
2785 * first sample of the data actually contained in the packet,
2786 * including any added padding. E.g. if the timebase is
2787 * 1/samplerate and the timestamp of the first input sample is
2788 * 0, the timestamp of the first output packet will be
2791 int initial_padding;
2794 * - decoding: For codecs that store a framerate value in the compressed
2795 * bitstream, the decoder may export it here. { 0, 1} when
2797 * - encoding: unused
2799 AVRational framerate;
2805 typedef struct AVProfile {
2807 const char *name; ///< short name for the profile
2810 typedef struct AVCodecDefault AVCodecDefault;
2817 typedef struct AVCodec {
2819 * Name of the codec implementation.
2820 * The name is globally unique among encoders and among decoders (but an
2821 * encoder and a decoder can share the same name).
2822 * This is the primary way to find a codec from the user perspective.
2826 * Descriptive name for the codec, meant to be more human readable than name.
2827 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2829 const char *long_name;
2830 enum AVMediaType type;
2833 * Codec capabilities.
2837 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2838 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2839 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2840 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2841 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2843 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2845 const AVClass *priv_class; ///< AVClass for the private context
2846 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2848 /*****************************************************************
2849 * No fields below this line are part of the public API. They
2850 * may not be used outside of libavcodec and can be changed and
2852 * New public fields should be added right above.
2853 *****************************************************************
2856 struct AVCodec *next;
2858 * @name Frame-level threading support functions
2862 * If defined, called on thread contexts when they are created.
2863 * If the codec allocates writable tables in init(), re-allocate them here.
2864 * priv_data will be set to a copy of the original.
2866 int (*init_thread_copy)(AVCodecContext *);
2868 * Copy necessary context variables from a previous thread context to the current one.
2869 * If not defined, the next thread will start automatically; otherwise, the codec
2870 * must call ff_thread_finish_setup().
2872 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2874 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2878 * Private codec-specific defaults.
2880 const AVCodecDefault *defaults;
2883 * Initialize codec static data, called from avcodec_register().
2885 void (*init_static_data)(struct AVCodec *codec);
2887 int (*init)(AVCodecContext *);
2888 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2889 const struct AVSubtitle *sub);
2891 * Encode data to an AVPacket.
2893 * @param avctx codec context
2894 * @param avpkt output AVPacket (may contain a user-provided buffer)
2895 * @param[in] frame AVFrame containing the raw data to be encoded
2896 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2897 * non-empty packet was returned in avpkt.
2898 * @return 0 on success, negative error code on failure
2900 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2901 int *got_packet_ptr);
2902 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2903 int (*close)(AVCodecContext *);
2906 * Will be called when seeking
2908 void (*flush)(AVCodecContext *);
2912 * @defgroup lavc_hwaccel AVHWAccel
2915 typedef struct AVHWAccel {
2917 * Name of the hardware accelerated codec.
2918 * The name is globally unique among encoders and among decoders (but an
2919 * encoder and a decoder can share the same name).
2924 * Type of codec implemented by the hardware accelerator.
2926 * See AVMEDIA_TYPE_xxx
2928 enum AVMediaType type;
2931 * Codec implemented by the hardware accelerator.
2933 * See AV_CODEC_ID_xxx
2938 * Supported pixel format.
2940 * Only hardware accelerated formats are supported here.
2942 enum AVPixelFormat pix_fmt;
2945 * Hardware accelerated codec capabilities.
2946 * see FF_HWACCEL_CODEC_CAP_*
2950 /*****************************************************************
2951 * No fields below this line are part of the public API. They
2952 * may not be used outside of libavcodec and can be changed and
2954 * New public fields should be added right above.
2955 *****************************************************************
2957 struct AVHWAccel *next;
2960 * Allocate a custom buffer
2962 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
2965 * Called at the beginning of each frame or field picture.
2967 * Meaningful frame information (codec specific) is guaranteed to
2968 * be parsed at this point. This function is mandatory.
2970 * Note that buf can be NULL along with buf_size set to 0.
2971 * Otherwise, this means the whole frame is available at this point.
2973 * @param avctx the codec context
2974 * @param buf the frame data buffer base
2975 * @param buf_size the size of the frame in bytes
2976 * @return zero if successful, a negative value otherwise
2978 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2981 * Callback for each slice.
2983 * Meaningful slice information (codec specific) is guaranteed to
2984 * be parsed at this point. This function is mandatory.
2986 * @param avctx the codec context
2987 * @param buf the slice data buffer base
2988 * @param buf_size the size of the slice in bytes
2989 * @return zero if successful, a negative value otherwise
2991 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2994 * Called at the end of each frame or field picture.
2996 * The whole picture is parsed at this point and can now be sent
2997 * to the hardware accelerator. This function is mandatory.
2999 * @param avctx the codec context
3000 * @return zero if successful, a negative value otherwise
3002 int (*end_frame)(AVCodecContext *avctx);
3005 * Size of per-frame hardware accelerator private data.
3007 * Private data is allocated with av_mallocz() before
3008 * AVCodecContext.get_buffer() and deallocated after
3009 * AVCodecContext.release_buffer().
3011 int frame_priv_data_size;
3014 * Initialize the hwaccel private data.
3016 * This will be called from ff_get_format(), after hwaccel and
3017 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3020 int (*init)(AVCodecContext *avctx);
3023 * Uninitialize the hwaccel private data.
3025 * This will be called from get_format() or avcodec_close(), after hwaccel
3026 * and hwaccel_context are already uninitialized.
3028 int (*uninit)(AVCodecContext *avctx);
3031 * Size of the private data to allocate in
3032 * AVCodecInternal.hwaccel_priv_data.
3038 * Hardware acceleration should be used for decoding even if the codec level
3039 * used is unknown or higher than the maximum supported level reported by the
3042 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3049 * @defgroup lavc_picture AVPicture
3051 * Functions for working with AVPicture
3056 * four components are given, that's all.
3057 * the last component is alpha
3059 typedef struct AVPicture {
3060 uint8_t *data[AV_NUM_DATA_POINTERS];
3061 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3068 #define AVPALETTE_SIZE 1024
3069 #define AVPALETTE_COUNT 256
3071 enum AVSubtitleType {
3074 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3077 * Plain text, the text field must be set by the decoder and is
3078 * authoritative. ass and pict fields may contain approximations.
3083 * Formatted text, the ass field must be set by the decoder and is
3084 * authoritative. pict and text fields may contain approximations.
3089 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3091 typedef struct AVSubtitleRect {
3092 int x; ///< top left corner of pict, undefined when pict is not set
3093 int y; ///< top left corner of pict, undefined when pict is not set
3094 int w; ///< width of pict, undefined when pict is not set
3095 int h; ///< height of pict, undefined when pict is not set
3096 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3099 * data+linesize for the bitmap of this subtitle.
3100 * can be set for text/ass as well once they where rendered
3103 enum AVSubtitleType type;
3105 char *text; ///< 0 terminated plain UTF-8 text
3108 * 0 terminated ASS/SSA compatible event line.
3109 * The pressentation of this is unaffected by the other values in this
3116 typedef struct AVSubtitle {
3117 uint16_t format; /* 0 = graphics */
3118 uint32_t start_display_time; /* relative to packet pts, in ms */
3119 uint32_t end_display_time; /* relative to packet pts, in ms */
3121 AVSubtitleRect **rects;
3122 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3126 * If c is NULL, returns the first registered codec,
3127 * if c is non-NULL, returns the next registered codec after c,
3128 * or NULL if c is the last one.
3130 AVCodec *av_codec_next(const AVCodec *c);
3133 * Return the LIBAVCODEC_VERSION_INT constant.
3135 unsigned avcodec_version(void);
3138 * Return the libavcodec build-time configuration.
3140 const char *avcodec_configuration(void);
3143 * Return the libavcodec license.
3145 const char *avcodec_license(void);
3148 * Register the codec codec and initialize libavcodec.
3150 * @warning either this function or avcodec_register_all() must be called
3151 * before any other libavcodec functions.
3153 * @see avcodec_register_all()
3155 void avcodec_register(AVCodec *codec);
3158 * Register all the codecs, parsers and bitstream filters which were enabled at
3159 * configuration time. If you do not call this function you can select exactly
3160 * which formats you want to support, by using the individual registration
3163 * @see avcodec_register
3164 * @see av_register_codec_parser
3165 * @see av_register_bitstream_filter
3167 void avcodec_register_all(void);
3170 * Allocate an AVCodecContext and set its fields to default values. The
3171 * resulting struct should be freed with avcodec_free_context().
3173 * @param codec if non-NULL, allocate private data and initialize defaults
3174 * for the given codec. It is illegal to then call avcodec_open2()
3175 * with a different codec.
3176 * If NULL, then the codec-specific defaults won't be initialized,
3177 * which may result in suboptimal default settings (this is
3178 * important mainly for encoders, e.g. libx264).
3180 * @return An AVCodecContext filled with default values or NULL on failure.
3181 * @see avcodec_get_context_defaults
3183 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3186 * Free the codec context and everything associated with it and write NULL to
3187 * the provided pointer.
3189 void avcodec_free_context(AVCodecContext **avctx);
3192 * Set the fields of the given AVCodecContext to default values corresponding
3193 * to the given codec (defaults may be codec-dependent).
3195 * Do not call this function if a non-NULL codec has been passed
3196 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3197 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3198 * different codec on this AVCodecContext.
3200 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3203 * Get the AVClass for AVCodecContext. It can be used in combination with
3204 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3206 * @see av_opt_find().
3208 const AVClass *avcodec_get_class(void);
3211 * Copy the settings of the source AVCodecContext into the destination
3212 * AVCodecContext. The resulting destination codec context will be
3213 * unopened, i.e. you are required to call avcodec_open2() before you
3214 * can use this AVCodecContext to decode/encode video/audio data.
3216 * @param dest target codec context, should be initialized with
3217 * avcodec_alloc_context3(), but otherwise uninitialized
3218 * @param src source codec context
3219 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3221 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3223 #if FF_API_AVFRAME_LAVC
3225 * @deprecated use av_frame_alloc()
3227 attribute_deprecated
3228 AVFrame *avcodec_alloc_frame(void);
3231 * Set the fields of the given AVFrame to default values.
3233 * @param frame The AVFrame of which the fields should be set to default values.
3235 * @deprecated use av_frame_unref()
3237 attribute_deprecated
3238 void avcodec_get_frame_defaults(AVFrame *frame);
3241 * Free the frame and any dynamically allocated objects in it,
3242 * e.g. extended_data.
3244 * @param frame frame to be freed. The pointer will be set to NULL.
3246 * @warning this function does NOT free the data buffers themselves
3247 * (it does not know how, since they might have been allocated with
3248 * a custom get_buffer()).
3250 * @deprecated use av_frame_free()
3252 attribute_deprecated
3253 void avcodec_free_frame(AVFrame **frame);
3257 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3258 * function the context has to be allocated with avcodec_alloc_context3().
3260 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3261 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3262 * retrieving a codec.
3264 * @warning This function is not thread safe!
3267 * avcodec_register_all();
3268 * av_dict_set(&opts, "b", "2.5M", 0);
3269 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3273 * context = avcodec_alloc_context3(codec);
3275 * if (avcodec_open2(context, codec, opts) < 0)
3279 * @param avctx The context to initialize.
3280 * @param codec The codec to open this context for. If a non-NULL codec has been
3281 * previously passed to avcodec_alloc_context3() or
3282 * avcodec_get_context_defaults3() for this context, then this
3283 * parameter MUST be either NULL or equal to the previously passed
3285 * @param options A dictionary filled with AVCodecContext and codec-private options.
3286 * On return this object will be filled with options that were not found.
3288 * @return zero on success, a negative value on error
3289 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3290 * av_dict_set(), av_opt_find().
3292 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3295 * Close a given AVCodecContext and free all the data associated with it
3296 * (but not the AVCodecContext itself).
3298 * Calling this function on an AVCodecContext that hasn't been opened will free
3299 * the codec-specific data allocated in avcodec_alloc_context3() /
3300 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3303 int avcodec_close(AVCodecContext *avctx);
3306 * Free all allocated data in the given subtitle struct.
3308 * @param sub AVSubtitle to free.
3310 void avsubtitle_free(AVSubtitle *sub);
3317 * @addtogroup lavc_packet
3321 #if FF_API_DESTRUCT_PACKET
3323 * Default packet destructor.
3324 * @deprecated use the AVBuffer API instead
3326 attribute_deprecated
3327 void av_destruct_packet(AVPacket *pkt);
3331 * Initialize optional fields of a packet with default values.
3333 * Note, this does not touch the data and size members, which have to be
3334 * initialized separately.
3338 void av_init_packet(AVPacket *pkt);
3341 * Allocate the payload of a packet and initialize its fields with
3345 * @param size wanted payload size
3346 * @return 0 if OK, AVERROR_xxx otherwise
3348 int av_new_packet(AVPacket *pkt, int size);
3351 * Reduce packet size, correctly zeroing padding
3354 * @param size new size
3356 void av_shrink_packet(AVPacket *pkt, int size);
3359 * Increase packet size, correctly zeroing padding
3362 * @param grow_by number of bytes by which to increase the size of the packet
3364 int av_grow_packet(AVPacket *pkt, int grow_by);
3367 * Initialize a reference-counted packet from av_malloc()ed data.
3369 * @param pkt packet to be initialized. This function will set the data, size,
3370 * buf and destruct fields, all others are left untouched.
3371 * @param data Data allocated by av_malloc() to be used as packet data. If this
3372 * function returns successfully, the data is owned by the underlying AVBuffer.
3373 * The caller may not access the data through other means.
3374 * @param size size of data in bytes, without the padding. I.e. the full buffer
3375 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3377 * @return 0 on success, a negative AVERROR on error
3379 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3382 * @warning This is a hack - the packet memory allocation stuff is broken. The
3383 * packet is allocated if it was not really allocated.
3385 int av_dup_packet(AVPacket *pkt);
3390 * @param pkt packet to free
3392 void av_free_packet(AVPacket *pkt);
3395 * Allocate new information of a packet.
3398 * @param type side information type
3399 * @param size side information size
3400 * @return pointer to fresh allocated data or NULL otherwise
3402 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3406 * Shrink the already allocated side data buffer
3409 * @param type side information type
3410 * @param size new side information size
3411 * @return 0 on success, < 0 on failure
3413 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3417 * Get side information from packet.
3420 * @param type desired side information type
3421 * @param size pointer for side information size to store (optional)
3422 * @return pointer to data if present or NULL otherwise
3424 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3428 * Convenience function to free all the side data stored.
3429 * All the other fields stay untouched.
3433 void av_packet_free_side_data(AVPacket *pkt);
3436 * Setup a new reference to the data described by a given packet
3438 * If src is reference-counted, setup dst as a new reference to the
3439 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3440 * data from src into it.
3442 * All the other fields are copied from src.
3444 * @see av_packet_unref
3446 * @param dst Destination packet
3447 * @param src Source packet
3449 * @return 0 on success, a negative AVERROR on error.
3451 int av_packet_ref(AVPacket *dst, AVPacket *src);
3456 * Unreference the buffer referenced by the packet and reset the
3457 * remaining packet fields to their default values.
3459 * @param pkt The packet to be unreferenced.
3461 void av_packet_unref(AVPacket *pkt);
3464 * Move every field in src to dst and reset src.
3466 * @see av_packet_unref
3468 * @param src Source packet, will be reset
3469 * @param dst Destination packet
3471 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3474 * Copy only "properties" fields from src to dst.
3476 * Properties for the purpose of this function are all the fields
3477 * beside those related to the packet data (buf, data, size)
3479 * @param dst Destination packet
3480 * @param src Source packet
3482 * @return 0 on success AVERROR on failure.
3485 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3488 * Convert valid timing fields (timestamps / durations) in a packet from one
3489 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3492 * @param pkt packet on which the conversion will be performed
3493 * @param tb_src source timebase, in which the timing fields in pkt are
3495 * @param tb_dst destination timebase, to which the timing fields will be
3498 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
3505 * @addtogroup lavc_decoding
3510 * Find a registered decoder with a matching codec ID.
3512 * @param id AVCodecID of the requested decoder
3513 * @return A decoder if one was found, NULL otherwise.
3515 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3518 * Find a registered decoder with the specified name.
3520 * @param name name of the requested decoder
3521 * @return A decoder if one was found, NULL otherwise.
3523 AVCodec *avcodec_find_decoder_by_name(const char *name);
3525 #if FF_API_GET_BUFFER
3526 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3527 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3528 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3532 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3533 * it can be called by custom get_buffer2() implementations for decoders without
3534 * CODEC_CAP_DR1 set.
3536 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3540 * Return the amount of padding in pixels which the get_buffer callback must
3541 * provide around the edge of the image for codecs which do not have the
3542 * CODEC_FLAG_EMU_EDGE flag.
3544 * @return Required padding in pixels.
3546 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
3549 attribute_deprecated
3550 unsigned avcodec_get_edge_width(void);
3554 * Modify width and height values so that they will result in a memory
3555 * buffer that is acceptable for the codec if you do not use any horizontal
3558 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3560 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3563 * Modify width and height values so that they will result in a memory
3564 * buffer that is acceptable for the codec if you also ensure that all
3565 * line sizes are a multiple of the respective linesize_align[i].
3567 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3569 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3570 int linesize_align[AV_NUM_DATA_POINTERS]);
3573 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3575 * Some decoders may support multiple frames in a single AVPacket. Such
3576 * decoders would then just decode the first frame and the return value would be
3577 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3578 * called again with an AVPacket containing the remaining data in order to
3579 * decode the second frame, etc... Even if no frames are returned, the packet
3580 * needs to be fed to the decoder with remaining data until it is completely
3581 * consumed or an error occurs.
3583 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3584 * and output. This means that for some packets they will not immediately
3585 * produce decoded output and need to be flushed at the end of decoding to get
3586 * all the decoded data. Flushing is done by calling this function with packets
3587 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3588 * returning samples. It is safe to flush even those decoders that are not
3589 * marked with CODEC_CAP_DELAY, then no samples will be returned.
3591 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3592 * larger than the actual read bytes because some optimized bitstream
3593 * readers read 32 or 64 bits at once and could read over the end.
3595 * @param avctx the codec context
3596 * @param[out] frame The AVFrame in which to store decoded audio samples.
3597 * The decoder will allocate a buffer for the decoded frame by
3598 * calling the AVCodecContext.get_buffer2() callback.
3599 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3600 * reference counted and the returned reference belongs to the
3601 * caller. The caller must release the frame using av_frame_unref()
3602 * when the frame is no longer needed. The caller may safely write
3603 * to the frame if av_frame_is_writable() returns 1.
3604 * When AVCodecContext.refcounted_frames is set to 0, the returned
3605 * reference belongs to the decoder and is valid only until the
3606 * next call to this function or until closing or flushing the
3607 * decoder. The caller may not write to it.
3608 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3609 * non-zero. Note that this field being set to zero
3610 * does not mean that an error has occurred. For
3611 * decoders with CODEC_CAP_DELAY set, no given decode
3612 * call is guaranteed to produce a frame.
3613 * @param[in] avpkt The input AVPacket containing the input buffer.
3614 * At least avpkt->data and avpkt->size should be set. Some
3615 * decoders might also require additional fields to be set.
3616 * @return A negative error code is returned if an error occurred during
3617 * decoding, otherwise the number of bytes consumed from the input
3618 * AVPacket is returned.
3620 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3621 int *got_frame_ptr, AVPacket *avpkt);
3624 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3625 * Some decoders may support multiple frames in a single AVPacket, such
3626 * decoders would then just decode the first frame.
3628 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3629 * the actual read bytes because some optimized bitstream readers read 32 or 64
3630 * bits at once and could read over the end.
3632 * @warning The end of the input buffer buf should be set to 0 to ensure that
3633 * no overreading happens for damaged MPEG streams.
3635 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3636 * between input and output, these need to be fed with avpkt->data=NULL,
3637 * avpkt->size=0 at the end to return the remaining frames.
3639 * @param avctx the codec context
3640 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3641 * Use av_frame_alloc() to get an AVFrame. The codec will
3642 * allocate memory for the actual bitmap by calling the
3643 * AVCodecContext.get_buffer2() callback.
3644 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3645 * reference counted and the returned reference belongs to the
3646 * caller. The caller must release the frame using av_frame_unref()
3647 * when the frame is no longer needed. The caller may safely write
3648 * to the frame if av_frame_is_writable() returns 1.
3649 * When AVCodecContext.refcounted_frames is set to 0, the returned
3650 * reference belongs to the decoder and is valid only until the
3651 * next call to this function or until closing or flushing the
3652 * decoder. The caller may not write to it.
3654 * @param[in] avpkt The input AVpacket containing the input buffer.
3655 * You can create such packet with av_init_packet() and by then setting
3656 * data and size, some decoders might in addition need other fields like
3657 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3659 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3660 * @return On error a negative value is returned, otherwise the number of bytes
3661 * used or zero if no frame could be decompressed.
3663 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3664 int *got_picture_ptr,
3668 * Decode a subtitle message.
3669 * Return a negative value on error, otherwise return the number of bytes used.
3670 * If no subtitle could be decompressed, got_sub_ptr is zero.
3671 * Otherwise, the subtitle is stored in *sub.
3672 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3673 * simplicity, because the performance difference is expect to be negligible
3674 * and reusing a get_buffer written for video codecs would probably perform badly
3675 * due to a potentially very different allocation pattern.
3677 * @param avctx the codec context
3678 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3679 freed with avsubtitle_free if *got_sub_ptr is set.
3680 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3681 * @param[in] avpkt The input AVPacket containing the input buffer.
3683 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3688 * @defgroup lavc_parsing Frame parsing
3692 enum AVPictureStructure {
3693 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3694 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3695 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3696 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3699 typedef struct AVCodecParserContext {
3701 struct AVCodecParser *parser;
3702 int64_t frame_offset; /* offset of the current frame */
3703 int64_t cur_offset; /* current offset
3704 (incremented by each av_parser_parse()) */
3705 int64_t next_frame_offset; /* offset of the next frame */
3707 int pict_type; /* XXX: Put it back in AVCodecContext. */
3709 * This field is used for proper frame duration computation in lavf.
3710 * It signals, how much longer the frame duration of the current frame
3711 * is compared to normal frame duration.
3713 * frame_duration = (1 + repeat_pict) * time_base
3715 * It is used by codecs like H.264 to display telecined material.
3717 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3718 int64_t pts; /* pts of the current frame */
3719 int64_t dts; /* dts of the current frame */
3724 int fetch_timestamp;
3726 #define AV_PARSER_PTS_NB 4
3727 int cur_frame_start_index;
3728 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3729 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3730 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3733 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3734 #define PARSER_FLAG_ONCE 0x0002
3735 /// Set if the parser has a valid file offset
3736 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3738 int64_t offset; ///< byte offset from starting packet start
3739 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3742 * Set by parser to 1 for key frames and 0 for non-key frames.
3743 * It is initialized to -1, so if the parser doesn't set this flag,
3744 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3750 * Time difference in stream time base units from the pts of this
3751 * packet to the point at which the output from the decoder has converged
3752 * independent from the availability of previous frames. That is, the
3753 * frames are virtually identical no matter if decoding started from
3754 * the very first frame or from this keyframe.
3755 * Is AV_NOPTS_VALUE if unknown.
3756 * This field is not the display duration of the current frame.
3757 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3760 * The purpose of this field is to allow seeking in streams that have no
3761 * keyframes in the conventional sense. It corresponds to the
3762 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3763 * essential for some types of subtitle streams to ensure that all
3764 * subtitles are correctly displayed after seeking.
3766 int64_t convergence_duration;
3768 // Timestamp generation support:
3770 * Synchronization point for start of timestamp generation.
3772 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3775 * For example, this corresponds to presence of H.264 buffering period
3781 * Offset of the current timestamp against last timestamp sync point in
3782 * units of AVCodecContext.time_base.
3784 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3785 * contain a valid timestamp offset.
3787 * Note that the timestamp of sync point has usually a nonzero
3788 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3789 * the next frame after timestamp sync point will be usually 1.
3791 * For example, this corresponds to H.264 cpb_removal_delay.
3793 int dts_ref_dts_delta;
3796 * Presentation delay of current frame in units of AVCodecContext.time_base.
3798 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3799 * contain valid non-negative timestamp delta (presentation time of a frame
3800 * must not lie in the past).
3802 * This delay represents the difference between decoding and presentation
3803 * time of the frame.
3805 * For example, this corresponds to H.264 dpb_output_delay.
3810 * Position of the packet in file.
3812 * Analogous to cur_frame_pts/dts
3814 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3817 * Byte position of currently parsed frame in stream.
3822 * Previous frame byte position.
3827 * Duration of the current frame.
3828 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3829 * For all other types, this is in units of AVCodecContext.time_base.
3833 enum AVFieldOrder field_order;
3836 * Indicate whether a picture is coded as a frame, top field or bottom field.
3838 * For example, H.264 field_pic_flag equal to 0 corresponds to
3839 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3840 * equal to 1 and bottom_field_flag equal to 0 corresponds to
3841 * AV_PICTURE_STRUCTURE_TOP_FIELD.
3843 enum AVPictureStructure picture_structure;
3846 * Picture number incremented in presentation or output order.
3847 * This field may be reinitialized at the first picture of a new sequence.
3849 * For example, this corresponds to H.264 PicOrderCnt.
3851 int output_picture_number;
3852 } AVCodecParserContext;
3854 typedef struct AVCodecParser {
3855 int codec_ids[5]; /* several codec IDs are permitted */
3857 int (*parser_init)(AVCodecParserContext *s);
3858 int (*parser_parse)(AVCodecParserContext *s,
3859 AVCodecContext *avctx,
3860 const uint8_t **poutbuf, int *poutbuf_size,
3861 const uint8_t *buf, int buf_size);
3862 void (*parser_close)(AVCodecParserContext *s);
3863 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3864 struct AVCodecParser *next;
3867 AVCodecParser *av_parser_next(const AVCodecParser *c);
3869 void av_register_codec_parser(AVCodecParser *parser);
3870 AVCodecParserContext *av_parser_init(int codec_id);
3875 * @param s parser context.
3876 * @param avctx codec context.
3877 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3878 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3879 * @param buf input buffer.
3880 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3881 * @param pts input presentation timestamp.
3882 * @param dts input decoding timestamp.
3883 * @param pos input byte position in stream.
3884 * @return the number of bytes of the input bitstream used.
3889 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3896 * decode_frame(data, size);
3900 int av_parser_parse2(AVCodecParserContext *s,
3901 AVCodecContext *avctx,
3902 uint8_t **poutbuf, int *poutbuf_size,
3903 const uint8_t *buf, int buf_size,
3904 int64_t pts, int64_t dts,
3908 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3909 * @deprecated use AVBitstreamFilter
3911 int av_parser_change(AVCodecParserContext *s,
3912 AVCodecContext *avctx,
3913 uint8_t **poutbuf, int *poutbuf_size,
3914 const uint8_t *buf, int buf_size, int keyframe);
3915 void av_parser_close(AVCodecParserContext *s);
3923 * @addtogroup lavc_encoding
3928 * Find a registered encoder with a matching codec ID.
3930 * @param id AVCodecID of the requested encoder
3931 * @return An encoder if one was found, NULL otherwise.
3933 AVCodec *avcodec_find_encoder(enum AVCodecID id);
3936 * Find a registered encoder with the specified name.
3938 * @param name name of the requested encoder
3939 * @return An encoder if one was found, NULL otherwise.
3941 AVCodec *avcodec_find_encoder_by_name(const char *name);
3944 * Encode a frame of audio.
3946 * Takes input samples from frame and writes the next output packet, if
3947 * available, to avpkt. The output packet does not necessarily contain data for
3948 * the most recent frame, as encoders can delay, split, and combine input frames
3949 * internally as needed.
3951 * @param avctx codec context
3952 * @param avpkt output AVPacket.
3953 * The user can supply an output buffer by setting
3954 * avpkt->data and avpkt->size prior to calling the
3955 * function, but if the size of the user-provided data is not
3956 * large enough, encoding will fail. All other AVPacket fields
3957 * will be reset by the encoder using av_init_packet(). If
3958 * avpkt->data is NULL, the encoder will allocate it.
3959 * The encoder will set avpkt->size to the size of the
3962 * If this function fails or produces no output, avpkt will be
3963 * freed using av_free_packet() (i.e. avpkt->destruct will be
3964 * called to free the user supplied buffer).
3965 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3966 * May be NULL when flushing an encoder that has the
3967 * CODEC_CAP_DELAY capability set.
3968 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3969 * can have any number of samples.
3970 * If it is not set, frame->nb_samples must be equal to
3971 * avctx->frame_size for all frames except the last.
3972 * The final frame may be smaller than avctx->frame_size.
3973 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3974 * output packet is non-empty, and to 0 if it is
3975 * empty. If the function returns an error, the
3976 * packet can be assumed to be invalid, and the
3977 * value of got_packet_ptr is undefined and should
3979 * @return 0 on success, negative error code on failure
3981 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3982 const AVFrame *frame, int *got_packet_ptr);
3985 * Encode a frame of video.
3987 * Takes input raw video data from frame and writes the next output packet, if
3988 * available, to avpkt. The output packet does not necessarily contain data for
3989 * the most recent frame, as encoders can delay and reorder input frames
3990 * internally as needed.
3992 * @param avctx codec context
3993 * @param avpkt output AVPacket.
3994 * The user can supply an output buffer by setting
3995 * avpkt->data and avpkt->size prior to calling the
3996 * function, but if the size of the user-provided data is not
3997 * large enough, encoding will fail. All other AVPacket fields
3998 * will be reset by the encoder using av_init_packet(). If
3999 * avpkt->data is NULL, the encoder will allocate it.
4000 * The encoder will set avpkt->size to the size of the
4001 * output packet. The returned data (if any) belongs to the
4002 * caller, he is responsible for freeing it.
4004 * If this function fails or produces no output, avpkt will be
4005 * freed using av_free_packet() (i.e. avpkt->destruct will be
4006 * called to free the user supplied buffer).
4007 * @param[in] frame AVFrame containing the raw video data to be encoded.
4008 * May be NULL when flushing an encoder that has the
4009 * CODEC_CAP_DELAY capability set.
4010 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4011 * output packet is non-empty, and to 0 if it is
4012 * empty. If the function returns an error, the
4013 * packet can be assumed to be invalid, and the
4014 * value of got_packet_ptr is undefined and should
4016 * @return 0 on success, negative error code on failure
4018 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4019 const AVFrame *frame, int *got_packet_ptr);
4021 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4022 const AVSubtitle *sub);
4030 * @addtogroup lavc_picture
4035 * Allocate memory for a picture. Call avpicture_free() to free it.
4037 * @see avpicture_fill()
4039 * @param picture the picture to be filled in
4040 * @param pix_fmt the format of the picture
4041 * @param width the width of the picture
4042 * @param height the height of the picture
4043 * @return zero if successful, a negative value if not
4045 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4048 * Free a picture previously allocated by avpicture_alloc().
4049 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4052 * @param picture the AVPicture to be freed
4054 void avpicture_free(AVPicture *picture);
4057 * Fill in the AVPicture fields.
4058 * The fields of the given AVPicture are filled in by using the 'ptr' address
4059 * which points to the image data buffer. Depending on the specified picture
4060 * format, one or multiple image data pointers and line sizes will be set.
4061 * If a planar format is specified, several pointers will be set pointing to
4062 * the different picture planes and the line sizes of the different planes
4063 * will be stored in the lines_sizes array.
4064 * Call with ptr == NULL to get the required size for the ptr buffer.
4066 * To allocate the buffer and fill in the AVPicture fields in one call,
4067 * use avpicture_alloc().
4069 * @param picture AVPicture whose fields are to be filled in
4070 * @param ptr Buffer which will contain or contains the actual image data
4071 * @param pix_fmt The format in which the picture data is stored.
4072 * @param width the width of the image in pixels
4073 * @param height the height of the image in pixels
4074 * @return size of the image data in bytes
4076 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4077 enum AVPixelFormat pix_fmt, int width, int height);
4080 * Copy pixel data from an AVPicture into a buffer.
4081 * The data is stored compactly, without any gaps for alignment or padding
4082 * which may be applied by avpicture_fill().
4084 * @see avpicture_get_size()
4086 * @param[in] src AVPicture containing image data
4087 * @param[in] pix_fmt The format in which the picture data is stored.
4088 * @param[in] width the width of the image in pixels.
4089 * @param[in] height the height of the image in pixels.
4090 * @param[out] dest A buffer into which picture data will be copied.
4091 * @param[in] dest_size The size of 'dest'.
4092 * @return The number of bytes written to dest, or a negative value (error code) on error.
4094 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4095 int width, int height,
4096 unsigned char *dest, int dest_size);
4099 * Calculate the size in bytes that a picture of the given width and height
4100 * would occupy if stored in the given picture format.
4101 * Note that this returns the size of a compact representation as generated
4102 * by avpicture_layout(), which can be smaller than the size required for e.g.
4105 * @param pix_fmt the given picture format
4106 * @param width the width of the image
4107 * @param height the height of the image
4108 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
4110 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4112 #if FF_API_DEINTERLACE
4114 * deinterlace - if not supported return -1
4116 * @deprecated - use yadif (in libavfilter) instead
4118 attribute_deprecated
4119 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4120 enum AVPixelFormat pix_fmt, int width, int height);
4123 * Copy image src to dst. Wraps av_picture_data_copy() above.
4125 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4126 enum AVPixelFormat pix_fmt, int width, int height);
4129 * Crop image top and left side.
4131 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4132 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4137 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4138 int padtop, int padbottom, int padleft, int padright, int *color);
4145 * @defgroup lavc_misc Utility functions
4148 * Miscellaneous utility functions related to both encoding and decoding
4154 * @defgroup lavc_misc_pixfmt Pixel formats
4156 * Functions for working with pixel formats.
4161 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4164 void attribute_deprecated avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4167 * Return a value representing the fourCC code associated to the
4168 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4171 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4173 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4174 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4175 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4176 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4177 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4178 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4181 * Compute what kind of losses will occur when converting from one specific
4182 * pixel format to another.
4183 * When converting from one pixel format to another, information loss may occur.
4184 * For example, when converting from RGB24 to GRAY, the color information will
4185 * be lost. Similarly, other losses occur when converting from some formats to
4186 * other formats. These losses can involve loss of chroma, but also loss of
4187 * resolution, loss of color depth, loss due to the color space conversion, loss
4188 * of the alpha bits or loss due to color quantization.
4189 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4190 * which will occur when converting from one pixel format to another.
4192 * @param[in] dst_pix_fmt destination pixel format
4193 * @param[in] src_pix_fmt source pixel format
4194 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4195 * @return Combination of flags informing you what kind of losses will occur.
4197 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4201 * Find the best pixel format to convert to given a certain source pixel
4202 * format. When converting from one pixel format to another, information loss
4203 * may occur. For example, when converting from RGB24 to GRAY, the color
4204 * information will be lost. Similarly, other losses occur when converting from
4205 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4206 * the given pixel formats should be used to suffer the least amount of loss.
4207 * The pixel formats from which it chooses one, are determined by the
4208 * pix_fmt_list parameter.
4211 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4212 * @param[in] src_pix_fmt source pixel format
4213 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4214 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4215 * @return The best pixel format to convert to or -1 if none was found.
4217 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4218 enum AVPixelFormat src_pix_fmt,
4219 int has_alpha, int *loss_ptr);
4221 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4227 #if FF_API_SET_DIMENSIONS
4229 * @deprecated this function is not supposed to be used from outside of lavc
4231 attribute_deprecated
4232 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4236 * Put a string representing the codec tag codec_tag in buf.
4238 * @param buf buffer to place codec tag in
4239 * @param buf_size size in bytes of buf
4240 * @param codec_tag codec tag to assign
4241 * @return the length of the string that would have been generated if
4242 * enough space had been available, excluding the trailing null
4244 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4246 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4249 * Return a name for the specified profile, if available.
4251 * @param codec the codec that is searched for the given profile
4252 * @param profile the profile value for which a name is requested
4253 * @return A name for the profile if found, NULL otherwise.
4255 const char *av_get_profile_name(const AVCodec *codec, int profile);
4257 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4258 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4259 //FIXME func typedef
4262 * Fill audio frame data and linesize.
4263 * AVFrame extended_data channel pointers are allocated if necessary for
4266 * @param frame the AVFrame
4267 * frame->nb_samples must be set prior to calling the
4268 * function. This function fills in frame->data,
4269 * frame->extended_data, frame->linesize[0].
4270 * @param nb_channels channel count
4271 * @param sample_fmt sample format
4272 * @param buf buffer to use for frame data
4273 * @param buf_size size of buffer
4274 * @param align plane size sample alignment (0 = default)
4275 * @return 0 on success, negative error code on failure
4277 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4278 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4279 int buf_size, int align);
4282 * Reset the internal decoder state / flush internal buffers. Should be called
4283 * e.g. when seeking or when switching to a different stream.
4285 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4286 * this invalidates the frames previously returned from the decoder. When
4287 * refcounted frames are used, the decoder just releases any references it might
4288 * keep internally, but the caller's reference remains valid.
4290 void avcodec_flush_buffers(AVCodecContext *avctx);
4293 * Return codec bits per sample.
4295 * @param[in] codec_id the codec
4296 * @return Number of bits per sample or zero if unknown for the given codec.
4298 int av_get_bits_per_sample(enum AVCodecID codec_id);
4301 * Return codec bits per sample.
4302 * Only return non-zero if the bits per sample is exactly correct, not an
4305 * @param[in] codec_id the codec
4306 * @return Number of bits per sample or zero if unknown for the given codec.
4308 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4311 * Return audio frame duration.
4313 * @param avctx codec context
4314 * @param frame_bytes size of the frame, or 0 if unknown
4315 * @return frame duration, in samples, if known. 0 if not able to
4318 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4321 typedef struct AVBitStreamFilterContext {
4323 struct AVBitStreamFilter *filter;
4324 AVCodecParserContext *parser;
4325 struct AVBitStreamFilterContext *next;
4326 } AVBitStreamFilterContext;
4329 typedef struct AVBitStreamFilter {
4332 int (*filter)(AVBitStreamFilterContext *bsfc,
4333 AVCodecContext *avctx, const char *args,
4334 uint8_t **poutbuf, int *poutbuf_size,
4335 const uint8_t *buf, int buf_size, int keyframe);
4336 void (*close)(AVBitStreamFilterContext *bsfc);
4337 struct AVBitStreamFilter *next;
4338 } AVBitStreamFilter;
4340 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4341 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4342 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4343 AVCodecContext *avctx, const char *args,
4344 uint8_t **poutbuf, int *poutbuf_size,
4345 const uint8_t *buf, int buf_size, int keyframe);
4346 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4348 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
4353 * Allocate a buffer with padding, reusing the given one if large enough.
4355 * Same behaviour av_fast_malloc but the buffer has additional
4356 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4359 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4362 * Encode extradata length to a buffer. Used by xiph codecs.
4364 * @param s buffer to write to; must be at least (v/255+1) bytes long
4365 * @param v size of extradata in bytes
4366 * @return number of bytes written to the buffer.
4368 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4370 #if FF_API_MISSING_SAMPLE
4372 * Log a generic warning message about a missing feature. This function is
4373 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4374 * only, and would normally not be used by applications.
4375 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4376 * a pointer to an AVClass struct
4377 * @param[in] feature string containing the name of the missing feature
4378 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4379 * If want_sample is non-zero, additional verbage will be added to the log
4380 * message which tells the user how to report samples to the development
4382 * @deprecated Use avpriv_report_missing_feature() instead.
4384 attribute_deprecated
4385 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4388 * Log a generic warning message asking for a sample. This function is
4389 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4390 * only, and would normally not be used by applications.
4391 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4392 * a pointer to an AVClass struct
4393 * @param[in] msg string containing an optional message, or NULL if no message
4394 * @deprecated Use avpriv_request_sample() instead.
4396 attribute_deprecated
4397 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4398 #endif /* FF_API_MISSING_SAMPLE */
4401 * Register the hardware accelerator hwaccel.
4403 void av_register_hwaccel(AVHWAccel *hwaccel);
4406 * If hwaccel is NULL, returns the first registered hardware accelerator,
4407 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4408 * after hwaccel, or NULL if hwaccel is the last one.
4410 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
4414 * Lock operation used by lockmgr
4417 AV_LOCK_CREATE, ///< Create a mutex
4418 AV_LOCK_OBTAIN, ///< Lock the mutex
4419 AV_LOCK_RELEASE, ///< Unlock the mutex
4420 AV_LOCK_DESTROY, ///< Free mutex resources
4424 * Register a user provided lock manager supporting the operations
4425 * specified by AVLockOp. The "mutex" argument to the function points
4426 * to a (void *) where the lockmgr should store/get a pointer to a user
4427 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
4428 * value left by the last call for all other ops. If the lock manager is
4429 * unable to perform the op then it should leave the mutex in the same
4430 * state as when it was called and return a non-zero value. However,
4431 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
4432 * have been successfully destroyed. If av_lockmgr_register succeeds
4433 * it will return a non-negative value, if it fails it will return a
4434 * negative value and destroy all mutex and unregister all callbacks.
4435 * av_lockmgr_register is not thread-safe, it must be called from a
4436 * single thread before any calls which make use of locking are used.
4438 * @param cb User defined callback. av_lockmgr_register invokes calls
4439 * to this callback and the previously registered callback.
4440 * The callback will be used to create more than one mutex
4441 * each of which must be backed by its own underlying locking
4442 * mechanism (i.e. do not use a single static object to
4443 * implement your lock manager). If cb is set to NULL the
4444 * lockmgr will be unregistered.
4446 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4449 * Get the type of the given codec.
4451 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4454 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4455 * with no corresponding avcodec_close()), 0 otherwise.
4457 int avcodec_is_open(AVCodecContext *s);
4460 * @return a non-zero number if codec is an encoder, zero otherwise
4462 int av_codec_is_encoder(const AVCodec *codec);
4465 * @return a non-zero number if codec is a decoder, zero otherwise
4467 int av_codec_is_decoder(const AVCodec *codec);
4470 * @return descriptor for given codec ID or NULL if no descriptor exists.
4472 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4475 * Iterate over all codec descriptors known to libavcodec.
4477 * @param prev previous descriptor. NULL to get the first descriptor.
4479 * @return next descriptor or NULL after the last descriptor
4481 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4484 * @return codec descriptor with the given name or NULL if no such descriptor
4487 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4493 #endif /* AVCODEC_AVCODEC_H */