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_BRENDER_PIX= MKBETAG('B','P','I','X'),
290 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
291 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
292 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
293 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
295 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
296 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
297 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
298 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
299 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
300 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
301 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
302 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
303 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
304 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
305 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
306 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
307 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
308 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
309 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
310 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
311 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
312 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
313 AV_CODEC_ID_SMVJPEG = MKBETAG('S','M','V','J'),
314 AV_CODEC_ID_HEVC = MKBETAG('H','2','6','5'),
315 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
317 /* various PCM "codecs" */
318 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
319 AV_CODEC_ID_PCM_S16LE = 0x10000,
320 AV_CODEC_ID_PCM_S16BE,
321 AV_CODEC_ID_PCM_U16LE,
322 AV_CODEC_ID_PCM_U16BE,
325 AV_CODEC_ID_PCM_MULAW,
326 AV_CODEC_ID_PCM_ALAW,
327 AV_CODEC_ID_PCM_S32LE,
328 AV_CODEC_ID_PCM_S32BE,
329 AV_CODEC_ID_PCM_U32LE,
330 AV_CODEC_ID_PCM_U32BE,
331 AV_CODEC_ID_PCM_S24LE,
332 AV_CODEC_ID_PCM_S24BE,
333 AV_CODEC_ID_PCM_U24LE,
334 AV_CODEC_ID_PCM_U24BE,
335 AV_CODEC_ID_PCM_S24DAUD,
336 AV_CODEC_ID_PCM_ZORK,
337 AV_CODEC_ID_PCM_S16LE_PLANAR,
339 AV_CODEC_ID_PCM_F32BE,
340 AV_CODEC_ID_PCM_F32LE,
341 AV_CODEC_ID_PCM_F64BE,
342 AV_CODEC_ID_PCM_F64LE,
343 AV_CODEC_ID_PCM_BLURAY,
346 AV_CODEC_ID_PCM_S8_PLANAR,
347 AV_CODEC_ID_PCM_S24LE_PLANAR_DEPRECATED,
348 AV_CODEC_ID_PCM_S32LE_PLANAR_DEPRECATED,
349 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
350 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
351 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
353 /* various ADPCM codecs */
354 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
355 AV_CODEC_ID_ADPCM_IMA_WAV,
356 AV_CODEC_ID_ADPCM_IMA_DK3,
357 AV_CODEC_ID_ADPCM_IMA_DK4,
358 AV_CODEC_ID_ADPCM_IMA_WS,
359 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
360 AV_CODEC_ID_ADPCM_MS,
361 AV_CODEC_ID_ADPCM_4XM,
362 AV_CODEC_ID_ADPCM_XA,
363 AV_CODEC_ID_ADPCM_ADX,
364 AV_CODEC_ID_ADPCM_EA,
365 AV_CODEC_ID_ADPCM_G726,
366 AV_CODEC_ID_ADPCM_CT,
367 AV_CODEC_ID_ADPCM_SWF,
368 AV_CODEC_ID_ADPCM_YAMAHA,
369 AV_CODEC_ID_ADPCM_SBPRO_4,
370 AV_CODEC_ID_ADPCM_SBPRO_3,
371 AV_CODEC_ID_ADPCM_SBPRO_2,
372 AV_CODEC_ID_ADPCM_THP,
373 AV_CODEC_ID_ADPCM_IMA_AMV,
374 AV_CODEC_ID_ADPCM_EA_R1,
375 AV_CODEC_ID_ADPCM_EA_R3,
376 AV_CODEC_ID_ADPCM_EA_R2,
377 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
378 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
379 AV_CODEC_ID_ADPCM_EA_XAS,
380 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
381 AV_CODEC_ID_ADPCM_IMA_ISS,
382 AV_CODEC_ID_ADPCM_G722,
383 AV_CODEC_ID_ADPCM_IMA_APC,
384 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
385 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
386 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
387 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
388 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
389 AV_CODEC_ID_ADPCM_G726LE = MKBETAG('6','2','7','G'),
392 AV_CODEC_ID_AMR_NB = 0x12000,
395 /* RealAudio codecs*/
396 AV_CODEC_ID_RA_144 = 0x13000,
399 /* various DPCM codecs */
400 AV_CODEC_ID_ROQ_DPCM = 0x14000,
401 AV_CODEC_ID_INTERPLAY_DPCM,
402 AV_CODEC_ID_XAN_DPCM,
403 AV_CODEC_ID_SOL_DPCM,
406 AV_CODEC_ID_MP2 = 0x15000,
407 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
417 AV_CODEC_ID_VMDAUDIO,
423 AV_CODEC_ID_WESTWOOD_SND1,
424 AV_CODEC_ID_GSM, ///< as in Berlin toast format
427 AV_CODEC_ID_TRUESPEECH,
429 AV_CODEC_ID_SMACKAUDIO,
432 AV_CODEC_ID_DSICINAUDIO,
434 AV_CODEC_ID_MUSEPACK7,
436 AV_CODEC_ID_GSM_MS, /* as found in WAV */
442 AV_CODEC_ID_NELLYMOSER,
443 AV_CODEC_ID_MUSEPACK8,
445 AV_CODEC_ID_WMAVOICE,
447 AV_CODEC_ID_WMALOSSLESS,
456 AV_CODEC_ID_BINKAUDIO_RDFT,
457 AV_CODEC_ID_BINKAUDIO_DCT,
458 AV_CODEC_ID_AAC_LATM,
463 AV_CODEC_ID_8SVX_EXP,
464 AV_CODEC_ID_8SVX_FIB,
465 AV_CODEC_ID_BMV_AUDIO,
469 AV_CODEC_ID_OPUS_DEPRECATED,
470 AV_CODEC_ID_COMFORT_NOISE,
471 AV_CODEC_ID_TAK_DEPRECATED,
472 AV_CODEC_ID_METASOUND,
473 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
474 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
475 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
476 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
477 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
478 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
479 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
480 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
482 /* subtitle codecs */
483 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
484 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
485 AV_CODEC_ID_DVB_SUBTITLE,
486 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
489 AV_CODEC_ID_MOV_TEXT,
490 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
491 AV_CODEC_ID_DVB_TELETEXT,
493 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
494 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
495 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
496 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
497 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
498 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
499 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
500 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
501 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
502 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
503 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
504 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
505 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
507 /* other specific kind of codecs (generally used for attachments) */
508 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
509 AV_CODEC_ID_TTF = 0x18000,
510 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
511 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
512 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
513 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
514 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
515 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
516 AV_CODEC_ID_TIMED_ID3 = MKBETAG('T','I','D','3'),
519 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
521 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
522 * stream (only used by libavformat) */
523 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
524 * stream (only used by libavformat) */
525 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
528 #include "old_codec_ids.h"
533 * This struct describes the properties of a single codec described by an
535 * @see avcodec_get_descriptor()
537 typedef struct AVCodecDescriptor {
539 enum AVMediaType type;
541 * Name of the codec described by this descriptor. It is non-empty and
542 * unique for each codec descriptor. It should contain alphanumeric
543 * characters and '_' only.
547 * A more descriptive name for this codec. May be NULL.
549 const char *long_name;
551 * Codec properties, a combination of AV_CODEC_PROP_* flags.
557 * Codec uses only intra compression.
560 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
562 * Codec supports lossy compression. Audio and video codecs only.
563 * @note a codec may support both lossy and lossless
566 #define AV_CODEC_PROP_LOSSY (1 << 1)
568 * Codec supports lossless compression. Audio and video codecs only.
570 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
572 * Subtitle codec is bitmap based
573 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
575 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
577 * Subtitle codec is text based.
578 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
580 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
583 * @ingroup lavc_decoding
584 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
585 * This is mainly needed because some optimized bitstream readers read
586 * 32 or 64 bit at once and could read over the end.<br>
587 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
588 * MPEG bitstreams could cause overread and segfault.
590 #define FF_INPUT_BUFFER_PADDING_SIZE 16
593 * @ingroup lavc_encoding
594 * minimum encoding buffer size
595 * Used to avoid some checks during header writing.
597 #define FF_MIN_BUFFER_SIZE 16384
601 * @ingroup lavc_encoding
602 * motion estimation type.
605 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
609 ME_EPZS, ///< enhanced predictive zonal search
610 ME_X1, ///< reserved for experiments
611 ME_HEX, ///< hexagon based search
612 ME_UMH, ///< uneven multi-hexagon search
613 ME_TESA, ///< transformed exhaustive search algorithm
614 ME_ITER=50, ///< iterative search
618 * @ingroup lavc_decoding
621 /* We leave some space between them for extensions (drop some
622 * keyframes for intra-only or drop just some bidir frames). */
623 AVDISCARD_NONE =-16, ///< discard nothing
624 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
625 AVDISCARD_NONREF = 8, ///< discard all non reference
626 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
627 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
628 AVDISCARD_ALL = 48, ///< discard all
631 enum AVColorPrimaries{
632 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
633 AVCOL_PRI_UNSPECIFIED = 2,
634 AVCOL_PRI_BT470M = 4,
635 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
636 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
637 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
639 AVCOL_PRI_BT2020 = 9, ///< ITU-R BT2020
640 AVCOL_PRI_NB , ///< Not part of ABI
643 enum AVColorTransferCharacteristic{
644 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
645 AVCOL_TRC_UNSPECIFIED = 2,
646 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
647 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
648 AVCOL_TRC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 or 625 / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC
649 AVCOL_TRC_SMPTE240M = 7,
650 AVCOL_TRC_LINEAR = 8, ///< "Linear transfer characteristics"
651 AVCOL_TRC_LOG = 9, ///< "Logarithmic transfer characteristic (100:1 range)"
652 AVCOL_TRC_LOG_SQRT = 10, ///< "Logarithmic transfer characteristic (100 * Sqrt( 10 ) : 1 range)"
653 AVCOL_TRC_IEC61966_2_4 = 11, ///< IEC 61966-2-4
654 AVCOL_TRC_BT1361_ECG = 12, ///< ITU-R BT1361 Extended Colour Gamut
655 AVCOL_TRC_IEC61966_2_1 = 13, ///< IEC 61966-2-1 (sRGB or sYCC)
656 AVCOL_TRC_BT2020_10 = 14, ///< ITU-R BT2020 for 10 bit system
657 AVCOL_TRC_BT2020_12 = 15, ///< ITU-R BT2020 for 12 bit system
658 AVCOL_TRC_NB , ///< Not part of ABI
662 * X X 3 4 X X are luma samples,
663 * 1 2 1-6 are possible chroma positions
664 * X X 5 6 X 0 is undefined/unknown position
666 enum AVChromaLocation{
667 AVCHROMA_LOC_UNSPECIFIED = 0,
668 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
669 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
670 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
671 AVCHROMA_LOC_TOP = 4,
672 AVCHROMA_LOC_BOTTOMLEFT = 5,
673 AVCHROMA_LOC_BOTTOM = 6,
674 AVCHROMA_LOC_NB , ///< Not part of ABI
677 enum AVAudioServiceType {
678 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
679 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
680 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
681 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
682 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
683 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
684 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
685 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
686 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
687 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
691 * @ingroup lavc_encoding
693 typedef struct RcOverride{
696 int qscale; // If this is 0 then quality_factor will be used instead.
697 float quality_factor;
700 #if FF_API_MAX_BFRAMES
702 * @deprecated there is no libavcodec-wide limit on the number of B-frames
704 #define FF_MAX_B_FRAMES 16
708 These flags can be passed in AVCodecContext.flags before initialization.
709 Note: Not everything is supported yet.
713 * Allow decoders to produce frames with data planes that are not aligned
714 * to CPU requirements (e.g. due to cropping).
716 #define CODEC_FLAG_UNALIGNED 0x0001
717 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
718 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
719 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
720 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
721 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
722 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
724 * The parent program guarantees that the input for B-frames containing
725 * streams is not written to for at least s->max_b_frames+1 frames, if
726 * this is not set the input will be copied.
728 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
729 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
730 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
731 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
732 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
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 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
737 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
738 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
739 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
740 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
741 /* Fx : Flag for h263+ extra options */
742 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
743 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
744 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
745 #define CODEC_FLAG_CLOSED_GOP 0x80000000
746 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
747 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
748 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
749 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
750 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
752 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
753 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
755 /* Unsupported options :
756 * Syntax Arithmetic coding (SAC)
757 * Reference Picture Selection
758 * Independent Segment Decoding */
760 /* codec capabilities */
762 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
764 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
765 * If not set, it might not use get_buffer() at all or use operations that
766 * assume the buffer was allocated by avcodec_default_get_buffer.
768 #define CODEC_CAP_DR1 0x0002
769 #define CODEC_CAP_TRUNCATED 0x0008
771 /* Codec can export data for HW decoding. This flag indicates that
772 * the codec would call get_format() with list that might contain HW accelerated
773 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
774 * including raw image format.
775 * The application can use the passed context to determine bitstream version,
776 * chroma format, resolution etc.
778 #define CODEC_CAP_HWACCEL 0x0010
779 #endif /* FF_API_XVMC */
781 * Encoder or decoder requires flushing with NULL input at the end in order to
782 * give the complete and correct output.
784 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
785 * with NULL data. The user can still send NULL data to the public encode
786 * or decode function, but libavcodec will not pass it along to the codec
787 * unless this flag is set.
790 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
791 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
795 * The encoder needs to be fed with NULL data at the end of encoding until the
796 * encoder no longer returns data.
798 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
799 * flag also means that the encoder must set the pts and duration for
800 * each output packet. If this flag is not set, the pts and duration will
801 * be determined by libavcodec from the input frame.
803 #define CODEC_CAP_DELAY 0x0020
805 * Codec can be fed a final frame with a smaller size.
806 * This can be used to prevent truncation of the last audio samples.
808 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
811 * Codec can export data for HW decoding (VDPAU).
813 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
816 * Codec can output multiple frames per AVPacket
817 * Normally demuxers return one frame at a time, demuxers which do not do
818 * are connected to a parser to split what they return into proper frames.
819 * This flag is reserved to the very rare category of codecs which have a
820 * bitstream that cannot be split into frames without timeconsuming
821 * operations like full decoding. Demuxers carring such bitstreams thus
822 * may return multiple frames in a packet. This has many disadvantages like
823 * prohibiting stream copy in many cases thus it should only be considered
826 #define CODEC_CAP_SUBFRAMES 0x0100
828 * Codec is experimental and is thus avoided in favor of non experimental
831 #define CODEC_CAP_EXPERIMENTAL 0x0200
833 * Codec should fill in channel configuration and samplerate instead of container
835 #define CODEC_CAP_CHANNEL_CONF 0x0400
836 #if FF_API_NEG_LINESIZES
838 * @deprecated no codecs use this capability
840 #define CODEC_CAP_NEG_LINESIZES 0x0800
843 * Codec supports frame-level multithreading.
845 #define CODEC_CAP_FRAME_THREADS 0x1000
847 * Codec supports slice-based (or partition-based) multithreading.
849 #define CODEC_CAP_SLICE_THREADS 0x2000
851 * Codec supports changed parameters at any point.
853 #define CODEC_CAP_PARAM_CHANGE 0x4000
855 * Codec supports avctx->thread_count == 0 (auto).
857 #define CODEC_CAP_AUTO_THREADS 0x8000
859 * Audio encoder supports receiving a different number of samples in each call.
861 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
863 * Codec is intra only.
865 #define CODEC_CAP_INTRA_ONLY 0x40000000
869 #define CODEC_CAP_LOSSLESS 0x80000000
872 //The following defines may change, don't expect compatibility if you use them.
873 #define MB_TYPE_INTRA4x4 0x0001
874 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
875 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
876 #define MB_TYPE_16x16 0x0008
877 #define MB_TYPE_16x8 0x0010
878 #define MB_TYPE_8x16 0x0020
879 #define MB_TYPE_8x8 0x0040
880 #define MB_TYPE_INTERLACED 0x0080
881 #define MB_TYPE_DIRECT2 0x0100 //FIXME
882 #define MB_TYPE_ACPRED 0x0200
883 #define MB_TYPE_GMC 0x0400
884 #define MB_TYPE_SKIP 0x0800
885 #define MB_TYPE_P0L0 0x1000
886 #define MB_TYPE_P1L0 0x2000
887 #define MB_TYPE_P0L1 0x4000
888 #define MB_TYPE_P1L1 0x8000
889 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
890 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
891 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
892 #define MB_TYPE_QUANT 0x00010000
893 #define MB_TYPE_CBP 0x00020000
894 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
899 * This specifies the area which should be displayed.
900 * Note there may be multiple such areas for one frame.
902 typedef struct AVPanScan{
905 * - encoding: Set by user.
906 * - decoding: Set by libavcodec.
911 * width and height in 1/16 pel
912 * - encoding: Set by user.
913 * - decoding: Set by libavcodec.
919 * position of the top left corner in 1/16 pel for up to 3 fields/frames
920 * - encoding: Set by user.
921 * - decoding: Set by libavcodec.
923 int16_t position[3][2];
926 #if FF_API_QSCALE_TYPE
927 #define FF_QSCALE_TYPE_MPEG1 0
928 #define FF_QSCALE_TYPE_MPEG2 1
929 #define FF_QSCALE_TYPE_H264 2
930 #define FF_QSCALE_TYPE_VP56 3
933 #if FF_API_GET_BUFFER
934 #define FF_BUFFER_TYPE_INTERNAL 1
935 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
936 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
937 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
939 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
940 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
941 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
942 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
946 * The decoder will keep a reference to the frame and may reuse it later.
948 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
951 * @defgroup lavc_packet AVPacket
953 * Types and functions for working with AVPacket.
956 enum AVPacketSideDataType {
958 AV_PKT_DATA_NEW_EXTRADATA,
961 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
964 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
965 * s32le channel_count
966 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
967 * u64le channel_layout
968 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
970 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
975 AV_PKT_DATA_PARAM_CHANGE,
978 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
979 * structures with info about macroblocks relevant to splitting the
980 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
981 * That is, it does not necessarily contain info about all macroblocks,
982 * as long as the distance between macroblocks in the info is smaller
983 * than the target payload size.
984 * Each MB info structure is 12 bytes, and is laid out as follows:
986 * u32le bit offset from the start of the packet
987 * u8 current quantizer at the start of the macroblock
989 * u16le macroblock address within the GOB
990 * u8 horizontal MV predictor
991 * u8 vertical MV predictor
992 * u8 horizontal MV predictor for block number 3
993 * u8 vertical MV predictor for block number 3
996 AV_PKT_DATA_H263_MB_INFO,
999 * Recommmends skipping the specified number of samples
1001 * u32le number of samples to skip from start of this packet
1002 * u32le number of samples to skip from end of this packet
1003 * u8 reason for start skip
1004 * u8 reason for end skip (0=padding silence, 1=convergence)
1007 AV_PKT_DATA_SKIP_SAMPLES=70,
1010 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1011 * the packet may contain "dual mono" audio specific to Japanese DTV
1012 * and if it is true, recommends only the selected channel to be used.
1014 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1017 AV_PKT_DATA_JP_DUALMONO,
1020 * A list of zero terminated key/value strings. There is no end marker for
1021 * the list, so it is required to rely on the side data size to stop.
1023 AV_PKT_DATA_STRINGS_METADATA,
1026 * Subtitle event position
1034 AV_PKT_DATA_SUBTITLE_POSITION,
1037 * Data found in BlockAdditional element of matroska container. There is
1038 * no end marker for the data, so it is required to rely on the side data
1039 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1042 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1045 * The optional first identifier line of a WebVTT cue.
1047 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1050 * The optional settings (rendering instructions) that immediately
1051 * follow the timestamp specifier of a WebVTT cue.
1053 AV_PKT_DATA_WEBVTT_SETTINGS,
1056 * A list of zero terminated key/value strings. There is no end marker for
1057 * the list, so it is required to rely on the side data size to stop. This
1058 * side data includes updated metadata which appeared in the stream.
1060 AV_PKT_DATA_METADATA_UPDATE,
1064 * This structure stores compressed data. It is typically exported by demuxers
1065 * and then passed as input to decoders, or received as output from encoders and
1066 * then passed to muxers.
1068 * For video, it should typically contain one compressed frame. For audio it may
1069 * contain several compressed frames.
1071 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1072 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1073 * without libavcodec and libavformat major bump.
1075 * The semantics of data ownership depends on the buf or destruct (deprecated)
1076 * fields. If either is set, the packet data is dynamically allocated and is
1077 * valid indefinitely until av_free_packet() is called (which in turn calls
1078 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1079 * the packet data is typically backed by some static buffer somewhere and is
1080 * only valid for a limited time (e.g. until the next read call when demuxing).
1082 * The side data is always allocated with av_malloc() and is freed in
1085 typedef struct AVPacket {
1087 * A reference to the reference-counted buffer where the packet data is
1089 * May be NULL, then the packet data is not reference-counted.
1093 * Presentation timestamp in AVStream->time_base units; the time at which
1094 * the decompressed packet will be presented to the user.
1095 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1096 * pts MUST be larger or equal to dts as presentation cannot happen before
1097 * decompression, unless one wants to view hex dumps. Some formats misuse
1098 * the terms dts and pts/cts to mean something different. Such timestamps
1099 * must be converted to true pts/dts before they are stored in AVPacket.
1103 * Decompression timestamp in AVStream->time_base units; the time at which
1104 * the packet is decompressed.
1105 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1112 * A combination of AV_PKT_FLAG values
1116 * Additional packet data that can be provided by the container.
1117 * Packet can contain several types of side information.
1122 enum AVPacketSideDataType type;
1124 int side_data_elems;
1127 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1128 * Equals next_pts - this_pts in presentation order.
1131 #if FF_API_DESTRUCT_PACKET
1132 attribute_deprecated
1133 void (*destruct)(struct AVPacket *);
1134 attribute_deprecated
1137 int64_t pos; ///< byte position in stream, -1 if unknown
1140 * Time difference in AVStream->time_base units from the pts of this
1141 * packet to the point at which the output from the decoder has converged
1142 * independent from the availability of previous frames. That is, the
1143 * frames are virtually identical no matter if decoding started from
1144 * the very first frame or from this keyframe.
1145 * Is AV_NOPTS_VALUE if unknown.
1146 * This field is not the display duration of the current packet.
1147 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1150 * The purpose of this field is to allow seeking in streams that have no
1151 * keyframes in the conventional sense. It corresponds to the
1152 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1153 * essential for some types of subtitle streams to ensure that all
1154 * subtitles are correctly displayed after seeking.
1156 int64_t convergence_duration;
1158 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1159 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1161 enum AVSideDataParamChangeFlags {
1162 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1163 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1164 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1165 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1171 struct AVCodecInternal;
1175 AV_FIELD_PROGRESSIVE,
1176 AV_FIELD_TT, //< Top coded_first, top displayed first
1177 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1178 AV_FIELD_TB, //< Top coded first, bottom displayed first
1179 AV_FIELD_BT, //< Bottom coded first, top displayed first
1183 * main external API structure.
1184 * New fields can be added to the end with minor version bumps.
1185 * Removal, reordering and changes to existing fields require a major
1187 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1189 * sizeof(AVCodecContext) must not be used outside libav*.
1191 typedef struct AVCodecContext {
1193 * information on struct for av_log
1194 * - set by avcodec_alloc_context3
1196 const AVClass *av_class;
1197 int log_level_offset;
1199 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1200 const struct AVCodec *codec;
1201 char codec_name[32];
1202 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1205 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1206 * This is used to work around some encoder bugs.
1207 * A demuxer should set this to what is stored in the field used to identify the codec.
1208 * If there are multiple such fields in a container then the demuxer should choose the one
1209 * which maximizes the information about the used codec.
1210 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1211 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1212 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1214 * - encoding: Set by user, if not then the default based on codec_id will be used.
1215 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1217 unsigned int codec_tag;
1220 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1221 * This is used to work around some encoder bugs.
1222 * - encoding: unused
1223 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1225 unsigned int stream_codec_tag;
1230 * Private context used for internal data.
1232 * Unlike priv_data, this is not codec-specific. It is used in general
1233 * libavcodec functions.
1235 struct AVCodecInternal *internal;
1238 * Private data of the user, can be used to carry app specific stuff.
1239 * - encoding: Set by user.
1240 * - decoding: Set by user.
1245 * the average bitrate
1246 * - encoding: Set by user; unused for constant quantizer encoding.
1247 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1252 * number of bits the bitstream is allowed to diverge from the reference.
1253 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1254 * - encoding: Set by user; unused for constant quantizer encoding.
1255 * - decoding: unused
1257 int bit_rate_tolerance;
1260 * Global quality for codecs which cannot change it per frame.
1261 * This should be proportional to MPEG-1/2/4 qscale.
1262 * - encoding: Set by user.
1263 * - decoding: unused
1268 * - encoding: Set by user.
1269 * - decoding: unused
1271 int compression_level;
1272 #define FF_COMPRESSION_DEFAULT -1
1276 * - encoding: Set by user.
1277 * - decoding: Set by user.
1283 * - encoding: Set by user.
1284 * - decoding: Set by user.
1289 * some codecs need / can use extradata like Huffman tables.
1290 * mjpeg: Huffman tables
1291 * rv10: additional flags
1292 * mpeg4: global headers (they can be in the bitstream or here)
1293 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1294 * than extradata_size to avoid problems if it is read with the bitstream reader.
1295 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1296 * - encoding: Set/allocated/freed by libavcodec.
1297 * - decoding: Set/allocated/freed by user.
1303 * This is the fundamental unit of time (in seconds) in terms
1304 * of which frame timestamps are represented. For fixed-fps content,
1305 * timebase should be 1/framerate and timestamp increments should be
1307 * - encoding: MUST be set by user.
1308 * - decoding: Set by libavcodec.
1310 AVRational time_base;
1313 * For some codecs, the time base is closer to the field rate than the frame rate.
1314 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1315 * if no telecine is used ...
1317 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1319 int ticks_per_frame;
1324 * Encoding: Number of frames delay there will be from the encoder input to
1325 * the decoder output. (we assume the decoder matches the spec)
1326 * Decoding: Number of frames delay in addition to what a standard decoder
1327 * as specified in the spec would produce.
1330 * Number of frames the decoded output will be delayed relative to the
1334 * For encoding, this is the number of "priming" samples added to the
1335 * beginning of the stream. The decoded output will be delayed by this
1336 * many samples relative to the input to the encoder. Note that this
1337 * field is purely informational and does not directly affect the pts
1338 * output by the encoder, which should always be based on the actual
1339 * presentation time, including any delay.
1340 * For decoding, this is the number of samples the decoder needs to
1341 * output before the decoder's output is valid. When seeking, you should
1342 * start decoding this many samples prior to your desired seek point.
1344 * - encoding: Set by libavcodec.
1345 * - decoding: Set by libavcodec.
1352 * picture width / height.
1353 * - encoding: MUST be set by user.
1354 * - decoding: May be set by the user before opening the decoder if known e.g.
1355 * from the container. Some decoders will require the dimensions
1356 * to be set by the caller. During decoding, the decoder may
1357 * overwrite those values as required.
1362 * Bitstream width / height, may be different from width/height e.g. when
1363 * the decoded frame is cropped before being output or lowres is enabled.
1364 * - encoding: unused
1365 * - decoding: May be set by the user before opening the decoder if known
1366 * e.g. from the container. During decoding, the decoder may
1367 * overwrite those values as required.
1369 int coded_width, coded_height;
1371 #if FF_API_ASPECT_EXTENDED
1372 #define FF_ASPECT_EXTENDED 15
1376 * the number of pictures in a group of pictures, or 0 for intra_only
1377 * - encoding: Set by user.
1378 * - decoding: unused
1383 * Pixel format, see AV_PIX_FMT_xxx.
1384 * May be set by the demuxer if known from headers.
1385 * May be overridden by the decoder if it knows better.
1386 * - encoding: Set by user.
1387 * - decoding: Set by user if known, overridden by libavcodec if known
1389 enum AVPixelFormat pix_fmt;
1392 * Motion estimation algorithm used for video coding.
1393 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1394 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1395 * - encoding: MUST be set by user.
1396 * - decoding: unused
1401 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1402 * decoder to draw a horizontal band. It improves cache usage. Not
1403 * all codecs can do that. You must check the codec capabilities
1405 * When multithreading is used, it may be called from multiple threads
1406 * at the same time; threads might draw different parts of the same AVFrame,
1407 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1409 * The function is also used by hardware acceleration APIs.
1410 * It is called at least once during frame decoding to pass
1411 * the data needed for hardware render.
1412 * In that mode instead of pixel data, AVFrame points to
1413 * a structure specific to the acceleration API. The application
1414 * reads the structure and can change some fields to indicate progress
1416 * - encoding: unused
1417 * - decoding: Set by user.
1418 * @param height the height of the slice
1419 * @param y the y position of the slice
1420 * @param type 1->top field, 2->bottom field, 3->frame
1421 * @param offset offset into the AVFrame.data from which the slice should be read
1423 void (*draw_horiz_band)(struct AVCodecContext *s,
1424 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1425 int y, int type, int height);
1428 * callback to negotiate the pixelFormat
1429 * @param fmt is the list of formats which are supported by the codec,
1430 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1431 * The first is always the native one.
1432 * @return the chosen format
1433 * - encoding: unused
1434 * - decoding: Set by user, if not set the native format will be chosen.
1436 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1439 * maximum number of B-frames between non-B-frames
1440 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1441 * - encoding: Set by user.
1442 * - decoding: unused
1447 * qscale factor between IP and B-frames
1448 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1449 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1450 * - encoding: Set by user.
1451 * - decoding: unused
1453 float b_quant_factor;
1455 /** obsolete FIXME remove */
1457 #define FF_RC_STRATEGY_XVID 1
1459 int b_frame_strategy;
1462 * qscale offset between IP and B-frames
1463 * - encoding: Set by user.
1464 * - decoding: unused
1466 float b_quant_offset;
1469 * Size of the frame reordering buffer in the decoder.
1470 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1471 * - encoding: Set by libavcodec.
1472 * - decoding: Set by libavcodec.
1477 * 0-> h263 quant 1-> mpeg quant
1478 * - encoding: Set by user.
1479 * - decoding: unused
1484 * qscale factor between P and I-frames
1485 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1486 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1487 * - encoding: Set by user.
1488 * - decoding: unused
1490 float i_quant_factor;
1493 * qscale offset between P and I-frames
1494 * - encoding: Set by user.
1495 * - decoding: unused
1497 float i_quant_offset;
1500 * luminance masking (0-> disabled)
1501 * - encoding: Set by user.
1502 * - decoding: unused
1507 * temporary complexity masking (0-> disabled)
1508 * - encoding: Set by user.
1509 * - decoding: unused
1511 float temporal_cplx_masking;
1514 * spatial complexity masking (0-> disabled)
1515 * - encoding: Set by user.
1516 * - decoding: unused
1518 float spatial_cplx_masking;
1521 * p block masking (0-> disabled)
1522 * - encoding: Set by user.
1523 * - decoding: unused
1528 * darkness masking (0-> disabled)
1529 * - encoding: Set by user.
1530 * - decoding: unused
1536 * - encoding: Set by libavcodec.
1537 * - decoding: Set by user (or 0).
1541 * prediction method (needed for huffyuv)
1542 * - encoding: Set by user.
1543 * - decoding: unused
1545 int prediction_method;
1546 #define FF_PRED_LEFT 0
1547 #define FF_PRED_PLANE 1
1548 #define FF_PRED_MEDIAN 2
1551 * slice offsets in the frame in bytes
1552 * - encoding: Set/allocated by libavcodec.
1553 * - decoding: Set/allocated by user (or NULL).
1558 * sample aspect ratio (0 if unknown)
1559 * That is the width of a pixel divided by the height of the pixel.
1560 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1561 * - encoding: Set by user.
1562 * - decoding: Set by libavcodec.
1564 AVRational sample_aspect_ratio;
1567 * motion estimation comparison function
1568 * - encoding: Set by user.
1569 * - decoding: unused
1573 * subpixel motion estimation comparison function
1574 * - encoding: Set by user.
1575 * - decoding: unused
1579 * macroblock comparison function (not supported yet)
1580 * - encoding: Set by user.
1581 * - decoding: unused
1585 * interlaced DCT comparison function
1586 * - encoding: Set by user.
1587 * - decoding: unused
1590 #define FF_CMP_SAD 0
1591 #define FF_CMP_SSE 1
1592 #define FF_CMP_SATD 2
1593 #define FF_CMP_DCT 3
1594 #define FF_CMP_PSNR 4
1595 #define FF_CMP_BIT 5
1597 #define FF_CMP_ZERO 7
1598 #define FF_CMP_VSAD 8
1599 #define FF_CMP_VSSE 9
1600 #define FF_CMP_NSSE 10
1601 #define FF_CMP_W53 11
1602 #define FF_CMP_W97 12
1603 #define FF_CMP_DCTMAX 13
1604 #define FF_CMP_DCT264 14
1605 #define FF_CMP_CHROMA 256
1608 * ME diamond size & shape
1609 * - encoding: Set by user.
1610 * - decoding: unused
1615 * amount of previous MV predictors (2a+1 x 2a+1 square)
1616 * - encoding: Set by user.
1617 * - decoding: unused
1619 int last_predictor_count;
1622 * prepass for motion estimation
1623 * - encoding: Set by user.
1624 * - decoding: unused
1629 * motion estimation prepass comparison function
1630 * - encoding: Set by user.
1631 * - decoding: unused
1636 * ME prepass diamond size & shape
1637 * - encoding: Set by user.
1638 * - decoding: unused
1644 * - encoding: Set by user.
1645 * - decoding: unused
1647 int me_subpel_quality;
1650 * DTG active format information (additional aspect ratio
1651 * information only used in DVB MPEG-2 transport streams)
1654 * - encoding: unused
1655 * - decoding: Set by decoder.
1657 int dtg_active_format;
1658 #define FF_DTG_AFD_SAME 8
1659 #define FF_DTG_AFD_4_3 9
1660 #define FF_DTG_AFD_16_9 10
1661 #define FF_DTG_AFD_14_9 11
1662 #define FF_DTG_AFD_4_3_SP_14_9 13
1663 #define FF_DTG_AFD_16_9_SP_14_9 14
1664 #define FF_DTG_AFD_SP_4_3 15
1667 * maximum motion estimation search range in subpel units
1668 * If 0 then no limit.
1670 * - encoding: Set by user.
1671 * - decoding: unused
1676 * intra quantizer bias
1677 * - encoding: Set by user.
1678 * - decoding: unused
1680 int intra_quant_bias;
1681 #define FF_DEFAULT_QUANT_BIAS 999999
1684 * inter quantizer bias
1685 * - encoding: Set by user.
1686 * - decoding: unused
1688 int inter_quant_bias;
1692 * - encoding: unused
1693 * - decoding: Set by user.
1696 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1697 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1698 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1702 * XVideo Motion Acceleration
1703 * - encoding: forbidden
1704 * - decoding: set by decoder
1705 * @deprecated XvMC doesn't need it anymore.
1707 attribute_deprecated int xvmc_acceleration;
1708 #endif /* FF_API_XVMC */
1711 * macroblock decision mode
1712 * - encoding: Set by user.
1713 * - decoding: unused
1716 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1717 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1718 #define FF_MB_DECISION_RD 2 ///< rate distortion
1721 * custom intra quantization matrix
1722 * - encoding: Set by user, can be NULL.
1723 * - decoding: Set by libavcodec.
1725 uint16_t *intra_matrix;
1728 * custom inter quantization matrix
1729 * - encoding: Set by user, can be NULL.
1730 * - decoding: Set by libavcodec.
1732 uint16_t *inter_matrix;
1735 * scene change detection threshold
1736 * 0 is default, larger means fewer detected scene changes.
1737 * - encoding: Set by user.
1738 * - decoding: unused
1740 int scenechange_threshold;
1743 * noise reduction strength
1744 * - encoding: Set by user.
1745 * - decoding: unused
1747 int noise_reduction;
1750 * Motion estimation threshold below which no motion estimation is
1751 * performed, but instead the user specified motion vectors are used.
1753 * - encoding: Set by user.
1754 * - decoding: unused
1759 * Macroblock threshold below which the user specified macroblock types will be used.
1760 * - encoding: Set by user.
1761 * - decoding: unused
1766 * precision of the intra DC coefficient - 8
1767 * - encoding: Set by user.
1768 * - decoding: unused
1770 int intra_dc_precision;
1773 * Number of macroblock rows at the top which are skipped.
1774 * - encoding: unused
1775 * - decoding: Set by user.
1780 * Number of macroblock rows at the bottom which are skipped.
1781 * - encoding: unused
1782 * - decoding: Set by user.
1787 * Border processing masking, raises the quantizer for mbs on the borders
1789 * - encoding: Set by user.
1790 * - decoding: unused
1792 float border_masking;
1795 * minimum MB lagrange multipler
1796 * - encoding: Set by user.
1797 * - decoding: unused
1802 * maximum MB lagrange multipler
1803 * - encoding: Set by user.
1804 * - decoding: unused
1810 * - encoding: Set by user.
1811 * - decoding: unused
1813 int me_penalty_compensation;
1817 * - encoding: Set by user.
1818 * - decoding: unused
1824 * - encoding: Set by user.
1825 * - decoding: unused
1831 * - encoding: Set by user.
1832 * - decoding: unused
1837 * number of reference frames
1838 * - encoding: Set by user.
1839 * - decoding: Set by lavc.
1844 * chroma qp offset from luma
1845 * - encoding: Set by user.
1846 * - decoding: unused
1851 * Multiplied by qscale for each frame and added to scene_change_score.
1852 * - encoding: Set by user.
1853 * - decoding: unused
1855 int scenechange_factor;
1859 * Note: Value depends upon the compare function used for fullpel ME.
1860 * - encoding: Set by user.
1861 * - decoding: unused
1866 * Adjust sensitivity of b_frame_strategy 1.
1867 * - encoding: Set by user.
1868 * - decoding: unused
1873 * Chromaticity coordinates of the source primaries.
1874 * - encoding: Set by user
1875 * - decoding: Set by libavcodec
1877 enum AVColorPrimaries color_primaries;
1880 * Color Transfer Characteristic.
1881 * - encoding: Set by user
1882 * - decoding: Set by libavcodec
1884 enum AVColorTransferCharacteristic color_trc;
1887 * YUV colorspace type.
1888 * - encoding: Set by user
1889 * - decoding: Set by libavcodec
1891 enum AVColorSpace colorspace;
1894 * MPEG vs JPEG YUV range.
1895 * - encoding: Set by user
1896 * - decoding: Set by libavcodec
1898 enum AVColorRange color_range;
1901 * This defines the location of chroma samples.
1902 * - encoding: Set by user
1903 * - decoding: Set by libavcodec
1905 enum AVChromaLocation chroma_sample_location;
1909 * Indicates number of picture subdivisions. Used for parallelized
1911 * - encoding: Set by user
1912 * - decoding: unused
1917 * - encoding: set by libavcodec
1918 * - decoding: Set by user.
1920 enum AVFieldOrder field_order;
1923 int sample_rate; ///< samples per second
1924 int channels; ///< number of audio channels
1927 * audio sample format
1928 * - encoding: Set by user.
1929 * - decoding: Set by libavcodec.
1931 enum AVSampleFormat sample_fmt; ///< sample format
1933 /* The following data should not be initialized. */
1935 * Number of samples per channel in an audio frame.
1937 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1938 * except the last must contain exactly frame_size samples per channel.
1939 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1940 * frame size is not restricted.
1941 * - decoding: may be set by some decoders to indicate constant frame size
1946 * Frame counter, set by libavcodec.
1948 * - decoding: total number of frames returned from the decoder so far.
1949 * - encoding: total number of frames passed to the encoder so far.
1951 * @note the counter is not incremented if encoding/decoding resulted in
1957 * number of bytes per packet if constant and known or 0
1958 * Used by some WAV based audio codecs.
1963 * Audio cutoff bandwidth (0 means "automatic")
1964 * - encoding: Set by user.
1965 * - decoding: unused
1969 #if FF_API_REQUEST_CHANNELS
1971 * Decoder should decode to this many channels if it can (0 for default)
1972 * - encoding: unused
1973 * - decoding: Set by user.
1974 * @deprecated Deprecated in favor of request_channel_layout.
1976 attribute_deprecated int request_channels;
1980 * Audio channel layout.
1981 * - encoding: set by user.
1982 * - decoding: set by user, may be overwritten by libavcodec.
1984 uint64_t channel_layout;
1987 * Request decoder to use this channel layout if it can (0 for default)
1988 * - encoding: unused
1989 * - decoding: Set by user.
1991 uint64_t request_channel_layout;
1994 * Type of service that the audio stream conveys.
1995 * - encoding: Set by user.
1996 * - decoding: Set by libavcodec.
1998 enum AVAudioServiceType audio_service_type;
2001 * desired sample format
2002 * - encoding: Not used.
2003 * - decoding: Set by user.
2004 * Decoder will decode to this format if it can.
2006 enum AVSampleFormat request_sample_fmt;
2008 #if FF_API_GET_BUFFER
2010 * Called at the beginning of each frame to get a buffer for it.
2012 * The function will set AVFrame.data[], AVFrame.linesize[].
2013 * AVFrame.extended_data[] must also be set, but it should be the same as
2014 * AVFrame.data[] except for planar audio with more channels than can fit
2015 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2016 * many data pointers as it can hold.
2018 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2019 * avcodec_default_get_buffer() instead of providing buffers allocated by
2022 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2023 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2024 * but if get_buffer() is overridden then alignment considerations should
2025 * be taken into account.
2027 * @see avcodec_default_get_buffer()
2031 * If pic.reference is set then the frame will be read later by libavcodec.
2032 * avcodec_align_dimensions2() should be used to find the required width and
2033 * height, as they normally need to be rounded up to the next multiple of 16.
2035 * If frame multithreading is used and thread_safe_callbacks is set,
2036 * it may be called from a different thread, but not from more than one at
2037 * once. Does not need to be reentrant.
2039 * @see release_buffer(), reget_buffer()
2040 * @see avcodec_align_dimensions2()
2044 * Decoders request a buffer of a particular size by setting
2045 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2046 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2047 * to a smaller value in the output frame.
2049 * Decoders cannot use the buffer after returning from
2050 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2051 * is assumed to be released immediately upon return. In some rare cases,
2052 * a decoder may need to call get_buffer() more than once in a single
2053 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2054 * called again after it has already been called once, the previously
2055 * acquired buffer is assumed to be released at that time and may not be
2056 * reused by the decoder.
2058 * As a convenience, av_samples_get_buffer_size() and
2059 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2060 * functions to find the required data size and to fill data pointers and
2061 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2062 * since all planes must be the same size.
2064 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2066 * - encoding: unused
2067 * - decoding: Set by libavcodec, user can override.
2069 * @deprecated use get_buffer2()
2071 attribute_deprecated
2072 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2075 * Called to release buffers which were allocated with get_buffer.
2076 * A released buffer can be reused in get_buffer().
2077 * pic.data[*] must be set to NULL.
2078 * May be called from a different thread if frame multithreading is used,
2079 * but not by more than one thread at once, so does not need to be reentrant.
2080 * - encoding: unused
2081 * - decoding: Set by libavcodec, user can override.
2083 * @deprecated custom freeing callbacks should be set from get_buffer2()
2085 attribute_deprecated
2086 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2089 * Called at the beginning of a frame to get cr buffer for it.
2090 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2091 * libavcodec will pass previous buffer in pic, function should return
2092 * same buffer or new buffer with old frame "painted" into it.
2093 * If pic.data[0] == NULL must behave like get_buffer().
2094 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2095 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2097 * - encoding: unused
2098 * - decoding: Set by libavcodec, user can override.
2100 attribute_deprecated
2101 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2105 * This callback is called at the beginning of each frame to get data
2106 * buffer(s) for it. There may be one contiguous buffer for all the data or
2107 * there may be a buffer per each data plane or anything in between. What
2108 * this means is, you may set however many entries in buf[] you feel necessary.
2109 * Each buffer must be reference-counted using the AVBuffer API (see description
2112 * The following fields will be set in the frame before this callback is
2115 * - width, height (video only)
2116 * - sample_rate, channel_layout, nb_samples (audio only)
2117 * Their values may differ from the corresponding values in
2118 * AVCodecContext. This callback must use the frame values, not the codec
2119 * context values, to calculate the required buffer size.
2121 * This callback must fill the following fields in the frame:
2125 * * if the data is planar audio with more than 8 channels, then this
2126 * callback must allocate and fill extended_data to contain all pointers
2127 * to all data planes. data[] must hold as many pointers as it can.
2128 * extended_data must be allocated with av_malloc() and will be freed in
2130 * * otherwise exended_data must point to data
2131 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2132 * the frame's data and extended_data pointers must be contained in these. That
2133 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2134 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2135 * and av_buffer_ref().
2136 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2137 * this callback and filled with the extra buffers if there are more
2138 * buffers than buf[] can hold. extended_buf will be freed in
2141 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2142 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2145 * Each data plane must be aligned to the maximum required by the target
2148 * @see avcodec_default_get_buffer2()
2152 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2153 * (read and/or written to if it is writable) later by libavcodec.
2155 * If CODEC_FLAG_EMU_EDGE is not set in s->flags, the buffer must contain an
2156 * edge of the size returned by avcodec_get_edge_width() on all sides.
2158 * avcodec_align_dimensions2() should be used to find the required width and
2159 * height, as they normally need to be rounded up to the next multiple of 16.
2161 * If frame multithreading is used and thread_safe_callbacks is set,
2162 * this callback may be called from a different thread, but not from more
2163 * than one at once. Does not need to be reentrant.
2165 * @see avcodec_align_dimensions2()
2169 * Decoders request a buffer of a particular size by setting
2170 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2171 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2172 * to a smaller value in the output frame.
2174 * As a convenience, av_samples_get_buffer_size() and
2175 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2176 * functions to find the required data size and to fill data pointers and
2177 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2178 * since all planes must be the same size.
2180 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2182 * - encoding: unused
2183 * - decoding: Set by libavcodec, user can override.
2185 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2188 * If non-zero, the decoded audio and video frames returned from
2189 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2190 * and are valid indefinitely. The caller must free them with
2191 * av_frame_unref() when they are not needed anymore.
2192 * Otherwise, the decoded frames must not be freed by the caller and are
2193 * only valid until the next decode call.
2195 * - encoding: unused
2196 * - decoding: set by the caller before avcodec_open2().
2198 int refcounted_frames;
2200 /* - encoding parameters */
2201 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2202 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2206 * - encoding: Set by user.
2207 * - decoding: unused
2213 * - encoding: Set by user.
2214 * - decoding: unused
2219 * maximum quantizer difference between frames
2220 * - encoding: Set by user.
2221 * - decoding: unused
2226 * ratecontrol qmin qmax limiting method
2227 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2228 * - encoding: Set by user.
2229 * - decoding: unused
2237 * decoder bitstream buffer size
2238 * - encoding: Set by user.
2239 * - decoding: unused
2244 * ratecontrol override, see RcOverride
2245 * - encoding: Allocated/set/freed by user.
2246 * - decoding: unused
2248 int rc_override_count;
2249 RcOverride *rc_override;
2252 * rate control equation
2253 * - encoding: Set by user
2254 * - decoding: unused
2260 * - encoding: Set by user.
2261 * - decoding: unused
2267 * - encoding: Set by user.
2268 * - decoding: unused
2272 float rc_buffer_aggressivity;
2275 * initial complexity for pass1 ratecontrol
2276 * - encoding: Set by user.
2277 * - decoding: unused
2279 float rc_initial_cplx;
2282 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2283 * - encoding: Set by user.
2284 * - decoding: unused.
2286 float rc_max_available_vbv_use;
2289 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2290 * - encoding: Set by user.
2291 * - decoding: unused.
2293 float rc_min_vbv_overflow_use;
2296 * Number of bits which should be loaded into the rc buffer before decoding starts.
2297 * - encoding: Set by user.
2298 * - decoding: unused
2300 int rc_initial_buffer_occupancy;
2302 #define FF_CODER_TYPE_VLC 0
2303 #define FF_CODER_TYPE_AC 1
2304 #define FF_CODER_TYPE_RAW 2
2305 #define FF_CODER_TYPE_RLE 3
2306 #define FF_CODER_TYPE_DEFLATE 4
2309 * - encoding: Set by user.
2310 * - decoding: unused
2316 * - encoding: Set by user.
2317 * - decoding: unused
2322 * minimum Lagrange multipler
2323 * - encoding: Set by user.
2324 * - decoding: unused
2329 * maximum Lagrange multipler
2330 * - encoding: Set by user.
2331 * - decoding: unused
2336 * frame skip threshold
2337 * - encoding: Set by user.
2338 * - decoding: unused
2340 int frame_skip_threshold;
2344 * - encoding: Set by user.
2345 * - decoding: unused
2347 int frame_skip_factor;
2350 * frame skip exponent
2351 * - encoding: Set by user.
2352 * - decoding: unused
2357 * frame skip comparison function
2358 * - encoding: Set by user.
2359 * - decoding: unused
2364 * trellis RD quantization
2365 * - encoding: Set by user.
2366 * - decoding: unused
2371 * - encoding: Set by user.
2372 * - decoding: unused
2374 int min_prediction_order;
2377 * - encoding: Set by user.
2378 * - decoding: unused
2380 int max_prediction_order;
2383 * GOP timecode frame start number
2384 * - encoding: Set by user, in non drop frame format
2385 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2387 int64_t timecode_frame_start;
2389 /* The RTP callback: This function is called */
2390 /* every time the encoder has a packet to send. */
2391 /* It depends on the encoder if the data starts */
2392 /* with a Start Code (it should). H.263 does. */
2393 /* mb_nb contains the number of macroblocks */
2394 /* encoded in the RTP payload. */
2395 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2397 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2398 /* do its best to deliver a chunk with size */
2399 /* below rtp_payload_size, the chunk will start */
2400 /* with a start code on some codecs like H.263. */
2401 /* This doesn't take account of any particular */
2402 /* headers inside the transmitted RTP payload. */
2404 /* statistics, used for 2-pass encoding */
2415 * number of bits used for the previously encoded frame
2416 * - encoding: Set by libavcodec.
2417 * - decoding: unused
2422 * pass1 encoding statistics output buffer
2423 * - encoding: Set by libavcodec.
2424 * - decoding: unused
2429 * pass2 encoding statistics input buffer
2430 * Concatenated stuff from stats_out of pass1 should be placed here.
2431 * - encoding: Allocated/set/freed by user.
2432 * - decoding: unused
2437 * Work around bugs in encoders which sometimes cannot be detected automatically.
2438 * - encoding: Set by user
2439 * - decoding: Set by user
2441 int workaround_bugs;
2442 #define FF_BUG_AUTODETECT 1 ///< autodetection
2443 #if FF_API_OLD_MSMPEG4
2444 #define FF_BUG_OLD_MSMPEG4 2
2446 #define FF_BUG_XVID_ILACE 4
2447 #define FF_BUG_UMP4 8
2448 #define FF_BUG_NO_PADDING 16
2449 #define FF_BUG_AMV 32
2451 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2453 #define FF_BUG_QPEL_CHROMA 64
2454 #define FF_BUG_STD_QPEL 128
2455 #define FF_BUG_QPEL_CHROMA2 256
2456 #define FF_BUG_DIRECT_BLOCKSIZE 512
2457 #define FF_BUG_EDGE 1024
2458 #define FF_BUG_HPEL_CHROMA 2048
2459 #define FF_BUG_DC_CLIP 4096
2460 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2461 #define FF_BUG_TRUNCATED 16384
2464 * strictly follow the standard (MPEG4, ...).
2465 * - encoding: Set by user.
2466 * - decoding: Set by user.
2467 * Setting this to STRICT or higher means the encoder and decoder will
2468 * generally do stupid things, whereas setting it to unofficial or lower
2469 * will mean the encoder might produce output that is not supported by all
2470 * spec-compliant decoders. Decoders don't differentiate between normal,
2471 * unofficial and experimental (that is, they always try to decode things
2472 * when they can) unless they are explicitly asked to behave stupidly
2473 * (=strictly conform to the specs)
2475 int strict_std_compliance;
2476 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2477 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2478 #define FF_COMPLIANCE_NORMAL 0
2479 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2480 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2483 * error concealment flags
2484 * - encoding: unused
2485 * - decoding: Set by user.
2487 int error_concealment;
2488 #define FF_EC_GUESS_MVS 1
2489 #define FF_EC_DEBLOCK 2
2493 * - encoding: Set by user.
2494 * - decoding: Set by user.
2497 #define FF_DEBUG_PICT_INFO 1
2498 #define FF_DEBUG_RC 2
2499 #define FF_DEBUG_BITSTREAM 4
2500 #define FF_DEBUG_MB_TYPE 8
2501 #define FF_DEBUG_QP 16
2504 * @deprecated this option does nothing
2506 #define FF_DEBUG_MV 32
2508 #define FF_DEBUG_DCT_COEFF 0x00000040
2509 #define FF_DEBUG_SKIP 0x00000080
2510 #define FF_DEBUG_STARTCODE 0x00000100
2511 #define FF_DEBUG_PTS 0x00000200
2512 #define FF_DEBUG_ER 0x00000400
2513 #define FF_DEBUG_MMCO 0x00000800
2514 #define FF_DEBUG_BUGS 0x00001000
2516 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2517 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2519 #define FF_DEBUG_BUFFERS 0x00008000
2520 #define FF_DEBUG_THREADS 0x00010000
2525 * Code outside libavcodec should access this field using AVOptions
2526 * - encoding: Set by user.
2527 * - decoding: Set by user.
2530 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2531 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2532 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2536 * Error recognition; may misdetect some more or less valid parts as errors.
2537 * - encoding: unused
2538 * - decoding: Set by user.
2540 int err_recognition;
2543 * Verify checksums embedded in the bitstream (could be of either encoded or
2544 * decoded data, depending on the codec) and print an error message on mismatch.
2545 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2546 * decoder returning an error.
2548 #define AV_EF_CRCCHECK (1<<0)
2549 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2550 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2551 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2553 #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
2554 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliancies as errors
2555 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2559 * opaque 64bit number (generally a PTS) that will be reordered and
2560 * output in AVFrame.reordered_opaque
2561 * @deprecated in favor of pkt_pts
2562 * - encoding: unused
2563 * - decoding: Set by user.
2565 int64_t reordered_opaque;
2568 * Hardware accelerator in use
2569 * - encoding: unused.
2570 * - decoding: Set by libavcodec
2572 struct AVHWAccel *hwaccel;
2575 * Hardware accelerator context.
2576 * For some hardware accelerators, a global context needs to be
2577 * provided by the user. In that case, this holds display-dependent
2578 * data FFmpeg cannot instantiate itself. Please refer to the
2579 * FFmpeg HW accelerator documentation to know how to fill this
2580 * is. e.g. for VA API, this is a struct vaapi_context.
2581 * - encoding: unused
2582 * - decoding: Set by user
2584 void *hwaccel_context;
2588 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2589 * - decoding: unused
2591 uint64_t error[AV_NUM_DATA_POINTERS];
2594 * DCT algorithm, see FF_DCT_* below
2595 * - encoding: Set by user.
2596 * - decoding: unused
2599 #define FF_DCT_AUTO 0
2600 #define FF_DCT_FASTINT 1
2601 #define FF_DCT_INT 2
2602 #define FF_DCT_MMX 3
2603 #define FF_DCT_ALTIVEC 5
2604 #define FF_DCT_FAAN 6
2607 * IDCT algorithm, see FF_IDCT_* below.
2608 * - encoding: Set by user.
2609 * - decoding: Set by user.
2612 #define FF_IDCT_AUTO 0
2613 #define FF_IDCT_INT 1
2614 #define FF_IDCT_SIMPLE 2
2615 #define FF_IDCT_SIMPLEMMX 3
2616 #define FF_IDCT_ARM 7
2617 #define FF_IDCT_ALTIVEC 8
2618 #define FF_IDCT_SH4 9
2619 #define FF_IDCT_SIMPLEARM 10
2620 #define FF_IDCT_IPP 13
2621 #define FF_IDCT_XVIDMMX 14
2622 #define FF_IDCT_SIMPLEARMV5TE 16
2623 #define FF_IDCT_SIMPLEARMV6 17
2624 #define FF_IDCT_SIMPLEVIS 18
2625 #define FF_IDCT_FAAN 20
2626 #define FF_IDCT_SIMPLENEON 22
2627 #if FF_API_ARCH_ALPHA
2628 #define FF_IDCT_SIMPLEALPHA 23
2632 * bits per sample/pixel from the demuxer (needed for huffyuv).
2633 * - encoding: Set by libavcodec.
2634 * - decoding: Set by user.
2636 int bits_per_coded_sample;
2639 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2640 * - encoding: set by user.
2641 * - decoding: set by libavcodec.
2643 int bits_per_raw_sample;
2647 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2648 * - encoding: unused
2649 * - decoding: Set by user.
2650 * Code outside libavcodec should access this field using:
2651 * av_codec_{get,set}_lowres(avctx)
2657 * the picture in the bitstream
2658 * - encoding: Set by libavcodec.
2659 * - decoding: unused
2661 AVFrame *coded_frame;
2665 * is used to decide how many independent tasks should be passed to execute()
2666 * - encoding: Set by user.
2667 * - decoding: Set by user.
2672 * Which multithreading methods to use.
2673 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2674 * so clients which cannot provide future frames should not use it.
2676 * - encoding: Set by user, otherwise the default is used.
2677 * - decoding: Set by user, otherwise the default is used.
2680 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2681 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2684 * Which multithreading methods are in use by the codec.
2685 * - encoding: Set by libavcodec.
2686 * - decoding: Set by libavcodec.
2688 int active_thread_type;
2691 * Set by the client if its custom get_buffer() callback can be called
2692 * synchronously from another thread, which allows faster multithreaded decoding.
2693 * draw_horiz_band() will be called from other threads regardless of this setting.
2694 * Ignored if the default get_buffer() is used.
2695 * - encoding: Set by user.
2696 * - decoding: Set by user.
2698 int thread_safe_callbacks;
2701 * The codec may call this to execute several independent things.
2702 * It will return only after finishing all tasks.
2703 * The user may replace this with some multithreaded implementation,
2704 * the default implementation will execute the parts serially.
2705 * @param count the number of things to execute
2706 * - encoding: Set by libavcodec, user can override.
2707 * - decoding: Set by libavcodec, user can override.
2709 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2712 * The codec may call this to execute several independent things.
2713 * It will return only after finishing all tasks.
2714 * The user may replace this with some multithreaded implementation,
2715 * the default implementation will execute the parts serially.
2716 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2717 * @param c context passed also to func
2718 * @param count the number of things to execute
2719 * @param arg2 argument passed unchanged to func
2720 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2721 * @param func function that will be called count times, with jobnr from 0 to count-1.
2722 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2723 * two instances of func executing at the same time will have the same threadnr.
2724 * @return always 0 currently, but code should handle a future improvement where when any call to func
2725 * returns < 0 no further calls to func may be done and < 0 is returned.
2726 * - encoding: Set by libavcodec, user can override.
2727 * - decoding: Set by libavcodec, user can override.
2729 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2731 #if FF_API_THREAD_OPAQUE
2733 * @deprecated this field should not be used from outside of lavc
2735 attribute_deprecated
2736 void *thread_opaque;
2740 * noise vs. sse weight for the nsse comparsion function
2741 * - encoding: Set by user.
2742 * - decoding: unused
2748 * - encoding: Set by user.
2749 * - decoding: Set by libavcodec.
2752 #define FF_PROFILE_UNKNOWN -99
2753 #define FF_PROFILE_RESERVED -100
2755 #define FF_PROFILE_AAC_MAIN 0
2756 #define FF_PROFILE_AAC_LOW 1
2757 #define FF_PROFILE_AAC_SSR 2
2758 #define FF_PROFILE_AAC_LTP 3
2759 #define FF_PROFILE_AAC_HE 4
2760 #define FF_PROFILE_AAC_HE_V2 28
2761 #define FF_PROFILE_AAC_LD 22
2762 #define FF_PROFILE_AAC_ELD 38
2763 #define FF_PROFILE_MPEG2_AAC_LOW 128
2764 #define FF_PROFILE_MPEG2_AAC_HE 131
2766 #define FF_PROFILE_DTS 20
2767 #define FF_PROFILE_DTS_ES 30
2768 #define FF_PROFILE_DTS_96_24 40
2769 #define FF_PROFILE_DTS_HD_HRA 50
2770 #define FF_PROFILE_DTS_HD_MA 60
2772 #define FF_PROFILE_MPEG2_422 0
2773 #define FF_PROFILE_MPEG2_HIGH 1
2774 #define FF_PROFILE_MPEG2_SS 2
2775 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2776 #define FF_PROFILE_MPEG2_MAIN 4
2777 #define FF_PROFILE_MPEG2_SIMPLE 5
2779 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2780 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2782 #define FF_PROFILE_H264_BASELINE 66
2783 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2784 #define FF_PROFILE_H264_MAIN 77
2785 #define FF_PROFILE_H264_EXTENDED 88
2786 #define FF_PROFILE_H264_HIGH 100
2787 #define FF_PROFILE_H264_HIGH_10 110
2788 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2789 #define FF_PROFILE_H264_HIGH_422 122
2790 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2791 #define FF_PROFILE_H264_HIGH_444 144
2792 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2793 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2794 #define FF_PROFILE_H264_CAVLC_444 44
2796 #define FF_PROFILE_VC1_SIMPLE 0
2797 #define FF_PROFILE_VC1_MAIN 1
2798 #define FF_PROFILE_VC1_COMPLEX 2
2799 #define FF_PROFILE_VC1_ADVANCED 3
2801 #define FF_PROFILE_MPEG4_SIMPLE 0
2802 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2803 #define FF_PROFILE_MPEG4_CORE 2
2804 #define FF_PROFILE_MPEG4_MAIN 3
2805 #define FF_PROFILE_MPEG4_N_BIT 4
2806 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2807 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2808 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2809 #define FF_PROFILE_MPEG4_HYBRID 8
2810 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2811 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2812 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2813 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2814 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2815 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2816 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2818 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2819 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2820 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2821 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2822 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2825 #define FF_PROFILE_HEVC_MAIN 1
2826 #define FF_PROFILE_HEVC_MAIN_10 2
2827 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2831 * - encoding: Set by user.
2832 * - decoding: Set by libavcodec.
2835 #define FF_LEVEL_UNKNOWN -99
2838 * Skip loop filtering for selected frames.
2839 * - encoding: unused
2840 * - decoding: Set by user.
2842 enum AVDiscard skip_loop_filter;
2845 * Skip IDCT/dequantization for selected frames.
2846 * - encoding: unused
2847 * - decoding: Set by user.
2849 enum AVDiscard skip_idct;
2852 * Skip decoding for selected frames.
2853 * - encoding: unused
2854 * - decoding: Set by user.
2856 enum AVDiscard skip_frame;
2859 * Header containing style information for text subtitles.
2860 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2861 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2862 * the Format line following. It shouldn't include any Dialogue line.
2863 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2864 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2866 uint8_t *subtitle_header;
2867 int subtitle_header_size;
2869 #if FF_API_ERROR_RATE
2871 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2874 attribute_deprecated
2878 #if FF_API_CODEC_PKT
2880 * @deprecated this field is not supposed to be accessed from outside lavc
2882 attribute_deprecated
2887 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2888 * Used for compliant TS muxing.
2889 * - encoding: Set by libavcodec.
2890 * - decoding: unused.
2895 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2896 * Code outside libavcodec should access this field using:
2897 * av_codec_{get,set}_pkt_timebase(avctx)
2898 * - encoding unused.
2899 * - decoding set by user.
2901 AVRational pkt_timebase;
2905 * Code outside libavcodec should access this field using:
2906 * av_codec_{get,set}_codec_descriptor(avctx)
2907 * - encoding: unused.
2908 * - decoding: set by libavcodec.
2910 const AVCodecDescriptor *codec_descriptor;
2914 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2915 * - encoding: unused
2916 * - decoding: Set by user.
2917 * Code outside libavcodec should access this field using:
2918 * av_codec_{get,set}_lowres(avctx)
2924 * Current statistics for PTS correction.
2925 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2926 * - encoding: unused
2928 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2929 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2930 int64_t pts_correction_last_pts; /// PTS of the last frame
2931 int64_t pts_correction_last_dts; /// DTS of the last frame
2934 * Character encoding of the input subtitles file.
2935 * - decoding: set by user
2936 * - encoding: unused
2941 * Subtitles character encoding mode. Formats or codecs might be adjusting
2942 * this setting (if they are doing the conversion themselves for instance).
2943 * - decoding: set by libavcodec
2944 * - encoding: unused
2946 int sub_charenc_mode;
2947 #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)
2948 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
2949 #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
2952 * Skip processing alpha if supported by codec.
2953 * Note that if the format uses pre-multiplied alpha (common with VP6,
2954 * and recommended due to better video quality/compression)
2955 * the image will look as if alpha-blended onto a black background.
2956 * However for formats that do not use pre-multiplied alpha
2957 * there might be serious artefacts (though e.g. libswscale currently
2958 * assumes pre-multiplied alpha anyway).
2959 * Code outside libavcodec should access this field using AVOptions
2961 * - decoding: set by user
2962 * - encoding: unused
2967 * Number of samples to skip after a discontinuity
2968 * - decoding: unused
2969 * - encoding: set by libavcodec
2973 #if !FF_API_DEBUG_MV
2975 * debug motion vectors
2976 * Code outside libavcodec should access this field using AVOptions
2977 * - encoding: Set by user.
2978 * - decoding: Set by user.
2981 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2982 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2983 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2987 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
2988 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
2990 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
2991 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
2993 int av_codec_get_lowres(const AVCodecContext *avctx);
2994 void av_codec_set_lowres(AVCodecContext *avctx, int val);
2996 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
2997 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3002 typedef struct AVProfile {
3004 const char *name; ///< short name for the profile
3007 typedef struct AVCodecDefault AVCodecDefault;
3014 typedef struct AVCodec {
3016 * Name of the codec implementation.
3017 * The name is globally unique among encoders and among decoders (but an
3018 * encoder and a decoder can share the same name).
3019 * This is the primary way to find a codec from the user perspective.
3023 * Descriptive name for the codec, meant to be more human readable than name.
3024 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3026 const char *long_name;
3027 enum AVMediaType type;
3030 * Codec capabilities.
3034 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3035 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3036 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3037 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3038 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3040 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3042 const AVClass *priv_class; ///< AVClass for the private context
3043 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3045 /*****************************************************************
3046 * No fields below this line are part of the public API. They
3047 * may not be used outside of libavcodec and can be changed and
3049 * New public fields should be added right above.
3050 *****************************************************************
3053 struct AVCodec *next;
3055 * @name Frame-level threading support functions
3059 * If defined, called on thread contexts when they are created.
3060 * If the codec allocates writable tables in init(), re-allocate them here.
3061 * priv_data will be set to a copy of the original.
3063 int (*init_thread_copy)(AVCodecContext *);
3065 * Copy necessary context variables from a previous thread context to the current one.
3066 * If not defined, the next thread will start automatically; otherwise, the codec
3067 * must call ff_thread_finish_setup().
3069 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3071 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3075 * Private codec-specific defaults.
3077 const AVCodecDefault *defaults;
3080 * Initialize codec static data, called from avcodec_register().
3082 void (*init_static_data)(struct AVCodec *codec);
3084 int (*init)(AVCodecContext *);
3085 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3086 const struct AVSubtitle *sub);
3088 * Encode data to an AVPacket.
3090 * @param avctx codec context
3091 * @param avpkt output AVPacket (may contain a user-provided buffer)
3092 * @param[in] frame AVFrame containing the raw data to be encoded
3093 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3094 * non-empty packet was returned in avpkt.
3095 * @return 0 on success, negative error code on failure
3097 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3098 int *got_packet_ptr);
3099 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3100 int (*close)(AVCodecContext *);
3103 * Will be called when seeking
3105 void (*flush)(AVCodecContext *);
3108 int av_codec_get_max_lowres(const AVCodec *codec);
3110 struct MpegEncContext;
3115 typedef struct AVHWAccel {
3117 * Name of the hardware accelerated codec.
3118 * The name is globally unique among encoders and among decoders (but an
3119 * encoder and a decoder can share the same name).
3124 * Type of codec implemented by the hardware accelerator.
3126 * See AVMEDIA_TYPE_xxx
3128 enum AVMediaType type;
3131 * Codec implemented by the hardware accelerator.
3133 * See AV_CODEC_ID_xxx
3138 * Supported pixel format.
3140 * Only hardware accelerated formats are supported here.
3142 enum AVPixelFormat pix_fmt;
3145 * Hardware accelerated codec capabilities.
3146 * see FF_HWACCEL_CODEC_CAP_*
3150 struct AVHWAccel *next;
3153 * Called at the beginning of each frame or field picture.
3155 * Meaningful frame information (codec specific) is guaranteed to
3156 * be parsed at this point. This function is mandatory.
3158 * Note that buf can be NULL along with buf_size set to 0.
3159 * Otherwise, this means the whole frame is available at this point.
3161 * @param avctx the codec context
3162 * @param buf the frame data buffer base
3163 * @param buf_size the size of the frame in bytes
3164 * @return zero if successful, a negative value otherwise
3166 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3169 * Callback for each slice.
3171 * Meaningful slice information (codec specific) is guaranteed to
3172 * be parsed at this point. This function is mandatory.
3173 * The only exception is XvMC, that works on MB level.
3175 * @param avctx the codec context
3176 * @param buf the slice data buffer base
3177 * @param buf_size the size of the slice in bytes
3178 * @return zero if successful, a negative value otherwise
3180 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3183 * Called at the end of each frame or field picture.
3185 * The whole picture is parsed at this point and can now be sent
3186 * to the hardware accelerator. This function is mandatory.
3188 * @param avctx the codec context
3189 * @return zero if successful, a negative value otherwise
3191 int (*end_frame)(AVCodecContext *avctx);
3194 * Size of HW accelerator private data.
3196 * Private data is allocated with av_mallocz() before
3197 * AVCodecContext.get_buffer() and deallocated after
3198 * AVCodecContext.release_buffer().
3203 * Called for every Macroblock in a slice.
3205 * XvMC uses it to replace the ff_MPV_decode_mb().
3206 * Instead of decoding to raw picture, MB parameters are
3207 * stored in an array provided by the video driver.
3209 * @param s the mpeg context
3211 void (*decode_mb)(struct MpegEncContext *s);
3215 * @defgroup lavc_picture AVPicture
3217 * Functions for working with AVPicture
3222 * Picture data structure.
3224 * Up to four components can be stored into it, the last component is
3227 typedef struct AVPicture {
3228 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3229 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3236 enum AVSubtitleType {
3239 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3242 * Plain text, the text field must be set by the decoder and is
3243 * authoritative. ass and pict fields may contain approximations.
3248 * Formatted text, the ass field must be set by the decoder and is
3249 * authoritative. pict and text fields may contain approximations.
3254 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3256 typedef struct AVSubtitleRect {
3257 int x; ///< top left corner of pict, undefined when pict is not set
3258 int y; ///< top left corner of pict, undefined when pict is not set
3259 int w; ///< width of pict, undefined when pict is not set
3260 int h; ///< height of pict, undefined when pict is not set
3261 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3264 * data+linesize for the bitmap of this subtitle.
3265 * can be set for text/ass as well once they where rendered
3268 enum AVSubtitleType type;
3270 char *text; ///< 0 terminated plain UTF-8 text
3273 * 0 terminated ASS/SSA compatible event line.
3274 * The presentation of this is unaffected by the other values in this
3282 typedef struct AVSubtitle {
3283 uint16_t format; /* 0 = graphics */
3284 uint32_t start_display_time; /* relative to packet pts, in ms */
3285 uint32_t end_display_time; /* relative to packet pts, in ms */
3287 AVSubtitleRect **rects;
3288 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3292 * If c is NULL, returns the first registered codec,
3293 * if c is non-NULL, returns the next registered codec after c,
3294 * or NULL if c is the last one.
3296 AVCodec *av_codec_next(const AVCodec *c);
3299 * Return the LIBAVCODEC_VERSION_INT constant.
3301 unsigned avcodec_version(void);
3304 * Return the libavcodec build-time configuration.
3306 const char *avcodec_configuration(void);
3309 * Return the libavcodec license.
3311 const char *avcodec_license(void);
3314 * Register the codec codec and initialize libavcodec.
3316 * @warning either this function or avcodec_register_all() must be called
3317 * before any other libavcodec functions.
3319 * @see avcodec_register_all()
3321 void avcodec_register(AVCodec *codec);
3324 * Register all the codecs, parsers and bitstream filters which were enabled at
3325 * configuration time. If you do not call this function you can select exactly
3326 * which formats you want to support, by using the individual registration
3329 * @see avcodec_register
3330 * @see av_register_codec_parser
3331 * @see av_register_bitstream_filter
3333 void avcodec_register_all(void);
3336 * Allocate an AVCodecContext and set its fields to default values. The
3337 * resulting struct can be deallocated by calling avcodec_close() on it followed
3340 * @param codec if non-NULL, allocate private data and initialize defaults
3341 * for the given codec. It is illegal to then call avcodec_open2()
3342 * with a different codec.
3343 * If NULL, then the codec-specific defaults won't be initialized,
3344 * which may result in suboptimal default settings (this is
3345 * important mainly for encoders, e.g. libx264).
3347 * @return An AVCodecContext filled with default values or NULL on failure.
3348 * @see avcodec_get_context_defaults
3350 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3353 * Set the fields of the given AVCodecContext to default values corresponding
3354 * to the given codec (defaults may be codec-dependent).
3356 * Do not call this function if a non-NULL codec has been passed
3357 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3358 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3359 * different codec on this AVCodecContext.
3361 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3364 * Get the AVClass for AVCodecContext. It can be used in combination with
3365 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3367 * @see av_opt_find().
3369 const AVClass *avcodec_get_class(void);
3372 * Get the AVClass for AVFrame. It can be used in combination with
3373 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3375 * @see av_opt_find().
3377 const AVClass *avcodec_get_frame_class(void);
3380 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3381 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3383 * @see av_opt_find().
3385 const AVClass *avcodec_get_subtitle_rect_class(void);
3388 * Copy the settings of the source AVCodecContext into the destination
3389 * AVCodecContext. The resulting destination codec context will be
3390 * unopened, i.e. you are required to call avcodec_open2() before you
3391 * can use this AVCodecContext to decode/encode video/audio data.
3393 * @param dest target codec context, should be initialized with
3394 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3395 * @param src source codec context
3396 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3398 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3400 #if FF_API_AVFRAME_LAVC
3402 * @deprecated use av_frame_alloc()
3404 attribute_deprecated
3405 AVFrame *avcodec_alloc_frame(void);
3408 * Set the fields of the given AVFrame to default values.
3410 * @param frame The AVFrame of which the fields should be set to default values.
3412 * @deprecated use av_frame_unref()
3414 attribute_deprecated
3415 void avcodec_get_frame_defaults(AVFrame *frame);
3418 * Free the frame and any dynamically allocated objects in it,
3419 * e.g. extended_data.
3421 * @param frame frame to be freed. The pointer will be set to NULL.
3423 * @warning this function does NOT free the data buffers themselves
3424 * (it does not know how, since they might have been allocated with
3425 * a custom get_buffer()).
3427 * @deprecated use av_frame_free()
3429 attribute_deprecated
3430 void avcodec_free_frame(AVFrame **frame);
3434 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3435 * function the context has to be allocated with avcodec_alloc_context3().
3437 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3438 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3439 * retrieving a codec.
3441 * @warning This function is not thread safe!
3444 * avcodec_register_all();
3445 * av_dict_set(&opts, "b", "2.5M", 0);
3446 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3450 * context = avcodec_alloc_context3(codec);
3452 * if (avcodec_open2(context, codec, opts) < 0)
3456 * @param avctx The context to initialize.
3457 * @param codec The codec to open this context for. If a non-NULL codec has been
3458 * previously passed to avcodec_alloc_context3() or
3459 * avcodec_get_context_defaults3() for this context, then this
3460 * parameter MUST be either NULL or equal to the previously passed
3462 * @param options A dictionary filled with AVCodecContext and codec-private options.
3463 * On return this object will be filled with options that were not found.
3465 * @return zero on success, a negative value on error
3466 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3467 * av_dict_set(), av_opt_find().
3469 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3472 * Close a given AVCodecContext and free all the data associated with it
3473 * (but not the AVCodecContext itself).
3475 * Calling this function on an AVCodecContext that hasn't been opened will free
3476 * the codec-specific data allocated in avcodec_alloc_context3() /
3477 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3480 int avcodec_close(AVCodecContext *avctx);
3483 * Free all allocated data in the given subtitle struct.
3485 * @param sub AVSubtitle to free.
3487 void avsubtitle_free(AVSubtitle *sub);
3494 * @addtogroup lavc_packet
3498 #if FF_API_DESTRUCT_PACKET
3500 * Default packet destructor.
3501 * @deprecated use the AVBuffer API instead
3503 attribute_deprecated
3504 void av_destruct_packet(AVPacket *pkt);
3508 * Initialize optional fields of a packet with default values.
3510 * Note, this does not touch the data and size members, which have to be
3511 * initialized separately.
3515 void av_init_packet(AVPacket *pkt);
3518 * Allocate the payload of a packet and initialize its fields with
3522 * @param size wanted payload size
3523 * @return 0 if OK, AVERROR_xxx otherwise
3525 int av_new_packet(AVPacket *pkt, int size);
3528 * Reduce packet size, correctly zeroing padding
3531 * @param size new size
3533 void av_shrink_packet(AVPacket *pkt, int size);
3536 * Increase packet size, correctly zeroing padding
3539 * @param grow_by number of bytes by which to increase the size of the packet
3541 int av_grow_packet(AVPacket *pkt, int grow_by);
3544 * Initialize a reference-counted packet from av_malloc()ed data.
3546 * @param pkt packet to be initialized. This function will set the data, size,
3547 * buf and destruct fields, all others are left untouched.
3548 * @param data Data allocated by av_malloc() to be used as packet data. If this
3549 * function returns successfully, the data is owned by the underlying AVBuffer.
3550 * The caller may not access the data through other means.
3551 * @param size size of data in bytes, without the padding. I.e. the full buffer
3552 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3554 * @return 0 on success, a negative AVERROR on error
3556 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3559 * @warning This is a hack - the packet memory allocation stuff is broken. The
3560 * packet is allocated if it was not really allocated.
3562 int av_dup_packet(AVPacket *pkt);
3565 * Copy packet, including contents
3567 * @return 0 on success, negative AVERROR on fail
3569 int av_copy_packet(AVPacket *dst, AVPacket *src);
3572 * Copy packet side data
3574 * @return 0 on success, negative AVERROR on fail
3576 int av_copy_packet_side_data(AVPacket *dst, AVPacket *src);
3581 * @param pkt packet to free
3583 void av_free_packet(AVPacket *pkt);
3586 * Allocate new information of a packet.
3589 * @param type side information type
3590 * @param size side information size
3591 * @return pointer to fresh allocated data or NULL otherwise
3593 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3597 * Shrink the already allocated side data buffer
3600 * @param type side information type
3601 * @param size new side information size
3602 * @return 0 on success, < 0 on failure
3604 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3608 * Get side information from packet.
3611 * @param type desired side information type
3612 * @param size pointer for side information size to store (optional)
3613 * @return pointer to data if present or NULL otherwise
3615 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3618 int av_packet_merge_side_data(AVPacket *pkt);
3620 int av_packet_split_side_data(AVPacket *pkt);
3623 * Pack a dictionary for use in side_data.
3625 * @param dict The dictionary to pack.
3626 * @param size pointer to store the size of the returned data
3627 * @return pointer to data if successful, NULL otherwise
3629 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
3631 * Unpack a dictionary from side_data.
3633 * @param data data from side_data
3634 * @param size size of the data
3635 * @param dict the metadata storage dictionary
3636 * @return 0 on success, < 0 on failure
3638 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
3642 * Convenience function to free all the side data stored.
3643 * All the other fields stay untouched.
3647 void av_packet_free_side_data(AVPacket *pkt);
3650 * Setup a new reference to the data described by a given packet
3652 * If src is reference-counted, setup dst as a new reference to the
3653 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3654 * data from src into it.
3656 * All the other fields are copied from src.
3658 * @see av_packet_unref
3660 * @param dst Destination packet
3661 * @param src Source packet
3663 * @return 0 on success, a negative AVERROR on error.
3665 int av_packet_ref(AVPacket *dst, AVPacket *src);
3670 * Unreference the buffer referenced by the packet and reset the
3671 * remaining packet fields to their default values.
3673 * @param pkt The packet to be unreferenced.
3675 void av_packet_unref(AVPacket *pkt);
3678 * Move every field in src to dst and reset src.
3680 * @see av_packet_unref
3682 * @param src Source packet, will be reset
3683 * @param dst Destination packet
3685 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3688 * Copy only "properties" fields from src to dst.
3690 * Properties for the purpose of this function are all the fields
3691 * beside those related to the packet data (buf, data, size)
3693 * @param dst Destination packet
3694 * @param src Source packet
3696 * @return 0 on success AVERROR on failure.
3699 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3706 * @addtogroup lavc_decoding
3711 * Find a registered decoder with a matching codec ID.
3713 * @param id AVCodecID of the requested decoder
3714 * @return A decoder if one was found, NULL otherwise.
3716 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3719 * Find a registered decoder with the specified name.
3721 * @param name name of the requested decoder
3722 * @return A decoder if one was found, NULL otherwise.
3724 AVCodec *avcodec_find_decoder_by_name(const char *name);
3726 #if FF_API_GET_BUFFER
3727 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3728 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3729 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3733 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3734 * it can be called by custom get_buffer2() implementations for decoders without
3735 * CODEC_CAP_DR1 set.
3737 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3740 * Return the amount of padding in pixels which the get_buffer callback must
3741 * provide around the edge of the image for codecs which do not have the
3742 * CODEC_FLAG_EMU_EDGE flag.
3744 * @return Required padding in pixels.
3746 unsigned avcodec_get_edge_width(void);
3749 * Modify width and height values so that they will result in a memory
3750 * buffer that is acceptable for the codec if you do not use any horizontal
3753 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3754 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3755 * according to avcodec_get_edge_width() before.
3757 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3760 * Modify width and height values so that they will result in a memory
3761 * buffer that is acceptable for the codec if you also ensure that all
3762 * line sizes are a multiple of the respective linesize_align[i].
3764 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3765 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3766 * according to avcodec_get_edge_width() before.
3768 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3769 int linesize_align[AV_NUM_DATA_POINTERS]);
3772 * Converts AVChromaLocation to swscale x/y chroma position.
3774 * The positions represent the chroma (0,0) position in a coordinates system
3775 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3777 * @param xpos horizontal chroma sample position
3778 * @param ypos vertical chroma sample position
3780 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
3783 * Converts swscale x/y chroma position to AVChromaLocation.
3785 * The positions represent the chroma (0,0) position in a coordinates system
3786 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3788 * @param xpos horizontal chroma sample position
3789 * @param ypos vertical chroma sample position
3791 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
3793 #if FF_API_OLD_DECODE_AUDIO
3795 * Wrapper function which calls avcodec_decode_audio4.
3797 * @deprecated Use avcodec_decode_audio4 instead.
3799 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3800 * Some decoders may support multiple frames in a single AVPacket, such
3801 * decoders would then just decode the first frame. In this case,
3802 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3803 * the remaining data in order to decode the second frame etc.
3805 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3806 * decompressed frame size in bytes.
3808 * @warning You must set frame_size_ptr to the allocated size of the
3809 * output buffer before calling avcodec_decode_audio3().
3811 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3812 * the actual read bytes because some optimized bitstream readers read 32 or 64
3813 * bits at once and could read over the end.
3815 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3816 * no overreading happens for damaged MPEG streams.
3818 * @warning You must not provide a custom get_buffer() when using
3819 * avcodec_decode_audio3(). Doing so will override it with
3820 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3821 * which does allow the application to provide a custom get_buffer().
3823 * @note You might have to align the input buffer avpkt->data and output buffer
3824 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3825 * necessary at all, on others it won't work at all if not aligned and on others
3826 * it will work but it will have an impact on performance.
3828 * In practice, avpkt->data should have 4 byte alignment at minimum and
3829 * samples should be 16 byte aligned unless the CPU doesn't need it
3830 * (AltiVec and SSE do).
3832 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3833 * between input and output, these need to be fed with avpkt->data=NULL,
3834 * avpkt->size=0 at the end to return the remaining frames.
3836 * @param avctx the codec context
3837 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3838 * If the sample format is planar, each channel plane will
3839 * be the same size, with no padding between channels.
3840 * @param[in,out] frame_size_ptr the output buffer size in bytes
3841 * @param[in] avpkt The input AVPacket containing the input buffer.
3842 * You can create such packet with av_init_packet() and by then setting
3843 * data and size, some decoders might in addition need other fields.
3844 * All decoders are designed to use the least fields possible though.
3845 * @return On error a negative value is returned, otherwise the number of bytes
3846 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3848 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3849 int *frame_size_ptr,
3854 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3856 * Some decoders may support multiple frames in a single AVPacket. Such
3857 * decoders would then just decode the first frame and the return value would be
3858 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3859 * called again with an AVPacket containing the remaining data in order to
3860 * decode the second frame, etc... Even if no frames are returned, the packet
3861 * needs to be fed to the decoder with remaining data until it is completely
3862 * consumed or an error occurs.
3864 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3865 * and output. This means that for some packets they will not immediately
3866 * produce decoded output and need to be flushed at the end of decoding to get
3867 * all the decoded data. Flushing is done by calling this function with packets
3868 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3869 * returning samples. It is safe to flush even those decoders that are not
3870 * marked with CODEC_CAP_DELAY, then no samples will be returned.
3872 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3873 * larger than the actual read bytes because some optimized bitstream
3874 * readers read 32 or 64 bits at once and could read over the end.
3876 * @param avctx the codec context
3877 * @param[out] frame The AVFrame in which to store decoded audio samples.
3878 * The decoder will allocate a buffer for the decoded frame by
3879 * calling the AVCodecContext.get_buffer2() callback.
3880 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3881 * reference counted and the returned reference belongs to the
3882 * caller. The caller must release the frame using av_frame_unref()
3883 * when the frame is no longer needed. The caller may safely write
3884 * to the frame if av_frame_is_writable() returns 1.
3885 * When AVCodecContext.refcounted_frames is set to 0, the returned
3886 * reference belongs to the decoder and is valid only until the
3887 * next call to this function or until closing or flushing the
3888 * decoder. The caller may not write to it.
3889 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3890 * non-zero. Note that this field being set to zero
3891 * does not mean that an error has occurred. For
3892 * decoders with CODEC_CAP_DELAY set, no given decode
3893 * call is guaranteed to produce a frame.
3894 * @param[in] avpkt The input AVPacket containing the input buffer.
3895 * At least avpkt->data and avpkt->size should be set. Some
3896 * decoders might also require additional fields to be set.
3897 * @return A negative error code is returned if an error occurred during
3898 * decoding, otherwise the number of bytes consumed from the input
3899 * AVPacket is returned.
3901 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3902 int *got_frame_ptr, const AVPacket *avpkt);
3905 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3906 * Some decoders may support multiple frames in a single AVPacket, such
3907 * decoders would then just decode the first frame.
3909 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3910 * the actual read bytes because some optimized bitstream readers read 32 or 64
3911 * bits at once and could read over the end.
3913 * @warning The end of the input buffer buf should be set to 0 to ensure that
3914 * no overreading happens for damaged MPEG streams.
3916 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3917 * between input and output, these need to be fed with avpkt->data=NULL,
3918 * avpkt->size=0 at the end to return the remaining frames.
3920 * @param avctx the codec context
3921 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3922 * Use av_frame_alloc() to get an AVFrame. The codec will
3923 * allocate memory for the actual bitmap by calling the
3924 * AVCodecContext.get_buffer2() callback.
3925 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3926 * reference counted and the returned reference belongs to the
3927 * caller. The caller must release the frame using av_frame_unref()
3928 * when the frame is no longer needed. The caller may safely write
3929 * to the frame if av_frame_is_writable() returns 1.
3930 * When AVCodecContext.refcounted_frames is set to 0, the returned
3931 * reference belongs to the decoder and is valid only until the
3932 * next call to this function or until closing or flushing the
3933 * decoder. The caller may not write to it.
3935 * @param[in] avpkt The input AVPacket containing the input buffer.
3936 * You can create such packet with av_init_packet() and by then setting
3937 * data and size, some decoders might in addition need other fields like
3938 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3940 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3941 * @return On error a negative value is returned, otherwise the number of bytes
3942 * used or zero if no frame could be decompressed.
3944 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3945 int *got_picture_ptr,
3946 const AVPacket *avpkt);
3949 * Decode a subtitle message.
3950 * Return a negative value on error, otherwise return the number of bytes used.
3951 * If no subtitle could be decompressed, got_sub_ptr is zero.
3952 * Otherwise, the subtitle is stored in *sub.
3953 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3954 * simplicity, because the performance difference is expect to be negligible
3955 * and reusing a get_buffer written for video codecs would probably perform badly
3956 * due to a potentially very different allocation pattern.
3958 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3959 * and output. This means that for some packets they will not immediately
3960 * produce decoded output and need to be flushed at the end of decoding to get
3961 * all the decoded data. Flushing is done by calling this function with packets
3962 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3963 * returning subtitles. It is safe to flush even those decoders that are not
3964 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
3966 * @param avctx the codec context
3967 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3968 freed with avsubtitle_free if *got_sub_ptr is set.
3969 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3970 * @param[in] avpkt The input AVPacket containing the input buffer.
3972 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3977 * @defgroup lavc_parsing Frame parsing
3981 enum AVPictureStructure {
3982 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3983 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3984 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3985 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3988 typedef struct AVCodecParserContext {
3990 struct AVCodecParser *parser;
3991 int64_t frame_offset; /* offset of the current frame */
3992 int64_t cur_offset; /* current offset
3993 (incremented by each av_parser_parse()) */
3994 int64_t next_frame_offset; /* offset of the next frame */
3996 int pict_type; /* XXX: Put it back in AVCodecContext. */
3998 * This field is used for proper frame duration computation in lavf.
3999 * It signals, how much longer the frame duration of the current frame
4000 * is compared to normal frame duration.
4002 * frame_duration = (1 + repeat_pict) * time_base
4004 * It is used by codecs like H.264 to display telecined material.
4006 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4007 int64_t pts; /* pts of the current frame */
4008 int64_t dts; /* dts of the current frame */
4013 int fetch_timestamp;
4015 #define AV_PARSER_PTS_NB 4
4016 int cur_frame_start_index;
4017 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4018 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4019 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4022 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4023 #define PARSER_FLAG_ONCE 0x0002
4024 /// Set if the parser has a valid file offset
4025 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4026 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4028 int64_t offset; ///< byte offset from starting packet start
4029 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4032 * Set by parser to 1 for key frames and 0 for non-key frames.
4033 * It is initialized to -1, so if the parser doesn't set this flag,
4034 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4040 * Time difference in stream time base units from the pts of this
4041 * packet to the point at which the output from the decoder has converged
4042 * independent from the availability of previous frames. That is, the
4043 * frames are virtually identical no matter if decoding started from
4044 * the very first frame or from this keyframe.
4045 * Is AV_NOPTS_VALUE if unknown.
4046 * This field is not the display duration of the current frame.
4047 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4050 * The purpose of this field is to allow seeking in streams that have no
4051 * keyframes in the conventional sense. It corresponds to the
4052 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4053 * essential for some types of subtitle streams to ensure that all
4054 * subtitles are correctly displayed after seeking.
4056 int64_t convergence_duration;
4058 // Timestamp generation support:
4060 * Synchronization point for start of timestamp generation.
4062 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4065 * For example, this corresponds to presence of H.264 buffering period
4071 * Offset of the current timestamp against last timestamp sync point in
4072 * units of AVCodecContext.time_base.
4074 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4075 * contain a valid timestamp offset.
4077 * Note that the timestamp of sync point has usually a nonzero
4078 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4079 * the next frame after timestamp sync point will be usually 1.
4081 * For example, this corresponds to H.264 cpb_removal_delay.
4083 int dts_ref_dts_delta;
4086 * Presentation delay of current frame in units of AVCodecContext.time_base.
4088 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4089 * contain valid non-negative timestamp delta (presentation time of a frame
4090 * must not lie in the past).
4092 * This delay represents the difference between decoding and presentation
4093 * time of the frame.
4095 * For example, this corresponds to H.264 dpb_output_delay.
4100 * Position of the packet in file.
4102 * Analogous to cur_frame_pts/dts
4104 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4107 * Byte position of currently parsed frame in stream.
4112 * Previous frame byte position.
4117 * Duration of the current frame.
4118 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4119 * For all other types, this is in units of AVCodecContext.time_base.
4123 enum AVFieldOrder field_order;
4126 * Indicate whether a picture is coded as a frame, top field or bottom field.
4128 * For example, H.264 field_pic_flag equal to 0 corresponds to
4129 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4130 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4131 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4133 enum AVPictureStructure picture_structure;
4136 * Picture number incremented in presentation or output order.
4137 * This field may be reinitialized at the first picture of a new sequence.
4139 * For example, this corresponds to H.264 PicOrderCnt.
4141 int output_picture_number;
4142 } AVCodecParserContext;
4144 typedef struct AVCodecParser {
4145 int codec_ids[5]; /* several codec IDs are permitted */
4147 int (*parser_init)(AVCodecParserContext *s);
4148 int (*parser_parse)(AVCodecParserContext *s,
4149 AVCodecContext *avctx,
4150 const uint8_t **poutbuf, int *poutbuf_size,
4151 const uint8_t *buf, int buf_size);
4152 void (*parser_close)(AVCodecParserContext *s);
4153 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4154 struct AVCodecParser *next;
4157 AVCodecParser *av_parser_next(AVCodecParser *c);
4159 void av_register_codec_parser(AVCodecParser *parser);
4160 AVCodecParserContext *av_parser_init(int codec_id);
4165 * @param s parser context.
4166 * @param avctx codec context.
4167 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4168 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4169 * @param buf input buffer.
4170 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4171 * @param pts input presentation timestamp.
4172 * @param dts input decoding timestamp.
4173 * @param pos input byte position in stream.
4174 * @return the number of bytes of the input bitstream used.
4179 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4186 * decode_frame(data, size);
4190 int av_parser_parse2(AVCodecParserContext *s,
4191 AVCodecContext *avctx,
4192 uint8_t **poutbuf, int *poutbuf_size,
4193 const uint8_t *buf, int buf_size,
4194 int64_t pts, int64_t dts,
4198 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4199 * @deprecated use AVBitStreamFilter
4201 int av_parser_change(AVCodecParserContext *s,
4202 AVCodecContext *avctx,
4203 uint8_t **poutbuf, int *poutbuf_size,
4204 const uint8_t *buf, int buf_size, int keyframe);
4205 void av_parser_close(AVCodecParserContext *s);
4213 * @addtogroup lavc_encoding
4218 * Find a registered encoder with a matching codec ID.
4220 * @param id AVCodecID of the requested encoder
4221 * @return An encoder if one was found, NULL otherwise.
4223 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4226 * Find a registered encoder with the specified name.
4228 * @param name name of the requested encoder
4229 * @return An encoder if one was found, NULL otherwise.
4231 AVCodec *avcodec_find_encoder_by_name(const char *name);
4233 #if FF_API_OLD_ENCODE_AUDIO
4235 * Encode an audio frame from samples into buf.
4237 * @deprecated Use avcodec_encode_audio2 instead.
4239 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4240 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4241 * will know how much space is needed because it depends on the value passed
4242 * in buf_size as described below. In that case a lower value can be used.
4244 * @param avctx the codec context
4245 * @param[out] buf the output buffer
4246 * @param[in] buf_size the output buffer size
4247 * @param[in] samples the input buffer containing the samples
4248 * The number of samples read from this buffer is frame_size*channels,
4249 * both of which are defined in avctx.
4250 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4251 * samples read from samples is equal to:
4252 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4253 * This also implies that av_get_bits_per_sample() must not return 0 for these
4255 * @return On error a negative value is returned, on success zero or the number
4256 * of bytes used to encode the data read from the input buffer.
4258 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4259 uint8_t *buf, int buf_size,
4260 const short *samples);
4264 * Encode a frame of audio.
4266 * Takes input samples from frame and writes the next output packet, if
4267 * available, to avpkt. The output packet does not necessarily contain data for
4268 * the most recent frame, as encoders can delay, split, and combine input frames
4269 * internally as needed.
4271 * @param avctx codec context
4272 * @param avpkt output AVPacket.
4273 * The user can supply an output buffer by setting
4274 * avpkt->data and avpkt->size prior to calling the
4275 * function, but if the size of the user-provided data is not
4276 * large enough, encoding will fail. If avpkt->data and
4277 * avpkt->size are set, avpkt->destruct must also be set. All
4278 * other AVPacket fields will be reset by the encoder using
4279 * av_init_packet(). If avpkt->data is NULL, the encoder will
4280 * allocate it. The encoder will set avpkt->size to the size
4281 * of the output packet.
4283 * If this function fails or produces no output, avpkt will be
4284 * freed using av_free_packet() (i.e. avpkt->destruct will be
4285 * called to free the user supplied buffer).
4286 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4287 * May be NULL when flushing an encoder that has the
4288 * CODEC_CAP_DELAY capability set.
4289 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4290 * can have any number of samples.
4291 * If it is not set, frame->nb_samples must be equal to
4292 * avctx->frame_size for all frames except the last.
4293 * The final frame may be smaller than avctx->frame_size.
4294 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4295 * output packet is non-empty, and to 0 if it is
4296 * empty. If the function returns an error, the
4297 * packet can be assumed to be invalid, and the
4298 * value of got_packet_ptr is undefined and should
4300 * @return 0 on success, negative error code on failure
4302 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4303 const AVFrame *frame, int *got_packet_ptr);
4305 #if FF_API_OLD_ENCODE_VIDEO
4307 * @deprecated use avcodec_encode_video2() instead.
4309 * Encode a video frame from pict into buf.
4310 * The input picture should be
4311 * stored using a specific format, namely avctx.pix_fmt.
4313 * @param avctx the codec context
4314 * @param[out] buf the output buffer for the bitstream of encoded frame
4315 * @param[in] buf_size the size of the output buffer in bytes
4316 * @param[in] pict the input picture to encode
4317 * @return On error a negative value is returned, on success zero or the number
4318 * of bytes used from the output buffer.
4320 attribute_deprecated
4321 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4322 const AVFrame *pict);
4326 * Encode a frame of video.
4328 * Takes input raw video data from frame and writes the next output packet, if
4329 * available, to avpkt. The output packet does not necessarily contain data for
4330 * the most recent frame, as encoders can delay and reorder input frames
4331 * internally as needed.
4333 * @param avctx codec context
4334 * @param avpkt output AVPacket.
4335 * The user can supply an output buffer by setting
4336 * avpkt->data and avpkt->size prior to calling the
4337 * function, but if the size of the user-provided data is not
4338 * large enough, encoding will fail. All other AVPacket fields
4339 * will be reset by the encoder using av_init_packet(). If
4340 * avpkt->data is NULL, the encoder will allocate it.
4341 * The encoder will set avpkt->size to the size of the
4342 * output packet. The returned data (if any) belongs to the
4343 * caller, he is responsible for freeing it.
4345 * If this function fails or produces no output, avpkt will be
4346 * freed using av_free_packet() (i.e. avpkt->destruct will be
4347 * called to free the user supplied buffer).
4348 * @param[in] frame AVFrame containing the raw video data to be encoded.
4349 * May be NULL when flushing an encoder that has the
4350 * CODEC_CAP_DELAY capability set.
4351 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4352 * output packet is non-empty, and to 0 if it is
4353 * empty. If the function returns an error, the
4354 * packet can be assumed to be invalid, and the
4355 * value of got_packet_ptr is undefined and should
4357 * @return 0 on success, negative error code on failure
4359 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4360 const AVFrame *frame, int *got_packet_ptr);
4362 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4363 const AVSubtitle *sub);
4370 #if FF_API_AVCODEC_RESAMPLE
4372 * @defgroup lavc_resample Audio resampling
4374 * @deprecated use libswresample instead
4378 struct ReSampleContext;
4379 struct AVResampleContext;
4381 typedef struct ReSampleContext ReSampleContext;
4384 * Initialize audio resampling context.
4386 * @param output_channels number of output channels
4387 * @param input_channels number of input channels
4388 * @param output_rate output sample rate
4389 * @param input_rate input sample rate
4390 * @param sample_fmt_out requested output sample format
4391 * @param sample_fmt_in input sample format
4392 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4393 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4394 * @param linear if 1 then the used FIR filter will be linearly interpolated
4395 between the 2 closest, if 0 the closest will be used
4396 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4397 * @return allocated ReSampleContext, NULL if error occurred
4399 attribute_deprecated
4400 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4401 int output_rate, int input_rate,
4402 enum AVSampleFormat sample_fmt_out,
4403 enum AVSampleFormat sample_fmt_in,
4404 int filter_length, int log2_phase_count,
4405 int linear, double cutoff);
4407 attribute_deprecated
4408 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4411 * Free resample context.
4413 * @param s a non-NULL pointer to a resample context previously
4414 * created with av_audio_resample_init()
4416 attribute_deprecated
4417 void audio_resample_close(ReSampleContext *s);
4421 * Initialize an audio resampler.
4422 * Note, if either rate is not an integer then simply scale both rates up so they are.
4423 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4424 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4425 * @param linear If 1 then the used FIR filter will be linearly interpolated
4426 between the 2 closest, if 0 the closest will be used
4427 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4429 attribute_deprecated
4430 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4433 * Resample an array of samples using a previously configured context.
4434 * @param src an array of unconsumed samples
4435 * @param consumed the number of samples of src which have been consumed are returned here
4436 * @param src_size the number of unconsumed samples available
4437 * @param dst_size the amount of space in samples available in dst
4438 * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
4439 * @return the number of samples written in dst or -1 if an error occurred
4441 attribute_deprecated
4442 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4446 * Compensate samplerate/timestamp drift. The compensation is done by changing
4447 * the resampler parameters, so no audible clicks or similar distortions occur
4448 * @param compensation_distance distance in output samples over which the compensation should be performed
4449 * @param sample_delta number of output samples which should be output less
4451 * example: av_resample_compensate(c, 10, 500)
4452 * here instead of 510 samples only 500 samples would be output
4454 * note, due to rounding the actual compensation might be slightly different,
4455 * especially if the compensation_distance is large and the in_rate used during init is small
4457 attribute_deprecated
4458 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4459 attribute_deprecated
4460 void av_resample_close(struct AVResampleContext *c);
4468 * @addtogroup lavc_picture
4473 * Allocate memory for the pixels of a picture and setup the AVPicture
4476 * Call avpicture_free() to free it.
4478 * @param picture the picture structure to be filled in
4479 * @param pix_fmt the pixel format of the picture
4480 * @param width the width of the picture
4481 * @param height the height of the picture
4482 * @return zero if successful, a negative error code otherwise
4484 * @see av_image_alloc(), avpicture_fill()
4486 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4489 * Free a picture previously allocated by avpicture_alloc().
4490 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4493 * @param picture the AVPicture to be freed
4495 void avpicture_free(AVPicture *picture);
4498 * Setup the picture fields based on the specified image parameters
4499 * and the provided image data buffer.
4501 * The picture fields are filled in by using the image data buffer
4502 * pointed to by ptr.
4504 * If ptr is NULL, the function will fill only the picture linesize
4505 * array and return the required size for the image buffer.
4507 * To allocate an image buffer and fill the picture data in one call,
4508 * use avpicture_alloc().
4510 * @param picture the picture to be filled in
4511 * @param ptr buffer where the image data is stored, or NULL
4512 * @param pix_fmt the pixel format of the image
4513 * @param width the width of the image in pixels
4514 * @param height the height of the image in pixels
4515 * @return the size in bytes required for src, a negative error code
4516 * in case of failure
4518 * @see av_image_fill_arrays()
4520 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4521 enum AVPixelFormat pix_fmt, int width, int height);
4524 * Copy pixel data from an AVPicture into a buffer.
4526 * avpicture_get_size() can be used to compute the required size for
4527 * the buffer to fill.
4529 * @param src source picture with filled data
4530 * @param pix_fmt picture pixel format
4531 * @param width picture width
4532 * @param height picture height
4533 * @param dest destination buffer
4534 * @param dest_size destination buffer size in bytes
4535 * @return the number of bytes written to dest, or a negative value
4536 * (error code) on error, for example if the destination buffer is not
4539 * @see av_image_copy_to_buffer()
4541 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4542 int width, int height,
4543 unsigned char *dest, int dest_size);
4546 * Calculate the size in bytes that a picture of the given width and height
4547 * would occupy if stored in the given picture format.
4549 * @param pix_fmt picture pixel format
4550 * @param width picture width
4551 * @param height picture height
4552 * @return the computed picture buffer size or a negative error code
4555 * @see av_image_get_buffer_size().
4557 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4559 #if FF_API_DEINTERLACE
4561 * deinterlace - if not supported return -1
4563 * @deprecated - use yadif (in libavfilter) instead
4565 attribute_deprecated
4566 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4567 enum AVPixelFormat pix_fmt, int width, int height);
4570 * Copy image src to dst. Wraps av_image_copy().
4572 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4573 enum AVPixelFormat pix_fmt, int width, int height);
4576 * Crop image top and left side.
4578 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4579 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4584 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4585 int padtop, int padbottom, int padleft, int padright, int *color);
4592 * @defgroup lavc_misc Utility functions
4595 * Miscellaneous utility functions related to both encoding and decoding
4601 * @defgroup lavc_misc_pixfmt Pixel formats
4603 * Functions for working with pixel formats.
4608 * Utility function to access log2_chroma_w log2_chroma_h from
4609 * the pixel format AVPixFmtDescriptor.
4611 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4612 * for one that returns a failure code and continues in case of invalid
4615 * @param[in] pix_fmt the pixel format
4616 * @param[out] h_shift store log2_chroma_w
4617 * @param[out] v_shift store log2_chroma_h
4619 * @see av_pix_fmt_get_chroma_sub_sample
4622 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4625 * Return a value representing the fourCC code associated to the
4626 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4629 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4631 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4632 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4633 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4634 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4635 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4636 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4639 * Compute what kind of losses will occur when converting from one specific
4640 * pixel format to another.
4641 * When converting from one pixel format to another, information loss may occur.
4642 * For example, when converting from RGB24 to GRAY, the color information will
4643 * be lost. Similarly, other losses occur when converting from some formats to
4644 * other formats. These losses can involve loss of chroma, but also loss of
4645 * resolution, loss of color depth, loss due to the color space conversion, loss
4646 * of the alpha bits or loss due to color quantization.
4647 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4648 * which will occur when converting from one pixel format to another.
4650 * @param[in] dst_pix_fmt destination pixel format
4651 * @param[in] src_pix_fmt source pixel format
4652 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4653 * @return Combination of flags informing you what kind of losses will occur
4654 * (maximum loss for an invalid dst_pix_fmt).
4656 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4660 * Find the best pixel format to convert to given a certain source pixel
4661 * format. When converting from one pixel format to another, information loss
4662 * may occur. For example, when converting from RGB24 to GRAY, the color
4663 * information will be lost. Similarly, other losses occur when converting from
4664 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4665 * the given pixel formats should be used to suffer the least amount of loss.
4666 * The pixel formats from which it chooses one, are determined by the
4667 * pix_fmt_list parameter.
4670 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4671 * @param[in] src_pix_fmt source pixel format
4672 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4673 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4674 * @return The best pixel format to convert to or -1 if none was found.
4676 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4677 enum AVPixelFormat src_pix_fmt,
4678 int has_alpha, int *loss_ptr);
4681 * Find the best pixel format to convert to given a certain source pixel
4682 * format and a selection of two destination pixel formats. When converting from
4683 * one pixel format to another, information loss may occur. For example, when converting
4684 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4685 * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4686 * the given pixel formats should be used to suffer the least amount of loss.
4688 * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be
4692 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4693 * dst_pix_fmt1= AV_PIX_FMT_RGB24;
4694 * dst_pix_fmt2= AV_PIX_FMT_GRAY8;
4695 * dst_pix_fmt3= AV_PIX_FMT_RGB8;
4696 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4697 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4698 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4701 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4702 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4703 * @param[in] src_pix_fmt Source pixel format
4704 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4705 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4706 * NULL or value of zero means we care about all losses. Out: the loss
4707 * that occurs when converting from src to selected dst pixel format.
4708 * @return The best pixel format to convert to or -1 if none was found.
4710 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4711 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4713 attribute_deprecated
4714 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
4715 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
4716 enum AVPixelFormat src_pix_fmt,
4717 int has_alpha, int *loss_ptr);
4719 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4720 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4724 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4730 #if FF_API_SET_DIMENSIONS
4732 * @deprecated this function is not supposed to be used from outside of lavc
4734 attribute_deprecated
4735 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4739 * Put a string representing the codec tag codec_tag in buf.
4741 * @param buf_size size in bytes of buf
4742 * @return the length of the string that would have been generated if
4743 * enough space had been available, excluding the trailing null
4745 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4747 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4750 * Return a name for the specified profile, if available.
4752 * @param codec the codec that is searched for the given profile
4753 * @param profile the profile value for which a name is requested
4754 * @return A name for the profile if found, NULL otherwise.
4756 const char *av_get_profile_name(const AVCodec *codec, int profile);
4758 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4759 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4760 //FIXME func typedef
4763 * Fill AVFrame audio data and linesize pointers.
4765 * The buffer buf must be a preallocated buffer with a size big enough
4766 * to contain the specified samples amount. The filled AVFrame data
4767 * pointers will point to this buffer.
4769 * AVFrame extended_data channel pointers are allocated if necessary for
4772 * @param frame the AVFrame
4773 * frame->nb_samples must be set prior to calling the
4774 * function. This function fills in frame->data,
4775 * frame->extended_data, frame->linesize[0].
4776 * @param nb_channels channel count
4777 * @param sample_fmt sample format
4778 * @param buf buffer to use for frame data
4779 * @param buf_size size of buffer
4780 * @param align plane size sample alignment (0 = default)
4781 * @return >=0 on success, negative error code on failure
4782 * @todo return the size in bytes required to store the samples in
4783 * case of success, at the next libavutil bump
4785 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4786 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4787 int buf_size, int align);
4790 * Reset the internal decoder state / flush internal buffers. Should be called
4791 * e.g. when seeking or when switching to a different stream.
4793 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4794 * this invalidates the frames previously returned from the decoder. When
4795 * refcounted frames are used, the decoder just releases any references it might
4796 * keep internally, but the caller's reference remains valid.
4798 void avcodec_flush_buffers(AVCodecContext *avctx);
4801 * Return codec bits per sample.
4803 * @param[in] codec_id the codec
4804 * @return Number of bits per sample or zero if unknown for the given codec.
4806 int av_get_bits_per_sample(enum AVCodecID codec_id);
4809 * Return the PCM codec associated with a sample format.
4810 * @param be endianness, 0 for little, 1 for big,
4811 * -1 (or anything else) for native
4812 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4814 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4817 * Return codec bits per sample.
4818 * Only return non-zero if the bits per sample is exactly correct, not an
4821 * @param[in] codec_id the codec
4822 * @return Number of bits per sample or zero if unknown for the given codec.
4824 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4827 * Return audio frame duration.
4829 * @param avctx codec context
4830 * @param frame_bytes size of the frame, or 0 if unknown
4831 * @return frame duration, in samples, if known. 0 if not able to
4834 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4837 typedef struct AVBitStreamFilterContext {
4839 struct AVBitStreamFilter *filter;
4840 AVCodecParserContext *parser;
4841 struct AVBitStreamFilterContext *next;
4842 } AVBitStreamFilterContext;
4845 typedef struct AVBitStreamFilter {
4848 int (*filter)(AVBitStreamFilterContext *bsfc,
4849 AVCodecContext *avctx, const char *args,
4850 uint8_t **poutbuf, int *poutbuf_size,
4851 const uint8_t *buf, int buf_size, int keyframe);
4852 void (*close)(AVBitStreamFilterContext *bsfc);
4853 struct AVBitStreamFilter *next;
4854 } AVBitStreamFilter;
4857 * Register a bitstream filter.
4859 * The filter will be accessible to the application code through
4860 * av_bitstream_filter_next() or can be directly initialized with
4861 * av_bitstream_filter_init().
4863 * @see avcodec_register_all()
4865 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4868 * Create and initialize a bitstream filter context given a bitstream
4871 * The returned context must be freed with av_bitstream_filter_close().
4873 * @param name the name of the bitstream filter
4874 * @return a bitstream filter context if a matching filter was found
4875 * and successfully initialized, NULL otherwise
4877 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4882 * This function filters the buffer buf with size buf_size, and places the
4883 * filtered buffer in the buffer pointed to by poutbuf.
4885 * The output buffer must be freed by the caller.
4887 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
4888 * @param avctx AVCodecContext accessed by the filter, may be NULL.
4889 * If specified, this must point to the encoder context of the
4890 * output stream the packet is sent to.
4891 * @param args arguments which specify the filter configuration, may be NULL
4892 * @param poutbuf pointer which is updated to point to the filtered buffer
4893 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
4894 * @param buf buffer containing the data to filter
4895 * @param buf_size size in bytes of buf
4896 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
4897 * @return >= 0 in case of success, or a negative error code in case of failure
4899 * If the return value is positive, an output buffer is allocated and
4900 * is availble in *poutbuf, and is distinct from the input buffer.
4902 * If the return value is 0, the output buffer is not allocated and
4903 * should be considered identical to the input buffer, or in case
4904 * *poutbuf was set it points to the input buffer (not necessarily to
4905 * its starting address).
4907 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4908 AVCodecContext *avctx, const char *args,
4909 uint8_t **poutbuf, int *poutbuf_size,
4910 const uint8_t *buf, int buf_size, int keyframe);
4913 * Release bitstream filter context.
4915 * @param bsf the bitstream filter context created with
4916 * av_bitstream_filter_init(), can be NULL
4918 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4921 * If f is NULL, return the first registered bitstream filter,
4922 * if f is non-NULL, return the next registered bitstream filter
4923 * after f, or NULL if f is the last one.
4925 * This function can be used to iterate over all registered bitstream
4928 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4933 * Same behaviour av_fast_malloc but the buffer has additional
4934 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
4936 * In addition the whole buffer will initially and after resizes
4937 * be 0-initialized so that no uninitialized data will ever appear.
4939 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4942 * Same behaviour av_fast_padded_malloc except that buffer will always
4943 * be 0-initialized after call.
4945 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4948 * Encode extradata length to a buffer. Used by xiph codecs.
4950 * @param s buffer to write to; must be at least (v/255+1) bytes long
4951 * @param v size of extradata in bytes
4952 * @return number of bytes written to the buffer.
4954 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4956 #if FF_API_MISSING_SAMPLE
4958 * Log a generic warning message about a missing feature. This function is
4959 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4960 * only, and would normally not be used by applications.
4961 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4962 * a pointer to an AVClass struct
4963 * @param[in] feature string containing the name of the missing feature
4964 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4965 * If want_sample is non-zero, additional verbage will be added to the log
4966 * message which tells the user how to report samples to the development
4968 * @deprecated Use avpriv_report_missing_feature() instead.
4970 attribute_deprecated
4971 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4974 * Log a generic warning message asking for a sample. This function is
4975 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4976 * only, and would normally not be used by applications.
4977 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4978 * a pointer to an AVClass struct
4979 * @param[in] msg string containing an optional message, or NULL if no message
4980 * @deprecated Use avpriv_request_sample() instead.
4982 attribute_deprecated
4983 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4984 #endif /* FF_API_MISSING_SAMPLE */
4987 * Register the hardware accelerator hwaccel.
4989 void av_register_hwaccel(AVHWAccel *hwaccel);
4992 * If hwaccel is NULL, returns the first registered hardware accelerator,
4993 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4994 * after hwaccel, or NULL if hwaccel is the last one.
4996 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
5000 * Lock operation used by lockmgr
5003 AV_LOCK_CREATE, ///< Create a mutex
5004 AV_LOCK_OBTAIN, ///< Lock the mutex
5005 AV_LOCK_RELEASE, ///< Unlock the mutex
5006 AV_LOCK_DESTROY, ///< Free mutex resources
5010 * Register a user provided lock manager supporting the operations
5011 * specified by AVLockOp. mutex points to a (void *) where the
5012 * lockmgr should store/get a pointer to a user allocated mutex. It's
5013 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
5015 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
5016 * callback during the call to av_lockmgr_register().
5017 * Thus, the application must be prepared to handle that.
5018 * If cb is set to NULL the lockmgr will be unregistered.
5019 * Also note that during unregistration the previously registered
5020 * lockmgr callback may also be invoked.
5022 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5025 * Get the type of the given codec.
5027 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5030 * Get the name of a codec.
5031 * @return a static string identifying the codec; never NULL
5033 const char *avcodec_get_name(enum AVCodecID id);
5036 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5037 * with no corresponding avcodec_close()), 0 otherwise.
5039 int avcodec_is_open(AVCodecContext *s);
5042 * @return a non-zero number if codec is an encoder, zero otherwise
5044 int av_codec_is_encoder(const AVCodec *codec);
5047 * @return a non-zero number if codec is a decoder, zero otherwise
5049 int av_codec_is_decoder(const AVCodec *codec);
5052 * @return descriptor for given codec ID or NULL if no descriptor exists.
5054 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5057 * Iterate over all codec descriptors known to libavcodec.
5059 * @param prev previous descriptor. NULL to get the first descriptor.
5061 * @return next descriptor or NULL after the last descriptor
5063 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5066 * @return codec descriptor with the given name or NULL if no such descriptor
5069 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5075 #endif /* AVCODEC_AVCODEC_H */