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
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/channel_layout.h"
34 #include "libavutil/dict.h"
35 #include "libavutil/log.h"
36 #include "libavutil/pixfmt.h"
37 #include "libavutil/rational.h"
39 #include "libavcodec/version.h"
41 * @defgroup libavc Encoding/Decoding Library
44 * @defgroup lavc_decoding Decoding
48 * @defgroup lavc_encoding Encoding
52 * @defgroup lavc_codec Codecs
54 * @defgroup lavc_codec_native Native Codecs
57 * @defgroup lavc_codec_wrappers External library wrappers
60 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
64 * @defgroup lavc_internal Internal
72 * @defgroup lavc_core Core functions/structures.
75 * Basic definitions, functions for querying libavcodec capabilities,
76 * allocating core structures, etc.
82 * Identify the syntax and semantics of the bitstream.
83 * The principle is roughly:
84 * Two decoders with the same ID can decode the same streams.
85 * Two encoders with the same ID can encode compatible streams.
86 * There may be slight deviations from the principle due to implementation
89 * If you add a codec ID to this list, add it so that
90 * 1. no value of a existing codec ID changes (that would break ABI),
91 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
92 * This ensures that 2 forks can independently add AVCodecIDs without producing conflicts.
94 * After adding new codec IDs, do not forget to add an entry to the codec
95 * descriptor list and bump libavcodec minor version.
101 AV_CODEC_ID_MPEG1VIDEO,
102 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
103 AV_CODEC_ID_MPEG2VIDEO_XVMC,
114 AV_CODEC_ID_RAWVIDEO,
115 AV_CODEC_ID_MSMPEG4V1,
116 AV_CODEC_ID_MSMPEG4V2,
117 AV_CODEC_ID_MSMPEG4V3,
140 AV_CODEC_ID_INTERPLAY_VIDEO,
147 AV_CODEC_ID_MSVIDEO1,
152 AV_CODEC_ID_TRUEMOTION1,
153 AV_CODEC_ID_VMDVIDEO,
179 AV_CODEC_ID_TRUEMOTION2,
185 AV_CODEC_ID_SMACKVIDEO,
190 AV_CODEC_ID_JPEG2000,
196 AV_CODEC_ID_DSICINVIDEO,
197 AV_CODEC_ID_TIERTEXSEQVIDEO,
205 AV_CODEC_ID_BETHSOFTVID,
217 AV_CODEC_ID_ESCAPE124,
221 AV_CODEC_ID_MOTIONPIXELS,
233 AV_CODEC_ID_FLASHSV2,
234 AV_CODEC_ID_CDGRAPHICS,
237 AV_CODEC_ID_BINKVIDEO,
238 AV_CODEC_ID_IFF_ILBM,
239 AV_CODEC_ID_IFF_BYTERUN1,
245 AV_CODEC_ID_A64_MULTI,
246 AV_CODEC_ID_A64_MULTI5,
249 AV_CODEC_ID_LAGARITH,
253 AV_CODEC_ID_WMV3IMAGE,
254 AV_CODEC_ID_VC1IMAGE,
256 AV_CODEC_ID_BMV_VIDEO,
263 AV_CODEC_ID_ZEROCODEC,
270 AV_CODEC_ID_BRENDER_PIX= MKBETAG('B','P','I','X'),
271 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
272 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
273 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
274 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
276 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
277 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
278 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
279 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
280 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
281 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
282 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
283 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
284 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
285 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
286 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
287 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
289 /* various PCM "codecs" */
290 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
291 AV_CODEC_ID_PCM_S16LE = 0x10000,
292 AV_CODEC_ID_PCM_S16BE,
293 AV_CODEC_ID_PCM_U16LE,
294 AV_CODEC_ID_PCM_U16BE,
297 AV_CODEC_ID_PCM_MULAW,
298 AV_CODEC_ID_PCM_ALAW,
299 AV_CODEC_ID_PCM_S32LE,
300 AV_CODEC_ID_PCM_S32BE,
301 AV_CODEC_ID_PCM_U32LE,
302 AV_CODEC_ID_PCM_U32BE,
303 AV_CODEC_ID_PCM_S24LE,
304 AV_CODEC_ID_PCM_S24BE,
305 AV_CODEC_ID_PCM_U24LE,
306 AV_CODEC_ID_PCM_U24BE,
307 AV_CODEC_ID_PCM_S24DAUD,
308 AV_CODEC_ID_PCM_ZORK,
309 AV_CODEC_ID_PCM_S16LE_PLANAR,
311 AV_CODEC_ID_PCM_F32BE,
312 AV_CODEC_ID_PCM_F32LE,
313 AV_CODEC_ID_PCM_F64BE,
314 AV_CODEC_ID_PCM_F64LE,
315 AV_CODEC_ID_PCM_BLURAY,
318 AV_CODEC_ID_PCM_S8_PLANAR,
319 AV_CODEC_ID_PCM_S24LE_PLANAR = MKBETAG(24,'P','S','P'),
320 AV_CODEC_ID_PCM_S32LE_PLANAR = MKBETAG(32,'P','S','P'),
321 AV_CODEC_ID_PCM_S16BE_PLANAR = MKBETAG('P','S','P',16),
323 /* various ADPCM codecs */
324 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
325 AV_CODEC_ID_ADPCM_IMA_WAV,
326 AV_CODEC_ID_ADPCM_IMA_DK3,
327 AV_CODEC_ID_ADPCM_IMA_DK4,
328 AV_CODEC_ID_ADPCM_IMA_WS,
329 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
330 AV_CODEC_ID_ADPCM_MS,
331 AV_CODEC_ID_ADPCM_4XM,
332 AV_CODEC_ID_ADPCM_XA,
333 AV_CODEC_ID_ADPCM_ADX,
334 AV_CODEC_ID_ADPCM_EA,
335 AV_CODEC_ID_ADPCM_G726,
336 AV_CODEC_ID_ADPCM_CT,
337 AV_CODEC_ID_ADPCM_SWF,
338 AV_CODEC_ID_ADPCM_YAMAHA,
339 AV_CODEC_ID_ADPCM_SBPRO_4,
340 AV_CODEC_ID_ADPCM_SBPRO_3,
341 AV_CODEC_ID_ADPCM_SBPRO_2,
342 AV_CODEC_ID_ADPCM_THP,
343 AV_CODEC_ID_ADPCM_IMA_AMV,
344 AV_CODEC_ID_ADPCM_EA_R1,
345 AV_CODEC_ID_ADPCM_EA_R3,
346 AV_CODEC_ID_ADPCM_EA_R2,
347 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
348 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
349 AV_CODEC_ID_ADPCM_EA_XAS,
350 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
351 AV_CODEC_ID_ADPCM_IMA_ISS,
352 AV_CODEC_ID_ADPCM_G722,
353 AV_CODEC_ID_ADPCM_IMA_APC,
354 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
355 AV_CODEC_ID_ADPCM_AFC = MKBETAG('A','F','C',' '),
356 AV_CODEC_ID_ADPCM_IMA_OKI = MKBETAG('O','K','I',' '),
359 AV_CODEC_ID_AMR_NB = 0x12000,
362 /* RealAudio codecs*/
363 AV_CODEC_ID_RA_144 = 0x13000,
366 /* various DPCM codecs */
367 AV_CODEC_ID_ROQ_DPCM = 0x14000,
368 AV_CODEC_ID_INTERPLAY_DPCM,
369 AV_CODEC_ID_XAN_DPCM,
370 AV_CODEC_ID_SOL_DPCM,
373 AV_CODEC_ID_MP2 = 0x15000,
374 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
384 AV_CODEC_ID_VMDAUDIO,
390 AV_CODEC_ID_WESTWOOD_SND1,
391 AV_CODEC_ID_GSM, ///< as in Berlin toast format
394 AV_CODEC_ID_TRUESPEECH,
396 AV_CODEC_ID_SMACKAUDIO,
399 AV_CODEC_ID_DSICINAUDIO,
401 AV_CODEC_ID_MUSEPACK7,
403 AV_CODEC_ID_GSM_MS, /* as found in WAV */
407 AV_CODEC_ID_NELLYMOSER,
408 AV_CODEC_ID_MUSEPACK8,
410 AV_CODEC_ID_WMAVOICE,
412 AV_CODEC_ID_WMALOSSLESS,
421 AV_CODEC_ID_BINKAUDIO_RDFT,
422 AV_CODEC_ID_BINKAUDIO_DCT,
423 AV_CODEC_ID_AAC_LATM,
428 AV_CODEC_ID_8SVX_EXP,
429 AV_CODEC_ID_8SVX_FIB,
430 AV_CODEC_ID_BMV_AUDIO,
434 AV_CODEC_ID_OPUS_DEPRECATED,
435 AV_CODEC_ID_COMFORT_NOISE,
436 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
437 AV_CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
438 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
439 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
440 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
441 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
442 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
444 /* subtitle codecs */
445 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
446 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
447 AV_CODEC_ID_DVB_SUBTITLE,
448 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
451 AV_CODEC_ID_MOV_TEXT,
452 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
453 AV_CODEC_ID_DVB_TELETEXT,
455 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
456 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
457 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
458 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
459 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
460 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
461 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
462 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
464 /* other specific kind of codecs (generally used for attachments) */
465 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
466 AV_CODEC_ID_TTF = 0x18000,
467 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
468 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
469 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
470 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
472 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
474 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
475 * stream (only used by libavformat) */
476 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
477 * stream (only used by libavformat) */
478 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
481 #include "old_codec_ids.h"
486 #define CodecID AVCodecID
490 * This struct describes the properties of a single codec described by an
492 * @see avcodec_get_descriptor()
494 typedef struct AVCodecDescriptor {
496 enum AVMediaType type;
498 * Name of the codec described by this descriptor. It is non-empty and
499 * unique for each codec descriptor. It should contain alphanumeric
500 * characters and '_' only.
504 * A more descriptive name for this codec. May be NULL.
506 const char *long_name;
508 * Codec properties, a combination of AV_CODEC_PROP_* flags.
514 * Codec uses only intra compression.
517 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
519 * Codec supports lossy compression. Audio and video codecs only.
520 * @note a codec may support both lossy and lossless
523 #define AV_CODEC_PROP_LOSSY (1 << 1)
525 * Codec supports lossless compression. Audio and video codecs only.
527 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
529 #if FF_API_OLD_DECODE_AUDIO
531 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
535 * @ingroup lavc_decoding
536 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
537 * This is mainly needed because some optimized bitstream readers read
538 * 32 or 64 bit at once and could read over the end.<br>
539 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
540 * MPEG bitstreams could cause overread and segfault.
542 #define FF_INPUT_BUFFER_PADDING_SIZE 16
545 * @ingroup lavc_encoding
546 * minimum encoding buffer size
547 * Used to avoid some checks during header writing.
549 #define FF_MIN_BUFFER_SIZE 16384
553 * @ingroup lavc_encoding
554 * motion estimation type.
557 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
561 ME_EPZS, ///< enhanced predictive zonal search
562 ME_X1, ///< reserved for experiments
563 ME_HEX, ///< hexagon based search
564 ME_UMH, ///< uneven multi-hexagon search
565 ME_ITER, ///< iterative search
566 ME_TESA, ///< transformed exhaustive search algorithm
570 * @ingroup lavc_decoding
573 /* We leave some space between them for extensions (drop some
574 * keyframes for intra-only or drop just some bidir frames). */
575 AVDISCARD_NONE =-16, ///< discard nothing
576 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
577 AVDISCARD_NONREF = 8, ///< discard all non reference
578 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
579 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
580 AVDISCARD_ALL = 48, ///< discard all
583 enum AVColorPrimaries{
584 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
585 AVCOL_PRI_UNSPECIFIED = 2,
586 AVCOL_PRI_BT470M = 4,
587 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
588 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
589 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
591 AVCOL_PRI_NB , ///< Not part of ABI
594 enum AVColorTransferCharacteristic{
595 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
596 AVCOL_TRC_UNSPECIFIED = 2,
597 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
598 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
599 AVCOL_TRC_SMPTE240M = 7,
600 AVCOL_TRC_NB , ///< Not part of ABI
605 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
606 AVCOL_SPC_UNSPECIFIED = 2,
608 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
609 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
610 AVCOL_SPC_SMPTE240M = 7,
611 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
612 AVCOL_SPC_NB , ///< Not part of ABI
614 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
617 AVCOL_RANGE_UNSPECIFIED = 0,
618 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
619 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
620 AVCOL_RANGE_NB , ///< Not part of ABI
624 * X X 3 4 X X are luma samples,
625 * 1 2 1-6 are possible chroma positions
626 * X X 5 6 X 0 is undefined/unknown position
628 enum AVChromaLocation{
629 AVCHROMA_LOC_UNSPECIFIED = 0,
630 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
631 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
632 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
633 AVCHROMA_LOC_TOP = 4,
634 AVCHROMA_LOC_BOTTOMLEFT = 5,
635 AVCHROMA_LOC_BOTTOM = 6,
636 AVCHROMA_LOC_NB , ///< Not part of ABI
639 enum AVAudioServiceType {
640 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
641 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
642 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
643 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
644 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
645 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
646 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
647 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
648 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
649 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
653 * @ingroup lavc_encoding
655 typedef struct RcOverride{
658 int qscale; // If this is 0 then quality_factor will be used instead.
659 float quality_factor;
662 #define FF_MAX_B_FRAMES 16
665 These flags can be passed in AVCodecContext.flags before initialization.
666 Note: Not everything is supported yet.
669 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
670 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
671 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
672 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
673 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
675 * The parent program guarantees that the input for B-frames containing
676 * streams is not written to for at least s->max_b_frames+1 frames, if
677 * this is not set the input will be copied.
679 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
680 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
681 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
682 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
683 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
684 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
685 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
686 location instead of only at frame boundaries. */
687 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
688 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
689 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
690 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
691 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
692 /* Fx : Flag for h263+ extra options */
693 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
694 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
695 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
696 #define CODEC_FLAG_CLOSED_GOP 0x80000000
697 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
698 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
699 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
700 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
701 #if FF_API_MPV_GLOBAL_OPTS
702 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
703 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
704 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
705 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
707 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
708 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
710 /* Unsupported options :
711 * Syntax Arithmetic coding (SAC)
712 * Reference Picture Selection
713 * Independent Segment Decoding */
715 /* codec capabilities */
717 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
719 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
720 * If not set, it might not use get_buffer() at all or use operations that
721 * assume the buffer was allocated by avcodec_default_get_buffer.
723 #define CODEC_CAP_DR1 0x0002
724 #define CODEC_CAP_TRUNCATED 0x0008
725 /* Codec can export data for HW decoding (XvMC). */
726 #define CODEC_CAP_HWACCEL 0x0010
728 * Encoder or decoder requires flushing with NULL input at the end in order to
729 * give the complete and correct output.
731 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
732 * with NULL data. The user can still send NULL data to the public encode
733 * or decode function, but libavcodec will not pass it along to the codec
734 * unless this flag is set.
737 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
738 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
742 * The encoder needs to be fed with NULL data at the end of encoding until the
743 * encoder no longer returns data.
745 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
746 * flag also means that the encoder must set the pts and duration for
747 * each output packet. If this flag is not set, the pts and duration will
748 * be determined by libavcodec from the input frame.
750 #define CODEC_CAP_DELAY 0x0020
752 * Codec can be fed a final frame with a smaller size.
753 * This can be used to prevent truncation of the last audio samples.
755 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
757 * Codec can export data for HW decoding (VDPAU).
759 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
761 * Codec can output multiple frames per AVPacket
762 * Normally demuxers return one frame at a time, demuxers which do not do
763 * are connected to a parser to split what they return into proper frames.
764 * This flag is reserved to the very rare category of codecs which have a
765 * bitstream that cannot be split into frames without timeconsuming
766 * operations like full decoding. Demuxers carring such bitstreams thus
767 * may return multiple frames in a packet. This has many disadvantages like
768 * prohibiting stream copy in many cases thus it should only be considered
771 #define CODEC_CAP_SUBFRAMES 0x0100
773 * Codec is experimental and is thus avoided in favor of non experimental
776 #define CODEC_CAP_EXPERIMENTAL 0x0200
778 * Codec should fill in channel configuration and samplerate instead of container
780 #define CODEC_CAP_CHANNEL_CONF 0x0400
783 * Codec is able to deal with negative linesizes
785 #define CODEC_CAP_NEG_LINESIZES 0x0800
788 * Codec supports frame-level multithreading.
790 #define CODEC_CAP_FRAME_THREADS 0x1000
792 * Codec supports slice-based (or partition-based) multithreading.
794 #define CODEC_CAP_SLICE_THREADS 0x2000
796 * Codec supports changed parameters at any point.
798 #define CODEC_CAP_PARAM_CHANGE 0x4000
800 * Codec supports avctx->thread_count == 0 (auto).
802 #define CODEC_CAP_AUTO_THREADS 0x8000
804 * Audio encoder supports receiving a different number of samples in each call.
806 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
808 * Codec is intra only.
810 #define CODEC_CAP_INTRA_ONLY 0x40000000
814 #define CODEC_CAP_LOSSLESS 0x80000000
816 //The following defines may change, don't expect compatibility if you use them.
817 #define MB_TYPE_INTRA4x4 0x0001
818 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
819 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
820 #define MB_TYPE_16x16 0x0008
821 #define MB_TYPE_16x8 0x0010
822 #define MB_TYPE_8x16 0x0020
823 #define MB_TYPE_8x8 0x0040
824 #define MB_TYPE_INTERLACED 0x0080
825 #define MB_TYPE_DIRECT2 0x0100 //FIXME
826 #define MB_TYPE_ACPRED 0x0200
827 #define MB_TYPE_GMC 0x0400
828 #define MB_TYPE_SKIP 0x0800
829 #define MB_TYPE_P0L0 0x1000
830 #define MB_TYPE_P1L0 0x2000
831 #define MB_TYPE_P0L1 0x4000
832 #define MB_TYPE_P1L1 0x8000
833 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
834 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
835 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
836 #define MB_TYPE_QUANT 0x00010000
837 #define MB_TYPE_CBP 0x00020000
838 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
842 * This specifies the area which should be displayed.
843 * Note there may be multiple such areas for one frame.
845 typedef struct AVPanScan{
848 * - encoding: Set by user.
849 * - decoding: Set by libavcodec.
854 * width and height in 1/16 pel
855 * - encoding: Set by user.
856 * - decoding: Set by libavcodec.
862 * position of the top left corner in 1/16 pel for up to 3 fields/frames
863 * - encoding: Set by user.
864 * - decoding: Set by libavcodec.
866 int16_t position[3][2];
869 #define FF_QSCALE_TYPE_MPEG1 0
870 #define FF_QSCALE_TYPE_MPEG2 1
871 #define FF_QSCALE_TYPE_H264 2
872 #define FF_QSCALE_TYPE_VP56 3
874 #define FF_BUFFER_TYPE_INTERNAL 1
875 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
876 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
877 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
879 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
880 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
881 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
882 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
885 * @defgroup lavc_packet AVPacket
887 * Types and functions for working with AVPacket.
890 enum AVPacketSideDataType {
892 AV_PKT_DATA_NEW_EXTRADATA,
895 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
898 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
899 * s32le channel_count
900 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
901 * u64le channel_layout
902 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
904 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
909 AV_PKT_DATA_PARAM_CHANGE,
912 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
913 * structures with info about macroblocks relevant to splitting the
914 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
915 * That is, it does not necessarily contain info about all macroblocks,
916 * as long as the distance between macroblocks in the info is smaller
917 * than the target payload size.
918 * Each MB info structure is 12 bytes, and is laid out as follows:
920 * u32le bit offset from the start of the packet
921 * u8 current quantizer at the start of the macroblock
923 * u16le macroblock address within the GOB
924 * u8 horizontal MV predictor
925 * u8 vertical MV predictor
926 * u8 horizontal MV predictor for block number 3
927 * u8 vertical MV predictor for block number 3
930 AV_PKT_DATA_H263_MB_INFO,
933 * Recommmends skipping the specified number of samples
935 * u32le number of samples to skip from start of this packet
936 * u32le number of samples to skip from end of this packet
937 * u8 reason for start skip
938 * u8 reason for end skip (0=padding silence, 1=convergence)
941 AV_PKT_DATA_SKIP_SAMPLES=70,
944 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
945 * the packet may contain "dual mono" audio specific to Japanese DTV
946 * and if it is true, recommends only the selected channel to be used.
948 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
951 AV_PKT_DATA_JP_DUALMONO,
954 * A list of zero terminated key/value strings. There is no end marker for
955 * the list, so it is required to rely on the side data size to stop.
957 AV_PKT_DATA_STRINGS_METADATA,
960 * Subtitle event position
968 AV_PKT_DATA_SUBTITLE_POSITION,
972 * This structure stores compressed data. It is typically exported by demuxers
973 * and then passed as input to decoders, or received as output from encoders and
974 * then passed to muxers.
976 * For video, it should typically contain one compressed frame. For audio it may
977 * contain several compressed frames.
979 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
980 * ABI. Thus it may be allocated on stack and no new fields can be added to it
981 * without libavcodec and libavformat major bump.
983 * The semantics of data ownership depends on the destruct field.
984 * If it is set, the packet data is dynamically allocated and is valid
985 * indefinitely until av_free_packet() is called (which in turn calls the
986 * destruct callback to free the data). If destruct is not set, the packet data
987 * is typically backed by some static buffer somewhere and is only valid for a
988 * limited time (e.g. until the next read call when demuxing).
990 * The side data is always allocated with av_malloc() and is freed in
993 typedef struct AVPacket {
995 * Presentation timestamp in AVStream->time_base units; the time at which
996 * the decompressed packet will be presented to the user.
997 * Can be AV_NOPTS_VALUE if it is not stored in the file.
998 * pts MUST be larger or equal to dts as presentation cannot happen before
999 * decompression, unless one wants to view hex dumps. Some formats misuse
1000 * the terms dts and pts/cts to mean something different. Such timestamps
1001 * must be converted to true pts/dts before they are stored in AVPacket.
1005 * Decompression timestamp in AVStream->time_base units; the time at which
1006 * the packet is decompressed.
1007 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1014 * A combination of AV_PKT_FLAG values
1018 * Additional packet data that can be provided by the container.
1019 * Packet can contain several types of side information.
1024 enum AVPacketSideDataType type;
1026 int side_data_elems;
1029 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1030 * Equals next_pts - this_pts in presentation order.
1033 void (*destruct)(struct AVPacket *);
1035 int64_t pos; ///< byte position in stream, -1 if unknown
1038 * Time difference in AVStream->time_base units from the pts of this
1039 * packet to the point at which the output from the decoder has converged
1040 * independent from the availability of previous frames. That is, the
1041 * frames are virtually identical no matter if decoding started from
1042 * the very first frame or from this keyframe.
1043 * Is AV_NOPTS_VALUE if unknown.
1044 * This field is not the display duration of the current packet.
1045 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1048 * The purpose of this field is to allow seeking in streams that have no
1049 * keyframes in the conventional sense. It corresponds to the
1050 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1051 * essential for some types of subtitle streams to ensure that all
1052 * subtitles are correctly displayed after seeking.
1054 int64_t convergence_duration;
1056 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1057 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1059 enum AVSideDataParamChangeFlags {
1060 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1061 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1062 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1063 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1070 * Audio Video Frame.
1071 * New fields can be added to the end of AVFRAME with minor version
1072 * bumps. Similarly fields that are marked as to be only accessed by
1073 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
1074 * without breaking compatibility with each other.
1075 * Removal, reordering and changes in the remaining cases require
1076 * a major version bump.
1077 * sizeof(AVFrame) must not be used outside libavcodec.
1079 typedef struct AVFrame {
1080 #define AV_NUM_DATA_POINTERS 8
1082 * pointer to the picture/channel planes.
1083 * This might be different from the first allocated byte
1084 * - encoding: Set by user
1085 * - decoding: set by AVCodecContext.get_buffer()
1087 uint8_t *data[AV_NUM_DATA_POINTERS];
1090 * Size, in bytes, of the data for each picture/channel plane.
1092 * For audio, only linesize[0] may be set. For planar audio, each channel
1093 * plane must be the same size.
1095 * - encoding: Set by user
1096 * - decoding: set by AVCodecContext.get_buffer()
1098 int linesize[AV_NUM_DATA_POINTERS];
1101 * pointers to the data planes/channels.
1103 * For video, this should simply point to data[].
1105 * For planar audio, each channel has a separate data pointer, and
1106 * linesize[0] contains the size of each channel buffer.
1107 * For packed audio, there is just one data pointer, and linesize[0]
1108 * contains the total size of the buffer for all channels.
1110 * Note: Both data and extended_data will always be set by get_buffer(),
1111 * but for planar audio with more channels that can fit in data,
1112 * extended_data must be used by the decoder in order to access all
1115 * encoding: set by user
1116 * decoding: set by AVCodecContext.get_buffer()
1118 uint8_t **extended_data;
1121 * width and height of the video frame
1122 * - encoding: unused
1123 * - decoding: Read by user.
1128 * number of audio samples (per channel) described by this frame
1129 * - encoding: Set by user
1130 * - decoding: Set by libavcodec
1135 * format of the frame, -1 if unknown or unset
1136 * Values correspond to enum AVPixelFormat for video frames,
1137 * enum AVSampleFormat for audio)
1138 * - encoding: unused
1139 * - decoding: Read by user.
1144 * 1 -> keyframe, 0-> not
1145 * - encoding: Set by libavcodec.
1146 * - decoding: Set by libavcodec.
1151 * Picture type of the frame, see ?_TYPE below.
1152 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1153 * - decoding: Set by libavcodec.
1155 enum AVPictureType pict_type;
1158 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1159 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1163 uint8_t *base[AV_NUM_DATA_POINTERS];
1166 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1167 * - encoding: unused
1168 * - decoding: Read by user.
1170 AVRational sample_aspect_ratio;
1173 * presentation timestamp in time_base units (time when frame should be shown to user)
1174 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1175 * - encoding: MUST be set by user.
1176 * - decoding: Set by libavcodec.
1181 * reordered pts from the last AVPacket that has been input into the decoder
1182 * - encoding: unused
1183 * - decoding: Read by user.
1188 * dts from the last AVPacket that has been input into the decoder
1189 * - encoding: unused
1190 * - decoding: Read by user.
1195 * picture number in bitstream order
1196 * - encoding: set by
1197 * - decoding: Set by libavcodec.
1199 int coded_picture_number;
1201 * picture number in display order
1202 * - encoding: set by
1203 * - decoding: Set by libavcodec.
1205 int display_picture_number;
1208 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1209 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1210 * - decoding: Set by libavcodec.
1215 * is this picture used as reference
1216 * The values for this are the same as the MpegEncContext.picture_structure
1217 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1218 * Set to 4 for delayed, non-reference frames.
1219 * - encoding: unused
1220 * - decoding: Set by libavcodec. (before get_buffer() call)).
1226 * - encoding: unused
1227 * - decoding: Set by libavcodec.
1229 int8_t *qscale_table;
1232 * - encoding: unused
1233 * - decoding: Set by libavcodec.
1243 * mbskip_table[mb]>=1 if MB didn't change
1244 * stride= mb_width = (width+15)>>4
1245 * - encoding: unused
1246 * - decoding: Set by libavcodec.
1248 uint8_t *mbskip_table;
1251 * motion vector table
1254 * int mv_sample_log2= 4 - motion_subsample_log2;
1255 * int mb_width= (width+15)>>4;
1256 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1257 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1259 * - encoding: Set by user.
1260 * - decoding: Set by libavcodec.
1262 int16_t (*motion_val[2])[2];
1265 * macroblock type table
1266 * mb_type_base + mb_width + 2
1267 * - encoding: Set by user.
1268 * - decoding: Set by libavcodec.
1274 * - encoding: unused
1275 * - decoding: Set by libavcodec.
1280 * motion reference frame index
1281 * the order in which these are stored can depend on the codec.
1282 * - encoding: Set by user.
1283 * - decoding: Set by libavcodec.
1285 int8_t *ref_index[2];
1288 * for some private data of the user
1289 * - encoding: unused
1290 * - decoding: Set by user.
1296 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1297 * - decoding: unused
1299 uint64_t error[AV_NUM_DATA_POINTERS];
1302 * type of the buffer (to keep track of who has to deallocate data[*])
1303 * - encoding: Set by the one who allocates it.
1304 * - decoding: Set by the one who allocates it.
1305 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1310 * When decoding, this signals how much the picture must be delayed.
1311 * extra_delay = repeat_pict / (2*fps)
1312 * - encoding: unused
1313 * - decoding: Set by libavcodec.
1318 * The content of the picture is interlaced.
1319 * - encoding: Set by user.
1320 * - decoding: Set by libavcodec. (default 0)
1322 int interlaced_frame;
1325 * If the content is interlaced, is top field displayed first.
1326 * - encoding: Set by user.
1327 * - decoding: Set by libavcodec.
1329 int top_field_first;
1332 * Tell user application that palette has changed from previous frame.
1333 * - encoding: ??? (no palette-enabled encoder yet)
1334 * - decoding: Set by libavcodec. (default 0).
1336 int palette_has_changed;
1339 * codec suggestion on buffer type if != 0
1340 * - encoding: unused
1341 * - decoding: Set by libavcodec. (before get_buffer() call)).
1347 * - encoding: Set by user.
1348 * - decoding: Set by libavcodec.
1350 AVPanScan *pan_scan;
1353 * reordered opaque 64bit (generally an integer or a double precision float
1354 * PTS but can be anything).
1355 * The user sets AVCodecContext.reordered_opaque to represent the input at
1357 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1358 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1359 * @deprecated in favor of pkt_pts
1360 * - encoding: unused
1361 * - decoding: Read by user.
1363 int64_t reordered_opaque;
1366 * hardware accelerator private data (FFmpeg-allocated)
1367 * - encoding: unused
1368 * - decoding: Set by libavcodec
1370 void *hwaccel_picture_private;
1373 * the AVCodecContext which ff_thread_get_buffer() was last called on
1374 * - encoding: Set by libavcodec.
1375 * - decoding: Set by libavcodec.
1377 struct AVCodecContext *owner;
1380 * used by multithreading to store frame-specific info
1381 * - encoding: Set by libavcodec.
1382 * - decoding: Set by libavcodec.
1384 void *thread_opaque;
1387 * log2 of the size of the block which a single vector in motion_val represents:
1388 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1389 * - encoding: unused
1390 * - decoding: Set by libavcodec.
1392 uint8_t motion_subsample_log2;
1395 * Sample rate of the audio data.
1397 * - encoding: unused
1398 * - decoding: read by user
1403 * Channel layout of the audio data.
1405 * - encoding: unused
1406 * - decoding: read by user.
1408 uint64_t channel_layout;
1411 * frame timestamp estimated using various heuristics, in stream time base
1412 * Code outside libavcodec should access this field using:
1413 * av_frame_get_best_effort_timestamp(frame)
1414 * - encoding: unused
1415 * - decoding: set by libavcodec, read by user.
1417 int64_t best_effort_timestamp;
1420 * reordered pos from the last AVPacket that has been input into the decoder
1421 * Code outside libavcodec should access this field using:
1422 * av_frame_get_pkt_pos(frame)
1423 * - encoding: unused
1424 * - decoding: Read by user.
1429 * duration of the corresponding packet, expressed in
1430 * AVStream->time_base units, 0 if unknown.
1431 * Code outside libavcodec should access this field using:
1432 * av_frame_get_pkt_duration(frame)
1433 * - encoding: unused
1434 * - decoding: Read by user.
1436 int64_t pkt_duration;
1440 * Code outside libavcodec should access this field using:
1441 * av_frame_get_metadata(frame)
1442 * - encoding: Set by user.
1443 * - decoding: Set by libavcodec.
1445 AVDictionary *metadata;
1448 * decode error flags of the frame, set to a combination of
1449 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
1450 * were errors during the decoding.
1451 * Code outside libavcodec should access this field using:
1452 * av_frame_get_decode_error_flags(frame)
1453 * - encoding: unused
1454 * - decoding: set by libavcodec, read by user.
1456 int decode_error_flags;
1457 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
1458 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
1461 * number of audio channels, only used for audio.
1462 * Code outside libavcodec should access this field using:
1463 * av_frame_get_channels(frame)
1464 * - encoding: unused
1465 * - decoding: Read by user.
1471 * Accessors for some AVFrame fields.
1472 * The position of these field in the structure is not part of the ABI,
1473 * they should not be accessed directly outside libavcodec.
1475 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
1476 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
1477 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
1478 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
1479 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
1480 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
1481 int64_t av_frame_get_channel_layout (const AVFrame *frame);
1482 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
1483 int av_frame_get_channels (const AVFrame *frame);
1484 void av_frame_set_channels (AVFrame *frame, int val);
1485 int av_frame_get_sample_rate (const AVFrame *frame);
1486 void av_frame_set_sample_rate (AVFrame *frame, int val);
1487 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
1488 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
1489 int av_frame_get_decode_error_flags (const AVFrame *frame);
1490 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
1492 struct AVCodecInternal;
1496 AV_FIELD_PROGRESSIVE,
1497 AV_FIELD_TT, //< Top coded_first, top displayed first
1498 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1499 AV_FIELD_TB, //< Top coded first, bottom displayed first
1500 AV_FIELD_BT, //< Bottom coded first, top displayed first
1504 * main external API structure.
1505 * New fields can be added to the end with minor version bumps.
1506 * Removal, reordering and changes to existing fields require a major
1508 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1510 * sizeof(AVCodecContext) must not be used outside libav*.
1512 typedef struct AVCodecContext {
1514 * information on struct for av_log
1515 * - set by avcodec_alloc_context3
1517 const AVClass *av_class;
1518 int log_level_offset;
1520 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1521 const struct AVCodec *codec;
1522 char codec_name[32];
1523 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1526 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1527 * This is used to work around some encoder bugs.
1528 * A demuxer should set this to what is stored in the field used to identify the codec.
1529 * If there are multiple such fields in a container then the demuxer should choose the one
1530 * which maximizes the information about the used codec.
1531 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1532 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1533 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1535 * - encoding: Set by user, if not then the default based on codec_id will be used.
1536 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1538 unsigned int codec_tag;
1541 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1542 * This is used to work around some encoder bugs.
1543 * - encoding: unused
1544 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1546 unsigned int stream_codec_tag;
1550 * @deprecated this field is unused
1552 attribute_deprecated int sub_id;
1558 * Private context used for internal data.
1560 * Unlike priv_data, this is not codec-specific. It is used in general
1561 * libavcodec functions.
1563 struct AVCodecInternal *internal;
1566 * Private data of the user, can be used to carry app specific stuff.
1567 * - encoding: Set by user.
1568 * - decoding: Set by user.
1573 * the average bitrate
1574 * - encoding: Set by user; unused for constant quantizer encoding.
1575 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1580 * number of bits the bitstream is allowed to diverge from the reference.
1581 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1582 * - encoding: Set by user; unused for constant quantizer encoding.
1583 * - decoding: unused
1585 int bit_rate_tolerance;
1588 * Global quality for codecs which cannot change it per frame.
1589 * This should be proportional to MPEG-1/2/4 qscale.
1590 * - encoding: Set by user.
1591 * - decoding: unused
1596 * - encoding: Set by user.
1597 * - decoding: unused
1599 int compression_level;
1600 #define FF_COMPRESSION_DEFAULT -1
1604 * - encoding: Set by user.
1605 * - decoding: Set by user.
1611 * - encoding: Set by user.
1612 * - decoding: Set by user.
1617 * some codecs need / can use extradata like Huffman tables.
1618 * mjpeg: Huffman tables
1619 * rv10: additional flags
1620 * mpeg4: global headers (they can be in the bitstream or here)
1621 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1622 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1623 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1624 * - encoding: Set/allocated/freed by libavcodec.
1625 * - decoding: Set/allocated/freed by user.
1631 * This is the fundamental unit of time (in seconds) in terms
1632 * of which frame timestamps are represented. For fixed-fps content,
1633 * timebase should be 1/framerate and timestamp increments should be
1635 * - encoding: MUST be set by user.
1636 * - decoding: Set by libavcodec.
1638 AVRational time_base;
1641 * For some codecs, the time base is closer to the field rate than the frame rate.
1642 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1643 * if no telecine is used ...
1645 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1647 int ticks_per_frame;
1652 * Encoding: Number of frames delay there will be from the encoder input to
1653 * the decoder output. (we assume the decoder matches the spec)
1654 * Decoding: Number of frames delay in addition to what a standard decoder
1655 * as specified in the spec would produce.
1658 * Number of frames the decoded output will be delayed relative to the
1662 * For encoding, this is the number of "priming" samples added to the
1663 * beginning of the stream. The decoded output will be delayed by this
1664 * many samples relative to the input to the encoder. Note that this
1665 * field is purely informational and does not directly affect the pts
1666 * output by the encoder, which should always be based on the actual
1667 * presentation time, including any delay.
1668 * For decoding, this is the number of samples the decoder needs to
1669 * output before the decoder's output is valid. When seeking, you should
1670 * start decoding this many samples prior to your desired seek point.
1672 * - encoding: Set by libavcodec.
1673 * - decoding: Set by libavcodec.
1680 * picture width / height.
1681 * - encoding: MUST be set by user.
1682 * - decoding: Set by libavcodec.
1683 * Note: For compatibility it is possible to set this instead of
1684 * coded_width/height before decoding.
1689 * Bitstream width / height, may be different from width/height if lowres enabled.
1690 * - encoding: unused
1691 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1693 int coded_width, coded_height;
1695 #define FF_ASPECT_EXTENDED 15
1698 * the number of pictures in a group of pictures, or 0 for intra_only
1699 * - encoding: Set by user.
1700 * - decoding: unused
1705 * Pixel format, see AV_PIX_FMT_xxx.
1706 * May be set by the demuxer if known from headers.
1707 * May be overridden by the decoder if it knows better.
1708 * - encoding: Set by user.
1709 * - decoding: Set by user if known, overridden by libavcodec if known
1711 enum AVPixelFormat pix_fmt;
1714 * Motion estimation algorithm used for video coding.
1715 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1716 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1717 * - encoding: MUST be set by user.
1718 * - decoding: unused
1723 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1724 * decoder to draw a horizontal band. It improves cache usage. Not
1725 * all codecs can do that. You must check the codec capabilities
1727 * When multithreading is used, it may be called from multiple threads
1728 * at the same time; threads might draw different parts of the same AVFrame,
1729 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1731 * The function is also used by hardware acceleration APIs.
1732 * It is called at least once during frame decoding to pass
1733 * the data needed for hardware render.
1734 * In that mode instead of pixel data, AVFrame points to
1735 * a structure specific to the acceleration API. The application
1736 * reads the structure and can change some fields to indicate progress
1738 * - encoding: unused
1739 * - decoding: Set by user.
1740 * @param height the height of the slice
1741 * @param y the y position of the slice
1742 * @param type 1->top field, 2->bottom field, 3->frame
1743 * @param offset offset into the AVFrame.data from which the slice should be read
1745 void (*draw_horiz_band)(struct AVCodecContext *s,
1746 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1747 int y, int type, int height);
1750 * callback to negotiate the pixelFormat
1751 * @param fmt is the list of formats which are supported by the codec,
1752 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1753 * The first is always the native one.
1754 * @return the chosen format
1755 * - encoding: unused
1756 * - decoding: Set by user, if not set the native format will be chosen.
1758 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1761 * maximum number of B-frames between non-B-frames
1762 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1763 * - encoding: Set by user.
1764 * - decoding: unused
1769 * qscale factor between IP and B-frames
1770 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1771 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1772 * - encoding: Set by user.
1773 * - decoding: unused
1775 float b_quant_factor;
1777 /** obsolete FIXME remove */
1779 #define FF_RC_STRATEGY_XVID 1
1781 int b_frame_strategy;
1783 #if FF_API_MPV_GLOBAL_OPTS
1785 * luma single coefficient elimination threshold
1786 * - encoding: Set by user.
1787 * - decoding: unused
1789 attribute_deprecated int luma_elim_threshold;
1792 * chroma single coeff elimination threshold
1793 * - encoding: Set by user.
1794 * - decoding: unused
1796 attribute_deprecated int chroma_elim_threshold;
1800 * qscale offset between IP and B-frames
1801 * - encoding: Set by user.
1802 * - decoding: unused
1804 float b_quant_offset;
1807 * Size of the frame reordering buffer in the decoder.
1808 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1809 * - encoding: Set by libavcodec.
1810 * - decoding: Set by libavcodec.
1815 * 0-> h263 quant 1-> mpeg quant
1816 * - encoding: Set by user.
1817 * - decoding: unused
1822 * qscale factor between P and I-frames
1823 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1824 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1825 * - encoding: Set by user.
1826 * - decoding: unused
1828 float i_quant_factor;
1831 * qscale offset between P and I-frames
1832 * - encoding: Set by user.
1833 * - decoding: unused
1835 float i_quant_offset;
1838 * luminance masking (0-> disabled)
1839 * - encoding: Set by user.
1840 * - decoding: unused
1845 * temporary complexity masking (0-> disabled)
1846 * - encoding: Set by user.
1847 * - decoding: unused
1849 float temporal_cplx_masking;
1852 * spatial complexity masking (0-> disabled)
1853 * - encoding: Set by user.
1854 * - decoding: unused
1856 float spatial_cplx_masking;
1859 * p block masking (0-> disabled)
1860 * - encoding: Set by user.
1861 * - decoding: unused
1866 * darkness masking (0-> disabled)
1867 * - encoding: Set by user.
1868 * - decoding: unused
1874 * - encoding: Set by libavcodec.
1875 * - decoding: Set by user (or 0).
1879 * prediction method (needed for huffyuv)
1880 * - encoding: Set by user.
1881 * - decoding: unused
1883 int prediction_method;
1884 #define FF_PRED_LEFT 0
1885 #define FF_PRED_PLANE 1
1886 #define FF_PRED_MEDIAN 2
1889 * slice offsets in the frame in bytes
1890 * - encoding: Set/allocated by libavcodec.
1891 * - decoding: Set/allocated by user (or NULL).
1896 * sample aspect ratio (0 if unknown)
1897 * That is the width of a pixel divided by the height of the pixel.
1898 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1899 * - encoding: Set by user.
1900 * - decoding: Set by libavcodec.
1902 AVRational sample_aspect_ratio;
1905 * motion estimation comparison function
1906 * - encoding: Set by user.
1907 * - decoding: unused
1911 * subpixel motion estimation comparison function
1912 * - encoding: Set by user.
1913 * - decoding: unused
1917 * macroblock comparison function (not supported yet)
1918 * - encoding: Set by user.
1919 * - decoding: unused
1923 * interlaced DCT comparison function
1924 * - encoding: Set by user.
1925 * - decoding: unused
1928 #define FF_CMP_SAD 0
1929 #define FF_CMP_SSE 1
1930 #define FF_CMP_SATD 2
1931 #define FF_CMP_DCT 3
1932 #define FF_CMP_PSNR 4
1933 #define FF_CMP_BIT 5
1935 #define FF_CMP_ZERO 7
1936 #define FF_CMP_VSAD 8
1937 #define FF_CMP_VSSE 9
1938 #define FF_CMP_NSSE 10
1939 #define FF_CMP_W53 11
1940 #define FF_CMP_W97 12
1941 #define FF_CMP_DCTMAX 13
1942 #define FF_CMP_DCT264 14
1943 #define FF_CMP_CHROMA 256
1946 * ME diamond size & shape
1947 * - encoding: Set by user.
1948 * - decoding: unused
1953 * amount of previous MV predictors (2a+1 x 2a+1 square)
1954 * - encoding: Set by user.
1955 * - decoding: unused
1957 int last_predictor_count;
1960 * prepass for motion estimation
1961 * - encoding: Set by user.
1962 * - decoding: unused
1967 * motion estimation prepass comparison function
1968 * - encoding: Set by user.
1969 * - decoding: unused
1974 * ME prepass diamond size & shape
1975 * - encoding: Set by user.
1976 * - decoding: unused
1982 * - encoding: Set by user.
1983 * - decoding: unused
1985 int me_subpel_quality;
1988 * DTG active format information (additional aspect ratio
1989 * information only used in DVB MPEG-2 transport streams)
1992 * - encoding: unused
1993 * - decoding: Set by decoder.
1995 int dtg_active_format;
1996 #define FF_DTG_AFD_SAME 8
1997 #define FF_DTG_AFD_4_3 9
1998 #define FF_DTG_AFD_16_9 10
1999 #define FF_DTG_AFD_14_9 11
2000 #define FF_DTG_AFD_4_3_SP_14_9 13
2001 #define FF_DTG_AFD_16_9_SP_14_9 14
2002 #define FF_DTG_AFD_SP_4_3 15
2005 * maximum motion estimation search range in subpel units
2006 * If 0 then no limit.
2008 * - encoding: Set by user.
2009 * - decoding: unused
2014 * intra quantizer bias
2015 * - encoding: Set by user.
2016 * - decoding: unused
2018 int intra_quant_bias;
2019 #define FF_DEFAULT_QUANT_BIAS 999999
2022 * inter quantizer bias
2023 * - encoding: Set by user.
2024 * - decoding: unused
2026 int inter_quant_bias;
2028 #if FF_API_COLOR_TABLE_ID
2031 * - encoding: unused
2032 * - decoding: Which clrtable should be used for 8bit RGB images.
2033 * Tables have to be stored somewhere. FIXME
2035 attribute_deprecated int color_table_id;
2040 * - encoding: unused
2041 * - decoding: Set by user.
2044 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2045 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2046 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2049 * XVideo Motion Acceleration
2050 * - encoding: forbidden
2051 * - decoding: set by decoder
2053 int xvmc_acceleration;
2056 * macroblock decision mode
2057 * - encoding: Set by user.
2058 * - decoding: unused
2061 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2062 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2063 #define FF_MB_DECISION_RD 2 ///< rate distortion
2066 * custom intra quantization matrix
2067 * - encoding: Set by user, can be NULL.
2068 * - decoding: Set by libavcodec.
2070 uint16_t *intra_matrix;
2073 * custom inter quantization matrix
2074 * - encoding: Set by user, can be NULL.
2075 * - decoding: Set by libavcodec.
2077 uint16_t *inter_matrix;
2080 * scene change detection threshold
2081 * 0 is default, larger means fewer detected scene changes.
2082 * - encoding: Set by user.
2083 * - decoding: unused
2085 int scenechange_threshold;
2088 * noise reduction strength
2089 * - encoding: Set by user.
2090 * - decoding: unused
2092 int noise_reduction;
2094 #if FF_API_INTER_THRESHOLD
2096 * @deprecated this field is unused
2098 attribute_deprecated int inter_threshold;
2101 #if FF_API_MPV_GLOBAL_OPTS
2103 * @deprecated use mpegvideo private options instead
2105 attribute_deprecated int quantizer_noise_shaping;
2109 * Motion estimation threshold below which no motion estimation is
2110 * performed, but instead the user specified motion vectors are used.
2112 * - encoding: Set by user.
2113 * - decoding: unused
2118 * Macroblock threshold below which the user specified macroblock types will be used.
2119 * - encoding: Set by user.
2120 * - decoding: unused
2125 * precision of the intra DC coefficient - 8
2126 * - encoding: Set by user.
2127 * - decoding: unused
2129 int intra_dc_precision;
2132 * Number of macroblock rows at the top which are skipped.
2133 * - encoding: unused
2134 * - decoding: Set by user.
2139 * Number of macroblock rows at the bottom which are skipped.
2140 * - encoding: unused
2141 * - decoding: Set by user.
2146 * Border processing masking, raises the quantizer for mbs on the borders
2148 * - encoding: Set by user.
2149 * - decoding: unused
2151 float border_masking;
2154 * minimum MB lagrange multipler
2155 * - encoding: Set by user.
2156 * - decoding: unused
2161 * maximum MB lagrange multipler
2162 * - encoding: Set by user.
2163 * - decoding: unused
2169 * - encoding: Set by user.
2170 * - decoding: unused
2172 int me_penalty_compensation;
2176 * - encoding: Set by user.
2177 * - decoding: unused
2183 * - encoding: Set by user.
2184 * - decoding: unused
2190 * - encoding: Set by user.
2191 * - decoding: unused
2196 * number of reference frames
2197 * - encoding: Set by user.
2198 * - decoding: Set by lavc.
2203 * chroma qp offset from luma
2204 * - encoding: Set by user.
2205 * - decoding: unused
2210 * Multiplied by qscale for each frame and added to scene_change_score.
2211 * - encoding: Set by user.
2212 * - decoding: unused
2214 int scenechange_factor;
2218 * Note: Value depends upon the compare function used for fullpel ME.
2219 * - encoding: Set by user.
2220 * - decoding: unused
2225 * Adjust sensitivity of b_frame_strategy 1.
2226 * - encoding: Set by user.
2227 * - decoding: unused
2232 * Chromaticity coordinates of the source primaries.
2233 * - encoding: Set by user
2234 * - decoding: Set by libavcodec
2236 enum AVColorPrimaries color_primaries;
2239 * Color Transfer Characteristic.
2240 * - encoding: Set by user
2241 * - decoding: Set by libavcodec
2243 enum AVColorTransferCharacteristic color_trc;
2246 * YUV colorspace type.
2247 * - encoding: Set by user
2248 * - decoding: Set by libavcodec
2250 enum AVColorSpace colorspace;
2253 * MPEG vs JPEG YUV range.
2254 * - encoding: Set by user
2255 * - decoding: Set by libavcodec
2257 enum AVColorRange color_range;
2260 * This defines the location of chroma samples.
2261 * - encoding: Set by user
2262 * - decoding: Set by libavcodec
2264 enum AVChromaLocation chroma_sample_location;
2268 * Indicates number of picture subdivisions. Used for parallelized
2270 * - encoding: Set by user
2271 * - decoding: unused
2276 * - encoding: set by libavcodec
2277 * - decoding: Set by user.
2279 enum AVFieldOrder field_order;
2282 int sample_rate; ///< samples per second
2283 int channels; ///< number of audio channels
2286 * audio sample format
2287 * - encoding: Set by user.
2288 * - decoding: Set by libavcodec.
2290 enum AVSampleFormat sample_fmt; ///< sample format
2292 /* The following data should not be initialized. */
2294 * Number of samples per channel in an audio frame.
2296 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2297 * except the last must contain exactly frame_size samples per channel.
2298 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2299 * frame size is not restricted.
2300 * - decoding: may be set by some decoders to indicate constant frame size
2305 * Frame counter, set by libavcodec.
2307 * - decoding: total number of frames returned from the decoder so far.
2308 * - encoding: total number of frames passed to the encoder so far.
2310 * @note the counter is not incremented if encoding/decoding resulted in
2316 * number of bytes per packet if constant and known or 0
2317 * Used by some WAV based audio codecs.
2322 * Audio cutoff bandwidth (0 means "automatic")
2323 * - encoding: Set by user.
2324 * - decoding: unused
2328 #if FF_API_REQUEST_CHANNELS
2330 * Decoder should decode to this many channels if it can (0 for default)
2331 * - encoding: unused
2332 * - decoding: Set by user.
2333 * @deprecated Deprecated in favor of request_channel_layout.
2335 int request_channels;
2339 * Audio channel layout.
2340 * - encoding: set by user.
2341 * - decoding: set by user, may be overwritten by libavcodec.
2343 uint64_t channel_layout;
2346 * Request decoder to use this channel layout if it can (0 for default)
2347 * - encoding: unused
2348 * - decoding: Set by user.
2350 uint64_t request_channel_layout;
2353 * Type of service that the audio stream conveys.
2354 * - encoding: Set by user.
2355 * - decoding: Set by libavcodec.
2357 enum AVAudioServiceType audio_service_type;
2360 * desired sample format
2361 * - encoding: Not used.
2362 * - decoding: Set by user.
2363 * Decoder will decode to this format if it can.
2365 enum AVSampleFormat request_sample_fmt;
2368 * Called at the beginning of each frame to get a buffer for it.
2370 * The function will set AVFrame.data[], AVFrame.linesize[].
2371 * AVFrame.extended_data[] must also be set, but it should be the same as
2372 * AVFrame.data[] except for planar audio with more channels than can fit
2373 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2374 * many data pointers as it can hold.
2376 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2377 * avcodec_default_get_buffer() instead of providing buffers allocated by
2380 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2381 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2382 * but if get_buffer() is overridden then alignment considerations should
2383 * be taken into account.
2385 * @see avcodec_default_get_buffer()
2389 * If pic.reference is set then the frame will be read later by libavcodec.
2390 * avcodec_align_dimensions2() should be used to find the required width and
2391 * height, as they normally need to be rounded up to the next multiple of 16.
2393 * If frame multithreading is used and thread_safe_callbacks is set,
2394 * it may be called from a different thread, but not from more than one at
2395 * once. Does not need to be reentrant.
2397 * @see release_buffer(), reget_buffer()
2398 * @see avcodec_align_dimensions2()
2402 * Decoders request a buffer of a particular size by setting
2403 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2404 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2405 * to a smaller value in the output frame.
2407 * Decoders cannot use the buffer after returning from
2408 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2409 * is assumed to be released immediately upon return. In some rare cases,
2410 * a decoder may need to call get_buffer() more than once in a single
2411 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
2412 * called again after it has already been called once, the previously
2413 * acquired buffer is assumed to be released at that time and may not be
2414 * reused by the decoder.
2416 * As a convenience, av_samples_get_buffer_size() and
2417 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2418 * functions to find the required data size and to fill data pointers and
2419 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2420 * since all planes must be the same size.
2422 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2424 * - encoding: unused
2425 * - decoding: Set by libavcodec, user can override.
2427 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2430 * Called to release buffers which were allocated with get_buffer.
2431 * A released buffer can be reused in get_buffer().
2432 * pic.data[*] must be set to NULL.
2433 * May be called from a different thread if frame multithreading is used,
2434 * but not by more than one thread at once, so does not need to be reentrant.
2435 * - encoding: unused
2436 * - decoding: Set by libavcodec, user can override.
2438 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2441 * Called at the beginning of a frame to get cr buffer for it.
2442 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2443 * libavcodec will pass previous buffer in pic, function should return
2444 * same buffer or new buffer with old frame "painted" into it.
2445 * If pic.data[0] == NULL must behave like get_buffer().
2446 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2447 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2449 * - encoding: unused
2450 * - decoding: Set by libavcodec, user can override.
2452 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2455 /* - encoding parameters */
2456 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2457 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2461 * - encoding: Set by user.
2462 * - decoding: unused
2468 * - encoding: Set by user.
2469 * - decoding: unused
2474 * maximum quantizer difference between frames
2475 * - encoding: Set by user.
2476 * - decoding: unused
2481 * ratecontrol qmin qmax limiting method
2482 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2483 * - encoding: Set by user.
2484 * - decoding: unused
2492 * decoder bitstream buffer size
2493 * - encoding: Set by user.
2494 * - decoding: unused
2499 * ratecontrol override, see RcOverride
2500 * - encoding: Allocated/set/freed by user.
2501 * - decoding: unused
2503 int rc_override_count;
2504 RcOverride *rc_override;
2507 * rate control equation
2508 * - encoding: Set by user
2509 * - decoding: unused
2515 * - encoding: Set by user.
2516 * - decoding: unused
2522 * - encoding: Set by user.
2523 * - decoding: unused
2527 float rc_buffer_aggressivity;
2530 * initial complexity for pass1 ratecontrol
2531 * - encoding: Set by user.
2532 * - decoding: unused
2534 float rc_initial_cplx;
2537 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2538 * - encoding: Set by user.
2539 * - decoding: unused.
2541 float rc_max_available_vbv_use;
2544 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2545 * - encoding: Set by user.
2546 * - decoding: unused.
2548 float rc_min_vbv_overflow_use;
2551 * Number of bits which should be loaded into the rc buffer before decoding starts.
2552 * - encoding: Set by user.
2553 * - decoding: unused
2555 int rc_initial_buffer_occupancy;
2557 #define FF_CODER_TYPE_VLC 0
2558 #define FF_CODER_TYPE_AC 1
2559 #define FF_CODER_TYPE_RAW 2
2560 #define FF_CODER_TYPE_RLE 3
2561 #define FF_CODER_TYPE_DEFLATE 4
2564 * - encoding: Set by user.
2565 * - decoding: unused
2571 * - encoding: Set by user.
2572 * - decoding: unused
2577 * minimum Lagrange multipler
2578 * - encoding: Set by user.
2579 * - decoding: unused
2584 * maximum Lagrange multipler
2585 * - encoding: Set by user.
2586 * - decoding: unused
2591 * frame skip threshold
2592 * - encoding: Set by user.
2593 * - decoding: unused
2595 int frame_skip_threshold;
2599 * - encoding: Set by user.
2600 * - decoding: unused
2602 int frame_skip_factor;
2605 * frame skip exponent
2606 * - encoding: Set by user.
2607 * - decoding: unused
2612 * frame skip comparison function
2613 * - encoding: Set by user.
2614 * - decoding: unused
2619 * trellis RD quantization
2620 * - encoding: Set by user.
2621 * - decoding: unused
2626 * - encoding: Set by user.
2627 * - decoding: unused
2629 int min_prediction_order;
2632 * - encoding: Set by user.
2633 * - decoding: unused
2635 int max_prediction_order;
2638 * GOP timecode frame start number
2639 * - encoding: Set by user, in non drop frame format
2640 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2642 int64_t timecode_frame_start;
2644 /* The RTP callback: This function is called */
2645 /* every time the encoder has a packet to send. */
2646 /* It depends on the encoder if the data starts */
2647 /* with a Start Code (it should). H.263 does. */
2648 /* mb_nb contains the number of macroblocks */
2649 /* encoded in the RTP payload. */
2650 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2652 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2653 /* do its best to deliver a chunk with size */
2654 /* below rtp_payload_size, the chunk will start */
2655 /* with a start code on some codecs like H.263. */
2656 /* This doesn't take account of any particular */
2657 /* headers inside the transmitted RTP payload. */
2659 /* statistics, used for 2-pass encoding */
2670 * number of bits used for the previously encoded frame
2671 * - encoding: Set by libavcodec.
2672 * - decoding: unused
2677 * pass1 encoding statistics output buffer
2678 * - encoding: Set by libavcodec.
2679 * - decoding: unused
2684 * pass2 encoding statistics input buffer
2685 * Concatenated stuff from stats_out of pass1 should be placed here.
2686 * - encoding: Allocated/set/freed by user.
2687 * - decoding: unused
2692 * Work around bugs in encoders which sometimes cannot be detected automatically.
2693 * - encoding: Set by user
2694 * - decoding: Set by user
2696 int workaround_bugs;
2697 #define FF_BUG_AUTODETECT 1 ///< autodetection
2698 #define FF_BUG_OLD_MSMPEG4 2
2699 #define FF_BUG_XVID_ILACE 4
2700 #define FF_BUG_UMP4 8
2701 #define FF_BUG_NO_PADDING 16
2702 #define FF_BUG_AMV 32
2703 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2704 #define FF_BUG_QPEL_CHROMA 64
2705 #define FF_BUG_STD_QPEL 128
2706 #define FF_BUG_QPEL_CHROMA2 256
2707 #define FF_BUG_DIRECT_BLOCKSIZE 512
2708 #define FF_BUG_EDGE 1024
2709 #define FF_BUG_HPEL_CHROMA 2048
2710 #define FF_BUG_DC_CLIP 4096
2711 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2712 #define FF_BUG_TRUNCATED 16384
2715 * strictly follow the standard (MPEG4, ...).
2716 * - encoding: Set by user.
2717 * - decoding: Set by user.
2718 * Setting this to STRICT or higher means the encoder and decoder will
2719 * generally do stupid things, whereas setting it to unofficial or lower
2720 * will mean the encoder might produce output that is not supported by all
2721 * spec-compliant decoders. Decoders don't differentiate between normal,
2722 * unofficial and experimental (that is, they always try to decode things
2723 * when they can) unless they are explicitly asked to behave stupidly
2724 * (=strictly conform to the specs)
2726 int strict_std_compliance;
2727 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2728 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2729 #define FF_COMPLIANCE_NORMAL 0
2730 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2731 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2734 * error concealment flags
2735 * - encoding: unused
2736 * - decoding: Set by user.
2738 int error_concealment;
2739 #define FF_EC_GUESS_MVS 1
2740 #define FF_EC_DEBLOCK 2
2744 * - encoding: Set by user.
2745 * - decoding: Set by user.
2748 #define FF_DEBUG_PICT_INFO 1
2749 #define FF_DEBUG_RC 2
2750 #define FF_DEBUG_BITSTREAM 4
2751 #define FF_DEBUG_MB_TYPE 8
2752 #define FF_DEBUG_QP 16
2753 #define FF_DEBUG_MV 32
2754 #define FF_DEBUG_DCT_COEFF 0x00000040
2755 #define FF_DEBUG_SKIP 0x00000080
2756 #define FF_DEBUG_STARTCODE 0x00000100
2757 #define FF_DEBUG_PTS 0x00000200
2758 #define FF_DEBUG_ER 0x00000400
2759 #define FF_DEBUG_MMCO 0x00000800
2760 #define FF_DEBUG_BUGS 0x00001000
2761 #define FF_DEBUG_VIS_QP 0x00002000
2762 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2763 #define FF_DEBUG_BUFFERS 0x00008000
2764 #define FF_DEBUG_THREADS 0x00010000
2768 * - encoding: Set by user.
2769 * - decoding: Set by user.
2772 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2773 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2774 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2777 * Error recognition; may misdetect some more or less valid parts as errors.
2778 * - encoding: unused
2779 * - decoding: Set by user.
2781 int err_recognition;
2782 #define AV_EF_CRCCHECK (1<<0)
2783 #define AV_EF_BITSTREAM (1<<1)
2784 #define AV_EF_BUFFER (1<<2)
2785 #define AV_EF_EXPLODE (1<<3)
2787 #define AV_EF_CAREFUL (1<<16)
2788 #define AV_EF_COMPLIANT (1<<17)
2789 #define AV_EF_AGGRESSIVE (1<<18)
2793 * opaque 64bit number (generally a PTS) that will be reordered and
2794 * output in AVFrame.reordered_opaque
2795 * @deprecated in favor of pkt_pts
2796 * - encoding: unused
2797 * - decoding: Set by user.
2799 int64_t reordered_opaque;
2802 * Hardware accelerator in use
2803 * - encoding: unused.
2804 * - decoding: Set by libavcodec
2806 struct AVHWAccel *hwaccel;
2809 * Hardware accelerator context.
2810 * For some hardware accelerators, a global context needs to be
2811 * provided by the user. In that case, this holds display-dependent
2812 * data FFmpeg cannot instantiate itself. Please refer to the
2813 * FFmpeg HW accelerator documentation to know how to fill this
2814 * is. e.g. for VA API, this is a struct vaapi_context.
2815 * - encoding: unused
2816 * - decoding: Set by user
2818 void *hwaccel_context;
2822 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2823 * - decoding: unused
2825 uint64_t error[AV_NUM_DATA_POINTERS];
2828 * DCT algorithm, see FF_DCT_* below
2829 * - encoding: Set by user.
2830 * - decoding: unused
2833 #define FF_DCT_AUTO 0
2834 #define FF_DCT_FASTINT 1
2835 #define FF_DCT_INT 2
2836 #define FF_DCT_MMX 3
2837 #define FF_DCT_ALTIVEC 5
2838 #define FF_DCT_FAAN 6
2841 * IDCT algorithm, see FF_IDCT_* below.
2842 * - encoding: Set by user.
2843 * - decoding: Set by user.
2846 #define FF_IDCT_AUTO 0
2847 #define FF_IDCT_INT 1
2848 #define FF_IDCT_SIMPLE 2
2849 #define FF_IDCT_SIMPLEMMX 3
2850 #define FF_IDCT_LIBMPEG2MMX 4
2852 #define FF_IDCT_MMI 5
2854 #define FF_IDCT_ARM 7
2855 #define FF_IDCT_ALTIVEC 8
2856 #define FF_IDCT_SH4 9
2857 #define FF_IDCT_SIMPLEARM 10
2858 #define FF_IDCT_H264 11
2859 #define FF_IDCT_VP3 12
2860 #define FF_IDCT_IPP 13
2861 #define FF_IDCT_XVIDMMX 14
2862 #define FF_IDCT_CAVS 15
2863 #define FF_IDCT_SIMPLEARMV5TE 16
2864 #define FF_IDCT_SIMPLEARMV6 17
2865 #define FF_IDCT_SIMPLEVIS 18
2866 #define FF_IDCT_WMV2 19
2867 #define FF_IDCT_FAAN 20
2868 #define FF_IDCT_EA 21
2869 #define FF_IDCT_SIMPLENEON 22
2870 #define FF_IDCT_SIMPLEALPHA 23
2871 #define FF_IDCT_BINK 24
2876 * @deprecated use av_set_cpu_flags_mask() instead.
2878 attribute_deprecated unsigned dsp_mask;
2882 * bits per sample/pixel from the demuxer (needed for huffyuv).
2883 * - encoding: Set by libavcodec.
2884 * - decoding: Set by user.
2886 int bits_per_coded_sample;
2889 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2890 * - encoding: set by user.
2891 * - decoding: set by libavcodec.
2893 int bits_per_raw_sample;
2896 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2897 * - encoding: unused
2898 * - decoding: Set by user.
2903 * the picture in the bitstream
2904 * - encoding: Set by libavcodec.
2905 * - decoding: Set by libavcodec.
2907 AVFrame *coded_frame;
2911 * is used to decide how many independent tasks should be passed to execute()
2912 * - encoding: Set by user.
2913 * - decoding: Set by user.
2918 * Which multithreading methods to use.
2919 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2920 * so clients which cannot provide future frames should not use it.
2922 * - encoding: Set by user, otherwise the default is used.
2923 * - decoding: Set by user, otherwise the default is used.
2926 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2927 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2930 * Which multithreading methods are in use by the codec.
2931 * - encoding: Set by libavcodec.
2932 * - decoding: Set by libavcodec.
2934 int active_thread_type;
2937 * Set by the client if its custom get_buffer() callback can be called
2938 * synchronously from another thread, which allows faster multithreaded decoding.
2939 * draw_horiz_band() will be called from other threads regardless of this setting.
2940 * Ignored if the default get_buffer() is used.
2941 * - encoding: Set by user.
2942 * - decoding: Set by user.
2944 int thread_safe_callbacks;
2947 * The codec may call this to execute several independent things.
2948 * It will return only after finishing all tasks.
2949 * The user may replace this with some multithreaded implementation,
2950 * the default implementation will execute the parts serially.
2951 * @param count the number of things to execute
2952 * - encoding: Set by libavcodec, user can override.
2953 * - decoding: Set by libavcodec, user can override.
2955 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2958 * The codec may call this to execute several independent things.
2959 * It will return only after finishing all tasks.
2960 * The user may replace this with some multithreaded implementation,
2961 * the default implementation will execute the parts serially.
2962 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2963 * @param c context passed also to func
2964 * @param count the number of things to execute
2965 * @param arg2 argument passed unchanged to func
2966 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2967 * @param func function that will be called count times, with jobnr from 0 to count-1.
2968 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2969 * two instances of func executing at the same time will have the same threadnr.
2970 * @return always 0 currently, but code should handle a future improvement where when any call to func
2971 * returns < 0 no further calls to func may be done and < 0 is returned.
2972 * - encoding: Set by libavcodec, user can override.
2973 * - decoding: Set by libavcodec, user can override.
2975 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2979 * Can be used by execute() to store some per AVCodecContext stuff.
2980 * - encoding: set by execute()
2981 * - decoding: set by execute()
2983 void *thread_opaque;
2986 * noise vs. sse weight for the nsse comparsion function
2987 * - encoding: Set by user.
2988 * - decoding: unused
2994 * - encoding: Set by user.
2995 * - decoding: Set by libavcodec.
2998 #define FF_PROFILE_UNKNOWN -99
2999 #define FF_PROFILE_RESERVED -100
3001 #define FF_PROFILE_AAC_MAIN 0
3002 #define FF_PROFILE_AAC_LOW 1
3003 #define FF_PROFILE_AAC_SSR 2
3004 #define FF_PROFILE_AAC_LTP 3
3005 #define FF_PROFILE_AAC_HE 4
3006 #define FF_PROFILE_AAC_HE_V2 28
3007 #define FF_PROFILE_AAC_LD 22
3008 #define FF_PROFILE_AAC_ELD 38
3010 #define FF_PROFILE_DTS 20
3011 #define FF_PROFILE_DTS_ES 30
3012 #define FF_PROFILE_DTS_96_24 40
3013 #define FF_PROFILE_DTS_HD_HRA 50
3014 #define FF_PROFILE_DTS_HD_MA 60
3016 #define FF_PROFILE_MPEG2_422 0
3017 #define FF_PROFILE_MPEG2_HIGH 1
3018 #define FF_PROFILE_MPEG2_SS 2
3019 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3020 #define FF_PROFILE_MPEG2_MAIN 4
3021 #define FF_PROFILE_MPEG2_SIMPLE 5
3023 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3024 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3026 #define FF_PROFILE_H264_BASELINE 66
3027 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3028 #define FF_PROFILE_H264_MAIN 77
3029 #define FF_PROFILE_H264_EXTENDED 88
3030 #define FF_PROFILE_H264_HIGH 100
3031 #define FF_PROFILE_H264_HIGH_10 110
3032 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3033 #define FF_PROFILE_H264_HIGH_422 122
3034 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3035 #define FF_PROFILE_H264_HIGH_444 144
3036 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3037 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3038 #define FF_PROFILE_H264_CAVLC_444 44
3040 #define FF_PROFILE_VC1_SIMPLE 0
3041 #define FF_PROFILE_VC1_MAIN 1
3042 #define FF_PROFILE_VC1_COMPLEX 2
3043 #define FF_PROFILE_VC1_ADVANCED 3
3045 #define FF_PROFILE_MPEG4_SIMPLE 0
3046 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3047 #define FF_PROFILE_MPEG4_CORE 2
3048 #define FF_PROFILE_MPEG4_MAIN 3
3049 #define FF_PROFILE_MPEG4_N_BIT 4
3050 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3051 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3052 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3053 #define FF_PROFILE_MPEG4_HYBRID 8
3054 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3055 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3056 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3057 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3058 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3059 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3060 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3064 * - encoding: Set by user.
3065 * - decoding: Set by libavcodec.
3068 #define FF_LEVEL_UNKNOWN -99
3072 * - encoding: unused
3073 * - decoding: Set by user.
3075 enum AVDiscard skip_loop_filter;
3079 * - encoding: unused
3080 * - decoding: Set by user.
3082 enum AVDiscard skip_idct;
3086 * - encoding: unused
3087 * - decoding: Set by user.
3089 enum AVDiscard skip_frame;
3092 * Header containing style information for text subtitles.
3093 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3094 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3095 * the Format line following. It shouldn't include any Dialogue line.
3096 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3097 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3099 uint8_t *subtitle_header;
3100 int subtitle_header_size;
3103 * Simulates errors in the bitstream to test error concealment.
3104 * - encoding: Set by user.
3105 * - decoding: unused
3110 * Current packet as passed into the decoder, to avoid having
3111 * to pass the packet into every function. Currently only valid
3112 * inside lavc and get/release_buffer callbacks.
3113 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
3114 * - encoding: unused
3119 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3120 * Used for compliant TS muxing.
3121 * - encoding: Set by libavcodec.
3122 * - decoding: unused.
3127 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3128 * Code outside libavcodec should access this field using:
3129 * avcodec_set_pkt_timebase(avctx)
3130 * - encoding unused.
3131 * - decodimg set by user
3133 AVRational pkt_timebase;
3137 * Code outside libavcodec should access this field using:
3138 * avcodec_get_codec_descriptior(avctx)
3139 * - encoding: unused.
3140 * - decoding: set by libavcodec.
3142 const AVCodecDescriptor *codec_descriptor;
3145 * Current statistics for PTS correction.
3146 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3147 * - encoding: unused
3149 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3150 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3151 int64_t pts_correction_last_pts; /// PTS of the last frame
3152 int64_t pts_correction_last_dts; /// DTS of the last frame
3155 * Current frame metadata.
3156 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3157 * - encoding: unused
3159 AVDictionary *metadata;
3162 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3163 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3165 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3166 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3171 typedef struct AVProfile {
3173 const char *name; ///< short name for the profile
3176 typedef struct AVCodecDefault AVCodecDefault;
3183 typedef struct AVCodec {
3185 * Name of the codec implementation.
3186 * The name is globally unique among encoders and among decoders (but an
3187 * encoder and a decoder can share the same name).
3188 * This is the primary way to find a codec from the user perspective.
3192 * Descriptive name for the codec, meant to be more human readable than name.
3193 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3195 const char *long_name;
3196 enum AVMediaType type;
3199 * Codec capabilities.
3203 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3204 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3205 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3206 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3207 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3208 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3209 const AVClass *priv_class; ///< AVClass for the private context
3210 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3212 /*****************************************************************
3213 * No fields below this line are part of the public API. They
3214 * may not be used outside of libavcodec and can be changed and
3216 * New public fields should be added right above.
3217 *****************************************************************
3220 struct AVCodec *next;
3222 * @name Frame-level threading support functions
3226 * If defined, called on thread contexts when they are created.
3227 * If the codec allocates writable tables in init(), re-allocate them here.
3228 * priv_data will be set to a copy of the original.
3230 int (*init_thread_copy)(AVCodecContext *);
3232 * Copy necessary context variables from a previous thread context to the current one.
3233 * If not defined, the next thread will start automatically; otherwise, the codec
3234 * must call ff_thread_finish_setup().
3236 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3238 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3242 * Private codec-specific defaults.
3244 const AVCodecDefault *defaults;
3247 * Initialize codec static data, called from avcodec_register().
3249 void (*init_static_data)(struct AVCodec *codec);
3251 int (*init)(AVCodecContext *);
3252 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3253 const struct AVSubtitle *sub);
3255 * Encode data to an AVPacket.
3257 * @param avctx codec context
3258 * @param avpkt output AVPacket (may contain a user-provided buffer)
3259 * @param[in] frame AVFrame containing the raw data to be encoded
3260 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3261 * non-empty packet was returned in avpkt.
3262 * @return 0 on success, negative error code on failure
3264 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3265 int *got_packet_ptr);
3266 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3267 int (*close)(AVCodecContext *);
3270 * Will be called when seeking
3272 void (*flush)(AVCodecContext *);
3278 typedef struct AVHWAccel {
3280 * Name of the hardware accelerated codec.
3281 * The name is globally unique among encoders and among decoders (but an
3282 * encoder and a decoder can share the same name).
3287 * Type of codec implemented by the hardware accelerator.
3289 * See AVMEDIA_TYPE_xxx
3291 enum AVMediaType type;
3294 * Codec implemented by the hardware accelerator.
3296 * See AV_CODEC_ID_xxx
3301 * Supported pixel format.
3303 * Only hardware accelerated formats are supported here.
3305 enum AVPixelFormat pix_fmt;
3308 * Hardware accelerated codec capabilities.
3309 * see FF_HWACCEL_CODEC_CAP_*
3313 struct AVHWAccel *next;
3316 * Called at the beginning of each frame or field picture.
3318 * Meaningful frame information (codec specific) is guaranteed to
3319 * be parsed at this point. This function is mandatory.
3321 * Note that buf can be NULL along with buf_size set to 0.
3322 * Otherwise, this means the whole frame is available at this point.
3324 * @param avctx the codec context
3325 * @param buf the frame data buffer base
3326 * @param buf_size the size of the frame in bytes
3327 * @return zero if successful, a negative value otherwise
3329 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3332 * Callback for each slice.
3334 * Meaningful slice information (codec specific) is guaranteed to
3335 * be parsed at this point. This function is mandatory.
3337 * @param avctx the codec context
3338 * @param buf the slice data buffer base
3339 * @param buf_size the size of the slice in bytes
3340 * @return zero if successful, a negative value otherwise
3342 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3345 * Called at the end of each frame or field picture.
3347 * The whole picture is parsed at this point and can now be sent
3348 * to the hardware accelerator. This function is mandatory.
3350 * @param avctx the codec context
3351 * @return zero if successful, a negative value otherwise
3353 int (*end_frame)(AVCodecContext *avctx);
3356 * Size of HW accelerator private data.
3358 * Private data is allocated with av_mallocz() before
3359 * AVCodecContext.get_buffer() and deallocated after
3360 * AVCodecContext.release_buffer().
3366 * @defgroup lavc_picture AVPicture
3368 * Functions for working with AVPicture
3373 * four components are given, that's all.
3374 * the last component is alpha
3376 typedef struct AVPicture {
3377 uint8_t *data[AV_NUM_DATA_POINTERS];
3378 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3385 enum AVSubtitleType {
3388 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3391 * Plain text, the text field must be set by the decoder and is
3392 * authoritative. ass and pict fields may contain approximations.
3397 * Formatted text, the ass field must be set by the decoder and is
3398 * authoritative. pict and text fields may contain approximations.
3403 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3405 typedef struct AVSubtitleRect {
3406 int x; ///< top left corner of pict, undefined when pict is not set
3407 int y; ///< top left corner of pict, undefined when pict is not set
3408 int w; ///< width of pict, undefined when pict is not set
3409 int h; ///< height of pict, undefined when pict is not set
3410 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3413 * data+linesize for the bitmap of this subtitle.
3414 * can be set for text/ass as well once they where rendered
3417 enum AVSubtitleType type;
3419 char *text; ///< 0 terminated plain UTF-8 text
3422 * 0 terminated ASS/SSA compatible event line.
3423 * The presentation of this is unaffected by the other values in this
3431 typedef struct AVSubtitle {
3432 uint16_t format; /* 0 = graphics */
3433 uint32_t start_display_time; /* relative to packet pts, in ms */
3434 uint32_t end_display_time; /* relative to packet pts, in ms */
3436 AVSubtitleRect **rects;
3437 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3441 * If c is NULL, returns the first registered codec,
3442 * if c is non-NULL, returns the next registered codec after c,
3443 * or NULL if c is the last one.
3445 AVCodec *av_codec_next(const AVCodec *c);
3448 * Return the LIBAVCODEC_VERSION_INT constant.
3450 unsigned avcodec_version(void);
3453 * Return the libavcodec build-time configuration.
3455 const char *avcodec_configuration(void);
3458 * Return the libavcodec license.
3460 const char *avcodec_license(void);
3463 * Register the codec codec and initialize libavcodec.
3465 * @warning either this function or avcodec_register_all() must be called
3466 * before any other libavcodec functions.
3468 * @see avcodec_register_all()
3470 void avcodec_register(AVCodec *codec);
3473 * Register all the codecs, parsers and bitstream filters which were enabled at
3474 * configuration time. If you do not call this function you can select exactly
3475 * which formats you want to support, by using the individual registration
3478 * @see avcodec_register
3479 * @see av_register_codec_parser
3480 * @see av_register_bitstream_filter
3482 void avcodec_register_all(void);
3485 #if FF_API_ALLOC_CONTEXT
3487 * Allocate an AVCodecContext and set its fields to default values. The
3488 * resulting struct can be deallocated by simply calling av_free().
3490 * @return An AVCodecContext filled with default values or NULL on failure.
3491 * @see avcodec_get_context_defaults
3493 * @deprecated use avcodec_alloc_context3()
3495 attribute_deprecated
3496 AVCodecContext *avcodec_alloc_context(void);
3498 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3499 * we WILL change its arguments and name a few times! */
3500 attribute_deprecated
3501 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3504 * Set the fields of the given AVCodecContext to default values.
3506 * @param s The AVCodecContext of which the fields should be set to default values.
3507 * @deprecated use avcodec_get_context_defaults3
3509 attribute_deprecated
3510 void avcodec_get_context_defaults(AVCodecContext *s);
3512 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3513 * we WILL change its arguments and name a few times! */
3514 attribute_deprecated
3515 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3519 * Allocate an AVCodecContext and set its fields to default values. The
3520 * resulting struct can be deallocated by calling avcodec_close() on it followed
3523 * @param codec if non-NULL, allocate private data and initialize defaults
3524 * for the given codec. It is illegal to then call avcodec_open2()
3525 * with a different codec.
3526 * If NULL, then the codec-specific defaults won't be initialized,
3527 * which may result in suboptimal default settings (this is
3528 * important mainly for encoders, e.g. libx264).
3530 * @return An AVCodecContext filled with default values or NULL on failure.
3531 * @see avcodec_get_context_defaults
3533 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3536 * Set the fields of the given AVCodecContext to default values corresponding
3537 * to the given codec (defaults may be codec-dependent).
3539 * Do not call this function if a non-NULL codec has been passed
3540 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3541 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3542 * different codec on this AVCodecContext.
3544 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3547 * Get the AVClass for AVCodecContext. It can be used in combination with
3548 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3550 * @see av_opt_find().
3552 const AVClass *avcodec_get_class(void);
3555 * Get the AVClass for AVFrame. It can be used in combination with
3556 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3558 * @see av_opt_find().
3560 const AVClass *avcodec_get_frame_class(void);
3563 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3564 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3566 * @see av_opt_find().
3568 const AVClass *avcodec_get_subtitle_rect_class(void);
3571 * Copy the settings of the source AVCodecContext into the destination
3572 * AVCodecContext. The resulting destination codec context will be
3573 * unopened, i.e. you are required to call avcodec_open2() before you
3574 * can use this AVCodecContext to decode/encode video/audio data.
3576 * @param dest target codec context, should be initialized with
3577 * avcodec_alloc_context3(), but otherwise uninitialized
3578 * @param src source codec context
3579 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3581 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3584 * Allocate an AVFrame and set its fields to default values. The resulting
3585 * struct must be freed using avcodec_free_frame().
3587 * @return An AVFrame filled with default values or NULL on failure.
3588 * @see avcodec_get_frame_defaults
3590 AVFrame *avcodec_alloc_frame(void);
3593 * Set the fields of the given AVFrame to default values.
3595 * @param frame The AVFrame of which the fields should be set to default values.
3597 void avcodec_get_frame_defaults(AVFrame *frame);
3600 * Free the frame and any dynamically allocated objects in it,
3601 * e.g. extended_data.
3603 * @param frame frame to be freed. The pointer will be set to NULL.
3605 * @warning this function does NOT free the data buffers themselves
3606 * (it does not know how, since they might have been allocated with
3607 * a custom get_buffer()).
3609 void avcodec_free_frame(AVFrame **frame);
3611 #if FF_API_AVCODEC_OPEN
3613 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3614 * function the context has to be allocated.
3616 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3617 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3618 * retrieving a codec.
3620 * @warning This function is not thread safe!
3623 * avcodec_register_all();
3624 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3628 * context = avcodec_alloc_context3(codec);
3630 * if (avcodec_open(context, codec) < 0)
3634 * @param avctx The context which will be set up to use the given codec.
3635 * @param codec The codec to use within the context.
3636 * @return zero on success, a negative value on error
3637 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3639 * @deprecated use avcodec_open2
3641 attribute_deprecated
3642 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3646 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3647 * function the context has to be allocated with avcodec_alloc_context3().
3649 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3650 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3651 * retrieving a codec.
3653 * @warning This function is not thread safe!
3656 * avcodec_register_all();
3657 * av_dict_set(&opts, "b", "2.5M", 0);
3658 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3662 * context = avcodec_alloc_context3(codec);
3664 * if (avcodec_open2(context, codec, opts) < 0)
3668 * @param avctx The context to initialize.
3669 * @param codec The codec to open this context for. If a non-NULL codec has been
3670 * previously passed to avcodec_alloc_context3() or
3671 * avcodec_get_context_defaults3() for this context, then this
3672 * parameter MUST be either NULL or equal to the previously passed
3674 * @param options A dictionary filled with AVCodecContext and codec-private options.
3675 * On return this object will be filled with options that were not found.
3677 * @return zero on success, a negative value on error
3678 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3679 * av_dict_set(), av_opt_find().
3681 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3684 * Close a given AVCodecContext and free all the data associated with it
3685 * (but not the AVCodecContext itself).
3687 * Calling this function on an AVCodecContext that hasn't been opened will free
3688 * the codec-specific data allocated in avcodec_alloc_context3() /
3689 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3692 int avcodec_close(AVCodecContext *avctx);
3695 * Free all allocated data in the given subtitle struct.
3697 * @param sub AVSubtitle to free.
3699 void avsubtitle_free(AVSubtitle *sub);
3706 * @addtogroup lavc_packet
3711 * Default packet destructor.
3713 void av_destruct_packet(AVPacket *pkt);
3716 * Initialize optional fields of a packet with default values.
3718 * Note, this does not touch the data and size members, which have to be
3719 * initialized separately.
3723 void av_init_packet(AVPacket *pkt);
3726 * Allocate the payload of a packet and initialize its fields with
3730 * @param size wanted payload size
3731 * @return 0 if OK, AVERROR_xxx otherwise
3733 int av_new_packet(AVPacket *pkt, int size);
3736 * Reduce packet size, correctly zeroing padding
3739 * @param size new size
3741 void av_shrink_packet(AVPacket *pkt, int size);
3744 * Increase packet size, correctly zeroing padding
3747 * @param grow_by number of bytes by which to increase the size of the packet
3749 int av_grow_packet(AVPacket *pkt, int grow_by);
3752 * @warning This is a hack - the packet memory allocation stuff is broken. The
3753 * packet is allocated if it was not really allocated.
3755 int av_dup_packet(AVPacket *pkt);
3758 * Copy packet, including contents
3760 * @return 0 on success, negative AVERROR on fail
3762 int av_copy_packet(AVPacket *dst, AVPacket *src);
3767 * @param pkt packet to free
3769 void av_free_packet(AVPacket *pkt);
3772 * Allocate new information of a packet.
3775 * @param type side information type
3776 * @param size side information size
3777 * @return pointer to fresh allocated data or NULL otherwise
3779 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3783 * Shrink the already allocated side data buffer
3786 * @param type side information type
3787 * @param size new side information size
3788 * @return 0 on success, < 0 on failure
3790 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3794 * Get side information from packet.
3797 * @param type desired side information type
3798 * @param size pointer for side information size to store (optional)
3799 * @return pointer to data if present or NULL otherwise
3801 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3804 int av_packet_merge_side_data(AVPacket *pkt);
3806 int av_packet_split_side_data(AVPacket *pkt);
3814 * @addtogroup lavc_decoding
3819 * Find a registered decoder with a matching codec ID.
3821 * @param id AVCodecID of the requested decoder
3822 * @return A decoder if one was found, NULL otherwise.
3824 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3827 * Find a registered decoder with the specified name.
3829 * @param name name of the requested decoder
3830 * @return A decoder if one was found, NULL otherwise.
3832 AVCodec *avcodec_find_decoder_by_name(const char *name);
3834 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3835 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3836 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3839 * Return the amount of padding in pixels which the get_buffer callback must
3840 * provide around the edge of the image for codecs which do not have the
3841 * CODEC_FLAG_EMU_EDGE flag.
3843 * @return Required padding in pixels.
3845 unsigned avcodec_get_edge_width(void);
3848 * Modify width and height values so that they will result in a memory
3849 * buffer that is acceptable for the codec if you do not use any horizontal
3852 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3853 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3854 * according to avcodec_get_edge_width() before.
3856 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3859 * Modify width and height values so that they will result in a memory
3860 * buffer that is acceptable for the codec if you also ensure that all
3861 * line sizes are a multiple of the respective linesize_align[i].
3863 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3864 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3865 * according to avcodec_get_edge_width() before.
3867 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3868 int linesize_align[AV_NUM_DATA_POINTERS]);
3870 #if FF_API_OLD_DECODE_AUDIO
3872 * Wrapper function which calls avcodec_decode_audio4.
3874 * @deprecated Use avcodec_decode_audio4 instead.
3876 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3877 * Some decoders may support multiple frames in a single AVPacket, such
3878 * decoders would then just decode the first frame. In this case,
3879 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3880 * the remaining data in order to decode the second frame etc.
3882 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3883 * decompressed frame size in bytes.
3885 * @warning You must set frame_size_ptr to the allocated size of the
3886 * output buffer before calling avcodec_decode_audio3().
3888 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3889 * the actual read bytes because some optimized bitstream readers read 32 or 64
3890 * bits at once and could read over the end.
3892 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3893 * no overreading happens for damaged MPEG streams.
3895 * @warning You must not provide a custom get_buffer() when using
3896 * avcodec_decode_audio3(). Doing so will override it with
3897 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3898 * which does allow the application to provide a custom get_buffer().
3900 * @note You might have to align the input buffer avpkt->data and output buffer
3901 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3902 * necessary at all, on others it won't work at all if not aligned and on others
3903 * it will work but it will have an impact on performance.
3905 * In practice, avpkt->data should have 4 byte alignment at minimum and
3906 * samples should be 16 byte aligned unless the CPU doesn't need it
3907 * (AltiVec and SSE do).
3909 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3910 * between input and output, these need to be fed with avpkt->data=NULL,
3911 * avpkt->size=0 at the end to return the remaining frames.
3913 * @param avctx the codec context
3914 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3915 * If the sample format is planar, each channel plane will
3916 * be the same size, with no padding between channels.
3917 * @param[in,out] frame_size_ptr the output buffer size in bytes
3918 * @param[in] avpkt The input AVPacket containing the input buffer.
3919 * You can create such packet with av_init_packet() and by then setting
3920 * data and size, some decoders might in addition need other fields.
3921 * All decoders are designed to use the least fields possible though.
3922 * @return On error a negative value is returned, otherwise the number of bytes
3923 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3925 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3926 int *frame_size_ptr,
3931 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3933 * Some decoders may support multiple frames in a single AVPacket. Such
3934 * decoders would then just decode the first frame. In this case,
3935 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3936 * the remaining data in order to decode the second frame, etc...
3937 * Even if no frames are returned, the packet needs to be fed to the decoder
3938 * with remaining data until it is completely consumed or an error occurs.
3940 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3941 * larger than the actual read bytes because some optimized bitstream
3942 * readers read 32 or 64 bits at once and could read over the end.
3944 * @note You might have to align the input buffer. The alignment requirements
3945 * depend on the CPU and the decoder.
3947 * @param avctx the codec context
3948 * @param[out] frame The AVFrame in which to store decoded audio samples.
3949 * Decoders request a buffer of a particular size by setting
3950 * AVFrame.nb_samples prior to calling get_buffer(). The
3951 * decoder may, however, only utilize part of the buffer by
3952 * setting AVFrame.nb_samples to a smaller value in the
3954 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3956 * @param[in] avpkt The input AVPacket containing the input buffer.
3957 * At least avpkt->data and avpkt->size should be set. Some
3958 * decoders might also require additional fields to be set.
3959 * @return A negative error code is returned if an error occurred during
3960 * decoding, otherwise the number of bytes consumed from the input
3961 * AVPacket is returned.
3963 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3964 int *got_frame_ptr, const AVPacket *avpkt);
3967 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3968 * Some decoders may support multiple frames in a single AVPacket, such
3969 * decoders would then just decode the first frame.
3971 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3972 * the actual read bytes because some optimized bitstream readers read 32 or 64
3973 * bits at once and could read over the end.
3975 * @warning The end of the input buffer buf should be set to 0 to ensure that
3976 * no overreading happens for damaged MPEG streams.
3978 * @note You might have to align the input buffer avpkt->data.
3979 * The alignment requirements depend on the CPU: on some CPUs it isn't
3980 * necessary at all, on others it won't work at all if not aligned and on others
3981 * it will work but it will have an impact on performance.
3983 * In practice, avpkt->data should have 4 byte alignment at minimum.
3985 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3986 * between input and output, these need to be fed with avpkt->data=NULL,
3987 * avpkt->size=0 at the end to return the remaining frames.
3989 * @param avctx the codec context
3990 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3991 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3992 * allocate memory for the actual bitmap.
3993 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3994 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3995 * decodes and the decoder tells the user once it does not need the data anymore,
3996 * the user app can at this point free/reuse/keep the memory as it sees fit.
3998 * @param[in] avpkt The input AVpacket containing the input buffer.
3999 * You can create such packet with av_init_packet() and by then setting
4000 * data and size, some decoders might in addition need other fields like
4001 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4003 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4004 * @return On error a negative value is returned, otherwise the number of bytes
4005 * used or zero if no frame could be decompressed.
4007 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4008 int *got_picture_ptr,
4009 const AVPacket *avpkt);
4012 * Decode a subtitle message.
4013 * Return a negative value on error, otherwise return the number of bytes used.
4014 * If no subtitle could be decompressed, got_sub_ptr is zero.
4015 * Otherwise, the subtitle is stored in *sub.
4016 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4017 * simplicity, because the performance difference is expect to be negligible
4018 * and reusing a get_buffer written for video codecs would probably perform badly
4019 * due to a potentially very different allocation pattern.
4021 * @param avctx the codec context
4022 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4023 freed with avsubtitle_free if *got_sub_ptr is set.
4024 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4025 * @param[in] avpkt The input AVPacket containing the input buffer.
4027 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4032 * @defgroup lavc_parsing Frame parsing
4036 typedef struct AVCodecParserContext {
4038 struct AVCodecParser *parser;
4039 int64_t frame_offset; /* offset of the current frame */
4040 int64_t cur_offset; /* current offset
4041 (incremented by each av_parser_parse()) */
4042 int64_t next_frame_offset; /* offset of the next frame */
4044 int pict_type; /* XXX: Put it back in AVCodecContext. */
4046 * This field is used for proper frame duration computation in lavf.
4047 * It signals, how much longer the frame duration of the current frame
4048 * is compared to normal frame duration.
4050 * frame_duration = (1 + repeat_pict) * time_base
4052 * It is used by codecs like H.264 to display telecined material.
4054 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4055 int64_t pts; /* pts of the current frame */
4056 int64_t dts; /* dts of the current frame */
4061 int fetch_timestamp;
4063 #define AV_PARSER_PTS_NB 4
4064 int cur_frame_start_index;
4065 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4066 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4067 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4070 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4071 #define PARSER_FLAG_ONCE 0x0002
4072 /// Set if the parser has a valid file offset
4073 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4074 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4076 int64_t offset; ///< byte offset from starting packet start
4077 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4080 * Set by parser to 1 for key frames and 0 for non-key frames.
4081 * It is initialized to -1, so if the parser doesn't set this flag,
4082 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4088 * Time difference in stream time base units from the pts of this
4089 * packet to the point at which the output from the decoder has converged
4090 * independent from the availability of previous frames. That is, the
4091 * frames are virtually identical no matter if decoding started from
4092 * the very first frame or from this keyframe.
4093 * Is AV_NOPTS_VALUE if unknown.
4094 * This field is not the display duration of the current frame.
4095 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4098 * The purpose of this field is to allow seeking in streams that have no
4099 * keyframes in the conventional sense. It corresponds to the
4100 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4101 * essential for some types of subtitle streams to ensure that all
4102 * subtitles are correctly displayed after seeking.
4104 int64_t convergence_duration;
4106 // Timestamp generation support:
4108 * Synchronization point for start of timestamp generation.
4110 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4113 * For example, this corresponds to presence of H.264 buffering period
4119 * Offset of the current timestamp against last timestamp sync point in
4120 * units of AVCodecContext.time_base.
4122 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4123 * contain a valid timestamp offset.
4125 * Note that the timestamp of sync point has usually a nonzero
4126 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4127 * the next frame after timestamp sync point will be usually 1.
4129 * For example, this corresponds to H.264 cpb_removal_delay.
4131 int dts_ref_dts_delta;
4134 * Presentation delay of current frame in units of AVCodecContext.time_base.
4136 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4137 * contain valid non-negative timestamp delta (presentation time of a frame
4138 * must not lie in the past).
4140 * This delay represents the difference between decoding and presentation
4141 * time of the frame.
4143 * For example, this corresponds to H.264 dpb_output_delay.
4148 * Position of the packet in file.
4150 * Analogous to cur_frame_pts/dts
4152 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4155 * Byte position of currently parsed frame in stream.
4160 * Previous frame byte position.
4165 * Duration of the current frame.
4166 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4167 * For all other types, this is in units of AVCodecContext.time_base.
4170 } AVCodecParserContext;
4172 typedef struct AVCodecParser {
4173 int codec_ids[5]; /* several codec IDs are permitted */
4175 int (*parser_init)(AVCodecParserContext *s);
4176 int (*parser_parse)(AVCodecParserContext *s,
4177 AVCodecContext *avctx,
4178 const uint8_t **poutbuf, int *poutbuf_size,
4179 const uint8_t *buf, int buf_size);
4180 void (*parser_close)(AVCodecParserContext *s);
4181 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4182 struct AVCodecParser *next;
4185 AVCodecParser *av_parser_next(AVCodecParser *c);
4187 void av_register_codec_parser(AVCodecParser *parser);
4188 AVCodecParserContext *av_parser_init(int codec_id);
4193 * @param s parser context.
4194 * @param avctx codec context.
4195 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4196 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4197 * @param buf input buffer.
4198 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4199 * @param pts input presentation timestamp.
4200 * @param dts input decoding timestamp.
4201 * @param pos input byte position in stream.
4202 * @return the number of bytes of the input bitstream used.
4207 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4214 * decode_frame(data, size);
4218 int av_parser_parse2(AVCodecParserContext *s,
4219 AVCodecContext *avctx,
4220 uint8_t **poutbuf, int *poutbuf_size,
4221 const uint8_t *buf, int buf_size,
4222 int64_t pts, int64_t dts,
4226 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4227 * @deprecated use AVBitstreamFilter
4229 int av_parser_change(AVCodecParserContext *s,
4230 AVCodecContext *avctx,
4231 uint8_t **poutbuf, int *poutbuf_size,
4232 const uint8_t *buf, int buf_size, int keyframe);
4233 void av_parser_close(AVCodecParserContext *s);
4241 * @addtogroup lavc_encoding
4246 * Find a registered encoder with a matching codec ID.
4248 * @param id AVCodecID of the requested encoder
4249 * @return An encoder if one was found, NULL otherwise.
4251 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4254 * Find a registered encoder with the specified name.
4256 * @param name name of the requested encoder
4257 * @return An encoder if one was found, NULL otherwise.
4259 AVCodec *avcodec_find_encoder_by_name(const char *name);
4261 #if FF_API_OLD_ENCODE_AUDIO
4263 * Encode an audio frame from samples into buf.
4265 * @deprecated Use avcodec_encode_audio2 instead.
4267 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4268 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4269 * will know how much space is needed because it depends on the value passed
4270 * in buf_size as described below. In that case a lower value can be used.
4272 * @param avctx the codec context
4273 * @param[out] buf the output buffer
4274 * @param[in] buf_size the output buffer size
4275 * @param[in] samples the input buffer containing the samples
4276 * The number of samples read from this buffer is frame_size*channels,
4277 * both of which are defined in avctx.
4278 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4279 * samples read from samples is equal to:
4280 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4281 * This also implies that av_get_bits_per_sample() must not return 0 for these
4283 * @return On error a negative value is returned, on success zero or the number
4284 * of bytes used to encode the data read from the input buffer.
4286 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4287 uint8_t *buf, int buf_size,
4288 const short *samples);
4292 * Encode a frame of audio.
4294 * Takes input samples from frame and writes the next output packet, if
4295 * available, to avpkt. The output packet does not necessarily contain data for
4296 * the most recent frame, as encoders can delay, split, and combine input frames
4297 * internally as needed.
4299 * @param avctx codec context
4300 * @param avpkt output AVPacket.
4301 * The user can supply an output buffer by setting
4302 * avpkt->data and avpkt->size prior to calling the
4303 * function, but if the size of the user-provided data is not
4304 * large enough, encoding will fail. If avpkt->data and
4305 * avpkt->size are set, avpkt->destruct must also be set. All
4306 * other AVPacket fields will be reset by the encoder using
4307 * av_init_packet(). If avpkt->data is NULL, the encoder will
4308 * allocate it. The encoder will set avpkt->size to the size
4309 * of the output packet.
4311 * If this function fails or produces no output, avpkt will be
4312 * freed using av_free_packet() (i.e. avpkt->destruct will be
4313 * called to free the user supplied buffer).
4314 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4315 * May be NULL when flushing an encoder that has the
4316 * CODEC_CAP_DELAY capability set.
4317 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4318 * can have any number of samples.
4319 * If it is not set, frame->nb_samples must be equal to
4320 * avctx->frame_size for all frames except the last.
4321 * The final frame may be smaller than avctx->frame_size.
4322 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4323 * output packet is non-empty, and to 0 if it is
4324 * empty. If the function returns an error, the
4325 * packet can be assumed to be invalid, and the
4326 * value of got_packet_ptr is undefined and should
4328 * @return 0 on success, negative error code on failure
4330 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4331 const AVFrame *frame, int *got_packet_ptr);
4333 #if FF_API_OLD_ENCODE_VIDEO
4335 * @deprecated use avcodec_encode_video2() instead.
4337 * Encode a video frame from pict into buf.
4338 * The input picture should be
4339 * stored using a specific format, namely avctx.pix_fmt.
4341 * @param avctx the codec context
4342 * @param[out] buf the output buffer for the bitstream of encoded frame
4343 * @param[in] buf_size the size of the output buffer in bytes
4344 * @param[in] pict the input picture to encode
4345 * @return On error a negative value is returned, on success zero or the number
4346 * of bytes used from the output buffer.
4348 attribute_deprecated
4349 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4350 const AVFrame *pict);
4354 * Encode a frame of video.
4356 * Takes input raw video data from frame and writes the next output packet, if
4357 * available, to avpkt. The output packet does not necessarily contain data for
4358 * the most recent frame, as encoders can delay and reorder input frames
4359 * internally as needed.
4361 * @param avctx codec context
4362 * @param avpkt output AVPacket.
4363 * The user can supply an output buffer by setting
4364 * avpkt->data and avpkt->size prior to calling the
4365 * function, but if the size of the user-provided data is not
4366 * large enough, encoding will fail. All other AVPacket fields
4367 * will be reset by the encoder using av_init_packet(). If
4368 * avpkt->data is NULL, the encoder will allocate it.
4369 * The encoder will set avpkt->size to the size of the
4370 * output packet. The returned data (if any) belongs to the
4371 * caller, he is responsible for freeing it.
4373 * If this function fails or produces no output, avpkt will be
4374 * freed using av_free_packet() (i.e. avpkt->destruct will be
4375 * called to free the user supplied buffer).
4376 * @param[in] frame AVFrame containing the raw video data to be encoded.
4377 * May be NULL when flushing an encoder that has the
4378 * CODEC_CAP_DELAY capability set.
4379 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4380 * output packet is non-empty, and to 0 if it is
4381 * empty. If the function returns an error, the
4382 * packet can be assumed to be invalid, and the
4383 * value of got_packet_ptr is undefined and should
4385 * @return 0 on success, negative error code on failure
4387 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4388 const AVFrame *frame, int *got_packet_ptr);
4390 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4391 const AVSubtitle *sub);
4398 #if FF_API_AVCODEC_RESAMPLE
4400 * @defgroup lavc_resample Audio resampling
4402 * @deprecated use libswresample instead
4406 struct ReSampleContext;
4407 struct AVResampleContext;
4409 typedef struct ReSampleContext ReSampleContext;
4412 * Initialize audio resampling context.
4414 * @param output_channels number of output channels
4415 * @param input_channels number of input channels
4416 * @param output_rate output sample rate
4417 * @param input_rate input sample rate
4418 * @param sample_fmt_out requested output sample format
4419 * @param sample_fmt_in input sample format
4420 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4421 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4422 * @param linear if 1 then the used FIR filter will be linearly interpolated
4423 between the 2 closest, if 0 the closest will be used
4424 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4425 * @return allocated ReSampleContext, NULL if error occurred
4427 attribute_deprecated
4428 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4429 int output_rate, int input_rate,
4430 enum AVSampleFormat sample_fmt_out,
4431 enum AVSampleFormat sample_fmt_in,
4432 int filter_length, int log2_phase_count,
4433 int linear, double cutoff);
4435 attribute_deprecated
4436 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4439 * Free resample context.
4441 * @param s a non-NULL pointer to a resample context previously
4442 * created with av_audio_resample_init()
4444 attribute_deprecated
4445 void audio_resample_close(ReSampleContext *s);
4449 * Initialize an audio resampler.
4450 * Note, if either rate is not an integer then simply scale both rates up so they are.
4451 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4452 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4453 * @param linear If 1 then the used FIR filter will be linearly interpolated
4454 between the 2 closest, if 0 the closest will be used
4455 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4457 attribute_deprecated
4458 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4461 * Resample an array of samples using a previously configured context.
4462 * @param src an array of unconsumed samples
4463 * @param consumed the number of samples of src which have been consumed are returned here
4464 * @param src_size the number of unconsumed samples available
4465 * @param dst_size the amount of space in samples available in dst
4466 * @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.
4467 * @return the number of samples written in dst or -1 if an error occurred
4469 attribute_deprecated
4470 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4474 * Compensate samplerate/timestamp drift. The compensation is done by changing
4475 * the resampler parameters, so no audible clicks or similar distortions occur
4476 * @param compensation_distance distance in output samples over which the compensation should be performed
4477 * @param sample_delta number of output samples which should be output less
4479 * example: av_resample_compensate(c, 10, 500)
4480 * here instead of 510 samples only 500 samples would be output
4482 * note, due to rounding the actual compensation might be slightly different,
4483 * especially if the compensation_distance is large and the in_rate used during init is small
4485 attribute_deprecated
4486 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4487 attribute_deprecated
4488 void av_resample_close(struct AVResampleContext *c);
4496 * @addtogroup lavc_picture
4501 * Allocate memory for a picture. Call avpicture_free() to free it.
4503 * @see avpicture_fill()
4505 * @param picture the picture to be filled in
4506 * @param pix_fmt the format of the picture
4507 * @param width the width of the picture
4508 * @param height the height of the picture
4509 * @return zero if successful, a negative value if not
4511 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4514 * Free a picture previously allocated by avpicture_alloc().
4515 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4518 * @param picture the AVPicture to be freed
4520 void avpicture_free(AVPicture *picture);
4523 * Fill in the AVPicture fields, always assume a linesize alignment of
4526 * @see av_image_fill_arrays()
4528 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4529 enum AVPixelFormat pix_fmt, int width, int height);
4532 * Copy pixel data from an AVPicture into a buffer, always assume a
4533 * linesize alignment of 1.
4535 * @see av_image_copy_to_buffer()
4537 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4538 int width, int height,
4539 unsigned char *dest, int dest_size);
4542 * Calculate the size in bytes that a picture of the given width and height
4543 * would occupy if stored in the given picture format.
4544 * Always assume a linesize alignment of 1.
4546 * @see av_image_get_buffer_size().
4548 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4551 * deinterlace - if not supported return -1
4553 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4554 enum AVPixelFormat pix_fmt, int width, int height);
4556 * Copy image src to dst. Wraps av_image_copy().
4558 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4559 enum AVPixelFormat pix_fmt, int width, int height);
4562 * Crop image top and left side.
4564 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4565 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4570 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4571 int padtop, int padbottom, int padleft, int padright, int *color);
4578 * @defgroup lavc_misc Utility functions
4581 * Miscellaneous utility functions related to both encoding and decoding
4587 * @defgroup lavc_misc_pixfmt Pixel formats
4589 * Functions for working with pixel formats.
4594 * Utility function to access log2_chroma_w log2_chroma_h from
4595 * the pixel format AVPixFmtDescriptor.
4597 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4598 * for one that returns a failure code and continues in case of invalid
4601 * @param[in] pix_fmt the pixel format
4602 * @param[out] h_shift store log2_chroma_h
4603 * @param[out] v_shift store log2_chroma_w
4605 * @see av_pix_fmt_get_chroma_sub_sample
4608 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4611 * Return a value representing the fourCC code associated to the
4612 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4615 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4617 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4618 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4619 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4620 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4621 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4622 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4625 * Compute what kind of losses will occur when converting from one specific
4626 * pixel format to another.
4627 * When converting from one pixel format to another, information loss may occur.
4628 * For example, when converting from RGB24 to GRAY, the color information will
4629 * be lost. Similarly, other losses occur when converting from some formats to
4630 * other formats. These losses can involve loss of chroma, but also loss of
4631 * resolution, loss of color depth, loss due to the color space conversion, loss
4632 * of the alpha bits or loss due to color quantization.
4633 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4634 * which will occur when converting from one pixel format to another.
4636 * @param[in] dst_pix_fmt destination pixel format
4637 * @param[in] src_pix_fmt source pixel format
4638 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4639 * @return Combination of flags informing you what kind of losses will occur
4640 * (maximum loss for an invalid dst_pix_fmt).
4642 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4645 #if FF_API_FIND_BEST_PIX_FMT
4647 * @deprecated use avcodec_find_best_pix_fmt_of_2() instead.
4649 * Find the best pixel format to convert to given a certain source pixel
4650 * format. When converting from one pixel format to another, information loss
4651 * may occur. For example, when converting from RGB24 to GRAY, the color
4652 * information will be lost. Similarly, other losses occur when converting from
4653 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4654 * the given pixel formats should be used to suffer the least amount of loss.
4655 * The pixel formats from which it chooses one, are determined by the
4656 * pix_fmt_mask parameter.
4658 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
4661 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4662 * pix_fmt_mask = (1 << AV_PIX_FMT_YUV422P) | (1 << AV_PIX_FMT_RGB24);
4663 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4666 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4667 * @param[in] src_pix_fmt source pixel format
4668 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4669 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4670 * @return The best pixel format to convert to or -1 if none was found.
4672 attribute_deprecated
4673 enum AVPixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum AVPixelFormat src_pix_fmt,
4674 int has_alpha, int *loss_ptr);
4675 #endif /* FF_API_FIND_BEST_PIX_FMT */
4678 * Find the best pixel format to convert to given a certain source pixel
4679 * format. When converting from one pixel format to another, information loss
4680 * may occur. For example, when converting from RGB24 to GRAY, the color
4681 * information will be lost. Similarly, other losses occur when converting from
4682 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4683 * the given pixel formats should be used to suffer the least amount of loss.
4684 * The pixel formats from which it chooses one, are determined by the
4685 * pix_fmt_list parameter.
4688 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4689 * @param[in] src_pix_fmt source pixel format
4690 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4691 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4692 * @return The best pixel format to convert to or -1 if none was found.
4694 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(enum AVPixelFormat *pix_fmt_list,
4695 enum AVPixelFormat src_pix_fmt,
4696 int has_alpha, int *loss_ptr);
4699 * Find the best pixel format to convert to given a certain source pixel
4700 * format and a selection of two destination pixel formats. When converting from
4701 * one pixel format to another, information loss may occur. For example, when converting
4702 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4703 * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4704 * the given pixel formats should be used to suffer the least amount of loss.
4706 * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be
4710 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4711 * dst_pix_fmt1= AV_PIX_FMT_RGB24;
4712 * dst_pix_fmt2= AV_PIX_FMT_GRAY8;
4713 * dst_pix_fmt3= AV_PIX_FMT_RGB8;
4714 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4715 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4716 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4719 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4720 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4721 * @param[in] src_pix_fmt Source pixel format
4722 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4723 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4724 * NULL or value of zero means we care about all losses. Out: the loss
4725 * that occurs when converting from src to selected dst pixel format.
4726 * @return The best pixel format to convert to or -1 if none was found.
4728 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4729 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4731 attribute_deprecated
4732 #if AV_HAVE_INCOMPATIBLE_FORK_ABI
4733 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4734 enum AVPixelFormat src_pix_fmt,
4735 int has_alpha, int *loss_ptr);
4737 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4738 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4742 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4748 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4751 * Put a string representing the codec tag codec_tag in buf.
4753 * @param buf_size size in bytes of buf
4754 * @return the length of the string that would have been generated if
4755 * enough space had been available, excluding the trailing null
4757 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4759 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4762 * Return a name for the specified profile, if available.
4764 * @param codec the codec that is searched for the given profile
4765 * @param profile the profile value for which a name is requested
4766 * @return A name for the profile if found, NULL otherwise.
4768 const char *av_get_profile_name(const AVCodec *codec, int profile);
4770 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4771 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4772 //FIXME func typedef
4775 * Fill audio frame data and linesize.
4776 * AVFrame extended_data channel pointers are allocated if necessary for
4779 * @param frame the AVFrame
4780 * frame->nb_samples must be set prior to calling the
4781 * function. This function fills in frame->data,
4782 * frame->extended_data, frame->linesize[0].
4783 * @param nb_channels channel count
4784 * @param sample_fmt sample format
4785 * @param buf buffer to use for frame data
4786 * @param buf_size size of buffer
4787 * @param align plane size sample alignment (0 = default)
4788 * @return >=0 on success, negative error code on failure
4789 * @todo return the size of the allocated frame size in case of
4790 * success, at the next libavutil bump
4792 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4793 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4794 int buf_size, int align);
4797 * Flush buffers, should be called when seeking or when switching to a different stream.
4799 void avcodec_flush_buffers(AVCodecContext *avctx);
4801 void avcodec_default_free_buffers(AVCodecContext *s);
4804 * Return codec bits per sample.
4806 * @param[in] codec_id the codec
4807 * @return Number of bits per sample or zero if unknown for the given codec.
4809 int av_get_bits_per_sample(enum AVCodecID codec_id);
4812 * Return the PCM codec associated with a sample format.
4813 * @param be endianness, 0 for little, 1 for big,
4814 * -1 (or anything else) for native
4815 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4817 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4820 * Return codec bits per sample.
4821 * Only return non-zero if the bits per sample is exactly correct, not an
4824 * @param[in] codec_id the codec
4825 * @return Number of bits per sample or zero if unknown for the given codec.
4827 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4830 * Return audio frame duration.
4832 * @param avctx codec context
4833 * @param frame_bytes size of the frame, or 0 if unknown
4834 * @return frame duration, in samples, if known. 0 if not able to
4837 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4840 typedef struct AVBitStreamFilterContext {
4842 struct AVBitStreamFilter *filter;
4843 AVCodecParserContext *parser;
4844 struct AVBitStreamFilterContext *next;
4845 } AVBitStreamFilterContext;
4848 typedef struct AVBitStreamFilter {
4851 int (*filter)(AVBitStreamFilterContext *bsfc,
4852 AVCodecContext *avctx, const char *args,
4853 uint8_t **poutbuf, int *poutbuf_size,
4854 const uint8_t *buf, int buf_size, int keyframe);
4855 void (*close)(AVBitStreamFilterContext *bsfc);
4856 struct AVBitStreamFilter *next;
4857 } AVBitStreamFilter;
4859 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4860 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4861 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4862 AVCodecContext *avctx, const char *args,
4863 uint8_t **poutbuf, int *poutbuf_size,
4864 const uint8_t *buf, int buf_size, int keyframe);
4865 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4867 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4872 * Reallocate the given block if it is not large enough, otherwise do nothing.
4876 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4879 * Allocate a buffer, reusing the given one if large enough.
4881 * Contrary to av_fast_realloc the current buffer contents might not be
4882 * preserved and on error the old buffer is freed, thus no special
4883 * handling to avoid memleaks is necessary.
4885 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4886 * @param size size of the buffer *ptr points to
4887 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4888 * *size 0 if an error occurred.
4890 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4893 * Same behaviour av_fast_malloc but the buffer has additional
4894 * FF_INPUT_PADDING_SIZE at the end which will will always be 0.
4896 * In addition the whole buffer will initially and after resizes
4897 * be 0-initialized so that no uninitialized data will ever appear.
4899 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4902 * Same behaviour av_fast_padded_malloc except that buffer will always
4903 * be 0-initialized after call.
4905 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4908 * Encode extradata length to a buffer. Used by xiph codecs.
4910 * @param s buffer to write to; must be at least (v/255+1) bytes long
4911 * @param v size of extradata in bytes
4912 * @return number of bytes written to the buffer.
4914 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4917 * Log a generic warning message about a missing feature. This function is
4918 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4919 * only, and would normally not be used by applications.
4920 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4921 * a pointer to an AVClass struct
4922 * @param[in] feature string containing the name of the missing feature
4923 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4924 * If want_sample is non-zero, additional verbage will be added to the log
4925 * message which tells the user how to report samples to the development
4928 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4931 * Log a generic warning message asking for a sample. This function is
4932 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4933 * only, and would normally not be used by applications.
4934 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4935 * a pointer to an AVClass struct
4936 * @param[in] msg string containing an optional message, or NULL if no message
4938 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4941 * Register the hardware accelerator hwaccel.
4943 void av_register_hwaccel(AVHWAccel *hwaccel);
4946 * If hwaccel is NULL, returns the first registered hardware accelerator,
4947 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4948 * after hwaccel, or NULL if hwaccel is the last one.
4950 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4954 * Lock operation used by lockmgr
4957 AV_LOCK_CREATE, ///< Create a mutex
4958 AV_LOCK_OBTAIN, ///< Lock the mutex
4959 AV_LOCK_RELEASE, ///< Unlock the mutex
4960 AV_LOCK_DESTROY, ///< Free mutex resources
4964 * Register a user provided lock manager supporting the operations
4965 * specified by AVLockOp. mutex points to a (void *) where the
4966 * lockmgr should store/get a pointer to a user allocated mutex. It's
4967 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4969 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4970 * callback during the call to av_lockmgr_register().
4971 * Thus, the application must be prepared to handle that.
4972 * If cb is set to NULL the lockmgr will be unregistered.
4973 * Also note that during unregistration the previously registered
4974 * lockmgr callback may also be invoked.
4976 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4979 * Get the type of the given codec.
4981 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4984 * Get the name of a codec.
4985 * @return a static string identifying the codec; never NULL
4987 const char *avcodec_get_name(enum AVCodecID id);
4990 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4991 * with no corresponding avcodec_close()), 0 otherwise.
4993 int avcodec_is_open(AVCodecContext *s);
4996 * @return a non-zero number if codec is an encoder, zero otherwise
4998 int av_codec_is_encoder(const AVCodec *codec);
5001 * @return a non-zero number if codec is a decoder, zero otherwise
5003 int av_codec_is_decoder(const AVCodec *codec);
5006 * @return descriptor for given codec ID or NULL if no descriptor exists.
5008 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5011 * Iterate over all codec descriptors known to libavcodec.
5013 * @param prev previous descriptor. NULL to get the first descriptor.
5015 * @return next descriptor or NULL after the last descriptor
5017 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5020 * @return codec descriptor with the given name or NULL if no such descriptor
5023 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5029 #endif /* AVCODEC_AVCODEC_H */