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/avutil.h"
33 #include "libavutil/buffer.h"
34 #include "libavutil/cpu.h"
35 #include "libavutil/channel_layout.h"
36 #include "libavutil/dict.h"
37 #include "libavutil/frame.h"
38 #include "libavutil/log.h"
39 #include "libavutil/pixfmt.h"
40 #include "libavutil/rational.h"
42 #include "libavcodec/version.h"
44 * @defgroup libavc Encoding/Decoding Library
47 * @defgroup lavc_decoding Decoding
51 * @defgroup lavc_encoding Encoding
55 * @defgroup lavc_codec Codecs
57 * @defgroup lavc_codec_native Native Codecs
60 * @defgroup lavc_codec_wrappers External library wrappers
63 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
67 * @defgroup lavc_internal Internal
75 * @defgroup lavc_core Core functions/structures.
78 * Basic definitions, functions for querying libavcodec capabilities,
79 * allocating core structures, etc.
85 * Identify the syntax and semantics of the bitstream.
86 * The principle is roughly:
87 * Two decoders with the same ID can decode the same streams.
88 * Two encoders with the same ID can encode compatible streams.
89 * There may be slight deviations from the principle due to implementation
92 * If you add a codec ID to this list, add it so that
93 * 1. no value of a existing codec ID changes (that would break ABI),
94 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
95 * This ensures that 2 forks can independently add AVCodecIDs without producing conflicts.
97 * After adding new codec IDs, do not forget to add an entry to the codec
98 * descriptor list and bump libavcodec minor version.
104 AV_CODEC_ID_MPEG1VIDEO,
105 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
106 AV_CODEC_ID_MPEG2VIDEO_XVMC,
117 AV_CODEC_ID_RAWVIDEO,
118 AV_CODEC_ID_MSMPEG4V1,
119 AV_CODEC_ID_MSMPEG4V2,
120 AV_CODEC_ID_MSMPEG4V3,
143 AV_CODEC_ID_INTERPLAY_VIDEO,
150 AV_CODEC_ID_MSVIDEO1,
155 AV_CODEC_ID_TRUEMOTION1,
156 AV_CODEC_ID_VMDVIDEO,
181 AV_CODEC_ID_TRUEMOTION2,
187 AV_CODEC_ID_SMACKVIDEO,
192 AV_CODEC_ID_JPEG2000,
198 AV_CODEC_ID_DSICINVIDEO,
199 AV_CODEC_ID_TIERTEXSEQVIDEO,
207 AV_CODEC_ID_BETHSOFTVID,
219 AV_CODEC_ID_ESCAPE124,
223 AV_CODEC_ID_MOTIONPIXELS,
235 AV_CODEC_ID_FLASHSV2,
236 AV_CODEC_ID_CDGRAPHICS,
239 AV_CODEC_ID_BINKVIDEO,
240 AV_CODEC_ID_IFF_ILBM,
241 AV_CODEC_ID_IFF_BYTERUN1,
247 AV_CODEC_ID_A64_MULTI,
248 AV_CODEC_ID_A64_MULTI5,
251 AV_CODEC_ID_LAGARITH,
255 AV_CODEC_ID_WMV3IMAGE,
256 AV_CODEC_ID_VC1IMAGE,
258 AV_CODEC_ID_BMV_VIDEO,
265 AV_CODEC_ID_ZEROCODEC,
274 AV_CODEC_ID_ESCAPE130_DEPRECATED,
275 AV_CODEC_ID_G2M_DEPRECATED,
277 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
278 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
279 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
280 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
281 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
283 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
284 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
285 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
286 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
287 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
288 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
289 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
290 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
291 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
292 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
293 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
294 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
295 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
296 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
297 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
298 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
299 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
300 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
301 AV_CODEC_ID_SMVJPEG = MKBETAG('S','M','V','J'),
303 /* various PCM "codecs" */
304 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
305 AV_CODEC_ID_PCM_S16LE = 0x10000,
306 AV_CODEC_ID_PCM_S16BE,
307 AV_CODEC_ID_PCM_U16LE,
308 AV_CODEC_ID_PCM_U16BE,
311 AV_CODEC_ID_PCM_MULAW,
312 AV_CODEC_ID_PCM_ALAW,
313 AV_CODEC_ID_PCM_S32LE,
314 AV_CODEC_ID_PCM_S32BE,
315 AV_CODEC_ID_PCM_U32LE,
316 AV_CODEC_ID_PCM_U32BE,
317 AV_CODEC_ID_PCM_S24LE,
318 AV_CODEC_ID_PCM_S24BE,
319 AV_CODEC_ID_PCM_U24LE,
320 AV_CODEC_ID_PCM_U24BE,
321 AV_CODEC_ID_PCM_S24DAUD,
322 AV_CODEC_ID_PCM_ZORK,
323 AV_CODEC_ID_PCM_S16LE_PLANAR,
325 AV_CODEC_ID_PCM_F32BE,
326 AV_CODEC_ID_PCM_F32LE,
327 AV_CODEC_ID_PCM_F64BE,
328 AV_CODEC_ID_PCM_F64LE,
329 AV_CODEC_ID_PCM_BLURAY,
332 AV_CODEC_ID_PCM_S8_PLANAR,
333 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
334 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
335 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
337 /* various ADPCM codecs */
338 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
339 AV_CODEC_ID_ADPCM_IMA_WAV,
340 AV_CODEC_ID_ADPCM_IMA_DK3,
341 AV_CODEC_ID_ADPCM_IMA_DK4,
342 AV_CODEC_ID_ADPCM_IMA_WS,
343 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
344 AV_CODEC_ID_ADPCM_MS,
345 AV_CODEC_ID_ADPCM_4XM,
346 AV_CODEC_ID_ADPCM_XA,
347 AV_CODEC_ID_ADPCM_ADX,
348 AV_CODEC_ID_ADPCM_EA,
349 AV_CODEC_ID_ADPCM_G726,
350 AV_CODEC_ID_ADPCM_CT,
351 AV_CODEC_ID_ADPCM_SWF,
352 AV_CODEC_ID_ADPCM_YAMAHA,
353 AV_CODEC_ID_ADPCM_SBPRO_4,
354 AV_CODEC_ID_ADPCM_SBPRO_3,
355 AV_CODEC_ID_ADPCM_SBPRO_2,
356 AV_CODEC_ID_ADPCM_THP,
357 AV_CODEC_ID_ADPCM_IMA_AMV,
358 AV_CODEC_ID_ADPCM_EA_R1,
359 AV_CODEC_ID_ADPCM_EA_R3,
360 AV_CODEC_ID_ADPCM_EA_R2,
361 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
362 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
363 AV_CODEC_ID_ADPCM_EA_XAS,
364 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
365 AV_CODEC_ID_ADPCM_IMA_ISS,
366 AV_CODEC_ID_ADPCM_G722,
367 AV_CODEC_ID_ADPCM_IMA_APC,
368 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
369 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
370 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
371 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
372 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
375 AV_CODEC_ID_AMR_NB = 0x12000,
378 /* RealAudio codecs*/
379 AV_CODEC_ID_RA_144 = 0x13000,
382 /* various DPCM codecs */
383 AV_CODEC_ID_ROQ_DPCM = 0x14000,
384 AV_CODEC_ID_INTERPLAY_DPCM,
385 AV_CODEC_ID_XAN_DPCM,
386 AV_CODEC_ID_SOL_DPCM,
389 AV_CODEC_ID_MP2 = 0x15000,
390 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
400 AV_CODEC_ID_VMDAUDIO,
406 AV_CODEC_ID_WESTWOOD_SND1,
407 AV_CODEC_ID_GSM, ///< as in Berlin toast format
410 AV_CODEC_ID_TRUESPEECH,
412 AV_CODEC_ID_SMACKAUDIO,
415 AV_CODEC_ID_DSICINAUDIO,
417 AV_CODEC_ID_MUSEPACK7,
419 AV_CODEC_ID_GSM_MS, /* as found in WAV */
423 AV_CODEC_ID_NELLYMOSER,
424 AV_CODEC_ID_MUSEPACK8,
426 AV_CODEC_ID_WMAVOICE,
428 AV_CODEC_ID_WMALOSSLESS,
437 AV_CODEC_ID_BINKAUDIO_RDFT,
438 AV_CODEC_ID_BINKAUDIO_DCT,
439 AV_CODEC_ID_AAC_LATM,
444 AV_CODEC_ID_8SVX_EXP,
445 AV_CODEC_ID_8SVX_FIB,
446 AV_CODEC_ID_BMV_AUDIO,
450 AV_CODEC_ID_OPUS_DEPRECATED,
451 AV_CODEC_ID_COMFORT_NOISE,
452 AV_CODEC_ID_TAK_DEPRECATED,
453 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
454 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
455 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
456 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
457 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
458 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
459 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
460 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
462 /* subtitle codecs */
463 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
464 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
465 AV_CODEC_ID_DVB_SUBTITLE,
466 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
469 AV_CODEC_ID_MOV_TEXT,
470 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
471 AV_CODEC_ID_DVB_TELETEXT,
473 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
474 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
475 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
476 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
477 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
478 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
479 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
480 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
481 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
482 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
483 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
484 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
485 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
487 /* other specific kind of codecs (generally used for attachments) */
488 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
489 AV_CODEC_ID_TTF = 0x18000,
490 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
491 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
492 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
493 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
494 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
495 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
498 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
500 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
501 * stream (only used by libavformat) */
502 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
503 * stream (only used by libavformat) */
504 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
507 #include "old_codec_ids.h"
512 * This struct describes the properties of a single codec described by an
514 * @see avcodec_get_descriptor()
516 typedef struct AVCodecDescriptor {
518 enum AVMediaType type;
520 * Name of the codec described by this descriptor. It is non-empty and
521 * unique for each codec descriptor. It should contain alphanumeric
522 * characters and '_' only.
526 * A more descriptive name for this codec. May be NULL.
528 const char *long_name;
530 * Codec properties, a combination of AV_CODEC_PROP_* flags.
536 * Codec uses only intra compression.
539 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
541 * Codec supports lossy compression. Audio and video codecs only.
542 * @note a codec may support both lossy and lossless
545 #define AV_CODEC_PROP_LOSSY (1 << 1)
547 * Codec supports lossless compression. Audio and video codecs only.
549 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
551 * Subtitle codec is bitmap based
552 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
554 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
556 * Subtitle codec is text based.
557 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
559 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
562 * @ingroup lavc_decoding
563 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
564 * This is mainly needed because some optimized bitstream readers read
565 * 32 or 64 bit at once and could read over the end.<br>
566 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
567 * MPEG bitstreams could cause overread and segfault.
569 #define FF_INPUT_BUFFER_PADDING_SIZE 16
572 * @ingroup lavc_encoding
573 * minimum encoding buffer size
574 * Used to avoid some checks during header writing.
576 #define FF_MIN_BUFFER_SIZE 16384
580 * @ingroup lavc_encoding
581 * motion estimation type.
584 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
588 ME_EPZS, ///< enhanced predictive zonal search
589 ME_X1, ///< reserved for experiments
590 ME_HEX, ///< hexagon based search
591 ME_UMH, ///< uneven multi-hexagon search
592 ME_TESA, ///< transformed exhaustive search algorithm
593 ME_ITER=50, ///< iterative search
597 * @ingroup lavc_decoding
600 /* We leave some space between them for extensions (drop some
601 * keyframes for intra-only or drop just some bidir frames). */
602 AVDISCARD_NONE =-16, ///< discard nothing
603 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
604 AVDISCARD_NONREF = 8, ///< discard all non reference
605 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
606 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
607 AVDISCARD_ALL = 48, ///< discard all
610 enum AVColorPrimaries{
611 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
612 AVCOL_PRI_UNSPECIFIED = 2,
613 AVCOL_PRI_BT470M = 4,
614 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
615 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
616 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
618 AVCOL_PRI_NB , ///< Not part of ABI
621 enum AVColorTransferCharacteristic{
622 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
623 AVCOL_TRC_UNSPECIFIED = 2,
624 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
625 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
626 AVCOL_TRC_SMPTE240M = 7,
627 AVCOL_TRC_NB , ///< Not part of ABI
632 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
633 AVCOL_SPC_UNSPECIFIED = 2,
635 AVCOL_SPC_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
636 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
637 AVCOL_SPC_SMPTE240M = 7,
638 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
639 AVCOL_SPC_NB , ///< Not part of ABI
641 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
644 AVCOL_RANGE_UNSPECIFIED = 0,
645 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
646 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
647 AVCOL_RANGE_NB , ///< Not part of ABI
651 * X X 3 4 X X are luma samples,
652 * 1 2 1-6 are possible chroma positions
653 * X X 5 6 X 0 is undefined/unknown position
655 enum AVChromaLocation{
656 AVCHROMA_LOC_UNSPECIFIED = 0,
657 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
658 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
659 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
660 AVCHROMA_LOC_TOP = 4,
661 AVCHROMA_LOC_BOTTOMLEFT = 5,
662 AVCHROMA_LOC_BOTTOM = 6,
663 AVCHROMA_LOC_NB , ///< Not part of ABI
666 enum AVAudioServiceType {
667 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
668 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
669 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
670 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
671 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
672 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
673 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
674 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
675 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
676 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
680 * @ingroup lavc_encoding
682 typedef struct RcOverride{
685 int qscale; // If this is 0 then quality_factor will be used instead.
686 float quality_factor;
689 #define FF_MAX_B_FRAMES 16
692 These flags can be passed in AVCodecContext.flags before initialization.
693 Note: Not everything is supported yet.
697 * Allow decoders to produce frames with data planes that are not aligned
698 * to CPU requirements (e.g. due to cropping).
700 #define CODEC_FLAG_UNALIGNED 0x0001
701 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
702 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
703 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
704 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
705 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
707 * The parent program guarantees that the input for B-frames containing
708 * streams is not written to for at least s->max_b_frames+1 frames, if
709 * this is not set the input will be copied.
711 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
712 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
713 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
714 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
715 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
716 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
717 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
718 location instead of only at frame boundaries. */
719 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
720 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
721 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
722 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
723 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
724 /* Fx : Flag for h263+ extra options */
725 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
726 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
727 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
728 #define CODEC_FLAG_CLOSED_GOP 0x80000000
729 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
730 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
731 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
732 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
733 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
735 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
736 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
738 /* Unsupported options :
739 * Syntax Arithmetic coding (SAC)
740 * Reference Picture Selection
741 * Independent Segment Decoding */
743 /* codec capabilities */
745 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
747 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
748 * If not set, it might not use get_buffer() at all or use operations that
749 * assume the buffer was allocated by avcodec_default_get_buffer.
751 #define CODEC_CAP_DR1 0x0002
752 #define CODEC_CAP_TRUNCATED 0x0008
753 /* Codec can export data for HW decoding (XvMC). */
754 #define CODEC_CAP_HWACCEL 0x0010
756 * Encoder or decoder requires flushing with NULL input at the end in order to
757 * give the complete and correct output.
759 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
760 * with NULL data. The user can still send NULL data to the public encode
761 * or decode function, but libavcodec will not pass it along to the codec
762 * unless this flag is set.
765 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
766 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
770 * The encoder needs to be fed with NULL data at the end of encoding until the
771 * encoder no longer returns data.
773 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
774 * flag also means that the encoder must set the pts and duration for
775 * each output packet. If this flag is not set, the pts and duration will
776 * be determined by libavcodec from the input frame.
778 #define CODEC_CAP_DELAY 0x0020
780 * Codec can be fed a final frame with a smaller size.
781 * This can be used to prevent truncation of the last audio samples.
783 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
785 * Codec can export data for HW decoding (VDPAU).
787 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
789 * Codec can output multiple frames per AVPacket
790 * Normally demuxers return one frame at a time, demuxers which do not do
791 * are connected to a parser to split what they return into proper frames.
792 * This flag is reserved to the very rare category of codecs which have a
793 * bitstream that cannot be split into frames without timeconsuming
794 * operations like full decoding. Demuxers carring such bitstreams thus
795 * may return multiple frames in a packet. This has many disadvantages like
796 * prohibiting stream copy in many cases thus it should only be considered
799 #define CODEC_CAP_SUBFRAMES 0x0100
801 * Codec is experimental and is thus avoided in favor of non experimental
804 #define CODEC_CAP_EXPERIMENTAL 0x0200
806 * Codec should fill in channel configuration and samplerate instead of container
808 #define CODEC_CAP_CHANNEL_CONF 0x0400
811 * Codec is able to deal with negative linesizes
813 #define CODEC_CAP_NEG_LINESIZES 0x0800
816 * Codec supports frame-level multithreading.
818 #define CODEC_CAP_FRAME_THREADS 0x1000
820 * Codec supports slice-based (or partition-based) multithreading.
822 #define CODEC_CAP_SLICE_THREADS 0x2000
824 * Codec supports changed parameters at any point.
826 #define CODEC_CAP_PARAM_CHANGE 0x4000
828 * Codec supports avctx->thread_count == 0 (auto).
830 #define CODEC_CAP_AUTO_THREADS 0x8000
832 * Audio encoder supports receiving a different number of samples in each call.
834 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
836 * Codec is intra only.
838 #define CODEC_CAP_INTRA_ONLY 0x40000000
842 #define CODEC_CAP_LOSSLESS 0x80000000
844 //The following defines may change, don't expect compatibility if you use them.
845 #define MB_TYPE_INTRA4x4 0x0001
846 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
847 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
848 #define MB_TYPE_16x16 0x0008
849 #define MB_TYPE_16x8 0x0010
850 #define MB_TYPE_8x16 0x0020
851 #define MB_TYPE_8x8 0x0040
852 #define MB_TYPE_INTERLACED 0x0080
853 #define MB_TYPE_DIRECT2 0x0100 //FIXME
854 #define MB_TYPE_ACPRED 0x0200
855 #define MB_TYPE_GMC 0x0400
856 #define MB_TYPE_SKIP 0x0800
857 #define MB_TYPE_P0L0 0x1000
858 #define MB_TYPE_P1L0 0x2000
859 #define MB_TYPE_P0L1 0x4000
860 #define MB_TYPE_P1L1 0x8000
861 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
862 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
863 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
864 #define MB_TYPE_QUANT 0x00010000
865 #define MB_TYPE_CBP 0x00020000
866 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
870 * This specifies the area which should be displayed.
871 * Note there may be multiple such areas for one frame.
873 typedef struct AVPanScan{
876 * - encoding: Set by user.
877 * - decoding: Set by libavcodec.
882 * width and height in 1/16 pel
883 * - encoding: Set by user.
884 * - decoding: Set by libavcodec.
890 * position of the top left corner in 1/16 pel for up to 3 fields/frames
891 * - encoding: Set by user.
892 * - decoding: Set by libavcodec.
894 int16_t position[3][2];
897 #define FF_QSCALE_TYPE_MPEG1 0
898 #define FF_QSCALE_TYPE_MPEG2 1
899 #define FF_QSCALE_TYPE_H264 2
900 #define FF_QSCALE_TYPE_VP56 3
902 #if FF_API_GET_BUFFER
903 #define FF_BUFFER_TYPE_INTERNAL 1
904 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
905 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
906 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
908 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
909 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
910 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
911 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
915 * The decoder will keep a reference to the frame and may reuse it later.
917 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
920 * @defgroup lavc_packet AVPacket
922 * Types and functions for working with AVPacket.
925 enum AVPacketSideDataType {
927 AV_PKT_DATA_NEW_EXTRADATA,
930 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
933 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
934 * s32le channel_count
935 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
936 * u64le channel_layout
937 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
939 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
944 AV_PKT_DATA_PARAM_CHANGE,
947 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
948 * structures with info about macroblocks relevant to splitting the
949 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
950 * That is, it does not necessarily contain info about all macroblocks,
951 * as long as the distance between macroblocks in the info is smaller
952 * than the target payload size.
953 * Each MB info structure is 12 bytes, and is laid out as follows:
955 * u32le bit offset from the start of the packet
956 * u8 current quantizer at the start of the macroblock
958 * u16le macroblock address within the GOB
959 * u8 horizontal MV predictor
960 * u8 vertical MV predictor
961 * u8 horizontal MV predictor for block number 3
962 * u8 vertical MV predictor for block number 3
965 AV_PKT_DATA_H263_MB_INFO,
968 * Recommmends skipping the specified number of samples
970 * u32le number of samples to skip from start of this packet
971 * u32le number of samples to skip from end of this packet
972 * u8 reason for start skip
973 * u8 reason for end skip (0=padding silence, 1=convergence)
976 AV_PKT_DATA_SKIP_SAMPLES=70,
979 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
980 * the packet may contain "dual mono" audio specific to Japanese DTV
981 * and if it is true, recommends only the selected channel to be used.
983 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
986 AV_PKT_DATA_JP_DUALMONO,
989 * A list of zero terminated key/value strings. There is no end marker for
990 * the list, so it is required to rely on the side data size to stop.
992 AV_PKT_DATA_STRINGS_METADATA,
995 * Subtitle event position
1003 AV_PKT_DATA_SUBTITLE_POSITION,
1006 * Data found in BlockAdditional element of matroska container. There is
1007 * no end marker for the data, so it is required to rely on the side data
1008 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1011 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1014 * The optional first identifier line of a WebVTT cue.
1016 AV_PKT_DATA_WEBVTT_IDENTIFIER,
1019 * The optional settings (rendering instructions) that immediately
1020 * follow the timestamp specifier of a WebVTT cue.
1022 AV_PKT_DATA_WEBVTT_SETTINGS,
1026 * This structure stores compressed data. It is typically exported by demuxers
1027 * and then passed as input to decoders, or received as output from encoders and
1028 * then passed to muxers.
1030 * For video, it should typically contain one compressed frame. For audio it may
1031 * contain several compressed frames.
1033 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1034 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1035 * without libavcodec and libavformat major bump.
1037 * The semantics of data ownership depends on the buf or destruct (deprecated)
1038 * fields. If either is set, the packet data is dynamically allocated and is
1039 * valid indefinitely until av_free_packet() is called (which in turn calls
1040 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1041 * the packet data is typically backed by some static buffer somewhere and is
1042 * only valid for a limited time (e.g. until the next read call when demuxing).
1044 * The side data is always allocated with av_malloc() and is freed in
1047 typedef struct AVPacket {
1049 * A reference to the reference-counted buffer where the packet data is
1051 * May be NULL, then the packet data is not reference-counted.
1055 * Presentation timestamp in AVStream->time_base units; the time at which
1056 * the decompressed packet will be presented to the user.
1057 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1058 * pts MUST be larger or equal to dts as presentation cannot happen before
1059 * decompression, unless one wants to view hex dumps. Some formats misuse
1060 * the terms dts and pts/cts to mean something different. Such timestamps
1061 * must be converted to true pts/dts before they are stored in AVPacket.
1065 * Decompression timestamp in AVStream->time_base units; the time at which
1066 * the packet is decompressed.
1067 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1074 * A combination of AV_PKT_FLAG values
1078 * Additional packet data that can be provided by the container.
1079 * Packet can contain several types of side information.
1084 enum AVPacketSideDataType type;
1086 int side_data_elems;
1089 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1090 * Equals next_pts - this_pts in presentation order.
1093 #if FF_API_DESTRUCT_PACKET
1094 attribute_deprecated
1095 void (*destruct)(struct AVPacket *);
1096 attribute_deprecated
1099 int64_t pos; ///< byte position in stream, -1 if unknown
1102 * Time difference in AVStream->time_base units from the pts of this
1103 * packet to the point at which the output from the decoder has converged
1104 * independent from the availability of previous frames. That is, the
1105 * frames are virtually identical no matter if decoding started from
1106 * the very first frame or from this keyframe.
1107 * Is AV_NOPTS_VALUE if unknown.
1108 * This field is not the display duration of the current packet.
1109 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1112 * The purpose of this field is to allow seeking in streams that have no
1113 * keyframes in the conventional sense. It corresponds to the
1114 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1115 * essential for some types of subtitle streams to ensure that all
1116 * subtitles are correctly displayed after seeking.
1118 int64_t convergence_duration;
1120 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1121 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1123 enum AVSideDataParamChangeFlags {
1124 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1125 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1126 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1127 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1133 struct AVCodecInternal;
1137 AV_FIELD_PROGRESSIVE,
1138 AV_FIELD_TT, //< Top coded_first, top displayed first
1139 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1140 AV_FIELD_TB, //< Top coded first, bottom displayed first
1141 AV_FIELD_BT, //< Bottom coded first, top displayed first
1145 * main external API structure.
1146 * New fields can be added to the end with minor version bumps.
1147 * Removal, reordering and changes to existing fields require a major
1149 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1151 * sizeof(AVCodecContext) must not be used outside libav*.
1153 typedef struct AVCodecContext {
1155 * information on struct for av_log
1156 * - set by avcodec_alloc_context3
1158 const AVClass *av_class;
1159 int log_level_offset;
1161 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1162 const struct AVCodec *codec;
1163 char codec_name[32];
1164 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1167 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1168 * This is used to work around some encoder bugs.
1169 * A demuxer should set this to what is stored in the field used to identify the codec.
1170 * If there are multiple such fields in a container then the demuxer should choose the one
1171 * which maximizes the information about the used codec.
1172 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1173 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1174 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1176 * - encoding: Set by user, if not then the default based on codec_id will be used.
1177 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1179 unsigned int codec_tag;
1182 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1183 * This is used to work around some encoder bugs.
1184 * - encoding: unused
1185 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1187 unsigned int stream_codec_tag;
1192 * Private context used for internal data.
1194 * Unlike priv_data, this is not codec-specific. It is used in general
1195 * libavcodec functions.
1197 struct AVCodecInternal *internal;
1200 * Private data of the user, can be used to carry app specific stuff.
1201 * - encoding: Set by user.
1202 * - decoding: Set by user.
1207 * the average bitrate
1208 * - encoding: Set by user; unused for constant quantizer encoding.
1209 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1214 * number of bits the bitstream is allowed to diverge from the reference.
1215 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1216 * - encoding: Set by user; unused for constant quantizer encoding.
1217 * - decoding: unused
1219 int bit_rate_tolerance;
1222 * Global quality for codecs which cannot change it per frame.
1223 * This should be proportional to MPEG-1/2/4 qscale.
1224 * - encoding: Set by user.
1225 * - decoding: unused
1230 * - encoding: Set by user.
1231 * - decoding: unused
1233 int compression_level;
1234 #define FF_COMPRESSION_DEFAULT -1
1238 * - encoding: Set by user.
1239 * - decoding: Set by user.
1245 * - encoding: Set by user.
1246 * - decoding: Set by user.
1251 * some codecs need / can use extradata like Huffman tables.
1252 * mjpeg: Huffman tables
1253 * rv10: additional flags
1254 * mpeg4: global headers (they can be in the bitstream or here)
1255 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1256 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1257 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1258 * - encoding: Set/allocated/freed by libavcodec.
1259 * - decoding: Set/allocated/freed by user.
1265 * This is the fundamental unit of time (in seconds) in terms
1266 * of which frame timestamps are represented. For fixed-fps content,
1267 * timebase should be 1/framerate and timestamp increments should be
1269 * - encoding: MUST be set by user.
1270 * - decoding: Set by libavcodec.
1272 AVRational time_base;
1275 * For some codecs, the time base is closer to the field rate than the frame rate.
1276 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1277 * if no telecine is used ...
1279 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1281 int ticks_per_frame;
1286 * Encoding: Number of frames delay there will be from the encoder input to
1287 * the decoder output. (we assume the decoder matches the spec)
1288 * Decoding: Number of frames delay in addition to what a standard decoder
1289 * as specified in the spec would produce.
1292 * Number of frames the decoded output will be delayed relative to the
1296 * For encoding, this is the number of "priming" samples added to the
1297 * beginning of the stream. The decoded output will be delayed by this
1298 * many samples relative to the input to the encoder. Note that this
1299 * field is purely informational and does not directly affect the pts
1300 * output by the encoder, which should always be based on the actual
1301 * presentation time, including any delay.
1302 * For decoding, this is the number of samples the decoder needs to
1303 * output before the decoder's output is valid. When seeking, you should
1304 * start decoding this many samples prior to your desired seek point.
1306 * - encoding: Set by libavcodec.
1307 * - decoding: Set by libavcodec.
1314 * picture width / height.
1315 * - encoding: MUST be set by user.
1316 * - decoding: May be set by the user before opening the decoder if known e.g.
1317 * from the container. Some decoders will require the dimensions
1318 * to be set by the caller. During decoding, the decoder may
1319 * overwrite those values as required.
1324 * Bitstream width / height, may be different from width/height e.g. when
1325 * the decoded frame is cropped before being output or lowres is enabled.
1326 * - encoding: unused
1327 * - decoding: May be set by the user before opening the decoder if known
1328 * e.g. from the container. During decoding, the decoder may
1329 * overwrite those values as required.
1331 int coded_width, coded_height;
1333 #define FF_ASPECT_EXTENDED 15
1336 * the number of pictures in a group of pictures, or 0 for intra_only
1337 * - encoding: Set by user.
1338 * - decoding: unused
1343 * Pixel format, see AV_PIX_FMT_xxx.
1344 * May be set by the demuxer if known from headers.
1345 * May be overridden by the decoder if it knows better.
1346 * - encoding: Set by user.
1347 * - decoding: Set by user if known, overridden by libavcodec if known
1349 enum AVPixelFormat pix_fmt;
1352 * Motion estimation algorithm used for video coding.
1353 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1354 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1355 * - encoding: MUST be set by user.
1356 * - decoding: unused
1361 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1362 * decoder to draw a horizontal band. It improves cache usage. Not
1363 * all codecs can do that. You must check the codec capabilities
1365 * When multithreading is used, it may be called from multiple threads
1366 * at the same time; threads might draw different parts of the same AVFrame,
1367 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1369 * The function is also used by hardware acceleration APIs.
1370 * It is called at least once during frame decoding to pass
1371 * the data needed for hardware render.
1372 * In that mode instead of pixel data, AVFrame points to
1373 * a structure specific to the acceleration API. The application
1374 * reads the structure and can change some fields to indicate progress
1376 * - encoding: unused
1377 * - decoding: Set by user.
1378 * @param height the height of the slice
1379 * @param y the y position of the slice
1380 * @param type 1->top field, 2->bottom field, 3->frame
1381 * @param offset offset into the AVFrame.data from which the slice should be read
1383 void (*draw_horiz_band)(struct AVCodecContext *s,
1384 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1385 int y, int type, int height);
1388 * callback to negotiate the pixelFormat
1389 * @param fmt is the list of formats which are supported by the codec,
1390 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1391 * The first is always the native one.
1392 * @return the chosen format
1393 * - encoding: unused
1394 * - decoding: Set by user, if not set the native format will be chosen.
1396 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1399 * maximum number of B-frames between non-B-frames
1400 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1401 * - encoding: Set by user.
1402 * - decoding: unused
1407 * qscale factor between IP and B-frames
1408 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1409 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1410 * - encoding: Set by user.
1411 * - decoding: unused
1413 float b_quant_factor;
1415 /** obsolete FIXME remove */
1417 #define FF_RC_STRATEGY_XVID 1
1419 int b_frame_strategy;
1422 * qscale offset between IP and B-frames
1423 * - encoding: Set by user.
1424 * - decoding: unused
1426 float b_quant_offset;
1429 * Size of the frame reordering buffer in the decoder.
1430 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1431 * - encoding: Set by libavcodec.
1432 * - decoding: Set by libavcodec.
1437 * 0-> h263 quant 1-> mpeg quant
1438 * - encoding: Set by user.
1439 * - decoding: unused
1444 * qscale factor between P and I-frames
1445 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1446 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1447 * - encoding: Set by user.
1448 * - decoding: unused
1450 float i_quant_factor;
1453 * qscale offset between P and I-frames
1454 * - encoding: Set by user.
1455 * - decoding: unused
1457 float i_quant_offset;
1460 * luminance masking (0-> disabled)
1461 * - encoding: Set by user.
1462 * - decoding: unused
1467 * temporary complexity masking (0-> disabled)
1468 * - encoding: Set by user.
1469 * - decoding: unused
1471 float temporal_cplx_masking;
1474 * spatial complexity masking (0-> disabled)
1475 * - encoding: Set by user.
1476 * - decoding: unused
1478 float spatial_cplx_masking;
1481 * p block masking (0-> disabled)
1482 * - encoding: Set by user.
1483 * - decoding: unused
1488 * darkness masking (0-> disabled)
1489 * - encoding: Set by user.
1490 * - decoding: unused
1496 * - encoding: Set by libavcodec.
1497 * - decoding: Set by user (or 0).
1501 * prediction method (needed for huffyuv)
1502 * - encoding: Set by user.
1503 * - decoding: unused
1505 int prediction_method;
1506 #define FF_PRED_LEFT 0
1507 #define FF_PRED_PLANE 1
1508 #define FF_PRED_MEDIAN 2
1511 * slice offsets in the frame in bytes
1512 * - encoding: Set/allocated by libavcodec.
1513 * - decoding: Set/allocated by user (or NULL).
1518 * sample aspect ratio (0 if unknown)
1519 * That is the width of a pixel divided by the height of the pixel.
1520 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1521 * - encoding: Set by user.
1522 * - decoding: Set by libavcodec.
1524 AVRational sample_aspect_ratio;
1527 * motion estimation comparison function
1528 * - encoding: Set by user.
1529 * - decoding: unused
1533 * subpixel motion estimation comparison function
1534 * - encoding: Set by user.
1535 * - decoding: unused
1539 * macroblock comparison function (not supported yet)
1540 * - encoding: Set by user.
1541 * - decoding: unused
1545 * interlaced DCT comparison function
1546 * - encoding: Set by user.
1547 * - decoding: unused
1550 #define FF_CMP_SAD 0
1551 #define FF_CMP_SSE 1
1552 #define FF_CMP_SATD 2
1553 #define FF_CMP_DCT 3
1554 #define FF_CMP_PSNR 4
1555 #define FF_CMP_BIT 5
1557 #define FF_CMP_ZERO 7
1558 #define FF_CMP_VSAD 8
1559 #define FF_CMP_VSSE 9
1560 #define FF_CMP_NSSE 10
1561 #define FF_CMP_W53 11
1562 #define FF_CMP_W97 12
1563 #define FF_CMP_DCTMAX 13
1564 #define FF_CMP_DCT264 14
1565 #define FF_CMP_CHROMA 256
1568 * ME diamond size & shape
1569 * - encoding: Set by user.
1570 * - decoding: unused
1575 * amount of previous MV predictors (2a+1 x 2a+1 square)
1576 * - encoding: Set by user.
1577 * - decoding: unused
1579 int last_predictor_count;
1582 * prepass for motion estimation
1583 * - encoding: Set by user.
1584 * - decoding: unused
1589 * motion estimation prepass comparison function
1590 * - encoding: Set by user.
1591 * - decoding: unused
1596 * ME prepass diamond size & shape
1597 * - encoding: Set by user.
1598 * - decoding: unused
1604 * - encoding: Set by user.
1605 * - decoding: unused
1607 int me_subpel_quality;
1610 * DTG active format information (additional aspect ratio
1611 * information only used in DVB MPEG-2 transport streams)
1614 * - encoding: unused
1615 * - decoding: Set by decoder.
1617 int dtg_active_format;
1618 #define FF_DTG_AFD_SAME 8
1619 #define FF_DTG_AFD_4_3 9
1620 #define FF_DTG_AFD_16_9 10
1621 #define FF_DTG_AFD_14_9 11
1622 #define FF_DTG_AFD_4_3_SP_14_9 13
1623 #define FF_DTG_AFD_16_9_SP_14_9 14
1624 #define FF_DTG_AFD_SP_4_3 15
1627 * maximum motion estimation search range in subpel units
1628 * If 0 then no limit.
1630 * - encoding: Set by user.
1631 * - decoding: unused
1636 * intra quantizer bias
1637 * - encoding: Set by user.
1638 * - decoding: unused
1640 int intra_quant_bias;
1641 #define FF_DEFAULT_QUANT_BIAS 999999
1644 * inter quantizer bias
1645 * - encoding: Set by user.
1646 * - decoding: unused
1648 int inter_quant_bias;
1652 * - encoding: unused
1653 * - decoding: Set by user.
1656 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1657 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1658 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1661 * XVideo Motion Acceleration
1662 * - encoding: forbidden
1663 * - decoding: set by decoder
1665 int xvmc_acceleration;
1668 * macroblock decision mode
1669 * - encoding: Set by user.
1670 * - decoding: unused
1673 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1674 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1675 #define FF_MB_DECISION_RD 2 ///< rate distortion
1678 * custom intra quantization matrix
1679 * - encoding: Set by user, can be NULL.
1680 * - decoding: Set by libavcodec.
1682 uint16_t *intra_matrix;
1685 * custom inter quantization matrix
1686 * - encoding: Set by user, can be NULL.
1687 * - decoding: Set by libavcodec.
1689 uint16_t *inter_matrix;
1692 * scene change detection threshold
1693 * 0 is default, larger means fewer detected scene changes.
1694 * - encoding: Set by user.
1695 * - decoding: unused
1697 int scenechange_threshold;
1700 * noise reduction strength
1701 * - encoding: Set by user.
1702 * - decoding: unused
1704 int noise_reduction;
1707 * Motion estimation threshold below which no motion estimation is
1708 * performed, but instead the user specified motion vectors are used.
1710 * - encoding: Set by user.
1711 * - decoding: unused
1716 * Macroblock threshold below which the user specified macroblock types will be used.
1717 * - encoding: Set by user.
1718 * - decoding: unused
1723 * precision of the intra DC coefficient - 8
1724 * - encoding: Set by user.
1725 * - decoding: unused
1727 int intra_dc_precision;
1730 * Number of macroblock rows at the top which are skipped.
1731 * - encoding: unused
1732 * - decoding: Set by user.
1737 * Number of macroblock rows at the bottom which are skipped.
1738 * - encoding: unused
1739 * - decoding: Set by user.
1744 * Border processing masking, raises the quantizer for mbs on the borders
1746 * - encoding: Set by user.
1747 * - decoding: unused
1749 float border_masking;
1752 * minimum MB lagrange multipler
1753 * - encoding: Set by user.
1754 * - decoding: unused
1759 * maximum MB lagrange multipler
1760 * - encoding: Set by user.
1761 * - decoding: unused
1767 * - encoding: Set by user.
1768 * - decoding: unused
1770 int me_penalty_compensation;
1774 * - encoding: Set by user.
1775 * - decoding: unused
1781 * - encoding: Set by user.
1782 * - decoding: unused
1788 * - encoding: Set by user.
1789 * - decoding: unused
1794 * number of reference frames
1795 * - encoding: Set by user.
1796 * - decoding: Set by lavc.
1801 * chroma qp offset from luma
1802 * - encoding: Set by user.
1803 * - decoding: unused
1808 * Multiplied by qscale for each frame and added to scene_change_score.
1809 * - encoding: Set by user.
1810 * - decoding: unused
1812 int scenechange_factor;
1816 * Note: Value depends upon the compare function used for fullpel ME.
1817 * - encoding: Set by user.
1818 * - decoding: unused
1823 * Adjust sensitivity of b_frame_strategy 1.
1824 * - encoding: Set by user.
1825 * - decoding: unused
1830 * Chromaticity coordinates of the source primaries.
1831 * - encoding: Set by user
1832 * - decoding: Set by libavcodec
1834 enum AVColorPrimaries color_primaries;
1837 * Color Transfer Characteristic.
1838 * - encoding: Set by user
1839 * - decoding: Set by libavcodec
1841 enum AVColorTransferCharacteristic color_trc;
1844 * YUV colorspace type.
1845 * - encoding: Set by user
1846 * - decoding: Set by libavcodec
1848 enum AVColorSpace colorspace;
1851 * MPEG vs JPEG YUV range.
1852 * - encoding: Set by user
1853 * - decoding: Set by libavcodec
1855 enum AVColorRange color_range;
1858 * This defines the location of chroma samples.
1859 * - encoding: Set by user
1860 * - decoding: Set by libavcodec
1862 enum AVChromaLocation chroma_sample_location;
1866 * Indicates number of picture subdivisions. Used for parallelized
1868 * - encoding: Set by user
1869 * - decoding: unused
1874 * - encoding: set by libavcodec
1875 * - decoding: Set by user.
1877 enum AVFieldOrder field_order;
1880 int sample_rate; ///< samples per second
1881 int channels; ///< number of audio channels
1884 * audio sample format
1885 * - encoding: Set by user.
1886 * - decoding: Set by libavcodec.
1888 enum AVSampleFormat sample_fmt; ///< sample format
1890 /* The following data should not be initialized. */
1892 * Number of samples per channel in an audio frame.
1894 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1895 * except the last must contain exactly frame_size samples per channel.
1896 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1897 * frame size is not restricted.
1898 * - decoding: may be set by some decoders to indicate constant frame size
1903 * Frame counter, set by libavcodec.
1905 * - decoding: total number of frames returned from the decoder so far.
1906 * - encoding: total number of frames passed to the encoder so far.
1908 * @note the counter is not incremented if encoding/decoding resulted in
1914 * number of bytes per packet if constant and known or 0
1915 * Used by some WAV based audio codecs.
1920 * Audio cutoff bandwidth (0 means "automatic")
1921 * - encoding: Set by user.
1922 * - decoding: unused
1926 #if FF_API_REQUEST_CHANNELS
1928 * Decoder should decode to this many channels if it can (0 for default)
1929 * - encoding: unused
1930 * - decoding: Set by user.
1931 * @deprecated Deprecated in favor of request_channel_layout.
1933 int request_channels;
1937 * Audio channel layout.
1938 * - encoding: set by user.
1939 * - decoding: set by user, may be overwritten by libavcodec.
1941 uint64_t channel_layout;
1944 * Request decoder to use this channel layout if it can (0 for default)
1945 * - encoding: unused
1946 * - decoding: Set by user.
1948 uint64_t request_channel_layout;
1951 * Type of service that the audio stream conveys.
1952 * - encoding: Set by user.
1953 * - decoding: Set by libavcodec.
1955 enum AVAudioServiceType audio_service_type;
1958 * desired sample format
1959 * - encoding: Not used.
1960 * - decoding: Set by user.
1961 * Decoder will decode to this format if it can.
1963 enum AVSampleFormat request_sample_fmt;
1965 #if FF_API_GET_BUFFER
1967 * Called at the beginning of each frame to get a buffer for it.
1969 * The function will set AVFrame.data[], AVFrame.linesize[].
1970 * AVFrame.extended_data[] must also be set, but it should be the same as
1971 * AVFrame.data[] except for planar audio with more channels than can fit
1972 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1973 * many data pointers as it can hold.
1975 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1976 * avcodec_default_get_buffer() instead of providing buffers allocated by
1979 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1980 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1981 * but if get_buffer() is overridden then alignment considerations should
1982 * be taken into account.
1984 * @see avcodec_default_get_buffer()
1988 * If pic.reference is set then the frame will be read later by libavcodec.
1989 * avcodec_align_dimensions2() should be used to find the required width and
1990 * height, as they normally need to be rounded up to the next multiple of 16.
1992 * If frame multithreading is used and thread_safe_callbacks is set,
1993 * it may be called from a different thread, but not from more than one at
1994 * once. Does not need to be reentrant.
1996 * @see release_buffer(), reget_buffer()
1997 * @see avcodec_align_dimensions2()
2001 * Decoders request a buffer of a particular size by setting
2002 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2003 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2004 * to a smaller value in the output frame.
2006 * Decoders cannot use the buffer after returning from
2007 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2008 * is assumed to be released immediately upon return. In some rare cases,
2009 * a decoder may need to call get_buffer() more than once in a single
2010 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2011 * called again after it has already been called once, the previously
2012 * acquired buffer is assumed to be released at that time and may not be
2013 * reused by the decoder.
2015 * As a convenience, av_samples_get_buffer_size() and
2016 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2017 * functions to find the required data size and to fill data pointers and
2018 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2019 * since all planes must be the same size.
2021 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2023 * - encoding: unused
2024 * - decoding: Set by libavcodec, user can override.
2026 * @deprecated use get_buffer2()
2028 attribute_deprecated
2029 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2032 * Called to release buffers which were allocated with get_buffer.
2033 * A released buffer can be reused in get_buffer().
2034 * pic.data[*] must be set to NULL.
2035 * May be called from a different thread if frame multithreading is used,
2036 * but not by more than one thread at once, so does not need to be reentrant.
2037 * - encoding: unused
2038 * - decoding: Set by libavcodec, user can override.
2040 * @deprecated custom freeing callbacks should be set from get_buffer2()
2042 attribute_deprecated
2043 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2046 * Called at the beginning of a frame to get cr buffer for it.
2047 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2048 * libavcodec will pass previous buffer in pic, function should return
2049 * same buffer or new buffer with old frame "painted" into it.
2050 * If pic.data[0] == NULL must behave like get_buffer().
2051 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2052 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2054 * - encoding: unused
2055 * - decoding: Set by libavcodec, user can override.
2057 attribute_deprecated
2058 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2062 * This callback is called at the beginning of each frame to get data
2063 * buffer(s) for it. There may be one contiguous buffer for all the data or
2064 * there may be a buffer per each data plane or anything in between. What
2065 * this means is, you may set however many entries in buf[] you feel necessary.
2066 * Each buffer must be reference-counted using the AVBuffer API (see description
2069 * The following fields will be set in the frame before this callback is
2072 * - width, height (video only)
2073 * - sample_rate, channel_layout, nb_samples (audio only)
2074 * Their values may differ from the corresponding values in
2075 * AVCodecContext. This callback must use the frame values, not the codec
2076 * context values, to calculate the required buffer size.
2078 * This callback must fill the following fields in the frame:
2082 * * if the data is planar audio with more than 8 channels, then this
2083 * callback must allocate and fill extended_data to contain all pointers
2084 * to all data planes. data[] must hold as many pointers as it can.
2085 * extended_data must be allocated with av_malloc() and will be freed in
2087 * * otherwise exended_data must point to data
2088 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2089 * the frame's data and extended_data pointers must be contained in these. That
2090 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2091 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2092 * and av_buffer_ref().
2093 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2094 * this callback and filled with the extra buffers if there are more
2095 * buffers than buf[] can hold. extended_buf will be freed in
2098 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2099 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2102 * Each data plane must be aligned to the maximum required by the target
2105 * @see avcodec_default_get_buffer2()
2109 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2110 * (read and/or written to if it is writable) later by libavcodec.
2112 * If CODEC_FLAG_EMU_EDGE is not set in s->flags, the buffer must contain an
2113 * edge of the size returned by avcodec_get_edge_width() on all sides.
2115 * avcodec_align_dimensions2() should be used to find the required width and
2116 * height, as they normally need to be rounded up to the next multiple of 16.
2118 * If frame multithreading is used and thread_safe_callbacks is set,
2119 * this callback may be called from a different thread, but not from more
2120 * than one at once. Does not need to be reentrant.
2122 * @see avcodec_align_dimensions2()
2126 * Decoders request a buffer of a particular size by setting
2127 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2128 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2129 * to a smaller value in the output frame.
2131 * As a convenience, av_samples_get_buffer_size() and
2132 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2133 * functions to find the required data size and to fill data pointers and
2134 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2135 * since all planes must be the same size.
2137 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2139 * - encoding: unused
2140 * - decoding: Set by libavcodec, user can override.
2142 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2145 * If non-zero, the decoded audio and video frames returned from
2146 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2147 * and are valid indefinitely. The caller must free them with
2148 * av_frame_unref() when they are not needed anymore.
2149 * Otherwise, the decoded frames must not be freed by the caller and are
2150 * only valid until the next decode call.
2152 * - encoding: unused
2153 * - decoding: set by the caller before avcodec_open2().
2155 int refcounted_frames;
2157 /* - encoding parameters */
2158 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2159 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2163 * - encoding: Set by user.
2164 * - decoding: unused
2170 * - encoding: Set by user.
2171 * - decoding: unused
2176 * maximum quantizer difference between frames
2177 * - encoding: Set by user.
2178 * - decoding: unused
2183 * ratecontrol qmin qmax limiting method
2184 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2185 * - encoding: Set by user.
2186 * - decoding: unused
2194 * decoder bitstream buffer size
2195 * - encoding: Set by user.
2196 * - decoding: unused
2201 * ratecontrol override, see RcOverride
2202 * - encoding: Allocated/set/freed by user.
2203 * - decoding: unused
2205 int rc_override_count;
2206 RcOverride *rc_override;
2209 * rate control equation
2210 * - encoding: Set by user
2211 * - decoding: unused
2217 * - encoding: Set by user.
2218 * - decoding: unused
2224 * - encoding: Set by user.
2225 * - decoding: unused
2229 float rc_buffer_aggressivity;
2232 * initial complexity for pass1 ratecontrol
2233 * - encoding: Set by user.
2234 * - decoding: unused
2236 float rc_initial_cplx;
2239 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2240 * - encoding: Set by user.
2241 * - decoding: unused.
2243 float rc_max_available_vbv_use;
2246 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2247 * - encoding: Set by user.
2248 * - decoding: unused.
2250 float rc_min_vbv_overflow_use;
2253 * Number of bits which should be loaded into the rc buffer before decoding starts.
2254 * - encoding: Set by user.
2255 * - decoding: unused
2257 int rc_initial_buffer_occupancy;
2259 #define FF_CODER_TYPE_VLC 0
2260 #define FF_CODER_TYPE_AC 1
2261 #define FF_CODER_TYPE_RAW 2
2262 #define FF_CODER_TYPE_RLE 3
2263 #define FF_CODER_TYPE_DEFLATE 4
2266 * - encoding: Set by user.
2267 * - decoding: unused
2273 * - encoding: Set by user.
2274 * - decoding: unused
2279 * minimum Lagrange multipler
2280 * - encoding: Set by user.
2281 * - decoding: unused
2286 * maximum Lagrange multipler
2287 * - encoding: Set by user.
2288 * - decoding: unused
2293 * frame skip threshold
2294 * - encoding: Set by user.
2295 * - decoding: unused
2297 int frame_skip_threshold;
2301 * - encoding: Set by user.
2302 * - decoding: unused
2304 int frame_skip_factor;
2307 * frame skip exponent
2308 * - encoding: Set by user.
2309 * - decoding: unused
2314 * frame skip comparison function
2315 * - encoding: Set by user.
2316 * - decoding: unused
2321 * trellis RD quantization
2322 * - encoding: Set by user.
2323 * - decoding: unused
2328 * - encoding: Set by user.
2329 * - decoding: unused
2331 int min_prediction_order;
2334 * - encoding: Set by user.
2335 * - decoding: unused
2337 int max_prediction_order;
2340 * GOP timecode frame start number
2341 * - encoding: Set by user, in non drop frame format
2342 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2344 int64_t timecode_frame_start;
2346 /* The RTP callback: This function is called */
2347 /* every time the encoder has a packet to send. */
2348 /* It depends on the encoder if the data starts */
2349 /* with a Start Code (it should). H.263 does. */
2350 /* mb_nb contains the number of macroblocks */
2351 /* encoded in the RTP payload. */
2352 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2354 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2355 /* do its best to deliver a chunk with size */
2356 /* below rtp_payload_size, the chunk will start */
2357 /* with a start code on some codecs like H.263. */
2358 /* This doesn't take account of any particular */
2359 /* headers inside the transmitted RTP payload. */
2361 /* statistics, used for 2-pass encoding */
2372 * number of bits used for the previously encoded frame
2373 * - encoding: Set by libavcodec.
2374 * - decoding: unused
2379 * pass1 encoding statistics output buffer
2380 * - encoding: Set by libavcodec.
2381 * - decoding: unused
2386 * pass2 encoding statistics input buffer
2387 * Concatenated stuff from stats_out of pass1 should be placed here.
2388 * - encoding: Allocated/set/freed by user.
2389 * - decoding: unused
2394 * Work around bugs in encoders which sometimes cannot be detected automatically.
2395 * - encoding: Set by user
2396 * - decoding: Set by user
2398 int workaround_bugs;
2399 #define FF_BUG_AUTODETECT 1 ///< autodetection
2400 #define FF_BUG_OLD_MSMPEG4 2
2401 #define FF_BUG_XVID_ILACE 4
2402 #define FF_BUG_UMP4 8
2403 #define FF_BUG_NO_PADDING 16
2404 #define FF_BUG_AMV 32
2405 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2406 #define FF_BUG_QPEL_CHROMA 64
2407 #define FF_BUG_STD_QPEL 128
2408 #define FF_BUG_QPEL_CHROMA2 256
2409 #define FF_BUG_DIRECT_BLOCKSIZE 512
2410 #define FF_BUG_EDGE 1024
2411 #define FF_BUG_HPEL_CHROMA 2048
2412 #define FF_BUG_DC_CLIP 4096
2413 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2414 #define FF_BUG_TRUNCATED 16384
2417 * strictly follow the standard (MPEG4, ...).
2418 * - encoding: Set by user.
2419 * - decoding: Set by user.
2420 * Setting this to STRICT or higher means the encoder and decoder will
2421 * generally do stupid things, whereas setting it to unofficial or lower
2422 * will mean the encoder might produce output that is not supported by all
2423 * spec-compliant decoders. Decoders don't differentiate between normal,
2424 * unofficial and experimental (that is, they always try to decode things
2425 * when they can) unless they are explicitly asked to behave stupidly
2426 * (=strictly conform to the specs)
2428 int strict_std_compliance;
2429 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2430 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2431 #define FF_COMPLIANCE_NORMAL 0
2432 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2433 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2436 * error concealment flags
2437 * - encoding: unused
2438 * - decoding: Set by user.
2440 int error_concealment;
2441 #define FF_EC_GUESS_MVS 1
2442 #define FF_EC_DEBLOCK 2
2446 * - encoding: Set by user.
2447 * - decoding: Set by user.
2450 #define FF_DEBUG_PICT_INFO 1
2451 #define FF_DEBUG_RC 2
2452 #define FF_DEBUG_BITSTREAM 4
2453 #define FF_DEBUG_MB_TYPE 8
2454 #define FF_DEBUG_QP 16
2455 #define FF_DEBUG_MV 32
2456 #define FF_DEBUG_DCT_COEFF 0x00000040
2457 #define FF_DEBUG_SKIP 0x00000080
2458 #define FF_DEBUG_STARTCODE 0x00000100
2459 #define FF_DEBUG_PTS 0x00000200
2460 #define FF_DEBUG_ER 0x00000400
2461 #define FF_DEBUG_MMCO 0x00000800
2462 #define FF_DEBUG_BUGS 0x00001000
2463 #define FF_DEBUG_VIS_QP 0x00002000
2464 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2465 #define FF_DEBUG_BUFFERS 0x00008000
2466 #define FF_DEBUG_THREADS 0x00010000
2470 * - encoding: Set by user.
2471 * - decoding: Set by user.
2474 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2475 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2476 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2479 * Error recognition; may misdetect some more or less valid parts as errors.
2480 * - encoding: unused
2481 * - decoding: Set by user.
2483 int err_recognition;
2484 #define AV_EF_CRCCHECK (1<<0)
2485 #define AV_EF_BITSTREAM (1<<1)
2486 #define AV_EF_BUFFER (1<<2)
2487 #define AV_EF_EXPLODE (1<<3)
2489 #define AV_EF_CAREFUL (1<<16)
2490 #define AV_EF_COMPLIANT (1<<17)
2491 #define AV_EF_AGGRESSIVE (1<<18)
2495 * opaque 64bit number (generally a PTS) that will be reordered and
2496 * output in AVFrame.reordered_opaque
2497 * @deprecated in favor of pkt_pts
2498 * - encoding: unused
2499 * - decoding: Set by user.
2501 int64_t reordered_opaque;
2504 * Hardware accelerator in use
2505 * - encoding: unused.
2506 * - decoding: Set by libavcodec
2508 struct AVHWAccel *hwaccel;
2511 * Hardware accelerator context.
2512 * For some hardware accelerators, a global context needs to be
2513 * provided by the user. In that case, this holds display-dependent
2514 * data FFmpeg cannot instantiate itself. Please refer to the
2515 * FFmpeg HW accelerator documentation to know how to fill this
2516 * is. e.g. for VA API, this is a struct vaapi_context.
2517 * - encoding: unused
2518 * - decoding: Set by user
2520 void *hwaccel_context;
2524 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2525 * - decoding: unused
2527 uint64_t error[AV_NUM_DATA_POINTERS];
2530 * DCT algorithm, see FF_DCT_* below
2531 * - encoding: Set by user.
2532 * - decoding: unused
2535 #define FF_DCT_AUTO 0
2536 #define FF_DCT_FASTINT 1
2537 #define FF_DCT_INT 2
2538 #define FF_DCT_MMX 3
2539 #define FF_DCT_ALTIVEC 5
2540 #define FF_DCT_FAAN 6
2543 * IDCT algorithm, see FF_IDCT_* below.
2544 * - encoding: Set by user.
2545 * - decoding: Set by user.
2548 #define FF_IDCT_AUTO 0
2549 #define FF_IDCT_INT 1
2550 #define FF_IDCT_SIMPLE 2
2551 #define FF_IDCT_SIMPLEMMX 3
2552 #define FF_IDCT_ARM 7
2553 #define FF_IDCT_ALTIVEC 8
2554 #define FF_IDCT_SH4 9
2555 #define FF_IDCT_SIMPLEARM 10
2556 #define FF_IDCT_IPP 13
2557 #define FF_IDCT_XVIDMMX 14
2558 #define FF_IDCT_SIMPLEARMV5TE 16
2559 #define FF_IDCT_SIMPLEARMV6 17
2560 #define FF_IDCT_SIMPLEVIS 18
2561 #define FF_IDCT_FAAN 20
2562 #define FF_IDCT_SIMPLENEON 22
2563 #define FF_IDCT_SIMPLEALPHA 23
2566 * bits per sample/pixel from the demuxer (needed for huffyuv).
2567 * - encoding: Set by libavcodec.
2568 * - decoding: Set by user.
2570 int bits_per_coded_sample;
2573 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2574 * - encoding: set by user.
2575 * - decoding: set by libavcodec.
2577 int bits_per_raw_sample;
2581 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2582 * - encoding: unused
2583 * - decoding: Set by user.
2584 * Code outside libavcodec should access this field using:
2585 * av_codec_{get,set}_lowres(avctx)
2591 * the picture in the bitstream
2592 * - encoding: Set by libavcodec.
2593 * - decoding: Set by libavcodec.
2595 AVFrame *coded_frame;
2599 * is used to decide how many independent tasks should be passed to execute()
2600 * - encoding: Set by user.
2601 * - decoding: Set by user.
2606 * Which multithreading methods to use.
2607 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2608 * so clients which cannot provide future frames should not use it.
2610 * - encoding: Set by user, otherwise the default is used.
2611 * - decoding: Set by user, otherwise the default is used.
2614 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2615 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2618 * Which multithreading methods are in use by the codec.
2619 * - encoding: Set by libavcodec.
2620 * - decoding: Set by libavcodec.
2622 int active_thread_type;
2625 * Set by the client if its custom get_buffer() callback can be called
2626 * synchronously from another thread, which allows faster multithreaded decoding.
2627 * draw_horiz_band() will be called from other threads regardless of this setting.
2628 * Ignored if the default get_buffer() is used.
2629 * - encoding: Set by user.
2630 * - decoding: Set by user.
2632 int thread_safe_callbacks;
2635 * The codec may call this to execute several independent things.
2636 * It will return only after finishing all tasks.
2637 * The user may replace this with some multithreaded implementation,
2638 * the default implementation will execute the parts serially.
2639 * @param count the number of things to execute
2640 * - encoding: Set by libavcodec, user can override.
2641 * - decoding: Set by libavcodec, user can override.
2643 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2646 * The codec may call this to execute several independent things.
2647 * It will return only after finishing all tasks.
2648 * The user may replace this with some multithreaded implementation,
2649 * the default implementation will execute the parts serially.
2650 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2651 * @param c context passed also to func
2652 * @param count the number of things to execute
2653 * @param arg2 argument passed unchanged to func
2654 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2655 * @param func function that will be called count times, with jobnr from 0 to count-1.
2656 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2657 * two instances of func executing at the same time will have the same threadnr.
2658 * @return always 0 currently, but code should handle a future improvement where when any call to func
2659 * returns < 0 no further calls to func may be done and < 0 is returned.
2660 * - encoding: Set by libavcodec, user can override.
2661 * - decoding: Set by libavcodec, user can override.
2663 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2667 * Can be used by execute() to store some per AVCodecContext stuff.
2668 * - encoding: set by execute()
2669 * - decoding: set by execute()
2671 void *thread_opaque;
2674 * noise vs. sse weight for the nsse comparsion function
2675 * - encoding: Set by user.
2676 * - decoding: unused
2682 * - encoding: Set by user.
2683 * - decoding: Set by libavcodec.
2686 #define FF_PROFILE_UNKNOWN -99
2687 #define FF_PROFILE_RESERVED -100
2689 #define FF_PROFILE_AAC_MAIN 0
2690 #define FF_PROFILE_AAC_LOW 1
2691 #define FF_PROFILE_AAC_SSR 2
2692 #define FF_PROFILE_AAC_LTP 3
2693 #define FF_PROFILE_AAC_HE 4
2694 #define FF_PROFILE_AAC_HE_V2 28
2695 #define FF_PROFILE_AAC_LD 22
2696 #define FF_PROFILE_AAC_ELD 38
2698 #define FF_PROFILE_DTS 20
2699 #define FF_PROFILE_DTS_ES 30
2700 #define FF_PROFILE_DTS_96_24 40
2701 #define FF_PROFILE_DTS_HD_HRA 50
2702 #define FF_PROFILE_DTS_HD_MA 60
2704 #define FF_PROFILE_MPEG2_422 0
2705 #define FF_PROFILE_MPEG2_HIGH 1
2706 #define FF_PROFILE_MPEG2_SS 2
2707 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2708 #define FF_PROFILE_MPEG2_MAIN 4
2709 #define FF_PROFILE_MPEG2_SIMPLE 5
2711 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2712 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2714 #define FF_PROFILE_H264_BASELINE 66
2715 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2716 #define FF_PROFILE_H264_MAIN 77
2717 #define FF_PROFILE_H264_EXTENDED 88
2718 #define FF_PROFILE_H264_HIGH 100
2719 #define FF_PROFILE_H264_HIGH_10 110
2720 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2721 #define FF_PROFILE_H264_HIGH_422 122
2722 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2723 #define FF_PROFILE_H264_HIGH_444 144
2724 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2725 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2726 #define FF_PROFILE_H264_CAVLC_444 44
2728 #define FF_PROFILE_VC1_SIMPLE 0
2729 #define FF_PROFILE_VC1_MAIN 1
2730 #define FF_PROFILE_VC1_COMPLEX 2
2731 #define FF_PROFILE_VC1_ADVANCED 3
2733 #define FF_PROFILE_MPEG4_SIMPLE 0
2734 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2735 #define FF_PROFILE_MPEG4_CORE 2
2736 #define FF_PROFILE_MPEG4_MAIN 3
2737 #define FF_PROFILE_MPEG4_N_BIT 4
2738 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2739 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2740 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2741 #define FF_PROFILE_MPEG4_HYBRID 8
2742 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2743 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2744 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2745 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2746 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2747 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2748 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2750 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2751 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2752 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2753 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2754 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2758 * - encoding: Set by user.
2759 * - decoding: Set by libavcodec.
2762 #define FF_LEVEL_UNKNOWN -99
2765 * Skip loop filtering for selected frames.
2766 * - encoding: unused
2767 * - decoding: Set by user.
2769 enum AVDiscard skip_loop_filter;
2772 * Skip IDCT/dequantization for selected frames.
2773 * - encoding: unused
2774 * - decoding: Set by user.
2776 enum AVDiscard skip_idct;
2779 * Skip decoding for selected frames.
2780 * - encoding: unused
2781 * - decoding: Set by user.
2783 enum AVDiscard skip_frame;
2786 * Header containing style information for text subtitles.
2787 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2788 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2789 * the Format line following. It shouldn't include any Dialogue line.
2790 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2791 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2793 uint8_t *subtitle_header;
2794 int subtitle_header_size;
2797 * Simulates errors in the bitstream to test error concealment.
2798 * - encoding: Set by user.
2799 * - decoding: unused
2804 * Current packet as passed into the decoder, to avoid having
2805 * to pass the packet into every function. Currently only valid
2806 * inside lavc and get/release_buffer callbacks.
2807 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2808 * - encoding: unused
2813 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2814 * Used for compliant TS muxing.
2815 * - encoding: Set by libavcodec.
2816 * - decoding: unused.
2821 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2822 * Code outside libavcodec should access this field using:
2823 * av_codec_{get,set}_pkt_timebase(avctx)
2824 * - encoding unused.
2825 * - decoding set by user.
2827 AVRational pkt_timebase;
2831 * Code outside libavcodec should access this field using:
2832 * av_codec_{get,set}_codec_descriptor(avctx)
2833 * - encoding: unused.
2834 * - decoding: set by libavcodec.
2836 const AVCodecDescriptor *codec_descriptor;
2840 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2841 * - encoding: unused
2842 * - decoding: Set by user.
2843 * Code outside libavcodec should access this field using:
2844 * av_codec_{get,set}_lowres(avctx)
2850 * Current statistics for PTS correction.
2851 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2852 * - encoding: unused
2854 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2855 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2856 int64_t pts_correction_last_pts; /// PTS of the last frame
2857 int64_t pts_correction_last_dts; /// DTS of the last frame
2860 * Character encoding of the input subtitles file.
2861 * - decoding: set by user
2862 * - encoding: unused
2867 * Subtitles character encoding mode. Formats or codecs might be adjusting
2868 * this setting (if they are doing the conversion themselves for instance).
2869 * - decoding: set by libavcodec
2870 * - encoding: unused
2872 int sub_charenc_mode;
2873 #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)
2874 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
2875 #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
2879 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
2880 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
2882 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
2883 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
2885 int av_codec_get_lowres(const AVCodecContext *avctx);
2886 void av_codec_set_lowres(AVCodecContext *avctx, int val);
2891 typedef struct AVProfile {
2893 const char *name; ///< short name for the profile
2896 typedef struct AVCodecDefault AVCodecDefault;
2903 typedef struct AVCodec {
2905 * Name of the codec implementation.
2906 * The name is globally unique among encoders and among decoders (but an
2907 * encoder and a decoder can share the same name).
2908 * This is the primary way to find a codec from the user perspective.
2912 * Descriptive name for the codec, meant to be more human readable than name.
2913 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2915 const char *long_name;
2916 enum AVMediaType type;
2919 * Codec capabilities.
2923 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2924 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2925 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2926 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2927 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2928 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2929 const AVClass *priv_class; ///< AVClass for the private context
2930 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2932 /*****************************************************************
2933 * No fields below this line are part of the public API. They
2934 * may not be used outside of libavcodec and can be changed and
2936 * New public fields should be added right above.
2937 *****************************************************************
2940 struct AVCodec *next;
2942 * @name Frame-level threading support functions
2946 * If defined, called on thread contexts when they are created.
2947 * If the codec allocates writable tables in init(), re-allocate them here.
2948 * priv_data will be set to a copy of the original.
2950 int (*init_thread_copy)(AVCodecContext *);
2952 * Copy necessary context variables from a previous thread context to the current one.
2953 * If not defined, the next thread will start automatically; otherwise, the codec
2954 * must call ff_thread_finish_setup().
2956 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2958 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2962 * Private codec-specific defaults.
2964 const AVCodecDefault *defaults;
2967 * Initialize codec static data, called from avcodec_register().
2969 void (*init_static_data)(struct AVCodec *codec);
2971 int (*init)(AVCodecContext *);
2972 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2973 const struct AVSubtitle *sub);
2975 * Encode data to an AVPacket.
2977 * @param avctx codec context
2978 * @param avpkt output AVPacket (may contain a user-provided buffer)
2979 * @param[in] frame AVFrame containing the raw data to be encoded
2980 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2981 * non-empty packet was returned in avpkt.
2982 * @return 0 on success, negative error code on failure
2984 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2985 int *got_packet_ptr);
2986 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2987 int (*close)(AVCodecContext *);
2990 * Will be called when seeking
2992 void (*flush)(AVCodecContext *);
2998 typedef struct AVHWAccel {
3000 * Name of the hardware accelerated codec.
3001 * The name is globally unique among encoders and among decoders (but an
3002 * encoder and a decoder can share the same name).
3007 * Type of codec implemented by the hardware accelerator.
3009 * See AVMEDIA_TYPE_xxx
3011 enum AVMediaType type;
3014 * Codec implemented by the hardware accelerator.
3016 * See AV_CODEC_ID_xxx
3021 * Supported pixel format.
3023 * Only hardware accelerated formats are supported here.
3025 enum AVPixelFormat pix_fmt;
3028 * Hardware accelerated codec capabilities.
3029 * see FF_HWACCEL_CODEC_CAP_*
3033 struct AVHWAccel *next;
3036 * Called at the beginning of each frame or field picture.
3038 * Meaningful frame information (codec specific) is guaranteed to
3039 * be parsed at this point. This function is mandatory.
3041 * Note that buf can be NULL along with buf_size set to 0.
3042 * Otherwise, this means the whole frame is available at this point.
3044 * @param avctx the codec context
3045 * @param buf the frame data buffer base
3046 * @param buf_size the size of the frame in bytes
3047 * @return zero if successful, a negative value otherwise
3049 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3052 * Callback for each slice.
3054 * Meaningful slice information (codec specific) is guaranteed to
3055 * be parsed at this point. This function is mandatory.
3057 * @param avctx the codec context
3058 * @param buf the slice data buffer base
3059 * @param buf_size the size of the slice in bytes
3060 * @return zero if successful, a negative value otherwise
3062 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3065 * Called at the end of each frame or field picture.
3067 * The whole picture is parsed at this point and can now be sent
3068 * to the hardware accelerator. This function is mandatory.
3070 * @param avctx the codec context
3071 * @return zero if successful, a negative value otherwise
3073 int (*end_frame)(AVCodecContext *avctx);
3076 * Size of HW accelerator private data.
3078 * Private data is allocated with av_mallocz() before
3079 * AVCodecContext.get_buffer() and deallocated after
3080 * AVCodecContext.release_buffer().
3086 * @defgroup lavc_picture AVPicture
3088 * Functions for working with AVPicture
3093 * four components are given, that's all.
3094 * the last component is alpha
3096 typedef struct AVPicture {
3097 uint8_t *data[AV_NUM_DATA_POINTERS];
3098 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3105 enum AVSubtitleType {
3108 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3111 * Plain text, the text field must be set by the decoder and is
3112 * authoritative. ass and pict fields may contain approximations.
3117 * Formatted text, the ass field must be set by the decoder and is
3118 * authoritative. pict and text fields may contain approximations.
3123 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3125 typedef struct AVSubtitleRect {
3126 int x; ///< top left corner of pict, undefined when pict is not set
3127 int y; ///< top left corner of pict, undefined when pict is not set
3128 int w; ///< width of pict, undefined when pict is not set
3129 int h; ///< height of pict, undefined when pict is not set
3130 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3133 * data+linesize for the bitmap of this subtitle.
3134 * can be set for text/ass as well once they where rendered
3137 enum AVSubtitleType type;
3139 char *text; ///< 0 terminated plain UTF-8 text
3142 * 0 terminated ASS/SSA compatible event line.
3143 * The presentation of this is unaffected by the other values in this
3151 typedef struct AVSubtitle {
3152 uint16_t format; /* 0 = graphics */
3153 uint32_t start_display_time; /* relative to packet pts, in ms */
3154 uint32_t end_display_time; /* relative to packet pts, in ms */
3156 AVSubtitleRect **rects;
3157 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3161 * If c is NULL, returns the first registered codec,
3162 * if c is non-NULL, returns the next registered codec after c,
3163 * or NULL if c is the last one.
3165 AVCodec *av_codec_next(const AVCodec *c);
3168 * Return the LIBAVCODEC_VERSION_INT constant.
3170 unsigned avcodec_version(void);
3173 * Return the libavcodec build-time configuration.
3175 const char *avcodec_configuration(void);
3178 * Return the libavcodec license.
3180 const char *avcodec_license(void);
3183 * Register the codec codec and initialize libavcodec.
3185 * @warning either this function or avcodec_register_all() must be called
3186 * before any other libavcodec functions.
3188 * @see avcodec_register_all()
3190 void avcodec_register(AVCodec *codec);
3193 * Register all the codecs, parsers and bitstream filters which were enabled at
3194 * configuration time. If you do not call this function you can select exactly
3195 * which formats you want to support, by using the individual registration
3198 * @see avcodec_register
3199 * @see av_register_codec_parser
3200 * @see av_register_bitstream_filter
3202 void avcodec_register_all(void);
3205 #if FF_API_ALLOC_CONTEXT
3207 * Allocate an AVCodecContext and set its fields to default values. The
3208 * resulting struct can be deallocated by simply calling av_free().
3210 * @return An AVCodecContext filled with default values or NULL on failure.
3211 * @see avcodec_get_context_defaults
3213 * @deprecated use avcodec_alloc_context3()
3215 attribute_deprecated
3216 AVCodecContext *avcodec_alloc_context(void);
3218 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3219 * we WILL change its arguments and name a few times! */
3220 attribute_deprecated
3221 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3224 * Set the fields of the given AVCodecContext to default values.
3226 * @param s The AVCodecContext of which the fields should be set to default values.
3227 * @deprecated use avcodec_get_context_defaults3
3229 attribute_deprecated
3230 void avcodec_get_context_defaults(AVCodecContext *s);
3232 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3233 * we WILL change its arguments and name a few times! */
3234 attribute_deprecated
3235 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3239 * Allocate an AVCodecContext and set its fields to default values. The
3240 * resulting struct can be deallocated by calling avcodec_close() on it followed
3243 * @param codec if non-NULL, allocate private data and initialize defaults
3244 * for the given codec. It is illegal to then call avcodec_open2()
3245 * with a different codec.
3246 * If NULL, then the codec-specific defaults won't be initialized,
3247 * which may result in suboptimal default settings (this is
3248 * important mainly for encoders, e.g. libx264).
3250 * @return An AVCodecContext filled with default values or NULL on failure.
3251 * @see avcodec_get_context_defaults
3253 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3256 * Set the fields of the given AVCodecContext to default values corresponding
3257 * to the given codec (defaults may be codec-dependent).
3259 * Do not call this function if a non-NULL codec has been passed
3260 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3261 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3262 * different codec on this AVCodecContext.
3264 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3267 * Get the AVClass for AVCodecContext. It can be used in combination with
3268 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3270 * @see av_opt_find().
3272 const AVClass *avcodec_get_class(void);
3275 * Get the AVClass for AVFrame. It can be used in combination with
3276 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3278 * @see av_opt_find().
3280 const AVClass *avcodec_get_frame_class(void);
3283 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3284 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3286 * @see av_opt_find().
3288 const AVClass *avcodec_get_subtitle_rect_class(void);
3291 * Copy the settings of the source AVCodecContext into the destination
3292 * AVCodecContext. The resulting destination codec context will be
3293 * unopened, i.e. you are required to call avcodec_open2() before you
3294 * can use this AVCodecContext to decode/encode video/audio data.
3296 * @param dest target codec context, should be initialized with
3297 * avcodec_alloc_context3(), but otherwise uninitialized
3298 * @param src source codec context
3299 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3301 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3304 * Allocate an AVFrame and set its fields to default values. The resulting
3305 * struct must be freed using avcodec_free_frame().
3307 * @return An AVFrame filled with default values or NULL on failure.
3308 * @see avcodec_get_frame_defaults
3310 AVFrame *avcodec_alloc_frame(void);
3313 * Set the fields of the given AVFrame to default values.
3315 * @param frame The AVFrame of which the fields should be set to default values.
3317 void avcodec_get_frame_defaults(AVFrame *frame);
3320 * Free the frame and any dynamically allocated objects in it,
3321 * e.g. extended_data.
3323 * @param frame frame to be freed. The pointer will be set to NULL.
3325 * @warning this function does NOT free the data buffers themselves
3326 * (it does not know how, since they might have been allocated with
3327 * a custom get_buffer()).
3329 void avcodec_free_frame(AVFrame **frame);
3331 #if FF_API_AVCODEC_OPEN
3333 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3334 * function the context has to be allocated.
3336 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3337 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3338 * retrieving a codec.
3340 * @warning This function is not thread safe!
3343 * avcodec_register_all();
3344 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3348 * context = avcodec_alloc_context3(codec);
3350 * if (avcodec_open(context, codec) < 0)
3354 * @param avctx The context which will be set up to use the given codec.
3355 * @param codec The codec to use within the context.
3356 * @return zero on success, a negative value on error
3357 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3359 * @deprecated use avcodec_open2
3361 attribute_deprecated
3362 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3366 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3367 * function the context has to be allocated with avcodec_alloc_context3().
3369 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3370 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3371 * retrieving a codec.
3373 * @warning This function is not thread safe!
3376 * avcodec_register_all();
3377 * av_dict_set(&opts, "b", "2.5M", 0);
3378 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3382 * context = avcodec_alloc_context3(codec);
3384 * if (avcodec_open2(context, codec, opts) < 0)
3388 * @param avctx The context to initialize.
3389 * @param codec The codec to open this context for. If a non-NULL codec has been
3390 * previously passed to avcodec_alloc_context3() or
3391 * avcodec_get_context_defaults3() for this context, then this
3392 * parameter MUST be either NULL or equal to the previously passed
3394 * @param options A dictionary filled with AVCodecContext and codec-private options.
3395 * On return this object will be filled with options that were not found.
3397 * @return zero on success, a negative value on error
3398 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3399 * av_dict_set(), av_opt_find().
3401 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3404 * Close a given AVCodecContext and free all the data associated with it
3405 * (but not the AVCodecContext itself).
3407 * Calling this function on an AVCodecContext that hasn't been opened will free
3408 * the codec-specific data allocated in avcodec_alloc_context3() /
3409 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3412 int avcodec_close(AVCodecContext *avctx);
3415 * Free all allocated data in the given subtitle struct.
3417 * @param sub AVSubtitle to free.
3419 void avsubtitle_free(AVSubtitle *sub);
3426 * @addtogroup lavc_packet
3430 #if FF_API_DESTRUCT_PACKET
3432 * Default packet destructor.
3433 * @deprecated use the AVBuffer API instead
3435 attribute_deprecated
3436 void av_destruct_packet(AVPacket *pkt);
3440 * Initialize optional fields of a packet with default values.
3442 * Note, this does not touch the data and size members, which have to be
3443 * initialized separately.
3447 void av_init_packet(AVPacket *pkt);
3450 * Allocate the payload of a packet and initialize its fields with
3454 * @param size wanted payload size
3455 * @return 0 if OK, AVERROR_xxx otherwise
3457 int av_new_packet(AVPacket *pkt, int size);
3460 * Reduce packet size, correctly zeroing padding
3463 * @param size new size
3465 void av_shrink_packet(AVPacket *pkt, int size);
3468 * Increase packet size, correctly zeroing padding
3471 * @param grow_by number of bytes by which to increase the size of the packet
3473 int av_grow_packet(AVPacket *pkt, int grow_by);
3476 * Initialize a reference-counted packet from av_malloc()ed data.
3478 * @param pkt packet to be initialized. This function will set the data, size,
3479 * buf and destruct fields, all others are left untouched.
3480 * @param data Data allocated by av_malloc() to be used as packet data. If this
3481 * function returns successfully, the data is owned by the underlying AVBuffer.
3482 * The caller may not access the data through other means.
3483 * @param size size of data in bytes, without the padding. I.e. the full buffer
3484 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3486 * @return 0 on success, a negative AVERROR on error
3488 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3491 * @warning This is a hack - the packet memory allocation stuff is broken. The
3492 * packet is allocated if it was not really allocated.
3494 int av_dup_packet(AVPacket *pkt);
3497 * Copy packet, including contents
3499 * @return 0 on success, negative AVERROR on fail
3501 int av_copy_packet(AVPacket *dst, AVPacket *src);
3504 * Copy packet side data
3506 * @return 0 on success, negative AVERROR on fail
3508 int av_copy_packet_side_data(AVPacket *dst, AVPacket *src);
3513 * @param pkt packet to free
3515 void av_free_packet(AVPacket *pkt);
3518 * Allocate new information of a packet.
3521 * @param type side information type
3522 * @param size side information size
3523 * @return pointer to fresh allocated data or NULL otherwise
3525 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3529 * Shrink the already allocated side data buffer
3532 * @param type side information type
3533 * @param size new side information size
3534 * @return 0 on success, < 0 on failure
3536 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3540 * Get side information from packet.
3543 * @param type desired side information type
3544 * @param size pointer for side information size to store (optional)
3545 * @return pointer to data if present or NULL otherwise
3547 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3550 int av_packet_merge_side_data(AVPacket *pkt);
3552 int av_packet_split_side_data(AVPacket *pkt);
3560 * @addtogroup lavc_decoding
3565 * Find a registered decoder with a matching codec ID.
3567 * @param id AVCodecID of the requested decoder
3568 * @return A decoder if one was found, NULL otherwise.
3570 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3573 * Find a registered decoder with the specified name.
3575 * @param name name of the requested decoder
3576 * @return A decoder if one was found, NULL otherwise.
3578 AVCodec *avcodec_find_decoder_by_name(const char *name);
3580 #if FF_API_GET_BUFFER
3581 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3582 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3583 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3587 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3588 * it can be called by custom get_buffer2() implementations for decoders without
3589 * CODEC_CAP_DR1 set.
3591 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3594 * Return the amount of padding in pixels which the get_buffer callback must
3595 * provide around the edge of the image for codecs which do not have the
3596 * CODEC_FLAG_EMU_EDGE flag.
3598 * @return Required padding in pixels.
3600 unsigned avcodec_get_edge_width(void);
3603 * Modify width and height values so that they will result in a memory
3604 * buffer that is acceptable for the codec if you do not use any horizontal
3607 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3608 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3609 * according to avcodec_get_edge_width() before.
3611 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3614 * Modify width and height values so that they will result in a memory
3615 * buffer that is acceptable for the codec if you also ensure that all
3616 * line sizes are a multiple of the respective linesize_align[i].
3618 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3619 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3620 * according to avcodec_get_edge_width() before.
3622 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3623 int linesize_align[AV_NUM_DATA_POINTERS]);
3625 #if FF_API_OLD_DECODE_AUDIO
3627 * Wrapper function which calls avcodec_decode_audio4.
3629 * @deprecated Use avcodec_decode_audio4 instead.
3631 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3632 * Some decoders may support multiple frames in a single AVPacket, such
3633 * decoders would then just decode the first frame. In this case,
3634 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3635 * the remaining data in order to decode the second frame etc.
3637 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3638 * decompressed frame size in bytes.
3640 * @warning You must set frame_size_ptr to the allocated size of the
3641 * output buffer before calling avcodec_decode_audio3().
3643 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3644 * the actual read bytes because some optimized bitstream readers read 32 or 64
3645 * bits at once and could read over the end.
3647 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3648 * no overreading happens for damaged MPEG streams.
3650 * @warning You must not provide a custom get_buffer() when using
3651 * avcodec_decode_audio3(). Doing so will override it with
3652 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3653 * which does allow the application to provide a custom get_buffer().
3655 * @note You might have to align the input buffer avpkt->data and output buffer
3656 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3657 * necessary at all, on others it won't work at all if not aligned and on others
3658 * it will work but it will have an impact on performance.
3660 * In practice, avpkt->data should have 4 byte alignment at minimum and
3661 * samples should be 16 byte aligned unless the CPU doesn't need it
3662 * (AltiVec and SSE do).
3664 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3665 * between input and output, these need to be fed with avpkt->data=NULL,
3666 * avpkt->size=0 at the end to return the remaining frames.
3668 * @param avctx the codec context
3669 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3670 * If the sample format is planar, each channel plane will
3671 * be the same size, with no padding between channels.
3672 * @param[in,out] frame_size_ptr the output buffer size in bytes
3673 * @param[in] avpkt The input AVPacket containing the input buffer.
3674 * You can create such packet with av_init_packet() and by then setting
3675 * data and size, some decoders might in addition need other fields.
3676 * All decoders are designed to use the least fields possible though.
3677 * @return On error a negative value is returned, otherwise the number of bytes
3678 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3680 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3681 int *frame_size_ptr,
3686 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3688 * Some decoders may support multiple frames in a single AVPacket. Such
3689 * decoders would then just decode the first frame. In this case,
3690 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3691 * the remaining data in order to decode the second frame, etc...
3692 * Even if no frames are returned, the packet needs to be fed to the decoder
3693 * with remaining data until it is completely consumed or an error occurs.
3695 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3696 * larger than the actual read bytes because some optimized bitstream
3697 * readers read 32 or 64 bits at once and could read over the end.
3699 * @note You might have to align the input buffer. The alignment requirements
3700 * depend on the CPU and the decoder.
3702 * @param avctx the codec context
3703 * @param[out] frame The AVFrame in which to store decoded audio samples.
3704 * The decoder will allocate a buffer for the decoded frame by
3705 * calling the AVCodecContext.get_buffer2() callback.
3706 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3707 * reference counted and the returned reference belongs to the
3708 * caller. The caller must release the frame using av_frame_unref()
3709 * when the frame is no longer needed. The caller may safely write
3710 * to the frame if av_frame_is_writable() returns 1.
3711 * When AVCodecContext.refcounted_frames is set to 0, the returned
3712 * reference belongs to the decoder and is valid only until the
3713 * next call to this function or until closing the decoder.
3714 * The caller may not write to it.
3715 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3717 * @param[in] avpkt The input AVPacket containing the input buffer.
3718 * At least avpkt->data and avpkt->size should be set. Some
3719 * decoders might also require additional fields to be set.
3720 * @return A negative error code is returned if an error occurred during
3721 * decoding, otherwise the number of bytes consumed from the input
3722 * AVPacket is returned.
3724 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3725 int *got_frame_ptr, const AVPacket *avpkt);
3728 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3729 * Some decoders may support multiple frames in a single AVPacket, such
3730 * decoders would then just decode the first frame.
3732 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3733 * the actual read bytes because some optimized bitstream readers read 32 or 64
3734 * bits at once and could read over the end.
3736 * @warning The end of the input buffer buf should be set to 0 to ensure that
3737 * no overreading happens for damaged MPEG streams.
3739 * @note You might have to align the input buffer avpkt->data.
3740 * The alignment requirements depend on the CPU: on some CPUs it isn't
3741 * necessary at all, on others it won't work at all if not aligned and on others
3742 * it will work but it will have an impact on performance.
3744 * In practice, avpkt->data should have 4 byte alignment at minimum.
3746 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3747 * between input and output, these need to be fed with avpkt->data=NULL,
3748 * avpkt->size=0 at the end to return the remaining frames.
3750 * @param avctx the codec context
3751 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3752 * Use av_frame_alloc() to get an AVFrame. The codec will
3753 * allocate memory for the actual bitmap by calling the
3754 * AVCodecContext.get_buffer2() callback.
3755 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3756 * reference counted and the returned reference belongs to the
3757 * caller. The caller must release the frame using av_frame_unref()
3758 * when the frame is no longer needed. The caller may safely write
3759 * to the frame if av_frame_is_writable() returns 1.
3760 * When AVCodecContext.refcounted_frames is set to 0, the returned
3761 * reference belongs to the decoder and is valid only until the
3762 * next call to this function or until closing the decoder. The
3763 * caller may not write to it.
3765 * @param[in] avpkt The input AVpacket containing the input buffer.
3766 * You can create such packet with av_init_packet() and by then setting
3767 * data and size, some decoders might in addition need other fields like
3768 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3770 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3771 * @return On error a negative value is returned, otherwise the number of bytes
3772 * used or zero if no frame could be decompressed.
3774 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3775 int *got_picture_ptr,
3776 const AVPacket *avpkt);
3779 * Decode a subtitle message.
3780 * Return a negative value on error, otherwise return the number of bytes used.
3781 * If no subtitle could be decompressed, got_sub_ptr is zero.
3782 * Otherwise, the subtitle is stored in *sub.
3783 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3784 * simplicity, because the performance difference is expect to be negligible
3785 * and reusing a get_buffer written for video codecs would probably perform badly
3786 * due to a potentially very different allocation pattern.
3788 * @param avctx the codec context
3789 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3790 freed with avsubtitle_free if *got_sub_ptr is set.
3791 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3792 * @param[in] avpkt The input AVPacket containing the input buffer.
3794 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3799 * @defgroup lavc_parsing Frame parsing
3803 enum AVPictureStructure {
3804 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3805 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3806 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3807 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3810 typedef struct AVCodecParserContext {
3812 struct AVCodecParser *parser;
3813 int64_t frame_offset; /* offset of the current frame */
3814 int64_t cur_offset; /* current offset
3815 (incremented by each av_parser_parse()) */
3816 int64_t next_frame_offset; /* offset of the next frame */
3818 int pict_type; /* XXX: Put it back in AVCodecContext. */
3820 * This field is used for proper frame duration computation in lavf.
3821 * It signals, how much longer the frame duration of the current frame
3822 * is compared to normal frame duration.
3824 * frame_duration = (1 + repeat_pict) * time_base
3826 * It is used by codecs like H.264 to display telecined material.
3828 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3829 int64_t pts; /* pts of the current frame */
3830 int64_t dts; /* dts of the current frame */
3835 int fetch_timestamp;
3837 #define AV_PARSER_PTS_NB 4
3838 int cur_frame_start_index;
3839 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3840 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3841 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3844 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3845 #define PARSER_FLAG_ONCE 0x0002
3846 /// Set if the parser has a valid file offset
3847 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3848 #define PARSER_FLAG_USE_CODEC_TS 0x1000
3850 int64_t offset; ///< byte offset from starting packet start
3851 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3854 * Set by parser to 1 for key frames and 0 for non-key frames.
3855 * It is initialized to -1, so if the parser doesn't set this flag,
3856 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3862 * Time difference in stream time base units from the pts of this
3863 * packet to the point at which the output from the decoder has converged
3864 * independent from the availability of previous frames. That is, the
3865 * frames are virtually identical no matter if decoding started from
3866 * the very first frame or from this keyframe.
3867 * Is AV_NOPTS_VALUE if unknown.
3868 * This field is not the display duration of the current frame.
3869 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3872 * The purpose of this field is to allow seeking in streams that have no
3873 * keyframes in the conventional sense. It corresponds to the
3874 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3875 * essential for some types of subtitle streams to ensure that all
3876 * subtitles are correctly displayed after seeking.
3878 int64_t convergence_duration;
3880 // Timestamp generation support:
3882 * Synchronization point for start of timestamp generation.
3884 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3887 * For example, this corresponds to presence of H.264 buffering period
3893 * Offset of the current timestamp against last timestamp sync point in
3894 * units of AVCodecContext.time_base.
3896 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3897 * contain a valid timestamp offset.
3899 * Note that the timestamp of sync point has usually a nonzero
3900 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3901 * the next frame after timestamp sync point will be usually 1.
3903 * For example, this corresponds to H.264 cpb_removal_delay.
3905 int dts_ref_dts_delta;
3908 * Presentation delay of current frame in units of AVCodecContext.time_base.
3910 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3911 * contain valid non-negative timestamp delta (presentation time of a frame
3912 * must not lie in the past).
3914 * This delay represents the difference between decoding and presentation
3915 * time of the frame.
3917 * For example, this corresponds to H.264 dpb_output_delay.
3922 * Position of the packet in file.
3924 * Analogous to cur_frame_pts/dts
3926 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3929 * Byte position of currently parsed frame in stream.
3934 * Previous frame byte position.
3939 * Duration of the current frame.
3940 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3941 * For all other types, this is in units of AVCodecContext.time_base.
3945 enum AVFieldOrder field_order;
3948 * Indicate whether a picture is coded as a frame, top field or bottom field.
3950 * For example, H.264 field_pic_flag equal to 0 corresponds to
3951 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3952 * equal to 1 and bottom_field_flag equal to 0 corresponds to
3953 * AV_PICTURE_STRUCTURE_TOP_FIELD.
3955 enum AVPictureStructure picture_structure;
3956 } AVCodecParserContext;
3958 typedef struct AVCodecParser {
3959 int codec_ids[5]; /* several codec IDs are permitted */
3961 int (*parser_init)(AVCodecParserContext *s);
3962 int (*parser_parse)(AVCodecParserContext *s,
3963 AVCodecContext *avctx,
3964 const uint8_t **poutbuf, int *poutbuf_size,
3965 const uint8_t *buf, int buf_size);
3966 void (*parser_close)(AVCodecParserContext *s);
3967 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3968 struct AVCodecParser *next;
3971 AVCodecParser *av_parser_next(AVCodecParser *c);
3973 void av_register_codec_parser(AVCodecParser *parser);
3974 AVCodecParserContext *av_parser_init(int codec_id);
3979 * @param s parser context.
3980 * @param avctx codec context.
3981 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3982 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3983 * @param buf input buffer.
3984 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3985 * @param pts input presentation timestamp.
3986 * @param dts input decoding timestamp.
3987 * @param pos input byte position in stream.
3988 * @return the number of bytes of the input bitstream used.
3993 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4000 * decode_frame(data, size);
4004 int av_parser_parse2(AVCodecParserContext *s,
4005 AVCodecContext *avctx,
4006 uint8_t **poutbuf, int *poutbuf_size,
4007 const uint8_t *buf, int buf_size,
4008 int64_t pts, int64_t dts,
4012 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4013 * @deprecated use AVBitStreamFilter
4015 int av_parser_change(AVCodecParserContext *s,
4016 AVCodecContext *avctx,
4017 uint8_t **poutbuf, int *poutbuf_size,
4018 const uint8_t *buf, int buf_size, int keyframe);
4019 void av_parser_close(AVCodecParserContext *s);
4027 * @addtogroup lavc_encoding
4032 * Find a registered encoder with a matching codec ID.
4034 * @param id AVCodecID of the requested encoder
4035 * @return An encoder if one was found, NULL otherwise.
4037 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4040 * Find a registered encoder with the specified name.
4042 * @param name name of the requested encoder
4043 * @return An encoder if one was found, NULL otherwise.
4045 AVCodec *avcodec_find_encoder_by_name(const char *name);
4047 #if FF_API_OLD_ENCODE_AUDIO
4049 * Encode an audio frame from samples into buf.
4051 * @deprecated Use avcodec_encode_audio2 instead.
4053 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4054 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4055 * will know how much space is needed because it depends on the value passed
4056 * in buf_size as described below. In that case a lower value can be used.
4058 * @param avctx the codec context
4059 * @param[out] buf the output buffer
4060 * @param[in] buf_size the output buffer size
4061 * @param[in] samples the input buffer containing the samples
4062 * The number of samples read from this buffer is frame_size*channels,
4063 * both of which are defined in avctx.
4064 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4065 * samples read from samples is equal to:
4066 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4067 * This also implies that av_get_bits_per_sample() must not return 0 for these
4069 * @return On error a negative value is returned, on success zero or the number
4070 * of bytes used to encode the data read from the input buffer.
4072 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4073 uint8_t *buf, int buf_size,
4074 const short *samples);
4078 * Encode a frame of audio.
4080 * Takes input samples from frame and writes the next output packet, if
4081 * available, to avpkt. The output packet does not necessarily contain data for
4082 * the most recent frame, as encoders can delay, split, and combine input frames
4083 * internally as needed.
4085 * @param avctx codec context
4086 * @param avpkt output AVPacket.
4087 * The user can supply an output buffer by setting
4088 * avpkt->data and avpkt->size prior to calling the
4089 * function, but if the size of the user-provided data is not
4090 * large enough, encoding will fail. If avpkt->data and
4091 * avpkt->size are set, avpkt->destruct must also be set. All
4092 * other AVPacket fields will be reset by the encoder using
4093 * av_init_packet(). If avpkt->data is NULL, the encoder will
4094 * allocate it. The encoder will set avpkt->size to the size
4095 * of the output packet.
4097 * If this function fails or produces no output, avpkt will be
4098 * freed using av_free_packet() (i.e. avpkt->destruct will be
4099 * called to free the user supplied buffer).
4100 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4101 * May be NULL when flushing an encoder that has the
4102 * CODEC_CAP_DELAY capability set.
4103 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4104 * can have any number of samples.
4105 * If it is not set, frame->nb_samples must be equal to
4106 * avctx->frame_size for all frames except the last.
4107 * The final frame may be smaller than avctx->frame_size.
4108 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4109 * output packet is non-empty, and to 0 if it is
4110 * empty. If the function returns an error, the
4111 * packet can be assumed to be invalid, and the
4112 * value of got_packet_ptr is undefined and should
4114 * @return 0 on success, negative error code on failure
4116 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4117 const AVFrame *frame, int *got_packet_ptr);
4119 #if FF_API_OLD_ENCODE_VIDEO
4121 * @deprecated use avcodec_encode_video2() instead.
4123 * Encode a video frame from pict into buf.
4124 * The input picture should be
4125 * stored using a specific format, namely avctx.pix_fmt.
4127 * @param avctx the codec context
4128 * @param[out] buf the output buffer for the bitstream of encoded frame
4129 * @param[in] buf_size the size of the output buffer in bytes
4130 * @param[in] pict the input picture to encode
4131 * @return On error a negative value is returned, on success zero or the number
4132 * of bytes used from the output buffer.
4134 attribute_deprecated
4135 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4136 const AVFrame *pict);
4140 * Encode a frame of video.
4142 * Takes input raw video data from frame and writes the next output packet, if
4143 * available, to avpkt. The output packet does not necessarily contain data for
4144 * the most recent frame, as encoders can delay and reorder input frames
4145 * internally as needed.
4147 * @param avctx codec context
4148 * @param avpkt output AVPacket.
4149 * The user can supply an output buffer by setting
4150 * avpkt->data and avpkt->size prior to calling the
4151 * function, but if the size of the user-provided data is not
4152 * large enough, encoding will fail. All other AVPacket fields
4153 * will be reset by the encoder using av_init_packet(). If
4154 * avpkt->data is NULL, the encoder will allocate it.
4155 * The encoder will set avpkt->size to the size of the
4156 * output packet. The returned data (if any) belongs to the
4157 * caller, he is responsible for freeing it.
4159 * If this function fails or produces no output, avpkt will be
4160 * freed using av_free_packet() (i.e. avpkt->destruct will be
4161 * called to free the user supplied buffer).
4162 * @param[in] frame AVFrame containing the raw video data to be encoded.
4163 * May be NULL when flushing an encoder that has the
4164 * CODEC_CAP_DELAY capability set.
4165 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4166 * output packet is non-empty, and to 0 if it is
4167 * empty. If the function returns an error, the
4168 * packet can be assumed to be invalid, and the
4169 * value of got_packet_ptr is undefined and should
4171 * @return 0 on success, negative error code on failure
4173 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4174 const AVFrame *frame, int *got_packet_ptr);
4176 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4177 const AVSubtitle *sub);
4184 #if FF_API_AVCODEC_RESAMPLE
4186 * @defgroup lavc_resample Audio resampling
4188 * @deprecated use libswresample instead
4192 struct ReSampleContext;
4193 struct AVResampleContext;
4195 typedef struct ReSampleContext ReSampleContext;
4198 * Initialize audio resampling context.
4200 * @param output_channels number of output channels
4201 * @param input_channels number of input channels
4202 * @param output_rate output sample rate
4203 * @param input_rate input sample rate
4204 * @param sample_fmt_out requested output sample format
4205 * @param sample_fmt_in input sample format
4206 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4207 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4208 * @param linear if 1 then the used FIR filter will be linearly interpolated
4209 between the 2 closest, if 0 the closest will be used
4210 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4211 * @return allocated ReSampleContext, NULL if error occurred
4213 attribute_deprecated
4214 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4215 int output_rate, int input_rate,
4216 enum AVSampleFormat sample_fmt_out,
4217 enum AVSampleFormat sample_fmt_in,
4218 int filter_length, int log2_phase_count,
4219 int linear, double cutoff);
4221 attribute_deprecated
4222 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4225 * Free resample context.
4227 * @param s a non-NULL pointer to a resample context previously
4228 * created with av_audio_resample_init()
4230 attribute_deprecated
4231 void audio_resample_close(ReSampleContext *s);
4235 * Initialize an audio resampler.
4236 * Note, if either rate is not an integer then simply scale both rates up so they are.
4237 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4238 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4239 * @param linear If 1 then the used FIR filter will be linearly interpolated
4240 between the 2 closest, if 0 the closest will be used
4241 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4243 attribute_deprecated
4244 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4247 * Resample an array of samples using a previously configured context.
4248 * @param src an array of unconsumed samples
4249 * @param consumed the number of samples of src which have been consumed are returned here
4250 * @param src_size the number of unconsumed samples available
4251 * @param dst_size the amount of space in samples available in dst
4252 * @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.
4253 * @return the number of samples written in dst or -1 if an error occurred
4255 attribute_deprecated
4256 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4260 * Compensate samplerate/timestamp drift. The compensation is done by changing
4261 * the resampler parameters, so no audible clicks or similar distortions occur
4262 * @param compensation_distance distance in output samples over which the compensation should be performed
4263 * @param sample_delta number of output samples which should be output less
4265 * example: av_resample_compensate(c, 10, 500)
4266 * here instead of 510 samples only 500 samples would be output
4268 * note, due to rounding the actual compensation might be slightly different,
4269 * especially if the compensation_distance is large and the in_rate used during init is small
4271 attribute_deprecated
4272 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4273 attribute_deprecated
4274 void av_resample_close(struct AVResampleContext *c);
4282 * @addtogroup lavc_picture
4287 * Allocate memory for a picture. Call avpicture_free() to free it.
4289 * @see avpicture_fill()
4291 * @param picture the picture to be filled in
4292 * @param pix_fmt the format of the picture
4293 * @param width the width of the picture
4294 * @param height the height of the picture
4295 * @return zero if successful, a negative value if not
4297 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4300 * Free a picture previously allocated by avpicture_alloc().
4301 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4304 * @param picture the AVPicture to be freed
4306 void avpicture_free(AVPicture *picture);
4309 * Fill in the AVPicture fields, always assume a linesize alignment of
4312 * @see av_image_fill_arrays()
4314 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4315 enum AVPixelFormat pix_fmt, int width, int height);
4318 * Copy pixel data from an AVPicture into a buffer, always assume a
4319 * linesize alignment of 1.
4321 * @see av_image_copy_to_buffer()
4323 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4324 int width, int height,
4325 unsigned char *dest, int dest_size);
4328 * Calculate the size in bytes that a picture of the given width and height
4329 * would occupy if stored in the given picture format.
4330 * Always assume a linesize alignment of 1.
4332 * @see av_image_get_buffer_size().
4334 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4336 #if FF_API_DEINTERLACE
4338 * deinterlace - if not supported return -1
4340 * @deprecated - use yadif (in libavfilter) instead
4342 attribute_deprecated
4343 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4344 enum AVPixelFormat pix_fmt, int width, int height);
4347 * Copy image src to dst. Wraps av_image_copy().
4349 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4350 enum AVPixelFormat pix_fmt, int width, int height);
4353 * Crop image top and left side.
4355 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4356 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4361 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4362 int padtop, int padbottom, int padleft, int padright, int *color);
4369 * @defgroup lavc_misc Utility functions
4372 * Miscellaneous utility functions related to both encoding and decoding
4378 * @defgroup lavc_misc_pixfmt Pixel formats
4380 * Functions for working with pixel formats.
4385 * Utility function to access log2_chroma_w log2_chroma_h from
4386 * the pixel format AVPixFmtDescriptor.
4388 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4389 * for one that returns a failure code and continues in case of invalid
4392 * @param[in] pix_fmt the pixel format
4393 * @param[out] h_shift store log2_chroma_w
4394 * @param[out] v_shift store log2_chroma_h
4396 * @see av_pix_fmt_get_chroma_sub_sample
4399 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4402 * Return a value representing the fourCC code associated to the
4403 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4406 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4408 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4409 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4410 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4411 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4412 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4413 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4416 * Compute what kind of losses will occur when converting from one specific
4417 * pixel format to another.
4418 * When converting from one pixel format to another, information loss may occur.
4419 * For example, when converting from RGB24 to GRAY, the color information will
4420 * be lost. Similarly, other losses occur when converting from some formats to
4421 * other formats. These losses can involve loss of chroma, but also loss of
4422 * resolution, loss of color depth, loss due to the color space conversion, loss
4423 * of the alpha bits or loss due to color quantization.
4424 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4425 * which will occur when converting from one pixel format to another.
4427 * @param[in] dst_pix_fmt destination pixel format
4428 * @param[in] src_pix_fmt source pixel format
4429 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4430 * @return Combination of flags informing you what kind of losses will occur
4431 * (maximum loss for an invalid dst_pix_fmt).
4433 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4437 * Find the best pixel format to convert to given a certain source pixel
4438 * format. When converting from one pixel format to another, information loss
4439 * may occur. For example, when converting from RGB24 to GRAY, the color
4440 * information will be lost. Similarly, other losses occur when converting from
4441 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4442 * the given pixel formats should be used to suffer the least amount of loss.
4443 * The pixel formats from which it chooses one, are determined by the
4444 * pix_fmt_list parameter.
4447 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4448 * @param[in] src_pix_fmt source pixel format
4449 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4450 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4451 * @return The best pixel format to convert to or -1 if none was found.
4453 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(enum AVPixelFormat *pix_fmt_list,
4454 enum AVPixelFormat src_pix_fmt,
4455 int has_alpha, int *loss_ptr);
4458 * Find the best pixel format to convert to given a certain source pixel
4459 * format and a selection of two destination pixel formats. When converting from
4460 * one pixel format to another, information loss may occur. For example, when converting
4461 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4462 * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4463 * the given pixel formats should be used to suffer the least amount of loss.
4465 * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be
4469 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4470 * dst_pix_fmt1= AV_PIX_FMT_RGB24;
4471 * dst_pix_fmt2= AV_PIX_FMT_GRAY8;
4472 * dst_pix_fmt3= AV_PIX_FMT_RGB8;
4473 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4474 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4475 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4478 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4479 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4480 * @param[in] src_pix_fmt Source pixel format
4481 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4482 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4483 * NULL or value of zero means we care about all losses. Out: the loss
4484 * that occurs when converting from src to selected dst pixel format.
4485 * @return The best pixel format to convert to or -1 if none was found.
4487 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4488 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4490 attribute_deprecated
4491 #if AV_HAVE_INCOMPATIBLE_FORK_ABI
4492 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4493 enum AVPixelFormat src_pix_fmt,
4494 int has_alpha, int *loss_ptr);
4496 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4497 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4501 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4507 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4510 * Put a string representing the codec tag codec_tag in buf.
4512 * @param buf_size size in bytes of buf
4513 * @return the length of the string that would have been generated if
4514 * enough space had been available, excluding the trailing null
4516 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4518 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4521 * Return a name for the specified profile, if available.
4523 * @param codec the codec that is searched for the given profile
4524 * @param profile the profile value for which a name is requested
4525 * @return A name for the profile if found, NULL otherwise.
4527 const char *av_get_profile_name(const AVCodec *codec, int profile);
4529 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4530 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4531 //FIXME func typedef
4534 * Fill AVFrame audio data and linesize pointers.
4536 * The buffer buf must be a preallocated buffer with a size big enough
4537 * to contain the specified samples amount. The filled AVFrame data
4538 * pointers will point to this buffer.
4540 * AVFrame extended_data channel pointers are allocated if necessary for
4543 * @param frame the AVFrame
4544 * frame->nb_samples must be set prior to calling the
4545 * function. This function fills in frame->data,
4546 * frame->extended_data, frame->linesize[0].
4547 * @param nb_channels channel count
4548 * @param sample_fmt sample format
4549 * @param buf buffer to use for frame data
4550 * @param buf_size size of buffer
4551 * @param align plane size sample alignment (0 = default)
4552 * @return >=0 on success, negative error code on failure
4553 * @todo return the size in bytes required to store the samples in
4554 * case of success, at the next libavutil bump
4556 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4557 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4558 int buf_size, int align);
4561 * Flush buffers, should be called when seeking or when switching to a different stream.
4563 void avcodec_flush_buffers(AVCodecContext *avctx);
4566 * Return codec bits per sample.
4568 * @param[in] codec_id the codec
4569 * @return Number of bits per sample or zero if unknown for the given codec.
4571 int av_get_bits_per_sample(enum AVCodecID codec_id);
4574 * Return the PCM codec associated with a sample format.
4575 * @param be endianness, 0 for little, 1 for big,
4576 * -1 (or anything else) for native
4577 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4579 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4582 * Return codec bits per sample.
4583 * Only return non-zero if the bits per sample is exactly correct, not an
4586 * @param[in] codec_id the codec
4587 * @return Number of bits per sample or zero if unknown for the given codec.
4589 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4592 * Return audio frame duration.
4594 * @param avctx codec context
4595 * @param frame_bytes size of the frame, or 0 if unknown
4596 * @return frame duration, in samples, if known. 0 if not able to
4599 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4602 typedef struct AVBitStreamFilterContext {
4604 struct AVBitStreamFilter *filter;
4605 AVCodecParserContext *parser;
4606 struct AVBitStreamFilterContext *next;
4607 } AVBitStreamFilterContext;
4610 typedef struct AVBitStreamFilter {
4613 int (*filter)(AVBitStreamFilterContext *bsfc,
4614 AVCodecContext *avctx, const char *args,
4615 uint8_t **poutbuf, int *poutbuf_size,
4616 const uint8_t *buf, int buf_size, int keyframe);
4617 void (*close)(AVBitStreamFilterContext *bsfc);
4618 struct AVBitStreamFilter *next;
4619 } AVBitStreamFilter;
4621 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4622 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4623 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4624 AVCodecContext *avctx, const char *args,
4625 uint8_t **poutbuf, int *poutbuf_size,
4626 const uint8_t *buf, int buf_size, int keyframe);
4627 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4629 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4634 * Reallocate the given block if it is not large enough, otherwise do nothing.
4638 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4641 * Allocate a buffer, reusing the given one if large enough.
4643 * Contrary to av_fast_realloc the current buffer contents might not be
4644 * preserved and on error the old buffer is freed, thus no special
4645 * handling to avoid memleaks is necessary.
4647 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4648 * @param size size of the buffer *ptr points to
4649 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4650 * *size 0 if an error occurred.
4652 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4655 * Same behaviour av_fast_malloc but the buffer has additional
4656 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will will always be 0.
4658 * In addition the whole buffer will initially and after resizes
4659 * be 0-initialized so that no uninitialized data will ever appear.
4661 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4664 * Same behaviour av_fast_padded_malloc except that buffer will always
4665 * be 0-initialized after call.
4667 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4670 * Encode extradata length to a buffer. Used by xiph codecs.
4672 * @param s buffer to write to; must be at least (v/255+1) bytes long
4673 * @param v size of extradata in bytes
4674 * @return number of bytes written to the buffer.
4676 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4678 #if FF_API_MISSING_SAMPLE
4680 * Log a generic warning message about a missing feature. This function is
4681 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4682 * only, and would normally not be used by applications.
4683 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4684 * a pointer to an AVClass struct
4685 * @param[in] feature string containing the name of the missing feature
4686 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4687 * If want_sample is non-zero, additional verbage will be added to the log
4688 * message which tells the user how to report samples to the development
4690 * @deprecated Use avpriv_report_missing_feature() instead.
4692 attribute_deprecated
4693 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4696 * Log a generic warning message asking for a sample. This function is
4697 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4698 * only, and would normally not be used by applications.
4699 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4700 * a pointer to an AVClass struct
4701 * @param[in] msg string containing an optional message, or NULL if no message
4702 * @deprecated Use avpriv_request_sample() instead.
4704 attribute_deprecated
4705 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4706 #endif /* FF_API_MISSING_SAMPLE */
4709 * Register the hardware accelerator hwaccel.
4711 void av_register_hwaccel(AVHWAccel *hwaccel);
4714 * If hwaccel is NULL, returns the first registered hardware accelerator,
4715 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4716 * after hwaccel, or NULL if hwaccel is the last one.
4718 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4722 * Lock operation used by lockmgr
4725 AV_LOCK_CREATE, ///< Create a mutex
4726 AV_LOCK_OBTAIN, ///< Lock the mutex
4727 AV_LOCK_RELEASE, ///< Unlock the mutex
4728 AV_LOCK_DESTROY, ///< Free mutex resources
4732 * Register a user provided lock manager supporting the operations
4733 * specified by AVLockOp. mutex points to a (void *) where the
4734 * lockmgr should store/get a pointer to a user allocated mutex. It's
4735 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4737 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4738 * callback during the call to av_lockmgr_register().
4739 * Thus, the application must be prepared to handle that.
4740 * If cb is set to NULL the lockmgr will be unregistered.
4741 * Also note that during unregistration the previously registered
4742 * lockmgr callback may also be invoked.
4744 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4747 * Get the type of the given codec.
4749 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4752 * Get the name of a codec.
4753 * @return a static string identifying the codec; never NULL
4755 const char *avcodec_get_name(enum AVCodecID id);
4758 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4759 * with no corresponding avcodec_close()), 0 otherwise.
4761 int avcodec_is_open(AVCodecContext *s);
4764 * @return a non-zero number if codec is an encoder, zero otherwise
4766 int av_codec_is_encoder(const AVCodec *codec);
4769 * @return a non-zero number if codec is a decoder, zero otherwise
4771 int av_codec_is_decoder(const AVCodec *codec);
4774 * @return descriptor for given codec ID or NULL if no descriptor exists.
4776 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4779 * Iterate over all codec descriptors known to libavcodec.
4781 * @param prev previous descriptor. NULL to get the first descriptor.
4783 * @return next descriptor or NULL after the last descriptor
4785 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4788 * @return codec descriptor with the given name or NULL if no such descriptor
4791 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4797 #endif /* AVCODEC_AVCODEC_H */