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_get_descriptor()
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)
514 * @ingroup lavc_decoding
515 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
516 * This is mainly needed because some optimized bitstream readers read
517 * 32 or 64 bit at once and could read over the end.<br>
518 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
519 * MPEG bitstreams could cause overread and segfault.
521 #define FF_INPUT_BUFFER_PADDING_SIZE 8
524 * @ingroup lavc_encoding
525 * minimum encoding buffer size
526 * Used to avoid some checks during header writing.
528 #define FF_MIN_BUFFER_SIZE 16384
532 * @ingroup lavc_encoding
533 * motion estimation type.
536 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
540 ME_EPZS, ///< enhanced predictive zonal search
541 ME_X1, ///< reserved for experiments
542 ME_HEX, ///< hexagon based search
543 ME_UMH, ///< uneven multi-hexagon search
544 ME_TESA, ///< transformed exhaustive search algorithm
548 * @ingroup lavc_decoding
551 /* We leave some space between them for extensions (drop some
552 * keyframes for intra-only or drop just some bidir frames). */
553 AVDISCARD_NONE =-16, ///< discard nothing
554 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
555 AVDISCARD_NONREF = 8, ///< discard all non reference
556 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
557 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
558 AVDISCARD_ALL = 48, ///< discard all
561 enum AVColorPrimaries{
562 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
563 AVCOL_PRI_UNSPECIFIED = 2,
564 AVCOL_PRI_BT470M = 4,
565 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
566 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
567 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
569 AVCOL_PRI_BT2020 = 9, ///< ITU-R BT2020
570 AVCOL_PRI_NB , ///< Not part of ABI
573 enum AVColorTransferCharacteristic{
574 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
575 AVCOL_TRC_UNSPECIFIED = 2,
576 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
577 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
578 AVCOL_TRC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 or 625 / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC
579 AVCOL_TRC_SMPTE240M = 7,
580 AVCOL_TRC_LINEAR = 8, ///< "Linear transfer characteristics"
581 AVCOL_TRC_LOG = 9, ///< "Logarithmic transfer characteristic (100:1 range)"
582 AVCOL_TRC_LOG_SQRT = 10, ///< "Logarithmic transfer characteristic (100 * Sqrt( 10 ) : 1 range)"
583 AVCOL_TRC_IEC61966_2_4 = 11, ///< IEC 61966-2-4
584 AVCOL_TRC_BT1361_ECG = 12, ///< ITU-R BT1361 Extended Colour Gamut
585 AVCOL_TRC_IEC61966_2_1 = 13, ///< IEC 61966-2-1 (sRGB or sYCC)
586 AVCOL_TRC_BT2020_10 = 14, ///< ITU-R BT2020 for 10 bit system
587 AVCOL_TRC_BT2020_12 = 15, ///< ITU-R BT2020 for 12 bit system
588 AVCOL_TRC_NB , ///< Not part of ABI
593 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
594 AVCOL_SPC_UNSPECIFIED = 2,
596 AVCOL_SPC_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
597 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
598 AVCOL_SPC_SMPTE240M = 7,
599 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
600 AVCOL_SPC_BT2020_NCL = 9, ///< ITU-R BT2020 non-constant luminance system
601 AVCOL_SPC_BT2020_CL = 10, ///< ITU-R BT2020 constant luminance system
602 AVCOL_SPC_NB , ///< Not part of ABI
606 AVCOL_RANGE_UNSPECIFIED = 0,
607 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
608 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
609 AVCOL_RANGE_NB , ///< Not part of ABI
613 * X X 3 4 X X are luma samples,
614 * 1 2 1-6 are possible chroma positions
615 * X X 5 6 X 0 is undefined/unknown position
617 enum AVChromaLocation{
618 AVCHROMA_LOC_UNSPECIFIED = 0,
619 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
620 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
621 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
622 AVCHROMA_LOC_TOP = 4,
623 AVCHROMA_LOC_BOTTOMLEFT = 5,
624 AVCHROMA_LOC_BOTTOM = 6,
625 AVCHROMA_LOC_NB , ///< Not part of ABI
628 enum AVAudioServiceType {
629 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
630 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
631 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
632 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
633 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
634 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
635 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
636 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
637 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
638 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
642 * @ingroup lavc_encoding
644 typedef struct RcOverride{
647 int qscale; // If this is 0 then quality_factor will be used instead.
648 float quality_factor;
651 #if FF_API_MAX_BFRAMES
653 * @deprecated there is no libavcodec-wide limit on the number of B-frames
655 #define FF_MAX_B_FRAMES 16
659 These flags can be passed in AVCodecContext.flags before initialization.
660 Note: Not everything is supported yet.
664 * Allow decoders to produce frames with data planes that are not aligned
665 * to CPU requirements (e.g. due to cropping).
667 #define CODEC_FLAG_UNALIGNED 0x0001
668 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
669 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
670 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
671 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
674 * @deprecated use the "gmc" private option of the libxvid encoder
676 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
680 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
683 #define CODEC_FLAG_MV0 0x0040
685 #if FF_API_INPUT_PRESERVED
687 * @deprecated passing reference-counted frames to the encoders replaces this
690 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
692 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
693 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
694 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
697 * @deprecated edges are not used/required anymore. I.e. this flag is now always
700 #define CODEC_FLAG_EMU_EDGE 0x4000
702 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
703 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
704 location instead of only at frame boundaries. */
705 #if FF_API_NORMALIZE_AQP
707 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
710 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
712 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
713 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
714 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
715 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
716 /* Fx : Flag for h263+ extra options */
717 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
718 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
719 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
720 #define CODEC_FLAG_CLOSED_GOP 0x80000000
721 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
722 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
723 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
724 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
726 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
728 /* Unsupported options :
729 * Syntax Arithmetic coding (SAC)
730 * Reference Picture Selection
731 * Independent Segment Decoding */
733 /* codec capabilities */
735 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
737 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
738 * If not set, it might not use get_buffer() at all or use operations that
739 * assume the buffer was allocated by avcodec_default_get_buffer.
741 #define CODEC_CAP_DR1 0x0002
742 #define CODEC_CAP_TRUNCATED 0x0008
744 /* Codec can export data for HW decoding (XvMC). */
745 #define CODEC_CAP_HWACCEL 0x0010
746 #endif /* FF_API_XVMC */
748 * Encoder or decoder requires flushing with NULL input at the end in order to
749 * give the complete and correct output.
751 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
752 * with NULL data. The user can still send NULL data to the public encode
753 * or decode function, but libavcodec will not pass it along to the codec
754 * unless this flag is set.
757 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
758 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
762 * The encoder needs to be fed with NULL data at the end of encoding until the
763 * encoder no longer returns data.
765 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
766 * flag also means that the encoder must set the pts and duration for
767 * each output packet. If this flag is not set, the pts and duration will
768 * be determined by libavcodec from the input frame.
770 #define CODEC_CAP_DELAY 0x0020
772 * Codec can be fed a final frame with a smaller size.
773 * This can be used to prevent truncation of the last audio samples.
775 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
778 * Codec can export data for HW decoding (VDPAU).
780 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
783 * Codec can output multiple frames per AVPacket
784 * Normally demuxers return one frame at a time, demuxers which do not do
785 * are connected to a parser to split what they return into proper frames.
786 * This flag is reserved to the very rare category of codecs which have a
787 * bitstream that cannot be split into frames without timeconsuming
788 * operations like full decoding. Demuxers carring such bitstreams thus
789 * may return multiple frames in a packet. This has many disadvantages like
790 * prohibiting stream copy in many cases thus it should only be considered
793 #define CODEC_CAP_SUBFRAMES 0x0100
795 * Codec is experimental and is thus avoided in favor of non experimental
798 #define CODEC_CAP_EXPERIMENTAL 0x0200
800 * Codec should fill in channel configuration and samplerate instead of container
802 #define CODEC_CAP_CHANNEL_CONF 0x0400
803 #if FF_API_NEG_LINESIZES
805 * @deprecated no codecs use this capability
807 #define CODEC_CAP_NEG_LINESIZES 0x0800
810 * Codec supports frame-level multithreading.
812 #define CODEC_CAP_FRAME_THREADS 0x1000
814 * Codec supports slice-based (or partition-based) multithreading.
816 #define CODEC_CAP_SLICE_THREADS 0x2000
818 * Codec supports changed parameters at any point.
820 #define CODEC_CAP_PARAM_CHANGE 0x4000
822 * Codec supports avctx->thread_count == 0 (auto).
824 #define CODEC_CAP_AUTO_THREADS 0x8000
826 * Audio encoder supports receiving a different number of samples in each call.
828 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
831 //The following defines may change, don't expect compatibility if you use them.
832 #define MB_TYPE_INTRA4x4 0x0001
833 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
834 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
835 #define MB_TYPE_16x16 0x0008
836 #define MB_TYPE_16x8 0x0010
837 #define MB_TYPE_8x16 0x0020
838 #define MB_TYPE_8x8 0x0040
839 #define MB_TYPE_INTERLACED 0x0080
840 #define MB_TYPE_DIRECT2 0x0100 //FIXME
841 #define MB_TYPE_ACPRED 0x0200
842 #define MB_TYPE_GMC 0x0400
843 #define MB_TYPE_SKIP 0x0800
844 #define MB_TYPE_P0L0 0x1000
845 #define MB_TYPE_P1L0 0x2000
846 #define MB_TYPE_P0L1 0x4000
847 #define MB_TYPE_P1L1 0x8000
848 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
849 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
850 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
851 #define MB_TYPE_QUANT 0x00010000
852 #define MB_TYPE_CBP 0x00020000
853 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
858 * This specifies the area which should be displayed.
859 * Note there may be multiple such areas for one frame.
861 typedef struct AVPanScan{
864 * - encoding: Set by user.
865 * - decoding: Set by libavcodec.
870 * width and height in 1/16 pel
871 * - encoding: Set by user.
872 * - decoding: Set by libavcodec.
878 * position of the top left corner in 1/16 pel for up to 3 fields/frames
879 * - encoding: Set by user.
880 * - decoding: Set by libavcodec.
882 int16_t position[3][2];
885 #if FF_API_QSCALE_TYPE
886 #define FF_QSCALE_TYPE_MPEG1 0
887 #define FF_QSCALE_TYPE_MPEG2 1
888 #define FF_QSCALE_TYPE_H264 2
889 #define FF_QSCALE_TYPE_VP56 3
892 #if FF_API_GET_BUFFER
893 #define FF_BUFFER_TYPE_INTERNAL 1
894 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
895 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
896 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
898 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
899 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
900 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
901 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
905 * The decoder will keep a reference to the frame and may reuse it later.
907 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
910 * @defgroup lavc_packet AVPacket
912 * Types and functions for working with AVPacket.
915 enum AVPacketSideDataType {
917 AV_PKT_DATA_NEW_EXTRADATA,
920 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
923 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
924 * s32le channel_count
925 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
926 * u64le channel_layout
927 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
929 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
934 AV_PKT_DATA_PARAM_CHANGE,
937 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
938 * structures with info about macroblocks relevant to splitting the
939 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
940 * That is, it does not necessarily contain info about all macroblocks,
941 * as long as the distance between macroblocks in the info is smaller
942 * than the target payload size.
943 * Each MB info structure is 12 bytes, and is laid out as follows:
945 * u32le bit offset from the start of the packet
946 * u8 current quantizer at the start of the macroblock
948 * u16le macroblock address within the GOB
949 * u8 horizontal MV predictor
950 * u8 vertical MV predictor
951 * u8 horizontal MV predictor for block number 3
952 * u8 vertical MV predictor for block number 3
955 AV_PKT_DATA_H263_MB_INFO,
958 * This side data should be associated with an audio stream and contains
959 * ReplayGain information in form of the AVReplayGain struct.
961 AV_PKT_DATA_REPLAYGAIN,
964 typedef struct AVPacketSideData {
967 enum AVPacketSideDataType type;
971 * This structure stores compressed data. It is typically exported by demuxers
972 * and then passed as input to decoders, or received as output from encoders and
973 * then passed to muxers.
975 * For video, it should typically contain one compressed frame. For audio it may
976 * contain several compressed frames.
978 * AVPacket is one of the few structs in Libav, whose size is a part of public
979 * ABI. Thus it may be allocated on stack and no new fields can be added to it
980 * without libavcodec and libavformat major bump.
982 * The semantics of data ownership depends on the buf or destruct (deprecated)
983 * fields. If either is set, the packet data is dynamically allocated and is
984 * valid indefinitely until av_free_packet() is called (which in turn calls
985 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
986 * the packet data is typically backed by some static buffer somewhere and is
987 * only valid for a limited time (e.g. until the next read call when demuxing).
989 * The side data is always allocated with av_malloc() and is freed in
992 typedef struct AVPacket {
994 * A reference to the reference-counted buffer where the packet data is
996 * May be NULL, then the packet data is not reference-counted.
1000 * Presentation timestamp in AVStream->time_base units; the time at which
1001 * the decompressed packet will be presented to the user.
1002 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1003 * pts MUST be larger or equal to dts as presentation cannot happen before
1004 * decompression, unless one wants to view hex dumps. Some formats misuse
1005 * the terms dts and pts/cts to mean something different. Such timestamps
1006 * must be converted to true pts/dts before they are stored in AVPacket.
1010 * Decompression timestamp in AVStream->time_base units; the time at which
1011 * the packet is decompressed.
1012 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1019 * A combination of AV_PKT_FLAG values
1023 * Additional packet data that can be provided by the container.
1024 * Packet can contain several types of side information.
1026 AVPacketSideData *side_data;
1027 int side_data_elems;
1030 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1031 * Equals next_pts - this_pts in presentation order.
1034 #if FF_API_DESTRUCT_PACKET
1035 attribute_deprecated
1036 void (*destruct)(struct AVPacket *);
1037 attribute_deprecated
1040 int64_t pos; ///< byte position in stream, -1 if unknown
1043 * Time difference in AVStream->time_base units from the pts of this
1044 * packet to the point at which the output from the decoder has converged
1045 * independent from the availability of previous frames. That is, the
1046 * frames are virtually identical no matter if decoding started from
1047 * the very first frame or from this keyframe.
1048 * Is AV_NOPTS_VALUE if unknown.
1049 * This field is not the display duration of the current packet.
1050 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1053 * The purpose of this field is to allow seeking in streams that have no
1054 * keyframes in the conventional sense. It corresponds to the
1055 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1056 * essential for some types of subtitle streams to ensure that all
1057 * subtitles are correctly displayed after seeking.
1059 int64_t convergence_duration;
1061 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1062 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1064 enum AVSideDataParamChangeFlags {
1065 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1066 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1067 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1068 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1074 struct AVCodecInternal;
1078 AV_FIELD_PROGRESSIVE,
1079 AV_FIELD_TT, //< Top coded_first, top displayed first
1080 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1081 AV_FIELD_TB, //< Top coded first, bottom displayed first
1082 AV_FIELD_BT, //< Bottom coded first, top displayed first
1086 * main external API structure.
1087 * New fields can be added to the end with minor version bumps.
1088 * Removal, reordering and changes to existing fields require a major
1090 * sizeof(AVCodecContext) must not be used outside libav*.
1092 typedef struct AVCodecContext {
1094 * information on struct for av_log
1095 * - set by avcodec_alloc_context3
1097 const AVClass *av_class;
1098 int log_level_offset;
1100 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1101 const struct AVCodec *codec;
1102 char codec_name[32];
1103 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1106 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1107 * This is used to work around some encoder bugs.
1108 * A demuxer should set this to what is stored in the field used to identify the codec.
1109 * If there are multiple such fields in a container then the demuxer should choose the one
1110 * which maximizes the information about the used codec.
1111 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1112 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1113 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1115 * - encoding: Set by user, if not then the default based on codec_id will be used.
1116 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1118 unsigned int codec_tag;
1121 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1122 * This is used to work around some encoder bugs.
1123 * - encoding: unused
1124 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1126 unsigned int stream_codec_tag;
1131 * Private context used for internal data.
1133 * Unlike priv_data, this is not codec-specific. It is used in general
1134 * libavcodec functions.
1136 struct AVCodecInternal *internal;
1139 * Private data of the user, can be used to carry app specific stuff.
1140 * - encoding: Set by user.
1141 * - decoding: Set by user.
1146 * the average bitrate
1147 * - encoding: Set by user; unused for constant quantizer encoding.
1148 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1153 * number of bits the bitstream is allowed to diverge from the reference.
1154 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1155 * - encoding: Set by user; unused for constant quantizer encoding.
1156 * - decoding: unused
1158 int bit_rate_tolerance;
1161 * Global quality for codecs which cannot change it per frame.
1162 * This should be proportional to MPEG-1/2/4 qscale.
1163 * - encoding: Set by user.
1164 * - decoding: unused
1169 * - encoding: Set by user.
1170 * - decoding: unused
1172 int compression_level;
1173 #define FF_COMPRESSION_DEFAULT -1
1177 * - encoding: Set by user.
1178 * - decoding: Set by user.
1184 * - encoding: Set by user.
1185 * - decoding: Set by user.
1190 * some codecs need / can use extradata like Huffman tables.
1191 * mjpeg: Huffman tables
1192 * rv10: additional flags
1193 * mpeg4: global headers (they can be in the bitstream or here)
1194 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1195 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1196 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1197 * - encoding: Set/allocated/freed by libavcodec.
1198 * - decoding: Set/allocated/freed by user.
1204 * This is the fundamental unit of time (in seconds) in terms
1205 * of which frame timestamps are represented. For fixed-fps content,
1206 * timebase should be 1/framerate and timestamp increments should be
1208 * - encoding: MUST be set by user.
1209 * - decoding: Set by libavcodec.
1211 AVRational time_base;
1214 * For some codecs, the time base is closer to the field rate than the frame rate.
1215 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1216 * if no telecine is used ...
1218 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1220 int ticks_per_frame;
1226 * Number of frames the decoded output will be delayed relative to the
1230 * For encoding, this is the number of "priming" samples added by the
1231 * encoder to the beginning of the stream. The decoded output will be
1232 * delayed by this many samples relative to the input to the encoder (or
1233 * more, if the decoder adds its own padding).
1234 * The timestamps on the output packets are adjusted by the encoder so
1235 * that they always refer to the first sample of the data actually
1236 * contained in the packet, including any added padding.
1237 * E.g. if the timebase is 1/samplerate and the timestamp of the first
1238 * input sample is 0, the timestamp of the first output packet will be
1241 * For decoding, this is the number of samples the decoder needs to
1242 * output before the decoder's output is valid. When seeking, you should
1243 * start decoding this many samples prior to your desired seek point.
1245 * - encoding: Set by libavcodec.
1246 * - decoding: Set by libavcodec.
1253 * picture width / height.
1254 * - encoding: MUST be set by user.
1255 * - decoding: May be set by the user before opening the decoder if known e.g.
1256 * from the container. Some decoders will require the dimensions
1257 * to be set by the caller. During decoding, the decoder may
1258 * overwrite those values as required.
1263 * Bitstream width / height, may be different from width/height e.g. when
1264 * the decoded frame is cropped before being output.
1265 * - encoding: unused
1266 * - decoding: May be set by the user before opening the decoder if known
1267 * e.g. from the container. During decoding, the decoder may
1268 * overwrite those values as required.
1270 int coded_width, coded_height;
1272 #if FF_API_ASPECT_EXTENDED
1273 #define FF_ASPECT_EXTENDED 15
1277 * the number of pictures in a group of pictures, or 0 for intra_only
1278 * - encoding: Set by user.
1279 * - decoding: unused
1284 * Pixel format, see AV_PIX_FMT_xxx.
1285 * May be set by the demuxer if known from headers.
1286 * May be overriden by the decoder if it knows better.
1287 * - encoding: Set by user.
1288 * - decoding: Set by user if known, overridden by libavcodec if known
1290 enum AVPixelFormat pix_fmt;
1293 * Motion estimation algorithm used for video coding.
1294 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1295 * 8 (umh), 10 (tesa) [7, 8, 10 are x264 specific]
1296 * - encoding: MUST be set by user.
1297 * - decoding: unused
1302 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1303 * decoder to draw a horizontal band. It improves cache usage. Not
1304 * all codecs can do that. You must check the codec capabilities
1306 * When multithreading is used, it may be called from multiple threads
1307 * at the same time; threads might draw different parts of the same AVFrame,
1308 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1310 * The function is also used by hardware acceleration APIs.
1311 * It is called at least once during frame decoding to pass
1312 * the data needed for hardware render.
1313 * In that mode instead of pixel data, AVFrame points to
1314 * a structure specific to the acceleration API. The application
1315 * reads the structure and can change some fields to indicate progress
1317 * - encoding: unused
1318 * - decoding: Set by user.
1319 * @param height the height of the slice
1320 * @param y the y position of the slice
1321 * @param type 1->top field, 2->bottom field, 3->frame
1322 * @param offset offset into the AVFrame.data from which the slice should be read
1324 void (*draw_horiz_band)(struct AVCodecContext *s,
1325 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1326 int y, int type, int height);
1329 * callback to negotiate the pixelFormat
1330 * @param fmt is the list of formats which are supported by the codec,
1331 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1332 * The first is always the native one.
1333 * @return the chosen format
1334 * - encoding: unused
1335 * - decoding: Set by user, if not set the native format will be chosen.
1337 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1340 * maximum number of B-frames between non-B-frames
1341 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1342 * - encoding: Set by user.
1343 * - decoding: unused
1348 * qscale factor between IP and B-frames
1349 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1350 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1351 * - encoding: Set by user.
1352 * - decoding: unused
1354 float b_quant_factor;
1356 /** obsolete FIXME remove */
1358 #define FF_RC_STRATEGY_XVID 1
1360 int b_frame_strategy;
1363 * qscale offset between IP and B-frames
1364 * - encoding: Set by user.
1365 * - decoding: unused
1367 float b_quant_offset;
1370 * Size of the frame reordering buffer in the decoder.
1371 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1372 * - encoding: Set by libavcodec.
1373 * - decoding: Set by libavcodec.
1378 * 0-> h263 quant 1-> mpeg quant
1379 * - encoding: Set by user.
1380 * - decoding: unused
1385 * qscale factor between P and I-frames
1386 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1387 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1388 * - encoding: Set by user.
1389 * - decoding: unused
1391 float i_quant_factor;
1394 * qscale offset between P and I-frames
1395 * - encoding: Set by user.
1396 * - decoding: unused
1398 float i_quant_offset;
1401 * luminance masking (0-> disabled)
1402 * - encoding: Set by user.
1403 * - decoding: unused
1408 * temporary complexity masking (0-> disabled)
1409 * - encoding: Set by user.
1410 * - decoding: unused
1412 float temporal_cplx_masking;
1415 * spatial complexity masking (0-> disabled)
1416 * - encoding: Set by user.
1417 * - decoding: unused
1419 float spatial_cplx_masking;
1422 * p block masking (0-> disabled)
1423 * - encoding: Set by user.
1424 * - decoding: unused
1429 * darkness masking (0-> disabled)
1430 * - encoding: Set by user.
1431 * - decoding: unused
1437 * - encoding: Set by libavcodec.
1438 * - decoding: Set by user (or 0).
1442 * prediction method (needed for huffyuv)
1443 * - encoding: Set by user.
1444 * - decoding: unused
1446 int prediction_method;
1447 #define FF_PRED_LEFT 0
1448 #define FF_PRED_PLANE 1
1449 #define FF_PRED_MEDIAN 2
1452 * slice offsets in the frame in bytes
1453 * - encoding: Set/allocated by libavcodec.
1454 * - decoding: Set/allocated by user (or NULL).
1459 * sample aspect ratio (0 if unknown)
1460 * That is the width of a pixel divided by the height of the pixel.
1461 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1462 * - encoding: Set by user.
1463 * - decoding: Set by libavcodec.
1465 AVRational sample_aspect_ratio;
1468 * motion estimation comparison function
1469 * - encoding: Set by user.
1470 * - decoding: unused
1474 * subpixel motion estimation comparison function
1475 * - encoding: Set by user.
1476 * - decoding: unused
1480 * macroblock comparison function (not supported yet)
1481 * - encoding: Set by user.
1482 * - decoding: unused
1486 * interlaced DCT comparison function
1487 * - encoding: Set by user.
1488 * - decoding: unused
1491 #define FF_CMP_SAD 0
1492 #define FF_CMP_SSE 1
1493 #define FF_CMP_SATD 2
1494 #define FF_CMP_DCT 3
1495 #define FF_CMP_PSNR 4
1496 #define FF_CMP_BIT 5
1498 #define FF_CMP_ZERO 7
1499 #define FF_CMP_VSAD 8
1500 #define FF_CMP_VSSE 9
1501 #define FF_CMP_NSSE 10
1502 #define FF_CMP_DCTMAX 13
1503 #define FF_CMP_DCT264 14
1504 #define FF_CMP_CHROMA 256
1507 * ME diamond size & shape
1508 * - encoding: Set by user.
1509 * - decoding: unused
1514 * amount of previous MV predictors (2a+1 x 2a+1 square)
1515 * - encoding: Set by user.
1516 * - decoding: unused
1518 int last_predictor_count;
1521 * prepass for motion estimation
1522 * - encoding: Set by user.
1523 * - decoding: unused
1528 * motion estimation prepass comparison function
1529 * - encoding: Set by user.
1530 * - decoding: unused
1535 * ME prepass diamond size & shape
1536 * - encoding: Set by user.
1537 * - decoding: unused
1543 * - encoding: Set by user.
1544 * - decoding: unused
1546 int me_subpel_quality;
1549 * DTG active format information (additional aspect ratio
1550 * information only used in DVB MPEG-2 transport streams)
1553 * - encoding: unused
1554 * - decoding: Set by decoder.
1556 int dtg_active_format;
1557 #define FF_DTG_AFD_SAME 8
1558 #define FF_DTG_AFD_4_3 9
1559 #define FF_DTG_AFD_16_9 10
1560 #define FF_DTG_AFD_14_9 11
1561 #define FF_DTG_AFD_4_3_SP_14_9 13
1562 #define FF_DTG_AFD_16_9_SP_14_9 14
1563 #define FF_DTG_AFD_SP_4_3 15
1566 * maximum motion estimation search range in subpel units
1567 * If 0 then no limit.
1569 * - encoding: Set by user.
1570 * - decoding: unused
1575 * intra quantizer bias
1576 * - encoding: Set by user.
1577 * - decoding: unused
1579 int intra_quant_bias;
1580 #define FF_DEFAULT_QUANT_BIAS 999999
1583 * inter quantizer bias
1584 * - encoding: Set by user.
1585 * - decoding: unused
1587 int inter_quant_bias;
1591 * - encoding: unused
1592 * - decoding: Set by user.
1595 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1596 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1597 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1601 * XVideo Motion Acceleration
1602 * - encoding: forbidden
1603 * - decoding: set by decoder
1604 * @deprecated XvMC support is slated for removal.
1606 attribute_deprecated int xvmc_acceleration;
1607 #endif /* FF_API_XVMC */
1610 * macroblock decision mode
1611 * - encoding: Set by user.
1612 * - decoding: unused
1615 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1616 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1617 #define FF_MB_DECISION_RD 2 ///< rate distortion
1620 * custom intra quantization matrix
1621 * - encoding: Set by user, can be NULL.
1622 * - decoding: Set by libavcodec.
1624 uint16_t *intra_matrix;
1627 * custom inter quantization matrix
1628 * - encoding: Set by user, can be NULL.
1629 * - decoding: Set by libavcodec.
1631 uint16_t *inter_matrix;
1634 * scene change detection threshold
1635 * 0 is default, larger means fewer detected scene changes.
1636 * - encoding: Set by user.
1637 * - decoding: unused
1639 int scenechange_threshold;
1642 * noise reduction strength
1643 * - encoding: Set by user.
1644 * - decoding: unused
1646 int noise_reduction;
1649 * Motion estimation threshold below which no motion estimation is
1650 * performed, but instead the user specified motion vectors are used.
1652 * - encoding: Set by user.
1653 * - decoding: unused
1658 * Macroblock threshold below which the user specified macroblock types will be used.
1659 * - encoding: Set by user.
1660 * - decoding: unused
1665 * precision of the intra DC coefficient - 8
1666 * - encoding: Set by user.
1667 * - decoding: unused
1669 int intra_dc_precision;
1672 * Number of macroblock rows at the top which are skipped.
1673 * - encoding: unused
1674 * - decoding: Set by user.
1679 * Number of macroblock rows at the bottom which are skipped.
1680 * - encoding: unused
1681 * - decoding: Set by user.
1686 * Border processing masking, raises the quantizer for mbs on the borders
1688 * - encoding: Set by user.
1689 * - decoding: unused
1691 float border_masking;
1694 * minimum MB lagrange multipler
1695 * - encoding: Set by user.
1696 * - decoding: unused
1701 * maximum MB lagrange multipler
1702 * - encoding: Set by user.
1703 * - decoding: unused
1709 * - encoding: Set by user.
1710 * - decoding: unused
1712 int me_penalty_compensation;
1716 * - encoding: Set by user.
1717 * - decoding: unused
1723 * - encoding: Set by user.
1724 * - decoding: unused
1730 * - encoding: Set by user.
1731 * - decoding: unused
1736 * number of reference frames
1737 * - encoding: Set by user.
1738 * - decoding: Set by lavc.
1743 * chroma qp offset from luma
1744 * - encoding: Set by user.
1745 * - decoding: unused
1750 * Multiplied by qscale for each frame and added to scene_change_score.
1751 * - encoding: Set by user.
1752 * - decoding: unused
1754 int scenechange_factor;
1758 * Note: Value depends upon the compare function used for fullpel ME.
1759 * - encoding: Set by user.
1760 * - decoding: unused
1765 * Adjust sensitivity of b_frame_strategy 1.
1766 * - encoding: Set by user.
1767 * - decoding: unused
1772 * Chromaticity coordinates of the source primaries.
1773 * - encoding: Set by user
1774 * - decoding: Set by libavcodec
1776 enum AVColorPrimaries color_primaries;
1779 * Color Transfer Characteristic.
1780 * - encoding: Set by user
1781 * - decoding: Set by libavcodec
1783 enum AVColorTransferCharacteristic color_trc;
1786 * YUV colorspace type.
1787 * - encoding: Set by user
1788 * - decoding: Set by libavcodec
1790 enum AVColorSpace colorspace;
1793 * MPEG vs JPEG YUV range.
1794 * - encoding: Set by user
1795 * - decoding: Set by libavcodec
1797 enum AVColorRange color_range;
1800 * This defines the location of chroma samples.
1801 * - encoding: Set by user
1802 * - decoding: Set by libavcodec
1804 enum AVChromaLocation chroma_sample_location;
1808 * Indicates number of picture subdivisions. Used for parallelized
1810 * - encoding: Set by user
1811 * - decoding: unused
1816 * - encoding: set by libavcodec
1817 * - decoding: Set by libavcodec
1819 enum AVFieldOrder field_order;
1822 int sample_rate; ///< samples per second
1823 int channels; ///< number of audio channels
1826 * audio sample format
1827 * - encoding: Set by user.
1828 * - decoding: Set by libavcodec.
1830 enum AVSampleFormat sample_fmt; ///< sample format
1832 /* The following data should not be initialized. */
1834 * Number of samples per channel in an audio frame.
1836 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1837 * except the last must contain exactly frame_size samples per channel.
1838 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1839 * frame size is not restricted.
1840 * - decoding: may be set by some decoders to indicate constant frame size
1845 * Frame counter, set by libavcodec.
1847 * - decoding: total number of frames returned from the decoder so far.
1848 * - encoding: total number of frames passed to the encoder so far.
1850 * @note the counter is not incremented if encoding/decoding resulted in
1856 * number of bytes per packet if constant and known or 0
1857 * Used by some WAV based audio codecs.
1862 * Audio cutoff bandwidth (0 means "automatic")
1863 * - encoding: Set by user.
1864 * - decoding: unused
1868 #if FF_API_REQUEST_CHANNELS
1870 * Decoder should decode to this many channels if it can (0 for default)
1871 * - encoding: unused
1872 * - decoding: Set by user.
1873 * @deprecated Deprecated in favor of request_channel_layout.
1875 attribute_deprecated int request_channels;
1879 * Audio channel layout.
1880 * - encoding: set by user.
1881 * - decoding: set by libavcodec.
1883 uint64_t channel_layout;
1886 * Request decoder to use this channel layout if it can (0 for default)
1887 * - encoding: unused
1888 * - decoding: Set by user.
1890 uint64_t request_channel_layout;
1893 * Type of service that the audio stream conveys.
1894 * - encoding: Set by user.
1895 * - decoding: Set by libavcodec.
1897 enum AVAudioServiceType audio_service_type;
1900 * Used to request a sample format from the decoder.
1901 * - encoding: unused.
1902 * - decoding: Set by user.
1904 enum AVSampleFormat request_sample_fmt;
1906 #if FF_API_GET_BUFFER
1908 * Called at the beginning of each frame to get a buffer for it.
1910 * The function will set AVFrame.data[], AVFrame.linesize[].
1911 * AVFrame.extended_data[] must also be set, but it should be the same as
1912 * AVFrame.data[] except for planar audio with more channels than can fit
1913 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1914 * many data pointers as it can hold.
1916 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1917 * avcodec_default_get_buffer() instead of providing buffers allocated by
1920 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1921 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1922 * but if get_buffer() is overridden then alignment considerations should
1923 * be taken into account.
1925 * @see avcodec_default_get_buffer()
1929 * If pic.reference is set then the frame will be read later by libavcodec.
1930 * avcodec_align_dimensions2() should be used to find the required width and
1931 * height, as they normally need to be rounded up to the next multiple of 16.
1933 * If frame multithreading is used and thread_safe_callbacks is set,
1934 * it may be called from a different thread, but not from more than one at
1935 * once. Does not need to be reentrant.
1937 * @see release_buffer(), reget_buffer()
1938 * @see avcodec_align_dimensions2()
1942 * Decoders request a buffer of a particular size by setting
1943 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1944 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1945 * to a smaller value in the output frame.
1947 * Decoders cannot use the buffer after returning from
1948 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1949 * is assumed to be released immediately upon return. In some rare cases,
1950 * a decoder may need to call get_buffer() more than once in a single
1951 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
1952 * called again after it has already been called once, the previously
1953 * acquired buffer is assumed to be released at that time and may not be
1954 * reused by the decoder.
1956 * As a convenience, av_samples_get_buffer_size() and
1957 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1958 * functions to find the required data size and to fill data pointers and
1959 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1960 * since all planes must be the same size.
1962 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1964 * - encoding: unused
1965 * - decoding: Set by libavcodec, user can override.
1967 * @deprecated use get_buffer2()
1969 attribute_deprecated
1970 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1973 * Called to release buffers which were allocated with get_buffer.
1974 * A released buffer can be reused in get_buffer().
1975 * pic.data[*] must be set to NULL.
1976 * May be called from a different thread if frame multithreading is used,
1977 * but not by more than one thread at once, so does not need to be reentrant.
1978 * - encoding: unused
1979 * - decoding: Set by libavcodec, user can override.
1981 * @deprecated custom freeing callbacks should be set from get_buffer2()
1983 attribute_deprecated
1984 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1987 * Called at the beginning of a frame to get cr buffer for it.
1988 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1989 * libavcodec will pass previous buffer in pic, function should return
1990 * same buffer or new buffer with old frame "painted" into it.
1991 * If pic.data[0] == NULL must behave like get_buffer().
1992 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
1993 * avcodec_default_reget_buffer() instead of providing buffers allocated by
1995 * - encoding: unused
1996 * - decoding: Set by libavcodec, user can override.
1998 attribute_deprecated
1999 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2003 * This callback is called at the beginning of each frame to get data
2004 * buffer(s) for it. There may be one contiguous buffer for all the data or
2005 * there may be a buffer per each data plane or anything in between. What
2006 * this means is, you may set however many entries in buf[] you feel necessary.
2007 * Each buffer must be reference-counted using the AVBuffer API (see description
2010 * The following fields will be set in the frame before this callback is
2013 * - width, height (video only)
2014 * - sample_rate, channel_layout, nb_samples (audio only)
2015 * Their values may differ from the corresponding values in
2016 * AVCodecContext. This callback must use the frame values, not the codec
2017 * context values, to calculate the required buffer size.
2019 * This callback must fill the following fields in the frame:
2023 * * if the data is planar audio with more than 8 channels, then this
2024 * callback must allocate and fill extended_data to contain all pointers
2025 * to all data planes. data[] must hold as many pointers as it can.
2026 * extended_data must be allocated with av_malloc() and will be freed in
2028 * * otherwise exended_data must point to data
2029 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2030 * the frame's data and extended_data pointers must be contained in these. That
2031 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2032 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2033 * and av_buffer_ref().
2034 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2035 * this callback and filled with the extra buffers if there are more
2036 * buffers than buf[] can hold. extended_buf will be freed in
2039 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2040 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2043 * Each data plane must be aligned to the maximum required by the target
2046 * @see avcodec_default_get_buffer2()
2050 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2051 * (read and/or written to if it is writable) later by libavcodec.
2053 * avcodec_align_dimensions2() should be used to find the required width and
2054 * height, as they normally need to be rounded up to the next multiple of 16.
2056 * If frame multithreading is used and thread_safe_callbacks is set,
2057 * this callback may be called from a different thread, but not from more
2058 * than one at once. Does not need to be reentrant.
2060 * @see avcodec_align_dimensions2()
2064 * Decoders request a buffer of a particular size by setting
2065 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2066 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2067 * to a smaller value in the output frame.
2069 * As a convenience, av_samples_get_buffer_size() and
2070 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2071 * functions to find the required data size and to fill data pointers and
2072 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2073 * since all planes must be the same size.
2075 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2077 * - encoding: unused
2078 * - decoding: Set by libavcodec, user can override.
2080 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2083 * If non-zero, the decoded audio and video frames returned from
2084 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2085 * and are valid indefinitely. The caller must free them with
2086 * av_frame_unref() when they are not needed anymore.
2087 * Otherwise, the decoded frames must not be freed by the caller and are
2088 * only valid until the next decode call.
2090 * - encoding: unused
2091 * - decoding: set by the caller before avcodec_open2().
2093 int refcounted_frames;
2095 /* - encoding parameters */
2096 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2097 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2101 * - encoding: Set by user.
2102 * - decoding: unused
2108 * - encoding: Set by user.
2109 * - decoding: unused
2114 * maximum quantizer difference between frames
2115 * - encoding: Set by user.
2116 * - decoding: unused
2121 * ratecontrol qmin qmax limiting method
2122 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2123 * - encoding: Set by user.
2124 * - decoding: unused
2132 * decoder bitstream buffer size
2133 * - encoding: Set by user.
2134 * - decoding: unused
2139 * ratecontrol override, see RcOverride
2140 * - encoding: Allocated/set/freed by user.
2141 * - decoding: unused
2143 int rc_override_count;
2144 RcOverride *rc_override;
2147 * rate control equation
2148 * - encoding: Set by user
2149 * - decoding: unused
2155 * - encoding: Set by user.
2156 * - decoding: unused
2162 * - encoding: Set by user.
2163 * - decoding: unused
2167 float rc_buffer_aggressivity;
2170 * initial complexity for pass1 ratecontrol
2171 * - encoding: Set by user.
2172 * - decoding: unused
2174 float rc_initial_cplx;
2177 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2178 * - encoding: Set by user.
2179 * - decoding: unused.
2181 float rc_max_available_vbv_use;
2184 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2185 * - encoding: Set by user.
2186 * - decoding: unused.
2188 float rc_min_vbv_overflow_use;
2191 * Number of bits which should be loaded into the rc buffer before decoding starts.
2192 * - encoding: Set by user.
2193 * - decoding: unused
2195 int rc_initial_buffer_occupancy;
2197 #define FF_CODER_TYPE_VLC 0
2198 #define FF_CODER_TYPE_AC 1
2199 #define FF_CODER_TYPE_RAW 2
2200 #define FF_CODER_TYPE_RLE 3
2201 #define FF_CODER_TYPE_DEFLATE 4
2204 * - encoding: Set by user.
2205 * - decoding: unused
2211 * - encoding: Set by user.
2212 * - decoding: unused
2217 * minimum Lagrange multipler
2218 * - encoding: Set by user.
2219 * - decoding: unused
2224 * maximum Lagrange multipler
2225 * - encoding: Set by user.
2226 * - decoding: unused
2231 * frame skip threshold
2232 * - encoding: Set by user.
2233 * - decoding: unused
2235 int frame_skip_threshold;
2239 * - encoding: Set by user.
2240 * - decoding: unused
2242 int frame_skip_factor;
2245 * frame skip exponent
2246 * - encoding: Set by user.
2247 * - decoding: unused
2252 * frame skip comparison function
2253 * - encoding: Set by user.
2254 * - decoding: unused
2259 * trellis RD quantization
2260 * - encoding: Set by user.
2261 * - decoding: unused
2266 * - encoding: Set by user.
2267 * - decoding: unused
2269 int min_prediction_order;
2272 * - encoding: Set by user.
2273 * - decoding: unused
2275 int max_prediction_order;
2278 * GOP timecode frame start number, in non drop frame format
2279 * - encoding: Set by user.
2280 * - decoding: unused
2282 int64_t timecode_frame_start;
2284 /* The RTP callback: This function is called */
2285 /* every time the encoder has a packet to send. */
2286 /* It depends on the encoder if the data starts */
2287 /* with a Start Code (it should). H.263 does. */
2288 /* mb_nb contains the number of macroblocks */
2289 /* encoded in the RTP payload. */
2290 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2292 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2293 /* do its best to deliver a chunk with size */
2294 /* below rtp_payload_size, the chunk will start */
2295 /* with a start code on some codecs like H.263. */
2296 /* This doesn't take account of any particular */
2297 /* headers inside the transmitted RTP payload. */
2299 /* statistics, used for 2-pass encoding */
2310 * number of bits used for the previously encoded frame
2311 * - encoding: Set by libavcodec.
2312 * - decoding: unused
2317 * pass1 encoding statistics output buffer
2318 * - encoding: Set by libavcodec.
2319 * - decoding: unused
2324 * pass2 encoding statistics input buffer
2325 * Concatenated stuff from stats_out of pass1 should be placed here.
2326 * - encoding: Allocated/set/freed by user.
2327 * - decoding: unused
2332 * Work around bugs in encoders which sometimes cannot be detected automatically.
2333 * - encoding: Set by user
2334 * - decoding: Set by user
2336 int workaround_bugs;
2337 #define FF_BUG_AUTODETECT 1 ///< autodetection
2338 #if FF_API_OLD_MSMPEG4
2339 #define FF_BUG_OLD_MSMPEG4 2
2341 #define FF_BUG_XVID_ILACE 4
2342 #define FF_BUG_UMP4 8
2343 #define FF_BUG_NO_PADDING 16
2344 #define FF_BUG_AMV 32
2346 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2348 #define FF_BUG_QPEL_CHROMA 64
2349 #define FF_BUG_STD_QPEL 128
2350 #define FF_BUG_QPEL_CHROMA2 256
2351 #define FF_BUG_DIRECT_BLOCKSIZE 512
2352 #define FF_BUG_EDGE 1024
2353 #define FF_BUG_HPEL_CHROMA 2048
2354 #define FF_BUG_DC_CLIP 4096
2355 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2356 #define FF_BUG_TRUNCATED 16384
2359 * strictly follow the standard (MPEG4, ...).
2360 * - encoding: Set by user.
2361 * - decoding: Set by user.
2362 * Setting this to STRICT or higher means the encoder and decoder will
2363 * generally do stupid things, whereas setting it to unofficial or lower
2364 * will mean the encoder might produce output that is not supported by all
2365 * spec-compliant decoders. Decoders don't differentiate between normal,
2366 * unofficial and experimental (that is, they always try to decode things
2367 * when they can) unless they are explicitly asked to behave stupidly
2368 * (=strictly conform to the specs)
2370 int strict_std_compliance;
2371 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2372 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2373 #define FF_COMPLIANCE_NORMAL 0
2374 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2375 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2378 * error concealment flags
2379 * - encoding: unused
2380 * - decoding: Set by user.
2382 int error_concealment;
2383 #define FF_EC_GUESS_MVS 1
2384 #define FF_EC_DEBLOCK 2
2388 * - encoding: Set by user.
2389 * - decoding: Set by user.
2392 #define FF_DEBUG_PICT_INFO 1
2393 #define FF_DEBUG_RC 2
2394 #define FF_DEBUG_BITSTREAM 4
2395 #define FF_DEBUG_MB_TYPE 8
2396 #define FF_DEBUG_QP 16
2399 * @deprecated this option does nothing
2401 #define FF_DEBUG_MV 32
2403 #define FF_DEBUG_DCT_COEFF 0x00000040
2404 #define FF_DEBUG_SKIP 0x00000080
2405 #define FF_DEBUG_STARTCODE 0x00000100
2406 #define FF_DEBUG_PTS 0x00000200
2407 #define FF_DEBUG_ER 0x00000400
2408 #define FF_DEBUG_MMCO 0x00000800
2409 #define FF_DEBUG_BUGS 0x00001000
2411 #define FF_DEBUG_VIS_QP 0x00002000
2412 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2414 #define FF_DEBUG_BUFFERS 0x00008000
2415 #define FF_DEBUG_THREADS 0x00010000
2419 * @deprecated this option does not have any effect
2421 attribute_deprecated
2423 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2424 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2425 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2429 * Error recognition; may misdetect some more or less valid parts as errors.
2430 * - encoding: unused
2431 * - decoding: Set by user.
2433 int err_recognition;
2436 * Verify checksums embedded in the bitstream (could be of either encoded or
2437 * decoded data, depending on the codec) and print an error message on mismatch.
2438 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2439 * decoder returning an error.
2441 #define AV_EF_CRCCHECK (1<<0)
2442 #define AV_EF_BITSTREAM (1<<1)
2443 #define AV_EF_BUFFER (1<<2)
2444 #define AV_EF_EXPLODE (1<<3)
2447 * opaque 64bit number (generally a PTS) that will be reordered and
2448 * output in AVFrame.reordered_opaque
2449 * @deprecated in favor of pkt_pts
2450 * - encoding: unused
2451 * - decoding: Set by user.
2453 int64_t reordered_opaque;
2456 * Hardware accelerator in use
2457 * - encoding: unused.
2458 * - decoding: Set by libavcodec
2460 struct AVHWAccel *hwaccel;
2463 * Hardware accelerator context.
2464 * For some hardware accelerators, a global context needs to be
2465 * provided by the user. In that case, this holds display-dependent
2466 * data Libav cannot instantiate itself. Please refer to the
2467 * Libav HW accelerator documentation to know how to fill this
2468 * is. e.g. for VA API, this is a struct vaapi_context.
2469 * - encoding: unused
2470 * - decoding: Set by user
2472 void *hwaccel_context;
2476 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2477 * - decoding: unused
2479 uint64_t error[AV_NUM_DATA_POINTERS];
2482 * DCT algorithm, see FF_DCT_* below
2483 * - encoding: Set by user.
2484 * - decoding: unused
2487 #define FF_DCT_AUTO 0
2488 #define FF_DCT_FASTINT 1
2489 #define FF_DCT_INT 2
2490 #define FF_DCT_MMX 3
2491 #define FF_DCT_ALTIVEC 5
2492 #define FF_DCT_FAAN 6
2495 * IDCT algorithm, see FF_IDCT_* below.
2496 * - encoding: Set by user.
2497 * - decoding: Set by user.
2500 #define FF_IDCT_AUTO 0
2501 #define FF_IDCT_INT 1
2502 #define FF_IDCT_SIMPLE 2
2503 #define FF_IDCT_SIMPLEMMX 3
2504 #define FF_IDCT_ARM 7
2505 #define FF_IDCT_ALTIVEC 8
2507 #define FF_IDCT_SH4 9
2509 #define FF_IDCT_SIMPLEARM 10
2510 #define FF_IDCT_IPP 13
2511 #define FF_IDCT_XVIDMMX 14
2512 #define FF_IDCT_SIMPLEARMV5TE 16
2513 #define FF_IDCT_SIMPLEARMV6 17
2514 #if FF_API_ARCH_SPARC
2515 #define FF_IDCT_SIMPLEVIS 18
2517 #define FF_IDCT_FAAN 20
2518 #define FF_IDCT_SIMPLENEON 22
2519 #if FF_API_ARCH_ALPHA
2520 #define FF_IDCT_SIMPLEALPHA 23
2524 * bits per sample/pixel from the demuxer (needed for huffyuv).
2525 * - encoding: Set by libavcodec.
2526 * - decoding: Set by user.
2528 int bits_per_coded_sample;
2531 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2532 * - encoding: set by user.
2533 * - decoding: set by libavcodec.
2535 int bits_per_raw_sample;
2539 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2540 * - encoding: unused
2541 * - decoding: Set by user.
2543 * @deprecated use decoder private options instead
2545 attribute_deprecated int lowres;
2549 * the picture in the bitstream
2550 * - encoding: Set by libavcodec.
2551 * - decoding: unused
2553 AVFrame *coded_frame;
2557 * is used to decide how many independent tasks should be passed to execute()
2558 * - encoding: Set by user.
2559 * - decoding: Set by user.
2564 * Which multithreading methods to use.
2565 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2566 * so clients which cannot provide future frames should not use it.
2568 * - encoding: Set by user, otherwise the default is used.
2569 * - decoding: Set by user, otherwise the default is used.
2572 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2573 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2576 * Which multithreading methods are in use by the codec.
2577 * - encoding: Set by libavcodec.
2578 * - decoding: Set by libavcodec.
2580 int active_thread_type;
2583 * Set by the client if its custom get_buffer() callback can be called
2584 * synchronously from another thread, which allows faster multithreaded decoding.
2585 * draw_horiz_band() will be called from other threads regardless of this setting.
2586 * Ignored if the default get_buffer() is used.
2587 * - encoding: Set by user.
2588 * - decoding: Set by user.
2590 int thread_safe_callbacks;
2593 * The codec may call this to execute several independent things.
2594 * It will return only after finishing all tasks.
2595 * The user may replace this with some multithreaded implementation,
2596 * the default implementation will execute the parts serially.
2597 * @param count the number of things to execute
2598 * - encoding: Set by libavcodec, user can override.
2599 * - decoding: Set by libavcodec, user can override.
2601 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2604 * The codec may call this to execute several independent things.
2605 * It will return only after finishing all tasks.
2606 * The user may replace this with some multithreaded implementation,
2607 * the default implementation will execute the parts serially.
2608 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2609 * @param c context passed also to func
2610 * @param count the number of things to execute
2611 * @param arg2 argument passed unchanged to func
2612 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2613 * @param func function that will be called count times, with jobnr from 0 to count-1.
2614 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2615 * two instances of func executing at the same time will have the same threadnr.
2616 * @return always 0 currently, but code should handle a future improvement where when any call to func
2617 * returns < 0 no further calls to func may be done and < 0 is returned.
2618 * - encoding: Set by libavcodec, user can override.
2619 * - decoding: Set by libavcodec, user can override.
2621 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2623 #if FF_API_THREAD_OPAQUE
2625 * @deprecated this field should not be used from outside of lavc
2627 attribute_deprecated
2628 void *thread_opaque;
2632 * noise vs. sse weight for the nsse comparsion function
2633 * - encoding: Set by user.
2634 * - decoding: unused
2640 * - encoding: Set by user.
2641 * - decoding: Set by libavcodec.
2644 #define FF_PROFILE_UNKNOWN -99
2645 #define FF_PROFILE_RESERVED -100
2647 #define FF_PROFILE_AAC_MAIN 0
2648 #define FF_PROFILE_AAC_LOW 1
2649 #define FF_PROFILE_AAC_SSR 2
2650 #define FF_PROFILE_AAC_LTP 3
2651 #define FF_PROFILE_AAC_HE 4
2652 #define FF_PROFILE_AAC_HE_V2 28
2653 #define FF_PROFILE_AAC_LD 22
2654 #define FF_PROFILE_AAC_ELD 38
2655 #define FF_PROFILE_MPEG2_AAC_LOW 128
2656 #define FF_PROFILE_MPEG2_AAC_HE 131
2658 #define FF_PROFILE_DTS 20
2659 #define FF_PROFILE_DTS_ES 30
2660 #define FF_PROFILE_DTS_96_24 40
2661 #define FF_PROFILE_DTS_HD_HRA 50
2662 #define FF_PROFILE_DTS_HD_MA 60
2664 #define FF_PROFILE_MPEG2_422 0
2665 #define FF_PROFILE_MPEG2_HIGH 1
2666 #define FF_PROFILE_MPEG2_SS 2
2667 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2668 #define FF_PROFILE_MPEG2_MAIN 4
2669 #define FF_PROFILE_MPEG2_SIMPLE 5
2671 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2672 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2674 #define FF_PROFILE_H264_BASELINE 66
2675 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2676 #define FF_PROFILE_H264_MAIN 77
2677 #define FF_PROFILE_H264_EXTENDED 88
2678 #define FF_PROFILE_H264_HIGH 100
2679 #define FF_PROFILE_H264_HIGH_10 110
2680 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2681 #define FF_PROFILE_H264_HIGH_422 122
2682 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2683 #define FF_PROFILE_H264_HIGH_444 144
2684 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2685 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2686 #define FF_PROFILE_H264_CAVLC_444 44
2688 #define FF_PROFILE_VC1_SIMPLE 0
2689 #define FF_PROFILE_VC1_MAIN 1
2690 #define FF_PROFILE_VC1_COMPLEX 2
2691 #define FF_PROFILE_VC1_ADVANCED 3
2693 #define FF_PROFILE_MPEG4_SIMPLE 0
2694 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2695 #define FF_PROFILE_MPEG4_CORE 2
2696 #define FF_PROFILE_MPEG4_MAIN 3
2697 #define FF_PROFILE_MPEG4_N_BIT 4
2698 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2699 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2700 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2701 #define FF_PROFILE_MPEG4_HYBRID 8
2702 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2703 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2704 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2705 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2706 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2707 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2708 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2710 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2711 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2712 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2713 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2714 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2717 #define FF_PROFILE_HEVC_MAIN 1
2718 #define FF_PROFILE_HEVC_MAIN_10 2
2719 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2723 * - encoding: Set by user.
2724 * - decoding: Set by libavcodec.
2727 #define FF_LEVEL_UNKNOWN -99
2731 * - encoding: unused
2732 * - decoding: Set by user.
2734 enum AVDiscard skip_loop_filter;
2738 * - encoding: unused
2739 * - decoding: Set by user.
2741 enum AVDiscard skip_idct;
2745 * - encoding: unused
2746 * - decoding: Set by user.
2748 enum AVDiscard skip_frame;
2751 * Header containing style information for text subtitles.
2752 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2753 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2754 * the Format line following. It shouldn't include any Dialogue line.
2755 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2756 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2758 uint8_t *subtitle_header;
2759 int subtitle_header_size;
2761 #if FF_API_ERROR_RATE
2763 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2766 attribute_deprecated
2770 #if FF_API_CODEC_PKT
2772 * @deprecated this field is not supposed to be accessed from outside lavc
2774 attribute_deprecated
2779 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2780 * Used for compliant TS muxing.
2781 * - encoding: Set by libavcodec.
2782 * - decoding: unused.
2790 typedef struct AVProfile {
2792 const char *name; ///< short name for the profile
2795 typedef struct AVCodecDefault AVCodecDefault;
2802 typedef struct AVCodec {
2804 * Name of the codec implementation.
2805 * The name is globally unique among encoders and among decoders (but an
2806 * encoder and a decoder can share the same name).
2807 * This is the primary way to find a codec from the user perspective.
2811 * Descriptive name for the codec, meant to be more human readable than name.
2812 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2814 const char *long_name;
2815 enum AVMediaType type;
2818 * Codec capabilities.
2822 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2823 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2824 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2825 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2826 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2828 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2830 const AVClass *priv_class; ///< AVClass for the private context
2831 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2833 /*****************************************************************
2834 * No fields below this line are part of the public API. They
2835 * may not be used outside of libavcodec and can be changed and
2837 * New public fields should be added right above.
2838 *****************************************************************
2841 struct AVCodec *next;
2843 * @name Frame-level threading support functions
2847 * If defined, called on thread contexts when they are created.
2848 * If the codec allocates writable tables in init(), re-allocate them here.
2849 * priv_data will be set to a copy of the original.
2851 int (*init_thread_copy)(AVCodecContext *);
2853 * Copy necessary context variables from a previous thread context to the current one.
2854 * If not defined, the next thread will start automatically; otherwise, the codec
2855 * must call ff_thread_finish_setup().
2857 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2859 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2863 * Private codec-specific defaults.
2865 const AVCodecDefault *defaults;
2868 * Initialize codec static data, called from avcodec_register().
2870 void (*init_static_data)(struct AVCodec *codec);
2872 int (*init)(AVCodecContext *);
2873 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2874 const struct AVSubtitle *sub);
2876 * Encode data to an AVPacket.
2878 * @param avctx codec context
2879 * @param avpkt output AVPacket (may contain a user-provided buffer)
2880 * @param[in] frame AVFrame containing the raw data to be encoded
2881 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2882 * non-empty packet was returned in avpkt.
2883 * @return 0 on success, negative error code on failure
2885 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2886 int *got_packet_ptr);
2887 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2888 int (*close)(AVCodecContext *);
2891 * Will be called when seeking
2893 void (*flush)(AVCodecContext *);
2899 typedef struct AVHWAccel {
2901 * Name of the hardware accelerated codec.
2902 * The name is globally unique among encoders and among decoders (but an
2903 * encoder and a decoder can share the same name).
2908 * Type of codec implemented by the hardware accelerator.
2910 * See AVMEDIA_TYPE_xxx
2912 enum AVMediaType type;
2915 * Codec implemented by the hardware accelerator.
2917 * See AV_CODEC_ID_xxx
2922 * Supported pixel format.
2924 * Only hardware accelerated formats are supported here.
2926 enum AVPixelFormat pix_fmt;
2929 * Hardware accelerated codec capabilities.
2930 * see FF_HWACCEL_CODEC_CAP_*
2934 struct AVHWAccel *next;
2937 * Called at the beginning of each frame or field picture.
2939 * Meaningful frame information (codec specific) is guaranteed to
2940 * be parsed at this point. This function is mandatory.
2942 * Note that buf can be NULL along with buf_size set to 0.
2943 * Otherwise, this means the whole frame is available at this point.
2945 * @param avctx the codec context
2946 * @param buf the frame data buffer base
2947 * @param buf_size the size of the frame in bytes
2948 * @return zero if successful, a negative value otherwise
2950 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2953 * Callback for each slice.
2955 * Meaningful slice information (codec specific) is guaranteed to
2956 * be parsed at this point. This function is mandatory.
2958 * @param avctx the codec context
2959 * @param buf the slice data buffer base
2960 * @param buf_size the size of the slice in bytes
2961 * @return zero if successful, a negative value otherwise
2963 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2966 * Called at the end of each frame or field picture.
2968 * The whole picture is parsed at this point and can now be sent
2969 * to the hardware accelerator. This function is mandatory.
2971 * @param avctx the codec context
2972 * @return zero if successful, a negative value otherwise
2974 int (*end_frame)(AVCodecContext *avctx);
2977 * Size of HW accelerator private data.
2979 * Private data is allocated with av_mallocz() before
2980 * AVCodecContext.get_buffer() and deallocated after
2981 * AVCodecContext.release_buffer().
2987 * @defgroup lavc_picture AVPicture
2989 * Functions for working with AVPicture
2994 * four components are given, that's all.
2995 * the last component is alpha
2997 typedef struct AVPicture {
2998 uint8_t *data[AV_NUM_DATA_POINTERS];
2999 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3006 #define AVPALETTE_SIZE 1024
3007 #define AVPALETTE_COUNT 256
3009 enum AVSubtitleType {
3012 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3015 * Plain text, the text field must be set by the decoder and is
3016 * authoritative. ass and pict fields may contain approximations.
3021 * Formatted text, the ass field must be set by the decoder and is
3022 * authoritative. pict and text fields may contain approximations.
3027 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3029 typedef struct AVSubtitleRect {
3030 int x; ///< top left corner of pict, undefined when pict is not set
3031 int y; ///< top left corner of pict, undefined when pict is not set
3032 int w; ///< width of pict, undefined when pict is not set
3033 int h; ///< height of pict, undefined when pict is not set
3034 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3037 * data+linesize for the bitmap of this subtitle.
3038 * can be set for text/ass as well once they where rendered
3041 enum AVSubtitleType type;
3043 char *text; ///< 0 terminated plain UTF-8 text
3046 * 0 terminated ASS/SSA compatible event line.
3047 * The pressentation of this is unaffected by the other values in this
3054 typedef struct AVSubtitle {
3055 uint16_t format; /* 0 = graphics */
3056 uint32_t start_display_time; /* relative to packet pts, in ms */
3057 uint32_t end_display_time; /* relative to packet pts, in ms */
3059 AVSubtitleRect **rects;
3060 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3064 * If c is NULL, returns the first registered codec,
3065 * if c is non-NULL, returns the next registered codec after c,
3066 * or NULL if c is the last one.
3068 AVCodec *av_codec_next(const AVCodec *c);
3071 * Return the LIBAVCODEC_VERSION_INT constant.
3073 unsigned avcodec_version(void);
3076 * Return the libavcodec build-time configuration.
3078 const char *avcodec_configuration(void);
3081 * Return the libavcodec license.
3083 const char *avcodec_license(void);
3086 * Register the codec codec and initialize libavcodec.
3088 * @warning either this function or avcodec_register_all() must be called
3089 * before any other libavcodec functions.
3091 * @see avcodec_register_all()
3093 void avcodec_register(AVCodec *codec);
3096 * Register all the codecs, parsers and bitstream filters which were enabled at
3097 * configuration time. If you do not call this function you can select exactly
3098 * which formats you want to support, by using the individual registration
3101 * @see avcodec_register
3102 * @see av_register_codec_parser
3103 * @see av_register_bitstream_filter
3105 void avcodec_register_all(void);
3108 * Allocate an AVCodecContext and set its fields to default values. The
3109 * resulting struct can be deallocated by calling avcodec_close() on it followed
3112 * @param codec if non-NULL, allocate private data and initialize defaults
3113 * for the given codec. It is illegal to then call avcodec_open2()
3114 * with a different codec.
3115 * If NULL, then the codec-specific defaults won't be initialized,
3116 * which may result in suboptimal default settings (this is
3117 * important mainly for encoders, e.g. libx264).
3119 * @return An AVCodecContext filled with default values or NULL on failure.
3120 * @see avcodec_get_context_defaults
3122 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3125 * Set the fields of the given AVCodecContext to default values corresponding
3126 * to the given codec (defaults may be codec-dependent).
3128 * Do not call this function if a non-NULL codec has been passed
3129 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3130 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3131 * different codec on this AVCodecContext.
3133 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3136 * Get the AVClass for AVCodecContext. It can be used in combination with
3137 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3139 * @see av_opt_find().
3141 const AVClass *avcodec_get_class(void);
3144 * Copy the settings of the source AVCodecContext into the destination
3145 * AVCodecContext. The resulting destination codec context will be
3146 * unopened, i.e. you are required to call avcodec_open2() before you
3147 * can use this AVCodecContext to decode/encode video/audio data.
3149 * @param dest target codec context, should be initialized with
3150 * avcodec_alloc_context3(), but otherwise uninitialized
3151 * @param src source codec context
3152 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3154 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3156 #if FF_API_AVFRAME_LAVC
3158 * @deprecated use av_frame_alloc()
3160 attribute_deprecated
3161 AVFrame *avcodec_alloc_frame(void);
3164 * Set the fields of the given AVFrame to default values.
3166 * @param frame The AVFrame of which the fields should be set to default values.
3168 * @deprecated use av_frame_unref()
3170 attribute_deprecated
3171 void avcodec_get_frame_defaults(AVFrame *frame);
3174 * Free the frame and any dynamically allocated objects in it,
3175 * e.g. extended_data.
3177 * @param frame frame to be freed. The pointer will be set to NULL.
3179 * @warning this function does NOT free the data buffers themselves
3180 * (it does not know how, since they might have been allocated with
3181 * a custom get_buffer()).
3183 * @deprecated use av_frame_free()
3185 attribute_deprecated
3186 void avcodec_free_frame(AVFrame **frame);
3190 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3191 * function the context has to be allocated with avcodec_alloc_context3().
3193 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3194 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3195 * retrieving a codec.
3197 * @warning This function is not thread safe!
3200 * avcodec_register_all();
3201 * av_dict_set(&opts, "b", "2.5M", 0);
3202 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3206 * context = avcodec_alloc_context3(codec);
3208 * if (avcodec_open2(context, codec, opts) < 0)
3212 * @param avctx The context to initialize.
3213 * @param codec The codec to open this context for. If a non-NULL codec has been
3214 * previously passed to avcodec_alloc_context3() or
3215 * avcodec_get_context_defaults3() for this context, then this
3216 * parameter MUST be either NULL or equal to the previously passed
3218 * @param options A dictionary filled with AVCodecContext and codec-private options.
3219 * On return this object will be filled with options that were not found.
3221 * @return zero on success, a negative value on error
3222 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3223 * av_dict_set(), av_opt_find().
3225 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3228 * Close a given AVCodecContext and free all the data associated with it
3229 * (but not the AVCodecContext itself).
3231 * Calling this function on an AVCodecContext that hasn't been opened will free
3232 * the codec-specific data allocated in avcodec_alloc_context3() /
3233 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3236 int avcodec_close(AVCodecContext *avctx);
3239 * Free all allocated data in the given subtitle struct.
3241 * @param sub AVSubtitle to free.
3243 void avsubtitle_free(AVSubtitle *sub);
3250 * @addtogroup lavc_packet
3254 #if FF_API_DESTRUCT_PACKET
3256 * Default packet destructor.
3257 * @deprecated use the AVBuffer API instead
3259 attribute_deprecated
3260 void av_destruct_packet(AVPacket *pkt);
3264 * Initialize optional fields of a packet with default values.
3266 * Note, this does not touch the data and size members, which have to be
3267 * initialized separately.
3271 void av_init_packet(AVPacket *pkt);
3274 * Allocate the payload of a packet and initialize its fields with
3278 * @param size wanted payload size
3279 * @return 0 if OK, AVERROR_xxx otherwise
3281 int av_new_packet(AVPacket *pkt, int size);
3284 * Reduce packet size, correctly zeroing padding
3287 * @param size new size
3289 void av_shrink_packet(AVPacket *pkt, int size);
3292 * Increase packet size, correctly zeroing padding
3295 * @param grow_by number of bytes by which to increase the size of the packet
3297 int av_grow_packet(AVPacket *pkt, int grow_by);
3300 * Initialize a reference-counted packet from av_malloc()ed data.
3302 * @param pkt packet to be initialized. This function will set the data, size,
3303 * buf and destruct fields, all others are left untouched.
3304 * @param data Data allocated by av_malloc() to be used as packet data. If this
3305 * function returns successfully, the data is owned by the underlying AVBuffer.
3306 * The caller may not access the data through other means.
3307 * @param size size of data in bytes, without the padding. I.e. the full buffer
3308 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3310 * @return 0 on success, a negative AVERROR on error
3312 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3315 * @warning This is a hack - the packet memory allocation stuff is broken. The
3316 * packet is allocated if it was not really allocated.
3318 int av_dup_packet(AVPacket *pkt);
3323 * @param pkt packet to free
3325 void av_free_packet(AVPacket *pkt);
3328 * Allocate new information of a packet.
3331 * @param type side information type
3332 * @param size side information size
3333 * @return pointer to fresh allocated data or NULL otherwise
3335 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3339 * Shrink the already allocated side data buffer
3342 * @param type side information type
3343 * @param size new side information size
3344 * @return 0 on success, < 0 on failure
3346 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3350 * Get side information from packet.
3353 * @param type desired side information type
3354 * @param size pointer for side information size to store (optional)
3355 * @return pointer to data if present or NULL otherwise
3357 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3361 * Convenience function to free all the side data stored.
3362 * All the other fields stay untouched.
3366 void av_packet_free_side_data(AVPacket *pkt);
3369 * Setup a new reference to the data described by a given packet
3371 * If src is reference-counted, setup dst as a new reference to the
3372 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3373 * data from src into it.
3375 * All the other fields are copied from src.
3377 * @see av_packet_unref
3379 * @param dst Destination packet
3380 * @param src Source packet
3382 * @return 0 on success, a negative AVERROR on error.
3384 int av_packet_ref(AVPacket *dst, AVPacket *src);
3389 * Unreference the buffer referenced by the packet and reset the
3390 * remaining packet fields to their default values.
3392 * @param pkt The packet to be unreferenced.
3394 void av_packet_unref(AVPacket *pkt);
3397 * Move every field in src to dst and reset src.
3399 * @see av_packet_unref
3401 * @param src Source packet, will be reset
3402 * @param dst Destination packet
3404 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3407 * Copy only "properties" fields from src to dst.
3409 * Properties for the purpose of this function are all the fields
3410 * beside those related to the packet data (buf, data, size)
3412 * @param dst Destination packet
3413 * @param src Source packet
3415 * @return 0 on success AVERROR on failure.
3418 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3425 * @addtogroup lavc_decoding
3430 * Find a registered decoder with a matching codec ID.
3432 * @param id AVCodecID of the requested decoder
3433 * @return A decoder if one was found, NULL otherwise.
3435 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3438 * Find a registered decoder with the specified name.
3440 * @param name name of the requested decoder
3441 * @return A decoder if one was found, NULL otherwise.
3443 AVCodec *avcodec_find_decoder_by_name(const char *name);
3445 #if FF_API_GET_BUFFER
3446 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3447 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3448 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3452 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3453 * it can be called by custom get_buffer2() implementations for decoders without
3454 * CODEC_CAP_DR1 set.
3456 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3460 * Return the amount of padding in pixels which the get_buffer callback must
3461 * provide around the edge of the image for codecs which do not have the
3462 * CODEC_FLAG_EMU_EDGE flag.
3464 * @return Required padding in pixels.
3466 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
3469 attribute_deprecated
3470 unsigned avcodec_get_edge_width(void);
3474 * Modify width and height values so that they will result in a memory
3475 * buffer that is acceptable for the codec if you do not use any horizontal
3478 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3480 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3483 * Modify width and height values so that they will result in a memory
3484 * buffer that is acceptable for the codec if you also ensure that all
3485 * line sizes are a multiple of the respective linesize_align[i].
3487 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3489 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3490 int linesize_align[AV_NUM_DATA_POINTERS]);
3493 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3495 * Some decoders may support multiple frames in a single AVPacket. Such
3496 * decoders would then just decode the first frame and the return value would be
3497 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3498 * called again with an AVPacket containing the remaining data in order to
3499 * decode the second frame, etc... Even if no frames are returned, the packet
3500 * needs to be fed to the decoder with remaining data until it is completely
3501 * consumed or an error occurs.
3503 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3504 * and output. This means that for some packets they will not immediately
3505 * produce decoded output and need to be flushed at the end of decoding to get
3506 * all the decoded data. Flushing is done by calling this function with packets
3507 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3508 * returning samples. It is safe to flush even those decoders that are not
3509 * marked with CODEC_CAP_DELAY, then no samples will be returned.
3511 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3512 * larger than the actual read bytes because some optimized bitstream
3513 * readers read 32 or 64 bits at once and could read over the end.
3515 * @param avctx the codec context
3516 * @param[out] frame The AVFrame in which to store decoded audio samples.
3517 * The decoder will allocate a buffer for the decoded frame by
3518 * calling the AVCodecContext.get_buffer2() callback.
3519 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3520 * reference counted and the returned reference belongs to the
3521 * caller. The caller must release the frame using av_frame_unref()
3522 * when the frame is no longer needed. The caller may safely write
3523 * to the frame if av_frame_is_writable() returns 1.
3524 * When AVCodecContext.refcounted_frames is set to 0, the returned
3525 * reference belongs to the decoder and is valid only until the
3526 * next call to this function or until closing or flushing the
3527 * decoder. The caller may not write to it.
3528 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3529 * non-zero. Note that this field being set to zero
3530 * does not mean that an error has occurred. For
3531 * decoders with CODEC_CAP_DELAY set, no given decode
3532 * call is guaranteed to produce a frame.
3533 * @param[in] avpkt The input AVPacket containing the input buffer.
3534 * At least avpkt->data and avpkt->size should be set. Some
3535 * decoders might also require additional fields to be set.
3536 * @return A negative error code is returned if an error occurred during
3537 * decoding, otherwise the number of bytes consumed from the input
3538 * AVPacket is returned.
3540 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3541 int *got_frame_ptr, AVPacket *avpkt);
3544 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3545 * Some decoders may support multiple frames in a single AVPacket, such
3546 * decoders would then just decode the first frame.
3548 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3549 * the actual read bytes because some optimized bitstream readers read 32 or 64
3550 * bits at once and could read over the end.
3552 * @warning The end of the input buffer buf should be set to 0 to ensure that
3553 * no overreading happens for damaged MPEG streams.
3555 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3556 * between input and output, these need to be fed with avpkt->data=NULL,
3557 * avpkt->size=0 at the end to return the remaining frames.
3559 * @param avctx the codec context
3560 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3561 * Use av_frame_alloc() to get an AVFrame. The codec will
3562 * allocate memory for the actual bitmap by calling the
3563 * AVCodecContext.get_buffer2() callback.
3564 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3565 * reference counted and the returned reference belongs to the
3566 * caller. The caller must release the frame using av_frame_unref()
3567 * when the frame is no longer needed. The caller may safely write
3568 * to the frame if av_frame_is_writable() returns 1.
3569 * When AVCodecContext.refcounted_frames is set to 0, the returned
3570 * reference belongs to the decoder and is valid only until the
3571 * next call to this function or until closing or flushing the
3572 * decoder. The caller may not write to it.
3574 * @param[in] avpkt The input AVpacket containing the input buffer.
3575 * You can create such packet with av_init_packet() and by then setting
3576 * data and size, some decoders might in addition need other fields like
3577 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3579 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3580 * @return On error a negative value is returned, otherwise the number of bytes
3581 * used or zero if no frame could be decompressed.
3583 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3584 int *got_picture_ptr,
3588 * Decode a subtitle message.
3589 * Return a negative value on error, otherwise return the number of bytes used.
3590 * If no subtitle could be decompressed, got_sub_ptr is zero.
3591 * Otherwise, the subtitle is stored in *sub.
3592 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3593 * simplicity, because the performance difference is expect to be negligible
3594 * and reusing a get_buffer written for video codecs would probably perform badly
3595 * due to a potentially very different allocation pattern.
3597 * @param avctx the codec context
3598 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3599 freed with avsubtitle_free if *got_sub_ptr is set.
3600 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3601 * @param[in] avpkt The input AVPacket containing the input buffer.
3603 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3608 * @defgroup lavc_parsing Frame parsing
3612 enum AVPictureStructure {
3613 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3614 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3615 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3616 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3619 typedef struct AVCodecParserContext {
3621 struct AVCodecParser *parser;
3622 int64_t frame_offset; /* offset of the current frame */
3623 int64_t cur_offset; /* current offset
3624 (incremented by each av_parser_parse()) */
3625 int64_t next_frame_offset; /* offset of the next frame */
3627 int pict_type; /* XXX: Put it back in AVCodecContext. */
3629 * This field is used for proper frame duration computation in lavf.
3630 * It signals, how much longer the frame duration of the current frame
3631 * is compared to normal frame duration.
3633 * frame_duration = (1 + repeat_pict) * time_base
3635 * It is used by codecs like H.264 to display telecined material.
3637 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3638 int64_t pts; /* pts of the current frame */
3639 int64_t dts; /* dts of the current frame */
3644 int fetch_timestamp;
3646 #define AV_PARSER_PTS_NB 4
3647 int cur_frame_start_index;
3648 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3649 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3650 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3653 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3654 #define PARSER_FLAG_ONCE 0x0002
3655 /// Set if the parser has a valid file offset
3656 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3658 int64_t offset; ///< byte offset from starting packet start
3659 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3662 * Set by parser to 1 for key frames and 0 for non-key frames.
3663 * It is initialized to -1, so if the parser doesn't set this flag,
3664 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3670 * Time difference in stream time base units from the pts of this
3671 * packet to the point at which the output from the decoder has converged
3672 * independent from the availability of previous frames. That is, the
3673 * frames are virtually identical no matter if decoding started from
3674 * the very first frame or from this keyframe.
3675 * Is AV_NOPTS_VALUE if unknown.
3676 * This field is not the display duration of the current frame.
3677 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3680 * The purpose of this field is to allow seeking in streams that have no
3681 * keyframes in the conventional sense. It corresponds to the
3682 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3683 * essential for some types of subtitle streams to ensure that all
3684 * subtitles are correctly displayed after seeking.
3686 int64_t convergence_duration;
3688 // Timestamp generation support:
3690 * Synchronization point for start of timestamp generation.
3692 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3695 * For example, this corresponds to presence of H.264 buffering period
3701 * Offset of the current timestamp against last timestamp sync point in
3702 * units of AVCodecContext.time_base.
3704 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3705 * contain a valid timestamp offset.
3707 * Note that the timestamp of sync point has usually a nonzero
3708 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3709 * the next frame after timestamp sync point will be usually 1.
3711 * For example, this corresponds to H.264 cpb_removal_delay.
3713 int dts_ref_dts_delta;
3716 * Presentation delay of current frame in units of AVCodecContext.time_base.
3718 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3719 * contain valid non-negative timestamp delta (presentation time of a frame
3720 * must not lie in the past).
3722 * This delay represents the difference between decoding and presentation
3723 * time of the frame.
3725 * For example, this corresponds to H.264 dpb_output_delay.
3730 * Position of the packet in file.
3732 * Analogous to cur_frame_pts/dts
3734 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3737 * Byte position of currently parsed frame in stream.
3742 * Previous frame byte position.
3747 * Duration of the current frame.
3748 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3749 * For all other types, this is in units of AVCodecContext.time_base.
3753 enum AVFieldOrder field_order;
3756 * Indicate whether a picture is coded as a frame, top field or bottom field.
3758 * For example, H.264 field_pic_flag equal to 0 corresponds to
3759 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3760 * equal to 1 and bottom_field_flag equal to 0 corresponds to
3761 * AV_PICTURE_STRUCTURE_TOP_FIELD.
3763 enum AVPictureStructure picture_structure;
3766 * Picture number incremented in presentation or output order.
3767 * This field may be reinitialized at the first picture of a new sequence.
3769 * For example, this corresponds to H.264 PicOrderCnt.
3771 int output_picture_number;
3772 } AVCodecParserContext;
3774 typedef struct AVCodecParser {
3775 int codec_ids[5]; /* several codec IDs are permitted */
3777 int (*parser_init)(AVCodecParserContext *s);
3778 int (*parser_parse)(AVCodecParserContext *s,
3779 AVCodecContext *avctx,
3780 const uint8_t **poutbuf, int *poutbuf_size,
3781 const uint8_t *buf, int buf_size);
3782 void (*parser_close)(AVCodecParserContext *s);
3783 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3784 struct AVCodecParser *next;
3787 AVCodecParser *av_parser_next(AVCodecParser *c);
3789 void av_register_codec_parser(AVCodecParser *parser);
3790 AVCodecParserContext *av_parser_init(int codec_id);
3795 * @param s parser context.
3796 * @param avctx codec context.
3797 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3798 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3799 * @param buf input buffer.
3800 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3801 * @param pts input presentation timestamp.
3802 * @param dts input decoding timestamp.
3803 * @param pos input byte position in stream.
3804 * @return the number of bytes of the input bitstream used.
3809 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3816 * decode_frame(data, size);
3820 int av_parser_parse2(AVCodecParserContext *s,
3821 AVCodecContext *avctx,
3822 uint8_t **poutbuf, int *poutbuf_size,
3823 const uint8_t *buf, int buf_size,
3824 int64_t pts, int64_t dts,
3828 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3829 * @deprecated use AVBitstreamFilter
3831 int av_parser_change(AVCodecParserContext *s,
3832 AVCodecContext *avctx,
3833 uint8_t **poutbuf, int *poutbuf_size,
3834 const uint8_t *buf, int buf_size, int keyframe);
3835 void av_parser_close(AVCodecParserContext *s);
3843 * @addtogroup lavc_encoding
3848 * Find a registered encoder with a matching codec ID.
3850 * @param id AVCodecID of the requested encoder
3851 * @return An encoder if one was found, NULL otherwise.
3853 AVCodec *avcodec_find_encoder(enum AVCodecID id);
3856 * Find a registered encoder with the specified name.
3858 * @param name name of the requested encoder
3859 * @return An encoder if one was found, NULL otherwise.
3861 AVCodec *avcodec_find_encoder_by_name(const char *name);
3864 * Encode a frame of audio.
3866 * Takes input samples from frame and writes the next output packet, if
3867 * available, to avpkt. The output packet does not necessarily contain data for
3868 * the most recent frame, as encoders can delay, split, and combine input frames
3869 * internally as needed.
3871 * @param avctx codec context
3872 * @param avpkt output AVPacket.
3873 * The user can supply an output buffer by setting
3874 * avpkt->data and avpkt->size prior to calling the
3875 * function, but if the size of the user-provided data is not
3876 * large enough, encoding will fail. All other AVPacket fields
3877 * will be reset by the encoder using av_init_packet(). If
3878 * avpkt->data is NULL, the encoder will allocate it.
3879 * The encoder will set avpkt->size to the size of the
3882 * If this function fails or produces no output, avpkt will be
3883 * freed using av_free_packet() (i.e. avpkt->destruct will be
3884 * called to free the user supplied buffer).
3885 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3886 * May be NULL when flushing an encoder that has the
3887 * CODEC_CAP_DELAY capability set.
3888 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3889 * can have any number of samples.
3890 * If it is not set, frame->nb_samples must be equal to
3891 * avctx->frame_size for all frames except the last.
3892 * The final frame may be smaller than avctx->frame_size.
3893 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3894 * output packet is non-empty, and to 0 if it is
3895 * empty. If the function returns an error, the
3896 * packet can be assumed to be invalid, and the
3897 * value of got_packet_ptr is undefined and should
3899 * @return 0 on success, negative error code on failure
3901 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3902 const AVFrame *frame, int *got_packet_ptr);
3905 * Encode a frame of video.
3907 * Takes input raw video data from frame and writes the next output packet, if
3908 * available, to avpkt. The output packet does not necessarily contain data for
3909 * the most recent frame, as encoders can delay and reorder input frames
3910 * internally as needed.
3912 * @param avctx codec context
3913 * @param avpkt output AVPacket.
3914 * The user can supply an output buffer by setting
3915 * avpkt->data and avpkt->size prior to calling the
3916 * function, but if the size of the user-provided data is not
3917 * large enough, encoding will fail. All other AVPacket fields
3918 * will be reset by the encoder using av_init_packet(). If
3919 * avpkt->data is NULL, the encoder will allocate it.
3920 * The encoder will set avpkt->size to the size of the
3921 * output packet. The returned data (if any) belongs to the
3922 * caller, he is responsible for freeing it.
3924 * If this function fails or produces no output, avpkt will be
3925 * freed using av_free_packet() (i.e. avpkt->destruct will be
3926 * called to free the user supplied buffer).
3927 * @param[in] frame AVFrame containing the raw video data to be encoded.
3928 * May be NULL when flushing an encoder that has the
3929 * CODEC_CAP_DELAY capability set.
3930 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3931 * output packet is non-empty, and to 0 if it is
3932 * empty. If the function returns an error, the
3933 * packet can be assumed to be invalid, and the
3934 * value of got_packet_ptr is undefined and should
3936 * @return 0 on success, negative error code on failure
3938 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3939 const AVFrame *frame, int *got_packet_ptr);
3941 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3942 const AVSubtitle *sub);
3950 * @addtogroup lavc_picture
3955 * Allocate memory for a picture. Call avpicture_free() to free it.
3957 * @see avpicture_fill()
3959 * @param picture the picture to be filled in
3960 * @param pix_fmt the format of the picture
3961 * @param width the width of the picture
3962 * @param height the height of the picture
3963 * @return zero if successful, a negative value if not
3965 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
3968 * Free a picture previously allocated by avpicture_alloc().
3969 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3972 * @param picture the AVPicture to be freed
3974 void avpicture_free(AVPicture *picture);
3977 * Fill in the AVPicture fields.
3978 * The fields of the given AVPicture are filled in by using the 'ptr' address
3979 * which points to the image data buffer. Depending on the specified picture
3980 * format, one or multiple image data pointers and line sizes will be set.
3981 * If a planar format is specified, several pointers will be set pointing to
3982 * the different picture planes and the line sizes of the different planes
3983 * will be stored in the lines_sizes array.
3984 * Call with ptr == NULL to get the required size for the ptr buffer.
3986 * To allocate the buffer and fill in the AVPicture fields in one call,
3987 * use avpicture_alloc().
3989 * @param picture AVPicture whose fields are to be filled in
3990 * @param ptr Buffer which will contain or contains the actual image data
3991 * @param pix_fmt The format in which the picture data is stored.
3992 * @param width the width of the image in pixels
3993 * @param height the height of the image in pixels
3994 * @return size of the image data in bytes
3996 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3997 enum AVPixelFormat pix_fmt, int width, int height);
4000 * Copy pixel data from an AVPicture into a buffer.
4001 * The data is stored compactly, without any gaps for alignment or padding
4002 * which may be applied by avpicture_fill().
4004 * @see avpicture_get_size()
4006 * @param[in] src AVPicture containing image data
4007 * @param[in] pix_fmt The format in which the picture data is stored.
4008 * @param[in] width the width of the image in pixels.
4009 * @param[in] height the height of the image in pixels.
4010 * @param[out] dest A buffer into which picture data will be copied.
4011 * @param[in] dest_size The size of 'dest'.
4012 * @return The number of bytes written to dest, or a negative value (error code) on error.
4014 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4015 int width, int height,
4016 unsigned char *dest, int dest_size);
4019 * Calculate the size in bytes that a picture of the given width and height
4020 * would occupy if stored in the given picture format.
4021 * Note that this returns the size of a compact representation as generated
4022 * by avpicture_layout(), which can be smaller than the size required for e.g.
4025 * @param pix_fmt the given picture format
4026 * @param width the width of the image
4027 * @param height the height of the image
4028 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
4030 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4032 #if FF_API_DEINTERLACE
4034 * deinterlace - if not supported return -1
4036 * @deprecated - use yadif (in libavfilter) instead
4038 attribute_deprecated
4039 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4040 enum AVPixelFormat pix_fmt, int width, int height);
4043 * Copy image src to dst. Wraps av_picture_data_copy() above.
4045 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4046 enum AVPixelFormat pix_fmt, int width, int height);
4049 * Crop image top and left side.
4051 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4052 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4057 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4058 int padtop, int padbottom, int padleft, int padright, int *color);
4065 * @defgroup lavc_misc Utility functions
4068 * Miscellaneous utility functions related to both encoding and decoding
4074 * @defgroup lavc_misc_pixfmt Pixel formats
4076 * Functions for working with pixel formats.
4081 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4084 void attribute_deprecated avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4087 * Return a value representing the fourCC code associated to the
4088 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4091 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4093 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4094 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4095 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4096 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4097 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4098 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4101 * Compute what kind of losses will occur when converting from one specific
4102 * pixel format to another.
4103 * When converting from one pixel format to another, information loss may occur.
4104 * For example, when converting from RGB24 to GRAY, the color information will
4105 * be lost. Similarly, other losses occur when converting from some formats to
4106 * other formats. These losses can involve loss of chroma, but also loss of
4107 * resolution, loss of color depth, loss due to the color space conversion, loss
4108 * of the alpha bits or loss due to color quantization.
4109 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4110 * which will occur when converting from one pixel format to another.
4112 * @param[in] dst_pix_fmt destination pixel format
4113 * @param[in] src_pix_fmt source pixel format
4114 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4115 * @return Combination of flags informing you what kind of losses will occur.
4117 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4121 * Find the best pixel format to convert to given a certain source pixel
4122 * format. When converting from one pixel format to another, information loss
4123 * may occur. For example, when converting from RGB24 to GRAY, the color
4124 * information will be lost. Similarly, other losses occur when converting from
4125 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4126 * the given pixel formats should be used to suffer the least amount of loss.
4127 * The pixel formats from which it chooses one, are determined by the
4128 * pix_fmt_list parameter.
4131 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4132 * @param[in] src_pix_fmt source pixel format
4133 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4134 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4135 * @return The best pixel format to convert to or -1 if none was found.
4137 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4138 enum AVPixelFormat src_pix_fmt,
4139 int has_alpha, int *loss_ptr);
4141 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4147 #if FF_API_SET_DIMENSIONS
4149 * @deprecated this function is not supposed to be used from outside of lavc
4151 attribute_deprecated
4152 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4156 * Put a string representing the codec tag codec_tag in buf.
4158 * @param buf buffer to place codec tag in
4159 * @param buf_size size in bytes of buf
4160 * @param codec_tag codec tag to assign
4161 * @return the length of the string that would have been generated if
4162 * enough space had been available, excluding the trailing null
4164 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4166 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4169 * Return a name for the specified profile, if available.
4171 * @param codec the codec that is searched for the given profile
4172 * @param profile the profile value for which a name is requested
4173 * @return A name for the profile if found, NULL otherwise.
4175 const char *av_get_profile_name(const AVCodec *codec, int profile);
4177 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4178 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4179 //FIXME func typedef
4182 * Fill audio frame data and linesize.
4183 * AVFrame extended_data channel pointers are allocated if necessary for
4186 * @param frame the AVFrame
4187 * frame->nb_samples must be set prior to calling the
4188 * function. This function fills in frame->data,
4189 * frame->extended_data, frame->linesize[0].
4190 * @param nb_channels channel count
4191 * @param sample_fmt sample format
4192 * @param buf buffer to use for frame data
4193 * @param buf_size size of buffer
4194 * @param align plane size sample alignment (0 = default)
4195 * @return 0 on success, negative error code on failure
4197 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4198 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4199 int buf_size, int align);
4202 * Reset the internal decoder state / flush internal buffers. Should be called
4203 * e.g. when seeking or when switching to a different stream.
4205 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4206 * this invalidates the frames previously returned from the decoder. When
4207 * refcounted frames are used, the decoder just releases any references it might
4208 * keep internally, but the caller's reference remains valid.
4210 void avcodec_flush_buffers(AVCodecContext *avctx);
4213 * Return codec bits per sample.
4215 * @param[in] codec_id the codec
4216 * @return Number of bits per sample or zero if unknown for the given codec.
4218 int av_get_bits_per_sample(enum AVCodecID codec_id);
4221 * Return codec bits per sample.
4222 * Only return non-zero if the bits per sample is exactly correct, not an
4225 * @param[in] codec_id the codec
4226 * @return Number of bits per sample or zero if unknown for the given codec.
4228 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4231 * Return audio frame duration.
4233 * @param avctx codec context
4234 * @param frame_bytes size of the frame, or 0 if unknown
4235 * @return frame duration, in samples, if known. 0 if not able to
4238 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4241 typedef struct AVBitStreamFilterContext {
4243 struct AVBitStreamFilter *filter;
4244 AVCodecParserContext *parser;
4245 struct AVBitStreamFilterContext *next;
4246 } AVBitStreamFilterContext;
4249 typedef struct AVBitStreamFilter {
4252 int (*filter)(AVBitStreamFilterContext *bsfc,
4253 AVCodecContext *avctx, const char *args,
4254 uint8_t **poutbuf, int *poutbuf_size,
4255 const uint8_t *buf, int buf_size, int keyframe);
4256 void (*close)(AVBitStreamFilterContext *bsfc);
4257 struct AVBitStreamFilter *next;
4258 } AVBitStreamFilter;
4260 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4261 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4262 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4263 AVCodecContext *avctx, const char *args,
4264 uint8_t **poutbuf, int *poutbuf_size,
4265 const uint8_t *buf, int buf_size, int keyframe);
4266 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4268 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4273 * Allocate a buffer with padding, reusing the given one if large enough.
4275 * Same behaviour av_fast_malloc but the buffer has additional
4276 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4279 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4282 * Encode extradata length to a buffer. Used by xiph codecs.
4284 * @param s buffer to write to; must be at least (v/255+1) bytes long
4285 * @param v size of extradata in bytes
4286 * @return number of bytes written to the buffer.
4288 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4290 #if FF_API_MISSING_SAMPLE
4292 * Log a generic warning message about a missing feature. This function is
4293 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4294 * only, and would normally not be used by applications.
4295 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4296 * a pointer to an AVClass struct
4297 * @param[in] feature string containing the name of the missing feature
4298 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4299 * If want_sample is non-zero, additional verbage will be added to the log
4300 * message which tells the user how to report samples to the development
4302 * @deprecated Use avpriv_report_missing_feature() instead.
4304 attribute_deprecated
4305 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4308 * Log a generic warning message asking for a sample. This function is
4309 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4310 * only, and would normally not be used by applications.
4311 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4312 * a pointer to an AVClass struct
4313 * @param[in] msg string containing an optional message, or NULL if no message
4314 * @deprecated Use avpriv_request_sample() instead.
4316 attribute_deprecated
4317 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4318 #endif /* FF_API_MISSING_SAMPLE */
4321 * Register the hardware accelerator hwaccel.
4323 void av_register_hwaccel(AVHWAccel *hwaccel);
4326 * If hwaccel is NULL, returns the first registered hardware accelerator,
4327 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4328 * after hwaccel, or NULL if hwaccel is the last one.
4330 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4334 * Lock operation used by lockmgr
4337 AV_LOCK_CREATE, ///< Create a mutex
4338 AV_LOCK_OBTAIN, ///< Lock the mutex
4339 AV_LOCK_RELEASE, ///< Unlock the mutex
4340 AV_LOCK_DESTROY, ///< Free mutex resources
4344 * Register a user provided lock manager supporting the operations
4345 * specified by AVLockOp. mutex points to a (void *) where the
4346 * lockmgr should store/get a pointer to a user allocated mutex. It's
4347 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4349 * @param cb User defined callback. Note: Libav may invoke calls to this
4350 * callback during the call to av_lockmgr_register().
4351 * Thus, the application must be prepared to handle that.
4352 * If cb is set to NULL the lockmgr will be unregistered.
4353 * Also note that during unregistration the previously registered
4354 * lockmgr callback may also be invoked.
4356 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4359 * Get the type of the given codec.
4361 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4364 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4365 * with no corresponding avcodec_close()), 0 otherwise.
4367 int avcodec_is_open(AVCodecContext *s);
4370 * @return a non-zero number if codec is an encoder, zero otherwise
4372 int av_codec_is_encoder(const AVCodec *codec);
4375 * @return a non-zero number if codec is a decoder, zero otherwise
4377 int av_codec_is_decoder(const AVCodec *codec);
4380 * @return descriptor for given codec ID or NULL if no descriptor exists.
4382 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4385 * Iterate over all codec descriptors known to libavcodec.
4387 * @param prev previous descriptor. NULL to get the first descriptor.
4389 * @return next descriptor or NULL after the last descriptor
4391 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4394 * @return codec descriptor with the given name or NULL if no such descriptor
4397 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4403 #endif /* AVCODEC_AVCODEC_H */