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"
46 * @defgroup libavc Encoding/Decoding Library
49 * @defgroup lavc_decoding Decoding
53 * @defgroup lavc_encoding Encoding
57 * @defgroup lavc_codec Codecs
59 * @defgroup lavc_codec_native Native Codecs
62 * @defgroup lavc_codec_wrappers External library wrappers
65 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
69 * @defgroup lavc_internal Internal
77 * @defgroup lavc_core Core functions/structures.
80 * Basic definitions, functions for querying libavcodec capabilities,
81 * allocating core structures, etc.
87 * Identify the syntax and semantics of the bitstream.
88 * The principle is roughly:
89 * Two decoders with the same ID can decode the same streams.
90 * Two encoders with the same ID can encode compatible streams.
91 * There may be slight deviations from the principle due to implementation
94 * If you add a codec ID to this list, add it so that
95 * 1. no value of a existing codec ID changes (that would break ABI),
96 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
97 * This ensures that 2 forks can independently add AVCodecIDs without producing conflicts.
99 * After adding new codec IDs, do not forget to add an entry to the codec
100 * descriptor list and bump libavcodec minor version.
106 AV_CODEC_ID_MPEG1VIDEO,
107 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
108 AV_CODEC_ID_MPEG2VIDEO_XVMC,
119 AV_CODEC_ID_RAWVIDEO,
120 AV_CODEC_ID_MSMPEG4V1,
121 AV_CODEC_ID_MSMPEG4V2,
122 AV_CODEC_ID_MSMPEG4V3,
145 AV_CODEC_ID_INTERPLAY_VIDEO,
152 AV_CODEC_ID_MSVIDEO1,
157 AV_CODEC_ID_TRUEMOTION1,
158 AV_CODEC_ID_VMDVIDEO,
183 AV_CODEC_ID_TRUEMOTION2,
189 AV_CODEC_ID_SMACKVIDEO,
194 AV_CODEC_ID_JPEG2000,
200 AV_CODEC_ID_DSICINVIDEO,
201 AV_CODEC_ID_TIERTEXSEQVIDEO,
209 AV_CODEC_ID_BETHSOFTVID,
221 AV_CODEC_ID_ESCAPE124,
225 AV_CODEC_ID_MOTIONPIXELS,
237 AV_CODEC_ID_FLASHSV2,
238 AV_CODEC_ID_CDGRAPHICS,
241 AV_CODEC_ID_BINKVIDEO,
242 AV_CODEC_ID_IFF_ILBM,
243 AV_CODEC_ID_IFF_BYTERUN1,
249 AV_CODEC_ID_A64_MULTI,
250 AV_CODEC_ID_A64_MULTI5,
253 AV_CODEC_ID_LAGARITH,
257 AV_CODEC_ID_WMV3IMAGE,
258 AV_CODEC_ID_VC1IMAGE,
260 AV_CODEC_ID_BMV_VIDEO,
267 AV_CODEC_ID_ZEROCODEC,
276 AV_CODEC_ID_ESCAPE130_DEPRECATED,
277 AV_CODEC_ID_G2M_DEPRECATED,
278 AV_CODEC_ID_WEBP_DEPRECATED,
279 AV_CODEC_ID_HNM4_VIDEO,
280 AV_CODEC_ID_HEVC_DEPRECATED,
282 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
283 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
284 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
285 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
286 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
288 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
289 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
290 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
291 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
292 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
293 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
294 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
295 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
296 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
297 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
298 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
299 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
300 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
301 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
302 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
303 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
304 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
305 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
306 AV_CODEC_ID_SMVJPEG = MKBETAG('S','M','V','J'),
307 AV_CODEC_ID_HEVC = MKBETAG('H','2','6','5'),
308 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
310 /* various PCM "codecs" */
311 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
312 AV_CODEC_ID_PCM_S16LE = 0x10000,
313 AV_CODEC_ID_PCM_S16BE,
314 AV_CODEC_ID_PCM_U16LE,
315 AV_CODEC_ID_PCM_U16BE,
318 AV_CODEC_ID_PCM_MULAW,
319 AV_CODEC_ID_PCM_ALAW,
320 AV_CODEC_ID_PCM_S32LE,
321 AV_CODEC_ID_PCM_S32BE,
322 AV_CODEC_ID_PCM_U32LE,
323 AV_CODEC_ID_PCM_U32BE,
324 AV_CODEC_ID_PCM_S24LE,
325 AV_CODEC_ID_PCM_S24BE,
326 AV_CODEC_ID_PCM_U24LE,
327 AV_CODEC_ID_PCM_U24BE,
328 AV_CODEC_ID_PCM_S24DAUD,
329 AV_CODEC_ID_PCM_ZORK,
330 AV_CODEC_ID_PCM_S16LE_PLANAR,
332 AV_CODEC_ID_PCM_F32BE,
333 AV_CODEC_ID_PCM_F32LE,
334 AV_CODEC_ID_PCM_F64BE,
335 AV_CODEC_ID_PCM_F64LE,
336 AV_CODEC_ID_PCM_BLURAY,
339 AV_CODEC_ID_PCM_S8_PLANAR,
340 AV_CODEC_ID_PCM_S24LE_PLANAR_DEPRECATED,
341 AV_CODEC_ID_PCM_S32LE_PLANAR_DEPRECATED,
342 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
343 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
344 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
346 /* various ADPCM codecs */
347 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
348 AV_CODEC_ID_ADPCM_IMA_WAV,
349 AV_CODEC_ID_ADPCM_IMA_DK3,
350 AV_CODEC_ID_ADPCM_IMA_DK4,
351 AV_CODEC_ID_ADPCM_IMA_WS,
352 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
353 AV_CODEC_ID_ADPCM_MS,
354 AV_CODEC_ID_ADPCM_4XM,
355 AV_CODEC_ID_ADPCM_XA,
356 AV_CODEC_ID_ADPCM_ADX,
357 AV_CODEC_ID_ADPCM_EA,
358 AV_CODEC_ID_ADPCM_G726,
359 AV_CODEC_ID_ADPCM_CT,
360 AV_CODEC_ID_ADPCM_SWF,
361 AV_CODEC_ID_ADPCM_YAMAHA,
362 AV_CODEC_ID_ADPCM_SBPRO_4,
363 AV_CODEC_ID_ADPCM_SBPRO_3,
364 AV_CODEC_ID_ADPCM_SBPRO_2,
365 AV_CODEC_ID_ADPCM_THP,
366 AV_CODEC_ID_ADPCM_IMA_AMV,
367 AV_CODEC_ID_ADPCM_EA_R1,
368 AV_CODEC_ID_ADPCM_EA_R3,
369 AV_CODEC_ID_ADPCM_EA_R2,
370 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
371 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
372 AV_CODEC_ID_ADPCM_EA_XAS,
373 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
374 AV_CODEC_ID_ADPCM_IMA_ISS,
375 AV_CODEC_ID_ADPCM_G722,
376 AV_CODEC_ID_ADPCM_IMA_APC,
377 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
378 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
379 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
380 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
381 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
382 AV_CODEC_ID_ADPCM_G726LE = MKBETAG('6','2','7','G'),
385 AV_CODEC_ID_AMR_NB = 0x12000,
388 /* RealAudio codecs*/
389 AV_CODEC_ID_RA_144 = 0x13000,
392 /* various DPCM codecs */
393 AV_CODEC_ID_ROQ_DPCM = 0x14000,
394 AV_CODEC_ID_INTERPLAY_DPCM,
395 AV_CODEC_ID_XAN_DPCM,
396 AV_CODEC_ID_SOL_DPCM,
399 AV_CODEC_ID_MP2 = 0x15000,
400 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
410 AV_CODEC_ID_VMDAUDIO,
416 AV_CODEC_ID_WESTWOOD_SND1,
417 AV_CODEC_ID_GSM, ///< as in Berlin toast format
420 AV_CODEC_ID_TRUESPEECH,
422 AV_CODEC_ID_SMACKAUDIO,
425 AV_CODEC_ID_DSICINAUDIO,
427 AV_CODEC_ID_MUSEPACK7,
429 AV_CODEC_ID_GSM_MS, /* as found in WAV */
435 AV_CODEC_ID_NELLYMOSER,
436 AV_CODEC_ID_MUSEPACK8,
438 AV_CODEC_ID_WMAVOICE,
440 AV_CODEC_ID_WMALOSSLESS,
449 AV_CODEC_ID_BINKAUDIO_RDFT,
450 AV_CODEC_ID_BINKAUDIO_DCT,
451 AV_CODEC_ID_AAC_LATM,
456 AV_CODEC_ID_8SVX_EXP,
457 AV_CODEC_ID_8SVX_FIB,
458 AV_CODEC_ID_BMV_AUDIO,
462 AV_CODEC_ID_OPUS_DEPRECATED,
463 AV_CODEC_ID_COMFORT_NOISE,
464 AV_CODEC_ID_TAK_DEPRECATED,
465 AV_CODEC_ID_METASOUND,
466 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
467 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
468 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
469 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
470 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
471 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
472 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
473 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
475 /* subtitle codecs */
476 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
477 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
478 AV_CODEC_ID_DVB_SUBTITLE,
479 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
482 AV_CODEC_ID_MOV_TEXT,
483 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
484 AV_CODEC_ID_DVB_TELETEXT,
486 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
487 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
488 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
489 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
490 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
491 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
492 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
493 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
494 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
495 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
496 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
497 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
498 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
500 /* other specific kind of codecs (generally used for attachments) */
501 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
502 AV_CODEC_ID_TTF = 0x18000,
503 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
504 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
505 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
506 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
507 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
508 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
511 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
513 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
514 * stream (only used by libavformat) */
515 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
516 * stream (only used by libavformat) */
517 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
520 #include "old_codec_ids.h"
525 * This struct describes the properties of a single codec described by an
527 * @see avcodec_get_descriptor()
529 typedef struct AVCodecDescriptor {
531 enum AVMediaType type;
533 * Name of the codec described by this descriptor. It is non-empty and
534 * unique for each codec descriptor. It should contain alphanumeric
535 * characters and '_' only.
539 * A more descriptive name for this codec. May be NULL.
541 const char *long_name;
543 * Codec properties, a combination of AV_CODEC_PROP_* flags.
549 * Codec uses only intra compression.
552 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
554 * Codec supports lossy compression. Audio and video codecs only.
555 * @note a codec may support both lossy and lossless
558 #define AV_CODEC_PROP_LOSSY (1 << 1)
560 * Codec supports lossless compression. Audio and video codecs only.
562 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
564 * Subtitle codec is bitmap based
565 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
567 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
569 * Subtitle codec is text based.
570 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
572 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
575 * @ingroup lavc_decoding
576 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
577 * This is mainly needed because some optimized bitstream readers read
578 * 32 or 64 bit at once and could read over the end.<br>
579 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
580 * MPEG bitstreams could cause overread and segfault.
582 #define FF_INPUT_BUFFER_PADDING_SIZE 16
585 * @ingroup lavc_encoding
586 * minimum encoding buffer size
587 * Used to avoid some checks during header writing.
589 #define FF_MIN_BUFFER_SIZE 16384
593 * @ingroup lavc_encoding
594 * motion estimation type.
597 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
601 ME_EPZS, ///< enhanced predictive zonal search
602 ME_X1, ///< reserved for experiments
603 ME_HEX, ///< hexagon based search
604 ME_UMH, ///< uneven multi-hexagon search
605 ME_TESA, ///< transformed exhaustive search algorithm
606 ME_ITER=50, ///< iterative search
610 * @ingroup lavc_decoding
613 /* We leave some space between them for extensions (drop some
614 * keyframes for intra-only or drop just some bidir frames). */
615 AVDISCARD_NONE =-16, ///< discard nothing
616 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
617 AVDISCARD_NONREF = 8, ///< discard all non reference
618 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
619 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
620 AVDISCARD_ALL = 48, ///< discard all
623 enum AVColorPrimaries{
624 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
625 AVCOL_PRI_UNSPECIFIED = 2,
626 AVCOL_PRI_BT470M = 4,
627 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
628 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
629 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
631 AVCOL_PRI_BT2020 = 9, ///< ITU-R BT2020
632 AVCOL_PRI_NB , ///< Not part of ABI
635 enum AVColorTransferCharacteristic{
636 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
637 AVCOL_TRC_UNSPECIFIED = 2,
638 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
639 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
640 AVCOL_TRC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 or 625 / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC
641 AVCOL_TRC_SMPTE240M = 7,
642 AVCOL_TRC_LINEAR = 8, ///< "Linear transfer characteristics"
643 AVCOL_TRC_LOG = 9, ///< "Logarithmic transfer characteristic (100:1 range)"
644 AVCOL_TRC_LOG_SQRT = 10, ///< "Logarithmic transfer characteristic (100 * Sqrt( 10 ) : 1 range)"
645 AVCOL_TRC_IEC61966_2_4 = 11, ///< IEC 61966-2-4
646 AVCOL_TRC_BT1361_ECG = 12, ///< ITU-R BT1361 Extended Colour Gamut
647 AVCOL_TRC_IEC61966_2_1 = 13, ///< IEC 61966-2-1 (sRGB or sYCC)
648 AVCOL_TRC_BT2020_10 = 14, ///< ITU-R BT2020 for 10 bit system
649 AVCOL_TRC_BT2020_12 = 15, ///< ITU-R BT2020 for 12 bit system
650 AVCOL_TRC_NB , ///< Not part of ABI
654 * X X 3 4 X X are luma samples,
655 * 1 2 1-6 are possible chroma positions
656 * X X 5 6 X 0 is undefined/unknown position
658 enum AVChromaLocation{
659 AVCHROMA_LOC_UNSPECIFIED = 0,
660 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
661 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
662 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
663 AVCHROMA_LOC_TOP = 4,
664 AVCHROMA_LOC_BOTTOMLEFT = 5,
665 AVCHROMA_LOC_BOTTOM = 6,
666 AVCHROMA_LOC_NB , ///< Not part of ABI
669 enum AVAudioServiceType {
670 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
671 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
672 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
673 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
674 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
675 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
676 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
677 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
678 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
679 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
683 * @ingroup lavc_encoding
685 typedef struct RcOverride{
688 int qscale; // If this is 0 then quality_factor will be used instead.
689 float quality_factor;
692 #define FF_MAX_B_FRAMES 16
695 These flags can be passed in AVCodecContext.flags before initialization.
696 Note: Not everything is supported yet.
700 * Allow decoders to produce frames with data planes that are not aligned
701 * to CPU requirements (e.g. due to cropping).
703 #define CODEC_FLAG_UNALIGNED 0x0001
704 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
705 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
706 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
707 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
708 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
709 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
711 * The parent program guarantees that the input for B-frames containing
712 * streams is not written to for at least s->max_b_frames+1 frames, if
713 * this is not set the input will be copied.
715 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
716 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
717 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
718 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
719 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
720 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
721 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
722 location instead of only at frame boundaries. */
723 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
724 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
725 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
726 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
727 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
728 /* Fx : Flag for h263+ extra options */
729 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
730 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
731 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
732 #define CODEC_FLAG_CLOSED_GOP 0x80000000
733 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
734 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
735 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
736 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
737 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
739 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
740 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
742 /* Unsupported options :
743 * Syntax Arithmetic coding (SAC)
744 * Reference Picture Selection
745 * Independent Segment Decoding */
747 /* codec capabilities */
749 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
751 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
752 * If not set, it might not use get_buffer() at all or use operations that
753 * assume the buffer was allocated by avcodec_default_get_buffer.
755 #define CODEC_CAP_DR1 0x0002
756 #define CODEC_CAP_TRUNCATED 0x0008
757 /* Codec can export data for HW decoding (XvMC). */
758 #define CODEC_CAP_HWACCEL 0x0010
760 * Encoder or decoder requires flushing with NULL input at the end in order to
761 * give the complete and correct output.
763 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
764 * with NULL data. The user can still send NULL data to the public encode
765 * or decode function, but libavcodec will not pass it along to the codec
766 * unless this flag is set.
769 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
770 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
774 * The encoder needs to be fed with NULL data at the end of encoding until the
775 * encoder no longer returns data.
777 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
778 * flag also means that the encoder must set the pts and duration for
779 * each output packet. If this flag is not set, the pts and duration will
780 * be determined by libavcodec from the input frame.
782 #define CODEC_CAP_DELAY 0x0020
784 * Codec can be fed a final frame with a smaller size.
785 * This can be used to prevent truncation of the last audio samples.
787 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
790 * Codec can export data for HW decoding (VDPAU).
792 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
795 * Codec can output multiple frames per AVPacket
796 * Normally demuxers return one frame at a time, demuxers which do not do
797 * are connected to a parser to split what they return into proper frames.
798 * This flag is reserved to the very rare category of codecs which have a
799 * bitstream that cannot be split into frames without timeconsuming
800 * operations like full decoding. Demuxers carring such bitstreams thus
801 * may return multiple frames in a packet. This has many disadvantages like
802 * prohibiting stream copy in many cases thus it should only be considered
805 #define CODEC_CAP_SUBFRAMES 0x0100
807 * Codec is experimental and is thus avoided in favor of non experimental
810 #define CODEC_CAP_EXPERIMENTAL 0x0200
812 * Codec should fill in channel configuration and samplerate instead of container
814 #define CODEC_CAP_CHANNEL_CONF 0x0400
817 * Codec is able to deal with negative linesizes
819 #define CODEC_CAP_NEG_LINESIZES 0x0800
822 * Codec supports frame-level multithreading.
824 #define CODEC_CAP_FRAME_THREADS 0x1000
826 * Codec supports slice-based (or partition-based) multithreading.
828 #define CODEC_CAP_SLICE_THREADS 0x2000
830 * Codec supports changed parameters at any point.
832 #define CODEC_CAP_PARAM_CHANGE 0x4000
834 * Codec supports avctx->thread_count == 0 (auto).
836 #define CODEC_CAP_AUTO_THREADS 0x8000
838 * Audio encoder supports receiving a different number of samples in each call.
840 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
842 * Codec is intra only.
844 #define CODEC_CAP_INTRA_ONLY 0x40000000
848 #define CODEC_CAP_LOSSLESS 0x80000000
850 //The following defines may change, don't expect compatibility if you use them.
851 #define MB_TYPE_INTRA4x4 0x0001
852 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
853 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
854 #define MB_TYPE_16x16 0x0008
855 #define MB_TYPE_16x8 0x0010
856 #define MB_TYPE_8x16 0x0020
857 #define MB_TYPE_8x8 0x0040
858 #define MB_TYPE_INTERLACED 0x0080
859 #define MB_TYPE_DIRECT2 0x0100 //FIXME
860 #define MB_TYPE_ACPRED 0x0200
861 #define MB_TYPE_GMC 0x0400
862 #define MB_TYPE_SKIP 0x0800
863 #define MB_TYPE_P0L0 0x1000
864 #define MB_TYPE_P1L0 0x2000
865 #define MB_TYPE_P0L1 0x4000
866 #define MB_TYPE_P1L1 0x8000
867 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
868 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
869 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
870 #define MB_TYPE_QUANT 0x00010000
871 #define MB_TYPE_CBP 0x00020000
872 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
876 * This specifies the area which should be displayed.
877 * Note there may be multiple such areas for one frame.
879 typedef struct AVPanScan{
882 * - encoding: Set by user.
883 * - decoding: Set by libavcodec.
888 * width and height in 1/16 pel
889 * - encoding: Set by user.
890 * - decoding: Set by libavcodec.
896 * position of the top left corner in 1/16 pel for up to 3 fields/frames
897 * - encoding: Set by user.
898 * - decoding: Set by libavcodec.
900 int16_t position[3][2];
903 #define FF_QSCALE_TYPE_MPEG1 0
904 #define FF_QSCALE_TYPE_MPEG2 1
905 #define FF_QSCALE_TYPE_H264 2
906 #define FF_QSCALE_TYPE_VP56 3
908 #if FF_API_GET_BUFFER
909 #define FF_BUFFER_TYPE_INTERNAL 1
910 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
911 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
912 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
914 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
915 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
916 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
917 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
921 * The decoder will keep a reference to the frame and may reuse it later.
923 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
926 * @defgroup lavc_packet AVPacket
928 * Types and functions for working with AVPacket.
931 enum AVPacketSideDataType {
933 AV_PKT_DATA_NEW_EXTRADATA,
936 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
939 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
940 * s32le channel_count
941 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
942 * u64le channel_layout
943 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
945 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
950 AV_PKT_DATA_PARAM_CHANGE,
953 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
954 * structures with info about macroblocks relevant to splitting the
955 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
956 * That is, it does not necessarily contain info about all macroblocks,
957 * as long as the distance between macroblocks in the info is smaller
958 * than the target payload size.
959 * Each MB info structure is 12 bytes, and is laid out as follows:
961 * u32le bit offset from the start of the packet
962 * u8 current quantizer at the start of the macroblock
964 * u16le macroblock address within the GOB
965 * u8 horizontal MV predictor
966 * u8 vertical MV predictor
967 * u8 horizontal MV predictor for block number 3
968 * u8 vertical MV predictor for block number 3
971 AV_PKT_DATA_H263_MB_INFO,
974 * Recommmends skipping the specified number of samples
976 * u32le number of samples to skip from start of this packet
977 * u32le number of samples to skip from end of this packet
978 * u8 reason for start skip
979 * u8 reason for end skip (0=padding silence, 1=convergence)
982 AV_PKT_DATA_SKIP_SAMPLES=70,
985 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
986 * the packet may contain "dual mono" audio specific to Japanese DTV
987 * and if it is true, recommends only the selected channel to be used.
989 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
992 AV_PKT_DATA_JP_DUALMONO,
995 * A list of zero terminated key/value strings. There is no end marker for
996 * the list, so it is required to rely on the side data size to stop.
998 AV_PKT_DATA_STRINGS_METADATA,
1001 * Subtitle event position
1009 AV_PKT_DATA_SUBTITLE_POSITION,
1012 * Data found in BlockAdditional element of matroska container. There is
1013 * no end marker for the data, so it is required to rely on the side data
1014 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1017 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1020 * The optional first identifier line of a WebVTT cue.
1022 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1025 * The optional settings (rendering instructions) that immediately
1026 * follow the timestamp specifier of a WebVTT cue.
1028 AV_PKT_DATA_WEBVTT_SETTINGS,
1032 * This structure stores compressed data. It is typically exported by demuxers
1033 * and then passed as input to decoders, or received as output from encoders and
1034 * then passed to muxers.
1036 * For video, it should typically contain one compressed frame. For audio it may
1037 * contain several compressed frames.
1039 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1040 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1041 * without libavcodec and libavformat major bump.
1043 * The semantics of data ownership depends on the buf or destruct (deprecated)
1044 * fields. If either is set, the packet data is dynamically allocated and is
1045 * valid indefinitely until av_free_packet() is called (which in turn calls
1046 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1047 * the packet data is typically backed by some static buffer somewhere and is
1048 * only valid for a limited time (e.g. until the next read call when demuxing).
1050 * The side data is always allocated with av_malloc() and is freed in
1053 typedef struct AVPacket {
1055 * A reference to the reference-counted buffer where the packet data is
1057 * May be NULL, then the packet data is not reference-counted.
1061 * Presentation timestamp in AVStream->time_base units; the time at which
1062 * the decompressed packet will be presented to the user.
1063 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1064 * pts MUST be larger or equal to dts as presentation cannot happen before
1065 * decompression, unless one wants to view hex dumps. Some formats misuse
1066 * the terms dts and pts/cts to mean something different. Such timestamps
1067 * must be converted to true pts/dts before they are stored in AVPacket.
1071 * Decompression timestamp in AVStream->time_base units; the time at which
1072 * the packet is decompressed.
1073 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1080 * A combination of AV_PKT_FLAG values
1084 * Additional packet data that can be provided by the container.
1085 * Packet can contain several types of side information.
1090 enum AVPacketSideDataType type;
1092 int side_data_elems;
1095 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1096 * Equals next_pts - this_pts in presentation order.
1099 #if FF_API_DESTRUCT_PACKET
1100 attribute_deprecated
1101 void (*destruct)(struct AVPacket *);
1102 attribute_deprecated
1105 int64_t pos; ///< byte position in stream, -1 if unknown
1108 * Time difference in AVStream->time_base units from the pts of this
1109 * packet to the point at which the output from the decoder has converged
1110 * independent from the availability of previous frames. That is, the
1111 * frames are virtually identical no matter if decoding started from
1112 * the very first frame or from this keyframe.
1113 * Is AV_NOPTS_VALUE if unknown.
1114 * This field is not the display duration of the current packet.
1115 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1118 * The purpose of this field is to allow seeking in streams that have no
1119 * keyframes in the conventional sense. It corresponds to the
1120 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1121 * essential for some types of subtitle streams to ensure that all
1122 * subtitles are correctly displayed after seeking.
1124 int64_t convergence_duration;
1126 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1127 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1129 enum AVSideDataParamChangeFlags {
1130 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1131 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1132 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1133 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1139 struct AVCodecInternal;
1143 AV_FIELD_PROGRESSIVE,
1144 AV_FIELD_TT, //< Top coded_first, top displayed first
1145 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1146 AV_FIELD_TB, //< Top coded first, bottom displayed first
1147 AV_FIELD_BT, //< Bottom coded first, top displayed first
1151 * main external API structure.
1152 * New fields can be added to the end with minor version bumps.
1153 * Removal, reordering and changes to existing fields require a major
1155 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1157 * sizeof(AVCodecContext) must not be used outside libav*.
1159 typedef struct AVCodecContext {
1161 * information on struct for av_log
1162 * - set by avcodec_alloc_context3
1164 const AVClass *av_class;
1165 int log_level_offset;
1167 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1168 const struct AVCodec *codec;
1169 char codec_name[32];
1170 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1173 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1174 * This is used to work around some encoder bugs.
1175 * A demuxer should set this to what is stored in the field used to identify the codec.
1176 * If there are multiple such fields in a container then the demuxer should choose the one
1177 * which maximizes the information about the used codec.
1178 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1179 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1180 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1182 * - encoding: Set by user, if not then the default based on codec_id will be used.
1183 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1185 unsigned int codec_tag;
1188 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1189 * This is used to work around some encoder bugs.
1190 * - encoding: unused
1191 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1193 unsigned int stream_codec_tag;
1198 * Private context used for internal data.
1200 * Unlike priv_data, this is not codec-specific. It is used in general
1201 * libavcodec functions.
1203 struct AVCodecInternal *internal;
1206 * Private data of the user, can be used to carry app specific stuff.
1207 * - encoding: Set by user.
1208 * - decoding: Set by user.
1213 * the average bitrate
1214 * - encoding: Set by user; unused for constant quantizer encoding.
1215 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1220 * number of bits the bitstream is allowed to diverge from the reference.
1221 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1222 * - encoding: Set by user; unused for constant quantizer encoding.
1223 * - decoding: unused
1225 int bit_rate_tolerance;
1228 * Global quality for codecs which cannot change it per frame.
1229 * This should be proportional to MPEG-1/2/4 qscale.
1230 * - encoding: Set by user.
1231 * - decoding: unused
1236 * - encoding: Set by user.
1237 * - decoding: unused
1239 int compression_level;
1240 #define FF_COMPRESSION_DEFAULT -1
1244 * - encoding: Set by user.
1245 * - decoding: Set by user.
1251 * - encoding: Set by user.
1252 * - decoding: Set by user.
1257 * some codecs need / can use extradata like Huffman tables.
1258 * mjpeg: Huffman tables
1259 * rv10: additional flags
1260 * mpeg4: global headers (they can be in the bitstream or here)
1261 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1262 * than extradata_size to avoid problems if it is read with the bitstream reader.
1263 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1264 * - encoding: Set/allocated/freed by libavcodec.
1265 * - decoding: Set/allocated/freed by user.
1271 * This is the fundamental unit of time (in seconds) in terms
1272 * of which frame timestamps are represented. For fixed-fps content,
1273 * timebase should be 1/framerate and timestamp increments should be
1275 * - encoding: MUST be set by user.
1276 * - decoding: Set by libavcodec.
1278 AVRational time_base;
1281 * For some codecs, the time base is closer to the field rate than the frame rate.
1282 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1283 * if no telecine is used ...
1285 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1287 int ticks_per_frame;
1292 * Encoding: Number of frames delay there will be from the encoder input to
1293 * the decoder output. (we assume the decoder matches the spec)
1294 * Decoding: Number of frames delay in addition to what a standard decoder
1295 * as specified in the spec would produce.
1298 * Number of frames the decoded output will be delayed relative to the
1302 * For encoding, this is the number of "priming" samples added to the
1303 * beginning of the stream. The decoded output will be delayed by this
1304 * many samples relative to the input to the encoder. Note that this
1305 * field is purely informational and does not directly affect the pts
1306 * output by the encoder, which should always be based on the actual
1307 * presentation time, including any delay.
1308 * For decoding, this is the number of samples the decoder needs to
1309 * output before the decoder's output is valid. When seeking, you should
1310 * start decoding this many samples prior to your desired seek point.
1312 * - encoding: Set by libavcodec.
1313 * - decoding: Set by libavcodec.
1320 * picture width / height.
1321 * - encoding: MUST be set by user.
1322 * - decoding: May be set by the user before opening the decoder if known e.g.
1323 * from the container. Some decoders will require the dimensions
1324 * to be set by the caller. During decoding, the decoder may
1325 * overwrite those values as required.
1330 * Bitstream width / height, may be different from width/height e.g. when
1331 * the decoded frame is cropped before being output or lowres is enabled.
1332 * - encoding: unused
1333 * - decoding: May be set by the user before opening the decoder if known
1334 * e.g. from the container. During decoding, the decoder may
1335 * overwrite those values as required.
1337 int coded_width, coded_height;
1339 #if FF_API_ASPECT_EXTENDED
1340 #define FF_ASPECT_EXTENDED 15
1344 * the number of pictures in a group of pictures, or 0 for intra_only
1345 * - encoding: Set by user.
1346 * - decoding: unused
1351 * Pixel format, see AV_PIX_FMT_xxx.
1352 * May be set by the demuxer if known from headers.
1353 * May be overridden by the decoder if it knows better.
1354 * - encoding: Set by user.
1355 * - decoding: Set by user if known, overridden by libavcodec if known
1357 enum AVPixelFormat pix_fmt;
1360 * Motion estimation algorithm used for video coding.
1361 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1362 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1363 * - encoding: MUST be set by user.
1364 * - decoding: unused
1369 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1370 * decoder to draw a horizontal band. It improves cache usage. Not
1371 * all codecs can do that. You must check the codec capabilities
1373 * When multithreading is used, it may be called from multiple threads
1374 * at the same time; threads might draw different parts of the same AVFrame,
1375 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1377 * The function is also used by hardware acceleration APIs.
1378 * It is called at least once during frame decoding to pass
1379 * the data needed for hardware render.
1380 * In that mode instead of pixel data, AVFrame points to
1381 * a structure specific to the acceleration API. The application
1382 * reads the structure and can change some fields to indicate progress
1384 * - encoding: unused
1385 * - decoding: Set by user.
1386 * @param height the height of the slice
1387 * @param y the y position of the slice
1388 * @param type 1->top field, 2->bottom field, 3->frame
1389 * @param offset offset into the AVFrame.data from which the slice should be read
1391 void (*draw_horiz_band)(struct AVCodecContext *s,
1392 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1393 int y, int type, int height);
1396 * callback to negotiate the pixelFormat
1397 * @param fmt is the list of formats which are supported by the codec,
1398 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1399 * The first is always the native one.
1400 * @return the chosen format
1401 * - encoding: unused
1402 * - decoding: Set by user, if not set the native format will be chosen.
1404 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1407 * maximum number of B-frames between non-B-frames
1408 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1409 * - encoding: Set by user.
1410 * - decoding: unused
1415 * qscale factor between IP and B-frames
1416 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1417 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1418 * - encoding: Set by user.
1419 * - decoding: unused
1421 float b_quant_factor;
1423 /** obsolete FIXME remove */
1425 #define FF_RC_STRATEGY_XVID 1
1427 int b_frame_strategy;
1430 * qscale offset between IP and B-frames
1431 * - encoding: Set by user.
1432 * - decoding: unused
1434 float b_quant_offset;
1437 * Size of the frame reordering buffer in the decoder.
1438 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1439 * - encoding: Set by libavcodec.
1440 * - decoding: Set by libavcodec.
1445 * 0-> h263 quant 1-> mpeg quant
1446 * - encoding: Set by user.
1447 * - decoding: unused
1452 * qscale factor between P and I-frames
1453 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1454 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1455 * - encoding: Set by user.
1456 * - decoding: unused
1458 float i_quant_factor;
1461 * qscale offset between P and I-frames
1462 * - encoding: Set by user.
1463 * - decoding: unused
1465 float i_quant_offset;
1468 * luminance masking (0-> disabled)
1469 * - encoding: Set by user.
1470 * - decoding: unused
1475 * temporary complexity masking (0-> disabled)
1476 * - encoding: Set by user.
1477 * - decoding: unused
1479 float temporal_cplx_masking;
1482 * spatial complexity masking (0-> disabled)
1483 * - encoding: Set by user.
1484 * - decoding: unused
1486 float spatial_cplx_masking;
1489 * p block masking (0-> disabled)
1490 * - encoding: Set by user.
1491 * - decoding: unused
1496 * darkness masking (0-> disabled)
1497 * - encoding: Set by user.
1498 * - decoding: unused
1504 * - encoding: Set by libavcodec.
1505 * - decoding: Set by user (or 0).
1509 * prediction method (needed for huffyuv)
1510 * - encoding: Set by user.
1511 * - decoding: unused
1513 int prediction_method;
1514 #define FF_PRED_LEFT 0
1515 #define FF_PRED_PLANE 1
1516 #define FF_PRED_MEDIAN 2
1519 * slice offsets in the frame in bytes
1520 * - encoding: Set/allocated by libavcodec.
1521 * - decoding: Set/allocated by user (or NULL).
1526 * sample aspect ratio (0 if unknown)
1527 * That is the width of a pixel divided by the height of the pixel.
1528 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1529 * - encoding: Set by user.
1530 * - decoding: Set by libavcodec.
1532 AVRational sample_aspect_ratio;
1535 * motion estimation comparison function
1536 * - encoding: Set by user.
1537 * - decoding: unused
1541 * subpixel motion estimation comparison function
1542 * - encoding: Set by user.
1543 * - decoding: unused
1547 * macroblock comparison function (not supported yet)
1548 * - encoding: Set by user.
1549 * - decoding: unused
1553 * interlaced DCT comparison function
1554 * - encoding: Set by user.
1555 * - decoding: unused
1558 #define FF_CMP_SAD 0
1559 #define FF_CMP_SSE 1
1560 #define FF_CMP_SATD 2
1561 #define FF_CMP_DCT 3
1562 #define FF_CMP_PSNR 4
1563 #define FF_CMP_BIT 5
1565 #define FF_CMP_ZERO 7
1566 #define FF_CMP_VSAD 8
1567 #define FF_CMP_VSSE 9
1568 #define FF_CMP_NSSE 10
1569 #define FF_CMP_W53 11
1570 #define FF_CMP_W97 12
1571 #define FF_CMP_DCTMAX 13
1572 #define FF_CMP_DCT264 14
1573 #define FF_CMP_CHROMA 256
1576 * ME diamond size & shape
1577 * - encoding: Set by user.
1578 * - decoding: unused
1583 * amount of previous MV predictors (2a+1 x 2a+1 square)
1584 * - encoding: Set by user.
1585 * - decoding: unused
1587 int last_predictor_count;
1590 * prepass for motion estimation
1591 * - encoding: Set by user.
1592 * - decoding: unused
1597 * motion estimation prepass comparison function
1598 * - encoding: Set by user.
1599 * - decoding: unused
1604 * ME prepass diamond size & shape
1605 * - encoding: Set by user.
1606 * - decoding: unused
1612 * - encoding: Set by user.
1613 * - decoding: unused
1615 int me_subpel_quality;
1618 * DTG active format information (additional aspect ratio
1619 * information only used in DVB MPEG-2 transport streams)
1622 * - encoding: unused
1623 * - decoding: Set by decoder.
1625 int dtg_active_format;
1626 #define FF_DTG_AFD_SAME 8
1627 #define FF_DTG_AFD_4_3 9
1628 #define FF_DTG_AFD_16_9 10
1629 #define FF_DTG_AFD_14_9 11
1630 #define FF_DTG_AFD_4_3_SP_14_9 13
1631 #define FF_DTG_AFD_16_9_SP_14_9 14
1632 #define FF_DTG_AFD_SP_4_3 15
1635 * maximum motion estimation search range in subpel units
1636 * If 0 then no limit.
1638 * - encoding: Set by user.
1639 * - decoding: unused
1644 * intra quantizer bias
1645 * - encoding: Set by user.
1646 * - decoding: unused
1648 int intra_quant_bias;
1649 #define FF_DEFAULT_QUANT_BIAS 999999
1652 * inter quantizer bias
1653 * - encoding: Set by user.
1654 * - decoding: unused
1656 int inter_quant_bias;
1660 * - encoding: unused
1661 * - decoding: Set by user.
1664 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1665 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1666 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1669 * XVideo Motion Acceleration
1670 * - encoding: forbidden
1671 * - decoding: set by decoder
1673 int xvmc_acceleration;
1676 * macroblock decision mode
1677 * - encoding: Set by user.
1678 * - decoding: unused
1681 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1682 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1683 #define FF_MB_DECISION_RD 2 ///< rate distortion
1686 * custom intra quantization matrix
1687 * - encoding: Set by user, can be NULL.
1688 * - decoding: Set by libavcodec.
1690 uint16_t *intra_matrix;
1693 * custom inter quantization matrix
1694 * - encoding: Set by user, can be NULL.
1695 * - decoding: Set by libavcodec.
1697 uint16_t *inter_matrix;
1700 * scene change detection threshold
1701 * 0 is default, larger means fewer detected scene changes.
1702 * - encoding: Set by user.
1703 * - decoding: unused
1705 int scenechange_threshold;
1708 * noise reduction strength
1709 * - encoding: Set by user.
1710 * - decoding: unused
1712 int noise_reduction;
1715 * Motion estimation threshold below which no motion estimation is
1716 * performed, but instead the user specified motion vectors are used.
1718 * - encoding: Set by user.
1719 * - decoding: unused
1724 * Macroblock threshold below which the user specified macroblock types will be used.
1725 * - encoding: Set by user.
1726 * - decoding: unused
1731 * precision of the intra DC coefficient - 8
1732 * - encoding: Set by user.
1733 * - decoding: unused
1735 int intra_dc_precision;
1738 * Number of macroblock rows at the top which are skipped.
1739 * - encoding: unused
1740 * - decoding: Set by user.
1745 * Number of macroblock rows at the bottom which are skipped.
1746 * - encoding: unused
1747 * - decoding: Set by user.
1752 * Border processing masking, raises the quantizer for mbs on the borders
1754 * - encoding: Set by user.
1755 * - decoding: unused
1757 float border_masking;
1760 * minimum MB lagrange multipler
1761 * - encoding: Set by user.
1762 * - decoding: unused
1767 * maximum MB lagrange multipler
1768 * - encoding: Set by user.
1769 * - decoding: unused
1775 * - encoding: Set by user.
1776 * - decoding: unused
1778 int me_penalty_compensation;
1782 * - encoding: Set by user.
1783 * - decoding: unused
1789 * - encoding: Set by user.
1790 * - decoding: unused
1796 * - encoding: Set by user.
1797 * - decoding: unused
1802 * number of reference frames
1803 * - encoding: Set by user.
1804 * - decoding: Set by lavc.
1809 * chroma qp offset from luma
1810 * - encoding: Set by user.
1811 * - decoding: unused
1816 * Multiplied by qscale for each frame and added to scene_change_score.
1817 * - encoding: Set by user.
1818 * - decoding: unused
1820 int scenechange_factor;
1824 * Note: Value depends upon the compare function used for fullpel ME.
1825 * - encoding: Set by user.
1826 * - decoding: unused
1831 * Adjust sensitivity of b_frame_strategy 1.
1832 * - encoding: Set by user.
1833 * - decoding: unused
1838 * Chromaticity coordinates of the source primaries.
1839 * - encoding: Set by user
1840 * - decoding: Set by libavcodec
1842 enum AVColorPrimaries color_primaries;
1845 * Color Transfer Characteristic.
1846 * - encoding: Set by user
1847 * - decoding: Set by libavcodec
1849 enum AVColorTransferCharacteristic color_trc;
1852 * YUV colorspace type.
1853 * - encoding: Set by user
1854 * - decoding: Set by libavcodec
1856 enum AVColorSpace colorspace;
1859 * MPEG vs JPEG YUV range.
1860 * - encoding: Set by user
1861 * - decoding: Set by libavcodec
1863 enum AVColorRange color_range;
1866 * This defines the location of chroma samples.
1867 * - encoding: Set by user
1868 * - decoding: Set by libavcodec
1870 enum AVChromaLocation chroma_sample_location;
1874 * Indicates number of picture subdivisions. Used for parallelized
1876 * - encoding: Set by user
1877 * - decoding: unused
1882 * - encoding: set by libavcodec
1883 * - decoding: Set by user.
1885 enum AVFieldOrder field_order;
1888 int sample_rate; ///< samples per second
1889 int channels; ///< number of audio channels
1892 * audio sample format
1893 * - encoding: Set by user.
1894 * - decoding: Set by libavcodec.
1896 enum AVSampleFormat sample_fmt; ///< sample format
1898 /* The following data should not be initialized. */
1900 * Number of samples per channel in an audio frame.
1902 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1903 * except the last must contain exactly frame_size samples per channel.
1904 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1905 * frame size is not restricted.
1906 * - decoding: may be set by some decoders to indicate constant frame size
1911 * Frame counter, set by libavcodec.
1913 * - decoding: total number of frames returned from the decoder so far.
1914 * - encoding: total number of frames passed to the encoder so far.
1916 * @note the counter is not incremented if encoding/decoding resulted in
1922 * number of bytes per packet if constant and known or 0
1923 * Used by some WAV based audio codecs.
1928 * Audio cutoff bandwidth (0 means "automatic")
1929 * - encoding: Set by user.
1930 * - decoding: unused
1934 #if FF_API_REQUEST_CHANNELS
1936 * Decoder should decode to this many channels if it can (0 for default)
1937 * - encoding: unused
1938 * - decoding: Set by user.
1939 * @deprecated Deprecated in favor of request_channel_layout.
1941 attribute_deprecated int request_channels;
1945 * Audio channel layout.
1946 * - encoding: set by user.
1947 * - decoding: set by user, may be overwritten by libavcodec.
1949 uint64_t channel_layout;
1952 * Request decoder to use this channel layout if it can (0 for default)
1953 * - encoding: unused
1954 * - decoding: Set by user.
1956 uint64_t request_channel_layout;
1959 * Type of service that the audio stream conveys.
1960 * - encoding: Set by user.
1961 * - decoding: Set by libavcodec.
1963 enum AVAudioServiceType audio_service_type;
1966 * desired sample format
1967 * - encoding: Not used.
1968 * - decoding: Set by user.
1969 * Decoder will decode to this format if it can.
1971 enum AVSampleFormat request_sample_fmt;
1973 #if FF_API_GET_BUFFER
1975 * Called at the beginning of each frame to get a buffer for it.
1977 * The function will set AVFrame.data[], AVFrame.linesize[].
1978 * AVFrame.extended_data[] must also be set, but it should be the same as
1979 * AVFrame.data[] except for planar audio with more channels than can fit
1980 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1981 * many data pointers as it can hold.
1983 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1984 * avcodec_default_get_buffer() instead of providing buffers allocated by
1987 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1988 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1989 * but if get_buffer() is overridden then alignment considerations should
1990 * be taken into account.
1992 * @see avcodec_default_get_buffer()
1996 * If pic.reference is set then the frame will be read later by libavcodec.
1997 * avcodec_align_dimensions2() should be used to find the required width and
1998 * height, as they normally need to be rounded up to the next multiple of 16.
2000 * If frame multithreading is used and thread_safe_callbacks is set,
2001 * it may be called from a different thread, but not from more than one at
2002 * once. Does not need to be reentrant.
2004 * @see release_buffer(), reget_buffer()
2005 * @see avcodec_align_dimensions2()
2009 * Decoders request a buffer of a particular size by setting
2010 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2011 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2012 * to a smaller value in the output frame.
2014 * Decoders cannot use the buffer after returning from
2015 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2016 * is assumed to be released immediately upon return. In some rare cases,
2017 * a decoder may need to call get_buffer() more than once in a single
2018 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2019 * called again after it has already been called once, the previously
2020 * acquired buffer is assumed to be released at that time and may not be
2021 * reused by the decoder.
2023 * As a convenience, av_samples_get_buffer_size() and
2024 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2025 * functions to find the required data size and to fill data pointers and
2026 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2027 * since all planes must be the same size.
2029 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2031 * - encoding: unused
2032 * - decoding: Set by libavcodec, user can override.
2034 * @deprecated use get_buffer2()
2036 attribute_deprecated
2037 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2040 * Called to release buffers which were allocated with get_buffer.
2041 * A released buffer can be reused in get_buffer().
2042 * pic.data[*] must be set to NULL.
2043 * May be called from a different thread if frame multithreading is used,
2044 * but not by more than one thread at once, so does not need to be reentrant.
2045 * - encoding: unused
2046 * - decoding: Set by libavcodec, user can override.
2048 * @deprecated custom freeing callbacks should be set from get_buffer2()
2050 attribute_deprecated
2051 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2054 * Called at the beginning of a frame to get cr buffer for it.
2055 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2056 * libavcodec will pass previous buffer in pic, function should return
2057 * same buffer or new buffer with old frame "painted" into it.
2058 * If pic.data[0] == NULL must behave like get_buffer().
2059 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2060 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2062 * - encoding: unused
2063 * - decoding: Set by libavcodec, user can override.
2065 attribute_deprecated
2066 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2070 * This callback is called at the beginning of each frame to get data
2071 * buffer(s) for it. There may be one contiguous buffer for all the data or
2072 * there may be a buffer per each data plane or anything in between. What
2073 * this means is, you may set however many entries in buf[] you feel necessary.
2074 * Each buffer must be reference-counted using the AVBuffer API (see description
2077 * The following fields will be set in the frame before this callback is
2080 * - width, height (video only)
2081 * - sample_rate, channel_layout, nb_samples (audio only)
2082 * Their values may differ from the corresponding values in
2083 * AVCodecContext. This callback must use the frame values, not the codec
2084 * context values, to calculate the required buffer size.
2086 * This callback must fill the following fields in the frame:
2090 * * if the data is planar audio with more than 8 channels, then this
2091 * callback must allocate and fill extended_data to contain all pointers
2092 * to all data planes. data[] must hold as many pointers as it can.
2093 * extended_data must be allocated with av_malloc() and will be freed in
2095 * * otherwise exended_data must point to data
2096 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2097 * the frame's data and extended_data pointers must be contained in these. That
2098 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2099 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2100 * and av_buffer_ref().
2101 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2102 * this callback and filled with the extra buffers if there are more
2103 * buffers than buf[] can hold. extended_buf will be freed in
2106 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2107 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2110 * Each data plane must be aligned to the maximum required by the target
2113 * @see avcodec_default_get_buffer2()
2117 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2118 * (read and/or written to if it is writable) later by libavcodec.
2120 * If CODEC_FLAG_EMU_EDGE is not set in s->flags, the buffer must contain an
2121 * edge of the size returned by avcodec_get_edge_width() on all sides.
2123 * avcodec_align_dimensions2() should be used to find the required width and
2124 * height, as they normally need to be rounded up to the next multiple of 16.
2126 * If frame multithreading is used and thread_safe_callbacks is set,
2127 * this callback may be called from a different thread, but not from more
2128 * than one at once. Does not need to be reentrant.
2130 * @see avcodec_align_dimensions2()
2134 * Decoders request a buffer of a particular size by setting
2135 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2136 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2137 * to a smaller value in the output frame.
2139 * As a convenience, av_samples_get_buffer_size() and
2140 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2141 * functions to find the required data size and to fill data pointers and
2142 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2143 * since all planes must be the same size.
2145 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2147 * - encoding: unused
2148 * - decoding: Set by libavcodec, user can override.
2150 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2153 * If non-zero, the decoded audio and video frames returned from
2154 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2155 * and are valid indefinitely. The caller must free them with
2156 * av_frame_unref() when they are not needed anymore.
2157 * Otherwise, the decoded frames must not be freed by the caller and are
2158 * only valid until the next decode call.
2160 * - encoding: unused
2161 * - decoding: set by the caller before avcodec_open2().
2163 int refcounted_frames;
2165 /* - encoding parameters */
2166 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2167 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2171 * - encoding: Set by user.
2172 * - decoding: unused
2178 * - encoding: Set by user.
2179 * - decoding: unused
2184 * maximum quantizer difference between frames
2185 * - encoding: Set by user.
2186 * - decoding: unused
2191 * ratecontrol qmin qmax limiting method
2192 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2193 * - encoding: Set by user.
2194 * - decoding: unused
2202 * decoder bitstream buffer size
2203 * - encoding: Set by user.
2204 * - decoding: unused
2209 * ratecontrol override, see RcOverride
2210 * - encoding: Allocated/set/freed by user.
2211 * - decoding: unused
2213 int rc_override_count;
2214 RcOverride *rc_override;
2217 * rate control equation
2218 * - encoding: Set by user
2219 * - decoding: unused
2225 * - encoding: Set by user.
2226 * - decoding: unused
2232 * - encoding: Set by user.
2233 * - decoding: unused
2237 float rc_buffer_aggressivity;
2240 * initial complexity for pass1 ratecontrol
2241 * - encoding: Set by user.
2242 * - decoding: unused
2244 float rc_initial_cplx;
2247 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2248 * - encoding: Set by user.
2249 * - decoding: unused.
2251 float rc_max_available_vbv_use;
2254 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2255 * - encoding: Set by user.
2256 * - decoding: unused.
2258 float rc_min_vbv_overflow_use;
2261 * Number of bits which should be loaded into the rc buffer before decoding starts.
2262 * - encoding: Set by user.
2263 * - decoding: unused
2265 int rc_initial_buffer_occupancy;
2267 #define FF_CODER_TYPE_VLC 0
2268 #define FF_CODER_TYPE_AC 1
2269 #define FF_CODER_TYPE_RAW 2
2270 #define FF_CODER_TYPE_RLE 3
2271 #define FF_CODER_TYPE_DEFLATE 4
2274 * - encoding: Set by user.
2275 * - decoding: unused
2281 * - encoding: Set by user.
2282 * - decoding: unused
2287 * minimum Lagrange multipler
2288 * - encoding: Set by user.
2289 * - decoding: unused
2294 * maximum Lagrange multipler
2295 * - encoding: Set by user.
2296 * - decoding: unused
2301 * frame skip threshold
2302 * - encoding: Set by user.
2303 * - decoding: unused
2305 int frame_skip_threshold;
2309 * - encoding: Set by user.
2310 * - decoding: unused
2312 int frame_skip_factor;
2315 * frame skip exponent
2316 * - encoding: Set by user.
2317 * - decoding: unused
2322 * frame skip comparison function
2323 * - encoding: Set by user.
2324 * - decoding: unused
2329 * trellis RD quantization
2330 * - encoding: Set by user.
2331 * - decoding: unused
2336 * - encoding: Set by user.
2337 * - decoding: unused
2339 int min_prediction_order;
2342 * - encoding: Set by user.
2343 * - decoding: unused
2345 int max_prediction_order;
2348 * GOP timecode frame start number
2349 * - encoding: Set by user, in non drop frame format
2350 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2352 int64_t timecode_frame_start;
2354 /* The RTP callback: This function is called */
2355 /* every time the encoder has a packet to send. */
2356 /* It depends on the encoder if the data starts */
2357 /* with a Start Code (it should). H.263 does. */
2358 /* mb_nb contains the number of macroblocks */
2359 /* encoded in the RTP payload. */
2360 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2362 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2363 /* do its best to deliver a chunk with size */
2364 /* below rtp_payload_size, the chunk will start */
2365 /* with a start code on some codecs like H.263. */
2366 /* This doesn't take account of any particular */
2367 /* headers inside the transmitted RTP payload. */
2369 /* statistics, used for 2-pass encoding */
2380 * number of bits used for the previously encoded frame
2381 * - encoding: Set by libavcodec.
2382 * - decoding: unused
2387 * pass1 encoding statistics output buffer
2388 * - encoding: Set by libavcodec.
2389 * - decoding: unused
2394 * pass2 encoding statistics input buffer
2395 * Concatenated stuff from stats_out of pass1 should be placed here.
2396 * - encoding: Allocated/set/freed by user.
2397 * - decoding: unused
2402 * Work around bugs in encoders which sometimes cannot be detected automatically.
2403 * - encoding: Set by user
2404 * - decoding: Set by user
2406 int workaround_bugs;
2407 #define FF_BUG_AUTODETECT 1 ///< autodetection
2408 #if FF_API_OLD_MSMPEG4
2409 #define FF_BUG_OLD_MSMPEG4 2
2411 #define FF_BUG_XVID_ILACE 4
2412 #define FF_BUG_UMP4 8
2413 #define FF_BUG_NO_PADDING 16
2414 #define FF_BUG_AMV 32
2416 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2418 #define FF_BUG_QPEL_CHROMA 64
2419 #define FF_BUG_STD_QPEL 128
2420 #define FF_BUG_QPEL_CHROMA2 256
2421 #define FF_BUG_DIRECT_BLOCKSIZE 512
2422 #define FF_BUG_EDGE 1024
2423 #define FF_BUG_HPEL_CHROMA 2048
2424 #define FF_BUG_DC_CLIP 4096
2425 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2426 #define FF_BUG_TRUNCATED 16384
2429 * strictly follow the standard (MPEG4, ...).
2430 * - encoding: Set by user.
2431 * - decoding: Set by user.
2432 * Setting this to STRICT or higher means the encoder and decoder will
2433 * generally do stupid things, whereas setting it to unofficial or lower
2434 * will mean the encoder might produce output that is not supported by all
2435 * spec-compliant decoders. Decoders don't differentiate between normal,
2436 * unofficial and experimental (that is, they always try to decode things
2437 * when they can) unless they are explicitly asked to behave stupidly
2438 * (=strictly conform to the specs)
2440 int strict_std_compliance;
2441 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2442 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2443 #define FF_COMPLIANCE_NORMAL 0
2444 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2445 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2448 * error concealment flags
2449 * - encoding: unused
2450 * - decoding: Set by user.
2452 int error_concealment;
2453 #define FF_EC_GUESS_MVS 1
2454 #define FF_EC_DEBLOCK 2
2458 * - encoding: Set by user.
2459 * - decoding: Set by user.
2462 #define FF_DEBUG_PICT_INFO 1
2463 #define FF_DEBUG_RC 2
2464 #define FF_DEBUG_BITSTREAM 4
2465 #define FF_DEBUG_MB_TYPE 8
2466 #define FF_DEBUG_QP 16
2469 * @deprecated this option does nothing
2471 #define FF_DEBUG_MV 32
2473 #define FF_DEBUG_DCT_COEFF 0x00000040
2474 #define FF_DEBUG_SKIP 0x00000080
2475 #define FF_DEBUG_STARTCODE 0x00000100
2476 #define FF_DEBUG_PTS 0x00000200
2477 #define FF_DEBUG_ER 0x00000400
2478 #define FF_DEBUG_MMCO 0x00000800
2479 #define FF_DEBUG_BUGS 0x00001000
2481 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2482 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2484 #define FF_DEBUG_BUFFERS 0x00008000
2485 #define FF_DEBUG_THREADS 0x00010000
2490 * Code outside libavcodec should access this field using AVOptions
2491 * - encoding: Set by user.
2492 * - decoding: Set by user.
2495 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2496 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2497 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2501 * Error recognition; may misdetect some more or less valid parts as errors.
2502 * - encoding: unused
2503 * - decoding: Set by user.
2505 int err_recognition;
2508 * Verify checksums embedded in the bitstream (could be of either encoded or
2509 * decoded data, depending on the codec) and print an error message on mismatch.
2510 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2511 * decoder returning an error.
2513 #define AV_EF_CRCCHECK (1<<0)
2514 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2515 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2516 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2518 #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
2519 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliancies as errors
2520 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2524 * opaque 64bit number (generally a PTS) that will be reordered and
2525 * output in AVFrame.reordered_opaque
2526 * @deprecated in favor of pkt_pts
2527 * - encoding: unused
2528 * - decoding: Set by user.
2530 int64_t reordered_opaque;
2533 * Hardware accelerator in use
2534 * - encoding: unused.
2535 * - decoding: Set by libavcodec
2537 struct AVHWAccel *hwaccel;
2540 * Hardware accelerator context.
2541 * For some hardware accelerators, a global context needs to be
2542 * provided by the user. In that case, this holds display-dependent
2543 * data FFmpeg cannot instantiate itself. Please refer to the
2544 * FFmpeg HW accelerator documentation to know how to fill this
2545 * is. e.g. for VA API, this is a struct vaapi_context.
2546 * - encoding: unused
2547 * - decoding: Set by user
2549 void *hwaccel_context;
2553 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2554 * - decoding: unused
2556 uint64_t error[AV_NUM_DATA_POINTERS];
2559 * DCT algorithm, see FF_DCT_* below
2560 * - encoding: Set by user.
2561 * - decoding: unused
2564 #define FF_DCT_AUTO 0
2565 #define FF_DCT_FASTINT 1
2566 #define FF_DCT_INT 2
2567 #define FF_DCT_MMX 3
2568 #define FF_DCT_ALTIVEC 5
2569 #define FF_DCT_FAAN 6
2572 * IDCT algorithm, see FF_IDCT_* below.
2573 * - encoding: Set by user.
2574 * - decoding: Set by user.
2577 #define FF_IDCT_AUTO 0
2578 #define FF_IDCT_INT 1
2579 #define FF_IDCT_SIMPLE 2
2580 #define FF_IDCT_SIMPLEMMX 3
2581 #define FF_IDCT_ARM 7
2582 #define FF_IDCT_ALTIVEC 8
2583 #define FF_IDCT_SH4 9
2584 #define FF_IDCT_SIMPLEARM 10
2585 #define FF_IDCT_IPP 13
2586 #define FF_IDCT_XVIDMMX 14
2587 #define FF_IDCT_SIMPLEARMV5TE 16
2588 #define FF_IDCT_SIMPLEARMV6 17
2589 #define FF_IDCT_SIMPLEVIS 18
2590 #define FF_IDCT_FAAN 20
2591 #define FF_IDCT_SIMPLENEON 22
2592 #define FF_IDCT_SIMPLEALPHA 23
2595 * bits per sample/pixel from the demuxer (needed for huffyuv).
2596 * - encoding: Set by libavcodec.
2597 * - decoding: Set by user.
2599 int bits_per_coded_sample;
2602 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2603 * - encoding: set by user.
2604 * - decoding: set by libavcodec.
2606 int bits_per_raw_sample;
2610 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2611 * - encoding: unused
2612 * - decoding: Set by user.
2613 * Code outside libavcodec should access this field using:
2614 * av_codec_{get,set}_lowres(avctx)
2620 * the picture in the bitstream
2621 * - encoding: Set by libavcodec.
2622 * - decoding: Set by libavcodec.
2624 AVFrame *coded_frame;
2628 * is used to decide how many independent tasks should be passed to execute()
2629 * - encoding: Set by user.
2630 * - decoding: Set by user.
2635 * Which multithreading methods to use.
2636 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2637 * so clients which cannot provide future frames should not use it.
2639 * - encoding: Set by user, otherwise the default is used.
2640 * - decoding: Set by user, otherwise the default is used.
2643 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2644 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2647 * Which multithreading methods are in use by the codec.
2648 * - encoding: Set by libavcodec.
2649 * - decoding: Set by libavcodec.
2651 int active_thread_type;
2654 * Set by the client if its custom get_buffer() callback can be called
2655 * synchronously from another thread, which allows faster multithreaded decoding.
2656 * draw_horiz_band() will be called from other threads regardless of this setting.
2657 * Ignored if the default get_buffer() is used.
2658 * - encoding: Set by user.
2659 * - decoding: Set by user.
2661 int thread_safe_callbacks;
2664 * The codec may call this to execute several independent things.
2665 * It will return only after finishing all tasks.
2666 * The user may replace this with some multithreaded implementation,
2667 * the default implementation will execute the parts serially.
2668 * @param count the number of things to execute
2669 * - encoding: Set by libavcodec, user can override.
2670 * - decoding: Set by libavcodec, user can override.
2672 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2675 * The codec may call this to execute several independent things.
2676 * It will return only after finishing all tasks.
2677 * The user may replace this with some multithreaded implementation,
2678 * the default implementation will execute the parts serially.
2679 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2680 * @param c context passed also to func
2681 * @param count the number of things to execute
2682 * @param arg2 argument passed unchanged to func
2683 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2684 * @param func function that will be called count times, with jobnr from 0 to count-1.
2685 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2686 * two instances of func executing at the same time will have the same threadnr.
2687 * @return always 0 currently, but code should handle a future improvement where when any call to func
2688 * returns < 0 no further calls to func may be done and < 0 is returned.
2689 * - encoding: Set by libavcodec, user can override.
2690 * - decoding: Set by libavcodec, user can override.
2692 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2694 #if FF_API_THREAD_OPAQUE
2696 * @deprecated this field should not be used from outside of lavc
2698 attribute_deprecated
2699 void *thread_opaque;
2703 * noise vs. sse weight for the nsse comparsion function
2704 * - encoding: Set by user.
2705 * - decoding: unused
2711 * - encoding: Set by user.
2712 * - decoding: Set by libavcodec.
2715 #define FF_PROFILE_UNKNOWN -99
2716 #define FF_PROFILE_RESERVED -100
2718 #define FF_PROFILE_AAC_MAIN 0
2719 #define FF_PROFILE_AAC_LOW 1
2720 #define FF_PROFILE_AAC_SSR 2
2721 #define FF_PROFILE_AAC_LTP 3
2722 #define FF_PROFILE_AAC_HE 4
2723 #define FF_PROFILE_AAC_HE_V2 28
2724 #define FF_PROFILE_AAC_LD 22
2725 #define FF_PROFILE_AAC_ELD 38
2726 #define FF_PROFILE_MPEG2_AAC_LOW 128
2727 #define FF_PROFILE_MPEG2_AAC_HE 131
2729 #define FF_PROFILE_DTS 20
2730 #define FF_PROFILE_DTS_ES 30
2731 #define FF_PROFILE_DTS_96_24 40
2732 #define FF_PROFILE_DTS_HD_HRA 50
2733 #define FF_PROFILE_DTS_HD_MA 60
2735 #define FF_PROFILE_MPEG2_422 0
2736 #define FF_PROFILE_MPEG2_HIGH 1
2737 #define FF_PROFILE_MPEG2_SS 2
2738 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2739 #define FF_PROFILE_MPEG2_MAIN 4
2740 #define FF_PROFILE_MPEG2_SIMPLE 5
2742 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2743 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2745 #define FF_PROFILE_H264_BASELINE 66
2746 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2747 #define FF_PROFILE_H264_MAIN 77
2748 #define FF_PROFILE_H264_EXTENDED 88
2749 #define FF_PROFILE_H264_HIGH 100
2750 #define FF_PROFILE_H264_HIGH_10 110
2751 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2752 #define FF_PROFILE_H264_HIGH_422 122
2753 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2754 #define FF_PROFILE_H264_HIGH_444 144
2755 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2756 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2757 #define FF_PROFILE_H264_CAVLC_444 44
2759 #define FF_PROFILE_VC1_SIMPLE 0
2760 #define FF_PROFILE_VC1_MAIN 1
2761 #define FF_PROFILE_VC1_COMPLEX 2
2762 #define FF_PROFILE_VC1_ADVANCED 3
2764 #define FF_PROFILE_MPEG4_SIMPLE 0
2765 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2766 #define FF_PROFILE_MPEG4_CORE 2
2767 #define FF_PROFILE_MPEG4_MAIN 3
2768 #define FF_PROFILE_MPEG4_N_BIT 4
2769 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2770 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2771 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2772 #define FF_PROFILE_MPEG4_HYBRID 8
2773 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2774 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2775 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2776 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2777 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2778 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2779 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2781 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2782 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2783 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2784 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2785 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2789 * - encoding: Set by user.
2790 * - decoding: Set by libavcodec.
2793 #define FF_LEVEL_UNKNOWN -99
2796 * Skip loop filtering for selected frames.
2797 * - encoding: unused
2798 * - decoding: Set by user.
2800 enum AVDiscard skip_loop_filter;
2803 * Skip IDCT/dequantization for selected frames.
2804 * - encoding: unused
2805 * - decoding: Set by user.
2807 enum AVDiscard skip_idct;
2810 * Skip decoding for selected frames.
2811 * - encoding: unused
2812 * - decoding: Set by user.
2814 enum AVDiscard skip_frame;
2817 * Header containing style information for text subtitles.
2818 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2819 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2820 * the Format line following. It shouldn't include any Dialogue line.
2821 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2822 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2824 uint8_t *subtitle_header;
2825 int subtitle_header_size;
2828 * Simulates errors in the bitstream to test error concealment.
2829 * - encoding: Set by user.
2830 * - decoding: unused
2834 #if FF_API_CODEC_PKT
2836 * @deprecated this field is not supposed to be accessed from outside lavc
2838 attribute_deprecated
2843 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2844 * Used for compliant TS muxing.
2845 * - encoding: Set by libavcodec.
2846 * - decoding: unused.
2851 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2852 * Code outside libavcodec should access this field using:
2853 * av_codec_{get,set}_pkt_timebase(avctx)
2854 * - encoding unused.
2855 * - decoding set by user.
2857 AVRational pkt_timebase;
2861 * Code outside libavcodec should access this field using:
2862 * av_codec_{get,set}_codec_descriptor(avctx)
2863 * - encoding: unused.
2864 * - decoding: set by libavcodec.
2866 const AVCodecDescriptor *codec_descriptor;
2870 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2871 * - encoding: unused
2872 * - decoding: Set by user.
2873 * Code outside libavcodec should access this field using:
2874 * av_codec_{get,set}_lowres(avctx)
2880 * Current statistics for PTS correction.
2881 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2882 * - encoding: unused
2884 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2885 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2886 int64_t pts_correction_last_pts; /// PTS of the last frame
2887 int64_t pts_correction_last_dts; /// DTS of the last frame
2890 * Character encoding of the input subtitles file.
2891 * - decoding: set by user
2892 * - encoding: unused
2897 * Subtitles character encoding mode. Formats or codecs might be adjusting
2898 * this setting (if they are doing the conversion themselves for instance).
2899 * - decoding: set by libavcodec
2900 * - encoding: unused
2902 int sub_charenc_mode;
2903 #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)
2904 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
2905 #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
2908 * Skip processing alpha if supported by codec.
2909 * Note that if the format uses pre-multiplied alpha (common with VP6,
2910 * and recommended due to better video quality/compression)
2911 * the image will look as if alpha-blended onto a black background.
2912 * However for formats that do not use pre-multiplied alpha
2913 * there might be serious artefacts (though e.g. libswscale currently
2914 * assumes pre-multiplied alpha anyway).
2915 * Code outside libavcodec should access this field using AVOptions
2917 * - decoding: set by user
2918 * - encoding: unused
2923 * Number of samples to skip after a discontinuity
2924 * - decoding: unused
2925 * - encoding: set by libavcodec
2929 #if !FF_API_DEBUG_MV
2931 * debug motion vectors
2932 * Code outside libavcodec should access this field using AVOptions
2933 * - encoding: Set by user.
2934 * - decoding: Set by user.
2937 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2938 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2939 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2943 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
2944 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
2946 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
2947 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
2949 int av_codec_get_lowres(const AVCodecContext *avctx);
2950 void av_codec_set_lowres(AVCodecContext *avctx, int val);
2952 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
2953 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
2958 typedef struct AVProfile {
2960 const char *name; ///< short name for the profile
2963 typedef struct AVCodecDefault AVCodecDefault;
2970 typedef struct AVCodec {
2972 * Name of the codec implementation.
2973 * The name is globally unique among encoders and among decoders (but an
2974 * encoder and a decoder can share the same name).
2975 * This is the primary way to find a codec from the user perspective.
2979 * Descriptive name for the codec, meant to be more human readable than name.
2980 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2982 const char *long_name;
2983 enum AVMediaType type;
2986 * Codec capabilities.
2990 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2991 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2992 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2993 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2994 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2996 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
2998 const AVClass *priv_class; ///< AVClass for the private context
2999 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3001 /*****************************************************************
3002 * No fields below this line are part of the public API. They
3003 * may not be used outside of libavcodec and can be changed and
3005 * New public fields should be added right above.
3006 *****************************************************************
3009 struct AVCodec *next;
3011 * @name Frame-level threading support functions
3015 * If defined, called on thread contexts when they are created.
3016 * If the codec allocates writable tables in init(), re-allocate them here.
3017 * priv_data will be set to a copy of the original.
3019 int (*init_thread_copy)(AVCodecContext *);
3021 * Copy necessary context variables from a previous thread context to the current one.
3022 * If not defined, the next thread will start automatically; otherwise, the codec
3023 * must call ff_thread_finish_setup().
3025 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3027 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3031 * Private codec-specific defaults.
3033 const AVCodecDefault *defaults;
3036 * Initialize codec static data, called from avcodec_register().
3038 void (*init_static_data)(struct AVCodec *codec);
3040 int (*init)(AVCodecContext *);
3041 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3042 const struct AVSubtitle *sub);
3044 * Encode data to an AVPacket.
3046 * @param avctx codec context
3047 * @param avpkt output AVPacket (may contain a user-provided buffer)
3048 * @param[in] frame AVFrame containing the raw data to be encoded
3049 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3050 * non-empty packet was returned in avpkt.
3051 * @return 0 on success, negative error code on failure
3053 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3054 int *got_packet_ptr);
3055 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3056 int (*close)(AVCodecContext *);
3059 * Will be called when seeking
3061 void (*flush)(AVCodecContext *);
3064 int av_codec_get_max_lowres(const AVCodec *codec);
3069 typedef struct AVHWAccel {
3071 * Name of the hardware accelerated codec.
3072 * The name is globally unique among encoders and among decoders (but an
3073 * encoder and a decoder can share the same name).
3078 * Type of codec implemented by the hardware accelerator.
3080 * See AVMEDIA_TYPE_xxx
3082 enum AVMediaType type;
3085 * Codec implemented by the hardware accelerator.
3087 * See AV_CODEC_ID_xxx
3092 * Supported pixel format.
3094 * Only hardware accelerated formats are supported here.
3096 enum AVPixelFormat pix_fmt;
3099 * Hardware accelerated codec capabilities.
3100 * see FF_HWACCEL_CODEC_CAP_*
3104 struct AVHWAccel *next;
3107 * Called at the beginning of each frame or field picture.
3109 * Meaningful frame information (codec specific) is guaranteed to
3110 * be parsed at this point. This function is mandatory.
3112 * Note that buf can be NULL along with buf_size set to 0.
3113 * Otherwise, this means the whole frame is available at this point.
3115 * @param avctx the codec context
3116 * @param buf the frame data buffer base
3117 * @param buf_size the size of the frame in bytes
3118 * @return zero if successful, a negative value otherwise
3120 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3123 * Callback for each slice.
3125 * Meaningful slice information (codec specific) is guaranteed to
3126 * be parsed at this point. This function is mandatory.
3128 * @param avctx the codec context
3129 * @param buf the slice data buffer base
3130 * @param buf_size the size of the slice in bytes
3131 * @return zero if successful, a negative value otherwise
3133 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3136 * Called at the end of each frame or field picture.
3138 * The whole picture is parsed at this point and can now be sent
3139 * to the hardware accelerator. This function is mandatory.
3141 * @param avctx the codec context
3142 * @return zero if successful, a negative value otherwise
3144 int (*end_frame)(AVCodecContext *avctx);
3147 * Size of HW accelerator private data.
3149 * Private data is allocated with av_mallocz() before
3150 * AVCodecContext.get_buffer() and deallocated after
3151 * AVCodecContext.release_buffer().
3157 * @defgroup lavc_picture AVPicture
3159 * Functions for working with AVPicture
3164 * Picture data structure.
3166 * Up to four components can be stored into it, the last component is
3169 typedef struct AVPicture {
3170 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3171 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3178 enum AVSubtitleType {
3181 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3184 * Plain text, the text field must be set by the decoder and is
3185 * authoritative. ass and pict fields may contain approximations.
3190 * Formatted text, the ass field must be set by the decoder and is
3191 * authoritative. pict and text fields may contain approximations.
3196 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3198 typedef struct AVSubtitleRect {
3199 int x; ///< top left corner of pict, undefined when pict is not set
3200 int y; ///< top left corner of pict, undefined when pict is not set
3201 int w; ///< width of pict, undefined when pict is not set
3202 int h; ///< height of pict, undefined when pict is not set
3203 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3206 * data+linesize for the bitmap of this subtitle.
3207 * can be set for text/ass as well once they where rendered
3210 enum AVSubtitleType type;
3212 char *text; ///< 0 terminated plain UTF-8 text
3215 * 0 terminated ASS/SSA compatible event line.
3216 * The presentation of this is unaffected by the other values in this
3224 typedef struct AVSubtitle {
3225 uint16_t format; /* 0 = graphics */
3226 uint32_t start_display_time; /* relative to packet pts, in ms */
3227 uint32_t end_display_time; /* relative to packet pts, in ms */
3229 AVSubtitleRect **rects;
3230 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3234 * If c is NULL, returns the first registered codec,
3235 * if c is non-NULL, returns the next registered codec after c,
3236 * or NULL if c is the last one.
3238 AVCodec *av_codec_next(const AVCodec *c);
3241 * Return the LIBAVCODEC_VERSION_INT constant.
3243 unsigned avcodec_version(void);
3246 * Return the libavcodec build-time configuration.
3248 const char *avcodec_configuration(void);
3251 * Return the libavcodec license.
3253 const char *avcodec_license(void);
3256 * Register the codec codec and initialize libavcodec.
3258 * @warning either this function or avcodec_register_all() must be called
3259 * before any other libavcodec functions.
3261 * @see avcodec_register_all()
3263 void avcodec_register(AVCodec *codec);
3266 * Register all the codecs, parsers and bitstream filters which were enabled at
3267 * configuration time. If you do not call this function you can select exactly
3268 * which formats you want to support, by using the individual registration
3271 * @see avcodec_register
3272 * @see av_register_codec_parser
3273 * @see av_register_bitstream_filter
3275 void avcodec_register_all(void);
3278 * Allocate an AVCodecContext and set its fields to default values. The
3279 * resulting struct can be deallocated by calling avcodec_close() on it followed
3282 * @param codec if non-NULL, allocate private data and initialize defaults
3283 * for the given codec. It is illegal to then call avcodec_open2()
3284 * with a different codec.
3285 * If NULL, then the codec-specific defaults won't be initialized,
3286 * which may result in suboptimal default settings (this is
3287 * important mainly for encoders, e.g. libx264).
3289 * @return An AVCodecContext filled with default values or NULL on failure.
3290 * @see avcodec_get_context_defaults
3292 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3295 * Set the fields of the given AVCodecContext to default values corresponding
3296 * to the given codec (defaults may be codec-dependent).
3298 * Do not call this function if a non-NULL codec has been passed
3299 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3300 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3301 * different codec on this AVCodecContext.
3303 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3306 * Get the AVClass for AVCodecContext. It can be used in combination with
3307 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3309 * @see av_opt_find().
3311 const AVClass *avcodec_get_class(void);
3314 * Get the AVClass for AVFrame. It can be used in combination with
3315 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3317 * @see av_opt_find().
3319 const AVClass *avcodec_get_frame_class(void);
3322 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3323 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3325 * @see av_opt_find().
3327 const AVClass *avcodec_get_subtitle_rect_class(void);
3330 * Copy the settings of the source AVCodecContext into the destination
3331 * AVCodecContext. The resulting destination codec context will be
3332 * unopened, i.e. you are required to call avcodec_open2() before you
3333 * can use this AVCodecContext to decode/encode video/audio data.
3335 * @param dest target codec context, should be initialized with
3336 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3337 * @param src source codec context
3338 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3340 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3343 * Allocate an AVFrame and set its fields to default values. The resulting
3344 * struct must be freed using avcodec_free_frame().
3346 * @return An AVFrame filled with default values or NULL on failure.
3347 * @see avcodec_get_frame_defaults
3349 AVFrame *avcodec_alloc_frame(void);
3352 * Set the fields of the given AVFrame to default values.
3354 * @param frame The AVFrame of which the fields should be set to default values.
3356 void avcodec_get_frame_defaults(AVFrame *frame);
3359 * Free the frame and any dynamically allocated objects in it,
3360 * e.g. extended_data.
3362 * @param frame frame to be freed. The pointer will be set to NULL.
3364 * @warning this function does NOT free the data buffers themselves
3365 * (it does not know how, since they might have been allocated with
3366 * a custom get_buffer()).
3368 void avcodec_free_frame(AVFrame **frame);
3371 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3372 * function the context has to be allocated with avcodec_alloc_context3().
3374 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3375 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3376 * retrieving a codec.
3378 * @warning This function is not thread safe!
3381 * avcodec_register_all();
3382 * av_dict_set(&opts, "b", "2.5M", 0);
3383 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3387 * context = avcodec_alloc_context3(codec);
3389 * if (avcodec_open2(context, codec, opts) < 0)
3393 * @param avctx The context to initialize.
3394 * @param codec The codec to open this context for. If a non-NULL codec has been
3395 * previously passed to avcodec_alloc_context3() or
3396 * avcodec_get_context_defaults3() for this context, then this
3397 * parameter MUST be either NULL or equal to the previously passed
3399 * @param options A dictionary filled with AVCodecContext and codec-private options.
3400 * On return this object will be filled with options that were not found.
3402 * @return zero on success, a negative value on error
3403 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3404 * av_dict_set(), av_opt_find().
3406 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3409 * Close a given AVCodecContext and free all the data associated with it
3410 * (but not the AVCodecContext itself).
3412 * Calling this function on an AVCodecContext that hasn't been opened will free
3413 * the codec-specific data allocated in avcodec_alloc_context3() /
3414 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3417 int avcodec_close(AVCodecContext *avctx);
3420 * Free all allocated data in the given subtitle struct.
3422 * @param sub AVSubtitle to free.
3424 void avsubtitle_free(AVSubtitle *sub);
3431 * @addtogroup lavc_packet
3435 #if FF_API_DESTRUCT_PACKET
3437 * Default packet destructor.
3438 * @deprecated use the AVBuffer API instead
3440 attribute_deprecated
3441 void av_destruct_packet(AVPacket *pkt);
3445 * Initialize optional fields of a packet with default values.
3447 * Note, this does not touch the data and size members, which have to be
3448 * initialized separately.
3452 void av_init_packet(AVPacket *pkt);
3455 * Allocate the payload of a packet and initialize its fields with
3459 * @param size wanted payload size
3460 * @return 0 if OK, AVERROR_xxx otherwise
3462 int av_new_packet(AVPacket *pkt, int size);
3465 * Reduce packet size, correctly zeroing padding
3468 * @param size new size
3470 void av_shrink_packet(AVPacket *pkt, int size);
3473 * Increase packet size, correctly zeroing padding
3476 * @param grow_by number of bytes by which to increase the size of the packet
3478 int av_grow_packet(AVPacket *pkt, int grow_by);
3481 * Initialize a reference-counted packet from av_malloc()ed data.
3483 * @param pkt packet to be initialized. This function will set the data, size,
3484 * buf and destruct fields, all others are left untouched.
3485 * @param data Data allocated by av_malloc() to be used as packet data. If this
3486 * function returns successfully, the data is owned by the underlying AVBuffer.
3487 * The caller may not access the data through other means.
3488 * @param size size of data in bytes, without the padding. I.e. the full buffer
3489 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3491 * @return 0 on success, a negative AVERROR on error
3493 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3496 * @warning This is a hack - the packet memory allocation stuff is broken. The
3497 * packet is allocated if it was not really allocated.
3499 int av_dup_packet(AVPacket *pkt);
3502 * Copy packet, including contents
3504 * @return 0 on success, negative AVERROR on fail
3506 int av_copy_packet(AVPacket *dst, AVPacket *src);
3509 * Copy packet side data
3511 * @return 0 on success, negative AVERROR on fail
3513 int av_copy_packet_side_data(AVPacket *dst, AVPacket *src);
3518 * @param pkt packet to free
3520 void av_free_packet(AVPacket *pkt);
3523 * Allocate new information of a packet.
3526 * @param type side information type
3527 * @param size side information size
3528 * @return pointer to fresh allocated data or NULL otherwise
3530 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3534 * Shrink the already allocated side data buffer
3537 * @param type side information type
3538 * @param size new side information size
3539 * @return 0 on success, < 0 on failure
3541 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3545 * Get side information from packet.
3548 * @param type desired side information type
3549 * @param size pointer for side information size to store (optional)
3550 * @return pointer to data if present or NULL otherwise
3552 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3555 int av_packet_merge_side_data(AVPacket *pkt);
3557 int av_packet_split_side_data(AVPacket *pkt);
3561 * Convenience function to free all the side data stored.
3562 * All the other fields stay untouched.
3566 void av_packet_free_side_data(AVPacket *pkt);
3569 * Setup a new reference to the data described by a given packet
3571 * If src is reference-counted, setup dst as a new reference to the
3572 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3573 * data from src into it.
3575 * All the other fields are copied from src.
3577 * @see av_packet_unref
3579 * @param dst Destination packet
3580 * @param src Source packet
3582 * @return 0 on success, a negative AVERROR on error.
3584 int av_packet_ref(AVPacket *dst, AVPacket *src);
3589 * Unreference the buffer referenced by the packet and reset the
3590 * remaining packet fields to their default values.
3592 * @param pkt The packet to be unreferenced.
3594 void av_packet_unref(AVPacket *pkt);
3597 * Move every field in src to dst and reset src.
3599 * @see av_packet_unref
3601 * @param src Source packet, will be reset
3602 * @param dst Destination packet
3604 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3607 * Copy only "properties" fields from src to dst.
3609 * Properties for the purpose of this function are all the fields
3610 * beside those related to the packet data (buf, data, size)
3612 * @param dst Destination packet
3613 * @param src Source packet
3615 * @return 0 on success AVERROR on failure.
3618 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3625 * @addtogroup lavc_decoding
3630 * Find a registered decoder with a matching codec ID.
3632 * @param id AVCodecID of the requested decoder
3633 * @return A decoder if one was found, NULL otherwise.
3635 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3638 * Find a registered decoder with the specified name.
3640 * @param name name of the requested decoder
3641 * @return A decoder if one was found, NULL otherwise.
3643 AVCodec *avcodec_find_decoder_by_name(const char *name);
3645 #if FF_API_GET_BUFFER
3646 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3647 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3648 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3652 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3653 * it can be called by custom get_buffer2() implementations for decoders without
3654 * CODEC_CAP_DR1 set.
3656 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3659 * Return the amount of padding in pixels which the get_buffer callback must
3660 * provide around the edge of the image for codecs which do not have the
3661 * CODEC_FLAG_EMU_EDGE flag.
3663 * @return Required padding in pixels.
3665 unsigned avcodec_get_edge_width(void);
3668 * Modify width and height values so that they will result in a memory
3669 * buffer that is acceptable for the codec if you do not use any horizontal
3672 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3673 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3674 * according to avcodec_get_edge_width() before.
3676 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3679 * Modify width and height values so that they will result in a memory
3680 * buffer that is acceptable for the codec if you also ensure that all
3681 * line sizes are a multiple of the respective linesize_align[i].
3683 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3684 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3685 * according to avcodec_get_edge_width() before.
3687 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3688 int linesize_align[AV_NUM_DATA_POINTERS]);
3691 * Converts AVChromaLocation to swscale x/y chroma position.
3693 * The positions represent the chroma (0,0) position in a coordinates system
3694 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3696 * @param xpos horizontal chroma sample position
3697 * @param ypos vertical chroma sample position
3699 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
3702 * Converts swscale x/y chroma position to AVChromaLocation.
3704 * The positions represent the chroma (0,0) position in a coordinates system
3705 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3707 * @param xpos horizontal chroma sample position
3708 * @param ypos vertical chroma sample position
3710 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
3712 #if FF_API_OLD_DECODE_AUDIO
3714 * Wrapper function which calls avcodec_decode_audio4.
3716 * @deprecated Use avcodec_decode_audio4 instead.
3718 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3719 * Some decoders may support multiple frames in a single AVPacket, such
3720 * decoders would then just decode the first frame. In this case,
3721 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3722 * the remaining data in order to decode the second frame etc.
3724 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3725 * decompressed frame size in bytes.
3727 * @warning You must set frame_size_ptr to the allocated size of the
3728 * output buffer before calling avcodec_decode_audio3().
3730 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3731 * the actual read bytes because some optimized bitstream readers read 32 or 64
3732 * bits at once and could read over the end.
3734 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3735 * no overreading happens for damaged MPEG streams.
3737 * @warning You must not provide a custom get_buffer() when using
3738 * avcodec_decode_audio3(). Doing so will override it with
3739 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3740 * which does allow the application to provide a custom get_buffer().
3742 * @note You might have to align the input buffer avpkt->data and output buffer
3743 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3744 * necessary at all, on others it won't work at all if not aligned and on others
3745 * it will work but it will have an impact on performance.
3747 * In practice, avpkt->data should have 4 byte alignment at minimum and
3748 * samples should be 16 byte aligned unless the CPU doesn't need it
3749 * (AltiVec and SSE do).
3751 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3752 * between input and output, these need to be fed with avpkt->data=NULL,
3753 * avpkt->size=0 at the end to return the remaining frames.
3755 * @param avctx the codec context
3756 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3757 * If the sample format is planar, each channel plane will
3758 * be the same size, with no padding between channels.
3759 * @param[in,out] frame_size_ptr the output buffer size in bytes
3760 * @param[in] avpkt The input AVPacket containing the input buffer.
3761 * You can create such packet with av_init_packet() and by then setting
3762 * data and size, some decoders might in addition need other fields.
3763 * All decoders are designed to use the least fields possible though.
3764 * @return On error a negative value is returned, otherwise the number of bytes
3765 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3767 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3768 int *frame_size_ptr,
3773 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3775 * Some decoders may support multiple frames in a single AVPacket. Such
3776 * decoders would then just decode the first frame and the return value would be
3777 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3778 * called again with an AVPacket containing the remaining data in order to
3779 * decode the second frame, etc... Even if no frames are returned, the packet
3780 * needs to be fed to the decoder with remaining data until it is completely
3781 * consumed or an error occurs.
3783 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3784 * and output. This means that for some packets they will not immediately
3785 * produce decoded output and need to be flushed at the end of decoding to get
3786 * all the decoded data. Flushing is done by calling this function with packets
3787 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3788 * returning samples. It is safe to flush even those decoders that are not
3789 * marked with CODEC_CAP_DELAY, then no samples will be returned.
3791 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3792 * larger than the actual read bytes because some optimized bitstream
3793 * readers read 32 or 64 bits at once and could read over the end.
3795 * @param avctx the codec context
3796 * @param[out] frame The AVFrame in which to store decoded audio samples.
3797 * The decoder will allocate a buffer for the decoded frame by
3798 * calling the AVCodecContext.get_buffer2() callback.
3799 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3800 * reference counted and the returned reference belongs to the
3801 * caller. The caller must release the frame using av_frame_unref()
3802 * when the frame is no longer needed. The caller may safely write
3803 * to the frame if av_frame_is_writable() returns 1.
3804 * When AVCodecContext.refcounted_frames is set to 0, the returned
3805 * reference belongs to the decoder and is valid only until the
3806 * next call to this function or until closing or flushing the
3807 * decoder. The caller may not write to it.
3808 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3809 * non-zero. Note that this field being set to zero
3810 * does not mean that an error has occurred. For
3811 * decoders with CODEC_CAP_DELAY set, no given decode
3812 * call is guaranteed to produce a frame.
3813 * @param[in] avpkt The input AVPacket containing the input buffer.
3814 * At least avpkt->data and avpkt->size should be set. Some
3815 * decoders might also require additional fields to be set.
3816 * @return A negative error code is returned if an error occurred during
3817 * decoding, otherwise the number of bytes consumed from the input
3818 * AVPacket is returned.
3820 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3821 int *got_frame_ptr, const AVPacket *avpkt);
3824 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3825 * Some decoders may support multiple frames in a single AVPacket, such
3826 * decoders would then just decode the first frame.
3828 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3829 * the actual read bytes because some optimized bitstream readers read 32 or 64
3830 * bits at once and could read over the end.
3832 * @warning The end of the input buffer buf should be set to 0 to ensure that
3833 * no overreading happens for damaged MPEG streams.
3835 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3836 * between input and output, these need to be fed with avpkt->data=NULL,
3837 * avpkt->size=0 at the end to return the remaining frames.
3839 * @param avctx the codec context
3840 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3841 * Use av_frame_alloc() to get an AVFrame. The codec will
3842 * allocate memory for the actual bitmap by calling the
3843 * AVCodecContext.get_buffer2() callback.
3844 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3845 * reference counted and the returned reference belongs to the
3846 * caller. The caller must release the frame using av_frame_unref()
3847 * when the frame is no longer needed. The caller may safely write
3848 * to the frame if av_frame_is_writable() returns 1.
3849 * When AVCodecContext.refcounted_frames is set to 0, the returned
3850 * reference belongs to the decoder and is valid only until the
3851 * next call to this function or until closing or flushing the
3852 * decoder. The caller may not write to it.
3854 * @param[in] avpkt The input AVPacket containing the input buffer.
3855 * You can create such packet with av_init_packet() and by then setting
3856 * data and size, some decoders might in addition need other fields like
3857 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3859 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3860 * @return On error a negative value is returned, otherwise the number of bytes
3861 * used or zero if no frame could be decompressed.
3863 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3864 int *got_picture_ptr,
3865 const AVPacket *avpkt);
3868 * Decode a subtitle message.
3869 * Return a negative value on error, otherwise return the number of bytes used.
3870 * If no subtitle could be decompressed, got_sub_ptr is zero.
3871 * Otherwise, the subtitle is stored in *sub.
3872 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3873 * simplicity, because the performance difference is expect to be negligible
3874 * and reusing a get_buffer written for video codecs would probably perform badly
3875 * due to a potentially very different allocation pattern.
3877 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3878 * and output. This means that for some packets they will not immediately
3879 * produce decoded output and need to be flushed at the end of decoding to get
3880 * all the decoded data. Flushing is done by calling this function with packets
3881 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3882 * returning subtitles. It is safe to flush even those decoders that are not
3883 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
3885 * @param avctx the codec context
3886 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3887 freed with avsubtitle_free if *got_sub_ptr is set.
3888 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3889 * @param[in] avpkt The input AVPacket containing the input buffer.
3891 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3896 * @defgroup lavc_parsing Frame parsing
3900 enum AVPictureStructure {
3901 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3902 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3903 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3904 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3907 typedef struct AVCodecParserContext {
3909 struct AVCodecParser *parser;
3910 int64_t frame_offset; /* offset of the current frame */
3911 int64_t cur_offset; /* current offset
3912 (incremented by each av_parser_parse()) */
3913 int64_t next_frame_offset; /* offset of the next frame */
3915 int pict_type; /* XXX: Put it back in AVCodecContext. */
3917 * This field is used for proper frame duration computation in lavf.
3918 * It signals, how much longer the frame duration of the current frame
3919 * is compared to normal frame duration.
3921 * frame_duration = (1 + repeat_pict) * time_base
3923 * It is used by codecs like H.264 to display telecined material.
3925 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3926 int64_t pts; /* pts of the current frame */
3927 int64_t dts; /* dts of the current frame */
3932 int fetch_timestamp;
3934 #define AV_PARSER_PTS_NB 4
3935 int cur_frame_start_index;
3936 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3937 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3938 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3941 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3942 #define PARSER_FLAG_ONCE 0x0002
3943 /// Set if the parser has a valid file offset
3944 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3945 #define PARSER_FLAG_USE_CODEC_TS 0x1000
3947 int64_t offset; ///< byte offset from starting packet start
3948 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3951 * Set by parser to 1 for key frames and 0 for non-key frames.
3952 * It is initialized to -1, so if the parser doesn't set this flag,
3953 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3959 * Time difference in stream time base units from the pts of this
3960 * packet to the point at which the output from the decoder has converged
3961 * independent from the availability of previous frames. That is, the
3962 * frames are virtually identical no matter if decoding started from
3963 * the very first frame or from this keyframe.
3964 * Is AV_NOPTS_VALUE if unknown.
3965 * This field is not the display duration of the current frame.
3966 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3969 * The purpose of this field is to allow seeking in streams that have no
3970 * keyframes in the conventional sense. It corresponds to the
3971 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3972 * essential for some types of subtitle streams to ensure that all
3973 * subtitles are correctly displayed after seeking.
3975 int64_t convergence_duration;
3977 // Timestamp generation support:
3979 * Synchronization point for start of timestamp generation.
3981 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3984 * For example, this corresponds to presence of H.264 buffering period
3990 * Offset of the current timestamp against last timestamp sync point in
3991 * units of AVCodecContext.time_base.
3993 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3994 * contain a valid timestamp offset.
3996 * Note that the timestamp of sync point has usually a nonzero
3997 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3998 * the next frame after timestamp sync point will be usually 1.
4000 * For example, this corresponds to H.264 cpb_removal_delay.
4002 int dts_ref_dts_delta;
4005 * Presentation delay of current frame in units of AVCodecContext.time_base.
4007 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4008 * contain valid non-negative timestamp delta (presentation time of a frame
4009 * must not lie in the past).
4011 * This delay represents the difference between decoding and presentation
4012 * time of the frame.
4014 * For example, this corresponds to H.264 dpb_output_delay.
4019 * Position of the packet in file.
4021 * Analogous to cur_frame_pts/dts
4023 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4026 * Byte position of currently parsed frame in stream.
4031 * Previous frame byte position.
4036 * Duration of the current frame.
4037 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4038 * For all other types, this is in units of AVCodecContext.time_base.
4042 enum AVFieldOrder field_order;
4045 * Indicate whether a picture is coded as a frame, top field or bottom field.
4047 * For example, H.264 field_pic_flag equal to 0 corresponds to
4048 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4049 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4050 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4052 enum AVPictureStructure picture_structure;
4055 * Picture number incremented in presentation or output order.
4056 * This field may be reinitialized at the first picture of a new sequence.
4058 * For example, this corresponds to H.264 PicOrderCnt.
4060 int output_picture_number;
4061 } AVCodecParserContext;
4063 typedef struct AVCodecParser {
4064 int codec_ids[5]; /* several codec IDs are permitted */
4066 int (*parser_init)(AVCodecParserContext *s);
4067 int (*parser_parse)(AVCodecParserContext *s,
4068 AVCodecContext *avctx,
4069 const uint8_t **poutbuf, int *poutbuf_size,
4070 const uint8_t *buf, int buf_size);
4071 void (*parser_close)(AVCodecParserContext *s);
4072 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4073 struct AVCodecParser *next;
4076 AVCodecParser *av_parser_next(AVCodecParser *c);
4078 void av_register_codec_parser(AVCodecParser *parser);
4079 AVCodecParserContext *av_parser_init(int codec_id);
4084 * @param s parser context.
4085 * @param avctx codec context.
4086 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4087 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4088 * @param buf input buffer.
4089 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4090 * @param pts input presentation timestamp.
4091 * @param dts input decoding timestamp.
4092 * @param pos input byte position in stream.
4093 * @return the number of bytes of the input bitstream used.
4098 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4105 * decode_frame(data, size);
4109 int av_parser_parse2(AVCodecParserContext *s,
4110 AVCodecContext *avctx,
4111 uint8_t **poutbuf, int *poutbuf_size,
4112 const uint8_t *buf, int buf_size,
4113 int64_t pts, int64_t dts,
4117 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4118 * @deprecated use AVBitStreamFilter
4120 int av_parser_change(AVCodecParserContext *s,
4121 AVCodecContext *avctx,
4122 uint8_t **poutbuf, int *poutbuf_size,
4123 const uint8_t *buf, int buf_size, int keyframe);
4124 void av_parser_close(AVCodecParserContext *s);
4132 * @addtogroup lavc_encoding
4137 * Find a registered encoder with a matching codec ID.
4139 * @param id AVCodecID of the requested encoder
4140 * @return An encoder if one was found, NULL otherwise.
4142 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4145 * Find a registered encoder with the specified name.
4147 * @param name name of the requested encoder
4148 * @return An encoder if one was found, NULL otherwise.
4150 AVCodec *avcodec_find_encoder_by_name(const char *name);
4152 #if FF_API_OLD_ENCODE_AUDIO
4154 * Encode an audio frame from samples into buf.
4156 * @deprecated Use avcodec_encode_audio2 instead.
4158 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4159 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4160 * will know how much space is needed because it depends on the value passed
4161 * in buf_size as described below. In that case a lower value can be used.
4163 * @param avctx the codec context
4164 * @param[out] buf the output buffer
4165 * @param[in] buf_size the output buffer size
4166 * @param[in] samples the input buffer containing the samples
4167 * The number of samples read from this buffer is frame_size*channels,
4168 * both of which are defined in avctx.
4169 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4170 * samples read from samples is equal to:
4171 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4172 * This also implies that av_get_bits_per_sample() must not return 0 for these
4174 * @return On error a negative value is returned, on success zero or the number
4175 * of bytes used to encode the data read from the input buffer.
4177 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4178 uint8_t *buf, int buf_size,
4179 const short *samples);
4183 * Encode a frame of audio.
4185 * Takes input samples from frame and writes the next output packet, if
4186 * available, to avpkt. The output packet does not necessarily contain data for
4187 * the most recent frame, as encoders can delay, split, and combine input frames
4188 * internally as needed.
4190 * @param avctx codec context
4191 * @param avpkt output AVPacket.
4192 * The user can supply an output buffer by setting
4193 * avpkt->data and avpkt->size prior to calling the
4194 * function, but if the size of the user-provided data is not
4195 * large enough, encoding will fail. If avpkt->data and
4196 * avpkt->size are set, avpkt->destruct must also be set. All
4197 * other AVPacket fields will be reset by the encoder using
4198 * av_init_packet(). If avpkt->data is NULL, the encoder will
4199 * allocate it. The encoder will set avpkt->size to the size
4200 * of the output packet.
4202 * If this function fails or produces no output, avpkt will be
4203 * freed using av_free_packet() (i.e. avpkt->destruct will be
4204 * called to free the user supplied buffer).
4205 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4206 * May be NULL when flushing an encoder that has the
4207 * CODEC_CAP_DELAY capability set.
4208 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4209 * can have any number of samples.
4210 * If it is not set, frame->nb_samples must be equal to
4211 * avctx->frame_size for all frames except the last.
4212 * The final frame may be smaller than avctx->frame_size.
4213 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4214 * output packet is non-empty, and to 0 if it is
4215 * empty. If the function returns an error, the
4216 * packet can be assumed to be invalid, and the
4217 * value of got_packet_ptr is undefined and should
4219 * @return 0 on success, negative error code on failure
4221 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4222 const AVFrame *frame, int *got_packet_ptr);
4224 #if FF_API_OLD_ENCODE_VIDEO
4226 * @deprecated use avcodec_encode_video2() instead.
4228 * Encode a video frame from pict into buf.
4229 * The input picture should be
4230 * stored using a specific format, namely avctx.pix_fmt.
4232 * @param avctx the codec context
4233 * @param[out] buf the output buffer for the bitstream of encoded frame
4234 * @param[in] buf_size the size of the output buffer in bytes
4235 * @param[in] pict the input picture to encode
4236 * @return On error a negative value is returned, on success zero or the number
4237 * of bytes used from the output buffer.
4239 attribute_deprecated
4240 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4241 const AVFrame *pict);
4245 * Encode a frame of video.
4247 * Takes input raw video data from frame and writes the next output packet, if
4248 * available, to avpkt. The output packet does not necessarily contain data for
4249 * the most recent frame, as encoders can delay and reorder input frames
4250 * internally as needed.
4252 * @param avctx codec context
4253 * @param avpkt output AVPacket.
4254 * The user can supply an output buffer by setting
4255 * avpkt->data and avpkt->size prior to calling the
4256 * function, but if the size of the user-provided data is not
4257 * large enough, encoding will fail. All other AVPacket fields
4258 * will be reset by the encoder using av_init_packet(). If
4259 * avpkt->data is NULL, the encoder will allocate it.
4260 * The encoder will set avpkt->size to the size of the
4261 * output packet. The returned data (if any) belongs to the
4262 * caller, he is responsible for freeing it.
4264 * If this function fails or produces no output, avpkt will be
4265 * freed using av_free_packet() (i.e. avpkt->destruct will be
4266 * called to free the user supplied buffer).
4267 * @param[in] frame AVFrame containing the raw video data to be encoded.
4268 * May be NULL when flushing an encoder that has the
4269 * CODEC_CAP_DELAY capability set.
4270 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4271 * output packet is non-empty, and to 0 if it is
4272 * empty. If the function returns an error, the
4273 * packet can be assumed to be invalid, and the
4274 * value of got_packet_ptr is undefined and should
4276 * @return 0 on success, negative error code on failure
4278 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4279 const AVFrame *frame, int *got_packet_ptr);
4281 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4282 const AVSubtitle *sub);
4289 #if FF_API_AVCODEC_RESAMPLE
4291 * @defgroup lavc_resample Audio resampling
4293 * @deprecated use libswresample instead
4297 struct ReSampleContext;
4298 struct AVResampleContext;
4300 typedef struct ReSampleContext ReSampleContext;
4303 * Initialize audio resampling context.
4305 * @param output_channels number of output channels
4306 * @param input_channels number of input channels
4307 * @param output_rate output sample rate
4308 * @param input_rate input sample rate
4309 * @param sample_fmt_out requested output sample format
4310 * @param sample_fmt_in input sample format
4311 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4312 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4313 * @param linear if 1 then the used FIR filter will be linearly interpolated
4314 between the 2 closest, if 0 the closest will be used
4315 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4316 * @return allocated ReSampleContext, NULL if error occurred
4318 attribute_deprecated
4319 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4320 int output_rate, int input_rate,
4321 enum AVSampleFormat sample_fmt_out,
4322 enum AVSampleFormat sample_fmt_in,
4323 int filter_length, int log2_phase_count,
4324 int linear, double cutoff);
4326 attribute_deprecated
4327 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4330 * Free resample context.
4332 * @param s a non-NULL pointer to a resample context previously
4333 * created with av_audio_resample_init()
4335 attribute_deprecated
4336 void audio_resample_close(ReSampleContext *s);
4340 * Initialize an audio resampler.
4341 * Note, if either rate is not an integer then simply scale both rates up so they are.
4342 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4343 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4344 * @param linear If 1 then the used FIR filter will be linearly interpolated
4345 between the 2 closest, if 0 the closest will be used
4346 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4348 attribute_deprecated
4349 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4352 * Resample an array of samples using a previously configured context.
4353 * @param src an array of unconsumed samples
4354 * @param consumed the number of samples of src which have been consumed are returned here
4355 * @param src_size the number of unconsumed samples available
4356 * @param dst_size the amount of space in samples available in dst
4357 * @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.
4358 * @return the number of samples written in dst or -1 if an error occurred
4360 attribute_deprecated
4361 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4365 * Compensate samplerate/timestamp drift. The compensation is done by changing
4366 * the resampler parameters, so no audible clicks or similar distortions occur
4367 * @param compensation_distance distance in output samples over which the compensation should be performed
4368 * @param sample_delta number of output samples which should be output less
4370 * example: av_resample_compensate(c, 10, 500)
4371 * here instead of 510 samples only 500 samples would be output
4373 * note, due to rounding the actual compensation might be slightly different,
4374 * especially if the compensation_distance is large and the in_rate used during init is small
4376 attribute_deprecated
4377 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4378 attribute_deprecated
4379 void av_resample_close(struct AVResampleContext *c);
4387 * @addtogroup lavc_picture
4392 * Allocate memory for the pixels of a picture and setup the AVPicture
4395 * Call avpicture_free() to free it.
4397 * @param picture the picture structure to be filled in
4398 * @param pix_fmt the pixel format of the picture
4399 * @param width the width of the picture
4400 * @param height the height of the picture
4401 * @return zero if successful, a negative error code otherwise
4403 * @see av_image_alloc(), avpicture_fill()
4405 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4408 * Free a picture previously allocated by avpicture_alloc().
4409 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4412 * @param picture the AVPicture to be freed
4414 void avpicture_free(AVPicture *picture);
4417 * Setup the picture fields based on the specified image parameters
4418 * and the provided image data buffer.
4420 * The picture fields are filled in by using the image data buffer
4421 * pointed to by ptr.
4423 * If ptr is NULL, the function will fill only the picture linesize
4424 * array and return the required size for the image buffer.
4426 * To allocate an image buffer and fill the picture data in one call,
4427 * use avpicture_alloc().
4429 * @param picture the picture to be filled in
4430 * @param ptr buffer where the image data is stored, or NULL
4431 * @param pix_fmt the pixel format of the image
4432 * @param width the width of the image in pixels
4433 * @param height the height of the image in pixels
4434 * @return the size in bytes required for src, a negative error code
4435 * in case of failure
4437 * @see av_image_fill_arrays()
4439 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4440 enum AVPixelFormat pix_fmt, int width, int height);
4443 * Copy pixel data from an AVPicture into a buffer.
4445 * avpicture_get_size() can be used to compute the required size for
4446 * the buffer to fill.
4448 * @param src source picture with filled data
4449 * @param pix_fmt picture pixel format
4450 * @param width picture width
4451 * @param height picture height
4452 * @param dest destination buffer
4453 * @param dest_size destination buffer size in bytes
4454 * @return the number of bytes written to dest, or a negative value
4455 * (error code) on error, for example if the destination buffer is not
4458 * @see av_image_copy_to_buffer()
4460 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4461 int width, int height,
4462 unsigned char *dest, int dest_size);
4465 * Calculate the size in bytes that a picture of the given width and height
4466 * would occupy if stored in the given picture format.
4468 * @param pix_fmt picture pixel format
4469 * @param width picture width
4470 * @param height picture height
4471 * @return the computed picture buffer size or a negative error code
4474 * @see av_image_get_buffer_size().
4476 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4478 #if FF_API_DEINTERLACE
4480 * deinterlace - if not supported return -1
4482 * @deprecated - use yadif (in libavfilter) instead
4484 attribute_deprecated
4485 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4486 enum AVPixelFormat pix_fmt, int width, int height);
4489 * Copy image src to dst. Wraps av_image_copy().
4491 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4492 enum AVPixelFormat pix_fmt, int width, int height);
4495 * Crop image top and left side.
4497 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4498 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4503 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4504 int padtop, int padbottom, int padleft, int padright, int *color);
4511 * @defgroup lavc_misc Utility functions
4514 * Miscellaneous utility functions related to both encoding and decoding
4520 * @defgroup lavc_misc_pixfmt Pixel formats
4522 * Functions for working with pixel formats.
4527 * Utility function to access log2_chroma_w log2_chroma_h from
4528 * the pixel format AVPixFmtDescriptor.
4530 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4531 * for one that returns a failure code and continues in case of invalid
4534 * @param[in] pix_fmt the pixel format
4535 * @param[out] h_shift store log2_chroma_w
4536 * @param[out] v_shift store log2_chroma_h
4538 * @see av_pix_fmt_get_chroma_sub_sample
4541 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4544 * Return a value representing the fourCC code associated to the
4545 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4548 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4550 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4551 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4552 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4553 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4554 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4555 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4558 * Compute what kind of losses will occur when converting from one specific
4559 * pixel format to another.
4560 * When converting from one pixel format to another, information loss may occur.
4561 * For example, when converting from RGB24 to GRAY, the color information will
4562 * be lost. Similarly, other losses occur when converting from some formats to
4563 * other formats. These losses can involve loss of chroma, but also loss of
4564 * resolution, loss of color depth, loss due to the color space conversion, loss
4565 * of the alpha bits or loss due to color quantization.
4566 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4567 * which will occur when converting from one pixel format to another.
4569 * @param[in] dst_pix_fmt destination pixel format
4570 * @param[in] src_pix_fmt source pixel format
4571 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4572 * @return Combination of flags informing you what kind of losses will occur
4573 * (maximum loss for an invalid dst_pix_fmt).
4575 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4579 * Find the best pixel format to convert to given a certain source pixel
4580 * format. When converting from one pixel format to another, information loss
4581 * may occur. For example, when converting from RGB24 to GRAY, the color
4582 * information will be lost. Similarly, other losses occur when converting from
4583 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4584 * the given pixel formats should be used to suffer the least amount of loss.
4585 * The pixel formats from which it chooses one, are determined by the
4586 * pix_fmt_list parameter.
4589 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4590 * @param[in] src_pix_fmt source pixel format
4591 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4592 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4593 * @return The best pixel format to convert to or -1 if none was found.
4595 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4596 enum AVPixelFormat src_pix_fmt,
4597 int has_alpha, int *loss_ptr);
4600 * Find the best pixel format to convert to given a certain source pixel
4601 * format and a selection of two destination pixel formats. When converting from
4602 * one pixel format to another, information loss may occur. For example, when converting
4603 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4604 * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4605 * the given pixel formats should be used to suffer the least amount of loss.
4607 * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be
4611 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4612 * dst_pix_fmt1= AV_PIX_FMT_RGB24;
4613 * dst_pix_fmt2= AV_PIX_FMT_GRAY8;
4614 * dst_pix_fmt3= AV_PIX_FMT_RGB8;
4615 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4616 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4617 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4620 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4621 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4622 * @param[in] src_pix_fmt Source pixel format
4623 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4624 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4625 * NULL or value of zero means we care about all losses. Out: the loss
4626 * that occurs when converting from src to selected dst pixel format.
4627 * @return The best pixel format to convert to or -1 if none was found.
4629 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4630 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4632 attribute_deprecated
4633 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
4634 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
4635 enum AVPixelFormat src_pix_fmt,
4636 int has_alpha, int *loss_ptr);
4638 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4639 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4643 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4649 #if FF_API_SET_DIMENSIONS
4651 * @deprecated this function is not supposed to be used from outside of lavc
4653 attribute_deprecated
4654 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4658 * Put a string representing the codec tag codec_tag in buf.
4660 * @param buf_size size in bytes of buf
4661 * @return the length of the string that would have been generated if
4662 * enough space had been available, excluding the trailing null
4664 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4666 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4669 * Return a name for the specified profile, if available.
4671 * @param codec the codec that is searched for the given profile
4672 * @param profile the profile value for which a name is requested
4673 * @return A name for the profile if found, NULL otherwise.
4675 const char *av_get_profile_name(const AVCodec *codec, int profile);
4677 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4678 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4679 //FIXME func typedef
4682 * Fill AVFrame audio data and linesize pointers.
4684 * The buffer buf must be a preallocated buffer with a size big enough
4685 * to contain the specified samples amount. The filled AVFrame data
4686 * pointers will point to this buffer.
4688 * AVFrame extended_data channel pointers are allocated if necessary for
4691 * @param frame the AVFrame
4692 * frame->nb_samples must be set prior to calling the
4693 * function. This function fills in frame->data,
4694 * frame->extended_data, frame->linesize[0].
4695 * @param nb_channels channel count
4696 * @param sample_fmt sample format
4697 * @param buf buffer to use for frame data
4698 * @param buf_size size of buffer
4699 * @param align plane size sample alignment (0 = default)
4700 * @return >=0 on success, negative error code on failure
4701 * @todo return the size in bytes required to store the samples in
4702 * case of success, at the next libavutil bump
4704 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4705 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4706 int buf_size, int align);
4709 * Reset the internal decoder state / flush internal buffers. Should be called
4710 * e.g. when seeking or when switching to a different stream.
4712 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4713 * this invalidates the frames previously returned from the decoder. When
4714 * refcounted frames are used, the decoder just releases any references it might
4715 * keep internally, but the caller's reference remains valid.
4717 void avcodec_flush_buffers(AVCodecContext *avctx);
4720 * Return codec bits per sample.
4722 * @param[in] codec_id the codec
4723 * @return Number of bits per sample or zero if unknown for the given codec.
4725 int av_get_bits_per_sample(enum AVCodecID codec_id);
4728 * Return the PCM codec associated with a sample format.
4729 * @param be endianness, 0 for little, 1 for big,
4730 * -1 (or anything else) for native
4731 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4733 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4736 * Return codec bits per sample.
4737 * Only return non-zero if the bits per sample is exactly correct, not an
4740 * @param[in] codec_id the codec
4741 * @return Number of bits per sample or zero if unknown for the given codec.
4743 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4746 * Return audio frame duration.
4748 * @param avctx codec context
4749 * @param frame_bytes size of the frame, or 0 if unknown
4750 * @return frame duration, in samples, if known. 0 if not able to
4753 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4756 typedef struct AVBitStreamFilterContext {
4758 struct AVBitStreamFilter *filter;
4759 AVCodecParserContext *parser;
4760 struct AVBitStreamFilterContext *next;
4761 } AVBitStreamFilterContext;
4764 typedef struct AVBitStreamFilter {
4767 int (*filter)(AVBitStreamFilterContext *bsfc,
4768 AVCodecContext *avctx, const char *args,
4769 uint8_t **poutbuf, int *poutbuf_size,
4770 const uint8_t *buf, int buf_size, int keyframe);
4771 void (*close)(AVBitStreamFilterContext *bsfc);
4772 struct AVBitStreamFilter *next;
4773 } AVBitStreamFilter;
4776 * Register a bitstream filter.
4778 * The filter will be accessible to the application code through
4779 * av_bitstream_filter_next() or can be directly initialized with
4780 * av_bitstream_filter_init().
4782 * @see avcodec_register_all()
4784 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4787 * Create and initialize a bitstream filter context given a bitstream
4790 * The returned context must be freed with av_bitstream_filter_close().
4792 * @param name the name of the bitstream filter
4793 * @return a bitstream filter context if a matching filter was found
4794 * and successfully initialized, NULL otherwise
4796 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4801 * This function filters the buffer buf with size buf_size, and places the
4802 * filtered buffer in the buffer pointed to by poutbuf.
4804 * The output buffer must be freed by the caller.
4806 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
4807 * @param avctx AVCodecContext accessed by the filter, may be NULL.
4808 * If specified, this must point to the encoder context of the
4809 * output stream the packet is sent to.
4810 * @param args arguments which specify the filter configuration, may be NULL
4811 * @param poutbuf pointer which is updated to point to the filtered buffer
4812 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
4813 * @param buf buffer containing the data to filter
4814 * @param buf_size size in bytes of buf
4815 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
4816 * @return >= 0 in case of success, or a negative error code in case of failure
4818 * If the return value is positive, an output buffer is allocated and
4819 * is availble in *poutbuf, and is distinct from the input buffer.
4821 * If the return value is 0, the output buffer is not allocated and
4822 * should be considered identical to the input buffer, or in case
4823 * *poutbuf was set it points to the input buffer (not necessarily to
4824 * its starting address).
4826 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4827 AVCodecContext *avctx, const char *args,
4828 uint8_t **poutbuf, int *poutbuf_size,
4829 const uint8_t *buf, int buf_size, int keyframe);
4832 * Release bitstream filter context.
4834 * @param bsf the bitstream filter context created with
4835 * av_bitstream_filter_init(), can be NULL
4837 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4840 * If f is NULL, return the first registered bitstream filter,
4841 * if f is non-NULL, return the next registered bitstream filter
4842 * after f, or NULL if f is the last one.
4844 * This function can be used to iterate over all registered bitstream
4847 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4852 * Reallocate the given block if it is not large enough, otherwise do nothing.
4856 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4859 * Allocate a buffer, reusing the given one if large enough.
4861 * Contrary to av_fast_realloc the current buffer contents might not be
4862 * preserved and on error the old buffer is freed, thus no special
4863 * handling to avoid memleaks is necessary.
4865 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4866 * @param size size of the buffer *ptr points to
4867 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4868 * *size 0 if an error occurred.
4870 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4873 * Same behaviour av_fast_malloc but the buffer has additional
4874 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
4876 * In addition the whole buffer will initially and after resizes
4877 * be 0-initialized so that no uninitialized data will ever appear.
4879 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4882 * Same behaviour av_fast_padded_malloc except that buffer will always
4883 * be 0-initialized after call.
4885 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4888 * Encode extradata length to a buffer. Used by xiph codecs.
4890 * @param s buffer to write to; must be at least (v/255+1) bytes long
4891 * @param v size of extradata in bytes
4892 * @return number of bytes written to the buffer.
4894 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4896 #if FF_API_MISSING_SAMPLE
4898 * Log a generic warning message about a missing feature. This function is
4899 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4900 * only, and would normally not be used by applications.
4901 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4902 * a pointer to an AVClass struct
4903 * @param[in] feature string containing the name of the missing feature
4904 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4905 * If want_sample is non-zero, additional verbage will be added to the log
4906 * message which tells the user how to report samples to the development
4908 * @deprecated Use avpriv_report_missing_feature() instead.
4910 attribute_deprecated
4911 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4914 * Log a generic warning message asking for a sample. This function is
4915 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4916 * only, and would normally not be used by applications.
4917 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4918 * a pointer to an AVClass struct
4919 * @param[in] msg string containing an optional message, or NULL if no message
4920 * @deprecated Use avpriv_request_sample() instead.
4922 attribute_deprecated
4923 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4924 #endif /* FF_API_MISSING_SAMPLE */
4927 * Register the hardware accelerator hwaccel.
4929 void av_register_hwaccel(AVHWAccel *hwaccel);
4932 * If hwaccel is NULL, returns the first registered hardware accelerator,
4933 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4934 * after hwaccel, or NULL if hwaccel is the last one.
4936 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4940 * Lock operation used by lockmgr
4943 AV_LOCK_CREATE, ///< Create a mutex
4944 AV_LOCK_OBTAIN, ///< Lock the mutex
4945 AV_LOCK_RELEASE, ///< Unlock the mutex
4946 AV_LOCK_DESTROY, ///< Free mutex resources
4950 * Register a user provided lock manager supporting the operations
4951 * specified by AVLockOp. mutex points to a (void *) where the
4952 * lockmgr should store/get a pointer to a user allocated mutex. It's
4953 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4955 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4956 * callback during the call to av_lockmgr_register().
4957 * Thus, the application must be prepared to handle that.
4958 * If cb is set to NULL the lockmgr will be unregistered.
4959 * Also note that during unregistration the previously registered
4960 * lockmgr callback may also be invoked.
4962 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4965 * Get the type of the given codec.
4967 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4970 * Get the name of a codec.
4971 * @return a static string identifying the codec; never NULL
4973 const char *avcodec_get_name(enum AVCodecID id);
4976 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4977 * with no corresponding avcodec_close()), 0 otherwise.
4979 int avcodec_is_open(AVCodecContext *s);
4982 * @return a non-zero number if codec is an encoder, zero otherwise
4984 int av_codec_is_encoder(const AVCodec *codec);
4987 * @return a non-zero number if codec is a decoder, zero otherwise
4989 int av_codec_is_decoder(const AVCodec *codec);
4992 * @return descriptor for given codec ID or NULL if no descriptor exists.
4994 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4997 * Iterate over all codec descriptors known to libavcodec.
4999 * @param prev previous descriptor. NULL to get the first descriptor.
5001 * @return next descriptor or NULL after the last descriptor
5003 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5006 * @return codec descriptor with the given name or NULL if no such descriptor
5009 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5015 #endif /* AVCODEC_AVCODEC_H */