2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/log.h"
40 #include "libavutil/pixfmt.h"
41 #include "libavutil/rational.h"
46 * @defgroup libavc Encoding/Decoding Library
49 * @defgroup lavc_decoding Decoding
53 * @defgroup lavc_encoding Encoding
57 * @defgroup lavc_codec Codecs
59 * @defgroup lavc_codec_native Native Codecs
62 * @defgroup lavc_codec_wrappers External library wrappers
65 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
69 * @defgroup lavc_internal Internal
77 * @defgroup lavc_core Core functions/structures.
80 * Basic definitions, functions for querying libavcodec capabilities,
81 * allocating core structures, etc.
87 * Identify the syntax and semantics of the bitstream.
88 * The principle is roughly:
89 * Two decoders with the same ID can decode the same streams.
90 * Two encoders with the same ID can encode compatible streams.
91 * There may be slight deviations from the principle due to implementation
94 * If you add a codec ID to this list, add it so that
95 * 1. no value of a existing codec ID changes (that would break ABI),
96 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
97 * This ensures that 2 forks can independently add AVCodecIDs without producing conflicts.
99 * After adding new codec IDs, do not forget to add an entry to the codec
100 * descriptor list and bump libavcodec minor version.
106 AV_CODEC_ID_MPEG1VIDEO,
107 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
109 AV_CODEC_ID_MPEG2VIDEO_XVMC,
110 #endif /* FF_API_XVMC */
121 AV_CODEC_ID_RAWVIDEO,
122 AV_CODEC_ID_MSMPEG4V1,
123 AV_CODEC_ID_MSMPEG4V2,
124 AV_CODEC_ID_MSMPEG4V3,
147 AV_CODEC_ID_INTERPLAY_VIDEO,
154 AV_CODEC_ID_MSVIDEO1,
159 AV_CODEC_ID_TRUEMOTION1,
160 AV_CODEC_ID_VMDVIDEO,
185 AV_CODEC_ID_TRUEMOTION2,
191 AV_CODEC_ID_SMACKVIDEO,
196 AV_CODEC_ID_JPEG2000,
202 AV_CODEC_ID_DSICINVIDEO,
203 AV_CODEC_ID_TIERTEXSEQVIDEO,
211 AV_CODEC_ID_BETHSOFTVID,
223 AV_CODEC_ID_ESCAPE124,
227 AV_CODEC_ID_MOTIONPIXELS,
239 AV_CODEC_ID_FLASHSV2,
240 AV_CODEC_ID_CDGRAPHICS,
243 AV_CODEC_ID_BINKVIDEO,
244 AV_CODEC_ID_IFF_ILBM,
245 AV_CODEC_ID_IFF_BYTERUN1,
251 AV_CODEC_ID_A64_MULTI,
252 AV_CODEC_ID_A64_MULTI5,
255 AV_CODEC_ID_LAGARITH,
259 AV_CODEC_ID_WMV3IMAGE,
260 AV_CODEC_ID_VC1IMAGE,
262 AV_CODEC_ID_BMV_VIDEO,
269 AV_CODEC_ID_ZEROCODEC,
278 AV_CODEC_ID_ESCAPE130_DEPRECATED,
279 AV_CODEC_ID_G2M_DEPRECATED,
280 AV_CODEC_ID_WEBP_DEPRECATED,
281 AV_CODEC_ID_HNM4_VIDEO,
282 AV_CODEC_ID_HEVC_DEPRECATED,
284 AV_CODEC_ID_ALIAS_PIX,
285 AV_CODEC_ID_BRENDER_PIX_DEPRECATED,
286 AV_CODEC_ID_PAF_VIDEO_DEPRECATED,
287 AV_CODEC_ID_EXR_DEPRECATED,
288 AV_CODEC_ID_VP7_DEPRECATED,
289 AV_CODEC_ID_SANM_DEPRECATED,
290 AV_CODEC_ID_SGIRLE_DEPRECATED,
291 AV_CODEC_ID_MVC1_DEPRECATED,
292 AV_CODEC_ID_MVC2_DEPRECATED,
295 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
296 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
297 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
298 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
299 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
301 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
302 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
303 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
304 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
305 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
306 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
307 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
308 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
309 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
310 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
311 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
312 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
313 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
314 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
315 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
316 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
317 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
318 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
319 AV_CODEC_ID_SMVJPEG = MKBETAG('S','M','V','J'),
320 AV_CODEC_ID_HEVC = MKBETAG('H','2','6','5'),
321 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
322 AV_CODEC_ID_VP7 = MKBETAG('V','P','7','0'),
323 AV_CODEC_ID_APNG = MKBETAG('A','P','N','G'),
325 /* various PCM "codecs" */
326 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
327 AV_CODEC_ID_PCM_S16LE = 0x10000,
328 AV_CODEC_ID_PCM_S16BE,
329 AV_CODEC_ID_PCM_U16LE,
330 AV_CODEC_ID_PCM_U16BE,
333 AV_CODEC_ID_PCM_MULAW,
334 AV_CODEC_ID_PCM_ALAW,
335 AV_CODEC_ID_PCM_S32LE,
336 AV_CODEC_ID_PCM_S32BE,
337 AV_CODEC_ID_PCM_U32LE,
338 AV_CODEC_ID_PCM_U32BE,
339 AV_CODEC_ID_PCM_S24LE,
340 AV_CODEC_ID_PCM_S24BE,
341 AV_CODEC_ID_PCM_U24LE,
342 AV_CODEC_ID_PCM_U24BE,
343 AV_CODEC_ID_PCM_S24DAUD,
344 AV_CODEC_ID_PCM_ZORK,
345 AV_CODEC_ID_PCM_S16LE_PLANAR,
347 AV_CODEC_ID_PCM_F32BE,
348 AV_CODEC_ID_PCM_F32LE,
349 AV_CODEC_ID_PCM_F64BE,
350 AV_CODEC_ID_PCM_F64LE,
351 AV_CODEC_ID_PCM_BLURAY,
354 AV_CODEC_ID_PCM_S8_PLANAR,
355 AV_CODEC_ID_PCM_S24LE_PLANAR_DEPRECATED,
356 AV_CODEC_ID_PCM_S32LE_PLANAR_DEPRECATED,
357 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
358 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
359 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
361 /* various ADPCM codecs */
362 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
363 AV_CODEC_ID_ADPCM_IMA_WAV,
364 AV_CODEC_ID_ADPCM_IMA_DK3,
365 AV_CODEC_ID_ADPCM_IMA_DK4,
366 AV_CODEC_ID_ADPCM_IMA_WS,
367 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
368 AV_CODEC_ID_ADPCM_MS,
369 AV_CODEC_ID_ADPCM_4XM,
370 AV_CODEC_ID_ADPCM_XA,
371 AV_CODEC_ID_ADPCM_ADX,
372 AV_CODEC_ID_ADPCM_EA,
373 AV_CODEC_ID_ADPCM_G726,
374 AV_CODEC_ID_ADPCM_CT,
375 AV_CODEC_ID_ADPCM_SWF,
376 AV_CODEC_ID_ADPCM_YAMAHA,
377 AV_CODEC_ID_ADPCM_SBPRO_4,
378 AV_CODEC_ID_ADPCM_SBPRO_3,
379 AV_CODEC_ID_ADPCM_SBPRO_2,
380 AV_CODEC_ID_ADPCM_THP,
381 AV_CODEC_ID_ADPCM_IMA_AMV,
382 AV_CODEC_ID_ADPCM_EA_R1,
383 AV_CODEC_ID_ADPCM_EA_R3,
384 AV_CODEC_ID_ADPCM_EA_R2,
385 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
386 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
387 AV_CODEC_ID_ADPCM_EA_XAS,
388 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
389 AV_CODEC_ID_ADPCM_IMA_ISS,
390 AV_CODEC_ID_ADPCM_G722,
391 AV_CODEC_ID_ADPCM_IMA_APC,
392 AV_CODEC_ID_ADPCM_VIMA_DEPRECATED,
393 AV_CODEC_ID_ADPCM_VIMA = MKBETAG('V','I','M','A'),
394 #if FF_API_VIMA_DECODER
395 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
397 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
398 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
399 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
400 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
401 AV_CODEC_ID_ADPCM_G726LE = MKBETAG('6','2','7','G'),
404 AV_CODEC_ID_AMR_NB = 0x12000,
407 /* RealAudio codecs*/
408 AV_CODEC_ID_RA_144 = 0x13000,
411 /* various DPCM codecs */
412 AV_CODEC_ID_ROQ_DPCM = 0x14000,
413 AV_CODEC_ID_INTERPLAY_DPCM,
414 AV_CODEC_ID_XAN_DPCM,
415 AV_CODEC_ID_SOL_DPCM,
418 AV_CODEC_ID_MP2 = 0x15000,
419 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
429 AV_CODEC_ID_VMDAUDIO,
435 AV_CODEC_ID_WESTWOOD_SND1,
436 AV_CODEC_ID_GSM, ///< as in Berlin toast format
439 AV_CODEC_ID_TRUESPEECH,
441 AV_CODEC_ID_SMACKAUDIO,
444 AV_CODEC_ID_DSICINAUDIO,
446 AV_CODEC_ID_MUSEPACK7,
448 AV_CODEC_ID_GSM_MS, /* as found in WAV */
454 AV_CODEC_ID_NELLYMOSER,
455 AV_CODEC_ID_MUSEPACK8,
457 AV_CODEC_ID_WMAVOICE,
459 AV_CODEC_ID_WMALOSSLESS,
468 AV_CODEC_ID_BINKAUDIO_RDFT,
469 AV_CODEC_ID_BINKAUDIO_DCT,
470 AV_CODEC_ID_AAC_LATM,
475 AV_CODEC_ID_8SVX_EXP,
476 AV_CODEC_ID_8SVX_FIB,
477 AV_CODEC_ID_BMV_AUDIO,
481 AV_CODEC_ID_OPUS_DEPRECATED,
482 AV_CODEC_ID_COMFORT_NOISE,
483 AV_CODEC_ID_TAK_DEPRECATED,
484 AV_CODEC_ID_METASOUND,
485 AV_CODEC_ID_PAF_AUDIO_DEPRECATED,
488 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
489 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
490 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
491 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
492 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
493 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
494 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
495 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
496 AV_CODEC_ID_DSD_LSBF = MKBETAG('D','S','D','L'),
497 AV_CODEC_ID_DSD_MSBF = MKBETAG('D','S','D','M'),
498 AV_CODEC_ID_DSD_LSBF_PLANAR = MKBETAG('D','S','D','1'),
499 AV_CODEC_ID_DSD_MSBF_PLANAR = MKBETAG('D','S','D','8'),
501 /* subtitle codecs */
502 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
503 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
504 AV_CODEC_ID_DVB_SUBTITLE,
505 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
508 AV_CODEC_ID_MOV_TEXT,
509 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
510 AV_CODEC_ID_DVB_TELETEXT,
512 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
513 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
514 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
515 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
516 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
517 AV_CODEC_ID_STL = MKBETAG('S','p','T','L'),
518 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
519 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
520 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
521 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
522 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
523 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
524 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
525 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
527 /* other specific kind of codecs (generally used for attachments) */
528 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
529 AV_CODEC_ID_TTF = 0x18000,
530 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
531 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
532 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
533 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
534 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
535 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
536 AV_CODEC_ID_TIMED_ID3 = MKBETAG('T','I','D','3'),
537 AV_CODEC_ID_BIN_DATA = MKBETAG('D','A','T','A'),
540 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
542 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
543 * stream (only used by libavformat) */
544 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
545 * stream (only used by libavformat) */
546 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
549 #include "old_codec_ids.h"
554 * This struct describes the properties of a single codec described by an
556 * @see avcodec_descriptor_get()
558 typedef struct AVCodecDescriptor {
560 enum AVMediaType type;
562 * Name of the codec described by this descriptor. It is non-empty and
563 * unique for each codec descriptor. It should contain alphanumeric
564 * characters and '_' only.
568 * A more descriptive name for this codec. May be NULL.
570 const char *long_name;
572 * Codec properties, a combination of AV_CODEC_PROP_* flags.
577 * MIME type(s) associated with the codec.
578 * May be NULL; if not, a NULL-terminated array of MIME types.
579 * The first item is always non-NULL and is the preferred MIME type.
581 const char *const *mime_types;
585 * Codec uses only intra compression.
588 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
590 * Codec supports lossy compression. Audio and video codecs only.
591 * @note a codec may support both lossy and lossless
594 #define AV_CODEC_PROP_LOSSY (1 << 1)
596 * Codec supports lossless compression. Audio and video codecs only.
598 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
600 * Codec supports frame reordering. That is, the coded order (the order in which
601 * the encoded packets are output by the encoders / stored / input to the
602 * decoders) may be different from the presentation order of the corresponding
605 * For codecs that do not have this property set, PTS and DTS should always be
608 #define AV_CODEC_PROP_REORDER (1 << 3)
610 * Subtitle codec is bitmap based
611 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
613 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
615 * Subtitle codec is text based.
616 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
618 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
621 * @ingroup lavc_decoding
622 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
623 * This is mainly needed because some optimized bitstream readers read
624 * 32 or 64 bit at once and could read over the end.<br>
625 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
626 * MPEG bitstreams could cause overread and segfault.
628 #define FF_INPUT_BUFFER_PADDING_SIZE 32
631 * @ingroup lavc_encoding
632 * minimum encoding buffer size
633 * Used to avoid some checks during header writing.
635 #define FF_MIN_BUFFER_SIZE 16384
639 * @ingroup lavc_encoding
640 * motion estimation type.
643 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
647 ME_EPZS, ///< enhanced predictive zonal search
648 ME_X1, ///< reserved for experiments
649 ME_HEX, ///< hexagon based search
650 ME_UMH, ///< uneven multi-hexagon search
651 ME_TESA, ///< transformed exhaustive search algorithm
652 ME_ITER=50, ///< iterative search
656 * @ingroup lavc_decoding
659 /* We leave some space between them for extensions (drop some
660 * keyframes for intra-only or drop just some bidir frames). */
661 AVDISCARD_NONE =-16, ///< discard nothing
662 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
663 AVDISCARD_NONREF = 8, ///< discard all non reference
664 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
665 AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
666 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
667 AVDISCARD_ALL = 48, ///< discard all
670 enum AVAudioServiceType {
671 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
672 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
673 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
674 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
675 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
676 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
677 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
678 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
679 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
680 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
684 * @ingroup lavc_encoding
686 typedef struct RcOverride{
689 int qscale; // If this is 0 then quality_factor will be used instead.
690 float quality_factor;
693 #if FF_API_MAX_BFRAMES
695 * @deprecated there is no libavcodec-wide limit on the number of B-frames
697 #define FF_MAX_B_FRAMES 16
701 These flags can be passed in AVCodecContext.flags before initialization.
702 Note: Not everything is supported yet.
706 * Allow decoders to produce frames with data planes that are not aligned
707 * to CPU requirements (e.g. due to cropping).
709 #define CODEC_FLAG_UNALIGNED 0x0001
710 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
711 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
712 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
713 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
716 * @deprecated use the "gmc" private option of the libxvid encoder
718 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
722 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
725 #define CODEC_FLAG_MV0 0x0040
727 #if FF_API_INPUT_PRESERVED
729 * @deprecated passing reference-counted frames to the encoders replaces this
732 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
734 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
735 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
736 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
739 * @deprecated edges are not used/required anymore. I.e. this flag is now always
742 #define CODEC_FLAG_EMU_EDGE 0x4000
744 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
745 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
746 location instead of only at frame boundaries. */
747 #if FF_API_NORMALIZE_AQP
749 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
752 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
754 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
755 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
756 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
757 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
758 /* Fx : Flag for h263+ extra options */
759 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
760 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
761 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
762 #define CODEC_FLAG_CLOSED_GOP 0x80000000
763 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
764 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
765 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
766 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
767 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
769 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
770 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
771 #define CODEC_FLAG2_EXPORT_MVS 0x10000000 ///< Export motion vectors through frame side data
772 #define CODEC_FLAG2_SKIP_MANUAL 0x20000000 ///< Do not skip samples and export skip information as frame side data
774 /* Unsupported options :
775 * Syntax Arithmetic coding (SAC)
776 * Reference Picture Selection
777 * Independent Segment Decoding */
779 /* codec capabilities */
781 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
783 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
784 * If not set, it might not use get_buffer() at all or use operations that
785 * assume the buffer was allocated by avcodec_default_get_buffer.
787 #define CODEC_CAP_DR1 0x0002
788 #define CODEC_CAP_TRUNCATED 0x0008
790 /* Codec can export data for HW decoding. This flag indicates that
791 * the codec would call get_format() with list that might contain HW accelerated
792 * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
793 * including raw image format.
794 * The application can use the passed context to determine bitstream version,
795 * chroma format, resolution etc.
797 #define CODEC_CAP_HWACCEL 0x0010
798 #endif /* FF_API_XVMC */
800 * Encoder or decoder requires flushing with NULL input at the end in order to
801 * give the complete and correct output.
803 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
804 * with NULL data. The user can still send NULL data to the public encode
805 * or decode function, but libavcodec will not pass it along to the codec
806 * unless this flag is set.
809 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
810 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
814 * The encoder needs to be fed with NULL data at the end of encoding until the
815 * encoder no longer returns data.
817 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
818 * flag also means that the encoder must set the pts and duration for
819 * each output packet. If this flag is not set, the pts and duration will
820 * be determined by libavcodec from the input frame.
822 #define CODEC_CAP_DELAY 0x0020
824 * Codec can be fed a final frame with a smaller size.
825 * This can be used to prevent truncation of the last audio samples.
827 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
830 * Codec can export data for HW decoding (VDPAU).
832 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
835 * Codec can output multiple frames per AVPacket
836 * Normally demuxers return one frame at a time, demuxers which do not do
837 * are connected to a parser to split what they return into proper frames.
838 * This flag is reserved to the very rare category of codecs which have a
839 * bitstream that cannot be split into frames without timeconsuming
840 * operations like full decoding. Demuxers carring such bitstreams thus
841 * may return multiple frames in a packet. This has many disadvantages like
842 * prohibiting stream copy in many cases thus it should only be considered
845 #define CODEC_CAP_SUBFRAMES 0x0100
847 * Codec is experimental and is thus avoided in favor of non experimental
850 #define CODEC_CAP_EXPERIMENTAL 0x0200
852 * Codec should fill in channel configuration and samplerate instead of container
854 #define CODEC_CAP_CHANNEL_CONF 0x0400
855 #if FF_API_NEG_LINESIZES
857 * @deprecated no codecs use this capability
859 #define CODEC_CAP_NEG_LINESIZES 0x0800
862 * Codec supports frame-level multithreading.
864 #define CODEC_CAP_FRAME_THREADS 0x1000
866 * Codec supports slice-based (or partition-based) multithreading.
868 #define CODEC_CAP_SLICE_THREADS 0x2000
870 * Codec supports changed parameters at any point.
872 #define CODEC_CAP_PARAM_CHANGE 0x4000
874 * Codec supports avctx->thread_count == 0 (auto).
876 #define CODEC_CAP_AUTO_THREADS 0x8000
878 * Audio encoder supports receiving a different number of samples in each call.
880 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
882 * Codec is intra only.
884 #define CODEC_CAP_INTRA_ONLY 0x40000000
888 #define CODEC_CAP_LOSSLESS 0x80000000
891 //The following defines may change, don't expect compatibility if you use them.
892 #define MB_TYPE_INTRA4x4 0x0001
893 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
894 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
895 #define MB_TYPE_16x16 0x0008
896 #define MB_TYPE_16x8 0x0010
897 #define MB_TYPE_8x16 0x0020
898 #define MB_TYPE_8x8 0x0040
899 #define MB_TYPE_INTERLACED 0x0080
900 #define MB_TYPE_DIRECT2 0x0100 //FIXME
901 #define MB_TYPE_ACPRED 0x0200
902 #define MB_TYPE_GMC 0x0400
903 #define MB_TYPE_SKIP 0x0800
904 #define MB_TYPE_P0L0 0x1000
905 #define MB_TYPE_P1L0 0x2000
906 #define MB_TYPE_P0L1 0x4000
907 #define MB_TYPE_P1L1 0x8000
908 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
909 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
910 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
911 #define MB_TYPE_QUANT 0x00010000
912 #define MB_TYPE_CBP 0x00020000
913 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
918 * This specifies the area which should be displayed.
919 * Note there may be multiple such areas for one frame.
921 typedef struct AVPanScan{
924 * - encoding: Set by user.
925 * - decoding: Set by libavcodec.
930 * width and height in 1/16 pel
931 * - encoding: Set by user.
932 * - decoding: Set by libavcodec.
938 * position of the top left corner in 1/16 pel for up to 3 fields/frames
939 * - encoding: Set by user.
940 * - decoding: Set by libavcodec.
942 int16_t position[3][2];
945 #if FF_API_QSCALE_TYPE
946 #define FF_QSCALE_TYPE_MPEG1 0
947 #define FF_QSCALE_TYPE_MPEG2 1
948 #define FF_QSCALE_TYPE_H264 2
949 #define FF_QSCALE_TYPE_VP56 3
952 #if FF_API_GET_BUFFER
953 #define FF_BUFFER_TYPE_INTERNAL 1
954 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
955 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
956 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
958 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
959 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
960 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
961 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
965 * The decoder will keep a reference to the frame and may reuse it later.
967 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
970 * @defgroup lavc_packet AVPacket
972 * Types and functions for working with AVPacket.
975 enum AVPacketSideDataType {
977 AV_PKT_DATA_NEW_EXTRADATA,
980 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
983 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
984 * s32le channel_count
985 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
986 * u64le channel_layout
987 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
989 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
994 AV_PKT_DATA_PARAM_CHANGE,
997 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
998 * structures with info about macroblocks relevant to splitting the
999 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1000 * That is, it does not necessarily contain info about all macroblocks,
1001 * as long as the distance between macroblocks in the info is smaller
1002 * than the target payload size.
1003 * Each MB info structure is 12 bytes, and is laid out as follows:
1005 * u32le bit offset from the start of the packet
1006 * u8 current quantizer at the start of the macroblock
1008 * u16le macroblock address within the GOB
1009 * u8 horizontal MV predictor
1010 * u8 vertical MV predictor
1011 * u8 horizontal MV predictor for block number 3
1012 * u8 vertical MV predictor for block number 3
1015 AV_PKT_DATA_H263_MB_INFO,
1018 * This side data should be associated with an audio stream and contains
1019 * ReplayGain information in form of the AVReplayGain struct.
1021 AV_PKT_DATA_REPLAYGAIN,
1024 * This side data contains a 3x3 transformation matrix describing an affine
1025 * transformation that needs to be applied to the decoded video frames for
1026 * correct presentation.
1028 * See libavutil/display.h for a detailed description of the data.
1030 AV_PKT_DATA_DISPLAYMATRIX,
1033 * This side data should be associated with a video stream and contains
1034 * Stereoscopic 3D information in form of the AVStereo3D struct.
1036 AV_PKT_DATA_STEREO3D,
1039 * This side data should be associated with an audio stream and corresponds
1040 * to enum AVAudioServiceType.
1042 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1045 * Recommmends skipping the specified number of samples
1047 * u32le number of samples to skip from start of this packet
1048 * u32le number of samples to skip from end of this packet
1049 * u8 reason for start skip
1050 * u8 reason for end skip (0=padding silence, 1=convergence)
1053 AV_PKT_DATA_SKIP_SAMPLES=70,
1056 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1057 * the packet may contain "dual mono" audio specific to Japanese DTV
1058 * and if it is true, recommends only the selected channel to be used.
1060 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
1063 AV_PKT_DATA_JP_DUALMONO,
1066 * A list of zero terminated key/value strings. There is no end marker for
1067 * the list, so it is required to rely on the side data size to stop.
1069 AV_PKT_DATA_STRINGS_METADATA,
1072 * Subtitle event position
1080 AV_PKT_DATA_SUBTITLE_POSITION,
1083 * Data found in BlockAdditional element of matroska container. There is
1084 * no end marker for the data, so it is required to rely on the side data
1085 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1088 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1091 * The optional first identifier line of a WebVTT cue.
1093 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1096 * The optional settings (rendering instructions) that immediately
1097 * follow the timestamp specifier of a WebVTT cue.
1099 AV_PKT_DATA_WEBVTT_SETTINGS,
1102 * A list of zero terminated key/value strings. There is no end marker for
1103 * the list, so it is required to rely on the side data size to stop. This
1104 * side data includes updated metadata which appeared in the stream.
1106 AV_PKT_DATA_METADATA_UPDATE,
1109 typedef struct AVPacketSideData {
1112 enum AVPacketSideDataType type;
1116 * This structure stores compressed data. It is typically exported by demuxers
1117 * and then passed as input to decoders, or received as output from encoders and
1118 * then passed to muxers.
1120 * For video, it should typically contain one compressed frame. For audio it may
1121 * contain several compressed frames.
1123 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1124 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1125 * without libavcodec and libavformat major bump.
1127 * The semantics of data ownership depends on the buf or destruct (deprecated)
1128 * fields. If either is set, the packet data is dynamically allocated and is
1129 * valid indefinitely until av_free_packet() is called (which in turn calls
1130 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1131 * the packet data is typically backed by some static buffer somewhere and is
1132 * only valid for a limited time (e.g. until the next read call when demuxing).
1134 * The side data is always allocated with av_malloc() and is freed in
1137 typedef struct AVPacket {
1139 * A reference to the reference-counted buffer where the packet data is
1141 * May be NULL, then the packet data is not reference-counted.
1145 * Presentation timestamp in AVStream->time_base units; the time at which
1146 * the decompressed packet will be presented to the user.
1147 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1148 * pts MUST be larger or equal to dts as presentation cannot happen before
1149 * decompression, unless one wants to view hex dumps. Some formats misuse
1150 * the terms dts and pts/cts to mean something different. Such timestamps
1151 * must be converted to true pts/dts before they are stored in AVPacket.
1155 * Decompression timestamp in AVStream->time_base units; the time at which
1156 * the packet is decompressed.
1157 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1164 * A combination of AV_PKT_FLAG values
1168 * Additional packet data that can be provided by the container.
1169 * Packet can contain several types of side information.
1171 AVPacketSideData *side_data;
1172 int side_data_elems;
1175 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1176 * Equals next_pts - this_pts in presentation order.
1179 #if FF_API_DESTRUCT_PACKET
1180 attribute_deprecated
1181 void (*destruct)(struct AVPacket *);
1182 attribute_deprecated
1185 int64_t pos; ///< byte position in stream, -1 if unknown
1188 * Time difference in AVStream->time_base units from the pts of this
1189 * packet to the point at which the output from the decoder has converged
1190 * independent from the availability of previous frames. That is, the
1191 * frames are virtually identical no matter if decoding started from
1192 * the very first frame or from this keyframe.
1193 * Is AV_NOPTS_VALUE if unknown.
1194 * This field is not the display duration of the current packet.
1195 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1198 * The purpose of this field is to allow seeking in streams that have no
1199 * keyframes in the conventional sense. It corresponds to the
1200 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1201 * essential for some types of subtitle streams to ensure that all
1202 * subtitles are correctly displayed after seeking.
1204 int64_t convergence_duration;
1206 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1207 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1209 enum AVSideDataParamChangeFlags {
1210 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1211 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1212 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1213 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1219 struct AVCodecInternal;
1223 AV_FIELD_PROGRESSIVE,
1224 AV_FIELD_TT, //< Top coded_first, top displayed first
1225 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1226 AV_FIELD_TB, //< Top coded first, bottom displayed first
1227 AV_FIELD_BT, //< Bottom coded first, top displayed first
1231 * main external API structure.
1232 * New fields can be added to the end with minor version bumps.
1233 * Removal, reordering and changes to existing fields require a major
1235 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1237 * sizeof(AVCodecContext) must not be used outside libav*.
1239 typedef struct AVCodecContext {
1241 * information on struct for av_log
1242 * - set by avcodec_alloc_context3
1244 const AVClass *av_class;
1245 int log_level_offset;
1247 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1248 const struct AVCodec *codec;
1249 #if FF_API_CODEC_NAME
1251 * @deprecated this field is not used for anything in libavcodec
1253 attribute_deprecated
1254 char codec_name[32];
1256 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1259 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1260 * This is used to work around some encoder bugs.
1261 * A demuxer should set this to what is stored in the field used to identify the codec.
1262 * If there are multiple such fields in a container then the demuxer should choose the one
1263 * which maximizes the information about the used codec.
1264 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1265 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1266 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1268 * - encoding: Set by user, if not then the default based on codec_id will be used.
1269 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1271 unsigned int codec_tag;
1273 #if FF_API_STREAM_CODEC_TAG
1275 * @deprecated this field is unused
1277 attribute_deprecated
1278 unsigned int stream_codec_tag;
1284 * Private context used for internal data.
1286 * Unlike priv_data, this is not codec-specific. It is used in general
1287 * libavcodec functions.
1289 struct AVCodecInternal *internal;
1292 * Private data of the user, can be used to carry app specific stuff.
1293 * - encoding: Set by user.
1294 * - decoding: Set by user.
1299 * the average bitrate
1300 * - encoding: Set by user; unused for constant quantizer encoding.
1301 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1306 * number of bits the bitstream is allowed to diverge from the reference.
1307 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1308 * - encoding: Set by user; unused for constant quantizer encoding.
1309 * - decoding: unused
1311 int bit_rate_tolerance;
1314 * Global quality for codecs which cannot change it per frame.
1315 * This should be proportional to MPEG-1/2/4 qscale.
1316 * - encoding: Set by user.
1317 * - decoding: unused
1322 * - encoding: Set by user.
1323 * - decoding: unused
1325 int compression_level;
1326 #define FF_COMPRESSION_DEFAULT -1
1330 * - encoding: Set by user.
1331 * - decoding: Set by user.
1337 * - encoding: Set by user.
1338 * - decoding: Set by user.
1343 * some codecs need / can use extradata like Huffman tables.
1344 * mjpeg: Huffman tables
1345 * rv10: additional flags
1346 * mpeg4: global headers (they can be in the bitstream or here)
1347 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1348 * than extradata_size to avoid problems if it is read with the bitstream reader.
1349 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1350 * - encoding: Set/allocated/freed by libavcodec.
1351 * - decoding: Set/allocated/freed by user.
1357 * This is the fundamental unit of time (in seconds) in terms
1358 * of which frame timestamps are represented. For fixed-fps content,
1359 * timebase should be 1/framerate and timestamp increments should be
1361 * This often, but not always is the inverse of the frame rate or field rate
1363 * - encoding: MUST be set by user.
1364 * - decoding: the use of this field for decoding is deprecated.
1365 * Use framerate instead.
1367 AVRational time_base;
1370 * For some codecs, the time base is closer to the field rate than the frame rate.
1371 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1372 * if no telecine is used ...
1374 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1376 int ticks_per_frame;
1381 * Encoding: Number of frames delay there will be from the encoder input to
1382 * the decoder output. (we assume the decoder matches the spec)
1383 * Decoding: Number of frames delay in addition to what a standard decoder
1384 * as specified in the spec would produce.
1387 * Number of frames the decoded output will be delayed relative to the
1391 * For encoding, this field is unused (see initial_padding).
1393 * For decoding, this is the number of samples the decoder needs to
1394 * output before the decoder's output is valid. When seeking, you should
1395 * start decoding this many samples prior to your desired seek point.
1397 * - encoding: Set by libavcodec.
1398 * - decoding: Set by libavcodec.
1405 * picture width / height.
1406 * - encoding: MUST be set by user.
1407 * - decoding: May be set by the user before opening the decoder if known e.g.
1408 * from the container. Some decoders will require the dimensions
1409 * to be set by the caller. During decoding, the decoder may
1410 * overwrite those values as required.
1415 * Bitstream width / height, may be different from width/height e.g. when
1416 * the decoded frame is cropped before being output or lowres is enabled.
1417 * - encoding: unused
1418 * - decoding: May be set by the user before opening the decoder if known
1419 * e.g. from the container. During decoding, the decoder may
1420 * overwrite those values as required.
1422 int coded_width, coded_height;
1424 #if FF_API_ASPECT_EXTENDED
1425 #define FF_ASPECT_EXTENDED 15
1429 * the number of pictures in a group of pictures, or 0 for intra_only
1430 * - encoding: Set by user.
1431 * - decoding: unused
1436 * Pixel format, see AV_PIX_FMT_xxx.
1437 * May be set by the demuxer if known from headers.
1438 * May be overridden by the decoder if it knows better.
1439 * - encoding: Set by user.
1440 * - decoding: Set by user if known, overridden by libavcodec if known
1442 enum AVPixelFormat pix_fmt;
1445 * Motion estimation algorithm used for video coding.
1446 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1447 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1448 * - encoding: MUST be set by user.
1449 * - decoding: unused
1454 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1455 * decoder to draw a horizontal band. It improves cache usage. Not
1456 * all codecs can do that. You must check the codec capabilities
1458 * When multithreading is used, it may be called from multiple threads
1459 * at the same time; threads might draw different parts of the same AVFrame,
1460 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1462 * The function is also used by hardware acceleration APIs.
1463 * It is called at least once during frame decoding to pass
1464 * the data needed for hardware render.
1465 * In that mode instead of pixel data, AVFrame points to
1466 * a structure specific to the acceleration API. The application
1467 * reads the structure and can change some fields to indicate progress
1469 * - encoding: unused
1470 * - decoding: Set by user.
1471 * @param height the height of the slice
1472 * @param y the y position of the slice
1473 * @param type 1->top field, 2->bottom field, 3->frame
1474 * @param offset offset into the AVFrame.data from which the slice should be read
1476 void (*draw_horiz_band)(struct AVCodecContext *s,
1477 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1478 int y, int type, int height);
1481 * callback to negotiate the pixelFormat
1482 * @param fmt is the list of formats which are supported by the codec,
1483 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1484 * The first is always the native one.
1485 * @note The callback may be called again immediately if initialization for
1486 * the selected (hardware-accelerated) pixel format failed.
1487 * @warning Behavior is undefined if the callback returns a value not
1488 * in the fmt list of formats.
1489 * @return the chosen format
1490 * - encoding: unused
1491 * - decoding: Set by user, if not set the native format will be chosen.
1493 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1496 * maximum number of B-frames between non-B-frames
1497 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1498 * - encoding: Set by user.
1499 * - decoding: unused
1504 * qscale factor between IP and B-frames
1505 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1506 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1507 * - encoding: Set by user.
1508 * - decoding: unused
1510 float b_quant_factor;
1512 /** obsolete FIXME remove */
1514 #define FF_RC_STRATEGY_XVID 1
1516 int b_frame_strategy;
1519 * qscale offset between IP and B-frames
1520 * - encoding: Set by user.
1521 * - decoding: unused
1523 float b_quant_offset;
1526 * Size of the frame reordering buffer in the decoder.
1527 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1528 * - encoding: Set by libavcodec.
1529 * - decoding: Set by libavcodec.
1534 * 0-> h263 quant 1-> mpeg quant
1535 * - encoding: Set by user.
1536 * - decoding: unused
1541 * qscale factor between P and I-frames
1542 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1543 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1544 * - encoding: Set by user.
1545 * - decoding: unused
1547 float i_quant_factor;
1550 * qscale offset between P and I-frames
1551 * - encoding: Set by user.
1552 * - decoding: unused
1554 float i_quant_offset;
1557 * luminance masking (0-> disabled)
1558 * - encoding: Set by user.
1559 * - decoding: unused
1564 * temporary complexity masking (0-> disabled)
1565 * - encoding: Set by user.
1566 * - decoding: unused
1568 float temporal_cplx_masking;
1571 * spatial complexity masking (0-> disabled)
1572 * - encoding: Set by user.
1573 * - decoding: unused
1575 float spatial_cplx_masking;
1578 * p block masking (0-> disabled)
1579 * - encoding: Set by user.
1580 * - decoding: unused
1585 * darkness masking (0-> disabled)
1586 * - encoding: Set by user.
1587 * - decoding: unused
1593 * - encoding: Set by libavcodec.
1594 * - decoding: Set by user (or 0).
1598 * prediction method (needed for huffyuv)
1599 * - encoding: Set by user.
1600 * - decoding: unused
1602 int prediction_method;
1603 #define FF_PRED_LEFT 0
1604 #define FF_PRED_PLANE 1
1605 #define FF_PRED_MEDIAN 2
1608 * slice offsets in the frame in bytes
1609 * - encoding: Set/allocated by libavcodec.
1610 * - decoding: Set/allocated by user (or NULL).
1615 * sample aspect ratio (0 if unknown)
1616 * That is the width of a pixel divided by the height of the pixel.
1617 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1618 * - encoding: Set by user.
1619 * - decoding: Set by libavcodec.
1621 AVRational sample_aspect_ratio;
1624 * motion estimation comparison function
1625 * - encoding: Set by user.
1626 * - decoding: unused
1630 * subpixel motion estimation comparison function
1631 * - encoding: Set by user.
1632 * - decoding: unused
1636 * macroblock comparison function (not supported yet)
1637 * - encoding: Set by user.
1638 * - decoding: unused
1642 * interlaced DCT comparison function
1643 * - encoding: Set by user.
1644 * - decoding: unused
1647 #define FF_CMP_SAD 0
1648 #define FF_CMP_SSE 1
1649 #define FF_CMP_SATD 2
1650 #define FF_CMP_DCT 3
1651 #define FF_CMP_PSNR 4
1652 #define FF_CMP_BIT 5
1654 #define FF_CMP_ZERO 7
1655 #define FF_CMP_VSAD 8
1656 #define FF_CMP_VSSE 9
1657 #define FF_CMP_NSSE 10
1658 #define FF_CMP_W53 11
1659 #define FF_CMP_W97 12
1660 #define FF_CMP_DCTMAX 13
1661 #define FF_CMP_DCT264 14
1662 #define FF_CMP_CHROMA 256
1665 * ME diamond size & shape
1666 * - encoding: Set by user.
1667 * - decoding: unused
1672 * amount of previous MV predictors (2a+1 x 2a+1 square)
1673 * - encoding: Set by user.
1674 * - decoding: unused
1676 int last_predictor_count;
1679 * prepass for motion estimation
1680 * - encoding: Set by user.
1681 * - decoding: unused
1686 * motion estimation prepass comparison function
1687 * - encoding: Set by user.
1688 * - decoding: unused
1693 * ME prepass diamond size & shape
1694 * - encoding: Set by user.
1695 * - decoding: unused
1701 * - encoding: Set by user.
1702 * - decoding: unused
1704 int me_subpel_quality;
1708 * DTG active format information (additional aspect ratio
1709 * information only used in DVB MPEG-2 transport streams)
1712 * - encoding: unused
1713 * - decoding: Set by decoder.
1714 * @deprecated Deprecated in favor of AVSideData
1716 attribute_deprecated int dtg_active_format;
1717 #define FF_DTG_AFD_SAME 8
1718 #define FF_DTG_AFD_4_3 9
1719 #define FF_DTG_AFD_16_9 10
1720 #define FF_DTG_AFD_14_9 11
1721 #define FF_DTG_AFD_4_3_SP_14_9 13
1722 #define FF_DTG_AFD_16_9_SP_14_9 14
1723 #define FF_DTG_AFD_SP_4_3 15
1724 #endif /* FF_API_AFD */
1727 * maximum motion estimation search range in subpel units
1728 * If 0 then no limit.
1730 * - encoding: Set by user.
1731 * - decoding: unused
1736 * intra quantizer bias
1737 * - encoding: Set by user.
1738 * - decoding: unused
1740 int intra_quant_bias;
1741 #define FF_DEFAULT_QUANT_BIAS 999999
1744 * inter quantizer bias
1745 * - encoding: Set by user.
1746 * - decoding: unused
1748 int inter_quant_bias;
1752 * - encoding: unused
1753 * - decoding: Set by user.
1756 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1757 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1758 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1762 * XVideo Motion Acceleration
1763 * - encoding: forbidden
1764 * - decoding: set by decoder
1765 * @deprecated XvMC doesn't need it anymore.
1767 attribute_deprecated int xvmc_acceleration;
1768 #endif /* FF_API_XVMC */
1771 * macroblock decision mode
1772 * - encoding: Set by user.
1773 * - decoding: unused
1776 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1777 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1778 #define FF_MB_DECISION_RD 2 ///< rate distortion
1781 * custom intra quantization matrix
1782 * - encoding: Set by user, can be NULL.
1783 * - decoding: Set by libavcodec.
1785 uint16_t *intra_matrix;
1788 * custom inter quantization matrix
1789 * - encoding: Set by user, can be NULL.
1790 * - decoding: Set by libavcodec.
1792 uint16_t *inter_matrix;
1795 * scene change detection threshold
1796 * 0 is default, larger means fewer detected scene changes.
1797 * - encoding: Set by user.
1798 * - decoding: unused
1800 int scenechange_threshold;
1803 * noise reduction strength
1804 * - encoding: Set by user.
1805 * - decoding: unused
1807 int noise_reduction;
1811 * @deprecated this field is unused
1813 attribute_deprecated
1817 * @deprecated this field is unused
1819 attribute_deprecated
1824 * precision of the intra DC coefficient - 8
1825 * - encoding: Set by user.
1826 * - decoding: Set by libavcodec
1828 int intra_dc_precision;
1831 * Number of macroblock rows at the top which are skipped.
1832 * - encoding: unused
1833 * - decoding: Set by user.
1838 * Number of macroblock rows at the bottom which are skipped.
1839 * - encoding: unused
1840 * - decoding: Set by user.
1846 * @deprecated use encoder private options instead
1848 attribute_deprecated
1849 float border_masking;
1853 * minimum MB lagrange multipler
1854 * - encoding: Set by user.
1855 * - decoding: unused
1860 * maximum MB lagrange multipler
1861 * - encoding: Set by user.
1862 * - decoding: unused
1868 * - encoding: Set by user.
1869 * - decoding: unused
1871 int me_penalty_compensation;
1875 * - encoding: Set by user.
1876 * - decoding: unused
1882 * - encoding: Set by user.
1883 * - decoding: unused
1889 * - encoding: Set by user.
1890 * - decoding: unused
1895 * number of reference frames
1896 * - encoding: Set by user.
1897 * - decoding: Set by lavc.
1902 * chroma qp offset from luma
1903 * - encoding: Set by user.
1904 * - decoding: unused
1908 #if FF_API_UNUSED_MEMBERS
1910 * Multiplied by qscale for each frame and added to scene_change_score.
1911 * - encoding: Set by user.
1912 * - decoding: unused
1914 attribute_deprecated int scenechange_factor;
1919 * Note: Value depends upon the compare function used for fullpel ME.
1920 * - encoding: Set by user.
1921 * - decoding: unused
1926 * Adjust sensitivity of b_frame_strategy 1.
1927 * - encoding: Set by user.
1928 * - decoding: unused
1933 * Chromaticity coordinates of the source primaries.
1934 * - encoding: Set by user
1935 * - decoding: Set by libavcodec
1937 enum AVColorPrimaries color_primaries;
1940 * Color Transfer Characteristic.
1941 * - encoding: Set by user
1942 * - decoding: Set by libavcodec
1944 enum AVColorTransferCharacteristic color_trc;
1947 * YUV colorspace type.
1948 * - encoding: Set by user
1949 * - decoding: Set by libavcodec
1951 enum AVColorSpace colorspace;
1954 * MPEG vs JPEG YUV range.
1955 * - encoding: Set by user
1956 * - decoding: Set by libavcodec
1958 enum AVColorRange color_range;
1961 * This defines the location of chroma samples.
1962 * - encoding: Set by user
1963 * - decoding: Set by libavcodec
1965 enum AVChromaLocation chroma_sample_location;
1969 * Indicates number of picture subdivisions. Used for parallelized
1971 * - encoding: Set by user
1972 * - decoding: unused
1977 * - encoding: set by libavcodec
1978 * - decoding: Set by user.
1980 enum AVFieldOrder field_order;
1983 int sample_rate; ///< samples per second
1984 int channels; ///< number of audio channels
1987 * audio sample format
1988 * - encoding: Set by user.
1989 * - decoding: Set by libavcodec.
1991 enum AVSampleFormat sample_fmt; ///< sample format
1993 /* The following data should not be initialized. */
1995 * Number of samples per channel in an audio frame.
1997 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1998 * except the last must contain exactly frame_size samples per channel.
1999 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2000 * frame size is not restricted.
2001 * - decoding: may be set by some decoders to indicate constant frame size
2006 * Frame counter, set by libavcodec.
2008 * - decoding: total number of frames returned from the decoder so far.
2009 * - encoding: total number of frames passed to the encoder so far.
2011 * @note the counter is not incremented if encoding/decoding resulted in
2017 * number of bytes per packet if constant and known or 0
2018 * Used by some WAV based audio codecs.
2023 * Audio cutoff bandwidth (0 means "automatic")
2024 * - encoding: Set by user.
2025 * - decoding: unused
2029 #if FF_API_REQUEST_CHANNELS
2031 * Decoder should decode to this many channels if it can (0 for default)
2032 * - encoding: unused
2033 * - decoding: Set by user.
2034 * @deprecated Deprecated in favor of request_channel_layout.
2036 attribute_deprecated int request_channels;
2040 * Audio channel layout.
2041 * - encoding: set by user.
2042 * - decoding: set by user, may be overwritten by libavcodec.
2044 uint64_t channel_layout;
2047 * Request decoder to use this channel layout if it can (0 for default)
2048 * - encoding: unused
2049 * - decoding: Set by user.
2051 uint64_t request_channel_layout;
2054 * Type of service that the audio stream conveys.
2055 * - encoding: Set by user.
2056 * - decoding: Set by libavcodec.
2058 enum AVAudioServiceType audio_service_type;
2061 * desired sample format
2062 * - encoding: Not used.
2063 * - decoding: Set by user.
2064 * Decoder will decode to this format if it can.
2066 enum AVSampleFormat request_sample_fmt;
2068 #if FF_API_GET_BUFFER
2070 * Called at the beginning of each frame to get a buffer for it.
2072 * The function will set AVFrame.data[], AVFrame.linesize[].
2073 * AVFrame.extended_data[] must also be set, but it should be the same as
2074 * AVFrame.data[] except for planar audio with more channels than can fit
2075 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2076 * many data pointers as it can hold.
2078 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2079 * avcodec_default_get_buffer() instead of providing buffers allocated by
2082 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2083 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2084 * but if get_buffer() is overridden then alignment considerations should
2085 * be taken into account.
2087 * @see avcodec_default_get_buffer()
2091 * If pic.reference is set then the frame will be read later by libavcodec.
2092 * avcodec_align_dimensions2() should be used to find the required width and
2093 * height, as they normally need to be rounded up to the next multiple of 16.
2095 * If frame multithreading is used and thread_safe_callbacks is set,
2096 * it may be called from a different thread, but not from more than one at
2097 * once. Does not need to be reentrant.
2099 * @see release_buffer(), reget_buffer()
2100 * @see avcodec_align_dimensions2()
2104 * Decoders request a buffer of a particular size by setting
2105 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2106 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2107 * to a smaller value in the output frame.
2109 * Decoders cannot use the buffer after returning from
2110 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2111 * is assumed to be released immediately upon return. In some rare cases,
2112 * a decoder may need to call get_buffer() more than once in a single
2113 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2114 * called again after it has already been called once, the previously
2115 * acquired buffer is assumed to be released at that time and may not be
2116 * reused by the decoder.
2118 * As a convenience, av_samples_get_buffer_size() and
2119 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2120 * functions to find the required data size and to fill data pointers and
2121 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2122 * since all planes must be the same size.
2124 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2126 * - encoding: unused
2127 * - decoding: Set by libavcodec, user can override.
2129 * @deprecated use get_buffer2()
2131 attribute_deprecated
2132 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2135 * Called to release buffers which were allocated with get_buffer.
2136 * A released buffer can be reused in get_buffer().
2137 * pic.data[*] must be set to NULL.
2138 * May be called from a different thread if frame multithreading is used,
2139 * but not by more than one thread at once, so does not need to be reentrant.
2140 * - encoding: unused
2141 * - decoding: Set by libavcodec, user can override.
2143 * @deprecated custom freeing callbacks should be set from get_buffer2()
2145 attribute_deprecated
2146 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2149 * Called at the beginning of a frame to get cr buffer for it.
2150 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2151 * libavcodec will pass previous buffer in pic, function should return
2152 * same buffer or new buffer with old frame "painted" into it.
2153 * If pic.data[0] == NULL must behave like get_buffer().
2154 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2155 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2157 * - encoding: unused
2158 * - decoding: Set by libavcodec, user can override.
2160 attribute_deprecated
2161 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2165 * This callback is called at the beginning of each frame to get data
2166 * buffer(s) for it. There may be one contiguous buffer for all the data or
2167 * there may be a buffer per each data plane or anything in between. What
2168 * this means is, you may set however many entries in buf[] you feel necessary.
2169 * Each buffer must be reference-counted using the AVBuffer API (see description
2172 * The following fields will be set in the frame before this callback is
2175 * - width, height (video only)
2176 * - sample_rate, channel_layout, nb_samples (audio only)
2177 * Their values may differ from the corresponding values in
2178 * AVCodecContext. This callback must use the frame values, not the codec
2179 * context values, to calculate the required buffer size.
2181 * This callback must fill the following fields in the frame:
2185 * * if the data is planar audio with more than 8 channels, then this
2186 * callback must allocate and fill extended_data to contain all pointers
2187 * to all data planes. data[] must hold as many pointers as it can.
2188 * extended_data must be allocated with av_malloc() and will be freed in
2190 * * otherwise exended_data must point to data
2191 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2192 * the frame's data and extended_data pointers must be contained in these. That
2193 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2194 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2195 * and av_buffer_ref().
2196 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2197 * this callback and filled with the extra buffers if there are more
2198 * buffers than buf[] can hold. extended_buf will be freed in
2201 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2202 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2205 * Each data plane must be aligned to the maximum required by the target
2208 * @see avcodec_default_get_buffer2()
2212 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2213 * (read and/or written to if it is writable) later by libavcodec.
2215 * avcodec_align_dimensions2() should be used to find the required width and
2216 * height, as they normally need to be rounded up to the next multiple of 16.
2218 * Some decoders do not support linesizes changing between frames.
2220 * If frame multithreading is used and thread_safe_callbacks is set,
2221 * this callback may be called from a different thread, but not from more
2222 * than one at once. Does not need to be reentrant.
2224 * @see avcodec_align_dimensions2()
2228 * Decoders request a buffer of a particular size by setting
2229 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2230 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2231 * to a smaller value in the output frame.
2233 * As a convenience, av_samples_get_buffer_size() and
2234 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2235 * functions to find the required data size and to fill data pointers and
2236 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2237 * since all planes must be the same size.
2239 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2241 * - encoding: unused
2242 * - decoding: Set by libavcodec, user can override.
2244 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2247 * If non-zero, the decoded audio and video frames returned from
2248 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2249 * and are valid indefinitely. The caller must free them with
2250 * av_frame_unref() when they are not needed anymore.
2251 * Otherwise, the decoded frames must not be freed by the caller and are
2252 * only valid until the next decode call.
2254 * - encoding: unused
2255 * - decoding: set by the caller before avcodec_open2().
2257 int refcounted_frames;
2259 /* - encoding parameters */
2260 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2261 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2265 * - encoding: Set by user.
2266 * - decoding: unused
2272 * - encoding: Set by user.
2273 * - decoding: unused
2278 * maximum quantizer difference between frames
2279 * - encoding: Set by user.
2280 * - decoding: unused
2286 * @deprecated use encoder private options instead
2288 attribute_deprecated
2291 attribute_deprecated
2293 attribute_deprecated
2298 * decoder bitstream buffer size
2299 * - encoding: Set by user.
2300 * - decoding: unused
2305 * ratecontrol override, see RcOverride
2306 * - encoding: Allocated/set/freed by user.
2307 * - decoding: unused
2309 int rc_override_count;
2310 RcOverride *rc_override;
2314 * @deprecated use encoder private options instead
2316 attribute_deprecated
2322 * - encoding: Set by user.
2323 * - decoding: Set by libavcodec.
2329 * - encoding: Set by user.
2330 * - decoding: unused
2336 * @deprecated use encoder private options instead
2338 attribute_deprecated
2339 float rc_buffer_aggressivity;
2341 attribute_deprecated
2342 float rc_initial_cplx;
2346 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2347 * - encoding: Set by user.
2348 * - decoding: unused.
2350 float rc_max_available_vbv_use;
2353 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2354 * - encoding: Set by user.
2355 * - decoding: unused.
2357 float rc_min_vbv_overflow_use;
2360 * Number of bits which should be loaded into the rc buffer before decoding starts.
2361 * - encoding: Set by user.
2362 * - decoding: unused
2364 int rc_initial_buffer_occupancy;
2366 #define FF_CODER_TYPE_VLC 0
2367 #define FF_CODER_TYPE_AC 1
2368 #define FF_CODER_TYPE_RAW 2
2369 #define FF_CODER_TYPE_RLE 3
2370 #if FF_API_UNUSED_MEMBERS
2371 #define FF_CODER_TYPE_DEFLATE 4
2372 #endif /* FF_API_UNUSED_MEMBERS */
2375 * - encoding: Set by user.
2376 * - decoding: unused
2382 * - encoding: Set by user.
2383 * - decoding: unused
2389 * @deprecated use encoder private options instead
2391 attribute_deprecated
2395 * @deprecated use encoder private options instead
2397 attribute_deprecated
2402 * frame skip threshold
2403 * - encoding: Set by user.
2404 * - decoding: unused
2406 int frame_skip_threshold;
2410 * - encoding: Set by user.
2411 * - decoding: unused
2413 int frame_skip_factor;
2416 * frame skip exponent
2417 * - encoding: Set by user.
2418 * - decoding: unused
2423 * frame skip comparison function
2424 * - encoding: Set by user.
2425 * - decoding: unused
2430 * trellis RD quantization
2431 * - encoding: Set by user.
2432 * - decoding: unused
2437 * - encoding: Set by user.
2438 * - decoding: unused
2440 int min_prediction_order;
2443 * - encoding: Set by user.
2444 * - decoding: unused
2446 int max_prediction_order;
2449 * GOP timecode frame start number
2450 * - encoding: Set by user, in non drop frame format
2451 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2453 int64_t timecode_frame_start;
2455 /* The RTP callback: This function is called */
2456 /* every time the encoder has a packet to send. */
2457 /* It depends on the encoder if the data starts */
2458 /* with a Start Code (it should). H.263 does. */
2459 /* mb_nb contains the number of macroblocks */
2460 /* encoded in the RTP payload. */
2461 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2463 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2464 /* do its best to deliver a chunk with size */
2465 /* below rtp_payload_size, the chunk will start */
2466 /* with a start code on some codecs like H.263. */
2467 /* This doesn't take account of any particular */
2468 /* headers inside the transmitted RTP payload. */
2470 /* statistics, used for 2-pass encoding */
2481 * number of bits used for the previously encoded frame
2482 * - encoding: Set by libavcodec.
2483 * - decoding: unused
2488 * pass1 encoding statistics output buffer
2489 * - encoding: Set by libavcodec.
2490 * - decoding: unused
2495 * pass2 encoding statistics input buffer
2496 * Concatenated stuff from stats_out of pass1 should be placed here.
2497 * - encoding: Allocated/set/freed by user.
2498 * - decoding: unused
2503 * Work around bugs in encoders which sometimes cannot be detected automatically.
2504 * - encoding: Set by user
2505 * - decoding: Set by user
2507 int workaround_bugs;
2508 #define FF_BUG_AUTODETECT 1 ///< autodetection
2509 #if FF_API_OLD_MSMPEG4
2510 #define FF_BUG_OLD_MSMPEG4 2
2512 #define FF_BUG_XVID_ILACE 4
2513 #define FF_BUG_UMP4 8
2514 #define FF_BUG_NO_PADDING 16
2515 #define FF_BUG_AMV 32
2517 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2519 #define FF_BUG_QPEL_CHROMA 64
2520 #define FF_BUG_STD_QPEL 128
2521 #define FF_BUG_QPEL_CHROMA2 256
2522 #define FF_BUG_DIRECT_BLOCKSIZE 512
2523 #define FF_BUG_EDGE 1024
2524 #define FF_BUG_HPEL_CHROMA 2048
2525 #define FF_BUG_DC_CLIP 4096
2526 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2527 #define FF_BUG_TRUNCATED 16384
2530 * strictly follow the standard (MPEG4, ...).
2531 * - encoding: Set by user.
2532 * - decoding: Set by user.
2533 * Setting this to STRICT or higher means the encoder and decoder will
2534 * generally do stupid things, whereas setting it to unofficial or lower
2535 * will mean the encoder might produce output that is not supported by all
2536 * spec-compliant decoders. Decoders don't differentiate between normal,
2537 * unofficial and experimental (that is, they always try to decode things
2538 * when they can) unless they are explicitly asked to behave stupidly
2539 * (=strictly conform to the specs)
2541 int strict_std_compliance;
2542 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2543 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2544 #define FF_COMPLIANCE_NORMAL 0
2545 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2546 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2549 * error concealment flags
2550 * - encoding: unused
2551 * - decoding: Set by user.
2553 int error_concealment;
2554 #define FF_EC_GUESS_MVS 1
2555 #define FF_EC_DEBLOCK 2
2556 #define FF_EC_FAVOR_INTER 256
2560 * - encoding: Set by user.
2561 * - decoding: Set by user.
2564 #define FF_DEBUG_PICT_INFO 1
2565 #define FF_DEBUG_RC 2
2566 #define FF_DEBUG_BITSTREAM 4
2567 #define FF_DEBUG_MB_TYPE 8
2568 #define FF_DEBUG_QP 16
2571 * @deprecated this option does nothing
2573 #define FF_DEBUG_MV 32
2575 #define FF_DEBUG_DCT_COEFF 0x00000040
2576 #define FF_DEBUG_SKIP 0x00000080
2577 #define FF_DEBUG_STARTCODE 0x00000100
2578 #if FF_API_UNUSED_MEMBERS
2579 #define FF_DEBUG_PTS 0x00000200
2580 #endif /* FF_API_UNUSED_MEMBERS */
2581 #define FF_DEBUG_ER 0x00000400
2582 #define FF_DEBUG_MMCO 0x00000800
2583 #define FF_DEBUG_BUGS 0x00001000
2585 #define FF_DEBUG_VIS_QP 0x00002000 ///< only access through AVOptions from outside libavcodec
2586 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2588 #define FF_DEBUG_BUFFERS 0x00008000
2589 #define FF_DEBUG_THREADS 0x00010000
2590 #define FF_DEBUG_NOMC 0x01000000
2595 * Code outside libavcodec should access this field using AVOptions
2596 * - encoding: Set by user.
2597 * - decoding: Set by user.
2600 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2601 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2602 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2606 * Error recognition; may misdetect some more or less valid parts as errors.
2607 * - encoding: unused
2608 * - decoding: Set by user.
2610 int err_recognition;
2613 * Verify checksums embedded in the bitstream (could be of either encoded or
2614 * decoded data, depending on the codec) and print an error message on mismatch.
2615 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2616 * decoder returning an error.
2618 #define AV_EF_CRCCHECK (1<<0)
2619 #define AV_EF_BITSTREAM (1<<1) ///< detect bitstream specification deviations
2620 #define AV_EF_BUFFER (1<<2) ///< detect improper bitstream length
2621 #define AV_EF_EXPLODE (1<<3) ///< abort decoding on minor error detection
2623 #define AV_EF_IGNORE_ERR (1<<15) ///< ignore errors and continue
2624 #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
2625 #define AV_EF_COMPLIANT (1<<17) ///< consider all spec non compliances as errors
2626 #define AV_EF_AGGRESSIVE (1<<18) ///< consider things that a sane encoder should not do as an error
2630 * opaque 64bit number (generally a PTS) that will be reordered and
2631 * output in AVFrame.reordered_opaque
2632 * - encoding: unused
2633 * - decoding: Set by user.
2635 int64_t reordered_opaque;
2638 * Hardware accelerator in use
2639 * - encoding: unused.
2640 * - decoding: Set by libavcodec
2642 struct AVHWAccel *hwaccel;
2645 * Hardware accelerator context.
2646 * For some hardware accelerators, a global context needs to be
2647 * provided by the user. In that case, this holds display-dependent
2648 * data FFmpeg cannot instantiate itself. Please refer to the
2649 * FFmpeg HW accelerator documentation to know how to fill this
2650 * is. e.g. for VA API, this is a struct vaapi_context.
2651 * - encoding: unused
2652 * - decoding: Set by user
2654 void *hwaccel_context;
2658 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2659 * - decoding: unused
2661 uint64_t error[AV_NUM_DATA_POINTERS];
2664 * DCT algorithm, see FF_DCT_* below
2665 * - encoding: Set by user.
2666 * - decoding: unused
2669 #define FF_DCT_AUTO 0
2670 #define FF_DCT_FASTINT 1
2671 #if FF_API_UNUSED_MEMBERS
2672 #define FF_DCT_INT 2
2673 #endif /* FF_API_UNUSED_MEMBERS */
2674 #define FF_DCT_MMX 3
2675 #define FF_DCT_ALTIVEC 5
2676 #define FF_DCT_FAAN 6
2679 * IDCT algorithm, see FF_IDCT_* below.
2680 * - encoding: Set by user.
2681 * - decoding: Set by user.
2684 #define FF_IDCT_AUTO 0
2685 #define FF_IDCT_INT 1
2686 #define FF_IDCT_SIMPLE 2
2687 #define FF_IDCT_SIMPLEMMX 3
2688 #define FF_IDCT_ARM 7
2689 #define FF_IDCT_ALTIVEC 8
2691 #define FF_IDCT_SH4 9
2693 #define FF_IDCT_SIMPLEARM 10
2694 #if FF_API_UNUSED_MEMBERS
2695 #define FF_IDCT_IPP 13
2696 #endif /* FF_API_UNUSED_MEMBERS */
2697 #define FF_IDCT_XVID 14
2698 #if FF_API_IDCT_XVIDMMX
2699 #define FF_IDCT_XVIDMMX 14
2700 #endif /* FF_API_IDCT_XVIDMMX */
2701 #define FF_IDCT_SIMPLEARMV5TE 16
2702 #define FF_IDCT_SIMPLEARMV6 17
2703 #if FF_API_ARCH_SPARC
2704 #define FF_IDCT_SIMPLEVIS 18
2706 #define FF_IDCT_FAAN 20
2707 #define FF_IDCT_SIMPLENEON 22
2708 #if FF_API_ARCH_ALPHA
2709 #define FF_IDCT_SIMPLEALPHA 23
2711 #define FF_IDCT_SIMPLEAUTO 128
2714 * bits per sample/pixel from the demuxer (needed for huffyuv).
2715 * - encoding: Set by libavcodec.
2716 * - decoding: Set by user.
2718 int bits_per_coded_sample;
2721 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2722 * - encoding: set by user.
2723 * - decoding: set by libavcodec.
2725 int bits_per_raw_sample;
2729 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2730 * - encoding: unused
2731 * - decoding: Set by user.
2732 * Code outside libavcodec should access this field using:
2733 * av_codec_{get,set}_lowres(avctx)
2739 * the picture in the bitstream
2740 * - encoding: Set by libavcodec.
2741 * - decoding: unused
2743 AVFrame *coded_frame;
2747 * is used to decide how many independent tasks should be passed to execute()
2748 * - encoding: Set by user.
2749 * - decoding: Set by user.
2754 * Which multithreading methods to use.
2755 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2756 * so clients which cannot provide future frames should not use it.
2758 * - encoding: Set by user, otherwise the default is used.
2759 * - decoding: Set by user, otherwise the default is used.
2762 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2763 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2766 * Which multithreading methods are in use by the codec.
2767 * - encoding: Set by libavcodec.
2768 * - decoding: Set by libavcodec.
2770 int active_thread_type;
2773 * Set by the client if its custom get_buffer() callback can be called
2774 * synchronously from another thread, which allows faster multithreaded decoding.
2775 * draw_horiz_band() will be called from other threads regardless of this setting.
2776 * Ignored if the default get_buffer() is used.
2777 * - encoding: Set by user.
2778 * - decoding: Set by user.
2780 int thread_safe_callbacks;
2783 * The codec may call this to execute several independent things.
2784 * It will return only after finishing all tasks.
2785 * The user may replace this with some multithreaded implementation,
2786 * the default implementation will execute the parts serially.
2787 * @param count the number of things to execute
2788 * - encoding: Set by libavcodec, user can override.
2789 * - decoding: Set by libavcodec, user can override.
2791 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2794 * The codec may call this to execute several independent things.
2795 * It will return only after finishing all tasks.
2796 * The user may replace this with some multithreaded implementation,
2797 * the default implementation will execute the parts serially.
2798 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2799 * @param c context passed also to func
2800 * @param count the number of things to execute
2801 * @param arg2 argument passed unchanged to func
2802 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2803 * @param func function that will be called count times, with jobnr from 0 to count-1.
2804 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2805 * two instances of func executing at the same time will have the same threadnr.
2806 * @return always 0 currently, but code should handle a future improvement where when any call to func
2807 * returns < 0 no further calls to func may be done and < 0 is returned.
2808 * - encoding: Set by libavcodec, user can override.
2809 * - decoding: Set by libavcodec, user can override.
2811 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2813 #if FF_API_THREAD_OPAQUE
2815 * @deprecated this field should not be used from outside of lavc
2817 attribute_deprecated
2818 void *thread_opaque;
2822 * noise vs. sse weight for the nsse comparison function
2823 * - encoding: Set by user.
2824 * - decoding: unused
2830 * - encoding: Set by user.
2831 * - decoding: Set by libavcodec.
2834 #define FF_PROFILE_UNKNOWN -99
2835 #define FF_PROFILE_RESERVED -100
2837 #define FF_PROFILE_AAC_MAIN 0
2838 #define FF_PROFILE_AAC_LOW 1
2839 #define FF_PROFILE_AAC_SSR 2
2840 #define FF_PROFILE_AAC_LTP 3
2841 #define FF_PROFILE_AAC_HE 4
2842 #define FF_PROFILE_AAC_HE_V2 28
2843 #define FF_PROFILE_AAC_LD 22
2844 #define FF_PROFILE_AAC_ELD 38
2845 #define FF_PROFILE_MPEG2_AAC_LOW 128
2846 #define FF_PROFILE_MPEG2_AAC_HE 131
2848 #define FF_PROFILE_DTS 20
2849 #define FF_PROFILE_DTS_ES 30
2850 #define FF_PROFILE_DTS_96_24 40
2851 #define FF_PROFILE_DTS_HD_HRA 50
2852 #define FF_PROFILE_DTS_HD_MA 60
2854 #define FF_PROFILE_MPEG2_422 0
2855 #define FF_PROFILE_MPEG2_HIGH 1
2856 #define FF_PROFILE_MPEG2_SS 2
2857 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2858 #define FF_PROFILE_MPEG2_MAIN 4
2859 #define FF_PROFILE_MPEG2_SIMPLE 5
2861 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2862 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2864 #define FF_PROFILE_H264_BASELINE 66
2865 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2866 #define FF_PROFILE_H264_MAIN 77
2867 #define FF_PROFILE_H264_EXTENDED 88
2868 #define FF_PROFILE_H264_HIGH 100
2869 #define FF_PROFILE_H264_HIGH_10 110
2870 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2871 #define FF_PROFILE_H264_HIGH_422 122
2872 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2873 #define FF_PROFILE_H264_HIGH_444 144
2874 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2875 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2876 #define FF_PROFILE_H264_CAVLC_444 44
2878 #define FF_PROFILE_VC1_SIMPLE 0
2879 #define FF_PROFILE_VC1_MAIN 1
2880 #define FF_PROFILE_VC1_COMPLEX 2
2881 #define FF_PROFILE_VC1_ADVANCED 3
2883 #define FF_PROFILE_MPEG4_SIMPLE 0
2884 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2885 #define FF_PROFILE_MPEG4_CORE 2
2886 #define FF_PROFILE_MPEG4_MAIN 3
2887 #define FF_PROFILE_MPEG4_N_BIT 4
2888 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2889 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2890 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2891 #define FF_PROFILE_MPEG4_HYBRID 8
2892 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2893 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2894 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2895 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2896 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2897 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2898 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2900 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2901 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2902 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2903 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2904 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2907 #define FF_PROFILE_HEVC_MAIN 1
2908 #define FF_PROFILE_HEVC_MAIN_10 2
2909 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2910 #define FF_PROFILE_HEVC_REXT 4
2914 * - encoding: Set by user.
2915 * - decoding: Set by libavcodec.
2918 #define FF_LEVEL_UNKNOWN -99
2921 * Skip loop filtering for selected frames.
2922 * - encoding: unused
2923 * - decoding: Set by user.
2925 enum AVDiscard skip_loop_filter;
2928 * Skip IDCT/dequantization for selected frames.
2929 * - encoding: unused
2930 * - decoding: Set by user.
2932 enum AVDiscard skip_idct;
2935 * Skip decoding for selected frames.
2936 * - encoding: unused
2937 * - decoding: Set by user.
2939 enum AVDiscard skip_frame;
2942 * Header containing style information for text subtitles.
2943 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2944 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2945 * the Format line following. It shouldn't include any Dialogue line.
2946 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2947 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2949 uint8_t *subtitle_header;
2950 int subtitle_header_size;
2952 #if FF_API_ERROR_RATE
2954 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2957 attribute_deprecated
2961 #if FF_API_CODEC_PKT
2963 * @deprecated this field is not supposed to be accessed from outside lavc
2965 attribute_deprecated
2970 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2971 * Used for compliant TS muxing.
2972 * - encoding: Set by libavcodec.
2973 * - decoding: unused.
2978 * Encoding only. Allow encoders to output packets that do not contain any
2979 * encoded data, only side data.
2981 * Some encoders need to output such packets, e.g. to update some stream
2982 * parameters at the end of encoding.
2984 * All callers are strongly recommended to set this option to 1 and update
2985 * their code to deal with such packets, since this behaviour may become
2986 * always enabled in the future (then this option will be deprecated and
2987 * later removed). To avoid ABI issues when this happens, the callers should
2988 * use AVOptions to set this field.
2990 int side_data_only_packets;
2993 * Audio only. The number of "priming" samples (padding) inserted by the
2994 * encoder at the beginning of the audio. I.e. this number of leading
2995 * decoded samples must be discarded by the caller to get the original audio
2996 * without leading padding.
2998 * - decoding: unused
2999 * - encoding: Set by libavcodec. The timestamps on the output packets are
3000 * adjusted by the encoder so that they always refer to the
3001 * first sample of the data actually contained in the packet,
3002 * including any added padding. E.g. if the timebase is
3003 * 1/samplerate and the timestamp of the first input sample is
3004 * 0, the timestamp of the first output packet will be
3007 int initial_padding;
3010 * - decoding: For codecs that store a framerate value in the compressed
3011 * bitstream, the decoder may export it here. { 0, 1} when
3013 * - encoding: unused
3015 AVRational framerate;
3018 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3019 * - encoding: unused.
3020 * - decoding: Set by libavcodec before calling get_format()
3022 enum AVPixelFormat sw_pix_fmt;
3025 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3026 * Code outside libavcodec should access this field using:
3027 * av_codec_{get,set}_pkt_timebase(avctx)
3028 * - encoding unused.
3029 * - decoding set by user.
3031 AVRational pkt_timebase;
3035 * Code outside libavcodec should access this field using:
3036 * av_codec_{get,set}_codec_descriptor(avctx)
3037 * - encoding: unused.
3038 * - decoding: set by libavcodec.
3040 const AVCodecDescriptor *codec_descriptor;
3044 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3045 * - encoding: unused
3046 * - decoding: Set by user.
3047 * Code outside libavcodec should access this field using:
3048 * av_codec_{get,set}_lowres(avctx)
3054 * Current statistics for PTS correction.
3055 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3056 * - encoding: unused
3058 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3059 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3060 int64_t pts_correction_last_pts; /// PTS of the last frame
3061 int64_t pts_correction_last_dts; /// DTS of the last frame
3064 * Character encoding of the input subtitles file.
3065 * - decoding: set by user
3066 * - encoding: unused
3071 * Subtitles character encoding mode. Formats or codecs might be adjusting
3072 * this setting (if they are doing the conversion themselves for instance).
3073 * - decoding: set by libavcodec
3074 * - encoding: unused
3076 int sub_charenc_mode;
3077 #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)
3078 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
3079 #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
3082 * Skip processing alpha if supported by codec.
3083 * Note that if the format uses pre-multiplied alpha (common with VP6,
3084 * and recommended due to better video quality/compression)
3085 * the image will look as if alpha-blended onto a black background.
3086 * However for formats that do not use pre-multiplied alpha
3087 * there might be serious artefacts (though e.g. libswscale currently
3088 * assumes pre-multiplied alpha anyway).
3089 * Code outside libavcodec should access this field using AVOptions
3091 * - decoding: set by user
3092 * - encoding: unused
3097 * Number of samples to skip after a discontinuity
3098 * - decoding: unused
3099 * - encoding: set by libavcodec
3103 #if !FF_API_DEBUG_MV
3105 * debug motion vectors
3106 * Code outside libavcodec should access this field using AVOptions
3107 * - encoding: Set by user.
3108 * - decoding: Set by user.
3111 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
3112 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
3113 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3117 * custom intra quantization matrix
3118 * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3119 * - encoding: Set by user, can be NULL.
3120 * - decoding: unused.
3122 uint16_t *chroma_intra_matrix;
3125 * dump format separator.
3126 * can be ", " or "\n " or anything else
3127 * Code outside libavcodec should access this field using AVOptions
3128 * (NO direct access).
3129 * - encoding: Set by user.
3130 * - decoding: Set by user.
3132 uint8_t *dump_separator;
3135 * ',' separated list of allowed decoders.
3136 * If NULL then all are allowed
3137 * - encoding: unused
3138 * - decoding: set by user through AVOPtions (NO direct access)
3140 char *codec_whitelist;
3143 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3144 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3146 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3147 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3149 int av_codec_get_lowres(const AVCodecContext *avctx);
3150 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3152 int av_codec_get_seek_preroll(const AVCodecContext *avctx);
3153 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3155 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3156 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3161 typedef struct AVProfile {
3163 const char *name; ///< short name for the profile
3166 typedef struct AVCodecDefault AVCodecDefault;
3173 typedef struct AVCodec {
3175 * Name of the codec implementation.
3176 * The name is globally unique among encoders and among decoders (but an
3177 * encoder and a decoder can share the same name).
3178 * This is the primary way to find a codec from the user perspective.
3182 * Descriptive name for the codec, meant to be more human readable than name.
3183 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3185 const char *long_name;
3186 enum AVMediaType type;
3189 * Codec capabilities.
3193 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3194 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3195 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3196 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3197 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3199 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3201 const AVClass *priv_class; ///< AVClass for the private context
3202 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3204 /*****************************************************************
3205 * No fields below this line are part of the public API. They
3206 * may not be used outside of libavcodec and can be changed and
3208 * New public fields should be added right above.
3209 *****************************************************************
3212 struct AVCodec *next;
3214 * @name Frame-level threading support functions
3218 * If defined, called on thread contexts when they are created.
3219 * If the codec allocates writable tables in init(), re-allocate them here.
3220 * priv_data will be set to a copy of the original.
3222 int (*init_thread_copy)(AVCodecContext *);
3224 * Copy necessary context variables from a previous thread context to the current one.
3225 * If not defined, the next thread will start automatically; otherwise, the codec
3226 * must call ff_thread_finish_setup().
3228 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3230 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3234 * Private codec-specific defaults.
3236 const AVCodecDefault *defaults;
3239 * Initialize codec static data, called from avcodec_register().
3241 void (*init_static_data)(struct AVCodec *codec);
3243 int (*init)(AVCodecContext *);
3244 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3245 const struct AVSubtitle *sub);
3247 * Encode data to an AVPacket.
3249 * @param avctx codec context
3250 * @param avpkt output AVPacket (may contain a user-provided buffer)
3251 * @param[in] frame AVFrame containing the raw data to be encoded
3252 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3253 * non-empty packet was returned in avpkt.
3254 * @return 0 on success, negative error code on failure
3256 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3257 int *got_packet_ptr);
3258 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3259 int (*close)(AVCodecContext *);
3262 * Will be called when seeking
3264 void (*flush)(AVCodecContext *);
3267 int av_codec_get_max_lowres(const AVCodec *codec);
3269 struct MpegEncContext;
3272 * @defgroup lavc_hwaccel AVHWAccel
3275 typedef struct AVHWAccel {
3277 * Name of the hardware accelerated codec.
3278 * The name is globally unique among encoders and among decoders (but an
3279 * encoder and a decoder can share the same name).
3284 * Type of codec implemented by the hardware accelerator.
3286 * See AVMEDIA_TYPE_xxx
3288 enum AVMediaType type;
3291 * Codec implemented by the hardware accelerator.
3293 * See AV_CODEC_ID_xxx
3298 * Supported pixel format.
3300 * Only hardware accelerated formats are supported here.
3302 enum AVPixelFormat pix_fmt;
3305 * Hardware accelerated codec capabilities.
3306 * see FF_HWACCEL_CODEC_CAP_*
3310 /*****************************************************************
3311 * No fields below this line are part of the public API. They
3312 * may not be used outside of libavcodec and can be changed and
3314 * New public fields should be added right above.
3315 *****************************************************************
3317 struct AVHWAccel *next;
3320 * Allocate a custom buffer
3322 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3325 * Called at the beginning of each frame or field picture.
3327 * Meaningful frame information (codec specific) is guaranteed to
3328 * be parsed at this point. This function is mandatory.
3330 * Note that buf can be NULL along with buf_size set to 0.
3331 * Otherwise, this means the whole frame is available at this point.
3333 * @param avctx the codec context
3334 * @param buf the frame data buffer base
3335 * @param buf_size the size of the frame in bytes
3336 * @return zero if successful, a negative value otherwise
3338 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3341 * Callback for each slice.
3343 * Meaningful slice information (codec specific) is guaranteed to
3344 * be parsed at this point. This function is mandatory.
3345 * The only exception is XvMC, that works on MB level.
3347 * @param avctx the codec context
3348 * @param buf the slice data buffer base
3349 * @param buf_size the size of the slice in bytes
3350 * @return zero if successful, a negative value otherwise
3352 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3355 * Called at the end of each frame or field picture.
3357 * The whole picture is parsed at this point and can now be sent
3358 * to the hardware accelerator. This function is mandatory.
3360 * @param avctx the codec context
3361 * @return zero if successful, a negative value otherwise
3363 int (*end_frame)(AVCodecContext *avctx);
3366 * Size of per-frame hardware accelerator private data.
3368 * Private data is allocated with av_mallocz() before
3369 * AVCodecContext.get_buffer() and deallocated after
3370 * AVCodecContext.release_buffer().
3372 int frame_priv_data_size;
3375 * Called for every Macroblock in a slice.
3377 * XvMC uses it to replace the ff_mpv_decode_mb().
3378 * Instead of decoding to raw picture, MB parameters are
3379 * stored in an array provided by the video driver.
3381 * @param s the mpeg context
3383 void (*decode_mb)(struct MpegEncContext *s);
3386 * Initialize the hwaccel private data.
3388 * This will be called from ff_get_format(), after hwaccel and
3389 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3392 int (*init)(AVCodecContext *avctx);
3395 * Uninitialize the hwaccel private data.
3397 * This will be called from get_format() or avcodec_close(), after hwaccel
3398 * and hwaccel_context are already uninitialized.
3400 int (*uninit)(AVCodecContext *avctx);
3403 * Size of the private data to allocate in
3404 * AVCodecInternal.hwaccel_priv_data.
3410 * Hardware acceleration should be used for decoding even if the codec level
3411 * used is unknown or higher than the maximum supported level reported by the
3414 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3417 * Hardware acceleration can output YUV pixel formats with a different chroma
3418 * sampling than 4:2:0 and/or other than 8 bits per component.
3420 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3427 * @defgroup lavc_picture AVPicture
3429 * Functions for working with AVPicture
3434 * Picture data structure.
3436 * Up to four components can be stored into it, the last component is
3439 typedef struct AVPicture {
3440 uint8_t *data[AV_NUM_DATA_POINTERS]; ///< pointers to the image data planes
3441 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3448 enum AVSubtitleType {
3451 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3454 * Plain text, the text field must be set by the decoder and is
3455 * authoritative. ass and pict fields may contain approximations.
3460 * Formatted text, the ass field must be set by the decoder and is
3461 * authoritative. pict and text fields may contain approximations.
3466 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3468 typedef struct AVSubtitleRect {
3469 int x; ///< top left corner of pict, undefined when pict is not set
3470 int y; ///< top left corner of pict, undefined when pict is not set
3471 int w; ///< width of pict, undefined when pict is not set
3472 int h; ///< height of pict, undefined when pict is not set
3473 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3476 * data+linesize for the bitmap of this subtitle.
3477 * can be set for text/ass as well once they are rendered
3480 enum AVSubtitleType type;
3482 char *text; ///< 0 terminated plain UTF-8 text
3485 * 0 terminated ASS/SSA compatible event line.
3486 * The presentation of this is unaffected by the other values in this
3494 typedef struct AVSubtitle {
3495 uint16_t format; /* 0 = graphics */
3496 uint32_t start_display_time; /* relative to packet pts, in ms */
3497 uint32_t end_display_time; /* relative to packet pts, in ms */
3499 AVSubtitleRect **rects;
3500 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3504 * If c is NULL, returns the first registered codec,
3505 * if c is non-NULL, returns the next registered codec after c,
3506 * or NULL if c is the last one.
3508 AVCodec *av_codec_next(const AVCodec *c);
3511 * Return the LIBAVCODEC_VERSION_INT constant.
3513 unsigned avcodec_version(void);
3516 * Return the libavcodec build-time configuration.
3518 const char *avcodec_configuration(void);
3521 * Return the libavcodec license.
3523 const char *avcodec_license(void);
3526 * Register the codec codec and initialize libavcodec.
3528 * @warning either this function or avcodec_register_all() must be called
3529 * before any other libavcodec functions.
3531 * @see avcodec_register_all()
3533 void avcodec_register(AVCodec *codec);
3536 * Register all the codecs, parsers and bitstream filters which were enabled at
3537 * configuration time. If you do not call this function you can select exactly
3538 * which formats you want to support, by using the individual registration
3541 * @see avcodec_register
3542 * @see av_register_codec_parser
3543 * @see av_register_bitstream_filter
3545 void avcodec_register_all(void);
3548 * Allocate an AVCodecContext and set its fields to default values. The
3549 * resulting struct should be freed with avcodec_free_context().
3551 * @param codec if non-NULL, allocate private data and initialize defaults
3552 * for the given codec. It is illegal to then call avcodec_open2()
3553 * with a different codec.
3554 * If NULL, then the codec-specific defaults won't be initialized,
3555 * which may result in suboptimal default settings (this is
3556 * important mainly for encoders, e.g. libx264).
3558 * @return An AVCodecContext filled with default values or NULL on failure.
3559 * @see avcodec_get_context_defaults
3561 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3564 * Free the codec context and everything associated with it and write NULL to
3565 * the provided pointer.
3567 void avcodec_free_context(AVCodecContext **avctx);
3570 * Set the fields of the given AVCodecContext to default values corresponding
3571 * to the given codec (defaults may be codec-dependent).
3573 * Do not call this function if a non-NULL codec has been passed
3574 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3575 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3576 * different codec on this AVCodecContext.
3578 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3581 * Get the AVClass for AVCodecContext. It can be used in combination with
3582 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3584 * @see av_opt_find().
3586 const AVClass *avcodec_get_class(void);
3589 * Get the AVClass for AVFrame. It can be used in combination with
3590 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3592 * @see av_opt_find().
3594 const AVClass *avcodec_get_frame_class(void);
3597 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3598 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3600 * @see av_opt_find().
3602 const AVClass *avcodec_get_subtitle_rect_class(void);
3605 * Copy the settings of the source AVCodecContext into the destination
3606 * AVCodecContext. The resulting destination codec context will be
3607 * unopened, i.e. you are required to call avcodec_open2() before you
3608 * can use this AVCodecContext to decode/encode video/audio data.
3610 * @param dest target codec context, should be initialized with
3611 * avcodec_alloc_context3(NULL), but otherwise uninitialized
3612 * @param src source codec context
3613 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3615 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3617 #if FF_API_AVFRAME_LAVC
3619 * @deprecated use av_frame_alloc()
3621 attribute_deprecated
3622 AVFrame *avcodec_alloc_frame(void);
3625 * Set the fields of the given AVFrame to default values.
3627 * @param frame The AVFrame of which the fields should be set to default values.
3629 * @deprecated use av_frame_unref()
3631 attribute_deprecated
3632 void avcodec_get_frame_defaults(AVFrame *frame);
3635 * Free the frame and any dynamically allocated objects in it,
3636 * e.g. extended_data.
3638 * @param frame frame to be freed. The pointer will be set to NULL.
3640 * @warning this function does NOT free the data buffers themselves
3641 * (it does not know how, since they might have been allocated with
3642 * a custom get_buffer()).
3644 * @deprecated use av_frame_free()
3646 attribute_deprecated
3647 void avcodec_free_frame(AVFrame **frame);
3651 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3652 * function the context has to be allocated with avcodec_alloc_context3().
3654 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3655 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3656 * retrieving a codec.
3658 * @warning This function is not thread safe!
3660 * @note Always call this function before using decoding routines (such as
3661 * @ref avcodec_decode_video2()).
3664 * avcodec_register_all();
3665 * av_dict_set(&opts, "b", "2.5M", 0);
3666 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3670 * context = avcodec_alloc_context3(codec);
3672 * if (avcodec_open2(context, codec, opts) < 0)
3676 * @param avctx The context to initialize.
3677 * @param codec The codec to open this context for. If a non-NULL codec has been
3678 * previously passed to avcodec_alloc_context3() or
3679 * avcodec_get_context_defaults3() for this context, then this
3680 * parameter MUST be either NULL or equal to the previously passed
3682 * @param options A dictionary filled with AVCodecContext and codec-private options.
3683 * On return this object will be filled with options that were not found.
3685 * @return zero on success, a negative value on error
3686 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3687 * av_dict_set(), av_opt_find().
3689 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3692 * Close a given AVCodecContext and free all the data associated with it
3693 * (but not the AVCodecContext itself).
3695 * Calling this function on an AVCodecContext that hasn't been opened will free
3696 * the codec-specific data allocated in avcodec_alloc_context3() /
3697 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3700 int avcodec_close(AVCodecContext *avctx);
3703 * Free all allocated data in the given subtitle struct.
3705 * @param sub AVSubtitle to free.
3707 void avsubtitle_free(AVSubtitle *sub);
3714 * @addtogroup lavc_packet
3718 #if FF_API_DESTRUCT_PACKET
3720 * Default packet destructor.
3721 * @deprecated use the AVBuffer API instead
3723 attribute_deprecated
3724 void av_destruct_packet(AVPacket *pkt);
3728 * Initialize optional fields of a packet with default values.
3730 * Note, this does not touch the data and size members, which have to be
3731 * initialized separately.
3735 void av_init_packet(AVPacket *pkt);
3738 * Allocate the payload of a packet and initialize its fields with
3742 * @param size wanted payload size
3743 * @return 0 if OK, AVERROR_xxx otherwise
3745 int av_new_packet(AVPacket *pkt, int size);
3748 * Reduce packet size, correctly zeroing padding
3751 * @param size new size
3753 void av_shrink_packet(AVPacket *pkt, int size);
3756 * Increase packet size, correctly zeroing padding
3759 * @param grow_by number of bytes by which to increase the size of the packet
3761 int av_grow_packet(AVPacket *pkt, int grow_by);
3764 * Initialize a reference-counted packet from av_malloc()ed data.
3766 * @param pkt packet to be initialized. This function will set the data, size,
3767 * buf and destruct fields, all others are left untouched.
3768 * @param data Data allocated by av_malloc() to be used as packet data. If this
3769 * function returns successfully, the data is owned by the underlying AVBuffer.
3770 * The caller may not access the data through other means.
3771 * @param size size of data in bytes, without the padding. I.e. the full buffer
3772 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3774 * @return 0 on success, a negative AVERROR on error
3776 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3779 * @warning This is a hack - the packet memory allocation stuff is broken. The
3780 * packet is allocated if it was not really allocated.
3782 int av_dup_packet(AVPacket *pkt);
3785 * Copy packet, including contents
3787 * @return 0 on success, negative AVERROR on fail
3789 int av_copy_packet(AVPacket *dst, const AVPacket *src);
3792 * Copy packet side data
3794 * @return 0 on success, negative AVERROR on fail
3796 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
3801 * @param pkt packet to free
3803 void av_free_packet(AVPacket *pkt);
3806 * Allocate new information of a packet.
3809 * @param type side information type
3810 * @param size side information size
3811 * @return pointer to fresh allocated data or NULL otherwise
3813 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3817 * Shrink the already allocated side data buffer
3820 * @param type side information type
3821 * @param size new side information size
3822 * @return 0 on success, < 0 on failure
3824 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3828 * Get side information from packet.
3831 * @param type desired side information type
3832 * @param size pointer for side information size to store (optional)
3833 * @return pointer to data if present or NULL otherwise
3835 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3838 int av_packet_merge_side_data(AVPacket *pkt);
3840 int av_packet_split_side_data(AVPacket *pkt);
3843 * Pack a dictionary for use in side_data.
3845 * @param dict The dictionary to pack.
3846 * @param size pointer to store the size of the returned data
3847 * @return pointer to data if successful, NULL otherwise
3849 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
3851 * Unpack a dictionary from side_data.
3853 * @param data data from side_data
3854 * @param size size of the data
3855 * @param dict the metadata storage dictionary
3856 * @return 0 on success, < 0 on failure
3858 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
3862 * Convenience function to free all the side data stored.
3863 * All the other fields stay untouched.
3867 void av_packet_free_side_data(AVPacket *pkt);
3870 * Setup a new reference to the data described by a given packet
3872 * If src is reference-counted, setup dst as a new reference to the
3873 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3874 * data from src into it.
3876 * All the other fields are copied from src.
3878 * @see av_packet_unref
3880 * @param dst Destination packet
3881 * @param src Source packet
3883 * @return 0 on success, a negative AVERROR on error.
3885 int av_packet_ref(AVPacket *dst, const AVPacket *src);
3890 * Unreference the buffer referenced by the packet and reset the
3891 * remaining packet fields to their default values.
3893 * @param pkt The packet to be unreferenced.
3895 void av_packet_unref(AVPacket *pkt);
3898 * Move every field in src to dst and reset src.
3900 * @see av_packet_unref
3902 * @param src Source packet, will be reset
3903 * @param dst Destination packet
3905 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3908 * Copy only "properties" fields from src to dst.
3910 * Properties for the purpose of this function are all the fields
3911 * beside those related to the packet data (buf, data, size)
3913 * @param dst Destination packet
3914 * @param src Source packet
3916 * @return 0 on success AVERROR on failure.
3919 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3922 * Convert valid timing fields (timestamps / durations) in a packet from one
3923 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3926 * @param pkt packet on which the conversion will be performed
3927 * @param tb_src source timebase, in which the timing fields in pkt are
3929 * @param tb_dst destination timebase, to which the timing fields will be
3932 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
3939 * @addtogroup lavc_decoding
3944 * Find a registered decoder with a matching codec ID.
3946 * @param id AVCodecID of the requested decoder
3947 * @return A decoder if one was found, NULL otherwise.
3949 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3952 * Find a registered decoder with the specified name.
3954 * @param name name of the requested decoder
3955 * @return A decoder if one was found, NULL otherwise.
3957 AVCodec *avcodec_find_decoder_by_name(const char *name);
3959 #if FF_API_GET_BUFFER
3960 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3961 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3962 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3966 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3967 * it can be called by custom get_buffer2() implementations for decoders without
3968 * CODEC_CAP_DR1 set.
3970 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3974 * Return the amount of padding in pixels which the get_buffer callback must
3975 * provide around the edge of the image for codecs which do not have the
3976 * CODEC_FLAG_EMU_EDGE flag.
3978 * @return Required padding in pixels.
3980 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
3983 attribute_deprecated
3984 unsigned avcodec_get_edge_width(void);
3988 * Modify width and height values so that they will result in a memory
3989 * buffer that is acceptable for the codec if you do not use any horizontal
3992 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3994 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3997 * Modify width and height values so that they will result in a memory
3998 * buffer that is acceptable for the codec if you also ensure that all
3999 * line sizes are a multiple of the respective linesize_align[i].
4001 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
4003 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4004 int linesize_align[AV_NUM_DATA_POINTERS]);
4007 * Converts AVChromaLocation to swscale x/y chroma position.
4009 * The positions represent the chroma (0,0) position in a coordinates system
4010 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4012 * @param xpos horizontal chroma sample position
4013 * @param ypos vertical chroma sample position
4015 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4018 * Converts swscale x/y chroma position to AVChromaLocation.
4020 * The positions represent the chroma (0,0) position in a coordinates system
4021 * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4023 * @param xpos horizontal chroma sample position
4024 * @param ypos vertical chroma sample position
4026 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4028 #if FF_API_OLD_DECODE_AUDIO
4030 * Wrapper function which calls avcodec_decode_audio4.
4032 * @deprecated Use avcodec_decode_audio4 instead.
4034 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
4035 * Some decoders may support multiple frames in a single AVPacket, such
4036 * decoders would then just decode the first frame. In this case,
4037 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
4038 * the remaining data in order to decode the second frame etc.
4040 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
4041 * decompressed frame size in bytes.
4043 * @warning You must set frame_size_ptr to the allocated size of the
4044 * output buffer before calling avcodec_decode_audio3().
4046 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4047 * the actual read bytes because some optimized bitstream readers read 32 or 64
4048 * bits at once and could read over the end.
4050 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
4051 * no overreading happens for damaged MPEG streams.
4053 * @warning You must not provide a custom get_buffer() when using
4054 * avcodec_decode_audio3(). Doing so will override it with
4055 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
4056 * which does allow the application to provide a custom get_buffer().
4058 * @note You might have to align the input buffer avpkt->data and output buffer
4059 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
4060 * necessary at all, on others it won't work at all if not aligned and on others
4061 * it will work but it will have an impact on performance.
4063 * In practice, avpkt->data should have 4 byte alignment at minimum and
4064 * samples should be 16 byte aligned unless the CPU doesn't need it
4065 * (AltiVec and SSE do).
4067 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4068 * between input and output, these need to be fed with avpkt->data=NULL,
4069 * avpkt->size=0 at the end to return the remaining frames.
4071 * @param avctx the codec context
4072 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
4073 * If the sample format is planar, each channel plane will
4074 * be the same size, with no padding between channels.
4075 * @param[in,out] frame_size_ptr the output buffer size in bytes
4076 * @param[in] avpkt The input AVPacket containing the input buffer.
4077 * You can create such packet with av_init_packet() and by then setting
4078 * data and size, some decoders might in addition need other fields.
4079 * All decoders are designed to use the least fields possible though.
4080 * @return On error a negative value is returned, otherwise the number of bytes
4081 * used or zero if no frame data was decompressed (used) from the input AVPacket.
4083 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
4084 int *frame_size_ptr,
4089 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4091 * Some decoders may support multiple frames in a single AVPacket. Such
4092 * decoders would then just decode the first frame and the return value would be
4093 * less than the packet size. In this case, avcodec_decode_audio4 has to be
4094 * called again with an AVPacket containing the remaining data in order to
4095 * decode the second frame, etc... Even if no frames are returned, the packet
4096 * needs to be fed to the decoder with remaining data until it is completely
4097 * consumed or an error occurs.
4099 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4100 * and output. This means that for some packets they will not immediately
4101 * produce decoded output and need to be flushed at the end of decoding to get
4102 * all the decoded data. Flushing is done by calling this function with packets
4103 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4104 * returning samples. It is safe to flush even those decoders that are not
4105 * marked with CODEC_CAP_DELAY, then no samples will be returned.
4107 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
4108 * larger than the actual read bytes because some optimized bitstream
4109 * readers read 32 or 64 bits at once and could read over the end.
4111 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4112 * before packets may be fed to the decoder.
4114 * @param avctx the codec context
4115 * @param[out] frame The AVFrame in which to store decoded audio samples.
4116 * The decoder will allocate a buffer for the decoded frame by
4117 * calling the AVCodecContext.get_buffer2() callback.
4118 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4119 * reference counted and the returned reference belongs to the
4120 * caller. The caller must release the frame using av_frame_unref()
4121 * when the frame is no longer needed. The caller may safely write
4122 * to the frame if av_frame_is_writable() returns 1.
4123 * When AVCodecContext.refcounted_frames is set to 0, the returned
4124 * reference belongs to the decoder and is valid only until the
4125 * next call to this function or until closing or flushing the
4126 * decoder. The caller may not write to it.
4127 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4128 * non-zero. Note that this field being set to zero
4129 * does not mean that an error has occurred. For
4130 * decoders with CODEC_CAP_DELAY set, no given decode
4131 * call is guaranteed to produce a frame.
4132 * @param[in] avpkt The input AVPacket containing the input buffer.
4133 * At least avpkt->data and avpkt->size should be set. Some
4134 * decoders might also require additional fields to be set.
4135 * @return A negative error code is returned if an error occurred during
4136 * decoding, otherwise the number of bytes consumed from the input
4137 * AVPacket is returned.
4139 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4140 int *got_frame_ptr, const AVPacket *avpkt);
4143 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4144 * Some decoders may support multiple frames in a single AVPacket, such
4145 * decoders would then just decode the first frame.
4147 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4148 * the actual read bytes because some optimized bitstream readers read 32 or 64
4149 * bits at once and could read over the end.
4151 * @warning The end of the input buffer buf should be set to 0 to ensure that
4152 * no overreading happens for damaged MPEG streams.
4154 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4155 * between input and output, these need to be fed with avpkt->data=NULL,
4156 * avpkt->size=0 at the end to return the remaining frames.
4158 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4159 * before packets may be fed to the decoder.
4161 * @param avctx the codec context
4162 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4163 * Use av_frame_alloc() to get an AVFrame. The codec will
4164 * allocate memory for the actual bitmap by calling the
4165 * AVCodecContext.get_buffer2() callback.
4166 * When AVCodecContext.refcounted_frames is set to 1, the frame is
4167 * reference counted and the returned reference belongs to the
4168 * caller. The caller must release the frame using av_frame_unref()
4169 * when the frame is no longer needed. The caller may safely write
4170 * to the frame if av_frame_is_writable() returns 1.
4171 * When AVCodecContext.refcounted_frames is set to 0, the returned
4172 * reference belongs to the decoder and is valid only until the
4173 * next call to this function or until closing or flushing the
4174 * decoder. The caller may not write to it.
4176 * @param[in] avpkt The input AVPacket containing the input buffer.
4177 * You can create such packet with av_init_packet() and by then setting
4178 * data and size, some decoders might in addition need other fields like
4179 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4181 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4182 * @return On error a negative value is returned, otherwise the number of bytes
4183 * used or zero if no frame could be decompressed.
4185 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4186 int *got_picture_ptr,
4187 const AVPacket *avpkt);
4190 * Decode a subtitle message.
4191 * Return a negative value on error, otherwise return the number of bytes used.
4192 * If no subtitle could be decompressed, got_sub_ptr is zero.
4193 * Otherwise, the subtitle is stored in *sub.
4194 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4195 * simplicity, because the performance difference is expect to be negligible
4196 * and reusing a get_buffer written for video codecs would probably perform badly
4197 * due to a potentially very different allocation pattern.
4199 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4200 * and output. This means that for some packets they will not immediately
4201 * produce decoded output and need to be flushed at the end of decoding to get
4202 * all the decoded data. Flushing is done by calling this function with packets
4203 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4204 * returning subtitles. It is safe to flush even those decoders that are not
4205 * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4207 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4208 * before packets may be fed to the decoder.
4210 * @param avctx the codec context
4211 * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4212 * must be freed with avsubtitle_free if *got_sub_ptr is set.
4213 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4214 * @param[in] avpkt The input AVPacket containing the input buffer.
4216 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4221 * @defgroup lavc_parsing Frame parsing
4225 enum AVPictureStructure {
4226 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
4227 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
4228 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4229 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
4232 typedef struct AVCodecParserContext {
4234 struct AVCodecParser *parser;
4235 int64_t frame_offset; /* offset of the current frame */
4236 int64_t cur_offset; /* current offset
4237 (incremented by each av_parser_parse()) */
4238 int64_t next_frame_offset; /* offset of the next frame */
4240 int pict_type; /* XXX: Put it back in AVCodecContext. */
4242 * This field is used for proper frame duration computation in lavf.
4243 * It signals, how much longer the frame duration of the current frame
4244 * is compared to normal frame duration.
4246 * frame_duration = (1 + repeat_pict) * time_base
4248 * It is used by codecs like H.264 to display telecined material.
4250 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4251 int64_t pts; /* pts of the current frame */
4252 int64_t dts; /* dts of the current frame */
4257 int fetch_timestamp;
4259 #define AV_PARSER_PTS_NB 4
4260 int cur_frame_start_index;
4261 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4262 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4263 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4266 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4267 #define PARSER_FLAG_ONCE 0x0002
4268 /// Set if the parser has a valid file offset
4269 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4270 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4272 int64_t offset; ///< byte offset from starting packet start
4273 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4276 * Set by parser to 1 for key frames and 0 for non-key frames.
4277 * It is initialized to -1, so if the parser doesn't set this flag,
4278 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4284 * Time difference in stream time base units from the pts of this
4285 * packet to the point at which the output from the decoder has converged
4286 * independent from the availability of previous frames. That is, the
4287 * frames are virtually identical no matter if decoding started from
4288 * the very first frame or from this keyframe.
4289 * Is AV_NOPTS_VALUE if unknown.
4290 * This field is not the display duration of the current frame.
4291 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4294 * The purpose of this field is to allow seeking in streams that have no
4295 * keyframes in the conventional sense. It corresponds to the
4296 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4297 * essential for some types of subtitle streams to ensure that all
4298 * subtitles are correctly displayed after seeking.
4300 int64_t convergence_duration;
4302 // Timestamp generation support:
4304 * Synchronization point for start of timestamp generation.
4306 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4309 * For example, this corresponds to presence of H.264 buffering period
4315 * Offset of the current timestamp against last timestamp sync point in
4316 * units of AVCodecContext.time_base.
4318 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4319 * contain a valid timestamp offset.
4321 * Note that the timestamp of sync point has usually a nonzero
4322 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4323 * the next frame after timestamp sync point will be usually 1.
4325 * For example, this corresponds to H.264 cpb_removal_delay.
4327 int dts_ref_dts_delta;
4330 * Presentation delay of current frame in units of AVCodecContext.time_base.
4332 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4333 * contain valid non-negative timestamp delta (presentation time of a frame
4334 * must not lie in the past).
4336 * This delay represents the difference between decoding and presentation
4337 * time of the frame.
4339 * For example, this corresponds to H.264 dpb_output_delay.
4344 * Position of the packet in file.
4346 * Analogous to cur_frame_pts/dts
4348 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4351 * Byte position of currently parsed frame in stream.
4356 * Previous frame byte position.
4361 * Duration of the current frame.
4362 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4363 * For all other types, this is in units of AVCodecContext.time_base.
4367 enum AVFieldOrder field_order;
4370 * Indicate whether a picture is coded as a frame, top field or bottom field.
4372 * For example, H.264 field_pic_flag equal to 0 corresponds to
4373 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4374 * equal to 1 and bottom_field_flag equal to 0 corresponds to
4375 * AV_PICTURE_STRUCTURE_TOP_FIELD.
4377 enum AVPictureStructure picture_structure;
4380 * Picture number incremented in presentation or output order.
4381 * This field may be reinitialized at the first picture of a new sequence.
4383 * For example, this corresponds to H.264 PicOrderCnt.
4385 int output_picture_number;
4388 * Dimensions of the decoded video intended for presentation.
4394 * Dimensions of the coded video.
4400 * The format of the coded data, corresponds to enum AVPixelFormat for video
4401 * and for enum AVSampleFormat for audio.
4403 * Note that a decoder can have considerable freedom in how exactly it
4404 * decodes the data, so the format reported here might be different from the
4405 * one returned by a decoder.
4408 } AVCodecParserContext;
4410 typedef struct AVCodecParser {
4411 int codec_ids[5]; /* several codec IDs are permitted */
4413 int (*parser_init)(AVCodecParserContext *s);
4414 /* This callback never returns an error, a negative value means that
4415 * the frame start was in a previous packet. */
4416 int (*parser_parse)(AVCodecParserContext *s,
4417 AVCodecContext *avctx,
4418 const uint8_t **poutbuf, int *poutbuf_size,
4419 const uint8_t *buf, int buf_size);
4420 void (*parser_close)(AVCodecParserContext *s);
4421 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4422 struct AVCodecParser *next;
4425 AVCodecParser *av_parser_next(const AVCodecParser *c);
4427 void av_register_codec_parser(AVCodecParser *parser);
4428 AVCodecParserContext *av_parser_init(int codec_id);
4433 * @param s parser context.
4434 * @param avctx codec context.
4435 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4436 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4437 * @param buf input buffer.
4438 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4439 * @param pts input presentation timestamp.
4440 * @param dts input decoding timestamp.
4441 * @param pos input byte position in stream.
4442 * @return the number of bytes of the input bitstream used.
4447 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4454 * decode_frame(data, size);
4458 int av_parser_parse2(AVCodecParserContext *s,
4459 AVCodecContext *avctx,
4460 uint8_t **poutbuf, int *poutbuf_size,
4461 const uint8_t *buf, int buf_size,
4462 int64_t pts, int64_t dts,
4466 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4467 * @deprecated use AVBitStreamFilter
4469 int av_parser_change(AVCodecParserContext *s,
4470 AVCodecContext *avctx,
4471 uint8_t **poutbuf, int *poutbuf_size,
4472 const uint8_t *buf, int buf_size, int keyframe);
4473 void av_parser_close(AVCodecParserContext *s);
4481 * @addtogroup lavc_encoding
4486 * Find a registered encoder with a matching codec ID.
4488 * @param id AVCodecID of the requested encoder
4489 * @return An encoder if one was found, NULL otherwise.
4491 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4494 * Find a registered encoder with the specified name.
4496 * @param name name of the requested encoder
4497 * @return An encoder if one was found, NULL otherwise.
4499 AVCodec *avcodec_find_encoder_by_name(const char *name);
4501 #if FF_API_OLD_ENCODE_AUDIO
4503 * Encode an audio frame from samples into buf.
4505 * @deprecated Use avcodec_encode_audio2 instead.
4507 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4508 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4509 * will know how much space is needed because it depends on the value passed
4510 * in buf_size as described below. In that case a lower value can be used.
4512 * @param avctx the codec context
4513 * @param[out] buf the output buffer
4514 * @param[in] buf_size the output buffer size
4515 * @param[in] samples the input buffer containing the samples
4516 * The number of samples read from this buffer is frame_size*channels,
4517 * both of which are defined in avctx.
4518 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4519 * samples read from samples is equal to:
4520 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4521 * This also implies that av_get_bits_per_sample() must not return 0 for these
4523 * @return On error a negative value is returned, on success zero or the number
4524 * of bytes used to encode the data read from the input buffer.
4526 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4527 uint8_t *buf, int buf_size,
4528 const short *samples);
4532 * Encode a frame of audio.
4534 * Takes input samples from frame and writes the next output packet, if
4535 * available, to avpkt. The output packet does not necessarily contain data for
4536 * the most recent frame, as encoders can delay, split, and combine input frames
4537 * internally as needed.
4539 * @param avctx codec context
4540 * @param avpkt output AVPacket.
4541 * The user can supply an output buffer by setting
4542 * avpkt->data and avpkt->size prior to calling the
4543 * function, but if the size of the user-provided data is not
4544 * large enough, encoding will fail. If avpkt->data and
4545 * avpkt->size are set, avpkt->destruct must also be set. All
4546 * other AVPacket fields will be reset by the encoder using
4547 * av_init_packet(). If avpkt->data is NULL, the encoder will
4548 * allocate it. The encoder will set avpkt->size to the size
4549 * of the output packet.
4551 * If this function fails or produces no output, avpkt will be
4552 * freed using av_free_packet() (i.e. avpkt->destruct will be
4553 * called to free the user supplied buffer).
4554 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4555 * May be NULL when flushing an encoder that has the
4556 * CODEC_CAP_DELAY capability set.
4557 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4558 * can have any number of samples.
4559 * If it is not set, frame->nb_samples must be equal to
4560 * avctx->frame_size for all frames except the last.
4561 * The final frame may be smaller than avctx->frame_size.
4562 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4563 * output packet is non-empty, and to 0 if it is
4564 * empty. If the function returns an error, the
4565 * packet can be assumed to be invalid, and the
4566 * value of got_packet_ptr is undefined and should
4568 * @return 0 on success, negative error code on failure
4570 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4571 const AVFrame *frame, int *got_packet_ptr);
4573 #if FF_API_OLD_ENCODE_VIDEO
4575 * @deprecated use avcodec_encode_video2() instead.
4577 * Encode a video frame from pict into buf.
4578 * The input picture should be
4579 * stored using a specific format, namely avctx.pix_fmt.
4581 * @param avctx the codec context
4582 * @param[out] buf the output buffer for the bitstream of encoded frame
4583 * @param[in] buf_size the size of the output buffer in bytes
4584 * @param[in] pict the input picture to encode
4585 * @return On error a negative value is returned, on success zero or the number
4586 * of bytes used from the output buffer.
4588 attribute_deprecated
4589 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4590 const AVFrame *pict);
4594 * Encode a frame of video.
4596 * Takes input raw video data from frame and writes the next output packet, if
4597 * available, to avpkt. The output packet does not necessarily contain data for
4598 * the most recent frame, as encoders can delay and reorder input frames
4599 * internally as needed.
4601 * @param avctx codec context
4602 * @param avpkt output AVPacket.
4603 * The user can supply an output buffer by setting
4604 * avpkt->data and avpkt->size prior to calling the
4605 * function, but if the size of the user-provided data is not
4606 * large enough, encoding will fail. All other AVPacket fields
4607 * will be reset by the encoder using av_init_packet(). If
4608 * avpkt->data is NULL, the encoder will allocate it.
4609 * The encoder will set avpkt->size to the size of the
4610 * output packet. The returned data (if any) belongs to the
4611 * caller, he is responsible for freeing it.
4613 * If this function fails or produces no output, avpkt will be
4614 * freed using av_free_packet() (i.e. avpkt->destruct will be
4615 * called to free the user supplied buffer).
4616 * @param[in] frame AVFrame containing the raw video data to be encoded.
4617 * May be NULL when flushing an encoder that has the
4618 * CODEC_CAP_DELAY capability set.
4619 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4620 * output packet is non-empty, and to 0 if it is
4621 * empty. If the function returns an error, the
4622 * packet can be assumed to be invalid, and the
4623 * value of got_packet_ptr is undefined and should
4625 * @return 0 on success, negative error code on failure
4627 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4628 const AVFrame *frame, int *got_packet_ptr);
4630 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4631 const AVSubtitle *sub);
4638 #if FF_API_AVCODEC_RESAMPLE
4640 * @defgroup lavc_resample Audio resampling
4642 * @deprecated use libswresample instead
4646 struct ReSampleContext;
4647 struct AVResampleContext;
4649 typedef struct ReSampleContext ReSampleContext;
4652 * Initialize audio resampling context.
4654 * @param output_channels number of output channels
4655 * @param input_channels number of input channels
4656 * @param output_rate output sample rate
4657 * @param input_rate input sample rate
4658 * @param sample_fmt_out requested output sample format
4659 * @param sample_fmt_in input sample format
4660 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4661 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4662 * @param linear if 1 then the used FIR filter will be linearly interpolated
4663 between the 2 closest, if 0 the closest will be used
4664 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4665 * @return allocated ReSampleContext, NULL if error occurred
4667 attribute_deprecated
4668 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4669 int output_rate, int input_rate,
4670 enum AVSampleFormat sample_fmt_out,
4671 enum AVSampleFormat sample_fmt_in,
4672 int filter_length, int log2_phase_count,
4673 int linear, double cutoff);
4675 attribute_deprecated
4676 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4679 * Free resample context.
4681 * @param s a non-NULL pointer to a resample context previously
4682 * created with av_audio_resample_init()
4684 attribute_deprecated
4685 void audio_resample_close(ReSampleContext *s);
4689 * Initialize an audio resampler.
4690 * Note, if either rate is not an integer then simply scale both rates up so they are.
4691 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4692 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4693 * @param linear If 1 then the used FIR filter will be linearly interpolated
4694 between the 2 closest, if 0 the closest will be used
4695 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4697 attribute_deprecated
4698 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4701 * Resample an array of samples using a previously configured context.
4702 * @param src an array of unconsumed samples
4703 * @param consumed the number of samples of src which have been consumed are returned here
4704 * @param src_size the number of unconsumed samples available
4705 * @param dst_size the amount of space in samples available in dst
4706 * @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.
4707 * @return the number of samples written in dst or -1 if an error occurred
4709 attribute_deprecated
4710 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4714 * Compensate samplerate/timestamp drift. The compensation is done by changing
4715 * the resampler parameters, so no audible clicks or similar distortions occur
4716 * @param compensation_distance distance in output samples over which the compensation should be performed
4717 * @param sample_delta number of output samples which should be output less
4719 * example: av_resample_compensate(c, 10, 500)
4720 * here instead of 510 samples only 500 samples would be output
4722 * note, due to rounding the actual compensation might be slightly different,
4723 * especially if the compensation_distance is large and the in_rate used during init is small
4725 attribute_deprecated
4726 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4727 attribute_deprecated
4728 void av_resample_close(struct AVResampleContext *c);
4736 * @addtogroup lavc_picture
4741 * Allocate memory for the pixels of a picture and setup the AVPicture
4744 * Call avpicture_free() to free it.
4746 * @param picture the picture structure to be filled in
4747 * @param pix_fmt the pixel format of the picture
4748 * @param width the width of the picture
4749 * @param height the height of the picture
4750 * @return zero if successful, a negative error code otherwise
4752 * @see av_image_alloc(), avpicture_fill()
4754 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4757 * Free a picture previously allocated by avpicture_alloc().
4758 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4761 * @param picture the AVPicture to be freed
4763 void avpicture_free(AVPicture *picture);
4766 * Setup the picture fields based on the specified image parameters
4767 * and the provided image data buffer.
4769 * The picture fields are filled in by using the image data buffer
4770 * pointed to by ptr.
4772 * If ptr is NULL, the function will fill only the picture linesize
4773 * array and return the required size for the image buffer.
4775 * To allocate an image buffer and fill the picture data in one call,
4776 * use avpicture_alloc().
4778 * @param picture the picture to be filled in
4779 * @param ptr buffer where the image data is stored, or NULL
4780 * @param pix_fmt the pixel format of the image
4781 * @param width the width of the image in pixels
4782 * @param height the height of the image in pixels
4783 * @return the size in bytes required for src, a negative error code
4784 * in case of failure
4786 * @see av_image_fill_arrays()
4788 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4789 enum AVPixelFormat pix_fmt, int width, int height);
4792 * Copy pixel data from an AVPicture into a buffer.
4794 * avpicture_get_size() can be used to compute the required size for
4795 * the buffer to fill.
4797 * @param src source picture with filled data
4798 * @param pix_fmt picture pixel format
4799 * @param width picture width
4800 * @param height picture height
4801 * @param dest destination buffer
4802 * @param dest_size destination buffer size in bytes
4803 * @return the number of bytes written to dest, or a negative value
4804 * (error code) on error, for example if the destination buffer is not
4807 * @see av_image_copy_to_buffer()
4809 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4810 int width, int height,
4811 unsigned char *dest, int dest_size);
4814 * Calculate the size in bytes that a picture of the given width and height
4815 * would occupy if stored in the given picture format.
4817 * @param pix_fmt picture pixel format
4818 * @param width picture width
4819 * @param height picture height
4820 * @return the computed picture buffer size or a negative error code
4823 * @see av_image_get_buffer_size().
4825 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4827 #if FF_API_DEINTERLACE
4829 * deinterlace - if not supported return -1
4831 * @deprecated - use yadif (in libavfilter) instead
4833 attribute_deprecated
4834 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4835 enum AVPixelFormat pix_fmt, int width, int height);
4838 * Copy image src to dst. Wraps av_image_copy().
4840 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4841 enum AVPixelFormat pix_fmt, int width, int height);
4844 * Crop image top and left side.
4846 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4847 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4852 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4853 int padtop, int padbottom, int padleft, int padright, int *color);
4860 * @defgroup lavc_misc Utility functions
4863 * Miscellaneous utility functions related to both encoding and decoding
4869 * @defgroup lavc_misc_pixfmt Pixel formats
4871 * Functions for working with pixel formats.
4876 * Utility function to access log2_chroma_w log2_chroma_h from
4877 * the pixel format AVPixFmtDescriptor.
4879 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4880 * for one that returns a failure code and continues in case of invalid
4883 * @param[in] pix_fmt the pixel format
4884 * @param[out] h_shift store log2_chroma_w
4885 * @param[out] v_shift store log2_chroma_h
4887 * @see av_pix_fmt_get_chroma_sub_sample
4890 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4893 * Return a value representing the fourCC code associated to the
4894 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4897 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4900 * @deprecated see av_get_pix_fmt_loss()
4902 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4906 * Find the best pixel format to convert to given a certain source pixel
4907 * format. When converting from one pixel format to another, information loss
4908 * may occur. For example, when converting from RGB24 to GRAY, the color
4909 * information will be lost. Similarly, other losses occur when converting from
4910 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4911 * the given pixel formats should be used to suffer the least amount of loss.
4912 * The pixel formats from which it chooses one, are determined by the
4913 * pix_fmt_list parameter.
4916 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4917 * @param[in] src_pix_fmt source pixel format
4918 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4919 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4920 * @return The best pixel format to convert to or -1 if none was found.
4922 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
4923 enum AVPixelFormat src_pix_fmt,
4924 int has_alpha, int *loss_ptr);
4927 * @deprecated see av_find_best_pix_fmt_of_2()
4929 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4930 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4932 attribute_deprecated
4933 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
4934 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
4935 enum AVPixelFormat src_pix_fmt,
4936 int has_alpha, int *loss_ptr);
4938 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4939 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4943 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4949 #if FF_API_SET_DIMENSIONS
4951 * @deprecated this function is not supposed to be used from outside of lavc
4953 attribute_deprecated
4954 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4958 * Put a string representing the codec tag codec_tag in buf.
4960 * @param buf buffer to place codec tag in
4961 * @param buf_size size in bytes of buf
4962 * @param codec_tag codec tag to assign
4963 * @return the length of the string that would have been generated if
4964 * enough space had been available, excluding the trailing null
4966 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4968 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4971 * Return a name for the specified profile, if available.
4973 * @param codec the codec that is searched for the given profile
4974 * @param profile the profile value for which a name is requested
4975 * @return A name for the profile if found, NULL otherwise.
4977 const char *av_get_profile_name(const AVCodec *codec, int profile);
4979 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4980 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4981 //FIXME func typedef
4984 * Fill AVFrame audio data and linesize pointers.
4986 * The buffer buf must be a preallocated buffer with a size big enough
4987 * to contain the specified samples amount. The filled AVFrame data
4988 * pointers will point to this buffer.
4990 * AVFrame extended_data channel pointers are allocated if necessary for
4993 * @param frame the AVFrame
4994 * frame->nb_samples must be set prior to calling the
4995 * function. This function fills in frame->data,
4996 * frame->extended_data, frame->linesize[0].
4997 * @param nb_channels channel count
4998 * @param sample_fmt sample format
4999 * @param buf buffer to use for frame data
5000 * @param buf_size size of buffer
5001 * @param align plane size sample alignment (0 = default)
5002 * @return >=0 on success, negative error code on failure
5003 * @todo return the size in bytes required to store the samples in
5004 * case of success, at the next libavutil bump
5006 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5007 enum AVSampleFormat sample_fmt, const uint8_t *buf,
5008 int buf_size, int align);
5011 * Reset the internal decoder state / flush internal buffers. Should be called
5012 * e.g. when seeking or when switching to a different stream.
5014 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5015 * this invalidates the frames previously returned from the decoder. When
5016 * refcounted frames are used, the decoder just releases any references it might
5017 * keep internally, but the caller's reference remains valid.
5019 void avcodec_flush_buffers(AVCodecContext *avctx);
5022 * Return codec bits per sample.
5024 * @param[in] codec_id the codec
5025 * @return Number of bits per sample or zero if unknown for the given codec.
5027 int av_get_bits_per_sample(enum AVCodecID codec_id);
5030 * Return the PCM codec associated with a sample format.
5031 * @param be endianness, 0 for little, 1 for big,
5032 * -1 (or anything else) for native
5033 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5035 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5038 * Return codec bits per sample.
5039 * Only return non-zero if the bits per sample is exactly correct, not an
5042 * @param[in] codec_id the codec
5043 * @return Number of bits per sample or zero if unknown for the given codec.
5045 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5048 * Return audio frame duration.
5050 * @param avctx codec context
5051 * @param frame_bytes size of the frame, or 0 if unknown
5052 * @return frame duration, in samples, if known. 0 if not able to
5055 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5058 typedef struct AVBitStreamFilterContext {
5060 struct AVBitStreamFilter *filter;
5061 AVCodecParserContext *parser;
5062 struct AVBitStreamFilterContext *next;
5063 } AVBitStreamFilterContext;
5066 typedef struct AVBitStreamFilter {
5069 int (*filter)(AVBitStreamFilterContext *bsfc,
5070 AVCodecContext *avctx, const char *args,
5071 uint8_t **poutbuf, int *poutbuf_size,
5072 const uint8_t *buf, int buf_size, int keyframe);
5073 void (*close)(AVBitStreamFilterContext *bsfc);
5074 struct AVBitStreamFilter *next;
5075 } AVBitStreamFilter;
5078 * Register a bitstream filter.
5080 * The filter will be accessible to the application code through
5081 * av_bitstream_filter_next() or can be directly initialized with
5082 * av_bitstream_filter_init().
5084 * @see avcodec_register_all()
5086 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5089 * Create and initialize a bitstream filter context given a bitstream
5092 * The returned context must be freed with av_bitstream_filter_close().
5094 * @param name the name of the bitstream filter
5095 * @return a bitstream filter context if a matching filter was found
5096 * and successfully initialized, NULL otherwise
5098 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5103 * This function filters the buffer buf with size buf_size, and places the
5104 * filtered buffer in the buffer pointed to by poutbuf.
5106 * The output buffer must be freed by the caller.
5108 * @param bsfc bitstream filter context created by av_bitstream_filter_init()
5109 * @param avctx AVCodecContext accessed by the filter, may be NULL.
5110 * If specified, this must point to the encoder context of the
5111 * output stream the packet is sent to.
5112 * @param args arguments which specify the filter configuration, may be NULL
5113 * @param poutbuf pointer which is updated to point to the filtered buffer
5114 * @param poutbuf_size pointer which is updated to the filtered buffer size in bytes
5115 * @param buf buffer containing the data to filter
5116 * @param buf_size size in bytes of buf
5117 * @param keyframe set to non-zero if the buffer to filter corresponds to a key-frame packet data
5118 * @return >= 0 in case of success, or a negative error code in case of failure
5120 * If the return value is positive, an output buffer is allocated and
5121 * is available in *poutbuf, and is distinct from the input buffer.
5123 * If the return value is 0, the output buffer is not allocated and
5124 * should be considered identical to the input buffer, or in case
5125 * *poutbuf was set it points to the input buffer (not necessarily to
5126 * its starting address).
5128 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5129 AVCodecContext *avctx, const char *args,
5130 uint8_t **poutbuf, int *poutbuf_size,
5131 const uint8_t *buf, int buf_size, int keyframe);
5134 * Release bitstream filter context.
5136 * @param bsf the bitstream filter context created with
5137 * av_bitstream_filter_init(), can be NULL
5139 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5142 * If f is NULL, return the first registered bitstream filter,
5143 * if f is non-NULL, return the next registered bitstream filter
5144 * after f, or NULL if f is the last one.
5146 * This function can be used to iterate over all registered bitstream
5149 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5154 * Same behaviour av_fast_malloc but the buffer has additional
5155 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5157 * In addition the whole buffer will initially and after resizes
5158 * be 0-initialized so that no uninitialized data will ever appear.
5160 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5163 * Same behaviour av_fast_padded_malloc except that buffer will always
5164 * be 0-initialized after call.
5166 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5169 * Encode extradata length to a buffer. Used by xiph codecs.
5171 * @param s buffer to write to; must be at least (v/255+1) bytes long
5172 * @param v size of extradata in bytes
5173 * @return number of bytes written to the buffer.
5175 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5177 #if FF_API_MISSING_SAMPLE
5179 * Log a generic warning message about a missing feature. This function is
5180 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5181 * only, and would normally not be used by applications.
5182 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5183 * a pointer to an AVClass struct
5184 * @param[in] feature string containing the name of the missing feature
5185 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5186 * If want_sample is non-zero, additional verbage will be added to the log
5187 * message which tells the user how to report samples to the development
5189 * @deprecated Use avpriv_report_missing_feature() instead.
5191 attribute_deprecated
5192 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5195 * Log a generic warning message asking for a sample. This function is
5196 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5197 * only, and would normally not be used by applications.
5198 * @param[in] avc a pointer to an arbitrary struct of which the first field is
5199 * a pointer to an AVClass struct
5200 * @param[in] msg string containing an optional message, or NULL if no message
5201 * @deprecated Use avpriv_request_sample() instead.
5203 attribute_deprecated
5204 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5205 #endif /* FF_API_MISSING_SAMPLE */
5208 * Register the hardware accelerator hwaccel.
5210 void av_register_hwaccel(AVHWAccel *hwaccel);
5213 * If hwaccel is NULL, returns the first registered hardware accelerator,
5214 * if hwaccel is non-NULL, returns the next registered hardware accelerator
5215 * after hwaccel, or NULL if hwaccel is the last one.
5217 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5221 * Lock operation used by lockmgr
5224 AV_LOCK_CREATE, ///< Create a mutex
5225 AV_LOCK_OBTAIN, ///< Lock the mutex
5226 AV_LOCK_RELEASE, ///< Unlock the mutex
5227 AV_LOCK_DESTROY, ///< Free mutex resources
5231 * Register a user provided lock manager supporting the operations
5232 * specified by AVLockOp. The "mutex" argument to the function points
5233 * to a (void *) where the lockmgr should store/get a pointer to a user
5234 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5235 * value left by the last call for all other ops. If the lock manager is
5236 * unable to perform the op then it should leave the mutex in the same
5237 * state as when it was called and return a non-zero value. However,
5238 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5239 * have been successfully destroyed. If av_lockmgr_register succeeds
5240 * it will return a non-negative value, if it fails it will return a
5241 * negative value and destroy all mutex and unregister all callbacks.
5242 * av_lockmgr_register is not thread-safe, it must be called from a
5243 * single thread before any calls which make use of locking are used.
5245 * @param cb User defined callback. av_lockmgr_register invokes calls
5246 * to this callback and the previously registered callback.
5247 * The callback will be used to create more than one mutex
5248 * each of which must be backed by its own underlying locking
5249 * mechanism (i.e. do not use a single static object to
5250 * implement your lock manager). If cb is set to NULL the
5251 * lockmgr will be unregistered.
5253 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5256 * Get the type of the given codec.
5258 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5261 * Get the name of a codec.
5262 * @return a static string identifying the codec; never NULL
5264 const char *avcodec_get_name(enum AVCodecID id);
5267 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5268 * with no corresponding avcodec_close()), 0 otherwise.
5270 int avcodec_is_open(AVCodecContext *s);
5273 * @return a non-zero number if codec is an encoder, zero otherwise
5275 int av_codec_is_encoder(const AVCodec *codec);
5278 * @return a non-zero number if codec is a decoder, zero otherwise
5280 int av_codec_is_decoder(const AVCodec *codec);
5283 * @return descriptor for given codec ID or NULL if no descriptor exists.
5285 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5288 * Iterate over all codec descriptors known to libavcodec.
5290 * @param prev previous descriptor. NULL to get the first descriptor.
5292 * @return next descriptor or NULL after the last descriptor
5294 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5297 * @return codec descriptor with the given name or NULL if no such descriptor
5300 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5306 #endif /* AVCODEC_AVCODEC_H */