2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/log.h"
40 #include "libavutil/pixfmt.h"
41 #include "libavutil/rational.h"
45 #if FF_API_FAST_MALLOC
46 // to provide fast_*alloc
47 #include "libavutil/mem.h"
51 * @defgroup libavc Encoding/Decoding Library
54 * @defgroup lavc_decoding Decoding
58 * @defgroup lavc_encoding Encoding
62 * @defgroup lavc_codec Codecs
64 * @defgroup lavc_codec_native Native Codecs
67 * @defgroup lavc_codec_wrappers External library wrappers
70 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
74 * @defgroup lavc_internal Internal
82 * @defgroup lavc_core Core functions/structures.
85 * Basic definitions, functions for querying libavcodec capabilities,
86 * allocating core structures, etc.
92 * Identify the syntax and semantics of the bitstream.
93 * The principle is roughly:
94 * Two decoders with the same ID can decode the same streams.
95 * Two encoders with the same ID can encode compatible streams.
96 * There may be slight deviations from the principle due to implementation
99 * If you add a codec ID to this list, add it so that
100 * 1. no value of a existing codec ID changes (that would break ABI),
101 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
102 * This ensures that 2 forks can independently add AVCodecIDs without producing conflicts.
104 * After adding new codec IDs, do not forget to add an entry to the codec
105 * descriptor list and bump libavcodec minor version.
111 AV_CODEC_ID_MPEG1VIDEO,
112 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
114 AV_CODEC_ID_MPEG2VIDEO_XVMC,
115 #endif /* FF_API_XVMC */
126 AV_CODEC_ID_RAWVIDEO,
127 AV_CODEC_ID_MSMPEG4V1,
128 AV_CODEC_ID_MSMPEG4V2,
129 AV_CODEC_ID_MSMPEG4V3,
152 AV_CODEC_ID_INTERPLAY_VIDEO,
159 AV_CODEC_ID_MSVIDEO1,
164 AV_CODEC_ID_TRUEMOTION1,
165 AV_CODEC_ID_VMDVIDEO,
190 AV_CODEC_ID_TRUEMOTION2,
196 AV_CODEC_ID_SMACKVIDEO,
201 AV_CODEC_ID_JPEG2000,
207 AV_CODEC_ID_DSICINVIDEO,
208 AV_CODEC_ID_TIERTEXSEQVIDEO,
216 AV_CODEC_ID_BETHSOFTVID,
228 AV_CODEC_ID_ESCAPE124,
232 AV_CODEC_ID_MOTIONPIXELS,
244 AV_CODEC_ID_FLASHSV2,
245 AV_CODEC_ID_CDGRAPHICS,
248 AV_CODEC_ID_BINKVIDEO,
249 AV_CODEC_ID_IFF_ILBM,
250 AV_CODEC_ID_IFF_BYTERUN1,
256 AV_CODEC_ID_A64_MULTI,
257 AV_CODEC_ID_A64_MULTI5,
260 AV_CODEC_ID_LAGARITH,
264 AV_CODEC_ID_WMV3IMAGE,
265 AV_CODEC_ID_VC1IMAGE,
267 AV_CODEC_ID_BMV_VIDEO,
274 AV_CODEC_ID_ZEROCODEC,
283 AV_CODEC_ID_ESCAPE130_DEPRECATED,
284 AV_CODEC_ID_G2M_DEPRECATED,
285 AV_CODEC_ID_WEBP_DEPRECATED,
286 AV_CODEC_ID_HNM4_VIDEO,
287 AV_CODEC_ID_HEVC_DEPRECATED,
289 AV_CODEC_ID_ALIAS_PIX,
290 AV_CODEC_ID_BRENDER_PIX_DEPRECATED,
291 AV_CODEC_ID_PAF_VIDEO_DEPRECATED,
292 AV_CODEC_ID_EXR_DEPRECATED,
293 AV_CODEC_ID_VP7_DEPRECATED,
294 AV_CODEC_ID_SANM_DEPRECATED,
295 AV_CODEC_ID_SGIRLE_DEPRECATED,
296 AV_CODEC_ID_MVC1_DEPRECATED,
297 AV_CODEC_ID_MVC2_DEPRECATED,
299 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
300 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
301 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
302 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
303 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
305 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
306 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
307 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
308 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
309 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
310 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
311 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
312 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
313 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
314 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
315 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
316 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
317 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
318 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
319 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
320 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
321 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
322 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
323 AV_CODEC_ID_SMVJPEG = MKBETAG('S','M','V','J'),
324 AV_CODEC_ID_HEVC = MKBETAG('H','2','6','5'),
325 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
326 AV_CODEC_ID_VP7 = MKBETAG('V','P','7','0'),
328 /* various PCM "codecs" */
329 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
330 AV_CODEC_ID_PCM_S16LE = 0x10000,
331 AV_CODEC_ID_PCM_S16BE,
332 AV_CODEC_ID_PCM_U16LE,
333 AV_CODEC_ID_PCM_U16BE,
336 AV_CODEC_ID_PCM_MULAW,
337 AV_CODEC_ID_PCM_ALAW,
338 AV_CODEC_ID_PCM_S32LE,
339 AV_CODEC_ID_PCM_S32BE,
340 AV_CODEC_ID_PCM_U32LE,
341 AV_CODEC_ID_PCM_U32BE,
342 AV_CODEC_ID_PCM_S24LE,
343 AV_CODEC_ID_PCM_S24BE,
344 AV_CODEC_ID_PCM_U24LE,
345 AV_CODEC_ID_PCM_U24BE,
346 AV_CODEC_ID_PCM_S24DAUD,
347 AV_CODEC_ID_PCM_ZORK,
348 AV_CODEC_ID_PCM_S16LE_PLANAR,
350 AV_CODEC_ID_PCM_F32BE,
351 AV_CODEC_ID_PCM_F32LE,
352 AV_CODEC_ID_PCM_F64BE,
353 AV_CODEC_ID_PCM_F64LE,
354 AV_CODEC_ID_PCM_BLURAY,
357 AV_CODEC_ID_PCM_S8_PLANAR,
358 AV_CODEC_ID_PCM_S24LE_PLANAR_DEPRECATED,
359 AV_CODEC_ID_PCM_S32LE_PLANAR_DEPRECATED,
360 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
361 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
362 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
364 /* various ADPCM codecs */
365 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
366 AV_CODEC_ID_ADPCM_IMA_WAV,
367 AV_CODEC_ID_ADPCM_IMA_DK3,
368 AV_CODEC_ID_ADPCM_IMA_DK4,
369 AV_CODEC_ID_ADPCM_IMA_WS,
370 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
371 AV_CODEC_ID_ADPCM_MS,
372 AV_CODEC_ID_ADPCM_4XM,
373 AV_CODEC_ID_ADPCM_XA,
374 AV_CODEC_ID_ADPCM_ADX,
375 AV_CODEC_ID_ADPCM_EA,
376 AV_CODEC_ID_ADPCM_G726,
377 AV_CODEC_ID_ADPCM_CT,
378 AV_CODEC_ID_ADPCM_SWF,
379 AV_CODEC_ID_ADPCM_YAMAHA,
380 AV_CODEC_ID_ADPCM_SBPRO_4,
381 AV_CODEC_ID_ADPCM_SBPRO_3,
382 AV_CODEC_ID_ADPCM_SBPRO_2,
383 AV_CODEC_ID_ADPCM_THP,
384 AV_CODEC_ID_ADPCM_IMA_AMV,
385 AV_CODEC_ID_ADPCM_EA_R1,
386 AV_CODEC_ID_ADPCM_EA_R3,
387 AV_CODEC_ID_ADPCM_EA_R2,
388 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
389 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
390 AV_CODEC_ID_ADPCM_EA_XAS,
391 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
392 AV_CODEC_ID_ADPCM_IMA_ISS,
393 AV_CODEC_ID_ADPCM_G722,
394 AV_CODEC_ID_ADPCM_IMA_APC,
395 AV_CODEC_ID_ADPCM_VIMA_DEPRECATED,
396 AV_CODEC_ID_ADPCM_VIMA = MKBETAG('V','I','M','A'),
397 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
398 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
399 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
400 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
401 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
402 AV_CODEC_ID_ADPCM_G726LE = MKBETAG('6','2','7','G'),
405 AV_CODEC_ID_AMR_NB = 0x12000,
408 /* RealAudio codecs*/
409 AV_CODEC_ID_RA_144 = 0x13000,
412 /* various DPCM codecs */
413 AV_CODEC_ID_ROQ_DPCM = 0x14000,
414 AV_CODEC_ID_INTERPLAY_DPCM,
415 AV_CODEC_ID_XAN_DPCM,
416 AV_CODEC_ID_SOL_DPCM,
419 AV_CODEC_ID_MP2 = 0x15000,
420 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
430 AV_CODEC_ID_VMDAUDIO,
436 AV_CODEC_ID_WESTWOOD_SND1,
437 AV_CODEC_ID_GSM, ///< as in Berlin toast format
440 AV_CODEC_ID_TRUESPEECH,
442 AV_CODEC_ID_SMACKAUDIO,
445 AV_CODEC_ID_DSICINAUDIO,
447 AV_CODEC_ID_MUSEPACK7,
449 AV_CODEC_ID_GSM_MS, /* as found in WAV */
455 AV_CODEC_ID_NELLYMOSER,
456 AV_CODEC_ID_MUSEPACK8,
458 AV_CODEC_ID_WMAVOICE,
460 AV_CODEC_ID_WMALOSSLESS,
469 AV_CODEC_ID_BINKAUDIO_RDFT,
470 AV_CODEC_ID_BINKAUDIO_DCT,
471 AV_CODEC_ID_AAC_LATM,
476 AV_CODEC_ID_8SVX_EXP,
477 AV_CODEC_ID_8SVX_FIB,
478 AV_CODEC_ID_BMV_AUDIO,
482 AV_CODEC_ID_OPUS_DEPRECATED,
483 AV_CODEC_ID_COMFORT_NOISE,
484 AV_CODEC_ID_TAK_DEPRECATED,
485 AV_CODEC_ID_METASOUND,
486 AV_CODEC_ID_PAF_AUDIO_DEPRECATED,
488 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
489 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
490 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
491 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
492 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
493 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
494 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
495 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
496 AV_CODEC_ID_DSD_LSBF = MKBETAG('D','S','D','L'),
497 AV_CODEC_ID_DSD_MSBF = MKBETAG('D','S','D','M'),
498 AV_CODEC_ID_DSD_LSBF_PLANAR = MKBETAG('D','S','D','1'),
499 AV_CODEC_ID_DSD_MSBF_PLANAR = MKBETAG('D','S','D','8'),
501 /* subtitle codecs */
502 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
503 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
504 AV_CODEC_ID_DVB_SUBTITLE,
505 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
508 AV_CODEC_ID_MOV_TEXT,
509 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
510 AV_CODEC_ID_DVB_TELETEXT,
512 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
513 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
514 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
515 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
516 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
517 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
518 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
519 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
520 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
521 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
522 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
523 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
524 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
526 /* other specific kind of codecs (generally used for attachments) */
527 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
528 AV_CODEC_ID_TTF = 0x18000,
529 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
530 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
531 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
532 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
533 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
534 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
535 AV_CODEC_ID_TIMED_ID3 = MKBETAG('T','I','D','3'),
536 AV_CODEC_ID_BIN_DATA = MKBETAG('D','A','T','A'),
539 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
541 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
542 * stream (only used by libavformat) */
543 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
544 * stream (only used by libavformat) */
545 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
548 #include "old_codec_ids.h"
553 * This struct describes the properties of a single codec described by an
555 * @see avcodec_get_descriptor()
557 typedef struct AVCodecDescriptor {
559 enum AVMediaType type;
561 * Name of the codec described by this descriptor. It is non-empty and
562 * unique for each codec descriptor. It should contain alphanumeric
563 * characters and '_' only.
567 * A more descriptive name for this codec. May be NULL.
569 const char *long_name;
571 * Codec properties, a combination of AV_CODEC_PROP_* flags.
576 * MIME type(s) associated with the codec.
577 * May be NULL; if not, a NULL-terminated array of MIME types.
578 * The first item is always non-NULL and is the prefered MIME type.
580 const char *const *mime_types;
584 * Codec uses only intra compression.
587 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
589 * Codec supports lossy compression. Audio and video codecs only.
590 * @note a codec may support both lossy and lossless
593 #define AV_CODEC_PROP_LOSSY (1 << 1)
595 * Codec supports lossless compression. Audio and video codecs only.
597 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
599 * Subtitle codec is bitmap based
600 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
602 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
604 * Subtitle codec is text based.
605 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
607 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
610 * @ingroup lavc_decoding
611 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
612 * This is mainly needed because some optimized bitstream readers read
613 * 32 or 64 bit at once and could read over the end.<br>
614 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
615 * MPEG bitstreams could cause overread and segfault.
617 #define FF_INPUT_BUFFER_PADDING_SIZE 16
620 * @ingroup lavc_encoding
621 * minimum encoding buffer size
622 * Used to avoid some checks during header writing.
624 #define FF_MIN_BUFFER_SIZE 16384
628 * @ingroup lavc_encoding
629 * motion estimation type.
632 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
636 ME_EPZS, ///< enhanced predictive zonal search
637 ME_X1, ///< reserved for experiments
638 ME_HEX, ///< hexagon based search
639 ME_UMH, ///< uneven multi-hexagon search
640 ME_TESA, ///< transformed exhaustive search algorithm
641 ME_ITER=50, ///< iterative search
645 * @ingroup lavc_decoding
648 /* We leave some space between them for extensions (drop some
649 * keyframes for intra-only or drop just some bidir frames). */
650 AVDISCARD_NONE =-16, ///< discard nothing
651 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
652 AVDISCARD_NONREF = 8, ///< discard all non reference
653 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
654 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
655 AVDISCARD_ALL = 48, ///< discard all
658 enum AVColorPrimaries{
659 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
660 AVCOL_PRI_UNSPECIFIED = 2,
661 AVCOL_PRI_BT470M = 4,
662 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
663 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
664 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
666 AVCOL_PRI_BT2020 = 9, ///< ITU-R BT2020
667 AVCOL_PRI_NB , ///< Not part of ABI
670 enum AVColorTransferCharacteristic{
671 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
672 AVCOL_TRC_UNSPECIFIED = 2,
673 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
674 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
675 AVCOL_TRC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 or 625 / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC
676 AVCOL_TRC_SMPTE240M = 7,
677 AVCOL_TRC_LINEAR = 8, ///< "Linear transfer characteristics"
678 AVCOL_TRC_LOG = 9, ///< "Logarithmic transfer characteristic (100:1 range)"
679 AVCOL_TRC_LOG_SQRT = 10, ///< "Logarithmic transfer characteristic (100 * Sqrt( 10 ) : 1 range)"
680 AVCOL_TRC_IEC61966_2_4 = 11, ///< IEC 61966-2-4
681 AVCOL_TRC_BT1361_ECG = 12, ///< ITU-R BT1361 Extended Colour Gamut
682 AVCOL_TRC_IEC61966_2_1 = 13, ///< IEC 61966-2-1 (sRGB or sYCC)
683 AVCOL_TRC_BT2020_10 = 14, ///< ITU-R BT2020 for 10 bit system
684 AVCOL_TRC_BT2020_12 = 15, ///< ITU-R BT2020 for 12 bit system
685 AVCOL_TRC_NB , ///< Not part of ABI
689 * X X 3 4 X X are luma samples,
690 * 1 2 1-6 are possible chroma positions
691 * X X 5 6 X 0 is undefined/unknown position
693 enum AVChromaLocation{
694 AVCHROMA_LOC_UNSPECIFIED = 0,
695 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
696 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
697 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
698 AVCHROMA_LOC_TOP = 4,
699 AVCHROMA_LOC_BOTTOMLEFT = 5,
700 AVCHROMA_LOC_BOTTOM = 6,
701 AVCHROMA_LOC_NB , ///< Not part of ABI
704 enum AVAudioServiceType {
705 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
706 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
707 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
708 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
709 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
710 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
711 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
712 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
713 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
714 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
718 * @ingroup lavc_encoding
720 typedef struct RcOverride{
723 int qscale; // If this is 0 then quality_factor will be used instead.
724 float quality_factor;
727 #if FF_API_MAX_BFRAMES
729 * @deprecated there is no libavcodec-wide limit on the number of B-frames
731 #define FF_MAX_B_FRAMES 16
735 These flags can be passed in AVCodecContext.flags before initialization.
736 Note: Not everything is supported yet.
740 * Allow decoders to produce frames with data planes that are not aligned
741 * to CPU requirements (e.g. due to cropping).
743 #define CODEC_FLAG_UNALIGNED 0x0001
744 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
745 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
746 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
747 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
750 * @deprecated use the "gmc" private option of the libxvid encoder
752 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
756 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
759 #define CODEC_FLAG_MV0 0x0040
761 #if FF_API_INPUT_PRESERVED
763 * @deprecated passing reference-counted frames to the encoders replaces this
766 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
768 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
769 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
770 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
773 * @deprecated edges are not used/required anymore. I.e. this flag is now always
776 #define CODEC_FLAG_EMU_EDGE 0x4000
778 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
779 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
780 location instead of only at frame boundaries. */
781 #if FF_API_NORMALIZE_AQP
783 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
786 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
788 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
789 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
790 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
791 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
792 /* Fx : Flag for h263+ extra options */
793 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
794 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
795 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
796 #define CODEC_FLAG_CLOSED_GOP 0x80000000
797 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
798 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
799 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
800 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
801 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
803 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
804 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
806 /* Unsupported options :
807 * Syntax Arithmetic coding (SAC)
808 * Reference Picture Selection
809 * Independent Segment Decoding */
811 /* codec capabilities */
813 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
815 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
816 * If not set, it might not use get_buffer() at all or use operations that
817 * assume the buffer was allocated by avcodec_default_get_buffer.
819 #define CODEC_CAP_DR1 0x0002
820 #define CODEC_CAP_TRUNCATED 0x0008
822 /* Codec can export data for HW decoding. This flag indicates that
823 * the codec would call get_format() with list that might contain HW accelerated
824 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
825 * including raw image format.
826 * The application can use the passed context to determine bitstream version,
827 * chroma format, resolution etc.
829 #define CODEC_CAP_HWACCEL 0x0010
830 #endif /* FF_API_XVMC */
832 * Encoder or decoder requires flushing with NULL input at the end in order to
833 * give the complete and correct output.
835 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
836 * with NULL data. The user can still send NULL data to the public encode
837 * or decode function, but libavcodec will not pass it along to the codec
838 * unless this flag is set.
841 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
842 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
846 * The encoder needs to be fed with NULL data at the end of encoding until the
847 * encoder no longer returns data.
849 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
850 * flag also means that the encoder must set the pts and duration for
851 * each output packet. If this flag is not set, the pts and duration will
852 * be determined by libavcodec from the input frame.
854 #define CODEC_CAP_DELAY 0x0020
856 * Codec can be fed a final frame with a smaller size.
857 * This can be used to prevent truncation of the last audio samples.
859 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
862 * Codec can export data for HW decoding (VDPAU).
864 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
867 * Codec can output multiple frames per AVPacket
868 * Normally demuxers return one frame at a time, demuxers which do not do
869 * are connected to a parser to split what they return into proper frames.
870 * This flag is reserved to the very rare category of codecs which have a
871 * bitstream that cannot be split into frames without timeconsuming
872 * operations like full decoding. Demuxers carring such bitstreams thus
873 * may return multiple frames in a packet. This has many disadvantages like
874 * prohibiting stream copy in many cases thus it should only be considered
877 #define CODEC_CAP_SUBFRAMES 0x0100
879 * Codec is experimental and is thus avoided in favor of non experimental
882 #define CODEC_CAP_EXPERIMENTAL 0x0200
884 * Codec should fill in channel configuration and samplerate instead of container
886 #define CODEC_CAP_CHANNEL_CONF 0x0400
887 #if FF_API_NEG_LINESIZES
889 * @deprecated no codecs use this capability
891 #define CODEC_CAP_NEG_LINESIZES 0x0800
894 * Codec supports frame-level multithreading.
896 #define CODEC_CAP_FRAME_THREADS 0x1000
898 * Codec supports slice-based (or partition-based) multithreading.
900 #define CODEC_CAP_SLICE_THREADS 0x2000
902 * Codec supports changed parameters at any point.
904 #define CODEC_CAP_PARAM_CHANGE 0x4000
906 * Codec supports avctx->thread_count == 0 (auto).
908 #define CODEC_CAP_AUTO_THREADS 0x8000
910 * Audio encoder supports receiving a different number of samples in each call.
912 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
914 * Codec is intra only.
916 #define CODEC_CAP_INTRA_ONLY 0x40000000
920 #define CODEC_CAP_LOSSLESS 0x80000000
923 //The following defines may change, don't expect compatibility if you use them.
924 #define MB_TYPE_INTRA4x4 0x0001
925 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
926 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
927 #define MB_TYPE_16x16 0x0008
928 #define MB_TYPE_16x8 0x0010
929 #define MB_TYPE_8x16 0x0020
930 #define MB_TYPE_8x8 0x0040
931 #define MB_TYPE_INTERLACED 0x0080
932 #define MB_TYPE_DIRECT2 0x0100 //FIXME
933 #define MB_TYPE_ACPRED 0x0200
934 #define MB_TYPE_GMC 0x0400
935 #define MB_TYPE_SKIP 0x0800
936 #define MB_TYPE_P0L0 0x1000
937 #define MB_TYPE_P1L0 0x2000
938 #define MB_TYPE_P0L1 0x4000
939 #define MB_TYPE_P1L1 0x8000
940 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
941 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
942 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
943 #define MB_TYPE_QUANT 0x00010000
944 #define MB_TYPE_CBP 0x00020000
945 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
950 * This specifies the area which should be displayed.
951 * Note there may be multiple such areas for one frame.
953 typedef struct AVPanScan{
956 * - encoding: Set by user.
957 * - decoding: Set by libavcodec.
962 * width and height in 1/16 pel
963 * - encoding: Set by user.
964 * - decoding: Set by libavcodec.
970 * position of the top left corner in 1/16 pel for up to 3 fields/frames
971 * - encoding: Set by user.
972 * - decoding: Set by libavcodec.
974 int16_t position[3][2];
977 #if FF_API_QSCALE_TYPE
978 #define FF_QSCALE_TYPE_MPEG1 0
979 #define FF_QSCALE_TYPE_MPEG2 1
980 #define FF_QSCALE_TYPE_H264 2
981 #define FF_QSCALE_TYPE_VP56 3
984 #if FF_API_GET_BUFFER
985 #define FF_BUFFER_TYPE_INTERNAL 1
986 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
987 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
988 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
990 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
991 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
992 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
993 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
997 * The decoder will keep a reference to the frame and may reuse it later.
999 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1002 * @defgroup lavc_packet AVPacket
1004 * Types and functions for working with AVPacket.
1007 enum AVPacketSideDataType {
1008 AV_PKT_DATA_PALETTE,
1009 AV_PKT_DATA_NEW_EXTRADATA,
1012 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1015 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1016 * s32le channel_count
1017 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1018 * u64le channel_layout
1019 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1021 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1026 AV_PKT_DATA_PARAM_CHANGE,
1029 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1030 * structures with info about macroblocks relevant to splitting the
1031 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1032 * That is, it does not necessarily contain info about all macroblocks,
1033 * as long as the distance between macroblocks in the info is smaller
1034 * than the target payload size.
1035 * Each MB info structure is 12 bytes, and is laid out as follows:
1037 * u32le bit offset from the start of the packet
1038 * u8 current quantizer at the start of the macroblock
1040 * u16le macroblock address within the GOB
1041 * u8 horizontal MV predictor
1042 * u8 vertical MV predictor
1043 * u8 horizontal MV predictor for block number 3
1044 * u8 vertical MV predictor for block number 3
1047 AV_PKT_DATA_H263_MB_INFO,
1050 * This side data should be associated with an audio stream and contains
1051 * ReplayGain information in form of the AVReplayGain struct.
1053 AV_PKT_DATA_REPLAYGAIN,
1056 * This side data contains a 3x3 transformation matrix describing an affine
1057 * transformation that needs to be applied to the decoded video frames for
1058 * correct presentation.
1060 * See libavutil/display.h for a detailed description of the data.
1062 AV_PKT_DATA_DISPLAYMATRIX,
1065 * Recommmends skipping the specified number of samples
1067 * u32le number of samples to skip from start of this packet
1068 * u32le number of samples to skip from end of this packet
1069 * u8 reason for start skip
1070 * u8 reason for end skip (0=padding silence, 1=convergence)
1073 AV_PKT_DATA_SKIP_SAMPLES=70,
1076 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1077 * the packet may contain "dual mono" audio specific to Japanese DTV
1078 * and if it is true, recommends only the selected channel to be used.
1080 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1083 AV_PKT_DATA_JP_DUALMONO,
1086 * A list of zero terminated key/value strings. There is no end marker for
1087 * the list, so it is required to rely on the side data size to stop.
1089 AV_PKT_DATA_STRINGS_METADATA,
1092 * Subtitle event position
1100 AV_PKT_DATA_SUBTITLE_POSITION,
1103 * Data found in BlockAdditional element of matroska container. There is
1104 * no end marker for the data, so it is required to rely on the side data
1105 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1108 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1111 * The optional first identifier line of a WebVTT cue.
1113 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1116 * The optional settings (rendering instructions) that immediately
1117 * follow the timestamp specifier of a WebVTT cue.
1119 AV_PKT_DATA_WEBVTT_SETTINGS,
1122 * A list of zero terminated key/value strings. There is no end marker for
1123 * the list, so it is required to rely on the side data size to stop. This
1124 * side data includes updated metadata which appeared in the stream.
1126 AV_PKT_DATA_METADATA_UPDATE,
1129 typedef struct AVPacketSideData {
1132 enum AVPacketSideDataType type;
1136 * This structure stores compressed data. It is typically exported by demuxers
1137 * and then passed as input to decoders, or received as output from encoders and
1138 * then passed to muxers.
1140 * For video, it should typically contain one compressed frame. For audio it may
1141 * contain several compressed frames.
1143 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1144 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1145 * without libavcodec and libavformat major bump.
1147 * The semantics of data ownership depends on the buf or destruct (deprecated)
1148 * fields. If either is set, the packet data is dynamically allocated and is
1149 * valid indefinitely until av_free_packet() is called (which in turn calls
1150 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1151 * the packet data is typically backed by some static buffer somewhere and is
1152 * only valid for a limited time (e.g. until the next read call when demuxing).
1154 * The side data is always allocated with av_malloc() and is freed in
1157 typedef struct AVPacket {
1159 * A reference to the reference-counted buffer where the packet data is
1161 * May be NULL, then the packet data is not reference-counted.
1165 * Presentation timestamp in AVStream->time_base units; the time at which
1166 * the decompressed packet will be presented to the user.
1167 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1168 * pts MUST be larger or equal to dts as presentation cannot happen before
1169 * decompression, unless one wants to view hex dumps. Some formats misuse
1170 * the terms dts and pts/cts to mean something different. Such timestamps
1171 * must be converted to true pts/dts before they are stored in AVPacket.
1175 * Decompression timestamp in AVStream->time_base units; the time at which
1176 * the packet is decompressed.
1177 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1184 * A combination of AV_PKT_FLAG values
1188 * Additional packet data that can be provided by the container.
1189 * Packet can contain several types of side information.
1191 AVPacketSideData *side_data;
1192 int side_data_elems;
1195 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1196 * Equals next_pts - this_pts in presentation order.
1199 #if FF_API_DESTRUCT_PACKET
1200 attribute_deprecated
1201 void (*destruct)(struct AVPacket *);
1202 attribute_deprecated
1205 int64_t pos; ///< byte position in stream, -1 if unknown
1208 * Time difference in AVStream->time_base units from the pts of this
1209 * packet to the point at which the output from the decoder has converged
1210 * independent from the availability of previous frames. That is, the
1211 * frames are virtually identical no matter if decoding started from
1212 * the very first frame or from this keyframe.
1213 * Is AV_NOPTS_VALUE if unknown.
1214 * This field is not the display duration of the current packet.
1215 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1218 * The purpose of this field is to allow seeking in streams that have no
1219 * keyframes in the conventional sense. It corresponds to the
1220 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1221 * essential for some types of subtitle streams to ensure that all
1222 * subtitles are correctly displayed after seeking.
1224 int64_t convergence_duration;
1226 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1227 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1229 enum AVSideDataParamChangeFlags {
1230 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1231 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1232 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1233 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1239 struct AVCodecInternal;
1243 AV_FIELD_PROGRESSIVE,
1244 AV_FIELD_TT, //< Top coded_first, top displayed first
1245 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1246 AV_FIELD_TB, //< Top coded first, bottom displayed first
1247 AV_FIELD_BT, //< Bottom coded first, top displayed first
1251 * main external API structure.
1252 * New fields can be added to the end with minor version bumps.
1253 * Removal, reordering and changes to existing fields require a major
1255 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1257 * sizeof(AVCodecContext) must not be used outside libav*.
1259 typedef struct AVCodecContext {
1261 * information on struct for av_log
1262 * - set by avcodec_alloc_context3
1264 const AVClass *av_class;
1265 int log_level_offset;
1267 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1268 const struct AVCodec *codec;
1269 #if FF_API_CODEC_NAME
1271 * @deprecated this field is not used for anything in libavcodec
1273 attribute_deprecated
1274 char codec_name[32];
1276 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1279 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1280 * This is used to work around some encoder bugs.
1281 * A demuxer should set this to what is stored in the field used to identify the codec.
1282 * If there are multiple such fields in a container then the demuxer should choose the one
1283 * which maximizes the information about the used codec.
1284 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1285 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1286 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1288 * - encoding: Set by user, if not then the default based on codec_id will be used.
1289 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1291 unsigned int codec_tag;
1294 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1295 * This is used to work around some encoder bugs.
1296 * - encoding: unused
1297 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1299 unsigned int stream_codec_tag;
1304 * Private context used for internal data.
1306 * Unlike priv_data, this is not codec-specific. It is used in general
1307 * libavcodec functions.
1309 struct AVCodecInternal *internal;
1312 * Private data of the user, can be used to carry app specific stuff.
1313 * - encoding: Set by user.
1314 * - decoding: Set by user.
1319 * the average bitrate
1320 * - encoding: Set by user; unused for constant quantizer encoding.
1321 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1326 * number of bits the bitstream is allowed to diverge from the reference.
1327 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1328 * - encoding: Set by user; unused for constant quantizer encoding.
1329 * - decoding: unused
1331 int bit_rate_tolerance;
1334 * Global quality for codecs which cannot change it per frame.
1335 * This should be proportional to MPEG-1/2/4 qscale.
1336 * - encoding: Set by user.
1337 * - decoding: unused
1342 * - encoding: Set by user.
1343 * - decoding: unused
1345 int compression_level;
1346 #define FF_COMPRESSION_DEFAULT -1
1350 * - encoding: Set by user.
1351 * - decoding: Set by user.
1357 * - encoding: Set by user.
1358 * - decoding: Set by user.
1363 * some codecs need / can use extradata like Huffman tables.
1364 * mjpeg: Huffman tables
1365 * rv10: additional flags
1366 * mpeg4: global headers (they can be in the bitstream or here)
1367 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1368 * than extradata_size to avoid problems if it is read with the bitstream reader.
1369 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1370 * - encoding: Set/allocated/freed by libavcodec.
1371 * - decoding: Set/allocated/freed by user.
1377 * This is the fundamental unit of time (in seconds) in terms
1378 * of which frame timestamps are represented. For fixed-fps content,
1379 * timebase should be 1/framerate and timestamp increments should be
1381 * - encoding: MUST be set by user.
1382 * - decoding: Set by libavcodec.
1384 AVRational time_base;
1387 * For some codecs, the time base is closer to the field rate than the frame rate.
1388 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1389 * if no telecine is used ...
1391 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1393 int ticks_per_frame;
1398 * Encoding: Number of frames delay there will be from the encoder input to
1399 * the decoder output. (we assume the decoder matches the spec)
1400 * Decoding: Number of frames delay in addition to what a standard decoder
1401 * as specified in the spec would produce.
1404 * Number of frames the decoded output will be delayed relative to the
1408 * For encoding, this is the number of "priming" samples added by the
1409 * encoder to the beginning of the stream. The decoded output will be
1410 * delayed by this many samples relative to the input to the encoder (or
1411 * more, if the decoder adds its own padding).
1412 * The timestamps on the output packets are adjusted by the encoder so
1413 * that they always refer to the first sample of the data actually
1414 * contained in the packet, including any added padding.
1415 * E.g. if the timebase is 1/samplerate and the timestamp of the first
1416 * input sample is 0, the timestamp of the first output packet will be
1419 * For decoding, this is the number of samples the decoder needs to
1420 * output before the decoder's output is valid. When seeking, you should
1421 * start decoding this many samples prior to your desired seek point.
1423 * - encoding: Set by libavcodec.
1424 * - decoding: Set by libavcodec.
1431 * picture width / height.
1432 * - encoding: MUST be set by user.
1433 * - decoding: May be set by the user before opening the decoder if known e.g.
1434 * from the container. Some decoders will require the dimensions
1435 * to be set by the caller. During decoding, the decoder may
1436 * overwrite those values as required.
1441 * Bitstream width / height, may be different from width/height e.g. when
1442 * the decoded frame is cropped before being output or lowres is enabled.
1443 * - encoding: unused
1444 * - decoding: May be set by the user before opening the decoder if known
1445 * e.g. from the container. During decoding, the decoder may
1446 * overwrite those values as required.
1448 int coded_width, coded_height;
1450 #if FF_API_ASPECT_EXTENDED
1451 #define FF_ASPECT_EXTENDED 15
1455 * the number of pictures in a group of pictures, or 0 for intra_only
1456 * - encoding: Set by user.
1457 * - decoding: unused
1462 * Pixel format, see AV_PIX_FMT_xxx.
1463 * May be set by the demuxer if known from headers.
1464 * May be overridden by the decoder if it knows better.
1465 * - encoding: Set by user.
1466 * - decoding: Set by user if known, overridden by libavcodec if known
1468 enum AVPixelFormat pix_fmt;
1471 * Motion estimation algorithm used for video coding.
1472 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1473 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1474 * - encoding: MUST be set by user.
1475 * - decoding: unused
1480 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1481 * decoder to draw a horizontal band. It improves cache usage. Not
1482 * all codecs can do that. You must check the codec capabilities
1484 * When multithreading is used, it may be called from multiple threads
1485 * at the same time; threads might draw different parts of the same AVFrame,
1486 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1488 * The function is also used by hardware acceleration APIs.
1489 * It is called at least once during frame decoding to pass
1490 * the data needed for hardware render.
1491 * In that mode instead of pixel data, AVFrame points to
1492 * a structure specific to the acceleration API. The application
1493 * reads the structure and can change some fields to indicate progress
1495 * - encoding: unused
1496 * - decoding: Set by user.
1497 * @param height the height of the slice
1498 * @param y the y position of the slice
1499 * @param type 1->top field, 2->bottom field, 3->frame
1500 * @param offset offset into the AVFrame.data from which the slice should be read
1502 void (*draw_horiz_band)(struct AVCodecContext *s,
1503 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1504 int y, int type, int height);
1507 * callback to negotiate the pixelFormat
1508 * @param fmt is the list of formats which are supported by the codec,
1509 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1510 * The first is always the native one.
1511 * @return the chosen format
1512 * - encoding: unused
1513 * - decoding: Set by user, if not set the native format will be chosen.
1515 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1518 * maximum number of B-frames between non-B-frames
1519 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1520 * - encoding: Set by user.
1521 * - decoding: unused
1526 * qscale factor between IP and B-frames
1527 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1528 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1529 * - encoding: Set by user.
1530 * - decoding: unused
1532 float b_quant_factor;
1534 /** obsolete FIXME remove */
1536 #define FF_RC_STRATEGY_XVID 1
1538 int b_frame_strategy;
1541 * qscale offset between IP and B-frames
1542 * - encoding: Set by user.
1543 * - decoding: unused
1545 float b_quant_offset;
1548 * Size of the frame reordering buffer in the decoder.
1549 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1550 * - encoding: Set by libavcodec.
1551 * - decoding: Set by libavcodec.
1556 * 0-> h263 quant 1-> mpeg quant
1557 * - encoding: Set by user.
1558 * - decoding: unused
1563 * qscale factor between P and I-frames
1564 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1565 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1566 * - encoding: Set by user.
1567 * - decoding: unused
1569 float i_quant_factor;
1572 * qscale offset between P and I-frames
1573 * - encoding: Set by user.
1574 * - decoding: unused
1576 float i_quant_offset;
1579 * luminance masking (0-> disabled)
1580 * - encoding: Set by user.
1581 * - decoding: unused
1586 * temporary complexity masking (0-> disabled)
1587 * - encoding: Set by user.
1588 * - decoding: unused
1590 float temporal_cplx_masking;
1593 * spatial complexity masking (0-> disabled)
1594 * - encoding: Set by user.
1595 * - decoding: unused
1597 float spatial_cplx_masking;
1600 * p block masking (0-> disabled)
1601 * - encoding: Set by user.
1602 * - decoding: unused
1607 * darkness masking (0-> disabled)
1608 * - encoding: Set by user.
1609 * - decoding: unused
1615 * - encoding: Set by libavcodec.
1616 * - decoding: Set by user (or 0).
1620 * prediction method (needed for huffyuv)
1621 * - encoding: Set by user.
1622 * - decoding: unused
1624 int prediction_method;
1625 #define FF_PRED_LEFT 0
1626 #define FF_PRED_PLANE 1
1627 #define FF_PRED_MEDIAN 2
1630 * slice offsets in the frame in bytes
1631 * - encoding: Set/allocated by libavcodec.
1632 * - decoding: Set/allocated by user (or NULL).
1637 * sample aspect ratio (0 if unknown)
1638 * That is the width of a pixel divided by the height of the pixel.
1639 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1640 * - encoding: Set by user.
1641 * - decoding: Set by libavcodec.
1643 AVRational sample_aspect_ratio;
1646 * motion estimation comparison function
1647 * - encoding: Set by user.
1648 * - decoding: unused
1652 * subpixel motion estimation comparison function
1653 * - encoding: Set by user.
1654 * - decoding: unused
1658 * macroblock comparison function (not supported yet)
1659 * - encoding: Set by user.
1660 * - decoding: unused
1664 * interlaced DCT comparison function
1665 * - encoding: Set by user.
1666 * - decoding: unused
1669 #define FF_CMP_SAD 0
1670 #define FF_CMP_SSE 1
1671 #define FF_CMP_SATD 2
1672 #define FF_CMP_DCT 3
1673 #define FF_CMP_PSNR 4
1674 #define FF_CMP_BIT 5
1676 #define FF_CMP_ZERO 7
1677 #define FF_CMP_VSAD 8
1678 #define FF_CMP_VSSE 9
1679 #define FF_CMP_NSSE 10
1680 #define FF_CMP_W53 11
1681 #define FF_CMP_W97 12
1682 #define FF_CMP_DCTMAX 13
1683 #define FF_CMP_DCT264 14
1684 #define FF_CMP_CHROMA 256
1687 * ME diamond size & shape
1688 * - encoding: Set by user.
1689 * - decoding: unused
1694 * amount of previous MV predictors (2a+1 x 2a+1 square)
1695 * - encoding: Set by user.
1696 * - decoding: unused
1698 int last_predictor_count;
1701 * prepass for motion estimation
1702 * - encoding: Set by user.
1703 * - decoding: unused
1708 * motion estimation prepass comparison function
1709 * - encoding: Set by user.
1710 * - decoding: unused
1715 * ME prepass diamond size & shape
1716 * - encoding: Set by user.
1717 * - decoding: unused
1723 * - encoding: Set by user.
1724 * - decoding: unused
1726 int me_subpel_quality;
1729 * DTG active format information (additional aspect ratio
1730 * information only used in DVB MPEG-2 transport streams)
1733 * - encoding: unused
1734 * - decoding: Set by decoder.
1736 int dtg_active_format;
1737 #define FF_DTG_AFD_SAME 8
1738 #define FF_DTG_AFD_4_3 9
1739 #define FF_DTG_AFD_16_9 10
1740 #define FF_DTG_AFD_14_9 11
1741 #define FF_DTG_AFD_4_3_SP_14_9 13
1742 #define FF_DTG_AFD_16_9_SP_14_9 14
1743 #define FF_DTG_AFD_SP_4_3 15
1746 * maximum motion estimation search range in subpel units
1747 * If 0 then no limit.
1749 * - encoding: Set by user.
1750 * - decoding: unused
1755 * intra quantizer bias
1756 * - encoding: Set by user.
1757 * - decoding: unused
1759 int intra_quant_bias;
1760 #define FF_DEFAULT_QUANT_BIAS 999999
1763 * inter quantizer bias
1764 * - encoding: Set by user.
1765 * - decoding: unused
1767 int inter_quant_bias;
1771 * - encoding: unused
1772 * - decoding: Set by user.
1775 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1776 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1777 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1781 * XVideo Motion Acceleration
1782 * - encoding: forbidden
1783 * - decoding: set by decoder
1784 * @deprecated XvMC doesn't need it anymore.
1786 attribute_deprecated int xvmc_acceleration;
1787 #endif /* FF_API_XVMC */
1790 * macroblock decision mode
1791 * - encoding: Set by user.
1792 * - decoding: unused
1795 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1796 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1797 #define FF_MB_DECISION_RD 2 ///< rate distortion
1800 * custom intra quantization matrix
1801 * - encoding: Set by user, can be NULL.
1802 * - decoding: Set by libavcodec.
1804 uint16_t *intra_matrix;
1807 * custom inter quantization matrix
1808 * - encoding: Set by user, can be NULL.
1809 * - decoding: Set by libavcodec.
1811 uint16_t *inter_matrix;
1814 * scene change detection threshold
1815 * 0 is default, larger means fewer detected scene changes.
1816 * - encoding: Set by user.
1817 * - decoding: unused
1819 int scenechange_threshold;
1822 * noise reduction strength
1823 * - encoding: Set by user.
1824 * - decoding: unused
1826 int noise_reduction;
1829 * Motion estimation threshold below which no motion estimation is
1830 * performed, but instead the user specified motion vectors are used.
1832 * - encoding: Set by user.
1833 * - decoding: unused
1838 * Macroblock threshold below which the user specified macroblock types will be used.
1839 * - encoding: Set by user.
1840 * - decoding: unused
1845 * precision of the intra DC coefficient - 8
1846 * - encoding: Set by user.
1847 * - decoding: unused
1849 int intra_dc_precision;
1852 * Number of macroblock rows at the top which are skipped.
1853 * - encoding: unused
1854 * - decoding: Set by user.
1859 * Number of macroblock rows at the bottom which are skipped.
1860 * - encoding: unused
1861 * - decoding: Set by user.
1866 * Border processing masking, raises the quantizer for mbs on the borders
1868 * - encoding: Set by user.
1869 * - decoding: unused
1871 float border_masking;
1874 * minimum MB lagrange multipler
1875 * - encoding: Set by user.
1876 * - decoding: unused
1881 * maximum MB lagrange multipler
1882 * - encoding: Set by user.
1883 * - decoding: unused
1889 * - encoding: Set by user.
1890 * - decoding: unused
1892 int me_penalty_compensation;
1896 * - encoding: Set by user.
1897 * - decoding: unused
1903 * - encoding: Set by user.
1904 * - decoding: unused
1910 * - encoding: Set by user.
1911 * - decoding: unused
1916 * number of reference frames
1917 * - encoding: Set by user.
1918 * - decoding: Set by lavc.
1923 * chroma qp offset from luma
1924 * - encoding: Set by user.
1925 * - decoding: unused
1930 * Multiplied by qscale for each frame and added to scene_change_score.
1931 * - encoding: Set by user.
1932 * - decoding: unused
1934 int scenechange_factor;
1938 * Note: Value depends upon the compare function used for fullpel ME.
1939 * - encoding: Set by user.
1940 * - decoding: unused
1945 * Adjust sensitivity of b_frame_strategy 1.
1946 * - encoding: Set by user.
1947 * - decoding: unused
1952 * Chromaticity coordinates of the source primaries.
1953 * - encoding: Set by user
1954 * - decoding: Set by libavcodec
1956 enum AVColorPrimaries color_primaries;
1959 * Color Transfer Characteristic.
1960 * - encoding: Set by user
1961 * - decoding: Set by libavcodec
1963 enum AVColorTransferCharacteristic color_trc;
1966 * YUV colorspace type.
1967 * - encoding: Set by user
1968 * - decoding: Set by libavcodec
1970 enum AVColorSpace colorspace;
1973 * MPEG vs JPEG YUV range.
1974 * - encoding: Set by user
1975 * - decoding: Set by libavcodec
1977 enum AVColorRange color_range;
1980 * This defines the location of chroma samples.
1981 * - encoding: Set by user
1982 * - decoding: Set by libavcodec
1984 enum AVChromaLocation chroma_sample_location;
1988 * Indicates number of picture subdivisions. Used for parallelized
1990 * - encoding: Set by user
1991 * - decoding: unused
1996 * - encoding: set by libavcodec
1997 * - decoding: Set by user.
1999 enum AVFieldOrder field_order;
2002 int sample_rate; ///< samples per second
2003 int channels; ///< number of audio channels
2006 * audio sample format
2007 * - encoding: Set by user.
2008 * - decoding: Set by libavcodec.
2010 enum AVSampleFormat sample_fmt; ///< sample format
2012 /* The following data should not be initialized. */
2014 * Number of samples per channel in an audio frame.
2016 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2017 * except the last must contain exactly frame_size samples per channel.
2018 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2019 * frame size is not restricted.
2020 * - decoding: may be set by some decoders to indicate constant frame size
2025 * Frame counter, set by libavcodec.
2027 * - decoding: total number of frames returned from the decoder so far.
2028 * - encoding: total number of frames passed to the encoder so far.
2030 * @note the counter is not incremented if encoding/decoding resulted in
2036 * number of bytes per packet if constant and known or 0
2037 * Used by some WAV based audio codecs.
2042 * Audio cutoff bandwidth (0 means "automatic")
2043 * - encoding: Set by user.
2044 * - decoding: unused
2048 #if FF_API_REQUEST_CHANNELS
2050 * Decoder should decode to this many channels if it can (0 for default)
2051 * - encoding: unused
2052 * - decoding: Set by user.
2053 * @deprecated Deprecated in favor of request_channel_layout.
2055 attribute_deprecated int request_channels;
2059 * Audio channel layout.
2060 * - encoding: set by user.
2061 * - decoding: set by user, may be overwritten by libavcodec.
2063 uint64_t channel_layout;
2066 * Request decoder to use this channel layout if it can (0 for default)
2067 * - encoding: unused
2068 * - decoding: Set by user.
2070 uint64_t request_channel_layout;
2073 * Type of service that the audio stream conveys.
2074 * - encoding: Set by user.
2075 * - decoding: Set by libavcodec.
2077 enum AVAudioServiceType audio_service_type;
2080 * desired sample format
2081 * - encoding: Not used.
2082 * - decoding: Set by user.
2083 * Decoder will decode to this format if it can.
2085 enum AVSampleFormat request_sample_fmt;
2087 #if FF_API_GET_BUFFER
2089 * Called at the beginning of each frame to get a buffer for it.
2091 * The function will set AVFrame.data[], AVFrame.linesize[].
2092 * AVFrame.extended_data[] must also be set, but it should be the same as
2093 * AVFrame.data[] except for planar audio with more channels than can fit
2094 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2095 * many data pointers as it can hold.
2097 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2098 * avcodec_default_get_buffer() instead of providing buffers allocated by
2101 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2102 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2103 * but if get_buffer() is overridden then alignment considerations should
2104 * be taken into account.
2106 * @see avcodec_default_get_buffer()
2110 * If pic.reference is set then the frame will be read later by libavcodec.
2111 * avcodec_align_dimensions2() should be used to find the required width and
2112 * height, as they normally need to be rounded up to the next multiple of 16.
2114 * If frame multithreading is used and thread_safe_callbacks is set,
2115 * it may be called from a different thread, but not from more than one at
2116 * once. Does not need to be reentrant.
2118 * @see release_buffer(), reget_buffer()
2119 * @see avcodec_align_dimensions2()
2123 * Decoders request a buffer of a particular size by setting
2124 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2125 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2126 * to a smaller value in the output frame.
2128 * Decoders cannot use the buffer after returning from
2129 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2130 * is assumed to be released immediately upon return. In some rare cases,
2131 * a decoder may need to call get_buffer() more than once in a single
2132 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2133 * called again after it has already been called once, the previously
2134 * acquired buffer is assumed to be released at that time and may not be
2135 * reused by the decoder.
2137 * As a convenience, av_samples_get_buffer_size() and
2138 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2139 * functions to find the required data size and to fill data pointers and
2140 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2141 * since all planes must be the same size.
2143 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2145 * - encoding: unused
2146 * - decoding: Set by libavcodec, user can override.
2148 * @deprecated use get_buffer2()
2150 attribute_deprecated
2151 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2154 * Called to release buffers which were allocated with get_buffer.
2155 * A released buffer can be reused in get_buffer().
2156 * pic.data[*] must be set to NULL.
2157 * May be called from a different thread if frame multithreading is used,
2158 * but not by more than one thread at once, so does not need to be reentrant.
2159 * - encoding: unused
2160 * - decoding: Set by libavcodec, user can override.
2162 * @deprecated custom freeing callbacks should be set from get_buffer2()
2164 attribute_deprecated
2165 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2168 * Called at the beginning of a frame to get cr buffer for it.
2169 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2170 * libavcodec will pass previous buffer in pic, function should return
2171 * same buffer or new buffer with old frame "painted" into it.
2172 * If pic.data[0] == NULL must behave like get_buffer().
2173 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2174 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2176 * - encoding: unused
2177 * - decoding: Set by libavcodec, user can override.
2179 attribute_deprecated
2180 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2184 * This callback is called at the beginning of each frame to get data
2185 * buffer(s) for it. There may be one contiguous buffer for all the data or
2186 * there may be a buffer per each data plane or anything in between. What
2187 * this means is, you may set however many entries in buf[] you feel necessary.
2188 * Each buffer must be reference-counted using the AVBuffer API (see description
2191 * The following fields will be set in the frame before this callback is
2194 * - width, height (video only)
2195 * - sample_rate, channel_layout, nb_samples (audio only)
2196 * Their values may differ from the corresponding values in
2197 * AVCodecContext. This callback must use the frame values, not the codec
2198 * context values, to calculate the required buffer size.
2200 * This callback must fill the following fields in the frame:
2204 * * if the data is planar audio with more than 8 channels, then this
2205 * callback must allocate and fill extended_data to contain all pointers
2206 * to all data planes. data[] must hold as many pointers as it can.
2207 * extended_data must be allocated with av_malloc() and will be freed in
2209 * * otherwise exended_data must point to data
2210 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2211 * the frame's data and extended_data pointers must be contained in these. That
2212 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2213 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2214 * and av_buffer_ref().
2215 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2216 * this callback and filled with the extra buffers if there are more
2217 * buffers than buf[] can hold. extended_buf will be freed in
2220 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2221 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2224 * Each data plane must be aligned to the maximum required by the target
2227 * @see avcodec_default_get_buffer2()
2231 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2232 * (read and/or written to if it is writable) later by libavcodec.
2234 * avcodec_align_dimensions2() should be used to find the required width and
2235 * height, as they normally need to be rounded up to the next multiple of 16.
2237 * Some decoders do not support linesizes changing between frames.
2239 * If frame multithreading is used and thread_safe_callbacks is set,
2240 * this callback may be called from a different thread, but not from more
2241 * than one at once. Does not need to be reentrant.
2243 * @see avcodec_align_dimensions2()
2247 * Decoders request a buffer of a particular size by setting
2248 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2249 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2250 * to a smaller value in the output frame.
2252 * As a convenience, av_samples_get_buffer_size() and
2253 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2254 * functions to find the required data size and to fill data pointers and
2255 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2256 * since all planes must be the same size.
2258 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2260 * - encoding: unused
2261 * - decoding: Set by libavcodec, user can override.
2263 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2266 * If non-zero, the decoded audio and video frames returned from
2267 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2268 * and are valid indefinitely. The caller must free them with
2269 * av_frame_unref() when they are not needed anymore.
2270 * Otherwise, the decoded frames must not be freed by the caller and are
2271 * only valid until the next decode call.
2273 * - encoding: unused
2274 * - decoding: set by the caller before avcodec_open2().
2276 int refcounted_frames;
2278 /* - encoding parameters */
2279 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2280 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2284 * - encoding: Set by user.
2285 * - decoding: unused
2291 * - encoding: Set by user.
2292 * - decoding: unused
2297 * maximum quantizer difference between frames
2298 * - encoding: Set by user.
2299 * - decoding: unused
2304 * ratecontrol qmin qmax limiting method
2305 * 0-> clipping, 1-> use a nice continuous function to limit qscale within qmin/qmax.
2306 * - encoding: Set by user.
2307 * - decoding: unused
2315 * decoder bitstream buffer size
2316 * - encoding: Set by user.
2317 * - decoding: unused
2322 * ratecontrol override, see RcOverride
2323 * - encoding: Allocated/set/freed by user.
2324 * - decoding: unused
2326 int rc_override_count;
2327 RcOverride *rc_override;
2330 * rate control equation
2331 * - encoding: Set by user
2332 * - decoding: unused
2338 * - encoding: Set by user.
2339 * - decoding: unused
2345 * - encoding: Set by user.
2346 * - decoding: unused
2350 float rc_buffer_aggressivity;
2353 * initial complexity for pass1 ratecontrol
2354 * - encoding: Set by user.
2355 * - decoding: unused
2357 float rc_initial_cplx;
2360 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2361 * - encoding: Set by user.
2362 * - decoding: unused.
2364 float rc_max_available_vbv_use;
2367 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2368 * - encoding: Set by user.
2369 * - decoding: unused.
2371 float rc_min_vbv_overflow_use;
2374 * Number of bits which should be loaded into the rc buffer before decoding starts.
2375 * - encoding: Set by user.
2376 * - decoding: unused
2378 int rc_initial_buffer_occupancy;
2380 #define FF_CODER_TYPE_VLC 0
2381 #define FF_CODER_TYPE_AC 1
2382 #define FF_CODER_TYPE_RAW 2
2383 #define FF_CODER_TYPE_RLE 3
2384 #define FF_CODER_TYPE_DEFLATE 4
2387 * - encoding: Set by user.
2388 * - decoding: unused
2394 * - encoding: Set by user.
2395 * - decoding: unused
2400 * minimum Lagrange multiplier
2401 * - encoding: Set by user.
2402 * - decoding: unused
2407 * maximum Lagrange multiplier
2408 * - encoding: Set by user.
2409 * - decoding: unused
2414 * frame skip threshold
2415 * - encoding: Set by user.
2416 * - decoding: unused
2418 int frame_skip_threshold;
2422 * - encoding: Set by user.
2423 * - decoding: unused
2425 int frame_skip_factor;
2428 * frame skip exponent
2429 * - encoding: Set by user.
2430 * - decoding: unused
2435 * frame skip comparison function
2436 * - encoding: Set by user.
2437 * - decoding: unused
2442 * trellis RD quantization
2443 * - encoding: Set by user.
2444 * - decoding: unused
2449 * - encoding: Set by user.
2450 * - decoding: unused
2452 int min_prediction_order;
2455 * - encoding: Set by user.
2456 * - decoding: unused
2458 int max_prediction_order;
2461 * GOP timecode frame start number
2462 * - encoding: Set by user, in non drop frame format
2463 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2465 int64_t timecode_frame_start;
2467 /* The RTP callback: This function is called */
2468 /* every time the encoder has a packet to send. */
2469 /* It depends on the encoder if the data starts */
2470 /* with a Start Code (it should). H.263 does. */
2471 /* mb_nb contains the number of macroblocks */
2472 /* encoded in the RTP payload. */
2473 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2475 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2476 /* do its best to deliver a chunk with size */
2477 /* below rtp_payload_size, the chunk will start */
2478 /* with a start code on some codecs like H.263. */
2479 /* This doesn't take account of any particular */
2480 /* headers inside the transmitted RTP payload. */
2482 /* statistics, used for 2-pass encoding */
2493 * number of bits used for the previously encoded frame
2494 * - encoding: Set by libavcodec.
2495 * - decoding: unused
2500 * pass1 encoding statistics output buffer
2501 * - encoding: Set by libavcodec.
2502 * - decoding: unused
2507 * pass2 encoding statistics input buffer
2508 * Concatenated stuff from stats_out of pass1 should be placed here.
2509 * - encoding: Allocated/set/freed by user.
2510 * - decoding: unused
2515 * Work around bugs in encoders which sometimes cannot be detected automatically.
2516 * - encoding: Set by user
2517 * - decoding: Set by user
2519 int workaround_bugs;
2520 #define FF_BUG_AUTODETECT 1 ///< autodetection
2521 #if FF_API_OLD_MSMPEG4
2522 #define FF_BUG_OLD_MSMPEG4 2
2524 #define FF_BUG_XVID_ILACE 4
2525 #define FF_BUG_UMP4 8
2526 #define FF_BUG_NO_PADDING 16
2527 #define FF_BUG_AMV 32
2529 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2531 #define FF_BUG_QPEL_CHROMA 64
2532 #define FF_BUG_STD_QPEL 128
2533 #define FF_BUG_QPEL_CHROMA2 256
2534 #define FF_BUG_DIRECT_BLOCKSIZE 512
2535 #define FF_BUG_EDGE 1024
2536 #define FF_BUG_HPEL_CHROMA 2048
2537 #define FF_BUG_DC_CLIP 4096
2538 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2539 #define FF_BUG_TRUNCATED 16384
2542 * strictly follow the standard (MPEG4, ...).
2543 * - encoding: Set by user.
2544 * - decoding: Set by user.
2545 * Setting this to STRICT or higher means the encoder and decoder will
2546 * generally do stupid things, whereas setting it to unofficial or lower
2547 * will mean the encoder might produce output that is not supported by all
2548 * spec-compliant decoders. Decoders don't differentiate between normal,
2549 * unofficial and experimental (that is, they always try to decode things
2550 * when they can) unless they are explicitly asked to behave stupidly
2551 * (=strictly conform to the specs)
2553 int strict_std_compliance;
2554 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2555 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2556 #define FF_COMPLIANCE_NORMAL 0
2557 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2558 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2561 * error concealment flags
2562 * - encoding: unused
2563 * - decoding: Set by user.
2565 int error_concealment;
2566 #define FF_EC_GUESS_MVS 1
2567 #define FF_EC_DEBLOCK 2
2568 #define FF_EC_FAVOR_INTER 256
2572 * - encoding: Set by user.
2573 * - decoding: Set by user.
2576 #define FF_DEBUG_PICT_INFO 1
2577 #define FF_DEBUG_RC 2
2578 #define FF_DEBUG_BITSTREAM 4
2579 #define FF_DEBUG_MB_TYPE 8
2580 #define FF_DEBUG_QP 16
2583 * @deprecated this option does nothing
2585 #define FF_DEBUG_MV 32
2587 #define FF_DEBUG_DCT_COEFF 0x00000040
2588 #define FF_DEBUG_SKIP 0x00000080
2589 #define FF_DEBUG_STARTCODE 0x00000100
2590 #define FF_DEBUG_PTS 0x00000200
2591 #define FF_DEBUG_ER 0x00000400
2592 #define FF_DEBUG_MMCO 0x00000800
2593 #define FF_DEBUG_BUGS 0x00001000
2595 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2596 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2598 #define FF_DEBUG_BUFFERS 0x00008000
2599 #define FF_DEBUG_THREADS 0x00010000
2600 #define FF_DEBUG_NOMC 0x01000000
2605 * Code outside libavcodec should access this field using AVOptions
2606 * - encoding: Set by user.
2607 * - decoding: Set by user.
2610 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2611 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2612 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2616 * Error recognition; may misdetect some more or less valid parts as errors.
2617 * - encoding: unused
2618 * - decoding: Set by user.
2620 int err_recognition;
2623 * Verify checksums embedded in the bitstream (could be of either encoded or
2624 * decoded data, depending on the codec) and print an error message on mismatch.
2625 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2626 * decoder returning an error.
2628 #define AV_EF_CRCCHECK (1<<0)
2629 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2630 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2631 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2633 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2634 #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
2635 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2636 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2640 * opaque 64bit number (generally a PTS) that will be reordered and
2641 * output in AVFrame.reordered_opaque
2642 * @deprecated in favor of pkt_pts
2643 * - encoding: unused
2644 * - decoding: Set by user.
2646 int64_t reordered_opaque;
2649 * Hardware accelerator in use
2650 * - encoding: unused.
2651 * - decoding: Set by libavcodec
2653 struct AVHWAccel *hwaccel;
2656 * Hardware accelerator context.
2657 * For some hardware accelerators, a global context needs to be
2658 * provided by the user. In that case, this holds display-dependent
2659 * data FFmpeg cannot instantiate itself. Please refer to the
2660 * FFmpeg HW accelerator documentation to know how to fill this
2661 * is. e.g. for VA API, this is a struct vaapi_context.
2662 * - encoding: unused
2663 * - decoding: Set by user
2665 void *hwaccel_context;
2669 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2670 * - decoding: unused
2672 uint64_t error[AV_NUM_DATA_POINTERS];
2675 * DCT algorithm, see FF_DCT_* below
2676 * - encoding: Set by user.
2677 * - decoding: unused
2680 #define FF_DCT_AUTO 0
2681 #define FF_DCT_FASTINT 1
2682 #define FF_DCT_INT 2
2683 #define FF_DCT_MMX 3
2684 #define FF_DCT_ALTIVEC 5
2685 #define FF_DCT_FAAN 6
2688 * IDCT algorithm, see FF_IDCT_* below.
2689 * - encoding: Set by user.
2690 * - decoding: Set by user.
2693 #define FF_IDCT_AUTO 0
2694 #define FF_IDCT_INT 1
2695 #define FF_IDCT_SIMPLE 2
2696 #define FF_IDCT_SIMPLEMMX 3
2697 #define FF_IDCT_ARM 7
2698 #define FF_IDCT_ALTIVEC 8
2700 #define FF_IDCT_SH4 9
2702 #define FF_IDCT_SIMPLEARM 10
2703 #define FF_IDCT_IPP 13
2704 #define FF_IDCT_XVIDMMX 14
2705 #define FF_IDCT_SIMPLEARMV5TE 16
2706 #define FF_IDCT_SIMPLEARMV6 17
2707 #if FF_API_ARCH_SPARC
2708 #define FF_IDCT_SIMPLEVIS 18
2710 #define FF_IDCT_FAAN 20
2711 #define FF_IDCT_SIMPLENEON 22
2712 #if FF_API_ARCH_ALPHA
2713 #define FF_IDCT_SIMPLEALPHA 23
2717 * bits per sample/pixel from the demuxer (needed for huffyuv).
2718 * - encoding: Set by libavcodec.
2719 * - decoding: Set by user.
2721 int bits_per_coded_sample;
2724 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2725 * - encoding: set by user.
2726 * - decoding: set by libavcodec.
2728 int bits_per_raw_sample;
2732 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2733 * - encoding: unused
2734 * - decoding: Set by user.
2735 * Code outside libavcodec should access this field using:
2736 * av_codec_{get,set}_lowres(avctx)
2742 * the picture in the bitstream
2743 * - encoding: Set by libavcodec.
2744 * - decoding: unused
2746 AVFrame *coded_frame;
2750 * is used to decide how many independent tasks should be passed to execute()
2751 * - encoding: Set by user.
2752 * - decoding: Set by user.
2757 * Which multithreading methods to use.
2758 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2759 * so clients which cannot provide future frames should not use it.
2761 * - encoding: Set by user, otherwise the default is used.
2762 * - decoding: Set by user, otherwise the default is used.
2765 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2766 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2769 * Which multithreading methods are in use by the codec.
2770 * - encoding: Set by libavcodec.
2771 * - decoding: Set by libavcodec.
2773 int active_thread_type;
2776 * Set by the client if its custom get_buffer() callback can be called
2777 * synchronously from another thread, which allows faster multithreaded decoding.
2778 * draw_horiz_band() will be called from other threads regardless of this setting.
2779 * Ignored if the default get_buffer() is used.
2780 * - encoding: Set by user.
2781 * - decoding: Set by user.
2783 int thread_safe_callbacks;
2786 * The codec may call this to execute several independent things.
2787 * It will return only after finishing all tasks.
2788 * The user may replace this with some multithreaded implementation,
2789 * the default implementation will execute the parts serially.
2790 * @param count the number of things to execute
2791 * - encoding: Set by libavcodec, user can override.
2792 * - decoding: Set by libavcodec, user can override.
2794 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2797 * The codec may call this to execute several independent things.
2798 * It will return only after finishing all tasks.
2799 * The user may replace this with some multithreaded implementation,
2800 * the default implementation will execute the parts serially.
2801 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2802 * @param c context passed also to func
2803 * @param count the number of things to execute
2804 * @param arg2 argument passed unchanged to func
2805 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2806 * @param func function that will be called count times, with jobnr from 0 to count-1.
2807 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2808 * two instances of func executing at the same time will have the same threadnr.
2809 * @return always 0 currently, but code should handle a future improvement where when any call to func
2810 * returns < 0 no further calls to func may be done and < 0 is returned.
2811 * - encoding: Set by libavcodec, user can override.
2812 * - decoding: Set by libavcodec, user can override.
2814 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2816 #if FF_API_THREAD_OPAQUE
2818 * @deprecated this field should not be used from outside of lavc
2820 attribute_deprecated
2821 void *thread_opaque;
2825 * noise vs. sse weight for the nsse comparison function
2826 * - encoding: Set by user.
2827 * - decoding: unused
2833 * - encoding: Set by user.
2834 * - decoding: Set by libavcodec.
2837 #define FF_PROFILE_UNKNOWN -99
2838 #define FF_PROFILE_RESERVED -100
2840 #define FF_PROFILE_AAC_MAIN 0
2841 #define FF_PROFILE_AAC_LOW 1
2842 #define FF_PROFILE_AAC_SSR 2
2843 #define FF_PROFILE_AAC_LTP 3
2844 #define FF_PROFILE_AAC_HE 4
2845 #define FF_PROFILE_AAC_HE_V2 28
2846 #define FF_PROFILE_AAC_LD 22
2847 #define FF_PROFILE_AAC_ELD 38
2848 #define FF_PROFILE_MPEG2_AAC_LOW 128
2849 #define FF_PROFILE_MPEG2_AAC_HE 131
2851 #define FF_PROFILE_DTS 20
2852 #define FF_PROFILE_DTS_ES 30
2853 #define FF_PROFILE_DTS_96_24 40
2854 #define FF_PROFILE_DTS_HD_HRA 50
2855 #define FF_PROFILE_DTS_HD_MA 60
2857 #define FF_PROFILE_MPEG2_422 0
2858 #define FF_PROFILE_MPEG2_HIGH 1
2859 #define FF_PROFILE_MPEG2_SS 2
2860 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2861 #define FF_PROFILE_MPEG2_MAIN 4
2862 #define FF_PROFILE_MPEG2_SIMPLE 5
2864 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2865 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2867 #define FF_PROFILE_H264_BASELINE 66
2868 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2869 #define FF_PROFILE_H264_MAIN 77
2870 #define FF_PROFILE_H264_EXTENDED 88
2871 #define FF_PROFILE_H264_HIGH 100
2872 #define FF_PROFILE_H264_HIGH_10 110
2873 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2874 #define FF_PROFILE_H264_HIGH_422 122
2875 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2876 #define FF_PROFILE_H264_HIGH_444 144
2877 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2878 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2879 #define FF_PROFILE_H264_CAVLC_444 44
2881 #define FF_PROFILE_VC1_SIMPLE 0
2882 #define FF_PROFILE_VC1_MAIN 1
2883 #define FF_PROFILE_VC1_COMPLEX 2
2884 #define FF_PROFILE_VC1_ADVANCED 3
2886 #define FF_PROFILE_MPEG4_SIMPLE 0
2887 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2888 #define FF_PROFILE_MPEG4_CORE 2
2889 #define FF_PROFILE_MPEG4_MAIN 3
2890 #define FF_PROFILE_MPEG4_N_BIT 4
2891 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2892 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2893 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2894 #define FF_PROFILE_MPEG4_HYBRID 8
2895 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2896 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2897 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2898 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2899 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2900 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2901 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2903 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2904 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2905 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2906 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2907 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2910 #define FF_PROFILE_HEVC_MAIN 1
2911 #define FF_PROFILE_HEVC_MAIN_10 2
2912 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2916 * - encoding: Set by user.
2917 * - decoding: Set by libavcodec.
2920 #define FF_LEVEL_UNKNOWN -99
2923 * Skip loop filtering for selected frames.
2924 * - encoding: unused
2925 * - decoding: Set by user.
2927 enum AVDiscard skip_loop_filter;
2930 * Skip IDCT/dequantization for selected frames.
2931 * - encoding: unused
2932 * - decoding: Set by user.
2934 enum AVDiscard skip_idct;
2937 * Skip decoding for selected frames.
2938 * - encoding: unused
2939 * - decoding: Set by user.
2941 enum AVDiscard skip_frame;
2944 * Header containing style information for text subtitles.
2945 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2946 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2947 * the Format line following. It shouldn't include any Dialogue line.
2948 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2949 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2951 uint8_t *subtitle_header;
2952 int subtitle_header_size;
2954 #if FF_API_ERROR_RATE
2956 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2959 attribute_deprecated
2963 #if FF_API_CODEC_PKT
2965 * @deprecated this field is not supposed to be accessed from outside lavc
2967 attribute_deprecated
2972 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2973 * Used for compliant TS muxing.
2974 * - encoding: Set by libavcodec.
2975 * - decoding: unused.
2980 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2981 * Code outside libavcodec should access this field using:
2982 * av_codec_{get,set}_pkt_timebase(avctx)
2983 * - encoding unused.
2984 * - decoding set by user.
2986 AVRational pkt_timebase;
2990 * Code outside libavcodec should access this field using:
2991 * av_codec_{get,set}_codec_descriptor(avctx)
2992 * - encoding: unused.
2993 * - decoding: set by libavcodec.
2995 const AVCodecDescriptor *codec_descriptor;
2999 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3000 * - encoding: unused
3001 * - decoding: Set by user.
3002 * Code outside libavcodec should access this field using:
3003 * av_codec_{get,set}_lowres(avctx)
3009 * Current statistics for PTS correction.
3010 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3011 * - encoding: unused
3013 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3014 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3015 int64_t pts_correction_last_pts; /// PTS of the last frame
3016 int64_t pts_correction_last_dts; /// DTS of the last frame
3019 * Character encoding of the input subtitles file.
3020 * - decoding: set by user
3021 * - encoding: unused
3026 * Subtitles character encoding mode. Formats or codecs might be adjusting
3027 * this setting (if they are doing the conversion themselves for instance).
3028 * - decoding: set by libavcodec
3029 * - encoding: unused
3031 int sub_charenc_mode;
3032 #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)
3033 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3034 #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
3037 * Skip processing alpha if supported by codec.
3038 * Note that if the format uses pre-multiplied alpha (common with VP6,
3039 * and recommended due to better video quality/compression)
3040 * the image will look as if alpha-blended onto a black background.
3041 * However for formats that do not use pre-multiplied alpha
3042 * there might be serious artefacts (though e.g. libswscale currently
3043 * assumes pre-multiplied alpha anyway).
3044 * Code outside libavcodec should access this field using AVOptions
3046 * - decoding: set by user
3047 * - encoding: unused
3052 * Number of samples to skip after a discontinuity
3053 * - decoding: unused
3054 * - encoding: set by libavcodec
3058 #if !FF_API_DEBUG_MV
3060 * debug motion vectors
3061 * Code outside libavcodec should access this field using AVOptions
3062 * - encoding: Set by user.
3063 * - decoding: Set by user.
3066 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3067 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3068 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3072 * custom intra quantization matrix
3073 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3074 * - encoding: Set by user, can be NULL.
3075 * - decoding: unused.
3077 uint16_t *chroma_intra_matrix;
3080 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3081 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3083 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3084 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3086 int av_codec_get_lowres(const AVCodecContext *avctx);
3087 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3089 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3090 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3092 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3093 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3098 typedef struct AVProfile {
3100 const char *name; ///< short name for the profile
3103 typedef struct AVCodecDefault AVCodecDefault;
3110 typedef struct AVCodec {
3112 * Name of the codec implementation.
3113 * The name is globally unique among encoders and among decoders (but an
3114 * encoder and a decoder can share the same name).
3115 * This is the primary way to find a codec from the user perspective.
3119 * Descriptive name for the codec, meant to be more human readable than name.
3120 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3122 const char *long_name;
3123 enum AVMediaType type;
3126 * Codec capabilities.
3130 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3131 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3132 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3133 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3134 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3136 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3138 const AVClass *priv_class; ///< AVClass for the private context
3139 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3141 /*****************************************************************
3142 * No fields below this line are part of the public API. They
3143 * may not be used outside of libavcodec and can be changed and
3145 * New public fields should be added right above.
3146 *****************************************************************
3149 struct AVCodec *next;
3151 * @name Frame-level threading support functions
3155 * If defined, called on thread contexts when they are created.
3156 * If the codec allocates writable tables in init(), re-allocate them here.
3157 * priv_data will be set to a copy of the original.
3159 int (*init_thread_copy)(AVCodecContext *);
3161 * Copy necessary context variables from a previous thread context to the current one.
3162 * If not defined, the next thread will start automatically; otherwise, the codec
3163 * must call ff_thread_finish_setup().
3165 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3167 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3171 * Private codec-specific defaults.
3173 const AVCodecDefault *defaults;
3176 * Initialize codec static data, called from avcodec_register().
3178 void (*init_static_data)(struct AVCodec *codec);
3180 int (*init)(AVCodecContext *);
3181 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3182 const struct AVSubtitle *sub);
3184 * Encode data to an AVPacket.
3186 * @param avctx codec context
3187 * @param avpkt output AVPacket (may contain a user-provided buffer)
3188 * @param[in] frame AVFrame containing the raw data to be encoded
3189 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3190 * non-empty packet was returned in avpkt.
3191 * @return 0 on success, negative error code on failure
3193 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3194 int *got_packet_ptr);
3195 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3196 int (*close)(AVCodecContext *);
3199 * Will be called when seeking
3201 void (*flush)(AVCodecContext *);
3204 int av_codec_get_max_lowres(const AVCodec *codec);
3206 struct MpegEncContext;
3211 typedef struct AVHWAccel {
3213 * Name of the hardware accelerated codec.
3214 * The name is globally unique among encoders and among decoders (but an
3215 * encoder and a decoder can share the same name).
3220 * Type of codec implemented by the hardware accelerator.
3222 * See AVMEDIA_TYPE_xxx
3224 enum AVMediaType type;
3227 * Codec implemented by the hardware accelerator.
3229 * See AV_CODEC_ID_xxx
3234 * Supported pixel format.
3236 * Only hardware accelerated formats are supported here.
3238 enum AVPixelFormat pix_fmt;
3241 * Hardware accelerated codec capabilities.
3242 * see FF_HWACCEL_CODEC_CAP_*
3246 /*****************************************************************
3247 * No fields below this line are part of the public API. They
3248 * may not be used outside of libavcodec and can be changed and
3250 * New public fields should be added right above.
3251 *****************************************************************
3253 struct AVHWAccel *next;
3256 * Allocate a custom buffer
3258 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3261 * Called at the beginning of each frame or field picture.
3263 * Meaningful frame information (codec specific) is guaranteed to
3264 * be parsed at this point. This function is mandatory.
3266 * Note that buf can be NULL along with buf_size set to 0.
3267 * Otherwise, this means the whole frame is available at this point.
3269 * @param avctx the codec context
3270 * @param buf the frame data buffer base
3271 * @param buf_size the size of the frame in bytes
3272 * @return zero if successful, a negative value otherwise
3274 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3277 * Callback for each slice.
3279 * Meaningful slice information (codec specific) is guaranteed to
3280 * be parsed at this point. This function is mandatory.
3281 * The only exception is XvMC, that works on MB level.
3283 * @param avctx the codec context
3284 * @param buf the slice data buffer base
3285 * @param buf_size the size of the slice in bytes
3286 * @return zero if successful, a negative value otherwise
3288 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3291 * Called at the end of each frame or field picture.
3293 * The whole picture is parsed at this point and can now be sent
3294 * to the hardware accelerator. This function is mandatory.
3296 * @param avctx the codec context
3297 * @return zero if successful, a negative value otherwise
3299 int (*end_frame)(AVCodecContext *avctx);
3302 * Size of per-frame hardware accelerator private data.
3304 * Private data is allocated with av_mallocz() before
3305 * AVCodecContext.get_buffer() and deallocated after
3306 * AVCodecContext.release_buffer().
3308 int frame_priv_data_size;
3311 * Called for every Macroblock in a slice.
3313 * XvMC uses it to replace the ff_MPV_decode_mb().
3314 * Instead of decoding to raw picture, MB parameters are
3315 * stored in an array provided by the video driver.
3317 * @param s the mpeg context
3319 void (*decode_mb)(struct MpegEncContext *s);
3322 * Initialize the hwaccel private data.
3324 * This will be called from ff_get_format(), after hwaccel and
3325 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3328 int (*init)(AVCodecContext *avctx);
3331 * Uninitialize the hwaccel private data.
3333 * This will be called from get_format() or avcodec_close(), after hwaccel
3334 * and hwaccel_context are already uninitialized.
3336 int (*uninit)(AVCodecContext *avctx);
3339 * Size of the private data to allocate in
3340 * AVCodecInternal.hwaccel_priv_data.
3346 * @defgroup lavc_picture AVPicture
3348 * Functions for working with AVPicture
3353 * Picture data structure.
3355 * Up to four components can be stored into it, the last component is
3358 typedef struct AVPicture {
3359 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3360 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3367 enum AVSubtitleType {
3370 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3373 * Plain text, the text field must be set by the decoder and is
3374 * authoritative. ass and pict fields may contain approximations.
3379 * Formatted text, the ass field must be set by the decoder and is
3380 * authoritative. pict and text fields may contain approximations.
3385 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3387 typedef struct AVSubtitleRect {
3388 int x; ///< top left corner of pict, undefined when pict is not set
3389 int y; ///< top left corner of pict, undefined when pict is not set
3390 int w; ///< width of pict, undefined when pict is not set
3391 int h; ///< height of pict, undefined when pict is not set
3392 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3395 * data+linesize for the bitmap of this subtitle.
3396 * can be set for text/ass as well once they where rendered
3399 enum AVSubtitleType type;
3401 char *text; ///< 0 terminated plain UTF-8 text
3404 * 0 terminated ASS/SSA compatible event line.
3405 * The presentation of this is unaffected by the other values in this
3413 typedef struct AVSubtitle {
3414 uint16_t format; /* 0 = graphics */
3415 uint32_t start_display_time; /* relative to packet pts, in ms */
3416 uint32_t end_display_time; /* relative to packet pts, in ms */
3418 AVSubtitleRect **rects;
3419 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3423 * If c is NULL, returns the first registered codec,
3424 * if c is non-NULL, returns the next registered codec after c,
3425 * or NULL if c is the last one.
3427 AVCodec *av_codec_next(const AVCodec *c);
3430 * Return the LIBAVCODEC_VERSION_INT constant.
3432 unsigned avcodec_version(void);
3435 * Return the libavcodec build-time configuration.
3437 const char *avcodec_configuration(void);
3440 * Return the libavcodec license.
3442 const char *avcodec_license(void);
3445 * Register the codec codec and initialize libavcodec.
3447 * @warning either this function or avcodec_register_all() must be called
3448 * before any other libavcodec functions.
3450 * @see avcodec_register_all()
3452 void avcodec_register(AVCodec *codec);
3455 * Register all the codecs, parsers and bitstream filters which were enabled at
3456 * configuration time. If you do not call this function you can select exactly
3457 * which formats you want to support, by using the individual registration
3460 * @see avcodec_register
3461 * @see av_register_codec_parser
3462 * @see av_register_bitstream_filter
3464 void avcodec_register_all(void);
3467 * Allocate an AVCodecContext and set its fields to default values. The
3468 * resulting struct should be freed with avcodec_free_context().
3470 * @param codec if non-NULL, allocate private data and initialize defaults
3471 * for the given codec. It is illegal to then call avcodec_open2()
3472 * with a different codec.
3473 * If NULL, then the codec-specific defaults won't be initialized,
3474 * which may result in suboptimal default settings (this is
3475 * important mainly for encoders, e.g. libx264).
3477 * @return An AVCodecContext filled with default values or NULL on failure.
3478 * @see avcodec_get_context_defaults
3480 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3483 * Free the codec context and everything associated with it and write NULL to
3484 * the provided pointer.
3486 void avcodec_free_context(AVCodecContext **avctx);
3489 * Set the fields of the given AVCodecContext to default values corresponding
3490 * to the given codec (defaults may be codec-dependent).
3492 * Do not call this function if a non-NULL codec has been passed
3493 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3494 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3495 * different codec on this AVCodecContext.
3497 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3500 * Get the AVClass for AVCodecContext. It can be used in combination with
3501 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3503 * @see av_opt_find().
3505 const AVClass *avcodec_get_class(void);
3508 * Get the AVClass for AVFrame. It can be used in combination with
3509 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3511 * @see av_opt_find().
3513 const AVClass *avcodec_get_frame_class(void);
3516 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3517 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3519 * @see av_opt_find().
3521 const AVClass *avcodec_get_subtitle_rect_class(void);
3524 * Copy the settings of the source AVCodecContext into the destination
3525 * AVCodecContext. The resulting destination codec context will be
3526 * unopened, i.e. you are required to call avcodec_open2() before you
3527 * can use this AVCodecContext to decode/encode video/audio data.
3529 * @param dest target codec context, should be initialized with
3530 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3531 * @param src source codec context
3532 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3534 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3536 #if FF_API_AVFRAME_LAVC
3538 * @deprecated use av_frame_alloc()
3540 attribute_deprecated
3541 AVFrame *avcodec_alloc_frame(void);
3544 * Set the fields of the given AVFrame to default values.
3546 * @param frame The AVFrame of which the fields should be set to default values.
3548 * @deprecated use av_frame_unref()
3550 attribute_deprecated
3551 void avcodec_get_frame_defaults(AVFrame *frame);
3554 * Free the frame and any dynamically allocated objects in it,
3555 * e.g. extended_data.
3557 * @param frame frame to be freed. The pointer will be set to NULL.
3559 * @warning this function does NOT free the data buffers themselves
3560 * (it does not know how, since they might have been allocated with
3561 * a custom get_buffer()).
3563 * @deprecated use av_frame_free()
3565 attribute_deprecated
3566 void avcodec_free_frame(AVFrame **frame);
3570 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3571 * function the context has to be allocated with avcodec_alloc_context3().
3573 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3574 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3575 * retrieving a codec.
3577 * @warning This function is not thread safe!
3580 * avcodec_register_all();
3581 * av_dict_set(&opts, "b", "2.5M", 0);
3582 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3586 * context = avcodec_alloc_context3(codec);
3588 * if (avcodec_open2(context, codec, opts) < 0)
3592 * @param avctx The context to initialize.
3593 * @param codec The codec to open this context for. If a non-NULL codec has been
3594 * previously passed to avcodec_alloc_context3() or
3595 * avcodec_get_context_defaults3() for this context, then this
3596 * parameter MUST be either NULL or equal to the previously passed
3598 * @param options A dictionary filled with AVCodecContext and codec-private options.
3599 * On return this object will be filled with options that were not found.
3601 * @return zero on success, a negative value on error
3602 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3603 * av_dict_set(), av_opt_find().
3605 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3608 * Close a given AVCodecContext and free all the data associated with it
3609 * (but not the AVCodecContext itself).
3611 * Calling this function on an AVCodecContext that hasn't been opened will free
3612 * the codec-specific data allocated in avcodec_alloc_context3() /
3613 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3616 int avcodec_close(AVCodecContext *avctx);
3619 * Free all allocated data in the given subtitle struct.
3621 * @param sub AVSubtitle to free.
3623 void avsubtitle_free(AVSubtitle *sub);
3630 * @addtogroup lavc_packet
3634 #if FF_API_DESTRUCT_PACKET
3636 * Default packet destructor.
3637 * @deprecated use the AVBuffer API instead
3639 attribute_deprecated
3640 void av_destruct_packet(AVPacket *pkt);
3644 * Initialize optional fields of a packet with default values.
3646 * Note, this does not touch the data and size members, which have to be
3647 * initialized separately.
3651 void av_init_packet(AVPacket *pkt);
3654 * Allocate the payload of a packet and initialize its fields with
3658 * @param size wanted payload size
3659 * @return 0 if OK, AVERROR_xxx otherwise
3661 int av_new_packet(AVPacket *pkt, int size);
3664 * Reduce packet size, correctly zeroing padding
3667 * @param size new size
3669 void av_shrink_packet(AVPacket *pkt, int size);
3672 * Increase packet size, correctly zeroing padding
3675 * @param grow_by number of bytes by which to increase the size of the packet
3677 int av_grow_packet(AVPacket *pkt, int grow_by);
3680 * Initialize a reference-counted packet from av_malloc()ed data.
3682 * @param pkt packet to be initialized. This function will set the data, size,
3683 * buf and destruct fields, all others are left untouched.
3684 * @param data Data allocated by av_malloc() to be used as packet data. If this
3685 * function returns successfully, the data is owned by the underlying AVBuffer.
3686 * The caller may not access the data through other means.
3687 * @param size size of data in bytes, without the padding. I.e. the full buffer
3688 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3690 * @return 0 on success, a negative AVERROR on error
3692 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3695 * @warning This is a hack - the packet memory allocation stuff is broken. The
3696 * packet is allocated if it was not really allocated.
3698 int av_dup_packet(AVPacket *pkt);
3701 * Copy packet, including contents
3703 * @return 0 on success, negative AVERROR on fail
3705 int av_copy_packet(AVPacket *dst, const AVPacket *src);
3708 * Copy packet side data
3710 * @return 0 on success, negative AVERROR on fail
3712 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
3717 * @param pkt packet to free
3719 void av_free_packet(AVPacket *pkt);
3722 * Allocate new information of a packet.
3725 * @param type side information type
3726 * @param size side information size
3727 * @return pointer to fresh allocated data or NULL otherwise
3729 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3733 * Shrink the already allocated side data buffer
3736 * @param type side information type
3737 * @param size new side information size
3738 * @return 0 on success, < 0 on failure
3740 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3744 * Get side information from packet.
3747 * @param type desired side information type
3748 * @param size pointer for side information size to store (optional)
3749 * @return pointer to data if present or NULL otherwise
3751 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3754 int av_packet_merge_side_data(AVPacket *pkt);
3756 int av_packet_split_side_data(AVPacket *pkt);
3759 * Pack a dictionary for use in side_data.
3761 * @param dict The dictionary to pack.
3762 * @param size pointer to store the size of the returned data
3763 * @return pointer to data if successful, NULL otherwise
3765 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
3767 * Unpack a dictionary from side_data.
3769 * @param data data from side_data
3770 * @param size size of the data
3771 * @param dict the metadata storage dictionary
3772 * @return 0 on success, < 0 on failure
3774 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
3778 * Convenience function to free all the side data stored.
3779 * All the other fields stay untouched.
3783 void av_packet_free_side_data(AVPacket *pkt);
3786 * Setup a new reference to the data described by a given packet
3788 * If src is reference-counted, setup dst as a new reference to the
3789 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3790 * data from src into it.
3792 * All the other fields are copied from src.
3794 * @see av_packet_unref
3796 * @param dst Destination packet
3797 * @param src Source packet
3799 * @return 0 on success, a negative AVERROR on error.
3801 int av_packet_ref(AVPacket *dst, const AVPacket *src);
3806 * Unreference the buffer referenced by the packet and reset the
3807 * remaining packet fields to their default values.
3809 * @param pkt The packet to be unreferenced.
3811 void av_packet_unref(AVPacket *pkt);
3814 * Move every field in src to dst and reset src.
3816 * @see av_packet_unref
3818 * @param src Source packet, will be reset
3819 * @param dst Destination packet
3821 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3824 * Copy only "properties" fields from src to dst.
3826 * Properties for the purpose of this function are all the fields
3827 * beside those related to the packet data (buf, data, size)
3829 * @param dst Destination packet
3830 * @param src Source packet
3832 * @return 0 on success AVERROR on failure.
3835 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3842 * @addtogroup lavc_decoding
3847 * Find a registered decoder with a matching codec ID.
3849 * @param id AVCodecID of the requested decoder
3850 * @return A decoder if one was found, NULL otherwise.
3852 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3855 * Find a registered decoder with the specified name.
3857 * @param name name of the requested decoder
3858 * @return A decoder if one was found, NULL otherwise.
3860 AVCodec *avcodec_find_decoder_by_name(const char *name);
3862 #if FF_API_GET_BUFFER
3863 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3864 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3865 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3869 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3870 * it can be called by custom get_buffer2() implementations for decoders without
3871 * CODEC_CAP_DR1 set.
3873 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3877 * Return the amount of padding in pixels which the get_buffer callback must
3878 * provide around the edge of the image for codecs which do not have the
3879 * CODEC_FLAG_EMU_EDGE flag.
3881 * @return Required padding in pixels.
3883 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
3886 attribute_deprecated
3887 unsigned avcodec_get_edge_width(void);
3891 * Modify width and height values so that they will result in a memory
3892 * buffer that is acceptable for the codec if you do not use any horizontal
3895 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3897 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3900 * Modify width and height values so that they will result in a memory
3901 * buffer that is acceptable for the codec if you also ensure that all
3902 * line sizes are a multiple of the respective linesize_align[i].
3904 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3906 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3907 int linesize_align[AV_NUM_DATA_POINTERS]);
3910 * Converts AVChromaLocation to swscale x/y chroma position.
3912 * The positions represent the chroma (0,0) position in a coordinates system
3913 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3915 * @param xpos horizontal chroma sample position
3916 * @param ypos vertical chroma sample position
3918 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
3921 * Converts swscale x/y chroma position to AVChromaLocation.
3923 * The positions represent the chroma (0,0) position in a coordinates system
3924 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3926 * @param xpos horizontal chroma sample position
3927 * @param ypos vertical chroma sample position
3929 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
3931 #if FF_API_OLD_DECODE_AUDIO
3933 * Wrapper function which calls avcodec_decode_audio4.
3935 * @deprecated Use avcodec_decode_audio4 instead.
3937 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3938 * Some decoders may support multiple frames in a single AVPacket, such
3939 * decoders would then just decode the first frame. In this case,
3940 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3941 * the remaining data in order to decode the second frame etc.
3943 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3944 * decompressed frame size in bytes.
3946 * @warning You must set frame_size_ptr to the allocated size of the
3947 * output buffer before calling avcodec_decode_audio3().
3949 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3950 * the actual read bytes because some optimized bitstream readers read 32 or 64
3951 * bits at once and could read over the end.
3953 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3954 * no overreading happens for damaged MPEG streams.
3956 * @warning You must not provide a custom get_buffer() when using
3957 * avcodec_decode_audio3(). Doing so will override it with
3958 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3959 * which does allow the application to provide a custom get_buffer().
3961 * @note You might have to align the input buffer avpkt->data and output buffer
3962 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3963 * necessary at all, on others it won't work at all if not aligned and on others
3964 * it will work but it will have an impact on performance.
3966 * In practice, avpkt->data should have 4 byte alignment at minimum and
3967 * samples should be 16 byte aligned unless the CPU doesn't need it
3968 * (AltiVec and SSE do).
3970 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3971 * between input and output, these need to be fed with avpkt->data=NULL,
3972 * avpkt->size=0 at the end to return the remaining frames.
3974 * @param avctx the codec context
3975 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3976 * If the sample format is planar, each channel plane will
3977 * be the same size, with no padding between channels.
3978 * @param[in,out] frame_size_ptr the output buffer size in bytes
3979 * @param[in] avpkt The input AVPacket containing the input buffer.
3980 * You can create such packet with av_init_packet() and by then setting
3981 * data and size, some decoders might in addition need other fields.
3982 * All decoders are designed to use the least fields possible though.
3983 * @return On error a negative value is returned, otherwise the number of bytes
3984 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3986 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3987 int *frame_size_ptr,
3992 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3994 * Some decoders may support multiple frames in a single AVPacket. Such
3995 * decoders would then just decode the first frame and the return value would be
3996 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3997 * called again with an AVPacket containing the remaining data in order to
3998 * decode the second frame, etc... Even if no frames are returned, the packet
3999 * needs to be fed to the decoder with remaining data until it is completely
4000 * consumed or an error occurs.
4002 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4003 * and output. This means that for some packets they will not immediately
4004 * produce decoded output and need to be flushed at the end of decoding to get
4005 * all the decoded data. Flushing is done by calling this function with packets
4006 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4007 * returning samples. It is safe to flush even those decoders that are not
4008 * marked with CODEC_CAP_DELAY, then no samples will be returned.
4010 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
4011 * larger than the actual read bytes because some optimized bitstream
4012 * readers read 32 or 64 bits at once and could read over the end.
4014 * @param avctx the codec context
4015 * @param[out] frame The AVFrame in which to store decoded audio samples.
4016 * The decoder will allocate a buffer for the decoded frame by
4017 * calling the AVCodecContext.get_buffer2() callback.
4018 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4019 * reference counted and the returned reference belongs to the
4020 * caller. The caller must release the frame using av_frame_unref()
4021 * when the frame is no longer needed. The caller may safely write
4022 * to the frame if av_frame_is_writable() returns 1.
4023 * When AVCodecContext.refcounted_frames is set to 0, the returned
4024 * reference belongs to the decoder and is valid only until the
4025 * next call to this function or until closing or flushing the
4026 * decoder. The caller may not write to it.
4027 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4028 * non-zero. Note that this field being set to zero
4029 * does not mean that an error has occurred. For
4030 * decoders with CODEC_CAP_DELAY set, no given decode
4031 * call is guaranteed to produce a frame.
4032 * @param[in] avpkt The input AVPacket containing the input buffer.
4033 * At least avpkt->data and avpkt->size should be set. Some
4034 * decoders might also require additional fields to be set.
4035 * @return A negative error code is returned if an error occurred during
4036 * decoding, otherwise the number of bytes consumed from the input
4037 * AVPacket is returned.
4039 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4040 int *got_frame_ptr, const AVPacket *avpkt);
4043 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4044 * Some decoders may support multiple frames in a single AVPacket, such
4045 * decoders would then just decode the first frame.
4047 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4048 * the actual read bytes because some optimized bitstream readers read 32 or 64
4049 * bits at once and could read over the end.
4051 * @warning The end of the input buffer buf should be set to 0 to ensure that
4052 * no overreading happens for damaged MPEG streams.
4054 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4055 * between input and output, these need to be fed with avpkt->data=NULL,
4056 * avpkt->size=0 at the end to return the remaining frames.
4058 * @param avctx the codec context
4059 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4060 * Use av_frame_alloc() to get an AVFrame. The codec will
4061 * allocate memory for the actual bitmap by calling the
4062 * AVCodecContext.get_buffer2() callback.
4063 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4064 * reference counted and the returned reference belongs to the
4065 * caller. The caller must release the frame using av_frame_unref()
4066 * when the frame is no longer needed. The caller may safely write
4067 * to the frame if av_frame_is_writable() returns 1.
4068 * When AVCodecContext.refcounted_frames is set to 0, the returned
4069 * reference belongs to the decoder and is valid only until the
4070 * next call to this function or until closing or flushing the
4071 * decoder. The caller may not write to it.
4073 * @param[in] avpkt The input AVPacket containing the input buffer.
4074 * You can create such packet with av_init_packet() and by then setting
4075 * data and size, some decoders might in addition need other fields like
4076 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4078 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4079 * @return On error a negative value is returned, otherwise the number of bytes
4080 * used or zero if no frame could be decompressed.
4082 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4083 int *got_picture_ptr,
4084 const AVPacket *avpkt);
4087 * Decode a subtitle message.
4088 * Return a negative value on error, otherwise return the number of bytes used.
4089 * If no subtitle could be decompressed, got_sub_ptr is zero.
4090 * Otherwise, the subtitle is stored in *sub.
4091 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4092 * simplicity, because the performance difference is expect to be negligible
4093 * and reusing a get_buffer written for video codecs would probably perform badly
4094 * due to a potentially very different allocation pattern.
4096 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4097 * and output. This means that for some packets they will not immediately
4098 * produce decoded output and need to be flushed at the end of decoding to get
4099 * all the decoded data. Flushing is done by calling this function with packets
4100 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4101 * returning subtitles. It is safe to flush even those decoders that are not
4102 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4104 * @param avctx the codec context
4105 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4106 freed with avsubtitle_free if *got_sub_ptr is set.
4107 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4108 * @param[in] avpkt The input AVPacket containing the input buffer.
4110 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4115 * @defgroup lavc_parsing Frame parsing
4119 enum AVPictureStructure {
4120 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4121 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4122 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4123 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4126 typedef struct AVCodecParserContext {
4128 struct AVCodecParser *parser;
4129 int64_t frame_offset; /* offset of the current frame */
4130 int64_t cur_offset; /* current offset
4131 (incremented by each av_parser_parse()) */
4132 int64_t next_frame_offset; /* offset of the next frame */
4134 int pict_type; /* XXX: Put it back in AVCodecContext. */
4136 * This field is used for proper frame duration computation in lavf.
4137 * It signals, how much longer the frame duration of the current frame
4138 * is compared to normal frame duration.
4140 * frame_duration = (1 + repeat_pict) * time_base
4142 * It is used by codecs like H.264 to display telecined material.
4144 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4145 int64_t pts; /* pts of the current frame */
4146 int64_t dts; /* dts of the current frame */
4151 int fetch_timestamp;
4153 #define AV_PARSER_PTS_NB 4
4154 int cur_frame_start_index;
4155 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4156 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4157 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4160 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4161 #define PARSER_FLAG_ONCE 0x0002
4162 /// Set if the parser has a valid file offset
4163 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4164 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4166 int64_t offset; ///< byte offset from starting packet start
4167 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4170 * Set by parser to 1 for key frames and 0 for non-key frames.
4171 * It is initialized to -1, so if the parser doesn't set this flag,
4172 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4178 * Time difference in stream time base units from the pts of this
4179 * packet to the point at which the output from the decoder has converged
4180 * independent from the availability of previous frames. That is, the
4181 * frames are virtually identical no matter if decoding started from
4182 * the very first frame or from this keyframe.
4183 * Is AV_NOPTS_VALUE if unknown.
4184 * This field is not the display duration of the current frame.
4185 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4188 * The purpose of this field is to allow seeking in streams that have no
4189 * keyframes in the conventional sense. It corresponds to the
4190 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4191 * essential for some types of subtitle streams to ensure that all
4192 * subtitles are correctly displayed after seeking.
4194 int64_t convergence_duration;
4196 // Timestamp generation support:
4198 * Synchronization point for start of timestamp generation.
4200 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4203 * For example, this corresponds to presence of H.264 buffering period
4209 * Offset of the current timestamp against last timestamp sync point in
4210 * units of AVCodecContext.time_base.
4212 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4213 * contain a valid timestamp offset.
4215 * Note that the timestamp of sync point has usually a nonzero
4216 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4217 * the next frame after timestamp sync point will be usually 1.
4219 * For example, this corresponds to H.264 cpb_removal_delay.
4221 int dts_ref_dts_delta;
4224 * Presentation delay of current frame in units of AVCodecContext.time_base.
4226 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4227 * contain valid non-negative timestamp delta (presentation time of a frame
4228 * must not lie in the past).
4230 * This delay represents the difference between decoding and presentation
4231 * time of the frame.
4233 * For example, this corresponds to H.264 dpb_output_delay.
4238 * Position of the packet in file.
4240 * Analogous to cur_frame_pts/dts
4242 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4245 * Byte position of currently parsed frame in stream.
4250 * Previous frame byte position.
4255 * Duration of the current frame.
4256 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4257 * For all other types, this is in units of AVCodecContext.time_base.
4261 enum AVFieldOrder field_order;
4264 * Indicate whether a picture is coded as a frame, top field or bottom field.
4266 * For example, H.264 field_pic_flag equal to 0 corresponds to
4267 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4268 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4269 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4271 enum AVPictureStructure picture_structure;
4274 * Picture number incremented in presentation or output order.
4275 * This field may be reinitialized at the first picture of a new sequence.
4277 * For example, this corresponds to H.264 PicOrderCnt.
4279 int output_picture_number;
4280 } AVCodecParserContext;
4282 typedef struct AVCodecParser {
4283 int codec_ids[5]; /* several codec IDs are permitted */
4285 int (*parser_init)(AVCodecParserContext *s);
4286 int (*parser_parse)(AVCodecParserContext *s,
4287 AVCodecContext *avctx,
4288 const uint8_t **poutbuf, int *poutbuf_size,
4289 const uint8_t *buf, int buf_size);
4290 void (*parser_close)(AVCodecParserContext *s);
4291 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4292 struct AVCodecParser *next;
4295 AVCodecParser *av_parser_next(AVCodecParser *c);
4297 void av_register_codec_parser(AVCodecParser *parser);
4298 AVCodecParserContext *av_parser_init(int codec_id);
4303 * @param s parser context.
4304 * @param avctx codec context.
4305 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4306 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4307 * @param buf input buffer.
4308 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4309 * @param pts input presentation timestamp.
4310 * @param dts input decoding timestamp.
4311 * @param pos input byte position in stream.
4312 * @return the number of bytes of the input bitstream used.
4317 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4324 * decode_frame(data, size);
4328 int av_parser_parse2(AVCodecParserContext *s,
4329 AVCodecContext *avctx,
4330 uint8_t **poutbuf, int *poutbuf_size,
4331 const uint8_t *buf, int buf_size,
4332 int64_t pts, int64_t dts,
4336 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4337 * @deprecated use AVBitStreamFilter
4339 int av_parser_change(AVCodecParserContext *s,
4340 AVCodecContext *avctx,
4341 uint8_t **poutbuf, int *poutbuf_size,
4342 const uint8_t *buf, int buf_size, int keyframe);
4343 void av_parser_close(AVCodecParserContext *s);
4351 * @addtogroup lavc_encoding
4356 * Find a registered encoder with a matching codec ID.
4358 * @param id AVCodecID of the requested encoder
4359 * @return An encoder if one was found, NULL otherwise.
4361 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4364 * Find a registered encoder with the specified name.
4366 * @param name name of the requested encoder
4367 * @return An encoder if one was found, NULL otherwise.
4369 AVCodec *avcodec_find_encoder_by_name(const char *name);
4371 #if FF_API_OLD_ENCODE_AUDIO
4373 * Encode an audio frame from samples into buf.
4375 * @deprecated Use avcodec_encode_audio2 instead.
4377 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4378 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4379 * will know how much space is needed because it depends on the value passed
4380 * in buf_size as described below. In that case a lower value can be used.
4382 * @param avctx the codec context
4383 * @param[out] buf the output buffer
4384 * @param[in] buf_size the output buffer size
4385 * @param[in] samples the input buffer containing the samples
4386 * The number of samples read from this buffer is frame_size*channels,
4387 * both of which are defined in avctx.
4388 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4389 * samples read from samples is equal to:
4390 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4391 * This also implies that av_get_bits_per_sample() must not return 0 for these
4393 * @return On error a negative value is returned, on success zero or the number
4394 * of bytes used to encode the data read from the input buffer.
4396 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4397 uint8_t *buf, int buf_size,
4398 const short *samples);
4402 * Encode a frame of audio.
4404 * Takes input samples from frame and writes the next output packet, if
4405 * available, to avpkt. The output packet does not necessarily contain data for
4406 * the most recent frame, as encoders can delay, split, and combine input frames
4407 * internally as needed.
4409 * @param avctx codec context
4410 * @param avpkt output AVPacket.
4411 * The user can supply an output buffer by setting
4412 * avpkt->data and avpkt->size prior to calling the
4413 * function, but if the size of the user-provided data is not
4414 * large enough, encoding will fail. If avpkt->data and
4415 * avpkt->size are set, avpkt->destruct must also be set. All
4416 * other AVPacket fields will be reset by the encoder using
4417 * av_init_packet(). If avpkt->data is NULL, the encoder will
4418 * allocate it. The encoder will set avpkt->size to the size
4419 * of the output packet.
4421 * If this function fails or produces no output, avpkt will be
4422 * freed using av_free_packet() (i.e. avpkt->destruct will be
4423 * called to free the user supplied buffer).
4424 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4425 * May be NULL when flushing an encoder that has the
4426 * CODEC_CAP_DELAY capability set.
4427 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4428 * can have any number of samples.
4429 * If it is not set, frame->nb_samples must be equal to
4430 * avctx->frame_size for all frames except the last.
4431 * The final frame may be smaller than avctx->frame_size.
4432 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4433 * output packet is non-empty, and to 0 if it is
4434 * empty. If the function returns an error, the
4435 * packet can be assumed to be invalid, and the
4436 * value of got_packet_ptr is undefined and should
4438 * @return 0 on success, negative error code on failure
4440 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4441 const AVFrame *frame, int *got_packet_ptr);
4443 #if FF_API_OLD_ENCODE_VIDEO
4445 * @deprecated use avcodec_encode_video2() instead.
4447 * Encode a video frame from pict into buf.
4448 * The input picture should be
4449 * stored using a specific format, namely avctx.pix_fmt.
4451 * @param avctx the codec context
4452 * @param[out] buf the output buffer for the bitstream of encoded frame
4453 * @param[in] buf_size the size of the output buffer in bytes
4454 * @param[in] pict the input picture to encode
4455 * @return On error a negative value is returned, on success zero or the number
4456 * of bytes used from the output buffer.
4458 attribute_deprecated
4459 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4460 const AVFrame *pict);
4464 * Encode a frame of video.
4466 * Takes input raw video data from frame and writes the next output packet, if
4467 * available, to avpkt. The output packet does not necessarily contain data for
4468 * the most recent frame, as encoders can delay and reorder input frames
4469 * internally as needed.
4471 * @param avctx codec context
4472 * @param avpkt output AVPacket.
4473 * The user can supply an output buffer by setting
4474 * avpkt->data and avpkt->size prior to calling the
4475 * function, but if the size of the user-provided data is not
4476 * large enough, encoding will fail. All other AVPacket fields
4477 * will be reset by the encoder using av_init_packet(). If
4478 * avpkt->data is NULL, the encoder will allocate it.
4479 * The encoder will set avpkt->size to the size of the
4480 * output packet. The returned data (if any) belongs to the
4481 * caller, he is responsible for freeing it.
4483 * If this function fails or produces no output, avpkt will be
4484 * freed using av_free_packet() (i.e. avpkt->destruct will be
4485 * called to free the user supplied buffer).
4486 * @param[in] frame AVFrame containing the raw video data to be encoded.
4487 * May be NULL when flushing an encoder that has the
4488 * CODEC_CAP_DELAY capability set.
4489 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4490 * output packet is non-empty, and to 0 if it is
4491 * empty. If the function returns an error, the
4492 * packet can be assumed to be invalid, and the
4493 * value of got_packet_ptr is undefined and should
4495 * @return 0 on success, negative error code on failure
4497 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4498 const AVFrame *frame, int *got_packet_ptr);
4500 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4501 const AVSubtitle *sub);
4508 #if FF_API_AVCODEC_RESAMPLE
4510 * @defgroup lavc_resample Audio resampling
4512 * @deprecated use libswresample instead
4516 struct ReSampleContext;
4517 struct AVResampleContext;
4519 typedef struct ReSampleContext ReSampleContext;
4522 * Initialize audio resampling context.
4524 * @param output_channels number of output channels
4525 * @param input_channels number of input channels
4526 * @param output_rate output sample rate
4527 * @param input_rate input sample rate
4528 * @param sample_fmt_out requested output sample format
4529 * @param sample_fmt_in input sample format
4530 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4531 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4532 * @param linear if 1 then the used FIR filter will be linearly interpolated
4533 between the 2 closest, if 0 the closest will be used
4534 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4535 * @return allocated ReSampleContext, NULL if error occurred
4537 attribute_deprecated
4538 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4539 int output_rate, int input_rate,
4540 enum AVSampleFormat sample_fmt_out,
4541 enum AVSampleFormat sample_fmt_in,
4542 int filter_length, int log2_phase_count,
4543 int linear, double cutoff);
4545 attribute_deprecated
4546 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4549 * Free resample context.
4551 * @param s a non-NULL pointer to a resample context previously
4552 * created with av_audio_resample_init()
4554 attribute_deprecated
4555 void audio_resample_close(ReSampleContext *s);
4559 * Initialize an audio resampler.
4560 * Note, if either rate is not an integer then simply scale both rates up so they are.
4561 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4562 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4563 * @param linear If 1 then the used FIR filter will be linearly interpolated
4564 between the 2 closest, if 0 the closest will be used
4565 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4567 attribute_deprecated
4568 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4571 * Resample an array of samples using a previously configured context.
4572 * @param src an array of unconsumed samples
4573 * @param consumed the number of samples of src which have been consumed are returned here
4574 * @param src_size the number of unconsumed samples available
4575 * @param dst_size the amount of space in samples available in dst
4576 * @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.
4577 * @return the number of samples written in dst or -1 if an error occurred
4579 attribute_deprecated
4580 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4584 * Compensate samplerate/timestamp drift. The compensation is done by changing
4585 * the resampler parameters, so no audible clicks or similar distortions occur
4586 * @param compensation_distance distance in output samples over which the compensation should be performed
4587 * @param sample_delta number of output samples which should be output less
4589 * example: av_resample_compensate(c, 10, 500)
4590 * here instead of 510 samples only 500 samples would be output
4592 * note, due to rounding the actual compensation might be slightly different,
4593 * especially if the compensation_distance is large and the in_rate used during init is small
4595 attribute_deprecated
4596 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4597 attribute_deprecated
4598 void av_resample_close(struct AVResampleContext *c);
4606 * @addtogroup lavc_picture
4611 * Allocate memory for the pixels of a picture and setup the AVPicture
4614 * Call avpicture_free() to free it.
4616 * @param picture the picture structure to be filled in
4617 * @param pix_fmt the pixel format of the picture
4618 * @param width the width of the picture
4619 * @param height the height of the picture
4620 * @return zero if successful, a negative error code otherwise
4622 * @see av_image_alloc(), avpicture_fill()
4624 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4627 * Free a picture previously allocated by avpicture_alloc().
4628 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4631 * @param picture the AVPicture to be freed
4633 void avpicture_free(AVPicture *picture);
4636 * Setup the picture fields based on the specified image parameters
4637 * and the provided image data buffer.
4639 * The picture fields are filled in by using the image data buffer
4640 * pointed to by ptr.
4642 * If ptr is NULL, the function will fill only the picture linesize
4643 * array and return the required size for the image buffer.
4645 * To allocate an image buffer and fill the picture data in one call,
4646 * use avpicture_alloc().
4648 * @param picture the picture to be filled in
4649 * @param ptr buffer where the image data is stored, or NULL
4650 * @param pix_fmt the pixel format of the image
4651 * @param width the width of the image in pixels
4652 * @param height the height of the image in pixels
4653 * @return the size in bytes required for src, a negative error code
4654 * in case of failure
4656 * @see av_image_fill_arrays()
4658 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4659 enum AVPixelFormat pix_fmt, int width, int height);
4662 * Copy pixel data from an AVPicture into a buffer.
4664 * avpicture_get_size() can be used to compute the required size for
4665 * the buffer to fill.
4667 * @param src source picture with filled data
4668 * @param pix_fmt picture pixel format
4669 * @param width picture width
4670 * @param height picture height
4671 * @param dest destination buffer
4672 * @param dest_size destination buffer size in bytes
4673 * @return the number of bytes written to dest, or a negative value
4674 * (error code) on error, for example if the destination buffer is not
4677 * @see av_image_copy_to_buffer()
4679 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4680 int width, int height,
4681 unsigned char *dest, int dest_size);
4684 * Calculate the size in bytes that a picture of the given width and height
4685 * would occupy if stored in the given picture format.
4687 * @param pix_fmt picture pixel format
4688 * @param width picture width
4689 * @param height picture height
4690 * @return the computed picture buffer size or a negative error code
4693 * @see av_image_get_buffer_size().
4695 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4697 #if FF_API_DEINTERLACE
4699 * deinterlace - if not supported return -1
4701 * @deprecated - use yadif (in libavfilter) instead
4703 attribute_deprecated
4704 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4705 enum AVPixelFormat pix_fmt, int width, int height);
4708 * Copy image src to dst. Wraps av_image_copy().
4710 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4711 enum AVPixelFormat pix_fmt, int width, int height);
4714 * Crop image top and left side.
4716 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4717 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4722 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4723 int padtop, int padbottom, int padleft, int padright, int *color);
4730 * @defgroup lavc_misc Utility functions
4733 * Miscellaneous utility functions related to both encoding and decoding
4739 * @defgroup lavc_misc_pixfmt Pixel formats
4741 * Functions for working with pixel formats.
4746 * Utility function to access log2_chroma_w log2_chroma_h from
4747 * the pixel format AVPixFmtDescriptor.
4749 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4750 * for one that returns a failure code and continues in case of invalid
4753 * @param[in] pix_fmt the pixel format
4754 * @param[out] h_shift store log2_chroma_w
4755 * @param[out] v_shift store log2_chroma_h
4757 * @see av_pix_fmt_get_chroma_sub_sample
4760 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4763 * Return a value representing the fourCC code associated to the
4764 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4767 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4770 * @deprecated see av_get_pix_fmt_loss()
4772 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4776 * Find the best pixel format to convert to given a certain source pixel
4777 * format. When converting from one pixel format to another, information loss
4778 * may occur. For example, when converting from RGB24 to GRAY, the color
4779 * information will be lost. Similarly, other losses occur when converting from
4780 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4781 * the given pixel formats should be used to suffer the least amount of loss.
4782 * The pixel formats from which it chooses one, are determined by the
4783 * pix_fmt_list parameter.
4786 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4787 * @param[in] src_pix_fmt source pixel format
4788 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4789 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4790 * @return The best pixel format to convert to or -1 if none was found.
4792 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4793 enum AVPixelFormat src_pix_fmt,
4794 int has_alpha, int *loss_ptr);
4797 * @deprecated see av_find_best_pix_fmt_of_2()
4799 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4800 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4802 attribute_deprecated
4803 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
4804 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
4805 enum AVPixelFormat src_pix_fmt,
4806 int has_alpha, int *loss_ptr);
4808 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4809 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4813 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4819 #if FF_API_SET_DIMENSIONS
4821 * @deprecated this function is not supposed to be used from outside of lavc
4823 attribute_deprecated
4824 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4828 * Put a string representing the codec tag codec_tag in buf.
4830 * @param buf buffer to place codec tag in
4831 * @param buf_size size in bytes of buf
4832 * @param codec_tag codec tag to assign
4833 * @return the length of the string that would have been generated if
4834 * enough space had been available, excluding the trailing null
4836 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4838 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4841 * Return a name for the specified profile, if available.
4843 * @param codec the codec that is searched for the given profile
4844 * @param profile the profile value for which a name is requested
4845 * @return A name for the profile if found, NULL otherwise.
4847 const char *av_get_profile_name(const AVCodec *codec, int profile);
4849 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4850 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4851 //FIXME func typedef
4854 * Fill AVFrame audio data and linesize pointers.
4856 * The buffer buf must be a preallocated buffer with a size big enough
4857 * to contain the specified samples amount. The filled AVFrame data
4858 * pointers will point to this buffer.
4860 * AVFrame extended_data channel pointers are allocated if necessary for
4863 * @param frame the AVFrame
4864 * frame->nb_samples must be set prior to calling the
4865 * function. This function fills in frame->data,
4866 * frame->extended_data, frame->linesize[0].
4867 * @param nb_channels channel count
4868 * @param sample_fmt sample format
4869 * @param buf buffer to use for frame data
4870 * @param buf_size size of buffer
4871 * @param align plane size sample alignment (0 = default)
4872 * @return >=0 on success, negative error code on failure
4873 * @todo return the size in bytes required to store the samples in
4874 * case of success, at the next libavutil bump
4876 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4877 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4878 int buf_size, int align);
4881 * Reset the internal decoder state / flush internal buffers. Should be called
4882 * e.g. when seeking or when switching to a different stream.
4884 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4885 * this invalidates the frames previously returned from the decoder. When
4886 * refcounted frames are used, the decoder just releases any references it might
4887 * keep internally, but the caller's reference remains valid.
4889 void avcodec_flush_buffers(AVCodecContext *avctx);
4892 * Return codec bits per sample.
4894 * @param[in] codec_id the codec
4895 * @return Number of bits per sample or zero if unknown for the given codec.
4897 int av_get_bits_per_sample(enum AVCodecID codec_id);
4900 * Return the PCM codec associated with a sample format.
4901 * @param be endianness, 0 for little, 1 for big,
4902 * -1 (or anything else) for native
4903 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4905 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4908 * Return codec bits per sample.
4909 * Only return non-zero if the bits per sample is exactly correct, not an
4912 * @param[in] codec_id the codec
4913 * @return Number of bits per sample or zero if unknown for the given codec.
4915 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4918 * Return audio frame duration.
4920 * @param avctx codec context
4921 * @param frame_bytes size of the frame, or 0 if unknown
4922 * @return frame duration, in samples, if known. 0 if not able to
4925 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4928 typedef struct AVBitStreamFilterContext {
4930 struct AVBitStreamFilter *filter;
4931 AVCodecParserContext *parser;
4932 struct AVBitStreamFilterContext *next;
4933 } AVBitStreamFilterContext;
4936 typedef struct AVBitStreamFilter {
4939 int (*filter)(AVBitStreamFilterContext *bsfc,
4940 AVCodecContext *avctx, const char *args,
4941 uint8_t **poutbuf, int *poutbuf_size,
4942 const uint8_t *buf, int buf_size, int keyframe);
4943 void (*close)(AVBitStreamFilterContext *bsfc);
4944 struct AVBitStreamFilter *next;
4945 } AVBitStreamFilter;
4948 * Register a bitstream filter.
4950 * The filter will be accessible to the application code through
4951 * av_bitstream_filter_next() or can be directly initialized with
4952 * av_bitstream_filter_init().
4954 * @see avcodec_register_all()
4956 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4959 * Create and initialize a bitstream filter context given a bitstream
4962 * The returned context must be freed with av_bitstream_filter_close().
4964 * @param name the name of the bitstream filter
4965 * @return a bitstream filter context if a matching filter was found
4966 * and successfully initialized, NULL otherwise
4968 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4973 * This function filters the buffer buf with size buf_size, and places the
4974 * filtered buffer in the buffer pointed to by poutbuf.
4976 * The output buffer must be freed by the caller.
4978 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
4979 * @param avctx AVCodecContext accessed by the filter, may be NULL.
4980 * If specified, this must point to the encoder context of the
4981 * output stream the packet is sent to.
4982 * @param args arguments which specify the filter configuration, may be NULL
4983 * @param poutbuf pointer which is updated to point to the filtered buffer
4984 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
4985 * @param buf buffer containing the data to filter
4986 * @param buf_size size in bytes of buf
4987 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
4988 * @return >= 0 in case of success, or a negative error code in case of failure
4990 * If the return value is positive, an output buffer is allocated and
4991 * is availble in *poutbuf, and is distinct from the input buffer.
4993 * If the return value is 0, the output buffer is not allocated and
4994 * should be considered identical to the input buffer, or in case
4995 * *poutbuf was set it points to the input buffer (not necessarily to
4996 * its starting address).
4998 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4999 AVCodecContext *avctx, const char *args,
5000 uint8_t **poutbuf, int *poutbuf_size,
5001 const uint8_t *buf, int buf_size, int keyframe);
5004 * Release bitstream filter context.
5006 * @param bsf the bitstream filter context created with
5007 * av_bitstream_filter_init(), can be NULL
5009 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5012 * If f is NULL, return the first registered bitstream filter,
5013 * if f is non-NULL, return the next registered bitstream filter
5014 * after f, or NULL if f is the last one.
5016 * This function can be used to iterate over all registered bitstream
5019 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
5024 * Same behaviour av_fast_malloc but the buffer has additional
5025 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5027 * In addition the whole buffer will initially and after resizes
5028 * be 0-initialized so that no uninitialized data will ever appear.
5030 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5033 * Same behaviour av_fast_padded_malloc except that buffer will always
5034 * be 0-initialized after call.
5036 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5039 * Encode extradata length to a buffer. Used by xiph codecs.
5041 * @param s buffer to write to; must be at least (v/255+1) bytes long
5042 * @param v size of extradata in bytes
5043 * @return number of bytes written to the buffer.
5045 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5047 #if FF_API_MISSING_SAMPLE
5049 * Log a generic warning message about a missing feature. This function is
5050 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5051 * only, and would normally not be used by applications.
5052 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5053 * a pointer to an AVClass struct
5054 * @param[in] feature string containing the name of the missing feature
5055 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5056 * If want_sample is non-zero, additional verbage will be added to the log
5057 * message which tells the user how to report samples to the development
5059 * @deprecated Use avpriv_report_missing_feature() instead.
5061 attribute_deprecated
5062 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5065 * Log a generic warning message asking for a sample. This function is
5066 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5067 * only, and would normally not be used by applications.
5068 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5069 * a pointer to an AVClass struct
5070 * @param[in] msg string containing an optional message, or NULL if no message
5071 * @deprecated Use avpriv_request_sample() instead.
5073 attribute_deprecated
5074 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5075 #endif /* FF_API_MISSING_SAMPLE */
5078 * Register the hardware accelerator hwaccel.
5080 void av_register_hwaccel(AVHWAccel *hwaccel);
5083 * If hwaccel is NULL, returns the first registered hardware accelerator,
5084 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5085 * after hwaccel, or NULL if hwaccel is the last one.
5087 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
5091 * Lock operation used by lockmgr
5094 AV_LOCK_CREATE, ///< Create a mutex
5095 AV_LOCK_OBTAIN, ///< Lock the mutex
5096 AV_LOCK_RELEASE, ///< Unlock the mutex
5097 AV_LOCK_DESTROY, ///< Free mutex resources
5101 * Register a user provided lock manager supporting the operations
5102 * specified by AVLockOp. mutex points to a (void *) where the
5103 * lockmgr should store/get a pointer to a user allocated mutex. It's
5104 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
5106 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
5107 * callback during the call to av_lockmgr_register().
5108 * Thus, the application must be prepared to handle that.
5109 * If cb is set to NULL the lockmgr will be unregistered.
5110 * Also note that during unregistration the previously registered
5111 * lockmgr callback may also be invoked.
5113 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5116 * Get the type of the given codec.
5118 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5121 * Get the name of a codec.
5122 * @return a static string identifying the codec; never NULL
5124 const char *avcodec_get_name(enum AVCodecID id);
5127 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5128 * with no corresponding avcodec_close()), 0 otherwise.
5130 int avcodec_is_open(AVCodecContext *s);
5133 * @return a non-zero number if codec is an encoder, zero otherwise
5135 int av_codec_is_encoder(const AVCodec *codec);
5138 * @return a non-zero number if codec is a decoder, zero otherwise
5140 int av_codec_is_decoder(const AVCodec *codec);
5143 * @return descriptor for given codec ID or NULL if no descriptor exists.
5145 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5148 * Iterate over all codec descriptors known to libavcodec.
5150 * @param prev previous descriptor. NULL to get the first descriptor.
5152 * @return next descriptor or NULL after the last descriptor
5154 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5157 * @return codec descriptor with the given name or NULL if no such descriptor
5160 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5166 #endif /* AVCODEC_AVCODEC_H */