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,
276 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
277 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
278 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
279 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
280 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
282 AV_CODEC_ID_012V = MKBETAG('0','1','2','V'),
283 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
284 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
285 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
286 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
287 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
288 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
289 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
290 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
291 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
292 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
293 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
294 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
295 AV_CODEC_ID_SGIRLE = MKBETAG('S','G','I','R'),
296 AV_CODEC_ID_MVC1 = MKBETAG('M','V','C','1'),
297 AV_CODEC_ID_MVC2 = MKBETAG('M','V','C','2'),
298 AV_CODEC_ID_SNOW = MKBETAG('S','N','O','W'),
299 AV_CODEC_ID_WEBP = MKBETAG('W','E','B','P'),
301 /* various PCM "codecs" */
302 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
303 AV_CODEC_ID_PCM_S16LE = 0x10000,
304 AV_CODEC_ID_PCM_S16BE,
305 AV_CODEC_ID_PCM_U16LE,
306 AV_CODEC_ID_PCM_U16BE,
309 AV_CODEC_ID_PCM_MULAW,
310 AV_CODEC_ID_PCM_ALAW,
311 AV_CODEC_ID_PCM_S32LE,
312 AV_CODEC_ID_PCM_S32BE,
313 AV_CODEC_ID_PCM_U32LE,
314 AV_CODEC_ID_PCM_U32BE,
315 AV_CODEC_ID_PCM_S24LE,
316 AV_CODEC_ID_PCM_S24BE,
317 AV_CODEC_ID_PCM_U24LE,
318 AV_CODEC_ID_PCM_U24BE,
319 AV_CODEC_ID_PCM_S24DAUD,
320 AV_CODEC_ID_PCM_ZORK,
321 AV_CODEC_ID_PCM_S16LE_PLANAR,
323 AV_CODEC_ID_PCM_F32BE,
324 AV_CODEC_ID_PCM_F32LE,
325 AV_CODEC_ID_PCM_F64BE,
326 AV_CODEC_ID_PCM_F64LE,
327 AV_CODEC_ID_PCM_BLURAY,
330 AV_CODEC_ID_PCM_S8_PLANAR,
331 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
332 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
333 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
335 /* various ADPCM codecs */
336 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
337 AV_CODEC_ID_ADPCM_IMA_WAV,
338 AV_CODEC_ID_ADPCM_IMA_DK3,
339 AV_CODEC_ID_ADPCM_IMA_DK4,
340 AV_CODEC_ID_ADPCM_IMA_WS,
341 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
342 AV_CODEC_ID_ADPCM_MS,
343 AV_CODEC_ID_ADPCM_4XM,
344 AV_CODEC_ID_ADPCM_XA,
345 AV_CODEC_ID_ADPCM_ADX,
346 AV_CODEC_ID_ADPCM_EA,
347 AV_CODEC_ID_ADPCM_G726,
348 AV_CODEC_ID_ADPCM_CT,
349 AV_CODEC_ID_ADPCM_SWF,
350 AV_CODEC_ID_ADPCM_YAMAHA,
351 AV_CODEC_ID_ADPCM_SBPRO_4,
352 AV_CODEC_ID_ADPCM_SBPRO_3,
353 AV_CODEC_ID_ADPCM_SBPRO_2,
354 AV_CODEC_ID_ADPCM_THP,
355 AV_CODEC_ID_ADPCM_IMA_AMV,
356 AV_CODEC_ID_ADPCM_EA_R1,
357 AV_CODEC_ID_ADPCM_EA_R3,
358 AV_CODEC_ID_ADPCM_EA_R2,
359 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
360 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
361 AV_CODEC_ID_ADPCM_EA_XAS,
362 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
363 AV_CODEC_ID_ADPCM_IMA_ISS,
364 AV_CODEC_ID_ADPCM_G722,
365 AV_CODEC_ID_ADPCM_IMA_APC,
366 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
367 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
368 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
369 AV_CODEC_ID_ADPCM_DTK = MKBETAG('D','T','K',' '),
370 AV_CODEC_ID_ADPCM_IMA_RAD = MKBETAG('R','A','D',' '),
373 AV_CODEC_ID_AMR_NB = 0x12000,
376 /* RealAudio codecs*/
377 AV_CODEC_ID_RA_144 = 0x13000,
380 /* various DPCM codecs */
381 AV_CODEC_ID_ROQ_DPCM = 0x14000,
382 AV_CODEC_ID_INTERPLAY_DPCM,
383 AV_CODEC_ID_XAN_DPCM,
384 AV_CODEC_ID_SOL_DPCM,
387 AV_CODEC_ID_MP2 = 0x15000,
388 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
398 AV_CODEC_ID_VMDAUDIO,
404 AV_CODEC_ID_WESTWOOD_SND1,
405 AV_CODEC_ID_GSM, ///< as in Berlin toast format
408 AV_CODEC_ID_TRUESPEECH,
410 AV_CODEC_ID_SMACKAUDIO,
413 AV_CODEC_ID_DSICINAUDIO,
415 AV_CODEC_ID_MUSEPACK7,
417 AV_CODEC_ID_GSM_MS, /* as found in WAV */
421 AV_CODEC_ID_NELLYMOSER,
422 AV_CODEC_ID_MUSEPACK8,
424 AV_CODEC_ID_WMAVOICE,
426 AV_CODEC_ID_WMALOSSLESS,
435 AV_CODEC_ID_BINKAUDIO_RDFT,
436 AV_CODEC_ID_BINKAUDIO_DCT,
437 AV_CODEC_ID_AAC_LATM,
442 AV_CODEC_ID_8SVX_EXP,
443 AV_CODEC_ID_8SVX_FIB,
444 AV_CODEC_ID_BMV_AUDIO,
448 AV_CODEC_ID_OPUS_DEPRECATED,
449 AV_CODEC_ID_COMFORT_NOISE,
450 AV_CODEC_ID_TAK_DEPRECATED,
451 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
452 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
453 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
454 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
455 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
456 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
457 AV_CODEC_ID_EVRC = MKBETAG('s','e','v','c'),
458 AV_CODEC_ID_SMV = MKBETAG('s','s','m','v'),
460 /* subtitle codecs */
461 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
462 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
463 AV_CODEC_ID_DVB_SUBTITLE,
464 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
467 AV_CODEC_ID_MOV_TEXT,
468 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
469 AV_CODEC_ID_DVB_TELETEXT,
471 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
472 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
473 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
474 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
475 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
476 AV_CODEC_ID_SUBVIEWER1 = MKBETAG('S','b','V','1'),
477 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
478 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
479 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
480 AV_CODEC_ID_MPL2 = MKBETAG('M','P','L','2'),
481 AV_CODEC_ID_VPLAYER = MKBETAG('V','P','l','r'),
482 AV_CODEC_ID_PJS = MKBETAG('P','h','J','S'),
483 AV_CODEC_ID_ASS = MKBETAG('A','S','S',' '), ///< ASS as defined in Matroska
485 /* other specific kind of codecs (generally used for attachments) */
486 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
487 AV_CODEC_ID_TTF = 0x18000,
488 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
489 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
490 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
491 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
492 AV_CODEC_ID_SMPTE_KLV = MKBETAG('K','L','V','A'),
493 AV_CODEC_ID_DVD_NAV = MKBETAG('D','N','A','V'),
496 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
498 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
499 * stream (only used by libavformat) */
500 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
501 * stream (only used by libavformat) */
502 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
505 #include "old_codec_ids.h"
510 * This struct describes the properties of a single codec described by an
512 * @see avcodec_get_descriptor()
514 typedef struct AVCodecDescriptor {
516 enum AVMediaType type;
518 * Name of the codec described by this descriptor. It is non-empty and
519 * unique for each codec descriptor. It should contain alphanumeric
520 * characters and '_' only.
524 * A more descriptive name for this codec. May be NULL.
526 const char *long_name;
528 * Codec properties, a combination of AV_CODEC_PROP_* flags.
534 * Codec uses only intra compression.
537 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
539 * Codec supports lossy compression. Audio and video codecs only.
540 * @note a codec may support both lossy and lossless
543 #define AV_CODEC_PROP_LOSSY (1 << 1)
545 * Codec supports lossless compression. Audio and video codecs only.
547 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
549 * Subtitle codec is bitmap based
550 * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
552 #define AV_CODEC_PROP_BITMAP_SUB (1 << 16)
554 * Subtitle codec is text based.
555 * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
557 #define AV_CODEC_PROP_TEXT_SUB (1 << 17)
560 * @ingroup lavc_decoding
561 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
562 * This is mainly needed because some optimized bitstream readers read
563 * 32 or 64 bit at once and could read over the end.<br>
564 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
565 * MPEG bitstreams could cause overread and segfault.
567 #define FF_INPUT_BUFFER_PADDING_SIZE 16
570 * @ingroup lavc_encoding
571 * minimum encoding buffer size
572 * Used to avoid some checks during header writing.
574 #define FF_MIN_BUFFER_SIZE 16384
578 * @ingroup lavc_encoding
579 * motion estimation type.
582 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
586 ME_EPZS, ///< enhanced predictive zonal search
587 ME_X1, ///< reserved for experiments
588 ME_HEX, ///< hexagon based search
589 ME_UMH, ///< uneven multi-hexagon search
590 ME_TESA, ///< transformed exhaustive search algorithm
591 ME_ITER=50, ///< iterative search
595 * @ingroup lavc_decoding
598 /* We leave some space between them for extensions (drop some
599 * keyframes for intra-only or drop just some bidir frames). */
600 AVDISCARD_NONE =-16, ///< discard nothing
601 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
602 AVDISCARD_NONREF = 8, ///< discard all non reference
603 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
604 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
605 AVDISCARD_ALL = 48, ///< discard all
608 enum AVColorPrimaries{
609 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
610 AVCOL_PRI_UNSPECIFIED = 2,
611 AVCOL_PRI_BT470M = 4,
612 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
613 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
614 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
616 AVCOL_PRI_NB , ///< Not part of ABI
619 enum AVColorTransferCharacteristic{
620 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
621 AVCOL_TRC_UNSPECIFIED = 2,
622 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
623 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
624 AVCOL_TRC_SMPTE240M = 7,
625 AVCOL_TRC_NB , ///< Not part of ABI
630 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
631 AVCOL_SPC_UNSPECIFIED = 2,
633 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
634 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
635 AVCOL_SPC_SMPTE240M = 7,
636 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
637 AVCOL_SPC_NB , ///< Not part of ABI
639 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
642 AVCOL_RANGE_UNSPECIFIED = 0,
643 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
644 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
645 AVCOL_RANGE_NB , ///< Not part of ABI
649 * X X 3 4 X X are luma samples,
650 * 1 2 1-6 are possible chroma positions
651 * X X 5 6 X 0 is undefined/unknown position
653 enum AVChromaLocation{
654 AVCHROMA_LOC_UNSPECIFIED = 0,
655 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
656 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
657 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
658 AVCHROMA_LOC_TOP = 4,
659 AVCHROMA_LOC_BOTTOMLEFT = 5,
660 AVCHROMA_LOC_BOTTOM = 6,
661 AVCHROMA_LOC_NB , ///< Not part of ABI
664 enum AVAudioServiceType {
665 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
666 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
667 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
668 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
669 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
670 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
671 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
672 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
673 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
674 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
678 * @ingroup lavc_encoding
680 typedef struct RcOverride{
683 int qscale; // If this is 0 then quality_factor will be used instead.
684 float quality_factor;
687 #define FF_MAX_B_FRAMES 16
690 These flags can be passed in AVCodecContext.flags before initialization.
691 Note: Not everything is supported yet.
695 * Allow decoders to produce frames with data planes that are not aligned
696 * to CPU requirements (e.g. due to cropping).
698 #define CODEC_FLAG_UNALIGNED 0x0001
699 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
700 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
701 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
702 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
703 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
705 * The parent program guarantees that the input for B-frames containing
706 * streams is not written to for at least s->max_b_frames+1 frames, if
707 * this is not set the input will be copied.
709 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
710 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
711 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
712 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
713 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
714 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
715 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
716 location instead of only at frame boundaries. */
717 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
718 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
719 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
720 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
721 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
722 /* Fx : Flag for h263+ extra options */
723 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
724 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
725 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
726 #define CODEC_FLAG_CLOSED_GOP 0x80000000
727 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
728 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
729 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
730 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
731 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
733 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
734 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
736 /* Unsupported options :
737 * Syntax Arithmetic coding (SAC)
738 * Reference Picture Selection
739 * Independent Segment Decoding */
741 /* codec capabilities */
743 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
745 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
746 * If not set, it might not use get_buffer() at all or use operations that
747 * assume the buffer was allocated by avcodec_default_get_buffer.
749 #define CODEC_CAP_DR1 0x0002
750 #define CODEC_CAP_TRUNCATED 0x0008
751 /* Codec can export data for HW decoding (XvMC). */
752 #define CODEC_CAP_HWACCEL 0x0010
754 * Encoder or decoder requires flushing with NULL input at the end in order to
755 * give the complete and correct output.
757 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
758 * with NULL data. The user can still send NULL data to the public encode
759 * or decode function, but libavcodec will not pass it along to the codec
760 * unless this flag is set.
763 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
764 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
768 * The encoder needs to be fed with NULL data at the end of encoding until the
769 * encoder no longer returns data.
771 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
772 * flag also means that the encoder must set the pts and duration for
773 * each output packet. If this flag is not set, the pts and duration will
774 * be determined by libavcodec from the input frame.
776 #define CODEC_CAP_DELAY 0x0020
778 * Codec can be fed a final frame with a smaller size.
779 * This can be used to prevent truncation of the last audio samples.
781 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
783 * Codec can export data for HW decoding (VDPAU).
785 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
787 * Codec can output multiple frames per AVPacket
788 * Normally demuxers return one frame at a time, demuxers which do not do
789 * are connected to a parser to split what they return into proper frames.
790 * This flag is reserved to the very rare category of codecs which have a
791 * bitstream that cannot be split into frames without timeconsuming
792 * operations like full decoding. Demuxers carring such bitstreams thus
793 * may return multiple frames in a packet. This has many disadvantages like
794 * prohibiting stream copy in many cases thus it should only be considered
797 #define CODEC_CAP_SUBFRAMES 0x0100
799 * Codec is experimental and is thus avoided in favor of non experimental
802 #define CODEC_CAP_EXPERIMENTAL 0x0200
804 * Codec should fill in channel configuration and samplerate instead of container
806 #define CODEC_CAP_CHANNEL_CONF 0x0400
809 * Codec is able to deal with negative linesizes
811 #define CODEC_CAP_NEG_LINESIZES 0x0800
814 * Codec supports frame-level multithreading.
816 #define CODEC_CAP_FRAME_THREADS 0x1000
818 * Codec supports slice-based (or partition-based) multithreading.
820 #define CODEC_CAP_SLICE_THREADS 0x2000
822 * Codec supports changed parameters at any point.
824 #define CODEC_CAP_PARAM_CHANGE 0x4000
826 * Codec supports avctx->thread_count == 0 (auto).
828 #define CODEC_CAP_AUTO_THREADS 0x8000
830 * Audio encoder supports receiving a different number of samples in each call.
832 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
834 * Codec is intra only.
836 #define CODEC_CAP_INTRA_ONLY 0x40000000
840 #define CODEC_CAP_LOSSLESS 0x80000000
842 //The following defines may change, don't expect compatibility if you use them.
843 #define MB_TYPE_INTRA4x4 0x0001
844 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
845 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
846 #define MB_TYPE_16x16 0x0008
847 #define MB_TYPE_16x8 0x0010
848 #define MB_TYPE_8x16 0x0020
849 #define MB_TYPE_8x8 0x0040
850 #define MB_TYPE_INTERLACED 0x0080
851 #define MB_TYPE_DIRECT2 0x0100 //FIXME
852 #define MB_TYPE_ACPRED 0x0200
853 #define MB_TYPE_GMC 0x0400
854 #define MB_TYPE_SKIP 0x0800
855 #define MB_TYPE_P0L0 0x1000
856 #define MB_TYPE_P1L0 0x2000
857 #define MB_TYPE_P0L1 0x4000
858 #define MB_TYPE_P1L1 0x8000
859 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
860 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
861 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
862 #define MB_TYPE_QUANT 0x00010000
863 #define MB_TYPE_CBP 0x00020000
864 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
868 * This specifies the area which should be displayed.
869 * Note there may be multiple such areas for one frame.
871 typedef struct AVPanScan{
874 * - encoding: Set by user.
875 * - decoding: Set by libavcodec.
880 * width and height in 1/16 pel
881 * - encoding: Set by user.
882 * - decoding: Set by libavcodec.
888 * position of the top left corner in 1/16 pel for up to 3 fields/frames
889 * - encoding: Set by user.
890 * - decoding: Set by libavcodec.
892 int16_t position[3][2];
895 #define FF_QSCALE_TYPE_MPEG1 0
896 #define FF_QSCALE_TYPE_MPEG2 1
897 #define FF_QSCALE_TYPE_H264 2
898 #define FF_QSCALE_TYPE_VP56 3
900 #if FF_API_GET_BUFFER
901 #define FF_BUFFER_TYPE_INTERNAL 1
902 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
903 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
904 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
906 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
907 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
908 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
909 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
913 * The decoder will keep a reference to the frame and may reuse it later.
915 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
918 * @defgroup lavc_packet AVPacket
920 * Types and functions for working with AVPacket.
923 enum AVPacketSideDataType {
925 AV_PKT_DATA_NEW_EXTRADATA,
928 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
931 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
932 * s32le channel_count
933 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
934 * u64le channel_layout
935 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
937 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
942 AV_PKT_DATA_PARAM_CHANGE,
945 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
946 * structures with info about macroblocks relevant to splitting the
947 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
948 * That is, it does not necessarily contain info about all macroblocks,
949 * as long as the distance between macroblocks in the info is smaller
950 * than the target payload size.
951 * Each MB info structure is 12 bytes, and is laid out as follows:
953 * u32le bit offset from the start of the packet
954 * u8 current quantizer at the start of the macroblock
956 * u16le macroblock address within the GOB
957 * u8 horizontal MV predictor
958 * u8 vertical MV predictor
959 * u8 horizontal MV predictor for block number 3
960 * u8 vertical MV predictor for block number 3
963 AV_PKT_DATA_H263_MB_INFO,
966 * Recommmends skipping the specified number of samples
968 * u32le number of samples to skip from start of this packet
969 * u32le number of samples to skip from end of this packet
970 * u8 reason for start skip
971 * u8 reason for end skip (0=padding silence, 1=convergence)
974 AV_PKT_DATA_SKIP_SAMPLES=70,
977 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
978 * the packet may contain "dual mono" audio specific to Japanese DTV
979 * and if it is true, recommends only the selected channel to be used.
981 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
984 AV_PKT_DATA_JP_DUALMONO,
987 * A list of zero terminated key/value strings. There is no end marker for
988 * the list, so it is required to rely on the side data size to stop.
990 AV_PKT_DATA_STRINGS_METADATA,
993 * Subtitle event position
1001 AV_PKT_DATA_SUBTITLE_POSITION,
1004 * Data found in BlockAdditional element of matroska container. There is
1005 * no end marker for the data, so it is required to rely on the side data
1006 * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1009 AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1013 * This structure stores compressed data. It is typically exported by demuxers
1014 * and then passed as input to decoders, or received as output from encoders and
1015 * then passed to muxers.
1017 * For video, it should typically contain one compressed frame. For audio it may
1018 * contain several compressed frames.
1020 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1021 * ABI. Thus it may be allocated on stack and no new fields can be added to it
1022 * without libavcodec and libavformat major bump.
1024 * The semantics of data ownership depends on the buf or destruct (deprecated)
1025 * fields. If either is set, the packet data is dynamically allocated and is
1026 * valid indefinitely until av_free_packet() is called (which in turn calls
1027 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
1028 * the packet data is typically backed by some static buffer somewhere and is
1029 * only valid for a limited time (e.g. until the next read call when demuxing).
1031 * The side data is always allocated with av_malloc() and is freed in
1034 typedef struct AVPacket {
1036 * A reference to the reference-counted buffer where the packet data is
1038 * May be NULL, then the packet data is not reference-counted.
1042 * Presentation timestamp in AVStream->time_base units; the time at which
1043 * the decompressed packet will be presented to the user.
1044 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1045 * pts MUST be larger or equal to dts as presentation cannot happen before
1046 * decompression, unless one wants to view hex dumps. Some formats misuse
1047 * the terms dts and pts/cts to mean something different. Such timestamps
1048 * must be converted to true pts/dts before they are stored in AVPacket.
1052 * Decompression timestamp in AVStream->time_base units; the time at which
1053 * the packet is decompressed.
1054 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1061 * A combination of AV_PKT_FLAG values
1065 * Additional packet data that can be provided by the container.
1066 * Packet can contain several types of side information.
1071 enum AVPacketSideDataType type;
1073 int side_data_elems;
1076 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1077 * Equals next_pts - this_pts in presentation order.
1080 #if FF_API_DESTRUCT_PACKET
1081 attribute_deprecated
1082 void (*destruct)(struct AVPacket *);
1083 attribute_deprecated
1086 int64_t pos; ///< byte position in stream, -1 if unknown
1089 * Time difference in AVStream->time_base units from the pts of this
1090 * packet to the point at which the output from the decoder has converged
1091 * independent from the availability of previous frames. That is, the
1092 * frames are virtually identical no matter if decoding started from
1093 * the very first frame or from this keyframe.
1094 * Is AV_NOPTS_VALUE if unknown.
1095 * This field is not the display duration of the current packet.
1096 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1099 * The purpose of this field is to allow seeking in streams that have no
1100 * keyframes in the conventional sense. It corresponds to the
1101 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1102 * essential for some types of subtitle streams to ensure that all
1103 * subtitles are correctly displayed after seeking.
1105 int64_t convergence_duration;
1107 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1108 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1110 enum AVSideDataParamChangeFlags {
1111 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1112 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1113 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1114 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1120 struct AVCodecInternal;
1124 AV_FIELD_PROGRESSIVE,
1125 AV_FIELD_TT, //< Top coded_first, top displayed first
1126 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1127 AV_FIELD_TB, //< Top coded first, bottom displayed first
1128 AV_FIELD_BT, //< Bottom coded first, top displayed first
1132 * main external API structure.
1133 * New fields can be added to the end with minor version bumps.
1134 * Removal, reordering and changes to existing fields require a major
1136 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1138 * sizeof(AVCodecContext) must not be used outside libav*.
1140 typedef struct AVCodecContext {
1142 * information on struct for av_log
1143 * - set by avcodec_alloc_context3
1145 const AVClass *av_class;
1146 int log_level_offset;
1148 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1149 const struct AVCodec *codec;
1150 char codec_name[32];
1151 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1154 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1155 * This is used to work around some encoder bugs.
1156 * A demuxer should set this to what is stored in the field used to identify the codec.
1157 * If there are multiple such fields in a container then the demuxer should choose the one
1158 * which maximizes the information about the used codec.
1159 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1160 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1161 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1163 * - encoding: Set by user, if not then the default based on codec_id will be used.
1164 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1166 unsigned int codec_tag;
1169 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1170 * This is used to work around some encoder bugs.
1171 * - encoding: unused
1172 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1174 unsigned int stream_codec_tag;
1179 * Private context used for internal data.
1181 * Unlike priv_data, this is not codec-specific. It is used in general
1182 * libavcodec functions.
1184 struct AVCodecInternal *internal;
1187 * Private data of the user, can be used to carry app specific stuff.
1188 * - encoding: Set by user.
1189 * - decoding: Set by user.
1194 * the average bitrate
1195 * - encoding: Set by user; unused for constant quantizer encoding.
1196 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1201 * number of bits the bitstream is allowed to diverge from the reference.
1202 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1203 * - encoding: Set by user; unused for constant quantizer encoding.
1204 * - decoding: unused
1206 int bit_rate_tolerance;
1209 * Global quality for codecs which cannot change it per frame.
1210 * This should be proportional to MPEG-1/2/4 qscale.
1211 * - encoding: Set by user.
1212 * - decoding: unused
1217 * - encoding: Set by user.
1218 * - decoding: unused
1220 int compression_level;
1221 #define FF_COMPRESSION_DEFAULT -1
1225 * - encoding: Set by user.
1226 * - decoding: Set by user.
1232 * - encoding: Set by user.
1233 * - decoding: Set by user.
1238 * some codecs need / can use extradata like Huffman tables.
1239 * mjpeg: Huffman tables
1240 * rv10: additional flags
1241 * mpeg4: global headers (they can be in the bitstream or here)
1242 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1243 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1244 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1245 * - encoding: Set/allocated/freed by libavcodec.
1246 * - decoding: Set/allocated/freed by user.
1252 * This is the fundamental unit of time (in seconds) in terms
1253 * of which frame timestamps are represented. For fixed-fps content,
1254 * timebase should be 1/framerate and timestamp increments should be
1256 * - encoding: MUST be set by user.
1257 * - decoding: Set by libavcodec.
1259 AVRational time_base;
1262 * For some codecs, the time base is closer to the field rate than the frame rate.
1263 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1264 * if no telecine is used ...
1266 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1268 int ticks_per_frame;
1273 * Encoding: Number of frames delay there will be from the encoder input to
1274 * the decoder output. (we assume the decoder matches the spec)
1275 * Decoding: Number of frames delay in addition to what a standard decoder
1276 * as specified in the spec would produce.
1279 * Number of frames the decoded output will be delayed relative to the
1283 * For encoding, this is the number of "priming" samples added to the
1284 * beginning of the stream. The decoded output will be delayed by this
1285 * many samples relative to the input to the encoder. Note that this
1286 * field is purely informational and does not directly affect the pts
1287 * output by the encoder, which should always be based on the actual
1288 * presentation time, including any delay.
1289 * For decoding, this is the number of samples the decoder needs to
1290 * output before the decoder's output is valid. When seeking, you should
1291 * start decoding this many samples prior to your desired seek point.
1293 * - encoding: Set by libavcodec.
1294 * - decoding: Set by libavcodec.
1301 * picture width / height.
1302 * - encoding: MUST be set by user.
1303 * - decoding: May be set by the user before opening the decoder if known e.g.
1304 * from the container. Some decoders will require the dimensions
1305 * to be set by the caller. During decoding, the decoder may
1306 * overwrite those values as required.
1311 * Bitstream width / height, may be different from width/height e.g. when
1312 * the decoded frame is cropped before being output or lowres is enabled.
1313 * - encoding: unused
1314 * - decoding: May be set by the user before opening the decoder if known
1315 * e.g. from the container. During decoding, the decoder may
1316 * overwrite those values as required.
1318 int coded_width, coded_height;
1320 #define FF_ASPECT_EXTENDED 15
1323 * the number of pictures in a group of pictures, or 0 for intra_only
1324 * - encoding: Set by user.
1325 * - decoding: unused
1330 * Pixel format, see AV_PIX_FMT_xxx.
1331 * May be set by the demuxer if known from headers.
1332 * May be overridden by the decoder if it knows better.
1333 * - encoding: Set by user.
1334 * - decoding: Set by user if known, overridden by libavcodec if known
1336 enum AVPixelFormat pix_fmt;
1339 * Motion estimation algorithm used for video coding.
1340 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1341 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1342 * - encoding: MUST be set by user.
1343 * - decoding: unused
1348 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1349 * decoder to draw a horizontal band. It improves cache usage. Not
1350 * all codecs can do that. You must check the codec capabilities
1352 * When multithreading is used, it may be called from multiple threads
1353 * at the same time; threads might draw different parts of the same AVFrame,
1354 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1356 * The function is also used by hardware acceleration APIs.
1357 * It is called at least once during frame decoding to pass
1358 * the data needed for hardware render.
1359 * In that mode instead of pixel data, AVFrame points to
1360 * a structure specific to the acceleration API. The application
1361 * reads the structure and can change some fields to indicate progress
1363 * - encoding: unused
1364 * - decoding: Set by user.
1365 * @param height the height of the slice
1366 * @param y the y position of the slice
1367 * @param type 1->top field, 2->bottom field, 3->frame
1368 * @param offset offset into the AVFrame.data from which the slice should be read
1370 void (*draw_horiz_band)(struct AVCodecContext *s,
1371 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1372 int y, int type, int height);
1375 * callback to negotiate the pixelFormat
1376 * @param fmt is the list of formats which are supported by the codec,
1377 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1378 * The first is always the native one.
1379 * @return the chosen format
1380 * - encoding: unused
1381 * - decoding: Set by user, if not set the native format will be chosen.
1383 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1386 * maximum number of B-frames between non-B-frames
1387 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1388 * - encoding: Set by user.
1389 * - decoding: unused
1394 * qscale factor between IP and B-frames
1395 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1396 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1397 * - encoding: Set by user.
1398 * - decoding: unused
1400 float b_quant_factor;
1402 /** obsolete FIXME remove */
1404 #define FF_RC_STRATEGY_XVID 1
1406 int b_frame_strategy;
1409 * qscale offset between IP and B-frames
1410 * - encoding: Set by user.
1411 * - decoding: unused
1413 float b_quant_offset;
1416 * Size of the frame reordering buffer in the decoder.
1417 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1418 * - encoding: Set by libavcodec.
1419 * - decoding: Set by libavcodec.
1424 * 0-> h263 quant 1-> mpeg quant
1425 * - encoding: Set by user.
1426 * - decoding: unused
1431 * qscale factor between P and I-frames
1432 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1433 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1434 * - encoding: Set by user.
1435 * - decoding: unused
1437 float i_quant_factor;
1440 * qscale offset between P and I-frames
1441 * - encoding: Set by user.
1442 * - decoding: unused
1444 float i_quant_offset;
1447 * luminance masking (0-> disabled)
1448 * - encoding: Set by user.
1449 * - decoding: unused
1454 * temporary complexity masking (0-> disabled)
1455 * - encoding: Set by user.
1456 * - decoding: unused
1458 float temporal_cplx_masking;
1461 * spatial complexity masking (0-> disabled)
1462 * - encoding: Set by user.
1463 * - decoding: unused
1465 float spatial_cplx_masking;
1468 * p block masking (0-> disabled)
1469 * - encoding: Set by user.
1470 * - decoding: unused
1475 * darkness masking (0-> disabled)
1476 * - encoding: Set by user.
1477 * - decoding: unused
1483 * - encoding: Set by libavcodec.
1484 * - decoding: Set by user (or 0).
1488 * prediction method (needed for huffyuv)
1489 * - encoding: Set by user.
1490 * - decoding: unused
1492 int prediction_method;
1493 #define FF_PRED_LEFT 0
1494 #define FF_PRED_PLANE 1
1495 #define FF_PRED_MEDIAN 2
1498 * slice offsets in the frame in bytes
1499 * - encoding: Set/allocated by libavcodec.
1500 * - decoding: Set/allocated by user (or NULL).
1505 * sample aspect ratio (0 if unknown)
1506 * That is the width of a pixel divided by the height of the pixel.
1507 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1508 * - encoding: Set by user.
1509 * - decoding: Set by libavcodec.
1511 AVRational sample_aspect_ratio;
1514 * motion estimation comparison function
1515 * - encoding: Set by user.
1516 * - decoding: unused
1520 * subpixel motion estimation comparison function
1521 * - encoding: Set by user.
1522 * - decoding: unused
1526 * macroblock comparison function (not supported yet)
1527 * - encoding: Set by user.
1528 * - decoding: unused
1532 * interlaced DCT comparison function
1533 * - encoding: Set by user.
1534 * - decoding: unused
1537 #define FF_CMP_SAD 0
1538 #define FF_CMP_SSE 1
1539 #define FF_CMP_SATD 2
1540 #define FF_CMP_DCT 3
1541 #define FF_CMP_PSNR 4
1542 #define FF_CMP_BIT 5
1544 #define FF_CMP_ZERO 7
1545 #define FF_CMP_VSAD 8
1546 #define FF_CMP_VSSE 9
1547 #define FF_CMP_NSSE 10
1548 #define FF_CMP_W53 11
1549 #define FF_CMP_W97 12
1550 #define FF_CMP_DCTMAX 13
1551 #define FF_CMP_DCT264 14
1552 #define FF_CMP_CHROMA 256
1555 * ME diamond size & shape
1556 * - encoding: Set by user.
1557 * - decoding: unused
1562 * amount of previous MV predictors (2a+1 x 2a+1 square)
1563 * - encoding: Set by user.
1564 * - decoding: unused
1566 int last_predictor_count;
1569 * prepass for motion estimation
1570 * - encoding: Set by user.
1571 * - decoding: unused
1576 * motion estimation prepass comparison function
1577 * - encoding: Set by user.
1578 * - decoding: unused
1583 * ME prepass diamond size & shape
1584 * - encoding: Set by user.
1585 * - decoding: unused
1591 * - encoding: Set by user.
1592 * - decoding: unused
1594 int me_subpel_quality;
1597 * DTG active format information (additional aspect ratio
1598 * information only used in DVB MPEG-2 transport streams)
1601 * - encoding: unused
1602 * - decoding: Set by decoder.
1604 int dtg_active_format;
1605 #define FF_DTG_AFD_SAME 8
1606 #define FF_DTG_AFD_4_3 9
1607 #define FF_DTG_AFD_16_9 10
1608 #define FF_DTG_AFD_14_9 11
1609 #define FF_DTG_AFD_4_3_SP_14_9 13
1610 #define FF_DTG_AFD_16_9_SP_14_9 14
1611 #define FF_DTG_AFD_SP_4_3 15
1614 * maximum motion estimation search range in subpel units
1615 * If 0 then no limit.
1617 * - encoding: Set by user.
1618 * - decoding: unused
1623 * intra quantizer bias
1624 * - encoding: Set by user.
1625 * - decoding: unused
1627 int intra_quant_bias;
1628 #define FF_DEFAULT_QUANT_BIAS 999999
1631 * inter quantizer bias
1632 * - encoding: Set by user.
1633 * - decoding: unused
1635 int inter_quant_bias;
1639 * - encoding: unused
1640 * - decoding: Set by user.
1643 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1644 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1645 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1648 * XVideo Motion Acceleration
1649 * - encoding: forbidden
1650 * - decoding: set by decoder
1652 int xvmc_acceleration;
1655 * macroblock decision mode
1656 * - encoding: Set by user.
1657 * - decoding: unused
1660 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1661 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1662 #define FF_MB_DECISION_RD 2 ///< rate distortion
1665 * custom intra quantization matrix
1666 * - encoding: Set by user, can be NULL.
1667 * - decoding: Set by libavcodec.
1669 uint16_t *intra_matrix;
1672 * custom inter quantization matrix
1673 * - encoding: Set by user, can be NULL.
1674 * - decoding: Set by libavcodec.
1676 uint16_t *inter_matrix;
1679 * scene change detection threshold
1680 * 0 is default, larger means fewer detected scene changes.
1681 * - encoding: Set by user.
1682 * - decoding: unused
1684 int scenechange_threshold;
1687 * noise reduction strength
1688 * - encoding: Set by user.
1689 * - decoding: unused
1691 int noise_reduction;
1694 * Motion estimation threshold below which no motion estimation is
1695 * performed, but instead the user specified motion vectors are used.
1697 * - encoding: Set by user.
1698 * - decoding: unused
1703 * Macroblock threshold below which the user specified macroblock types will be used.
1704 * - encoding: Set by user.
1705 * - decoding: unused
1710 * precision of the intra DC coefficient - 8
1711 * - encoding: Set by user.
1712 * - decoding: unused
1714 int intra_dc_precision;
1717 * Number of macroblock rows at the top which are skipped.
1718 * - encoding: unused
1719 * - decoding: Set by user.
1724 * Number of macroblock rows at the bottom which are skipped.
1725 * - encoding: unused
1726 * - decoding: Set by user.
1731 * Border processing masking, raises the quantizer for mbs on the borders
1733 * - encoding: Set by user.
1734 * - decoding: unused
1736 float border_masking;
1739 * minimum MB lagrange multipler
1740 * - encoding: Set by user.
1741 * - decoding: unused
1746 * maximum MB lagrange multipler
1747 * - encoding: Set by user.
1748 * - decoding: unused
1754 * - encoding: Set by user.
1755 * - decoding: unused
1757 int me_penalty_compensation;
1761 * - encoding: Set by user.
1762 * - decoding: unused
1768 * - encoding: Set by user.
1769 * - decoding: unused
1775 * - encoding: Set by user.
1776 * - decoding: unused
1781 * number of reference frames
1782 * - encoding: Set by user.
1783 * - decoding: Set by lavc.
1788 * chroma qp offset from luma
1789 * - encoding: Set by user.
1790 * - decoding: unused
1795 * Multiplied by qscale for each frame and added to scene_change_score.
1796 * - encoding: Set by user.
1797 * - decoding: unused
1799 int scenechange_factor;
1803 * Note: Value depends upon the compare function used for fullpel ME.
1804 * - encoding: Set by user.
1805 * - decoding: unused
1810 * Adjust sensitivity of b_frame_strategy 1.
1811 * - encoding: Set by user.
1812 * - decoding: unused
1817 * Chromaticity coordinates of the source primaries.
1818 * - encoding: Set by user
1819 * - decoding: Set by libavcodec
1821 enum AVColorPrimaries color_primaries;
1824 * Color Transfer Characteristic.
1825 * - encoding: Set by user
1826 * - decoding: Set by libavcodec
1828 enum AVColorTransferCharacteristic color_trc;
1831 * YUV colorspace type.
1832 * - encoding: Set by user
1833 * - decoding: Set by libavcodec
1835 enum AVColorSpace colorspace;
1838 * MPEG vs JPEG YUV range.
1839 * - encoding: Set by user
1840 * - decoding: Set by libavcodec
1842 enum AVColorRange color_range;
1845 * This defines the location of chroma samples.
1846 * - encoding: Set by user
1847 * - decoding: Set by libavcodec
1849 enum AVChromaLocation chroma_sample_location;
1853 * Indicates number of picture subdivisions. Used for parallelized
1855 * - encoding: Set by user
1856 * - decoding: unused
1861 * - encoding: set by libavcodec
1862 * - decoding: Set by user.
1864 enum AVFieldOrder field_order;
1867 int sample_rate; ///< samples per second
1868 int channels; ///< number of audio channels
1871 * audio sample format
1872 * - encoding: Set by user.
1873 * - decoding: Set by libavcodec.
1875 enum AVSampleFormat sample_fmt; ///< sample format
1877 /* The following data should not be initialized. */
1879 * Number of samples per channel in an audio frame.
1881 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1882 * except the last must contain exactly frame_size samples per channel.
1883 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1884 * frame size is not restricted.
1885 * - decoding: may be set by some decoders to indicate constant frame size
1890 * Frame counter, set by libavcodec.
1892 * - decoding: total number of frames returned from the decoder so far.
1893 * - encoding: total number of frames passed to the encoder so far.
1895 * @note the counter is not incremented if encoding/decoding resulted in
1901 * number of bytes per packet if constant and known or 0
1902 * Used by some WAV based audio codecs.
1907 * Audio cutoff bandwidth (0 means "automatic")
1908 * - encoding: Set by user.
1909 * - decoding: unused
1913 #if FF_API_REQUEST_CHANNELS
1915 * Decoder should decode to this many channels if it can (0 for default)
1916 * - encoding: unused
1917 * - decoding: Set by user.
1918 * @deprecated Deprecated in favor of request_channel_layout.
1920 int request_channels;
1924 * Audio channel layout.
1925 * - encoding: set by user.
1926 * - decoding: set by user, may be overwritten by libavcodec.
1928 uint64_t channel_layout;
1931 * Request decoder to use this channel layout if it can (0 for default)
1932 * - encoding: unused
1933 * - decoding: Set by user.
1935 uint64_t request_channel_layout;
1938 * Type of service that the audio stream conveys.
1939 * - encoding: Set by user.
1940 * - decoding: Set by libavcodec.
1942 enum AVAudioServiceType audio_service_type;
1945 * desired sample format
1946 * - encoding: Not used.
1947 * - decoding: Set by user.
1948 * Decoder will decode to this format if it can.
1950 enum AVSampleFormat request_sample_fmt;
1952 #if FF_API_GET_BUFFER
1954 * Called at the beginning of each frame to get a buffer for it.
1956 * The function will set AVFrame.data[], AVFrame.linesize[].
1957 * AVFrame.extended_data[] must also be set, but it should be the same as
1958 * AVFrame.data[] except for planar audio with more channels than can fit
1959 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1960 * many data pointers as it can hold.
1962 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1963 * avcodec_default_get_buffer() instead of providing buffers allocated by
1966 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1967 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1968 * but if get_buffer() is overridden then alignment considerations should
1969 * be taken into account.
1971 * @see avcodec_default_get_buffer()
1975 * If pic.reference is set then the frame will be read later by libavcodec.
1976 * avcodec_align_dimensions2() should be used to find the required width and
1977 * height, as they normally need to be rounded up to the next multiple of 16.
1979 * If frame multithreading is used and thread_safe_callbacks is set,
1980 * it may be called from a different thread, but not from more than one at
1981 * once. Does not need to be reentrant.
1983 * @see release_buffer(), reget_buffer()
1984 * @see avcodec_align_dimensions2()
1988 * Decoders request a buffer of a particular size by setting
1989 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1990 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1991 * to a smaller value in the output frame.
1993 * Decoders cannot use the buffer after returning from
1994 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1995 * is assumed to be released immediately upon return. In some rare cases,
1996 * a decoder may need to call get_buffer() more than once in a single
1997 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
1998 * called again after it has already been called once, the previously
1999 * acquired buffer is assumed to be released at that time and may not be
2000 * reused by the decoder.
2002 * As a convenience, av_samples_get_buffer_size() and
2003 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2004 * functions to find the required data size and to fill data pointers and
2005 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2006 * since all planes must be the same size.
2008 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2010 * - encoding: unused
2011 * - decoding: Set by libavcodec, user can override.
2013 * @deprecated use get_buffer2()
2015 attribute_deprecated
2016 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2019 * Called to release buffers which were allocated with get_buffer.
2020 * A released buffer can be reused in get_buffer().
2021 * pic.data[*] must be set to NULL.
2022 * May be called from a different thread if frame multithreading is used,
2023 * but not by more than one thread at once, so does not need to be reentrant.
2024 * - encoding: unused
2025 * - decoding: Set by libavcodec, user can override.
2027 * @deprecated custom freeing callbacks should be set from get_buffer2()
2029 attribute_deprecated
2030 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2033 * Called at the beginning of a frame to get cr buffer for it.
2034 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2035 * libavcodec will pass previous buffer in pic, function should return
2036 * same buffer or new buffer with old frame "painted" into it.
2037 * If pic.data[0] == NULL must behave like get_buffer().
2038 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2039 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2041 * - encoding: unused
2042 * - decoding: Set by libavcodec, user can override.
2044 attribute_deprecated
2045 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2049 * This callback is called at the beginning of each frame to get data
2050 * buffer(s) for it. There may be one contiguous buffer for all the data or
2051 * there may be a buffer per each data plane or anything in between. What
2052 * this means is, you may set however many entries in buf[] you feel necessary.
2053 * Each buffer must be reference-counted using the AVBuffer API (see description
2056 * The following fields will be set in the frame before this callback is
2059 * - width, height (video only)
2060 * - sample_rate, channel_layout, nb_samples (audio only)
2061 * Their values may differ from the corresponding values in
2062 * AVCodecContext. This callback must use the frame values, not the codec
2063 * context values, to calculate the required buffer size.
2065 * This callback must fill the following fields in the frame:
2069 * * if the data is planar audio with more than 8 channels, then this
2070 * callback must allocate and fill extended_data to contain all pointers
2071 * to all data planes. data[] must hold as many pointers as it can.
2072 * extended_data must be allocated with av_malloc() and will be freed in
2074 * * otherwise exended_data must point to data
2075 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2076 * the frame's data and extended_data pointers must be contained in these. That
2077 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2078 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2079 * and av_buffer_ref().
2080 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2081 * this callback and filled with the extra buffers if there are more
2082 * buffers than buf[] can hold. extended_buf will be freed in
2085 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2086 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2089 * Each data plane must be aligned to the maximum required by the target
2092 * @see avcodec_default_get_buffer2()
2096 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2097 * (read and/or written to if it is writable) later by libavcodec.
2099 * If CODEC_FLAG_EMU_EDGE is not set in s->flags, the buffer must contain an
2100 * edge of the size returned by avcodec_get_edge_width() on all sides.
2102 * avcodec_align_dimensions2() should be used to find the required width and
2103 * height, as they normally need to be rounded up to the next multiple of 16.
2105 * If frame multithreading is used and thread_safe_callbacks is set,
2106 * this callback may be called from a different thread, but not from more
2107 * than one at once. Does not need to be reentrant.
2109 * @see avcodec_align_dimensions2()
2113 * Decoders request a buffer of a particular size by setting
2114 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2115 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2116 * to a smaller value in the output frame.
2118 * As a convenience, av_samples_get_buffer_size() and
2119 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2120 * functions to find the required data size and to fill data pointers and
2121 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2122 * since all planes must be the same size.
2124 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2126 * - encoding: unused
2127 * - decoding: Set by libavcodec, user can override.
2129 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2132 * If non-zero, the decoded audio and video frames returned from
2133 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2134 * and are valid indefinitely. The caller must free them with
2135 * av_frame_unref() when they are not needed anymore.
2136 * Otherwise, the decoded frames must not be freed by the caller and are
2137 * only valid until the next decode call.
2139 * - encoding: unused
2140 * - decoding: set by the caller before avcodec_open2().
2142 int refcounted_frames;
2144 /* - encoding parameters */
2145 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2146 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2150 * - encoding: Set by user.
2151 * - decoding: unused
2157 * - encoding: Set by user.
2158 * - decoding: unused
2163 * maximum quantizer difference between frames
2164 * - encoding: Set by user.
2165 * - decoding: unused
2170 * ratecontrol qmin qmax limiting method
2171 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2172 * - encoding: Set by user.
2173 * - decoding: unused
2181 * decoder bitstream buffer size
2182 * - encoding: Set by user.
2183 * - decoding: unused
2188 * ratecontrol override, see RcOverride
2189 * - encoding: Allocated/set/freed by user.
2190 * - decoding: unused
2192 int rc_override_count;
2193 RcOverride *rc_override;
2196 * rate control equation
2197 * - encoding: Set by user
2198 * - decoding: unused
2204 * - encoding: Set by user.
2205 * - decoding: unused
2211 * - encoding: Set by user.
2212 * - decoding: unused
2216 float rc_buffer_aggressivity;
2219 * initial complexity for pass1 ratecontrol
2220 * - encoding: Set by user.
2221 * - decoding: unused
2223 float rc_initial_cplx;
2226 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2227 * - encoding: Set by user.
2228 * - decoding: unused.
2230 float rc_max_available_vbv_use;
2233 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2234 * - encoding: Set by user.
2235 * - decoding: unused.
2237 float rc_min_vbv_overflow_use;
2240 * Number of bits which should be loaded into the rc buffer before decoding starts.
2241 * - encoding: Set by user.
2242 * - decoding: unused
2244 int rc_initial_buffer_occupancy;
2246 #define FF_CODER_TYPE_VLC 0
2247 #define FF_CODER_TYPE_AC 1
2248 #define FF_CODER_TYPE_RAW 2
2249 #define FF_CODER_TYPE_RLE 3
2250 #define FF_CODER_TYPE_DEFLATE 4
2253 * - encoding: Set by user.
2254 * - decoding: unused
2260 * - encoding: Set by user.
2261 * - decoding: unused
2266 * minimum Lagrange multipler
2267 * - encoding: Set by user.
2268 * - decoding: unused
2273 * maximum Lagrange multipler
2274 * - encoding: Set by user.
2275 * - decoding: unused
2280 * frame skip threshold
2281 * - encoding: Set by user.
2282 * - decoding: unused
2284 int frame_skip_threshold;
2288 * - encoding: Set by user.
2289 * - decoding: unused
2291 int frame_skip_factor;
2294 * frame skip exponent
2295 * - encoding: Set by user.
2296 * - decoding: unused
2301 * frame skip comparison function
2302 * - encoding: Set by user.
2303 * - decoding: unused
2308 * trellis RD quantization
2309 * - encoding: Set by user.
2310 * - decoding: unused
2315 * - encoding: Set by user.
2316 * - decoding: unused
2318 int min_prediction_order;
2321 * - encoding: Set by user.
2322 * - decoding: unused
2324 int max_prediction_order;
2327 * GOP timecode frame start number
2328 * - encoding: Set by user, in non drop frame format
2329 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2331 int64_t timecode_frame_start;
2333 /* The RTP callback: This function is called */
2334 /* every time the encoder has a packet to send. */
2335 /* It depends on the encoder if the data starts */
2336 /* with a Start Code (it should). H.263 does. */
2337 /* mb_nb contains the number of macroblocks */
2338 /* encoded in the RTP payload. */
2339 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2341 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2342 /* do its best to deliver a chunk with size */
2343 /* below rtp_payload_size, the chunk will start */
2344 /* with a start code on some codecs like H.263. */
2345 /* This doesn't take account of any particular */
2346 /* headers inside the transmitted RTP payload. */
2348 /* statistics, used for 2-pass encoding */
2359 * number of bits used for the previously encoded frame
2360 * - encoding: Set by libavcodec.
2361 * - decoding: unused
2366 * pass1 encoding statistics output buffer
2367 * - encoding: Set by libavcodec.
2368 * - decoding: unused
2373 * pass2 encoding statistics input buffer
2374 * Concatenated stuff from stats_out of pass1 should be placed here.
2375 * - encoding: Allocated/set/freed by user.
2376 * - decoding: unused
2381 * Work around bugs in encoders which sometimes cannot be detected automatically.
2382 * - encoding: Set by user
2383 * - decoding: Set by user
2385 int workaround_bugs;
2386 #define FF_BUG_AUTODETECT 1 ///< autodetection
2387 #define FF_BUG_OLD_MSMPEG4 2
2388 #define FF_BUG_XVID_ILACE 4
2389 #define FF_BUG_UMP4 8
2390 #define FF_BUG_NO_PADDING 16
2391 #define FF_BUG_AMV 32
2392 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2393 #define FF_BUG_QPEL_CHROMA 64
2394 #define FF_BUG_STD_QPEL 128
2395 #define FF_BUG_QPEL_CHROMA2 256
2396 #define FF_BUG_DIRECT_BLOCKSIZE 512
2397 #define FF_BUG_EDGE 1024
2398 #define FF_BUG_HPEL_CHROMA 2048
2399 #define FF_BUG_DC_CLIP 4096
2400 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2401 #define FF_BUG_TRUNCATED 16384
2404 * strictly follow the standard (MPEG4, ...).
2405 * - encoding: Set by user.
2406 * - decoding: Set by user.
2407 * Setting this to STRICT or higher means the encoder and decoder will
2408 * generally do stupid things, whereas setting it to unofficial or lower
2409 * will mean the encoder might produce output that is not supported by all
2410 * spec-compliant decoders. Decoders don't differentiate between normal,
2411 * unofficial and experimental (that is, they always try to decode things
2412 * when they can) unless they are explicitly asked to behave stupidly
2413 * (=strictly conform to the specs)
2415 int strict_std_compliance;
2416 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2417 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2418 #define FF_COMPLIANCE_NORMAL 0
2419 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2420 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2423 * error concealment flags
2424 * - encoding: unused
2425 * - decoding: Set by user.
2427 int error_concealment;
2428 #define FF_EC_GUESS_MVS 1
2429 #define FF_EC_DEBLOCK 2
2433 * - encoding: Set by user.
2434 * - decoding: Set by user.
2437 #define FF_DEBUG_PICT_INFO 1
2438 #define FF_DEBUG_RC 2
2439 #define FF_DEBUG_BITSTREAM 4
2440 #define FF_DEBUG_MB_TYPE 8
2441 #define FF_DEBUG_QP 16
2442 #define FF_DEBUG_MV 32
2443 #define FF_DEBUG_DCT_COEFF 0x00000040
2444 #define FF_DEBUG_SKIP 0x00000080
2445 #define FF_DEBUG_STARTCODE 0x00000100
2446 #define FF_DEBUG_PTS 0x00000200
2447 #define FF_DEBUG_ER 0x00000400
2448 #define FF_DEBUG_MMCO 0x00000800
2449 #define FF_DEBUG_BUGS 0x00001000
2450 #define FF_DEBUG_VIS_QP 0x00002000
2451 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2452 #define FF_DEBUG_BUFFERS 0x00008000
2453 #define FF_DEBUG_THREADS 0x00010000
2457 * - encoding: Set by user.
2458 * - decoding: Set by user.
2461 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2462 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2463 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2466 * Error recognition; may misdetect some more or less valid parts as errors.
2467 * - encoding: unused
2468 * - decoding: Set by user.
2470 int err_recognition;
2471 #define AV_EF_CRCCHECK (1<<0)
2472 #define AV_EF_BITSTREAM (1<<1)
2473 #define AV_EF_BUFFER (1<<2)
2474 #define AV_EF_EXPLODE (1<<3)
2476 #define AV_EF_CAREFUL (1<<16)
2477 #define AV_EF_COMPLIANT (1<<17)
2478 #define AV_EF_AGGRESSIVE (1<<18)
2482 * opaque 64bit number (generally a PTS) that will be reordered and
2483 * output in AVFrame.reordered_opaque
2484 * @deprecated in favor of pkt_pts
2485 * - encoding: unused
2486 * - decoding: Set by user.
2488 int64_t reordered_opaque;
2491 * Hardware accelerator in use
2492 * - encoding: unused.
2493 * - decoding: Set by libavcodec
2495 struct AVHWAccel *hwaccel;
2498 * Hardware accelerator context.
2499 * For some hardware accelerators, a global context needs to be
2500 * provided by the user. In that case, this holds display-dependent
2501 * data FFmpeg cannot instantiate itself. Please refer to the
2502 * FFmpeg HW accelerator documentation to know how to fill this
2503 * is. e.g. for VA API, this is a struct vaapi_context.
2504 * - encoding: unused
2505 * - decoding: Set by user
2507 void *hwaccel_context;
2511 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2512 * - decoding: unused
2514 uint64_t error[AV_NUM_DATA_POINTERS];
2517 * DCT algorithm, see FF_DCT_* below
2518 * - encoding: Set by user.
2519 * - decoding: unused
2522 #define FF_DCT_AUTO 0
2523 #define FF_DCT_FASTINT 1
2524 #define FF_DCT_INT 2
2525 #define FF_DCT_MMX 3
2526 #define FF_DCT_ALTIVEC 5
2527 #define FF_DCT_FAAN 6
2530 * IDCT algorithm, see FF_IDCT_* below.
2531 * - encoding: Set by user.
2532 * - decoding: Set by user.
2535 #define FF_IDCT_AUTO 0
2536 #define FF_IDCT_INT 1
2537 #define FF_IDCT_SIMPLE 2
2538 #define FF_IDCT_SIMPLEMMX 3
2539 #define FF_IDCT_ARM 7
2540 #define FF_IDCT_ALTIVEC 8
2541 #define FF_IDCT_SH4 9
2542 #define FF_IDCT_SIMPLEARM 10
2543 #define FF_IDCT_IPP 13
2544 #define FF_IDCT_XVIDMMX 14
2545 #define FF_IDCT_SIMPLEARMV5TE 16
2546 #define FF_IDCT_SIMPLEARMV6 17
2547 #define FF_IDCT_SIMPLEVIS 18
2548 #define FF_IDCT_FAAN 20
2549 #define FF_IDCT_SIMPLENEON 22
2550 #define FF_IDCT_SIMPLEALPHA 23
2553 * bits per sample/pixel from the demuxer (needed for huffyuv).
2554 * - encoding: Set by libavcodec.
2555 * - decoding: Set by user.
2557 int bits_per_coded_sample;
2560 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2561 * - encoding: set by user.
2562 * - decoding: set by libavcodec.
2564 int bits_per_raw_sample;
2568 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2569 * - encoding: unused
2570 * - decoding: Set by user.
2571 * Code outside libavcodec should access this field using:
2572 * av_codec_{get,set}_lowres(avctx)
2578 * the picture in the bitstream
2579 * - encoding: Set by libavcodec.
2580 * - decoding: Set by libavcodec.
2582 AVFrame *coded_frame;
2586 * is used to decide how many independent tasks should be passed to execute()
2587 * - encoding: Set by user.
2588 * - decoding: Set by user.
2593 * Which multithreading methods to use.
2594 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2595 * so clients which cannot provide future frames should not use it.
2597 * - encoding: Set by user, otherwise the default is used.
2598 * - decoding: Set by user, otherwise the default is used.
2601 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2602 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2605 * Which multithreading methods are in use by the codec.
2606 * - encoding: Set by libavcodec.
2607 * - decoding: Set by libavcodec.
2609 int active_thread_type;
2612 * Set by the client if its custom get_buffer() callback can be called
2613 * synchronously from another thread, which allows faster multithreaded decoding.
2614 * draw_horiz_band() will be called from other threads regardless of this setting.
2615 * Ignored if the default get_buffer() is used.
2616 * - encoding: Set by user.
2617 * - decoding: Set by user.
2619 int thread_safe_callbacks;
2622 * The codec may call this to execute several independent things.
2623 * It will return only after finishing all tasks.
2624 * The user may replace this with some multithreaded implementation,
2625 * the default implementation will execute the parts serially.
2626 * @param count the number of things to execute
2627 * - encoding: Set by libavcodec, user can override.
2628 * - decoding: Set by libavcodec, user can override.
2630 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2633 * The codec may call this to execute several independent things.
2634 * It will return only after finishing all tasks.
2635 * The user may replace this with some multithreaded implementation,
2636 * the default implementation will execute the parts serially.
2637 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2638 * @param c context passed also to func
2639 * @param count the number of things to execute
2640 * @param arg2 argument passed unchanged to func
2641 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2642 * @param func function that will be called count times, with jobnr from 0 to count-1.
2643 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2644 * two instances of func executing at the same time will have the same threadnr.
2645 * @return always 0 currently, but code should handle a future improvement where when any call to func
2646 * returns < 0 no further calls to func may be done and < 0 is returned.
2647 * - encoding: Set by libavcodec, user can override.
2648 * - decoding: Set by libavcodec, user can override.
2650 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2654 * Can be used by execute() to store some per AVCodecContext stuff.
2655 * - encoding: set by execute()
2656 * - decoding: set by execute()
2658 void *thread_opaque;
2661 * noise vs. sse weight for the nsse comparsion function
2662 * - encoding: Set by user.
2663 * - decoding: unused
2669 * - encoding: Set by user.
2670 * - decoding: Set by libavcodec.
2673 #define FF_PROFILE_UNKNOWN -99
2674 #define FF_PROFILE_RESERVED -100
2676 #define FF_PROFILE_AAC_MAIN 0
2677 #define FF_PROFILE_AAC_LOW 1
2678 #define FF_PROFILE_AAC_SSR 2
2679 #define FF_PROFILE_AAC_LTP 3
2680 #define FF_PROFILE_AAC_HE 4
2681 #define FF_PROFILE_AAC_HE_V2 28
2682 #define FF_PROFILE_AAC_LD 22
2683 #define FF_PROFILE_AAC_ELD 38
2685 #define FF_PROFILE_DTS 20
2686 #define FF_PROFILE_DTS_ES 30
2687 #define FF_PROFILE_DTS_96_24 40
2688 #define FF_PROFILE_DTS_HD_HRA 50
2689 #define FF_PROFILE_DTS_HD_MA 60
2691 #define FF_PROFILE_MPEG2_422 0
2692 #define FF_PROFILE_MPEG2_HIGH 1
2693 #define FF_PROFILE_MPEG2_SS 2
2694 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2695 #define FF_PROFILE_MPEG2_MAIN 4
2696 #define FF_PROFILE_MPEG2_SIMPLE 5
2698 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2699 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2701 #define FF_PROFILE_H264_BASELINE 66
2702 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2703 #define FF_PROFILE_H264_MAIN 77
2704 #define FF_PROFILE_H264_EXTENDED 88
2705 #define FF_PROFILE_H264_HIGH 100
2706 #define FF_PROFILE_H264_HIGH_10 110
2707 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2708 #define FF_PROFILE_H264_HIGH_422 122
2709 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2710 #define FF_PROFILE_H264_HIGH_444 144
2711 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2712 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2713 #define FF_PROFILE_H264_CAVLC_444 44
2715 #define FF_PROFILE_VC1_SIMPLE 0
2716 #define FF_PROFILE_VC1_MAIN 1
2717 #define FF_PROFILE_VC1_COMPLEX 2
2718 #define FF_PROFILE_VC1_ADVANCED 3
2720 #define FF_PROFILE_MPEG4_SIMPLE 0
2721 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2722 #define FF_PROFILE_MPEG4_CORE 2
2723 #define FF_PROFILE_MPEG4_MAIN 3
2724 #define FF_PROFILE_MPEG4_N_BIT 4
2725 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2726 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2727 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2728 #define FF_PROFILE_MPEG4_HYBRID 8
2729 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2730 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2731 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2732 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2733 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2734 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2735 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2737 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2738 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2739 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2740 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2741 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2745 * - encoding: Set by user.
2746 * - decoding: Set by libavcodec.
2749 #define FF_LEVEL_UNKNOWN -99
2752 * Skip loop filtering for selected frames.
2753 * - encoding: unused
2754 * - decoding: Set by user.
2756 enum AVDiscard skip_loop_filter;
2759 * Skip IDCT/dequantization for selected frames.
2760 * - encoding: unused
2761 * - decoding: Set by user.
2763 enum AVDiscard skip_idct;
2766 * Skip decoding for selected frames.
2767 * - encoding: unused
2768 * - decoding: Set by user.
2770 enum AVDiscard skip_frame;
2773 * Header containing style information for text subtitles.
2774 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2775 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2776 * the Format line following. It shouldn't include any Dialogue line.
2777 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2778 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2780 uint8_t *subtitle_header;
2781 int subtitle_header_size;
2784 * Simulates errors in the bitstream to test error concealment.
2785 * - encoding: Set by user.
2786 * - decoding: unused
2791 * Current packet as passed into the decoder, to avoid having
2792 * to pass the packet into every function. Currently only valid
2793 * inside lavc and get/release_buffer callbacks.
2794 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2795 * - encoding: unused
2800 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2801 * Used for compliant TS muxing.
2802 * - encoding: Set by libavcodec.
2803 * - decoding: unused.
2808 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2809 * Code outside libavcodec should access this field using:
2810 * av_codec_{get,set}_pkt_timebase(avctx)
2811 * - encoding unused.
2812 * - decodimg set by user
2814 AVRational pkt_timebase;
2818 * Code outside libavcodec should access this field using:
2819 * av_codec_{get,set}_codec_descriptor(avctx)
2820 * - encoding: unused.
2821 * - decoding: set by libavcodec.
2823 const AVCodecDescriptor *codec_descriptor;
2827 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2828 * - encoding: unused
2829 * - decoding: Set by user.
2830 * Code outside libavcodec should access this field using:
2831 * av_codec_{get,set}_lowres(avctx)
2837 * Current statistics for PTS correction.
2838 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2839 * - encoding: unused
2841 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2842 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2843 int64_t pts_correction_last_pts; /// PTS of the last frame
2844 int64_t pts_correction_last_dts; /// DTS of the last frame
2847 * Character encoding of the input subtitles file.
2848 * - decoding: set by user
2849 * - encoding: unused
2854 * Subtitles character encoding mode. Formats or codecs might be adjusting
2855 * this setting (if they are doing the conversion themselves for instance).
2856 * - decoding: set by libavcodec
2857 * - encoding: unused
2859 int sub_charenc_mode;
2860 #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)
2861 #define FF_SUB_CHARENC_MODE_AUTOMATIC 0 ///< libavcodec will select the mode itself
2862 #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
2866 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
2867 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
2869 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
2870 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
2872 int av_codec_get_lowres(const AVCodecContext *avctx);
2873 void av_codec_set_lowres(AVCodecContext *avctx, int val);
2878 typedef struct AVProfile {
2880 const char *name; ///< short name for the profile
2883 typedef struct AVCodecDefault AVCodecDefault;
2890 typedef struct AVCodec {
2892 * Name of the codec implementation.
2893 * The name is globally unique among encoders and among decoders (but an
2894 * encoder and a decoder can share the same name).
2895 * This is the primary way to find a codec from the user perspective.
2899 * Descriptive name for the codec, meant to be more human readable than name.
2900 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2902 const char *long_name;
2903 enum AVMediaType type;
2906 * Codec capabilities.
2910 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2911 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2912 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2913 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2914 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2915 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2916 const AVClass *priv_class; ///< AVClass for the private context
2917 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2919 /*****************************************************************
2920 * No fields below this line are part of the public API. They
2921 * may not be used outside of libavcodec and can be changed and
2923 * New public fields should be added right above.
2924 *****************************************************************
2927 struct AVCodec *next;
2929 * @name Frame-level threading support functions
2933 * If defined, called on thread contexts when they are created.
2934 * If the codec allocates writable tables in init(), re-allocate them here.
2935 * priv_data will be set to a copy of the original.
2937 int (*init_thread_copy)(AVCodecContext *);
2939 * Copy necessary context variables from a previous thread context to the current one.
2940 * If not defined, the next thread will start automatically; otherwise, the codec
2941 * must call ff_thread_finish_setup().
2943 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2945 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2949 * Private codec-specific defaults.
2951 const AVCodecDefault *defaults;
2954 * Initialize codec static data, called from avcodec_register().
2956 void (*init_static_data)(struct AVCodec *codec);
2958 int (*init)(AVCodecContext *);
2959 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2960 const struct AVSubtitle *sub);
2962 * Encode data to an AVPacket.
2964 * @param avctx codec context
2965 * @param avpkt output AVPacket (may contain a user-provided buffer)
2966 * @param[in] frame AVFrame containing the raw data to be encoded
2967 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2968 * non-empty packet was returned in avpkt.
2969 * @return 0 on success, negative error code on failure
2971 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2972 int *got_packet_ptr);
2973 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2974 int (*close)(AVCodecContext *);
2977 * Will be called when seeking
2979 void (*flush)(AVCodecContext *);
2985 typedef struct AVHWAccel {
2987 * Name of the hardware accelerated codec.
2988 * The name is globally unique among encoders and among decoders (but an
2989 * encoder and a decoder can share the same name).
2994 * Type of codec implemented by the hardware accelerator.
2996 * See AVMEDIA_TYPE_xxx
2998 enum AVMediaType type;
3001 * Codec implemented by the hardware accelerator.
3003 * See AV_CODEC_ID_xxx
3008 * Supported pixel format.
3010 * Only hardware accelerated formats are supported here.
3012 enum AVPixelFormat pix_fmt;
3015 * Hardware accelerated codec capabilities.
3016 * see FF_HWACCEL_CODEC_CAP_*
3020 struct AVHWAccel *next;
3023 * Called at the beginning of each frame or field picture.
3025 * Meaningful frame information (codec specific) is guaranteed to
3026 * be parsed at this point. This function is mandatory.
3028 * Note that buf can be NULL along with buf_size set to 0.
3029 * Otherwise, this means the whole frame is available at this point.
3031 * @param avctx the codec context
3032 * @param buf the frame data buffer base
3033 * @param buf_size the size of the frame in bytes
3034 * @return zero if successful, a negative value otherwise
3036 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3039 * Callback for each slice.
3041 * Meaningful slice information (codec specific) is guaranteed to
3042 * be parsed at this point. This function is mandatory.
3044 * @param avctx the codec context
3045 * @param buf the slice data buffer base
3046 * @param buf_size the size of the slice in bytes
3047 * @return zero if successful, a negative value otherwise
3049 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3052 * Called at the end of each frame or field picture.
3054 * The whole picture is parsed at this point and can now be sent
3055 * to the hardware accelerator. This function is mandatory.
3057 * @param avctx the codec context
3058 * @return zero if successful, a negative value otherwise
3060 int (*end_frame)(AVCodecContext *avctx);
3063 * Size of HW accelerator private data.
3065 * Private data is allocated with av_mallocz() before
3066 * AVCodecContext.get_buffer() and deallocated after
3067 * AVCodecContext.release_buffer().
3073 * @defgroup lavc_picture AVPicture
3075 * Functions for working with AVPicture
3080 * four components are given, that's all.
3081 * the last component is alpha
3083 typedef struct AVPicture {
3084 uint8_t *data[AV_NUM_DATA_POINTERS];
3085 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3092 enum AVSubtitleType {
3095 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3098 * Plain text, the text field must be set by the decoder and is
3099 * authoritative. ass and pict fields may contain approximations.
3104 * Formatted text, the ass field must be set by the decoder and is
3105 * authoritative. pict and text fields may contain approximations.
3110 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3112 typedef struct AVSubtitleRect {
3113 int x; ///< top left corner of pict, undefined when pict is not set
3114 int y; ///< top left corner of pict, undefined when pict is not set
3115 int w; ///< width of pict, undefined when pict is not set
3116 int h; ///< height of pict, undefined when pict is not set
3117 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3120 * data+linesize for the bitmap of this subtitle.
3121 * can be set for text/ass as well once they where rendered
3124 enum AVSubtitleType type;
3126 char *text; ///< 0 terminated plain UTF-8 text
3129 * 0 terminated ASS/SSA compatible event line.
3130 * The presentation of this is unaffected by the other values in this
3138 typedef struct AVSubtitle {
3139 uint16_t format; /* 0 = graphics */
3140 uint32_t start_display_time; /* relative to packet pts, in ms */
3141 uint32_t end_display_time; /* relative to packet pts, in ms */
3143 AVSubtitleRect **rects;
3144 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3148 * If c is NULL, returns the first registered codec,
3149 * if c is non-NULL, returns the next registered codec after c,
3150 * or NULL if c is the last one.
3152 AVCodec *av_codec_next(const AVCodec *c);
3155 * Return the LIBAVCODEC_VERSION_INT constant.
3157 unsigned avcodec_version(void);
3160 * Return the libavcodec build-time configuration.
3162 const char *avcodec_configuration(void);
3165 * Return the libavcodec license.
3167 const char *avcodec_license(void);
3170 * Register the codec codec and initialize libavcodec.
3172 * @warning either this function or avcodec_register_all() must be called
3173 * before any other libavcodec functions.
3175 * @see avcodec_register_all()
3177 void avcodec_register(AVCodec *codec);
3180 * Register all the codecs, parsers and bitstream filters which were enabled at
3181 * configuration time. If you do not call this function you can select exactly
3182 * which formats you want to support, by using the individual registration
3185 * @see avcodec_register
3186 * @see av_register_codec_parser
3187 * @see av_register_bitstream_filter
3189 void avcodec_register_all(void);
3192 #if FF_API_ALLOC_CONTEXT
3194 * Allocate an AVCodecContext and set its fields to default values. The
3195 * resulting struct can be deallocated by simply calling av_free().
3197 * @return An AVCodecContext filled with default values or NULL on failure.
3198 * @see avcodec_get_context_defaults
3200 * @deprecated use avcodec_alloc_context3()
3202 attribute_deprecated
3203 AVCodecContext *avcodec_alloc_context(void);
3205 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3206 * we WILL change its arguments and name a few times! */
3207 attribute_deprecated
3208 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3211 * Set the fields of the given AVCodecContext to default values.
3213 * @param s The AVCodecContext of which the fields should be set to default values.
3214 * @deprecated use avcodec_get_context_defaults3
3216 attribute_deprecated
3217 void avcodec_get_context_defaults(AVCodecContext *s);
3219 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3220 * we WILL change its arguments and name a few times! */
3221 attribute_deprecated
3222 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3226 * Allocate an AVCodecContext and set its fields to default values. The
3227 * resulting struct can be deallocated by calling avcodec_close() on it followed
3230 * @param codec if non-NULL, allocate private data and initialize defaults
3231 * for the given codec. It is illegal to then call avcodec_open2()
3232 * with a different codec.
3233 * If NULL, then the codec-specific defaults won't be initialized,
3234 * which may result in suboptimal default settings (this is
3235 * important mainly for encoders, e.g. libx264).
3237 * @return An AVCodecContext filled with default values or NULL on failure.
3238 * @see avcodec_get_context_defaults
3240 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3243 * Set the fields of the given AVCodecContext to default values corresponding
3244 * to the given codec (defaults may be codec-dependent).
3246 * Do not call this function if a non-NULL codec has been passed
3247 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3248 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3249 * different codec on this AVCodecContext.
3251 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3254 * Get the AVClass for AVCodecContext. It can be used in combination with
3255 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3257 * @see av_opt_find().
3259 const AVClass *avcodec_get_class(void);
3262 * Get the AVClass for AVFrame. It can be used in combination with
3263 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3265 * @see av_opt_find().
3267 const AVClass *avcodec_get_frame_class(void);
3270 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3271 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3273 * @see av_opt_find().
3275 const AVClass *avcodec_get_subtitle_rect_class(void);
3278 * Copy the settings of the source AVCodecContext into the destination
3279 * AVCodecContext. The resulting destination codec context will be
3280 * unopened, i.e. you are required to call avcodec_open2() before you
3281 * can use this AVCodecContext to decode/encode video/audio data.
3283 * @param dest target codec context, should be initialized with
3284 * avcodec_alloc_context3(), but otherwise uninitialized
3285 * @param src source codec context
3286 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3288 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3291 * Allocate an AVFrame and set its fields to default values. The resulting
3292 * struct must be freed using avcodec_free_frame().
3294 * @return An AVFrame filled with default values or NULL on failure.
3295 * @see avcodec_get_frame_defaults
3297 AVFrame *avcodec_alloc_frame(void);
3300 * Set the fields of the given AVFrame to default values.
3302 * @param frame The AVFrame of which the fields should be set to default values.
3304 void avcodec_get_frame_defaults(AVFrame *frame);
3307 * Free the frame and any dynamically allocated objects in it,
3308 * e.g. extended_data.
3310 * @param frame frame to be freed. The pointer will be set to NULL.
3312 * @warning this function does NOT free the data buffers themselves
3313 * (it does not know how, since they might have been allocated with
3314 * a custom get_buffer()).
3316 void avcodec_free_frame(AVFrame **frame);
3318 #if FF_API_AVCODEC_OPEN
3320 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3321 * function the context has to be allocated.
3323 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3324 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3325 * retrieving a codec.
3327 * @warning This function is not thread safe!
3330 * avcodec_register_all();
3331 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3335 * context = avcodec_alloc_context3(codec);
3337 * if (avcodec_open(context, codec) < 0)
3341 * @param avctx The context which will be set up to use the given codec.
3342 * @param codec The codec to use within the context.
3343 * @return zero on success, a negative value on error
3344 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3346 * @deprecated use avcodec_open2
3348 attribute_deprecated
3349 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3353 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3354 * function the context has to be allocated with avcodec_alloc_context3().
3356 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3357 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3358 * retrieving a codec.
3360 * @warning This function is not thread safe!
3363 * avcodec_register_all();
3364 * av_dict_set(&opts, "b", "2.5M", 0);
3365 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3369 * context = avcodec_alloc_context3(codec);
3371 * if (avcodec_open2(context, codec, opts) < 0)
3375 * @param avctx The context to initialize.
3376 * @param codec The codec to open this context for. If a non-NULL codec has been
3377 * previously passed to avcodec_alloc_context3() or
3378 * avcodec_get_context_defaults3() for this context, then this
3379 * parameter MUST be either NULL or equal to the previously passed
3381 * @param options A dictionary filled with AVCodecContext and codec-private options.
3382 * On return this object will be filled with options that were not found.
3384 * @return zero on success, a negative value on error
3385 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3386 * av_dict_set(), av_opt_find().
3388 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3391 * Close a given AVCodecContext and free all the data associated with it
3392 * (but not the AVCodecContext itself).
3394 * Calling this function on an AVCodecContext that hasn't been opened will free
3395 * the codec-specific data allocated in avcodec_alloc_context3() /
3396 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3399 int avcodec_close(AVCodecContext *avctx);
3402 * Free all allocated data in the given subtitle struct.
3404 * @param sub AVSubtitle to free.
3406 void avsubtitle_free(AVSubtitle *sub);
3413 * @addtogroup lavc_packet
3417 #if FF_API_DESTRUCT_PACKET
3419 * Default packet destructor.
3420 * @deprecated use the AVBuffer API instead
3422 attribute_deprecated
3423 void av_destruct_packet(AVPacket *pkt);
3427 * Initialize optional fields of a packet with default values.
3429 * Note, this does not touch the data and size members, which have to be
3430 * initialized separately.
3434 void av_init_packet(AVPacket *pkt);
3437 * Allocate the payload of a packet and initialize its fields with
3441 * @param size wanted payload size
3442 * @return 0 if OK, AVERROR_xxx otherwise
3444 int av_new_packet(AVPacket *pkt, int size);
3447 * Reduce packet size, correctly zeroing padding
3450 * @param size new size
3452 void av_shrink_packet(AVPacket *pkt, int size);
3455 * Increase packet size, correctly zeroing padding
3458 * @param grow_by number of bytes by which to increase the size of the packet
3460 int av_grow_packet(AVPacket *pkt, int grow_by);
3463 * Initialize a reference-counted packet from av_malloc()ed data.
3465 * @param pkt packet to be initialized. This function will set the data, size,
3466 * buf and destruct fields, all others are left untouched.
3467 * @param data Data allocated by av_malloc() to be used as packet data. If this
3468 * function returns successfully, the data is owned by the underlying AVBuffer.
3469 * The caller may not access the data through other means.
3470 * @param size size of data in bytes, without the padding. I.e. the full buffer
3471 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3473 * @return 0 on success, a negative AVERROR on error
3475 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3478 * @warning This is a hack - the packet memory allocation stuff is broken. The
3479 * packet is allocated if it was not really allocated.
3481 int av_dup_packet(AVPacket *pkt);
3484 * Copy packet, including contents
3486 * @return 0 on success, negative AVERROR on fail
3488 int av_copy_packet(AVPacket *dst, AVPacket *src);
3491 * Copy packet side data
3493 * @return 0 on success, negative AVERROR on fail
3495 int av_copy_packet_side_data(AVPacket *dst, AVPacket *src);
3500 * @param pkt packet to free
3502 void av_free_packet(AVPacket *pkt);
3505 * Allocate new information of a packet.
3508 * @param type side information type
3509 * @param size side information size
3510 * @return pointer to fresh allocated data or NULL otherwise
3512 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3516 * Shrink the already allocated side data buffer
3519 * @param type side information type
3520 * @param size new side information size
3521 * @return 0 on success, < 0 on failure
3523 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3527 * Get side information from packet.
3530 * @param type desired side information type
3531 * @param size pointer for side information size to store (optional)
3532 * @return pointer to data if present or NULL otherwise
3534 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3537 int av_packet_merge_side_data(AVPacket *pkt);
3539 int av_packet_split_side_data(AVPacket *pkt);
3547 * @addtogroup lavc_decoding
3552 * Find a registered decoder with a matching codec ID.
3554 * @param id AVCodecID of the requested decoder
3555 * @return A decoder if one was found, NULL otherwise.
3557 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3560 * Find a registered decoder with the specified name.
3562 * @param name name of the requested decoder
3563 * @return A decoder if one was found, NULL otherwise.
3565 AVCodec *avcodec_find_decoder_by_name(const char *name);
3567 #if FF_API_GET_BUFFER
3568 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3569 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3570 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3574 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3575 * it can be called by custom get_buffer2() implementations for decoders without
3576 * CODEC_CAP_DR1 set.
3578 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3581 * Return the amount of padding in pixels which the get_buffer callback must
3582 * provide around the edge of the image for codecs which do not have the
3583 * CODEC_FLAG_EMU_EDGE flag.
3585 * @return Required padding in pixels.
3587 unsigned avcodec_get_edge_width(void);
3590 * Modify width and height values so that they will result in a memory
3591 * buffer that is acceptable for the codec if you do not use any horizontal
3594 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3595 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3596 * according to avcodec_get_edge_width() before.
3598 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3601 * Modify width and height values so that they will result in a memory
3602 * buffer that is acceptable for the codec if you also ensure that all
3603 * line sizes are a multiple of the respective linesize_align[i].
3605 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3606 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3607 * according to avcodec_get_edge_width() before.
3609 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3610 int linesize_align[AV_NUM_DATA_POINTERS]);
3612 #if FF_API_OLD_DECODE_AUDIO
3614 * Wrapper function which calls avcodec_decode_audio4.
3616 * @deprecated Use avcodec_decode_audio4 instead.
3618 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3619 * Some decoders may support multiple frames in a single AVPacket, such
3620 * decoders would then just decode the first frame. In this case,
3621 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3622 * the remaining data in order to decode the second frame etc.
3624 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3625 * decompressed frame size in bytes.
3627 * @warning You must set frame_size_ptr to the allocated size of the
3628 * output buffer before calling avcodec_decode_audio3().
3630 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3631 * the actual read bytes because some optimized bitstream readers read 32 or 64
3632 * bits at once and could read over the end.
3634 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3635 * no overreading happens for damaged MPEG streams.
3637 * @warning You must not provide a custom get_buffer() when using
3638 * avcodec_decode_audio3(). Doing so will override it with
3639 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3640 * which does allow the application to provide a custom get_buffer().
3642 * @note You might have to align the input buffer avpkt->data and output buffer
3643 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3644 * necessary at all, on others it won't work at all if not aligned and on others
3645 * it will work but it will have an impact on performance.
3647 * In practice, avpkt->data should have 4 byte alignment at minimum and
3648 * samples should be 16 byte aligned unless the CPU doesn't need it
3649 * (AltiVec and SSE do).
3651 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3652 * between input and output, these need to be fed with avpkt->data=NULL,
3653 * avpkt->size=0 at the end to return the remaining frames.
3655 * @param avctx the codec context
3656 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3657 * If the sample format is planar, each channel plane will
3658 * be the same size, with no padding between channels.
3659 * @param[in,out] frame_size_ptr the output buffer size in bytes
3660 * @param[in] avpkt The input AVPacket containing the input buffer.
3661 * You can create such packet with av_init_packet() and by then setting
3662 * data and size, some decoders might in addition need other fields.
3663 * All decoders are designed to use the least fields possible though.
3664 * @return On error a negative value is returned, otherwise the number of bytes
3665 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3667 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3668 int *frame_size_ptr,
3673 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3675 * Some decoders may support multiple frames in a single AVPacket. Such
3676 * decoders would then just decode the first frame. In this case,
3677 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3678 * the remaining data in order to decode the second frame, etc...
3679 * Even if no frames are returned, the packet needs to be fed to the decoder
3680 * with remaining data until it is completely consumed or an error occurs.
3682 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3683 * larger than the actual read bytes because some optimized bitstream
3684 * readers read 32 or 64 bits at once and could read over the end.
3686 * @note You might have to align the input buffer. The alignment requirements
3687 * depend on the CPU and the decoder.
3689 * @param avctx the codec context
3690 * @param[out] frame The AVFrame in which to store decoded audio samples.
3691 * The decoder will allocate a buffer for the decoded frame by
3692 * calling the AVCodecContext.get_buffer2() callback.
3693 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3694 * reference counted and the returned reference belongs to the
3695 * caller. The caller must release the frame using av_frame_unref()
3696 * when the frame is no longer needed. The caller may safely write
3697 * to the frame if av_frame_is_writable() returns 1.
3698 * When AVCodecContext.refcounted_frames is set to 0, the returned
3699 * reference belongs to the decoder and is valid only until the
3700 * next call to this function or until closing the decoder.
3701 * The caller may not write to it.
3702 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3704 * @param[in] avpkt The input AVPacket containing the input buffer.
3705 * At least avpkt->data and avpkt->size should be set. Some
3706 * decoders might also require additional fields to be set.
3707 * @return A negative error code is returned if an error occurred during
3708 * decoding, otherwise the number of bytes consumed from the input
3709 * AVPacket is returned.
3711 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3712 int *got_frame_ptr, const AVPacket *avpkt);
3715 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3716 * Some decoders may support multiple frames in a single AVPacket, such
3717 * decoders would then just decode the first frame.
3719 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3720 * the actual read bytes because some optimized bitstream readers read 32 or 64
3721 * bits at once and could read over the end.
3723 * @warning The end of the input buffer buf should be set to 0 to ensure that
3724 * no overreading happens for damaged MPEG streams.
3726 * @note You might have to align the input buffer avpkt->data.
3727 * The alignment requirements depend on the CPU: on some CPUs it isn't
3728 * necessary at all, on others it won't work at all if not aligned and on others
3729 * it will work but it will have an impact on performance.
3731 * In practice, avpkt->data should have 4 byte alignment at minimum.
3733 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3734 * between input and output, these need to be fed with avpkt->data=NULL,
3735 * avpkt->size=0 at the end to return the remaining frames.
3737 * @param avctx the codec context
3738 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3739 * Use av_frame_alloc() to get an AVFrame. The codec will
3740 * allocate memory for the actual bitmap by calling the
3741 * AVCodecContext.get_buffer2() callback.
3742 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3743 * reference counted and the returned reference belongs to the
3744 * caller. The caller must release the frame using av_frame_unref()
3745 * when the frame is no longer needed. The caller may safely write
3746 * to the frame if av_frame_is_writable() returns 1.
3747 * When AVCodecContext.refcounted_frames is set to 0, the returned
3748 * reference belongs to the decoder and is valid only until the
3749 * next call to this function or until closing the decoder. The
3750 * caller may not write to it.
3752 * @param[in] avpkt The input AVpacket containing the input buffer.
3753 * You can create such packet with av_init_packet() and by then setting
3754 * data and size, some decoders might in addition need other fields like
3755 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3757 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3758 * @return On error a negative value is returned, otherwise the number of bytes
3759 * used or zero if no frame could be decompressed.
3761 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3762 int *got_picture_ptr,
3763 const AVPacket *avpkt);
3766 * Decode a subtitle message.
3767 * Return a negative value on error, otherwise return the number of bytes used.
3768 * If no subtitle could be decompressed, got_sub_ptr is zero.
3769 * Otherwise, the subtitle is stored in *sub.
3770 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3771 * simplicity, because the performance difference is expect to be negligible
3772 * and reusing a get_buffer written for video codecs would probably perform badly
3773 * due to a potentially very different allocation pattern.
3775 * @param avctx the codec context
3776 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3777 freed with avsubtitle_free if *got_sub_ptr is set.
3778 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3779 * @param[in] avpkt The input AVPacket containing the input buffer.
3781 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3786 * @defgroup lavc_parsing Frame parsing
3790 typedef struct AVCodecParserContext {
3792 struct AVCodecParser *parser;
3793 int64_t frame_offset; /* offset of the current frame */
3794 int64_t cur_offset; /* current offset
3795 (incremented by each av_parser_parse()) */
3796 int64_t next_frame_offset; /* offset of the next frame */
3798 int pict_type; /* XXX: Put it back in AVCodecContext. */
3800 * This field is used for proper frame duration computation in lavf.
3801 * It signals, how much longer the frame duration of the current frame
3802 * is compared to normal frame duration.
3804 * frame_duration = (1 + repeat_pict) * time_base
3806 * It is used by codecs like H.264 to display telecined material.
3808 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3809 int64_t pts; /* pts of the current frame */
3810 int64_t dts; /* dts of the current frame */
3815 int fetch_timestamp;
3817 #define AV_PARSER_PTS_NB 4
3818 int cur_frame_start_index;
3819 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3820 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3821 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3824 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3825 #define PARSER_FLAG_ONCE 0x0002
3826 /// Set if the parser has a valid file offset
3827 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3828 #define PARSER_FLAG_USE_CODEC_TS 0x1000
3830 int64_t offset; ///< byte offset from starting packet start
3831 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3834 * Set by parser to 1 for key frames and 0 for non-key frames.
3835 * It is initialized to -1, so if the parser doesn't set this flag,
3836 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3842 * Time difference in stream time base units from the pts of this
3843 * packet to the point at which the output from the decoder has converged
3844 * independent from the availability of previous frames. That is, the
3845 * frames are virtually identical no matter if decoding started from
3846 * the very first frame or from this keyframe.
3847 * Is AV_NOPTS_VALUE if unknown.
3848 * This field is not the display duration of the current frame.
3849 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3852 * The purpose of this field is to allow seeking in streams that have no
3853 * keyframes in the conventional sense. It corresponds to the
3854 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3855 * essential for some types of subtitle streams to ensure that all
3856 * subtitles are correctly displayed after seeking.
3858 int64_t convergence_duration;
3860 // Timestamp generation support:
3862 * Synchronization point for start of timestamp generation.
3864 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3867 * For example, this corresponds to presence of H.264 buffering period
3873 * Offset of the current timestamp against last timestamp sync point in
3874 * units of AVCodecContext.time_base.
3876 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3877 * contain a valid timestamp offset.
3879 * Note that the timestamp of sync point has usually a nonzero
3880 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3881 * the next frame after timestamp sync point will be usually 1.
3883 * For example, this corresponds to H.264 cpb_removal_delay.
3885 int dts_ref_dts_delta;
3888 * Presentation delay of current frame in units of AVCodecContext.time_base.
3890 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3891 * contain valid non-negative timestamp delta (presentation time of a frame
3892 * must not lie in the past).
3894 * This delay represents the difference between decoding and presentation
3895 * time of the frame.
3897 * For example, this corresponds to H.264 dpb_output_delay.
3902 * Position of the packet in file.
3904 * Analogous to cur_frame_pts/dts
3906 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3909 * Byte position of currently parsed frame in stream.
3914 * Previous frame byte position.
3919 * Duration of the current frame.
3920 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3921 * For all other types, this is in units of AVCodecContext.time_base.
3925 enum AVFieldOrder field_order;
3926 } AVCodecParserContext;
3928 typedef struct AVCodecParser {
3929 int codec_ids[5]; /* several codec IDs are permitted */
3931 int (*parser_init)(AVCodecParserContext *s);
3932 int (*parser_parse)(AVCodecParserContext *s,
3933 AVCodecContext *avctx,
3934 const uint8_t **poutbuf, int *poutbuf_size,
3935 const uint8_t *buf, int buf_size);
3936 void (*parser_close)(AVCodecParserContext *s);
3937 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3938 struct AVCodecParser *next;
3941 AVCodecParser *av_parser_next(AVCodecParser *c);
3943 void av_register_codec_parser(AVCodecParser *parser);
3944 AVCodecParserContext *av_parser_init(int codec_id);
3949 * @param s parser context.
3950 * @param avctx codec context.
3951 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3952 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3953 * @param buf input buffer.
3954 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3955 * @param pts input presentation timestamp.
3956 * @param dts input decoding timestamp.
3957 * @param pos input byte position in stream.
3958 * @return the number of bytes of the input bitstream used.
3963 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3970 * decode_frame(data, size);
3974 int av_parser_parse2(AVCodecParserContext *s,
3975 AVCodecContext *avctx,
3976 uint8_t **poutbuf, int *poutbuf_size,
3977 const uint8_t *buf, int buf_size,
3978 int64_t pts, int64_t dts,
3982 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3983 * @deprecated use AVBitStreamFilter
3985 int av_parser_change(AVCodecParserContext *s,
3986 AVCodecContext *avctx,
3987 uint8_t **poutbuf, int *poutbuf_size,
3988 const uint8_t *buf, int buf_size, int keyframe);
3989 void av_parser_close(AVCodecParserContext *s);
3997 * @addtogroup lavc_encoding
4002 * Find a registered encoder with a matching codec ID.
4004 * @param id AVCodecID of the requested encoder
4005 * @return An encoder if one was found, NULL otherwise.
4007 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4010 * Find a registered encoder with the specified name.
4012 * @param name name of the requested encoder
4013 * @return An encoder if one was found, NULL otherwise.
4015 AVCodec *avcodec_find_encoder_by_name(const char *name);
4017 #if FF_API_OLD_ENCODE_AUDIO
4019 * Encode an audio frame from samples into buf.
4021 * @deprecated Use avcodec_encode_audio2 instead.
4023 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4024 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4025 * will know how much space is needed because it depends on the value passed
4026 * in buf_size as described below. In that case a lower value can be used.
4028 * @param avctx the codec context
4029 * @param[out] buf the output buffer
4030 * @param[in] buf_size the output buffer size
4031 * @param[in] samples the input buffer containing the samples
4032 * The number of samples read from this buffer is frame_size*channels,
4033 * both of which are defined in avctx.
4034 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4035 * samples read from samples is equal to:
4036 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4037 * This also implies that av_get_bits_per_sample() must not return 0 for these
4039 * @return On error a negative value is returned, on success zero or the number
4040 * of bytes used to encode the data read from the input buffer.
4042 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4043 uint8_t *buf, int buf_size,
4044 const short *samples);
4048 * Encode a frame of audio.
4050 * Takes input samples from frame and writes the next output packet, if
4051 * available, to avpkt. The output packet does not necessarily contain data for
4052 * the most recent frame, as encoders can delay, split, and combine input frames
4053 * internally as needed.
4055 * @param avctx codec context
4056 * @param avpkt output AVPacket.
4057 * The user can supply an output buffer by setting
4058 * avpkt->data and avpkt->size prior to calling the
4059 * function, but if the size of the user-provided data is not
4060 * large enough, encoding will fail. If avpkt->data and
4061 * avpkt->size are set, avpkt->destruct must also be set. All
4062 * other AVPacket fields will be reset by the encoder using
4063 * av_init_packet(). If avpkt->data is NULL, the encoder will
4064 * allocate it. The encoder will set avpkt->size to the size
4065 * of the output packet.
4067 * If this function fails or produces no output, avpkt will be
4068 * freed using av_free_packet() (i.e. avpkt->destruct will be
4069 * called to free the user supplied buffer).
4070 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4071 * May be NULL when flushing an encoder that has the
4072 * CODEC_CAP_DELAY capability set.
4073 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4074 * can have any number of samples.
4075 * If it is not set, frame->nb_samples must be equal to
4076 * avctx->frame_size for all frames except the last.
4077 * The final frame may be smaller than avctx->frame_size.
4078 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4079 * output packet is non-empty, and to 0 if it is
4080 * empty. If the function returns an error, the
4081 * packet can be assumed to be invalid, and the
4082 * value of got_packet_ptr is undefined and should
4084 * @return 0 on success, negative error code on failure
4086 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4087 const AVFrame *frame, int *got_packet_ptr);
4089 #if FF_API_OLD_ENCODE_VIDEO
4091 * @deprecated use avcodec_encode_video2() instead.
4093 * Encode a video frame from pict into buf.
4094 * The input picture should be
4095 * stored using a specific format, namely avctx.pix_fmt.
4097 * @param avctx the codec context
4098 * @param[out] buf the output buffer for the bitstream of encoded frame
4099 * @param[in] buf_size the size of the output buffer in bytes
4100 * @param[in] pict the input picture to encode
4101 * @return On error a negative value is returned, on success zero or the number
4102 * of bytes used from the output buffer.
4104 attribute_deprecated
4105 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4106 const AVFrame *pict);
4110 * Encode a frame of video.
4112 * Takes input raw video data from frame and writes the next output packet, if
4113 * available, to avpkt. The output packet does not necessarily contain data for
4114 * the most recent frame, as encoders can delay and reorder input frames
4115 * internally as needed.
4117 * @param avctx codec context
4118 * @param avpkt output AVPacket.
4119 * The user can supply an output buffer by setting
4120 * avpkt->data and avpkt->size prior to calling the
4121 * function, but if the size of the user-provided data is not
4122 * large enough, encoding will fail. All other AVPacket fields
4123 * will be reset by the encoder using av_init_packet(). If
4124 * avpkt->data is NULL, the encoder will allocate it.
4125 * The encoder will set avpkt->size to the size of the
4126 * output packet. The returned data (if any) belongs to the
4127 * caller, he is responsible for freeing it.
4129 * If this function fails or produces no output, avpkt will be
4130 * freed using av_free_packet() (i.e. avpkt->destruct will be
4131 * called to free the user supplied buffer).
4132 * @param[in] frame AVFrame containing the raw video data to be encoded.
4133 * May be NULL when flushing an encoder that has the
4134 * CODEC_CAP_DELAY capability set.
4135 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4136 * output packet is non-empty, and to 0 if it is
4137 * empty. If the function returns an error, the
4138 * packet can be assumed to be invalid, and the
4139 * value of got_packet_ptr is undefined and should
4141 * @return 0 on success, negative error code on failure
4143 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4144 const AVFrame *frame, int *got_packet_ptr);
4146 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4147 const AVSubtitle *sub);
4154 #if FF_API_AVCODEC_RESAMPLE
4156 * @defgroup lavc_resample Audio resampling
4158 * @deprecated use libswresample instead
4162 struct ReSampleContext;
4163 struct AVResampleContext;
4165 typedef struct ReSampleContext ReSampleContext;
4168 * Initialize audio resampling context.
4170 * @param output_channels number of output channels
4171 * @param input_channels number of input channels
4172 * @param output_rate output sample rate
4173 * @param input_rate input sample rate
4174 * @param sample_fmt_out requested output sample format
4175 * @param sample_fmt_in input sample format
4176 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4177 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4178 * @param linear if 1 then the used FIR filter will be linearly interpolated
4179 between the 2 closest, if 0 the closest will be used
4180 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4181 * @return allocated ReSampleContext, NULL if error occurred
4183 attribute_deprecated
4184 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4185 int output_rate, int input_rate,
4186 enum AVSampleFormat sample_fmt_out,
4187 enum AVSampleFormat sample_fmt_in,
4188 int filter_length, int log2_phase_count,
4189 int linear, double cutoff);
4191 attribute_deprecated
4192 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4195 * Free resample context.
4197 * @param s a non-NULL pointer to a resample context previously
4198 * created with av_audio_resample_init()
4200 attribute_deprecated
4201 void audio_resample_close(ReSampleContext *s);
4205 * Initialize an audio resampler.
4206 * Note, if either rate is not an integer then simply scale both rates up so they are.
4207 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4208 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4209 * @param linear If 1 then the used FIR filter will be linearly interpolated
4210 between the 2 closest, if 0 the closest will be used
4211 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4213 attribute_deprecated
4214 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4217 * Resample an array of samples using a previously configured context.
4218 * @param src an array of unconsumed samples
4219 * @param consumed the number of samples of src which have been consumed are returned here
4220 * @param src_size the number of unconsumed samples available
4221 * @param dst_size the amount of space in samples available in dst
4222 * @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.
4223 * @return the number of samples written in dst or -1 if an error occurred
4225 attribute_deprecated
4226 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4230 * Compensate samplerate/timestamp drift. The compensation is done by changing
4231 * the resampler parameters, so no audible clicks or similar distortions occur
4232 * @param compensation_distance distance in output samples over which the compensation should be performed
4233 * @param sample_delta number of output samples which should be output less
4235 * example: av_resample_compensate(c, 10, 500)
4236 * here instead of 510 samples only 500 samples would be output
4238 * note, due to rounding the actual compensation might be slightly different,
4239 * especially if the compensation_distance is large and the in_rate used during init is small
4241 attribute_deprecated
4242 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4243 attribute_deprecated
4244 void av_resample_close(struct AVResampleContext *c);
4252 * @addtogroup lavc_picture
4257 * Allocate memory for a picture. Call avpicture_free() to free it.
4259 * @see avpicture_fill()
4261 * @param picture the picture to be filled in
4262 * @param pix_fmt the format of the picture
4263 * @param width the width of the picture
4264 * @param height the height of the picture
4265 * @return zero if successful, a negative value if not
4267 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4270 * Free a picture previously allocated by avpicture_alloc().
4271 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4274 * @param picture the AVPicture to be freed
4276 void avpicture_free(AVPicture *picture);
4279 * Fill in the AVPicture fields, always assume a linesize alignment of
4282 * @see av_image_fill_arrays()
4284 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4285 enum AVPixelFormat pix_fmt, int width, int height);
4288 * Copy pixel data from an AVPicture into a buffer, always assume a
4289 * linesize alignment of 1.
4291 * @see av_image_copy_to_buffer()
4293 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4294 int width, int height,
4295 unsigned char *dest, int dest_size);
4298 * Calculate the size in bytes that a picture of the given width and height
4299 * would occupy if stored in the given picture format.
4300 * Always assume a linesize alignment of 1.
4302 * @see av_image_get_buffer_size().
4304 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4306 #if FF_API_DEINTERLACE
4308 * deinterlace - if not supported return -1
4310 * @deprecated - use yadif (in libavfilter) instead
4312 attribute_deprecated
4313 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4314 enum AVPixelFormat pix_fmt, int width, int height);
4317 * Copy image src to dst. Wraps av_image_copy().
4319 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4320 enum AVPixelFormat pix_fmt, int width, int height);
4323 * Crop image top and left side.
4325 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4326 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4331 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4332 int padtop, int padbottom, int padleft, int padright, int *color);
4339 * @defgroup lavc_misc Utility functions
4342 * Miscellaneous utility functions related to both encoding and decoding
4348 * @defgroup lavc_misc_pixfmt Pixel formats
4350 * Functions for working with pixel formats.
4355 * Utility function to access log2_chroma_w log2_chroma_h from
4356 * the pixel format AVPixFmtDescriptor.
4358 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4359 * for one that returns a failure code and continues in case of invalid
4362 * @param[in] pix_fmt the pixel format
4363 * @param[out] h_shift store log2_chroma_w
4364 * @param[out] v_shift store log2_chroma_h
4366 * @see av_pix_fmt_get_chroma_sub_sample
4369 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4372 * Return a value representing the fourCC code associated to the
4373 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4376 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4378 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4379 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4380 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4381 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4382 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4383 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4386 * Compute what kind of losses will occur when converting from one specific
4387 * pixel format to another.
4388 * When converting from one pixel format to another, information loss may occur.
4389 * For example, when converting from RGB24 to GRAY, the color information will
4390 * be lost. Similarly, other losses occur when converting from some formats to
4391 * other formats. These losses can involve loss of chroma, but also loss of
4392 * resolution, loss of color depth, loss due to the color space conversion, loss
4393 * of the alpha bits or loss due to color quantization.
4394 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4395 * which will occur when converting from one pixel format to another.
4397 * @param[in] dst_pix_fmt destination pixel format
4398 * @param[in] src_pix_fmt source pixel format
4399 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4400 * @return Combination of flags informing you what kind of losses will occur
4401 * (maximum loss for an invalid dst_pix_fmt).
4403 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4407 * Find the best pixel format to convert to given a certain source pixel
4408 * format. When converting from one pixel format to another, information loss
4409 * may occur. For example, when converting from RGB24 to GRAY, the color
4410 * information will be lost. Similarly, other losses occur when converting from
4411 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4412 * the given pixel formats should be used to suffer the least amount of loss.
4413 * The pixel formats from which it chooses one, are determined by the
4414 * pix_fmt_list parameter.
4417 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4418 * @param[in] src_pix_fmt source pixel format
4419 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4420 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4421 * @return The best pixel format to convert to or -1 if none was found.
4423 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(enum AVPixelFormat *pix_fmt_list,
4424 enum AVPixelFormat src_pix_fmt,
4425 int has_alpha, int *loss_ptr);
4428 * Find the best pixel format to convert to given a certain source pixel
4429 * format and a selection of two destination pixel formats. When converting from
4430 * one pixel format to another, information loss may occur. For example, when converting
4431 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4432 * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4433 * the given pixel formats should be used to suffer the least amount of loss.
4435 * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be
4439 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4440 * dst_pix_fmt1= AV_PIX_FMT_RGB24;
4441 * dst_pix_fmt2= AV_PIX_FMT_GRAY8;
4442 * dst_pix_fmt3= AV_PIX_FMT_RGB8;
4443 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4444 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4445 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4448 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4449 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4450 * @param[in] src_pix_fmt Source pixel format
4451 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4452 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4453 * NULL or value of zero means we care about all losses. Out: the loss
4454 * that occurs when converting from src to selected dst pixel format.
4455 * @return The best pixel format to convert to or -1 if none was found.
4457 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4458 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4460 attribute_deprecated
4461 #if AV_HAVE_INCOMPATIBLE_FORK_ABI
4462 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4463 enum AVPixelFormat src_pix_fmt,
4464 int has_alpha, int *loss_ptr);
4466 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4467 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4471 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4477 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4480 * Put a string representing the codec tag codec_tag in buf.
4482 * @param buf_size size in bytes of buf
4483 * @return the length of the string that would have been generated if
4484 * enough space had been available, excluding the trailing null
4486 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4488 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4491 * Return a name for the specified profile, if available.
4493 * @param codec the codec that is searched for the given profile
4494 * @param profile the profile value for which a name is requested
4495 * @return A name for the profile if found, NULL otherwise.
4497 const char *av_get_profile_name(const AVCodec *codec, int profile);
4499 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4500 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4501 //FIXME func typedef
4504 * Fill AVFrame audio data and linesize pointers.
4506 * The buffer buf must be a preallocated buffer with a size big enough
4507 * to contain the specified samples amount. The filled AVFrame data
4508 * pointers will point to this buffer.
4510 * AVFrame extended_data channel pointers are allocated if necessary for
4513 * @param frame the AVFrame
4514 * frame->nb_samples must be set prior to calling the
4515 * function. This function fills in frame->data,
4516 * frame->extended_data, frame->linesize[0].
4517 * @param nb_channels channel count
4518 * @param sample_fmt sample format
4519 * @param buf buffer to use for frame data
4520 * @param buf_size size of buffer
4521 * @param align plane size sample alignment (0 = default)
4522 * @return >=0 on success, negative error code on failure
4523 * @todo return the size in bytes required to store the samples in
4524 * case of success, at the next libavutil bump
4526 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4527 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4528 int buf_size, int align);
4531 * Flush buffers, should be called when seeking or when switching to a different stream.
4533 void avcodec_flush_buffers(AVCodecContext *avctx);
4536 * Return codec bits per sample.
4538 * @param[in] codec_id the codec
4539 * @return Number of bits per sample or zero if unknown for the given codec.
4541 int av_get_bits_per_sample(enum AVCodecID codec_id);
4544 * Return the PCM codec associated with a sample format.
4545 * @param be endianness, 0 for little, 1 for big,
4546 * -1 (or anything else) for native
4547 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4549 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4552 * Return codec bits per sample.
4553 * Only return non-zero if the bits per sample is exactly correct, not an
4556 * @param[in] codec_id the codec
4557 * @return Number of bits per sample or zero if unknown for the given codec.
4559 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4562 * Return audio frame duration.
4564 * @param avctx codec context
4565 * @param frame_bytes size of the frame, or 0 if unknown
4566 * @return frame duration, in samples, if known. 0 if not able to
4569 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4572 typedef struct AVBitStreamFilterContext {
4574 struct AVBitStreamFilter *filter;
4575 AVCodecParserContext *parser;
4576 struct AVBitStreamFilterContext *next;
4577 } AVBitStreamFilterContext;
4580 typedef struct AVBitStreamFilter {
4583 int (*filter)(AVBitStreamFilterContext *bsfc,
4584 AVCodecContext *avctx, const char *args,
4585 uint8_t **poutbuf, int *poutbuf_size,
4586 const uint8_t *buf, int buf_size, int keyframe);
4587 void (*close)(AVBitStreamFilterContext *bsfc);
4588 struct AVBitStreamFilter *next;
4589 } AVBitStreamFilter;
4591 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4592 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4593 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4594 AVCodecContext *avctx, const char *args,
4595 uint8_t **poutbuf, int *poutbuf_size,
4596 const uint8_t *buf, int buf_size, int keyframe);
4597 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4599 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4604 * Reallocate the given block if it is not large enough, otherwise do nothing.
4608 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4611 * Allocate a buffer, reusing the given one if large enough.
4613 * Contrary to av_fast_realloc the current buffer contents might not be
4614 * preserved and on error the old buffer is freed, thus no special
4615 * handling to avoid memleaks is necessary.
4617 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4618 * @param size size of the buffer *ptr points to
4619 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4620 * *size 0 if an error occurred.
4622 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4625 * Same behaviour av_fast_malloc but the buffer has additional
4626 * FF_INPUT_BUFFER_PADDING_SIZE at the end which will will always be 0.
4628 * In addition the whole buffer will initially and after resizes
4629 * be 0-initialized so that no uninitialized data will ever appear.
4631 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4634 * Same behaviour av_fast_padded_malloc except that buffer will always
4635 * be 0-initialized after call.
4637 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4640 * Encode extradata length to a buffer. Used by xiph codecs.
4642 * @param s buffer to write to; must be at least (v/255+1) bytes long
4643 * @param v size of extradata in bytes
4644 * @return number of bytes written to the buffer.
4646 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4648 #if FF_API_MISSING_SAMPLE
4650 * Log a generic warning message about a missing feature. This function is
4651 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4652 * only, and would normally not be used by applications.
4653 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4654 * a pointer to an AVClass struct
4655 * @param[in] feature string containing the name of the missing feature
4656 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4657 * If want_sample is non-zero, additional verbage will be added to the log
4658 * message which tells the user how to report samples to the development
4660 * @deprecated Use avpriv_report_missing_feature() instead.
4662 attribute_deprecated
4663 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4666 * Log a generic warning message asking for a sample. This function is
4667 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4668 * only, and would normally not be used by applications.
4669 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4670 * a pointer to an AVClass struct
4671 * @param[in] msg string containing an optional message, or NULL if no message
4672 * @deprecated Use avpriv_request_sample() instead.
4674 attribute_deprecated
4675 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4676 #endif /* FF_API_MISSING_SAMPLE */
4679 * Register the hardware accelerator hwaccel.
4681 void av_register_hwaccel(AVHWAccel *hwaccel);
4684 * If hwaccel is NULL, returns the first registered hardware accelerator,
4685 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4686 * after hwaccel, or NULL if hwaccel is the last one.
4688 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4692 * Lock operation used by lockmgr
4695 AV_LOCK_CREATE, ///< Create a mutex
4696 AV_LOCK_OBTAIN, ///< Lock the mutex
4697 AV_LOCK_RELEASE, ///< Unlock the mutex
4698 AV_LOCK_DESTROY, ///< Free mutex resources
4702 * Register a user provided lock manager supporting the operations
4703 * specified by AVLockOp. mutex points to a (void *) where the
4704 * lockmgr should store/get a pointer to a user allocated mutex. It's
4705 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4707 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4708 * callback during the call to av_lockmgr_register().
4709 * Thus, the application must be prepared to handle that.
4710 * If cb is set to NULL the lockmgr will be unregistered.
4711 * Also note that during unregistration the previously registered
4712 * lockmgr callback may also be invoked.
4714 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4717 * Get the type of the given codec.
4719 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4722 * Get the name of a codec.
4723 * @return a static string identifying the codec; never NULL
4725 const char *avcodec_get_name(enum AVCodecID id);
4728 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4729 * with no corresponding avcodec_close()), 0 otherwise.
4731 int avcodec_is_open(AVCodecContext *s);
4734 * @return a non-zero number if codec is an encoder, zero otherwise
4736 int av_codec_is_encoder(const AVCodec *codec);
4739 * @return a non-zero number if codec is a decoder, zero otherwise
4741 int av_codec_is_decoder(const AVCodec *codec);
4744 * @return descriptor for given codec ID or NULL if no descriptor exists.
4746 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4749 * Iterate over all codec descriptors known to libavcodec.
4751 * @param prev previous descriptor. NULL to get the first descriptor.
4753 * @return next descriptor or NULL after the last descriptor
4755 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4758 * @return codec descriptor with the given name or NULL if no such descriptor
4761 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4767 #endif /* AVCODEC_AVCODEC_H */