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
107 AV_CODEC_ID_MPEG2VIDEO_XVMC,
108 #endif /* FF_API_XVMC */
119 AV_CODEC_ID_RAWVIDEO,
120 AV_CODEC_ID_MSMPEG4V1,
121 AV_CODEC_ID_MSMPEG4V2,
122 AV_CODEC_ID_MSMPEG4V3,
145 AV_CODEC_ID_INTERPLAY_VIDEO,
152 AV_CODEC_ID_MSVIDEO1,
157 AV_CODEC_ID_TRUEMOTION1,
158 AV_CODEC_ID_VMDVIDEO,
183 AV_CODEC_ID_TRUEMOTION2,
189 AV_CODEC_ID_SMACKVIDEO,
194 AV_CODEC_ID_JPEG2000,
200 AV_CODEC_ID_DSICINVIDEO,
201 AV_CODEC_ID_TIERTEXSEQVIDEO,
209 AV_CODEC_ID_BETHSOFTVID,
221 AV_CODEC_ID_ESCAPE124,
225 AV_CODEC_ID_MOTIONPIXELS,
237 AV_CODEC_ID_FLASHSV2,
238 AV_CODEC_ID_CDGRAPHICS,
241 AV_CODEC_ID_BINKVIDEO,
242 AV_CODEC_ID_IFF_ILBM,
243 AV_CODEC_ID_IFF_BYTERUN1,
249 AV_CODEC_ID_A64_MULTI,
250 AV_CODEC_ID_A64_MULTI5,
253 AV_CODEC_ID_LAGARITH,
257 AV_CODEC_ID_WMV3IMAGE,
258 AV_CODEC_ID_VC1IMAGE,
260 AV_CODEC_ID_BMV_VIDEO,
267 AV_CODEC_ID_ZEROCODEC,
276 AV_CODEC_ID_ESCAPE130,
279 AV_CODEC_ID_HNM4_VIDEO,
282 /* various PCM "codecs" */
283 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
284 AV_CODEC_ID_PCM_S16LE = 0x10000,
285 AV_CODEC_ID_PCM_S16BE,
286 AV_CODEC_ID_PCM_U16LE,
287 AV_CODEC_ID_PCM_U16BE,
290 AV_CODEC_ID_PCM_MULAW,
291 AV_CODEC_ID_PCM_ALAW,
292 AV_CODEC_ID_PCM_S32LE,
293 AV_CODEC_ID_PCM_S32BE,
294 AV_CODEC_ID_PCM_U32LE,
295 AV_CODEC_ID_PCM_U32BE,
296 AV_CODEC_ID_PCM_S24LE,
297 AV_CODEC_ID_PCM_S24BE,
298 AV_CODEC_ID_PCM_U24LE,
299 AV_CODEC_ID_PCM_U24BE,
300 AV_CODEC_ID_PCM_S24DAUD,
301 AV_CODEC_ID_PCM_ZORK,
302 AV_CODEC_ID_PCM_S16LE_PLANAR,
304 AV_CODEC_ID_PCM_F32BE,
305 AV_CODEC_ID_PCM_F32LE,
306 AV_CODEC_ID_PCM_F64BE,
307 AV_CODEC_ID_PCM_F64LE,
308 AV_CODEC_ID_PCM_BLURAY,
311 AV_CODEC_ID_PCM_S8_PLANAR,
312 AV_CODEC_ID_PCM_S24LE_PLANAR,
313 AV_CODEC_ID_PCM_S32LE_PLANAR,
315 /* various ADPCM codecs */
316 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
317 AV_CODEC_ID_ADPCM_IMA_WAV,
318 AV_CODEC_ID_ADPCM_IMA_DK3,
319 AV_CODEC_ID_ADPCM_IMA_DK4,
320 AV_CODEC_ID_ADPCM_IMA_WS,
321 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
322 AV_CODEC_ID_ADPCM_MS,
323 AV_CODEC_ID_ADPCM_4XM,
324 AV_CODEC_ID_ADPCM_XA,
325 AV_CODEC_ID_ADPCM_ADX,
326 AV_CODEC_ID_ADPCM_EA,
327 AV_CODEC_ID_ADPCM_G726,
328 AV_CODEC_ID_ADPCM_CT,
329 AV_CODEC_ID_ADPCM_SWF,
330 AV_CODEC_ID_ADPCM_YAMAHA,
331 AV_CODEC_ID_ADPCM_SBPRO_4,
332 AV_CODEC_ID_ADPCM_SBPRO_3,
333 AV_CODEC_ID_ADPCM_SBPRO_2,
334 AV_CODEC_ID_ADPCM_THP,
335 AV_CODEC_ID_ADPCM_IMA_AMV,
336 AV_CODEC_ID_ADPCM_EA_R1,
337 AV_CODEC_ID_ADPCM_EA_R3,
338 AV_CODEC_ID_ADPCM_EA_R2,
339 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
340 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
341 AV_CODEC_ID_ADPCM_EA_XAS,
342 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
343 AV_CODEC_ID_ADPCM_IMA_ISS,
344 AV_CODEC_ID_ADPCM_G722,
345 AV_CODEC_ID_ADPCM_IMA_APC,
348 AV_CODEC_ID_AMR_NB = 0x12000,
351 /* RealAudio codecs*/
352 AV_CODEC_ID_RA_144 = 0x13000,
355 /* various DPCM codecs */
356 AV_CODEC_ID_ROQ_DPCM = 0x14000,
357 AV_CODEC_ID_INTERPLAY_DPCM,
358 AV_CODEC_ID_XAN_DPCM,
359 AV_CODEC_ID_SOL_DPCM,
362 AV_CODEC_ID_MP2 = 0x15000,
363 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
373 AV_CODEC_ID_VMDAUDIO,
379 AV_CODEC_ID_WESTWOOD_SND1,
380 AV_CODEC_ID_GSM, ///< as in Berlin toast format
383 AV_CODEC_ID_TRUESPEECH,
385 AV_CODEC_ID_SMACKAUDIO,
388 AV_CODEC_ID_DSICINAUDIO,
390 AV_CODEC_ID_MUSEPACK7,
392 AV_CODEC_ID_GSM_MS, /* as found in WAV */
398 AV_CODEC_ID_NELLYMOSER,
399 AV_CODEC_ID_MUSEPACK8,
401 AV_CODEC_ID_WMAVOICE,
403 AV_CODEC_ID_WMALOSSLESS,
412 AV_CODEC_ID_BINKAUDIO_RDFT,
413 AV_CODEC_ID_BINKAUDIO_DCT,
414 AV_CODEC_ID_AAC_LATM,
419 AV_CODEC_ID_8SVX_EXP,
420 AV_CODEC_ID_8SVX_FIB,
421 AV_CODEC_ID_BMV_AUDIO,
426 AV_CODEC_ID_COMFORT_NOISE,
428 AV_CODEC_ID_METASOUND,
430 /* subtitle codecs */
431 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
432 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
433 AV_CODEC_ID_DVB_SUBTITLE,
434 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
437 AV_CODEC_ID_MOV_TEXT,
438 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
439 AV_CODEC_ID_DVB_TELETEXT,
442 /* other specific kind of codecs (generally used for attachments) */
443 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
444 AV_CODEC_ID_TTF = 0x18000,
446 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
448 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
449 * stream (only used by libavformat) */
450 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
451 * stream (only used by libavformat) */
452 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
456 * This struct describes the properties of a single codec described by an
458 * @see avcodec_get_descriptor()
460 typedef struct AVCodecDescriptor {
462 enum AVMediaType type;
464 * Name of the codec described by this descriptor. It is non-empty and
465 * unique for each codec descriptor. It should contain alphanumeric
466 * characters and '_' only.
470 * A more descriptive name for this codec. May be NULL.
472 const char *long_name;
474 * Codec properties, a combination of AV_CODEC_PROP_* flags.
480 * Codec uses only intra compression.
483 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
485 * Codec supports lossy compression. Audio and video codecs only.
486 * @note a codec may support both lossy and lossless
489 #define AV_CODEC_PROP_LOSSY (1 << 1)
491 * Codec supports lossless compression. Audio and video codecs only.
493 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
496 * @ingroup lavc_decoding
497 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
498 * This is mainly needed because some optimized bitstream readers read
499 * 32 or 64 bit at once and could read over the end.<br>
500 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
501 * MPEG bitstreams could cause overread and segfault.
503 #define FF_INPUT_BUFFER_PADDING_SIZE 8
506 * @ingroup lavc_encoding
507 * minimum encoding buffer size
508 * Used to avoid some checks during header writing.
510 #define FF_MIN_BUFFER_SIZE 16384
514 * @ingroup lavc_encoding
515 * motion estimation type.
518 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
522 ME_EPZS, ///< enhanced predictive zonal search
523 ME_X1, ///< reserved for experiments
524 ME_HEX, ///< hexagon based search
525 ME_UMH, ///< uneven multi-hexagon search
526 ME_TESA, ///< transformed exhaustive search algorithm
530 * @ingroup lavc_decoding
533 /* We leave some space between them for extensions (drop some
534 * keyframes for intra-only or drop just some bidir frames). */
535 AVDISCARD_NONE =-16, ///< discard nothing
536 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
537 AVDISCARD_NONREF = 8, ///< discard all non reference
538 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
539 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
540 AVDISCARD_ALL = 48, ///< discard all
543 enum AVColorPrimaries{
544 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
545 AVCOL_PRI_UNSPECIFIED = 2,
546 AVCOL_PRI_BT470M = 4,
547 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
548 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
549 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
551 AVCOL_PRI_BT2020 = 9, ///< ITU-R BT2020
552 AVCOL_PRI_NB , ///< Not part of ABI
555 enum AVColorTransferCharacteristic{
556 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
557 AVCOL_TRC_UNSPECIFIED = 2,
558 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
559 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
560 AVCOL_TRC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 or 625 / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC
561 AVCOL_TRC_SMPTE240M = 7,
562 AVCOL_TRC_LINEAR = 8, ///< "Linear transfer characteristics"
563 AVCOL_TRC_LOG = 9, ///< "Logarithmic transfer characteristic (100:1 range)"
564 AVCOL_TRC_LOG_SQRT = 10, ///< "Logarithmic transfer characteristic (100 * Sqrt( 10 ) : 1 range)"
565 AVCOL_TRC_IEC61966_2_4 = 11, ///< IEC 61966-2-4
566 AVCOL_TRC_BT1361_ECG = 12, ///< ITU-R BT1361 Extended Colour Gamut
567 AVCOL_TRC_IEC61966_2_1 = 13, ///< IEC 61966-2-1 (sRGB or sYCC)
568 AVCOL_TRC_BT2020_10 = 14, ///< ITU-R BT2020 for 10 bit system
569 AVCOL_TRC_BT2020_12 = 15, ///< ITU-R BT2020 for 12 bit system
570 AVCOL_TRC_NB , ///< Not part of ABI
575 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
576 AVCOL_SPC_UNSPECIFIED = 2,
578 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
579 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
580 AVCOL_SPC_SMPTE240M = 7,
581 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
582 AVCOL_SPC_BT2020_NCL = 9, ///< ITU-R BT2020 non-constant luminance system
583 AVCOL_SPC_BT2020_CL = 10, ///< ITU-R BT2020 constant luminance system
584 AVCOL_SPC_NB , ///< Not part of ABI
588 AVCOL_RANGE_UNSPECIFIED = 0,
589 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
590 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
591 AVCOL_RANGE_NB , ///< Not part of ABI
595 * X X 3 4 X X are luma samples,
596 * 1 2 1-6 are possible chroma positions
597 * X X 5 6 X 0 is undefined/unknown position
599 enum AVChromaLocation{
600 AVCHROMA_LOC_UNSPECIFIED = 0,
601 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
602 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
603 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
604 AVCHROMA_LOC_TOP = 4,
605 AVCHROMA_LOC_BOTTOMLEFT = 5,
606 AVCHROMA_LOC_BOTTOM = 6,
607 AVCHROMA_LOC_NB , ///< Not part of ABI
610 enum AVAudioServiceType {
611 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
612 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
613 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
614 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
615 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
616 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
617 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
618 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
619 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
620 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
624 * @ingroup lavc_encoding
626 typedef struct RcOverride{
629 int qscale; // If this is 0 then quality_factor will be used instead.
630 float quality_factor;
633 #define FF_MAX_B_FRAMES 16
636 These flags can be passed in AVCodecContext.flags before initialization.
637 Note: Not everything is supported yet.
641 * Allow decoders to produce frames with data planes that are not aligned
642 * to CPU requirements (e.g. due to cropping).
644 #define CODEC_FLAG_UNALIGNED 0x0001
645 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
646 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
647 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
648 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
649 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
650 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
652 * The parent program guarantees that the input for B-frames containing
653 * streams is not written to for at least s->max_b_frames+1 frames, if
654 * this is not set the input will be copied.
656 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
657 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
658 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
659 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
660 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
661 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
662 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
663 location instead of only at frame boundaries. */
664 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
665 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
666 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
667 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
668 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
669 /* Fx : Flag for h263+ extra options */
670 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
671 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
672 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
673 #define CODEC_FLAG_CLOSED_GOP 0x80000000
674 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
675 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
676 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
677 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
679 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
681 /* Unsupported options :
682 * Syntax Arithmetic coding (SAC)
683 * Reference Picture Selection
684 * Independent Segment Decoding */
686 /* codec capabilities */
688 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
690 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
691 * If not set, it might not use get_buffer() at all or use operations that
692 * assume the buffer was allocated by avcodec_default_get_buffer.
694 #define CODEC_CAP_DR1 0x0002
695 #define CODEC_CAP_TRUNCATED 0x0008
697 /* Codec can export data for HW decoding (XvMC). */
698 #define CODEC_CAP_HWACCEL 0x0010
699 #endif /* FF_API_XVMC */
701 * Encoder or decoder requires flushing with NULL input at the end in order to
702 * give the complete and correct output.
704 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
705 * with NULL data. The user can still send NULL data to the public encode
706 * or decode function, but libavcodec will not pass it along to the codec
707 * unless this flag is set.
710 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
711 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
715 * The encoder needs to be fed with NULL data at the end of encoding until the
716 * encoder no longer returns data.
718 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
719 * flag also means that the encoder must set the pts and duration for
720 * each output packet. If this flag is not set, the pts and duration will
721 * be determined by libavcodec from the input frame.
723 #define CODEC_CAP_DELAY 0x0020
725 * Codec can be fed a final frame with a smaller size.
726 * This can be used to prevent truncation of the last audio samples.
728 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
731 * Codec can export data for HW decoding (VDPAU).
733 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
736 * Codec can output multiple frames per AVPacket
737 * Normally demuxers return one frame at a time, demuxers which do not do
738 * are connected to a parser to split what they return into proper frames.
739 * This flag is reserved to the very rare category of codecs which have a
740 * bitstream that cannot be split into frames without timeconsuming
741 * operations like full decoding. Demuxers carring such bitstreams thus
742 * may return multiple frames in a packet. This has many disadvantages like
743 * prohibiting stream copy in many cases thus it should only be considered
746 #define CODEC_CAP_SUBFRAMES 0x0100
748 * Codec is experimental and is thus avoided in favor of non experimental
751 #define CODEC_CAP_EXPERIMENTAL 0x0200
753 * Codec should fill in channel configuration and samplerate instead of container
755 #define CODEC_CAP_CHANNEL_CONF 0x0400
757 * Codec is able to deal with negative linesizes
759 #define CODEC_CAP_NEG_LINESIZES 0x0800
761 * Codec supports frame-level multithreading.
763 #define CODEC_CAP_FRAME_THREADS 0x1000
765 * Codec supports slice-based (or partition-based) multithreading.
767 #define CODEC_CAP_SLICE_THREADS 0x2000
769 * Codec supports changed parameters at any point.
771 #define CODEC_CAP_PARAM_CHANGE 0x4000
773 * Codec supports avctx->thread_count == 0 (auto).
775 #define CODEC_CAP_AUTO_THREADS 0x8000
777 * Audio encoder supports receiving a different number of samples in each call.
779 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
782 //The following defines may change, don't expect compatibility if you use them.
783 #define MB_TYPE_INTRA4x4 0x0001
784 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
785 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
786 #define MB_TYPE_16x16 0x0008
787 #define MB_TYPE_16x8 0x0010
788 #define MB_TYPE_8x16 0x0020
789 #define MB_TYPE_8x8 0x0040
790 #define MB_TYPE_INTERLACED 0x0080
791 #define MB_TYPE_DIRECT2 0x0100 //FIXME
792 #define MB_TYPE_ACPRED 0x0200
793 #define MB_TYPE_GMC 0x0400
794 #define MB_TYPE_SKIP 0x0800
795 #define MB_TYPE_P0L0 0x1000
796 #define MB_TYPE_P1L0 0x2000
797 #define MB_TYPE_P0L1 0x4000
798 #define MB_TYPE_P1L1 0x8000
799 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
800 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
801 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
802 #define MB_TYPE_QUANT 0x00010000
803 #define MB_TYPE_CBP 0x00020000
804 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
809 * This specifies the area which should be displayed.
810 * Note there may be multiple such areas for one frame.
812 typedef struct AVPanScan{
815 * - encoding: Set by user.
816 * - decoding: Set by libavcodec.
821 * width and height in 1/16 pel
822 * - encoding: Set by user.
823 * - decoding: Set by libavcodec.
829 * position of the top left corner in 1/16 pel for up to 3 fields/frames
830 * - encoding: Set by user.
831 * - decoding: Set by libavcodec.
833 int16_t position[3][2];
836 #if FF_API_QSCALE_TYPE
837 #define FF_QSCALE_TYPE_MPEG1 0
838 #define FF_QSCALE_TYPE_MPEG2 1
839 #define FF_QSCALE_TYPE_H264 2
840 #define FF_QSCALE_TYPE_VP56 3
843 #if FF_API_GET_BUFFER
844 #define FF_BUFFER_TYPE_INTERNAL 1
845 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
846 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
847 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
849 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
850 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
851 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
852 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
856 * The decoder will keep a reference to the frame and may reuse it later.
858 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
861 * @defgroup lavc_packet AVPacket
863 * Types and functions for working with AVPacket.
866 enum AVPacketSideDataType {
868 AV_PKT_DATA_NEW_EXTRADATA,
871 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
874 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
875 * s32le channel_count
876 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
877 * u64le channel_layout
878 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
880 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
885 AV_PKT_DATA_PARAM_CHANGE,
888 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
889 * structures with info about macroblocks relevant to splitting the
890 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
891 * That is, it does not necessarily contain info about all macroblocks,
892 * as long as the distance between macroblocks in the info is smaller
893 * than the target payload size.
894 * Each MB info structure is 12 bytes, and is laid out as follows:
896 * u32le bit offset from the start of the packet
897 * u8 current quantizer at the start of the macroblock
899 * u16le macroblock address within the GOB
900 * u8 horizontal MV predictor
901 * u8 vertical MV predictor
902 * u8 horizontal MV predictor for block number 3
903 * u8 vertical MV predictor for block number 3
906 AV_PKT_DATA_H263_MB_INFO,
910 * This structure stores compressed data. It is typically exported by demuxers
911 * and then passed as input to decoders, or received as output from encoders and
912 * then passed to muxers.
914 * For video, it should typically contain one compressed frame. For audio it may
915 * contain several compressed frames.
917 * AVPacket is one of the few structs in Libav, whose size is a part of public
918 * ABI. Thus it may be allocated on stack and no new fields can be added to it
919 * without libavcodec and libavformat major bump.
921 * The semantics of data ownership depends on the buf or destruct (deprecated)
922 * fields. If either is set, the packet data is dynamically allocated and is
923 * valid indefinitely until av_free_packet() is called (which in turn calls
924 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
925 * the packet data is typically backed by some static buffer somewhere and is
926 * only valid for a limited time (e.g. until the next read call when demuxing).
928 * The side data is always allocated with av_malloc() and is freed in
931 typedef struct AVPacket {
933 * A reference to the reference-counted buffer where the packet data is
935 * May be NULL, then the packet data is not reference-counted.
939 * Presentation timestamp in AVStream->time_base units; the time at which
940 * the decompressed packet will be presented to the user.
941 * Can be AV_NOPTS_VALUE if it is not stored in the file.
942 * pts MUST be larger or equal to dts as presentation cannot happen before
943 * decompression, unless one wants to view hex dumps. Some formats misuse
944 * the terms dts and pts/cts to mean something different. Such timestamps
945 * must be converted to true pts/dts before they are stored in AVPacket.
949 * Decompression timestamp in AVStream->time_base units; the time at which
950 * the packet is decompressed.
951 * Can be AV_NOPTS_VALUE if it is not stored in the file.
958 * A combination of AV_PKT_FLAG values
962 * Additional packet data that can be provided by the container.
963 * Packet can contain several types of side information.
968 enum AVPacketSideDataType type;
973 * Duration of this packet in AVStream->time_base units, 0 if unknown.
974 * Equals next_pts - this_pts in presentation order.
977 #if FF_API_DESTRUCT_PACKET
979 void (*destruct)(struct AVPacket *);
983 int64_t pos; ///< byte position in stream, -1 if unknown
986 * Time difference in AVStream->time_base units from the pts of this
987 * packet to the point at which the output from the decoder has converged
988 * independent from the availability of previous frames. That is, the
989 * frames are virtually identical no matter if decoding started from
990 * the very first frame or from this keyframe.
991 * Is AV_NOPTS_VALUE if unknown.
992 * This field is not the display duration of the current packet.
993 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
996 * The purpose of this field is to allow seeking in streams that have no
997 * keyframes in the conventional sense. It corresponds to the
998 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
999 * essential for some types of subtitle streams to ensure that all
1000 * subtitles are correctly displayed after seeking.
1002 int64_t convergence_duration;
1004 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1005 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1007 enum AVSideDataParamChangeFlags {
1008 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1009 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1010 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1011 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1017 struct AVCodecInternal;
1021 AV_FIELD_PROGRESSIVE,
1022 AV_FIELD_TT, //< Top coded_first, top displayed first
1023 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1024 AV_FIELD_TB, //< Top coded first, bottom displayed first
1025 AV_FIELD_BT, //< Bottom coded first, top displayed first
1029 * main external API structure.
1030 * New fields can be added to the end with minor version bumps.
1031 * Removal, reordering and changes to existing fields require a major
1033 * sizeof(AVCodecContext) must not be used outside libav*.
1035 typedef struct AVCodecContext {
1037 * information on struct for av_log
1038 * - set by avcodec_alloc_context3
1040 const AVClass *av_class;
1041 int log_level_offset;
1043 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1044 const struct AVCodec *codec;
1045 char codec_name[32];
1046 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1049 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1050 * This is used to work around some encoder bugs.
1051 * A demuxer should set this to what is stored in the field used to identify the codec.
1052 * If there are multiple such fields in a container then the demuxer should choose the one
1053 * which maximizes the information about the used codec.
1054 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1055 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1056 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1058 * - encoding: Set by user, if not then the default based on codec_id will be used.
1059 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1061 unsigned int codec_tag;
1064 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1065 * This is used to work around some encoder bugs.
1066 * - encoding: unused
1067 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1069 unsigned int stream_codec_tag;
1074 * Private context used for internal data.
1076 * Unlike priv_data, this is not codec-specific. It is used in general
1077 * libavcodec functions.
1079 struct AVCodecInternal *internal;
1082 * Private data of the user, can be used to carry app specific stuff.
1083 * - encoding: Set by user.
1084 * - decoding: Set by user.
1089 * the average bitrate
1090 * - encoding: Set by user; unused for constant quantizer encoding.
1091 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1096 * number of bits the bitstream is allowed to diverge from the reference.
1097 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1098 * - encoding: Set by user; unused for constant quantizer encoding.
1099 * - decoding: unused
1101 int bit_rate_tolerance;
1104 * Global quality for codecs which cannot change it per frame.
1105 * This should be proportional to MPEG-1/2/4 qscale.
1106 * - encoding: Set by user.
1107 * - decoding: unused
1112 * - encoding: Set by user.
1113 * - decoding: unused
1115 int compression_level;
1116 #define FF_COMPRESSION_DEFAULT -1
1120 * - encoding: Set by user.
1121 * - decoding: Set by user.
1127 * - encoding: Set by user.
1128 * - decoding: Set by user.
1133 * some codecs need / can use extradata like Huffman tables.
1134 * mjpeg: Huffman tables
1135 * rv10: additional flags
1136 * mpeg4: global headers (they can be in the bitstream or here)
1137 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1138 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1139 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1140 * - encoding: Set/allocated/freed by libavcodec.
1141 * - decoding: Set/allocated/freed by user.
1147 * This is the fundamental unit of time (in seconds) in terms
1148 * of which frame timestamps are represented. For fixed-fps content,
1149 * timebase should be 1/framerate and timestamp increments should be
1151 * - encoding: MUST be set by user.
1152 * - decoding: Set by libavcodec.
1154 AVRational time_base;
1157 * For some codecs, the time base is closer to the field rate than the frame rate.
1158 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1159 * if no telecine is used ...
1161 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1163 int ticks_per_frame;
1169 * Number of frames the decoded output will be delayed relative to the
1173 * For encoding, this is the number of "priming" samples added to the
1174 * beginning of the stream. The decoded output will be delayed by this
1175 * many samples relative to the input to the encoder. Note that this
1176 * field is purely informational and does not directly affect the pts
1177 * output by the encoder, which should always be based on the actual
1178 * presentation time, including any delay.
1179 * For decoding, this is the number of samples the decoder needs to
1180 * output before the decoder's output is valid. When seeking, you should
1181 * start decoding this many samples prior to your desired seek point.
1183 * - encoding: Set by libavcodec.
1184 * - decoding: Set by libavcodec.
1191 * picture width / height.
1192 * - encoding: MUST be set by user.
1193 * - decoding: May be set by the user before opening the decoder if known e.g.
1194 * from the container. Some decoders will require the dimensions
1195 * to be set by the caller. During decoding, the decoder may
1196 * overwrite those values as required.
1201 * Bitstream width / height, may be different from width/height e.g. when
1202 * the decoded frame is cropped before being output.
1203 * - encoding: unused
1204 * - decoding: May be set by the user before opening the decoder if known
1205 * e.g. from the container. During decoding, the decoder may
1206 * overwrite those values as required.
1208 int coded_width, coded_height;
1210 #if FF_API_ASPECT_EXTENDED
1211 #define FF_ASPECT_EXTENDED 15
1215 * the number of pictures in a group of pictures, or 0 for intra_only
1216 * - encoding: Set by user.
1217 * - decoding: unused
1222 * Pixel format, see AV_PIX_FMT_xxx.
1223 * May be set by the demuxer if known from headers.
1224 * May be overriden by the decoder if it knows better.
1225 * - encoding: Set by user.
1226 * - decoding: Set by user if known, overridden by libavcodec if known
1228 enum AVPixelFormat pix_fmt;
1231 * Motion estimation algorithm used for video coding.
1232 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1233 * 8 (umh), 10 (tesa) [7, 8, 10 are x264 specific]
1234 * - encoding: MUST be set by user.
1235 * - decoding: unused
1240 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1241 * decoder to draw a horizontal band. It improves cache usage. Not
1242 * all codecs can do that. You must check the codec capabilities
1244 * When multithreading is used, it may be called from multiple threads
1245 * at the same time; threads might draw different parts of the same AVFrame,
1246 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1248 * The function is also used by hardware acceleration APIs.
1249 * It is called at least once during frame decoding to pass
1250 * the data needed for hardware render.
1251 * In that mode instead of pixel data, AVFrame points to
1252 * a structure specific to the acceleration API. The application
1253 * reads the structure and can change some fields to indicate progress
1255 * - encoding: unused
1256 * - decoding: Set by user.
1257 * @param height the height of the slice
1258 * @param y the y position of the slice
1259 * @param type 1->top field, 2->bottom field, 3->frame
1260 * @param offset offset into the AVFrame.data from which the slice should be read
1262 void (*draw_horiz_band)(struct AVCodecContext *s,
1263 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1264 int y, int type, int height);
1267 * callback to negotiate the pixelFormat
1268 * @param fmt is the list of formats which are supported by the codec,
1269 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1270 * The first is always the native one.
1271 * @return the chosen format
1272 * - encoding: unused
1273 * - decoding: Set by user, if not set the native format will be chosen.
1275 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1278 * maximum number of B-frames between non-B-frames
1279 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1280 * - encoding: Set by user.
1281 * - decoding: unused
1286 * qscale factor between IP and B-frames
1287 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1288 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1289 * - encoding: Set by user.
1290 * - decoding: unused
1292 float b_quant_factor;
1294 /** obsolete FIXME remove */
1296 #define FF_RC_STRATEGY_XVID 1
1298 int b_frame_strategy;
1301 * qscale offset between IP and B-frames
1302 * - encoding: Set by user.
1303 * - decoding: unused
1305 float b_quant_offset;
1308 * Size of the frame reordering buffer in the decoder.
1309 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1310 * - encoding: Set by libavcodec.
1311 * - decoding: Set by libavcodec.
1316 * 0-> h263 quant 1-> mpeg quant
1317 * - encoding: Set by user.
1318 * - decoding: unused
1323 * qscale factor between P and I-frames
1324 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1325 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1326 * - encoding: Set by user.
1327 * - decoding: unused
1329 float i_quant_factor;
1332 * qscale offset between P and I-frames
1333 * - encoding: Set by user.
1334 * - decoding: unused
1336 float i_quant_offset;
1339 * luminance masking (0-> disabled)
1340 * - encoding: Set by user.
1341 * - decoding: unused
1346 * temporary complexity masking (0-> disabled)
1347 * - encoding: Set by user.
1348 * - decoding: unused
1350 float temporal_cplx_masking;
1353 * spatial complexity masking (0-> disabled)
1354 * - encoding: Set by user.
1355 * - decoding: unused
1357 float spatial_cplx_masking;
1360 * p block masking (0-> disabled)
1361 * - encoding: Set by user.
1362 * - decoding: unused
1367 * darkness masking (0-> disabled)
1368 * - encoding: Set by user.
1369 * - decoding: unused
1375 * - encoding: Set by libavcodec.
1376 * - decoding: Set by user (or 0).
1380 * prediction method (needed for huffyuv)
1381 * - encoding: Set by user.
1382 * - decoding: unused
1384 int prediction_method;
1385 #define FF_PRED_LEFT 0
1386 #define FF_PRED_PLANE 1
1387 #define FF_PRED_MEDIAN 2
1390 * slice offsets in the frame in bytes
1391 * - encoding: Set/allocated by libavcodec.
1392 * - decoding: Set/allocated by user (or NULL).
1397 * sample aspect ratio (0 if unknown)
1398 * That is the width of a pixel divided by the height of the pixel.
1399 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1400 * - encoding: Set by user.
1401 * - decoding: Set by libavcodec.
1403 AVRational sample_aspect_ratio;
1406 * motion estimation comparison function
1407 * - encoding: Set by user.
1408 * - decoding: unused
1412 * subpixel motion estimation comparison function
1413 * - encoding: Set by user.
1414 * - decoding: unused
1418 * macroblock comparison function (not supported yet)
1419 * - encoding: Set by user.
1420 * - decoding: unused
1424 * interlaced DCT comparison function
1425 * - encoding: Set by user.
1426 * - decoding: unused
1429 #define FF_CMP_SAD 0
1430 #define FF_CMP_SSE 1
1431 #define FF_CMP_SATD 2
1432 #define FF_CMP_DCT 3
1433 #define FF_CMP_PSNR 4
1434 #define FF_CMP_BIT 5
1436 #define FF_CMP_ZERO 7
1437 #define FF_CMP_VSAD 8
1438 #define FF_CMP_VSSE 9
1439 #define FF_CMP_NSSE 10
1440 #define FF_CMP_DCTMAX 13
1441 #define FF_CMP_DCT264 14
1442 #define FF_CMP_CHROMA 256
1445 * ME diamond size & shape
1446 * - encoding: Set by user.
1447 * - decoding: unused
1452 * amount of previous MV predictors (2a+1 x 2a+1 square)
1453 * - encoding: Set by user.
1454 * - decoding: unused
1456 int last_predictor_count;
1459 * prepass for motion estimation
1460 * - encoding: Set by user.
1461 * - decoding: unused
1466 * motion estimation prepass comparison function
1467 * - encoding: Set by user.
1468 * - decoding: unused
1473 * ME prepass diamond size & shape
1474 * - encoding: Set by user.
1475 * - decoding: unused
1481 * - encoding: Set by user.
1482 * - decoding: unused
1484 int me_subpel_quality;
1487 * DTG active format information (additional aspect ratio
1488 * information only used in DVB MPEG-2 transport streams)
1491 * - encoding: unused
1492 * - decoding: Set by decoder.
1494 int dtg_active_format;
1495 #define FF_DTG_AFD_SAME 8
1496 #define FF_DTG_AFD_4_3 9
1497 #define FF_DTG_AFD_16_9 10
1498 #define FF_DTG_AFD_14_9 11
1499 #define FF_DTG_AFD_4_3_SP_14_9 13
1500 #define FF_DTG_AFD_16_9_SP_14_9 14
1501 #define FF_DTG_AFD_SP_4_3 15
1504 * maximum motion estimation search range in subpel units
1505 * If 0 then no limit.
1507 * - encoding: Set by user.
1508 * - decoding: unused
1513 * intra quantizer bias
1514 * - encoding: Set by user.
1515 * - decoding: unused
1517 int intra_quant_bias;
1518 #define FF_DEFAULT_QUANT_BIAS 999999
1521 * inter quantizer bias
1522 * - encoding: Set by user.
1523 * - decoding: unused
1525 int inter_quant_bias;
1529 * - encoding: unused
1530 * - decoding: Set by user.
1533 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1534 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1535 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1539 * XVideo Motion Acceleration
1540 * - encoding: forbidden
1541 * - decoding: set by decoder
1542 * @deprecated XvMC support is slated for removal.
1544 attribute_deprecated int xvmc_acceleration;
1545 #endif /* FF_API_XVMC */
1548 * macroblock decision mode
1549 * - encoding: Set by user.
1550 * - decoding: unused
1553 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1554 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1555 #define FF_MB_DECISION_RD 2 ///< rate distortion
1558 * custom intra quantization matrix
1559 * - encoding: Set by user, can be NULL.
1560 * - decoding: Set by libavcodec.
1562 uint16_t *intra_matrix;
1565 * custom inter quantization matrix
1566 * - encoding: Set by user, can be NULL.
1567 * - decoding: Set by libavcodec.
1569 uint16_t *inter_matrix;
1572 * scene change detection threshold
1573 * 0 is default, larger means fewer detected scene changes.
1574 * - encoding: Set by user.
1575 * - decoding: unused
1577 int scenechange_threshold;
1580 * noise reduction strength
1581 * - encoding: Set by user.
1582 * - decoding: unused
1584 int noise_reduction;
1587 * Motion estimation threshold below which no motion estimation is
1588 * performed, but instead the user specified motion vectors are used.
1590 * - encoding: Set by user.
1591 * - decoding: unused
1596 * Macroblock threshold below which the user specified macroblock types will be used.
1597 * - encoding: Set by user.
1598 * - decoding: unused
1603 * precision of the intra DC coefficient - 8
1604 * - encoding: Set by user.
1605 * - decoding: unused
1607 int intra_dc_precision;
1610 * Number of macroblock rows at the top which are skipped.
1611 * - encoding: unused
1612 * - decoding: Set by user.
1617 * Number of macroblock rows at the bottom which are skipped.
1618 * - encoding: unused
1619 * - decoding: Set by user.
1624 * Border processing masking, raises the quantizer for mbs on the borders
1626 * - encoding: Set by user.
1627 * - decoding: unused
1629 float border_masking;
1632 * minimum MB lagrange multipler
1633 * - encoding: Set by user.
1634 * - decoding: unused
1639 * maximum MB lagrange multipler
1640 * - encoding: Set by user.
1641 * - decoding: unused
1647 * - encoding: Set by user.
1648 * - decoding: unused
1650 int me_penalty_compensation;
1654 * - encoding: Set by user.
1655 * - decoding: unused
1661 * - encoding: Set by user.
1662 * - decoding: unused
1668 * - encoding: Set by user.
1669 * - decoding: unused
1674 * number of reference frames
1675 * - encoding: Set by user.
1676 * - decoding: Set by lavc.
1681 * chroma qp offset from luma
1682 * - encoding: Set by user.
1683 * - decoding: unused
1688 * Multiplied by qscale for each frame and added to scene_change_score.
1689 * - encoding: Set by user.
1690 * - decoding: unused
1692 int scenechange_factor;
1696 * Note: Value depends upon the compare function used for fullpel ME.
1697 * - encoding: Set by user.
1698 * - decoding: unused
1703 * Adjust sensitivity of b_frame_strategy 1.
1704 * - encoding: Set by user.
1705 * - decoding: unused
1710 * Chromaticity coordinates of the source primaries.
1711 * - encoding: Set by user
1712 * - decoding: Set by libavcodec
1714 enum AVColorPrimaries color_primaries;
1717 * Color Transfer Characteristic.
1718 * - encoding: Set by user
1719 * - decoding: Set by libavcodec
1721 enum AVColorTransferCharacteristic color_trc;
1724 * YUV colorspace type.
1725 * - encoding: Set by user
1726 * - decoding: Set by libavcodec
1728 enum AVColorSpace colorspace;
1731 * MPEG vs JPEG YUV range.
1732 * - encoding: Set by user
1733 * - decoding: Set by libavcodec
1735 enum AVColorRange color_range;
1738 * This defines the location of chroma samples.
1739 * - encoding: Set by user
1740 * - decoding: Set by libavcodec
1742 enum AVChromaLocation chroma_sample_location;
1746 * Indicates number of picture subdivisions. Used for parallelized
1748 * - encoding: Set by user
1749 * - decoding: unused
1754 * - encoding: set by libavcodec
1755 * - decoding: Set by libavcodec
1757 enum AVFieldOrder field_order;
1760 int sample_rate; ///< samples per second
1761 int channels; ///< number of audio channels
1764 * audio sample format
1765 * - encoding: Set by user.
1766 * - decoding: Set by libavcodec.
1768 enum AVSampleFormat sample_fmt; ///< sample format
1770 /* The following data should not be initialized. */
1772 * Number of samples per channel in an audio frame.
1774 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1775 * except the last must contain exactly frame_size samples per channel.
1776 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1777 * frame size is not restricted.
1778 * - decoding: may be set by some decoders to indicate constant frame size
1783 * Frame counter, set by libavcodec.
1785 * - decoding: total number of frames returned from the decoder so far.
1786 * - encoding: total number of frames passed to the encoder so far.
1788 * @note the counter is not incremented if encoding/decoding resulted in
1794 * number of bytes per packet if constant and known or 0
1795 * Used by some WAV based audio codecs.
1800 * Audio cutoff bandwidth (0 means "automatic")
1801 * - encoding: Set by user.
1802 * - decoding: unused
1806 #if FF_API_REQUEST_CHANNELS
1808 * Decoder should decode to this many channels if it can (0 for default)
1809 * - encoding: unused
1810 * - decoding: Set by user.
1811 * @deprecated Deprecated in favor of request_channel_layout.
1813 attribute_deprecated int request_channels;
1817 * Audio channel layout.
1818 * - encoding: set by user.
1819 * - decoding: set by libavcodec.
1821 uint64_t channel_layout;
1824 * Request decoder to use this channel layout if it can (0 for default)
1825 * - encoding: unused
1826 * - decoding: Set by user.
1828 uint64_t request_channel_layout;
1831 * Type of service that the audio stream conveys.
1832 * - encoding: Set by user.
1833 * - decoding: Set by libavcodec.
1835 enum AVAudioServiceType audio_service_type;
1838 * Used to request a sample format from the decoder.
1839 * - encoding: unused.
1840 * - decoding: Set by user.
1842 enum AVSampleFormat request_sample_fmt;
1844 #if FF_API_GET_BUFFER
1846 * Called at the beginning of each frame to get a buffer for it.
1848 * The function will set AVFrame.data[], AVFrame.linesize[].
1849 * AVFrame.extended_data[] must also be set, but it should be the same as
1850 * AVFrame.data[] except for planar audio with more channels than can fit
1851 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1852 * many data pointers as it can hold.
1854 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1855 * avcodec_default_get_buffer() instead of providing buffers allocated by
1858 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1859 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1860 * but if get_buffer() is overridden then alignment considerations should
1861 * be taken into account.
1863 * @see avcodec_default_get_buffer()
1867 * If pic.reference is set then the frame will be read later by libavcodec.
1868 * avcodec_align_dimensions2() should be used to find the required width and
1869 * height, as they normally need to be rounded up to the next multiple of 16.
1871 * If frame multithreading is used and thread_safe_callbacks is set,
1872 * it may be called from a different thread, but not from more than one at
1873 * once. Does not need to be reentrant.
1875 * @see release_buffer(), reget_buffer()
1876 * @see avcodec_align_dimensions2()
1880 * Decoders request a buffer of a particular size by setting
1881 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1882 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1883 * to a smaller value in the output frame.
1885 * Decoders cannot use the buffer after returning from
1886 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1887 * is assumed to be released immediately upon return. In some rare cases,
1888 * a decoder may need to call get_buffer() more than once in a single
1889 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
1890 * called again after it has already been called once, the previously
1891 * acquired buffer is assumed to be released at that time and may not be
1892 * reused by the decoder.
1894 * As a convenience, av_samples_get_buffer_size() and
1895 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1896 * functions to find the required data size and to fill data pointers and
1897 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1898 * since all planes must be the same size.
1900 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1902 * - encoding: unused
1903 * - decoding: Set by libavcodec, user can override.
1905 * @deprecated use get_buffer2()
1907 attribute_deprecated
1908 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1911 * Called to release buffers which were allocated with get_buffer.
1912 * A released buffer can be reused in get_buffer().
1913 * pic.data[*] must be set to NULL.
1914 * May be called from a different thread if frame multithreading is used,
1915 * but not by more than one thread at once, so does not need to be reentrant.
1916 * - encoding: unused
1917 * - decoding: Set by libavcodec, user can override.
1919 * @deprecated custom freeing callbacks should be set from get_buffer2()
1921 attribute_deprecated
1922 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1925 * Called at the beginning of a frame to get cr buffer for it.
1926 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1927 * libavcodec will pass previous buffer in pic, function should return
1928 * same buffer or new buffer with old frame "painted" into it.
1929 * If pic.data[0] == NULL must behave like get_buffer().
1930 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
1931 * avcodec_default_reget_buffer() instead of providing buffers allocated by
1933 * - encoding: unused
1934 * - decoding: Set by libavcodec, user can override.
1936 attribute_deprecated
1937 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1941 * This callback is called at the beginning of each frame to get data
1942 * buffer(s) for it. There may be one contiguous buffer for all the data or
1943 * there may be a buffer per each data plane or anything in between. What
1944 * this means is, you may set however many entries in buf[] you feel necessary.
1945 * Each buffer must be reference-counted using the AVBuffer API (see description
1948 * The following fields will be set in the frame before this callback is
1951 * - width, height (video only)
1952 * - sample_rate, channel_layout, nb_samples (audio only)
1953 * Their values may differ from the corresponding values in
1954 * AVCodecContext. This callback must use the frame values, not the codec
1955 * context values, to calculate the required buffer size.
1957 * This callback must fill the following fields in the frame:
1961 * * if the data is planar audio with more than 8 channels, then this
1962 * callback must allocate and fill extended_data to contain all pointers
1963 * to all data planes. data[] must hold as many pointers as it can.
1964 * extended_data must be allocated with av_malloc() and will be freed in
1966 * * otherwise exended_data must point to data
1967 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1968 * the frame's data and extended_data pointers must be contained in these. That
1969 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1970 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1971 * and av_buffer_ref().
1972 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1973 * this callback and filled with the extra buffers if there are more
1974 * buffers than buf[] can hold. extended_buf will be freed in
1977 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
1978 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1981 * Each data plane must be aligned to the maximum required by the target
1984 * @see avcodec_default_get_buffer2()
1988 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1989 * (read and/or written to if it is writable) later by libavcodec.
1991 * If CODEC_FLAG_EMU_EDGE is not set in s->flags, the buffer must contain an
1992 * edge of the size returned by avcodec_get_edge_width() on all sides.
1994 * avcodec_align_dimensions2() should be used to find the required width and
1995 * height, as they normally need to be rounded up to the next multiple of 16.
1997 * If frame multithreading is used and thread_safe_callbacks is set,
1998 * this callback may be called from a different thread, but not from more
1999 * than one at once. Does not need to be reentrant.
2001 * @see avcodec_align_dimensions2()
2005 * Decoders request a buffer of a particular size by setting
2006 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2007 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2008 * to a smaller value in the output frame.
2010 * As a convenience, av_samples_get_buffer_size() and
2011 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2012 * functions to find the required data size and to fill data pointers and
2013 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2014 * since all planes must be the same size.
2016 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2018 * - encoding: unused
2019 * - decoding: Set by libavcodec, user can override.
2021 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2024 * If non-zero, the decoded audio and video frames returned from
2025 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2026 * and are valid indefinitely. The caller must free them with
2027 * av_frame_unref() when they are not needed anymore.
2028 * Otherwise, the decoded frames must not be freed by the caller and are
2029 * only valid until the next decode call.
2031 * - encoding: unused
2032 * - decoding: set by the caller before avcodec_open2().
2034 int refcounted_frames;
2036 /* - encoding parameters */
2037 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2038 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2042 * - encoding: Set by user.
2043 * - decoding: unused
2049 * - encoding: Set by user.
2050 * - decoding: unused
2055 * maximum quantizer difference between frames
2056 * - encoding: Set by user.
2057 * - decoding: unused
2062 * ratecontrol qmin qmax limiting method
2063 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2064 * - encoding: Set by user.
2065 * - decoding: unused
2073 * decoder bitstream buffer size
2074 * - encoding: Set by user.
2075 * - decoding: unused
2080 * ratecontrol override, see RcOverride
2081 * - encoding: Allocated/set/freed by user.
2082 * - decoding: unused
2084 int rc_override_count;
2085 RcOverride *rc_override;
2088 * rate control equation
2089 * - encoding: Set by user
2090 * - decoding: unused
2096 * - encoding: Set by user.
2097 * - decoding: unused
2103 * - encoding: Set by user.
2104 * - decoding: unused
2108 float rc_buffer_aggressivity;
2111 * initial complexity for pass1 ratecontrol
2112 * - encoding: Set by user.
2113 * - decoding: unused
2115 float rc_initial_cplx;
2118 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2119 * - encoding: Set by user.
2120 * - decoding: unused.
2122 float rc_max_available_vbv_use;
2125 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2126 * - encoding: Set by user.
2127 * - decoding: unused.
2129 float rc_min_vbv_overflow_use;
2132 * Number of bits which should be loaded into the rc buffer before decoding starts.
2133 * - encoding: Set by user.
2134 * - decoding: unused
2136 int rc_initial_buffer_occupancy;
2138 #define FF_CODER_TYPE_VLC 0
2139 #define FF_CODER_TYPE_AC 1
2140 #define FF_CODER_TYPE_RAW 2
2141 #define FF_CODER_TYPE_RLE 3
2142 #define FF_CODER_TYPE_DEFLATE 4
2145 * - encoding: Set by user.
2146 * - decoding: unused
2152 * - encoding: Set by user.
2153 * - decoding: unused
2158 * minimum Lagrange multipler
2159 * - encoding: Set by user.
2160 * - decoding: unused
2165 * maximum Lagrange multipler
2166 * - encoding: Set by user.
2167 * - decoding: unused
2172 * frame skip threshold
2173 * - encoding: Set by user.
2174 * - decoding: unused
2176 int frame_skip_threshold;
2180 * - encoding: Set by user.
2181 * - decoding: unused
2183 int frame_skip_factor;
2186 * frame skip exponent
2187 * - encoding: Set by user.
2188 * - decoding: unused
2193 * frame skip comparison function
2194 * - encoding: Set by user.
2195 * - decoding: unused
2200 * trellis RD quantization
2201 * - encoding: Set by user.
2202 * - decoding: unused
2207 * - encoding: Set by user.
2208 * - decoding: unused
2210 int min_prediction_order;
2213 * - encoding: Set by user.
2214 * - decoding: unused
2216 int max_prediction_order;
2219 * GOP timecode frame start number, in non drop frame format
2220 * - encoding: Set by user.
2221 * - decoding: unused
2223 int64_t timecode_frame_start;
2225 /* The RTP callback: This function is called */
2226 /* every time the encoder has a packet to send. */
2227 /* It depends on the encoder if the data starts */
2228 /* with a Start Code (it should). H.263 does. */
2229 /* mb_nb contains the number of macroblocks */
2230 /* encoded in the RTP payload. */
2231 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2233 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2234 /* do its best to deliver a chunk with size */
2235 /* below rtp_payload_size, the chunk will start */
2236 /* with a start code on some codecs like H.263. */
2237 /* This doesn't take account of any particular */
2238 /* headers inside the transmitted RTP payload. */
2240 /* statistics, used for 2-pass encoding */
2251 * number of bits used for the previously encoded frame
2252 * - encoding: Set by libavcodec.
2253 * - decoding: unused
2258 * pass1 encoding statistics output buffer
2259 * - encoding: Set by libavcodec.
2260 * - decoding: unused
2265 * pass2 encoding statistics input buffer
2266 * Concatenated stuff from stats_out of pass1 should be placed here.
2267 * - encoding: Allocated/set/freed by user.
2268 * - decoding: unused
2273 * Work around bugs in encoders which sometimes cannot be detected automatically.
2274 * - encoding: Set by user
2275 * - decoding: Set by user
2277 int workaround_bugs;
2278 #define FF_BUG_AUTODETECT 1 ///< autodetection
2279 #if FF_API_OLD_MSMPEG4
2280 #define FF_BUG_OLD_MSMPEG4 2
2282 #define FF_BUG_XVID_ILACE 4
2283 #define FF_BUG_UMP4 8
2284 #define FF_BUG_NO_PADDING 16
2285 #define FF_BUG_AMV 32
2287 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2289 #define FF_BUG_QPEL_CHROMA 64
2290 #define FF_BUG_STD_QPEL 128
2291 #define FF_BUG_QPEL_CHROMA2 256
2292 #define FF_BUG_DIRECT_BLOCKSIZE 512
2293 #define FF_BUG_EDGE 1024
2294 #define FF_BUG_HPEL_CHROMA 2048
2295 #define FF_BUG_DC_CLIP 4096
2296 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2297 #define FF_BUG_TRUNCATED 16384
2300 * strictly follow the standard (MPEG4, ...).
2301 * - encoding: Set by user.
2302 * - decoding: Set by user.
2303 * Setting this to STRICT or higher means the encoder and decoder will
2304 * generally do stupid things, whereas setting it to unofficial or lower
2305 * will mean the encoder might produce output that is not supported by all
2306 * spec-compliant decoders. Decoders don't differentiate between normal,
2307 * unofficial and experimental (that is, they always try to decode things
2308 * when they can) unless they are explicitly asked to behave stupidly
2309 * (=strictly conform to the specs)
2311 int strict_std_compliance;
2312 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2313 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2314 #define FF_COMPLIANCE_NORMAL 0
2315 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2316 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2319 * error concealment flags
2320 * - encoding: unused
2321 * - decoding: Set by user.
2323 int error_concealment;
2324 #define FF_EC_GUESS_MVS 1
2325 #define FF_EC_DEBLOCK 2
2329 * - encoding: Set by user.
2330 * - decoding: Set by user.
2333 #define FF_DEBUG_PICT_INFO 1
2334 #define FF_DEBUG_RC 2
2335 #define FF_DEBUG_BITSTREAM 4
2336 #define FF_DEBUG_MB_TYPE 8
2337 #define FF_DEBUG_QP 16
2340 * @deprecated this option does nothing
2342 #define FF_DEBUG_MV 32
2344 #define FF_DEBUG_DCT_COEFF 0x00000040
2345 #define FF_DEBUG_SKIP 0x00000080
2346 #define FF_DEBUG_STARTCODE 0x00000100
2347 #define FF_DEBUG_PTS 0x00000200
2348 #define FF_DEBUG_ER 0x00000400
2349 #define FF_DEBUG_MMCO 0x00000800
2350 #define FF_DEBUG_BUGS 0x00001000
2352 #define FF_DEBUG_VIS_QP 0x00002000
2353 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2355 #define FF_DEBUG_BUFFERS 0x00008000
2356 #define FF_DEBUG_THREADS 0x00010000
2360 * @deprecated this option does not have any effect
2362 attribute_deprecated
2364 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2365 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2366 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2370 * Error recognition; may misdetect some more or less valid parts as errors.
2371 * - encoding: unused
2372 * - decoding: Set by user.
2374 int err_recognition;
2377 * Verify checksums embedded in the bitstream (could be of either encoded or
2378 * decoded data, depending on the codec) and print an error message on mismatch.
2379 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2380 * decoder returning an error.
2382 #define AV_EF_CRCCHECK (1<<0)
2383 #define AV_EF_BITSTREAM (1<<1)
2384 #define AV_EF_BUFFER (1<<2)
2385 #define AV_EF_EXPLODE (1<<3)
2388 * opaque 64bit number (generally a PTS) that will be reordered and
2389 * output in AVFrame.reordered_opaque
2390 * @deprecated in favor of pkt_pts
2391 * - encoding: unused
2392 * - decoding: Set by user.
2394 int64_t reordered_opaque;
2397 * Hardware accelerator in use
2398 * - encoding: unused.
2399 * - decoding: Set by libavcodec
2401 struct AVHWAccel *hwaccel;
2404 * Hardware accelerator context.
2405 * For some hardware accelerators, a global context needs to be
2406 * provided by the user. In that case, this holds display-dependent
2407 * data Libav cannot instantiate itself. Please refer to the
2408 * Libav HW accelerator documentation to know how to fill this
2409 * is. e.g. for VA API, this is a struct vaapi_context.
2410 * - encoding: unused
2411 * - decoding: Set by user
2413 void *hwaccel_context;
2417 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2418 * - decoding: unused
2420 uint64_t error[AV_NUM_DATA_POINTERS];
2423 * DCT algorithm, see FF_DCT_* below
2424 * - encoding: Set by user.
2425 * - decoding: unused
2428 #define FF_DCT_AUTO 0
2429 #define FF_DCT_FASTINT 1
2430 #define FF_DCT_INT 2
2431 #define FF_DCT_MMX 3
2432 #define FF_DCT_ALTIVEC 5
2433 #define FF_DCT_FAAN 6
2436 * IDCT algorithm, see FF_IDCT_* below.
2437 * - encoding: Set by user.
2438 * - decoding: Set by user.
2441 #define FF_IDCT_AUTO 0
2442 #define FF_IDCT_INT 1
2443 #define FF_IDCT_SIMPLE 2
2444 #define FF_IDCT_SIMPLEMMX 3
2445 #define FF_IDCT_ARM 7
2446 #define FF_IDCT_ALTIVEC 8
2447 #define FF_IDCT_SH4 9
2448 #define FF_IDCT_SIMPLEARM 10
2449 #define FF_IDCT_IPP 13
2450 #define FF_IDCT_XVIDMMX 14
2451 #define FF_IDCT_SIMPLEARMV5TE 16
2452 #define FF_IDCT_SIMPLEARMV6 17
2453 #define FF_IDCT_SIMPLEVIS 18
2454 #define FF_IDCT_FAAN 20
2455 #define FF_IDCT_SIMPLENEON 22
2456 #if FF_API_ARCH_ALPHA
2457 #define FF_IDCT_SIMPLEALPHA 23
2461 * bits per sample/pixel from the demuxer (needed for huffyuv).
2462 * - encoding: Set by libavcodec.
2463 * - decoding: Set by user.
2465 int bits_per_coded_sample;
2468 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2469 * - encoding: set by user.
2470 * - decoding: set by libavcodec.
2472 int bits_per_raw_sample;
2476 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2477 * - encoding: unused
2478 * - decoding: Set by user.
2480 * @deprecated use decoder private options instead
2482 attribute_deprecated int lowres;
2486 * the picture in the bitstream
2487 * - encoding: Set by libavcodec.
2488 * - decoding: Set by libavcodec.
2490 AVFrame *coded_frame;
2494 * is used to decide how many independent tasks should be passed to execute()
2495 * - encoding: Set by user.
2496 * - decoding: Set by user.
2501 * Which multithreading methods to use.
2502 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2503 * so clients which cannot provide future frames should not use it.
2505 * - encoding: Set by user, otherwise the default is used.
2506 * - decoding: Set by user, otherwise the default is used.
2509 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2510 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2513 * Which multithreading methods are in use by the codec.
2514 * - encoding: Set by libavcodec.
2515 * - decoding: Set by libavcodec.
2517 int active_thread_type;
2520 * Set by the client if its custom get_buffer() callback can be called
2521 * synchronously from another thread, which allows faster multithreaded decoding.
2522 * draw_horiz_band() will be called from other threads regardless of this setting.
2523 * Ignored if the default get_buffer() is used.
2524 * - encoding: Set by user.
2525 * - decoding: Set by user.
2527 int thread_safe_callbacks;
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 * @param count the number of things to execute
2535 * - encoding: Set by libavcodec, user can override.
2536 * - decoding: Set by libavcodec, user can override.
2538 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2541 * The codec may call this to execute several independent things.
2542 * It will return only after finishing all tasks.
2543 * The user may replace this with some multithreaded implementation,
2544 * the default implementation will execute the parts serially.
2545 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2546 * @param c context passed also to func
2547 * @param count the number of things to execute
2548 * @param arg2 argument passed unchanged to func
2549 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2550 * @param func function that will be called count times, with jobnr from 0 to count-1.
2551 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2552 * two instances of func executing at the same time will have the same threadnr.
2553 * @return always 0 currently, but code should handle a future improvement where when any call to func
2554 * returns < 0 no further calls to func may be done and < 0 is returned.
2555 * - encoding: Set by libavcodec, user can override.
2556 * - decoding: Set by libavcodec, user can override.
2558 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2560 #if FF_API_THREAD_OPAQUE
2562 * @deprecated this field should not be used from outside of lavc
2564 attribute_deprecated
2565 void *thread_opaque;
2569 * noise vs. sse weight for the nsse comparsion function
2570 * - encoding: Set by user.
2571 * - decoding: unused
2577 * - encoding: Set by user.
2578 * - decoding: Set by libavcodec.
2581 #define FF_PROFILE_UNKNOWN -99
2582 #define FF_PROFILE_RESERVED -100
2584 #define FF_PROFILE_AAC_MAIN 0
2585 #define FF_PROFILE_AAC_LOW 1
2586 #define FF_PROFILE_AAC_SSR 2
2587 #define FF_PROFILE_AAC_LTP 3
2588 #define FF_PROFILE_AAC_HE 4
2589 #define FF_PROFILE_AAC_HE_V2 28
2590 #define FF_PROFILE_AAC_LD 22
2591 #define FF_PROFILE_AAC_ELD 38
2592 #define FF_PROFILE_MPEG2_AAC_LOW 128
2593 #define FF_PROFILE_MPEG2_AAC_HE 131
2595 #define FF_PROFILE_DTS 20
2596 #define FF_PROFILE_DTS_ES 30
2597 #define FF_PROFILE_DTS_96_24 40
2598 #define FF_PROFILE_DTS_HD_HRA 50
2599 #define FF_PROFILE_DTS_HD_MA 60
2601 #define FF_PROFILE_MPEG2_422 0
2602 #define FF_PROFILE_MPEG2_HIGH 1
2603 #define FF_PROFILE_MPEG2_SS 2
2604 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2605 #define FF_PROFILE_MPEG2_MAIN 4
2606 #define FF_PROFILE_MPEG2_SIMPLE 5
2608 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2609 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2611 #define FF_PROFILE_H264_BASELINE 66
2612 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2613 #define FF_PROFILE_H264_MAIN 77
2614 #define FF_PROFILE_H264_EXTENDED 88
2615 #define FF_PROFILE_H264_HIGH 100
2616 #define FF_PROFILE_H264_HIGH_10 110
2617 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2618 #define FF_PROFILE_H264_HIGH_422 122
2619 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2620 #define FF_PROFILE_H264_HIGH_444 144
2621 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2622 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2623 #define FF_PROFILE_H264_CAVLC_444 44
2625 #define FF_PROFILE_VC1_SIMPLE 0
2626 #define FF_PROFILE_VC1_MAIN 1
2627 #define FF_PROFILE_VC1_COMPLEX 2
2628 #define FF_PROFILE_VC1_ADVANCED 3
2630 #define FF_PROFILE_MPEG4_SIMPLE 0
2631 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2632 #define FF_PROFILE_MPEG4_CORE 2
2633 #define FF_PROFILE_MPEG4_MAIN 3
2634 #define FF_PROFILE_MPEG4_N_BIT 4
2635 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2636 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2637 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2638 #define FF_PROFILE_MPEG4_HYBRID 8
2639 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2640 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2641 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2642 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2643 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2644 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2645 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2647 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2648 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2649 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2650 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2651 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2655 * - encoding: Set by user.
2656 * - decoding: Set by libavcodec.
2659 #define FF_LEVEL_UNKNOWN -99
2663 * - encoding: unused
2664 * - decoding: Set by user.
2666 enum AVDiscard skip_loop_filter;
2670 * - encoding: unused
2671 * - decoding: Set by user.
2673 enum AVDiscard skip_idct;
2677 * - encoding: unused
2678 * - decoding: Set by user.
2680 enum AVDiscard skip_frame;
2683 * Header containing style information for text subtitles.
2684 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2685 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2686 * the Format line following. It shouldn't include any Dialogue line.
2687 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2688 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2690 uint8_t *subtitle_header;
2691 int subtitle_header_size;
2693 #if FF_API_ERROR_RATE
2695 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2698 attribute_deprecated
2702 #if FF_API_CODEC_PKT
2704 * @deprecated this field is not supposed to be accessed from outside lavc
2706 attribute_deprecated
2711 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2712 * Used for compliant TS muxing.
2713 * - encoding: Set by libavcodec.
2714 * - decoding: unused.
2722 typedef struct AVProfile {
2724 const char *name; ///< short name for the profile
2727 typedef struct AVCodecDefault AVCodecDefault;
2734 typedef struct AVCodec {
2736 * Name of the codec implementation.
2737 * The name is globally unique among encoders and among decoders (but an
2738 * encoder and a decoder can share the same name).
2739 * This is the primary way to find a codec from the user perspective.
2743 * Descriptive name for the codec, meant to be more human readable than name.
2744 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2746 const char *long_name;
2747 enum AVMediaType type;
2750 * Codec capabilities.
2754 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2755 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2756 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2757 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2758 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2760 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2762 const AVClass *priv_class; ///< AVClass for the private context
2763 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2765 /*****************************************************************
2766 * No fields below this line are part of the public API. They
2767 * may not be used outside of libavcodec and can be changed and
2769 * New public fields should be added right above.
2770 *****************************************************************
2773 struct AVCodec *next;
2775 * @name Frame-level threading support functions
2779 * If defined, called on thread contexts when they are created.
2780 * If the codec allocates writable tables in init(), re-allocate them here.
2781 * priv_data will be set to a copy of the original.
2783 int (*init_thread_copy)(AVCodecContext *);
2785 * Copy necessary context variables from a previous thread context to the current one.
2786 * If not defined, the next thread will start automatically; otherwise, the codec
2787 * must call ff_thread_finish_setup().
2789 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2791 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2795 * Private codec-specific defaults.
2797 const AVCodecDefault *defaults;
2800 * Initialize codec static data, called from avcodec_register().
2802 void (*init_static_data)(struct AVCodec *codec);
2804 int (*init)(AVCodecContext *);
2805 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2806 const struct AVSubtitle *sub);
2808 * Encode data to an AVPacket.
2810 * @param avctx codec context
2811 * @param avpkt output AVPacket (may contain a user-provided buffer)
2812 * @param[in] frame AVFrame containing the raw data to be encoded
2813 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2814 * non-empty packet was returned in avpkt.
2815 * @return 0 on success, negative error code on failure
2817 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2818 int *got_packet_ptr);
2819 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2820 int (*close)(AVCodecContext *);
2823 * Will be called when seeking
2825 void (*flush)(AVCodecContext *);
2831 typedef struct AVHWAccel {
2833 * Name of the hardware accelerated codec.
2834 * The name is globally unique among encoders and among decoders (but an
2835 * encoder and a decoder can share the same name).
2840 * Type of codec implemented by the hardware accelerator.
2842 * See AVMEDIA_TYPE_xxx
2844 enum AVMediaType type;
2847 * Codec implemented by the hardware accelerator.
2849 * See AV_CODEC_ID_xxx
2854 * Supported pixel format.
2856 * Only hardware accelerated formats are supported here.
2858 enum AVPixelFormat pix_fmt;
2861 * Hardware accelerated codec capabilities.
2862 * see FF_HWACCEL_CODEC_CAP_*
2866 struct AVHWAccel *next;
2869 * Called at the beginning of each frame or field picture.
2871 * Meaningful frame information (codec specific) is guaranteed to
2872 * be parsed at this point. This function is mandatory.
2874 * Note that buf can be NULL along with buf_size set to 0.
2875 * Otherwise, this means the whole frame is available at this point.
2877 * @param avctx the codec context
2878 * @param buf the frame data buffer base
2879 * @param buf_size the size of the frame in bytes
2880 * @return zero if successful, a negative value otherwise
2882 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2885 * Callback for each slice.
2887 * Meaningful slice information (codec specific) is guaranteed to
2888 * be parsed at this point. This function is mandatory.
2890 * @param avctx the codec context
2891 * @param buf the slice data buffer base
2892 * @param buf_size the size of the slice in bytes
2893 * @return zero if successful, a negative value otherwise
2895 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2898 * Called at the end of each frame or field picture.
2900 * The whole picture is parsed at this point and can now be sent
2901 * to the hardware accelerator. This function is mandatory.
2903 * @param avctx the codec context
2904 * @return zero if successful, a negative value otherwise
2906 int (*end_frame)(AVCodecContext *avctx);
2909 * Size of HW accelerator private data.
2911 * Private data is allocated with av_mallocz() before
2912 * AVCodecContext.get_buffer() and deallocated after
2913 * AVCodecContext.release_buffer().
2919 * @defgroup lavc_picture AVPicture
2921 * Functions for working with AVPicture
2926 * four components are given, that's all.
2927 * the last component is alpha
2929 typedef struct AVPicture {
2930 uint8_t *data[AV_NUM_DATA_POINTERS];
2931 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
2938 #define AVPALETTE_SIZE 1024
2939 #define AVPALETTE_COUNT 256
2941 enum AVSubtitleType {
2944 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2947 * Plain text, the text field must be set by the decoder and is
2948 * authoritative. ass and pict fields may contain approximations.
2953 * Formatted text, the ass field must be set by the decoder and is
2954 * authoritative. pict and text fields may contain approximations.
2959 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
2961 typedef struct AVSubtitleRect {
2962 int x; ///< top left corner of pict, undefined when pict is not set
2963 int y; ///< top left corner of pict, undefined when pict is not set
2964 int w; ///< width of pict, undefined when pict is not set
2965 int h; ///< height of pict, undefined when pict is not set
2966 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2969 * data+linesize for the bitmap of this subtitle.
2970 * can be set for text/ass as well once they where rendered
2973 enum AVSubtitleType type;
2975 char *text; ///< 0 terminated plain UTF-8 text
2978 * 0 terminated ASS/SSA compatible event line.
2979 * The pressentation of this is unaffected by the other values in this
2986 typedef struct AVSubtitle {
2987 uint16_t format; /* 0 = graphics */
2988 uint32_t start_display_time; /* relative to packet pts, in ms */
2989 uint32_t end_display_time; /* relative to packet pts, in ms */
2991 AVSubtitleRect **rects;
2992 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
2996 * If c is NULL, returns the first registered codec,
2997 * if c is non-NULL, returns the next registered codec after c,
2998 * or NULL if c is the last one.
3000 AVCodec *av_codec_next(const AVCodec *c);
3003 * Return the LIBAVCODEC_VERSION_INT constant.
3005 unsigned avcodec_version(void);
3008 * Return the libavcodec build-time configuration.
3010 const char *avcodec_configuration(void);
3013 * Return the libavcodec license.
3015 const char *avcodec_license(void);
3018 * Register the codec codec and initialize libavcodec.
3020 * @warning either this function or avcodec_register_all() must be called
3021 * before any other libavcodec functions.
3023 * @see avcodec_register_all()
3025 void avcodec_register(AVCodec *codec);
3028 * Register all the codecs, parsers and bitstream filters which were enabled at
3029 * configuration time. If you do not call this function you can select exactly
3030 * which formats you want to support, by using the individual registration
3033 * @see avcodec_register
3034 * @see av_register_codec_parser
3035 * @see av_register_bitstream_filter
3037 void avcodec_register_all(void);
3040 * Allocate an AVCodecContext and set its fields to default values. The
3041 * resulting struct can be deallocated by calling avcodec_close() on it followed
3044 * @param codec if non-NULL, allocate private data and initialize defaults
3045 * for the given codec. It is illegal to then call avcodec_open2()
3046 * with a different codec.
3047 * If NULL, then the codec-specific defaults won't be initialized,
3048 * which may result in suboptimal default settings (this is
3049 * important mainly for encoders, e.g. libx264).
3051 * @return An AVCodecContext filled with default values or NULL on failure.
3052 * @see avcodec_get_context_defaults
3054 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3057 * Set the fields of the given AVCodecContext to default values corresponding
3058 * to the given codec (defaults may be codec-dependent).
3060 * Do not call this function if a non-NULL codec has been passed
3061 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3062 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3063 * different codec on this AVCodecContext.
3065 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3068 * Get the AVClass for AVCodecContext. It can be used in combination with
3069 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3071 * @see av_opt_find().
3073 const AVClass *avcodec_get_class(void);
3076 * Copy the settings of the source AVCodecContext into the destination
3077 * AVCodecContext. The resulting destination codec context will be
3078 * unopened, i.e. you are required to call avcodec_open2() before you
3079 * can use this AVCodecContext to decode/encode video/audio data.
3081 * @param dest target codec context, should be initialized with
3082 * avcodec_alloc_context3(), but otherwise uninitialized
3083 * @param src source codec context
3084 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3086 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3089 * Allocate an AVFrame and set its fields to default values. The resulting
3090 * struct must be freed using avcodec_free_frame().
3092 * @return An AVFrame filled with default values or NULL on failure.
3093 * @see avcodec_get_frame_defaults
3095 AVFrame *avcodec_alloc_frame(void);
3098 * Set the fields of the given AVFrame to default values.
3100 * @param frame The AVFrame of which the fields should be set to default values.
3102 void avcodec_get_frame_defaults(AVFrame *frame);
3105 * Free the frame and any dynamically allocated objects in it,
3106 * e.g. extended_data.
3108 * @param frame frame to be freed. The pointer will be set to NULL.
3110 * @warning this function does NOT free the data buffers themselves
3111 * (it does not know how, since they might have been allocated with
3112 * a custom get_buffer()).
3114 void avcodec_free_frame(AVFrame **frame);
3117 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3118 * function the context has to be allocated with avcodec_alloc_context3().
3120 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3121 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3122 * retrieving a codec.
3124 * @warning This function is not thread safe!
3127 * avcodec_register_all();
3128 * av_dict_set(&opts, "b", "2.5M", 0);
3129 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3133 * context = avcodec_alloc_context3(codec);
3135 * if (avcodec_open2(context, codec, opts) < 0)
3139 * @param avctx The context to initialize.
3140 * @param codec The codec to open this context for. If a non-NULL codec has been
3141 * previously passed to avcodec_alloc_context3() or
3142 * avcodec_get_context_defaults3() for this context, then this
3143 * parameter MUST be either NULL or equal to the previously passed
3145 * @param options A dictionary filled with AVCodecContext and codec-private options.
3146 * On return this object will be filled with options that were not found.
3148 * @return zero on success, a negative value on error
3149 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3150 * av_dict_set(), av_opt_find().
3152 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3155 * Close a given AVCodecContext and free all the data associated with it
3156 * (but not the AVCodecContext itself).
3158 * Calling this function on an AVCodecContext that hasn't been opened will free
3159 * the codec-specific data allocated in avcodec_alloc_context3() /
3160 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3163 int avcodec_close(AVCodecContext *avctx);
3166 * Free all allocated data in the given subtitle struct.
3168 * @param sub AVSubtitle to free.
3170 void avsubtitle_free(AVSubtitle *sub);
3177 * @addtogroup lavc_packet
3181 #if FF_API_DESTRUCT_PACKET
3183 * Default packet destructor.
3184 * @deprecated use the AVBuffer API instead
3186 attribute_deprecated
3187 void av_destruct_packet(AVPacket *pkt);
3191 * Initialize optional fields of a packet with default values.
3193 * Note, this does not touch the data and size members, which have to be
3194 * initialized separately.
3198 void av_init_packet(AVPacket *pkt);
3201 * Allocate the payload of a packet and initialize its fields with
3205 * @param size wanted payload size
3206 * @return 0 if OK, AVERROR_xxx otherwise
3208 int av_new_packet(AVPacket *pkt, int size);
3211 * Reduce packet size, correctly zeroing padding
3214 * @param size new size
3216 void av_shrink_packet(AVPacket *pkt, int size);
3219 * Increase packet size, correctly zeroing padding
3222 * @param grow_by number of bytes by which to increase the size of the packet
3224 int av_grow_packet(AVPacket *pkt, int grow_by);
3227 * Initialize a reference-counted packet from av_malloc()ed data.
3229 * @param pkt packet to be initialized. This function will set the data, size,
3230 * buf and destruct fields, all others are left untouched.
3231 * @param data Data allocated by av_malloc() to be used as packet data. If this
3232 * function returns successfully, the data is owned by the underlying AVBuffer.
3233 * The caller may not access the data through other means.
3234 * @param size size of data in bytes, without the padding. I.e. the full buffer
3235 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3237 * @return 0 on success, a negative AVERROR on error
3239 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3242 * @warning This is a hack - the packet memory allocation stuff is broken. The
3243 * packet is allocated if it was not really allocated.
3245 int av_dup_packet(AVPacket *pkt);
3250 * @param pkt packet to free
3252 void av_free_packet(AVPacket *pkt);
3255 * Allocate new information of a packet.
3258 * @param type side information type
3259 * @param size side information size
3260 * @return pointer to fresh allocated data or NULL otherwise
3262 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3266 * Shrink the already allocated side data buffer
3269 * @param type side information type
3270 * @param size new side information size
3271 * @return 0 on success, < 0 on failure
3273 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3277 * Get side information from packet.
3280 * @param type desired side information type
3281 * @param size pointer for side information size to store (optional)
3282 * @return pointer to data if present or NULL otherwise
3284 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3288 * Convenience function to free all the side data stored.
3289 * All the other fields stay untouched.
3293 void av_packet_free_side_data(AVPacket *pkt);
3296 * Setup a new reference to the data described by a given packet
3298 * If src is reference-counted, setup dst as a new reference to the
3299 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3300 * data from src into it.
3302 * All the other fields are copied from src.
3304 * @see av_packet_unref
3306 * @param dst Destination packet
3307 * @param src Source packet
3309 * @return 0 on success, a negative AVERROR on error.
3311 int av_packet_ref(AVPacket *dst, AVPacket *src);
3316 * Unreference the buffer referenced by the packet and reset the
3317 * remaining packet fields to their default values.
3319 * @param pkt The packet to be unreferenced.
3321 void av_packet_unref(AVPacket *pkt);
3324 * Move every field in src to dst and reset src.
3326 * @see av_packet_unref
3328 * @param src Source packet, will be reset
3329 * @param dst Destination packet
3331 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3334 * Copy only "properties" fields from src to dst.
3336 * Properties for the purpose of this function are all the fields
3337 * beside those related to the packet data (buf, data, size)
3339 * @param dst Destination packet
3340 * @param src Source packet
3342 * @return 0 on success AVERROR on failure.
3345 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3352 * @addtogroup lavc_decoding
3357 * Find a registered decoder with a matching codec ID.
3359 * @param id AVCodecID of the requested decoder
3360 * @return A decoder if one was found, NULL otherwise.
3362 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3365 * Find a registered decoder with the specified name.
3367 * @param name name of the requested decoder
3368 * @return A decoder if one was found, NULL otherwise.
3370 AVCodec *avcodec_find_decoder_by_name(const char *name);
3372 #if FF_API_GET_BUFFER
3373 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3374 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3375 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3379 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3380 * it can be called by custom get_buffer2() implementations for decoders without
3381 * CODEC_CAP_DR1 set.
3383 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3386 * Return the amount of padding in pixels which the get_buffer callback must
3387 * provide around the edge of the image for codecs which do not have the
3388 * CODEC_FLAG_EMU_EDGE flag.
3390 * @return Required padding in pixels.
3392 unsigned avcodec_get_edge_width(void);
3395 * Modify width and height values so that they will result in a memory
3396 * buffer that is acceptable for the codec if you do not use any horizontal
3399 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3400 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3401 * according to avcodec_get_edge_width() before.
3403 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3406 * Modify width and height values so that they will result in a memory
3407 * buffer that is acceptable for the codec if you also ensure that all
3408 * line sizes are a multiple of the respective linesize_align[i].
3410 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3411 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3412 * according to avcodec_get_edge_width() before.
3414 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3415 int linesize_align[AV_NUM_DATA_POINTERS]);
3418 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3420 * Some decoders may support multiple frames in a single AVPacket. Such
3421 * decoders would then just decode the first frame and the return value would be
3422 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3423 * called again with an AVPacket containing the remaining data in order to
3424 * decode the second frame, etc... Even if no frames are returned, the packet
3425 * needs to be fed to the decoder with remaining data until it is completely
3426 * consumed or an error occurs.
3428 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3429 * and output. This means that for some packets they will not immediately
3430 * produce decoded output and need to be flushed at the end of decoding to get
3431 * all the decoded data. Flushing is done by calling this function with packets
3432 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3433 * returning samples. It is safe to flush even those decoders that are not
3434 * marked with CODEC_CAP_DELAY, then no samples will be returned.
3436 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3437 * larger than the actual read bytes because some optimized bitstream
3438 * readers read 32 or 64 bits at once and could read over the end.
3440 * @param avctx the codec context
3441 * @param[out] frame The AVFrame in which to store decoded audio samples.
3442 * The decoder will allocate a buffer for the decoded frame by
3443 * calling the AVCodecContext.get_buffer2() callback.
3444 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3445 * reference counted and the returned reference belongs to the
3446 * caller. The caller must release the frame using av_frame_unref()
3447 * when the frame is no longer needed. The caller may safely write
3448 * to the frame if av_frame_is_writable() returns 1.
3449 * When AVCodecContext.refcounted_frames is set to 0, the returned
3450 * reference belongs to the decoder and is valid only until the
3451 * next call to this function or until closing or flushing the
3452 * decoder. The caller may not write to it.
3453 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3454 * non-zero. Note that this field being set to zero
3455 * does not mean that an error has occurred. For
3456 * decoders with CODEC_CAP_DELAY set, no given decode
3457 * call is guaranteed to produce a frame.
3458 * @param[in] avpkt The input AVPacket containing the input buffer.
3459 * At least avpkt->data and avpkt->size should be set. Some
3460 * decoders might also require additional fields to be set.
3461 * @return A negative error code is returned if an error occurred during
3462 * decoding, otherwise the number of bytes consumed from the input
3463 * AVPacket is returned.
3465 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3466 int *got_frame_ptr, AVPacket *avpkt);
3469 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3470 * Some decoders may support multiple frames in a single AVPacket, such
3471 * decoders would then just decode the first frame.
3473 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3474 * the actual read bytes because some optimized bitstream readers read 32 or 64
3475 * bits at once and could read over the end.
3477 * @warning The end of the input buffer buf should be set to 0 to ensure that
3478 * no overreading happens for damaged MPEG streams.
3480 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3481 * between input and output, these need to be fed with avpkt->data=NULL,
3482 * avpkt->size=0 at the end to return the remaining frames.
3484 * @param avctx the codec context
3485 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3486 * Use av_frame_alloc() to get an AVFrame. The codec will
3487 * allocate memory for the actual bitmap by calling the
3488 * AVCodecContext.get_buffer2() callback.
3489 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3490 * reference counted and the returned reference belongs to the
3491 * caller. The caller must release the frame using av_frame_unref()
3492 * when the frame is no longer needed. The caller may safely write
3493 * to the frame if av_frame_is_writable() returns 1.
3494 * When AVCodecContext.refcounted_frames is set to 0, the returned
3495 * reference belongs to the decoder and is valid only until the
3496 * next call to this function or until closing or flushing the
3497 * decoder. The caller may not write to it.
3499 * @param[in] avpkt The input AVpacket containing the input buffer.
3500 * You can create such packet with av_init_packet() and by then setting
3501 * data and size, some decoders might in addition need other fields like
3502 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3504 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3505 * @return On error a negative value is returned, otherwise the number of bytes
3506 * used or zero if no frame could be decompressed.
3508 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3509 int *got_picture_ptr,
3513 * Decode a subtitle message.
3514 * Return a negative value on error, otherwise return the number of bytes used.
3515 * If no subtitle could be decompressed, got_sub_ptr is zero.
3516 * Otherwise, the subtitle is stored in *sub.
3517 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3518 * simplicity, because the performance difference is expect to be negligible
3519 * and reusing a get_buffer written for video codecs would probably perform badly
3520 * due to a potentially very different allocation pattern.
3522 * @param avctx the codec context
3523 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3524 freed with avsubtitle_free if *got_sub_ptr is set.
3525 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3526 * @param[in] avpkt The input AVPacket containing the input buffer.
3528 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3533 * @defgroup lavc_parsing Frame parsing
3537 enum AVPictureStructure {
3538 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3539 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3540 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3541 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3544 typedef struct AVCodecParserContext {
3546 struct AVCodecParser *parser;
3547 int64_t frame_offset; /* offset of the current frame */
3548 int64_t cur_offset; /* current offset
3549 (incremented by each av_parser_parse()) */
3550 int64_t next_frame_offset; /* offset of the next frame */
3552 int pict_type; /* XXX: Put it back in AVCodecContext. */
3554 * This field is used for proper frame duration computation in lavf.
3555 * It signals, how much longer the frame duration of the current frame
3556 * is compared to normal frame duration.
3558 * frame_duration = (1 + repeat_pict) * time_base
3560 * It is used by codecs like H.264 to display telecined material.
3562 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3563 int64_t pts; /* pts of the current frame */
3564 int64_t dts; /* dts of the current frame */
3569 int fetch_timestamp;
3571 #define AV_PARSER_PTS_NB 4
3572 int cur_frame_start_index;
3573 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3574 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3575 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3578 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3579 #define PARSER_FLAG_ONCE 0x0002
3580 /// Set if the parser has a valid file offset
3581 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3583 int64_t offset; ///< byte offset from starting packet start
3584 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3587 * Set by parser to 1 for key frames and 0 for non-key frames.
3588 * It is initialized to -1, so if the parser doesn't set this flag,
3589 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3595 * Time difference in stream time base units from the pts of this
3596 * packet to the point at which the output from the decoder has converged
3597 * independent from the availability of previous frames. That is, the
3598 * frames are virtually identical no matter if decoding started from
3599 * the very first frame or from this keyframe.
3600 * Is AV_NOPTS_VALUE if unknown.
3601 * This field is not the display duration of the current frame.
3602 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3605 * The purpose of this field is to allow seeking in streams that have no
3606 * keyframes in the conventional sense. It corresponds to the
3607 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3608 * essential for some types of subtitle streams to ensure that all
3609 * subtitles are correctly displayed after seeking.
3611 int64_t convergence_duration;
3613 // Timestamp generation support:
3615 * Synchronization point for start of timestamp generation.
3617 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3620 * For example, this corresponds to presence of H.264 buffering period
3626 * Offset of the current timestamp against last timestamp sync point in
3627 * units of AVCodecContext.time_base.
3629 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3630 * contain a valid timestamp offset.
3632 * Note that the timestamp of sync point has usually a nonzero
3633 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3634 * the next frame after timestamp sync point will be usually 1.
3636 * For example, this corresponds to H.264 cpb_removal_delay.
3638 int dts_ref_dts_delta;
3641 * Presentation delay of current frame in units of AVCodecContext.time_base.
3643 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3644 * contain valid non-negative timestamp delta (presentation time of a frame
3645 * must not lie in the past).
3647 * This delay represents the difference between decoding and presentation
3648 * time of the frame.
3650 * For example, this corresponds to H.264 dpb_output_delay.
3655 * Position of the packet in file.
3657 * Analogous to cur_frame_pts/dts
3659 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3662 * Byte position of currently parsed frame in stream.
3667 * Previous frame byte position.
3672 * Duration of the current frame.
3673 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3674 * For all other types, this is in units of AVCodecContext.time_base.
3678 enum AVFieldOrder field_order;
3681 * Indicate whether a picture is coded as a frame, top field or bottom field.
3683 * For example, H.264 field_pic_flag equal to 0 corresponds to
3684 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3685 * equal to 1 and bottom_field_flag equal to 0 corresponds to
3686 * AV_PICTURE_STRUCTURE_TOP_FIELD.
3688 enum AVPictureStructure picture_structure;
3691 * Picture number incremented in presentation or output order.
3692 * This field may be reinitialized at the first picture of a new sequence.
3694 * For example, this corresponds to H.264 PicOrderCnt.
3696 int output_picture_number;
3697 } AVCodecParserContext;
3699 typedef struct AVCodecParser {
3700 int codec_ids[5]; /* several codec IDs are permitted */
3702 int (*parser_init)(AVCodecParserContext *s);
3703 int (*parser_parse)(AVCodecParserContext *s,
3704 AVCodecContext *avctx,
3705 const uint8_t **poutbuf, int *poutbuf_size,
3706 const uint8_t *buf, int buf_size);
3707 void (*parser_close)(AVCodecParserContext *s);
3708 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3709 struct AVCodecParser *next;
3712 AVCodecParser *av_parser_next(AVCodecParser *c);
3714 void av_register_codec_parser(AVCodecParser *parser);
3715 AVCodecParserContext *av_parser_init(int codec_id);
3720 * @param s parser context.
3721 * @param avctx codec context.
3722 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3723 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3724 * @param buf input buffer.
3725 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3726 * @param pts input presentation timestamp.
3727 * @param dts input decoding timestamp.
3728 * @param pos input byte position in stream.
3729 * @return the number of bytes of the input bitstream used.
3734 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3741 * decode_frame(data, size);
3745 int av_parser_parse2(AVCodecParserContext *s,
3746 AVCodecContext *avctx,
3747 uint8_t **poutbuf, int *poutbuf_size,
3748 const uint8_t *buf, int buf_size,
3749 int64_t pts, int64_t dts,
3753 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3754 * @deprecated use AVBitstreamFilter
3756 int av_parser_change(AVCodecParserContext *s,
3757 AVCodecContext *avctx,
3758 uint8_t **poutbuf, int *poutbuf_size,
3759 const uint8_t *buf, int buf_size, int keyframe);
3760 void av_parser_close(AVCodecParserContext *s);
3768 * @addtogroup lavc_encoding
3773 * Find a registered encoder with a matching codec ID.
3775 * @param id AVCodecID of the requested encoder
3776 * @return An encoder if one was found, NULL otherwise.
3778 AVCodec *avcodec_find_encoder(enum AVCodecID id);
3781 * Find a registered encoder with the specified name.
3783 * @param name name of the requested encoder
3784 * @return An encoder if one was found, NULL otherwise.
3786 AVCodec *avcodec_find_encoder_by_name(const char *name);
3789 * Encode a frame of audio.
3791 * Takes input samples from frame and writes the next output packet, if
3792 * available, to avpkt. The output packet does not necessarily contain data for
3793 * the most recent frame, as encoders can delay, split, and combine input frames
3794 * internally as needed.
3796 * @param avctx codec context
3797 * @param avpkt output AVPacket.
3798 * The user can supply an output buffer by setting
3799 * avpkt->data and avpkt->size prior to calling the
3800 * function, but if the size of the user-provided data is not
3801 * large enough, encoding will fail. All other AVPacket fields
3802 * will be reset by the encoder using av_init_packet(). If
3803 * avpkt->data is NULL, the encoder will allocate it.
3804 * The encoder will set avpkt->size to the size of the
3807 * If this function fails or produces no output, avpkt will be
3808 * freed using av_free_packet() (i.e. avpkt->destruct will be
3809 * called to free the user supplied buffer).
3810 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3811 * May be NULL when flushing an encoder that has the
3812 * CODEC_CAP_DELAY capability set.
3813 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3814 * can have any number of samples.
3815 * If it is not set, frame->nb_samples must be equal to
3816 * avctx->frame_size for all frames except the last.
3817 * The final frame may be smaller than avctx->frame_size.
3818 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3819 * output packet is non-empty, and to 0 if it is
3820 * empty. If the function returns an error, the
3821 * packet can be assumed to be invalid, and the
3822 * value of got_packet_ptr is undefined and should
3824 * @return 0 on success, negative error code on failure
3826 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3827 const AVFrame *frame, int *got_packet_ptr);
3830 * Encode a frame of video.
3832 * Takes input raw video data from frame and writes the next output packet, if
3833 * available, to avpkt. The output packet does not necessarily contain data for
3834 * the most recent frame, as encoders can delay and reorder input frames
3835 * internally as needed.
3837 * @param avctx codec context
3838 * @param avpkt output AVPacket.
3839 * The user can supply an output buffer by setting
3840 * avpkt->data and avpkt->size prior to calling the
3841 * function, but if the size of the user-provided data is not
3842 * large enough, encoding will fail. All other AVPacket fields
3843 * will be reset by the encoder using av_init_packet(). If
3844 * avpkt->data is NULL, the encoder will allocate it.
3845 * The encoder will set avpkt->size to the size of the
3846 * output packet. The returned data (if any) belongs to the
3847 * caller, he is responsible for freeing it.
3849 * If this function fails or produces no output, avpkt will be
3850 * freed using av_free_packet() (i.e. avpkt->destruct will be
3851 * called to free the user supplied buffer).
3852 * @param[in] frame AVFrame containing the raw video data to be encoded.
3853 * May be NULL when flushing an encoder that has the
3854 * CODEC_CAP_DELAY capability set.
3855 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3856 * output packet is non-empty, and to 0 if it is
3857 * empty. If the function returns an error, the
3858 * packet can be assumed to be invalid, and the
3859 * value of got_packet_ptr is undefined and should
3861 * @return 0 on success, negative error code on failure
3863 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3864 const AVFrame *frame, int *got_packet_ptr);
3866 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3867 const AVSubtitle *sub);
3875 * @addtogroup lavc_picture
3880 * Allocate memory for a picture. Call avpicture_free() to free it.
3882 * @see avpicture_fill()
3884 * @param picture the picture to be filled in
3885 * @param pix_fmt the format of the picture
3886 * @param width the width of the picture
3887 * @param height the height of the picture
3888 * @return zero if successful, a negative value if not
3890 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
3893 * Free a picture previously allocated by avpicture_alloc().
3894 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3897 * @param picture the AVPicture to be freed
3899 void avpicture_free(AVPicture *picture);
3902 * Fill in the AVPicture fields.
3903 * The fields of the given AVPicture are filled in by using the 'ptr' address
3904 * which points to the image data buffer. Depending on the specified picture
3905 * format, one or multiple image data pointers and line sizes will be set.
3906 * If a planar format is specified, several pointers will be set pointing to
3907 * the different picture planes and the line sizes of the different planes
3908 * will be stored in the lines_sizes array.
3909 * Call with ptr == NULL to get the required size for the ptr buffer.
3911 * To allocate the buffer and fill in the AVPicture fields in one call,
3912 * use avpicture_alloc().
3914 * @param picture AVPicture whose fields are to be filled in
3915 * @param ptr Buffer which will contain or contains the actual image data
3916 * @param pix_fmt The format in which the picture data is stored.
3917 * @param width the width of the image in pixels
3918 * @param height the height of the image in pixels
3919 * @return size of the image data in bytes
3921 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3922 enum AVPixelFormat pix_fmt, int width, int height);
3925 * Copy pixel data from an AVPicture into a buffer.
3926 * The data is stored compactly, without any gaps for alignment or padding
3927 * which may be applied by avpicture_fill().
3929 * @see avpicture_get_size()
3931 * @param[in] src AVPicture containing image data
3932 * @param[in] pix_fmt The format in which the picture data is stored.
3933 * @param[in] width the width of the image in pixels.
3934 * @param[in] height the height of the image in pixels.
3935 * @param[out] dest A buffer into which picture data will be copied.
3936 * @param[in] dest_size The size of 'dest'.
3937 * @return The number of bytes written to dest, or a negative value (error code) on error.
3939 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
3940 int width, int height,
3941 unsigned char *dest, int dest_size);
3944 * Calculate the size in bytes that a picture of the given width and height
3945 * would occupy if stored in the given picture format.
3946 * Note that this returns the size of a compact representation as generated
3947 * by avpicture_layout(), which can be smaller than the size required for e.g.
3950 * @param pix_fmt the given picture format
3951 * @param width the width of the image
3952 * @param height the height of the image
3953 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3955 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
3957 #if FF_API_DEINTERLACE
3959 * deinterlace - if not supported return -1
3961 * @deprecated - use yadif (in libavfilter) instead
3963 attribute_deprecated
3964 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3965 enum AVPixelFormat pix_fmt, int width, int height);
3968 * Copy image src to dst. Wraps av_picture_data_copy() above.
3970 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3971 enum AVPixelFormat pix_fmt, int width, int height);
3974 * Crop image top and left side.
3976 int av_picture_crop(AVPicture *dst, const AVPicture *src,
3977 enum AVPixelFormat pix_fmt, int top_band, int left_band);
3982 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
3983 int padtop, int padbottom, int padleft, int padright, int *color);
3990 * @defgroup lavc_misc Utility functions
3993 * Miscellaneous utility functions related to both encoding and decoding
3999 * @defgroup lavc_misc_pixfmt Pixel formats
4001 * Functions for working with pixel formats.
4006 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4009 void attribute_deprecated avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4012 * Return a value representing the fourCC code associated to the
4013 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4016 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4018 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4019 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4020 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4021 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4022 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4023 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4026 * Compute what kind of losses will occur when converting from one specific
4027 * pixel format to another.
4028 * When converting from one pixel format to another, information loss may occur.
4029 * For example, when converting from RGB24 to GRAY, the color information will
4030 * be lost. Similarly, other losses occur when converting from some formats to
4031 * other formats. These losses can involve loss of chroma, but also loss of
4032 * resolution, loss of color depth, loss due to the color space conversion, loss
4033 * of the alpha bits or loss due to color quantization.
4034 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4035 * which will occur when converting from one pixel format to another.
4037 * @param[in] dst_pix_fmt destination pixel format
4038 * @param[in] src_pix_fmt source pixel format
4039 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4040 * @return Combination of flags informing you what kind of losses will occur.
4042 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4046 * Find the best pixel format to convert to given a certain source pixel
4047 * format. When converting from one pixel format to another, information loss
4048 * may occur. For example, when converting from RGB24 to GRAY, the color
4049 * information will be lost. Similarly, other losses occur when converting from
4050 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4051 * the given pixel formats should be used to suffer the least amount of loss.
4052 * The pixel formats from which it chooses one, are determined by the
4053 * pix_fmt_list parameter.
4056 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4057 * @param[in] src_pix_fmt source pixel format
4058 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4059 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4060 * @return The best pixel format to convert to or -1 if none was found.
4062 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4063 enum AVPixelFormat src_pix_fmt,
4064 int has_alpha, int *loss_ptr);
4066 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4072 #if FF_API_SET_DIMENSIONS
4074 * @deprecated this function is not supposed to be used from outside of lavc
4076 attribute_deprecated
4077 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4081 * Put a string representing the codec tag codec_tag in buf.
4083 * @param buf_size size in bytes of buf
4084 * @return the length of the string that would have been generated if
4085 * enough space had been available, excluding the trailing null
4087 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4089 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4092 * Return a name for the specified profile, if available.
4094 * @param codec the codec that is searched for the given profile
4095 * @param profile the profile value for which a name is requested
4096 * @return A name for the profile if found, NULL otherwise.
4098 const char *av_get_profile_name(const AVCodec *codec, int profile);
4100 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4101 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4102 //FIXME func typedef
4105 * Fill audio frame data and linesize.
4106 * AVFrame extended_data channel pointers are allocated if necessary for
4109 * @param frame the AVFrame
4110 * frame->nb_samples must be set prior to calling the
4111 * function. This function fills in frame->data,
4112 * frame->extended_data, frame->linesize[0].
4113 * @param nb_channels channel count
4114 * @param sample_fmt sample format
4115 * @param buf buffer to use for frame data
4116 * @param buf_size size of buffer
4117 * @param align plane size sample alignment (0 = default)
4118 * @return 0 on success, negative error code on failure
4120 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4121 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4122 int buf_size, int align);
4125 * Reset the internal decoder state / flush internal buffers. Should be called
4126 * e.g. when seeking or when switching to a different stream.
4128 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4129 * this invalidates the frames previously returned from the decoder. When
4130 * refcounted frames are used, the decoder just releases any references it might
4131 * keep internally, but the caller's reference remains valid.
4133 void avcodec_flush_buffers(AVCodecContext *avctx);
4136 * Return codec bits per sample.
4138 * @param[in] codec_id the codec
4139 * @return Number of bits per sample or zero if unknown for the given codec.
4141 int av_get_bits_per_sample(enum AVCodecID codec_id);
4144 * Return codec bits per sample.
4145 * Only return non-zero if the bits per sample is exactly correct, not an
4148 * @param[in] codec_id the codec
4149 * @return Number of bits per sample or zero if unknown for the given codec.
4151 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4154 * Return audio frame duration.
4156 * @param avctx codec context
4157 * @param frame_bytes size of the frame, or 0 if unknown
4158 * @return frame duration, in samples, if known. 0 if not able to
4161 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4164 typedef struct AVBitStreamFilterContext {
4166 struct AVBitStreamFilter *filter;
4167 AVCodecParserContext *parser;
4168 struct AVBitStreamFilterContext *next;
4169 } AVBitStreamFilterContext;
4172 typedef struct AVBitStreamFilter {
4175 int (*filter)(AVBitStreamFilterContext *bsfc,
4176 AVCodecContext *avctx, const char *args,
4177 uint8_t **poutbuf, int *poutbuf_size,
4178 const uint8_t *buf, int buf_size, int keyframe);
4179 void (*close)(AVBitStreamFilterContext *bsfc);
4180 struct AVBitStreamFilter *next;
4181 } AVBitStreamFilter;
4183 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4184 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4185 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4186 AVCodecContext *avctx, const char *args,
4187 uint8_t **poutbuf, int *poutbuf_size,
4188 const uint8_t *buf, int buf_size, int keyframe);
4189 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4191 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4196 * Reallocate the given block if it is not large enough, otherwise do nothing.
4200 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4203 * Allocate a buffer, reusing the given one if large enough.
4205 * Contrary to av_fast_realloc the current buffer contents might not be
4206 * preserved and on error the old buffer is freed, thus no special
4207 * handling to avoid memleaks is necessary.
4209 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4210 * @param size size of the buffer *ptr points to
4211 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4212 * *size 0 if an error occurred.
4214 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4217 * Allocate a buffer with padding, reusing the given one if large enough.
4219 * Same behaviour av_fast_malloc but the buffer has additional
4220 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4223 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4226 * Encode extradata length to a buffer. Used by xiph codecs.
4228 * @param s buffer to write to; must be at least (v/255+1) bytes long
4229 * @param v size of extradata in bytes
4230 * @return number of bytes written to the buffer.
4232 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4234 #if FF_API_MISSING_SAMPLE
4236 * Log a generic warning message about a missing feature. This function is
4237 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4238 * only, and would normally not be used by applications.
4239 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4240 * a pointer to an AVClass struct
4241 * @param[in] feature string containing the name of the missing feature
4242 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4243 * If want_sample is non-zero, additional verbage will be added to the log
4244 * message which tells the user how to report samples to the development
4246 * @deprecated Use avpriv_report_missing_feature() instead.
4248 attribute_deprecated
4249 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4252 * Log a generic warning message asking for a sample. This function is
4253 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4254 * only, and would normally not be used by applications.
4255 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4256 * a pointer to an AVClass struct
4257 * @param[in] msg string containing an optional message, or NULL if no message
4258 * @deprecated Use avpriv_request_sample() instead.
4260 attribute_deprecated
4261 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4262 #endif /* FF_API_MISSING_SAMPLE */
4265 * Register the hardware accelerator hwaccel.
4267 void av_register_hwaccel(AVHWAccel *hwaccel);
4270 * If hwaccel is NULL, returns the first registered hardware accelerator,
4271 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4272 * after hwaccel, or NULL if hwaccel is the last one.
4274 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4278 * Lock operation used by lockmgr
4281 AV_LOCK_CREATE, ///< Create a mutex
4282 AV_LOCK_OBTAIN, ///< Lock the mutex
4283 AV_LOCK_RELEASE, ///< Unlock the mutex
4284 AV_LOCK_DESTROY, ///< Free mutex resources
4288 * Register a user provided lock manager supporting the operations
4289 * specified by AVLockOp. mutex points to a (void *) where the
4290 * lockmgr should store/get a pointer to a user allocated mutex. It's
4291 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4293 * @param cb User defined callback. Note: Libav may invoke calls to this
4294 * callback during the call to av_lockmgr_register().
4295 * Thus, the application must be prepared to handle that.
4296 * If cb is set to NULL the lockmgr will be unregistered.
4297 * Also note that during unregistration the previously registered
4298 * lockmgr callback may also be invoked.
4300 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4303 * Get the type of the given codec.
4305 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4308 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4309 * with no corresponding avcodec_close()), 0 otherwise.
4311 int avcodec_is_open(AVCodecContext *s);
4314 * @return a non-zero number if codec is an encoder, zero otherwise
4316 int av_codec_is_encoder(const AVCodec *codec);
4319 * @return a non-zero number if codec is a decoder, zero otherwise
4321 int av_codec_is_decoder(const AVCodec *codec);
4324 * @return descriptor for given codec ID or NULL if no descriptor exists.
4326 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4329 * Iterate over all codec descriptors known to libavcodec.
4331 * @param prev previous descriptor. NULL to get the first descriptor.
4333 * @return next descriptor or NULL after the last descriptor
4335 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4338 * @return codec descriptor with the given name or NULL if no such descriptor
4341 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4347 #endif /* AVCODEC_AVCODEC_H */