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 #if FF_API_FAST_MALLOC
41 // to provide fast_*alloc
42 #include "libavutil/mem.h"
44 #include "libavutil/pixfmt.h"
45 #include "libavutil/rational.h"
50 * @defgroup libavc Encoding/Decoding Library
53 * @defgroup lavc_decoding Decoding
57 * @defgroup lavc_encoding Encoding
61 * @defgroup lavc_codec Codecs
63 * @defgroup lavc_codec_native Native Codecs
66 * @defgroup lavc_codec_wrappers External library wrappers
69 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
73 * @defgroup lavc_internal Internal
81 * @defgroup lavc_core Core functions/structures.
84 * Basic definitions, functions for querying libavcodec capabilities,
85 * allocating core structures, etc.
91 * Identify the syntax and semantics of the bitstream.
92 * The principle is roughly:
93 * Two decoders with the same ID can decode the same streams.
94 * Two encoders with the same ID can encode compatible streams.
95 * There may be slight deviations from the principle due to implementation
98 * If you add a codec ID to this list, add it so that
99 * 1. no value of a existing codec ID changes (that would break ABI),
100 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
101 * This ensures that 2 forks can independently add AVCodecIDs without producing conflicts.
103 * After adding new codec IDs, do not forget to add an entry to the codec
104 * descriptor list and bump libavcodec minor version.
110 AV_CODEC_ID_MPEG1VIDEO,
111 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
113 AV_CODEC_ID_MPEG2VIDEO_XVMC,
114 #endif /* FF_API_XVMC */
125 AV_CODEC_ID_RAWVIDEO,
126 AV_CODEC_ID_MSMPEG4V1,
127 AV_CODEC_ID_MSMPEG4V2,
128 AV_CODEC_ID_MSMPEG4V3,
151 AV_CODEC_ID_INTERPLAY_VIDEO,
158 AV_CODEC_ID_MSVIDEO1,
163 AV_CODEC_ID_TRUEMOTION1,
164 AV_CODEC_ID_VMDVIDEO,
189 AV_CODEC_ID_TRUEMOTION2,
195 AV_CODEC_ID_SMACKVIDEO,
200 AV_CODEC_ID_JPEG2000,
206 AV_CODEC_ID_DSICINVIDEO,
207 AV_CODEC_ID_TIERTEXSEQVIDEO,
215 AV_CODEC_ID_BETHSOFTVID,
227 AV_CODEC_ID_ESCAPE124,
231 AV_CODEC_ID_MOTIONPIXELS,
243 AV_CODEC_ID_FLASHSV2,
244 AV_CODEC_ID_CDGRAPHICS,
247 AV_CODEC_ID_BINKVIDEO,
248 AV_CODEC_ID_IFF_ILBM,
249 AV_CODEC_ID_IFF_BYTERUN1,
255 AV_CODEC_ID_A64_MULTI,
256 AV_CODEC_ID_A64_MULTI5,
259 AV_CODEC_ID_LAGARITH,
263 AV_CODEC_ID_WMV3IMAGE,
264 AV_CODEC_ID_VC1IMAGE,
266 AV_CODEC_ID_BMV_VIDEO,
273 AV_CODEC_ID_ZEROCODEC,
282 AV_CODEC_ID_ESCAPE130_DEPRECATED,
283 AV_CODEC_ID_G2M_DEPRECATED,
284 AV_CODEC_ID_WEBP_DEPRECATED,
285 AV_CODEC_ID_HNM4_VIDEO,
286 AV_CODEC_ID_HEVC_DEPRECATED,
288 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
289 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
290 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
291 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
292 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
294 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
295 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
296 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
297 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
298 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
299 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
300 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
301 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
302 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
303 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
304 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
305 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
306 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
307 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
308 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
309 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
310 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
311 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
312 AV_CODEC_ID_SMVJPEG = MKBETAG('S','M','V','J'),
313 AV_CODEC_ID_HEVC = MKBETAG('H','2','6','5'),
314 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
316 /* various PCM "codecs" */
317 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
318 AV_CODEC_ID_PCM_S16LE = 0x10000,
319 AV_CODEC_ID_PCM_S16BE,
320 AV_CODEC_ID_PCM_U16LE,
321 AV_CODEC_ID_PCM_U16BE,
324 AV_CODEC_ID_PCM_MULAW,
325 AV_CODEC_ID_PCM_ALAW,
326 AV_CODEC_ID_PCM_S32LE,
327 AV_CODEC_ID_PCM_S32BE,
328 AV_CODEC_ID_PCM_U32LE,
329 AV_CODEC_ID_PCM_U32BE,
330 AV_CODEC_ID_PCM_S24LE,
331 AV_CODEC_ID_PCM_S24BE,
332 AV_CODEC_ID_PCM_U24LE,
333 AV_CODEC_ID_PCM_U24BE,
334 AV_CODEC_ID_PCM_S24DAUD,
335 AV_CODEC_ID_PCM_ZORK,
336 AV_CODEC_ID_PCM_S16LE_PLANAR,
338 AV_CODEC_ID_PCM_F32BE,
339 AV_CODEC_ID_PCM_F32LE,
340 AV_CODEC_ID_PCM_F64BE,
341 AV_CODEC_ID_PCM_F64LE,
342 AV_CODEC_ID_PCM_BLURAY,
345 AV_CODEC_ID_PCM_S8_PLANAR,
346 AV_CODEC_ID_PCM_S24LE_PLANAR_DEPRECATED,
347 AV_CODEC_ID_PCM_S32LE_PLANAR_DEPRECATED,
348 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
349 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
350 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
352 /* various ADPCM codecs */
353 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
354 AV_CODEC_ID_ADPCM_IMA_WAV,
355 AV_CODEC_ID_ADPCM_IMA_DK3,
356 AV_CODEC_ID_ADPCM_IMA_DK4,
357 AV_CODEC_ID_ADPCM_IMA_WS,
358 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
359 AV_CODEC_ID_ADPCM_MS,
360 AV_CODEC_ID_ADPCM_4XM,
361 AV_CODEC_ID_ADPCM_XA,
362 AV_CODEC_ID_ADPCM_ADX,
363 AV_CODEC_ID_ADPCM_EA,
364 AV_CODEC_ID_ADPCM_G726,
365 AV_CODEC_ID_ADPCM_CT,
366 AV_CODEC_ID_ADPCM_SWF,
367 AV_CODEC_ID_ADPCM_YAMAHA,
368 AV_CODEC_ID_ADPCM_SBPRO_4,
369 AV_CODEC_ID_ADPCM_SBPRO_3,
370 AV_CODEC_ID_ADPCM_SBPRO_2,
371 AV_CODEC_ID_ADPCM_THP,
372 AV_CODEC_ID_ADPCM_IMA_AMV,
373 AV_CODEC_ID_ADPCM_EA_R1,
374 AV_CODEC_ID_ADPCM_EA_R3,
375 AV_CODEC_ID_ADPCM_EA_R2,
376 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
377 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
378 AV_CODEC_ID_ADPCM_EA_XAS,
379 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
380 AV_CODEC_ID_ADPCM_IMA_ISS,
381 AV_CODEC_ID_ADPCM_G722,
382 AV_CODEC_ID_ADPCM_IMA_APC,
383 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
384 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
385 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
386 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
387 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
388 AV_CODEC_ID_ADPCM_G726LE = MKBETAG('6','2','7','G'),
391 AV_CODEC_ID_AMR_NB = 0x12000,
394 /* RealAudio codecs*/
395 AV_CODEC_ID_RA_144 = 0x13000,
398 /* various DPCM codecs */
399 AV_CODEC_ID_ROQ_DPCM = 0x14000,
400 AV_CODEC_ID_INTERPLAY_DPCM,
401 AV_CODEC_ID_XAN_DPCM,
402 AV_CODEC_ID_SOL_DPCM,
405 AV_CODEC_ID_MP2 = 0x15000,
406 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
416 AV_CODEC_ID_VMDAUDIO,
422 AV_CODEC_ID_WESTWOOD_SND1,
423 AV_CODEC_ID_GSM, ///< as in Berlin toast format
426 AV_CODEC_ID_TRUESPEECH,
428 AV_CODEC_ID_SMACKAUDIO,
431 AV_CODEC_ID_DSICINAUDIO,
433 AV_CODEC_ID_MUSEPACK7,
435 AV_CODEC_ID_GSM_MS, /* as found in WAV */
441 AV_CODEC_ID_NELLYMOSER,
442 AV_CODEC_ID_MUSEPACK8,
444 AV_CODEC_ID_WMAVOICE,
446 AV_CODEC_ID_WMALOSSLESS,
455 AV_CODEC_ID_BINKAUDIO_RDFT,
456 AV_CODEC_ID_BINKAUDIO_DCT,
457 AV_CODEC_ID_AAC_LATM,
462 AV_CODEC_ID_8SVX_EXP,
463 AV_CODEC_ID_8SVX_FIB,
464 AV_CODEC_ID_BMV_AUDIO,
468 AV_CODEC_ID_OPUS_DEPRECATED,
469 AV_CODEC_ID_COMFORT_NOISE,
470 AV_CODEC_ID_TAK_DEPRECATED,
471 AV_CODEC_ID_METASOUND,
472 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
473 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
474 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
475 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
476 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
477 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
478 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
479 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
481 /* subtitle codecs */
482 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
483 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
484 AV_CODEC_ID_DVB_SUBTITLE,
485 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
488 AV_CODEC_ID_MOV_TEXT,
489 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
490 AV_CODEC_ID_DVB_TELETEXT,
492 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
493 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
494 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
495 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
496 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
497 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
498 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
499 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
500 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
501 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
502 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
503 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
504 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
506 /* other specific kind of codecs (generally used for attachments) */
507 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
508 AV_CODEC_ID_TTF = 0x18000,
509 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
510 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
511 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
512 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
513 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
514 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
517 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
519 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
520 * stream (only used by libavformat) */
521 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
522 * stream (only used by libavformat) */
523 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
526 #include "old_codec_ids.h"
531 * This struct describes the properties of a single codec described by an
533 * @see avcodec_get_descriptor()
535 typedef struct AVCodecDescriptor {
537 enum AVMediaType type;
539 * Name of the codec described by this descriptor. It is non-empty and
540 * unique for each codec descriptor. It should contain alphanumeric
541 * characters and '_' only.
545 * A more descriptive name for this codec. May be NULL.
547 const char *long_name;
549 * Codec properties, a combination of AV_CODEC_PROP_* flags.
555 * Codec uses only intra compression.
558 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
560 * Codec supports lossy compression. Audio and video codecs only.
561 * @note a codec may support both lossy and lossless
564 #define AV_CODEC_PROP_LOSSY (1 << 1)
566 * Codec supports lossless compression. Audio and video codecs only.
568 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
570 * Subtitle codec is bitmap based
571 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
573 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
575 * Subtitle codec is text based.
576 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
578 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
581 * @ingroup lavc_decoding
582 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
583 * This is mainly needed because some optimized bitstream readers read
584 * 32 or 64 bit at once and could read over the end.<br>
585 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
586 * MPEG bitstreams could cause overread and segfault.
588 #define FF_INPUT_BUFFER_PADDING_SIZE 16
591 * @ingroup lavc_encoding
592 * minimum encoding buffer size
593 * Used to avoid some checks during header writing.
595 #define FF_MIN_BUFFER_SIZE 16384
599 * @ingroup lavc_encoding
600 * motion estimation type.
603 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
607 ME_EPZS, ///< enhanced predictive zonal search
608 ME_X1, ///< reserved for experiments
609 ME_HEX, ///< hexagon based search
610 ME_UMH, ///< uneven multi-hexagon search
611 ME_TESA, ///< transformed exhaustive search algorithm
612 ME_ITER=50, ///< iterative search
616 * @ingroup lavc_decoding
619 /* We leave some space between them for extensions (drop some
620 * keyframes for intra-only or drop just some bidir frames). */
621 AVDISCARD_NONE =-16, ///< discard nothing
622 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
623 AVDISCARD_NONREF = 8, ///< discard all non reference
624 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
625 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
626 AVDISCARD_ALL = 48, ///< discard all
629 enum AVColorPrimaries{
630 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
631 AVCOL_PRI_UNSPECIFIED = 2,
632 AVCOL_PRI_BT470M = 4,
633 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
634 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
635 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
637 AVCOL_PRI_BT2020 = 9, ///< ITU-R BT2020
638 AVCOL_PRI_NB , ///< Not part of ABI
641 enum AVColorTransferCharacteristic{
642 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
643 AVCOL_TRC_UNSPECIFIED = 2,
644 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
645 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
646 AVCOL_TRC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 or 625 / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC
647 AVCOL_TRC_SMPTE240M = 7,
648 AVCOL_TRC_LINEAR = 8, ///< "Linear transfer characteristics"
649 AVCOL_TRC_LOG = 9, ///< "Logarithmic transfer characteristic (100:1 range)"
650 AVCOL_TRC_LOG_SQRT = 10, ///< "Logarithmic transfer characteristic (100 * Sqrt( 10 ) : 1 range)"
651 AVCOL_TRC_IEC61966_2_4 = 11, ///< IEC 61966-2-4
652 AVCOL_TRC_BT1361_ECG = 12, ///< ITU-R BT1361 Extended Colour Gamut
653 AVCOL_TRC_IEC61966_2_1 = 13, ///< IEC 61966-2-1 (sRGB or sYCC)
654 AVCOL_TRC_BT2020_10 = 14, ///< ITU-R BT2020 for 10 bit system
655 AVCOL_TRC_BT2020_12 = 15, ///< ITU-R BT2020 for 12 bit system
656 AVCOL_TRC_NB , ///< Not part of ABI
660 * X X 3 4 X X are luma samples,
661 * 1 2 1-6 are possible chroma positions
662 * X X 5 6 X 0 is undefined/unknown position
664 enum AVChromaLocation{
665 AVCHROMA_LOC_UNSPECIFIED = 0,
666 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
667 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
668 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
669 AVCHROMA_LOC_TOP = 4,
670 AVCHROMA_LOC_BOTTOMLEFT = 5,
671 AVCHROMA_LOC_BOTTOM = 6,
672 AVCHROMA_LOC_NB , ///< Not part of ABI
675 enum AVAudioServiceType {
676 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
677 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
678 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
679 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
680 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
681 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
682 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
683 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
684 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
685 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
689 * @ingroup lavc_encoding
691 typedef struct RcOverride{
694 int qscale; // If this is 0 then quality_factor will be used instead.
695 float quality_factor;
698 #if FF_API_MAX_BFRAMES
700 * @deprecated there is no libavcodec-wide limit on the number of B-frames
702 #define FF_MAX_B_FRAMES 16
706 These flags can be passed in AVCodecContext.flags before initialization.
707 Note: Not everything is supported yet.
711 * Allow decoders to produce frames with data planes that are not aligned
712 * to CPU requirements (e.g. due to cropping).
714 #define CODEC_FLAG_UNALIGNED 0x0001
715 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
716 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
717 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
718 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
719 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
720 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
722 * The parent program guarantees that the input for B-frames containing
723 * streams is not written to for at least s->max_b_frames+1 frames, if
724 * this is not set the input will be copied.
726 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
727 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
728 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
729 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
730 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
731 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
732 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
733 location instead of only at frame boundaries. */
734 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
735 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
736 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
737 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
738 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
739 /* Fx : Flag for h263+ extra options */
740 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
741 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
742 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
743 #define CODEC_FLAG_CLOSED_GOP 0x80000000
744 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
745 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
746 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
747 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
748 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
750 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
751 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
753 /* Unsupported options :
754 * Syntax Arithmetic coding (SAC)
755 * Reference Picture Selection
756 * Independent Segment Decoding */
758 /* codec capabilities */
760 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
762 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
763 * If not set, it might not use get_buffer() at all or use operations that
764 * assume the buffer was allocated by avcodec_default_get_buffer.
766 #define CODEC_CAP_DR1 0x0002
767 #define CODEC_CAP_TRUNCATED 0x0008
769 /* Codec can export data for HW decoding (XvMC). */
770 #define CODEC_CAP_HWACCEL 0x0010
771 #endif /* FF_API_XVMC */
773 * Encoder or decoder requires flushing with NULL input at the end in order to
774 * give the complete and correct output.
776 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
777 * with NULL data. The user can still send NULL data to the public encode
778 * or decode function, but libavcodec will not pass it along to the codec
779 * unless this flag is set.
782 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
783 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
787 * The encoder needs to be fed with NULL data at the end of encoding until the
788 * encoder no longer returns data.
790 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
791 * flag also means that the encoder must set the pts and duration for
792 * each output packet. If this flag is not set, the pts and duration will
793 * be determined by libavcodec from the input frame.
795 #define CODEC_CAP_DELAY 0x0020
797 * Codec can be fed a final frame with a smaller size.
798 * This can be used to prevent truncation of the last audio samples.
800 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
803 * Codec can export data for HW decoding (VDPAU).
805 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
808 * Codec can output multiple frames per AVPacket
809 * Normally demuxers return one frame at a time, demuxers which do not do
810 * are connected to a parser to split what they return into proper frames.
811 * This flag is reserved to the very rare category of codecs which have a
812 * bitstream that cannot be split into frames without timeconsuming
813 * operations like full decoding. Demuxers carring such bitstreams thus
814 * may return multiple frames in a packet. This has many disadvantages like
815 * prohibiting stream copy in many cases thus it should only be considered
818 #define CODEC_CAP_SUBFRAMES 0x0100
820 * Codec is experimental and is thus avoided in favor of non experimental
823 #define CODEC_CAP_EXPERIMENTAL 0x0200
825 * Codec should fill in channel configuration and samplerate instead of container
827 #define CODEC_CAP_CHANNEL_CONF 0x0400
828 #if FF_API_NEG_LINESIZES
830 * @deprecated no codecs use this capability
832 #define CODEC_CAP_NEG_LINESIZES 0x0800
835 * Codec supports frame-level multithreading.
837 #define CODEC_CAP_FRAME_THREADS 0x1000
839 * Codec supports slice-based (or partition-based) multithreading.
841 #define CODEC_CAP_SLICE_THREADS 0x2000
843 * Codec supports changed parameters at any point.
845 #define CODEC_CAP_PARAM_CHANGE 0x4000
847 * Codec supports avctx->thread_count == 0 (auto).
849 #define CODEC_CAP_AUTO_THREADS 0x8000
851 * Audio encoder supports receiving a different number of samples in each call.
853 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
855 * Codec is intra only.
857 #define CODEC_CAP_INTRA_ONLY 0x40000000
861 #define CODEC_CAP_LOSSLESS 0x80000000
864 //The following defines may change, don't expect compatibility if you use them.
865 #define MB_TYPE_INTRA4x4 0x0001
866 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
867 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
868 #define MB_TYPE_16x16 0x0008
869 #define MB_TYPE_16x8 0x0010
870 #define MB_TYPE_8x16 0x0020
871 #define MB_TYPE_8x8 0x0040
872 #define MB_TYPE_INTERLACED 0x0080
873 #define MB_TYPE_DIRECT2 0x0100 //FIXME
874 #define MB_TYPE_ACPRED 0x0200
875 #define MB_TYPE_GMC 0x0400
876 #define MB_TYPE_SKIP 0x0800
877 #define MB_TYPE_P0L0 0x1000
878 #define MB_TYPE_P1L0 0x2000
879 #define MB_TYPE_P0L1 0x4000
880 #define MB_TYPE_P1L1 0x8000
881 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
882 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
883 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
884 #define MB_TYPE_QUANT 0x00010000
885 #define MB_TYPE_CBP 0x00020000
886 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
891 * This specifies the area which should be displayed.
892 * Note there may be multiple such areas for one frame.
894 typedef struct AVPanScan{
897 * - encoding: Set by user.
898 * - decoding: Set by libavcodec.
903 * width and height in 1/16 pel
904 * - encoding: Set by user.
905 * - decoding: Set by libavcodec.
911 * position of the top left corner in 1/16 pel for up to 3 fields/frames
912 * - encoding: Set by user.
913 * - decoding: Set by libavcodec.
915 int16_t position[3][2];
918 #if FF_API_QSCALE_TYPE
919 #define FF_QSCALE_TYPE_MPEG1 0
920 #define FF_QSCALE_TYPE_MPEG2 1
921 #define FF_QSCALE_TYPE_H264 2
922 #define FF_QSCALE_TYPE_VP56 3
925 #if FF_API_GET_BUFFER
926 #define FF_BUFFER_TYPE_INTERNAL 1
927 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
928 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
929 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
931 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
932 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
933 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
934 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
938 * The decoder will keep a reference to the frame and may reuse it later.
940 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
943 * @defgroup lavc_packet AVPacket
945 * Types and functions for working with AVPacket.
948 enum AVPacketSideDataType {
950 AV_PKT_DATA_NEW_EXTRADATA,
953 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
956 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
957 * s32le channel_count
958 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
959 * u64le channel_layout
960 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
962 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
967 AV_PKT_DATA_PARAM_CHANGE,
970 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
971 * structures with info about macroblocks relevant to splitting the
972 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
973 * That is, it does not necessarily contain info about all macroblocks,
974 * as long as the distance between macroblocks in the info is smaller
975 * than the target payload size.
976 * Each MB info structure is 12 bytes, and is laid out as follows:
978 * u32le bit offset from the start of the packet
979 * u8 current quantizer at the start of the macroblock
981 * u16le macroblock address within the GOB
982 * u8 horizontal MV predictor
983 * u8 vertical MV predictor
984 * u8 horizontal MV predictor for block number 3
985 * u8 vertical MV predictor for block number 3
988 AV_PKT_DATA_H263_MB_INFO,
991 * Recommmends skipping the specified number of samples
993 * u32le number of samples to skip from start of this packet
994 * u32le number of samples to skip from end of this packet
995 * u8 reason for start skip
996 * u8 reason for end skip (0=padding silence, 1=convergence)
999 AV_PKT_DATA_SKIP_SAMPLES=70,
1002 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1003 * the packet may contain "dual mono" audio specific to Japanese DTV
1004 * and if it is true, recommends only the selected channel to be used.
1006 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1009 AV_PKT_DATA_JP_DUALMONO,
1012 * A list of zero terminated key/value strings. There is no end marker for
1013 * the list, so it is required to rely on the side data size to stop.
1015 AV_PKT_DATA_STRINGS_METADATA,
1018 * Subtitle event position
1026 AV_PKT_DATA_SUBTITLE_POSITION,
1029 * Data found in BlockAdditional element of matroska container. There is
1030 * no end marker for the data, so it is required to rely on the side data
1031 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1034 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1037 * The optional first identifier line of a WebVTT cue.
1039 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1042 * The optional settings (rendering instructions) that immediately
1043 * follow the timestamp specifier of a WebVTT cue.
1045 AV_PKT_DATA_WEBVTT_SETTINGS,
1049 * This structure stores compressed data. It is typically exported by demuxers
1050 * and then passed as input to decoders, or received as output from encoders and
1051 * then passed to muxers.
1053 * For video, it should typically contain one compressed frame. For audio it may
1054 * contain several compressed frames.
1056 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1057 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1058 * without libavcodec and libavformat major bump.
1060 * The semantics of data ownership depends on the buf or destruct (deprecated)
1061 * fields. If either is set, the packet data is dynamically allocated and is
1062 * valid indefinitely until av_free_packet() is called (which in turn calls
1063 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1064 * the packet data is typically backed by some static buffer somewhere and is
1065 * only valid for a limited time (e.g. until the next read call when demuxing).
1067 * The side data is always allocated with av_malloc() and is freed in
1070 typedef struct AVPacket {
1072 * A reference to the reference-counted buffer where the packet data is
1074 * May be NULL, then the packet data is not reference-counted.
1078 * Presentation timestamp in AVStream->time_base units; the time at which
1079 * the decompressed packet will be presented to the user.
1080 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1081 * pts MUST be larger or equal to dts as presentation cannot happen before
1082 * decompression, unless one wants to view hex dumps. Some formats misuse
1083 * the terms dts and pts/cts to mean something different. Such timestamps
1084 * must be converted to true pts/dts before they are stored in AVPacket.
1088 * Decompression timestamp in AVStream->time_base units; the time at which
1089 * the packet is decompressed.
1090 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1097 * A combination of AV_PKT_FLAG values
1101 * Additional packet data that can be provided by the container.
1102 * Packet can contain several types of side information.
1107 enum AVPacketSideDataType type;
1109 int side_data_elems;
1112 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1113 * Equals next_pts - this_pts in presentation order.
1116 #if FF_API_DESTRUCT_PACKET
1117 attribute_deprecated
1118 void (*destruct)(struct AVPacket *);
1119 attribute_deprecated
1122 int64_t pos; ///< byte position in stream, -1 if unknown
1125 * Time difference in AVStream->time_base units from the pts of this
1126 * packet to the point at which the output from the decoder has converged
1127 * independent from the availability of previous frames. That is, the
1128 * frames are virtually identical no matter if decoding started from
1129 * the very first frame or from this keyframe.
1130 * Is AV_NOPTS_VALUE if unknown.
1131 * This field is not the display duration of the current packet.
1132 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1135 * The purpose of this field is to allow seeking in streams that have no
1136 * keyframes in the conventional sense. It corresponds to the
1137 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1138 * essential for some types of subtitle streams to ensure that all
1139 * subtitles are correctly displayed after seeking.
1141 int64_t convergence_duration;
1143 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1144 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1146 enum AVSideDataParamChangeFlags {
1147 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1148 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1149 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1150 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1156 struct AVCodecInternal;
1160 AV_FIELD_PROGRESSIVE,
1161 AV_FIELD_TT, //< Top coded_first, top displayed first
1162 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1163 AV_FIELD_TB, //< Top coded first, bottom displayed first
1164 AV_FIELD_BT, //< Bottom coded first, top displayed first
1168 * main external API structure.
1169 * New fields can be added to the end with minor version bumps.
1170 * Removal, reordering and changes to existing fields require a major
1172 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1174 * sizeof(AVCodecContext) must not be used outside libav*.
1176 typedef struct AVCodecContext {
1178 * information on struct for av_log
1179 * - set by avcodec_alloc_context3
1181 const AVClass *av_class;
1182 int log_level_offset;
1184 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1185 const struct AVCodec *codec;
1186 char codec_name[32];
1187 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1190 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1191 * This is used to work around some encoder bugs.
1192 * A demuxer should set this to what is stored in the field used to identify the codec.
1193 * If there are multiple such fields in a container then the demuxer should choose the one
1194 * which maximizes the information about the used codec.
1195 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1196 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1197 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1199 * - encoding: Set by user, if not then the default based on codec_id will be used.
1200 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1202 unsigned int codec_tag;
1205 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1206 * This is used to work around some encoder bugs.
1207 * - encoding: unused
1208 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1210 unsigned int stream_codec_tag;
1215 * Private context used for internal data.
1217 * Unlike priv_data, this is not codec-specific. It is used in general
1218 * libavcodec functions.
1220 struct AVCodecInternal *internal;
1223 * Private data of the user, can be used to carry app specific stuff.
1224 * - encoding: Set by user.
1225 * - decoding: Set by user.
1230 * the average bitrate
1231 * - encoding: Set by user; unused for constant quantizer encoding.
1232 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1237 * number of bits the bitstream is allowed to diverge from the reference.
1238 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1239 * - encoding: Set by user; unused for constant quantizer encoding.
1240 * - decoding: unused
1242 int bit_rate_tolerance;
1245 * Global quality for codecs which cannot change it per frame.
1246 * This should be proportional to MPEG-1/2/4 qscale.
1247 * - encoding: Set by user.
1248 * - decoding: unused
1253 * - encoding: Set by user.
1254 * - decoding: unused
1256 int compression_level;
1257 #define FF_COMPRESSION_DEFAULT -1
1261 * - encoding: Set by user.
1262 * - decoding: Set by user.
1268 * - encoding: Set by user.
1269 * - decoding: Set by user.
1274 * some codecs need / can use extradata like Huffman tables.
1275 * mjpeg: Huffman tables
1276 * rv10: additional flags
1277 * mpeg4: global headers (they can be in the bitstream or here)
1278 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1279 * than extradata_size to avoid problems if it is read with the bitstream reader.
1280 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1281 * - encoding: Set/allocated/freed by libavcodec.
1282 * - decoding: Set/allocated/freed by user.
1288 * This is the fundamental unit of time (in seconds) in terms
1289 * of which frame timestamps are represented. For fixed-fps content,
1290 * timebase should be 1/framerate and timestamp increments should be
1292 * - encoding: MUST be set by user.
1293 * - decoding: Set by libavcodec.
1295 AVRational time_base;
1298 * For some codecs, the time base is closer to the field rate than the frame rate.
1299 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1300 * if no telecine is used ...
1302 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1304 int ticks_per_frame;
1309 * Encoding: Number of frames delay there will be from the encoder input to
1310 * the decoder output. (we assume the decoder matches the spec)
1311 * Decoding: Number of frames delay in addition to what a standard decoder
1312 * as specified in the spec would produce.
1315 * Number of frames the decoded output will be delayed relative to the
1319 * For encoding, this is the number of "priming" samples added to the
1320 * beginning of the stream. The decoded output will be delayed by this
1321 * many samples relative to the input to the encoder. Note that this
1322 * field is purely informational and does not directly affect the pts
1323 * output by the encoder, which should always be based on the actual
1324 * presentation time, including any delay.
1325 * For decoding, this is the number of samples the decoder needs to
1326 * output before the decoder's output is valid. When seeking, you should
1327 * start decoding this many samples prior to your desired seek point.
1329 * - encoding: Set by libavcodec.
1330 * - decoding: Set by libavcodec.
1337 * picture width / height.
1338 * - encoding: MUST be set by user.
1339 * - decoding: May be set by the user before opening the decoder if known e.g.
1340 * from the container. Some decoders will require the dimensions
1341 * to be set by the caller. During decoding, the decoder may
1342 * overwrite those values as required.
1347 * Bitstream width / height, may be different from width/height e.g. when
1348 * the decoded frame is cropped before being output or lowres is enabled.
1349 * - encoding: unused
1350 * - decoding: May be set by the user before opening the decoder if known
1351 * e.g. from the container. During decoding, the decoder may
1352 * overwrite those values as required.
1354 int coded_width, coded_height;
1356 #if FF_API_ASPECT_EXTENDED
1357 #define FF_ASPECT_EXTENDED 15
1361 * the number of pictures in a group of pictures, or 0 for intra_only
1362 * - encoding: Set by user.
1363 * - decoding: unused
1368 * Pixel format, see AV_PIX_FMT_xxx.
1369 * May be set by the demuxer if known from headers.
1370 * May be overridden by the decoder if it knows better.
1371 * - encoding: Set by user.
1372 * - decoding: Set by user if known, overridden by libavcodec if known
1374 enum AVPixelFormat pix_fmt;
1377 * Motion estimation algorithm used for video coding.
1378 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1379 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1380 * - encoding: MUST be set by user.
1381 * - decoding: unused
1386 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1387 * decoder to draw a horizontal band. It improves cache usage. Not
1388 * all codecs can do that. You must check the codec capabilities
1390 * When multithreading is used, it may be called from multiple threads
1391 * at the same time; threads might draw different parts of the same AVFrame,
1392 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1394 * The function is also used by hardware acceleration APIs.
1395 * It is called at least once during frame decoding to pass
1396 * the data needed for hardware render.
1397 * In that mode instead of pixel data, AVFrame points to
1398 * a structure specific to the acceleration API. The application
1399 * reads the structure and can change some fields to indicate progress
1401 * - encoding: unused
1402 * - decoding: Set by user.
1403 * @param height the height of the slice
1404 * @param y the y position of the slice
1405 * @param type 1->top field, 2->bottom field, 3->frame
1406 * @param offset offset into the AVFrame.data from which the slice should be read
1408 void (*draw_horiz_band)(struct AVCodecContext *s,
1409 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1410 int y, int type, int height);
1413 * callback to negotiate the pixelFormat
1414 * @param fmt is the list of formats which are supported by the codec,
1415 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1416 * The first is always the native one.
1417 * @return the chosen format
1418 * - encoding: unused
1419 * - decoding: Set by user, if not set the native format will be chosen.
1421 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1424 * maximum number of B-frames between non-B-frames
1425 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1426 * - encoding: Set by user.
1427 * - decoding: unused
1432 * qscale factor between IP and B-frames
1433 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1434 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1435 * - encoding: Set by user.
1436 * - decoding: unused
1438 float b_quant_factor;
1440 /** obsolete FIXME remove */
1442 #define FF_RC_STRATEGY_XVID 1
1444 int b_frame_strategy;
1447 * qscale offset between IP and B-frames
1448 * - encoding: Set by user.
1449 * - decoding: unused
1451 float b_quant_offset;
1454 * Size of the frame reordering buffer in the decoder.
1455 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1456 * - encoding: Set by libavcodec.
1457 * - decoding: Set by libavcodec.
1462 * 0-> h263 quant 1-> mpeg quant
1463 * - encoding: Set by user.
1464 * - decoding: unused
1469 * qscale factor between P and I-frames
1470 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1471 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1472 * - encoding: Set by user.
1473 * - decoding: unused
1475 float i_quant_factor;
1478 * qscale offset between P and I-frames
1479 * - encoding: Set by user.
1480 * - decoding: unused
1482 float i_quant_offset;
1485 * luminance masking (0-> disabled)
1486 * - encoding: Set by user.
1487 * - decoding: unused
1492 * temporary complexity masking (0-> disabled)
1493 * - encoding: Set by user.
1494 * - decoding: unused
1496 float temporal_cplx_masking;
1499 * spatial complexity masking (0-> disabled)
1500 * - encoding: Set by user.
1501 * - decoding: unused
1503 float spatial_cplx_masking;
1506 * p block masking (0-> disabled)
1507 * - encoding: Set by user.
1508 * - decoding: unused
1513 * darkness masking (0-> disabled)
1514 * - encoding: Set by user.
1515 * - decoding: unused
1521 * - encoding: Set by libavcodec.
1522 * - decoding: Set by user (or 0).
1526 * prediction method (needed for huffyuv)
1527 * - encoding: Set by user.
1528 * - decoding: unused
1530 int prediction_method;
1531 #define FF_PRED_LEFT 0
1532 #define FF_PRED_PLANE 1
1533 #define FF_PRED_MEDIAN 2
1536 * slice offsets in the frame in bytes
1537 * - encoding: Set/allocated by libavcodec.
1538 * - decoding: Set/allocated by user (or NULL).
1543 * sample aspect ratio (0 if unknown)
1544 * That is the width of a pixel divided by the height of the pixel.
1545 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1546 * - encoding: Set by user.
1547 * - decoding: Set by libavcodec.
1549 AVRational sample_aspect_ratio;
1552 * motion estimation comparison function
1553 * - encoding: Set by user.
1554 * - decoding: unused
1558 * subpixel motion estimation comparison function
1559 * - encoding: Set by user.
1560 * - decoding: unused
1564 * macroblock comparison function (not supported yet)
1565 * - encoding: Set by user.
1566 * - decoding: unused
1570 * interlaced DCT comparison function
1571 * - encoding: Set by user.
1572 * - decoding: unused
1575 #define FF_CMP_SAD 0
1576 #define FF_CMP_SSE 1
1577 #define FF_CMP_SATD 2
1578 #define FF_CMP_DCT 3
1579 #define FF_CMP_PSNR 4
1580 #define FF_CMP_BIT 5
1582 #define FF_CMP_ZERO 7
1583 #define FF_CMP_VSAD 8
1584 #define FF_CMP_VSSE 9
1585 #define FF_CMP_NSSE 10
1586 #define FF_CMP_W53 11
1587 #define FF_CMP_W97 12
1588 #define FF_CMP_DCTMAX 13
1589 #define FF_CMP_DCT264 14
1590 #define FF_CMP_CHROMA 256
1593 * ME diamond size & shape
1594 * - encoding: Set by user.
1595 * - decoding: unused
1600 * amount of previous MV predictors (2a+1 x 2a+1 square)
1601 * - encoding: Set by user.
1602 * - decoding: unused
1604 int last_predictor_count;
1607 * prepass for motion estimation
1608 * - encoding: Set by user.
1609 * - decoding: unused
1614 * motion estimation prepass comparison function
1615 * - encoding: Set by user.
1616 * - decoding: unused
1621 * ME prepass diamond size & shape
1622 * - encoding: Set by user.
1623 * - decoding: unused
1629 * - encoding: Set by user.
1630 * - decoding: unused
1632 int me_subpel_quality;
1635 * DTG active format information (additional aspect ratio
1636 * information only used in DVB MPEG-2 transport streams)
1639 * - encoding: unused
1640 * - decoding: Set by decoder.
1642 int dtg_active_format;
1643 #define FF_DTG_AFD_SAME 8
1644 #define FF_DTG_AFD_4_3 9
1645 #define FF_DTG_AFD_16_9 10
1646 #define FF_DTG_AFD_14_9 11
1647 #define FF_DTG_AFD_4_3_SP_14_9 13
1648 #define FF_DTG_AFD_16_9_SP_14_9 14
1649 #define FF_DTG_AFD_SP_4_3 15
1652 * maximum motion estimation search range in subpel units
1653 * If 0 then no limit.
1655 * - encoding: Set by user.
1656 * - decoding: unused
1661 * intra quantizer bias
1662 * - encoding: Set by user.
1663 * - decoding: unused
1665 int intra_quant_bias;
1666 #define FF_DEFAULT_QUANT_BIAS 999999
1669 * inter quantizer bias
1670 * - encoding: Set by user.
1671 * - decoding: unused
1673 int inter_quant_bias;
1677 * - encoding: unused
1678 * - decoding: Set by user.
1681 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1682 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1683 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1687 * XVideo Motion Acceleration
1688 * - encoding: forbidden
1689 * - decoding: set by decoder
1690 * @deprecated XvMC support is slated for removal.
1692 attribute_deprecated int xvmc_acceleration;
1693 #endif /* FF_API_XVMC */
1696 * macroblock decision mode
1697 * - encoding: Set by user.
1698 * - decoding: unused
1701 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1702 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1703 #define FF_MB_DECISION_RD 2 ///< rate distortion
1706 * custom intra quantization matrix
1707 * - encoding: Set by user, can be NULL.
1708 * - decoding: Set by libavcodec.
1710 uint16_t *intra_matrix;
1713 * custom inter quantization matrix
1714 * - encoding: Set by user, can be NULL.
1715 * - decoding: Set by libavcodec.
1717 uint16_t *inter_matrix;
1720 * scene change detection threshold
1721 * 0 is default, larger means fewer detected scene changes.
1722 * - encoding: Set by user.
1723 * - decoding: unused
1725 int scenechange_threshold;
1728 * noise reduction strength
1729 * - encoding: Set by user.
1730 * - decoding: unused
1732 int noise_reduction;
1735 * Motion estimation threshold below which no motion estimation is
1736 * performed, but instead the user specified motion vectors are used.
1738 * - encoding: Set by user.
1739 * - decoding: unused
1744 * Macroblock threshold below which the user specified macroblock types will be used.
1745 * - encoding: Set by user.
1746 * - decoding: unused
1751 * precision of the intra DC coefficient - 8
1752 * - encoding: Set by user.
1753 * - decoding: unused
1755 int intra_dc_precision;
1758 * Number of macroblock rows at the top which are skipped.
1759 * - encoding: unused
1760 * - decoding: Set by user.
1765 * Number of macroblock rows at the bottom which are skipped.
1766 * - encoding: unused
1767 * - decoding: Set by user.
1772 * Border processing masking, raises the quantizer for mbs on the borders
1774 * - encoding: Set by user.
1775 * - decoding: unused
1777 float border_masking;
1780 * minimum MB lagrange multipler
1781 * - encoding: Set by user.
1782 * - decoding: unused
1787 * maximum MB lagrange multipler
1788 * - encoding: Set by user.
1789 * - decoding: unused
1795 * - encoding: Set by user.
1796 * - decoding: unused
1798 int me_penalty_compensation;
1802 * - encoding: Set by user.
1803 * - decoding: unused
1809 * - encoding: Set by user.
1810 * - decoding: unused
1816 * - encoding: Set by user.
1817 * - decoding: unused
1822 * number of reference frames
1823 * - encoding: Set by user.
1824 * - decoding: Set by lavc.
1829 * chroma qp offset from luma
1830 * - encoding: Set by user.
1831 * - decoding: unused
1836 * Multiplied by qscale for each frame and added to scene_change_score.
1837 * - encoding: Set by user.
1838 * - decoding: unused
1840 int scenechange_factor;
1844 * Note: Value depends upon the compare function used for fullpel ME.
1845 * - encoding: Set by user.
1846 * - decoding: unused
1851 * Adjust sensitivity of b_frame_strategy 1.
1852 * - encoding: Set by user.
1853 * - decoding: unused
1858 * Chromaticity coordinates of the source primaries.
1859 * - encoding: Set by user
1860 * - decoding: Set by libavcodec
1862 enum AVColorPrimaries color_primaries;
1865 * Color Transfer Characteristic.
1866 * - encoding: Set by user
1867 * - decoding: Set by libavcodec
1869 enum AVColorTransferCharacteristic color_trc;
1872 * YUV colorspace type.
1873 * - encoding: Set by user
1874 * - decoding: Set by libavcodec
1876 enum AVColorSpace colorspace;
1879 * MPEG vs JPEG YUV range.
1880 * - encoding: Set by user
1881 * - decoding: Set by libavcodec
1883 enum AVColorRange color_range;
1886 * This defines the location of chroma samples.
1887 * - encoding: Set by user
1888 * - decoding: Set by libavcodec
1890 enum AVChromaLocation chroma_sample_location;
1894 * Indicates number of picture subdivisions. Used for parallelized
1896 * - encoding: Set by user
1897 * - decoding: unused
1902 * - encoding: set by libavcodec
1903 * - decoding: Set by user.
1905 enum AVFieldOrder field_order;
1908 int sample_rate; ///< samples per second
1909 int channels; ///< number of audio channels
1912 * audio sample format
1913 * - encoding: Set by user.
1914 * - decoding: Set by libavcodec.
1916 enum AVSampleFormat sample_fmt; ///< sample format
1918 /* The following data should not be initialized. */
1920 * Number of samples per channel in an audio frame.
1922 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1923 * except the last must contain exactly frame_size samples per channel.
1924 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1925 * frame size is not restricted.
1926 * - decoding: may be set by some decoders to indicate constant frame size
1931 * Frame counter, set by libavcodec.
1933 * - decoding: total number of frames returned from the decoder so far.
1934 * - encoding: total number of frames passed to the encoder so far.
1936 * @note the counter is not incremented if encoding/decoding resulted in
1942 * number of bytes per packet if constant and known or 0
1943 * Used by some WAV based audio codecs.
1948 * Audio cutoff bandwidth (0 means "automatic")
1949 * - encoding: Set by user.
1950 * - decoding: unused
1954 #if FF_API_REQUEST_CHANNELS
1956 * Decoder should decode to this many channels if it can (0 for default)
1957 * - encoding: unused
1958 * - decoding: Set by user.
1959 * @deprecated Deprecated in favor of request_channel_layout.
1961 attribute_deprecated int request_channels;
1965 * Audio channel layout.
1966 * - encoding: set by user.
1967 * - decoding: set by user, may be overwritten by libavcodec.
1969 uint64_t channel_layout;
1972 * Request decoder to use this channel layout if it can (0 for default)
1973 * - encoding: unused
1974 * - decoding: Set by user.
1976 uint64_t request_channel_layout;
1979 * Type of service that the audio stream conveys.
1980 * - encoding: Set by user.
1981 * - decoding: Set by libavcodec.
1983 enum AVAudioServiceType audio_service_type;
1986 * desired sample format
1987 * - encoding: Not used.
1988 * - decoding: Set by user.
1989 * Decoder will decode to this format if it can.
1991 enum AVSampleFormat request_sample_fmt;
1993 #if FF_API_GET_BUFFER
1995 * Called at the beginning of each frame to get a buffer for it.
1997 * The function will set AVFrame.data[], AVFrame.linesize[].
1998 * AVFrame.extended_data[] must also be set, but it should be the same as
1999 * AVFrame.data[] except for planar audio with more channels than can fit
2000 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2001 * many data pointers as it can hold.
2003 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2004 * avcodec_default_get_buffer() instead of providing buffers allocated by
2007 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2008 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2009 * but if get_buffer() is overridden then alignment considerations should
2010 * be taken into account.
2012 * @see avcodec_default_get_buffer()
2016 * If pic.reference is set then the frame will be read later by libavcodec.
2017 * avcodec_align_dimensions2() should be used to find the required width and
2018 * height, as they normally need to be rounded up to the next multiple of 16.
2020 * If frame multithreading is used and thread_safe_callbacks is set,
2021 * it may be called from a different thread, but not from more than one at
2022 * once. Does not need to be reentrant.
2024 * @see release_buffer(), reget_buffer()
2025 * @see avcodec_align_dimensions2()
2029 * Decoders request a buffer of a particular size by setting
2030 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2031 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2032 * to a smaller value in the output frame.
2034 * Decoders cannot use the buffer after returning from
2035 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2036 * is assumed to be released immediately upon return. In some rare cases,
2037 * a decoder may need to call get_buffer() more than once in a single
2038 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2039 * called again after it has already been called once, the previously
2040 * acquired buffer is assumed to be released at that time and may not be
2041 * reused by the decoder.
2043 * As a convenience, av_samples_get_buffer_size() and
2044 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2045 * functions to find the required data size and to fill data pointers and
2046 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2047 * since all planes must be the same size.
2049 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2051 * - encoding: unused
2052 * - decoding: Set by libavcodec, user can override.
2054 * @deprecated use get_buffer2()
2056 attribute_deprecated
2057 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2060 * Called to release buffers which were allocated with get_buffer.
2061 * A released buffer can be reused in get_buffer().
2062 * pic.data[*] must be set to NULL.
2063 * May be called from a different thread if frame multithreading is used,
2064 * but not by more than one thread at once, so does not need to be reentrant.
2065 * - encoding: unused
2066 * - decoding: Set by libavcodec, user can override.
2068 * @deprecated custom freeing callbacks should be set from get_buffer2()
2070 attribute_deprecated
2071 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2074 * Called at the beginning of a frame to get cr buffer for it.
2075 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2076 * libavcodec will pass previous buffer in pic, function should return
2077 * same buffer or new buffer with old frame "painted" into it.
2078 * If pic.data[0] == NULL must behave like get_buffer().
2079 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2080 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2082 * - encoding: unused
2083 * - decoding: Set by libavcodec, user can override.
2085 attribute_deprecated
2086 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2090 * This callback is called at the beginning of each frame to get data
2091 * buffer(s) for it. There may be one contiguous buffer for all the data or
2092 * there may be a buffer per each data plane or anything in between. What
2093 * this means is, you may set however many entries in buf[] you feel necessary.
2094 * Each buffer must be reference-counted using the AVBuffer API (see description
2097 * The following fields will be set in the frame before this callback is
2100 * - width, height (video only)
2101 * - sample_rate, channel_layout, nb_samples (audio only)
2102 * Their values may differ from the corresponding values in
2103 * AVCodecContext. This callback must use the frame values, not the codec
2104 * context values, to calculate the required buffer size.
2106 * This callback must fill the following fields in the frame:
2110 * * if the data is planar audio with more than 8 channels, then this
2111 * callback must allocate and fill extended_data to contain all pointers
2112 * to all data planes. data[] must hold as many pointers as it can.
2113 * extended_data must be allocated with av_malloc() and will be freed in
2115 * * otherwise exended_data must point to data
2116 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2117 * the frame's data and extended_data pointers must be contained in these. That
2118 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2119 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2120 * and av_buffer_ref().
2121 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2122 * this callback and filled with the extra buffers if there are more
2123 * buffers than buf[] can hold. extended_buf will be freed in
2126 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2127 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2130 * Each data plane must be aligned to the maximum required by the target
2133 * @see avcodec_default_get_buffer2()
2137 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2138 * (read and/or written to if it is writable) later by libavcodec.
2140 * If CODEC_FLAG_EMU_EDGE is not set in s->flags, the buffer must contain an
2141 * edge of the size returned by avcodec_get_edge_width() on all sides.
2143 * avcodec_align_dimensions2() should be used to find the required width and
2144 * height, as they normally need to be rounded up to the next multiple of 16.
2146 * If frame multithreading is used and thread_safe_callbacks is set,
2147 * this callback may be called from a different thread, but not from more
2148 * than one at once. Does not need to be reentrant.
2150 * @see avcodec_align_dimensions2()
2154 * Decoders request a buffer of a particular size by setting
2155 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2156 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2157 * to a smaller value in the output frame.
2159 * As a convenience, av_samples_get_buffer_size() and
2160 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2161 * functions to find the required data size and to fill data pointers and
2162 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2163 * since all planes must be the same size.
2165 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2167 * - encoding: unused
2168 * - decoding: Set by libavcodec, user can override.
2170 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2173 * If non-zero, the decoded audio and video frames returned from
2174 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2175 * and are valid indefinitely. The caller must free them with
2176 * av_frame_unref() when they are not needed anymore.
2177 * Otherwise, the decoded frames must not be freed by the caller and are
2178 * only valid until the next decode call.
2180 * - encoding: unused
2181 * - decoding: set by the caller before avcodec_open2().
2183 int refcounted_frames;
2185 /* - encoding parameters */
2186 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2187 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2191 * - encoding: Set by user.
2192 * - decoding: unused
2198 * - encoding: Set by user.
2199 * - decoding: unused
2204 * maximum quantizer difference between frames
2205 * - encoding: Set by user.
2206 * - decoding: unused
2211 * ratecontrol qmin qmax limiting method
2212 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2213 * - encoding: Set by user.
2214 * - decoding: unused
2222 * decoder bitstream buffer size
2223 * - encoding: Set by user.
2224 * - decoding: unused
2229 * ratecontrol override, see RcOverride
2230 * - encoding: Allocated/set/freed by user.
2231 * - decoding: unused
2233 int rc_override_count;
2234 RcOverride *rc_override;
2237 * rate control equation
2238 * - encoding: Set by user
2239 * - decoding: unused
2245 * - encoding: Set by user.
2246 * - decoding: unused
2252 * - encoding: Set by user.
2253 * - decoding: unused
2257 float rc_buffer_aggressivity;
2260 * initial complexity for pass1 ratecontrol
2261 * - encoding: Set by user.
2262 * - decoding: unused
2264 float rc_initial_cplx;
2267 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2268 * - encoding: Set by user.
2269 * - decoding: unused.
2271 float rc_max_available_vbv_use;
2274 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2275 * - encoding: Set by user.
2276 * - decoding: unused.
2278 float rc_min_vbv_overflow_use;
2281 * Number of bits which should be loaded into the rc buffer before decoding starts.
2282 * - encoding: Set by user.
2283 * - decoding: unused
2285 int rc_initial_buffer_occupancy;
2287 #define FF_CODER_TYPE_VLC 0
2288 #define FF_CODER_TYPE_AC 1
2289 #define FF_CODER_TYPE_RAW 2
2290 #define FF_CODER_TYPE_RLE 3
2291 #define FF_CODER_TYPE_DEFLATE 4
2294 * - encoding: Set by user.
2295 * - decoding: unused
2301 * - encoding: Set by user.
2302 * - decoding: unused
2307 * minimum Lagrange multipler
2308 * - encoding: Set by user.
2309 * - decoding: unused
2314 * maximum Lagrange multipler
2315 * - encoding: Set by user.
2316 * - decoding: unused
2321 * frame skip threshold
2322 * - encoding: Set by user.
2323 * - decoding: unused
2325 int frame_skip_threshold;
2329 * - encoding: Set by user.
2330 * - decoding: unused
2332 int frame_skip_factor;
2335 * frame skip exponent
2336 * - encoding: Set by user.
2337 * - decoding: unused
2342 * frame skip comparison function
2343 * - encoding: Set by user.
2344 * - decoding: unused
2349 * trellis RD quantization
2350 * - encoding: Set by user.
2351 * - decoding: unused
2356 * - encoding: Set by user.
2357 * - decoding: unused
2359 int min_prediction_order;
2362 * - encoding: Set by user.
2363 * - decoding: unused
2365 int max_prediction_order;
2368 * GOP timecode frame start number
2369 * - encoding: Set by user, in non drop frame format
2370 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2372 int64_t timecode_frame_start;
2374 /* The RTP callback: This function is called */
2375 /* every time the encoder has a packet to send. */
2376 /* It depends on the encoder if the data starts */
2377 /* with a Start Code (it should). H.263 does. */
2378 /* mb_nb contains the number of macroblocks */
2379 /* encoded in the RTP payload. */
2380 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2382 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2383 /* do its best to deliver a chunk with size */
2384 /* below rtp_payload_size, the chunk will start */
2385 /* with a start code on some codecs like H.263. */
2386 /* This doesn't take account of any particular */
2387 /* headers inside the transmitted RTP payload. */
2389 /* statistics, used for 2-pass encoding */
2400 * number of bits used for the previously encoded frame
2401 * - encoding: Set by libavcodec.
2402 * - decoding: unused
2407 * pass1 encoding statistics output buffer
2408 * - encoding: Set by libavcodec.
2409 * - decoding: unused
2414 * pass2 encoding statistics input buffer
2415 * Concatenated stuff from stats_out of pass1 should be placed here.
2416 * - encoding: Allocated/set/freed by user.
2417 * - decoding: unused
2422 * Work around bugs in encoders which sometimes cannot be detected automatically.
2423 * - encoding: Set by user
2424 * - decoding: Set by user
2426 int workaround_bugs;
2427 #define FF_BUG_AUTODETECT 1 ///< autodetection
2428 #if FF_API_OLD_MSMPEG4
2429 #define FF_BUG_OLD_MSMPEG4 2
2431 #define FF_BUG_XVID_ILACE 4
2432 #define FF_BUG_UMP4 8
2433 #define FF_BUG_NO_PADDING 16
2434 #define FF_BUG_AMV 32
2436 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2438 #define FF_BUG_QPEL_CHROMA 64
2439 #define FF_BUG_STD_QPEL 128
2440 #define FF_BUG_QPEL_CHROMA2 256
2441 #define FF_BUG_DIRECT_BLOCKSIZE 512
2442 #define FF_BUG_EDGE 1024
2443 #define FF_BUG_HPEL_CHROMA 2048
2444 #define FF_BUG_DC_CLIP 4096
2445 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2446 #define FF_BUG_TRUNCATED 16384
2449 * strictly follow the standard (MPEG4, ...).
2450 * - encoding: Set by user.
2451 * - decoding: Set by user.
2452 * Setting this to STRICT or higher means the encoder and decoder will
2453 * generally do stupid things, whereas setting it to unofficial or lower
2454 * will mean the encoder might produce output that is not supported by all
2455 * spec-compliant decoders. Decoders don't differentiate between normal,
2456 * unofficial and experimental (that is, they always try to decode things
2457 * when they can) unless they are explicitly asked to behave stupidly
2458 * (=strictly conform to the specs)
2460 int strict_std_compliance;
2461 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2462 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2463 #define FF_COMPLIANCE_NORMAL 0
2464 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2465 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2468 * error concealment flags
2469 * - encoding: unused
2470 * - decoding: Set by user.
2472 int error_concealment;
2473 #define FF_EC_GUESS_MVS 1
2474 #define FF_EC_DEBLOCK 2
2478 * - encoding: Set by user.
2479 * - decoding: Set by user.
2482 #define FF_DEBUG_PICT_INFO 1
2483 #define FF_DEBUG_RC 2
2484 #define FF_DEBUG_BITSTREAM 4
2485 #define FF_DEBUG_MB_TYPE 8
2486 #define FF_DEBUG_QP 16
2489 * @deprecated this option does nothing
2491 #define FF_DEBUG_MV 32
2493 #define FF_DEBUG_DCT_COEFF 0x00000040
2494 #define FF_DEBUG_SKIP 0x00000080
2495 #define FF_DEBUG_STARTCODE 0x00000100
2496 #define FF_DEBUG_PTS 0x00000200
2497 #define FF_DEBUG_ER 0x00000400
2498 #define FF_DEBUG_MMCO 0x00000800
2499 #define FF_DEBUG_BUGS 0x00001000
2501 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2502 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2504 #define FF_DEBUG_BUFFERS 0x00008000
2505 #define FF_DEBUG_THREADS 0x00010000
2510 * Code outside libavcodec should access this field using AVOptions
2511 * - encoding: Set by user.
2512 * - decoding: Set by user.
2515 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2516 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2517 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2521 * Error recognition; may misdetect some more or less valid parts as errors.
2522 * - encoding: unused
2523 * - decoding: Set by user.
2525 int err_recognition;
2528 * Verify checksums embedded in the bitstream (could be of either encoded or
2529 * decoded data, depending on the codec) and print an error message on mismatch.
2530 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2531 * decoder returning an error.
2533 #define AV_EF_CRCCHECK (1<<0)
2534 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2535 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2536 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2538 #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
2539 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliancies as errors
2540 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2544 * opaque 64bit number (generally a PTS) that will be reordered and
2545 * output in AVFrame.reordered_opaque
2546 * @deprecated in favor of pkt_pts
2547 * - encoding: unused
2548 * - decoding: Set by user.
2550 int64_t reordered_opaque;
2553 * Hardware accelerator in use
2554 * - encoding: unused.
2555 * - decoding: Set by libavcodec
2557 struct AVHWAccel *hwaccel;
2560 * Hardware accelerator context.
2561 * For some hardware accelerators, a global context needs to be
2562 * provided by the user. In that case, this holds display-dependent
2563 * data FFmpeg cannot instantiate itself. Please refer to the
2564 * FFmpeg HW accelerator documentation to know how to fill this
2565 * is. e.g. for VA API, this is a struct vaapi_context.
2566 * - encoding: unused
2567 * - decoding: Set by user
2569 void *hwaccel_context;
2573 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2574 * - decoding: unused
2576 uint64_t error[AV_NUM_DATA_POINTERS];
2579 * DCT algorithm, see FF_DCT_* below
2580 * - encoding: Set by user.
2581 * - decoding: unused
2584 #define FF_DCT_AUTO 0
2585 #define FF_DCT_FASTINT 1
2586 #define FF_DCT_INT 2
2587 #define FF_DCT_MMX 3
2588 #define FF_DCT_ALTIVEC 5
2589 #define FF_DCT_FAAN 6
2592 * IDCT algorithm, see FF_IDCT_* below.
2593 * - encoding: Set by user.
2594 * - decoding: Set by user.
2597 #define FF_IDCT_AUTO 0
2598 #define FF_IDCT_INT 1
2599 #define FF_IDCT_SIMPLE 2
2600 #define FF_IDCT_SIMPLEMMX 3
2601 #define FF_IDCT_ARM 7
2602 #define FF_IDCT_ALTIVEC 8
2603 #define FF_IDCT_SH4 9
2604 #define FF_IDCT_SIMPLEARM 10
2605 #define FF_IDCT_IPP 13
2606 #define FF_IDCT_XVIDMMX 14
2607 #define FF_IDCT_SIMPLEARMV5TE 16
2608 #define FF_IDCT_SIMPLEARMV6 17
2609 #define FF_IDCT_SIMPLEVIS 18
2610 #define FF_IDCT_FAAN 20
2611 #define FF_IDCT_SIMPLENEON 22
2612 #if FF_API_ARCH_ALPHA
2613 #define FF_IDCT_SIMPLEALPHA 23
2617 * bits per sample/pixel from the demuxer (needed for huffyuv).
2618 * - encoding: Set by libavcodec.
2619 * - decoding: Set by user.
2621 int bits_per_coded_sample;
2624 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2625 * - encoding: set by user.
2626 * - decoding: set by libavcodec.
2628 int bits_per_raw_sample;
2632 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2633 * - encoding: unused
2634 * - decoding: Set by user.
2635 * Code outside libavcodec should access this field using:
2636 * av_codec_{get,set}_lowres(avctx)
2642 * the picture in the bitstream
2643 * - encoding: Set by libavcodec.
2644 * - decoding: unused
2646 AVFrame *coded_frame;
2650 * is used to decide how many independent tasks should be passed to execute()
2651 * - encoding: Set by user.
2652 * - decoding: Set by user.
2657 * Which multithreading methods to use.
2658 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2659 * so clients which cannot provide future frames should not use it.
2661 * - encoding: Set by user, otherwise the default is used.
2662 * - decoding: Set by user, otherwise the default is used.
2665 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2666 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2669 * Which multithreading methods are in use by the codec.
2670 * - encoding: Set by libavcodec.
2671 * - decoding: Set by libavcodec.
2673 int active_thread_type;
2676 * Set by the client if its custom get_buffer() callback can be called
2677 * synchronously from another thread, which allows faster multithreaded decoding.
2678 * draw_horiz_band() will be called from other threads regardless of this setting.
2679 * Ignored if the default get_buffer() is used.
2680 * - encoding: Set by user.
2681 * - decoding: Set by user.
2683 int thread_safe_callbacks;
2686 * The codec may call this to execute several independent things.
2687 * It will return only after finishing all tasks.
2688 * The user may replace this with some multithreaded implementation,
2689 * the default implementation will execute the parts serially.
2690 * @param count the number of things to execute
2691 * - encoding: Set by libavcodec, user can override.
2692 * - decoding: Set by libavcodec, user can override.
2694 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2697 * The codec may call this to execute several independent things.
2698 * It will return only after finishing all tasks.
2699 * The user may replace this with some multithreaded implementation,
2700 * the default implementation will execute the parts serially.
2701 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2702 * @param c context passed also to func
2703 * @param count the number of things to execute
2704 * @param arg2 argument passed unchanged to func
2705 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2706 * @param func function that will be called count times, with jobnr from 0 to count-1.
2707 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2708 * two instances of func executing at the same time will have the same threadnr.
2709 * @return always 0 currently, but code should handle a future improvement where when any call to func
2710 * returns < 0 no further calls to func may be done and < 0 is returned.
2711 * - encoding: Set by libavcodec, user can override.
2712 * - decoding: Set by libavcodec, user can override.
2714 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2716 #if FF_API_THREAD_OPAQUE
2718 * @deprecated this field should not be used from outside of lavc
2720 attribute_deprecated
2721 void *thread_opaque;
2725 * noise vs. sse weight for the nsse comparsion function
2726 * - encoding: Set by user.
2727 * - decoding: unused
2733 * - encoding: Set by user.
2734 * - decoding: Set by libavcodec.
2737 #define FF_PROFILE_UNKNOWN -99
2738 #define FF_PROFILE_RESERVED -100
2740 #define FF_PROFILE_AAC_MAIN 0
2741 #define FF_PROFILE_AAC_LOW 1
2742 #define FF_PROFILE_AAC_SSR 2
2743 #define FF_PROFILE_AAC_LTP 3
2744 #define FF_PROFILE_AAC_HE 4
2745 #define FF_PROFILE_AAC_HE_V2 28
2746 #define FF_PROFILE_AAC_LD 22
2747 #define FF_PROFILE_AAC_ELD 38
2748 #define FF_PROFILE_MPEG2_AAC_LOW 128
2749 #define FF_PROFILE_MPEG2_AAC_HE 131
2751 #define FF_PROFILE_DTS 20
2752 #define FF_PROFILE_DTS_ES 30
2753 #define FF_PROFILE_DTS_96_24 40
2754 #define FF_PROFILE_DTS_HD_HRA 50
2755 #define FF_PROFILE_DTS_HD_MA 60
2757 #define FF_PROFILE_MPEG2_422 0
2758 #define FF_PROFILE_MPEG2_HIGH 1
2759 #define FF_PROFILE_MPEG2_SS 2
2760 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2761 #define FF_PROFILE_MPEG2_MAIN 4
2762 #define FF_PROFILE_MPEG2_SIMPLE 5
2764 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2765 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2767 #define FF_PROFILE_H264_BASELINE 66
2768 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2769 #define FF_PROFILE_H264_MAIN 77
2770 #define FF_PROFILE_H264_EXTENDED 88
2771 #define FF_PROFILE_H264_HIGH 100
2772 #define FF_PROFILE_H264_HIGH_10 110
2773 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2774 #define FF_PROFILE_H264_HIGH_422 122
2775 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2776 #define FF_PROFILE_H264_HIGH_444 144
2777 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2778 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2779 #define FF_PROFILE_H264_CAVLC_444 44
2781 #define FF_PROFILE_VC1_SIMPLE 0
2782 #define FF_PROFILE_VC1_MAIN 1
2783 #define FF_PROFILE_VC1_COMPLEX 2
2784 #define FF_PROFILE_VC1_ADVANCED 3
2786 #define FF_PROFILE_MPEG4_SIMPLE 0
2787 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2788 #define FF_PROFILE_MPEG4_CORE 2
2789 #define FF_PROFILE_MPEG4_MAIN 3
2790 #define FF_PROFILE_MPEG4_N_BIT 4
2791 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2792 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2793 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2794 #define FF_PROFILE_MPEG4_HYBRID 8
2795 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2796 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2797 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2798 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2799 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2800 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2801 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2803 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2804 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2805 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2806 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2807 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2811 * - encoding: Set by user.
2812 * - decoding: Set by libavcodec.
2815 #define FF_LEVEL_UNKNOWN -99
2818 * Skip loop filtering for selected frames.
2819 * - encoding: unused
2820 * - decoding: Set by user.
2822 enum AVDiscard skip_loop_filter;
2825 * Skip IDCT/dequantization for selected frames.
2826 * - encoding: unused
2827 * - decoding: Set by user.
2829 enum AVDiscard skip_idct;
2832 * Skip decoding for selected frames.
2833 * - encoding: unused
2834 * - decoding: Set by user.
2836 enum AVDiscard skip_frame;
2839 * Header containing style information for text subtitles.
2840 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2841 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2842 * the Format line following. It shouldn't include any Dialogue line.
2843 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2844 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2846 uint8_t *subtitle_header;
2847 int subtitle_header_size;
2849 #if FF_API_ERROR_RATE
2851 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2854 attribute_deprecated
2858 #if FF_API_CODEC_PKT
2860 * @deprecated this field is not supposed to be accessed from outside lavc
2862 attribute_deprecated
2867 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2868 * Used for compliant TS muxing.
2869 * - encoding: Set by libavcodec.
2870 * - decoding: unused.
2875 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2876 * Code outside libavcodec should access this field using:
2877 * av_codec_{get,set}_pkt_timebase(avctx)
2878 * - encoding unused.
2879 * - decoding set by user.
2881 AVRational pkt_timebase;
2885 * Code outside libavcodec should access this field using:
2886 * av_codec_{get,set}_codec_descriptor(avctx)
2887 * - encoding: unused.
2888 * - decoding: set by libavcodec.
2890 const AVCodecDescriptor *codec_descriptor;
2894 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2895 * - encoding: unused
2896 * - decoding: Set by user.
2897 * Code outside libavcodec should access this field using:
2898 * av_codec_{get,set}_lowres(avctx)
2904 * Current statistics for PTS correction.
2905 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2906 * - encoding: unused
2908 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2909 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2910 int64_t pts_correction_last_pts; /// PTS of the last frame
2911 int64_t pts_correction_last_dts; /// DTS of the last frame
2914 * Character encoding of the input subtitles file.
2915 * - decoding: set by user
2916 * - encoding: unused
2921 * Subtitles character encoding mode. Formats or codecs might be adjusting
2922 * this setting (if they are doing the conversion themselves for instance).
2923 * - decoding: set by libavcodec
2924 * - encoding: unused
2926 int sub_charenc_mode;
2927 #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)
2928 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
2929 #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
2932 * Skip processing alpha if supported by codec.
2933 * Note that if the format uses pre-multiplied alpha (common with VP6,
2934 * and recommended due to better video quality/compression)
2935 * the image will look as if alpha-blended onto a black background.
2936 * However for formats that do not use pre-multiplied alpha
2937 * there might be serious artefacts (though e.g. libswscale currently
2938 * assumes pre-multiplied alpha anyway).
2939 * Code outside libavcodec should access this field using AVOptions
2941 * - decoding: set by user
2942 * - encoding: unused
2947 * Number of samples to skip after a discontinuity
2948 * - decoding: unused
2949 * - encoding: set by libavcodec
2953 #if !FF_API_DEBUG_MV
2955 * debug motion vectors
2956 * Code outside libavcodec should access this field using AVOptions
2957 * - encoding: Set by user.
2958 * - decoding: Set by user.
2961 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2962 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2963 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2967 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
2968 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
2970 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
2971 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
2973 int av_codec_get_lowres(const AVCodecContext *avctx);
2974 void av_codec_set_lowres(AVCodecContext *avctx, int val);
2976 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
2977 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
2982 typedef struct AVProfile {
2984 const char *name; ///< short name for the profile
2987 typedef struct AVCodecDefault AVCodecDefault;
2994 typedef struct AVCodec {
2996 * Name of the codec implementation.
2997 * The name is globally unique among encoders and among decoders (but an
2998 * encoder and a decoder can share the same name).
2999 * This is the primary way to find a codec from the user perspective.
3003 * Descriptive name for the codec, meant to be more human readable than name.
3004 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3006 const char *long_name;
3007 enum AVMediaType type;
3010 * Codec capabilities.
3014 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3015 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3016 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3017 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3018 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3020 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3022 const AVClass *priv_class; ///< AVClass for the private context
3023 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3025 /*****************************************************************
3026 * No fields below this line are part of the public API. They
3027 * may not be used outside of libavcodec and can be changed and
3029 * New public fields should be added right above.
3030 *****************************************************************
3033 struct AVCodec *next;
3035 * @name Frame-level threading support functions
3039 * If defined, called on thread contexts when they are created.
3040 * If the codec allocates writable tables in init(), re-allocate them here.
3041 * priv_data will be set to a copy of the original.
3043 int (*init_thread_copy)(AVCodecContext *);
3045 * Copy necessary context variables from a previous thread context to the current one.
3046 * If not defined, the next thread will start automatically; otherwise, the codec
3047 * must call ff_thread_finish_setup().
3049 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3051 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3055 * Private codec-specific defaults.
3057 const AVCodecDefault *defaults;
3060 * Initialize codec static data, called from avcodec_register().
3062 void (*init_static_data)(struct AVCodec *codec);
3064 int (*init)(AVCodecContext *);
3065 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3066 const struct AVSubtitle *sub);
3068 * Encode data to an AVPacket.
3070 * @param avctx codec context
3071 * @param avpkt output AVPacket (may contain a user-provided buffer)
3072 * @param[in] frame AVFrame containing the raw data to be encoded
3073 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3074 * non-empty packet was returned in avpkt.
3075 * @return 0 on success, negative error code on failure
3077 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3078 int *got_packet_ptr);
3079 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3080 int (*close)(AVCodecContext *);
3083 * Will be called when seeking
3085 void (*flush)(AVCodecContext *);
3088 int av_codec_get_max_lowres(const AVCodec *codec);
3093 typedef struct AVHWAccel {
3095 * Name of the hardware accelerated codec.
3096 * The name is globally unique among encoders and among decoders (but an
3097 * encoder and a decoder can share the same name).
3102 * Type of codec implemented by the hardware accelerator.
3104 * See AVMEDIA_TYPE_xxx
3106 enum AVMediaType type;
3109 * Codec implemented by the hardware accelerator.
3111 * See AV_CODEC_ID_xxx
3116 * Supported pixel format.
3118 * Only hardware accelerated formats are supported here.
3120 enum AVPixelFormat pix_fmt;
3123 * Hardware accelerated codec capabilities.
3124 * see FF_HWACCEL_CODEC_CAP_*
3128 struct AVHWAccel *next;
3131 * Called at the beginning of each frame or field picture.
3133 * Meaningful frame information (codec specific) is guaranteed to
3134 * be parsed at this point. This function is mandatory.
3136 * Note that buf can be NULL along with buf_size set to 0.
3137 * Otherwise, this means the whole frame is available at this point.
3139 * @param avctx the codec context
3140 * @param buf the frame data buffer base
3141 * @param buf_size the size of the frame in bytes
3142 * @return zero if successful, a negative value otherwise
3144 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3147 * Callback for each slice.
3149 * Meaningful slice information (codec specific) is guaranteed to
3150 * be parsed at this point. This function is mandatory.
3152 * @param avctx the codec context
3153 * @param buf the slice data buffer base
3154 * @param buf_size the size of the slice in bytes
3155 * @return zero if successful, a negative value otherwise
3157 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3160 * Called at the end of each frame or field picture.
3162 * The whole picture is parsed at this point and can now be sent
3163 * to the hardware accelerator. This function is mandatory.
3165 * @param avctx the codec context
3166 * @return zero if successful, a negative value otherwise
3168 int (*end_frame)(AVCodecContext *avctx);
3171 * Size of HW accelerator private data.
3173 * Private data is allocated with av_mallocz() before
3174 * AVCodecContext.get_buffer() and deallocated after
3175 * AVCodecContext.release_buffer().
3181 * @defgroup lavc_picture AVPicture
3183 * Functions for working with AVPicture
3188 * Picture data structure.
3190 * Up to four components can be stored into it, the last component is
3193 typedef struct AVPicture {
3194 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3195 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3202 enum AVSubtitleType {
3205 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3208 * Plain text, the text field must be set by the decoder and is
3209 * authoritative. ass and pict fields may contain approximations.
3214 * Formatted text, the ass field must be set by the decoder and is
3215 * authoritative. pict and text fields may contain approximations.
3220 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3222 typedef struct AVSubtitleRect {
3223 int x; ///< top left corner of pict, undefined when pict is not set
3224 int y; ///< top left corner of pict, undefined when pict is not set
3225 int w; ///< width of pict, undefined when pict is not set
3226 int h; ///< height of pict, undefined when pict is not set
3227 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3230 * data+linesize for the bitmap of this subtitle.
3231 * can be set for text/ass as well once they where rendered
3234 enum AVSubtitleType type;
3236 char *text; ///< 0 terminated plain UTF-8 text
3239 * 0 terminated ASS/SSA compatible event line.
3240 * The presentation of this is unaffected by the other values in this
3248 typedef struct AVSubtitle {
3249 uint16_t format; /* 0 = graphics */
3250 uint32_t start_display_time; /* relative to packet pts, in ms */
3251 uint32_t end_display_time; /* relative to packet pts, in ms */
3253 AVSubtitleRect **rects;
3254 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3258 * If c is NULL, returns the first registered codec,
3259 * if c is non-NULL, returns the next registered codec after c,
3260 * or NULL if c is the last one.
3262 AVCodec *av_codec_next(const AVCodec *c);
3265 * Return the LIBAVCODEC_VERSION_INT constant.
3267 unsigned avcodec_version(void);
3270 * Return the libavcodec build-time configuration.
3272 const char *avcodec_configuration(void);
3275 * Return the libavcodec license.
3277 const char *avcodec_license(void);
3280 * Register the codec codec and initialize libavcodec.
3282 * @warning either this function or avcodec_register_all() must be called
3283 * before any other libavcodec functions.
3285 * @see avcodec_register_all()
3287 void avcodec_register(AVCodec *codec);
3290 * Register all the codecs, parsers and bitstream filters which were enabled at
3291 * configuration time. If you do not call this function you can select exactly
3292 * which formats you want to support, by using the individual registration
3295 * @see avcodec_register
3296 * @see av_register_codec_parser
3297 * @see av_register_bitstream_filter
3299 void avcodec_register_all(void);
3302 * Allocate an AVCodecContext and set its fields to default values. The
3303 * resulting struct can be deallocated by calling avcodec_close() on it followed
3306 * @param codec if non-NULL, allocate private data and initialize defaults
3307 * for the given codec. It is illegal to then call avcodec_open2()
3308 * with a different codec.
3309 * If NULL, then the codec-specific defaults won't be initialized,
3310 * which may result in suboptimal default settings (this is
3311 * important mainly for encoders, e.g. libx264).
3313 * @return An AVCodecContext filled with default values or NULL on failure.
3314 * @see avcodec_get_context_defaults
3316 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3319 * Set the fields of the given AVCodecContext to default values corresponding
3320 * to the given codec (defaults may be codec-dependent).
3322 * Do not call this function if a non-NULL codec has been passed
3323 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3324 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3325 * different codec on this AVCodecContext.
3327 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3330 * Get the AVClass for AVCodecContext. It can be used in combination with
3331 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3333 * @see av_opt_find().
3335 const AVClass *avcodec_get_class(void);
3338 * Get the AVClass for AVFrame. It can be used in combination with
3339 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3341 * @see av_opt_find().
3343 const AVClass *avcodec_get_frame_class(void);
3346 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3347 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3349 * @see av_opt_find().
3351 const AVClass *avcodec_get_subtitle_rect_class(void);
3354 * Copy the settings of the source AVCodecContext into the destination
3355 * AVCodecContext. The resulting destination codec context will be
3356 * unopened, i.e. you are required to call avcodec_open2() before you
3357 * can use this AVCodecContext to decode/encode video/audio data.
3359 * @param dest target codec context, should be initialized with
3360 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3361 * @param src source codec context
3362 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3364 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3366 #if FF_API_AVFRAME_LAVC
3368 * @deprecated use av_frame_alloc()
3370 attribute_deprecated
3371 AVFrame *avcodec_alloc_frame(void);
3375 * Set the fields of the given AVFrame to default values.
3377 * @param frame The AVFrame of which the fields should be set to default values.
3379 void avcodec_get_frame_defaults(AVFrame *frame);
3382 * Free the frame and any dynamically allocated objects in it,
3383 * e.g. extended_data.
3385 * @param frame frame to be freed. The pointer will be set to NULL.
3387 * @warning this function does NOT free the data buffers themselves
3388 * (it does not know how, since they might have been allocated with
3389 * a custom get_buffer()).
3391 void avcodec_free_frame(AVFrame **frame);
3394 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3395 * function the context has to be allocated with avcodec_alloc_context3().
3397 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3398 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3399 * retrieving a codec.
3401 * @warning This function is not thread safe!
3404 * avcodec_register_all();
3405 * av_dict_set(&opts, "b", "2.5M", 0);
3406 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3410 * context = avcodec_alloc_context3(codec);
3412 * if (avcodec_open2(context, codec, opts) < 0)
3416 * @param avctx The context to initialize.
3417 * @param codec The codec to open this context for. If a non-NULL codec has been
3418 * previously passed to avcodec_alloc_context3() or
3419 * avcodec_get_context_defaults3() for this context, then this
3420 * parameter MUST be either NULL or equal to the previously passed
3422 * @param options A dictionary filled with AVCodecContext and codec-private options.
3423 * On return this object will be filled with options that were not found.
3425 * @return zero on success, a negative value on error
3426 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3427 * av_dict_set(), av_opt_find().
3429 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3432 * Close a given AVCodecContext and free all the data associated with it
3433 * (but not the AVCodecContext itself).
3435 * Calling this function on an AVCodecContext that hasn't been opened will free
3436 * the codec-specific data allocated in avcodec_alloc_context3() /
3437 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3440 int avcodec_close(AVCodecContext *avctx);
3443 * Free all allocated data in the given subtitle struct.
3445 * @param sub AVSubtitle to free.
3447 void avsubtitle_free(AVSubtitle *sub);
3454 * @addtogroup lavc_packet
3458 #if FF_API_DESTRUCT_PACKET
3460 * Default packet destructor.
3461 * @deprecated use the AVBuffer API instead
3463 attribute_deprecated
3464 void av_destruct_packet(AVPacket *pkt);
3468 * Initialize optional fields of a packet with default values.
3470 * Note, this does not touch the data and size members, which have to be
3471 * initialized separately.
3475 void av_init_packet(AVPacket *pkt);
3478 * Allocate the payload of a packet and initialize its fields with
3482 * @param size wanted payload size
3483 * @return 0 if OK, AVERROR_xxx otherwise
3485 int av_new_packet(AVPacket *pkt, int size);
3488 * Reduce packet size, correctly zeroing padding
3491 * @param size new size
3493 void av_shrink_packet(AVPacket *pkt, int size);
3496 * Increase packet size, correctly zeroing padding
3499 * @param grow_by number of bytes by which to increase the size of the packet
3501 int av_grow_packet(AVPacket *pkt, int grow_by);
3504 * Initialize a reference-counted packet from av_malloc()ed data.
3506 * @param pkt packet to be initialized. This function will set the data, size,
3507 * buf and destruct fields, all others are left untouched.
3508 * @param data Data allocated by av_malloc() to be used as packet data. If this
3509 * function returns successfully, the data is owned by the underlying AVBuffer.
3510 * The caller may not access the data through other means.
3511 * @param size size of data in bytes, without the padding. I.e. the full buffer
3512 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3514 * @return 0 on success, a negative AVERROR on error
3516 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3519 * @warning This is a hack - the packet memory allocation stuff is broken. The
3520 * packet is allocated if it was not really allocated.
3522 int av_dup_packet(AVPacket *pkt);
3525 * Copy packet, including contents
3527 * @return 0 on success, negative AVERROR on fail
3529 int av_copy_packet(AVPacket *dst, AVPacket *src);
3532 * Copy packet side data
3534 * @return 0 on success, negative AVERROR on fail
3536 int av_copy_packet_side_data(AVPacket *dst, AVPacket *src);
3541 * @param pkt packet to free
3543 void av_free_packet(AVPacket *pkt);
3546 * Allocate new information of a packet.
3549 * @param type side information type
3550 * @param size side information size
3551 * @return pointer to fresh allocated data or NULL otherwise
3553 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3557 * Shrink the already allocated side data buffer
3560 * @param type side information type
3561 * @param size new side information size
3562 * @return 0 on success, < 0 on failure
3564 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3568 * Get side information from packet.
3571 * @param type desired side information type
3572 * @param size pointer for side information size to store (optional)
3573 * @return pointer to data if present or NULL otherwise
3575 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3578 int av_packet_merge_side_data(AVPacket *pkt);
3580 int av_packet_split_side_data(AVPacket *pkt);
3584 * Convenience function to free all the side data stored.
3585 * All the other fields stay untouched.
3589 void av_packet_free_side_data(AVPacket *pkt);
3592 * Setup a new reference to the data described by a given packet
3594 * If src is reference-counted, setup dst as a new reference to the
3595 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3596 * data from src into it.
3598 * All the other fields are copied from src.
3600 * @see av_packet_unref
3602 * @param dst Destination packet
3603 * @param src Source packet
3605 * @return 0 on success, a negative AVERROR on error.
3607 int av_packet_ref(AVPacket *dst, AVPacket *src);
3612 * Unreference the buffer referenced by the packet and reset the
3613 * remaining packet fields to their default values.
3615 * @param pkt The packet to be unreferenced.
3617 void av_packet_unref(AVPacket *pkt);
3620 * Move every field in src to dst and reset src.
3622 * @see av_packet_unref
3624 * @param src Source packet, will be reset
3625 * @param dst Destination packet
3627 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3630 * Copy only "properties" fields from src to dst.
3632 * Properties for the purpose of this function are all the fields
3633 * beside those related to the packet data (buf, data, size)
3635 * @param dst Destination packet
3636 * @param src Source packet
3638 * @return 0 on success AVERROR on failure.
3641 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3648 * @addtogroup lavc_decoding
3653 * Find a registered decoder with a matching codec ID.
3655 * @param id AVCodecID of the requested decoder
3656 * @return A decoder if one was found, NULL otherwise.
3658 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3661 * Find a registered decoder with the specified name.
3663 * @param name name of the requested decoder
3664 * @return A decoder if one was found, NULL otherwise.
3666 AVCodec *avcodec_find_decoder_by_name(const char *name);
3668 #if FF_API_GET_BUFFER
3669 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3670 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3671 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3675 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3676 * it can be called by custom get_buffer2() implementations for decoders without
3677 * CODEC_CAP_DR1 set.
3679 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3682 * Return the amount of padding in pixels which the get_buffer callback must
3683 * provide around the edge of the image for codecs which do not have the
3684 * CODEC_FLAG_EMU_EDGE flag.
3686 * @return Required padding in pixels.
3688 unsigned avcodec_get_edge_width(void);
3691 * Modify width and height values so that they will result in a memory
3692 * buffer that is acceptable for the codec if you do not use any horizontal
3695 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3696 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3697 * according to avcodec_get_edge_width() before.
3699 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3702 * Modify width and height values so that they will result in a memory
3703 * buffer that is acceptable for the codec if you also ensure that all
3704 * line sizes are a multiple of the respective linesize_align[i].
3706 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3707 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3708 * according to avcodec_get_edge_width() before.
3710 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3711 int linesize_align[AV_NUM_DATA_POINTERS]);
3714 * Converts AVChromaLocation to swscale x/y chroma position.
3716 * The positions represent the chroma (0,0) position in a coordinates system
3717 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3719 * @param xpos horizontal chroma sample position
3720 * @param ypos vertical chroma sample position
3722 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
3725 * Converts swscale x/y chroma position to AVChromaLocation.
3727 * The positions represent the chroma (0,0) position in a coordinates system
3728 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
3730 * @param xpos horizontal chroma sample position
3731 * @param ypos vertical chroma sample position
3733 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
3735 #if FF_API_OLD_DECODE_AUDIO
3737 * Wrapper function which calls avcodec_decode_audio4.
3739 * @deprecated Use avcodec_decode_audio4 instead.
3741 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3742 * Some decoders may support multiple frames in a single AVPacket, such
3743 * decoders would then just decode the first frame. In this case,
3744 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3745 * the remaining data in order to decode the second frame etc.
3747 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3748 * decompressed frame size in bytes.
3750 * @warning You must set frame_size_ptr to the allocated size of the
3751 * output buffer before calling avcodec_decode_audio3().
3753 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3754 * the actual read bytes because some optimized bitstream readers read 32 or 64
3755 * bits at once and could read over the end.
3757 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3758 * no overreading happens for damaged MPEG streams.
3760 * @warning You must not provide a custom get_buffer() when using
3761 * avcodec_decode_audio3(). Doing so will override it with
3762 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3763 * which does allow the application to provide a custom get_buffer().
3765 * @note You might have to align the input buffer avpkt->data and output buffer
3766 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3767 * necessary at all, on others it won't work at all if not aligned and on others
3768 * it will work but it will have an impact on performance.
3770 * In practice, avpkt->data should have 4 byte alignment at minimum and
3771 * samples should be 16 byte aligned unless the CPU doesn't need it
3772 * (AltiVec and SSE do).
3774 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3775 * between input and output, these need to be fed with avpkt->data=NULL,
3776 * avpkt->size=0 at the end to return the remaining frames.
3778 * @param avctx the codec context
3779 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3780 * If the sample format is planar, each channel plane will
3781 * be the same size, with no padding between channels.
3782 * @param[in,out] frame_size_ptr the output buffer size in bytes
3783 * @param[in] avpkt The input AVPacket containing the input buffer.
3784 * You can create such packet with av_init_packet() and by then setting
3785 * data and size, some decoders might in addition need other fields.
3786 * All decoders are designed to use the least fields possible though.
3787 * @return On error a negative value is returned, otherwise the number of bytes
3788 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3790 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3791 int *frame_size_ptr,
3796 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3798 * Some decoders may support multiple frames in a single AVPacket. Such
3799 * decoders would then just decode the first frame and the return value would be
3800 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3801 * called again with an AVPacket containing the remaining data in order to
3802 * decode the second frame, etc... Even if no frames are returned, the packet
3803 * needs to be fed to the decoder with remaining data until it is completely
3804 * consumed or an error occurs.
3806 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3807 * and output. This means that for some packets they will not immediately
3808 * produce decoded output and need to be flushed at the end of decoding to get
3809 * all the decoded data. Flushing is done by calling this function with packets
3810 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3811 * returning samples. It is safe to flush even those decoders that are not
3812 * marked with CODEC_CAP_DELAY, then no samples will be returned.
3814 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3815 * larger than the actual read bytes because some optimized bitstream
3816 * readers read 32 or 64 bits at once and could read over the end.
3818 * @param avctx the codec context
3819 * @param[out] frame The AVFrame in which to store decoded audio samples.
3820 * The decoder will allocate a buffer for the decoded frame by
3821 * calling the AVCodecContext.get_buffer2() callback.
3822 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3823 * reference counted and the returned reference belongs to the
3824 * caller. The caller must release the frame using av_frame_unref()
3825 * when the frame is no longer needed. The caller may safely write
3826 * to the frame if av_frame_is_writable() returns 1.
3827 * When AVCodecContext.refcounted_frames is set to 0, the returned
3828 * reference belongs to the decoder and is valid only until the
3829 * next call to this function or until closing or flushing the
3830 * decoder. The caller may not write to it.
3831 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3832 * non-zero. Note that this field being set to zero
3833 * does not mean that an error has occurred. For
3834 * decoders with CODEC_CAP_DELAY set, no given decode
3835 * call is guaranteed to produce a frame.
3836 * @param[in] avpkt The input AVPacket containing the input buffer.
3837 * At least avpkt->data and avpkt->size should be set. Some
3838 * decoders might also require additional fields to be set.
3839 * @return A negative error code is returned if an error occurred during
3840 * decoding, otherwise the number of bytes consumed from the input
3841 * AVPacket is returned.
3843 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3844 int *got_frame_ptr, const AVPacket *avpkt);
3847 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3848 * Some decoders may support multiple frames in a single AVPacket, such
3849 * decoders would then just decode the first frame.
3851 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3852 * the actual read bytes because some optimized bitstream readers read 32 or 64
3853 * bits at once and could read over the end.
3855 * @warning The end of the input buffer buf should be set to 0 to ensure that
3856 * no overreading happens for damaged MPEG streams.
3858 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3859 * between input and output, these need to be fed with avpkt->data=NULL,
3860 * avpkt->size=0 at the end to return the remaining frames.
3862 * @param avctx the codec context
3863 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3864 * Use av_frame_alloc() to get an AVFrame. The codec will
3865 * allocate memory for the actual bitmap by calling the
3866 * AVCodecContext.get_buffer2() callback.
3867 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3868 * reference counted and the returned reference belongs to the
3869 * caller. The caller must release the frame using av_frame_unref()
3870 * when the frame is no longer needed. The caller may safely write
3871 * to the frame if av_frame_is_writable() returns 1.
3872 * When AVCodecContext.refcounted_frames is set to 0, the returned
3873 * reference belongs to the decoder and is valid only until the
3874 * next call to this function or until closing or flushing the
3875 * decoder. The caller may not write to it.
3877 * @param[in] avpkt The input AVPacket containing the input buffer.
3878 * You can create such packet with av_init_packet() and by then setting
3879 * data and size, some decoders might in addition need other fields like
3880 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3882 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3883 * @return On error a negative value is returned, otherwise the number of bytes
3884 * used or zero if no frame could be decompressed.
3886 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3887 int *got_picture_ptr,
3888 const AVPacket *avpkt);
3891 * Decode a subtitle message.
3892 * Return a negative value on error, otherwise return the number of bytes used.
3893 * If no subtitle could be decompressed, got_sub_ptr is zero.
3894 * Otherwise, the subtitle is stored in *sub.
3895 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3896 * simplicity, because the performance difference is expect to be negligible
3897 * and reusing a get_buffer written for video codecs would probably perform badly
3898 * due to a potentially very different allocation pattern.
3900 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3901 * and output. This means that for some packets they will not immediately
3902 * produce decoded output and need to be flushed at the end of decoding to get
3903 * all the decoded data. Flushing is done by calling this function with packets
3904 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3905 * returning subtitles. It is safe to flush even those decoders that are not
3906 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
3908 * @param avctx the codec context
3909 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3910 freed with avsubtitle_free if *got_sub_ptr is set.
3911 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3912 * @param[in] avpkt The input AVPacket containing the input buffer.
3914 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3919 * @defgroup lavc_parsing Frame parsing
3923 enum AVPictureStructure {
3924 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3925 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3926 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3927 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3930 typedef struct AVCodecParserContext {
3932 struct AVCodecParser *parser;
3933 int64_t frame_offset; /* offset of the current frame */
3934 int64_t cur_offset; /* current offset
3935 (incremented by each av_parser_parse()) */
3936 int64_t next_frame_offset; /* offset of the next frame */
3938 int pict_type; /* XXX: Put it back in AVCodecContext. */
3940 * This field is used for proper frame duration computation in lavf.
3941 * It signals, how much longer the frame duration of the current frame
3942 * is compared to normal frame duration.
3944 * frame_duration = (1 + repeat_pict) * time_base
3946 * It is used by codecs like H.264 to display telecined material.
3948 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3949 int64_t pts; /* pts of the current frame */
3950 int64_t dts; /* dts of the current frame */
3955 int fetch_timestamp;
3957 #define AV_PARSER_PTS_NB 4
3958 int cur_frame_start_index;
3959 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3960 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3961 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3964 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3965 #define PARSER_FLAG_ONCE 0x0002
3966 /// Set if the parser has a valid file offset
3967 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3968 #define PARSER_FLAG_USE_CODEC_TS 0x1000
3970 int64_t offset; ///< byte offset from starting packet start
3971 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3974 * Set by parser to 1 for key frames and 0 for non-key frames.
3975 * It is initialized to -1, so if the parser doesn't set this flag,
3976 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3982 * Time difference in stream time base units from the pts of this
3983 * packet to the point at which the output from the decoder has converged
3984 * independent from the availability of previous frames. That is, the
3985 * frames are virtually identical no matter if decoding started from
3986 * the very first frame or from this keyframe.
3987 * Is AV_NOPTS_VALUE if unknown.
3988 * This field is not the display duration of the current frame.
3989 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3992 * The purpose of this field is to allow seeking in streams that have no
3993 * keyframes in the conventional sense. It corresponds to the
3994 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3995 * essential for some types of subtitle streams to ensure that all
3996 * subtitles are correctly displayed after seeking.
3998 int64_t convergence_duration;
4000 // Timestamp generation support:
4002 * Synchronization point for start of timestamp generation.
4004 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4007 * For example, this corresponds to presence of H.264 buffering period
4013 * Offset of the current timestamp against last timestamp sync point in
4014 * units of AVCodecContext.time_base.
4016 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4017 * contain a valid timestamp offset.
4019 * Note that the timestamp of sync point has usually a nonzero
4020 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4021 * the next frame after timestamp sync point will be usually 1.
4023 * For example, this corresponds to H.264 cpb_removal_delay.
4025 int dts_ref_dts_delta;
4028 * Presentation delay of current frame in units of AVCodecContext.time_base.
4030 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4031 * contain valid non-negative timestamp delta (presentation time of a frame
4032 * must not lie in the past).
4034 * This delay represents the difference between decoding and presentation
4035 * time of the frame.
4037 * For example, this corresponds to H.264 dpb_output_delay.
4042 * Position of the packet in file.
4044 * Analogous to cur_frame_pts/dts
4046 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4049 * Byte position of currently parsed frame in stream.
4054 * Previous frame byte position.
4059 * Duration of the current frame.
4060 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4061 * For all other types, this is in units of AVCodecContext.time_base.
4065 enum AVFieldOrder field_order;
4068 * Indicate whether a picture is coded as a frame, top field or bottom field.
4070 * For example, H.264 field_pic_flag equal to 0 corresponds to
4071 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4072 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4073 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4075 enum AVPictureStructure picture_structure;
4078 * Picture number incremented in presentation or output order.
4079 * This field may be reinitialized at the first picture of a new sequence.
4081 * For example, this corresponds to H.264 PicOrderCnt.
4083 int output_picture_number;
4084 } AVCodecParserContext;
4086 typedef struct AVCodecParser {
4087 int codec_ids[5]; /* several codec IDs are permitted */
4089 int (*parser_init)(AVCodecParserContext *s);
4090 int (*parser_parse)(AVCodecParserContext *s,
4091 AVCodecContext *avctx,
4092 const uint8_t **poutbuf, int *poutbuf_size,
4093 const uint8_t *buf, int buf_size);
4094 void (*parser_close)(AVCodecParserContext *s);
4095 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4096 struct AVCodecParser *next;
4099 AVCodecParser *av_parser_next(AVCodecParser *c);
4101 void av_register_codec_parser(AVCodecParser *parser);
4102 AVCodecParserContext *av_parser_init(int codec_id);
4107 * @param s parser context.
4108 * @param avctx codec context.
4109 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4110 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4111 * @param buf input buffer.
4112 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4113 * @param pts input presentation timestamp.
4114 * @param dts input decoding timestamp.
4115 * @param pos input byte position in stream.
4116 * @return the number of bytes of the input bitstream used.
4121 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4128 * decode_frame(data, size);
4132 int av_parser_parse2(AVCodecParserContext *s,
4133 AVCodecContext *avctx,
4134 uint8_t **poutbuf, int *poutbuf_size,
4135 const uint8_t *buf, int buf_size,
4136 int64_t pts, int64_t dts,
4140 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4141 * @deprecated use AVBitStreamFilter
4143 int av_parser_change(AVCodecParserContext *s,
4144 AVCodecContext *avctx,
4145 uint8_t **poutbuf, int *poutbuf_size,
4146 const uint8_t *buf, int buf_size, int keyframe);
4147 void av_parser_close(AVCodecParserContext *s);
4155 * @addtogroup lavc_encoding
4160 * Find a registered encoder with a matching codec ID.
4162 * @param id AVCodecID of the requested encoder
4163 * @return An encoder if one was found, NULL otherwise.
4165 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4168 * Find a registered encoder with the specified name.
4170 * @param name name of the requested encoder
4171 * @return An encoder if one was found, NULL otherwise.
4173 AVCodec *avcodec_find_encoder_by_name(const char *name);
4175 #if FF_API_OLD_ENCODE_AUDIO
4177 * Encode an audio frame from samples into buf.
4179 * @deprecated Use avcodec_encode_audio2 instead.
4181 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4182 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4183 * will know how much space is needed because it depends on the value passed
4184 * in buf_size as described below. In that case a lower value can be used.
4186 * @param avctx the codec context
4187 * @param[out] buf the output buffer
4188 * @param[in] buf_size the output buffer size
4189 * @param[in] samples the input buffer containing the samples
4190 * The number of samples read from this buffer is frame_size*channels,
4191 * both of which are defined in avctx.
4192 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4193 * samples read from samples is equal to:
4194 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4195 * This also implies that av_get_bits_per_sample() must not return 0 for these
4197 * @return On error a negative value is returned, on success zero or the number
4198 * of bytes used to encode the data read from the input buffer.
4200 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4201 uint8_t *buf, int buf_size,
4202 const short *samples);
4206 * Encode a frame of audio.
4208 * Takes input samples from frame and writes the next output packet, if
4209 * available, to avpkt. The output packet does not necessarily contain data for
4210 * the most recent frame, as encoders can delay, split, and combine input frames
4211 * internally as needed.
4213 * @param avctx codec context
4214 * @param avpkt output AVPacket.
4215 * The user can supply an output buffer by setting
4216 * avpkt->data and avpkt->size prior to calling the
4217 * function, but if the size of the user-provided data is not
4218 * large enough, encoding will fail. If avpkt->data and
4219 * avpkt->size are set, avpkt->destruct must also be set. All
4220 * other AVPacket fields will be reset by the encoder using
4221 * av_init_packet(). If avpkt->data is NULL, the encoder will
4222 * allocate it. The encoder will set avpkt->size to the size
4223 * of the output packet.
4225 * If this function fails or produces no output, avpkt will be
4226 * freed using av_free_packet() (i.e. avpkt->destruct will be
4227 * called to free the user supplied buffer).
4228 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4229 * May be NULL when flushing an encoder that has the
4230 * CODEC_CAP_DELAY capability set.
4231 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4232 * can have any number of samples.
4233 * If it is not set, frame->nb_samples must be equal to
4234 * avctx->frame_size for all frames except the last.
4235 * The final frame may be smaller than avctx->frame_size.
4236 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4237 * output packet is non-empty, and to 0 if it is
4238 * empty. If the function returns an error, the
4239 * packet can be assumed to be invalid, and the
4240 * value of got_packet_ptr is undefined and should
4242 * @return 0 on success, negative error code on failure
4244 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4245 const AVFrame *frame, int *got_packet_ptr);
4247 #if FF_API_OLD_ENCODE_VIDEO
4249 * @deprecated use avcodec_encode_video2() instead.
4251 * Encode a video frame from pict into buf.
4252 * The input picture should be
4253 * stored using a specific format, namely avctx.pix_fmt.
4255 * @param avctx the codec context
4256 * @param[out] buf the output buffer for the bitstream of encoded frame
4257 * @param[in] buf_size the size of the output buffer in bytes
4258 * @param[in] pict the input picture to encode
4259 * @return On error a negative value is returned, on success zero or the number
4260 * of bytes used from the output buffer.
4262 attribute_deprecated
4263 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4264 const AVFrame *pict);
4268 * Encode a frame of video.
4270 * Takes input raw video data from frame and writes the next output packet, if
4271 * available, to avpkt. The output packet does not necessarily contain data for
4272 * the most recent frame, as encoders can delay and reorder input frames
4273 * internally as needed.
4275 * @param avctx codec context
4276 * @param avpkt output AVPacket.
4277 * The user can supply an output buffer by setting
4278 * avpkt->data and avpkt->size prior to calling the
4279 * function, but if the size of the user-provided data is not
4280 * large enough, encoding will fail. All other AVPacket fields
4281 * will be reset by the encoder using av_init_packet(). If
4282 * avpkt->data is NULL, the encoder will allocate it.
4283 * The encoder will set avpkt->size to the size of the
4284 * output packet. The returned data (if any) belongs to the
4285 * caller, he is responsible for freeing it.
4287 * If this function fails or produces no output, avpkt will be
4288 * freed using av_free_packet() (i.e. avpkt->destruct will be
4289 * called to free the user supplied buffer).
4290 * @param[in] frame AVFrame containing the raw video data to be encoded.
4291 * May be NULL when flushing an encoder that has the
4292 * CODEC_CAP_DELAY capability set.
4293 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4294 * output packet is non-empty, and to 0 if it is
4295 * empty. If the function returns an error, the
4296 * packet can be assumed to be invalid, and the
4297 * value of got_packet_ptr is undefined and should
4299 * @return 0 on success, negative error code on failure
4301 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4302 const AVFrame *frame, int *got_packet_ptr);
4304 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4305 const AVSubtitle *sub);
4312 #if FF_API_AVCODEC_RESAMPLE
4314 * @defgroup lavc_resample Audio resampling
4316 * @deprecated use libswresample instead
4320 struct ReSampleContext;
4321 struct AVResampleContext;
4323 typedef struct ReSampleContext ReSampleContext;
4326 * Initialize audio resampling context.
4328 * @param output_channels number of output channels
4329 * @param input_channels number of input channels
4330 * @param output_rate output sample rate
4331 * @param input_rate input sample rate
4332 * @param sample_fmt_out requested output sample format
4333 * @param sample_fmt_in input sample format
4334 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4335 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4336 * @param linear if 1 then the used FIR filter will be linearly interpolated
4337 between the 2 closest, if 0 the closest will be used
4338 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4339 * @return allocated ReSampleContext, NULL if error occurred
4341 attribute_deprecated
4342 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4343 int output_rate, int input_rate,
4344 enum AVSampleFormat sample_fmt_out,
4345 enum AVSampleFormat sample_fmt_in,
4346 int filter_length, int log2_phase_count,
4347 int linear, double cutoff);
4349 attribute_deprecated
4350 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4353 * Free resample context.
4355 * @param s a non-NULL pointer to a resample context previously
4356 * created with av_audio_resample_init()
4358 attribute_deprecated
4359 void audio_resample_close(ReSampleContext *s);
4363 * Initialize an audio resampler.
4364 * Note, if either rate is not an integer then simply scale both rates up so they are.
4365 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4366 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4367 * @param linear If 1 then the used FIR filter will be linearly interpolated
4368 between the 2 closest, if 0 the closest will be used
4369 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4371 attribute_deprecated
4372 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4375 * Resample an array of samples using a previously configured context.
4376 * @param src an array of unconsumed samples
4377 * @param consumed the number of samples of src which have been consumed are returned here
4378 * @param src_size the number of unconsumed samples available
4379 * @param dst_size the amount of space in samples available in dst
4380 * @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.
4381 * @return the number of samples written in dst or -1 if an error occurred
4383 attribute_deprecated
4384 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4388 * Compensate samplerate/timestamp drift. The compensation is done by changing
4389 * the resampler parameters, so no audible clicks or similar distortions occur
4390 * @param compensation_distance distance in output samples over which the compensation should be performed
4391 * @param sample_delta number of output samples which should be output less
4393 * example: av_resample_compensate(c, 10, 500)
4394 * here instead of 510 samples only 500 samples would be output
4396 * note, due to rounding the actual compensation might be slightly different,
4397 * especially if the compensation_distance is large and the in_rate used during init is small
4399 attribute_deprecated
4400 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4401 attribute_deprecated
4402 void av_resample_close(struct AVResampleContext *c);
4410 * @addtogroup lavc_picture
4415 * Allocate memory for the pixels of a picture and setup the AVPicture
4418 * Call avpicture_free() to free it.
4420 * @param picture the picture structure to be filled in
4421 * @param pix_fmt the pixel format of the picture
4422 * @param width the width of the picture
4423 * @param height the height of the picture
4424 * @return zero if successful, a negative error code otherwise
4426 * @see av_image_alloc(), avpicture_fill()
4428 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4431 * Free a picture previously allocated by avpicture_alloc().
4432 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4435 * @param picture the AVPicture to be freed
4437 void avpicture_free(AVPicture *picture);
4440 * Setup the picture fields based on the specified image parameters
4441 * and the provided image data buffer.
4443 * The picture fields are filled in by using the image data buffer
4444 * pointed to by ptr.
4446 * If ptr is NULL, the function will fill only the picture linesize
4447 * array and return the required size for the image buffer.
4449 * To allocate an image buffer and fill the picture data in one call,
4450 * use avpicture_alloc().
4452 * @param picture the picture to be filled in
4453 * @param ptr buffer where the image data is stored, or NULL
4454 * @param pix_fmt the pixel format of the image
4455 * @param width the width of the image in pixels
4456 * @param height the height of the image in pixels
4457 * @return the size in bytes required for src, a negative error code
4458 * in case of failure
4460 * @see av_image_fill_arrays()
4462 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4463 enum AVPixelFormat pix_fmt, int width, int height);
4466 * Copy pixel data from an AVPicture into a buffer.
4468 * avpicture_get_size() can be used to compute the required size for
4469 * the buffer to fill.
4471 * @param src source picture with filled data
4472 * @param pix_fmt picture pixel format
4473 * @param width picture width
4474 * @param height picture height
4475 * @param dest destination buffer
4476 * @param dest_size destination buffer size in bytes
4477 * @return the number of bytes written to dest, or a negative value
4478 * (error code) on error, for example if the destination buffer is not
4481 * @see av_image_copy_to_buffer()
4483 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4484 int width, int height,
4485 unsigned char *dest, int dest_size);
4488 * Calculate the size in bytes that a picture of the given width and height
4489 * would occupy if stored in the given picture format.
4491 * @param pix_fmt picture pixel format
4492 * @param width picture width
4493 * @param height picture height
4494 * @return the computed picture buffer size or a negative error code
4497 * @see av_image_get_buffer_size().
4499 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4501 #if FF_API_DEINTERLACE
4503 * deinterlace - if not supported return -1
4505 * @deprecated - use yadif (in libavfilter) instead
4507 attribute_deprecated
4508 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4509 enum AVPixelFormat pix_fmt, int width, int height);
4512 * Copy image src to dst. Wraps av_image_copy().
4514 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4515 enum AVPixelFormat pix_fmt, int width, int height);
4518 * Crop image top and left side.
4520 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4521 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4526 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4527 int padtop, int padbottom, int padleft, int padright, int *color);
4534 * @defgroup lavc_misc Utility functions
4537 * Miscellaneous utility functions related to both encoding and decoding
4543 * @defgroup lavc_misc_pixfmt Pixel formats
4545 * Functions for working with pixel formats.
4550 * Utility function to access log2_chroma_w log2_chroma_h from
4551 * the pixel format AVPixFmtDescriptor.
4553 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4554 * for one that returns a failure code and continues in case of invalid
4557 * @param[in] pix_fmt the pixel format
4558 * @param[out] h_shift store log2_chroma_w
4559 * @param[out] v_shift store log2_chroma_h
4561 * @see av_pix_fmt_get_chroma_sub_sample
4564 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4567 * Return a value representing the fourCC code associated to the
4568 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4571 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4573 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4574 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4575 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4576 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4577 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4578 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4581 * Compute what kind of losses will occur when converting from one specific
4582 * pixel format to another.
4583 * When converting from one pixel format to another, information loss may occur.
4584 * For example, when converting from RGB24 to GRAY, the color information will
4585 * be lost. Similarly, other losses occur when converting from some formats to
4586 * other formats. These losses can involve loss of chroma, but also loss of
4587 * resolution, loss of color depth, loss due to the color space conversion, loss
4588 * of the alpha bits or loss due to color quantization.
4589 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4590 * which will occur when converting from one pixel format to another.
4592 * @param[in] dst_pix_fmt destination pixel format
4593 * @param[in] src_pix_fmt source pixel format
4594 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4595 * @return Combination of flags informing you what kind of losses will occur
4596 * (maximum loss for an invalid dst_pix_fmt).
4598 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4602 * Find the best pixel format to convert to given a certain source pixel
4603 * format. When converting from one pixel format to another, information loss
4604 * may occur. For example, when converting from RGB24 to GRAY, the color
4605 * information will be lost. Similarly, other losses occur when converting from
4606 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4607 * the given pixel formats should be used to suffer the least amount of loss.
4608 * The pixel formats from which it chooses one, are determined by the
4609 * pix_fmt_list parameter.
4612 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4613 * @param[in] src_pix_fmt source pixel format
4614 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4615 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4616 * @return The best pixel format to convert to or -1 if none was found.
4618 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4619 enum AVPixelFormat src_pix_fmt,
4620 int has_alpha, int *loss_ptr);
4623 * Find the best pixel format to convert to given a certain source pixel
4624 * format and a selection of two destination pixel formats. When converting from
4625 * one pixel format to another, information loss may occur. For example, when converting
4626 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4627 * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4628 * the given pixel formats should be used to suffer the least amount of loss.
4630 * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be
4634 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4635 * dst_pix_fmt1= AV_PIX_FMT_RGB24;
4636 * dst_pix_fmt2= AV_PIX_FMT_GRAY8;
4637 * dst_pix_fmt3= AV_PIX_FMT_RGB8;
4638 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4639 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4640 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4643 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4644 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4645 * @param[in] src_pix_fmt Source pixel format
4646 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4647 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4648 * NULL or value of zero means we care about all losses. Out: the loss
4649 * that occurs when converting from src to selected dst pixel format.
4650 * @return The best pixel format to convert to or -1 if none was found.
4652 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4653 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4655 attribute_deprecated
4656 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
4657 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
4658 enum AVPixelFormat src_pix_fmt,
4659 int has_alpha, int *loss_ptr);
4661 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4662 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4666 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4672 #if FF_API_SET_DIMENSIONS
4674 * @deprecated this function is not supposed to be used from outside of lavc
4676 attribute_deprecated
4677 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4681 * Put a string representing the codec tag codec_tag in buf.
4683 * @param buf_size size in bytes of buf
4684 * @return the length of the string that would have been generated if
4685 * enough space had been available, excluding the trailing null
4687 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4689 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4692 * Return a name for the specified profile, if available.
4694 * @param codec the codec that is searched for the given profile
4695 * @param profile the profile value for which a name is requested
4696 * @return A name for the profile if found, NULL otherwise.
4698 const char *av_get_profile_name(const AVCodec *codec, int profile);
4700 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4701 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4702 //FIXME func typedef
4705 * Fill AVFrame audio data and linesize pointers.
4707 * The buffer buf must be a preallocated buffer with a size big enough
4708 * to contain the specified samples amount. The filled AVFrame data
4709 * pointers will point to this buffer.
4711 * AVFrame extended_data channel pointers are allocated if necessary for
4714 * @param frame the AVFrame
4715 * frame->nb_samples must be set prior to calling the
4716 * function. This function fills in frame->data,
4717 * frame->extended_data, frame->linesize[0].
4718 * @param nb_channels channel count
4719 * @param sample_fmt sample format
4720 * @param buf buffer to use for frame data
4721 * @param buf_size size of buffer
4722 * @param align plane size sample alignment (0 = default)
4723 * @return >=0 on success, negative error code on failure
4724 * @todo return the size in bytes required to store the samples in
4725 * case of success, at the next libavutil bump
4727 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4728 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4729 int buf_size, int align);
4732 * Reset the internal decoder state / flush internal buffers. Should be called
4733 * e.g. when seeking or when switching to a different stream.
4735 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4736 * this invalidates the frames previously returned from the decoder. When
4737 * refcounted frames are used, the decoder just releases any references it might
4738 * keep internally, but the caller's reference remains valid.
4740 void avcodec_flush_buffers(AVCodecContext *avctx);
4743 * Return codec bits per sample.
4745 * @param[in] codec_id the codec
4746 * @return Number of bits per sample or zero if unknown for the given codec.
4748 int av_get_bits_per_sample(enum AVCodecID codec_id);
4751 * Return the PCM codec associated with a sample format.
4752 * @param be endianness, 0 for little, 1 for big,
4753 * -1 (or anything else) for native
4754 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4756 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4759 * Return codec bits per sample.
4760 * Only return non-zero if the bits per sample is exactly correct, not an
4763 * @param[in] codec_id the codec
4764 * @return Number of bits per sample or zero if unknown for the given codec.
4766 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4769 * Return audio frame duration.
4771 * @param avctx codec context
4772 * @param frame_bytes size of the frame, or 0 if unknown
4773 * @return frame duration, in samples, if known. 0 if not able to
4776 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4779 typedef struct AVBitStreamFilterContext {
4781 struct AVBitStreamFilter *filter;
4782 AVCodecParserContext *parser;
4783 struct AVBitStreamFilterContext *next;
4784 } AVBitStreamFilterContext;
4787 typedef struct AVBitStreamFilter {
4790 int (*filter)(AVBitStreamFilterContext *bsfc,
4791 AVCodecContext *avctx, const char *args,
4792 uint8_t **poutbuf, int *poutbuf_size,
4793 const uint8_t *buf, int buf_size, int keyframe);
4794 void (*close)(AVBitStreamFilterContext *bsfc);
4795 struct AVBitStreamFilter *next;
4796 } AVBitStreamFilter;
4799 * Register a bitstream filter.
4801 * The filter will be accessible to the application code through
4802 * av_bitstream_filter_next() or can be directly initialized with
4803 * av_bitstream_filter_init().
4805 * @see avcodec_register_all()
4807 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4810 * Create and initialize a bitstream filter context given a bitstream
4813 * The returned context must be freed with av_bitstream_filter_close().
4815 * @param name the name of the bitstream filter
4816 * @return a bitstream filter context if a matching filter was found
4817 * and successfully initialized, NULL otherwise
4819 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4824 * This function filters the buffer buf with size buf_size, and places the
4825 * filtered buffer in the buffer pointed to by poutbuf.
4827 * The output buffer must be freed by the caller.
4829 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
4830 * @param avctx AVCodecContext accessed by the filter, may be NULL.
4831 * If specified, this must point to the encoder context of the
4832 * output stream the packet is sent to.
4833 * @param args arguments which specify the filter configuration, may be NULL
4834 * @param poutbuf pointer which is updated to point to the filtered buffer
4835 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
4836 * @param buf buffer containing the data to filter
4837 * @param buf_size size in bytes of buf
4838 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
4839 * @return >= 0 in case of success, or a negative error code in case of failure
4841 * If the return value is positive, an output buffer is allocated and
4842 * is availble in *poutbuf, and is distinct from the input buffer.
4844 * If the return value is 0, the output buffer is not allocated and
4845 * should be considered identical to the input buffer, or in case
4846 * *poutbuf was set it points to the input buffer (not necessarily to
4847 * its starting address).
4849 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4850 AVCodecContext *avctx, const char *args,
4851 uint8_t **poutbuf, int *poutbuf_size,
4852 const uint8_t *buf, int buf_size, int keyframe);
4855 * Release bitstream filter context.
4857 * @param bsf the bitstream filter context created with
4858 * av_bitstream_filter_init(), can be NULL
4860 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4863 * If f is NULL, return the first registered bitstream filter,
4864 * if f is non-NULL, return the next registered bitstream filter
4865 * after f, or NULL if f is the last one.
4867 * This function can be used to iterate over all registered bitstream
4870 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4875 * Same behaviour av_fast_malloc but the buffer has additional
4876 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
4878 * In addition the whole buffer will initially and after resizes
4879 * be 0-initialized so that no uninitialized data will ever appear.
4881 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4884 * Same behaviour av_fast_padded_malloc except that buffer will always
4885 * be 0-initialized after call.
4887 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4890 * Encode extradata length to a buffer. Used by xiph codecs.
4892 * @param s buffer to write to; must be at least (v/255+1) bytes long
4893 * @param v size of extradata in bytes
4894 * @return number of bytes written to the buffer.
4896 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4898 #if FF_API_MISSING_SAMPLE
4900 * Log a generic warning message about a missing feature. This function is
4901 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4902 * only, and would normally not be used by applications.
4903 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4904 * a pointer to an AVClass struct
4905 * @param[in] feature string containing the name of the missing feature
4906 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4907 * If want_sample is non-zero, additional verbage will be added to the log
4908 * message which tells the user how to report samples to the development
4910 * @deprecated Use avpriv_report_missing_feature() instead.
4912 attribute_deprecated
4913 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4916 * Log a generic warning message asking for a sample. This function is
4917 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4918 * only, and would normally not be used by applications.
4919 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4920 * a pointer to an AVClass struct
4921 * @param[in] msg string containing an optional message, or NULL if no message
4922 * @deprecated Use avpriv_request_sample() instead.
4924 attribute_deprecated
4925 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4926 #endif /* FF_API_MISSING_SAMPLE */
4929 * Register the hardware accelerator hwaccel.
4931 void av_register_hwaccel(AVHWAccel *hwaccel);
4934 * If hwaccel is NULL, returns the first registered hardware accelerator,
4935 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4936 * after hwaccel, or NULL if hwaccel is the last one.
4938 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4942 * Lock operation used by lockmgr
4945 AV_LOCK_CREATE, ///< Create a mutex
4946 AV_LOCK_OBTAIN, ///< Lock the mutex
4947 AV_LOCK_RELEASE, ///< Unlock the mutex
4948 AV_LOCK_DESTROY, ///< Free mutex resources
4952 * Register a user provided lock manager supporting the operations
4953 * specified by AVLockOp. mutex points to a (void *) where the
4954 * lockmgr should store/get a pointer to a user allocated mutex. It's
4955 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4957 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4958 * callback during the call to av_lockmgr_register().
4959 * Thus, the application must be prepared to handle that.
4960 * If cb is set to NULL the lockmgr will be unregistered.
4961 * Also note that during unregistration the previously registered
4962 * lockmgr callback may also be invoked.
4964 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4967 * Get the type of the given codec.
4969 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4972 * Get the name of a codec.
4973 * @return a static string identifying the codec; never NULL
4975 const char *avcodec_get_name(enum AVCodecID id);
4978 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4979 * with no corresponding avcodec_close()), 0 otherwise.
4981 int avcodec_is_open(AVCodecContext *s);
4984 * @return a non-zero number if codec is an encoder, zero otherwise
4986 int av_codec_is_encoder(const AVCodec *codec);
4989 * @return a non-zero number if codec is a decoder, zero otherwise
4991 int av_codec_is_decoder(const AVCodec *codec);
4994 * @return descriptor for given codec ID or NULL if no descriptor exists.
4996 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4999 * Iterate over all codec descriptors known to libavcodec.
5001 * @param prev previous descriptor. NULL to get the first descriptor.
5003 * @return next descriptor or NULL after the last descriptor
5005 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5008 * @return codec descriptor with the given name or NULL if no such descriptor
5011 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5017 #endif /* AVCODEC_AVCODEC_H */