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/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
37 #include "libavutil/audioconvert.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_Y41P = MKBETAG('Y','4','1','P'),
271 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
272 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
273 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
275 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
276 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
277 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
278 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
279 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
280 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
281 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
282 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
283 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
284 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
285 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
287 /* various PCM "codecs" */
288 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
289 AV_CODEC_ID_PCM_S16LE = 0x10000,
290 AV_CODEC_ID_PCM_S16BE,
291 AV_CODEC_ID_PCM_U16LE,
292 AV_CODEC_ID_PCM_U16BE,
295 AV_CODEC_ID_PCM_MULAW,
296 AV_CODEC_ID_PCM_ALAW,
297 AV_CODEC_ID_PCM_S32LE,
298 AV_CODEC_ID_PCM_S32BE,
299 AV_CODEC_ID_PCM_U32LE,
300 AV_CODEC_ID_PCM_U32BE,
301 AV_CODEC_ID_PCM_S24LE,
302 AV_CODEC_ID_PCM_S24BE,
303 AV_CODEC_ID_PCM_U24LE,
304 AV_CODEC_ID_PCM_U24BE,
305 AV_CODEC_ID_PCM_S24DAUD,
306 AV_CODEC_ID_PCM_ZORK,
307 AV_CODEC_ID_PCM_S16LE_PLANAR,
309 AV_CODEC_ID_PCM_F32BE,
310 AV_CODEC_ID_PCM_F32LE,
311 AV_CODEC_ID_PCM_F64BE,
312 AV_CODEC_ID_PCM_F64LE,
313 AV_CODEC_ID_PCM_BLURAY,
316 AV_CODEC_ID_PCM_S8_PLANAR,
318 /* various ADPCM codecs */
319 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
320 AV_CODEC_ID_ADPCM_IMA_WAV,
321 AV_CODEC_ID_ADPCM_IMA_DK3,
322 AV_CODEC_ID_ADPCM_IMA_DK4,
323 AV_CODEC_ID_ADPCM_IMA_WS,
324 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
325 AV_CODEC_ID_ADPCM_MS,
326 AV_CODEC_ID_ADPCM_4XM,
327 AV_CODEC_ID_ADPCM_XA,
328 AV_CODEC_ID_ADPCM_ADX,
329 AV_CODEC_ID_ADPCM_EA,
330 AV_CODEC_ID_ADPCM_G726,
331 AV_CODEC_ID_ADPCM_CT,
332 AV_CODEC_ID_ADPCM_SWF,
333 AV_CODEC_ID_ADPCM_YAMAHA,
334 AV_CODEC_ID_ADPCM_SBPRO_4,
335 AV_CODEC_ID_ADPCM_SBPRO_3,
336 AV_CODEC_ID_ADPCM_SBPRO_2,
337 AV_CODEC_ID_ADPCM_THP,
338 AV_CODEC_ID_ADPCM_IMA_AMV,
339 AV_CODEC_ID_ADPCM_EA_R1,
340 AV_CODEC_ID_ADPCM_EA_R3,
341 AV_CODEC_ID_ADPCM_EA_R2,
342 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
343 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
344 AV_CODEC_ID_ADPCM_EA_XAS,
345 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
346 AV_CODEC_ID_ADPCM_IMA_ISS,
347 AV_CODEC_ID_ADPCM_G722,
348 AV_CODEC_ID_ADPCM_IMA_APC,
349 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
352 AV_CODEC_ID_AMR_NB = 0x12000,
355 /* RealAudio codecs*/
356 AV_CODEC_ID_RA_144 = 0x13000,
359 /* various DPCM codecs */
360 AV_CODEC_ID_ROQ_DPCM = 0x14000,
361 AV_CODEC_ID_INTERPLAY_DPCM,
362 AV_CODEC_ID_XAN_DPCM,
363 AV_CODEC_ID_SOL_DPCM,
366 AV_CODEC_ID_MP2 = 0x15000,
367 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
377 AV_CODEC_ID_VMDAUDIO,
383 AV_CODEC_ID_WESTWOOD_SND1,
384 AV_CODEC_ID_GSM, ///< as in Berlin toast format
387 AV_CODEC_ID_TRUESPEECH,
389 AV_CODEC_ID_SMACKAUDIO,
392 AV_CODEC_ID_DSICINAUDIO,
394 AV_CODEC_ID_MUSEPACK7,
396 AV_CODEC_ID_GSM_MS, /* as found in WAV */
400 AV_CODEC_ID_NELLYMOSER,
401 AV_CODEC_ID_MUSEPACK8,
403 AV_CODEC_ID_WMAVOICE,
405 AV_CODEC_ID_WMALOSSLESS,
414 AV_CODEC_ID_BINKAUDIO_RDFT,
415 AV_CODEC_ID_BINKAUDIO_DCT,
416 AV_CODEC_ID_AAC_LATM,
421 AV_CODEC_ID_8SVX_EXP,
422 AV_CODEC_ID_8SVX_FIB,
423 AV_CODEC_ID_BMV_AUDIO,
427 AV_CODEC_ID_OPUS_DEPRECATED,
428 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
429 AV_CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
430 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
431 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
432 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
433 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
435 /* subtitle codecs */
436 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
437 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
438 AV_CODEC_ID_DVB_SUBTITLE,
439 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
442 AV_CODEC_ID_MOV_TEXT,
443 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
444 AV_CODEC_ID_DVB_TELETEXT,
446 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
447 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
448 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
449 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
450 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
451 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
452 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
453 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
455 /* other specific kind of codecs (generally used for attachments) */
456 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
457 AV_CODEC_ID_TTF = 0x18000,
458 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
459 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
460 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
461 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
463 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
465 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
466 * stream (only used by libavformat) */
467 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
468 * stream (only used by libavformat) */
469 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
472 #include "old_codec_ids.h"
477 #define CodecID AVCodecID
481 * This struct describes the properties of a single codec described by an
483 * @see avcodec_get_descriptor()
485 typedef struct AVCodecDescriptor {
487 enum AVMediaType type;
489 * Name of the codec described by this descriptor. It is non-empty and
490 * unique for each codec descriptor. It should contain alphanumeric
491 * characters and '_' only.
495 * A more descriptive name for this codec. May be NULL.
497 const char *long_name;
499 * Codec properties, a combination of AV_CODEC_PROP_* flags.
505 * Codec uses only intra compression.
508 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
510 * Codec supports lossy compression. Audio and video codecs only.
511 * @note a codec may support both lossy and lossless
514 #define AV_CODEC_PROP_LOSSY (1 << 1)
516 * Codec supports lossless compression. Audio and video codecs only.
518 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
520 #if FF_API_OLD_DECODE_AUDIO
522 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
526 * @ingroup lavc_decoding
527 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
528 * This is mainly needed because some optimized bitstream readers read
529 * 32 or 64 bit at once and could read over the end.<br>
530 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
531 * MPEG bitstreams could cause overread and segfault.
533 #define FF_INPUT_BUFFER_PADDING_SIZE 16
536 * @ingroup lavc_encoding
537 * minimum encoding buffer size
538 * Used to avoid some checks during header writing.
540 #define FF_MIN_BUFFER_SIZE 16384
544 * @ingroup lavc_encoding
545 * motion estimation type.
548 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
552 ME_EPZS, ///< enhanced predictive zonal search
553 ME_X1, ///< reserved for experiments
554 ME_HEX, ///< hexagon based search
555 ME_UMH, ///< uneven multi-hexagon search
556 ME_ITER, ///< iterative search
557 ME_TESA, ///< transformed exhaustive search algorithm
561 * @ingroup lavc_decoding
564 /* We leave some space between them for extensions (drop some
565 * keyframes for intra-only or drop just some bidir frames). */
566 AVDISCARD_NONE =-16, ///< discard nothing
567 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
568 AVDISCARD_NONREF = 8, ///< discard all non reference
569 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
570 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
571 AVDISCARD_ALL = 48, ///< discard all
574 enum AVColorPrimaries{
575 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
576 AVCOL_PRI_UNSPECIFIED = 2,
577 AVCOL_PRI_BT470M = 4,
578 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
579 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
580 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
582 AVCOL_PRI_NB , ///< Not part of ABI
585 enum AVColorTransferCharacteristic{
586 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
587 AVCOL_TRC_UNSPECIFIED = 2,
588 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
589 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
590 AVCOL_TRC_SMPTE240M = 7,
591 AVCOL_TRC_NB , ///< Not part of ABI
596 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
597 AVCOL_SPC_UNSPECIFIED = 2,
599 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
600 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
601 AVCOL_SPC_SMPTE240M = 7,
602 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
603 AVCOL_SPC_NB , ///< Not part of ABI
605 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
608 AVCOL_RANGE_UNSPECIFIED = 0,
609 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
610 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
611 AVCOL_RANGE_NB , ///< Not part of ABI
615 * X X 3 4 X X are luma samples,
616 * 1 2 1-6 are possible chroma positions
617 * X X 5 6 X 0 is undefined/unknown position
619 enum AVChromaLocation{
620 AVCHROMA_LOC_UNSPECIFIED = 0,
621 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
622 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
623 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
624 AVCHROMA_LOC_TOP = 4,
625 AVCHROMA_LOC_BOTTOMLEFT = 5,
626 AVCHROMA_LOC_BOTTOM = 6,
627 AVCHROMA_LOC_NB , ///< Not part of ABI
630 enum AVAudioServiceType {
631 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
632 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
633 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
634 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
635 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
636 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
637 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
638 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
639 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
640 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
644 * @ingroup lavc_encoding
646 typedef struct RcOverride{
649 int qscale; // If this is 0 then quality_factor will be used instead.
650 float quality_factor;
653 #define FF_MAX_B_FRAMES 16
656 These flags can be passed in AVCodecContext.flags before initialization.
657 Note: Not everything is supported yet.
660 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
661 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
662 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
663 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
664 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
666 * The parent program guarantees that the input for B-frames containing
667 * streams is not written to for at least s->max_b_frames+1 frames, if
668 * this is not set the input will be copied.
670 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
671 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
672 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
673 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
674 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
675 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
676 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
677 location instead of only at frame boundaries. */
678 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
679 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
680 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
681 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
682 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
683 /* Fx : Flag for h263+ extra options */
684 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
685 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
686 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
687 #define CODEC_FLAG_CLOSED_GOP 0x80000000
688 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
689 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
690 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
691 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
692 #if FF_API_MPV_GLOBAL_OPTS
693 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
694 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
695 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
696 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
698 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
699 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
701 /* Unsupported options :
702 * Syntax Arithmetic coding (SAC)
703 * Reference Picture Selection
704 * Independent Segment Decoding */
706 /* codec capabilities */
708 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
710 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
711 * If not set, it might not use get_buffer() at all or use operations that
712 * assume the buffer was allocated by avcodec_default_get_buffer.
714 #define CODEC_CAP_DR1 0x0002
715 #define CODEC_CAP_TRUNCATED 0x0008
716 /* Codec can export data for HW decoding (XvMC). */
717 #define CODEC_CAP_HWACCEL 0x0010
719 * Encoder or decoder requires flushing with NULL input at the end in order to
720 * give the complete and correct output.
722 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
723 * with NULL data. The user can still send NULL data to the public encode
724 * or decode function, but libavcodec will not pass it along to the codec
725 * unless this flag is set.
728 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
729 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
733 * The encoder needs to be fed with NULL data at the end of encoding until the
734 * encoder no longer returns data.
736 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
737 * flag also means that the encoder must set the pts and duration for
738 * each output packet. If this flag is not set, the pts and duration will
739 * be determined by libavcodec from the input frame.
741 #define CODEC_CAP_DELAY 0x0020
743 * Codec can be fed a final frame with a smaller size.
744 * This can be used to prevent truncation of the last audio samples.
746 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
748 * Codec can export data for HW decoding (VDPAU).
750 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
752 * Codec can output multiple frames per AVPacket
753 * Normally demuxers return one frame at a time, demuxers which do not do
754 * are connected to a parser to split what they return into proper frames.
755 * This flag is reserved to the very rare category of codecs which have a
756 * bitstream that cannot be split into frames without timeconsuming
757 * operations like full decoding. Demuxers carring such bitstreams thus
758 * may return multiple frames in a packet. This has many disadvantages like
759 * prohibiting stream copy in many cases thus it should only be considered
762 #define CODEC_CAP_SUBFRAMES 0x0100
764 * Codec is experimental and is thus avoided in favor of non experimental
767 #define CODEC_CAP_EXPERIMENTAL 0x0200
769 * Codec should fill in channel configuration and samplerate instead of container
771 #define CODEC_CAP_CHANNEL_CONF 0x0400
774 * Codec is able to deal with negative linesizes
776 #define CODEC_CAP_NEG_LINESIZES 0x0800
779 * Codec supports frame-level multithreading.
781 #define CODEC_CAP_FRAME_THREADS 0x1000
783 * Codec supports slice-based (or partition-based) multithreading.
785 #define CODEC_CAP_SLICE_THREADS 0x2000
787 * Codec supports changed parameters at any point.
789 #define CODEC_CAP_PARAM_CHANGE 0x4000
791 * Codec supports avctx->thread_count == 0 (auto).
793 #define CODEC_CAP_AUTO_THREADS 0x8000
795 * Audio encoder supports receiving a different number of samples in each call.
797 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
799 * Codec is intra only.
801 #define CODEC_CAP_INTRA_ONLY 0x40000000
805 #define CODEC_CAP_LOSSLESS 0x80000000
807 //The following defines may change, don't expect compatibility if you use them.
808 #define MB_TYPE_INTRA4x4 0x0001
809 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
810 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
811 #define MB_TYPE_16x16 0x0008
812 #define MB_TYPE_16x8 0x0010
813 #define MB_TYPE_8x16 0x0020
814 #define MB_TYPE_8x8 0x0040
815 #define MB_TYPE_INTERLACED 0x0080
816 #define MB_TYPE_DIRECT2 0x0100 //FIXME
817 #define MB_TYPE_ACPRED 0x0200
818 #define MB_TYPE_GMC 0x0400
819 #define MB_TYPE_SKIP 0x0800
820 #define MB_TYPE_P0L0 0x1000
821 #define MB_TYPE_P1L0 0x2000
822 #define MB_TYPE_P0L1 0x4000
823 #define MB_TYPE_P1L1 0x8000
824 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
825 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
826 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
827 #define MB_TYPE_QUANT 0x00010000
828 #define MB_TYPE_CBP 0x00020000
829 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
833 * This specifies the area which should be displayed.
834 * Note there may be multiple such areas for one frame.
836 typedef struct AVPanScan{
839 * - encoding: Set by user.
840 * - decoding: Set by libavcodec.
845 * width and height in 1/16 pel
846 * - encoding: Set by user.
847 * - decoding: Set by libavcodec.
853 * position of the top left corner in 1/16 pel for up to 3 fields/frames
854 * - encoding: Set by user.
855 * - decoding: Set by libavcodec.
857 int16_t position[3][2];
860 #define FF_QSCALE_TYPE_MPEG1 0
861 #define FF_QSCALE_TYPE_MPEG2 1
862 #define FF_QSCALE_TYPE_H264 2
863 #define FF_QSCALE_TYPE_VP56 3
865 #define FF_BUFFER_TYPE_INTERNAL 1
866 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
867 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
868 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
870 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
871 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
872 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
873 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
876 * @defgroup lavc_packet AVPacket
878 * Types and functions for working with AVPacket.
881 enum AVPacketSideDataType {
883 AV_PKT_DATA_NEW_EXTRADATA,
886 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
889 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
890 * s32le channel_count
891 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
892 * u64le channel_layout
893 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
895 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
900 AV_PKT_DATA_PARAM_CHANGE,
903 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
904 * structures with info about macroblocks relevant to splitting the
905 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
906 * That is, it does not necessarily contain info about all macroblocks,
907 * as long as the distance between macroblocks in the info is smaller
908 * than the target payload size.
909 * Each MB info structure is 12 bytes, and is laid out as follows:
911 * u32le bit offset from the start of the packet
912 * u8 current quantizer at the start of the macroblock
914 * u16le macroblock address within the GOB
915 * u8 horizontal MV predictor
916 * u8 vertical MV predictor
917 * u8 horizontal MV predictor for block number 3
918 * u8 vertical MV predictor for block number 3
921 AV_PKT_DATA_H263_MB_INFO,
924 * Recommmends skipping the specified number of samples
926 * u32le number of samples to skip from start of this packet
927 * u32le number of samples to skip from end of this packet
928 * u8 reason for start skip
929 * u8 reason for end skip (0=padding silence, 1=convergence)
932 AV_PKT_DATA_SKIP_SAMPLES=70,
935 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
936 * the packet may contain "dual mono" audio specific to Japanese DTV
937 * and if it is true, recommends only the selected channel to be used.
939 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
942 AV_PKT_DATA_JP_DUALMONO,
945 typedef struct AVPacket {
947 * Presentation timestamp in AVStream->time_base units; the time at which
948 * the decompressed packet will be presented to the user.
949 * Can be AV_NOPTS_VALUE if it is not stored in the file.
950 * pts MUST be larger or equal to dts as presentation cannot happen before
951 * decompression, unless one wants to view hex dumps. Some formats misuse
952 * the terms dts and pts/cts to mean something different. Such timestamps
953 * must be converted to true pts/dts before they are stored in AVPacket.
957 * Decompression timestamp in AVStream->time_base units; the time at which
958 * the packet is decompressed.
959 * Can be AV_NOPTS_VALUE if it is not stored in the file.
966 * A combination of AV_PKT_FLAG values
970 * Additional packet data that can be provided by the container.
971 * Packet can contain several types of side information.
976 enum AVPacketSideDataType type;
981 * Duration of this packet in AVStream->time_base units, 0 if unknown.
982 * Equals next_pts - this_pts in presentation order.
985 void (*destruct)(struct AVPacket *);
987 int64_t pos; ///< byte position in stream, -1 if unknown
990 * Time difference in AVStream->time_base units from the pts of this
991 * packet to the point at which the output from the decoder has converged
992 * independent from the availability of previous frames. That is, the
993 * frames are virtually identical no matter if decoding started from
994 * the very first frame or from this keyframe.
995 * Is AV_NOPTS_VALUE if unknown.
996 * This field is not the display duration of the current packet.
997 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1000 * The purpose of this field is to allow seeking in streams that have no
1001 * keyframes in the conventional sense. It corresponds to the
1002 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1003 * essential for some types of subtitle streams to ensure that all
1004 * subtitles are correctly displayed after seeking.
1006 int64_t convergence_duration;
1008 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1009 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1011 enum AVSideDataParamChangeFlags {
1012 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1013 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1014 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1015 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1022 * Audio Video Frame.
1023 * New fields can be added to the end of AVFRAME with minor version
1024 * bumps. Similarly fields that are marked as to be only accessed by
1025 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
1026 * without breaking compatibility with each other.
1027 * Removal, reordering and changes in the remaining cases require
1028 * a major version bump.
1029 * sizeof(AVFrame) must not be used outside libavcodec.
1031 typedef struct AVFrame {
1032 #define AV_NUM_DATA_POINTERS 8
1034 * pointer to the picture/channel planes.
1035 * This might be different from the first allocated byte
1036 * - encoding: Set by user
1037 * - decoding: set by AVCodecContext.get_buffer()
1039 uint8_t *data[AV_NUM_DATA_POINTERS];
1042 * Size, in bytes, of the data for each picture/channel plane.
1044 * For audio, only linesize[0] may be set. For planar audio, each channel
1045 * plane must be the same size.
1047 * - encoding: Set by user
1048 * - decoding: set by AVCodecContext.get_buffer()
1050 int linesize[AV_NUM_DATA_POINTERS];
1053 * pointers to the data planes/channels.
1055 * For video, this should simply point to data[].
1057 * For planar audio, each channel has a separate data pointer, and
1058 * linesize[0] contains the size of each channel buffer.
1059 * For packed audio, there is just one data pointer, and linesize[0]
1060 * contains the total size of the buffer for all channels.
1062 * Note: Both data and extended_data will always be set by get_buffer(),
1063 * but for planar audio with more channels that can fit in data,
1064 * extended_data must be used by the decoder in order to access all
1068 * decoding: set by AVCodecContext.get_buffer()
1070 uint8_t **extended_data;
1073 * width and height of the video frame
1074 * - encoding: unused
1075 * - decoding: Read by user.
1080 * number of audio samples (per channel) described by this frame
1081 * - encoding: Set by user
1082 * - decoding: Set by libavcodec
1087 * format of the frame, -1 if unknown or unset
1088 * Values correspond to enum PixelFormat for video frames,
1089 * enum AVSampleFormat for audio)
1090 * - encoding: unused
1091 * - decoding: Read by user.
1096 * 1 -> keyframe, 0-> not
1097 * - encoding: Set by libavcodec.
1098 * - decoding: Set by libavcodec.
1103 * Picture type of the frame, see ?_TYPE below.
1104 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1105 * - decoding: Set by libavcodec.
1107 enum AVPictureType pict_type;
1110 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1111 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1115 uint8_t *base[AV_NUM_DATA_POINTERS];
1118 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1119 * - encoding: unused
1120 * - decoding: Read by user.
1122 AVRational sample_aspect_ratio;
1125 * presentation timestamp in time_base units (time when frame should be shown to user)
1126 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1127 * - encoding: MUST be set by user.
1128 * - decoding: Set by libavcodec.
1133 * reordered pts from the last AVPacket that has been input into the decoder
1134 * - encoding: unused
1135 * - decoding: Read by user.
1140 * dts from the last AVPacket that has been input into the decoder
1141 * - encoding: unused
1142 * - decoding: Read by user.
1147 * picture number in bitstream order
1148 * - encoding: set by
1149 * - decoding: Set by libavcodec.
1151 int coded_picture_number;
1153 * picture number in display order
1154 * - encoding: set by
1155 * - decoding: Set by libavcodec.
1157 int display_picture_number;
1160 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1161 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1162 * - decoding: Set by libavcodec.
1167 * is this picture used as reference
1168 * The values for this are the same as the MpegEncContext.picture_structure
1169 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1170 * Set to 4 for delayed, non-reference frames.
1171 * - encoding: unused
1172 * - decoding: Set by libavcodec. (before get_buffer() call)).
1178 * - encoding: unused
1179 * - decoding: Set by libavcodec.
1181 int8_t *qscale_table;
1184 * - encoding: unused
1185 * - decoding: Set by libavcodec.
1195 * mbskip_table[mb]>=1 if MB didn't change
1196 * stride= mb_width = (width+15)>>4
1197 * - encoding: unused
1198 * - decoding: Set by libavcodec.
1200 uint8_t *mbskip_table;
1203 * motion vector table
1206 * int mv_sample_log2= 4 - motion_subsample_log2;
1207 * int mb_width= (width+15)>>4;
1208 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1209 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1211 * - encoding: Set by user.
1212 * - decoding: Set by libavcodec.
1214 int16_t (*motion_val[2])[2];
1217 * macroblock type table
1218 * mb_type_base + mb_width + 2
1219 * - encoding: Set by user.
1220 * - decoding: Set by libavcodec.
1226 * - encoding: unused
1227 * - decoding: Set by libavcodec.
1232 * motion reference frame index
1233 * the order in which these are stored can depend on the codec.
1234 * - encoding: Set by user.
1235 * - decoding: Set by libavcodec.
1237 int8_t *ref_index[2];
1240 * for some private data of the user
1241 * - encoding: unused
1242 * - decoding: Set by user.
1248 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1249 * - decoding: unused
1251 uint64_t error[AV_NUM_DATA_POINTERS];
1254 * type of the buffer (to keep track of who has to deallocate data[*])
1255 * - encoding: Set by the one who allocates it.
1256 * - decoding: Set by the one who allocates it.
1257 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1262 * When decoding, this signals how much the picture must be delayed.
1263 * extra_delay = repeat_pict / (2*fps)
1264 * - encoding: unused
1265 * - decoding: Set by libavcodec.
1270 * The content of the picture is interlaced.
1271 * - encoding: Set by user.
1272 * - decoding: Set by libavcodec. (default 0)
1274 int interlaced_frame;
1277 * If the content is interlaced, is top field displayed first.
1278 * - encoding: Set by user.
1279 * - decoding: Set by libavcodec.
1281 int top_field_first;
1284 * Tell user application that palette has changed from previous frame.
1285 * - encoding: ??? (no palette-enabled encoder yet)
1286 * - decoding: Set by libavcodec. (default 0).
1288 int palette_has_changed;
1291 * codec suggestion on buffer type if != 0
1292 * - encoding: unused
1293 * - decoding: Set by libavcodec. (before get_buffer() call)).
1299 * - encoding: Set by user.
1300 * - decoding: Set by libavcodec.
1302 AVPanScan *pan_scan;
1305 * reordered opaque 64bit (generally an integer or a double precision float
1306 * PTS but can be anything).
1307 * The user sets AVCodecContext.reordered_opaque to represent the input at
1309 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1310 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1311 * @deprecated in favor of pkt_pts
1312 * - encoding: unused
1313 * - decoding: Read by user.
1315 int64_t reordered_opaque;
1318 * hardware accelerator private data (FFmpeg-allocated)
1319 * - encoding: unused
1320 * - decoding: Set by libavcodec
1322 void *hwaccel_picture_private;
1325 * the AVCodecContext which ff_thread_get_buffer() was last called on
1326 * - encoding: Set by libavcodec.
1327 * - decoding: Set by libavcodec.
1329 struct AVCodecContext *owner;
1332 * used by multithreading to store frame-specific info
1333 * - encoding: Set by libavcodec.
1334 * - decoding: Set by libavcodec.
1336 void *thread_opaque;
1339 * log2 of the size of the block which a single vector in motion_val represents:
1340 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1341 * - encoding: unused
1342 * - decoding: Set by libavcodec.
1344 uint8_t motion_subsample_log2;
1347 * Sample rate of the audio data.
1349 * - encoding: unused
1350 * - decoding: read by user
1355 * Channel layout of the audio data.
1357 * - encoding: unused
1358 * - decoding: read by user.
1360 uint64_t channel_layout;
1363 * frame timestamp estimated using various heuristics, in stream time base
1364 * Code outside libavcodec should access this field using:
1365 * av_frame_get_best_effort_timestamp(frame)
1366 * - encoding: unused
1367 * - decoding: set by libavcodec, read by user.
1369 int64_t best_effort_timestamp;
1372 * reordered pos from the last AVPacket that has been input into the decoder
1373 * Code outside libavcodec should access this field using:
1374 * av_frame_get_pkt_pos(frame)
1375 * - encoding: unused
1376 * - decoding: Read by user.
1381 * duration of the corresponding packet, expressed in
1382 * AVStream->time_base units, 0 if unknown.
1383 * Code outside libavcodec should access this field using:
1384 * av_frame_get_pkt_duration(frame)
1385 * - encoding: unused
1386 * - decoding: Read by user.
1388 int64_t pkt_duration;
1392 * Code outside libavcodec should access this field using:
1393 * av_frame_get_metadata(frame)
1394 * - encoding: Set by user.
1395 * - decoding: Set by libavcodec.
1397 AVDictionary *metadata;
1400 * decode error flags of the frame, set to a combination of
1401 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
1402 * were errors during the decoding.
1403 * Code outside libavcodec should access this field using:
1404 * av_frame_get_decode_error_flags(frame)
1405 * - encoding: unused
1406 * - decoding: set by libavcodec, read by user.
1408 int decode_error_flags;
1409 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
1410 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
1413 * number of audio channels, only used for audio.
1414 * Code outside libavcodec should access this field using:
1415 * av_frame_get_channels(frame)
1416 * - encoding: unused
1417 * - decoding: Read by user.
1423 * Accessors for some AVFrame fields.
1424 * The position of these field in the structure is not part of the ABI,
1425 * they should not be accessed directly outside libavcodec.
1427 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
1428 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
1429 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
1430 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
1431 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
1432 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
1433 int64_t av_frame_get_channel_layout (const AVFrame *frame);
1434 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
1435 int av_frame_get_channels (const AVFrame *frame);
1436 void av_frame_set_channels (AVFrame *frame, int val);
1437 int av_frame_get_sample_rate (const AVFrame *frame);
1438 void av_frame_set_sample_rate (AVFrame *frame, int val);
1439 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
1440 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
1441 int av_frame_get_decode_error_flags (const AVFrame *frame);
1442 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
1444 struct AVCodecInternal;
1448 AV_FIELD_PROGRESSIVE,
1449 AV_FIELD_TT, //< Top coded_first, top displayed first
1450 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1451 AV_FIELD_TB, //< Top coded first, bottom displayed first
1452 AV_FIELD_BT, //< Bottom coded first, top displayed first
1456 * main external API structure.
1457 * New fields can be added to the end with minor version bumps.
1458 * Removal, reordering and changes to existing fields require a major
1460 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1462 * sizeof(AVCodecContext) must not be used outside libav*.
1464 typedef struct AVCodecContext {
1466 * information on struct for av_log
1467 * - set by avcodec_alloc_context3
1469 const AVClass *av_class;
1470 int log_level_offset;
1472 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1473 const struct AVCodec *codec;
1474 char codec_name[32];
1475 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1478 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1479 * This is used to work around some encoder bugs.
1480 * A demuxer should set this to what is stored in the field used to identify the codec.
1481 * If there are multiple such fields in a container then the demuxer should choose the one
1482 * which maximizes the information about the used codec.
1483 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1484 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1485 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1487 * - encoding: Set by user, if not then the default based on codec_id will be used.
1488 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1490 unsigned int codec_tag;
1493 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1494 * This is used to work around some encoder bugs.
1495 * - encoding: unused
1496 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1498 unsigned int stream_codec_tag;
1502 * @deprecated this field is unused
1504 attribute_deprecated int sub_id;
1510 * Private context used for internal data.
1512 * Unlike priv_data, this is not codec-specific. It is used in general
1513 * libavcodec functions.
1515 struct AVCodecInternal *internal;
1518 * Private data of the user, can be used to carry app specific stuff.
1519 * - encoding: Set by user.
1520 * - decoding: Set by user.
1525 * the average bitrate
1526 * - encoding: Set by user; unused for constant quantizer encoding.
1527 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1532 * number of bits the bitstream is allowed to diverge from the reference.
1533 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1534 * - encoding: Set by user; unused for constant quantizer encoding.
1535 * - decoding: unused
1537 int bit_rate_tolerance;
1540 * Global quality for codecs which cannot change it per frame.
1541 * This should be proportional to MPEG-1/2/4 qscale.
1542 * - encoding: Set by user.
1543 * - decoding: unused
1548 * - encoding: Set by user.
1549 * - decoding: unused
1551 int compression_level;
1552 #define FF_COMPRESSION_DEFAULT -1
1556 * - encoding: Set by user.
1557 * - decoding: Set by user.
1563 * - encoding: Set by user.
1564 * - decoding: Set by user.
1569 * some codecs need / can use extradata like Huffman tables.
1570 * mjpeg: Huffman tables
1571 * rv10: additional flags
1572 * mpeg4: global headers (they can be in the bitstream or here)
1573 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1574 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1575 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1576 * - encoding: Set/allocated/freed by libavcodec.
1577 * - decoding: Set/allocated/freed by user.
1583 * This is the fundamental unit of time (in seconds) in terms
1584 * of which frame timestamps are represented. For fixed-fps content,
1585 * timebase should be 1/framerate and timestamp increments should be
1587 * - encoding: MUST be set by user.
1588 * - decoding: Set by libavcodec.
1590 AVRational time_base;
1593 * For some codecs, the time base is closer to the field rate than the frame rate.
1594 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1595 * if no telecine is used ...
1597 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1599 int ticks_per_frame;
1602 * Encoding: Number of frames delay there will be from the encoder input to
1603 * the decoder output. (we assume the decoder matches the spec)
1604 * Decoding: Number of frames delay in addition to what a standard decoder
1605 * as specified in the spec would produce.
1608 * Number of frames the decoded output will be delayed relative to the
1612 * For encoding, this is the number of "priming" samples added to the
1613 * beginning of the stream. The decoded output will be delayed by this
1614 * many samples relative to the input to the encoder. Note that this
1615 * field is purely informational and does not directly affect the pts
1616 * output by the encoder, which should always be based on the actual
1617 * presentation time, including any delay.
1618 * For decoding, this is the number of samples the decoder needs to
1619 * output before the decoder's output is valid. When seeking, you should
1620 * start decoding this many samples prior to your desired seek point.
1622 * - encoding: Set by libavcodec.
1623 * - decoding: Set by libavcodec.
1630 * picture width / height.
1631 * - encoding: MUST be set by user.
1632 * - decoding: Set by libavcodec.
1633 * Note: For compatibility it is possible to set this instead of
1634 * coded_width/height before decoding.
1639 * Bitstream width / height, may be different from width/height if lowres enabled.
1640 * - encoding: unused
1641 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1643 int coded_width, coded_height;
1645 #define FF_ASPECT_EXTENDED 15
1648 * the number of pictures in a group of pictures, or 0 for intra_only
1649 * - encoding: Set by user.
1650 * - decoding: unused
1655 * Pixel format, see PIX_FMT_xxx.
1656 * May be set by the demuxer if known from headers.
1657 * May be overridden by the decoder if it knows better.
1658 * - encoding: Set by user.
1659 * - decoding: Set by user if known, overridden by libavcodec if known
1661 enum PixelFormat pix_fmt;
1664 * Motion estimation algorithm used for video coding.
1665 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1666 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1667 * - encoding: MUST be set by user.
1668 * - decoding: unused
1673 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1674 * decoder to draw a horizontal band. It improves cache usage. Not
1675 * all codecs can do that. You must check the codec capabilities
1677 * When multithreading is used, it may be called from multiple threads
1678 * at the same time; threads might draw different parts of the same AVFrame,
1679 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1681 * The function is also used by hardware acceleration APIs.
1682 * It is called at least once during frame decoding to pass
1683 * the data needed for hardware render.
1684 * In that mode instead of pixel data, AVFrame points to
1685 * a structure specific to the acceleration API. The application
1686 * reads the structure and can change some fields to indicate progress
1688 * - encoding: unused
1689 * - decoding: Set by user.
1690 * @param height the height of the slice
1691 * @param y the y position of the slice
1692 * @param type 1->top field, 2->bottom field, 3->frame
1693 * @param offset offset into the AVFrame.data from which the slice should be read
1695 void (*draw_horiz_band)(struct AVCodecContext *s,
1696 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1697 int y, int type, int height);
1700 * callback to negotiate the pixelFormat
1701 * @param fmt is the list of formats which are supported by the codec,
1702 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1703 * The first is always the native one.
1704 * @return the chosen format
1705 * - encoding: unused
1706 * - decoding: Set by user, if not set the native format will be chosen.
1708 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1711 * maximum number of B-frames between non-B-frames
1712 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1713 * - encoding: Set by user.
1714 * - decoding: unused
1719 * qscale factor between IP and B-frames
1720 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1721 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1722 * - encoding: Set by user.
1723 * - decoding: unused
1725 float b_quant_factor;
1727 /** obsolete FIXME remove */
1729 #define FF_RC_STRATEGY_XVID 1
1731 int b_frame_strategy;
1733 #if FF_API_MPV_GLOBAL_OPTS
1735 * luma single coefficient elimination threshold
1736 * - encoding: Set by user.
1737 * - decoding: unused
1739 attribute_deprecated int luma_elim_threshold;
1742 * chroma single coeff elimination threshold
1743 * - encoding: Set by user.
1744 * - decoding: unused
1746 attribute_deprecated int chroma_elim_threshold;
1750 * qscale offset between IP and B-frames
1751 * - encoding: Set by user.
1752 * - decoding: unused
1754 float b_quant_offset;
1757 * Size of the frame reordering buffer in the decoder.
1758 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1759 * - encoding: Set by libavcodec.
1760 * - decoding: Set by libavcodec.
1765 * 0-> h263 quant 1-> mpeg quant
1766 * - encoding: Set by user.
1767 * - decoding: unused
1772 * qscale factor between P and I-frames
1773 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1774 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1775 * - encoding: Set by user.
1776 * - decoding: unused
1778 float i_quant_factor;
1781 * qscale offset between P and I-frames
1782 * - encoding: Set by user.
1783 * - decoding: unused
1785 float i_quant_offset;
1788 * luminance masking (0-> disabled)
1789 * - encoding: Set by user.
1790 * - decoding: unused
1795 * temporary complexity masking (0-> disabled)
1796 * - encoding: Set by user.
1797 * - decoding: unused
1799 float temporal_cplx_masking;
1802 * spatial complexity masking (0-> disabled)
1803 * - encoding: Set by user.
1804 * - decoding: unused
1806 float spatial_cplx_masking;
1809 * p block masking (0-> disabled)
1810 * - encoding: Set by user.
1811 * - decoding: unused
1816 * darkness masking (0-> disabled)
1817 * - encoding: Set by user.
1818 * - decoding: unused
1824 * - encoding: Set by libavcodec.
1825 * - decoding: Set by user (or 0).
1829 * prediction method (needed for huffyuv)
1830 * - encoding: Set by user.
1831 * - decoding: unused
1833 int prediction_method;
1834 #define FF_PRED_LEFT 0
1835 #define FF_PRED_PLANE 1
1836 #define FF_PRED_MEDIAN 2
1839 * slice offsets in the frame in bytes
1840 * - encoding: Set/allocated by libavcodec.
1841 * - decoding: Set/allocated by user (or NULL).
1846 * sample aspect ratio (0 if unknown)
1847 * That is the width of a pixel divided by the height of the pixel.
1848 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1849 * - encoding: Set by user.
1850 * - decoding: Set by libavcodec.
1852 AVRational sample_aspect_ratio;
1855 * motion estimation comparison function
1856 * - encoding: Set by user.
1857 * - decoding: unused
1861 * subpixel motion estimation comparison function
1862 * - encoding: Set by user.
1863 * - decoding: unused
1867 * macroblock comparison function (not supported yet)
1868 * - encoding: Set by user.
1869 * - decoding: unused
1873 * interlaced DCT comparison function
1874 * - encoding: Set by user.
1875 * - decoding: unused
1878 #define FF_CMP_SAD 0
1879 #define FF_CMP_SSE 1
1880 #define FF_CMP_SATD 2
1881 #define FF_CMP_DCT 3
1882 #define FF_CMP_PSNR 4
1883 #define FF_CMP_BIT 5
1885 #define FF_CMP_ZERO 7
1886 #define FF_CMP_VSAD 8
1887 #define FF_CMP_VSSE 9
1888 #define FF_CMP_NSSE 10
1889 #define FF_CMP_W53 11
1890 #define FF_CMP_W97 12
1891 #define FF_CMP_DCTMAX 13
1892 #define FF_CMP_DCT264 14
1893 #define FF_CMP_CHROMA 256
1896 * ME diamond size & shape
1897 * - encoding: Set by user.
1898 * - decoding: unused
1903 * amount of previous MV predictors (2a+1 x 2a+1 square)
1904 * - encoding: Set by user.
1905 * - decoding: unused
1907 int last_predictor_count;
1910 * prepass for motion estimation
1911 * - encoding: Set by user.
1912 * - decoding: unused
1917 * motion estimation prepass comparison function
1918 * - encoding: Set by user.
1919 * - decoding: unused
1924 * ME prepass diamond size & shape
1925 * - encoding: Set by user.
1926 * - decoding: unused
1932 * - encoding: Set by user.
1933 * - decoding: unused
1935 int me_subpel_quality;
1938 * DTG active format information (additional aspect ratio
1939 * information only used in DVB MPEG-2 transport streams)
1942 * - encoding: unused
1943 * - decoding: Set by decoder.
1945 int dtg_active_format;
1946 #define FF_DTG_AFD_SAME 8
1947 #define FF_DTG_AFD_4_3 9
1948 #define FF_DTG_AFD_16_9 10
1949 #define FF_DTG_AFD_14_9 11
1950 #define FF_DTG_AFD_4_3_SP_14_9 13
1951 #define FF_DTG_AFD_16_9_SP_14_9 14
1952 #define FF_DTG_AFD_SP_4_3 15
1955 * maximum motion estimation search range in subpel units
1956 * If 0 then no limit.
1958 * - encoding: Set by user.
1959 * - decoding: unused
1964 * intra quantizer bias
1965 * - encoding: Set by user.
1966 * - decoding: unused
1968 int intra_quant_bias;
1969 #define FF_DEFAULT_QUANT_BIAS 999999
1972 * inter quantizer bias
1973 * - encoding: Set by user.
1974 * - decoding: unused
1976 int inter_quant_bias;
1978 #if FF_API_COLOR_TABLE_ID
1981 * - encoding: unused
1982 * - decoding: Which clrtable should be used for 8bit RGB images.
1983 * Tables have to be stored somewhere. FIXME
1985 attribute_deprecated int color_table_id;
1990 * - encoding: unused
1991 * - decoding: Set by user.
1994 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1995 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1996 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1999 * XVideo Motion Acceleration
2000 * - encoding: forbidden
2001 * - decoding: set by decoder
2003 int xvmc_acceleration;
2006 * macroblock decision mode
2007 * - encoding: Set by user.
2008 * - decoding: unused
2011 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2012 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2013 #define FF_MB_DECISION_RD 2 ///< rate distortion
2016 * custom intra quantization matrix
2017 * - encoding: Set by user, can be NULL.
2018 * - decoding: Set by libavcodec.
2020 uint16_t *intra_matrix;
2023 * custom inter quantization matrix
2024 * - encoding: Set by user, can be NULL.
2025 * - decoding: Set by libavcodec.
2027 uint16_t *inter_matrix;
2030 * scene change detection threshold
2031 * 0 is default, larger means fewer detected scene changes.
2032 * - encoding: Set by user.
2033 * - decoding: unused
2035 int scenechange_threshold;
2038 * noise reduction strength
2039 * - encoding: Set by user.
2040 * - decoding: unused
2042 int noise_reduction;
2044 #if FF_API_INTER_THRESHOLD
2046 * @deprecated this field is unused
2048 attribute_deprecated int inter_threshold;
2051 #if FF_API_MPV_GLOBAL_OPTS
2053 * @deprecated use mpegvideo private options instead
2055 attribute_deprecated int quantizer_noise_shaping;
2059 * Motion estimation threshold below which no motion estimation is
2060 * performed, but instead the user specified motion vectors are used.
2062 * - encoding: Set by user.
2063 * - decoding: unused
2068 * Macroblock threshold below which the user specified macroblock types will be used.
2069 * - encoding: Set by user.
2070 * - decoding: unused
2075 * precision of the intra DC coefficient - 8
2076 * - encoding: Set by user.
2077 * - decoding: unused
2079 int intra_dc_precision;
2082 * Number of macroblock rows at the top which are skipped.
2083 * - encoding: unused
2084 * - decoding: Set by user.
2089 * Number of macroblock rows at the bottom which are skipped.
2090 * - encoding: unused
2091 * - decoding: Set by user.
2096 * Border processing masking, raises the quantizer for mbs on the borders
2098 * - encoding: Set by user.
2099 * - decoding: unused
2101 float border_masking;
2104 * minimum MB lagrange multipler
2105 * - encoding: Set by user.
2106 * - decoding: unused
2111 * maximum MB lagrange multipler
2112 * - encoding: Set by user.
2113 * - decoding: unused
2119 * - encoding: Set by user.
2120 * - decoding: unused
2122 int me_penalty_compensation;
2126 * - encoding: Set by user.
2127 * - decoding: unused
2133 * - encoding: Set by user.
2134 * - decoding: unused
2140 * - encoding: Set by user.
2141 * - decoding: unused
2146 * number of reference frames
2147 * - encoding: Set by user.
2148 * - decoding: Set by lavc.
2153 * chroma qp offset from luma
2154 * - encoding: Set by user.
2155 * - decoding: unused
2160 * Multiplied by qscale for each frame and added to scene_change_score.
2161 * - encoding: Set by user.
2162 * - decoding: unused
2164 int scenechange_factor;
2168 * Note: Value depends upon the compare function used for fullpel ME.
2169 * - encoding: Set by user.
2170 * - decoding: unused
2175 * Adjust sensitivity of b_frame_strategy 1.
2176 * - encoding: Set by user.
2177 * - decoding: unused
2182 * Chromaticity coordinates of the source primaries.
2183 * - encoding: Set by user
2184 * - decoding: Set by libavcodec
2186 enum AVColorPrimaries color_primaries;
2189 * Color Transfer Characteristic.
2190 * - encoding: Set by user
2191 * - decoding: Set by libavcodec
2193 enum AVColorTransferCharacteristic color_trc;
2196 * YUV colorspace type.
2197 * - encoding: Set by user
2198 * - decoding: Set by libavcodec
2200 enum AVColorSpace colorspace;
2203 * MPEG vs JPEG YUV range.
2204 * - encoding: Set by user
2205 * - decoding: Set by libavcodec
2207 enum AVColorRange color_range;
2210 * This defines the location of chroma samples.
2211 * - encoding: Set by user
2212 * - decoding: Set by libavcodec
2214 enum AVChromaLocation chroma_sample_location;
2218 * Indicates number of picture subdivisions. Used for parallelized
2220 * - encoding: Set by user
2221 * - decoding: unused
2226 * - encoding: set by libavcodec
2227 * - decoding: Set by libavcodec
2229 enum AVFieldOrder field_order;
2232 int sample_rate; ///< samples per second
2233 int channels; ///< number of audio channels
2236 * audio sample format
2237 * - encoding: Set by user.
2238 * - decoding: Set by libavcodec.
2240 enum AVSampleFormat sample_fmt; ///< sample format
2242 /* The following data should not be initialized. */
2244 * Samples per packet, initialized when calling 'init'.
2249 * Frame counter, set by libavcodec.
2251 * - decoding: total number of frames returned from the decoder so far.
2252 * - encoding: total number of frames passed to the encoder so far.
2254 * @note the counter is not incremented if encoding/decoding resulted in
2260 * number of bytes per packet if constant and known or 0
2261 * Used by some WAV based audio codecs.
2266 * Audio cutoff bandwidth (0 means "automatic")
2267 * - encoding: Set by user.
2268 * - decoding: unused
2272 #if FF_API_REQUEST_CHANNELS
2274 * Decoder should decode to this many channels if it can (0 for default)
2275 * - encoding: unused
2276 * - decoding: Set by user.
2277 * @deprecated Deprecated in favor of request_channel_layout.
2279 int request_channels;
2283 * Audio channel layout.
2284 * - encoding: set by user.
2285 * - decoding: set by user, may be overwritten by libavcodec.
2287 uint64_t channel_layout;
2290 * Request decoder to use this channel layout if it can (0 for default)
2291 * - encoding: unused
2292 * - decoding: Set by user.
2294 uint64_t request_channel_layout;
2297 * Type of service that the audio stream conveys.
2298 * - encoding: Set by user.
2299 * - decoding: Set by libavcodec.
2301 enum AVAudioServiceType audio_service_type;
2304 * desired sample format
2305 * - encoding: Not used.
2306 * - decoding: Set by user.
2307 * Decoder will decode to this format if it can.
2309 enum AVSampleFormat request_sample_fmt;
2312 * Called at the beginning of each frame to get a buffer for it.
2314 * The function will set AVFrame.data[], AVFrame.linesize[].
2315 * AVFrame.extended_data[] must also be set, but it should be the same as
2316 * AVFrame.data[] except for planar audio with more channels than can fit
2317 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2318 * many data pointers as it can hold.
2320 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2321 * avcodec_default_get_buffer() instead of providing buffers allocated by
2324 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2325 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2326 * but if get_buffer() is overridden then alignment considerations should
2327 * be taken into account.
2329 * @see avcodec_default_get_buffer()
2333 * If pic.reference is set then the frame will be read later by libavcodec.
2334 * avcodec_align_dimensions2() should be used to find the required width and
2335 * height, as they normally need to be rounded up to the next multiple of 16.
2337 * If frame multithreading is used and thread_safe_callbacks is set,
2338 * it may be called from a different thread, but not from more than one at
2339 * once. Does not need to be reentrant.
2341 * @see release_buffer(), reget_buffer()
2342 * @see avcodec_align_dimensions2()
2346 * Decoders request a buffer of a particular size by setting
2347 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2348 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2349 * to a smaller value in the output frame.
2351 * Decoders cannot use the buffer after returning from
2352 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2353 * is assumed to be released immediately upon return.
2355 * As a convenience, av_samples_get_buffer_size() and
2356 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2357 * functions to find the required data size and to fill data pointers and
2358 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2359 * since all planes must be the same size.
2361 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2363 * - encoding: unused
2364 * - decoding: Set by libavcodec, user can override.
2366 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2369 * Called to release buffers which were allocated with get_buffer.
2370 * A released buffer can be reused in get_buffer().
2371 * pic.data[*] must be set to NULL.
2372 * May be called from a different thread if frame multithreading is used,
2373 * but not by more than one thread at once, so does not need to be reentrant.
2374 * - encoding: unused
2375 * - decoding: Set by libavcodec, user can override.
2377 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2380 * Called at the beginning of a frame to get cr buffer for it.
2381 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2382 * libavcodec will pass previous buffer in pic, function should return
2383 * same buffer or new buffer with old frame "painted" into it.
2384 * If pic.data[0] == NULL must behave like get_buffer().
2385 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2386 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2388 * - encoding: unused
2389 * - decoding: Set by libavcodec, user can override.
2391 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2394 /* - encoding parameters */
2395 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2396 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2400 * - encoding: Set by user.
2401 * - decoding: unused
2407 * - encoding: Set by user.
2408 * - decoding: unused
2413 * maximum quantizer difference between frames
2414 * - encoding: Set by user.
2415 * - decoding: unused
2420 * ratecontrol qmin qmax limiting method
2421 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2422 * - encoding: Set by user.
2423 * - decoding: unused
2431 * decoder bitstream buffer size
2432 * - encoding: Set by user.
2433 * - decoding: unused
2438 * ratecontrol override, see RcOverride
2439 * - encoding: Allocated/set/freed by user.
2440 * - decoding: unused
2442 int rc_override_count;
2443 RcOverride *rc_override;
2446 * rate control equation
2447 * - encoding: Set by user
2448 * - decoding: unused
2454 * - encoding: Set by user.
2455 * - decoding: unused
2461 * - encoding: Set by user.
2462 * - decoding: unused
2466 float rc_buffer_aggressivity;
2469 * initial complexity for pass1 ratecontrol
2470 * - encoding: Set by user.
2471 * - decoding: unused
2473 float rc_initial_cplx;
2476 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2477 * - encoding: Set by user.
2478 * - decoding: unused.
2480 float rc_max_available_vbv_use;
2483 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2484 * - encoding: Set by user.
2485 * - decoding: unused.
2487 float rc_min_vbv_overflow_use;
2490 * Number of bits which should be loaded into the rc buffer before decoding starts.
2491 * - encoding: Set by user.
2492 * - decoding: unused
2494 int rc_initial_buffer_occupancy;
2496 #define FF_CODER_TYPE_VLC 0
2497 #define FF_CODER_TYPE_AC 1
2498 #define FF_CODER_TYPE_RAW 2
2499 #define FF_CODER_TYPE_RLE 3
2500 #define FF_CODER_TYPE_DEFLATE 4
2503 * - encoding: Set by user.
2504 * - decoding: unused
2510 * - encoding: Set by user.
2511 * - decoding: unused
2516 * minimum Lagrange multipler
2517 * - encoding: Set by user.
2518 * - decoding: unused
2523 * maximum Lagrange multipler
2524 * - encoding: Set by user.
2525 * - decoding: unused
2530 * frame skip threshold
2531 * - encoding: Set by user.
2532 * - decoding: unused
2534 int frame_skip_threshold;
2538 * - encoding: Set by user.
2539 * - decoding: unused
2541 int frame_skip_factor;
2544 * frame skip exponent
2545 * - encoding: Set by user.
2546 * - decoding: unused
2551 * frame skip comparison function
2552 * - encoding: Set by user.
2553 * - decoding: unused
2558 * trellis RD quantization
2559 * - encoding: Set by user.
2560 * - decoding: unused
2565 * - encoding: Set by user.
2566 * - decoding: unused
2568 int min_prediction_order;
2571 * - encoding: Set by user.
2572 * - decoding: unused
2574 int max_prediction_order;
2577 * GOP timecode frame start number
2578 * - encoding: Set by user, in non drop frame format
2579 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2581 int64_t timecode_frame_start;
2583 /* The RTP callback: This function is called */
2584 /* every time the encoder has a packet to send. */
2585 /* It depends on the encoder if the data starts */
2586 /* with a Start Code (it should). H.263 does. */
2587 /* mb_nb contains the number of macroblocks */
2588 /* encoded in the RTP payload. */
2589 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2591 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2592 /* do its best to deliver a chunk with size */
2593 /* below rtp_payload_size, the chunk will start */
2594 /* with a start code on some codecs like H.263. */
2595 /* This doesn't take account of any particular */
2596 /* headers inside the transmitted RTP payload. */
2598 /* statistics, used for 2-pass encoding */
2609 * number of bits used for the previously encoded frame
2610 * - encoding: Set by libavcodec.
2611 * - decoding: unused
2616 * pass1 encoding statistics output buffer
2617 * - encoding: Set by libavcodec.
2618 * - decoding: unused
2623 * pass2 encoding statistics input buffer
2624 * Concatenated stuff from stats_out of pass1 should be placed here.
2625 * - encoding: Allocated/set/freed by user.
2626 * - decoding: unused
2631 * Work around bugs in encoders which sometimes cannot be detected automatically.
2632 * - encoding: Set by user
2633 * - decoding: Set by user
2635 int workaround_bugs;
2636 #define FF_BUG_AUTODETECT 1 ///< autodetection
2637 #define FF_BUG_OLD_MSMPEG4 2
2638 #define FF_BUG_XVID_ILACE 4
2639 #define FF_BUG_UMP4 8
2640 #define FF_BUG_NO_PADDING 16
2641 #define FF_BUG_AMV 32
2642 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2643 #define FF_BUG_QPEL_CHROMA 64
2644 #define FF_BUG_STD_QPEL 128
2645 #define FF_BUG_QPEL_CHROMA2 256
2646 #define FF_BUG_DIRECT_BLOCKSIZE 512
2647 #define FF_BUG_EDGE 1024
2648 #define FF_BUG_HPEL_CHROMA 2048
2649 #define FF_BUG_DC_CLIP 4096
2650 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2651 #define FF_BUG_TRUNCATED 16384
2654 * strictly follow the standard (MPEG4, ...).
2655 * - encoding: Set by user.
2656 * - decoding: Set by user.
2657 * Setting this to STRICT or higher means the encoder and decoder will
2658 * generally do stupid things, whereas setting it to unofficial or lower
2659 * will mean the encoder might produce output that is not supported by all
2660 * spec-compliant decoders. Decoders don't differentiate between normal,
2661 * unofficial and experimental (that is, they always try to decode things
2662 * when they can) unless they are explicitly asked to behave stupidly
2663 * (=strictly conform to the specs)
2665 int strict_std_compliance;
2666 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2667 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2668 #define FF_COMPLIANCE_NORMAL 0
2669 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2670 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2673 * error concealment flags
2674 * - encoding: unused
2675 * - decoding: Set by user.
2677 int error_concealment;
2678 #define FF_EC_GUESS_MVS 1
2679 #define FF_EC_DEBLOCK 2
2683 * - encoding: Set by user.
2684 * - decoding: Set by user.
2687 #define FF_DEBUG_PICT_INFO 1
2688 #define FF_DEBUG_RC 2
2689 #define FF_DEBUG_BITSTREAM 4
2690 #define FF_DEBUG_MB_TYPE 8
2691 #define FF_DEBUG_QP 16
2692 #define FF_DEBUG_MV 32
2693 #define FF_DEBUG_DCT_COEFF 0x00000040
2694 #define FF_DEBUG_SKIP 0x00000080
2695 #define FF_DEBUG_STARTCODE 0x00000100
2696 #define FF_DEBUG_PTS 0x00000200
2697 #define FF_DEBUG_ER 0x00000400
2698 #define FF_DEBUG_MMCO 0x00000800
2699 #define FF_DEBUG_BUGS 0x00001000
2700 #define FF_DEBUG_VIS_QP 0x00002000
2701 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2702 #define FF_DEBUG_BUFFERS 0x00008000
2703 #define FF_DEBUG_THREADS 0x00010000
2707 * - encoding: Set by user.
2708 * - decoding: Set by user.
2711 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2712 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2713 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2716 * Error recognition; may misdetect some more or less valid parts as errors.
2717 * - encoding: unused
2718 * - decoding: Set by user.
2720 int err_recognition;
2721 #define AV_EF_CRCCHECK (1<<0)
2722 #define AV_EF_BITSTREAM (1<<1)
2723 #define AV_EF_BUFFER (1<<2)
2724 #define AV_EF_EXPLODE (1<<3)
2726 #define AV_EF_CAREFUL (1<<16)
2727 #define AV_EF_COMPLIANT (1<<17)
2728 #define AV_EF_AGGRESSIVE (1<<18)
2732 * opaque 64bit number (generally a PTS) that will be reordered and
2733 * output in AVFrame.reordered_opaque
2734 * @deprecated in favor of pkt_pts
2735 * - encoding: unused
2736 * - decoding: Set by user.
2738 int64_t reordered_opaque;
2741 * Hardware accelerator in use
2742 * - encoding: unused.
2743 * - decoding: Set by libavcodec
2745 struct AVHWAccel *hwaccel;
2748 * Hardware accelerator context.
2749 * For some hardware accelerators, a global context needs to be
2750 * provided by the user. In that case, this holds display-dependent
2751 * data FFmpeg cannot instantiate itself. Please refer to the
2752 * FFmpeg HW accelerator documentation to know how to fill this
2753 * is. e.g. for VA API, this is a struct vaapi_context.
2754 * - encoding: unused
2755 * - decoding: Set by user
2757 void *hwaccel_context;
2761 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2762 * - decoding: unused
2764 uint64_t error[AV_NUM_DATA_POINTERS];
2767 * DCT algorithm, see FF_DCT_* below
2768 * - encoding: Set by user.
2769 * - decoding: unused
2772 #define FF_DCT_AUTO 0
2773 #define FF_DCT_FASTINT 1
2774 #define FF_DCT_INT 2
2775 #define FF_DCT_MMX 3
2776 #define FF_DCT_ALTIVEC 5
2777 #define FF_DCT_FAAN 6
2780 * IDCT algorithm, see FF_IDCT_* below.
2781 * - encoding: Set by user.
2782 * - decoding: Set by user.
2785 #define FF_IDCT_AUTO 0
2786 #define FF_IDCT_INT 1
2787 #define FF_IDCT_SIMPLE 2
2788 #define FF_IDCT_SIMPLEMMX 3
2789 #define FF_IDCT_LIBMPEG2MMX 4
2790 #define FF_IDCT_MMI 5
2791 #define FF_IDCT_ARM 7
2792 #define FF_IDCT_ALTIVEC 8
2793 #define FF_IDCT_SH4 9
2794 #define FF_IDCT_SIMPLEARM 10
2795 #define FF_IDCT_H264 11
2796 #define FF_IDCT_VP3 12
2797 #define FF_IDCT_IPP 13
2798 #define FF_IDCT_XVIDMMX 14
2799 #define FF_IDCT_CAVS 15
2800 #define FF_IDCT_SIMPLEARMV5TE 16
2801 #define FF_IDCT_SIMPLEARMV6 17
2802 #define FF_IDCT_SIMPLEVIS 18
2803 #define FF_IDCT_WMV2 19
2804 #define FF_IDCT_FAAN 20
2805 #define FF_IDCT_EA 21
2806 #define FF_IDCT_SIMPLENEON 22
2807 #define FF_IDCT_SIMPLEALPHA 23
2808 #define FF_IDCT_BINK 24
2813 * @deprecated use av_set_cpu_flags_mask() instead.
2815 attribute_deprecated unsigned dsp_mask;
2819 * bits per sample/pixel from the demuxer (needed for huffyuv).
2820 * - encoding: Set by libavcodec.
2821 * - decoding: Set by user.
2823 int bits_per_coded_sample;
2826 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2827 * - encoding: set by user.
2828 * - decoding: set by libavcodec.
2830 int bits_per_raw_sample;
2833 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2834 * - encoding: unused
2835 * - decoding: Set by user.
2840 * the picture in the bitstream
2841 * - encoding: Set by libavcodec.
2842 * - decoding: Set by libavcodec.
2844 AVFrame *coded_frame;
2848 * is used to decide how many independent tasks should be passed to execute()
2849 * - encoding: Set by user.
2850 * - decoding: Set by user.
2855 * Which multithreading methods to use.
2856 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2857 * so clients which cannot provide future frames should not use it.
2859 * - encoding: Set by user, otherwise the default is used.
2860 * - decoding: Set by user, otherwise the default is used.
2863 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2864 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2867 * Which multithreading methods are in use by the codec.
2868 * - encoding: Set by libavcodec.
2869 * - decoding: Set by libavcodec.
2871 int active_thread_type;
2874 * Set by the client if its custom get_buffer() callback can be called
2875 * synchronously from another thread, which allows faster multithreaded decoding.
2876 * draw_horiz_band() will be called from other threads regardless of this setting.
2877 * Ignored if the default get_buffer() is used.
2878 * - encoding: Set by user.
2879 * - decoding: Set by user.
2881 int thread_safe_callbacks;
2884 * The codec may call this to execute several independent things.
2885 * It will return only after finishing all tasks.
2886 * The user may replace this with some multithreaded implementation,
2887 * the default implementation will execute the parts serially.
2888 * @param count the number of things to execute
2889 * - encoding: Set by libavcodec, user can override.
2890 * - decoding: Set by libavcodec, user can override.
2892 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2895 * The codec may call this to execute several independent things.
2896 * It will return only after finishing all tasks.
2897 * The user may replace this with some multithreaded implementation,
2898 * the default implementation will execute the parts serially.
2899 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2900 * @param c context passed also to func
2901 * @param count the number of things to execute
2902 * @param arg2 argument passed unchanged to func
2903 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2904 * @param func function that will be called count times, with jobnr from 0 to count-1.
2905 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2906 * two instances of func executing at the same time will have the same threadnr.
2907 * @return always 0 currently, but code should handle a future improvement where when any call to func
2908 * returns < 0 no further calls to func may be done and < 0 is returned.
2909 * - encoding: Set by libavcodec, user can override.
2910 * - decoding: Set by libavcodec, user can override.
2912 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2916 * Can be used by execute() to store some per AVCodecContext stuff.
2917 * - encoding: set by execute()
2918 * - decoding: set by execute()
2920 void *thread_opaque;
2923 * noise vs. sse weight for the nsse comparsion function
2924 * - encoding: Set by user.
2925 * - decoding: unused
2931 * - encoding: Set by user.
2932 * - decoding: Set by libavcodec.
2935 #define FF_PROFILE_UNKNOWN -99
2936 #define FF_PROFILE_RESERVED -100
2938 #define FF_PROFILE_AAC_MAIN 0
2939 #define FF_PROFILE_AAC_LOW 1
2940 #define FF_PROFILE_AAC_SSR 2
2941 #define FF_PROFILE_AAC_LTP 3
2942 #define FF_PROFILE_AAC_HE 4
2943 #define FF_PROFILE_AAC_HE_V2 28
2944 #define FF_PROFILE_AAC_LD 22
2945 #define FF_PROFILE_AAC_ELD 38
2947 #define FF_PROFILE_DTS 20
2948 #define FF_PROFILE_DTS_ES 30
2949 #define FF_PROFILE_DTS_96_24 40
2950 #define FF_PROFILE_DTS_HD_HRA 50
2951 #define FF_PROFILE_DTS_HD_MA 60
2953 #define FF_PROFILE_MPEG2_422 0
2954 #define FF_PROFILE_MPEG2_HIGH 1
2955 #define FF_PROFILE_MPEG2_SS 2
2956 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2957 #define FF_PROFILE_MPEG2_MAIN 4
2958 #define FF_PROFILE_MPEG2_SIMPLE 5
2960 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2961 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2963 #define FF_PROFILE_H264_BASELINE 66
2964 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2965 #define FF_PROFILE_H264_MAIN 77
2966 #define FF_PROFILE_H264_EXTENDED 88
2967 #define FF_PROFILE_H264_HIGH 100
2968 #define FF_PROFILE_H264_HIGH_10 110
2969 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2970 #define FF_PROFILE_H264_HIGH_422 122
2971 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2972 #define FF_PROFILE_H264_HIGH_444 144
2973 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2974 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2975 #define FF_PROFILE_H264_CAVLC_444 44
2977 #define FF_PROFILE_VC1_SIMPLE 0
2978 #define FF_PROFILE_VC1_MAIN 1
2979 #define FF_PROFILE_VC1_COMPLEX 2
2980 #define FF_PROFILE_VC1_ADVANCED 3
2982 #define FF_PROFILE_MPEG4_SIMPLE 0
2983 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2984 #define FF_PROFILE_MPEG4_CORE 2
2985 #define FF_PROFILE_MPEG4_MAIN 3
2986 #define FF_PROFILE_MPEG4_N_BIT 4
2987 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2988 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2989 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2990 #define FF_PROFILE_MPEG4_HYBRID 8
2991 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2992 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2993 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2994 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2995 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2996 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2997 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3001 * - encoding: Set by user.
3002 * - decoding: Set by libavcodec.
3005 #define FF_LEVEL_UNKNOWN -99
3009 * - encoding: unused
3010 * - decoding: Set by user.
3012 enum AVDiscard skip_loop_filter;
3016 * - encoding: unused
3017 * - decoding: Set by user.
3019 enum AVDiscard skip_idct;
3023 * - encoding: unused
3024 * - decoding: Set by user.
3026 enum AVDiscard skip_frame;
3029 * Header containing style information for text subtitles.
3030 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3031 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3032 * the Format line following. It shouldn't include any Dialogue line.
3033 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3034 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3036 uint8_t *subtitle_header;
3037 int subtitle_header_size;
3040 * Simulates errors in the bitstream to test error concealment.
3041 * - encoding: Set by user.
3042 * - decoding: unused
3047 * Current packet as passed into the decoder, to avoid having
3048 * to pass the packet into every function. Currently only valid
3049 * inside lavc and get/release_buffer callbacks.
3050 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
3051 * - encoding: unused
3056 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3057 * Used for compliant TS muxing.
3058 * - encoding: Set by libavcodec.
3059 * - decoding: unused.
3064 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3065 * Code outside libavcodec should access this field using:
3066 * avcodec_set_pkt_timebase(avctx)
3067 * - encoding unused.
3068 * - decodimg set by user
3070 AVRational pkt_timebase;
3074 * Code outside libavcodec should access this field using:
3075 * avcodec_get_codec_descriptior(avctx)
3076 * - encoding: unused.
3077 * - decoding: set by libavcodec.
3079 const AVCodecDescriptor *codec_descriptor;
3082 * Current statistics for PTS correction.
3083 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3084 * - encoding: unused
3086 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3087 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3088 int64_t pts_correction_last_pts; /// PTS of the last frame
3089 int64_t pts_correction_last_dts; /// DTS of the last frame
3092 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3093 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3095 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3096 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3101 typedef struct AVProfile {
3103 const char *name; ///< short name for the profile
3106 typedef struct AVCodecDefault AVCodecDefault;
3113 typedef struct AVCodec {
3115 * Name of the codec implementation.
3116 * The name is globally unique among encoders and among decoders (but an
3117 * encoder and a decoder can share the same name).
3118 * This is the primary way to find a codec from the user perspective.
3122 * Descriptive name for the codec, meant to be more human readable than name.
3123 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3125 const char *long_name;
3126 enum AVMediaType type;
3129 * Codec capabilities.
3133 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3134 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3135 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3136 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3137 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3138 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3139 const AVClass *priv_class; ///< AVClass for the private context
3140 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3142 /*****************************************************************
3143 * No fields below this line are part of the public API. They
3144 * may not be used outside of libavcodec and can be changed and
3146 * New public fields should be added right above.
3147 *****************************************************************
3150 struct AVCodec *next;
3152 * @name Frame-level threading support functions
3156 * If defined, called on thread contexts when they are created.
3157 * If the codec allocates writable tables in init(), re-allocate them here.
3158 * priv_data will be set to a copy of the original.
3160 int (*init_thread_copy)(AVCodecContext *);
3162 * Copy necessary context variables from a previous thread context to the current one.
3163 * If not defined, the next thread will start automatically; otherwise, the codec
3164 * must call ff_thread_finish_setup().
3166 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3168 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3172 * Private codec-specific defaults.
3174 const AVCodecDefault *defaults;
3177 * Initialize codec static data, called from avcodec_register().
3179 void (*init_static_data)(struct AVCodec *codec);
3181 int (*init)(AVCodecContext *);
3182 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3183 const struct AVSubtitle *sub);
3185 * Encode data to an AVPacket.
3187 * @param avctx codec context
3188 * @param avpkt output AVPacket (may contain a user-provided buffer)
3189 * @param[in] frame AVFrame containing the raw data to be encoded
3190 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3191 * non-empty packet was returned in avpkt.
3192 * @return 0 on success, negative error code on failure
3194 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3195 int *got_packet_ptr);
3196 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3197 int (*close)(AVCodecContext *);
3200 * Will be called when seeking
3202 void (*flush)(AVCodecContext *);
3208 typedef struct AVHWAccel {
3210 * Name of the hardware accelerated codec.
3211 * The name is globally unique among encoders and among decoders (but an
3212 * encoder and a decoder can share the same name).
3217 * Type of codec implemented by the hardware accelerator.
3219 * See AVMEDIA_TYPE_xxx
3221 enum AVMediaType type;
3224 * Codec implemented by the hardware accelerator.
3226 * See AV_CODEC_ID_xxx
3231 * Supported pixel format.
3233 * Only hardware accelerated formats are supported here.
3235 enum PixelFormat pix_fmt;
3238 * Hardware accelerated codec capabilities.
3239 * see FF_HWACCEL_CODEC_CAP_*
3243 struct AVHWAccel *next;
3246 * Called at the beginning of each frame or field picture.
3248 * Meaningful frame information (codec specific) is guaranteed to
3249 * be parsed at this point. This function is mandatory.
3251 * Note that buf can be NULL along with buf_size set to 0.
3252 * Otherwise, this means the whole frame is available at this point.
3254 * @param avctx the codec context
3255 * @param buf the frame data buffer base
3256 * @param buf_size the size of the frame in bytes
3257 * @return zero if successful, a negative value otherwise
3259 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3262 * Callback for each slice.
3264 * Meaningful slice information (codec specific) is guaranteed to
3265 * be parsed at this point. This function is mandatory.
3267 * @param avctx the codec context
3268 * @param buf the slice data buffer base
3269 * @param buf_size the size of the slice in bytes
3270 * @return zero if successful, a negative value otherwise
3272 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3275 * Called at the end of each frame or field picture.
3277 * The whole picture is parsed at this point and can now be sent
3278 * to the hardware accelerator. This function is mandatory.
3280 * @param avctx the codec context
3281 * @return zero if successful, a negative value otherwise
3283 int (*end_frame)(AVCodecContext *avctx);
3286 * Size of HW accelerator private data.
3288 * Private data is allocated with av_mallocz() before
3289 * AVCodecContext.get_buffer() and deallocated after
3290 * AVCodecContext.release_buffer().
3296 * @defgroup lavc_picture AVPicture
3298 * Functions for working with AVPicture
3303 * four components are given, that's all.
3304 * the last component is alpha
3306 typedef struct AVPicture {
3307 uint8_t *data[AV_NUM_DATA_POINTERS];
3308 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3315 enum AVSubtitleType {
3318 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3321 * Plain text, the text field must be set by the decoder and is
3322 * authoritative. ass and pict fields may contain approximations.
3327 * Formatted text, the ass field must be set by the decoder and is
3328 * authoritative. pict and text fields may contain approximations.
3333 typedef struct AVSubtitleRect {
3334 int x; ///< top left corner of pict, undefined when pict is not set
3335 int y; ///< top left corner of pict, undefined when pict is not set
3336 int w; ///< width of pict, undefined when pict is not set
3337 int h; ///< height of pict, undefined when pict is not set
3338 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3341 * data+linesize for the bitmap of this subtitle.
3342 * can be set for text/ass as well once they where rendered
3345 enum AVSubtitleType type;
3347 char *text; ///< 0 terminated plain UTF-8 text
3350 * 0 terminated ASS/SSA compatible event line.
3351 * The presentation of this is unaffected by the other values in this
3357 * 1 indicates this subtitle is a forced subtitle.
3358 * A forced subtitle should be displayed even when subtitles are hidden.
3363 typedef struct AVSubtitle {
3364 uint16_t format; /* 0 = graphics */
3365 uint32_t start_display_time; /* relative to packet pts, in ms */
3366 uint32_t end_display_time; /* relative to packet pts, in ms */
3368 AVSubtitleRect **rects;
3369 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3373 * If c is NULL, returns the first registered codec,
3374 * if c is non-NULL, returns the next registered codec after c,
3375 * or NULL if c is the last one.
3377 AVCodec *av_codec_next(const AVCodec *c);
3380 * Return the LIBAVCODEC_VERSION_INT constant.
3382 unsigned avcodec_version(void);
3385 * Return the libavcodec build-time configuration.
3387 const char *avcodec_configuration(void);
3390 * Return the libavcodec license.
3392 const char *avcodec_license(void);
3395 * Register the codec codec and initialize libavcodec.
3397 * @warning either this function or avcodec_register_all() must be called
3398 * before any other libavcodec functions.
3400 * @see avcodec_register_all()
3402 void avcodec_register(AVCodec *codec);
3405 * Register all the codecs, parsers and bitstream filters which were enabled at
3406 * configuration time. If you do not call this function you can select exactly
3407 * which formats you want to support, by using the individual registration
3410 * @see avcodec_register
3411 * @see av_register_codec_parser
3412 * @see av_register_bitstream_filter
3414 void avcodec_register_all(void);
3417 #if FF_API_ALLOC_CONTEXT
3419 * Allocate an AVCodecContext and set its fields to default values. The
3420 * resulting struct can be deallocated by simply calling av_free().
3422 * @return An AVCodecContext filled with default values or NULL on failure.
3423 * @see avcodec_get_context_defaults
3425 * @deprecated use avcodec_alloc_context3()
3427 attribute_deprecated
3428 AVCodecContext *avcodec_alloc_context(void);
3430 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3431 * we WILL change its arguments and name a few times! */
3432 attribute_deprecated
3433 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3436 * Set the fields of the given AVCodecContext to default values.
3438 * @param s The AVCodecContext of which the fields should be set to default values.
3439 * @deprecated use avcodec_get_context_defaults3
3441 attribute_deprecated
3442 void avcodec_get_context_defaults(AVCodecContext *s);
3444 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3445 * we WILL change its arguments and name a few times! */
3446 attribute_deprecated
3447 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3451 * Allocate an AVCodecContext and set its fields to default values. The
3452 * resulting struct can be deallocated by calling avcodec_close() on it followed
3455 * @param codec if non-NULL, allocate private data and initialize defaults
3456 * for the given codec. It is illegal to then call avcodec_open2()
3457 * with a different codec.
3458 * If NULL, then the codec-specific defaults won't be initialized,
3459 * which may result in suboptimal default settings (this is
3460 * important mainly for encoders, e.g. libx264).
3462 * @return An AVCodecContext filled with default values or NULL on failure.
3463 * @see avcodec_get_context_defaults
3465 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3468 * Set the fields of the given AVCodecContext to default values corresponding
3469 * to the given codec (defaults may be codec-dependent).
3471 * Do not call this function if a non-NULL codec has been passed
3472 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3473 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3474 * different codec on this AVCodecContext.
3476 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3479 * Get the AVClass for AVCodecContext. It can be used in combination with
3480 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3482 * @see av_opt_find().
3484 const AVClass *avcodec_get_class(void);
3487 * Get the AVClass for AVFrame. It can be used in combination with
3488 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3490 * @see av_opt_find().
3492 const AVClass *avcodec_get_frame_class(void);
3495 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3496 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3498 * @see av_opt_find().
3500 const AVClass *avcodec_get_subtitle_rect_class(void);
3503 * Copy the settings of the source AVCodecContext into the destination
3504 * AVCodecContext. The resulting destination codec context will be
3505 * unopened, i.e. you are required to call avcodec_open2() before you
3506 * can use this AVCodecContext to decode/encode video/audio data.
3508 * @param dest target codec context, should be initialized with
3509 * avcodec_alloc_context3(), but otherwise uninitialized
3510 * @param src source codec context
3511 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3513 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3516 * Allocate an AVFrame and set its fields to default values. The resulting
3517 * struct must be freed using avcodec_free_frame().
3519 * @return An AVFrame filled with default values or NULL on failure.
3520 * @see avcodec_get_frame_defaults
3522 AVFrame *avcodec_alloc_frame(void);
3525 * Set the fields of the given AVFrame to default values.
3527 * @param frame The AVFrame of which the fields should be set to default values.
3529 void avcodec_get_frame_defaults(AVFrame *frame);
3532 * Free the frame and any dynamically allocated objects in it,
3533 * e.g. extended_data.
3535 * @param frame frame to be freed. The pointer will be set to NULL.
3537 * @warning this function does NOT free the data buffers themselves
3538 * (it does not know how, since they might have been allocated with
3539 * a custom get_buffer()).
3541 void avcodec_free_frame(AVFrame **frame);
3543 #if FF_API_AVCODEC_OPEN
3545 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3546 * function the context has to be allocated.
3548 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3549 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3550 * retrieving a codec.
3552 * @warning This function is not thread safe!
3555 * avcodec_register_all();
3556 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3560 * context = avcodec_alloc_context3(codec);
3562 * if (avcodec_open(context, codec) < 0)
3566 * @param avctx The context which will be set up to use the given codec.
3567 * @param codec The codec to use within the context.
3568 * @return zero on success, a negative value on error
3569 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3571 * @deprecated use avcodec_open2
3573 attribute_deprecated
3574 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3578 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3579 * function the context has to be allocated with avcodec_alloc_context3().
3581 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3582 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3583 * retrieving a codec.
3585 * @warning This function is not thread safe!
3588 * avcodec_register_all();
3589 * av_dict_set(&opts, "b", "2.5M", 0);
3590 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3594 * context = avcodec_alloc_context3(codec);
3596 * if (avcodec_open2(context, codec, opts) < 0)
3600 * @param avctx The context to initialize.
3601 * @param codec The codec to open this context for. If a non-NULL codec has been
3602 * previously passed to avcodec_alloc_context3() or
3603 * avcodec_get_context_defaults3() for this context, then this
3604 * parameter MUST be either NULL or equal to the previously passed
3606 * @param options A dictionary filled with AVCodecContext and codec-private options.
3607 * On return this object will be filled with options that were not found.
3609 * @return zero on success, a negative value on error
3610 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3611 * av_dict_set(), av_opt_find().
3613 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3616 * Close a given AVCodecContext and free all the data associated with it
3617 * (but not the AVCodecContext itself).
3619 * Calling this function on an AVCodecContext that hasn't been opened will free
3620 * the codec-specific data allocated in avcodec_alloc_context3() /
3621 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3624 int avcodec_close(AVCodecContext *avctx);
3627 * Free all allocated data in the given subtitle struct.
3629 * @param sub AVSubtitle to free.
3631 void avsubtitle_free(AVSubtitle *sub);
3638 * @addtogroup lavc_packet
3643 * Default packet destructor.
3645 void av_destruct_packet(AVPacket *pkt);
3648 * Initialize optional fields of a packet with default values.
3650 * Note, this does not touch the data and size members, which have to be
3651 * initialized separately.
3655 void av_init_packet(AVPacket *pkt);
3658 * Allocate the payload of a packet and initialize its fields with
3662 * @param size wanted payload size
3663 * @return 0 if OK, AVERROR_xxx otherwise
3665 int av_new_packet(AVPacket *pkt, int size);
3668 * Reduce packet size, correctly zeroing padding
3671 * @param size new size
3673 void av_shrink_packet(AVPacket *pkt, int size);
3676 * Increase packet size, correctly zeroing padding
3679 * @param grow_by number of bytes by which to increase the size of the packet
3681 int av_grow_packet(AVPacket *pkt, int grow_by);
3684 * @warning This is a hack - the packet memory allocation stuff is broken. The
3685 * packet is allocated if it was not really allocated.
3687 int av_dup_packet(AVPacket *pkt);
3690 * Copy packet, including contents
3692 * @return 0 on success, negative AVERROR on fail
3694 int av_copy_packet(AVPacket *dst, AVPacket *src);
3699 * @param pkt packet to free
3701 void av_free_packet(AVPacket *pkt);
3704 * Allocate new information of a packet.
3707 * @param type side information type
3708 * @param size side information size
3709 * @return pointer to fresh allocated data or NULL otherwise
3711 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3715 * Shrink the already allocated side data buffer
3718 * @param type side information type
3719 * @param size new side information size
3720 * @return 0 on success, < 0 on failure
3722 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3726 * Get side information from packet.
3729 * @param type desired side information type
3730 * @param size pointer for side information size to store (optional)
3731 * @return pointer to data if present or NULL otherwise
3733 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3736 int av_packet_merge_side_data(AVPacket *pkt);
3738 int av_packet_split_side_data(AVPacket *pkt);
3746 * @addtogroup lavc_decoding
3751 * Find a registered decoder with a matching codec ID.
3753 * @param id AVCodecID of the requested decoder
3754 * @return A decoder if one was found, NULL otherwise.
3756 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3759 * Find a registered decoder with the specified name.
3761 * @param name name of the requested decoder
3762 * @return A decoder if one was found, NULL otherwise.
3764 AVCodec *avcodec_find_decoder_by_name(const char *name);
3766 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3767 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3768 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3771 * Return the amount of padding in pixels which the get_buffer callback must
3772 * provide around the edge of the image for codecs which do not have the
3773 * CODEC_FLAG_EMU_EDGE flag.
3775 * @return Required padding in pixels.
3777 unsigned avcodec_get_edge_width(void);
3780 * Modify width and height values so that they will result in a memory
3781 * buffer that is acceptable for the codec if you do not use any horizontal
3784 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3785 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3786 * according to avcodec_get_edge_width() before.
3788 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3791 * Modify width and height values so that they will result in a memory
3792 * buffer that is acceptable for the codec if you also ensure that all
3793 * line sizes are a multiple of the respective linesize_align[i].
3795 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3796 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3797 * according to avcodec_get_edge_width() before.
3799 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3800 int linesize_align[AV_NUM_DATA_POINTERS]);
3802 #if FF_API_OLD_DECODE_AUDIO
3804 * Wrapper function which calls avcodec_decode_audio4.
3806 * @deprecated Use avcodec_decode_audio4 instead.
3808 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3809 * Some decoders may support multiple frames in a single AVPacket, such
3810 * decoders would then just decode the first frame. In this case,
3811 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3812 * the remaining data in order to decode the second frame etc.
3814 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3815 * decompressed frame size in bytes.
3817 * @warning You must set frame_size_ptr to the allocated size of the
3818 * output buffer before calling avcodec_decode_audio3().
3820 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3821 * the actual read bytes because some optimized bitstream readers read 32 or 64
3822 * bits at once and could read over the end.
3824 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3825 * no overreading happens for damaged MPEG streams.
3827 * @warning You must not provide a custom get_buffer() when using
3828 * avcodec_decode_audio3(). Doing so will override it with
3829 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3830 * which does allow the application to provide a custom get_buffer().
3832 * @note You might have to align the input buffer avpkt->data and output buffer
3833 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3834 * necessary at all, on others it won't work at all if not aligned and on others
3835 * it will work but it will have an impact on performance.
3837 * In practice, avpkt->data should have 4 byte alignment at minimum and
3838 * samples should be 16 byte aligned unless the CPU doesn't need it
3839 * (AltiVec and SSE do).
3841 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3842 * between input and output, these need to be fed with avpkt->data=NULL,
3843 * avpkt->size=0 at the end to return the remaining frames.
3845 * @param avctx the codec context
3846 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3847 * If the sample format is planar, each channel plane will
3848 * be the same size, with no padding between channels.
3849 * @param[in,out] frame_size_ptr the output buffer size in bytes
3850 * @param[in] avpkt The input AVPacket containing the input buffer.
3851 * You can create such packet with av_init_packet() and by then setting
3852 * data and size, some decoders might in addition need other fields.
3853 * All decoders are designed to use the least fields possible though.
3854 * @return On error a negative value is returned, otherwise the number of bytes
3855 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3857 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3858 int *frame_size_ptr,
3863 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3865 * Some decoders may support multiple frames in a single AVPacket. Such
3866 * decoders would then just decode the first frame. In this case,
3867 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3868 * the remaining data in order to decode the second frame, etc...
3869 * Even if no frames are returned, the packet needs to be fed to the decoder
3870 * with remaining data until it is completely consumed or an error occurs.
3872 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3873 * larger than the actual read bytes because some optimized bitstream
3874 * readers read 32 or 64 bits at once and could read over the end.
3876 * @note You might have to align the input buffer. The alignment requirements
3877 * depend on the CPU and the decoder.
3879 * @param avctx the codec context
3880 * @param[out] frame The AVFrame in which to store decoded audio samples.
3881 * Decoders request a buffer of a particular size by setting
3882 * AVFrame.nb_samples prior to calling get_buffer(). The
3883 * decoder may, however, only utilize part of the buffer by
3884 * setting AVFrame.nb_samples to a smaller value in the
3886 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3888 * @param[in] avpkt The input AVPacket containing the input buffer.
3889 * At least avpkt->data and avpkt->size should be set. Some
3890 * decoders might also require additional fields to be set.
3891 * @return A negative error code is returned if an error occurred during
3892 * decoding, otherwise the number of bytes consumed from the input
3893 * AVPacket is returned.
3895 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3896 int *got_frame_ptr, const AVPacket *avpkt);
3899 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3900 * Some decoders may support multiple frames in a single AVPacket, such
3901 * decoders would then just decode the first frame.
3903 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3904 * the actual read bytes because some optimized bitstream readers read 32 or 64
3905 * bits at once and could read over the end.
3907 * @warning The end of the input buffer buf should be set to 0 to ensure that
3908 * no overreading happens for damaged MPEG streams.
3910 * @note You might have to align the input buffer avpkt->data.
3911 * The alignment requirements depend on the CPU: on some CPUs it isn't
3912 * necessary at all, on others it won't work at all if not aligned and on others
3913 * it will work but it will have an impact on performance.
3915 * In practice, avpkt->data should have 4 byte alignment at minimum.
3917 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3918 * between input and output, these need to be fed with avpkt->data=NULL,
3919 * avpkt->size=0 at the end to return the remaining frames.
3921 * @param avctx the codec context
3922 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3923 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3924 * allocate memory for the actual bitmap.
3925 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3926 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3927 * decodes and the decoder tells the user once it does not need the data anymore,
3928 * the user app can at this point free/reuse/keep the memory as it sees fit.
3930 * @param[in] avpkt The input AVpacket containing the input buffer.
3931 * You can create such packet with av_init_packet() and by then setting
3932 * data and size, some decoders might in addition need other fields like
3933 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3935 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3936 * @return On error a negative value is returned, otherwise the number of bytes
3937 * used or zero if no frame could be decompressed.
3939 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3940 int *got_picture_ptr,
3941 const AVPacket *avpkt);
3944 * Decode a subtitle message.
3945 * Return a negative value on error, otherwise return the number of bytes used.
3946 * If no subtitle could be decompressed, got_sub_ptr is zero.
3947 * Otherwise, the subtitle is stored in *sub.
3948 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3949 * simplicity, because the performance difference is expect to be negligible
3950 * and reusing a get_buffer written for video codecs would probably perform badly
3951 * due to a potentially very different allocation pattern.
3953 * @param avctx the codec context
3954 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3955 freed with avsubtitle_free if *got_sub_ptr is set.
3956 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3957 * @param[in] avpkt The input AVPacket containing the input buffer.
3959 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3964 * @defgroup lavc_parsing Frame parsing
3968 typedef struct AVCodecParserContext {
3970 struct AVCodecParser *parser;
3971 int64_t frame_offset; /* offset of the current frame */
3972 int64_t cur_offset; /* current offset
3973 (incremented by each av_parser_parse()) */
3974 int64_t next_frame_offset; /* offset of the next frame */
3976 int pict_type; /* XXX: Put it back in AVCodecContext. */
3978 * This field is used for proper frame duration computation in lavf.
3979 * It signals, how much longer the frame duration of the current frame
3980 * is compared to normal frame duration.
3982 * frame_duration = (1 + repeat_pict) * time_base
3984 * It is used by codecs like H.264 to display telecined material.
3986 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3987 int64_t pts; /* pts of the current frame */
3988 int64_t dts; /* dts of the current frame */
3993 int fetch_timestamp;
3995 #define AV_PARSER_PTS_NB 4
3996 int cur_frame_start_index;
3997 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3998 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3999 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4002 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4003 #define PARSER_FLAG_ONCE 0x0002
4004 /// Set if the parser has a valid file offset
4005 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4006 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4008 int64_t offset; ///< byte offset from starting packet start
4009 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4012 * Set by parser to 1 for key frames and 0 for non-key frames.
4013 * It is initialized to -1, so if the parser doesn't set this flag,
4014 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4020 * Time difference in stream time base units from the pts of this
4021 * packet to the point at which the output from the decoder has converged
4022 * independent from the availability of previous frames. That is, the
4023 * frames are virtually identical no matter if decoding started from
4024 * the very first frame or from this keyframe.
4025 * Is AV_NOPTS_VALUE if unknown.
4026 * This field is not the display duration of the current frame.
4027 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4030 * The purpose of this field is to allow seeking in streams that have no
4031 * keyframes in the conventional sense. It corresponds to the
4032 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4033 * essential for some types of subtitle streams to ensure that all
4034 * subtitles are correctly displayed after seeking.
4036 int64_t convergence_duration;
4038 // Timestamp generation support:
4040 * Synchronization point for start of timestamp generation.
4042 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4045 * For example, this corresponds to presence of H.264 buffering period
4051 * Offset of the current timestamp against last timestamp sync point in
4052 * units of AVCodecContext.time_base.
4054 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4055 * contain a valid timestamp offset.
4057 * Note that the timestamp of sync point has usually a nonzero
4058 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4059 * the next frame after timestamp sync point will be usually 1.
4061 * For example, this corresponds to H.264 cpb_removal_delay.
4063 int dts_ref_dts_delta;
4066 * Presentation delay of current frame in units of AVCodecContext.time_base.
4068 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4069 * contain valid non-negative timestamp delta (presentation time of a frame
4070 * must not lie in the past).
4072 * This delay represents the difference between decoding and presentation
4073 * time of the frame.
4075 * For example, this corresponds to H.264 dpb_output_delay.
4080 * Position of the packet in file.
4082 * Analogous to cur_frame_pts/dts
4084 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4087 * Byte position of currently parsed frame in stream.
4092 * Previous frame byte position.
4097 * Duration of the current frame.
4098 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4099 * For all other types, this is in units of AVCodecContext.time_base.
4102 } AVCodecParserContext;
4104 typedef struct AVCodecParser {
4105 int codec_ids[5]; /* several codec IDs are permitted */
4107 int (*parser_init)(AVCodecParserContext *s);
4108 int (*parser_parse)(AVCodecParserContext *s,
4109 AVCodecContext *avctx,
4110 const uint8_t **poutbuf, int *poutbuf_size,
4111 const uint8_t *buf, int buf_size);
4112 void (*parser_close)(AVCodecParserContext *s);
4113 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4114 struct AVCodecParser *next;
4117 AVCodecParser *av_parser_next(AVCodecParser *c);
4119 void av_register_codec_parser(AVCodecParser *parser);
4120 AVCodecParserContext *av_parser_init(int codec_id);
4125 * @param s parser context.
4126 * @param avctx codec context.
4127 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4128 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4129 * @param buf input buffer.
4130 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4131 * @param pts input presentation timestamp.
4132 * @param dts input decoding timestamp.
4133 * @param pos input byte position in stream.
4134 * @return the number of bytes of the input bitstream used.
4139 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4146 * decode_frame(data, size);
4150 int av_parser_parse2(AVCodecParserContext *s,
4151 AVCodecContext *avctx,
4152 uint8_t **poutbuf, int *poutbuf_size,
4153 const uint8_t *buf, int buf_size,
4154 int64_t pts, int64_t dts,
4157 int av_parser_change(AVCodecParserContext *s,
4158 AVCodecContext *avctx,
4159 uint8_t **poutbuf, int *poutbuf_size,
4160 const uint8_t *buf, int buf_size, int keyframe);
4161 void av_parser_close(AVCodecParserContext *s);
4169 * @addtogroup lavc_encoding
4174 * Find a registered encoder with a matching codec ID.
4176 * @param id AVCodecID of the requested encoder
4177 * @return An encoder if one was found, NULL otherwise.
4179 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4182 * Find a registered encoder with the specified name.
4184 * @param name name of the requested encoder
4185 * @return An encoder if one was found, NULL otherwise.
4187 AVCodec *avcodec_find_encoder_by_name(const char *name);
4189 #if FF_API_OLD_ENCODE_AUDIO
4191 * Encode an audio frame from samples into buf.
4193 * @deprecated Use avcodec_encode_audio2 instead.
4195 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4196 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4197 * will know how much space is needed because it depends on the value passed
4198 * in buf_size as described below. In that case a lower value can be used.
4200 * @param avctx the codec context
4201 * @param[out] buf the output buffer
4202 * @param[in] buf_size the output buffer size
4203 * @param[in] samples the input buffer containing the samples
4204 * The number of samples read from this buffer is frame_size*channels,
4205 * both of which are defined in avctx.
4206 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4207 * samples read from samples is equal to:
4208 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4209 * This also implies that av_get_bits_per_sample() must not return 0 for these
4211 * @return On error a negative value is returned, on success zero or the number
4212 * of bytes used to encode the data read from the input buffer.
4214 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4215 uint8_t *buf, int buf_size,
4216 const short *samples);
4220 * Encode a frame of audio.
4222 * Takes input samples from frame and writes the next output packet, if
4223 * available, to avpkt. The output packet does not necessarily contain data for
4224 * the most recent frame, as encoders can delay, split, and combine input frames
4225 * internally as needed.
4227 * @param avctx codec context
4228 * @param avpkt output AVPacket.
4229 * The user can supply an output buffer by setting
4230 * avpkt->data and avpkt->size prior to calling the
4231 * function, but if the size of the user-provided data is not
4232 * large enough, encoding will fail. If avpkt->data and
4233 * avpkt->size are set, avpkt->destruct must also be set. All
4234 * other AVPacket fields will be reset by the encoder using
4235 * av_init_packet(). If avpkt->data is NULL, the encoder will
4236 * allocate it. The encoder will set avpkt->size to the size
4237 * of the output packet.
4239 * If this function fails or produces no output, avpkt will be
4240 * freed using av_free_packet() (i.e. avpkt->destruct will be
4241 * called to free the user supplied buffer).
4242 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4243 * May be NULL when flushing an encoder that has the
4244 * CODEC_CAP_DELAY capability set.
4245 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4246 * can have any number of samples.
4247 * If it is not set, frame->nb_samples must be equal to
4248 * avctx->frame_size for all frames except the last.
4249 * The final frame may be smaller than avctx->frame_size.
4250 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4251 * output packet is non-empty, and to 0 if it is
4252 * empty. If the function returns an error, the
4253 * packet can be assumed to be invalid, and the
4254 * value of got_packet_ptr is undefined and should
4256 * @return 0 on success, negative error code on failure
4258 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4259 const AVFrame *frame, int *got_packet_ptr);
4261 #if FF_API_OLD_ENCODE_VIDEO
4263 * @deprecated use avcodec_encode_video2() instead.
4265 * Encode a video frame from pict into buf.
4266 * The input picture should be
4267 * stored using a specific format, namely avctx.pix_fmt.
4269 * @param avctx the codec context
4270 * @param[out] buf the output buffer for the bitstream of encoded frame
4271 * @param[in] buf_size the size of the output buffer in bytes
4272 * @param[in] pict the input picture to encode
4273 * @return On error a negative value is returned, on success zero or the number
4274 * of bytes used from the output buffer.
4276 attribute_deprecated
4277 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4278 const AVFrame *pict);
4282 * Encode a frame of video.
4284 * Takes input raw video data from frame and writes the next output packet, if
4285 * available, to avpkt. The output packet does not necessarily contain data for
4286 * the most recent frame, as encoders can delay and reorder input frames
4287 * internally as needed.
4289 * @param avctx codec context
4290 * @param avpkt output AVPacket.
4291 * The user can supply an output buffer by setting
4292 * avpkt->data and avpkt->size prior to calling the
4293 * function, but if the size of the user-provided data is not
4294 * large enough, encoding will fail. All other AVPacket fields
4295 * will be reset by the encoder using av_init_packet(). If
4296 * avpkt->data is NULL, the encoder will allocate it.
4297 * The encoder will set avpkt->size to the size of the
4298 * output packet. The returned data (if any) belongs to the
4299 * caller, he is responsible for freeing it.
4301 * If this function fails or produces no output, avpkt will be
4302 * freed using av_free_packet() (i.e. avpkt->destruct will be
4303 * called to free the user supplied buffer).
4304 * @param[in] frame AVFrame containing the raw video data to be encoded.
4305 * May be NULL when flushing an encoder that has the
4306 * CODEC_CAP_DELAY capability set.
4307 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4308 * output packet is non-empty, and to 0 if it is
4309 * empty. If the function returns an error, the
4310 * packet can be assumed to be invalid, and the
4311 * value of got_packet_ptr is undefined and should
4313 * @return 0 on success, negative error code on failure
4315 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4316 const AVFrame *frame, int *got_packet_ptr);
4318 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4319 const AVSubtitle *sub);
4326 #if FF_API_AVCODEC_RESAMPLE
4328 * @defgroup lavc_resample Audio resampling
4330 * @deprecated use libswresample instead
4334 struct ReSampleContext;
4335 struct AVResampleContext;
4337 typedef struct ReSampleContext ReSampleContext;
4340 * Initialize audio resampling context.
4342 * @param output_channels number of output channels
4343 * @param input_channels number of input channels
4344 * @param output_rate output sample rate
4345 * @param input_rate input sample rate
4346 * @param sample_fmt_out requested output sample format
4347 * @param sample_fmt_in input sample format
4348 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4349 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4350 * @param linear if 1 then the used FIR filter will be linearly interpolated
4351 between the 2 closest, if 0 the closest will be used
4352 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4353 * @return allocated ReSampleContext, NULL if error occurred
4355 attribute_deprecated
4356 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4357 int output_rate, int input_rate,
4358 enum AVSampleFormat sample_fmt_out,
4359 enum AVSampleFormat sample_fmt_in,
4360 int filter_length, int log2_phase_count,
4361 int linear, double cutoff);
4363 attribute_deprecated
4364 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4367 * Free resample context.
4369 * @param s a non-NULL pointer to a resample context previously
4370 * created with av_audio_resample_init()
4372 attribute_deprecated
4373 void audio_resample_close(ReSampleContext *s);
4377 * Initialize an audio resampler.
4378 * Note, if either rate is not an integer then simply scale both rates up so they are.
4379 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4380 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4381 * @param linear If 1 then the used FIR filter will be linearly interpolated
4382 between the 2 closest, if 0 the closest will be used
4383 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4385 attribute_deprecated
4386 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4389 * Resample an array of samples using a previously configured context.
4390 * @param src an array of unconsumed samples
4391 * @param consumed the number of samples of src which have been consumed are returned here
4392 * @param src_size the number of unconsumed samples available
4393 * @param dst_size the amount of space in samples available in dst
4394 * @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.
4395 * @return the number of samples written in dst or -1 if an error occurred
4397 attribute_deprecated
4398 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4402 * Compensate samplerate/timestamp drift. The compensation is done by changing
4403 * the resampler parameters, so no audible clicks or similar distortions occur
4404 * @param compensation_distance distance in output samples over which the compensation should be performed
4405 * @param sample_delta number of output samples which should be output less
4407 * example: av_resample_compensate(c, 10, 500)
4408 * here instead of 510 samples only 500 samples would be output
4410 * note, due to rounding the actual compensation might be slightly different,
4411 * especially if the compensation_distance is large and the in_rate used during init is small
4413 attribute_deprecated
4414 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4415 attribute_deprecated
4416 void av_resample_close(struct AVResampleContext *c);
4424 * @addtogroup lavc_picture
4429 * Allocate memory for a picture. Call avpicture_free() to free it.
4431 * @see avpicture_fill()
4433 * @param picture the picture to be filled in
4434 * @param pix_fmt the format of the picture
4435 * @param width the width of the picture
4436 * @param height the height of the picture
4437 * @return zero if successful, a negative value if not
4439 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
4442 * Free a picture previously allocated by avpicture_alloc().
4443 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4446 * @param picture the AVPicture to be freed
4448 void avpicture_free(AVPicture *picture);
4451 * Fill in the AVPicture fields, always assume a linesize alignment of
4454 * @see av_image_fill_arrays()
4456 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4457 enum PixelFormat pix_fmt, int width, int height);
4460 * Copy pixel data from an AVPicture into a buffer, always assume a
4461 * linesize alignment of 1.
4463 * @see av_image_copy_to_buffer()
4465 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
4466 unsigned char *dest, int dest_size);
4469 * Calculate the size in bytes that a picture of the given width and height
4470 * would occupy if stored in the given picture format.
4471 * Always assume a linesize alignment of 1.
4473 * @see av_image_get_buffer_size().
4475 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
4478 * deinterlace - if not supported return -1
4480 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4481 enum PixelFormat pix_fmt, int width, int height);
4483 * Copy image src to dst. Wraps av_image_copy().
4485 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4486 enum PixelFormat pix_fmt, int width, int height);
4489 * Crop image top and left side.
4491 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4492 enum PixelFormat pix_fmt, int top_band, int left_band);
4497 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4498 int padtop, int padbottom, int padleft, int padright, int *color);
4505 * @defgroup lavc_misc Utility functions
4508 * Miscellaneous utility functions related to both encoding and decoding
4514 * @defgroup lavc_misc_pixfmt Pixel formats
4516 * Functions for working with pixel formats.
4520 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
4523 * Return a value representing the fourCC code associated to the
4524 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4527 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
4529 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4530 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4531 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4532 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4533 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4534 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4537 * Compute what kind of losses will occur when converting from one specific
4538 * pixel format to another.
4539 * When converting from one pixel format to another, information loss may occur.
4540 * For example, when converting from RGB24 to GRAY, the color information will
4541 * be lost. Similarly, other losses occur when converting from some formats to
4542 * other formats. These losses can involve loss of chroma, but also loss of
4543 * resolution, loss of color depth, loss due to the color space conversion, loss
4544 * of the alpha bits or loss due to color quantization.
4545 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4546 * which will occur when converting from one pixel format to another.
4548 * @param[in] dst_pix_fmt destination pixel format
4549 * @param[in] src_pix_fmt source pixel format
4550 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4551 * @return Combination of flags informing you what kind of losses will occur
4552 * (maximum loss for an invalid dst_pix_fmt).
4554 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
4557 #if FF_API_FIND_BEST_PIX_FMT
4559 * @deprecated use avcodec_find_best_pix_fmt_of_2() instead.
4561 * Find the best pixel format to convert to given a certain source pixel
4562 * format. When converting from one pixel format to another, information loss
4563 * may occur. For example, when converting from RGB24 to GRAY, the color
4564 * information will be lost. Similarly, other losses occur when converting from
4565 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4566 * the given pixel formats should be used to suffer the least amount of loss.
4567 * The pixel formats from which it chooses one, are determined by the
4568 * pix_fmt_mask parameter.
4570 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
4573 * src_pix_fmt = PIX_FMT_YUV420P;
4574 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
4575 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4578 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4579 * @param[in] src_pix_fmt source pixel format
4580 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4581 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4582 * @return The best pixel format to convert to or -1 if none was found.
4584 attribute_deprecated
4585 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
4586 int has_alpha, int *loss_ptr);
4587 #endif /* FF_API_FIND_BEST_PIX_FMT */
4590 * Find the best pixel format to convert to given a certain source pixel
4591 * format. When converting from one pixel format to another, information loss
4592 * may occur. For example, when converting from RGB24 to GRAY, the color
4593 * information will be lost. Similarly, other losses occur when converting from
4594 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4595 * the given pixel formats should be used to suffer the least amount of loss.
4596 * The pixel formats from which it chooses one, are determined by the
4597 * pix_fmt_list parameter.
4600 * @param[in] pix_fmt_list PIX_FMT_NONE terminated array of pixel formats to choose from
4601 * @param[in] src_pix_fmt source pixel format
4602 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4603 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4604 * @return The best pixel format to convert to or -1 if none was found.
4606 enum PixelFormat avcodec_find_best_pix_fmt_of_list(enum PixelFormat *pix_fmt_list,
4607 enum PixelFormat src_pix_fmt,
4608 int has_alpha, int *loss_ptr);
4611 * Find the best pixel format to convert to given a certain source pixel
4612 * format and a selection of two destination pixel formats. When converting from
4613 * one pixel format to another, information loss may occur. For example, when converting
4614 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4615 * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4616 * the given pixel formats should be used to suffer the least amount of loss.
4618 * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
4622 * src_pix_fmt = PIX_FMT_YUV420P;
4623 * dst_pix_fmt1= PIX_FMT_RGB24;
4624 * dst_pix_fmt2= PIX_FMT_GRAY8;
4625 * dst_pix_fmt3= PIX_FMT_RGB8;
4626 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4627 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4628 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4631 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4632 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4633 * @param[in] src_pix_fmt Source pixel format
4634 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4635 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4636 * NULL or value of zero means we care about all losses. Out: the loss
4637 * that occurs when converting from src to selected dst pixel format.
4638 * @return The best pixel format to convert to or -1 if none was found.
4640 enum PixelFormat avcodec_find_best_pix_fmt_of_2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
4641 enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4643 attribute_deprecated
4644 #if AV_HAVE_INCOMPATIBLE_FORK_ABI
4645 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat *pix_fmt_list,
4646 enum PixelFormat src_pix_fmt,
4647 int has_alpha, int *loss_ptr);
4649 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
4650 enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4654 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4660 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4663 * Put a string representing the codec tag codec_tag in buf.
4665 * @param buf_size size in bytes of buf
4666 * @return the length of the string that would have been generated if
4667 * enough space had been available, excluding the trailing null
4669 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4671 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4674 * Return a name for the specified profile, if available.
4676 * @param codec the codec that is searched for the given profile
4677 * @param profile the profile value for which a name is requested
4678 * @return A name for the profile if found, NULL otherwise.
4680 const char *av_get_profile_name(const AVCodec *codec, int profile);
4682 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4683 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4684 //FIXME func typedef
4687 * Fill audio frame data and linesize.
4688 * AVFrame extended_data channel pointers are allocated if necessary for
4691 * @param frame the AVFrame
4692 * frame->nb_samples must be set prior to calling the
4693 * function. This function fills in frame->data,
4694 * frame->extended_data, frame->linesize[0].
4695 * @param nb_channels channel count
4696 * @param sample_fmt sample format
4697 * @param buf buffer to use for frame data
4698 * @param buf_size size of buffer
4699 * @param align plane size sample alignment (0 = default)
4700 * @return 0 on success, negative error code on failure
4702 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4703 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4704 int buf_size, int align);
4707 * Flush buffers, should be called when seeking or when switching to a different stream.
4709 void avcodec_flush_buffers(AVCodecContext *avctx);
4711 void avcodec_default_free_buffers(AVCodecContext *s);
4714 * Return codec bits per sample.
4716 * @param[in] codec_id the codec
4717 * @return Number of bits per sample or zero if unknown for the given codec.
4719 int av_get_bits_per_sample(enum AVCodecID codec_id);
4722 * Return the PCM codec associated with a sample format.
4723 * @param be endianness, 0 for little, 1 for big,
4724 * -1 (or anything else) for native
4725 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4727 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4730 * Return codec bits per sample.
4731 * Only return non-zero if the bits per sample is exactly correct, not an
4734 * @param[in] codec_id the codec
4735 * @return Number of bits per sample or zero if unknown for the given codec.
4737 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4740 * Return audio frame duration.
4742 * @param avctx codec context
4743 * @param frame_bytes size of the frame, or 0 if unknown
4744 * @return frame duration, in samples, if known. 0 if not able to
4747 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4750 typedef struct AVBitStreamFilterContext {
4752 struct AVBitStreamFilter *filter;
4753 AVCodecParserContext *parser;
4754 struct AVBitStreamFilterContext *next;
4755 } AVBitStreamFilterContext;
4758 typedef struct AVBitStreamFilter {
4761 int (*filter)(AVBitStreamFilterContext *bsfc,
4762 AVCodecContext *avctx, const char *args,
4763 uint8_t **poutbuf, int *poutbuf_size,
4764 const uint8_t *buf, int buf_size, int keyframe);
4765 void (*close)(AVBitStreamFilterContext *bsfc);
4766 struct AVBitStreamFilter *next;
4767 } AVBitStreamFilter;
4769 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4770 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4771 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4772 AVCodecContext *avctx, const char *args,
4773 uint8_t **poutbuf, int *poutbuf_size,
4774 const uint8_t *buf, int buf_size, int keyframe);
4775 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4777 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4782 * Reallocate the given block if it is not large enough, otherwise do nothing.
4786 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4789 * Allocate a buffer, reusing the given one if large enough.
4791 * Contrary to av_fast_realloc the current buffer contents might not be
4792 * preserved and on error the old buffer is freed, thus no special
4793 * handling to avoid memleaks is necessary.
4795 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4796 * @param size size of the buffer *ptr points to
4797 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4798 * *size 0 if an error occurred.
4800 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4803 * Same behaviour av_fast_malloc but the buffer has additional
4804 * FF_INPUT_PADDING_SIZE at the end which will will always be 0.
4806 * In addition the whole buffer will initially and after resizes
4807 * be 0-initialized so that no uninitialized data will ever appear.
4809 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4812 * Same behaviour av_fast_padded_malloc except that buffer will always
4813 * be 0-initialized after call.
4815 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4818 * Encode extradata length to a buffer. Used by xiph codecs.
4820 * @param s buffer to write to; must be at least (v/255+1) bytes long
4821 * @param v size of extradata in bytes
4822 * @return number of bytes written to the buffer.
4824 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4827 * Log a generic warning message about a missing feature. This function is
4828 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4829 * only, and would normally not be used by applications.
4830 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4831 * a pointer to an AVClass struct
4832 * @param[in] feature string containing the name of the missing feature
4833 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4834 * If want_sample is non-zero, additional verbage will be added to the log
4835 * message which tells the user how to report samples to the development
4838 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4841 * Log a generic warning message asking for a sample. This function is
4842 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4843 * only, and would normally not be used by applications.
4844 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4845 * a pointer to an AVClass struct
4846 * @param[in] msg string containing an optional message, or NULL if no message
4848 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4851 * Register the hardware accelerator hwaccel.
4853 void av_register_hwaccel(AVHWAccel *hwaccel);
4856 * If hwaccel is NULL, returns the first registered hardware accelerator,
4857 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4858 * after hwaccel, or NULL if hwaccel is the last one.
4860 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4864 * Lock operation used by lockmgr
4867 AV_LOCK_CREATE, ///< Create a mutex
4868 AV_LOCK_OBTAIN, ///< Lock the mutex
4869 AV_LOCK_RELEASE, ///< Unlock the mutex
4870 AV_LOCK_DESTROY, ///< Free mutex resources
4874 * Register a user provided lock manager supporting the operations
4875 * specified by AVLockOp. mutex points to a (void *) where the
4876 * lockmgr should store/get a pointer to a user allocated mutex. It's
4877 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4879 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4880 * callback during the call to av_lockmgr_register().
4881 * Thus, the application must be prepared to handle that.
4882 * If cb is set to NULL the lockmgr will be unregistered.
4883 * Also note that during unregistration the previously registered
4884 * lockmgr callback may also be invoked.
4886 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4889 * Get the type of the given codec.
4891 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4894 * Get the name of a codec.
4895 * @return a static string identifying the codec; never NULL
4897 const char *avcodec_get_name(enum AVCodecID id);
4900 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4901 * with no corresponding avcodec_close()), 0 otherwise.
4903 int avcodec_is_open(AVCodecContext *s);
4906 * @return a non-zero number if codec is an encoder, zero otherwise
4908 int av_codec_is_encoder(const AVCodec *codec);
4911 * @return a non-zero number if codec is a decoder, zero otherwise
4913 int av_codec_is_decoder(const AVCodec *codec);
4916 * @return descriptor for given codec ID or NULL if no descriptor exists.
4918 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4921 * Iterate over all codec descriptors known to libavcodec.
4923 * @param prev previous descriptor. NULL to get the first descriptor.
4925 * @return next descriptor or NULL after the last descriptor
4927 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4930 * @return codec descriptor with the given name or NULL if no such descriptor
4933 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4939 #endif /* AVCODEC_AVCODEC_H */