2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav 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 * Libav 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 Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/dict.h"
37 #include "libavutil/frame.h"
38 #include "libavutil/log.h"
39 #include "libavutil/pixfmt.h"
40 #include "libavutil/rational.h"
45 * @defgroup libavc Encoding/Decoding Library
48 * @defgroup lavc_decoding Decoding
52 * @defgroup lavc_encoding Encoding
56 * @defgroup lavc_codec Codecs
58 * @defgroup lavc_codec_native Native Codecs
61 * @defgroup lavc_codec_wrappers External library wrappers
64 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
68 * @defgroup lavc_internal Internal
76 * @defgroup lavc_core Core functions/structures.
79 * Basic definitions, functions for querying libavcodec capabilities,
80 * allocating core structures, etc.
86 * Identify the syntax and semantics of the bitstream.
87 * The principle is roughly:
88 * Two decoders with the same ID can decode the same streams.
89 * Two encoders with the same ID can encode compatible streams.
90 * There may be slight deviations from the principle due to implementation
93 * If you add a codec ID to this list, add it so that
94 * 1. no value of a existing codec ID changes (that would break ABI),
95 * 2. it is as close as possible to similar codecs.
97 * After adding new codec IDs, do not forget to add an entry to the codec
98 * descriptor list and bump libavcodec minor version.
104 AV_CODEC_ID_MPEG1VIDEO,
105 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
106 AV_CODEC_ID_MPEG2VIDEO_XVMC,
117 AV_CODEC_ID_RAWVIDEO,
118 AV_CODEC_ID_MSMPEG4V1,
119 AV_CODEC_ID_MSMPEG4V2,
120 AV_CODEC_ID_MSMPEG4V3,
143 AV_CODEC_ID_INTERPLAY_VIDEO,
150 AV_CODEC_ID_MSVIDEO1,
155 AV_CODEC_ID_TRUEMOTION1,
156 AV_CODEC_ID_VMDVIDEO,
181 AV_CODEC_ID_TRUEMOTION2,
187 AV_CODEC_ID_SMACKVIDEO,
192 AV_CODEC_ID_JPEG2000,
198 AV_CODEC_ID_DSICINVIDEO,
199 AV_CODEC_ID_TIERTEXSEQVIDEO,
207 AV_CODEC_ID_BETHSOFTVID,
219 AV_CODEC_ID_ESCAPE124,
223 AV_CODEC_ID_MOTIONPIXELS,
235 AV_CODEC_ID_FLASHSV2,
236 AV_CODEC_ID_CDGRAPHICS,
239 AV_CODEC_ID_BINKVIDEO,
240 AV_CODEC_ID_IFF_ILBM,
241 AV_CODEC_ID_IFF_BYTERUN1,
247 AV_CODEC_ID_A64_MULTI,
248 AV_CODEC_ID_A64_MULTI5,
251 AV_CODEC_ID_LAGARITH,
255 AV_CODEC_ID_WMV3IMAGE,
256 AV_CODEC_ID_VC1IMAGE,
258 AV_CODEC_ID_BMV_VIDEO,
265 AV_CODEC_ID_ZEROCODEC,
274 AV_CODEC_ID_ESCAPE130,
277 AV_CODEC_ID_HNM4_VIDEO,
280 /* various PCM "codecs" */
281 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
282 AV_CODEC_ID_PCM_S16LE = 0x10000,
283 AV_CODEC_ID_PCM_S16BE,
284 AV_CODEC_ID_PCM_U16LE,
285 AV_CODEC_ID_PCM_U16BE,
288 AV_CODEC_ID_PCM_MULAW,
289 AV_CODEC_ID_PCM_ALAW,
290 AV_CODEC_ID_PCM_S32LE,
291 AV_CODEC_ID_PCM_S32BE,
292 AV_CODEC_ID_PCM_U32LE,
293 AV_CODEC_ID_PCM_U32BE,
294 AV_CODEC_ID_PCM_S24LE,
295 AV_CODEC_ID_PCM_S24BE,
296 AV_CODEC_ID_PCM_U24LE,
297 AV_CODEC_ID_PCM_U24BE,
298 AV_CODEC_ID_PCM_S24DAUD,
299 AV_CODEC_ID_PCM_ZORK,
300 AV_CODEC_ID_PCM_S16LE_PLANAR,
302 AV_CODEC_ID_PCM_F32BE,
303 AV_CODEC_ID_PCM_F32LE,
304 AV_CODEC_ID_PCM_F64BE,
305 AV_CODEC_ID_PCM_F64LE,
306 AV_CODEC_ID_PCM_BLURAY,
309 AV_CODEC_ID_PCM_S8_PLANAR,
310 AV_CODEC_ID_PCM_S24LE_PLANAR,
311 AV_CODEC_ID_PCM_S32LE_PLANAR,
313 /* various ADPCM codecs */
314 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
315 AV_CODEC_ID_ADPCM_IMA_WAV,
316 AV_CODEC_ID_ADPCM_IMA_DK3,
317 AV_CODEC_ID_ADPCM_IMA_DK4,
318 AV_CODEC_ID_ADPCM_IMA_WS,
319 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
320 AV_CODEC_ID_ADPCM_MS,
321 AV_CODEC_ID_ADPCM_4XM,
322 AV_CODEC_ID_ADPCM_XA,
323 AV_CODEC_ID_ADPCM_ADX,
324 AV_CODEC_ID_ADPCM_EA,
325 AV_CODEC_ID_ADPCM_G726,
326 AV_CODEC_ID_ADPCM_CT,
327 AV_CODEC_ID_ADPCM_SWF,
328 AV_CODEC_ID_ADPCM_YAMAHA,
329 AV_CODEC_ID_ADPCM_SBPRO_4,
330 AV_CODEC_ID_ADPCM_SBPRO_3,
331 AV_CODEC_ID_ADPCM_SBPRO_2,
332 AV_CODEC_ID_ADPCM_THP,
333 AV_CODEC_ID_ADPCM_IMA_AMV,
334 AV_CODEC_ID_ADPCM_EA_R1,
335 AV_CODEC_ID_ADPCM_EA_R3,
336 AV_CODEC_ID_ADPCM_EA_R2,
337 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
338 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
339 AV_CODEC_ID_ADPCM_EA_XAS,
340 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
341 AV_CODEC_ID_ADPCM_IMA_ISS,
342 AV_CODEC_ID_ADPCM_G722,
343 AV_CODEC_ID_ADPCM_IMA_APC,
346 AV_CODEC_ID_AMR_NB = 0x12000,
349 /* RealAudio codecs*/
350 AV_CODEC_ID_RA_144 = 0x13000,
353 /* various DPCM codecs */
354 AV_CODEC_ID_ROQ_DPCM = 0x14000,
355 AV_CODEC_ID_INTERPLAY_DPCM,
356 AV_CODEC_ID_XAN_DPCM,
357 AV_CODEC_ID_SOL_DPCM,
360 AV_CODEC_ID_MP2 = 0x15000,
361 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
371 AV_CODEC_ID_VMDAUDIO,
377 AV_CODEC_ID_WESTWOOD_SND1,
378 AV_CODEC_ID_GSM, ///< as in Berlin toast format
381 AV_CODEC_ID_TRUESPEECH,
383 AV_CODEC_ID_SMACKAUDIO,
386 AV_CODEC_ID_DSICINAUDIO,
388 AV_CODEC_ID_MUSEPACK7,
390 AV_CODEC_ID_GSM_MS, /* as found in WAV */
396 AV_CODEC_ID_NELLYMOSER,
397 AV_CODEC_ID_MUSEPACK8,
399 AV_CODEC_ID_WMAVOICE,
401 AV_CODEC_ID_WMALOSSLESS,
410 AV_CODEC_ID_BINKAUDIO_RDFT,
411 AV_CODEC_ID_BINKAUDIO_DCT,
412 AV_CODEC_ID_AAC_LATM,
417 AV_CODEC_ID_8SVX_EXP,
418 AV_CODEC_ID_8SVX_FIB,
419 AV_CODEC_ID_BMV_AUDIO,
424 AV_CODEC_ID_COMFORT_NOISE,
426 AV_CODEC_ID_METASOUND,
428 /* subtitle codecs */
429 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
430 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
431 AV_CODEC_ID_DVB_SUBTITLE,
432 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
435 AV_CODEC_ID_MOV_TEXT,
436 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
437 AV_CODEC_ID_DVB_TELETEXT,
440 /* other specific kind of codecs (generally used for attachments) */
441 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
442 AV_CODEC_ID_TTF = 0x18000,
444 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
446 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
447 * stream (only used by libavformat) */
448 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
449 * stream (only used by libavformat) */
450 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
454 * This struct describes the properties of a single codec described by an
456 * @see avcodec_get_descriptor()
458 typedef struct AVCodecDescriptor {
460 enum AVMediaType type;
462 * Name of the codec described by this descriptor. It is non-empty and
463 * unique for each codec descriptor. It should contain alphanumeric
464 * characters and '_' only.
468 * A more descriptive name for this codec. May be NULL.
470 const char *long_name;
472 * Codec properties, a combination of AV_CODEC_PROP_* flags.
478 * Codec uses only intra compression.
481 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
483 * Codec supports lossy compression. Audio and video codecs only.
484 * @note a codec may support both lossy and lossless
487 #define AV_CODEC_PROP_LOSSY (1 << 1)
489 * Codec supports lossless compression. Audio and video codecs only.
491 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
494 * @ingroup lavc_decoding
495 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
496 * This is mainly needed because some optimized bitstream readers read
497 * 32 or 64 bit at once and could read over the end.<br>
498 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
499 * MPEG bitstreams could cause overread and segfault.
501 #define FF_INPUT_BUFFER_PADDING_SIZE 8
504 * @ingroup lavc_encoding
505 * minimum encoding buffer size
506 * Used to avoid some checks during header writing.
508 #define FF_MIN_BUFFER_SIZE 16384
512 * @ingroup lavc_encoding
513 * motion estimation type.
516 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
520 ME_EPZS, ///< enhanced predictive zonal search
521 ME_X1, ///< reserved for experiments
522 ME_HEX, ///< hexagon based search
523 ME_UMH, ///< uneven multi-hexagon search
524 ME_TESA, ///< transformed exhaustive search algorithm
528 * @ingroup lavc_decoding
531 /* We leave some space between them for extensions (drop some
532 * keyframes for intra-only or drop just some bidir frames). */
533 AVDISCARD_NONE =-16, ///< discard nothing
534 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
535 AVDISCARD_NONREF = 8, ///< discard all non reference
536 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
537 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
538 AVDISCARD_ALL = 48, ///< discard all
541 enum AVColorPrimaries{
542 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
543 AVCOL_PRI_UNSPECIFIED = 2,
544 AVCOL_PRI_BT470M = 4,
545 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
546 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
547 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
549 AVCOL_PRI_BT2020 = 9, ///< ITU-R BT2020
550 AVCOL_PRI_NB , ///< Not part of ABI
553 enum AVColorTransferCharacteristic{
554 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
555 AVCOL_TRC_UNSPECIFIED = 2,
556 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
557 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
558 AVCOL_TRC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 or 625 / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC
559 AVCOL_TRC_SMPTE240M = 7,
560 AVCOL_TRC_LINEAR = 8, ///< "Linear transfer characteristics"
561 AVCOL_TRC_LOG = 9, ///< "Logarithmic transfer characteristic (100:1 range)"
562 AVCOL_TRC_LOG_SQRT = 10, ///< "Logarithmic transfer characteristic (100 * Sqrt( 10 ) : 1 range)"
563 AVCOL_TRC_IEC61966_2_4 = 11, ///< IEC 61966-2-4
564 AVCOL_TRC_BT1361_ECG = 12, ///< ITU-R BT1361 Extended Colour Gamut
565 AVCOL_TRC_IEC61966_2_1 = 13, ///< IEC 61966-2-1 (sRGB or sYCC)
566 AVCOL_TRC_BT2020_10 = 14, ///< ITU-R BT2020 for 10 bit system
567 AVCOL_TRC_BT2020_12 = 15, ///< ITU-R BT2020 for 12 bit system
568 AVCOL_TRC_NB , ///< Not part of ABI
573 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
574 AVCOL_SPC_UNSPECIFIED = 2,
576 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
577 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
578 AVCOL_SPC_SMPTE240M = 7,
579 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
580 AVCOL_SPC_BT2020_NCL = 9, ///< ITU-R BT2020 non-constant luminance system
581 AVCOL_SPC_BT2020_CL = 10, ///< ITU-R BT2020 constant luminance system
582 AVCOL_SPC_NB , ///< Not part of ABI
586 AVCOL_RANGE_UNSPECIFIED = 0,
587 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
588 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
589 AVCOL_RANGE_NB , ///< Not part of ABI
593 * X X 3 4 X X are luma samples,
594 * 1 2 1-6 are possible chroma positions
595 * X X 5 6 X 0 is undefined/unknown position
597 enum AVChromaLocation{
598 AVCHROMA_LOC_UNSPECIFIED = 0,
599 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
600 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
601 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
602 AVCHROMA_LOC_TOP = 4,
603 AVCHROMA_LOC_BOTTOMLEFT = 5,
604 AVCHROMA_LOC_BOTTOM = 6,
605 AVCHROMA_LOC_NB , ///< Not part of ABI
608 enum AVAudioServiceType {
609 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
610 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
611 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
612 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
613 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
614 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
615 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
616 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
617 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
618 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
622 * @ingroup lavc_encoding
624 typedef struct RcOverride{
627 int qscale; // If this is 0 then quality_factor will be used instead.
628 float quality_factor;
631 #define FF_MAX_B_FRAMES 16
634 These flags can be passed in AVCodecContext.flags before initialization.
635 Note: Not everything is supported yet.
639 * Allow decoders to produce frames with data planes that are not aligned
640 * to CPU requirements (e.g. due to cropping).
642 #define CODEC_FLAG_UNALIGNED 0x0001
643 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
644 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
645 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
646 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
647 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
648 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
650 * The parent program guarantees that the input for B-frames containing
651 * streams is not written to for at least s->max_b_frames+1 frames, if
652 * this is not set the input will be copied.
654 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
655 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
656 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
657 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
658 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
659 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
660 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
661 location instead of only at frame boundaries. */
662 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
663 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
664 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
665 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
666 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
667 /* Fx : Flag for h263+ extra options */
668 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
669 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
670 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
671 #define CODEC_FLAG_CLOSED_GOP 0x80000000
672 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
673 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
674 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
675 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
677 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
679 /* Unsupported options :
680 * Syntax Arithmetic coding (SAC)
681 * Reference Picture Selection
682 * Independent Segment Decoding */
684 /* codec capabilities */
686 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
688 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
689 * If not set, it might not use get_buffer() at all or use operations that
690 * assume the buffer was allocated by avcodec_default_get_buffer.
692 #define CODEC_CAP_DR1 0x0002
693 #define CODEC_CAP_TRUNCATED 0x0008
694 /* Codec can export data for HW decoding (XvMC). */
695 #define CODEC_CAP_HWACCEL 0x0010
697 * Encoder or decoder requires flushing with NULL input at the end in order to
698 * give the complete and correct output.
700 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
701 * with NULL data. The user can still send NULL data to the public encode
702 * or decode function, but libavcodec will not pass it along to the codec
703 * unless this flag is set.
706 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
707 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
711 * The encoder needs to be fed with NULL data at the end of encoding until the
712 * encoder no longer returns data.
714 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
715 * flag also means that the encoder must set the pts and duration for
716 * each output packet. If this flag is not set, the pts and duration will
717 * be determined by libavcodec from the input frame.
719 #define CODEC_CAP_DELAY 0x0020
721 * Codec can be fed a final frame with a smaller size.
722 * This can be used to prevent truncation of the last audio samples.
724 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
727 * Codec can export data for HW decoding (VDPAU).
729 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
732 * Codec can output multiple frames per AVPacket
733 * Normally demuxers return one frame at a time, demuxers which do not do
734 * are connected to a parser to split what they return into proper frames.
735 * This flag is reserved to the very rare category of codecs which have a
736 * bitstream that cannot be split into frames without timeconsuming
737 * operations like full decoding. Demuxers carring such bitstreams thus
738 * may return multiple frames in a packet. This has many disadvantages like
739 * prohibiting stream copy in many cases thus it should only be considered
742 #define CODEC_CAP_SUBFRAMES 0x0100
744 * Codec is experimental and is thus avoided in favor of non experimental
747 #define CODEC_CAP_EXPERIMENTAL 0x0200
749 * Codec should fill in channel configuration and samplerate instead of container
751 #define CODEC_CAP_CHANNEL_CONF 0x0400
753 * Codec is able to deal with negative linesizes
755 #define CODEC_CAP_NEG_LINESIZES 0x0800
757 * Codec supports frame-level multithreading.
759 #define CODEC_CAP_FRAME_THREADS 0x1000
761 * Codec supports slice-based (or partition-based) multithreading.
763 #define CODEC_CAP_SLICE_THREADS 0x2000
765 * Codec supports changed parameters at any point.
767 #define CODEC_CAP_PARAM_CHANGE 0x4000
769 * Codec supports avctx->thread_count == 0 (auto).
771 #define CODEC_CAP_AUTO_THREADS 0x8000
773 * Audio encoder supports receiving a different number of samples in each call.
775 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
777 //The following defines may change, don't expect compatibility if you use them.
778 #define MB_TYPE_INTRA4x4 0x0001
779 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
780 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
781 #define MB_TYPE_16x16 0x0008
782 #define MB_TYPE_16x8 0x0010
783 #define MB_TYPE_8x16 0x0020
784 #define MB_TYPE_8x8 0x0040
785 #define MB_TYPE_INTERLACED 0x0080
786 #define MB_TYPE_DIRECT2 0x0100 //FIXME
787 #define MB_TYPE_ACPRED 0x0200
788 #define MB_TYPE_GMC 0x0400
789 #define MB_TYPE_SKIP 0x0800
790 #define MB_TYPE_P0L0 0x1000
791 #define MB_TYPE_P1L0 0x2000
792 #define MB_TYPE_P0L1 0x4000
793 #define MB_TYPE_P1L1 0x8000
794 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
795 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
796 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
797 #define MB_TYPE_QUANT 0x00010000
798 #define MB_TYPE_CBP 0x00020000
799 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
803 * This specifies the area which should be displayed.
804 * Note there may be multiple such areas for one frame.
806 typedef struct AVPanScan{
809 * - encoding: Set by user.
810 * - decoding: Set by libavcodec.
815 * width and height in 1/16 pel
816 * - encoding: Set by user.
817 * - decoding: Set by libavcodec.
823 * position of the top left corner in 1/16 pel for up to 3 fields/frames
824 * - encoding: Set by user.
825 * - decoding: Set by libavcodec.
827 int16_t position[3][2];
830 #define FF_QSCALE_TYPE_MPEG1 0
831 #define FF_QSCALE_TYPE_MPEG2 1
832 #define FF_QSCALE_TYPE_H264 2
833 #define FF_QSCALE_TYPE_VP56 3
835 #if FF_API_GET_BUFFER
836 #define FF_BUFFER_TYPE_INTERNAL 1
837 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
838 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
839 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
841 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
842 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
843 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
844 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
848 * The decoder will keep a reference to the frame and may reuse it later.
850 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
853 * @defgroup lavc_packet AVPacket
855 * Types and functions for working with AVPacket.
858 enum AVPacketSideDataType {
860 AV_PKT_DATA_NEW_EXTRADATA,
863 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
866 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
867 * s32le channel_count
868 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
869 * u64le channel_layout
870 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
872 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
877 AV_PKT_DATA_PARAM_CHANGE,
880 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
881 * structures with info about macroblocks relevant to splitting the
882 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
883 * That is, it does not necessarily contain info about all macroblocks,
884 * as long as the distance between macroblocks in the info is smaller
885 * than the target payload size.
886 * Each MB info structure is 12 bytes, and is laid out as follows:
888 * u32le bit offset from the start of the packet
889 * u8 current quantizer at the start of the macroblock
891 * u16le macroblock address within the GOB
892 * u8 horizontal MV predictor
893 * u8 vertical MV predictor
894 * u8 horizontal MV predictor for block number 3
895 * u8 vertical MV predictor for block number 3
898 AV_PKT_DATA_H263_MB_INFO,
902 * This structure stores compressed data. It is typically exported by demuxers
903 * and then passed as input to decoders, or received as output from encoders and
904 * then passed to muxers.
906 * For video, it should typically contain one compressed frame. For audio it may
907 * contain several compressed frames.
909 * AVPacket is one of the few structs in Libav, whose size is a part of public
910 * ABI. Thus it may be allocated on stack and no new fields can be added to it
911 * without libavcodec and libavformat major bump.
913 * The semantics of data ownership depends on the buf or destruct (deprecated)
914 * fields. If either is set, the packet data is dynamically allocated and is
915 * valid indefinitely until av_free_packet() is called (which in turn calls
916 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
917 * the packet data is typically backed by some static buffer somewhere and is
918 * only valid for a limited time (e.g. until the next read call when demuxing).
920 * The side data is always allocated with av_malloc() and is freed in
923 typedef struct AVPacket {
925 * A reference to the reference-counted buffer where the packet data is
927 * May be NULL, then the packet data is not reference-counted.
931 * Presentation timestamp in AVStream->time_base units; the time at which
932 * the decompressed packet will be presented to the user.
933 * Can be AV_NOPTS_VALUE if it is not stored in the file.
934 * pts MUST be larger or equal to dts as presentation cannot happen before
935 * decompression, unless one wants to view hex dumps. Some formats misuse
936 * the terms dts and pts/cts to mean something different. Such timestamps
937 * must be converted to true pts/dts before they are stored in AVPacket.
941 * Decompression timestamp in AVStream->time_base units; the time at which
942 * the packet is decompressed.
943 * Can be AV_NOPTS_VALUE if it is not stored in the file.
950 * A combination of AV_PKT_FLAG values
954 * Additional packet data that can be provided by the container.
955 * Packet can contain several types of side information.
960 enum AVPacketSideDataType type;
965 * Duration of this packet in AVStream->time_base units, 0 if unknown.
966 * Equals next_pts - this_pts in presentation order.
969 #if FF_API_DESTRUCT_PACKET
971 void (*destruct)(struct AVPacket *);
975 int64_t pos; ///< byte position in stream, -1 if unknown
978 * Time difference in AVStream->time_base units from the pts of this
979 * packet to the point at which the output from the decoder has converged
980 * independent from the availability of previous frames. That is, the
981 * frames are virtually identical no matter if decoding started from
982 * the very first frame or from this keyframe.
983 * Is AV_NOPTS_VALUE if unknown.
984 * This field is not the display duration of the current packet.
985 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
988 * The purpose of this field is to allow seeking in streams that have no
989 * keyframes in the conventional sense. It corresponds to the
990 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
991 * essential for some types of subtitle streams to ensure that all
992 * subtitles are correctly displayed after seeking.
994 int64_t convergence_duration;
996 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
997 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
999 enum AVSideDataParamChangeFlags {
1000 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1001 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1002 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1003 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1009 struct AVCodecInternal;
1013 AV_FIELD_PROGRESSIVE,
1014 AV_FIELD_TT, //< Top coded_first, top displayed first
1015 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1016 AV_FIELD_TB, //< Top coded first, bottom displayed first
1017 AV_FIELD_BT, //< Bottom coded first, top displayed first
1021 * main external API structure.
1022 * New fields can be added to the end with minor version bumps.
1023 * Removal, reordering and changes to existing fields require a major
1025 * sizeof(AVCodecContext) must not be used outside libav*.
1027 typedef struct AVCodecContext {
1029 * information on struct for av_log
1030 * - set by avcodec_alloc_context3
1032 const AVClass *av_class;
1033 int log_level_offset;
1035 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1036 const struct AVCodec *codec;
1037 char codec_name[32];
1038 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1041 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1042 * This is used to work around some encoder bugs.
1043 * A demuxer should set this to what is stored in the field used to identify the codec.
1044 * If there are multiple such fields in a container then the demuxer should choose the one
1045 * which maximizes the information about the used codec.
1046 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1047 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1048 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1050 * - encoding: Set by user, if not then the default based on codec_id will be used.
1051 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1053 unsigned int codec_tag;
1056 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1057 * This is used to work around some encoder bugs.
1058 * - encoding: unused
1059 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1061 unsigned int stream_codec_tag;
1066 * Private context used for internal data.
1068 * Unlike priv_data, this is not codec-specific. It is used in general
1069 * libavcodec functions.
1071 struct AVCodecInternal *internal;
1074 * Private data of the user, can be used to carry app specific stuff.
1075 * - encoding: Set by user.
1076 * - decoding: Set by user.
1081 * the average bitrate
1082 * - encoding: Set by user; unused for constant quantizer encoding.
1083 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1088 * number of bits the bitstream is allowed to diverge from the reference.
1089 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1090 * - encoding: Set by user; unused for constant quantizer encoding.
1091 * - decoding: unused
1093 int bit_rate_tolerance;
1096 * Global quality for codecs which cannot change it per frame.
1097 * This should be proportional to MPEG-1/2/4 qscale.
1098 * - encoding: Set by user.
1099 * - decoding: unused
1104 * - encoding: Set by user.
1105 * - decoding: unused
1107 int compression_level;
1108 #define FF_COMPRESSION_DEFAULT -1
1112 * - encoding: Set by user.
1113 * - decoding: Set by user.
1119 * - encoding: Set by user.
1120 * - decoding: Set by user.
1125 * some codecs need / can use extradata like Huffman tables.
1126 * mjpeg: Huffman tables
1127 * rv10: additional flags
1128 * mpeg4: global headers (they can be in the bitstream or here)
1129 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1130 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1131 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1132 * - encoding: Set/allocated/freed by libavcodec.
1133 * - decoding: Set/allocated/freed by user.
1139 * This is the fundamental unit of time (in seconds) in terms
1140 * of which frame timestamps are represented. For fixed-fps content,
1141 * timebase should be 1/framerate and timestamp increments should be
1143 * - encoding: MUST be set by user.
1144 * - decoding: Set by libavcodec.
1146 AVRational time_base;
1149 * For some codecs, the time base is closer to the field rate than the frame rate.
1150 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1151 * if no telecine is used ...
1153 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1155 int ticks_per_frame;
1161 * Number of frames the decoded output will be delayed relative to the
1165 * For encoding, this is the number of "priming" samples added to the
1166 * beginning of the stream. The decoded output will be delayed by this
1167 * many samples relative to the input to the encoder. Note that this
1168 * field is purely informational and does not directly affect the pts
1169 * output by the encoder, which should always be based on the actual
1170 * presentation time, including any delay.
1171 * For decoding, this is the number of samples the decoder needs to
1172 * output before the decoder's output is valid. When seeking, you should
1173 * start decoding this many samples prior to your desired seek point.
1175 * - encoding: Set by libavcodec.
1176 * - decoding: Set by libavcodec.
1183 * picture width / height.
1184 * - encoding: MUST be set by user.
1185 * - decoding: May be set by the user before opening the decoder if known e.g.
1186 * from the container. Some decoders will require the dimensions
1187 * to be set by the caller. During decoding, the decoder may
1188 * overwrite those values as required.
1193 * Bitstream width / height, may be different from width/height e.g. when
1194 * the decoded frame is cropped before being output.
1195 * - encoding: unused
1196 * - decoding: May be set by the user before opening the decoder if known
1197 * e.g. from the container. During decoding, the decoder may
1198 * overwrite those values as required.
1200 int coded_width, coded_height;
1202 #if FF_API_ASPECT_EXTENDED
1203 #define FF_ASPECT_EXTENDED 15
1207 * the number of pictures in a group of pictures, or 0 for intra_only
1208 * - encoding: Set by user.
1209 * - decoding: unused
1214 * Pixel format, see AV_PIX_FMT_xxx.
1215 * May be set by the demuxer if known from headers.
1216 * May be overriden by the decoder if it knows better.
1217 * - encoding: Set by user.
1218 * - decoding: Set by user if known, overridden by libavcodec if known
1220 enum AVPixelFormat pix_fmt;
1223 * Motion estimation algorithm used for video coding.
1224 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1225 * 8 (umh), 10 (tesa) [7, 8, 10 are x264 specific]
1226 * - encoding: MUST be set by user.
1227 * - decoding: unused
1232 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1233 * decoder to draw a horizontal band. It improves cache usage. Not
1234 * all codecs can do that. You must check the codec capabilities
1236 * When multithreading is used, it may be called from multiple threads
1237 * at the same time; threads might draw different parts of the same AVFrame,
1238 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1240 * The function is also used by hardware acceleration APIs.
1241 * It is called at least once during frame decoding to pass
1242 * the data needed for hardware render.
1243 * In that mode instead of pixel data, AVFrame points to
1244 * a structure specific to the acceleration API. The application
1245 * reads the structure and can change some fields to indicate progress
1247 * - encoding: unused
1248 * - decoding: Set by user.
1249 * @param height the height of the slice
1250 * @param y the y position of the slice
1251 * @param type 1->top field, 2->bottom field, 3->frame
1252 * @param offset offset into the AVFrame.data from which the slice should be read
1254 void (*draw_horiz_band)(struct AVCodecContext *s,
1255 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1256 int y, int type, int height);
1259 * callback to negotiate the pixelFormat
1260 * @param fmt is the list of formats which are supported by the codec,
1261 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1262 * The first is always the native one.
1263 * @return the chosen format
1264 * - encoding: unused
1265 * - decoding: Set by user, if not set the native format will be chosen.
1267 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1270 * maximum number of B-frames between non-B-frames
1271 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1272 * - encoding: Set by user.
1273 * - decoding: unused
1278 * qscale factor between IP and B-frames
1279 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1280 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1281 * - encoding: Set by user.
1282 * - decoding: unused
1284 float b_quant_factor;
1286 /** obsolete FIXME remove */
1288 #define FF_RC_STRATEGY_XVID 1
1290 int b_frame_strategy;
1293 * qscale offset between IP and B-frames
1294 * - encoding: Set by user.
1295 * - decoding: unused
1297 float b_quant_offset;
1300 * Size of the frame reordering buffer in the decoder.
1301 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1302 * - encoding: Set by libavcodec.
1303 * - decoding: Set by libavcodec.
1308 * 0-> h263 quant 1-> mpeg quant
1309 * - encoding: Set by user.
1310 * - decoding: unused
1315 * qscale factor between P and I-frames
1316 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1317 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1318 * - encoding: Set by user.
1319 * - decoding: unused
1321 float i_quant_factor;
1324 * qscale offset between P and I-frames
1325 * - encoding: Set by user.
1326 * - decoding: unused
1328 float i_quant_offset;
1331 * luminance masking (0-> disabled)
1332 * - encoding: Set by user.
1333 * - decoding: unused
1338 * temporary complexity masking (0-> disabled)
1339 * - encoding: Set by user.
1340 * - decoding: unused
1342 float temporal_cplx_masking;
1345 * spatial complexity masking (0-> disabled)
1346 * - encoding: Set by user.
1347 * - decoding: unused
1349 float spatial_cplx_masking;
1352 * p block masking (0-> disabled)
1353 * - encoding: Set by user.
1354 * - decoding: unused
1359 * darkness masking (0-> disabled)
1360 * - encoding: Set by user.
1361 * - decoding: unused
1367 * - encoding: Set by libavcodec.
1368 * - decoding: Set by user (or 0).
1372 * prediction method (needed for huffyuv)
1373 * - encoding: Set by user.
1374 * - decoding: unused
1376 int prediction_method;
1377 #define FF_PRED_LEFT 0
1378 #define FF_PRED_PLANE 1
1379 #define FF_PRED_MEDIAN 2
1382 * slice offsets in the frame in bytes
1383 * - encoding: Set/allocated by libavcodec.
1384 * - decoding: Set/allocated by user (or NULL).
1389 * sample aspect ratio (0 if unknown)
1390 * That is the width of a pixel divided by the height of the pixel.
1391 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1392 * - encoding: Set by user.
1393 * - decoding: Set by libavcodec.
1395 AVRational sample_aspect_ratio;
1398 * motion estimation comparison function
1399 * - encoding: Set by user.
1400 * - decoding: unused
1404 * subpixel motion estimation comparison function
1405 * - encoding: Set by user.
1406 * - decoding: unused
1410 * macroblock comparison function (not supported yet)
1411 * - encoding: Set by user.
1412 * - decoding: unused
1416 * interlaced DCT comparison function
1417 * - encoding: Set by user.
1418 * - decoding: unused
1421 #define FF_CMP_SAD 0
1422 #define FF_CMP_SSE 1
1423 #define FF_CMP_SATD 2
1424 #define FF_CMP_DCT 3
1425 #define FF_CMP_PSNR 4
1426 #define FF_CMP_BIT 5
1428 #define FF_CMP_ZERO 7
1429 #define FF_CMP_VSAD 8
1430 #define FF_CMP_VSSE 9
1431 #define FF_CMP_NSSE 10
1432 #define FF_CMP_DCTMAX 13
1433 #define FF_CMP_DCT264 14
1434 #define FF_CMP_CHROMA 256
1437 * ME diamond size & shape
1438 * - encoding: Set by user.
1439 * - decoding: unused
1444 * amount of previous MV predictors (2a+1 x 2a+1 square)
1445 * - encoding: Set by user.
1446 * - decoding: unused
1448 int last_predictor_count;
1451 * prepass for motion estimation
1452 * - encoding: Set by user.
1453 * - decoding: unused
1458 * motion estimation prepass comparison function
1459 * - encoding: Set by user.
1460 * - decoding: unused
1465 * ME prepass diamond size & shape
1466 * - encoding: Set by user.
1467 * - decoding: unused
1473 * - encoding: Set by user.
1474 * - decoding: unused
1476 int me_subpel_quality;
1479 * DTG active format information (additional aspect ratio
1480 * information only used in DVB MPEG-2 transport streams)
1483 * - encoding: unused
1484 * - decoding: Set by decoder.
1486 int dtg_active_format;
1487 #define FF_DTG_AFD_SAME 8
1488 #define FF_DTG_AFD_4_3 9
1489 #define FF_DTG_AFD_16_9 10
1490 #define FF_DTG_AFD_14_9 11
1491 #define FF_DTG_AFD_4_3_SP_14_9 13
1492 #define FF_DTG_AFD_16_9_SP_14_9 14
1493 #define FF_DTG_AFD_SP_4_3 15
1496 * maximum motion estimation search range in subpel units
1497 * If 0 then no limit.
1499 * - encoding: Set by user.
1500 * - decoding: unused
1505 * intra quantizer bias
1506 * - encoding: Set by user.
1507 * - decoding: unused
1509 int intra_quant_bias;
1510 #define FF_DEFAULT_QUANT_BIAS 999999
1513 * inter quantizer bias
1514 * - encoding: Set by user.
1515 * - decoding: unused
1517 int inter_quant_bias;
1521 * - encoding: unused
1522 * - decoding: Set by user.
1525 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1526 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1527 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1530 * XVideo Motion Acceleration
1531 * - encoding: forbidden
1532 * - decoding: set by decoder
1534 int xvmc_acceleration;
1537 * macroblock decision mode
1538 * - encoding: Set by user.
1539 * - decoding: unused
1542 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1543 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1544 #define FF_MB_DECISION_RD 2 ///< rate distortion
1547 * custom intra quantization matrix
1548 * - encoding: Set by user, can be NULL.
1549 * - decoding: Set by libavcodec.
1551 uint16_t *intra_matrix;
1554 * custom inter quantization matrix
1555 * - encoding: Set by user, can be NULL.
1556 * - decoding: Set by libavcodec.
1558 uint16_t *inter_matrix;
1561 * scene change detection threshold
1562 * 0 is default, larger means fewer detected scene changes.
1563 * - encoding: Set by user.
1564 * - decoding: unused
1566 int scenechange_threshold;
1569 * noise reduction strength
1570 * - encoding: Set by user.
1571 * - decoding: unused
1573 int noise_reduction;
1576 * Motion estimation threshold below which no motion estimation is
1577 * performed, but instead the user specified motion vectors are used.
1579 * - encoding: Set by user.
1580 * - decoding: unused
1585 * Macroblock threshold below which the user specified macroblock types will be used.
1586 * - encoding: Set by user.
1587 * - decoding: unused
1592 * precision of the intra DC coefficient - 8
1593 * - encoding: Set by user.
1594 * - decoding: unused
1596 int intra_dc_precision;
1599 * Number of macroblock rows at the top which are skipped.
1600 * - encoding: unused
1601 * - decoding: Set by user.
1606 * Number of macroblock rows at the bottom which are skipped.
1607 * - encoding: unused
1608 * - decoding: Set by user.
1613 * Border processing masking, raises the quantizer for mbs on the borders
1615 * - encoding: Set by user.
1616 * - decoding: unused
1618 float border_masking;
1621 * minimum MB lagrange multipler
1622 * - encoding: Set by user.
1623 * - decoding: unused
1628 * maximum MB lagrange multipler
1629 * - encoding: Set by user.
1630 * - decoding: unused
1636 * - encoding: Set by user.
1637 * - decoding: unused
1639 int me_penalty_compensation;
1643 * - encoding: Set by user.
1644 * - decoding: unused
1650 * - encoding: Set by user.
1651 * - decoding: unused
1657 * - encoding: Set by user.
1658 * - decoding: unused
1663 * number of reference frames
1664 * - encoding: Set by user.
1665 * - decoding: Set by lavc.
1670 * chroma qp offset from luma
1671 * - encoding: Set by user.
1672 * - decoding: unused
1677 * Multiplied by qscale for each frame and added to scene_change_score.
1678 * - encoding: Set by user.
1679 * - decoding: unused
1681 int scenechange_factor;
1685 * Note: Value depends upon the compare function used for fullpel ME.
1686 * - encoding: Set by user.
1687 * - decoding: unused
1692 * Adjust sensitivity of b_frame_strategy 1.
1693 * - encoding: Set by user.
1694 * - decoding: unused
1699 * Chromaticity coordinates of the source primaries.
1700 * - encoding: Set by user
1701 * - decoding: Set by libavcodec
1703 enum AVColorPrimaries color_primaries;
1706 * Color Transfer Characteristic.
1707 * - encoding: Set by user
1708 * - decoding: Set by libavcodec
1710 enum AVColorTransferCharacteristic color_trc;
1713 * YUV colorspace type.
1714 * - encoding: Set by user
1715 * - decoding: Set by libavcodec
1717 enum AVColorSpace colorspace;
1720 * MPEG vs JPEG YUV range.
1721 * - encoding: Set by user
1722 * - decoding: Set by libavcodec
1724 enum AVColorRange color_range;
1727 * This defines the location of chroma samples.
1728 * - encoding: Set by user
1729 * - decoding: Set by libavcodec
1731 enum AVChromaLocation chroma_sample_location;
1735 * Indicates number of picture subdivisions. Used for parallelized
1737 * - encoding: Set by user
1738 * - decoding: unused
1743 * - encoding: set by libavcodec
1744 * - decoding: Set by libavcodec
1746 enum AVFieldOrder field_order;
1749 int sample_rate; ///< samples per second
1750 int channels; ///< number of audio channels
1753 * audio sample format
1754 * - encoding: Set by user.
1755 * - decoding: Set by libavcodec.
1757 enum AVSampleFormat sample_fmt; ///< sample format
1759 /* The following data should not be initialized. */
1761 * Number of samples per channel in an audio frame.
1763 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1764 * except the last must contain exactly frame_size samples per channel.
1765 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1766 * frame size is not restricted.
1767 * - decoding: may be set by some decoders to indicate constant frame size
1772 * Frame counter, set by libavcodec.
1774 * - decoding: total number of frames returned from the decoder so far.
1775 * - encoding: total number of frames passed to the encoder so far.
1777 * @note the counter is not incremented if encoding/decoding resulted in
1783 * number of bytes per packet if constant and known or 0
1784 * Used by some WAV based audio codecs.
1789 * Audio cutoff bandwidth (0 means "automatic")
1790 * - encoding: Set by user.
1791 * - decoding: unused
1795 #if FF_API_REQUEST_CHANNELS
1797 * Decoder should decode to this many channels if it can (0 for default)
1798 * - encoding: unused
1799 * - decoding: Set by user.
1800 * @deprecated Deprecated in favor of request_channel_layout.
1802 attribute_deprecated int request_channels;
1806 * Audio channel layout.
1807 * - encoding: set by user.
1808 * - decoding: set by libavcodec.
1810 uint64_t channel_layout;
1813 * Request decoder to use this channel layout if it can (0 for default)
1814 * - encoding: unused
1815 * - decoding: Set by user.
1817 uint64_t request_channel_layout;
1820 * Type of service that the audio stream conveys.
1821 * - encoding: Set by user.
1822 * - decoding: Set by libavcodec.
1824 enum AVAudioServiceType audio_service_type;
1827 * Used to request a sample format from the decoder.
1828 * - encoding: unused.
1829 * - decoding: Set by user.
1831 enum AVSampleFormat request_sample_fmt;
1833 #if FF_API_GET_BUFFER
1835 * Called at the beginning of each frame to get a buffer for it.
1837 * The function will set AVFrame.data[], AVFrame.linesize[].
1838 * AVFrame.extended_data[] must also be set, but it should be the same as
1839 * AVFrame.data[] except for planar audio with more channels than can fit
1840 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1841 * many data pointers as it can hold.
1843 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1844 * avcodec_default_get_buffer() instead of providing buffers allocated by
1847 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1848 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1849 * but if get_buffer() is overridden then alignment considerations should
1850 * be taken into account.
1852 * @see avcodec_default_get_buffer()
1856 * If pic.reference is set then the frame will be read later by libavcodec.
1857 * avcodec_align_dimensions2() should be used to find the required width and
1858 * height, as they normally need to be rounded up to the next multiple of 16.
1860 * If frame multithreading is used and thread_safe_callbacks is set,
1861 * it may be called from a different thread, but not from more than one at
1862 * once. Does not need to be reentrant.
1864 * @see release_buffer(), reget_buffer()
1865 * @see avcodec_align_dimensions2()
1869 * Decoders request a buffer of a particular size by setting
1870 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1871 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1872 * to a smaller value in the output frame.
1874 * Decoders cannot use the buffer after returning from
1875 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1876 * is assumed to be released immediately upon return. In some rare cases,
1877 * a decoder may need to call get_buffer() more than once in a single
1878 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
1879 * called again after it has already been called once, the previously
1880 * acquired buffer is assumed to be released at that time and may not be
1881 * reused by the decoder.
1883 * As a convenience, av_samples_get_buffer_size() and
1884 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1885 * functions to find the required data size and to fill data pointers and
1886 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1887 * since all planes must be the same size.
1889 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1891 * - encoding: unused
1892 * - decoding: Set by libavcodec, user can override.
1894 * @deprecated use get_buffer2()
1896 attribute_deprecated
1897 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1900 * Called to release buffers which were allocated with get_buffer.
1901 * A released buffer can be reused in get_buffer().
1902 * pic.data[*] must be set to NULL.
1903 * May be called from a different thread if frame multithreading is used,
1904 * but not by more than one thread at once, so does not need to be reentrant.
1905 * - encoding: unused
1906 * - decoding: Set by libavcodec, user can override.
1908 * @deprecated custom freeing callbacks should be set from get_buffer2()
1910 attribute_deprecated
1911 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1914 * Called at the beginning of a frame to get cr buffer for it.
1915 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1916 * libavcodec will pass previous buffer in pic, function should return
1917 * same buffer or new buffer with old frame "painted" into it.
1918 * If pic.data[0] == NULL must behave like get_buffer().
1919 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
1920 * avcodec_default_reget_buffer() instead of providing buffers allocated by
1922 * - encoding: unused
1923 * - decoding: Set by libavcodec, user can override.
1925 attribute_deprecated
1926 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1930 * This callback is called at the beginning of each frame to get data
1931 * buffer(s) for it. There may be one contiguous buffer for all the data or
1932 * there may be a buffer per each data plane or anything in between. What
1933 * this means is, you may set however many entries in buf[] you feel necessary.
1934 * Each buffer must be reference-counted using the AVBuffer API (see description
1937 * The following fields will be set in the frame before this callback is
1940 * - width, height (video only)
1941 * - sample_rate, channel_layout, nb_samples (audio only)
1942 * Their values may differ from the corresponding values in
1943 * AVCodecContext. This callback must use the frame values, not the codec
1944 * context values, to calculate the required buffer size.
1946 * This callback must fill the following fields in the frame:
1950 * * if the data is planar audio with more than 8 channels, then this
1951 * callback must allocate and fill extended_data to contain all pointers
1952 * to all data planes. data[] must hold as many pointers as it can.
1953 * extended_data must be allocated with av_malloc() and will be freed in
1955 * * otherwise exended_data must point to data
1956 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1957 * the frame's data and extended_data pointers must be contained in these. That
1958 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1959 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1960 * and av_buffer_ref().
1961 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1962 * this callback and filled with the extra buffers if there are more
1963 * buffers than buf[] can hold. extended_buf will be freed in
1966 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
1967 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1970 * Each data plane must be aligned to the maximum required by the target
1973 * @see avcodec_default_get_buffer2()
1977 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1978 * (read and/or written to if it is writable) later by libavcodec.
1980 * If CODEC_FLAG_EMU_EDGE is not set in s->flags, the buffer must contain an
1981 * edge of the size returned by avcodec_get_edge_width() on all sides.
1983 * avcodec_align_dimensions2() should be used to find the required width and
1984 * height, as they normally need to be rounded up to the next multiple of 16.
1986 * If frame multithreading is used and thread_safe_callbacks is set,
1987 * this callback may be called from a different thread, but not from more
1988 * than one at once. Does not need to be reentrant.
1990 * @see avcodec_align_dimensions2()
1994 * Decoders request a buffer of a particular size by setting
1995 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1996 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1997 * to a smaller value in the output frame.
1999 * As a convenience, av_samples_get_buffer_size() and
2000 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2001 * functions to find the required data size and to fill data pointers and
2002 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2003 * since all planes must be the same size.
2005 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2007 * - encoding: unused
2008 * - decoding: Set by libavcodec, user can override.
2010 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2013 * If non-zero, the decoded audio and video frames returned from
2014 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2015 * and are valid indefinitely. The caller must free them with
2016 * av_frame_unref() when they are not needed anymore.
2017 * Otherwise, the decoded frames must not be freed by the caller and are
2018 * only valid until the next decode call.
2020 * - encoding: unused
2021 * - decoding: set by the caller before avcodec_open2().
2023 int refcounted_frames;
2025 /* - encoding parameters */
2026 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2027 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2031 * - encoding: Set by user.
2032 * - decoding: unused
2038 * - encoding: Set by user.
2039 * - decoding: unused
2044 * maximum quantizer difference between frames
2045 * - encoding: Set by user.
2046 * - decoding: unused
2051 * ratecontrol qmin qmax limiting method
2052 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2053 * - encoding: Set by user.
2054 * - decoding: unused
2062 * decoder bitstream buffer size
2063 * - encoding: Set by user.
2064 * - decoding: unused
2069 * ratecontrol override, see RcOverride
2070 * - encoding: Allocated/set/freed by user.
2071 * - decoding: unused
2073 int rc_override_count;
2074 RcOverride *rc_override;
2077 * rate control equation
2078 * - encoding: Set by user
2079 * - decoding: unused
2085 * - encoding: Set by user.
2086 * - decoding: unused
2092 * - encoding: Set by user.
2093 * - decoding: unused
2097 float rc_buffer_aggressivity;
2100 * initial complexity for pass1 ratecontrol
2101 * - encoding: Set by user.
2102 * - decoding: unused
2104 float rc_initial_cplx;
2107 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2108 * - encoding: Set by user.
2109 * - decoding: unused.
2111 float rc_max_available_vbv_use;
2114 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2115 * - encoding: Set by user.
2116 * - decoding: unused.
2118 float rc_min_vbv_overflow_use;
2121 * Number of bits which should be loaded into the rc buffer before decoding starts.
2122 * - encoding: Set by user.
2123 * - decoding: unused
2125 int rc_initial_buffer_occupancy;
2127 #define FF_CODER_TYPE_VLC 0
2128 #define FF_CODER_TYPE_AC 1
2129 #define FF_CODER_TYPE_RAW 2
2130 #define FF_CODER_TYPE_RLE 3
2131 #define FF_CODER_TYPE_DEFLATE 4
2134 * - encoding: Set by user.
2135 * - decoding: unused
2141 * - encoding: Set by user.
2142 * - decoding: unused
2147 * minimum Lagrange multipler
2148 * - encoding: Set by user.
2149 * - decoding: unused
2154 * maximum Lagrange multipler
2155 * - encoding: Set by user.
2156 * - decoding: unused
2161 * frame skip threshold
2162 * - encoding: Set by user.
2163 * - decoding: unused
2165 int frame_skip_threshold;
2169 * - encoding: Set by user.
2170 * - decoding: unused
2172 int frame_skip_factor;
2175 * frame skip exponent
2176 * - encoding: Set by user.
2177 * - decoding: unused
2182 * frame skip comparison function
2183 * - encoding: Set by user.
2184 * - decoding: unused
2189 * trellis RD quantization
2190 * - encoding: Set by user.
2191 * - decoding: unused
2196 * - encoding: Set by user.
2197 * - decoding: unused
2199 int min_prediction_order;
2202 * - encoding: Set by user.
2203 * - decoding: unused
2205 int max_prediction_order;
2208 * GOP timecode frame start number, in non drop frame format
2209 * - encoding: Set by user.
2210 * - decoding: unused
2212 int64_t timecode_frame_start;
2214 /* The RTP callback: This function is called */
2215 /* every time the encoder has a packet to send. */
2216 /* It depends on the encoder if the data starts */
2217 /* with a Start Code (it should). H.263 does. */
2218 /* mb_nb contains the number of macroblocks */
2219 /* encoded in the RTP payload. */
2220 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2222 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2223 /* do its best to deliver a chunk with size */
2224 /* below rtp_payload_size, the chunk will start */
2225 /* with a start code on some codecs like H.263. */
2226 /* This doesn't take account of any particular */
2227 /* headers inside the transmitted RTP payload. */
2229 /* statistics, used for 2-pass encoding */
2240 * number of bits used for the previously encoded frame
2241 * - encoding: Set by libavcodec.
2242 * - decoding: unused
2247 * pass1 encoding statistics output buffer
2248 * - encoding: Set by libavcodec.
2249 * - decoding: unused
2254 * pass2 encoding statistics input buffer
2255 * Concatenated stuff from stats_out of pass1 should be placed here.
2256 * - encoding: Allocated/set/freed by user.
2257 * - decoding: unused
2262 * Work around bugs in encoders which sometimes cannot be detected automatically.
2263 * - encoding: Set by user
2264 * - decoding: Set by user
2266 int workaround_bugs;
2267 #define FF_BUG_AUTODETECT 1 ///< autodetection
2268 #if FF_API_OLD_MSMPEG4
2269 #define FF_BUG_OLD_MSMPEG4 2
2271 #define FF_BUG_XVID_ILACE 4
2272 #define FF_BUG_UMP4 8
2273 #define FF_BUG_NO_PADDING 16
2274 #define FF_BUG_AMV 32
2276 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2278 #define FF_BUG_QPEL_CHROMA 64
2279 #define FF_BUG_STD_QPEL 128
2280 #define FF_BUG_QPEL_CHROMA2 256
2281 #define FF_BUG_DIRECT_BLOCKSIZE 512
2282 #define FF_BUG_EDGE 1024
2283 #define FF_BUG_HPEL_CHROMA 2048
2284 #define FF_BUG_DC_CLIP 4096
2285 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2286 #define FF_BUG_TRUNCATED 16384
2289 * strictly follow the standard (MPEG4, ...).
2290 * - encoding: Set by user.
2291 * - decoding: Set by user.
2292 * Setting this to STRICT or higher means the encoder and decoder will
2293 * generally do stupid things, whereas setting it to unofficial or lower
2294 * will mean the encoder might produce output that is not supported by all
2295 * spec-compliant decoders. Decoders don't differentiate between normal,
2296 * unofficial and experimental (that is, they always try to decode things
2297 * when they can) unless they are explicitly asked to behave stupidly
2298 * (=strictly conform to the specs)
2300 int strict_std_compliance;
2301 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2302 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2303 #define FF_COMPLIANCE_NORMAL 0
2304 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2305 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2308 * error concealment flags
2309 * - encoding: unused
2310 * - decoding: Set by user.
2312 int error_concealment;
2313 #define FF_EC_GUESS_MVS 1
2314 #define FF_EC_DEBLOCK 2
2318 * - encoding: Set by user.
2319 * - decoding: Set by user.
2322 #define FF_DEBUG_PICT_INFO 1
2323 #define FF_DEBUG_RC 2
2324 #define FF_DEBUG_BITSTREAM 4
2325 #define FF_DEBUG_MB_TYPE 8
2326 #define FF_DEBUG_QP 16
2329 * @deprecated this option does nothing
2331 #define FF_DEBUG_MV 32
2333 #define FF_DEBUG_DCT_COEFF 0x00000040
2334 #define FF_DEBUG_SKIP 0x00000080
2335 #define FF_DEBUG_STARTCODE 0x00000100
2336 #define FF_DEBUG_PTS 0x00000200
2337 #define FF_DEBUG_ER 0x00000400
2338 #define FF_DEBUG_MMCO 0x00000800
2339 #define FF_DEBUG_BUGS 0x00001000
2341 #define FF_DEBUG_VIS_QP 0x00002000
2342 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2344 #define FF_DEBUG_BUFFERS 0x00008000
2345 #define FF_DEBUG_THREADS 0x00010000
2349 * @deprecated this option does not have any effect
2351 attribute_deprecated
2353 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2354 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2355 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2359 * Error recognition; may misdetect some more or less valid parts as errors.
2360 * - encoding: unused
2361 * - decoding: Set by user.
2363 int err_recognition;
2366 * Verify checksums embedded in the bitstream (could be of either encoded or
2367 * decoded data, depending on the codec) and print an error message on mismatch.
2368 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2369 * decoder returning an error.
2371 #define AV_EF_CRCCHECK (1<<0)
2372 #define AV_EF_BITSTREAM (1<<1)
2373 #define AV_EF_BUFFER (1<<2)
2374 #define AV_EF_EXPLODE (1<<3)
2377 * opaque 64bit number (generally a PTS) that will be reordered and
2378 * output in AVFrame.reordered_opaque
2379 * @deprecated in favor of pkt_pts
2380 * - encoding: unused
2381 * - decoding: Set by user.
2383 int64_t reordered_opaque;
2386 * Hardware accelerator in use
2387 * - encoding: unused.
2388 * - decoding: Set by libavcodec
2390 struct AVHWAccel *hwaccel;
2393 * Hardware accelerator context.
2394 * For some hardware accelerators, a global context needs to be
2395 * provided by the user. In that case, this holds display-dependent
2396 * data Libav cannot instantiate itself. Please refer to the
2397 * Libav HW accelerator documentation to know how to fill this
2398 * is. e.g. for VA API, this is a struct vaapi_context.
2399 * - encoding: unused
2400 * - decoding: Set by user
2402 void *hwaccel_context;
2406 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2407 * - decoding: unused
2409 uint64_t error[AV_NUM_DATA_POINTERS];
2412 * DCT algorithm, see FF_DCT_* below
2413 * - encoding: Set by user.
2414 * - decoding: unused
2417 #define FF_DCT_AUTO 0
2418 #define FF_DCT_FASTINT 1
2419 #define FF_DCT_INT 2
2420 #define FF_DCT_MMX 3
2421 #define FF_DCT_ALTIVEC 5
2422 #define FF_DCT_FAAN 6
2425 * IDCT algorithm, see FF_IDCT_* below.
2426 * - encoding: Set by user.
2427 * - decoding: Set by user.
2430 #define FF_IDCT_AUTO 0
2431 #define FF_IDCT_INT 1
2432 #define FF_IDCT_SIMPLE 2
2433 #define FF_IDCT_SIMPLEMMX 3
2434 #define FF_IDCT_ARM 7
2435 #define FF_IDCT_ALTIVEC 8
2436 #define FF_IDCT_SH4 9
2437 #define FF_IDCT_SIMPLEARM 10
2438 #define FF_IDCT_IPP 13
2439 #define FF_IDCT_XVIDMMX 14
2440 #define FF_IDCT_SIMPLEARMV5TE 16
2441 #define FF_IDCT_SIMPLEARMV6 17
2442 #define FF_IDCT_SIMPLEVIS 18
2443 #define FF_IDCT_FAAN 20
2444 #define FF_IDCT_SIMPLENEON 22
2445 #if FF_API_ARCH_ALPHA
2446 #define FF_IDCT_SIMPLEALPHA 23
2450 * bits per sample/pixel from the demuxer (needed for huffyuv).
2451 * - encoding: Set by libavcodec.
2452 * - decoding: Set by user.
2454 int bits_per_coded_sample;
2457 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2458 * - encoding: set by user.
2459 * - decoding: set by libavcodec.
2461 int bits_per_raw_sample;
2465 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2466 * - encoding: unused
2467 * - decoding: Set by user.
2469 * @deprecated use decoder private options instead
2471 attribute_deprecated int lowres;
2475 * the picture in the bitstream
2476 * - encoding: Set by libavcodec.
2477 * - decoding: Set by libavcodec.
2479 AVFrame *coded_frame;
2483 * is used to decide how many independent tasks should be passed to execute()
2484 * - encoding: Set by user.
2485 * - decoding: Set by user.
2490 * Which multithreading methods to use.
2491 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2492 * so clients which cannot provide future frames should not use it.
2494 * - encoding: Set by user, otherwise the default is used.
2495 * - decoding: Set by user, otherwise the default is used.
2498 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2499 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2502 * Which multithreading methods are in use by the codec.
2503 * - encoding: Set by libavcodec.
2504 * - decoding: Set by libavcodec.
2506 int active_thread_type;
2509 * Set by the client if its custom get_buffer() callback can be called
2510 * synchronously from another thread, which allows faster multithreaded decoding.
2511 * draw_horiz_band() will be called from other threads regardless of this setting.
2512 * Ignored if the default get_buffer() is used.
2513 * - encoding: Set by user.
2514 * - decoding: Set by user.
2516 int thread_safe_callbacks;
2519 * The codec may call this to execute several independent things.
2520 * It will return only after finishing all tasks.
2521 * The user may replace this with some multithreaded implementation,
2522 * the default implementation will execute the parts serially.
2523 * @param count the number of things to execute
2524 * - encoding: Set by libavcodec, user can override.
2525 * - decoding: Set by libavcodec, user can override.
2527 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2530 * The codec may call this to execute several independent things.
2531 * It will return only after finishing all tasks.
2532 * The user may replace this with some multithreaded implementation,
2533 * the default implementation will execute the parts serially.
2534 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2535 * @param c context passed also to func
2536 * @param count the number of things to execute
2537 * @param arg2 argument passed unchanged to func
2538 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2539 * @param func function that will be called count times, with jobnr from 0 to count-1.
2540 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2541 * two instances of func executing at the same time will have the same threadnr.
2542 * @return always 0 currently, but code should handle a future improvement where when any call to func
2543 * returns < 0 no further calls to func may be done and < 0 is returned.
2544 * - encoding: Set by libavcodec, user can override.
2545 * - decoding: Set by libavcodec, user can override.
2547 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2549 #if FF_API_THREAD_OPAQUE
2551 * @deprecated this field should not be used from outside of lavc
2553 attribute_deprecated
2554 void *thread_opaque;
2558 * noise vs. sse weight for the nsse comparsion function
2559 * - encoding: Set by user.
2560 * - decoding: unused
2566 * - encoding: Set by user.
2567 * - decoding: Set by libavcodec.
2570 #define FF_PROFILE_UNKNOWN -99
2571 #define FF_PROFILE_RESERVED -100
2573 #define FF_PROFILE_AAC_MAIN 0
2574 #define FF_PROFILE_AAC_LOW 1
2575 #define FF_PROFILE_AAC_SSR 2
2576 #define FF_PROFILE_AAC_LTP 3
2577 #define FF_PROFILE_AAC_HE 4
2578 #define FF_PROFILE_AAC_HE_V2 28
2579 #define FF_PROFILE_AAC_LD 22
2580 #define FF_PROFILE_AAC_ELD 38
2581 #define FF_PROFILE_MPEG2_AAC_LOW 128
2582 #define FF_PROFILE_MPEG2_AAC_HE 131
2584 #define FF_PROFILE_DTS 20
2585 #define FF_PROFILE_DTS_ES 30
2586 #define FF_PROFILE_DTS_96_24 40
2587 #define FF_PROFILE_DTS_HD_HRA 50
2588 #define FF_PROFILE_DTS_HD_MA 60
2590 #define FF_PROFILE_MPEG2_422 0
2591 #define FF_PROFILE_MPEG2_HIGH 1
2592 #define FF_PROFILE_MPEG2_SS 2
2593 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2594 #define FF_PROFILE_MPEG2_MAIN 4
2595 #define FF_PROFILE_MPEG2_SIMPLE 5
2597 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2598 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2600 #define FF_PROFILE_H264_BASELINE 66
2601 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2602 #define FF_PROFILE_H264_MAIN 77
2603 #define FF_PROFILE_H264_EXTENDED 88
2604 #define FF_PROFILE_H264_HIGH 100
2605 #define FF_PROFILE_H264_HIGH_10 110
2606 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2607 #define FF_PROFILE_H264_HIGH_422 122
2608 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2609 #define FF_PROFILE_H264_HIGH_444 144
2610 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2611 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2612 #define FF_PROFILE_H264_CAVLC_444 44
2614 #define FF_PROFILE_VC1_SIMPLE 0
2615 #define FF_PROFILE_VC1_MAIN 1
2616 #define FF_PROFILE_VC1_COMPLEX 2
2617 #define FF_PROFILE_VC1_ADVANCED 3
2619 #define FF_PROFILE_MPEG4_SIMPLE 0
2620 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2621 #define FF_PROFILE_MPEG4_CORE 2
2622 #define FF_PROFILE_MPEG4_MAIN 3
2623 #define FF_PROFILE_MPEG4_N_BIT 4
2624 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2625 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2626 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2627 #define FF_PROFILE_MPEG4_HYBRID 8
2628 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2629 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2630 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2631 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2632 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2633 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2634 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2636 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2637 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2638 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2639 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2640 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2644 * - encoding: Set by user.
2645 * - decoding: Set by libavcodec.
2648 #define FF_LEVEL_UNKNOWN -99
2652 * - encoding: unused
2653 * - decoding: Set by user.
2655 enum AVDiscard skip_loop_filter;
2659 * - encoding: unused
2660 * - decoding: Set by user.
2662 enum AVDiscard skip_idct;
2666 * - encoding: unused
2667 * - decoding: Set by user.
2669 enum AVDiscard skip_frame;
2672 * Header containing style information for text subtitles.
2673 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2674 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2675 * the Format line following. It shouldn't include any Dialogue line.
2676 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2677 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2679 uint8_t *subtitle_header;
2680 int subtitle_header_size;
2683 * Simulates errors in the bitstream to test error concealment.
2684 * - encoding: Set by user.
2685 * - decoding: unused
2689 #if FF_API_CODEC_PKT
2691 * @deprecated this field is not supposed to be accessed from outside lavc
2693 attribute_deprecated
2698 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2699 * Used for compliant TS muxing.
2700 * - encoding: Set by libavcodec.
2701 * - decoding: unused.
2709 typedef struct AVProfile {
2711 const char *name; ///< short name for the profile
2714 typedef struct AVCodecDefault AVCodecDefault;
2721 typedef struct AVCodec {
2723 * Name of the codec implementation.
2724 * The name is globally unique among encoders and among decoders (but an
2725 * encoder and a decoder can share the same name).
2726 * This is the primary way to find a codec from the user perspective.
2730 * Descriptive name for the codec, meant to be more human readable than name.
2731 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2733 const char *long_name;
2734 enum AVMediaType type;
2737 * Codec capabilities.
2741 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2742 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2743 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2744 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2745 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2747 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2749 const AVClass *priv_class; ///< AVClass for the private context
2750 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2752 /*****************************************************************
2753 * No fields below this line are part of the public API. They
2754 * may not be used outside of libavcodec and can be changed and
2756 * New public fields should be added right above.
2757 *****************************************************************
2760 struct AVCodec *next;
2762 * @name Frame-level threading support functions
2766 * If defined, called on thread contexts when they are created.
2767 * If the codec allocates writable tables in init(), re-allocate them here.
2768 * priv_data will be set to a copy of the original.
2770 int (*init_thread_copy)(AVCodecContext *);
2772 * Copy necessary context variables from a previous thread context to the current one.
2773 * If not defined, the next thread will start automatically; otherwise, the codec
2774 * must call ff_thread_finish_setup().
2776 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2778 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2782 * Private codec-specific defaults.
2784 const AVCodecDefault *defaults;
2787 * Initialize codec static data, called from avcodec_register().
2789 void (*init_static_data)(struct AVCodec *codec);
2791 int (*init)(AVCodecContext *);
2792 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2793 const struct AVSubtitle *sub);
2795 * Encode data to an AVPacket.
2797 * @param avctx codec context
2798 * @param avpkt output AVPacket (may contain a user-provided buffer)
2799 * @param[in] frame AVFrame containing the raw data to be encoded
2800 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2801 * non-empty packet was returned in avpkt.
2802 * @return 0 on success, negative error code on failure
2804 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2805 int *got_packet_ptr);
2806 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2807 int (*close)(AVCodecContext *);
2810 * Will be called when seeking
2812 void (*flush)(AVCodecContext *);
2818 typedef struct AVHWAccel {
2820 * Name of the hardware accelerated codec.
2821 * The name is globally unique among encoders and among decoders (but an
2822 * encoder and a decoder can share the same name).
2827 * Type of codec implemented by the hardware accelerator.
2829 * See AVMEDIA_TYPE_xxx
2831 enum AVMediaType type;
2834 * Codec implemented by the hardware accelerator.
2836 * See AV_CODEC_ID_xxx
2841 * Supported pixel format.
2843 * Only hardware accelerated formats are supported here.
2845 enum AVPixelFormat pix_fmt;
2848 * Hardware accelerated codec capabilities.
2849 * see FF_HWACCEL_CODEC_CAP_*
2853 struct AVHWAccel *next;
2856 * Called at the beginning of each frame or field picture.
2858 * Meaningful frame information (codec specific) is guaranteed to
2859 * be parsed at this point. This function is mandatory.
2861 * Note that buf can be NULL along with buf_size set to 0.
2862 * Otherwise, this means the whole frame is available at this point.
2864 * @param avctx the codec context
2865 * @param buf the frame data buffer base
2866 * @param buf_size the size of the frame in bytes
2867 * @return zero if successful, a negative value otherwise
2869 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2872 * Callback for each slice.
2874 * Meaningful slice information (codec specific) is guaranteed to
2875 * be parsed at this point. This function is mandatory.
2877 * @param avctx the codec context
2878 * @param buf the slice data buffer base
2879 * @param buf_size the size of the slice in bytes
2880 * @return zero if successful, a negative value otherwise
2882 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2885 * Called at the end of each frame or field picture.
2887 * The whole picture is parsed at this point and can now be sent
2888 * to the hardware accelerator. This function is mandatory.
2890 * @param avctx the codec context
2891 * @return zero if successful, a negative value otherwise
2893 int (*end_frame)(AVCodecContext *avctx);
2896 * Size of HW accelerator private data.
2898 * Private data is allocated with av_mallocz() before
2899 * AVCodecContext.get_buffer() and deallocated after
2900 * AVCodecContext.release_buffer().
2906 * @defgroup lavc_picture AVPicture
2908 * Functions for working with AVPicture
2913 * four components are given, that's all.
2914 * the last component is alpha
2916 typedef struct AVPicture {
2917 uint8_t *data[AV_NUM_DATA_POINTERS];
2918 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
2925 #define AVPALETTE_SIZE 1024
2926 #define AVPALETTE_COUNT 256
2928 enum AVSubtitleType {
2931 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2934 * Plain text, the text field must be set by the decoder and is
2935 * authoritative. ass and pict fields may contain approximations.
2940 * Formatted text, the ass field must be set by the decoder and is
2941 * authoritative. pict and text fields may contain approximations.
2946 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
2948 typedef struct AVSubtitleRect {
2949 int x; ///< top left corner of pict, undefined when pict is not set
2950 int y; ///< top left corner of pict, undefined when pict is not set
2951 int w; ///< width of pict, undefined when pict is not set
2952 int h; ///< height of pict, undefined when pict is not set
2953 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2956 * data+linesize for the bitmap of this subtitle.
2957 * can be set for text/ass as well once they where rendered
2960 enum AVSubtitleType type;
2962 char *text; ///< 0 terminated plain UTF-8 text
2965 * 0 terminated ASS/SSA compatible event line.
2966 * The pressentation of this is unaffected by the other values in this
2973 typedef struct AVSubtitle {
2974 uint16_t format; /* 0 = graphics */
2975 uint32_t start_display_time; /* relative to packet pts, in ms */
2976 uint32_t end_display_time; /* relative to packet pts, in ms */
2978 AVSubtitleRect **rects;
2979 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
2983 * If c is NULL, returns the first registered codec,
2984 * if c is non-NULL, returns the next registered codec after c,
2985 * or NULL if c is the last one.
2987 AVCodec *av_codec_next(const AVCodec *c);
2990 * Return the LIBAVCODEC_VERSION_INT constant.
2992 unsigned avcodec_version(void);
2995 * Return the libavcodec build-time configuration.
2997 const char *avcodec_configuration(void);
3000 * Return the libavcodec license.
3002 const char *avcodec_license(void);
3005 * Register the codec codec and initialize libavcodec.
3007 * @warning either this function or avcodec_register_all() must be called
3008 * before any other libavcodec functions.
3010 * @see avcodec_register_all()
3012 void avcodec_register(AVCodec *codec);
3015 * Register all the codecs, parsers and bitstream filters which were enabled at
3016 * configuration time. If you do not call this function you can select exactly
3017 * which formats you want to support, by using the individual registration
3020 * @see avcodec_register
3021 * @see av_register_codec_parser
3022 * @see av_register_bitstream_filter
3024 void avcodec_register_all(void);
3027 * Allocate an AVCodecContext and set its fields to default values. The
3028 * resulting struct can be deallocated by calling avcodec_close() on it followed
3031 * @param codec if non-NULL, allocate private data and initialize defaults
3032 * for the given codec. It is illegal to then call avcodec_open2()
3033 * with a different codec.
3034 * If NULL, then the codec-specific defaults won't be initialized,
3035 * which may result in suboptimal default settings (this is
3036 * important mainly for encoders, e.g. libx264).
3038 * @return An AVCodecContext filled with default values or NULL on failure.
3039 * @see avcodec_get_context_defaults
3041 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3044 * Set the fields of the given AVCodecContext to default values corresponding
3045 * to the given codec (defaults may be codec-dependent).
3047 * Do not call this function if a non-NULL codec has been passed
3048 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3049 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3050 * different codec on this AVCodecContext.
3052 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3055 * Get the AVClass for AVCodecContext. It can be used in combination with
3056 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3058 * @see av_opt_find().
3060 const AVClass *avcodec_get_class(void);
3063 * Copy the settings of the source AVCodecContext into the destination
3064 * AVCodecContext. The resulting destination codec context will be
3065 * unopened, i.e. you are required to call avcodec_open2() before you
3066 * can use this AVCodecContext to decode/encode video/audio data.
3068 * @param dest target codec context, should be initialized with
3069 * avcodec_alloc_context3(), but otherwise uninitialized
3070 * @param src source codec context
3071 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3073 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3076 * Allocate an AVFrame and set its fields to default values. The resulting
3077 * struct must be freed using avcodec_free_frame().
3079 * @return An AVFrame filled with default values or NULL on failure.
3080 * @see avcodec_get_frame_defaults
3082 AVFrame *avcodec_alloc_frame(void);
3085 * Set the fields of the given AVFrame to default values.
3087 * @param frame The AVFrame of which the fields should be set to default values.
3089 void avcodec_get_frame_defaults(AVFrame *frame);
3092 * Free the frame and any dynamically allocated objects in it,
3093 * e.g. extended_data.
3095 * @param frame frame to be freed. The pointer will be set to NULL.
3097 * @warning this function does NOT free the data buffers themselves
3098 * (it does not know how, since they might have been allocated with
3099 * a custom get_buffer()).
3101 void avcodec_free_frame(AVFrame **frame);
3104 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3105 * function the context has to be allocated with avcodec_alloc_context3().
3107 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3108 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3109 * retrieving a codec.
3111 * @warning This function is not thread safe!
3114 * avcodec_register_all();
3115 * av_dict_set(&opts, "b", "2.5M", 0);
3116 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3120 * context = avcodec_alloc_context3(codec);
3122 * if (avcodec_open2(context, codec, opts) < 0)
3126 * @param avctx The context to initialize.
3127 * @param codec The codec to open this context for. If a non-NULL codec has been
3128 * previously passed to avcodec_alloc_context3() or
3129 * avcodec_get_context_defaults3() for this context, then this
3130 * parameter MUST be either NULL or equal to the previously passed
3132 * @param options A dictionary filled with AVCodecContext and codec-private options.
3133 * On return this object will be filled with options that were not found.
3135 * @return zero on success, a negative value on error
3136 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3137 * av_dict_set(), av_opt_find().
3139 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3142 * Close a given AVCodecContext and free all the data associated with it
3143 * (but not the AVCodecContext itself).
3145 * Calling this function on an AVCodecContext that hasn't been opened will free
3146 * the codec-specific data allocated in avcodec_alloc_context3() /
3147 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3150 int avcodec_close(AVCodecContext *avctx);
3153 * Free all allocated data in the given subtitle struct.
3155 * @param sub AVSubtitle to free.
3157 void avsubtitle_free(AVSubtitle *sub);
3164 * @addtogroup lavc_packet
3168 #if FF_API_DESTRUCT_PACKET
3170 * Default packet destructor.
3171 * @deprecated use the AVBuffer API instead
3173 attribute_deprecated
3174 void av_destruct_packet(AVPacket *pkt);
3178 * Initialize optional fields of a packet with default values.
3180 * Note, this does not touch the data and size members, which have to be
3181 * initialized separately.
3185 void av_init_packet(AVPacket *pkt);
3188 * Allocate the payload of a packet and initialize its fields with
3192 * @param size wanted payload size
3193 * @return 0 if OK, AVERROR_xxx otherwise
3195 int av_new_packet(AVPacket *pkt, int size);
3198 * Reduce packet size, correctly zeroing padding
3201 * @param size new size
3203 void av_shrink_packet(AVPacket *pkt, int size);
3206 * Increase packet size, correctly zeroing padding
3209 * @param grow_by number of bytes by which to increase the size of the packet
3211 int av_grow_packet(AVPacket *pkt, int grow_by);
3214 * Initialize a reference-counted packet from av_malloc()ed data.
3216 * @param pkt packet to be initialized. This function will set the data, size,
3217 * buf and destruct fields, all others are left untouched.
3218 * @param data Data allocated by av_malloc() to be used as packet data. If this
3219 * function returns successfully, the data is owned by the underlying AVBuffer.
3220 * The caller may not access the data through other means.
3221 * @param size size of data in bytes, without the padding. I.e. the full buffer
3222 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3224 * @return 0 on success, a negative AVERROR on error
3226 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3229 * @warning This is a hack - the packet memory allocation stuff is broken. The
3230 * packet is allocated if it was not really allocated.
3232 int av_dup_packet(AVPacket *pkt);
3237 * @param pkt packet to free
3239 void av_free_packet(AVPacket *pkt);
3242 * Allocate new information of a packet.
3245 * @param type side information type
3246 * @param size side information size
3247 * @return pointer to fresh allocated data or NULL otherwise
3249 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3253 * Shrink the already allocated side data buffer
3256 * @param type side information type
3257 * @param size new side information size
3258 * @return 0 on success, < 0 on failure
3260 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3264 * Get side information from packet.
3267 * @param type desired side information type
3268 * @param size pointer for side information size to store (optional)
3269 * @return pointer to data if present or NULL otherwise
3271 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3275 * Convenience function to free all the side data stored.
3276 * All the other fields stay untouched.
3280 void av_packet_free_side_data(AVPacket *pkt);
3283 * Setup a new reference to the data described by a given packet
3285 * If src is reference-counted, setup dst as a new reference to the
3286 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3287 * data from src into it.
3289 * All the other fields are copied from src.
3291 * @see av_packet_unref
3293 * @param dst Destination packet
3294 * @param src Source packet
3296 * @return 0 on success, a negative AVERROR on error.
3298 int av_packet_ref(AVPacket *dst, AVPacket *src);
3303 * Unreference the buffer referenced by the packet and reset the
3304 * remaining packet fields to their default values.
3306 * @param pkt The packet to be unreferenced.
3308 void av_packet_unref(AVPacket *pkt);
3311 * Move every field in src to dst and reset src.
3313 * @see av_packet_unref
3315 * @param src Source packet, will be reset
3316 * @param dst Destination packet
3318 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3321 * Copy only "properties" fields from src to dst.
3323 * Properties for the purpose of this function are all the fields
3324 * beside those related to the packet data (buf, data, size)
3326 * @param dst Destination packet
3327 * @param src Source packet
3329 * @return 0 on success AVERROR on failure.
3332 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3339 * @addtogroup lavc_decoding
3344 * Find a registered decoder with a matching codec ID.
3346 * @param id AVCodecID of the requested decoder
3347 * @return A decoder if one was found, NULL otherwise.
3349 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3352 * Find a registered decoder with the specified name.
3354 * @param name name of the requested decoder
3355 * @return A decoder if one was found, NULL otherwise.
3357 AVCodec *avcodec_find_decoder_by_name(const char *name);
3359 #if FF_API_GET_BUFFER
3360 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3361 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3362 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3366 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3367 * it can be called by custom get_buffer2() implementations for decoders without
3368 * CODEC_CAP_DR1 set.
3370 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3373 * Return the amount of padding in pixels which the get_buffer callback must
3374 * provide around the edge of the image for codecs which do not have the
3375 * CODEC_FLAG_EMU_EDGE flag.
3377 * @return Required padding in pixels.
3379 unsigned avcodec_get_edge_width(void);
3382 * Modify width and height values so that they will result in a memory
3383 * buffer that is acceptable for the codec if you do not use any horizontal
3386 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3387 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3388 * according to avcodec_get_edge_width() before.
3390 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3393 * Modify width and height values so that they will result in a memory
3394 * buffer that is acceptable for the codec if you also ensure that all
3395 * line sizes are a multiple of the respective linesize_align[i].
3397 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3398 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3399 * according to avcodec_get_edge_width() before.
3401 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3402 int linesize_align[AV_NUM_DATA_POINTERS]);
3405 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3407 * Some decoders may support multiple frames in a single AVPacket. Such
3408 * decoders would then just decode the first frame and the return value would be
3409 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3410 * called again with an AVPacket containing the remaining data in order to
3411 * decode the second frame, etc... Even if no frames are returned, the packet
3412 * needs to be fed to the decoder with remaining data until it is completely
3413 * consumed or an error occurs.
3415 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3416 * and output. This means that for some packets they will not immediately
3417 * produce decoded output and need to be flushed at the end of decoding to get
3418 * all the decoded data. Flushing is done by calling this function with packets
3419 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3420 * returning samples. It is safe to flush even those decoders that are not
3421 * marked with CODEC_CAP_DELAY, then no samples will be returned.
3423 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3424 * larger than the actual read bytes because some optimized bitstream
3425 * readers read 32 or 64 bits at once and could read over the end.
3427 * @param avctx the codec context
3428 * @param[out] frame The AVFrame in which to store decoded audio samples.
3429 * The decoder will allocate a buffer for the decoded frame by
3430 * calling the AVCodecContext.get_buffer2() callback.
3431 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3432 * reference counted and the returned reference belongs to the
3433 * caller. The caller must release the frame using av_frame_unref()
3434 * when the frame is no longer needed. The caller may safely write
3435 * to the frame if av_frame_is_writable() returns 1.
3436 * When AVCodecContext.refcounted_frames is set to 0, the returned
3437 * reference belongs to the decoder and is valid only until the
3438 * next call to this function or until closing or flushing the
3439 * decoder. The caller may not write to it.
3440 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3441 * non-zero. Note that this field being set to zero
3442 * does not mean that an error has occurred. For
3443 * decoders with CODEC_CAP_DELAY set, no given decode
3444 * call is guaranteed to produce a frame.
3445 * @param[in] avpkt The input AVPacket containing the input buffer.
3446 * At least avpkt->data and avpkt->size should be set. Some
3447 * decoders might also require additional fields to be set.
3448 * @return A negative error code is returned if an error occurred during
3449 * decoding, otherwise the number of bytes consumed from the input
3450 * AVPacket is returned.
3452 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3453 int *got_frame_ptr, AVPacket *avpkt);
3456 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3457 * Some decoders may support multiple frames in a single AVPacket, such
3458 * decoders would then just decode the first frame.
3460 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3461 * the actual read bytes because some optimized bitstream readers read 32 or 64
3462 * bits at once and could read over the end.
3464 * @warning The end of the input buffer buf should be set to 0 to ensure that
3465 * no overreading happens for damaged MPEG streams.
3467 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3468 * between input and output, these need to be fed with avpkt->data=NULL,
3469 * avpkt->size=0 at the end to return the remaining frames.
3471 * @param avctx the codec context
3472 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3473 * Use av_frame_alloc() to get an AVFrame. The codec will
3474 * allocate memory for the actual bitmap by calling the
3475 * AVCodecContext.get_buffer2() callback.
3476 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3477 * reference counted and the returned reference belongs to the
3478 * caller. The caller must release the frame using av_frame_unref()
3479 * when the frame is no longer needed. The caller may safely write
3480 * to the frame if av_frame_is_writable() returns 1.
3481 * When AVCodecContext.refcounted_frames is set to 0, the returned
3482 * reference belongs to the decoder and is valid only until the
3483 * next call to this function or until closing or flushing the
3484 * decoder. The caller may not write to it.
3486 * @param[in] avpkt The input AVpacket containing the input buffer.
3487 * You can create such packet with av_init_packet() and by then setting
3488 * data and size, some decoders might in addition need other fields like
3489 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3491 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3492 * @return On error a negative value is returned, otherwise the number of bytes
3493 * used or zero if no frame could be decompressed.
3495 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3496 int *got_picture_ptr,
3500 * Decode a subtitle message.
3501 * Return a negative value on error, otherwise return the number of bytes used.
3502 * If no subtitle could be decompressed, got_sub_ptr is zero.
3503 * Otherwise, the subtitle is stored in *sub.
3504 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3505 * simplicity, because the performance difference is expect to be negligible
3506 * and reusing a get_buffer written for video codecs would probably perform badly
3507 * due to a potentially very different allocation pattern.
3509 * @param avctx the codec context
3510 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3511 freed with avsubtitle_free if *got_sub_ptr is set.
3512 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3513 * @param[in] avpkt The input AVPacket containing the input buffer.
3515 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3520 * @defgroup lavc_parsing Frame parsing
3524 enum AVPictureStructure {
3525 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3526 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3527 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3528 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3531 typedef struct AVCodecParserContext {
3533 struct AVCodecParser *parser;
3534 int64_t frame_offset; /* offset of the current frame */
3535 int64_t cur_offset; /* current offset
3536 (incremented by each av_parser_parse()) */
3537 int64_t next_frame_offset; /* offset of the next frame */
3539 int pict_type; /* XXX: Put it back in AVCodecContext. */
3541 * This field is used for proper frame duration computation in lavf.
3542 * It signals, how much longer the frame duration of the current frame
3543 * is compared to normal frame duration.
3545 * frame_duration = (1 + repeat_pict) * time_base
3547 * It is used by codecs like H.264 to display telecined material.
3549 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3550 int64_t pts; /* pts of the current frame */
3551 int64_t dts; /* dts of the current frame */
3556 int fetch_timestamp;
3558 #define AV_PARSER_PTS_NB 4
3559 int cur_frame_start_index;
3560 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3561 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3562 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3565 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3566 #define PARSER_FLAG_ONCE 0x0002
3567 /// Set if the parser has a valid file offset
3568 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3570 int64_t offset; ///< byte offset from starting packet start
3571 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3574 * Set by parser to 1 for key frames and 0 for non-key frames.
3575 * It is initialized to -1, so if the parser doesn't set this flag,
3576 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3582 * Time difference in stream time base units from the pts of this
3583 * packet to the point at which the output from the decoder has converged
3584 * independent from the availability of previous frames. That is, the
3585 * frames are virtually identical no matter if decoding started from
3586 * the very first frame or from this keyframe.
3587 * Is AV_NOPTS_VALUE if unknown.
3588 * This field is not the display duration of the current frame.
3589 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3592 * The purpose of this field is to allow seeking in streams that have no
3593 * keyframes in the conventional sense. It corresponds to the
3594 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3595 * essential for some types of subtitle streams to ensure that all
3596 * subtitles are correctly displayed after seeking.
3598 int64_t convergence_duration;
3600 // Timestamp generation support:
3602 * Synchronization point for start of timestamp generation.
3604 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3607 * For example, this corresponds to presence of H.264 buffering period
3613 * Offset of the current timestamp against last timestamp sync point in
3614 * units of AVCodecContext.time_base.
3616 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3617 * contain a valid timestamp offset.
3619 * Note that the timestamp of sync point has usually a nonzero
3620 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3621 * the next frame after timestamp sync point will be usually 1.
3623 * For example, this corresponds to H.264 cpb_removal_delay.
3625 int dts_ref_dts_delta;
3628 * Presentation delay of current frame in units of AVCodecContext.time_base.
3630 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3631 * contain valid non-negative timestamp delta (presentation time of a frame
3632 * must not lie in the past).
3634 * This delay represents the difference between decoding and presentation
3635 * time of the frame.
3637 * For example, this corresponds to H.264 dpb_output_delay.
3642 * Position of the packet in file.
3644 * Analogous to cur_frame_pts/dts
3646 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3649 * Byte position of currently parsed frame in stream.
3654 * Previous frame byte position.
3659 * Duration of the current frame.
3660 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3661 * For all other types, this is in units of AVCodecContext.time_base.
3665 enum AVFieldOrder field_order;
3668 * Indicate whether a picture is coded as a frame, top field or bottom field.
3670 * For example, H.264 field_pic_flag equal to 0 corresponds to
3671 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3672 * equal to 1 and bottom_field_flag equal to 0 corresponds to
3673 * AV_PICTURE_STRUCTURE_TOP_FIELD.
3675 enum AVPictureStructure picture_structure;
3678 * Picture number incremented in presentation or output order.
3679 * This field may be reinitialized at the first picture of a new sequence.
3681 * For example, this corresponds to H.264 PicOrderCnt.
3683 int output_picture_number;
3684 } AVCodecParserContext;
3686 typedef struct AVCodecParser {
3687 int codec_ids[5]; /* several codec IDs are permitted */
3689 int (*parser_init)(AVCodecParserContext *s);
3690 int (*parser_parse)(AVCodecParserContext *s,
3691 AVCodecContext *avctx,
3692 const uint8_t **poutbuf, int *poutbuf_size,
3693 const uint8_t *buf, int buf_size);
3694 void (*parser_close)(AVCodecParserContext *s);
3695 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3696 struct AVCodecParser *next;
3699 AVCodecParser *av_parser_next(AVCodecParser *c);
3701 void av_register_codec_parser(AVCodecParser *parser);
3702 AVCodecParserContext *av_parser_init(int codec_id);
3707 * @param s parser context.
3708 * @param avctx codec context.
3709 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3710 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3711 * @param buf input buffer.
3712 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3713 * @param pts input presentation timestamp.
3714 * @param dts input decoding timestamp.
3715 * @param pos input byte position in stream.
3716 * @return the number of bytes of the input bitstream used.
3721 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3728 * decode_frame(data, size);
3732 int av_parser_parse2(AVCodecParserContext *s,
3733 AVCodecContext *avctx,
3734 uint8_t **poutbuf, int *poutbuf_size,
3735 const uint8_t *buf, int buf_size,
3736 int64_t pts, int64_t dts,
3740 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3741 * @deprecated use AVBitstreamFilter
3743 int av_parser_change(AVCodecParserContext *s,
3744 AVCodecContext *avctx,
3745 uint8_t **poutbuf, int *poutbuf_size,
3746 const uint8_t *buf, int buf_size, int keyframe);
3747 void av_parser_close(AVCodecParserContext *s);
3755 * @addtogroup lavc_encoding
3760 * Find a registered encoder with a matching codec ID.
3762 * @param id AVCodecID of the requested encoder
3763 * @return An encoder if one was found, NULL otherwise.
3765 AVCodec *avcodec_find_encoder(enum AVCodecID id);
3768 * Find a registered encoder with the specified name.
3770 * @param name name of the requested encoder
3771 * @return An encoder if one was found, NULL otherwise.
3773 AVCodec *avcodec_find_encoder_by_name(const char *name);
3776 * Encode a frame of audio.
3778 * Takes input samples from frame and writes the next output packet, if
3779 * available, to avpkt. The output packet does not necessarily contain data for
3780 * the most recent frame, as encoders can delay, split, and combine input frames
3781 * internally as needed.
3783 * @param avctx codec context
3784 * @param avpkt output AVPacket.
3785 * The user can supply an output buffer by setting
3786 * avpkt->data and avpkt->size prior to calling the
3787 * function, but if the size of the user-provided data is not
3788 * large enough, encoding will fail. All other AVPacket fields
3789 * will be reset by the encoder using av_init_packet(). If
3790 * avpkt->data is NULL, the encoder will allocate it.
3791 * The encoder will set avpkt->size to the size of the
3794 * If this function fails or produces no output, avpkt will be
3795 * freed using av_free_packet() (i.e. avpkt->destruct will be
3796 * called to free the user supplied buffer).
3797 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3798 * May be NULL when flushing an encoder that has the
3799 * CODEC_CAP_DELAY capability set.
3800 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3801 * can have any number of samples.
3802 * If it is not set, frame->nb_samples must be equal to
3803 * avctx->frame_size for all frames except the last.
3804 * The final frame may be smaller than avctx->frame_size.
3805 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3806 * output packet is non-empty, and to 0 if it is
3807 * empty. If the function returns an error, the
3808 * packet can be assumed to be invalid, and the
3809 * value of got_packet_ptr is undefined and should
3811 * @return 0 on success, negative error code on failure
3813 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3814 const AVFrame *frame, int *got_packet_ptr);
3817 * Encode a frame of video.
3819 * Takes input raw video data from frame and writes the next output packet, if
3820 * available, to avpkt. The output packet does not necessarily contain data for
3821 * the most recent frame, as encoders can delay and reorder input frames
3822 * internally as needed.
3824 * @param avctx codec context
3825 * @param avpkt output AVPacket.
3826 * The user can supply an output buffer by setting
3827 * avpkt->data and avpkt->size prior to calling the
3828 * function, but if the size of the user-provided data is not
3829 * large enough, encoding will fail. All other AVPacket fields
3830 * will be reset by the encoder using av_init_packet(). If
3831 * avpkt->data is NULL, the encoder will allocate it.
3832 * The encoder will set avpkt->size to the size of the
3833 * output packet. The returned data (if any) belongs to the
3834 * caller, he is responsible for freeing it.
3836 * If this function fails or produces no output, avpkt will be
3837 * freed using av_free_packet() (i.e. avpkt->destruct will be
3838 * called to free the user supplied buffer).
3839 * @param[in] frame AVFrame containing the raw video data to be encoded.
3840 * May be NULL when flushing an encoder that has the
3841 * CODEC_CAP_DELAY capability set.
3842 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3843 * output packet is non-empty, and to 0 if it is
3844 * empty. If the function returns an error, the
3845 * packet can be assumed to be invalid, and the
3846 * value of got_packet_ptr is undefined and should
3848 * @return 0 on success, negative error code on failure
3850 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3851 const AVFrame *frame, int *got_packet_ptr);
3853 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3854 const AVSubtitle *sub);
3862 * @addtogroup lavc_picture
3867 * Allocate memory for a picture. Call avpicture_free() to free it.
3869 * @see avpicture_fill()
3871 * @param picture the picture to be filled in
3872 * @param pix_fmt the format of the picture
3873 * @param width the width of the picture
3874 * @param height the height of the picture
3875 * @return zero if successful, a negative value if not
3877 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
3880 * Free a picture previously allocated by avpicture_alloc().
3881 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3884 * @param picture the AVPicture to be freed
3886 void avpicture_free(AVPicture *picture);
3889 * Fill in the AVPicture fields.
3890 * The fields of the given AVPicture are filled in by using the 'ptr' address
3891 * which points to the image data buffer. Depending on the specified picture
3892 * format, one or multiple image data pointers and line sizes will be set.
3893 * If a planar format is specified, several pointers will be set pointing to
3894 * the different picture planes and the line sizes of the different planes
3895 * will be stored in the lines_sizes array.
3896 * Call with ptr == NULL to get the required size for the ptr buffer.
3898 * To allocate the buffer and fill in the AVPicture fields in one call,
3899 * use avpicture_alloc().
3901 * @param picture AVPicture whose fields are to be filled in
3902 * @param ptr Buffer which will contain or contains the actual image data
3903 * @param pix_fmt The format in which the picture data is stored.
3904 * @param width the width of the image in pixels
3905 * @param height the height of the image in pixels
3906 * @return size of the image data in bytes
3908 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3909 enum AVPixelFormat pix_fmt, int width, int height);
3912 * Copy pixel data from an AVPicture into a buffer.
3913 * The data is stored compactly, without any gaps for alignment or padding
3914 * which may be applied by avpicture_fill().
3916 * @see avpicture_get_size()
3918 * @param[in] src AVPicture containing image data
3919 * @param[in] pix_fmt The format in which the picture data is stored.
3920 * @param[in] width the width of the image in pixels.
3921 * @param[in] height the height of the image in pixels.
3922 * @param[out] dest A buffer into which picture data will be copied.
3923 * @param[in] dest_size The size of 'dest'.
3924 * @return The number of bytes written to dest, or a negative value (error code) on error.
3926 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
3927 int width, int height,
3928 unsigned char *dest, int dest_size);
3931 * Calculate the size in bytes that a picture of the given width and height
3932 * would occupy if stored in the given picture format.
3933 * Note that this returns the size of a compact representation as generated
3934 * by avpicture_layout(), which can be smaller than the size required for e.g.
3937 * @param pix_fmt the given picture format
3938 * @param width the width of the image
3939 * @param height the height of the image
3940 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3942 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
3944 #if FF_API_DEINTERLACE
3946 * deinterlace - if not supported return -1
3948 * @deprecated - use yadif (in libavfilter) instead
3950 attribute_deprecated
3951 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3952 enum AVPixelFormat pix_fmt, int width, int height);
3955 * Copy image src to dst. Wraps av_picture_data_copy() above.
3957 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3958 enum AVPixelFormat pix_fmt, int width, int height);
3961 * Crop image top and left side.
3963 int av_picture_crop(AVPicture *dst, const AVPicture *src,
3964 enum AVPixelFormat pix_fmt, int top_band, int left_band);
3969 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
3970 int padtop, int padbottom, int padleft, int padright, int *color);
3977 * @defgroup lavc_misc Utility functions
3980 * Miscellaneous utility functions related to both encoding and decoding
3986 * @defgroup lavc_misc_pixfmt Pixel formats
3988 * Functions for working with pixel formats.
3993 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
3996 void attribute_deprecated avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
3999 * Return a value representing the fourCC code associated to the
4000 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4003 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4005 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4006 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4007 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4008 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4009 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4010 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4013 * Compute what kind of losses will occur when converting from one specific
4014 * pixel format to another.
4015 * When converting from one pixel format to another, information loss may occur.
4016 * For example, when converting from RGB24 to GRAY, the color information will
4017 * be lost. Similarly, other losses occur when converting from some formats to
4018 * other formats. These losses can involve loss of chroma, but also loss of
4019 * resolution, loss of color depth, loss due to the color space conversion, loss
4020 * of the alpha bits or loss due to color quantization.
4021 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4022 * which will occur when converting from one pixel format to another.
4024 * @param[in] dst_pix_fmt destination pixel format
4025 * @param[in] src_pix_fmt source pixel format
4026 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4027 * @return Combination of flags informing you what kind of losses will occur.
4029 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4033 * Find the best pixel format to convert to given a certain source pixel
4034 * format. When converting from one pixel format to another, information loss
4035 * may occur. For example, when converting from RGB24 to GRAY, the color
4036 * information will be lost. Similarly, other losses occur when converting from
4037 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4038 * the given pixel formats should be used to suffer the least amount of loss.
4039 * The pixel formats from which it chooses one, are determined by the
4040 * pix_fmt_list parameter.
4043 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4044 * @param[in] src_pix_fmt source pixel format
4045 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4046 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4047 * @return The best pixel format to convert to or -1 if none was found.
4049 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4050 enum AVPixelFormat src_pix_fmt,
4051 int has_alpha, int *loss_ptr);
4053 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4059 #if FF_API_SET_DIMENSIONS
4061 * @deprecated this function is not supposed to be used from outside of lavc
4063 attribute_deprecated
4064 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4068 * Put a string representing the codec tag codec_tag in buf.
4070 * @param buf_size size in bytes of buf
4071 * @return the length of the string that would have been generated if
4072 * enough space had been available, excluding the trailing null
4074 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4076 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4079 * Return a name for the specified profile, if available.
4081 * @param codec the codec that is searched for the given profile
4082 * @param profile the profile value for which a name is requested
4083 * @return A name for the profile if found, NULL otherwise.
4085 const char *av_get_profile_name(const AVCodec *codec, int profile);
4087 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4088 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4089 //FIXME func typedef
4092 * Fill audio frame data and linesize.
4093 * AVFrame extended_data channel pointers are allocated if necessary for
4096 * @param frame the AVFrame
4097 * frame->nb_samples must be set prior to calling the
4098 * function. This function fills in frame->data,
4099 * frame->extended_data, frame->linesize[0].
4100 * @param nb_channels channel count
4101 * @param sample_fmt sample format
4102 * @param buf buffer to use for frame data
4103 * @param buf_size size of buffer
4104 * @param align plane size sample alignment (0 = default)
4105 * @return 0 on success, negative error code on failure
4107 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4108 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4109 int buf_size, int align);
4112 * Reset the internal decoder state / flush internal buffers. Should be called
4113 * e.g. when seeking or when switching to a different stream.
4115 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4116 * this invalidates the frames previously returned from the decoder. When
4117 * refcounted frames are used, the decoder just releases any references it might
4118 * keep internally, but the caller's reference remains valid.
4120 void avcodec_flush_buffers(AVCodecContext *avctx);
4123 * Return codec bits per sample.
4125 * @param[in] codec_id the codec
4126 * @return Number of bits per sample or zero if unknown for the given codec.
4128 int av_get_bits_per_sample(enum AVCodecID codec_id);
4131 * Return codec bits per sample.
4132 * Only return non-zero if the bits per sample is exactly correct, not an
4135 * @param[in] codec_id the codec
4136 * @return Number of bits per sample or zero if unknown for the given codec.
4138 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4141 * Return audio frame duration.
4143 * @param avctx codec context
4144 * @param frame_bytes size of the frame, or 0 if unknown
4145 * @return frame duration, in samples, if known. 0 if not able to
4148 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4151 typedef struct AVBitStreamFilterContext {
4153 struct AVBitStreamFilter *filter;
4154 AVCodecParserContext *parser;
4155 struct AVBitStreamFilterContext *next;
4156 } AVBitStreamFilterContext;
4159 typedef struct AVBitStreamFilter {
4162 int (*filter)(AVBitStreamFilterContext *bsfc,
4163 AVCodecContext *avctx, const char *args,
4164 uint8_t **poutbuf, int *poutbuf_size,
4165 const uint8_t *buf, int buf_size, int keyframe);
4166 void (*close)(AVBitStreamFilterContext *bsfc);
4167 struct AVBitStreamFilter *next;
4168 } AVBitStreamFilter;
4170 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4171 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4172 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4173 AVCodecContext *avctx, const char *args,
4174 uint8_t **poutbuf, int *poutbuf_size,
4175 const uint8_t *buf, int buf_size, int keyframe);
4176 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4178 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4183 * Reallocate the given block if it is not large enough, otherwise do nothing.
4187 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4190 * Allocate a buffer, reusing the given one if large enough.
4192 * Contrary to av_fast_realloc the current buffer contents might not be
4193 * preserved and on error the old buffer is freed, thus no special
4194 * handling to avoid memleaks is necessary.
4196 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4197 * @param size size of the buffer *ptr points to
4198 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4199 * *size 0 if an error occurred.
4201 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4204 * Allocate a buffer with padding, reusing the given one if large enough.
4206 * Same behaviour av_fast_malloc but the buffer has additional
4207 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4210 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4213 * Encode extradata length to a buffer. Used by xiph codecs.
4215 * @param s buffer to write to; must be at least (v/255+1) bytes long
4216 * @param v size of extradata in bytes
4217 * @return number of bytes written to the buffer.
4219 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4221 #if FF_API_MISSING_SAMPLE
4223 * Log a generic warning message about a missing feature. This function is
4224 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4225 * only, and would normally not be used by applications.
4226 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4227 * a pointer to an AVClass struct
4228 * @param[in] feature string containing the name of the missing feature
4229 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4230 * If want_sample is non-zero, additional verbage will be added to the log
4231 * message which tells the user how to report samples to the development
4233 * @deprecated Use avpriv_report_missing_feature() instead.
4235 attribute_deprecated
4236 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4239 * Log a generic warning message asking for a sample. This function is
4240 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4241 * only, and would normally not be used by applications.
4242 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4243 * a pointer to an AVClass struct
4244 * @param[in] msg string containing an optional message, or NULL if no message
4245 * @deprecated Use avpriv_request_sample() instead.
4247 attribute_deprecated
4248 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4249 #endif /* FF_API_MISSING_SAMPLE */
4252 * Register the hardware accelerator hwaccel.
4254 void av_register_hwaccel(AVHWAccel *hwaccel);
4257 * If hwaccel is NULL, returns the first registered hardware accelerator,
4258 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4259 * after hwaccel, or NULL if hwaccel is the last one.
4261 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4265 * Lock operation used by lockmgr
4268 AV_LOCK_CREATE, ///< Create a mutex
4269 AV_LOCK_OBTAIN, ///< Lock the mutex
4270 AV_LOCK_RELEASE, ///< Unlock the mutex
4271 AV_LOCK_DESTROY, ///< Free mutex resources
4275 * Register a user provided lock manager supporting the operations
4276 * specified by AVLockOp. mutex points to a (void *) where the
4277 * lockmgr should store/get a pointer to a user allocated mutex. It's
4278 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4280 * @param cb User defined callback. Note: Libav may invoke calls to this
4281 * callback during the call to av_lockmgr_register().
4282 * Thus, the application must be prepared to handle that.
4283 * If cb is set to NULL the lockmgr will be unregistered.
4284 * Also note that during unregistration the previously registered
4285 * lockmgr callback may also be invoked.
4287 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4290 * Get the type of the given codec.
4292 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4295 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4296 * with no corresponding avcodec_close()), 0 otherwise.
4298 int avcodec_is_open(AVCodecContext *s);
4301 * @return a non-zero number if codec is an encoder, zero otherwise
4303 int av_codec_is_encoder(const AVCodec *codec);
4306 * @return a non-zero number if codec is a decoder, zero otherwise
4308 int av_codec_is_decoder(const AVCodec *codec);
4311 * @return descriptor for given codec ID or NULL if no descriptor exists.
4313 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4316 * Iterate over all codec descriptors known to libavcodec.
4318 * @param prev previous descriptor. NULL to get the first descriptor.
4320 * @return next descriptor or NULL after the last descriptor
4322 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4325 * @return codec descriptor with the given name or NULL if no such descriptor
4328 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4334 #endif /* AVCODEC_AVCODEC_H */