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,
290 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
291 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
292 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
293 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
294 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
296 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
297 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
298 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
299 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
300 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
301 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
302 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
303 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
304 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
305 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
306 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
307 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
308 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
309 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
310 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
311 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
312 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
313 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
314 AV_CODEC_ID_SMVJPEG = MKBETAG('S','M','V','J'),
315 AV_CODEC_ID_HEVC = MKBETAG('H','2','6','5'),
316 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
318 /* various PCM "codecs" */
319 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
320 AV_CODEC_ID_PCM_S16LE = 0x10000,
321 AV_CODEC_ID_PCM_S16BE,
322 AV_CODEC_ID_PCM_U16LE,
323 AV_CODEC_ID_PCM_U16BE,
326 AV_CODEC_ID_PCM_MULAW,
327 AV_CODEC_ID_PCM_ALAW,
328 AV_CODEC_ID_PCM_S32LE,
329 AV_CODEC_ID_PCM_S32BE,
330 AV_CODEC_ID_PCM_U32LE,
331 AV_CODEC_ID_PCM_U32BE,
332 AV_CODEC_ID_PCM_S24LE,
333 AV_CODEC_ID_PCM_S24BE,
334 AV_CODEC_ID_PCM_U24LE,
335 AV_CODEC_ID_PCM_U24BE,
336 AV_CODEC_ID_PCM_S24DAUD,
337 AV_CODEC_ID_PCM_ZORK,
338 AV_CODEC_ID_PCM_S16LE_PLANAR,
340 AV_CODEC_ID_PCM_F32BE,
341 AV_CODEC_ID_PCM_F32LE,
342 AV_CODEC_ID_PCM_F64BE,
343 AV_CODEC_ID_PCM_F64LE,
344 AV_CODEC_ID_PCM_BLURAY,
347 AV_CODEC_ID_PCM_S8_PLANAR,
348 AV_CODEC_ID_PCM_S24LE_PLANAR_DEPRECATED,
349 AV_CODEC_ID_PCM_S32LE_PLANAR_DEPRECATED,
350 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
351 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
352 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
354 /* various ADPCM codecs */
355 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
356 AV_CODEC_ID_ADPCM_IMA_WAV,
357 AV_CODEC_ID_ADPCM_IMA_DK3,
358 AV_CODEC_ID_ADPCM_IMA_DK4,
359 AV_CODEC_ID_ADPCM_IMA_WS,
360 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
361 AV_CODEC_ID_ADPCM_MS,
362 AV_CODEC_ID_ADPCM_4XM,
363 AV_CODEC_ID_ADPCM_XA,
364 AV_CODEC_ID_ADPCM_ADX,
365 AV_CODEC_ID_ADPCM_EA,
366 AV_CODEC_ID_ADPCM_G726,
367 AV_CODEC_ID_ADPCM_CT,
368 AV_CODEC_ID_ADPCM_SWF,
369 AV_CODEC_ID_ADPCM_YAMAHA,
370 AV_CODEC_ID_ADPCM_SBPRO_4,
371 AV_CODEC_ID_ADPCM_SBPRO_3,
372 AV_CODEC_ID_ADPCM_SBPRO_2,
373 AV_CODEC_ID_ADPCM_THP,
374 AV_CODEC_ID_ADPCM_IMA_AMV,
375 AV_CODEC_ID_ADPCM_EA_R1,
376 AV_CODEC_ID_ADPCM_EA_R3,
377 AV_CODEC_ID_ADPCM_EA_R2,
378 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
379 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
380 AV_CODEC_ID_ADPCM_EA_XAS,
381 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
382 AV_CODEC_ID_ADPCM_IMA_ISS,
383 AV_CODEC_ID_ADPCM_G722,
384 AV_CODEC_ID_ADPCM_IMA_APC,
385 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
386 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
387 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
388 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
389 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
390 AV_CODEC_ID_ADPCM_G726LE = MKBETAG('6','2','7','G'),
393 AV_CODEC_ID_AMR_NB = 0x12000,
396 /* RealAudio codecs*/
397 AV_CODEC_ID_RA_144 = 0x13000,
400 /* various DPCM codecs */
401 AV_CODEC_ID_ROQ_DPCM = 0x14000,
402 AV_CODEC_ID_INTERPLAY_DPCM,
403 AV_CODEC_ID_XAN_DPCM,
404 AV_CODEC_ID_SOL_DPCM,
407 AV_CODEC_ID_MP2 = 0x15000,
408 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
418 AV_CODEC_ID_VMDAUDIO,
424 AV_CODEC_ID_WESTWOOD_SND1,
425 AV_CODEC_ID_GSM, ///< as in Berlin toast format
428 AV_CODEC_ID_TRUESPEECH,
430 AV_CODEC_ID_SMACKAUDIO,
433 AV_CODEC_ID_DSICINAUDIO,
435 AV_CODEC_ID_MUSEPACK7,
437 AV_CODEC_ID_GSM_MS, /* as found in WAV */
443 AV_CODEC_ID_NELLYMOSER,
444 AV_CODEC_ID_MUSEPACK8,
446 AV_CODEC_ID_WMAVOICE,
448 AV_CODEC_ID_WMALOSSLESS,
457 AV_CODEC_ID_BINKAUDIO_RDFT,
458 AV_CODEC_ID_BINKAUDIO_DCT,
459 AV_CODEC_ID_AAC_LATM,
464 AV_CODEC_ID_8SVX_EXP,
465 AV_CODEC_ID_8SVX_FIB,
466 AV_CODEC_ID_BMV_AUDIO,
470 AV_CODEC_ID_OPUS_DEPRECATED,
471 AV_CODEC_ID_COMFORT_NOISE,
472 AV_CODEC_ID_TAK_DEPRECATED,
473 AV_CODEC_ID_METASOUND,
474 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
475 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
476 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
477 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
478 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
479 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
480 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
481 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
483 /* subtitle codecs */
484 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
485 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
486 AV_CODEC_ID_DVB_SUBTITLE,
487 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
490 AV_CODEC_ID_MOV_TEXT,
491 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
492 AV_CODEC_ID_DVB_TELETEXT,
494 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
495 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
496 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
497 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
498 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
499 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
500 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
501 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
502 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
503 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
504 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
505 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
506 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
508 /* other specific kind of codecs (generally used for attachments) */
509 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
510 AV_CODEC_ID_TTF = 0x18000,
511 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
512 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
513 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
514 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
515 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
516 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
517 AV_CODEC_ID_TIMED_ID3 = MKBETAG('T','I','D','3'),
520 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
522 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
523 * stream (only used by libavformat) */
524 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
525 * stream (only used by libavformat) */
526 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
529 #include "old_codec_ids.h"
534 * This struct describes the properties of a single codec described by an
536 * @see avcodec_get_descriptor()
538 typedef struct AVCodecDescriptor {
540 enum AVMediaType type;
542 * Name of the codec described by this descriptor. It is non-empty and
543 * unique for each codec descriptor. It should contain alphanumeric
544 * characters and '_' only.
548 * A more descriptive name for this codec. May be NULL.
550 const char *long_name;
552 * Codec properties, a combination of AV_CODEC_PROP_* flags.
558 * Codec uses only intra compression.
561 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
563 * Codec supports lossy compression. Audio and video codecs only.
564 * @note a codec may support both lossy and lossless
567 #define AV_CODEC_PROP_LOSSY (1 << 1)
569 * Codec supports lossless compression. Audio and video codecs only.
571 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
573 * Subtitle codec is bitmap based
574 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
576 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
578 * Subtitle codec is text based.
579 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
581 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
584 * @ingroup lavc_decoding
585 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
586 * This is mainly needed because some optimized bitstream readers read
587 * 32 or 64 bit at once and could read over the end.<br>
588 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
589 * MPEG bitstreams could cause overread and segfault.
591 #define FF_INPUT_BUFFER_PADDING_SIZE 16
594 * @ingroup lavc_encoding
595 * minimum encoding buffer size
596 * Used to avoid some checks during header writing.
598 #define FF_MIN_BUFFER_SIZE 16384
602 * @ingroup lavc_encoding
603 * motion estimation type.
606 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
610 ME_EPZS, ///< enhanced predictive zonal search
611 ME_X1, ///< reserved for experiments
612 ME_HEX, ///< hexagon based search
613 ME_UMH, ///< uneven multi-hexagon search
614 ME_TESA, ///< transformed exhaustive search algorithm
615 ME_ITER=50, ///< iterative search
619 * @ingroup lavc_decoding
622 /* We leave some space between them for extensions (drop some
623 * keyframes for intra-only or drop just some bidir frames). */
624 AVDISCARD_NONE =-16, ///< discard nothing
625 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
626 AVDISCARD_NONREF = 8, ///< discard all non reference
627 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
628 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
629 AVDISCARD_ALL = 48, ///< discard all
632 enum AVColorPrimaries{
633 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
634 AVCOL_PRI_UNSPECIFIED = 2,
635 AVCOL_PRI_BT470M = 4,
636 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
637 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
638 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
640 AVCOL_PRI_BT2020 = 9, ///< ITU-R BT2020
641 AVCOL_PRI_NB , ///< Not part of ABI
644 enum AVColorTransferCharacteristic{
645 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
646 AVCOL_TRC_UNSPECIFIED = 2,
647 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
648 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
649 AVCOL_TRC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 or 625 / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC
650 AVCOL_TRC_SMPTE240M = 7,
651 AVCOL_TRC_LINEAR = 8, ///< "Linear transfer characteristics"
652 AVCOL_TRC_LOG = 9, ///< "Logarithmic transfer characteristic (100:1 range)"
653 AVCOL_TRC_LOG_SQRT = 10, ///< "Logarithmic transfer characteristic (100 * Sqrt( 10 ) : 1 range)"
654 AVCOL_TRC_IEC61966_2_4 = 11, ///< IEC 61966-2-4
655 AVCOL_TRC_BT1361_ECG = 12, ///< ITU-R BT1361 Extended Colour Gamut
656 AVCOL_TRC_IEC61966_2_1 = 13, ///< IEC 61966-2-1 (sRGB or sYCC)
657 AVCOL_TRC_BT2020_10 = 14, ///< ITU-R BT2020 for 10 bit system
658 AVCOL_TRC_BT2020_12 = 15, ///< ITU-R BT2020 for 12 bit system
659 AVCOL_TRC_NB , ///< Not part of ABI
663 * X X 3 4 X X are luma samples,
664 * 1 2 1-6 are possible chroma positions
665 * X X 5 6 X 0 is undefined/unknown position
667 enum AVChromaLocation{
668 AVCHROMA_LOC_UNSPECIFIED = 0,
669 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
670 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
671 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
672 AVCHROMA_LOC_TOP = 4,
673 AVCHROMA_LOC_BOTTOMLEFT = 5,
674 AVCHROMA_LOC_BOTTOM = 6,
675 AVCHROMA_LOC_NB , ///< Not part of ABI
678 enum AVAudioServiceType {
679 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
680 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
681 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
682 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
683 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
684 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
685 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
686 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
687 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
688 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
692 * @ingroup lavc_encoding
694 typedef struct RcOverride{
697 int qscale; // If this is 0 then quality_factor will be used instead.
698 float quality_factor;
701 #if FF_API_MAX_BFRAMES
703 * @deprecated there is no libavcodec-wide limit on the number of B-frames
705 #define FF_MAX_B_FRAMES 16
709 These flags can be passed in AVCodecContext.flags before initialization.
710 Note: Not everything is supported yet.
714 * Allow decoders to produce frames with data planes that are not aligned
715 * to CPU requirements (e.g. due to cropping).
717 #define CODEC_FLAG_UNALIGNED 0x0001
718 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
719 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
720 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
721 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
722 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
723 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
725 * The parent program guarantees that the input for B-frames containing
726 * streams is not written to for at least s->max_b_frames+1 frames, if
727 * this is not set the input will be copied.
729 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
730 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
731 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
732 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
735 * @deprecated edges are not used/required anymore. I.e. this flag is now always
738 #define CODEC_FLAG_EMU_EDGE 0x4000
740 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
741 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
742 location instead of only at frame boundaries. */
743 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
744 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
745 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
746 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
747 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
748 /* Fx : Flag for h263+ extra options */
749 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
750 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
751 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
752 #define CODEC_FLAG_CLOSED_GOP 0x80000000
753 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
754 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
755 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
756 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
757 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
759 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
760 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
762 /* Unsupported options :
763 * Syntax Arithmetic coding (SAC)
764 * Reference Picture Selection
765 * Independent Segment Decoding */
767 /* codec capabilities */
769 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
771 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
772 * If not set, it might not use get_buffer() at all or use operations that
773 * assume the buffer was allocated by avcodec_default_get_buffer.
775 #define CODEC_CAP_DR1 0x0002
776 #define CODEC_CAP_TRUNCATED 0x0008
778 /* Codec can export data for HW decoding. This flag indicates that
779 * the codec would call get_format() with list that might contain HW accelerated
780 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
781 * including raw image format.
782 * The application can use the passed context to determine bitstream version,
783 * chroma format, resolution etc.
785 #define CODEC_CAP_HWACCEL 0x0010
786 #endif /* FF_API_XVMC */
788 * Encoder or decoder requires flushing with NULL input at the end in order to
789 * give the complete and correct output.
791 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
792 * with NULL data. The user can still send NULL data to the public encode
793 * or decode function, but libavcodec will not pass it along to the codec
794 * unless this flag is set.
797 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
798 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
802 * The encoder needs to be fed with NULL data at the end of encoding until the
803 * encoder no longer returns data.
805 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
806 * flag also means that the encoder must set the pts and duration for
807 * each output packet. If this flag is not set, the pts and duration will
808 * be determined by libavcodec from the input frame.
810 #define CODEC_CAP_DELAY 0x0020
812 * Codec can be fed a final frame with a smaller size.
813 * This can be used to prevent truncation of the last audio samples.
815 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
818 * Codec can export data for HW decoding (VDPAU).
820 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
823 * Codec can output multiple frames per AVPacket
824 * Normally demuxers return one frame at a time, demuxers which do not do
825 * are connected to a parser to split what they return into proper frames.
826 * This flag is reserved to the very rare category of codecs which have a
827 * bitstream that cannot be split into frames without timeconsuming
828 * operations like full decoding. Demuxers carring such bitstreams thus
829 * may return multiple frames in a packet. This has many disadvantages like
830 * prohibiting stream copy in many cases thus it should only be considered
833 #define CODEC_CAP_SUBFRAMES 0x0100
835 * Codec is experimental and is thus avoided in favor of non experimental
838 #define CODEC_CAP_EXPERIMENTAL 0x0200
840 * Codec should fill in channel configuration and samplerate instead of container
842 #define CODEC_CAP_CHANNEL_CONF 0x0400
843 #if FF_API_NEG_LINESIZES
845 * @deprecated no codecs use this capability
847 #define CODEC_CAP_NEG_LINESIZES 0x0800
850 * Codec supports frame-level multithreading.
852 #define CODEC_CAP_FRAME_THREADS 0x1000
854 * Codec supports slice-based (or partition-based) multithreading.
856 #define CODEC_CAP_SLICE_THREADS 0x2000
858 * Codec supports changed parameters at any point.
860 #define CODEC_CAP_PARAM_CHANGE 0x4000
862 * Codec supports avctx->thread_count == 0 (auto).
864 #define CODEC_CAP_AUTO_THREADS 0x8000
866 * Audio encoder supports receiving a different number of samples in each call.
868 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
870 * Codec is intra only.
872 #define CODEC_CAP_INTRA_ONLY 0x40000000
876 #define CODEC_CAP_LOSSLESS 0x80000000
879 //The following defines may change, don't expect compatibility if you use them.
880 #define MB_TYPE_INTRA4x4 0x0001
881 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
882 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
883 #define MB_TYPE_16x16 0x0008
884 #define MB_TYPE_16x8 0x0010
885 #define MB_TYPE_8x16 0x0020
886 #define MB_TYPE_8x8 0x0040
887 #define MB_TYPE_INTERLACED 0x0080
888 #define MB_TYPE_DIRECT2 0x0100 //FIXME
889 #define MB_TYPE_ACPRED 0x0200
890 #define MB_TYPE_GMC 0x0400
891 #define MB_TYPE_SKIP 0x0800
892 #define MB_TYPE_P0L0 0x1000
893 #define MB_TYPE_P1L0 0x2000
894 #define MB_TYPE_P0L1 0x4000
895 #define MB_TYPE_P1L1 0x8000
896 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
897 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
898 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
899 #define MB_TYPE_QUANT 0x00010000
900 #define MB_TYPE_CBP 0x00020000
901 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
906 * This specifies the area which should be displayed.
907 * Note there may be multiple such areas for one frame.
909 typedef struct AVPanScan{
912 * - encoding: Set by user.
913 * - decoding: Set by libavcodec.
918 * width and height in 1/16 pel
919 * - encoding: Set by user.
920 * - decoding: Set by libavcodec.
926 * position of the top left corner in 1/16 pel for up to 3 fields/frames
927 * - encoding: Set by user.
928 * - decoding: Set by libavcodec.
930 int16_t position[3][2];
933 #if FF_API_QSCALE_TYPE
934 #define FF_QSCALE_TYPE_MPEG1 0
935 #define FF_QSCALE_TYPE_MPEG2 1
936 #define FF_QSCALE_TYPE_H264 2
937 #define FF_QSCALE_TYPE_VP56 3
940 #if FF_API_GET_BUFFER
941 #define FF_BUFFER_TYPE_INTERNAL 1
942 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
943 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
944 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
946 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
947 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
948 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
949 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
953 * The decoder will keep a reference to the frame and may reuse it later.
955 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
958 * @defgroup lavc_packet AVPacket
960 * Types and functions for working with AVPacket.
963 enum AVPacketSideDataType {
965 AV_PKT_DATA_NEW_EXTRADATA,
968 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
971 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
972 * s32le channel_count
973 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
974 * u64le channel_layout
975 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
977 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
982 AV_PKT_DATA_PARAM_CHANGE,
985 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
986 * structures with info about macroblocks relevant to splitting the
987 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
988 * That is, it does not necessarily contain info about all macroblocks,
989 * as long as the distance between macroblocks in the info is smaller
990 * than the target payload size.
991 * Each MB info structure is 12 bytes, and is laid out as follows:
993 * u32le bit offset from the start of the packet
994 * u8 current quantizer at the start of the macroblock
996 * u16le macroblock address within the GOB
997 * u8 horizontal MV predictor
998 * u8 vertical MV predictor
999 * u8 horizontal MV predictor for block number 3
1000 * u8 vertical MV predictor for block number 3
1003 AV_PKT_DATA_H263_MB_INFO,
1006 * Recommmends skipping the specified number of samples
1008 * u32le number of samples to skip from start of this packet
1009 * u32le number of samples to skip from end of this packet
1010 * u8 reason for start skip
1011 * u8 reason for end skip (0=padding silence, 1=convergence)
1014 AV_PKT_DATA_SKIP_SAMPLES=70,
1017 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1018 * the packet may contain "dual mono" audio specific to Japanese DTV
1019 * and if it is true, recommends only the selected channel to be used.
1021 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1024 AV_PKT_DATA_JP_DUALMONO,
1027 * A list of zero terminated key/value strings. There is no end marker for
1028 * the list, so it is required to rely on the side data size to stop.
1030 AV_PKT_DATA_STRINGS_METADATA,
1033 * Subtitle event position
1041 AV_PKT_DATA_SUBTITLE_POSITION,
1044 * Data found in BlockAdditional element of matroska container. There is
1045 * no end marker for the data, so it is required to rely on the side data
1046 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1049 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1052 * The optional first identifier line of a WebVTT cue.
1054 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1057 * The optional settings (rendering instructions) that immediately
1058 * follow the timestamp specifier of a WebVTT cue.
1060 AV_PKT_DATA_WEBVTT_SETTINGS,
1063 * A list of zero terminated key/value strings. There is no end marker for
1064 * the list, so it is required to rely on the side data size to stop. This
1065 * side data includes updated metadata which appeared in the stream.
1067 AV_PKT_DATA_METADATA_UPDATE,
1071 * This structure stores compressed data. It is typically exported by demuxers
1072 * and then passed as input to decoders, or received as output from encoders and
1073 * then passed to muxers.
1075 * For video, it should typically contain one compressed frame. For audio it may
1076 * contain several compressed frames.
1078 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1079 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1080 * without libavcodec and libavformat major bump.
1082 * The semantics of data ownership depends on the buf or destruct (deprecated)
1083 * fields. If either is set, the packet data is dynamically allocated and is
1084 * valid indefinitely until av_free_packet() is called (which in turn calls
1085 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1086 * the packet data is typically backed by some static buffer somewhere and is
1087 * only valid for a limited time (e.g. until the next read call when demuxing).
1089 * The side data is always allocated with av_malloc() and is freed in
1092 typedef struct AVPacket {
1094 * A reference to the reference-counted buffer where the packet data is
1096 * May be NULL, then the packet data is not reference-counted.
1100 * Presentation timestamp in AVStream->time_base units; the time at which
1101 * the decompressed packet will be presented to the user.
1102 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1103 * pts MUST be larger or equal to dts as presentation cannot happen before
1104 * decompression, unless one wants to view hex dumps. Some formats misuse
1105 * the terms dts and pts/cts to mean something different. Such timestamps
1106 * must be converted to true pts/dts before they are stored in AVPacket.
1110 * Decompression timestamp in AVStream->time_base units; the time at which
1111 * the packet is decompressed.
1112 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1119 * A combination of AV_PKT_FLAG values
1123 * Additional packet data that can be provided by the container.
1124 * Packet can contain several types of side information.
1129 enum AVPacketSideDataType type;
1131 int side_data_elems;
1134 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1135 * Equals next_pts - this_pts in presentation order.
1138 #if FF_API_DESTRUCT_PACKET
1139 attribute_deprecated
1140 void (*destruct)(struct AVPacket *);
1141 attribute_deprecated
1144 int64_t pos; ///< byte position in stream, -1 if unknown
1147 * Time difference in AVStream->time_base units from the pts of this
1148 * packet to the point at which the output from the decoder has converged
1149 * independent from the availability of previous frames. That is, the
1150 * frames are virtually identical no matter if decoding started from
1151 * the very first frame or from this keyframe.
1152 * Is AV_NOPTS_VALUE if unknown.
1153 * This field is not the display duration of the current packet.
1154 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1157 * The purpose of this field is to allow seeking in streams that have no
1158 * keyframes in the conventional sense. It corresponds to the
1159 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1160 * essential for some types of subtitle streams to ensure that all
1161 * subtitles are correctly displayed after seeking.
1163 int64_t convergence_duration;
1165 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1166 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1168 enum AVSideDataParamChangeFlags {
1169 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1170 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1171 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1172 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1178 struct AVCodecInternal;
1182 AV_FIELD_PROGRESSIVE,
1183 AV_FIELD_TT, //< Top coded_first, top displayed first
1184 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1185 AV_FIELD_TB, //< Top coded first, bottom displayed first
1186 AV_FIELD_BT, //< Bottom coded first, top displayed first
1190 * main external API structure.
1191 * New fields can be added to the end with minor version bumps.
1192 * Removal, reordering and changes to existing fields require a major
1194 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1196 * sizeof(AVCodecContext) must not be used outside libav*.
1198 typedef struct AVCodecContext {
1200 * information on struct for av_log
1201 * - set by avcodec_alloc_context3
1203 const AVClass *av_class;
1204 int log_level_offset;
1206 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1207 const struct AVCodec *codec;
1208 char codec_name[32];
1209 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1212 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1213 * This is used to work around some encoder bugs.
1214 * A demuxer should set this to what is stored in the field used to identify the codec.
1215 * If there are multiple such fields in a container then the demuxer should choose the one
1216 * which maximizes the information about the used codec.
1217 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1218 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1219 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1221 * - encoding: Set by user, if not then the default based on codec_id will be used.
1222 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1224 unsigned int codec_tag;
1227 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1228 * This is used to work around some encoder bugs.
1229 * - encoding: unused
1230 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1232 unsigned int stream_codec_tag;
1237 * Private context used for internal data.
1239 * Unlike priv_data, this is not codec-specific. It is used in general
1240 * libavcodec functions.
1242 struct AVCodecInternal *internal;
1245 * Private data of the user, can be used to carry app specific stuff.
1246 * - encoding: Set by user.
1247 * - decoding: Set by user.
1252 * the average bitrate
1253 * - encoding: Set by user; unused for constant quantizer encoding.
1254 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1259 * number of bits the bitstream is allowed to diverge from the reference.
1260 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1261 * - encoding: Set by user; unused for constant quantizer encoding.
1262 * - decoding: unused
1264 int bit_rate_tolerance;
1267 * Global quality for codecs which cannot change it per frame.
1268 * This should be proportional to MPEG-1/2/4 qscale.
1269 * - encoding: Set by user.
1270 * - decoding: unused
1275 * - encoding: Set by user.
1276 * - decoding: unused
1278 int compression_level;
1279 #define FF_COMPRESSION_DEFAULT -1
1283 * - encoding: Set by user.
1284 * - decoding: Set by user.
1290 * - encoding: Set by user.
1291 * - decoding: Set by user.
1296 * some codecs need / can use extradata like Huffman tables.
1297 * mjpeg: Huffman tables
1298 * rv10: additional flags
1299 * mpeg4: global headers (they can be in the bitstream or here)
1300 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1301 * than extradata_size to avoid problems if it is read with the bitstream reader.
1302 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1303 * - encoding: Set/allocated/freed by libavcodec.
1304 * - decoding: Set/allocated/freed by user.
1310 * This is the fundamental unit of time (in seconds) in terms
1311 * of which frame timestamps are represented. For fixed-fps content,
1312 * timebase should be 1/framerate and timestamp increments should be
1314 * - encoding: MUST be set by user.
1315 * - decoding: Set by libavcodec.
1317 AVRational time_base;
1320 * For some codecs, the time base is closer to the field rate than the frame rate.
1321 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1322 * if no telecine is used ...
1324 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1326 int ticks_per_frame;
1331 * Encoding: Number of frames delay there will be from the encoder input to
1332 * the decoder output. (we assume the decoder matches the spec)
1333 * Decoding: Number of frames delay in addition to what a standard decoder
1334 * as specified in the spec would produce.
1337 * Number of frames the decoded output will be delayed relative to the
1341 * For encoding, this is the number of "priming" samples added to the
1342 * beginning of the stream. The decoded output will be delayed by this
1343 * many samples relative to the input to the encoder. Note that this
1344 * field is purely informational and does not directly affect the pts
1345 * output by the encoder, which should always be based on the actual
1346 * presentation time, including any delay.
1347 * For decoding, this is the number of samples the decoder needs to
1348 * output before the decoder's output is valid. When seeking, you should
1349 * start decoding this many samples prior to your desired seek point.
1351 * - encoding: Set by libavcodec.
1352 * - decoding: Set by libavcodec.
1359 * picture width / height.
1360 * - encoding: MUST be set by user.
1361 * - decoding: May be set by the user before opening the decoder if known e.g.
1362 * from the container. Some decoders will require the dimensions
1363 * to be set by the caller. During decoding, the decoder may
1364 * overwrite those values as required.
1369 * Bitstream width / height, may be different from width/height e.g. when
1370 * the decoded frame is cropped before being output or lowres is enabled.
1371 * - encoding: unused
1372 * - decoding: May be set by the user before opening the decoder if known
1373 * e.g. from the container. During decoding, the decoder may
1374 * overwrite those values as required.
1376 int coded_width, coded_height;
1378 #if FF_API_ASPECT_EXTENDED
1379 #define FF_ASPECT_EXTENDED 15
1383 * the number of pictures in a group of pictures, or 0 for intra_only
1384 * - encoding: Set by user.
1385 * - decoding: unused
1390 * Pixel format, see AV_PIX_FMT_xxx.
1391 * May be set by the demuxer if known from headers.
1392 * May be overridden by the decoder if it knows better.
1393 * - encoding: Set by user.
1394 * - decoding: Set by user if known, overridden by libavcodec if known
1396 enum AVPixelFormat pix_fmt;
1399 * Motion estimation algorithm used for video coding.
1400 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1401 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1402 * - encoding: MUST be set by user.
1403 * - decoding: unused
1408 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1409 * decoder to draw a horizontal band. It improves cache usage. Not
1410 * all codecs can do that. You must check the codec capabilities
1412 * When multithreading is used, it may be called from multiple threads
1413 * at the same time; threads might draw different parts of the same AVFrame,
1414 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1416 * The function is also used by hardware acceleration APIs.
1417 * It is called at least once during frame decoding to pass
1418 * the data needed for hardware render.
1419 * In that mode instead of pixel data, AVFrame points to
1420 * a structure specific to the acceleration API. The application
1421 * reads the structure and can change some fields to indicate progress
1423 * - encoding: unused
1424 * - decoding: Set by user.
1425 * @param height the height of the slice
1426 * @param y the y position of the slice
1427 * @param type 1->top field, 2->bottom field, 3->frame
1428 * @param offset offset into the AVFrame.data from which the slice should be read
1430 void (*draw_horiz_band)(struct AVCodecContext *s,
1431 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1432 int y, int type, int height);
1435 * callback to negotiate the pixelFormat
1436 * @param fmt is the list of formats which are supported by the codec,
1437 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1438 * The first is always the native one.
1439 * @return the chosen format
1440 * - encoding: unused
1441 * - decoding: Set by user, if not set the native format will be chosen.
1443 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1446 * maximum number of B-frames between non-B-frames
1447 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1448 * - encoding: Set by user.
1449 * - decoding: unused
1454 * qscale factor between IP and B-frames
1455 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1456 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1457 * - encoding: Set by user.
1458 * - decoding: unused
1460 float b_quant_factor;
1462 /** obsolete FIXME remove */
1464 #define FF_RC_STRATEGY_XVID 1
1466 int b_frame_strategy;
1469 * qscale offset between IP and B-frames
1470 * - encoding: Set by user.
1471 * - decoding: unused
1473 float b_quant_offset;
1476 * Size of the frame reordering buffer in the decoder.
1477 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1478 * - encoding: Set by libavcodec.
1479 * - decoding: Set by libavcodec.
1484 * 0-> h263 quant 1-> mpeg quant
1485 * - encoding: Set by user.
1486 * - decoding: unused
1491 * qscale factor between P and I-frames
1492 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1493 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1494 * - encoding: Set by user.
1495 * - decoding: unused
1497 float i_quant_factor;
1500 * qscale offset between P and I-frames
1501 * - encoding: Set by user.
1502 * - decoding: unused
1504 float i_quant_offset;
1507 * luminance masking (0-> disabled)
1508 * - encoding: Set by user.
1509 * - decoding: unused
1514 * temporary complexity masking (0-> disabled)
1515 * - encoding: Set by user.
1516 * - decoding: unused
1518 float temporal_cplx_masking;
1521 * spatial complexity masking (0-> disabled)
1522 * - encoding: Set by user.
1523 * - decoding: unused
1525 float spatial_cplx_masking;
1528 * p block masking (0-> disabled)
1529 * - encoding: Set by user.
1530 * - decoding: unused
1535 * darkness masking (0-> disabled)
1536 * - encoding: Set by user.
1537 * - decoding: unused
1543 * - encoding: Set by libavcodec.
1544 * - decoding: Set by user (or 0).
1548 * prediction method (needed for huffyuv)
1549 * - encoding: Set by user.
1550 * - decoding: unused
1552 int prediction_method;
1553 #define FF_PRED_LEFT 0
1554 #define FF_PRED_PLANE 1
1555 #define FF_PRED_MEDIAN 2
1558 * slice offsets in the frame in bytes
1559 * - encoding: Set/allocated by libavcodec.
1560 * - decoding: Set/allocated by user (or NULL).
1565 * sample aspect ratio (0 if unknown)
1566 * That is the width of a pixel divided by the height of the pixel.
1567 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1568 * - encoding: Set by user.
1569 * - decoding: Set by libavcodec.
1571 AVRational sample_aspect_ratio;
1574 * motion estimation comparison function
1575 * - encoding: Set by user.
1576 * - decoding: unused
1580 * subpixel motion estimation comparison function
1581 * - encoding: Set by user.
1582 * - decoding: unused
1586 * macroblock comparison function (not supported yet)
1587 * - encoding: Set by user.
1588 * - decoding: unused
1592 * interlaced DCT comparison function
1593 * - encoding: Set by user.
1594 * - decoding: unused
1597 #define FF_CMP_SAD 0
1598 #define FF_CMP_SSE 1
1599 #define FF_CMP_SATD 2
1600 #define FF_CMP_DCT 3
1601 #define FF_CMP_PSNR 4
1602 #define FF_CMP_BIT 5
1604 #define FF_CMP_ZERO 7
1605 #define FF_CMP_VSAD 8
1606 #define FF_CMP_VSSE 9
1607 #define FF_CMP_NSSE 10
1608 #define FF_CMP_W53 11
1609 #define FF_CMP_W97 12
1610 #define FF_CMP_DCTMAX 13
1611 #define FF_CMP_DCT264 14
1612 #define FF_CMP_CHROMA 256
1615 * ME diamond size & shape
1616 * - encoding: Set by user.
1617 * - decoding: unused
1622 * amount of previous MV predictors (2a+1 x 2a+1 square)
1623 * - encoding: Set by user.
1624 * - decoding: unused
1626 int last_predictor_count;
1629 * prepass for motion estimation
1630 * - encoding: Set by user.
1631 * - decoding: unused
1636 * motion estimation prepass comparison function
1637 * - encoding: Set by user.
1638 * - decoding: unused
1643 * ME prepass diamond size & shape
1644 * - encoding: Set by user.
1645 * - decoding: unused
1651 * - encoding: Set by user.
1652 * - decoding: unused
1654 int me_subpel_quality;
1657 * DTG active format information (additional aspect ratio
1658 * information only used in DVB MPEG-2 transport streams)
1661 * - encoding: unused
1662 * - decoding: Set by decoder.
1664 int dtg_active_format;
1665 #define FF_DTG_AFD_SAME 8
1666 #define FF_DTG_AFD_4_3 9
1667 #define FF_DTG_AFD_16_9 10
1668 #define FF_DTG_AFD_14_9 11
1669 #define FF_DTG_AFD_4_3_SP_14_9 13
1670 #define FF_DTG_AFD_16_9_SP_14_9 14
1671 #define FF_DTG_AFD_SP_4_3 15
1674 * maximum motion estimation search range in subpel units
1675 * If 0 then no limit.
1677 * - encoding: Set by user.
1678 * - decoding: unused
1683 * intra quantizer bias
1684 * - encoding: Set by user.
1685 * - decoding: unused
1687 int intra_quant_bias;
1688 #define FF_DEFAULT_QUANT_BIAS 999999
1691 * inter quantizer bias
1692 * - encoding: Set by user.
1693 * - decoding: unused
1695 int inter_quant_bias;
1699 * - encoding: unused
1700 * - decoding: Set by user.
1703 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1704 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1705 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1709 * XVideo Motion Acceleration
1710 * - encoding: forbidden
1711 * - decoding: set by decoder
1712 * @deprecated XvMC doesn't need it anymore.
1714 attribute_deprecated int xvmc_acceleration;
1715 #endif /* FF_API_XVMC */
1718 * macroblock decision mode
1719 * - encoding: Set by user.
1720 * - decoding: unused
1723 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1724 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1725 #define FF_MB_DECISION_RD 2 ///< rate distortion
1728 * custom intra quantization matrix
1729 * - encoding: Set by user, can be NULL.
1730 * - decoding: Set by libavcodec.
1732 uint16_t *intra_matrix;
1735 * custom inter quantization matrix
1736 * - encoding: Set by user, can be NULL.
1737 * - decoding: Set by libavcodec.
1739 uint16_t *inter_matrix;
1742 * scene change detection threshold
1743 * 0 is default, larger means fewer detected scene changes.
1744 * - encoding: Set by user.
1745 * - decoding: unused
1747 int scenechange_threshold;
1750 * noise reduction strength
1751 * - encoding: Set by user.
1752 * - decoding: unused
1754 int noise_reduction;
1757 * Motion estimation threshold below which no motion estimation is
1758 * performed, but instead the user specified motion vectors are used.
1760 * - encoding: Set by user.
1761 * - decoding: unused
1766 * Macroblock threshold below which the user specified macroblock types will be used.
1767 * - encoding: Set by user.
1768 * - decoding: unused
1773 * precision of the intra DC coefficient - 8
1774 * - encoding: Set by user.
1775 * - decoding: unused
1777 int intra_dc_precision;
1780 * Number of macroblock rows at the top which are skipped.
1781 * - encoding: unused
1782 * - decoding: Set by user.
1787 * Number of macroblock rows at the bottom which are skipped.
1788 * - encoding: unused
1789 * - decoding: Set by user.
1794 * Border processing masking, raises the quantizer for mbs on the borders
1796 * - encoding: Set by user.
1797 * - decoding: unused
1799 float border_masking;
1802 * minimum MB lagrange multipler
1803 * - encoding: Set by user.
1804 * - decoding: unused
1809 * maximum MB lagrange multipler
1810 * - encoding: Set by user.
1811 * - decoding: unused
1817 * - encoding: Set by user.
1818 * - decoding: unused
1820 int me_penalty_compensation;
1824 * - encoding: Set by user.
1825 * - decoding: unused
1831 * - encoding: Set by user.
1832 * - decoding: unused
1838 * - encoding: Set by user.
1839 * - decoding: unused
1844 * number of reference frames
1845 * - encoding: Set by user.
1846 * - decoding: Set by lavc.
1851 * chroma qp offset from luma
1852 * - encoding: Set by user.
1853 * - decoding: unused
1858 * Multiplied by qscale for each frame and added to scene_change_score.
1859 * - encoding: Set by user.
1860 * - decoding: unused
1862 int scenechange_factor;
1866 * Note: Value depends upon the compare function used for fullpel ME.
1867 * - encoding: Set by user.
1868 * - decoding: unused
1873 * Adjust sensitivity of b_frame_strategy 1.
1874 * - encoding: Set by user.
1875 * - decoding: unused
1880 * Chromaticity coordinates of the source primaries.
1881 * - encoding: Set by user
1882 * - decoding: Set by libavcodec
1884 enum AVColorPrimaries color_primaries;
1887 * Color Transfer Characteristic.
1888 * - encoding: Set by user
1889 * - decoding: Set by libavcodec
1891 enum AVColorTransferCharacteristic color_trc;
1894 * YUV colorspace type.
1895 * - encoding: Set by user
1896 * - decoding: Set by libavcodec
1898 enum AVColorSpace colorspace;
1901 * MPEG vs JPEG YUV range.
1902 * - encoding: Set by user
1903 * - decoding: Set by libavcodec
1905 enum AVColorRange color_range;
1908 * This defines the location of chroma samples.
1909 * - encoding: Set by user
1910 * - decoding: Set by libavcodec
1912 enum AVChromaLocation chroma_sample_location;
1916 * Indicates number of picture subdivisions. Used for parallelized
1918 * - encoding: Set by user
1919 * - decoding: unused
1924 * - encoding: set by libavcodec
1925 * - decoding: Set by user.
1927 enum AVFieldOrder field_order;
1930 int sample_rate; ///< samples per second
1931 int channels; ///< number of audio channels
1934 * audio sample format
1935 * - encoding: Set by user.
1936 * - decoding: Set by libavcodec.
1938 enum AVSampleFormat sample_fmt; ///< sample format
1940 /* The following data should not be initialized. */
1942 * Number of samples per channel in an audio frame.
1944 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1945 * except the last must contain exactly frame_size samples per channel.
1946 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1947 * frame size is not restricted.
1948 * - decoding: may be set by some decoders to indicate constant frame size
1953 * Frame counter, set by libavcodec.
1955 * - decoding: total number of frames returned from the decoder so far.
1956 * - encoding: total number of frames passed to the encoder so far.
1958 * @note the counter is not incremented if encoding/decoding resulted in
1964 * number of bytes per packet if constant and known or 0
1965 * Used by some WAV based audio codecs.
1970 * Audio cutoff bandwidth (0 means "automatic")
1971 * - encoding: Set by user.
1972 * - decoding: unused
1976 #if FF_API_REQUEST_CHANNELS
1978 * Decoder should decode to this many channels if it can (0 for default)
1979 * - encoding: unused
1980 * - decoding: Set by user.
1981 * @deprecated Deprecated in favor of request_channel_layout.
1983 attribute_deprecated int request_channels;
1987 * Audio channel layout.
1988 * - encoding: set by user.
1989 * - decoding: set by user, may be overwritten by libavcodec.
1991 uint64_t channel_layout;
1994 * Request decoder to use this channel layout if it can (0 for default)
1995 * - encoding: unused
1996 * - decoding: Set by user.
1998 uint64_t request_channel_layout;
2001 * Type of service that the audio stream conveys.
2002 * - encoding: Set by user.
2003 * - decoding: Set by libavcodec.
2005 enum AVAudioServiceType audio_service_type;
2008 * desired sample format
2009 * - encoding: Not used.
2010 * - decoding: Set by user.
2011 * Decoder will decode to this format if it can.
2013 enum AVSampleFormat request_sample_fmt;
2015 #if FF_API_GET_BUFFER
2017 * Called at the beginning of each frame to get a buffer for it.
2019 * The function will set AVFrame.data[], AVFrame.linesize[].
2020 * AVFrame.extended_data[] must also be set, but it should be the same as
2021 * AVFrame.data[] except for planar audio with more channels than can fit
2022 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2023 * many data pointers as it can hold.
2025 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2026 * avcodec_default_get_buffer() instead of providing buffers allocated by
2029 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2030 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2031 * but if get_buffer() is overridden then alignment considerations should
2032 * be taken into account.
2034 * @see avcodec_default_get_buffer()
2038 * If pic.reference is set then the frame will be read later by libavcodec.
2039 * avcodec_align_dimensions2() should be used to find the required width and
2040 * height, as they normally need to be rounded up to the next multiple of 16.
2042 * If frame multithreading is used and thread_safe_callbacks is set,
2043 * it may be called from a different thread, but not from more than one at
2044 * once. Does not need to be reentrant.
2046 * @see release_buffer(), reget_buffer()
2047 * @see avcodec_align_dimensions2()
2051 * Decoders request a buffer of a particular size by setting
2052 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2053 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2054 * to a smaller value in the output frame.
2056 * Decoders cannot use the buffer after returning from
2057 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2058 * is assumed to be released immediately upon return. In some rare cases,
2059 * a decoder may need to call get_buffer() more than once in a single
2060 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2061 * called again after it has already been called once, the previously
2062 * acquired buffer is assumed to be released at that time and may not be
2063 * reused by the decoder.
2065 * As a convenience, av_samples_get_buffer_size() and
2066 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2067 * functions to find the required data size and to fill data pointers and
2068 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2069 * since all planes must be the same size.
2071 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2073 * - encoding: unused
2074 * - decoding: Set by libavcodec, user can override.
2076 * @deprecated use get_buffer2()
2078 attribute_deprecated
2079 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2082 * Called to release buffers which were allocated with get_buffer.
2083 * A released buffer can be reused in get_buffer().
2084 * pic.data[*] must be set to NULL.
2085 * May be called from a different thread if frame multithreading is used,
2086 * but not by more than one thread at once, so does not need to be reentrant.
2087 * - encoding: unused
2088 * - decoding: Set by libavcodec, user can override.
2090 * @deprecated custom freeing callbacks should be set from get_buffer2()
2092 attribute_deprecated
2093 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2096 * Called at the beginning of a frame to get cr buffer for it.
2097 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2098 * libavcodec will pass previous buffer in pic, function should return
2099 * same buffer or new buffer with old frame "painted" into it.
2100 * If pic.data[0] == NULL must behave like get_buffer().
2101 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2102 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2104 * - encoding: unused
2105 * - decoding: Set by libavcodec, user can override.
2107 attribute_deprecated
2108 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2112 * This callback is called at the beginning of each frame to get data
2113 * buffer(s) for it. There may be one contiguous buffer for all the data or
2114 * there may be a buffer per each data plane or anything in between. What
2115 * this means is, you may set however many entries in buf[] you feel necessary.
2116 * Each buffer must be reference-counted using the AVBuffer API (see description
2119 * The following fields will be set in the frame before this callback is
2122 * - width, height (video only)
2123 * - sample_rate, channel_layout, nb_samples (audio only)
2124 * Their values may differ from the corresponding values in
2125 * AVCodecContext. This callback must use the frame values, not the codec
2126 * context values, to calculate the required buffer size.
2128 * This callback must fill the following fields in the frame:
2132 * * if the data is planar audio with more than 8 channels, then this
2133 * callback must allocate and fill extended_data to contain all pointers
2134 * to all data planes. data[] must hold as many pointers as it can.
2135 * extended_data must be allocated with av_malloc() and will be freed in
2137 * * otherwise exended_data must point to data
2138 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2139 * the frame's data and extended_data pointers must be contained in these. That
2140 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2141 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2142 * and av_buffer_ref().
2143 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2144 * this callback and filled with the extra buffers if there are more
2145 * buffers than buf[] can hold. extended_buf will be freed in
2148 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2149 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2152 * Each data plane must be aligned to the maximum required by the target
2155 * @see avcodec_default_get_buffer2()
2159 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2160 * (read and/or written to if it is writable) later by libavcodec.
2162 * avcodec_align_dimensions2() should be used to find the required width and
2163 * height, as they normally need to be rounded up to the next multiple of 16.
2165 * Some decoders do not support linesizes changing between frames.
2167 * If frame multithreading is used and thread_safe_callbacks is set,
2168 * this callback may be called from a different thread, but not from more
2169 * than one at once. Does not need to be reentrant.
2171 * @see avcodec_align_dimensions2()
2175 * Decoders request a buffer of a particular size by setting
2176 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2177 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2178 * to a smaller value in the output frame.
2180 * As a convenience, av_samples_get_buffer_size() and
2181 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2182 * functions to find the required data size and to fill data pointers and
2183 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2184 * since all planes must be the same size.
2186 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2188 * - encoding: unused
2189 * - decoding: Set by libavcodec, user can override.
2191 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2194 * If non-zero, the decoded audio and video frames returned from
2195 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2196 * and are valid indefinitely. The caller must free them with
2197 * av_frame_unref() when they are not needed anymore.
2198 * Otherwise, the decoded frames must not be freed by the caller and are
2199 * only valid until the next decode call.
2201 * - encoding: unused
2202 * - decoding: set by the caller before avcodec_open2().
2204 int refcounted_frames;
2206 /* - encoding parameters */
2207 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2208 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2212 * - encoding: Set by user.
2213 * - decoding: unused
2219 * - encoding: Set by user.
2220 * - decoding: unused
2225 * maximum quantizer difference between frames
2226 * - encoding: Set by user.
2227 * - decoding: unused
2232 * ratecontrol qmin qmax limiting method
2233 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2234 * - encoding: Set by user.
2235 * - decoding: unused
2243 * decoder bitstream buffer size
2244 * - encoding: Set by user.
2245 * - decoding: unused
2250 * ratecontrol override, see RcOverride
2251 * - encoding: Allocated/set/freed by user.
2252 * - decoding: unused
2254 int rc_override_count;
2255 RcOverride *rc_override;
2258 * rate control equation
2259 * - encoding: Set by user
2260 * - decoding: unused
2266 * - encoding: Set by user.
2267 * - decoding: unused
2273 * - encoding: Set by user.
2274 * - decoding: unused
2278 float rc_buffer_aggressivity;
2281 * initial complexity for pass1 ratecontrol
2282 * - encoding: Set by user.
2283 * - decoding: unused
2285 float rc_initial_cplx;
2288 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2289 * - encoding: Set by user.
2290 * - decoding: unused.
2292 float rc_max_available_vbv_use;
2295 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2296 * - encoding: Set by user.
2297 * - decoding: unused.
2299 float rc_min_vbv_overflow_use;
2302 * Number of bits which should be loaded into the rc buffer before decoding starts.
2303 * - encoding: Set by user.
2304 * - decoding: unused
2306 int rc_initial_buffer_occupancy;
2308 #define FF_CODER_TYPE_VLC 0
2309 #define FF_CODER_TYPE_AC 1
2310 #define FF_CODER_TYPE_RAW 2
2311 #define FF_CODER_TYPE_RLE 3
2312 #define FF_CODER_TYPE_DEFLATE 4
2315 * - encoding: Set by user.
2316 * - decoding: unused
2322 * - encoding: Set by user.
2323 * - decoding: unused
2328 * minimum Lagrange multipler
2329 * - encoding: Set by user.
2330 * - decoding: unused
2335 * maximum Lagrange multipler
2336 * - encoding: Set by user.
2337 * - decoding: unused
2342 * frame skip threshold
2343 * - encoding: Set by user.
2344 * - decoding: unused
2346 int frame_skip_threshold;
2350 * - encoding: Set by user.
2351 * - decoding: unused
2353 int frame_skip_factor;
2356 * frame skip exponent
2357 * - encoding: Set by user.
2358 * - decoding: unused
2363 * frame skip comparison function
2364 * - encoding: Set by user.
2365 * - decoding: unused
2370 * trellis RD quantization
2371 * - encoding: Set by user.
2372 * - decoding: unused
2377 * - encoding: Set by user.
2378 * - decoding: unused
2380 int min_prediction_order;
2383 * - encoding: Set by user.
2384 * - decoding: unused
2386 int max_prediction_order;
2389 * GOP timecode frame start number
2390 * - encoding: Set by user, in non drop frame format
2391 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2393 int64_t timecode_frame_start;
2395 /* The RTP callback: This function is called */
2396 /* every time the encoder has a packet to send. */
2397 /* It depends on the encoder if the data starts */
2398 /* with a Start Code (it should). H.263 does. */
2399 /* mb_nb contains the number of macroblocks */
2400 /* encoded in the RTP payload. */
2401 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2403 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2404 /* do its best to deliver a chunk with size */
2405 /* below rtp_payload_size, the chunk will start */
2406 /* with a start code on some codecs like H.263. */
2407 /* This doesn't take account of any particular */
2408 /* headers inside the transmitted RTP payload. */
2410 /* statistics, used for 2-pass encoding */
2421 * number of bits used for the previously encoded frame
2422 * - encoding: Set by libavcodec.
2423 * - decoding: unused
2428 * pass1 encoding statistics output buffer
2429 * - encoding: Set by libavcodec.
2430 * - decoding: unused
2435 * pass2 encoding statistics input buffer
2436 * Concatenated stuff from stats_out of pass1 should be placed here.
2437 * - encoding: Allocated/set/freed by user.
2438 * - decoding: unused
2443 * Work around bugs in encoders which sometimes cannot be detected automatically.
2444 * - encoding: Set by user
2445 * - decoding: Set by user
2447 int workaround_bugs;
2448 #define FF_BUG_AUTODETECT 1 ///< autodetection
2449 #if FF_API_OLD_MSMPEG4
2450 #define FF_BUG_OLD_MSMPEG4 2
2452 #define FF_BUG_XVID_ILACE 4
2453 #define FF_BUG_UMP4 8
2454 #define FF_BUG_NO_PADDING 16
2455 #define FF_BUG_AMV 32
2457 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2459 #define FF_BUG_QPEL_CHROMA 64
2460 #define FF_BUG_STD_QPEL 128
2461 #define FF_BUG_QPEL_CHROMA2 256
2462 #define FF_BUG_DIRECT_BLOCKSIZE 512
2463 #define FF_BUG_EDGE 1024
2464 #define FF_BUG_HPEL_CHROMA 2048
2465 #define FF_BUG_DC_CLIP 4096
2466 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2467 #define FF_BUG_TRUNCATED 16384
2470 * strictly follow the standard (MPEG4, ...).
2471 * - encoding: Set by user.
2472 * - decoding: Set by user.
2473 * Setting this to STRICT or higher means the encoder and decoder will
2474 * generally do stupid things, whereas setting it to unofficial or lower
2475 * will mean the encoder might produce output that is not supported by all
2476 * spec-compliant decoders. Decoders don't differentiate between normal,
2477 * unofficial and experimental (that is, they always try to decode things
2478 * when they can) unless they are explicitly asked to behave stupidly
2479 * (=strictly conform to the specs)
2481 int strict_std_compliance;
2482 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2483 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2484 #define FF_COMPLIANCE_NORMAL 0
2485 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2486 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2489 * error concealment flags
2490 * - encoding: unused
2491 * - decoding: Set by user.
2493 int error_concealment;
2494 #define FF_EC_GUESS_MVS 1
2495 #define FF_EC_DEBLOCK 2
2499 * - encoding: Set by user.
2500 * - decoding: Set by user.
2503 #define FF_DEBUG_PICT_INFO 1
2504 #define FF_DEBUG_RC 2
2505 #define FF_DEBUG_BITSTREAM 4
2506 #define FF_DEBUG_MB_TYPE 8
2507 #define FF_DEBUG_QP 16
2510 * @deprecated this option does nothing
2512 #define FF_DEBUG_MV 32
2514 #define FF_DEBUG_DCT_COEFF 0x00000040
2515 #define FF_DEBUG_SKIP 0x00000080
2516 #define FF_DEBUG_STARTCODE 0x00000100
2517 #define FF_DEBUG_PTS 0x00000200
2518 #define FF_DEBUG_ER 0x00000400
2519 #define FF_DEBUG_MMCO 0x00000800
2520 #define FF_DEBUG_BUGS 0x00001000
2522 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2523 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2525 #define FF_DEBUG_BUFFERS 0x00008000
2526 #define FF_DEBUG_THREADS 0x00010000
2531 * Code outside libavcodec should access this field using AVOptions
2532 * - encoding: Set by user.
2533 * - decoding: Set by user.
2536 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2537 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2538 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2542 * Error recognition; may misdetect some more or less valid parts as errors.
2543 * - encoding: unused
2544 * - decoding: Set by user.
2546 int err_recognition;
2549 * Verify checksums embedded in the bitstream (could be of either encoded or
2550 * decoded data, depending on the codec) and print an error message on mismatch.
2551 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2552 * decoder returning an error.
2554 #define AV_EF_CRCCHECK (1<<0)
2555 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2556 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2557 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2559 #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
2560 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliancies as errors
2561 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2565 * opaque 64bit number (generally a PTS) that will be reordered and
2566 * output in AVFrame.reordered_opaque
2567 * @deprecated in favor of pkt_pts
2568 * - encoding: unused
2569 * - decoding: Set by user.
2571 int64_t reordered_opaque;
2574 * Hardware accelerator in use
2575 * - encoding: unused.
2576 * - decoding: Set by libavcodec
2578 struct AVHWAccel *hwaccel;
2581 * Hardware accelerator context.
2582 * For some hardware accelerators, a global context needs to be
2583 * provided by the user. In that case, this holds display-dependent
2584 * data FFmpeg cannot instantiate itself. Please refer to the
2585 * FFmpeg HW accelerator documentation to know how to fill this
2586 * is. e.g. for VA API, this is a struct vaapi_context.
2587 * - encoding: unused
2588 * - decoding: Set by user
2590 void *hwaccel_context;
2594 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2595 * - decoding: unused
2597 uint64_t error[AV_NUM_DATA_POINTERS];
2600 * DCT algorithm, see FF_DCT_* below
2601 * - encoding: Set by user.
2602 * - decoding: unused
2605 #define FF_DCT_AUTO 0
2606 #define FF_DCT_FASTINT 1
2607 #define FF_DCT_INT 2
2608 #define FF_DCT_MMX 3
2609 #define FF_DCT_ALTIVEC 5
2610 #define FF_DCT_FAAN 6
2613 * IDCT algorithm, see FF_IDCT_* below.
2614 * - encoding: Set by user.
2615 * - decoding: Set by user.
2618 #define FF_IDCT_AUTO 0
2619 #define FF_IDCT_INT 1
2620 #define FF_IDCT_SIMPLE 2
2621 #define FF_IDCT_SIMPLEMMX 3
2622 #define FF_IDCT_ARM 7
2623 #define FF_IDCT_ALTIVEC 8
2625 #define FF_IDCT_SH4 9
2627 #define FF_IDCT_SIMPLEARM 10
2628 #define FF_IDCT_IPP 13
2629 #define FF_IDCT_XVIDMMX 14
2630 #define FF_IDCT_SIMPLEARMV5TE 16
2631 #define FF_IDCT_SIMPLEARMV6 17
2632 #if FF_API_ARCH_SPARC
2633 #define FF_IDCT_SIMPLEVIS 18
2635 #define FF_IDCT_FAAN 20
2636 #define FF_IDCT_SIMPLENEON 22
2637 #if FF_API_ARCH_ALPHA
2638 #define FF_IDCT_SIMPLEALPHA 23
2642 * bits per sample/pixel from the demuxer (needed for huffyuv).
2643 * - encoding: Set by libavcodec.
2644 * - decoding: Set by user.
2646 int bits_per_coded_sample;
2649 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2650 * - encoding: set by user.
2651 * - decoding: set by libavcodec.
2653 int bits_per_raw_sample;
2657 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2658 * - encoding: unused
2659 * - decoding: Set by user.
2660 * Code outside libavcodec should access this field using:
2661 * av_codec_{get,set}_lowres(avctx)
2667 * the picture in the bitstream
2668 * - encoding: Set by libavcodec.
2669 * - decoding: unused
2671 AVFrame *coded_frame;
2675 * is used to decide how many independent tasks should be passed to execute()
2676 * - encoding: Set by user.
2677 * - decoding: Set by user.
2682 * Which multithreading methods to use.
2683 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2684 * so clients which cannot provide future frames should not use it.
2686 * - encoding: Set by user, otherwise the default is used.
2687 * - decoding: Set by user, otherwise the default is used.
2690 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2691 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2694 * Which multithreading methods are in use by the codec.
2695 * - encoding: Set by libavcodec.
2696 * - decoding: Set by libavcodec.
2698 int active_thread_type;
2701 * Set by the client if its custom get_buffer() callback can be called
2702 * synchronously from another thread, which allows faster multithreaded decoding.
2703 * draw_horiz_band() will be called from other threads regardless of this setting.
2704 * Ignored if the default get_buffer() is used.
2705 * - encoding: Set by user.
2706 * - decoding: Set by user.
2708 int thread_safe_callbacks;
2711 * The codec may call this to execute several independent things.
2712 * It will return only after finishing all tasks.
2713 * The user may replace this with some multithreaded implementation,
2714 * the default implementation will execute the parts serially.
2715 * @param count the number of things to execute
2716 * - encoding: Set by libavcodec, user can override.
2717 * - decoding: Set by libavcodec, user can override.
2719 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2722 * The codec may call this to execute several independent things.
2723 * It will return only after finishing all tasks.
2724 * The user may replace this with some multithreaded implementation,
2725 * the default implementation will execute the parts serially.
2726 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2727 * @param c context passed also to func
2728 * @param count the number of things to execute
2729 * @param arg2 argument passed unchanged to func
2730 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2731 * @param func function that will be called count times, with jobnr from 0 to count-1.
2732 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2733 * two instances of func executing at the same time will have the same threadnr.
2734 * @return always 0 currently, but code should handle a future improvement where when any call to func
2735 * returns < 0 no further calls to func may be done and < 0 is returned.
2736 * - encoding: Set by libavcodec, user can override.
2737 * - decoding: Set by libavcodec, user can override.
2739 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2741 #if FF_API_THREAD_OPAQUE
2743 * @deprecated this field should not be used from outside of lavc
2745 attribute_deprecated
2746 void *thread_opaque;
2750 * noise vs. sse weight for the nsse comparsion function
2751 * - encoding: Set by user.
2752 * - decoding: unused
2758 * - encoding: Set by user.
2759 * - decoding: Set by libavcodec.
2762 #define FF_PROFILE_UNKNOWN -99
2763 #define FF_PROFILE_RESERVED -100
2765 #define FF_PROFILE_AAC_MAIN 0
2766 #define FF_PROFILE_AAC_LOW 1
2767 #define FF_PROFILE_AAC_SSR 2
2768 #define FF_PROFILE_AAC_LTP 3
2769 #define FF_PROFILE_AAC_HE 4
2770 #define FF_PROFILE_AAC_HE_V2 28
2771 #define FF_PROFILE_AAC_LD 22
2772 #define FF_PROFILE_AAC_ELD 38
2773 #define FF_PROFILE_MPEG2_AAC_LOW 128
2774 #define FF_PROFILE_MPEG2_AAC_HE 131
2776 #define FF_PROFILE_DTS 20
2777 #define FF_PROFILE_DTS_ES 30
2778 #define FF_PROFILE_DTS_96_24 40
2779 #define FF_PROFILE_DTS_HD_HRA 50
2780 #define FF_PROFILE_DTS_HD_MA 60
2782 #define FF_PROFILE_MPEG2_422 0
2783 #define FF_PROFILE_MPEG2_HIGH 1
2784 #define FF_PROFILE_MPEG2_SS 2
2785 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2786 #define FF_PROFILE_MPEG2_MAIN 4
2787 #define FF_PROFILE_MPEG2_SIMPLE 5
2789 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2790 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2792 #define FF_PROFILE_H264_BASELINE 66
2793 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2794 #define FF_PROFILE_H264_MAIN 77
2795 #define FF_PROFILE_H264_EXTENDED 88
2796 #define FF_PROFILE_H264_HIGH 100
2797 #define FF_PROFILE_H264_HIGH_10 110
2798 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2799 #define FF_PROFILE_H264_HIGH_422 122
2800 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2801 #define FF_PROFILE_H264_HIGH_444 144
2802 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2803 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2804 #define FF_PROFILE_H264_CAVLC_444 44
2806 #define FF_PROFILE_VC1_SIMPLE 0
2807 #define FF_PROFILE_VC1_MAIN 1
2808 #define FF_PROFILE_VC1_COMPLEX 2
2809 #define FF_PROFILE_VC1_ADVANCED 3
2811 #define FF_PROFILE_MPEG4_SIMPLE 0
2812 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2813 #define FF_PROFILE_MPEG4_CORE 2
2814 #define FF_PROFILE_MPEG4_MAIN 3
2815 #define FF_PROFILE_MPEG4_N_BIT 4
2816 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2817 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2818 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2819 #define FF_PROFILE_MPEG4_HYBRID 8
2820 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2821 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2822 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2823 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2824 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2825 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2826 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2828 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2829 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2830 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2831 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2832 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2835 #define FF_PROFILE_HEVC_MAIN 1
2836 #define FF_PROFILE_HEVC_MAIN_10 2
2837 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2841 * - encoding: Set by user.
2842 * - decoding: Set by libavcodec.
2845 #define FF_LEVEL_UNKNOWN -99
2848 * Skip loop filtering for selected frames.
2849 * - encoding: unused
2850 * - decoding: Set by user.
2852 enum AVDiscard skip_loop_filter;
2855 * Skip IDCT/dequantization for selected frames.
2856 * - encoding: unused
2857 * - decoding: Set by user.
2859 enum AVDiscard skip_idct;
2862 * Skip decoding for selected frames.
2863 * - encoding: unused
2864 * - decoding: Set by user.
2866 enum AVDiscard skip_frame;
2869 * Header containing style information for text subtitles.
2870 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2871 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2872 * the Format line following. It shouldn't include any Dialogue line.
2873 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2874 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2876 uint8_t *subtitle_header;
2877 int subtitle_header_size;
2879 #if FF_API_ERROR_RATE
2881 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2884 attribute_deprecated
2888 #if FF_API_CODEC_PKT
2890 * @deprecated this field is not supposed to be accessed from outside lavc
2892 attribute_deprecated
2897 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2898 * Used for compliant TS muxing.
2899 * - encoding: Set by libavcodec.
2900 * - decoding: unused.
2905 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2906 * Code outside libavcodec should access this field using:
2907 * av_codec_{get,set}_pkt_timebase(avctx)
2908 * - encoding unused.
2909 * - decoding set by user.
2911 AVRational pkt_timebase;
2915 * Code outside libavcodec should access this field using:
2916 * av_codec_{get,set}_codec_descriptor(avctx)
2917 * - encoding: unused.
2918 * - decoding: set by libavcodec.
2920 const AVCodecDescriptor *codec_descriptor;
2924 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2925 * - encoding: unused
2926 * - decoding: Set by user.
2927 * Code outside libavcodec should access this field using:
2928 * av_codec_{get,set}_lowres(avctx)
2934 * Current statistics for PTS correction.
2935 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2936 * - encoding: unused
2938 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2939 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2940 int64_t pts_correction_last_pts; /// PTS of the last frame
2941 int64_t pts_correction_last_dts; /// DTS of the last frame
2944 * Character encoding of the input subtitles file.
2945 * - decoding: set by user
2946 * - encoding: unused
2951 * Subtitles character encoding mode. Formats or codecs might be adjusting
2952 * this setting (if they are doing the conversion themselves for instance).
2953 * - decoding: set by libavcodec
2954 * - encoding: unused
2956 int sub_charenc_mode;
2957 #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)
2958 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
2959 #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
2962 * Skip processing alpha if supported by codec.
2963 * Note that if the format uses pre-multiplied alpha (common with VP6,
2964 * and recommended due to better video quality/compression)
2965 * the image will look as if alpha-blended onto a black background.
2966 * However for formats that do not use pre-multiplied alpha
2967 * there might be serious artefacts (though e.g. libswscale currently
2968 * assumes pre-multiplied alpha anyway).
2969 * Code outside libavcodec should access this field using AVOptions
2971 * - decoding: set by user
2972 * - encoding: unused
2977 * Number of samples to skip after a discontinuity
2978 * - decoding: unused
2979 * - encoding: set by libavcodec
2983 #if !FF_API_DEBUG_MV
2985 * debug motion vectors
2986 * Code outside libavcodec should access this field using AVOptions
2987 * - encoding: Set by user.
2988 * - decoding: Set by user.
2991 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2992 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2993 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2997 * custom intra quantization matrix
2998 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
2999 * - encoding: Set by user, can be NULL.
3000 * - decoding: unused.
3002 uint16_t *chroma_intra_matrix;
3005 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3006 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3008 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3009 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3011 int av_codec_get_lowres(const AVCodecContext *avctx);
3012 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3014 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3015 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3017 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3018 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3023 typedef struct AVProfile {
3025 const char *name; ///< short name for the profile
3028 typedef struct AVCodecDefault AVCodecDefault;
3035 typedef struct AVCodec {
3037 * Name of the codec implementation.
3038 * The name is globally unique among encoders and among decoders (but an
3039 * encoder and a decoder can share the same name).
3040 * This is the primary way to find a codec from the user perspective.
3044 * Descriptive name for the codec, meant to be more human readable than name.
3045 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3047 const char *long_name;
3048 enum AVMediaType type;
3051 * Codec capabilities.
3055 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3056 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3057 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3058 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3059 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3061 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3063 const AVClass *priv_class; ///< AVClass for the private context
3064 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3066 /*****************************************************************
3067 * No fields below this line are part of the public API. They
3068 * may not be used outside of libavcodec and can be changed and
3070 * New public fields should be added right above.
3071 *****************************************************************
3074 struct AVCodec *next;
3076 * @name Frame-level threading support functions
3080 * If defined, called on thread contexts when they are created.
3081 * If the codec allocates writable tables in init(), re-allocate them here.
3082 * priv_data will be set to a copy of the original.
3084 int (*init_thread_copy)(AVCodecContext *);
3086 * Copy necessary context variables from a previous thread context to the current one.
3087 * If not defined, the next thread will start automatically; otherwise, the codec
3088 * must call ff_thread_finish_setup().
3090 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3092 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3096 * Private codec-specific defaults.
3098 const AVCodecDefault *defaults;
3101 * Initialize codec static data, called from avcodec_register().
3103 void (*init_static_data)(struct AVCodec *codec);
3105 int (*init)(AVCodecContext *);
3106 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3107 const struct AVSubtitle *sub);
3109 * Encode data to an AVPacket.
3111 * @param avctx codec context
3112 * @param avpkt output AVPacket (may contain a user-provided buffer)
3113 * @param[in] frame AVFrame containing the raw data to be encoded
3114 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3115 * non-empty packet was returned in avpkt.
3116 * @return 0 on success, negative error code on failure
3118 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3119 int *got_packet_ptr);
3120 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3121 int (*close)(AVCodecContext *);
3124 * Will be called when seeking
3126 void (*flush)(AVCodecContext *);
3129 int av_codec_get_max_lowres(const AVCodec *codec);
3131 struct MpegEncContext;
3136 typedef struct AVHWAccel {
3138 * Name of the hardware accelerated codec.
3139 * The name is globally unique among encoders and among decoders (but an
3140 * encoder and a decoder can share the same name).
3145 * Type of codec implemented by the hardware accelerator.
3147 * See AVMEDIA_TYPE_xxx
3149 enum AVMediaType type;
3152 * Codec implemented by the hardware accelerator.
3154 * See AV_CODEC_ID_xxx
3159 * Supported pixel format.
3161 * Only hardware accelerated formats are supported here.
3163 enum AVPixelFormat pix_fmt;
3166 * Hardware accelerated codec capabilities.
3167 * see FF_HWACCEL_CODEC_CAP_*
3171 struct AVHWAccel *next;
3174 * Called at the beginning of each frame or field picture.
3176 * Meaningful frame information (codec specific) is guaranteed to
3177 * be parsed at this point. This function is mandatory.
3179 * Note that buf can be NULL along with buf_size set to 0.
3180 * Otherwise, this means the whole frame is available at this point.
3182 * @param avctx the codec context
3183 * @param buf the frame data buffer base
3184 * @param buf_size the size of the frame in bytes
3185 * @return zero if successful, a negative value otherwise
3187 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3190 * Callback for each slice.
3192 * Meaningful slice information (codec specific) is guaranteed to
3193 * be parsed at this point. This function is mandatory.
3194 * The only exception is XvMC, that works on MB level.
3196 * @param avctx the codec context
3197 * @param buf the slice data buffer base
3198 * @param buf_size the size of the slice in bytes
3199 * @return zero if successful, a negative value otherwise
3201 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3204 * Called at the end of each frame or field picture.
3206 * The whole picture is parsed at this point and can now be sent
3207 * to the hardware accelerator. This function is mandatory.
3209 * @param avctx the codec context
3210 * @return zero if successful, a negative value otherwise
3212 int (*end_frame)(AVCodecContext *avctx);
3215 * Size of HW accelerator private data.
3217 * Private data is allocated with av_mallocz() before
3218 * AVCodecContext.get_buffer() and deallocated after
3219 * AVCodecContext.release_buffer().
3224 * Called for every Macroblock in a slice.
3226 * XvMC uses it to replace the ff_MPV_decode_mb().
3227 * Instead of decoding to raw picture, MB parameters are
3228 * stored in an array provided by the video driver.
3230 * @param s the mpeg context
3232 void (*decode_mb)(struct MpegEncContext *s);
3236 * @defgroup lavc_picture AVPicture
3238 * Functions for working with AVPicture
3243 * Picture data structure.
3245 * Up to four components can be stored into it, the last component is
3248 typedef struct AVPicture {
3249 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3250 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3257 enum AVSubtitleType {
3260 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3263 * Plain text, the text field must be set by the decoder and is
3264 * authoritative. ass and pict fields may contain approximations.
3269 * Formatted text, the ass field must be set by the decoder and is
3270 * authoritative. pict and text fields may contain approximations.
3275 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3277 typedef struct AVSubtitleRect {
3278 int x; ///< top left corner of pict, undefined when pict is not set
3279 int y; ///< top left corner of pict, undefined when pict is not set
3280 int w; ///< width of pict, undefined when pict is not set
3281 int h; ///< height of pict, undefined when pict is not set
3282 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3285 * data+linesize for the bitmap of this subtitle.
3286 * can be set for text/ass as well once they where rendered
3289 enum AVSubtitleType type;
3291 char *text; ///< 0 terminated plain UTF-8 text
3294 * 0 terminated ASS/SSA compatible event line.
3295 * The presentation of this is unaffected by the other values in this
3303 typedef struct AVSubtitle {
3304 uint16_t format; /* 0 = graphics */
3305 uint32_t start_display_time; /* relative to packet pts, in ms */
3306 uint32_t end_display_time; /* relative to packet pts, in ms */
3308 AVSubtitleRect **rects;
3309 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3313 * If c is NULL, returns the first registered codec,
3314 * if c is non-NULL, returns the next registered codec after c,
3315 * or NULL if c is the last one.
3317 AVCodec *av_codec_next(const AVCodec *c);
3320 * Return the LIBAVCODEC_VERSION_INT constant.
3322 unsigned avcodec_version(void);
3325 * Return the libavcodec build-time configuration.
3327 const char *avcodec_configuration(void);
3330 * Return the libavcodec license.
3332 const char *avcodec_license(void);
3335 * Register the codec codec and initialize libavcodec.
3337 * @warning either this function or avcodec_register_all() must be called
3338 * before any other libavcodec functions.
3340 * @see avcodec_register_all()
3342 void avcodec_register(AVCodec *codec);
3345 * Register all the codecs, parsers and bitstream filters which were enabled at
3346 * configuration time. If you do not call this function you can select exactly
3347 * which formats you want to support, by using the individual registration
3350 * @see avcodec_register
3351 * @see av_register_codec_parser
3352 * @see av_register_bitstream_filter
3354 void avcodec_register_all(void);
3357 * Allocate an AVCodecContext and set its fields to default values. The
3358 * resulting struct can be deallocated by calling avcodec_close() on it followed
3361 * @param codec if non-NULL, allocate private data and initialize defaults
3362 * for the given codec. It is illegal to then call avcodec_open2()
3363 * with a different codec.
3364 * If NULL, then the codec-specific defaults won't be initialized,
3365 * which may result in suboptimal default settings (this is
3366 * important mainly for encoders, e.g. libx264).
3368 * @return An AVCodecContext filled with default values or NULL on failure.
3369 * @see avcodec_get_context_defaults
3371 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3374 * Set the fields of the given AVCodecContext to default values corresponding
3375 * to the given codec (defaults may be codec-dependent).
3377 * Do not call this function if a non-NULL codec has been passed
3378 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3379 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3380 * different codec on this AVCodecContext.
3382 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3385 * Get the AVClass for AVCodecContext. It can be used in combination with
3386 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3388 * @see av_opt_find().
3390 const AVClass *avcodec_get_class(void);
3393 * Get the AVClass for AVFrame. It can be used in combination with
3394 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3396 * @see av_opt_find().
3398 const AVClass *avcodec_get_frame_class(void);
3401 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3402 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3404 * @see av_opt_find().
3406 const AVClass *avcodec_get_subtitle_rect_class(void);
3409 * Copy the settings of the source AVCodecContext into the destination
3410 * AVCodecContext. The resulting destination codec context will be
3411 * unopened, i.e. you are required to call avcodec_open2() before you
3412 * can use this AVCodecContext to decode/encode video/audio data.
3414 * @param dest target codec context, should be initialized with
3415 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3416 * @param src source codec context
3417 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3419 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3421 #if FF_API_AVFRAME_LAVC
3423 * @deprecated use av_frame_alloc()
3425 attribute_deprecated
3426 AVFrame *avcodec_alloc_frame(void);
3429 * Set the fields of the given AVFrame to default values.
3431 * @param frame The AVFrame of which the fields should be set to default values.
3433 * @deprecated use av_frame_unref()
3435 attribute_deprecated
3436 void avcodec_get_frame_defaults(AVFrame *frame);
3439 * Free the frame and any dynamically allocated objects in it,
3440 * e.g. extended_data.
3442 * @param frame frame to be freed. The pointer will be set to NULL.
3444 * @warning this function does NOT free the data buffers themselves
3445 * (it does not know how, since they might have been allocated with
3446 * a custom get_buffer()).
3448 * @deprecated use av_frame_free()
3450 attribute_deprecated
3451 void avcodec_free_frame(AVFrame **frame);
3455 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3456 * function the context has to be allocated with avcodec_alloc_context3().
3458 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3459 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3460 * retrieving a codec.
3462 * @warning This function is not thread safe!
3465 * avcodec_register_all();
3466 * av_dict_set(&opts, "b", "2.5M", 0);
3467 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3471 * context = avcodec_alloc_context3(codec);
3473 * if (avcodec_open2(context, codec, opts) < 0)
3477 * @param avctx The context to initialize.
3478 * @param codec The codec to open this context for. If a non-NULL codec has been
3479 * previously passed to avcodec_alloc_context3() or
3480 * avcodec_get_context_defaults3() for this context, then this
3481 * parameter MUST be either NULL or equal to the previously passed
3483 * @param options A dictionary filled with AVCodecContext and codec-private options.
3484 * On return this object will be filled with options that were not found.
3486 * @return zero on success, a negative value on error
3487 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3488 * av_dict_set(), av_opt_find().
3490 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3493 * Close a given AVCodecContext and free all the data associated with it
3494 * (but not the AVCodecContext itself).
3496 * Calling this function on an AVCodecContext that hasn't been opened will free
3497 * the codec-specific data allocated in avcodec_alloc_context3() /
3498 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3501 int avcodec_close(AVCodecContext *avctx);
3504 * Free all allocated data in the given subtitle struct.
3506 * @param sub AVSubtitle to free.
3508 void avsubtitle_free(AVSubtitle *sub);
3515 * @addtogroup lavc_packet
3519 #if FF_API_DESTRUCT_PACKET
3521 * Default packet destructor.
3522 * @deprecated use the AVBuffer API instead
3524 attribute_deprecated
3525 void av_destruct_packet(AVPacket *pkt);
3529 * Initialize optional fields of a packet with default values.
3531 * Note, this does not touch the data and size members, which have to be
3532 * initialized separately.
3536 void av_init_packet(AVPacket *pkt);
3539 * Allocate the payload of a packet and initialize its fields with
3543 * @param size wanted payload size
3544 * @return 0 if OK, AVERROR_xxx otherwise
3546 int av_new_packet(AVPacket *pkt, int size);
3549 * Reduce packet size, correctly zeroing padding
3552 * @param size new size
3554 void av_shrink_packet(AVPacket *pkt, int size);
3557 * Increase packet size, correctly zeroing padding
3560 * @param grow_by number of bytes by which to increase the size of the packet
3562 int av_grow_packet(AVPacket *pkt, int grow_by);
3565 * Initialize a reference-counted packet from av_malloc()ed data.
3567 * @param pkt packet to be initialized. This function will set the data, size,
3568 * buf and destruct fields, all others are left untouched.
3569 * @param data Data allocated by av_malloc() to be used as packet data. If this
3570 * function returns successfully, the data is owned by the underlying AVBuffer.
3571 * The caller may not access the data through other means.
3572 * @param size size of data in bytes, without the padding. I.e. the full buffer
3573 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3575 * @return 0 on success, a negative AVERROR on error
3577 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3580 * @warning This is a hack - the packet memory allocation stuff is broken. The
3581 * packet is allocated if it was not really allocated.
3583 int av_dup_packet(AVPacket *pkt);
3586 * Copy packet, including contents
3588 * @return 0 on success, negative AVERROR on fail
3590 int av_copy_packet(AVPacket *dst, AVPacket *src);
3593 * Copy packet side data
3595 * @return 0 on success, negative AVERROR on fail
3597 int av_copy_packet_side_data(AVPacket *dst, AVPacket *src);
3602 * @param pkt packet to free
3604 void av_free_packet(AVPacket *pkt);
3607 * Allocate new information of a packet.
3610 * @param type side information type
3611 * @param size side information size
3612 * @return pointer to fresh allocated data or NULL otherwise
3614 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3618 * Shrink the already allocated side data buffer
3621 * @param type side information type
3622 * @param size new side information size
3623 * @return 0 on success, < 0 on failure
3625 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3629 * Get side information from packet.
3632 * @param type desired side information type
3633 * @param size pointer for side information size to store (optional)
3634 * @return pointer to data if present or NULL otherwise
3636 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3639 int av_packet_merge_side_data(AVPacket *pkt);
3641 int av_packet_split_side_data(AVPacket *pkt);
3644 * Pack a dictionary for use in side_data.
3646 * @param dict The dictionary to pack.
3647 * @param size pointer to store the size of the returned data
3648 * @return pointer to data if successful, NULL otherwise
3650 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
3652 * Unpack a dictionary from side_data.
3654 * @param data data from side_data
3655 * @param size size of the data
3656 * @param dict the metadata storage dictionary
3657 * @return 0 on success, < 0 on failure
3659 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
3663 * Convenience function to free all the side data stored.
3664 * All the other fields stay untouched.
3668 void av_packet_free_side_data(AVPacket *pkt);
3671 * Setup a new reference to the data described by a given packet
3673 * If src is reference-counted, setup dst as a new reference to the
3674 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3675 * data from src into it.
3677 * All the other fields are copied from src.
3679 * @see av_packet_unref
3681 * @param dst Destination packet
3682 * @param src Source packet
3684 * @return 0 on success, a negative AVERROR on error.
3686 int av_packet_ref(AVPacket *dst, AVPacket *src);
3691 * Unreference the buffer referenced by the packet and reset the
3692 * remaining packet fields to their default values.
3694 * @param pkt The packet to be unreferenced.
3696 void av_packet_unref(AVPacket *pkt);
3699 * Move every field in src to dst and reset src.
3701 * @see av_packet_unref
3703 * @param src Source packet, will be reset
3704 * @param dst Destination packet
3706 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3709 * Copy only "properties" fields from src to dst.
3711 * Properties for the purpose of this function are all the fields
3712 * beside those related to the packet data (buf, data, size)
3714 * @param dst Destination packet
3715 * @param src Source packet
3717 * @return 0 on success AVERROR on failure.
3720 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3727 * @addtogroup lavc_decoding
3732 * Find a registered decoder with a matching codec ID.
3734 * @param id AVCodecID of the requested decoder
3735 * @return A decoder if one was found, NULL otherwise.
3737 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3740 * Find a registered decoder with the specified name.
3742 * @param name name of the requested decoder
3743 * @return A decoder if one was found, NULL otherwise.
3745 AVCodec *avcodec_find_decoder_by_name(const char *name);
3747 #if FF_API_GET_BUFFER
3748 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3749 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3750 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3754 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3755 * it can be called by custom get_buffer2() implementations for decoders without
3756 * CODEC_CAP_DR1 set.
3758 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3762 * Return the amount of padding in pixels which the get_buffer callback must
3763 * provide around the edge of the image for codecs which do not have the
3764 * CODEC_FLAG_EMU_EDGE flag.
3766 * @return Required padding in pixels.
3768 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
3771 attribute_deprecated
3772 unsigned avcodec_get_edge_width(void);
3776 * Modify width and height values so that they will result in a memory
3777 * buffer that is acceptable for the codec if you do not use any horizontal
3780 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3782 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3785 * Modify width and height values so that they will result in a memory
3786 * buffer that is acceptable for the codec if you also ensure that all
3787 * line sizes are a multiple of the respective linesize_align[i].
3789 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3791 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3792 int linesize_align[AV_NUM_DATA_POINTERS]);
3795 * Converts AVChromaLocation to swscale x/y chroma position.
3797 * The positions represent the chroma (0,0) position in a coordinates system
3798 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3800 * @param xpos horizontal chroma sample position
3801 * @param ypos vertical chroma sample position
3803 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
3806 * Converts swscale x/y chroma position to AVChromaLocation.
3808 * The positions represent the chroma (0,0) position in a coordinates system
3809 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3811 * @param xpos horizontal chroma sample position
3812 * @param ypos vertical chroma sample position
3814 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
3816 #if FF_API_OLD_DECODE_AUDIO
3818 * Wrapper function which calls avcodec_decode_audio4.
3820 * @deprecated Use avcodec_decode_audio4 instead.
3822 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3823 * Some decoders may support multiple frames in a single AVPacket, such
3824 * decoders would then just decode the first frame. In this case,
3825 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3826 * the remaining data in order to decode the second frame etc.
3828 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3829 * decompressed frame size in bytes.
3831 * @warning You must set frame_size_ptr to the allocated size of the
3832 * output buffer before calling avcodec_decode_audio3().
3834 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3835 * the actual read bytes because some optimized bitstream readers read 32 or 64
3836 * bits at once and could read over the end.
3838 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3839 * no overreading happens for damaged MPEG streams.
3841 * @warning You must not provide a custom get_buffer() when using
3842 * avcodec_decode_audio3(). Doing so will override it with
3843 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3844 * which does allow the application to provide a custom get_buffer().
3846 * @note You might have to align the input buffer avpkt->data and output buffer
3847 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3848 * necessary at all, on others it won't work at all if not aligned and on others
3849 * it will work but it will have an impact on performance.
3851 * In practice, avpkt->data should have 4 byte alignment at minimum and
3852 * samples should be 16 byte aligned unless the CPU doesn't need it
3853 * (AltiVec and SSE do).
3855 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3856 * between input and output, these need to be fed with avpkt->data=NULL,
3857 * avpkt->size=0 at the end to return the remaining frames.
3859 * @param avctx the codec context
3860 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3861 * If the sample format is planar, each channel plane will
3862 * be the same size, with no padding between channels.
3863 * @param[in,out] frame_size_ptr the output buffer size in bytes
3864 * @param[in] avpkt The input AVPacket containing the input buffer.
3865 * You can create such packet with av_init_packet() and by then setting
3866 * data and size, some decoders might in addition need other fields.
3867 * All decoders are designed to use the least fields possible though.
3868 * @return On error a negative value is returned, otherwise the number of bytes
3869 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3871 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3872 int *frame_size_ptr,
3877 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3879 * Some decoders may support multiple frames in a single AVPacket. Such
3880 * decoders would then just decode the first frame and the return value would be
3881 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3882 * called again with an AVPacket containing the remaining data in order to
3883 * decode the second frame, etc... Even if no frames are returned, the packet
3884 * needs to be fed to the decoder with remaining data until it is completely
3885 * consumed or an error occurs.
3887 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3888 * and output. This means that for some packets they will not immediately
3889 * produce decoded output and need to be flushed at the end of decoding to get
3890 * all the decoded data. Flushing is done by calling this function with packets
3891 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3892 * returning samples. It is safe to flush even those decoders that are not
3893 * marked with CODEC_CAP_DELAY, then no samples will be returned.
3895 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3896 * larger than the actual read bytes because some optimized bitstream
3897 * readers read 32 or 64 bits at once and could read over the end.
3899 * @param avctx the codec context
3900 * @param[out] frame The AVFrame in which to store decoded audio samples.
3901 * The decoder will allocate a buffer for the decoded frame by
3902 * calling the AVCodecContext.get_buffer2() callback.
3903 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3904 * reference counted and the returned reference belongs to the
3905 * caller. The caller must release the frame using av_frame_unref()
3906 * when the frame is no longer needed. The caller may safely write
3907 * to the frame if av_frame_is_writable() returns 1.
3908 * When AVCodecContext.refcounted_frames is set to 0, the returned
3909 * reference belongs to the decoder and is valid only until the
3910 * next call to this function or until closing or flushing the
3911 * decoder. The caller may not write to it.
3912 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3913 * non-zero. Note that this field being set to zero
3914 * does not mean that an error has occurred. For
3915 * decoders with CODEC_CAP_DELAY set, no given decode
3916 * call is guaranteed to produce a frame.
3917 * @param[in] avpkt The input AVPacket containing the input buffer.
3918 * At least avpkt->data and avpkt->size should be set. Some
3919 * decoders might also require additional fields to be set.
3920 * @return A negative error code is returned if an error occurred during
3921 * decoding, otherwise the number of bytes consumed from the input
3922 * AVPacket is returned.
3924 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3925 int *got_frame_ptr, const AVPacket *avpkt);
3928 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3929 * Some decoders may support multiple frames in a single AVPacket, such
3930 * decoders would then just decode the first frame.
3932 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3933 * the actual read bytes because some optimized bitstream readers read 32 or 64
3934 * bits at once and could read over the end.
3936 * @warning The end of the input buffer buf should be set to 0 to ensure that
3937 * no overreading happens for damaged MPEG streams.
3939 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3940 * between input and output, these need to be fed with avpkt->data=NULL,
3941 * avpkt->size=0 at the end to return the remaining frames.
3943 * @param avctx the codec context
3944 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3945 * Use av_frame_alloc() to get an AVFrame. The codec will
3946 * allocate memory for the actual bitmap by calling the
3947 * AVCodecContext.get_buffer2() callback.
3948 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3949 * reference counted and the returned reference belongs to the
3950 * caller. The caller must release the frame using av_frame_unref()
3951 * when the frame is no longer needed. The caller may safely write
3952 * to the frame if av_frame_is_writable() returns 1.
3953 * When AVCodecContext.refcounted_frames is set to 0, the returned
3954 * reference belongs to the decoder and is valid only until the
3955 * next call to this function or until closing or flushing the
3956 * decoder. The caller may not write to it.
3958 * @param[in] avpkt The input AVPacket containing the input buffer.
3959 * You can create such packet with av_init_packet() and by then setting
3960 * data and size, some decoders might in addition need other fields like
3961 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3963 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3964 * @return On error a negative value is returned, otherwise the number of bytes
3965 * used or zero if no frame could be decompressed.
3967 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3968 int *got_picture_ptr,
3969 const AVPacket *avpkt);
3972 * Decode a subtitle message.
3973 * Return a negative value on error, otherwise return the number of bytes used.
3974 * If no subtitle could be decompressed, got_sub_ptr is zero.
3975 * Otherwise, the subtitle is stored in *sub.
3976 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3977 * simplicity, because the performance difference is expect to be negligible
3978 * and reusing a get_buffer written for video codecs would probably perform badly
3979 * due to a potentially very different allocation pattern.
3981 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3982 * and output. This means that for some packets they will not immediately
3983 * produce decoded output and need to be flushed at the end of decoding to get
3984 * all the decoded data. Flushing is done by calling this function with packets
3985 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3986 * returning subtitles. It is safe to flush even those decoders that are not
3987 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
3989 * @param avctx the codec context
3990 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3991 freed with avsubtitle_free if *got_sub_ptr is set.
3992 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3993 * @param[in] avpkt The input AVPacket containing the input buffer.
3995 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4000 * @defgroup lavc_parsing Frame parsing
4004 enum AVPictureStructure {
4005 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4006 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4007 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4008 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4011 typedef struct AVCodecParserContext {
4013 struct AVCodecParser *parser;
4014 int64_t frame_offset; /* offset of the current frame */
4015 int64_t cur_offset; /* current offset
4016 (incremented by each av_parser_parse()) */
4017 int64_t next_frame_offset; /* offset of the next frame */
4019 int pict_type; /* XXX: Put it back in AVCodecContext. */
4021 * This field is used for proper frame duration computation in lavf.
4022 * It signals, how much longer the frame duration of the current frame
4023 * is compared to normal frame duration.
4025 * frame_duration = (1 + repeat_pict) * time_base
4027 * It is used by codecs like H.264 to display telecined material.
4029 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4030 int64_t pts; /* pts of the current frame */
4031 int64_t dts; /* dts of the current frame */
4036 int fetch_timestamp;
4038 #define AV_PARSER_PTS_NB 4
4039 int cur_frame_start_index;
4040 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4041 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4042 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4045 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4046 #define PARSER_FLAG_ONCE 0x0002
4047 /// Set if the parser has a valid file offset
4048 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4049 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4051 int64_t offset; ///< byte offset from starting packet start
4052 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4055 * Set by parser to 1 for key frames and 0 for non-key frames.
4056 * It is initialized to -1, so if the parser doesn't set this flag,
4057 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4063 * Time difference in stream time base units from the pts of this
4064 * packet to the point at which the output from the decoder has converged
4065 * independent from the availability of previous frames. That is, the
4066 * frames are virtually identical no matter if decoding started from
4067 * the very first frame or from this keyframe.
4068 * Is AV_NOPTS_VALUE if unknown.
4069 * This field is not the display duration of the current frame.
4070 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4073 * The purpose of this field is to allow seeking in streams that have no
4074 * keyframes in the conventional sense. It corresponds to the
4075 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4076 * essential for some types of subtitle streams to ensure that all
4077 * subtitles are correctly displayed after seeking.
4079 int64_t convergence_duration;
4081 // Timestamp generation support:
4083 * Synchronization point for start of timestamp generation.
4085 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4088 * For example, this corresponds to presence of H.264 buffering period
4094 * Offset of the current timestamp against last timestamp sync point in
4095 * units of AVCodecContext.time_base.
4097 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4098 * contain a valid timestamp offset.
4100 * Note that the timestamp of sync point has usually a nonzero
4101 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4102 * the next frame after timestamp sync point will be usually 1.
4104 * For example, this corresponds to H.264 cpb_removal_delay.
4106 int dts_ref_dts_delta;
4109 * Presentation delay of current frame in units of AVCodecContext.time_base.
4111 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4112 * contain valid non-negative timestamp delta (presentation time of a frame
4113 * must not lie in the past).
4115 * This delay represents the difference between decoding and presentation
4116 * time of the frame.
4118 * For example, this corresponds to H.264 dpb_output_delay.
4123 * Position of the packet in file.
4125 * Analogous to cur_frame_pts/dts
4127 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4130 * Byte position of currently parsed frame in stream.
4135 * Previous frame byte position.
4140 * Duration of the current frame.
4141 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4142 * For all other types, this is in units of AVCodecContext.time_base.
4146 enum AVFieldOrder field_order;
4149 * Indicate whether a picture is coded as a frame, top field or bottom field.
4151 * For example, H.264 field_pic_flag equal to 0 corresponds to
4152 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4153 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4154 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4156 enum AVPictureStructure picture_structure;
4159 * Picture number incremented in presentation or output order.
4160 * This field may be reinitialized at the first picture of a new sequence.
4162 * For example, this corresponds to H.264 PicOrderCnt.
4164 int output_picture_number;
4165 } AVCodecParserContext;
4167 typedef struct AVCodecParser {
4168 int codec_ids[5]; /* several codec IDs are permitted */
4170 int (*parser_init)(AVCodecParserContext *s);
4171 int (*parser_parse)(AVCodecParserContext *s,
4172 AVCodecContext *avctx,
4173 const uint8_t **poutbuf, int *poutbuf_size,
4174 const uint8_t *buf, int buf_size);
4175 void (*parser_close)(AVCodecParserContext *s);
4176 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4177 struct AVCodecParser *next;
4180 AVCodecParser *av_parser_next(AVCodecParser *c);
4182 void av_register_codec_parser(AVCodecParser *parser);
4183 AVCodecParserContext *av_parser_init(int codec_id);
4188 * @param s parser context.
4189 * @param avctx codec context.
4190 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4191 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4192 * @param buf input buffer.
4193 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4194 * @param pts input presentation timestamp.
4195 * @param dts input decoding timestamp.
4196 * @param pos input byte position in stream.
4197 * @return the number of bytes of the input bitstream used.
4202 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4209 * decode_frame(data, size);
4213 int av_parser_parse2(AVCodecParserContext *s,
4214 AVCodecContext *avctx,
4215 uint8_t **poutbuf, int *poutbuf_size,
4216 const uint8_t *buf, int buf_size,
4217 int64_t pts, int64_t dts,
4221 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4222 * @deprecated use AVBitStreamFilter
4224 int av_parser_change(AVCodecParserContext *s,
4225 AVCodecContext *avctx,
4226 uint8_t **poutbuf, int *poutbuf_size,
4227 const uint8_t *buf, int buf_size, int keyframe);
4228 void av_parser_close(AVCodecParserContext *s);
4236 * @addtogroup lavc_encoding
4241 * Find a registered encoder with a matching codec ID.
4243 * @param id AVCodecID of the requested encoder
4244 * @return An encoder if one was found, NULL otherwise.
4246 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4249 * Find a registered encoder with the specified name.
4251 * @param name name of the requested encoder
4252 * @return An encoder if one was found, NULL otherwise.
4254 AVCodec *avcodec_find_encoder_by_name(const char *name);
4256 #if FF_API_OLD_ENCODE_AUDIO
4258 * Encode an audio frame from samples into buf.
4260 * @deprecated Use avcodec_encode_audio2 instead.
4262 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4263 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4264 * will know how much space is needed because it depends on the value passed
4265 * in buf_size as described below. In that case a lower value can be used.
4267 * @param avctx the codec context
4268 * @param[out] buf the output buffer
4269 * @param[in] buf_size the output buffer size
4270 * @param[in] samples the input buffer containing the samples
4271 * The number of samples read from this buffer is frame_size*channels,
4272 * both of which are defined in avctx.
4273 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4274 * samples read from samples is equal to:
4275 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4276 * This also implies that av_get_bits_per_sample() must not return 0 for these
4278 * @return On error a negative value is returned, on success zero or the number
4279 * of bytes used to encode the data read from the input buffer.
4281 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4282 uint8_t *buf, int buf_size,
4283 const short *samples);
4287 * Encode a frame of audio.
4289 * Takes input samples from frame and writes the next output packet, if
4290 * available, to avpkt. The output packet does not necessarily contain data for
4291 * the most recent frame, as encoders can delay, split, and combine input frames
4292 * internally as needed.
4294 * @param avctx codec context
4295 * @param avpkt output AVPacket.
4296 * The user can supply an output buffer by setting
4297 * avpkt->data and avpkt->size prior to calling the
4298 * function, but if the size of the user-provided data is not
4299 * large enough, encoding will fail. If avpkt->data and
4300 * avpkt->size are set, avpkt->destruct must also be set. All
4301 * other AVPacket fields will be reset by the encoder using
4302 * av_init_packet(). If avpkt->data is NULL, the encoder will
4303 * allocate it. The encoder will set avpkt->size to the size
4304 * of the output packet.
4306 * If this function fails or produces no output, avpkt will be
4307 * freed using av_free_packet() (i.e. avpkt->destruct will be
4308 * called to free the user supplied buffer).
4309 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4310 * May be NULL when flushing an encoder that has the
4311 * CODEC_CAP_DELAY capability set.
4312 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4313 * can have any number of samples.
4314 * If it is not set, frame->nb_samples must be equal to
4315 * avctx->frame_size for all frames except the last.
4316 * The final frame may be smaller than avctx->frame_size.
4317 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4318 * output packet is non-empty, and to 0 if it is
4319 * empty. If the function returns an error, the
4320 * packet can be assumed to be invalid, and the
4321 * value of got_packet_ptr is undefined and should
4323 * @return 0 on success, negative error code on failure
4325 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4326 const AVFrame *frame, int *got_packet_ptr);
4328 #if FF_API_OLD_ENCODE_VIDEO
4330 * @deprecated use avcodec_encode_video2() instead.
4332 * Encode a video frame from pict into buf.
4333 * The input picture should be
4334 * stored using a specific format, namely avctx.pix_fmt.
4336 * @param avctx the codec context
4337 * @param[out] buf the output buffer for the bitstream of encoded frame
4338 * @param[in] buf_size the size of the output buffer in bytes
4339 * @param[in] pict the input picture to encode
4340 * @return On error a negative value is returned, on success zero or the number
4341 * of bytes used from the output buffer.
4343 attribute_deprecated
4344 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4345 const AVFrame *pict);
4349 * Encode a frame of video.
4351 * Takes input raw video data from frame and writes the next output packet, if
4352 * available, to avpkt. The output packet does not necessarily contain data for
4353 * the most recent frame, as encoders can delay and reorder input frames
4354 * internally as needed.
4356 * @param avctx codec context
4357 * @param avpkt output AVPacket.
4358 * The user can supply an output buffer by setting
4359 * avpkt->data and avpkt->size prior to calling the
4360 * function, but if the size of the user-provided data is not
4361 * large enough, encoding will fail. All other AVPacket fields
4362 * will be reset by the encoder using av_init_packet(). If
4363 * avpkt->data is NULL, the encoder will allocate it.
4364 * The encoder will set avpkt->size to the size of the
4365 * output packet. The returned data (if any) belongs to the
4366 * caller, he is responsible for freeing it.
4368 * If this function fails or produces no output, avpkt will be
4369 * freed using av_free_packet() (i.e. avpkt->destruct will be
4370 * called to free the user supplied buffer).
4371 * @param[in] frame AVFrame containing the raw video data to be encoded.
4372 * May be NULL when flushing an encoder that has the
4373 * CODEC_CAP_DELAY capability set.
4374 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4375 * output packet is non-empty, and to 0 if it is
4376 * empty. If the function returns an error, the
4377 * packet can be assumed to be invalid, and the
4378 * value of got_packet_ptr is undefined and should
4380 * @return 0 on success, negative error code on failure
4382 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4383 const AVFrame *frame, int *got_packet_ptr);
4385 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4386 const AVSubtitle *sub);
4393 #if FF_API_AVCODEC_RESAMPLE
4395 * @defgroup lavc_resample Audio resampling
4397 * @deprecated use libswresample instead
4401 struct ReSampleContext;
4402 struct AVResampleContext;
4404 typedef struct ReSampleContext ReSampleContext;
4407 * Initialize audio resampling context.
4409 * @param output_channels number of output channels
4410 * @param input_channels number of input channels
4411 * @param output_rate output sample rate
4412 * @param input_rate input sample rate
4413 * @param sample_fmt_out requested output sample format
4414 * @param sample_fmt_in input sample format
4415 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4416 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4417 * @param linear if 1 then the used FIR filter will be linearly interpolated
4418 between the 2 closest, if 0 the closest will be used
4419 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4420 * @return allocated ReSampleContext, NULL if error occurred
4422 attribute_deprecated
4423 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4424 int output_rate, int input_rate,
4425 enum AVSampleFormat sample_fmt_out,
4426 enum AVSampleFormat sample_fmt_in,
4427 int filter_length, int log2_phase_count,
4428 int linear, double cutoff);
4430 attribute_deprecated
4431 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4434 * Free resample context.
4436 * @param s a non-NULL pointer to a resample context previously
4437 * created with av_audio_resample_init()
4439 attribute_deprecated
4440 void audio_resample_close(ReSampleContext *s);
4444 * Initialize an audio resampler.
4445 * Note, if either rate is not an integer then simply scale both rates up so they are.
4446 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4447 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4448 * @param linear If 1 then the used FIR filter will be linearly interpolated
4449 between the 2 closest, if 0 the closest will be used
4450 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4452 attribute_deprecated
4453 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4456 * Resample an array of samples using a previously configured context.
4457 * @param src an array of unconsumed samples
4458 * @param consumed the number of samples of src which have been consumed are returned here
4459 * @param src_size the number of unconsumed samples available
4460 * @param dst_size the amount of space in samples available in dst
4461 * @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.
4462 * @return the number of samples written in dst or -1 if an error occurred
4464 attribute_deprecated
4465 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4469 * Compensate samplerate/timestamp drift. The compensation is done by changing
4470 * the resampler parameters, so no audible clicks or similar distortions occur
4471 * @param compensation_distance distance in output samples over which the compensation should be performed
4472 * @param sample_delta number of output samples which should be output less
4474 * example: av_resample_compensate(c, 10, 500)
4475 * here instead of 510 samples only 500 samples would be output
4477 * note, due to rounding the actual compensation might be slightly different,
4478 * especially if the compensation_distance is large and the in_rate used during init is small
4480 attribute_deprecated
4481 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4482 attribute_deprecated
4483 void av_resample_close(struct AVResampleContext *c);
4491 * @addtogroup lavc_picture
4496 * Allocate memory for the pixels of a picture and setup the AVPicture
4499 * Call avpicture_free() to free it.
4501 * @param picture the picture structure to be filled in
4502 * @param pix_fmt the pixel format of the picture
4503 * @param width the width of the picture
4504 * @param height the height of the picture
4505 * @return zero if successful, a negative error code otherwise
4507 * @see av_image_alloc(), avpicture_fill()
4509 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4512 * Free a picture previously allocated by avpicture_alloc().
4513 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4516 * @param picture the AVPicture to be freed
4518 void avpicture_free(AVPicture *picture);
4521 * Setup the picture fields based on the specified image parameters
4522 * and the provided image data buffer.
4524 * The picture fields are filled in by using the image data buffer
4525 * pointed to by ptr.
4527 * If ptr is NULL, the function will fill only the picture linesize
4528 * array and return the required size for the image buffer.
4530 * To allocate an image buffer and fill the picture data in one call,
4531 * use avpicture_alloc().
4533 * @param picture the picture to be filled in
4534 * @param ptr buffer where the image data is stored, or NULL
4535 * @param pix_fmt the pixel format of the image
4536 * @param width the width of the image in pixels
4537 * @param height the height of the image in pixels
4538 * @return the size in bytes required for src, a negative error code
4539 * in case of failure
4541 * @see av_image_fill_arrays()
4543 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4544 enum AVPixelFormat pix_fmt, int width, int height);
4547 * Copy pixel data from an AVPicture into a buffer.
4549 * avpicture_get_size() can be used to compute the required size for
4550 * the buffer to fill.
4552 * @param src source picture with filled data
4553 * @param pix_fmt picture pixel format
4554 * @param width picture width
4555 * @param height picture height
4556 * @param dest destination buffer
4557 * @param dest_size destination buffer size in bytes
4558 * @return the number of bytes written to dest, or a negative value
4559 * (error code) on error, for example if the destination buffer is not
4562 * @see av_image_copy_to_buffer()
4564 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4565 int width, int height,
4566 unsigned char *dest, int dest_size);
4569 * Calculate the size in bytes that a picture of the given width and height
4570 * would occupy if stored in the given picture format.
4572 * @param pix_fmt picture pixel format
4573 * @param width picture width
4574 * @param height picture height
4575 * @return the computed picture buffer size or a negative error code
4578 * @see av_image_get_buffer_size().
4580 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4582 #if FF_API_DEINTERLACE
4584 * deinterlace - if not supported return -1
4586 * @deprecated - use yadif (in libavfilter) instead
4588 attribute_deprecated
4589 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4590 enum AVPixelFormat pix_fmt, int width, int height);
4593 * Copy image src to dst. Wraps av_image_copy().
4595 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4596 enum AVPixelFormat pix_fmt, int width, int height);
4599 * Crop image top and left side.
4601 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4602 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4607 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4608 int padtop, int padbottom, int padleft, int padright, int *color);
4615 * @defgroup lavc_misc Utility functions
4618 * Miscellaneous utility functions related to both encoding and decoding
4624 * @defgroup lavc_misc_pixfmt Pixel formats
4626 * Functions for working with pixel formats.
4631 * Utility function to access log2_chroma_w log2_chroma_h from
4632 * the pixel format AVPixFmtDescriptor.
4634 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4635 * for one that returns a failure code and continues in case of invalid
4638 * @param[in] pix_fmt the pixel format
4639 * @param[out] h_shift store log2_chroma_w
4640 * @param[out] v_shift store log2_chroma_h
4642 * @see av_pix_fmt_get_chroma_sub_sample
4645 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4648 * Return a value representing the fourCC code associated to the
4649 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4652 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4654 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4655 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4656 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4657 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4658 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4659 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4662 * Compute what kind of losses will occur when converting from one specific
4663 * pixel format to another.
4664 * When converting from one pixel format to another, information loss may occur.
4665 * For example, when converting from RGB24 to GRAY, the color information will
4666 * be lost. Similarly, other losses occur when converting from some formats to
4667 * other formats. These losses can involve loss of chroma, but also loss of
4668 * resolution, loss of color depth, loss due to the color space conversion, loss
4669 * of the alpha bits or loss due to color quantization.
4670 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4671 * which will occur when converting from one pixel format to another.
4673 * @param[in] dst_pix_fmt destination pixel format
4674 * @param[in] src_pix_fmt source pixel format
4675 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4676 * @return Combination of flags informing you what kind of losses will occur
4677 * (maximum loss for an invalid dst_pix_fmt).
4679 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4683 * Find the best pixel format to convert to given a certain source pixel
4684 * format. When converting from one pixel format to another, information loss
4685 * may occur. For example, when converting from RGB24 to GRAY, the color
4686 * information will be lost. Similarly, other losses occur when converting from
4687 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4688 * the given pixel formats should be used to suffer the least amount of loss.
4689 * The pixel formats from which it chooses one, are determined by the
4690 * pix_fmt_list parameter.
4693 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4694 * @param[in] src_pix_fmt source pixel format
4695 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4696 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4697 * @return The best pixel format to convert to or -1 if none was found.
4699 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4700 enum AVPixelFormat src_pix_fmt,
4701 int has_alpha, int *loss_ptr);
4704 * Find the best pixel format to convert to given a certain source pixel
4705 * format and a selection of two destination pixel formats. When converting from
4706 * one pixel format to another, information loss may occur. For example, when converting
4707 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4708 * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4709 * the given pixel formats should be used to suffer the least amount of loss.
4711 * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be
4715 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4716 * dst_pix_fmt1= AV_PIX_FMT_RGB24;
4717 * dst_pix_fmt2= AV_PIX_FMT_GRAY8;
4718 * dst_pix_fmt3= AV_PIX_FMT_RGB8;
4719 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4720 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4721 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4724 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4725 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4726 * @param[in] src_pix_fmt Source pixel format
4727 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4728 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4729 * NULL or value of zero means we care about all losses. Out: the loss
4730 * that occurs when converting from src to selected dst pixel format.
4731 * @return The best pixel format to convert to or -1 if none was found.
4733 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4734 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4736 attribute_deprecated
4737 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
4738 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
4739 enum AVPixelFormat src_pix_fmt,
4740 int has_alpha, int *loss_ptr);
4742 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4743 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4747 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4753 #if FF_API_SET_DIMENSIONS
4755 * @deprecated this function is not supposed to be used from outside of lavc
4757 attribute_deprecated
4758 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4762 * Put a string representing the codec tag codec_tag in buf.
4764 * @param buf buffer to place codec tag in
4765 * @param buf_size size in bytes of buf
4766 * @param codec_tag codec tag to assign
4767 * @return the length of the string that would have been generated if
4768 * enough space had been available, excluding the trailing null
4770 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4772 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4775 * Return a name for the specified profile, if available.
4777 * @param codec the codec that is searched for the given profile
4778 * @param profile the profile value for which a name is requested
4779 * @return A name for the profile if found, NULL otherwise.
4781 const char *av_get_profile_name(const AVCodec *codec, int profile);
4783 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4784 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4785 //FIXME func typedef
4788 * Fill AVFrame audio data and linesize pointers.
4790 * The buffer buf must be a preallocated buffer with a size big enough
4791 * to contain the specified samples amount. The filled AVFrame data
4792 * pointers will point to this buffer.
4794 * AVFrame extended_data channel pointers are allocated if necessary for
4797 * @param frame the AVFrame
4798 * frame->nb_samples must be set prior to calling the
4799 * function. This function fills in frame->data,
4800 * frame->extended_data, frame->linesize[0].
4801 * @param nb_channels channel count
4802 * @param sample_fmt sample format
4803 * @param buf buffer to use for frame data
4804 * @param buf_size size of buffer
4805 * @param align plane size sample alignment (0 = default)
4806 * @return >=0 on success, negative error code on failure
4807 * @todo return the size in bytes required to store the samples in
4808 * case of success, at the next libavutil bump
4810 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4811 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4812 int buf_size, int align);
4815 * Reset the internal decoder state / flush internal buffers. Should be called
4816 * e.g. when seeking or when switching to a different stream.
4818 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4819 * this invalidates the frames previously returned from the decoder. When
4820 * refcounted frames are used, the decoder just releases any references it might
4821 * keep internally, but the caller's reference remains valid.
4823 void avcodec_flush_buffers(AVCodecContext *avctx);
4826 * Return codec bits per sample.
4828 * @param[in] codec_id the codec
4829 * @return Number of bits per sample or zero if unknown for the given codec.
4831 int av_get_bits_per_sample(enum AVCodecID codec_id);
4834 * Return the PCM codec associated with a sample format.
4835 * @param be endianness, 0 for little, 1 for big,
4836 * -1 (or anything else) for native
4837 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4839 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4842 * Return codec bits per sample.
4843 * Only return non-zero if the bits per sample is exactly correct, not an
4846 * @param[in] codec_id the codec
4847 * @return Number of bits per sample or zero if unknown for the given codec.
4849 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4852 * Return audio frame duration.
4854 * @param avctx codec context
4855 * @param frame_bytes size of the frame, or 0 if unknown
4856 * @return frame duration, in samples, if known. 0 if not able to
4859 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4862 typedef struct AVBitStreamFilterContext {
4864 struct AVBitStreamFilter *filter;
4865 AVCodecParserContext *parser;
4866 struct AVBitStreamFilterContext *next;
4867 } AVBitStreamFilterContext;
4870 typedef struct AVBitStreamFilter {
4873 int (*filter)(AVBitStreamFilterContext *bsfc,
4874 AVCodecContext *avctx, const char *args,
4875 uint8_t **poutbuf, int *poutbuf_size,
4876 const uint8_t *buf, int buf_size, int keyframe);
4877 void (*close)(AVBitStreamFilterContext *bsfc);
4878 struct AVBitStreamFilter *next;
4879 } AVBitStreamFilter;
4882 * Register a bitstream filter.
4884 * The filter will be accessible to the application code through
4885 * av_bitstream_filter_next() or can be directly initialized with
4886 * av_bitstream_filter_init().
4888 * @see avcodec_register_all()
4890 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4893 * Create and initialize a bitstream filter context given a bitstream
4896 * The returned context must be freed with av_bitstream_filter_close().
4898 * @param name the name of the bitstream filter
4899 * @return a bitstream filter context if a matching filter was found
4900 * and successfully initialized, NULL otherwise
4902 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4907 * This function filters the buffer buf with size buf_size, and places the
4908 * filtered buffer in the buffer pointed to by poutbuf.
4910 * The output buffer must be freed by the caller.
4912 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
4913 * @param avctx AVCodecContext accessed by the filter, may be NULL.
4914 * If specified, this must point to the encoder context of the
4915 * output stream the packet is sent to.
4916 * @param args arguments which specify the filter configuration, may be NULL
4917 * @param poutbuf pointer which is updated to point to the filtered buffer
4918 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
4919 * @param buf buffer containing the data to filter
4920 * @param buf_size size in bytes of buf
4921 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
4922 * @return >= 0 in case of success, or a negative error code in case of failure
4924 * If the return value is positive, an output buffer is allocated and
4925 * is availble in *poutbuf, and is distinct from the input buffer.
4927 * If the return value is 0, the output buffer is not allocated and
4928 * should be considered identical to the input buffer, or in case
4929 * *poutbuf was set it points to the input buffer (not necessarily to
4930 * its starting address).
4932 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4933 AVCodecContext *avctx, const char *args,
4934 uint8_t **poutbuf, int *poutbuf_size,
4935 const uint8_t *buf, int buf_size, int keyframe);
4938 * Release bitstream filter context.
4940 * @param bsf the bitstream filter context created with
4941 * av_bitstream_filter_init(), can be NULL
4943 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4946 * If f is NULL, return the first registered bitstream filter,
4947 * if f is non-NULL, return the next registered bitstream filter
4948 * after f, or NULL if f is the last one.
4950 * This function can be used to iterate over all registered bitstream
4953 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4958 * Same behaviour av_fast_malloc but the buffer has additional
4959 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
4961 * In addition the whole buffer will initially and after resizes
4962 * be 0-initialized so that no uninitialized data will ever appear.
4964 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4967 * Same behaviour av_fast_padded_malloc except that buffer will always
4968 * be 0-initialized after call.
4970 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4973 * Encode extradata length to a buffer. Used by xiph codecs.
4975 * @param s buffer to write to; must be at least (v/255+1) bytes long
4976 * @param v size of extradata in bytes
4977 * @return number of bytes written to the buffer.
4979 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4981 #if FF_API_MISSING_SAMPLE
4983 * Log a generic warning message about a missing feature. This function is
4984 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4985 * only, and would normally not be used by applications.
4986 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4987 * a pointer to an AVClass struct
4988 * @param[in] feature string containing the name of the missing feature
4989 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4990 * If want_sample is non-zero, additional verbage will be added to the log
4991 * message which tells the user how to report samples to the development
4993 * @deprecated Use avpriv_report_missing_feature() instead.
4995 attribute_deprecated
4996 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4999 * Log a generic warning message asking for a sample. This function is
5000 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5001 * only, and would normally not be used by applications.
5002 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5003 * a pointer to an AVClass struct
5004 * @param[in] msg string containing an optional message, or NULL if no message
5005 * @deprecated Use avpriv_request_sample() instead.
5007 attribute_deprecated
5008 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5009 #endif /* FF_API_MISSING_SAMPLE */
5012 * Register the hardware accelerator hwaccel.
5014 void av_register_hwaccel(AVHWAccel *hwaccel);
5017 * If hwaccel is NULL, returns the first registered hardware accelerator,
5018 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5019 * after hwaccel, or NULL if hwaccel is the last one.
5021 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
5025 * Lock operation used by lockmgr
5028 AV_LOCK_CREATE, ///< Create a mutex
5029 AV_LOCK_OBTAIN, ///< Lock the mutex
5030 AV_LOCK_RELEASE, ///< Unlock the mutex
5031 AV_LOCK_DESTROY, ///< Free mutex resources
5035 * Register a user provided lock manager supporting the operations
5036 * specified by AVLockOp. mutex points to a (void *) where the
5037 * lockmgr should store/get a pointer to a user allocated mutex. It's
5038 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
5040 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
5041 * callback during the call to av_lockmgr_register().
5042 * Thus, the application must be prepared to handle that.
5043 * If cb is set to NULL the lockmgr will be unregistered.
5044 * Also note that during unregistration the previously registered
5045 * lockmgr callback may also be invoked.
5047 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5050 * Get the type of the given codec.
5052 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5055 * Get the name of a codec.
5056 * @return a static string identifying the codec; never NULL
5058 const char *avcodec_get_name(enum AVCodecID id);
5061 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5062 * with no corresponding avcodec_close()), 0 otherwise.
5064 int avcodec_is_open(AVCodecContext *s);
5067 * @return a non-zero number if codec is an encoder, zero otherwise
5069 int av_codec_is_encoder(const AVCodec *codec);
5072 * @return a non-zero number if codec is a decoder, zero otherwise
5074 int av_codec_is_decoder(const AVCodec *codec);
5077 * @return descriptor for given codec ID or NULL if no descriptor exists.
5079 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5082 * Iterate over all codec descriptors known to libavcodec.
5084 * @param prev previous descriptor. NULL to get the first descriptor.
5086 * @return next descriptor or NULL after the last descriptor
5088 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5091 * @return codec descriptor with the given name or NULL if no such descriptor
5094 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5100 #endif /* AVCODEC_AVCODEC_H */