2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/log.h"
40 #include "libavutil/pixfmt.h"
41 #include "libavutil/rational.h"
45 #if FF_API_FAST_MALLOC
46 // to provide fast_*alloc
47 #include "libavutil/mem.h"
51 * @defgroup libavc Encoding/Decoding Library
54 * @defgroup lavc_decoding Decoding
58 * @defgroup lavc_encoding Encoding
62 * @defgroup lavc_codec Codecs
64 * @defgroup lavc_codec_native Native Codecs
67 * @defgroup lavc_codec_wrappers External library wrappers
70 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
74 * @defgroup lavc_internal Internal
82 * @defgroup lavc_core Core functions/structures.
85 * Basic definitions, functions for querying libavcodec capabilities,
86 * allocating core structures, etc.
92 * Identify the syntax and semantics of the bitstream.
93 * The principle is roughly:
94 * Two decoders with the same ID can decode the same streams.
95 * Two encoders with the same ID can encode compatible streams.
96 * There may be slight deviations from the principle due to implementation
99 * If you add a codec ID to this list, add it so that
100 * 1. no value of a existing codec ID changes (that would break ABI),
101 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
102 * This ensures that 2 forks can independently add AVCodecIDs without producing conflicts.
104 * After adding new codec IDs, do not forget to add an entry to the codec
105 * descriptor list and bump libavcodec minor version.
111 AV_CODEC_ID_MPEG1VIDEO,
112 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
114 AV_CODEC_ID_MPEG2VIDEO_XVMC,
115 #endif /* FF_API_XVMC */
126 AV_CODEC_ID_RAWVIDEO,
127 AV_CODEC_ID_MSMPEG4V1,
128 AV_CODEC_ID_MSMPEG4V2,
129 AV_CODEC_ID_MSMPEG4V3,
152 AV_CODEC_ID_INTERPLAY_VIDEO,
159 AV_CODEC_ID_MSVIDEO1,
164 AV_CODEC_ID_TRUEMOTION1,
165 AV_CODEC_ID_VMDVIDEO,
190 AV_CODEC_ID_TRUEMOTION2,
196 AV_CODEC_ID_SMACKVIDEO,
201 AV_CODEC_ID_JPEG2000,
207 AV_CODEC_ID_DSICINVIDEO,
208 AV_CODEC_ID_TIERTEXSEQVIDEO,
216 AV_CODEC_ID_BETHSOFTVID,
228 AV_CODEC_ID_ESCAPE124,
232 AV_CODEC_ID_MOTIONPIXELS,
244 AV_CODEC_ID_FLASHSV2,
245 AV_CODEC_ID_CDGRAPHICS,
248 AV_CODEC_ID_BINKVIDEO,
249 AV_CODEC_ID_IFF_ILBM,
250 AV_CODEC_ID_IFF_BYTERUN1,
256 AV_CODEC_ID_A64_MULTI,
257 AV_CODEC_ID_A64_MULTI5,
260 AV_CODEC_ID_LAGARITH,
264 AV_CODEC_ID_WMV3IMAGE,
265 AV_CODEC_ID_VC1IMAGE,
267 AV_CODEC_ID_BMV_VIDEO,
274 AV_CODEC_ID_ZEROCODEC,
283 AV_CODEC_ID_ESCAPE130_DEPRECATED,
284 AV_CODEC_ID_G2M_DEPRECATED,
285 AV_CODEC_ID_WEBP_DEPRECATED,
286 AV_CODEC_ID_HNM4_VIDEO,
287 AV_CODEC_ID_HEVC_DEPRECATED,
289 AV_CODEC_ID_ALIAS_PIX,
290 AV_CODEC_ID_BRENDER_PIX_DEPRECATED,
291 AV_CODEC_ID_PAF_VIDEO_DEPRECATED,
292 AV_CODEC_ID_EXR_DEPRECATED,
293 AV_CODEC_ID_VP7_DEPRECATED,
294 AV_CODEC_ID_SANM_DEPRECATED,
295 AV_CODEC_ID_SGIRLE_DEPRECATED,
296 AV_CODEC_ID_MVC1_DEPRECATED,
297 AV_CODEC_ID_MVC2_DEPRECATED,
299 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
300 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
301 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
302 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
303 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
305 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
306 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
307 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
308 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
309 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
310 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
311 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
312 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
313 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
314 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
315 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
316 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
317 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
318 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
319 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
320 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
321 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
322 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
323 AV_CODEC_ID_SMVJPEG = MKBETAG('S','M','V','J'),
324 AV_CODEC_ID_HEVC = MKBETAG('H','2','6','5'),
325 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
326 AV_CODEC_ID_VP7 = MKBETAG('V','P','7','0'),
328 /* various PCM "codecs" */
329 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
330 AV_CODEC_ID_PCM_S16LE = 0x10000,
331 AV_CODEC_ID_PCM_S16BE,
332 AV_CODEC_ID_PCM_U16LE,
333 AV_CODEC_ID_PCM_U16BE,
336 AV_CODEC_ID_PCM_MULAW,
337 AV_CODEC_ID_PCM_ALAW,
338 AV_CODEC_ID_PCM_S32LE,
339 AV_CODEC_ID_PCM_S32BE,
340 AV_CODEC_ID_PCM_U32LE,
341 AV_CODEC_ID_PCM_U32BE,
342 AV_CODEC_ID_PCM_S24LE,
343 AV_CODEC_ID_PCM_S24BE,
344 AV_CODEC_ID_PCM_U24LE,
345 AV_CODEC_ID_PCM_U24BE,
346 AV_CODEC_ID_PCM_S24DAUD,
347 AV_CODEC_ID_PCM_ZORK,
348 AV_CODEC_ID_PCM_S16LE_PLANAR,
350 AV_CODEC_ID_PCM_F32BE,
351 AV_CODEC_ID_PCM_F32LE,
352 AV_CODEC_ID_PCM_F64BE,
353 AV_CODEC_ID_PCM_F64LE,
354 AV_CODEC_ID_PCM_BLURAY,
357 AV_CODEC_ID_PCM_S8_PLANAR,
358 AV_CODEC_ID_PCM_S24LE_PLANAR_DEPRECATED,
359 AV_CODEC_ID_PCM_S32LE_PLANAR_DEPRECATED,
360 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
361 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
362 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
364 /* various ADPCM codecs */
365 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
366 AV_CODEC_ID_ADPCM_IMA_WAV,
367 AV_CODEC_ID_ADPCM_IMA_DK3,
368 AV_CODEC_ID_ADPCM_IMA_DK4,
369 AV_CODEC_ID_ADPCM_IMA_WS,
370 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
371 AV_CODEC_ID_ADPCM_MS,
372 AV_CODEC_ID_ADPCM_4XM,
373 AV_CODEC_ID_ADPCM_XA,
374 AV_CODEC_ID_ADPCM_ADX,
375 AV_CODEC_ID_ADPCM_EA,
376 AV_CODEC_ID_ADPCM_G726,
377 AV_CODEC_ID_ADPCM_CT,
378 AV_CODEC_ID_ADPCM_SWF,
379 AV_CODEC_ID_ADPCM_YAMAHA,
380 AV_CODEC_ID_ADPCM_SBPRO_4,
381 AV_CODEC_ID_ADPCM_SBPRO_3,
382 AV_CODEC_ID_ADPCM_SBPRO_2,
383 AV_CODEC_ID_ADPCM_THP,
384 AV_CODEC_ID_ADPCM_IMA_AMV,
385 AV_CODEC_ID_ADPCM_EA_R1,
386 AV_CODEC_ID_ADPCM_EA_R3,
387 AV_CODEC_ID_ADPCM_EA_R2,
388 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
389 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
390 AV_CODEC_ID_ADPCM_EA_XAS,
391 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
392 AV_CODEC_ID_ADPCM_IMA_ISS,
393 AV_CODEC_ID_ADPCM_G722,
394 AV_CODEC_ID_ADPCM_IMA_APC,
395 AV_CODEC_ID_ADPCM_VIMA_DEPRECATED,
396 AV_CODEC_ID_ADPCM_VIMA = MKBETAG('V','I','M','A'),
397 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
398 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
399 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
400 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
401 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
402 AV_CODEC_ID_ADPCM_G726LE = MKBETAG('6','2','7','G'),
405 AV_CODEC_ID_AMR_NB = 0x12000,
408 /* RealAudio codecs*/
409 AV_CODEC_ID_RA_144 = 0x13000,
412 /* various DPCM codecs */
413 AV_CODEC_ID_ROQ_DPCM = 0x14000,
414 AV_CODEC_ID_INTERPLAY_DPCM,
415 AV_CODEC_ID_XAN_DPCM,
416 AV_CODEC_ID_SOL_DPCM,
419 AV_CODEC_ID_MP2 = 0x15000,
420 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
430 AV_CODEC_ID_VMDAUDIO,
436 AV_CODEC_ID_WESTWOOD_SND1,
437 AV_CODEC_ID_GSM, ///< as in Berlin toast format
440 AV_CODEC_ID_TRUESPEECH,
442 AV_CODEC_ID_SMACKAUDIO,
445 AV_CODEC_ID_DSICINAUDIO,
447 AV_CODEC_ID_MUSEPACK7,
449 AV_CODEC_ID_GSM_MS, /* as found in WAV */
455 AV_CODEC_ID_NELLYMOSER,
456 AV_CODEC_ID_MUSEPACK8,
458 AV_CODEC_ID_WMAVOICE,
460 AV_CODEC_ID_WMALOSSLESS,
469 AV_CODEC_ID_BINKAUDIO_RDFT,
470 AV_CODEC_ID_BINKAUDIO_DCT,
471 AV_CODEC_ID_AAC_LATM,
476 AV_CODEC_ID_8SVX_EXP,
477 AV_CODEC_ID_8SVX_FIB,
478 AV_CODEC_ID_BMV_AUDIO,
482 AV_CODEC_ID_OPUS_DEPRECATED,
483 AV_CODEC_ID_COMFORT_NOISE,
484 AV_CODEC_ID_TAK_DEPRECATED,
485 AV_CODEC_ID_METASOUND,
486 AV_CODEC_ID_PAF_AUDIO_DEPRECATED,
488 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
489 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
490 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
491 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
492 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
493 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
494 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
495 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
496 AV_CODEC_ID_DSD_LSBF = MKBETAG('D','S','D','L'),
497 AV_CODEC_ID_DSD_MSBF = MKBETAG('D','S','D','M'),
498 AV_CODEC_ID_DSD_LSBF_PLANAR = MKBETAG('D','S','D','1'),
499 AV_CODEC_ID_DSD_MSBF_PLANAR = MKBETAG('D','S','D','8'),
501 /* subtitle codecs */
502 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
503 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
504 AV_CODEC_ID_DVB_SUBTITLE,
505 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
508 AV_CODEC_ID_MOV_TEXT,
509 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
510 AV_CODEC_ID_DVB_TELETEXT,
512 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
513 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
514 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
515 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
516 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
517 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
518 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
519 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
520 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
521 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
522 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
523 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
524 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
526 /* other specific kind of codecs (generally used for attachments) */
527 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
528 AV_CODEC_ID_TTF = 0x18000,
529 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
530 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
531 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
532 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
533 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
534 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
535 AV_CODEC_ID_TIMED_ID3 = MKBETAG('T','I','D','3'),
536 AV_CODEC_ID_BIN_DATA = MKBETAG('D','A','T','A'),
539 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
541 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
542 * stream (only used by libavformat) */
543 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
544 * stream (only used by libavformat) */
545 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
548 #include "old_codec_ids.h"
553 * This struct describes the properties of a single codec described by an
555 * @see avcodec_get_descriptor()
557 typedef struct AVCodecDescriptor {
559 enum AVMediaType type;
561 * Name of the codec described by this descriptor. It is non-empty and
562 * unique for each codec descriptor. It should contain alphanumeric
563 * characters and '_' only.
567 * A more descriptive name for this codec. May be NULL.
569 const char *long_name;
571 * Codec properties, a combination of AV_CODEC_PROP_* flags.
576 * MIME type(s) associated with the codec.
577 * May be NULL; if not, a NULL-terminated array of MIME types.
578 * The first item is always non-NULL and is the preferred MIME type.
580 const char *const *mime_types;
584 * Codec uses only intra compression.
587 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
589 * Codec supports lossy compression. Audio and video codecs only.
590 * @note a codec may support both lossy and lossless
593 #define AV_CODEC_PROP_LOSSY (1 << 1)
595 * Codec supports lossless compression. Audio and video codecs only.
597 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
599 * Subtitle codec is bitmap based
600 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
602 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
604 * Subtitle codec is text based.
605 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
607 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
610 * @ingroup lavc_decoding
611 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
612 * This is mainly needed because some optimized bitstream readers read
613 * 32 or 64 bit at once and could read over the end.<br>
614 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
615 * MPEG bitstreams could cause overread and segfault.
617 #define FF_INPUT_BUFFER_PADDING_SIZE 32
620 * @ingroup lavc_encoding
621 * minimum encoding buffer size
622 * Used to avoid some checks during header writing.
624 #define FF_MIN_BUFFER_SIZE 16384
628 * @ingroup lavc_encoding
629 * motion estimation type.
632 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
636 ME_EPZS, ///< enhanced predictive zonal search
637 ME_X1, ///< reserved for experiments
638 ME_HEX, ///< hexagon based search
639 ME_UMH, ///< uneven multi-hexagon search
640 ME_TESA, ///< transformed exhaustive search algorithm
641 ME_ITER=50, ///< iterative search
645 * @ingroup lavc_decoding
648 /* We leave some space between them for extensions (drop some
649 * keyframes for intra-only or drop just some bidir frames). */
650 AVDISCARD_NONE =-16, ///< discard nothing
651 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
652 AVDISCARD_NONREF = 8, ///< discard all non reference
653 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
654 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
655 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
656 AVDISCARD_ALL = 48, ///< discard all
659 enum AVAudioServiceType {
660 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
661 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
662 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
663 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
664 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
665 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
666 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
667 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
668 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
669 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
673 * @ingroup lavc_encoding
675 typedef struct RcOverride{
678 int qscale; // If this is 0 then quality_factor will be used instead.
679 float quality_factor;
682 #if FF_API_MAX_BFRAMES
684 * @deprecated there is no libavcodec-wide limit on the number of B-frames
686 #define FF_MAX_B_FRAMES 16
690 These flags can be passed in AVCodecContext.flags before initialization.
691 Note: Not everything is supported yet.
695 * Allow decoders to produce frames with data planes that are not aligned
696 * to CPU requirements (e.g. due to cropping).
698 #define CODEC_FLAG_UNALIGNED 0x0001
699 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
700 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
701 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
702 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
705 * @deprecated use the "gmc" private option of the libxvid encoder
707 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
711 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
714 #define CODEC_FLAG_MV0 0x0040
716 #if FF_API_INPUT_PRESERVED
718 * @deprecated passing reference-counted frames to the encoders replaces this
721 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
723 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
724 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
725 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
728 * @deprecated edges are not used/required anymore. I.e. this flag is now always
731 #define CODEC_FLAG_EMU_EDGE 0x4000
733 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
734 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
735 location instead of only at frame boundaries. */
736 #if FF_API_NORMALIZE_AQP
738 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
741 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
743 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
744 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
745 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
746 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
747 /* Fx : Flag for h263+ extra options */
748 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
749 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
750 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
751 #define CODEC_FLAG_CLOSED_GOP 0x80000000
752 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
753 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
754 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
755 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
756 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
758 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
759 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
761 /* Unsupported options :
762 * Syntax Arithmetic coding (SAC)
763 * Reference Picture Selection
764 * Independent Segment Decoding */
766 /* codec capabilities */
768 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
770 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
771 * If not set, it might not use get_buffer() at all or use operations that
772 * assume the buffer was allocated by avcodec_default_get_buffer.
774 #define CODEC_CAP_DR1 0x0002
775 #define CODEC_CAP_TRUNCATED 0x0008
777 /* Codec can export data for HW decoding. This flag indicates that
778 * the codec would call get_format() with list that might contain HW accelerated
779 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
780 * including raw image format.
781 * The application can use the passed context to determine bitstream version,
782 * chroma format, resolution etc.
784 #define CODEC_CAP_HWACCEL 0x0010
785 #endif /* FF_API_XVMC */
787 * Encoder or decoder requires flushing with NULL input at the end in order to
788 * give the complete and correct output.
790 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
791 * with NULL data. The user can still send NULL data to the public encode
792 * or decode function, but libavcodec will not pass it along to the codec
793 * unless this flag is set.
796 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
797 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
801 * The encoder needs to be fed with NULL data at the end of encoding until the
802 * encoder no longer returns data.
804 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
805 * flag also means that the encoder must set the pts and duration for
806 * each output packet. If this flag is not set, the pts and duration will
807 * be determined by libavcodec from the input frame.
809 #define CODEC_CAP_DELAY 0x0020
811 * Codec can be fed a final frame with a smaller size.
812 * This can be used to prevent truncation of the last audio samples.
814 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
817 * Codec can export data for HW decoding (VDPAU).
819 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
822 * Codec can output multiple frames per AVPacket
823 * Normally demuxers return one frame at a time, demuxers which do not do
824 * are connected to a parser to split what they return into proper frames.
825 * This flag is reserved to the very rare category of codecs which have a
826 * bitstream that cannot be split into frames without timeconsuming
827 * operations like full decoding. Demuxers carring such bitstreams thus
828 * may return multiple frames in a packet. This has many disadvantages like
829 * prohibiting stream copy in many cases thus it should only be considered
832 #define CODEC_CAP_SUBFRAMES 0x0100
834 * Codec is experimental and is thus avoided in favor of non experimental
837 #define CODEC_CAP_EXPERIMENTAL 0x0200
839 * Codec should fill in channel configuration and samplerate instead of container
841 #define CODEC_CAP_CHANNEL_CONF 0x0400
842 #if FF_API_NEG_LINESIZES
844 * @deprecated no codecs use this capability
846 #define CODEC_CAP_NEG_LINESIZES 0x0800
849 * Codec supports frame-level multithreading.
851 #define CODEC_CAP_FRAME_THREADS 0x1000
853 * Codec supports slice-based (or partition-based) multithreading.
855 #define CODEC_CAP_SLICE_THREADS 0x2000
857 * Codec supports changed parameters at any point.
859 #define CODEC_CAP_PARAM_CHANGE 0x4000
861 * Codec supports avctx->thread_count == 0 (auto).
863 #define CODEC_CAP_AUTO_THREADS 0x8000
865 * Audio encoder supports receiving a different number of samples in each call.
867 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
869 * Codec is intra only.
871 #define CODEC_CAP_INTRA_ONLY 0x40000000
875 #define CODEC_CAP_LOSSLESS 0x80000000
878 //The following defines may change, don't expect compatibility if you use them.
879 #define MB_TYPE_INTRA4x4 0x0001
880 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
881 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
882 #define MB_TYPE_16x16 0x0008
883 #define MB_TYPE_16x8 0x0010
884 #define MB_TYPE_8x16 0x0020
885 #define MB_TYPE_8x8 0x0040
886 #define MB_TYPE_INTERLACED 0x0080
887 #define MB_TYPE_DIRECT2 0x0100 //FIXME
888 #define MB_TYPE_ACPRED 0x0200
889 #define MB_TYPE_GMC 0x0400
890 #define MB_TYPE_SKIP 0x0800
891 #define MB_TYPE_P0L0 0x1000
892 #define MB_TYPE_P1L0 0x2000
893 #define MB_TYPE_P0L1 0x4000
894 #define MB_TYPE_P1L1 0x8000
895 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
896 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
897 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
898 #define MB_TYPE_QUANT 0x00010000
899 #define MB_TYPE_CBP 0x00020000
900 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
905 * This specifies the area which should be displayed.
906 * Note there may be multiple such areas for one frame.
908 typedef struct AVPanScan{
911 * - encoding: Set by user.
912 * - decoding: Set by libavcodec.
917 * width and height in 1/16 pel
918 * - encoding: Set by user.
919 * - decoding: Set by libavcodec.
925 * position of the top left corner in 1/16 pel for up to 3 fields/frames
926 * - encoding: Set by user.
927 * - decoding: Set by libavcodec.
929 int16_t position[3][2];
932 #if FF_API_QSCALE_TYPE
933 #define FF_QSCALE_TYPE_MPEG1 0
934 #define FF_QSCALE_TYPE_MPEG2 1
935 #define FF_QSCALE_TYPE_H264 2
936 #define FF_QSCALE_TYPE_VP56 3
939 #if FF_API_GET_BUFFER
940 #define FF_BUFFER_TYPE_INTERNAL 1
941 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
942 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
943 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
945 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
946 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
947 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
948 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
952 * The decoder will keep a reference to the frame and may reuse it later.
954 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
957 * @defgroup lavc_packet AVPacket
959 * Types and functions for working with AVPacket.
962 enum AVPacketSideDataType {
964 AV_PKT_DATA_NEW_EXTRADATA,
967 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
970 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
971 * s32le channel_count
972 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
973 * u64le channel_layout
974 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
976 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
981 AV_PKT_DATA_PARAM_CHANGE,
984 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
985 * structures with info about macroblocks relevant to splitting the
986 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
987 * That is, it does not necessarily contain info about all macroblocks,
988 * as long as the distance between macroblocks in the info is smaller
989 * than the target payload size.
990 * Each MB info structure is 12 bytes, and is laid out as follows:
992 * u32le bit offset from the start of the packet
993 * u8 current quantizer at the start of the macroblock
995 * u16le macroblock address within the GOB
996 * u8 horizontal MV predictor
997 * u8 vertical MV predictor
998 * u8 horizontal MV predictor for block number 3
999 * u8 vertical MV predictor for block number 3
1002 AV_PKT_DATA_H263_MB_INFO,
1005 * This side data should be associated with an audio stream and contains
1006 * ReplayGain information in form of the AVReplayGain struct.
1008 AV_PKT_DATA_REPLAYGAIN,
1011 * This side data contains a 3x3 transformation matrix describing an affine
1012 * transformation that needs to be applied to the decoded video frames for
1013 * correct presentation.
1015 * See libavutil/display.h for a detailed description of the data.
1017 AV_PKT_DATA_DISPLAYMATRIX,
1020 * Recommmends skipping the specified number of samples
1022 * u32le number of samples to skip from start of this packet
1023 * u32le number of samples to skip from end of this packet
1024 * u8 reason for start skip
1025 * u8 reason for end skip (0=padding silence, 1=convergence)
1028 AV_PKT_DATA_SKIP_SAMPLES=70,
1031 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1032 * the packet may contain "dual mono" audio specific to Japanese DTV
1033 * and if it is true, recommends only the selected channel to be used.
1035 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1038 AV_PKT_DATA_JP_DUALMONO,
1041 * A list of zero terminated key/value strings. There is no end marker for
1042 * the list, so it is required to rely on the side data size to stop.
1044 AV_PKT_DATA_STRINGS_METADATA,
1047 * Subtitle event position
1055 AV_PKT_DATA_SUBTITLE_POSITION,
1058 * Data found in BlockAdditional element of matroska container. There is
1059 * no end marker for the data, so it is required to rely on the side data
1060 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1063 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1066 * The optional first identifier line of a WebVTT cue.
1068 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1071 * The optional settings (rendering instructions) that immediately
1072 * follow the timestamp specifier of a WebVTT cue.
1074 AV_PKT_DATA_WEBVTT_SETTINGS,
1077 * A list of zero terminated key/value strings. There is no end marker for
1078 * the list, so it is required to rely on the side data size to stop. This
1079 * side data includes updated metadata which appeared in the stream.
1081 AV_PKT_DATA_METADATA_UPDATE,
1084 typedef struct AVPacketSideData {
1087 enum AVPacketSideDataType type;
1091 * This structure stores compressed data. It is typically exported by demuxers
1092 * and then passed as input to decoders, or received as output from encoders and
1093 * then passed to muxers.
1095 * For video, it should typically contain one compressed frame. For audio it may
1096 * contain several compressed frames.
1098 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1099 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1100 * without libavcodec and libavformat major bump.
1102 * The semantics of data ownership depends on the buf or destruct (deprecated)
1103 * fields. If either is set, the packet data is dynamically allocated and is
1104 * valid indefinitely until av_free_packet() is called (which in turn calls
1105 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1106 * the packet data is typically backed by some static buffer somewhere and is
1107 * only valid for a limited time (e.g. until the next read call when demuxing).
1109 * The side data is always allocated with av_malloc() and is freed in
1112 typedef struct AVPacket {
1114 * A reference to the reference-counted buffer where the packet data is
1116 * May be NULL, then the packet data is not reference-counted.
1120 * Presentation timestamp in AVStream->time_base units; the time at which
1121 * the decompressed packet will be presented to the user.
1122 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1123 * pts MUST be larger or equal to dts as presentation cannot happen before
1124 * decompression, unless one wants to view hex dumps. Some formats misuse
1125 * the terms dts and pts/cts to mean something different. Such timestamps
1126 * must be converted to true pts/dts before they are stored in AVPacket.
1130 * Decompression timestamp in AVStream->time_base units; the time at which
1131 * the packet is decompressed.
1132 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1139 * A combination of AV_PKT_FLAG values
1143 * Additional packet data that can be provided by the container.
1144 * Packet can contain several types of side information.
1146 AVPacketSideData *side_data;
1147 int side_data_elems;
1150 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1151 * Equals next_pts - this_pts in presentation order.
1154 #if FF_API_DESTRUCT_PACKET
1155 attribute_deprecated
1156 void (*destruct)(struct AVPacket *);
1157 attribute_deprecated
1160 int64_t pos; ///< byte position in stream, -1 if unknown
1163 * Time difference in AVStream->time_base units from the pts of this
1164 * packet to the point at which the output from the decoder has converged
1165 * independent from the availability of previous frames. That is, the
1166 * frames are virtually identical no matter if decoding started from
1167 * the very first frame or from this keyframe.
1168 * Is AV_NOPTS_VALUE if unknown.
1169 * This field is not the display duration of the current packet.
1170 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1173 * The purpose of this field is to allow seeking in streams that have no
1174 * keyframes in the conventional sense. It corresponds to the
1175 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1176 * essential for some types of subtitle streams to ensure that all
1177 * subtitles are correctly displayed after seeking.
1179 int64_t convergence_duration;
1181 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1182 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1184 enum AVSideDataParamChangeFlags {
1185 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1186 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1187 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1188 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1194 struct AVCodecInternal;
1198 AV_FIELD_PROGRESSIVE,
1199 AV_FIELD_TT, //< Top coded_first, top displayed first
1200 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1201 AV_FIELD_TB, //< Top coded first, bottom displayed first
1202 AV_FIELD_BT, //< Bottom coded first, top displayed first
1206 * main external API structure.
1207 * New fields can be added to the end with minor version bumps.
1208 * Removal, reordering and changes to existing fields require a major
1210 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1212 * sizeof(AVCodecContext) must not be used outside libav*.
1214 typedef struct AVCodecContext {
1216 * information on struct for av_log
1217 * - set by avcodec_alloc_context3
1219 const AVClass *av_class;
1220 int log_level_offset;
1222 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1223 const struct AVCodec *codec;
1224 #if FF_API_CODEC_NAME
1226 * @deprecated this field is not used for anything in libavcodec
1228 attribute_deprecated
1229 char codec_name[32];
1231 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1234 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1235 * This is used to work around some encoder bugs.
1236 * A demuxer should set this to what is stored in the field used to identify the codec.
1237 * If there are multiple such fields in a container then the demuxer should choose the one
1238 * which maximizes the information about the used codec.
1239 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1240 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1241 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1243 * - encoding: Set by user, if not then the default based on codec_id will be used.
1244 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1246 unsigned int codec_tag;
1249 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1250 * This is used to work around some encoder bugs.
1251 * - encoding: unused
1252 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1254 unsigned int stream_codec_tag;
1259 * Private context used for internal data.
1261 * Unlike priv_data, this is not codec-specific. It is used in general
1262 * libavcodec functions.
1264 struct AVCodecInternal *internal;
1267 * Private data of the user, can be used to carry app specific stuff.
1268 * - encoding: Set by user.
1269 * - decoding: Set by user.
1274 * the average bitrate
1275 * - encoding: Set by user; unused for constant quantizer encoding.
1276 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1281 * number of bits the bitstream is allowed to diverge from the reference.
1282 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1283 * - encoding: Set by user; unused for constant quantizer encoding.
1284 * - decoding: unused
1286 int bit_rate_tolerance;
1289 * Global quality for codecs which cannot change it per frame.
1290 * This should be proportional to MPEG-1/2/4 qscale.
1291 * - encoding: Set by user.
1292 * - decoding: unused
1297 * - encoding: Set by user.
1298 * - decoding: unused
1300 int compression_level;
1301 #define FF_COMPRESSION_DEFAULT -1
1305 * - encoding: Set by user.
1306 * - decoding: Set by user.
1312 * - encoding: Set by user.
1313 * - decoding: Set by user.
1318 * some codecs need / can use extradata like Huffman tables.
1319 * mjpeg: Huffman tables
1320 * rv10: additional flags
1321 * mpeg4: global headers (they can be in the bitstream or here)
1322 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1323 * than extradata_size to avoid problems if it is read with the bitstream reader.
1324 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1325 * - encoding: Set/allocated/freed by libavcodec.
1326 * - decoding: Set/allocated/freed by user.
1332 * This is the fundamental unit of time (in seconds) in terms
1333 * of which frame timestamps are represented. For fixed-fps content,
1334 * timebase should be 1/framerate and timestamp increments should be
1336 * - encoding: MUST be set by user.
1337 * - decoding: Set by libavcodec.
1339 AVRational time_base;
1342 * For some codecs, the time base is closer to the field rate than the frame rate.
1343 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1344 * if no telecine is used ...
1346 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1348 int ticks_per_frame;
1353 * Encoding: Number of frames delay there will be from the encoder input to
1354 * the decoder output. (we assume the decoder matches the spec)
1355 * Decoding: Number of frames delay in addition to what a standard decoder
1356 * as specified in the spec would produce.
1359 * Number of frames the decoded output will be delayed relative to the
1363 * For encoding, this is the number of "priming" samples added by the
1364 * encoder to the beginning of the stream. The decoded output will be
1365 * delayed by this many samples relative to the input to the encoder (or
1366 * more, if the decoder adds its own padding).
1367 * The timestamps on the output packets are adjusted by the encoder so
1368 * that they always refer to the first sample of the data actually
1369 * contained in the packet, including any added padding.
1370 * E.g. if the timebase is 1/samplerate and the timestamp of the first
1371 * input sample is 0, the timestamp of the first output packet will be
1374 * For decoding, this is the number of samples the decoder needs to
1375 * output before the decoder's output is valid. When seeking, you should
1376 * start decoding this many samples prior to your desired seek point.
1378 * - encoding: Set by libavcodec.
1379 * - decoding: Set by libavcodec.
1386 * picture width / height.
1387 * - encoding: MUST be set by user.
1388 * - decoding: May be set by the user before opening the decoder if known e.g.
1389 * from the container. Some decoders will require the dimensions
1390 * to be set by the caller. During decoding, the decoder may
1391 * overwrite those values as required.
1396 * Bitstream width / height, may be different from width/height e.g. when
1397 * the decoded frame is cropped before being output or lowres is enabled.
1398 * - encoding: unused
1399 * - decoding: May be set by the user before opening the decoder if known
1400 * e.g. from the container. During decoding, the decoder may
1401 * overwrite those values as required.
1403 int coded_width, coded_height;
1405 #if FF_API_ASPECT_EXTENDED
1406 #define FF_ASPECT_EXTENDED 15
1410 * the number of pictures in a group of pictures, or 0 for intra_only
1411 * - encoding: Set by user.
1412 * - decoding: unused
1417 * Pixel format, see AV_PIX_FMT_xxx.
1418 * May be set by the demuxer if known from headers.
1419 * May be overridden by the decoder if it knows better.
1420 * - encoding: Set by user.
1421 * - decoding: Set by user if known, overridden by libavcodec if known
1423 enum AVPixelFormat pix_fmt;
1426 * Motion estimation algorithm used for video coding.
1427 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1428 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1429 * - encoding: MUST be set by user.
1430 * - decoding: unused
1435 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1436 * decoder to draw a horizontal band. It improves cache usage. Not
1437 * all codecs can do that. You must check the codec capabilities
1439 * When multithreading is used, it may be called from multiple threads
1440 * at the same time; threads might draw different parts of the same AVFrame,
1441 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1443 * The function is also used by hardware acceleration APIs.
1444 * It is called at least once during frame decoding to pass
1445 * the data needed for hardware render.
1446 * In that mode instead of pixel data, AVFrame points to
1447 * a structure specific to the acceleration API. The application
1448 * reads the structure and can change some fields to indicate progress
1450 * - encoding: unused
1451 * - decoding: Set by user.
1452 * @param height the height of the slice
1453 * @param y the y position of the slice
1454 * @param type 1->top field, 2->bottom field, 3->frame
1455 * @param offset offset into the AVFrame.data from which the slice should be read
1457 void (*draw_horiz_band)(struct AVCodecContext *s,
1458 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1459 int y, int type, int height);
1462 * callback to negotiate the pixelFormat
1463 * @param fmt is the list of formats which are supported by the codec,
1464 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1465 * The first is always the native one.
1466 * @return the chosen format
1467 * - encoding: unused
1468 * - decoding: Set by user, if not set the native format will be chosen.
1470 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1473 * maximum number of B-frames between non-B-frames
1474 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1475 * - encoding: Set by user.
1476 * - decoding: unused
1481 * qscale factor between IP and B-frames
1482 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1483 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1484 * - encoding: Set by user.
1485 * - decoding: unused
1487 float b_quant_factor;
1489 /** obsolete FIXME remove */
1491 #define FF_RC_STRATEGY_XVID 1
1493 int b_frame_strategy;
1496 * qscale offset between IP and B-frames
1497 * - encoding: Set by user.
1498 * - decoding: unused
1500 float b_quant_offset;
1503 * Size of the frame reordering buffer in the decoder.
1504 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1505 * - encoding: Set by libavcodec.
1506 * - decoding: Set by libavcodec.
1511 * 0-> h263 quant 1-> mpeg quant
1512 * - encoding: Set by user.
1513 * - decoding: unused
1518 * qscale factor between P and I-frames
1519 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1520 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1521 * - encoding: Set by user.
1522 * - decoding: unused
1524 float i_quant_factor;
1527 * qscale offset between P and I-frames
1528 * - encoding: Set by user.
1529 * - decoding: unused
1531 float i_quant_offset;
1534 * luminance masking (0-> disabled)
1535 * - encoding: Set by user.
1536 * - decoding: unused
1541 * temporary complexity masking (0-> disabled)
1542 * - encoding: Set by user.
1543 * - decoding: unused
1545 float temporal_cplx_masking;
1548 * spatial complexity masking (0-> disabled)
1549 * - encoding: Set by user.
1550 * - decoding: unused
1552 float spatial_cplx_masking;
1555 * p block masking (0-> disabled)
1556 * - encoding: Set by user.
1557 * - decoding: unused
1562 * darkness masking (0-> disabled)
1563 * - encoding: Set by user.
1564 * - decoding: unused
1570 * - encoding: Set by libavcodec.
1571 * - decoding: Set by user (or 0).
1575 * prediction method (needed for huffyuv)
1576 * - encoding: Set by user.
1577 * - decoding: unused
1579 int prediction_method;
1580 #define FF_PRED_LEFT 0
1581 #define FF_PRED_PLANE 1
1582 #define FF_PRED_MEDIAN 2
1585 * slice offsets in the frame in bytes
1586 * - encoding: Set/allocated by libavcodec.
1587 * - decoding: Set/allocated by user (or NULL).
1592 * sample aspect ratio (0 if unknown)
1593 * That is the width of a pixel divided by the height of the pixel.
1594 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1595 * - encoding: Set by user.
1596 * - decoding: Set by libavcodec.
1598 AVRational sample_aspect_ratio;
1601 * motion estimation comparison function
1602 * - encoding: Set by user.
1603 * - decoding: unused
1607 * subpixel motion estimation comparison function
1608 * - encoding: Set by user.
1609 * - decoding: unused
1613 * macroblock comparison function (not supported yet)
1614 * - encoding: Set by user.
1615 * - decoding: unused
1619 * interlaced DCT comparison function
1620 * - encoding: Set by user.
1621 * - decoding: unused
1624 #define FF_CMP_SAD 0
1625 #define FF_CMP_SSE 1
1626 #define FF_CMP_SATD 2
1627 #define FF_CMP_DCT 3
1628 #define FF_CMP_PSNR 4
1629 #define FF_CMP_BIT 5
1631 #define FF_CMP_ZERO 7
1632 #define FF_CMP_VSAD 8
1633 #define FF_CMP_VSSE 9
1634 #define FF_CMP_NSSE 10
1635 #define FF_CMP_W53 11
1636 #define FF_CMP_W97 12
1637 #define FF_CMP_DCTMAX 13
1638 #define FF_CMP_DCT264 14
1639 #define FF_CMP_CHROMA 256
1642 * ME diamond size & shape
1643 * - encoding: Set by user.
1644 * - decoding: unused
1649 * amount of previous MV predictors (2a+1 x 2a+1 square)
1650 * - encoding: Set by user.
1651 * - decoding: unused
1653 int last_predictor_count;
1656 * prepass for motion estimation
1657 * - encoding: Set by user.
1658 * - decoding: unused
1663 * motion estimation prepass comparison function
1664 * - encoding: Set by user.
1665 * - decoding: unused
1670 * ME prepass diamond size & shape
1671 * - encoding: Set by user.
1672 * - decoding: unused
1678 * - encoding: Set by user.
1679 * - decoding: unused
1681 int me_subpel_quality;
1684 * DTG active format information (additional aspect ratio
1685 * information only used in DVB MPEG-2 transport streams)
1688 * - encoding: unused
1689 * - decoding: Set by decoder.
1691 int dtg_active_format;
1692 #define FF_DTG_AFD_SAME 8
1693 #define FF_DTG_AFD_4_3 9
1694 #define FF_DTG_AFD_16_9 10
1695 #define FF_DTG_AFD_14_9 11
1696 #define FF_DTG_AFD_4_3_SP_14_9 13
1697 #define FF_DTG_AFD_16_9_SP_14_9 14
1698 #define FF_DTG_AFD_SP_4_3 15
1701 * maximum motion estimation search range in subpel units
1702 * If 0 then no limit.
1704 * - encoding: Set by user.
1705 * - decoding: unused
1710 * intra quantizer bias
1711 * - encoding: Set by user.
1712 * - decoding: unused
1714 int intra_quant_bias;
1715 #define FF_DEFAULT_QUANT_BIAS 999999
1718 * inter quantizer bias
1719 * - encoding: Set by user.
1720 * - decoding: unused
1722 int inter_quant_bias;
1726 * - encoding: unused
1727 * - decoding: Set by user.
1730 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1731 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1732 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1736 * XVideo Motion Acceleration
1737 * - encoding: forbidden
1738 * - decoding: set by decoder
1739 * @deprecated XvMC doesn't need it anymore.
1741 attribute_deprecated int xvmc_acceleration;
1742 #endif /* FF_API_XVMC */
1745 * macroblock decision mode
1746 * - encoding: Set by user.
1747 * - decoding: unused
1750 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1751 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1752 #define FF_MB_DECISION_RD 2 ///< rate distortion
1755 * custom intra quantization matrix
1756 * - encoding: Set by user, can be NULL.
1757 * - decoding: Set by libavcodec.
1759 uint16_t *intra_matrix;
1762 * custom inter quantization matrix
1763 * - encoding: Set by user, can be NULL.
1764 * - decoding: Set by libavcodec.
1766 uint16_t *inter_matrix;
1769 * scene change detection threshold
1770 * 0 is default, larger means fewer detected scene changes.
1771 * - encoding: Set by user.
1772 * - decoding: unused
1774 int scenechange_threshold;
1777 * noise reduction strength
1778 * - encoding: Set by user.
1779 * - decoding: unused
1781 int noise_reduction;
1784 * Motion estimation threshold below which no motion estimation is
1785 * performed, but instead the user specified motion vectors are used.
1787 * - encoding: Set by user.
1788 * - decoding: unused
1793 * Macroblock threshold below which the user specified macroblock types will be used.
1794 * - encoding: Set by user.
1795 * - decoding: unused
1800 * precision of the intra DC coefficient - 8
1801 * - encoding: Set by user.
1802 * - decoding: unused
1804 int intra_dc_precision;
1807 * Number of macroblock rows at the top which are skipped.
1808 * - encoding: unused
1809 * - decoding: Set by user.
1814 * Number of macroblock rows at the bottom which are skipped.
1815 * - encoding: unused
1816 * - decoding: Set by user.
1821 * Border processing masking, raises the quantizer for mbs on the borders
1823 * - encoding: Set by user.
1824 * - decoding: unused
1826 float border_masking;
1829 * minimum MB lagrange multipler
1830 * - encoding: Set by user.
1831 * - decoding: unused
1836 * maximum MB lagrange multipler
1837 * - encoding: Set by user.
1838 * - decoding: unused
1844 * - encoding: Set by user.
1845 * - decoding: unused
1847 int me_penalty_compensation;
1851 * - encoding: Set by user.
1852 * - decoding: unused
1858 * - encoding: Set by user.
1859 * - decoding: unused
1865 * - encoding: Set by user.
1866 * - decoding: unused
1871 * number of reference frames
1872 * - encoding: Set by user.
1873 * - decoding: Set by lavc.
1878 * chroma qp offset from luma
1879 * - encoding: Set by user.
1880 * - decoding: unused
1885 * Multiplied by qscale for each frame and added to scene_change_score.
1886 * - encoding: Set by user.
1887 * - decoding: unused
1889 int scenechange_factor;
1893 * Note: Value depends upon the compare function used for fullpel ME.
1894 * - encoding: Set by user.
1895 * - decoding: unused
1900 * Adjust sensitivity of b_frame_strategy 1.
1901 * - encoding: Set by user.
1902 * - decoding: unused
1907 * Chromaticity coordinates of the source primaries.
1908 * - encoding: Set by user
1909 * - decoding: Set by libavcodec
1911 enum AVColorPrimaries color_primaries;
1914 * Color Transfer Characteristic.
1915 * - encoding: Set by user
1916 * - decoding: Set by libavcodec
1918 enum AVColorTransferCharacteristic color_trc;
1921 * YUV colorspace type.
1922 * - encoding: Set by user
1923 * - decoding: Set by libavcodec
1925 enum AVColorSpace colorspace;
1928 * MPEG vs JPEG YUV range.
1929 * - encoding: Set by user
1930 * - decoding: Set by libavcodec
1932 enum AVColorRange color_range;
1935 * This defines the location of chroma samples.
1936 * - encoding: Set by user
1937 * - decoding: Set by libavcodec
1939 enum AVChromaLocation chroma_sample_location;
1943 * Indicates number of picture subdivisions. Used for parallelized
1945 * - encoding: Set by user
1946 * - decoding: unused
1951 * - encoding: set by libavcodec
1952 * - decoding: Set by user.
1954 enum AVFieldOrder field_order;
1957 int sample_rate; ///< samples per second
1958 int channels; ///< number of audio channels
1961 * audio sample format
1962 * - encoding: Set by user.
1963 * - decoding: Set by libavcodec.
1965 enum AVSampleFormat sample_fmt; ///< sample format
1967 /* The following data should not be initialized. */
1969 * Number of samples per channel in an audio frame.
1971 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1972 * except the last must contain exactly frame_size samples per channel.
1973 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1974 * frame size is not restricted.
1975 * - decoding: may be set by some decoders to indicate constant frame size
1980 * Frame counter, set by libavcodec.
1982 * - decoding: total number of frames returned from the decoder so far.
1983 * - encoding: total number of frames passed to the encoder so far.
1985 * @note the counter is not incremented if encoding/decoding resulted in
1991 * number of bytes per packet if constant and known or 0
1992 * Used by some WAV based audio codecs.
1997 * Audio cutoff bandwidth (0 means "automatic")
1998 * - encoding: Set by user.
1999 * - decoding: unused
2003 #if FF_API_REQUEST_CHANNELS
2005 * Decoder should decode to this many channels if it can (0 for default)
2006 * - encoding: unused
2007 * - decoding: Set by user.
2008 * @deprecated Deprecated in favor of request_channel_layout.
2010 attribute_deprecated int request_channels;
2014 * Audio channel layout.
2015 * - encoding: set by user.
2016 * - decoding: set by user, may be overwritten by libavcodec.
2018 uint64_t channel_layout;
2021 * Request decoder to use this channel layout if it can (0 for default)
2022 * - encoding: unused
2023 * - decoding: Set by user.
2025 uint64_t request_channel_layout;
2028 * Type of service that the audio stream conveys.
2029 * - encoding: Set by user.
2030 * - decoding: Set by libavcodec.
2032 enum AVAudioServiceType audio_service_type;
2035 * desired sample format
2036 * - encoding: Not used.
2037 * - decoding: Set by user.
2038 * Decoder will decode to this format if it can.
2040 enum AVSampleFormat request_sample_fmt;
2042 #if FF_API_GET_BUFFER
2044 * Called at the beginning of each frame to get a buffer for it.
2046 * The function will set AVFrame.data[], AVFrame.linesize[].
2047 * AVFrame.extended_data[] must also be set, but it should be the same as
2048 * AVFrame.data[] except for planar audio with more channels than can fit
2049 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2050 * many data pointers as it can hold.
2052 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2053 * avcodec_default_get_buffer() instead of providing buffers allocated by
2056 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2057 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2058 * but if get_buffer() is overridden then alignment considerations should
2059 * be taken into account.
2061 * @see avcodec_default_get_buffer()
2065 * If pic.reference is set then the frame will be read later by libavcodec.
2066 * avcodec_align_dimensions2() should be used to find the required width and
2067 * height, as they normally need to be rounded up to the next multiple of 16.
2069 * If frame multithreading is used and thread_safe_callbacks is set,
2070 * it may be called from a different thread, but not from more than one at
2071 * once. Does not need to be reentrant.
2073 * @see release_buffer(), reget_buffer()
2074 * @see avcodec_align_dimensions2()
2078 * Decoders request a buffer of a particular size by setting
2079 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2080 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2081 * to a smaller value in the output frame.
2083 * Decoders cannot use the buffer after returning from
2084 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2085 * is assumed to be released immediately upon return. In some rare cases,
2086 * a decoder may need to call get_buffer() more than once in a single
2087 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2088 * called again after it has already been called once, the previously
2089 * acquired buffer is assumed to be released at that time and may not be
2090 * reused by the decoder.
2092 * As a convenience, av_samples_get_buffer_size() and
2093 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2094 * functions to find the required data size and to fill data pointers and
2095 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2096 * since all planes must be the same size.
2098 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2100 * - encoding: unused
2101 * - decoding: Set by libavcodec, user can override.
2103 * @deprecated use get_buffer2()
2105 attribute_deprecated
2106 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2109 * Called to release buffers which were allocated with get_buffer.
2110 * A released buffer can be reused in get_buffer().
2111 * pic.data[*] must be set to NULL.
2112 * May be called from a different thread if frame multithreading is used,
2113 * but not by more than one thread at once, so does not need to be reentrant.
2114 * - encoding: unused
2115 * - decoding: Set by libavcodec, user can override.
2117 * @deprecated custom freeing callbacks should be set from get_buffer2()
2119 attribute_deprecated
2120 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2123 * Called at the beginning of a frame to get cr buffer for it.
2124 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2125 * libavcodec will pass previous buffer in pic, function should return
2126 * same buffer or new buffer with old frame "painted" into it.
2127 * If pic.data[0] == NULL must behave like get_buffer().
2128 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2129 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2131 * - encoding: unused
2132 * - decoding: Set by libavcodec, user can override.
2134 attribute_deprecated
2135 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2139 * This callback is called at the beginning of each frame to get data
2140 * buffer(s) for it. There may be one contiguous buffer for all the data or
2141 * there may be a buffer per each data plane or anything in between. What
2142 * this means is, you may set however many entries in buf[] you feel necessary.
2143 * Each buffer must be reference-counted using the AVBuffer API (see description
2146 * The following fields will be set in the frame before this callback is
2149 * - width, height (video only)
2150 * - sample_rate, channel_layout, nb_samples (audio only)
2151 * Their values may differ from the corresponding values in
2152 * AVCodecContext. This callback must use the frame values, not the codec
2153 * context values, to calculate the required buffer size.
2155 * This callback must fill the following fields in the frame:
2159 * * if the data is planar audio with more than 8 channels, then this
2160 * callback must allocate and fill extended_data to contain all pointers
2161 * to all data planes. data[] must hold as many pointers as it can.
2162 * extended_data must be allocated with av_malloc() and will be freed in
2164 * * otherwise exended_data must point to data
2165 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2166 * the frame's data and extended_data pointers must be contained in these. That
2167 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2168 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2169 * and av_buffer_ref().
2170 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2171 * this callback and filled with the extra buffers if there are more
2172 * buffers than buf[] can hold. extended_buf will be freed in
2175 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2176 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2179 * Each data plane must be aligned to the maximum required by the target
2182 * @see avcodec_default_get_buffer2()
2186 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2187 * (read and/or written to if it is writable) later by libavcodec.
2189 * avcodec_align_dimensions2() should be used to find the required width and
2190 * height, as they normally need to be rounded up to the next multiple of 16.
2192 * Some decoders do not support linesizes changing between frames.
2194 * If frame multithreading is used and thread_safe_callbacks is set,
2195 * this callback may be called from a different thread, but not from more
2196 * than one at once. Does not need to be reentrant.
2198 * @see avcodec_align_dimensions2()
2202 * Decoders request a buffer of a particular size by setting
2203 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2204 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2205 * to a smaller value in the output frame.
2207 * As a convenience, av_samples_get_buffer_size() and
2208 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2209 * functions to find the required data size and to fill data pointers and
2210 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2211 * since all planes must be the same size.
2213 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2215 * - encoding: unused
2216 * - decoding: Set by libavcodec, user can override.
2218 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2221 * If non-zero, the decoded audio and video frames returned from
2222 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2223 * and are valid indefinitely. The caller must free them with
2224 * av_frame_unref() when they are not needed anymore.
2225 * Otherwise, the decoded frames must not be freed by the caller and are
2226 * only valid until the next decode call.
2228 * - encoding: unused
2229 * - decoding: set by the caller before avcodec_open2().
2231 int refcounted_frames;
2233 /* - encoding parameters */
2234 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2235 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2239 * - encoding: Set by user.
2240 * - decoding: unused
2246 * - encoding: Set by user.
2247 * - decoding: unused
2252 * maximum quantizer difference between frames
2253 * - encoding: Set by user.
2254 * - decoding: unused
2259 * ratecontrol qmin qmax limiting method
2260 * 0-> clipping, 1-> use a nice continuous function to limit qscale within qmin/qmax.
2261 * - encoding: Set by user.
2262 * - decoding: unused
2270 * decoder bitstream buffer size
2271 * - encoding: Set by user.
2272 * - decoding: unused
2277 * ratecontrol override, see RcOverride
2278 * - encoding: Allocated/set/freed by user.
2279 * - decoding: unused
2281 int rc_override_count;
2282 RcOverride *rc_override;
2285 * rate control equation
2286 * - encoding: Set by user
2287 * - decoding: unused
2293 * - encoding: Set by user.
2294 * - decoding: Set by libavcodec.
2300 * - encoding: Set by user.
2301 * - decoding: unused
2305 float rc_buffer_aggressivity;
2308 * initial complexity for pass1 ratecontrol
2309 * - encoding: Set by user.
2310 * - decoding: unused
2312 float rc_initial_cplx;
2315 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2316 * - encoding: Set by user.
2317 * - decoding: unused.
2319 float rc_max_available_vbv_use;
2322 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2323 * - encoding: Set by user.
2324 * - decoding: unused.
2326 float rc_min_vbv_overflow_use;
2329 * Number of bits which should be loaded into the rc buffer before decoding starts.
2330 * - encoding: Set by user.
2331 * - decoding: unused
2333 int rc_initial_buffer_occupancy;
2335 #define FF_CODER_TYPE_VLC 0
2336 #define FF_CODER_TYPE_AC 1
2337 #define FF_CODER_TYPE_RAW 2
2338 #define FF_CODER_TYPE_RLE 3
2339 #define FF_CODER_TYPE_DEFLATE 4
2342 * - encoding: Set by user.
2343 * - decoding: unused
2349 * - encoding: Set by user.
2350 * - decoding: unused
2355 * minimum Lagrange multiplier
2356 * - encoding: Set by user.
2357 * - decoding: unused
2362 * maximum Lagrange multiplier
2363 * - encoding: Set by user.
2364 * - decoding: unused
2369 * frame skip threshold
2370 * - encoding: Set by user.
2371 * - decoding: unused
2373 int frame_skip_threshold;
2377 * - encoding: Set by user.
2378 * - decoding: unused
2380 int frame_skip_factor;
2383 * frame skip exponent
2384 * - encoding: Set by user.
2385 * - decoding: unused
2390 * frame skip comparison function
2391 * - encoding: Set by user.
2392 * - decoding: unused
2397 * trellis RD quantization
2398 * - encoding: Set by user.
2399 * - decoding: unused
2404 * - encoding: Set by user.
2405 * - decoding: unused
2407 int min_prediction_order;
2410 * - encoding: Set by user.
2411 * - decoding: unused
2413 int max_prediction_order;
2416 * GOP timecode frame start number
2417 * - encoding: Set by user, in non drop frame format
2418 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2420 int64_t timecode_frame_start;
2422 /* The RTP callback: This function is called */
2423 /* every time the encoder has a packet to send. */
2424 /* It depends on the encoder if the data starts */
2425 /* with a Start Code (it should). H.263 does. */
2426 /* mb_nb contains the number of macroblocks */
2427 /* encoded in the RTP payload. */
2428 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2430 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2431 /* do its best to deliver a chunk with size */
2432 /* below rtp_payload_size, the chunk will start */
2433 /* with a start code on some codecs like H.263. */
2434 /* This doesn't take account of any particular */
2435 /* headers inside the transmitted RTP payload. */
2437 /* statistics, used for 2-pass encoding */
2448 * number of bits used for the previously encoded frame
2449 * - encoding: Set by libavcodec.
2450 * - decoding: unused
2455 * pass1 encoding statistics output buffer
2456 * - encoding: Set by libavcodec.
2457 * - decoding: unused
2462 * pass2 encoding statistics input buffer
2463 * Concatenated stuff from stats_out of pass1 should be placed here.
2464 * - encoding: Allocated/set/freed by user.
2465 * - decoding: unused
2470 * Work around bugs in encoders which sometimes cannot be detected automatically.
2471 * - encoding: Set by user
2472 * - decoding: Set by user
2474 int workaround_bugs;
2475 #define FF_BUG_AUTODETECT 1 ///< autodetection
2476 #if FF_API_OLD_MSMPEG4
2477 #define FF_BUG_OLD_MSMPEG4 2
2479 #define FF_BUG_XVID_ILACE 4
2480 #define FF_BUG_UMP4 8
2481 #define FF_BUG_NO_PADDING 16
2482 #define FF_BUG_AMV 32
2484 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2486 #define FF_BUG_QPEL_CHROMA 64
2487 #define FF_BUG_STD_QPEL 128
2488 #define FF_BUG_QPEL_CHROMA2 256
2489 #define FF_BUG_DIRECT_BLOCKSIZE 512
2490 #define FF_BUG_EDGE 1024
2491 #define FF_BUG_HPEL_CHROMA 2048
2492 #define FF_BUG_DC_CLIP 4096
2493 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2494 #define FF_BUG_TRUNCATED 16384
2497 * strictly follow the standard (MPEG4, ...).
2498 * - encoding: Set by user.
2499 * - decoding: Set by user.
2500 * Setting this to STRICT or higher means the encoder and decoder will
2501 * generally do stupid things, whereas setting it to unofficial or lower
2502 * will mean the encoder might produce output that is not supported by all
2503 * spec-compliant decoders. Decoders don't differentiate between normal,
2504 * unofficial and experimental (that is, they always try to decode things
2505 * when they can) unless they are explicitly asked to behave stupidly
2506 * (=strictly conform to the specs)
2508 int strict_std_compliance;
2509 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2510 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2511 #define FF_COMPLIANCE_NORMAL 0
2512 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2513 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2516 * error concealment flags
2517 * - encoding: unused
2518 * - decoding: Set by user.
2520 int error_concealment;
2521 #define FF_EC_GUESS_MVS 1
2522 #define FF_EC_DEBLOCK 2
2523 #define FF_EC_FAVOR_INTER 256
2527 * - encoding: Set by user.
2528 * - decoding: Set by user.
2531 #define FF_DEBUG_PICT_INFO 1
2532 #define FF_DEBUG_RC 2
2533 #define FF_DEBUG_BITSTREAM 4
2534 #define FF_DEBUG_MB_TYPE 8
2535 #define FF_DEBUG_QP 16
2538 * @deprecated this option does nothing
2540 #define FF_DEBUG_MV 32
2542 #define FF_DEBUG_DCT_COEFF 0x00000040
2543 #define FF_DEBUG_SKIP 0x00000080
2544 #define FF_DEBUG_STARTCODE 0x00000100
2545 #define FF_DEBUG_PTS 0x00000200
2546 #define FF_DEBUG_ER 0x00000400
2547 #define FF_DEBUG_MMCO 0x00000800
2548 #define FF_DEBUG_BUGS 0x00001000
2550 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2551 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2553 #define FF_DEBUG_BUFFERS 0x00008000
2554 #define FF_DEBUG_THREADS 0x00010000
2555 #define FF_DEBUG_NOMC 0x01000000
2560 * Code outside libavcodec should access this field using AVOptions
2561 * - encoding: Set by user.
2562 * - decoding: Set by user.
2565 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2566 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2567 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2571 * Error recognition; may misdetect some more or less valid parts as errors.
2572 * - encoding: unused
2573 * - decoding: Set by user.
2575 int err_recognition;
2578 * Verify checksums embedded in the bitstream (could be of either encoded or
2579 * decoded data, depending on the codec) and print an error message on mismatch.
2580 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2581 * decoder returning an error.
2583 #define AV_EF_CRCCHECK (1<<0)
2584 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2585 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2586 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2588 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2589 #define AV_EF_CAREFUL (1<<16) ///< consider things that violate the spec, are fast to calculate and have not been seen in the wild as errors
2590 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2591 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2595 * opaque 64bit number (generally a PTS) that will be reordered and
2596 * output in AVFrame.reordered_opaque
2597 * @deprecated in favor of pkt_pts
2598 * - encoding: unused
2599 * - decoding: Set by user.
2601 int64_t reordered_opaque;
2604 * Hardware accelerator in use
2605 * - encoding: unused.
2606 * - decoding: Set by libavcodec
2608 struct AVHWAccel *hwaccel;
2611 * Hardware accelerator context.
2612 * For some hardware accelerators, a global context needs to be
2613 * provided by the user. In that case, this holds display-dependent
2614 * data FFmpeg cannot instantiate itself. Please refer to the
2615 * FFmpeg HW accelerator documentation to know how to fill this
2616 * is. e.g. for VA API, this is a struct vaapi_context.
2617 * - encoding: unused
2618 * - decoding: Set by user
2620 void *hwaccel_context;
2624 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2625 * - decoding: unused
2627 uint64_t error[AV_NUM_DATA_POINTERS];
2630 * DCT algorithm, see FF_DCT_* below
2631 * - encoding: Set by user.
2632 * - decoding: unused
2635 #define FF_DCT_AUTO 0
2636 #define FF_DCT_FASTINT 1
2637 #define FF_DCT_INT 2
2638 #define FF_DCT_MMX 3
2639 #define FF_DCT_ALTIVEC 5
2640 #define FF_DCT_FAAN 6
2643 * IDCT algorithm, see FF_IDCT_* below.
2644 * - encoding: Set by user.
2645 * - decoding: Set by user.
2648 #define FF_IDCT_AUTO 0
2649 #define FF_IDCT_INT 1
2650 #define FF_IDCT_SIMPLE 2
2651 #define FF_IDCT_SIMPLEMMX 3
2652 #define FF_IDCT_ARM 7
2653 #define FF_IDCT_ALTIVEC 8
2655 #define FF_IDCT_SH4 9
2657 #define FF_IDCT_SIMPLEARM 10
2658 #define FF_IDCT_IPP 13
2659 #define FF_IDCT_XVIDMMX 14
2660 #define FF_IDCT_SIMPLEARMV5TE 16
2661 #define FF_IDCT_SIMPLEARMV6 17
2662 #if FF_API_ARCH_SPARC
2663 #define FF_IDCT_SIMPLEVIS 18
2665 #define FF_IDCT_FAAN 20
2666 #define FF_IDCT_SIMPLENEON 22
2667 #if FF_API_ARCH_ALPHA
2668 #define FF_IDCT_SIMPLEALPHA 23
2670 #define FF_IDCT_SIMPLEAUTO 128
2673 * bits per sample/pixel from the demuxer (needed for huffyuv).
2674 * - encoding: Set by libavcodec.
2675 * - decoding: Set by user.
2677 int bits_per_coded_sample;
2680 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2681 * - encoding: set by user.
2682 * - decoding: set by libavcodec.
2684 int bits_per_raw_sample;
2688 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2689 * - encoding: unused
2690 * - decoding: Set by user.
2691 * Code outside libavcodec should access this field using:
2692 * av_codec_{get,set}_lowres(avctx)
2698 * the picture in the bitstream
2699 * - encoding: Set by libavcodec.
2700 * - decoding: unused
2702 AVFrame *coded_frame;
2706 * is used to decide how many independent tasks should be passed to execute()
2707 * - encoding: Set by user.
2708 * - decoding: Set by user.
2713 * Which multithreading methods to use.
2714 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2715 * so clients which cannot provide future frames should not use it.
2717 * - encoding: Set by user, otherwise the default is used.
2718 * - decoding: Set by user, otherwise the default is used.
2721 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2722 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2725 * Which multithreading methods are in use by the codec.
2726 * - encoding: Set by libavcodec.
2727 * - decoding: Set by libavcodec.
2729 int active_thread_type;
2732 * Set by the client if its custom get_buffer() callback can be called
2733 * synchronously from another thread, which allows faster multithreaded decoding.
2734 * draw_horiz_band() will be called from other threads regardless of this setting.
2735 * Ignored if the default get_buffer() is used.
2736 * - encoding: Set by user.
2737 * - decoding: Set by user.
2739 int thread_safe_callbacks;
2742 * The codec may call this to execute several independent things.
2743 * It will return only after finishing all tasks.
2744 * The user may replace this with some multithreaded implementation,
2745 * the default implementation will execute the parts serially.
2746 * @param count the number of things to execute
2747 * - encoding: Set by libavcodec, user can override.
2748 * - decoding: Set by libavcodec, user can override.
2750 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2753 * The codec may call this to execute several independent things.
2754 * It will return only after finishing all tasks.
2755 * The user may replace this with some multithreaded implementation,
2756 * the default implementation will execute the parts serially.
2757 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2758 * @param c context passed also to func
2759 * @param count the number of things to execute
2760 * @param arg2 argument passed unchanged to func
2761 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2762 * @param func function that will be called count times, with jobnr from 0 to count-1.
2763 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2764 * two instances of func executing at the same time will have the same threadnr.
2765 * @return always 0 currently, but code should handle a future improvement where when any call to func
2766 * returns < 0 no further calls to func may be done and < 0 is returned.
2767 * - encoding: Set by libavcodec, user can override.
2768 * - decoding: Set by libavcodec, user can override.
2770 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2772 #if FF_API_THREAD_OPAQUE
2774 * @deprecated this field should not be used from outside of lavc
2776 attribute_deprecated
2777 void *thread_opaque;
2781 * noise vs. sse weight for the nsse comparison function
2782 * - encoding: Set by user.
2783 * - decoding: unused
2789 * - encoding: Set by user.
2790 * - decoding: Set by libavcodec.
2793 #define FF_PROFILE_UNKNOWN -99
2794 #define FF_PROFILE_RESERVED -100
2796 #define FF_PROFILE_AAC_MAIN 0
2797 #define FF_PROFILE_AAC_LOW 1
2798 #define FF_PROFILE_AAC_SSR 2
2799 #define FF_PROFILE_AAC_LTP 3
2800 #define FF_PROFILE_AAC_HE 4
2801 #define FF_PROFILE_AAC_HE_V2 28
2802 #define FF_PROFILE_AAC_LD 22
2803 #define FF_PROFILE_AAC_ELD 38
2804 #define FF_PROFILE_MPEG2_AAC_LOW 128
2805 #define FF_PROFILE_MPEG2_AAC_HE 131
2807 #define FF_PROFILE_DTS 20
2808 #define FF_PROFILE_DTS_ES 30
2809 #define FF_PROFILE_DTS_96_24 40
2810 #define FF_PROFILE_DTS_HD_HRA 50
2811 #define FF_PROFILE_DTS_HD_MA 60
2813 #define FF_PROFILE_MPEG2_422 0
2814 #define FF_PROFILE_MPEG2_HIGH 1
2815 #define FF_PROFILE_MPEG2_SS 2
2816 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2817 #define FF_PROFILE_MPEG2_MAIN 4
2818 #define FF_PROFILE_MPEG2_SIMPLE 5
2820 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2821 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2823 #define FF_PROFILE_H264_BASELINE 66
2824 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2825 #define FF_PROFILE_H264_MAIN 77
2826 #define FF_PROFILE_H264_EXTENDED 88
2827 #define FF_PROFILE_H264_HIGH 100
2828 #define FF_PROFILE_H264_HIGH_10 110
2829 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2830 #define FF_PROFILE_H264_HIGH_422 122
2831 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2832 #define FF_PROFILE_H264_HIGH_444 144
2833 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2834 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2835 #define FF_PROFILE_H264_CAVLC_444 44
2837 #define FF_PROFILE_VC1_SIMPLE 0
2838 #define FF_PROFILE_VC1_MAIN 1
2839 #define FF_PROFILE_VC1_COMPLEX 2
2840 #define FF_PROFILE_VC1_ADVANCED 3
2842 #define FF_PROFILE_MPEG4_SIMPLE 0
2843 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2844 #define FF_PROFILE_MPEG4_CORE 2
2845 #define FF_PROFILE_MPEG4_MAIN 3
2846 #define FF_PROFILE_MPEG4_N_BIT 4
2847 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2848 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2849 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2850 #define FF_PROFILE_MPEG4_HYBRID 8
2851 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2852 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2853 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2854 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2855 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2856 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2857 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2859 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2860 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2861 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2862 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2863 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2866 #define FF_PROFILE_HEVC_MAIN 1
2867 #define FF_PROFILE_HEVC_MAIN_10 2
2868 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2872 * - encoding: Set by user.
2873 * - decoding: Set by libavcodec.
2876 #define FF_LEVEL_UNKNOWN -99
2879 * Skip loop filtering for selected frames.
2880 * - encoding: unused
2881 * - decoding: Set by user.
2883 enum AVDiscard skip_loop_filter;
2886 * Skip IDCT/dequantization for selected frames.
2887 * - encoding: unused
2888 * - decoding: Set by user.
2890 enum AVDiscard skip_idct;
2893 * Skip decoding for selected frames.
2894 * - encoding: unused
2895 * - decoding: Set by user.
2897 enum AVDiscard skip_frame;
2900 * Header containing style information for text subtitles.
2901 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2902 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2903 * the Format line following. It shouldn't include any Dialogue line.
2904 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2905 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2907 uint8_t *subtitle_header;
2908 int subtitle_header_size;
2910 #if FF_API_ERROR_RATE
2912 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2915 attribute_deprecated
2919 #if FF_API_CODEC_PKT
2921 * @deprecated this field is not supposed to be accessed from outside lavc
2923 attribute_deprecated
2928 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2929 * Used for compliant TS muxing.
2930 * - encoding: Set by libavcodec.
2931 * - decoding: unused.
2936 * Encoding only. Allow encoders to output packets that do not contain any
2937 * encoded data, only side data.
2939 * Some encoders need to output such packets, e.g. to update some stream
2940 * parameters at the end of encoding.
2942 * All callers are strongly recommended to set this option to 1 and update
2943 * their code to deal with such packets, since this behaviour may become
2944 * always enabled in the future (then this option will be deprecated and
2945 * later removed). To avoid ABI issues when this happens, the callers should
2946 * use AVOptions to set this field.
2948 int side_data_only_packets;
2951 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2952 * Code outside libavcodec should access this field using:
2953 * av_codec_{get,set}_pkt_timebase(avctx)
2954 * - encoding unused.
2955 * - decoding set by user.
2957 AVRational pkt_timebase;
2961 * Code outside libavcodec should access this field using:
2962 * av_codec_{get,set}_codec_descriptor(avctx)
2963 * - encoding: unused.
2964 * - decoding: set by libavcodec.
2966 const AVCodecDescriptor *codec_descriptor;
2970 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2971 * - encoding: unused
2972 * - decoding: Set by user.
2973 * Code outside libavcodec should access this field using:
2974 * av_codec_{get,set}_lowres(avctx)
2980 * Current statistics for PTS correction.
2981 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2982 * - encoding: unused
2984 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2985 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2986 int64_t pts_correction_last_pts; /// PTS of the last frame
2987 int64_t pts_correction_last_dts; /// DTS of the last frame
2990 * Character encoding of the input subtitles file.
2991 * - decoding: set by user
2992 * - encoding: unused
2997 * Subtitles character encoding mode. Formats or codecs might be adjusting
2998 * this setting (if they are doing the conversion themselves for instance).
2999 * - decoding: set by libavcodec
3000 * - encoding: unused
3002 int sub_charenc_mode;
3003 #define FF_SUB_CHARENC_MODE_DO_NOTHING -1 ///< do nothing (demuxer outputs a stream supposed to be already in UTF-8, or the codec is bitmap for instance)
3004 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3005 #define FF_SUB_CHARENC_MODE_PRE_DECODER 1 ///< the AVPacket data needs to be recoded to UTF-8 before being fed to the decoder, requires iconv
3008 * Skip processing alpha if supported by codec.
3009 * Note that if the format uses pre-multiplied alpha (common with VP6,
3010 * and recommended due to better video quality/compression)
3011 * the image will look as if alpha-blended onto a black background.
3012 * However for formats that do not use pre-multiplied alpha
3013 * there might be serious artefacts (though e.g. libswscale currently
3014 * assumes pre-multiplied alpha anyway).
3015 * Code outside libavcodec should access this field using AVOptions
3017 * - decoding: set by user
3018 * - encoding: unused
3023 * Number of samples to skip after a discontinuity
3024 * - decoding: unused
3025 * - encoding: set by libavcodec
3029 #if !FF_API_DEBUG_MV
3031 * debug motion vectors
3032 * Code outside libavcodec should access this field using AVOptions
3033 * - encoding: Set by user.
3034 * - decoding: Set by user.
3037 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3038 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3039 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3043 * custom intra quantization matrix
3044 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3045 * - encoding: Set by user, can be NULL.
3046 * - decoding: unused.
3048 uint16_t *chroma_intra_matrix;
3051 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3052 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3054 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3055 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3057 int av_codec_get_lowres(const AVCodecContext *avctx);
3058 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3060 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3061 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3063 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3064 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3069 typedef struct AVProfile {
3071 const char *name; ///< short name for the profile
3074 typedef struct AVCodecDefault AVCodecDefault;
3081 typedef struct AVCodec {
3083 * Name of the codec implementation.
3084 * The name is globally unique among encoders and among decoders (but an
3085 * encoder and a decoder can share the same name).
3086 * This is the primary way to find a codec from the user perspective.
3090 * Descriptive name for the codec, meant to be more human readable than name.
3091 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3093 const char *long_name;
3094 enum AVMediaType type;
3097 * Codec capabilities.
3101 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3102 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3103 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3104 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3105 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3107 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3109 const AVClass *priv_class; ///< AVClass for the private context
3110 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3112 /*****************************************************************
3113 * No fields below this line are part of the public API. They
3114 * may not be used outside of libavcodec and can be changed and
3116 * New public fields should be added right above.
3117 *****************************************************************
3120 struct AVCodec *next;
3122 * @name Frame-level threading support functions
3126 * If defined, called on thread contexts when they are created.
3127 * If the codec allocates writable tables in init(), re-allocate them here.
3128 * priv_data will be set to a copy of the original.
3130 int (*init_thread_copy)(AVCodecContext *);
3132 * Copy necessary context variables from a previous thread context to the current one.
3133 * If not defined, the next thread will start automatically; otherwise, the codec
3134 * must call ff_thread_finish_setup().
3136 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3138 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3142 * Private codec-specific defaults.
3144 const AVCodecDefault *defaults;
3147 * Initialize codec static data, called from avcodec_register().
3149 void (*init_static_data)(struct AVCodec *codec);
3151 int (*init)(AVCodecContext *);
3152 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3153 const struct AVSubtitle *sub);
3155 * Encode data to an AVPacket.
3157 * @param avctx codec context
3158 * @param avpkt output AVPacket (may contain a user-provided buffer)
3159 * @param[in] frame AVFrame containing the raw data to be encoded
3160 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3161 * non-empty packet was returned in avpkt.
3162 * @return 0 on success, negative error code on failure
3164 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3165 int *got_packet_ptr);
3166 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3167 int (*close)(AVCodecContext *);
3170 * Will be called when seeking
3172 void (*flush)(AVCodecContext *);
3175 int av_codec_get_max_lowres(const AVCodec *codec);
3177 struct MpegEncContext;
3182 typedef struct AVHWAccel {
3184 * Name of the hardware accelerated codec.
3185 * The name is globally unique among encoders and among decoders (but an
3186 * encoder and a decoder can share the same name).
3191 * Type of codec implemented by the hardware accelerator.
3193 * See AVMEDIA_TYPE_xxx
3195 enum AVMediaType type;
3198 * Codec implemented by the hardware accelerator.
3200 * See AV_CODEC_ID_xxx
3205 * Supported pixel format.
3207 * Only hardware accelerated formats are supported here.
3209 enum AVPixelFormat pix_fmt;
3212 * Hardware accelerated codec capabilities.
3213 * see FF_HWACCEL_CODEC_CAP_*
3217 /*****************************************************************
3218 * No fields below this line are part of the public API. They
3219 * may not be used outside of libavcodec and can be changed and
3221 * New public fields should be added right above.
3222 *****************************************************************
3224 struct AVHWAccel *next;
3227 * Allocate a custom buffer
3229 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3232 * Called at the beginning of each frame or field picture.
3234 * Meaningful frame information (codec specific) is guaranteed to
3235 * be parsed at this point. This function is mandatory.
3237 * Note that buf can be NULL along with buf_size set to 0.
3238 * Otherwise, this means the whole frame is available at this point.
3240 * @param avctx the codec context
3241 * @param buf the frame data buffer base
3242 * @param buf_size the size of the frame in bytes
3243 * @return zero if successful, a negative value otherwise
3245 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3248 * Callback for each slice.
3250 * Meaningful slice information (codec specific) is guaranteed to
3251 * be parsed at this point. This function is mandatory.
3252 * The only exception is XvMC, that works on MB level.
3254 * @param avctx the codec context
3255 * @param buf the slice data buffer base
3256 * @param buf_size the size of the slice in bytes
3257 * @return zero if successful, a negative value otherwise
3259 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3262 * Called at the end of each frame or field picture.
3264 * The whole picture is parsed at this point and can now be sent
3265 * to the hardware accelerator. This function is mandatory.
3267 * @param avctx the codec context
3268 * @return zero if successful, a negative value otherwise
3270 int (*end_frame)(AVCodecContext *avctx);
3273 * Size of per-frame hardware accelerator private data.
3275 * Private data is allocated with av_mallocz() before
3276 * AVCodecContext.get_buffer() and deallocated after
3277 * AVCodecContext.release_buffer().
3279 int frame_priv_data_size;
3282 * Called for every Macroblock in a slice.
3284 * XvMC uses it to replace the ff_MPV_decode_mb().
3285 * Instead of decoding to raw picture, MB parameters are
3286 * stored in an array provided by the video driver.
3288 * @param s the mpeg context
3290 void (*decode_mb)(struct MpegEncContext *s);
3293 * Initialize the hwaccel private data.
3295 * This will be called from ff_get_format(), after hwaccel and
3296 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3299 int (*init)(AVCodecContext *avctx);
3302 * Uninitialize the hwaccel private data.
3304 * This will be called from get_format() or avcodec_close(), after hwaccel
3305 * and hwaccel_context are already uninitialized.
3307 int (*uninit)(AVCodecContext *avctx);
3310 * Size of the private data to allocate in
3311 * AVCodecInternal.hwaccel_priv_data.
3317 * @defgroup lavc_picture AVPicture
3319 * Functions for working with AVPicture
3324 * Picture data structure.
3326 * Up to four components can be stored into it, the last component is
3329 typedef struct AVPicture {
3330 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3331 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3338 enum AVSubtitleType {
3341 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3344 * Plain text, the text field must be set by the decoder and is
3345 * authoritative. ass and pict fields may contain approximations.
3350 * Formatted text, the ass field must be set by the decoder and is
3351 * authoritative. pict and text fields may contain approximations.
3356 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3358 typedef struct AVSubtitleRect {
3359 int x; ///< top left corner of pict, undefined when pict is not set
3360 int y; ///< top left corner of pict, undefined when pict is not set
3361 int w; ///< width of pict, undefined when pict is not set
3362 int h; ///< height of pict, undefined when pict is not set
3363 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3366 * data+linesize for the bitmap of this subtitle.
3367 * can be set for text/ass as well once they where rendered
3370 enum AVSubtitleType type;
3372 char *text; ///< 0 terminated plain UTF-8 text
3375 * 0 terminated ASS/SSA compatible event line.
3376 * The presentation of this is unaffected by the other values in this
3384 typedef struct AVSubtitle {
3385 uint16_t format; /* 0 = graphics */
3386 uint32_t start_display_time; /* relative to packet pts, in ms */
3387 uint32_t end_display_time; /* relative to packet pts, in ms */
3389 AVSubtitleRect **rects;
3390 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3394 * If c is NULL, returns the first registered codec,
3395 * if c is non-NULL, returns the next registered codec after c,
3396 * or NULL if c is the last one.
3398 AVCodec *av_codec_next(const AVCodec *c);
3401 * Return the LIBAVCODEC_VERSION_INT constant.
3403 unsigned avcodec_version(void);
3406 * Return the libavcodec build-time configuration.
3408 const char *avcodec_configuration(void);
3411 * Return the libavcodec license.
3413 const char *avcodec_license(void);
3416 * Register the codec codec and initialize libavcodec.
3418 * @warning either this function or avcodec_register_all() must be called
3419 * before any other libavcodec functions.
3421 * @see avcodec_register_all()
3423 void avcodec_register(AVCodec *codec);
3426 * Register all the codecs, parsers and bitstream filters which were enabled at
3427 * configuration time. If you do not call this function you can select exactly
3428 * which formats you want to support, by using the individual registration
3431 * @see avcodec_register
3432 * @see av_register_codec_parser
3433 * @see av_register_bitstream_filter
3435 void avcodec_register_all(void);
3438 * Allocate an AVCodecContext and set its fields to default values. The
3439 * resulting struct should be freed with avcodec_free_context().
3441 * @param codec if non-NULL, allocate private data and initialize defaults
3442 * for the given codec. It is illegal to then call avcodec_open2()
3443 * with a different codec.
3444 * If NULL, then the codec-specific defaults won't be initialized,
3445 * which may result in suboptimal default settings (this is
3446 * important mainly for encoders, e.g. libx264).
3448 * @return An AVCodecContext filled with default values or NULL on failure.
3449 * @see avcodec_get_context_defaults
3451 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3454 * Free the codec context and everything associated with it and write NULL to
3455 * the provided pointer.
3457 void avcodec_free_context(AVCodecContext **avctx);
3460 * Set the fields of the given AVCodecContext to default values corresponding
3461 * to the given codec (defaults may be codec-dependent).
3463 * Do not call this function if a non-NULL codec has been passed
3464 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3465 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3466 * different codec on this AVCodecContext.
3468 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3471 * Get the AVClass for AVCodecContext. It can be used in combination with
3472 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3474 * @see av_opt_find().
3476 const AVClass *avcodec_get_class(void);
3479 * Get the AVClass for AVFrame. It can be used in combination with
3480 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3482 * @see av_opt_find().
3484 const AVClass *avcodec_get_frame_class(void);
3487 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3488 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3490 * @see av_opt_find().
3492 const AVClass *avcodec_get_subtitle_rect_class(void);
3495 * Copy the settings of the source AVCodecContext into the destination
3496 * AVCodecContext. The resulting destination codec context will be
3497 * unopened, i.e. you are required to call avcodec_open2() before you
3498 * can use this AVCodecContext to decode/encode video/audio data.
3500 * @param dest target codec context, should be initialized with
3501 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3502 * @param src source codec context
3503 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3505 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3507 #if FF_API_AVFRAME_LAVC
3509 * @deprecated use av_frame_alloc()
3511 attribute_deprecated
3512 AVFrame *avcodec_alloc_frame(void);
3515 * Set the fields of the given AVFrame to default values.
3517 * @param frame The AVFrame of which the fields should be set to default values.
3519 * @deprecated use av_frame_unref()
3521 attribute_deprecated
3522 void avcodec_get_frame_defaults(AVFrame *frame);
3525 * Free the frame and any dynamically allocated objects in it,
3526 * e.g. extended_data.
3528 * @param frame frame to be freed. The pointer will be set to NULL.
3530 * @warning this function does NOT free the data buffers themselves
3531 * (it does not know how, since they might have been allocated with
3532 * a custom get_buffer()).
3534 * @deprecated use av_frame_free()
3536 attribute_deprecated
3537 void avcodec_free_frame(AVFrame **frame);
3541 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3542 * function the context has to be allocated with avcodec_alloc_context3().
3544 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3545 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3546 * retrieving a codec.
3548 * @warning This function is not thread safe!
3551 * avcodec_register_all();
3552 * av_dict_set(&opts, "b", "2.5M", 0);
3553 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3557 * context = avcodec_alloc_context3(codec);
3559 * if (avcodec_open2(context, codec, opts) < 0)
3563 * @param avctx The context to initialize.
3564 * @param codec The codec to open this context for. If a non-NULL codec has been
3565 * previously passed to avcodec_alloc_context3() or
3566 * avcodec_get_context_defaults3() for this context, then this
3567 * parameter MUST be either NULL or equal to the previously passed
3569 * @param options A dictionary filled with AVCodecContext and codec-private options.
3570 * On return this object will be filled with options that were not found.
3572 * @return zero on success, a negative value on error
3573 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3574 * av_dict_set(), av_opt_find().
3576 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3579 * Close a given AVCodecContext and free all the data associated with it
3580 * (but not the AVCodecContext itself).
3582 * Calling this function on an AVCodecContext that hasn't been opened will free
3583 * the codec-specific data allocated in avcodec_alloc_context3() /
3584 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3587 int avcodec_close(AVCodecContext *avctx);
3590 * Free all allocated data in the given subtitle struct.
3592 * @param sub AVSubtitle to free.
3594 void avsubtitle_free(AVSubtitle *sub);
3601 * @addtogroup lavc_packet
3605 #if FF_API_DESTRUCT_PACKET
3607 * Default packet destructor.
3608 * @deprecated use the AVBuffer API instead
3610 attribute_deprecated
3611 void av_destruct_packet(AVPacket *pkt);
3615 * Initialize optional fields of a packet with default values.
3617 * Note, this does not touch the data and size members, which have to be
3618 * initialized separately.
3622 void av_init_packet(AVPacket *pkt);
3625 * Allocate the payload of a packet and initialize its fields with
3629 * @param size wanted payload size
3630 * @return 0 if OK, AVERROR_xxx otherwise
3632 int av_new_packet(AVPacket *pkt, int size);
3635 * Reduce packet size, correctly zeroing padding
3638 * @param size new size
3640 void av_shrink_packet(AVPacket *pkt, int size);
3643 * Increase packet size, correctly zeroing padding
3646 * @param grow_by number of bytes by which to increase the size of the packet
3648 int av_grow_packet(AVPacket *pkt, int grow_by);
3651 * Initialize a reference-counted packet from av_malloc()ed data.
3653 * @param pkt packet to be initialized. This function will set the data, size,
3654 * buf and destruct fields, all others are left untouched.
3655 * @param data Data allocated by av_malloc() to be used as packet data. If this
3656 * function returns successfully, the data is owned by the underlying AVBuffer.
3657 * The caller may not access the data through other means.
3658 * @param size size of data in bytes, without the padding. I.e. the full buffer
3659 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3661 * @return 0 on success, a negative AVERROR on error
3663 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3666 * @warning This is a hack - the packet memory allocation stuff is broken. The
3667 * packet is allocated if it was not really allocated.
3669 int av_dup_packet(AVPacket *pkt);
3672 * Copy packet, including contents
3674 * @return 0 on success, negative AVERROR on fail
3676 int av_copy_packet(AVPacket *dst, const AVPacket *src);
3679 * Copy packet side data
3681 * @return 0 on success, negative AVERROR on fail
3683 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
3688 * @param pkt packet to free
3690 void av_free_packet(AVPacket *pkt);
3693 * Allocate new information of a packet.
3696 * @param type side information type
3697 * @param size side information size
3698 * @return pointer to fresh allocated data or NULL otherwise
3700 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3704 * Shrink the already allocated side data buffer
3707 * @param type side information type
3708 * @param size new side information size
3709 * @return 0 on success, < 0 on failure
3711 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3715 * Get side information from packet.
3718 * @param type desired side information type
3719 * @param size pointer for side information size to store (optional)
3720 * @return pointer to data if present or NULL otherwise
3722 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3725 int av_packet_merge_side_data(AVPacket *pkt);
3727 int av_packet_split_side_data(AVPacket *pkt);
3730 * Pack a dictionary for use in side_data.
3732 * @param dict The dictionary to pack.
3733 * @param size pointer to store the size of the returned data
3734 * @return pointer to data if successful, NULL otherwise
3736 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
3738 * Unpack a dictionary from side_data.
3740 * @param data data from side_data
3741 * @param size size of the data
3742 * @param dict the metadata storage dictionary
3743 * @return 0 on success, < 0 on failure
3745 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
3749 * Convenience function to free all the side data stored.
3750 * All the other fields stay untouched.
3754 void av_packet_free_side_data(AVPacket *pkt);
3757 * Setup a new reference to the data described by a given packet
3759 * If src is reference-counted, setup dst as a new reference to the
3760 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3761 * data from src into it.
3763 * All the other fields are copied from src.
3765 * @see av_packet_unref
3767 * @param dst Destination packet
3768 * @param src Source packet
3770 * @return 0 on success, a negative AVERROR on error.
3772 int av_packet_ref(AVPacket *dst, const AVPacket *src);
3777 * Unreference the buffer referenced by the packet and reset the
3778 * remaining packet fields to their default values.
3780 * @param pkt The packet to be unreferenced.
3782 void av_packet_unref(AVPacket *pkt);
3785 * Move every field in src to dst and reset src.
3787 * @see av_packet_unref
3789 * @param src Source packet, will be reset
3790 * @param dst Destination packet
3792 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3795 * Copy only "properties" fields from src to dst.
3797 * Properties for the purpose of this function are all the fields
3798 * beside those related to the packet data (buf, data, size)
3800 * @param dst Destination packet
3801 * @param src Source packet
3803 * @return 0 on success AVERROR on failure.
3806 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3813 * @addtogroup lavc_decoding
3818 * Find a registered decoder with a matching codec ID.