2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * Libav is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/dict.h"
37 #include "libavutil/frame.h"
38 #include "libavutil/log.h"
39 #include "libavutil/pixfmt.h"
40 #include "libavutil/rational.h"
45 * @defgroup libavc Encoding/Decoding Library
48 * @defgroup lavc_decoding Decoding
52 * @defgroup lavc_encoding Encoding
56 * @defgroup lavc_codec Codecs
58 * @defgroup lavc_codec_native Native Codecs
61 * @defgroup lavc_codec_wrappers External library wrappers
64 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
68 * @defgroup lavc_internal Internal
76 * @defgroup lavc_core Core functions/structures.
79 * Basic definitions, functions for querying libavcodec capabilities,
80 * allocating core structures, etc.
86 * Identify the syntax and semantics of the bitstream.
87 * The principle is roughly:
88 * Two decoders with the same ID can decode the same streams.
89 * Two encoders with the same ID can encode compatible streams.
90 * There may be slight deviations from the principle due to implementation
93 * If you add a codec ID to this list, add it so that
94 * 1. no value of a existing codec ID changes (that would break ABI),
95 * 2. it is as close as possible to similar codecs.
97 * After adding new codec IDs, do not forget to add an entry to the codec
98 * descriptor list and bump libavcodec minor version.
104 AV_CODEC_ID_MPEG1VIDEO,
105 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
106 AV_CODEC_ID_MPEG2VIDEO_XVMC,
117 AV_CODEC_ID_RAWVIDEO,
118 AV_CODEC_ID_MSMPEG4V1,
119 AV_CODEC_ID_MSMPEG4V2,
120 AV_CODEC_ID_MSMPEG4V3,
143 AV_CODEC_ID_INTERPLAY_VIDEO,
150 AV_CODEC_ID_MSVIDEO1,
155 AV_CODEC_ID_TRUEMOTION1,
156 AV_CODEC_ID_VMDVIDEO,
181 AV_CODEC_ID_TRUEMOTION2,
187 AV_CODEC_ID_SMACKVIDEO,
192 AV_CODEC_ID_JPEG2000,
198 AV_CODEC_ID_DSICINVIDEO,
199 AV_CODEC_ID_TIERTEXSEQVIDEO,
207 AV_CODEC_ID_BETHSOFTVID,
219 AV_CODEC_ID_ESCAPE124,
223 AV_CODEC_ID_MOTIONPIXELS,
235 AV_CODEC_ID_FLASHSV2,
236 AV_CODEC_ID_CDGRAPHICS,
239 AV_CODEC_ID_BINKVIDEO,
240 AV_CODEC_ID_IFF_ILBM,
241 AV_CODEC_ID_IFF_BYTERUN1,
247 AV_CODEC_ID_A64_MULTI,
248 AV_CODEC_ID_A64_MULTI5,
251 AV_CODEC_ID_LAGARITH,
255 AV_CODEC_ID_WMV3IMAGE,
256 AV_CODEC_ID_VC1IMAGE,
258 AV_CODEC_ID_BMV_VIDEO,
265 AV_CODEC_ID_ZEROCODEC,
274 AV_CODEC_ID_ESCAPE130,
277 AV_CODEC_ID_HNM4_VIDEO,
280 /* various PCM "codecs" */
281 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
282 AV_CODEC_ID_PCM_S16LE = 0x10000,
283 AV_CODEC_ID_PCM_S16BE,
284 AV_CODEC_ID_PCM_U16LE,
285 AV_CODEC_ID_PCM_U16BE,
288 AV_CODEC_ID_PCM_MULAW,
289 AV_CODEC_ID_PCM_ALAW,
290 AV_CODEC_ID_PCM_S32LE,
291 AV_CODEC_ID_PCM_S32BE,
292 AV_CODEC_ID_PCM_U32LE,
293 AV_CODEC_ID_PCM_U32BE,
294 AV_CODEC_ID_PCM_S24LE,
295 AV_CODEC_ID_PCM_S24BE,
296 AV_CODEC_ID_PCM_U24LE,
297 AV_CODEC_ID_PCM_U24BE,
298 AV_CODEC_ID_PCM_S24DAUD,
299 AV_CODEC_ID_PCM_ZORK,
300 AV_CODEC_ID_PCM_S16LE_PLANAR,
302 AV_CODEC_ID_PCM_F32BE,
303 AV_CODEC_ID_PCM_F32LE,
304 AV_CODEC_ID_PCM_F64BE,
305 AV_CODEC_ID_PCM_F64LE,
306 AV_CODEC_ID_PCM_BLURAY,
309 AV_CODEC_ID_PCM_S8_PLANAR,
310 AV_CODEC_ID_PCM_S24LE_PLANAR,
311 AV_CODEC_ID_PCM_S32LE_PLANAR,
313 /* various ADPCM codecs */
314 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
315 AV_CODEC_ID_ADPCM_IMA_WAV,
316 AV_CODEC_ID_ADPCM_IMA_DK3,
317 AV_CODEC_ID_ADPCM_IMA_DK4,
318 AV_CODEC_ID_ADPCM_IMA_WS,
319 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
320 AV_CODEC_ID_ADPCM_MS,
321 AV_CODEC_ID_ADPCM_4XM,
322 AV_CODEC_ID_ADPCM_XA,
323 AV_CODEC_ID_ADPCM_ADX,
324 AV_CODEC_ID_ADPCM_EA,
325 AV_CODEC_ID_ADPCM_G726,
326 AV_CODEC_ID_ADPCM_CT,
327 AV_CODEC_ID_ADPCM_SWF,
328 AV_CODEC_ID_ADPCM_YAMAHA,
329 AV_CODEC_ID_ADPCM_SBPRO_4,
330 AV_CODEC_ID_ADPCM_SBPRO_3,
331 AV_CODEC_ID_ADPCM_SBPRO_2,
332 AV_CODEC_ID_ADPCM_THP,
333 AV_CODEC_ID_ADPCM_IMA_AMV,
334 AV_CODEC_ID_ADPCM_EA_R1,
335 AV_CODEC_ID_ADPCM_EA_R3,
336 AV_CODEC_ID_ADPCM_EA_R2,
337 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
338 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
339 AV_CODEC_ID_ADPCM_EA_XAS,
340 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
341 AV_CODEC_ID_ADPCM_IMA_ISS,
342 AV_CODEC_ID_ADPCM_G722,
343 AV_CODEC_ID_ADPCM_IMA_APC,
346 AV_CODEC_ID_AMR_NB = 0x12000,
349 /* RealAudio codecs*/
350 AV_CODEC_ID_RA_144 = 0x13000,
353 /* various DPCM codecs */
354 AV_CODEC_ID_ROQ_DPCM = 0x14000,
355 AV_CODEC_ID_INTERPLAY_DPCM,
356 AV_CODEC_ID_XAN_DPCM,
357 AV_CODEC_ID_SOL_DPCM,
360 AV_CODEC_ID_MP2 = 0x15000,
361 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
371 AV_CODEC_ID_VMDAUDIO,
377 AV_CODEC_ID_WESTWOOD_SND1,
378 AV_CODEC_ID_GSM, ///< as in Berlin toast format
381 AV_CODEC_ID_TRUESPEECH,
383 AV_CODEC_ID_SMACKAUDIO,
386 AV_CODEC_ID_DSICINAUDIO,
388 AV_CODEC_ID_MUSEPACK7,
390 AV_CODEC_ID_GSM_MS, /* as found in WAV */
396 AV_CODEC_ID_NELLYMOSER,
397 AV_CODEC_ID_MUSEPACK8,
399 AV_CODEC_ID_WMAVOICE,
401 AV_CODEC_ID_WMALOSSLESS,
410 AV_CODEC_ID_BINKAUDIO_RDFT,
411 AV_CODEC_ID_BINKAUDIO_DCT,
412 AV_CODEC_ID_AAC_LATM,
417 AV_CODEC_ID_8SVX_EXP,
418 AV_CODEC_ID_8SVX_FIB,
419 AV_CODEC_ID_BMV_AUDIO,
424 AV_CODEC_ID_COMFORT_NOISE,
426 AV_CODEC_ID_METASOUND,
428 /* subtitle codecs */
429 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
430 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
431 AV_CODEC_ID_DVB_SUBTITLE,
432 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
435 AV_CODEC_ID_MOV_TEXT,
436 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
437 AV_CODEC_ID_DVB_TELETEXT,
440 /* other specific kind of codecs (generally used for attachments) */
441 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
442 AV_CODEC_ID_TTF = 0x18000,
444 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
446 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
447 * stream (only used by libavformat) */
448 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
449 * stream (only used by libavformat) */
450 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
454 * This struct describes the properties of a single codec described by an
456 * @see avcodec_get_descriptor()
458 typedef struct AVCodecDescriptor {
460 enum AVMediaType type;
462 * Name of the codec described by this descriptor. It is non-empty and
463 * unique for each codec descriptor. It should contain alphanumeric
464 * characters and '_' only.
468 * A more descriptive name for this codec. May be NULL.
470 const char *long_name;
472 * Codec properties, a combination of AV_CODEC_PROP_* flags.
478 * Codec uses only intra compression.
481 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
483 * Codec supports lossy compression. Audio and video codecs only.
484 * @note a codec may support both lossy and lossless
487 #define AV_CODEC_PROP_LOSSY (1 << 1)
489 * Codec supports lossless compression. Audio and video codecs only.
491 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
494 * @ingroup lavc_decoding
495 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
496 * This is mainly needed because some optimized bitstream readers read
497 * 32 or 64 bit at once and could read over the end.<br>
498 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
499 * MPEG bitstreams could cause overread and segfault.
501 #define FF_INPUT_BUFFER_PADDING_SIZE 8
504 * @ingroup lavc_encoding
505 * minimum encoding buffer size
506 * Used to avoid some checks during header writing.
508 #define FF_MIN_BUFFER_SIZE 16384
512 * @ingroup lavc_encoding
513 * motion estimation type.
516 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
520 ME_EPZS, ///< enhanced predictive zonal search
521 ME_X1, ///< reserved for experiments
522 ME_HEX, ///< hexagon based search
523 ME_UMH, ///< uneven multi-hexagon search
524 ME_TESA, ///< transformed exhaustive search algorithm
528 * @ingroup lavc_decoding
531 /* We leave some space between them for extensions (drop some
532 * keyframes for intra-only or drop just some bidir frames). */
533 AVDISCARD_NONE =-16, ///< discard nothing
534 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
535 AVDISCARD_NONREF = 8, ///< discard all non reference
536 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
537 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
538 AVDISCARD_ALL = 48, ///< discard all
541 enum AVColorPrimaries{
542 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
543 AVCOL_PRI_UNSPECIFIED = 2,
544 AVCOL_PRI_BT470M = 4,
545 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
546 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
547 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
549 AVCOL_PRI_NB , ///< Not part of ABI
552 enum AVColorTransferCharacteristic{
553 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
554 AVCOL_TRC_UNSPECIFIED = 2,
555 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
556 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
557 AVCOL_TRC_SMPTE240M = 7,
558 AVCOL_TRC_NB , ///< Not part of ABI
563 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
564 AVCOL_SPC_UNSPECIFIED = 2,
566 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
567 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
568 AVCOL_SPC_SMPTE240M = 7,
569 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
570 AVCOL_SPC_NB , ///< Not part of ABI
574 AVCOL_RANGE_UNSPECIFIED = 0,
575 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
576 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
577 AVCOL_RANGE_NB , ///< Not part of ABI
581 * X X 3 4 X X are luma samples,
582 * 1 2 1-6 are possible chroma positions
583 * X X 5 6 X 0 is undefined/unknown position
585 enum AVChromaLocation{
586 AVCHROMA_LOC_UNSPECIFIED = 0,
587 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
588 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
589 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
590 AVCHROMA_LOC_TOP = 4,
591 AVCHROMA_LOC_BOTTOMLEFT = 5,
592 AVCHROMA_LOC_BOTTOM = 6,
593 AVCHROMA_LOC_NB , ///< Not part of ABI
596 enum AVAudioServiceType {
597 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
598 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
599 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
600 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
601 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
602 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
603 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
604 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
605 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
606 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
610 * @ingroup lavc_encoding
612 typedef struct RcOverride{
615 int qscale; // If this is 0 then quality_factor will be used instead.
616 float quality_factor;
619 #define FF_MAX_B_FRAMES 16
622 These flags can be passed in AVCodecContext.flags before initialization.
623 Note: Not everything is supported yet.
627 * Allow decoders to produce frames with data planes that are not aligned
628 * to CPU requirements (e.g. due to cropping).
630 #define CODEC_FLAG_UNALIGNED 0x0001
631 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
632 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
633 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
634 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
635 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
636 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
638 * The parent program guarantees that the input for B-frames containing
639 * streams is not written to for at least s->max_b_frames+1 frames, if
640 * this is not set the input will be copied.
642 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
643 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
644 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
645 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
646 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
647 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
648 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
649 location instead of only at frame boundaries. */
650 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
651 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
652 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
653 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
654 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
655 /* Fx : Flag for h263+ extra options */
656 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
657 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
658 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
659 #define CODEC_FLAG_CLOSED_GOP 0x80000000
660 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
661 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
662 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
663 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
665 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
667 /* Unsupported options :
668 * Syntax Arithmetic coding (SAC)
669 * Reference Picture Selection
670 * Independent Segment Decoding */
672 /* codec capabilities */
674 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
676 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
677 * If not set, it might not use get_buffer() at all or use operations that
678 * assume the buffer was allocated by avcodec_default_get_buffer.
680 #define CODEC_CAP_DR1 0x0002
681 #define CODEC_CAP_TRUNCATED 0x0008
682 /* Codec can export data for HW decoding (XvMC). */
683 #define CODEC_CAP_HWACCEL 0x0010
685 * Encoder or decoder requires flushing with NULL input at the end in order to
686 * give the complete and correct output.
688 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
689 * with NULL data. The user can still send NULL data to the public encode
690 * or decode function, but libavcodec will not pass it along to the codec
691 * unless this flag is set.
694 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
695 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
699 * The encoder needs to be fed with NULL data at the end of encoding until the
700 * encoder no longer returns data.
702 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
703 * flag also means that the encoder must set the pts and duration for
704 * each output packet. If this flag is not set, the pts and duration will
705 * be determined by libavcodec from the input frame.
707 #define CODEC_CAP_DELAY 0x0020
709 * Codec can be fed a final frame with a smaller size.
710 * This can be used to prevent truncation of the last audio samples.
712 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
715 * Codec can export data for HW decoding (VDPAU).
717 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
720 * Codec can output multiple frames per AVPacket
721 * Normally demuxers return one frame at a time, demuxers which do not do
722 * are connected to a parser to split what they return into proper frames.
723 * This flag is reserved to the very rare category of codecs which have a
724 * bitstream that cannot be split into frames without timeconsuming
725 * operations like full decoding. Demuxers carring such bitstreams thus
726 * may return multiple frames in a packet. This has many disadvantages like
727 * prohibiting stream copy in many cases thus it should only be considered
730 #define CODEC_CAP_SUBFRAMES 0x0100
732 * Codec is experimental and is thus avoided in favor of non experimental
735 #define CODEC_CAP_EXPERIMENTAL 0x0200
737 * Codec should fill in channel configuration and samplerate instead of container
739 #define CODEC_CAP_CHANNEL_CONF 0x0400
741 * Codec is able to deal with negative linesizes
743 #define CODEC_CAP_NEG_LINESIZES 0x0800
745 * Codec supports frame-level multithreading.
747 #define CODEC_CAP_FRAME_THREADS 0x1000
749 * Codec supports slice-based (or partition-based) multithreading.
751 #define CODEC_CAP_SLICE_THREADS 0x2000
753 * Codec supports changed parameters at any point.
755 #define CODEC_CAP_PARAM_CHANGE 0x4000
757 * Codec supports avctx->thread_count == 0 (auto).
759 #define CODEC_CAP_AUTO_THREADS 0x8000
761 * Audio encoder supports receiving a different number of samples in each call.
763 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
765 //The following defines may change, don't expect compatibility if you use them.
766 #define MB_TYPE_INTRA4x4 0x0001
767 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
768 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
769 #define MB_TYPE_16x16 0x0008
770 #define MB_TYPE_16x8 0x0010
771 #define MB_TYPE_8x16 0x0020
772 #define MB_TYPE_8x8 0x0040
773 #define MB_TYPE_INTERLACED 0x0080
774 #define MB_TYPE_DIRECT2 0x0100 //FIXME
775 #define MB_TYPE_ACPRED 0x0200
776 #define MB_TYPE_GMC 0x0400
777 #define MB_TYPE_SKIP 0x0800
778 #define MB_TYPE_P0L0 0x1000
779 #define MB_TYPE_P1L0 0x2000
780 #define MB_TYPE_P0L1 0x4000
781 #define MB_TYPE_P1L1 0x8000
782 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
783 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
784 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
785 #define MB_TYPE_QUANT 0x00010000
786 #define MB_TYPE_CBP 0x00020000
787 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
791 * This specifies the area which should be displayed.
792 * Note there may be multiple such areas for one frame.
794 typedef struct AVPanScan{
797 * - encoding: Set by user.
798 * - decoding: Set by libavcodec.
803 * width and height in 1/16 pel
804 * - encoding: Set by user.
805 * - decoding: Set by libavcodec.
811 * position of the top left corner in 1/16 pel for up to 3 fields/frames
812 * - encoding: Set by user.
813 * - decoding: Set by libavcodec.
815 int16_t position[3][2];
818 #define FF_QSCALE_TYPE_MPEG1 0
819 #define FF_QSCALE_TYPE_MPEG2 1
820 #define FF_QSCALE_TYPE_H264 2
821 #define FF_QSCALE_TYPE_VP56 3
823 #if FF_API_GET_BUFFER
824 #define FF_BUFFER_TYPE_INTERNAL 1
825 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
826 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
827 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
829 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
830 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
831 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
832 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
836 * The decoder will keep a reference to the frame and may reuse it later.
838 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
841 * @defgroup lavc_packet AVPacket
843 * Types and functions for working with AVPacket.
846 enum AVPacketSideDataType {
848 AV_PKT_DATA_NEW_EXTRADATA,
851 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
854 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
855 * s32le channel_count
856 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
857 * u64le channel_layout
858 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
860 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
865 AV_PKT_DATA_PARAM_CHANGE,
868 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
869 * structures with info about macroblocks relevant to splitting the
870 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
871 * That is, it does not necessarily contain info about all macroblocks,
872 * as long as the distance between macroblocks in the info is smaller
873 * than the target payload size.
874 * Each MB info structure is 12 bytes, and is laid out as follows:
876 * u32le bit offset from the start of the packet
877 * u8 current quantizer at the start of the macroblock
879 * u16le macroblock address within the GOB
880 * u8 horizontal MV predictor
881 * u8 vertical MV predictor
882 * u8 horizontal MV predictor for block number 3
883 * u8 vertical MV predictor for block number 3
886 AV_PKT_DATA_H263_MB_INFO,
890 * This structure stores compressed data. It is typically exported by demuxers
891 * and then passed as input to decoders, or received as output from encoders and
892 * then passed to muxers.
894 * For video, it should typically contain one compressed frame. For audio it may
895 * contain several compressed frames.
897 * AVPacket is one of the few structs in Libav, whose size is a part of public
898 * ABI. Thus it may be allocated on stack and no new fields can be added to it
899 * without libavcodec and libavformat major bump.
901 * The semantics of data ownership depends on the buf or destruct (deprecated)
902 * fields. If either is set, the packet data is dynamically allocated and is
903 * valid indefinitely until av_free_packet() is called (which in turn calls
904 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
905 * the packet data is typically backed by some static buffer somewhere and is
906 * only valid for a limited time (e.g. until the next read call when demuxing).
908 * The side data is always allocated with av_malloc() and is freed in
911 typedef struct AVPacket {
913 * A reference to the reference-counted buffer where the packet data is
915 * May be NULL, then the packet data is not reference-counted.
919 * Presentation timestamp in AVStream->time_base units; the time at which
920 * the decompressed packet will be presented to the user.
921 * Can be AV_NOPTS_VALUE if it is not stored in the file.
922 * pts MUST be larger or equal to dts as presentation cannot happen before
923 * decompression, unless one wants to view hex dumps. Some formats misuse
924 * the terms dts and pts/cts to mean something different. Such timestamps
925 * must be converted to true pts/dts before they are stored in AVPacket.
929 * Decompression timestamp in AVStream->time_base units; the time at which
930 * the packet is decompressed.
931 * Can be AV_NOPTS_VALUE if it is not stored in the file.
938 * A combination of AV_PKT_FLAG values
942 * Additional packet data that can be provided by the container.
943 * Packet can contain several types of side information.
948 enum AVPacketSideDataType type;
953 * Duration of this packet in AVStream->time_base units, 0 if unknown.
954 * Equals next_pts - this_pts in presentation order.
957 #if FF_API_DESTRUCT_PACKET
959 void (*destruct)(struct AVPacket *);
963 int64_t pos; ///< byte position in stream, -1 if unknown
966 * Time difference in AVStream->time_base units from the pts of this
967 * packet to the point at which the output from the decoder has converged
968 * independent from the availability of previous frames. That is, the
969 * frames are virtually identical no matter if decoding started from
970 * the very first frame or from this keyframe.
971 * Is AV_NOPTS_VALUE if unknown.
972 * This field is not the display duration of the current packet.
973 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
976 * The purpose of this field is to allow seeking in streams that have no
977 * keyframes in the conventional sense. It corresponds to the
978 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
979 * essential for some types of subtitle streams to ensure that all
980 * subtitles are correctly displayed after seeking.
982 int64_t convergence_duration;
984 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
985 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
987 enum AVSideDataParamChangeFlags {
988 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
989 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
990 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
991 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
997 struct AVCodecInternal;
1001 AV_FIELD_PROGRESSIVE,
1002 AV_FIELD_TT, //< Top coded_first, top displayed first
1003 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1004 AV_FIELD_TB, //< Top coded first, bottom displayed first
1005 AV_FIELD_BT, //< Bottom coded first, top displayed first
1009 * main external API structure.
1010 * New fields can be added to the end with minor version bumps.
1011 * Removal, reordering and changes to existing fields require a major
1013 * sizeof(AVCodecContext) must not be used outside libav*.
1015 typedef struct AVCodecContext {
1017 * information on struct for av_log
1018 * - set by avcodec_alloc_context3
1020 const AVClass *av_class;
1021 int log_level_offset;
1023 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1024 const struct AVCodec *codec;
1025 char codec_name[32];
1026 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1029 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1030 * This is used to work around some encoder bugs.
1031 * A demuxer should set this to what is stored in the field used to identify the codec.
1032 * If there are multiple such fields in a container then the demuxer should choose the one
1033 * which maximizes the information about the used codec.
1034 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1035 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1036 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1038 * - encoding: Set by user, if not then the default based on codec_id will be used.
1039 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1041 unsigned int codec_tag;
1044 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1045 * This is used to work around some encoder bugs.
1046 * - encoding: unused
1047 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1049 unsigned int stream_codec_tag;
1054 * Private context used for internal data.
1056 * Unlike priv_data, this is not codec-specific. It is used in general
1057 * libavcodec functions.
1059 struct AVCodecInternal *internal;
1062 * Private data of the user, can be used to carry app specific stuff.
1063 * - encoding: Set by user.
1064 * - decoding: Set by user.
1069 * the average bitrate
1070 * - encoding: Set by user; unused for constant quantizer encoding.
1071 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1076 * number of bits the bitstream is allowed to diverge from the reference.
1077 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1078 * - encoding: Set by user; unused for constant quantizer encoding.
1079 * - decoding: unused
1081 int bit_rate_tolerance;
1084 * Global quality for codecs which cannot change it per frame.
1085 * This should be proportional to MPEG-1/2/4 qscale.
1086 * - encoding: Set by user.
1087 * - decoding: unused
1092 * - encoding: Set by user.
1093 * - decoding: unused
1095 int compression_level;
1096 #define FF_COMPRESSION_DEFAULT -1
1100 * - encoding: Set by user.
1101 * - decoding: Set by user.
1107 * - encoding: Set by user.
1108 * - decoding: Set by user.
1113 * some codecs need / can use extradata like Huffman tables.
1114 * mjpeg: Huffman tables
1115 * rv10: additional flags
1116 * mpeg4: global headers (they can be in the bitstream or here)
1117 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1118 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1119 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1120 * - encoding: Set/allocated/freed by libavcodec.
1121 * - decoding: Set/allocated/freed by user.
1127 * This is the fundamental unit of time (in seconds) in terms
1128 * of which frame timestamps are represented. For fixed-fps content,
1129 * timebase should be 1/framerate and timestamp increments should be
1131 * - encoding: MUST be set by user.
1132 * - decoding: Set by libavcodec.
1134 AVRational time_base;
1137 * For some codecs, the time base is closer to the field rate than the frame rate.
1138 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1139 * if no telecine is used ...
1141 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1143 int ticks_per_frame;
1149 * Number of frames the decoded output will be delayed relative to the
1153 * For encoding, this is the number of "priming" samples added to the
1154 * beginning of the stream. The decoded output will be delayed by this
1155 * many samples relative to the input to the encoder. Note that this
1156 * field is purely informational and does not directly affect the pts
1157 * output by the encoder, which should always be based on the actual
1158 * presentation time, including any delay.
1159 * For decoding, this is the number of samples the decoder needs to
1160 * output before the decoder's output is valid. When seeking, you should
1161 * start decoding this many samples prior to your desired seek point.
1163 * - encoding: Set by libavcodec.
1164 * - decoding: Set by libavcodec.
1171 * picture width / height.
1172 * - encoding: MUST be set by user.
1173 * - decoding: May be set by the user before opening the decoder if known e.g.
1174 * from the container. Some decoders will require the dimensions
1175 * to be set by the caller. During decoding, the decoder may
1176 * overwrite those values as required.
1181 * Bitstream width / height, may be different from width/height e.g. when
1182 * the decoded frame is cropped before being output.
1183 * - encoding: unused
1184 * - decoding: May be set by the user before opening the decoder if known
1185 * e.g. from the container. During decoding, the decoder may
1186 * overwrite those values as required.
1188 int coded_width, coded_height;
1190 #define FF_ASPECT_EXTENDED 15
1193 * the number of pictures in a group of pictures, or 0 for intra_only
1194 * - encoding: Set by user.
1195 * - decoding: unused
1200 * Pixel format, see AV_PIX_FMT_xxx.
1201 * May be set by the demuxer if known from headers.
1202 * May be overriden by the decoder if it knows better.
1203 * - encoding: Set by user.
1204 * - decoding: Set by user if known, overridden by libavcodec if known
1206 enum AVPixelFormat pix_fmt;
1209 * Motion estimation algorithm used for video coding.
1210 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1211 * 8 (umh), 10 (tesa) [7, 8, 10 are x264 specific]
1212 * - encoding: MUST be set by user.
1213 * - decoding: unused
1218 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1219 * decoder to draw a horizontal band. It improves cache usage. Not
1220 * all codecs can do that. You must check the codec capabilities
1222 * When multithreading is used, it may be called from multiple threads
1223 * at the same time; threads might draw different parts of the same AVFrame,
1224 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1226 * The function is also used by hardware acceleration APIs.
1227 * It is called at least once during frame decoding to pass
1228 * the data needed for hardware render.
1229 * In that mode instead of pixel data, AVFrame points to
1230 * a structure specific to the acceleration API. The application
1231 * reads the structure and can change some fields to indicate progress
1233 * - encoding: unused
1234 * - decoding: Set by user.
1235 * @param height the height of the slice
1236 * @param y the y position of the slice
1237 * @param type 1->top field, 2->bottom field, 3->frame
1238 * @param offset offset into the AVFrame.data from which the slice should be read
1240 void (*draw_horiz_band)(struct AVCodecContext *s,
1241 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1242 int y, int type, int height);
1245 * callback to negotiate the pixelFormat
1246 * @param fmt is the list of formats which are supported by the codec,
1247 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1248 * The first is always the native one.
1249 * @return the chosen format
1250 * - encoding: unused
1251 * - decoding: Set by user, if not set the native format will be chosen.
1253 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1256 * maximum number of B-frames between non-B-frames
1257 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1258 * - encoding: Set by user.
1259 * - decoding: unused
1264 * qscale factor between IP and B-frames
1265 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1266 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1267 * - encoding: Set by user.
1268 * - decoding: unused
1270 float b_quant_factor;
1272 /** obsolete FIXME remove */
1274 #define FF_RC_STRATEGY_XVID 1
1276 int b_frame_strategy;
1279 * qscale offset between IP and B-frames
1280 * - encoding: Set by user.
1281 * - decoding: unused
1283 float b_quant_offset;
1286 * Size of the frame reordering buffer in the decoder.
1287 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1288 * - encoding: Set by libavcodec.
1289 * - decoding: Set by libavcodec.
1294 * 0-> h263 quant 1-> mpeg quant
1295 * - encoding: Set by user.
1296 * - decoding: unused
1301 * qscale factor between P and I-frames
1302 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1303 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1304 * - encoding: Set by user.
1305 * - decoding: unused
1307 float i_quant_factor;
1310 * qscale offset between P and I-frames
1311 * - encoding: Set by user.
1312 * - decoding: unused
1314 float i_quant_offset;
1317 * luminance masking (0-> disabled)
1318 * - encoding: Set by user.
1319 * - decoding: unused
1324 * temporary complexity masking (0-> disabled)
1325 * - encoding: Set by user.
1326 * - decoding: unused
1328 float temporal_cplx_masking;
1331 * spatial complexity masking (0-> disabled)
1332 * - encoding: Set by user.
1333 * - decoding: unused
1335 float spatial_cplx_masking;
1338 * p block masking (0-> disabled)
1339 * - encoding: Set by user.
1340 * - decoding: unused
1345 * darkness masking (0-> disabled)
1346 * - encoding: Set by user.
1347 * - decoding: unused
1353 * - encoding: Set by libavcodec.
1354 * - decoding: Set by user (or 0).
1358 * prediction method (needed for huffyuv)
1359 * - encoding: Set by user.
1360 * - decoding: unused
1362 int prediction_method;
1363 #define FF_PRED_LEFT 0
1364 #define FF_PRED_PLANE 1
1365 #define FF_PRED_MEDIAN 2
1368 * slice offsets in the frame in bytes
1369 * - encoding: Set/allocated by libavcodec.
1370 * - decoding: Set/allocated by user (or NULL).
1375 * sample aspect ratio (0 if unknown)
1376 * That is the width of a pixel divided by the height of the pixel.
1377 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1378 * - encoding: Set by user.
1379 * - decoding: Set by libavcodec.
1381 AVRational sample_aspect_ratio;
1384 * motion estimation comparison function
1385 * - encoding: Set by user.
1386 * - decoding: unused
1390 * subpixel motion estimation comparison function
1391 * - encoding: Set by user.
1392 * - decoding: unused
1396 * macroblock comparison function (not supported yet)
1397 * - encoding: Set by user.
1398 * - decoding: unused
1402 * interlaced DCT comparison function
1403 * - encoding: Set by user.
1404 * - decoding: unused
1407 #define FF_CMP_SAD 0
1408 #define FF_CMP_SSE 1
1409 #define FF_CMP_SATD 2
1410 #define FF_CMP_DCT 3
1411 #define FF_CMP_PSNR 4
1412 #define FF_CMP_BIT 5
1414 #define FF_CMP_ZERO 7
1415 #define FF_CMP_VSAD 8
1416 #define FF_CMP_VSSE 9
1417 #define FF_CMP_NSSE 10
1418 #define FF_CMP_DCTMAX 13
1419 #define FF_CMP_DCT264 14
1420 #define FF_CMP_CHROMA 256
1423 * ME diamond size & shape
1424 * - encoding: Set by user.
1425 * - decoding: unused
1430 * amount of previous MV predictors (2a+1 x 2a+1 square)
1431 * - encoding: Set by user.
1432 * - decoding: unused
1434 int last_predictor_count;
1437 * prepass for motion estimation
1438 * - encoding: Set by user.
1439 * - decoding: unused
1444 * motion estimation prepass comparison function
1445 * - encoding: Set by user.
1446 * - decoding: unused
1451 * ME prepass diamond size & shape
1452 * - encoding: Set by user.
1453 * - decoding: unused
1459 * - encoding: Set by user.
1460 * - decoding: unused
1462 int me_subpel_quality;
1465 * DTG active format information (additional aspect ratio
1466 * information only used in DVB MPEG-2 transport streams)
1469 * - encoding: unused
1470 * - decoding: Set by decoder.
1472 int dtg_active_format;
1473 #define FF_DTG_AFD_SAME 8
1474 #define FF_DTG_AFD_4_3 9
1475 #define FF_DTG_AFD_16_9 10
1476 #define FF_DTG_AFD_14_9 11
1477 #define FF_DTG_AFD_4_3_SP_14_9 13
1478 #define FF_DTG_AFD_16_9_SP_14_9 14
1479 #define FF_DTG_AFD_SP_4_3 15
1482 * maximum motion estimation search range in subpel units
1483 * If 0 then no limit.
1485 * - encoding: Set by user.
1486 * - decoding: unused
1491 * intra quantizer bias
1492 * - encoding: Set by user.
1493 * - decoding: unused
1495 int intra_quant_bias;
1496 #define FF_DEFAULT_QUANT_BIAS 999999
1499 * inter quantizer bias
1500 * - encoding: Set by user.
1501 * - decoding: unused
1503 int inter_quant_bias;
1507 * - encoding: unused
1508 * - decoding: Set by user.
1511 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1512 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1513 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1516 * XVideo Motion Acceleration
1517 * - encoding: forbidden
1518 * - decoding: set by decoder
1520 int xvmc_acceleration;
1523 * macroblock decision mode
1524 * - encoding: Set by user.
1525 * - decoding: unused
1528 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1529 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1530 #define FF_MB_DECISION_RD 2 ///< rate distortion
1533 * custom intra quantization matrix
1534 * - encoding: Set by user, can be NULL.
1535 * - decoding: Set by libavcodec.
1537 uint16_t *intra_matrix;
1540 * custom inter quantization matrix
1541 * - encoding: Set by user, can be NULL.
1542 * - decoding: Set by libavcodec.
1544 uint16_t *inter_matrix;
1547 * scene change detection threshold
1548 * 0 is default, larger means fewer detected scene changes.
1549 * - encoding: Set by user.
1550 * - decoding: unused
1552 int scenechange_threshold;
1555 * noise reduction strength
1556 * - encoding: Set by user.
1557 * - decoding: unused
1559 int noise_reduction;
1562 * Motion estimation threshold below which no motion estimation is
1563 * performed, but instead the user specified motion vectors are used.
1565 * - encoding: Set by user.
1566 * - decoding: unused
1571 * Macroblock threshold below which the user specified macroblock types will be used.
1572 * - encoding: Set by user.
1573 * - decoding: unused
1578 * precision of the intra DC coefficient - 8
1579 * - encoding: Set by user.
1580 * - decoding: unused
1582 int intra_dc_precision;
1585 * Number of macroblock rows at the top which are skipped.
1586 * - encoding: unused
1587 * - decoding: Set by user.
1592 * Number of macroblock rows at the bottom which are skipped.
1593 * - encoding: unused
1594 * - decoding: Set by user.
1599 * Border processing masking, raises the quantizer for mbs on the borders
1601 * - encoding: Set by user.
1602 * - decoding: unused
1604 float border_masking;
1607 * minimum MB lagrange multipler
1608 * - encoding: Set by user.
1609 * - decoding: unused
1614 * maximum MB lagrange multipler
1615 * - encoding: Set by user.
1616 * - decoding: unused
1622 * - encoding: Set by user.
1623 * - decoding: unused
1625 int me_penalty_compensation;
1629 * - encoding: Set by user.
1630 * - decoding: unused
1636 * - encoding: Set by user.
1637 * - decoding: unused
1643 * - encoding: Set by user.
1644 * - decoding: unused
1649 * number of reference frames
1650 * - encoding: Set by user.
1651 * - decoding: Set by lavc.
1656 * chroma qp offset from luma
1657 * - encoding: Set by user.
1658 * - decoding: unused
1663 * Multiplied by qscale for each frame and added to scene_change_score.
1664 * - encoding: Set by user.
1665 * - decoding: unused
1667 int scenechange_factor;
1671 * Note: Value depends upon the compare function used for fullpel ME.
1672 * - encoding: Set by user.
1673 * - decoding: unused
1678 * Adjust sensitivity of b_frame_strategy 1.
1679 * - encoding: Set by user.
1680 * - decoding: unused
1685 * Chromaticity coordinates of the source primaries.
1686 * - encoding: Set by user
1687 * - decoding: Set by libavcodec
1689 enum AVColorPrimaries color_primaries;
1692 * Color Transfer Characteristic.
1693 * - encoding: Set by user
1694 * - decoding: Set by libavcodec
1696 enum AVColorTransferCharacteristic color_trc;
1699 * YUV colorspace type.
1700 * - encoding: Set by user
1701 * - decoding: Set by libavcodec
1703 enum AVColorSpace colorspace;
1706 * MPEG vs JPEG YUV range.
1707 * - encoding: Set by user
1708 * - decoding: Set by libavcodec
1710 enum AVColorRange color_range;
1713 * This defines the location of chroma samples.
1714 * - encoding: Set by user
1715 * - decoding: Set by libavcodec
1717 enum AVChromaLocation chroma_sample_location;
1721 * Indicates number of picture subdivisions. Used for parallelized
1723 * - encoding: Set by user
1724 * - decoding: unused
1729 * - encoding: set by libavcodec
1730 * - decoding: Set by libavcodec
1732 enum AVFieldOrder field_order;
1735 int sample_rate; ///< samples per second
1736 int channels; ///< number of audio channels
1739 * audio sample format
1740 * - encoding: Set by user.
1741 * - decoding: Set by libavcodec.
1743 enum AVSampleFormat sample_fmt; ///< sample format
1745 /* The following data should not be initialized. */
1747 * Number of samples per channel in an audio frame.
1749 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1750 * except the last must contain exactly frame_size samples per channel.
1751 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1752 * frame size is not restricted.
1753 * - decoding: may be set by some decoders to indicate constant frame size
1758 * Frame counter, set by libavcodec.
1760 * - decoding: total number of frames returned from the decoder so far.
1761 * - encoding: total number of frames passed to the encoder so far.
1763 * @note the counter is not incremented if encoding/decoding resulted in
1769 * number of bytes per packet if constant and known or 0
1770 * Used by some WAV based audio codecs.
1775 * Audio cutoff bandwidth (0 means "automatic")
1776 * - encoding: Set by user.
1777 * - decoding: unused
1781 #if FF_API_REQUEST_CHANNELS
1783 * Decoder should decode to this many channels if it can (0 for default)
1784 * - encoding: unused
1785 * - decoding: Set by user.
1786 * @deprecated Deprecated in favor of request_channel_layout.
1788 attribute_deprecated int request_channels;
1792 * Audio channel layout.
1793 * - encoding: set by user.
1794 * - decoding: set by libavcodec.
1796 uint64_t channel_layout;
1799 * Request decoder to use this channel layout if it can (0 for default)
1800 * - encoding: unused
1801 * - decoding: Set by user.
1803 uint64_t request_channel_layout;
1806 * Type of service that the audio stream conveys.
1807 * - encoding: Set by user.
1808 * - decoding: Set by libavcodec.
1810 enum AVAudioServiceType audio_service_type;
1813 * Used to request a sample format from the decoder.
1814 * - encoding: unused.
1815 * - decoding: Set by user.
1817 enum AVSampleFormat request_sample_fmt;
1819 #if FF_API_GET_BUFFER
1821 * Called at the beginning of each frame to get a buffer for it.
1823 * The function will set AVFrame.data[], AVFrame.linesize[].
1824 * AVFrame.extended_data[] must also be set, but it should be the same as
1825 * AVFrame.data[] except for planar audio with more channels than can fit
1826 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1827 * many data pointers as it can hold.
1829 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1830 * avcodec_default_get_buffer() instead of providing buffers allocated by
1833 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1834 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1835 * but if get_buffer() is overridden then alignment considerations should
1836 * be taken into account.
1838 * @see avcodec_default_get_buffer()
1842 * If pic.reference is set then the frame will be read later by libavcodec.
1843 * avcodec_align_dimensions2() should be used to find the required width and
1844 * height, as they normally need to be rounded up to the next multiple of 16.
1846 * If frame multithreading is used and thread_safe_callbacks is set,
1847 * it may be called from a different thread, but not from more than one at
1848 * once. Does not need to be reentrant.
1850 * @see release_buffer(), reget_buffer()
1851 * @see avcodec_align_dimensions2()
1855 * Decoders request a buffer of a particular size by setting
1856 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1857 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1858 * to a smaller value in the output frame.
1860 * Decoders cannot use the buffer after returning from
1861 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1862 * is assumed to be released immediately upon return. In some rare cases,
1863 * a decoder may need to call get_buffer() more than once in a single
1864 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
1865 * called again after it has already been called once, the previously
1866 * acquired buffer is assumed to be released at that time and may not be
1867 * reused by the decoder.
1869 * As a convenience, av_samples_get_buffer_size() and
1870 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1871 * functions to find the required data size and to fill data pointers and
1872 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1873 * since all planes must be the same size.
1875 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1877 * - encoding: unused
1878 * - decoding: Set by libavcodec, user can override.
1880 * @deprecated use get_buffer2()
1882 attribute_deprecated
1883 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1886 * Called to release buffers which were allocated with get_buffer.
1887 * A released buffer can be reused in get_buffer().
1888 * pic.data[*] must be set to NULL.
1889 * May be called from a different thread if frame multithreading is used,
1890 * but not by more than one thread at once, so does not need to be reentrant.
1891 * - encoding: unused
1892 * - decoding: Set by libavcodec, user can override.
1894 * @deprecated custom freeing callbacks should be set from get_buffer2()
1896 attribute_deprecated
1897 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1900 * Called at the beginning of a frame to get cr buffer for it.
1901 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1902 * libavcodec will pass previous buffer in pic, function should return
1903 * same buffer or new buffer with old frame "painted" into it.
1904 * If pic.data[0] == NULL must behave like get_buffer().
1905 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
1906 * avcodec_default_reget_buffer() instead of providing buffers allocated by
1908 * - encoding: unused
1909 * - decoding: Set by libavcodec, user can override.
1911 attribute_deprecated
1912 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1916 * This callback is called at the beginning of each frame to get data
1917 * buffer(s) for it. There may be one contiguous buffer for all the data or
1918 * there may be a buffer per each data plane or anything in between. What
1919 * this means is, you may set however many entries in buf[] you feel necessary.
1920 * Each buffer must be reference-counted using the AVBuffer API (see description
1923 * The following fields will be set in the frame before this callback is
1926 * - width, height (video only)
1927 * - sample_rate, channel_layout, nb_samples (audio only)
1928 * Their values may differ from the corresponding values in
1929 * AVCodecContext. This callback must use the frame values, not the codec
1930 * context values, to calculate the required buffer size.
1932 * This callback must fill the following fields in the frame:
1936 * * if the data is planar audio with more than 8 channels, then this
1937 * callback must allocate and fill extended_data to contain all pointers
1938 * to all data planes. data[] must hold as many pointers as it can.
1939 * extended_data must be allocated with av_malloc() and will be freed in
1941 * * otherwise exended_data must point to data
1942 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
1943 * the frame's data and extended_data pointers must be contained in these. That
1944 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
1945 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
1946 * and av_buffer_ref().
1947 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
1948 * this callback and filled with the extra buffers if there are more
1949 * buffers than buf[] can hold. extended_buf will be freed in
1952 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
1953 * avcodec_default_get_buffer2() instead of providing buffers allocated by
1956 * Each data plane must be aligned to the maximum required by the target
1959 * @see avcodec_default_get_buffer2()
1963 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
1964 * (read and/or written to if it is writable) later by libavcodec.
1966 * If CODEC_FLAG_EMU_EDGE is not set in s->flags, the buffer must contain an
1967 * edge of the size returned by avcodec_get_edge_width() on all sides.
1969 * avcodec_align_dimensions2() should be used to find the required width and
1970 * height, as they normally need to be rounded up to the next multiple of 16.
1972 * If frame multithreading is used and thread_safe_callbacks is set,
1973 * this callback may be called from a different thread, but not from more
1974 * than one at once. Does not need to be reentrant.
1976 * @see avcodec_align_dimensions2()
1980 * Decoders request a buffer of a particular size by setting
1981 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
1982 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1983 * to a smaller value in the output frame.
1985 * As a convenience, av_samples_get_buffer_size() and
1986 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
1987 * functions to find the required data size and to fill data pointers and
1988 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1989 * since all planes must be the same size.
1991 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1993 * - encoding: unused
1994 * - decoding: Set by libavcodec, user can override.
1996 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
1999 * If non-zero, the decoded audio and video frames returned from
2000 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2001 * and are valid indefinitely. The caller must free them with
2002 * av_frame_unref() when they are not needed anymore.
2003 * Otherwise, the decoded frames must not be freed by the caller and are
2004 * only valid until the next decode call.
2006 * - encoding: unused
2007 * - decoding: set by the caller before avcodec_open2().
2009 int refcounted_frames;
2011 /* - encoding parameters */
2012 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2013 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2017 * - encoding: Set by user.
2018 * - decoding: unused
2024 * - encoding: Set by user.
2025 * - decoding: unused
2030 * maximum quantizer difference between frames
2031 * - encoding: Set by user.
2032 * - decoding: unused
2037 * ratecontrol qmin qmax limiting method
2038 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2039 * - encoding: Set by user.
2040 * - decoding: unused
2048 * decoder bitstream buffer size
2049 * - encoding: Set by user.
2050 * - decoding: unused
2055 * ratecontrol override, see RcOverride
2056 * - encoding: Allocated/set/freed by user.
2057 * - decoding: unused
2059 int rc_override_count;
2060 RcOverride *rc_override;
2063 * rate control equation
2064 * - encoding: Set by user
2065 * - decoding: unused
2071 * - encoding: Set by user.
2072 * - decoding: unused
2078 * - encoding: Set by user.
2079 * - decoding: unused
2083 float rc_buffer_aggressivity;
2086 * initial complexity for pass1 ratecontrol
2087 * - encoding: Set by user.
2088 * - decoding: unused
2090 float rc_initial_cplx;
2093 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2094 * - encoding: Set by user.
2095 * - decoding: unused.
2097 float rc_max_available_vbv_use;
2100 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2101 * - encoding: Set by user.
2102 * - decoding: unused.
2104 float rc_min_vbv_overflow_use;
2107 * Number of bits which should be loaded into the rc buffer before decoding starts.
2108 * - encoding: Set by user.
2109 * - decoding: unused
2111 int rc_initial_buffer_occupancy;
2113 #define FF_CODER_TYPE_VLC 0
2114 #define FF_CODER_TYPE_AC 1
2115 #define FF_CODER_TYPE_RAW 2
2116 #define FF_CODER_TYPE_RLE 3
2117 #define FF_CODER_TYPE_DEFLATE 4
2120 * - encoding: Set by user.
2121 * - decoding: unused
2127 * - encoding: Set by user.
2128 * - decoding: unused
2133 * minimum Lagrange multipler
2134 * - encoding: Set by user.
2135 * - decoding: unused
2140 * maximum Lagrange multipler
2141 * - encoding: Set by user.
2142 * - decoding: unused
2147 * frame skip threshold
2148 * - encoding: Set by user.
2149 * - decoding: unused
2151 int frame_skip_threshold;
2155 * - encoding: Set by user.
2156 * - decoding: unused
2158 int frame_skip_factor;
2161 * frame skip exponent
2162 * - encoding: Set by user.
2163 * - decoding: unused
2168 * frame skip comparison function
2169 * - encoding: Set by user.
2170 * - decoding: unused
2175 * trellis RD quantization
2176 * - encoding: Set by user.
2177 * - decoding: unused
2182 * - encoding: Set by user.
2183 * - decoding: unused
2185 int min_prediction_order;
2188 * - encoding: Set by user.
2189 * - decoding: unused
2191 int max_prediction_order;
2194 * GOP timecode frame start number, in non drop frame format
2195 * - encoding: Set by user.
2196 * - decoding: unused
2198 int64_t timecode_frame_start;
2200 /* The RTP callback: This function is called */
2201 /* every time the encoder has a packet to send. */
2202 /* It depends on the encoder if the data starts */
2203 /* with a Start Code (it should). H.263 does. */
2204 /* mb_nb contains the number of macroblocks */
2205 /* encoded in the RTP payload. */
2206 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2208 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2209 /* do its best to deliver a chunk with size */
2210 /* below rtp_payload_size, the chunk will start */
2211 /* with a start code on some codecs like H.263. */
2212 /* This doesn't take account of any particular */
2213 /* headers inside the transmitted RTP payload. */
2215 /* statistics, used for 2-pass encoding */
2226 * number of bits used for the previously encoded frame
2227 * - encoding: Set by libavcodec.
2228 * - decoding: unused
2233 * pass1 encoding statistics output buffer
2234 * - encoding: Set by libavcodec.
2235 * - decoding: unused
2240 * pass2 encoding statistics input buffer
2241 * Concatenated stuff from stats_out of pass1 should be placed here.
2242 * - encoding: Allocated/set/freed by user.
2243 * - decoding: unused
2248 * Work around bugs in encoders which sometimes cannot be detected automatically.
2249 * - encoding: Set by user
2250 * - decoding: Set by user
2252 int workaround_bugs;
2253 #define FF_BUG_AUTODETECT 1 ///< autodetection
2254 #define FF_BUG_OLD_MSMPEG4 2
2255 #define FF_BUG_XVID_ILACE 4
2256 #define FF_BUG_UMP4 8
2257 #define FF_BUG_NO_PADDING 16
2258 #define FF_BUG_AMV 32
2260 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2262 #define FF_BUG_QPEL_CHROMA 64
2263 #define FF_BUG_STD_QPEL 128
2264 #define FF_BUG_QPEL_CHROMA2 256
2265 #define FF_BUG_DIRECT_BLOCKSIZE 512
2266 #define FF_BUG_EDGE 1024
2267 #define FF_BUG_HPEL_CHROMA 2048
2268 #define FF_BUG_DC_CLIP 4096
2269 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2270 #define FF_BUG_TRUNCATED 16384
2273 * strictly follow the standard (MPEG4, ...).
2274 * - encoding: Set by user.
2275 * - decoding: Set by user.
2276 * Setting this to STRICT or higher means the encoder and decoder will
2277 * generally do stupid things, whereas setting it to unofficial or lower
2278 * will mean the encoder might produce output that is not supported by all
2279 * spec-compliant decoders. Decoders don't differentiate between normal,
2280 * unofficial and experimental (that is, they always try to decode things
2281 * when they can) unless they are explicitly asked to behave stupidly
2282 * (=strictly conform to the specs)
2284 int strict_std_compliance;
2285 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2286 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2287 #define FF_COMPLIANCE_NORMAL 0
2288 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2289 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2292 * error concealment flags
2293 * - encoding: unused
2294 * - decoding: Set by user.
2296 int error_concealment;
2297 #define FF_EC_GUESS_MVS 1
2298 #define FF_EC_DEBLOCK 2
2302 * - encoding: Set by user.
2303 * - decoding: Set by user.
2306 #define FF_DEBUG_PICT_INFO 1
2307 #define FF_DEBUG_RC 2
2308 #define FF_DEBUG_BITSTREAM 4
2309 #define FF_DEBUG_MB_TYPE 8
2310 #define FF_DEBUG_QP 16
2313 * @deprecated this option does nothing
2315 #define FF_DEBUG_MV 32
2317 #define FF_DEBUG_DCT_COEFF 0x00000040
2318 #define FF_DEBUG_SKIP 0x00000080
2319 #define FF_DEBUG_STARTCODE 0x00000100
2320 #define FF_DEBUG_PTS 0x00000200
2321 #define FF_DEBUG_ER 0x00000400
2322 #define FF_DEBUG_MMCO 0x00000800
2323 #define FF_DEBUG_BUGS 0x00001000
2325 #define FF_DEBUG_VIS_QP 0x00002000
2326 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2328 #define FF_DEBUG_BUFFERS 0x00008000
2329 #define FF_DEBUG_THREADS 0x00010000
2333 * @deprecated this option does not have any effect
2335 attribute_deprecated
2337 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2338 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2339 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2343 * Error recognition; may misdetect some more or less valid parts as errors.
2344 * - encoding: unused
2345 * - decoding: Set by user.
2347 int err_recognition;
2350 * Verify checksums embedded in the bitstream (could be of either encoded or
2351 * decoded data, depending on the codec) and print an error message on mismatch.
2352 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2353 * decoder returning an error.
2355 #define AV_EF_CRCCHECK (1<<0)
2356 #define AV_EF_BITSTREAM (1<<1)
2357 #define AV_EF_BUFFER (1<<2)
2358 #define AV_EF_EXPLODE (1<<3)
2361 * opaque 64bit number (generally a PTS) that will be reordered and
2362 * output in AVFrame.reordered_opaque
2363 * @deprecated in favor of pkt_pts
2364 * - encoding: unused
2365 * - decoding: Set by user.
2367 int64_t reordered_opaque;
2370 * Hardware accelerator in use
2371 * - encoding: unused.
2372 * - decoding: Set by libavcodec
2374 struct AVHWAccel *hwaccel;
2377 * Hardware accelerator context.
2378 * For some hardware accelerators, a global context needs to be
2379 * provided by the user. In that case, this holds display-dependent
2380 * data Libav cannot instantiate itself. Please refer to the
2381 * Libav HW accelerator documentation to know how to fill this
2382 * is. e.g. for VA API, this is a struct vaapi_context.
2383 * - encoding: unused
2384 * - decoding: Set by user
2386 void *hwaccel_context;
2390 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2391 * - decoding: unused
2393 uint64_t error[AV_NUM_DATA_POINTERS];
2396 * DCT algorithm, see FF_DCT_* below
2397 * - encoding: Set by user.
2398 * - decoding: unused
2401 #define FF_DCT_AUTO 0
2402 #define FF_DCT_FASTINT 1
2403 #define FF_DCT_INT 2
2404 #define FF_DCT_MMX 3
2405 #define FF_DCT_ALTIVEC 5
2406 #define FF_DCT_FAAN 6
2409 * IDCT algorithm, see FF_IDCT_* below.
2410 * - encoding: Set by user.
2411 * - decoding: Set by user.
2414 #define FF_IDCT_AUTO 0
2415 #define FF_IDCT_INT 1
2416 #define FF_IDCT_SIMPLE 2
2417 #define FF_IDCT_SIMPLEMMX 3
2418 #define FF_IDCT_ARM 7
2419 #define FF_IDCT_ALTIVEC 8
2420 #define FF_IDCT_SH4 9
2421 #define FF_IDCT_SIMPLEARM 10
2422 #define FF_IDCT_IPP 13
2423 #define FF_IDCT_XVIDMMX 14
2424 #define FF_IDCT_SIMPLEARMV5TE 16
2425 #define FF_IDCT_SIMPLEARMV6 17
2426 #define FF_IDCT_SIMPLEVIS 18
2427 #define FF_IDCT_FAAN 20
2428 #define FF_IDCT_SIMPLENEON 22
2429 #define FF_IDCT_SIMPLEALPHA 23
2432 * bits per sample/pixel from the demuxer (needed for huffyuv).
2433 * - encoding: Set by libavcodec.
2434 * - decoding: Set by user.
2436 int bits_per_coded_sample;
2439 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2440 * - encoding: set by user.
2441 * - decoding: set by libavcodec.
2443 int bits_per_raw_sample;
2447 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2448 * - encoding: unused
2449 * - decoding: Set by user.
2451 * @deprecated use decoder private options instead
2453 attribute_deprecated int lowres;
2457 * the picture in the bitstream
2458 * - encoding: Set by libavcodec.
2459 * - decoding: Set by libavcodec.
2461 AVFrame *coded_frame;
2465 * is used to decide how many independent tasks should be passed to execute()
2466 * - encoding: Set by user.
2467 * - decoding: Set by user.
2472 * Which multithreading methods to use.
2473 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2474 * so clients which cannot provide future frames should not use it.
2476 * - encoding: Set by user, otherwise the default is used.
2477 * - decoding: Set by user, otherwise the default is used.
2480 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2481 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2484 * Which multithreading methods are in use by the codec.
2485 * - encoding: Set by libavcodec.
2486 * - decoding: Set by libavcodec.
2488 int active_thread_type;
2491 * Set by the client if its custom get_buffer() callback can be called
2492 * synchronously from another thread, which allows faster multithreaded decoding.
2493 * draw_horiz_band() will be called from other threads regardless of this setting.
2494 * Ignored if the default get_buffer() is used.
2495 * - encoding: Set by user.
2496 * - decoding: Set by user.
2498 int thread_safe_callbacks;
2501 * The codec may call this to execute several independent things.
2502 * It will return only after finishing all tasks.
2503 * The user may replace this with some multithreaded implementation,
2504 * the default implementation will execute the parts serially.
2505 * @param count the number of things to execute
2506 * - encoding: Set by libavcodec, user can override.
2507 * - decoding: Set by libavcodec, user can override.
2509 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2512 * The codec may call this to execute several independent things.
2513 * It will return only after finishing all tasks.
2514 * The user may replace this with some multithreaded implementation,
2515 * the default implementation will execute the parts serially.
2516 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2517 * @param c context passed also to func
2518 * @param count the number of things to execute
2519 * @param arg2 argument passed unchanged to func
2520 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2521 * @param func function that will be called count times, with jobnr from 0 to count-1.
2522 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2523 * two instances of func executing at the same time will have the same threadnr.
2524 * @return always 0 currently, but code should handle a future improvement where when any call to func
2525 * returns < 0 no further calls to func may be done and < 0 is returned.
2526 * - encoding: Set by libavcodec, user can override.
2527 * - decoding: Set by libavcodec, user can override.
2529 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2533 * Can be used by execute() to store some per AVCodecContext stuff.
2534 * - encoding: set by execute()
2535 * - decoding: set by execute()
2537 void *thread_opaque;
2540 * noise vs. sse weight for the nsse comparsion function
2541 * - encoding: Set by user.
2542 * - decoding: unused
2548 * - encoding: Set by user.
2549 * - decoding: Set by libavcodec.
2552 #define FF_PROFILE_UNKNOWN -99
2553 #define FF_PROFILE_RESERVED -100
2555 #define FF_PROFILE_AAC_MAIN 0
2556 #define FF_PROFILE_AAC_LOW 1
2557 #define FF_PROFILE_AAC_SSR 2
2558 #define FF_PROFILE_AAC_LTP 3
2559 #define FF_PROFILE_AAC_HE 4
2560 #define FF_PROFILE_AAC_HE_V2 28
2561 #define FF_PROFILE_AAC_LD 22
2562 #define FF_PROFILE_AAC_ELD 38
2563 #define FF_PROFILE_MPEG2_AAC_LOW 128
2564 #define FF_PROFILE_MPEG2_AAC_HE 131
2566 #define FF_PROFILE_DTS 20
2567 #define FF_PROFILE_DTS_ES 30
2568 #define FF_PROFILE_DTS_96_24 40
2569 #define FF_PROFILE_DTS_HD_HRA 50
2570 #define FF_PROFILE_DTS_HD_MA 60
2572 #define FF_PROFILE_MPEG2_422 0
2573 #define FF_PROFILE_MPEG2_HIGH 1
2574 #define FF_PROFILE_MPEG2_SS 2
2575 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2576 #define FF_PROFILE_MPEG2_MAIN 4
2577 #define FF_PROFILE_MPEG2_SIMPLE 5
2579 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2580 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2582 #define FF_PROFILE_H264_BASELINE 66
2583 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2584 #define FF_PROFILE_H264_MAIN 77
2585 #define FF_PROFILE_H264_EXTENDED 88
2586 #define FF_PROFILE_H264_HIGH 100
2587 #define FF_PROFILE_H264_HIGH_10 110
2588 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2589 #define FF_PROFILE_H264_HIGH_422 122
2590 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2591 #define FF_PROFILE_H264_HIGH_444 144
2592 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2593 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2594 #define FF_PROFILE_H264_CAVLC_444 44
2596 #define FF_PROFILE_VC1_SIMPLE 0
2597 #define FF_PROFILE_VC1_MAIN 1
2598 #define FF_PROFILE_VC1_COMPLEX 2
2599 #define FF_PROFILE_VC1_ADVANCED 3
2601 #define FF_PROFILE_MPEG4_SIMPLE 0
2602 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2603 #define FF_PROFILE_MPEG4_CORE 2
2604 #define FF_PROFILE_MPEG4_MAIN 3
2605 #define FF_PROFILE_MPEG4_N_BIT 4
2606 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2607 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2608 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2609 #define FF_PROFILE_MPEG4_HYBRID 8
2610 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2611 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2612 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2613 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2614 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2615 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2616 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2618 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2619 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2620 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2621 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2622 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2626 * - encoding: Set by user.
2627 * - decoding: Set by libavcodec.
2630 #define FF_LEVEL_UNKNOWN -99
2634 * - encoding: unused
2635 * - decoding: Set by user.
2637 enum AVDiscard skip_loop_filter;
2641 * - encoding: unused
2642 * - decoding: Set by user.
2644 enum AVDiscard skip_idct;
2648 * - encoding: unused
2649 * - decoding: Set by user.
2651 enum AVDiscard skip_frame;
2654 * Header containing style information for text subtitles.
2655 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2656 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2657 * the Format line following. It shouldn't include any Dialogue line.
2658 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2659 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2661 uint8_t *subtitle_header;
2662 int subtitle_header_size;
2665 * Simulates errors in the bitstream to test error concealment.
2666 * - encoding: Set by user.
2667 * - decoding: unused
2672 * Current packet as passed into the decoder, to avoid having
2673 * to pass the packet into every function. Currently only valid
2674 * inside lavc and get/release_buffer callbacks.
2675 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2676 * - encoding: unused
2681 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2682 * Used for compliant TS muxing.
2683 * - encoding: Set by libavcodec.
2684 * - decoding: unused.
2692 typedef struct AVProfile {
2694 const char *name; ///< short name for the profile
2697 typedef struct AVCodecDefault AVCodecDefault;
2704 typedef struct AVCodec {
2706 * Name of the codec implementation.
2707 * The name is globally unique among encoders and among decoders (but an
2708 * encoder and a decoder can share the same name).
2709 * This is the primary way to find a codec from the user perspective.
2713 * Descriptive name for the codec, meant to be more human readable than name.
2714 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2716 const char *long_name;
2717 enum AVMediaType type;
2720 * Codec capabilities.
2724 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2725 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2726 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2727 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2728 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2730 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2732 const AVClass *priv_class; ///< AVClass for the private context
2733 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2735 /*****************************************************************
2736 * No fields below this line are part of the public API. They
2737 * may not be used outside of libavcodec and can be changed and
2739 * New public fields should be added right above.
2740 *****************************************************************
2743 struct AVCodec *next;
2745 * @name Frame-level threading support functions
2749 * If defined, called on thread contexts when they are created.
2750 * If the codec allocates writable tables in init(), re-allocate them here.
2751 * priv_data will be set to a copy of the original.
2753 int (*init_thread_copy)(AVCodecContext *);
2755 * Copy necessary context variables from a previous thread context to the current one.
2756 * If not defined, the next thread will start automatically; otherwise, the codec
2757 * must call ff_thread_finish_setup().
2759 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2761 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2765 * Private codec-specific defaults.
2767 const AVCodecDefault *defaults;
2770 * Initialize codec static data, called from avcodec_register().
2772 void (*init_static_data)(struct AVCodec *codec);
2774 int (*init)(AVCodecContext *);
2775 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2776 const struct AVSubtitle *sub);
2778 * Encode data to an AVPacket.
2780 * @param avctx codec context
2781 * @param avpkt output AVPacket (may contain a user-provided buffer)
2782 * @param[in] frame AVFrame containing the raw data to be encoded
2783 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2784 * non-empty packet was returned in avpkt.
2785 * @return 0 on success, negative error code on failure
2787 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2788 int *got_packet_ptr);
2789 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2790 int (*close)(AVCodecContext *);
2793 * Will be called when seeking
2795 void (*flush)(AVCodecContext *);
2801 typedef struct AVHWAccel {
2803 * Name of the hardware accelerated codec.
2804 * The name is globally unique among encoders and among decoders (but an
2805 * encoder and a decoder can share the same name).
2810 * Type of codec implemented by the hardware accelerator.
2812 * See AVMEDIA_TYPE_xxx
2814 enum AVMediaType type;
2817 * Codec implemented by the hardware accelerator.
2819 * See AV_CODEC_ID_xxx
2824 * Supported pixel format.
2826 * Only hardware accelerated formats are supported here.
2828 enum AVPixelFormat pix_fmt;
2831 * Hardware accelerated codec capabilities.
2832 * see FF_HWACCEL_CODEC_CAP_*
2836 struct AVHWAccel *next;
2839 * Called at the beginning of each frame or field picture.
2841 * Meaningful frame information (codec specific) is guaranteed to
2842 * be parsed at this point. This function is mandatory.
2844 * Note that buf can be NULL along with buf_size set to 0.
2845 * Otherwise, this means the whole frame is available at this point.
2847 * @param avctx the codec context
2848 * @param buf the frame data buffer base
2849 * @param buf_size the size of the frame in bytes
2850 * @return zero if successful, a negative value otherwise
2852 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2855 * Callback for each slice.
2857 * Meaningful slice information (codec specific) is guaranteed to
2858 * be parsed at this point. This function is mandatory.
2860 * @param avctx the codec context
2861 * @param buf the slice data buffer base
2862 * @param buf_size the size of the slice in bytes
2863 * @return zero if successful, a negative value otherwise
2865 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2868 * Called at the end of each frame or field picture.
2870 * The whole picture is parsed at this point and can now be sent
2871 * to the hardware accelerator. This function is mandatory.
2873 * @param avctx the codec context
2874 * @return zero if successful, a negative value otherwise
2876 int (*end_frame)(AVCodecContext *avctx);
2879 * Size of HW accelerator private data.
2881 * Private data is allocated with av_mallocz() before
2882 * AVCodecContext.get_buffer() and deallocated after
2883 * AVCodecContext.release_buffer().
2889 * @defgroup lavc_picture AVPicture
2891 * Functions for working with AVPicture
2896 * four components are given, that's all.
2897 * the last component is alpha
2899 typedef struct AVPicture {
2900 uint8_t *data[AV_NUM_DATA_POINTERS];
2901 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
2908 #define AVPALETTE_SIZE 1024
2909 #define AVPALETTE_COUNT 256
2911 enum AVSubtitleType {
2914 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2917 * Plain text, the text field must be set by the decoder and is
2918 * authoritative. ass and pict fields may contain approximations.
2923 * Formatted text, the ass field must be set by the decoder and is
2924 * authoritative. pict and text fields may contain approximations.
2929 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
2931 typedef struct AVSubtitleRect {
2932 int x; ///< top left corner of pict, undefined when pict is not set
2933 int y; ///< top left corner of pict, undefined when pict is not set
2934 int w; ///< width of pict, undefined when pict is not set
2935 int h; ///< height of pict, undefined when pict is not set
2936 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2939 * data+linesize for the bitmap of this subtitle.
2940 * can be set for text/ass as well once they where rendered
2943 enum AVSubtitleType type;
2945 char *text; ///< 0 terminated plain UTF-8 text
2948 * 0 terminated ASS/SSA compatible event line.
2949 * The pressentation of this is unaffected by the other values in this
2956 typedef struct AVSubtitle {
2957 uint16_t format; /* 0 = graphics */
2958 uint32_t start_display_time; /* relative to packet pts, in ms */
2959 uint32_t end_display_time; /* relative to packet pts, in ms */
2961 AVSubtitleRect **rects;
2962 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
2966 * If c is NULL, returns the first registered codec,
2967 * if c is non-NULL, returns the next registered codec after c,
2968 * or NULL if c is the last one.
2970 AVCodec *av_codec_next(const AVCodec *c);
2973 * Return the LIBAVCODEC_VERSION_INT constant.
2975 unsigned avcodec_version(void);
2978 * Return the libavcodec build-time configuration.
2980 const char *avcodec_configuration(void);
2983 * Return the libavcodec license.
2985 const char *avcodec_license(void);
2988 * Register the codec codec and initialize libavcodec.
2990 * @warning either this function or avcodec_register_all() must be called
2991 * before any other libavcodec functions.
2993 * @see avcodec_register_all()
2995 void avcodec_register(AVCodec *codec);
2998 * Register all the codecs, parsers and bitstream filters which were enabled at
2999 * configuration time. If you do not call this function you can select exactly
3000 * which formats you want to support, by using the individual registration
3003 * @see avcodec_register
3004 * @see av_register_codec_parser
3005 * @see av_register_bitstream_filter
3007 void avcodec_register_all(void);
3010 * Allocate an AVCodecContext and set its fields to default values. The
3011 * resulting struct can be deallocated by calling avcodec_close() on it followed
3014 * @param codec if non-NULL, allocate private data and initialize defaults
3015 * for the given codec. It is illegal to then call avcodec_open2()
3016 * with a different codec.
3017 * If NULL, then the codec-specific defaults won't be initialized,
3018 * which may result in suboptimal default settings (this is
3019 * important mainly for encoders, e.g. libx264).
3021 * @return An AVCodecContext filled with default values or NULL on failure.
3022 * @see avcodec_get_context_defaults
3024 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3027 * Set the fields of the given AVCodecContext to default values corresponding
3028 * to the given codec (defaults may be codec-dependent).
3030 * Do not call this function if a non-NULL codec has been passed
3031 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3032 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3033 * different codec on this AVCodecContext.
3035 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3038 * Get the AVClass for AVCodecContext. It can be used in combination with
3039 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3041 * @see av_opt_find().
3043 const AVClass *avcodec_get_class(void);
3046 * Copy the settings of the source AVCodecContext into the destination
3047 * AVCodecContext. The resulting destination codec context will be
3048 * unopened, i.e. you are required to call avcodec_open2() before you
3049 * can use this AVCodecContext to decode/encode video/audio data.
3051 * @param dest target codec context, should be initialized with
3052 * avcodec_alloc_context3(), but otherwise uninitialized
3053 * @param src source codec context
3054 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3056 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3059 * Allocate an AVFrame and set its fields to default values. The resulting
3060 * struct must be freed using avcodec_free_frame().
3062 * @return An AVFrame filled with default values or NULL on failure.
3063 * @see avcodec_get_frame_defaults
3065 AVFrame *avcodec_alloc_frame(void);
3068 * Set the fields of the given AVFrame to default values.
3070 * @param frame The AVFrame of which the fields should be set to default values.
3072 void avcodec_get_frame_defaults(AVFrame *frame);
3075 * Free the frame and any dynamically allocated objects in it,
3076 * e.g. extended_data.
3078 * @param frame frame to be freed. The pointer will be set to NULL.
3080 * @warning this function does NOT free the data buffers themselves
3081 * (it does not know how, since they might have been allocated with
3082 * a custom get_buffer()).
3084 void avcodec_free_frame(AVFrame **frame);
3087 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3088 * function the context has to be allocated with avcodec_alloc_context3().
3090 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3091 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3092 * retrieving a codec.
3094 * @warning This function is not thread safe!
3097 * avcodec_register_all();
3098 * av_dict_set(&opts, "b", "2.5M", 0);
3099 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3103 * context = avcodec_alloc_context3(codec);
3105 * if (avcodec_open2(context, codec, opts) < 0)
3109 * @param avctx The context to initialize.
3110 * @param codec The codec to open this context for. If a non-NULL codec has been
3111 * previously passed to avcodec_alloc_context3() or
3112 * avcodec_get_context_defaults3() for this context, then this
3113 * parameter MUST be either NULL or equal to the previously passed
3115 * @param options A dictionary filled with AVCodecContext and codec-private options.
3116 * On return this object will be filled with options that were not found.
3118 * @return zero on success, a negative value on error
3119 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3120 * av_dict_set(), av_opt_find().
3122 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3125 * Close a given AVCodecContext and free all the data associated with it
3126 * (but not the AVCodecContext itself).
3128 * Calling this function on an AVCodecContext that hasn't been opened will free
3129 * the codec-specific data allocated in avcodec_alloc_context3() /
3130 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3133 int avcodec_close(AVCodecContext *avctx);
3136 * Free all allocated data in the given subtitle struct.
3138 * @param sub AVSubtitle to free.
3140 void avsubtitle_free(AVSubtitle *sub);
3147 * @addtogroup lavc_packet
3151 #if FF_API_DESTRUCT_PACKET
3153 * Default packet destructor.
3154 * @deprecated use the AVBuffer API instead
3156 attribute_deprecated
3157 void av_destruct_packet(AVPacket *pkt);
3161 * Initialize optional fields of a packet with default values.
3163 * Note, this does not touch the data and size members, which have to be
3164 * initialized separately.
3168 void av_init_packet(AVPacket *pkt);
3171 * Allocate the payload of a packet and initialize its fields with
3175 * @param size wanted payload size
3176 * @return 0 if OK, AVERROR_xxx otherwise
3178 int av_new_packet(AVPacket *pkt, int size);
3181 * Reduce packet size, correctly zeroing padding
3184 * @param size new size
3186 void av_shrink_packet(AVPacket *pkt, int size);
3189 * Increase packet size, correctly zeroing padding
3192 * @param grow_by number of bytes by which to increase the size of the packet
3194 int av_grow_packet(AVPacket *pkt, int grow_by);
3197 * Initialize a reference-counted packet from av_malloc()ed data.
3199 * @param pkt packet to be initialized. This function will set the data, size,
3200 * buf and destruct fields, all others are left untouched.
3201 * @param data Data allocated by av_malloc() to be used as packet data. If this
3202 * function returns successfully, the data is owned by the underlying AVBuffer.
3203 * The caller may not access the data through other means.
3204 * @param size size of data in bytes, without the padding. I.e. the full buffer
3205 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3207 * @return 0 on success, a negative AVERROR on error
3209 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3212 * @warning This is a hack - the packet memory allocation stuff is broken. The
3213 * packet is allocated if it was not really allocated.
3215 int av_dup_packet(AVPacket *pkt);
3220 * @param pkt packet to free
3222 void av_free_packet(AVPacket *pkt);
3225 * Allocate new information of a packet.
3228 * @param type side information type
3229 * @param size side information size
3230 * @return pointer to fresh allocated data or NULL otherwise
3232 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3236 * Shrink the already allocated side data buffer
3239 * @param type side information type
3240 * @param size new side information size
3241 * @return 0 on success, < 0 on failure
3243 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3247 * Get side information from packet.
3250 * @param type desired side information type
3251 * @param size pointer for side information size to store (optional)
3252 * @return pointer to data if present or NULL otherwise
3254 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3258 * Convenience function to free all the side data stored.
3259 * All the other fields stay untouched.
3263 void av_packet_free_side_data(AVPacket *pkt);
3266 * Setup a new reference to the data described by a given packet
3268 * If src is reference-counted, setup dst as a new reference to the
3269 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3270 * data from src into it.
3272 * All the other fields are copied from src.
3274 * @see av_packet_unref
3276 * @param dst Destination packet
3277 * @param src Source packet
3279 * @return 0 on success, a negative AVERROR on error.
3281 int av_packet_ref(AVPacket *dst, AVPacket *src);
3286 * Unreference the buffer referenced by the packet and reset the
3287 * remaining packet fields to their default values.
3289 * @param pkt The packet to be unreferenced.
3291 void av_packet_unref(AVPacket *pkt);
3294 * Move every field in src to dst and reset src.
3296 * @see av_packet_unref
3298 * @param src Source packet, will be reset
3299 * @param dst Destination packet
3301 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3304 * Copy only "properties" fields from src to dst.
3306 * Properties for the purpose of this function are all the fields
3307 * beside those related to the packet data (buf, data, size)
3309 * @param dst Destination packet
3310 * @param src Source packet
3312 * @return 0 on success AVERROR on failure.
3315 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3322 * @addtogroup lavc_decoding
3327 * Find a registered decoder with a matching codec ID.
3329 * @param id AVCodecID of the requested decoder
3330 * @return A decoder if one was found, NULL otherwise.
3332 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3335 * Find a registered decoder with the specified name.
3337 * @param name name of the requested decoder
3338 * @return A decoder if one was found, NULL otherwise.
3340 AVCodec *avcodec_find_decoder_by_name(const char *name);
3342 #if FF_API_GET_BUFFER
3343 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3344 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3345 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3349 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3350 * it can be called by custom get_buffer2() implementations for decoders without
3351 * CODEC_CAP_DR1 set.
3353 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3356 * Return the amount of padding in pixels which the get_buffer callback must
3357 * provide around the edge of the image for codecs which do not have the
3358 * CODEC_FLAG_EMU_EDGE flag.
3360 * @return Required padding in pixels.
3362 unsigned avcodec_get_edge_width(void);
3365 * Modify width and height values so that they will result in a memory
3366 * buffer that is acceptable for the codec if you do not use any horizontal
3369 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3370 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3371 * according to avcodec_get_edge_width() before.
3373 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3376 * Modify width and height values so that they will result in a memory
3377 * buffer that is acceptable for the codec if you also ensure that all
3378 * line sizes are a multiple of the respective linesize_align[i].
3380 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3381 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3382 * according to avcodec_get_edge_width() before.
3384 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3385 int linesize_align[AV_NUM_DATA_POINTERS]);
3388 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3390 * Some decoders may support multiple frames in a single AVPacket. Such
3391 * decoders would then just decode the first frame and the return value would be
3392 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3393 * called again with an AVPacket containing the remaining data in order to
3394 * decode the second frame, etc... Even if no frames are returned, the packet
3395 * needs to be fed to the decoder with remaining data until it is completely
3396 * consumed or an error occurs.
3398 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3399 * and output. This means that for some packets they will not immediately
3400 * produce decoded output and need to be flushed at the end of decoding to get
3401 * all the decoded data. Flushing is done by calling this function with packets
3402 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3403 * returning samples. It is safe to flush even those decoders that are not
3404 * marked with CODEC_CAP_DELAY, then no samples will be returned.
3406 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3407 * larger than the actual read bytes because some optimized bitstream
3408 * readers read 32 or 64 bits at once and could read over the end.
3410 * @param avctx the codec context
3411 * @param[out] frame The AVFrame in which to store decoded audio samples.
3412 * The decoder will allocate a buffer for the decoded frame by
3413 * calling the AVCodecContext.get_buffer2() callback.
3414 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3415 * reference counted and the returned reference belongs to the
3416 * caller. The caller must release the frame using av_frame_unref()
3417 * when the frame is no longer needed. The caller may safely write
3418 * to the frame if av_frame_is_writable() returns 1.
3419 * When AVCodecContext.refcounted_frames is set to 0, the returned
3420 * reference belongs to the decoder and is valid only until the
3421 * next call to this function or until closing or flushing the
3422 * decoder. The caller may not write to it.
3423 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3424 * non-zero. Note that this field being set to zero
3425 * does not mean that an error has occurred. For
3426 * decoders with CODEC_CAP_DELAY set, no given decode
3427 * call is guaranteed to produce a frame.
3428 * @param[in] avpkt The input AVPacket containing the input buffer.
3429 * At least avpkt->data and avpkt->size should be set. Some
3430 * decoders might also require additional fields to be set.
3431 * @return A negative error code is returned if an error occurred during
3432 * decoding, otherwise the number of bytes consumed from the input
3433 * AVPacket is returned.
3435 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3436 int *got_frame_ptr, AVPacket *avpkt);
3439 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3440 * Some decoders may support multiple frames in a single AVPacket, such
3441 * decoders would then just decode the first frame.
3443 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3444 * the actual read bytes because some optimized bitstream readers read 32 or 64
3445 * bits at once and could read over the end.
3447 * @warning The end of the input buffer buf should be set to 0 to ensure that
3448 * no overreading happens for damaged MPEG streams.
3450 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3451 * between input and output, these need to be fed with avpkt->data=NULL,
3452 * avpkt->size=0 at the end to return the remaining frames.
3454 * @param avctx the codec context
3455 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3456 * Use av_frame_alloc() to get an AVFrame. The codec will
3457 * allocate memory for the actual bitmap by calling the
3458 * AVCodecContext.get_buffer2() callback.
3459 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3460 * reference counted and the returned reference belongs to the
3461 * caller. The caller must release the frame using av_frame_unref()
3462 * when the frame is no longer needed. The caller may safely write
3463 * to the frame if av_frame_is_writable() returns 1.
3464 * When AVCodecContext.refcounted_frames is set to 0, the returned
3465 * reference belongs to the decoder and is valid only until the
3466 * next call to this function or until closing or flushing the
3467 * decoder. The caller may not write to it.
3469 * @param[in] avpkt The input AVpacket containing the input buffer.
3470 * You can create such packet with av_init_packet() and by then setting
3471 * data and size, some decoders might in addition need other fields like
3472 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3474 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3475 * @return On error a negative value is returned, otherwise the number of bytes
3476 * used or zero if no frame could be decompressed.
3478 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3479 int *got_picture_ptr,
3483 * Decode a subtitle message.
3484 * Return a negative value on error, otherwise return the number of bytes used.
3485 * If no subtitle could be decompressed, got_sub_ptr is zero.
3486 * Otherwise, the subtitle is stored in *sub.
3487 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3488 * simplicity, because the performance difference is expect to be negligible
3489 * and reusing a get_buffer written for video codecs would probably perform badly
3490 * due to a potentially very different allocation pattern.
3492 * @param avctx the codec context
3493 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3494 freed with avsubtitle_free if *got_sub_ptr is set.
3495 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3496 * @param[in] avpkt The input AVPacket containing the input buffer.
3498 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3503 * @defgroup lavc_parsing Frame parsing
3507 enum AVPictureStructure {
3508 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3509 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3510 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3511 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3514 typedef struct AVCodecParserContext {
3516 struct AVCodecParser *parser;
3517 int64_t frame_offset; /* offset of the current frame */
3518 int64_t cur_offset; /* current offset
3519 (incremented by each av_parser_parse()) */
3520 int64_t next_frame_offset; /* offset of the next frame */
3522 int pict_type; /* XXX: Put it back in AVCodecContext. */
3524 * This field is used for proper frame duration computation in lavf.
3525 * It signals, how much longer the frame duration of the current frame
3526 * is compared to normal frame duration.
3528 * frame_duration = (1 + repeat_pict) * time_base
3530 * It is used by codecs like H.264 to display telecined material.
3532 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3533 int64_t pts; /* pts of the current frame */
3534 int64_t dts; /* dts of the current frame */
3539 int fetch_timestamp;
3541 #define AV_PARSER_PTS_NB 4
3542 int cur_frame_start_index;
3543 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3544 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3545 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3548 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3549 #define PARSER_FLAG_ONCE 0x0002
3550 /// Set if the parser has a valid file offset
3551 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3553 int64_t offset; ///< byte offset from starting packet start
3554 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3557 * Set by parser to 1 for key frames and 0 for non-key frames.
3558 * It is initialized to -1, so if the parser doesn't set this flag,
3559 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3565 * Time difference in stream time base units from the pts of this
3566 * packet to the point at which the output from the decoder has converged
3567 * independent from the availability of previous frames. That is, the
3568 * frames are virtually identical no matter if decoding started from
3569 * the very first frame or from this keyframe.
3570 * Is AV_NOPTS_VALUE if unknown.
3571 * This field is not the display duration of the current frame.
3572 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3575 * The purpose of this field is to allow seeking in streams that have no
3576 * keyframes in the conventional sense. It corresponds to the
3577 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3578 * essential for some types of subtitle streams to ensure that all
3579 * subtitles are correctly displayed after seeking.
3581 int64_t convergence_duration;
3583 // Timestamp generation support:
3585 * Synchronization point for start of timestamp generation.
3587 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3590 * For example, this corresponds to presence of H.264 buffering period
3596 * Offset of the current timestamp against last timestamp sync point in
3597 * units of AVCodecContext.time_base.
3599 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3600 * contain a valid timestamp offset.
3602 * Note that the timestamp of sync point has usually a nonzero
3603 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3604 * the next frame after timestamp sync point will be usually 1.
3606 * For example, this corresponds to H.264 cpb_removal_delay.
3608 int dts_ref_dts_delta;
3611 * Presentation delay of current frame in units of AVCodecContext.time_base.
3613 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3614 * contain valid non-negative timestamp delta (presentation time of a frame
3615 * must not lie in the past).
3617 * This delay represents the difference between decoding and presentation
3618 * time of the frame.
3620 * For example, this corresponds to H.264 dpb_output_delay.
3625 * Position of the packet in file.
3627 * Analogous to cur_frame_pts/dts
3629 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3632 * Byte position of currently parsed frame in stream.
3637 * Previous frame byte position.
3642 * Duration of the current frame.
3643 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3644 * For all other types, this is in units of AVCodecContext.time_base.
3648 enum AVFieldOrder field_order;
3651 * Indicate whether a picture is coded as a frame, top field or bottom field.
3653 * For example, H.264 field_pic_flag equal to 0 corresponds to
3654 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3655 * equal to 1 and bottom_field_flag equal to 0 corresponds to
3656 * AV_PICTURE_STRUCTURE_TOP_FIELD.
3658 enum AVPictureStructure picture_structure;
3661 * Picture number incremented in presentation or output order.
3662 * This field may be reinitialized at the first picture of a new sequence.
3664 * For example, this corresponds to H.264 PicOrderCnt.
3666 int output_picture_number;
3667 } AVCodecParserContext;
3669 typedef struct AVCodecParser {
3670 int codec_ids[5]; /* several codec IDs are permitted */
3672 int (*parser_init)(AVCodecParserContext *s);
3673 int (*parser_parse)(AVCodecParserContext *s,
3674 AVCodecContext *avctx,
3675 const uint8_t **poutbuf, int *poutbuf_size,
3676 const uint8_t *buf, int buf_size);
3677 void (*parser_close)(AVCodecParserContext *s);
3678 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3679 struct AVCodecParser *next;
3682 AVCodecParser *av_parser_next(AVCodecParser *c);
3684 void av_register_codec_parser(AVCodecParser *parser);
3685 AVCodecParserContext *av_parser_init(int codec_id);
3690 * @param s parser context.
3691 * @param avctx codec context.
3692 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3693 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3694 * @param buf input buffer.
3695 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3696 * @param pts input presentation timestamp.
3697 * @param dts input decoding timestamp.
3698 * @param pos input byte position in stream.
3699 * @return the number of bytes of the input bitstream used.
3704 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3711 * decode_frame(data, size);
3715 int av_parser_parse2(AVCodecParserContext *s,
3716 AVCodecContext *avctx,
3717 uint8_t **poutbuf, int *poutbuf_size,
3718 const uint8_t *buf, int buf_size,
3719 int64_t pts, int64_t dts,
3723 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3724 * @deprecated use AVBitstreamFilter
3726 int av_parser_change(AVCodecParserContext *s,
3727 AVCodecContext *avctx,
3728 uint8_t **poutbuf, int *poutbuf_size,
3729 const uint8_t *buf, int buf_size, int keyframe);
3730 void av_parser_close(AVCodecParserContext *s);
3738 * @addtogroup lavc_encoding
3743 * Find a registered encoder with a matching codec ID.
3745 * @param id AVCodecID of the requested encoder
3746 * @return An encoder if one was found, NULL otherwise.
3748 AVCodec *avcodec_find_encoder(enum AVCodecID id);
3751 * Find a registered encoder with the specified name.
3753 * @param name name of the requested encoder
3754 * @return An encoder if one was found, NULL otherwise.
3756 AVCodec *avcodec_find_encoder_by_name(const char *name);
3759 * Encode a frame of audio.
3761 * Takes input samples from frame and writes the next output packet, if
3762 * available, to avpkt. The output packet does not necessarily contain data for
3763 * the most recent frame, as encoders can delay, split, and combine input frames
3764 * internally as needed.
3766 * @param avctx codec context
3767 * @param avpkt output AVPacket.
3768 * The user can supply an output buffer by setting
3769 * avpkt->data and avpkt->size prior to calling the
3770 * function, but if the size of the user-provided data is not
3771 * large enough, encoding will fail. All other AVPacket fields
3772 * will be reset by the encoder using av_init_packet(). If
3773 * avpkt->data is NULL, the encoder will allocate it.
3774 * The encoder will set avpkt->size to the size of the
3777 * If this function fails or produces no output, avpkt will be
3778 * freed using av_free_packet() (i.e. avpkt->destruct will be
3779 * called to free the user supplied buffer).
3780 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3781 * May be NULL when flushing an encoder that has the
3782 * CODEC_CAP_DELAY capability set.
3783 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3784 * can have any number of samples.
3785 * If it is not set, frame->nb_samples must be equal to
3786 * avctx->frame_size for all frames except the last.
3787 * The final frame may be smaller than avctx->frame_size.
3788 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3789 * output packet is non-empty, and to 0 if it is
3790 * empty. If the function returns an error, the
3791 * packet can be assumed to be invalid, and the
3792 * value of got_packet_ptr is undefined and should
3794 * @return 0 on success, negative error code on failure
3796 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3797 const AVFrame *frame, int *got_packet_ptr);
3800 * Encode a frame of video.
3802 * Takes input raw video data from frame and writes the next output packet, if
3803 * available, to avpkt. The output packet does not necessarily contain data for
3804 * the most recent frame, as encoders can delay and reorder input frames
3805 * internally as needed.
3807 * @param avctx codec context
3808 * @param avpkt output AVPacket.
3809 * The user can supply an output buffer by setting
3810 * avpkt->data and avpkt->size prior to calling the
3811 * function, but if the size of the user-provided data is not
3812 * large enough, encoding will fail. All other AVPacket fields
3813 * will be reset by the encoder using av_init_packet(). If
3814 * avpkt->data is NULL, the encoder will allocate it.
3815 * The encoder will set avpkt->size to the size of the
3816 * output packet. The returned data (if any) belongs to the
3817 * caller, he is responsible for freeing it.
3819 * If this function fails or produces no output, avpkt will be
3820 * freed using av_free_packet() (i.e. avpkt->destruct will be
3821 * called to free the user supplied buffer).
3822 * @param[in] frame AVFrame containing the raw video data to be encoded.
3823 * May be NULL when flushing an encoder that has the
3824 * CODEC_CAP_DELAY capability set.
3825 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3826 * output packet is non-empty, and to 0 if it is
3827 * empty. If the function returns an error, the
3828 * packet can be assumed to be invalid, and the
3829 * value of got_packet_ptr is undefined and should
3831 * @return 0 on success, negative error code on failure
3833 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3834 const AVFrame *frame, int *got_packet_ptr);
3836 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3837 const AVSubtitle *sub);
3845 * @addtogroup lavc_picture
3850 * Allocate memory for a picture. Call avpicture_free() to free it.
3852 * @see avpicture_fill()
3854 * @param picture the picture to be filled in
3855 * @param pix_fmt the format of the picture
3856 * @param width the width of the picture
3857 * @param height the height of the picture
3858 * @return zero if successful, a negative value if not
3860 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
3863 * Free a picture previously allocated by avpicture_alloc().
3864 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3867 * @param picture the AVPicture to be freed
3869 void avpicture_free(AVPicture *picture);
3872 * Fill in the AVPicture fields.
3873 * The fields of the given AVPicture are filled in by using the 'ptr' address
3874 * which points to the image data buffer. Depending on the specified picture
3875 * format, one or multiple image data pointers and line sizes will be set.
3876 * If a planar format is specified, several pointers will be set pointing to
3877 * the different picture planes and the line sizes of the different planes
3878 * will be stored in the lines_sizes array.
3879 * Call with ptr == NULL to get the required size for the ptr buffer.
3881 * To allocate the buffer and fill in the AVPicture fields in one call,
3882 * use avpicture_alloc().
3884 * @param picture AVPicture whose fields are to be filled in
3885 * @param ptr Buffer which will contain or contains the actual image data
3886 * @param pix_fmt The format in which the picture data is stored.
3887 * @param width the width of the image in pixels
3888 * @param height the height of the image in pixels
3889 * @return size of the image data in bytes
3891 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3892 enum AVPixelFormat pix_fmt, int width, int height);
3895 * Copy pixel data from an AVPicture into a buffer.
3896 * The data is stored compactly, without any gaps for alignment or padding
3897 * which may be applied by avpicture_fill().
3899 * @see avpicture_get_size()
3901 * @param[in] src AVPicture containing image data
3902 * @param[in] pix_fmt The format in which the picture data is stored.
3903 * @param[in] width the width of the image in pixels.
3904 * @param[in] height the height of the image in pixels.
3905 * @param[out] dest A buffer into which picture data will be copied.
3906 * @param[in] dest_size The size of 'dest'.
3907 * @return The number of bytes written to dest, or a negative value (error code) on error.
3909 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
3910 int width, int height,
3911 unsigned char *dest, int dest_size);
3914 * Calculate the size in bytes that a picture of the given width and height
3915 * would occupy if stored in the given picture format.
3916 * Note that this returns the size of a compact representation as generated
3917 * by avpicture_layout(), which can be smaller than the size required for e.g.
3920 * @param pix_fmt the given picture format
3921 * @param width the width of the image
3922 * @param height the height of the image
3923 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3925 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
3927 #if FF_API_DEINTERLACE
3929 * deinterlace - if not supported return -1
3931 * @deprecated - use yadif (in libavfilter) instead
3933 attribute_deprecated
3934 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3935 enum AVPixelFormat pix_fmt, int width, int height);
3938 * Copy image src to dst. Wraps av_picture_data_copy() above.
3940 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3941 enum AVPixelFormat pix_fmt, int width, int height);
3944 * Crop image top and left side.
3946 int av_picture_crop(AVPicture *dst, const AVPicture *src,
3947 enum AVPixelFormat pix_fmt, int top_band, int left_band);
3952 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
3953 int padtop, int padbottom, int padleft, int padright, int *color);
3960 * @defgroup lavc_misc Utility functions
3963 * Miscellaneous utility functions related to both encoding and decoding
3969 * @defgroup lavc_misc_pixfmt Pixel formats
3971 * Functions for working with pixel formats.
3976 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
3979 void attribute_deprecated avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
3982 * Return a value representing the fourCC code associated to the
3983 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3986 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
3988 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3989 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3990 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3991 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3992 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3993 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3996 * Compute what kind of losses will occur when converting from one specific
3997 * pixel format to another.
3998 * When converting from one pixel format to another, information loss may occur.
3999 * For example, when converting from RGB24 to GRAY, the color information will
4000 * be lost. Similarly, other losses occur when converting from some formats to
4001 * other formats. These losses can involve loss of chroma, but also loss of
4002 * resolution, loss of color depth, loss due to the color space conversion, loss
4003 * of the alpha bits or loss due to color quantization.
4004 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4005 * which will occur when converting from one pixel format to another.
4007 * @param[in] dst_pix_fmt destination pixel format
4008 * @param[in] src_pix_fmt source pixel format
4009 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4010 * @return Combination of flags informing you what kind of losses will occur.
4012 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4016 * Find the best pixel format to convert to given a certain source pixel
4017 * format. When converting from one pixel format to another, information loss
4018 * may occur. For example, when converting from RGB24 to GRAY, the color
4019 * information will be lost. Similarly, other losses occur when converting from
4020 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4021 * the given pixel formats should be used to suffer the least amount of loss.
4022 * The pixel formats from which it chooses one, are determined by the
4023 * pix_fmt_list parameter.
4026 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4027 * @param[in] src_pix_fmt source pixel format
4028 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4029 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4030 * @return The best pixel format to convert to or -1 if none was found.
4032 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4033 enum AVPixelFormat src_pix_fmt,
4034 int has_alpha, int *loss_ptr);
4036 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4042 #if FF_API_SET_DIMENSIONS
4044 * @deprecated this function is not supposed to be used from outside of lavc
4046 attribute_deprecated
4047 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4051 * Put a string representing the codec tag codec_tag in buf.
4053 * @param buf_size size in bytes of buf
4054 * @return the length of the string that would have been generated if
4055 * enough space had been available, excluding the trailing null
4057 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4059 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4062 * Return a name for the specified profile, if available.
4064 * @param codec the codec that is searched for the given profile
4065 * @param profile the profile value for which a name is requested
4066 * @return A name for the profile if found, NULL otherwise.
4068 const char *av_get_profile_name(const AVCodec *codec, int profile);
4070 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4071 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4072 //FIXME func typedef
4075 * Fill audio frame data and linesize.
4076 * AVFrame extended_data channel pointers are allocated if necessary for
4079 * @param frame the AVFrame
4080 * frame->nb_samples must be set prior to calling the
4081 * function. This function fills in frame->data,
4082 * frame->extended_data, frame->linesize[0].
4083 * @param nb_channels channel count
4084 * @param sample_fmt sample format
4085 * @param buf buffer to use for frame data
4086 * @param buf_size size of buffer
4087 * @param align plane size sample alignment (0 = default)
4088 * @return 0 on success, negative error code on failure
4090 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4091 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4092 int buf_size, int align);
4095 * Reset the internal decoder state / flush internal buffers. Should be called
4096 * e.g. when seeking or when switching to a different stream.
4098 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4099 * this invalidates the frames previously returned from the decoder. When
4100 * refcounted frames are used, the decoder just releases any references it might
4101 * keep internally, but the caller's reference remains valid.
4103 void avcodec_flush_buffers(AVCodecContext *avctx);
4106 * Return codec bits per sample.
4108 * @param[in] codec_id the codec
4109 * @return Number of bits per sample or zero if unknown for the given codec.
4111 int av_get_bits_per_sample(enum AVCodecID codec_id);
4114 * Return codec bits per sample.
4115 * Only return non-zero if the bits per sample is exactly correct, not an
4118 * @param[in] codec_id the codec
4119 * @return Number of bits per sample or zero if unknown for the given codec.
4121 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4124 * Return audio frame duration.
4126 * @param avctx codec context
4127 * @param frame_bytes size of the frame, or 0 if unknown
4128 * @return frame duration, in samples, if known. 0 if not able to
4131 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4134 typedef struct AVBitStreamFilterContext {
4136 struct AVBitStreamFilter *filter;
4137 AVCodecParserContext *parser;
4138 struct AVBitStreamFilterContext *next;
4139 } AVBitStreamFilterContext;
4142 typedef struct AVBitStreamFilter {
4145 int (*filter)(AVBitStreamFilterContext *bsfc,
4146 AVCodecContext *avctx, const char *args,
4147 uint8_t **poutbuf, int *poutbuf_size,
4148 const uint8_t *buf, int buf_size, int keyframe);
4149 void (*close)(AVBitStreamFilterContext *bsfc);
4150 struct AVBitStreamFilter *next;
4151 } AVBitStreamFilter;
4153 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4154 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4155 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4156 AVCodecContext *avctx, const char *args,
4157 uint8_t **poutbuf, int *poutbuf_size,
4158 const uint8_t *buf, int buf_size, int keyframe);
4159 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4161 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4166 * Reallocate the given block if it is not large enough, otherwise do nothing.
4170 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4173 * Allocate a buffer, reusing the given one if large enough.
4175 * Contrary to av_fast_realloc the current buffer contents might not be
4176 * preserved and on error the old buffer is freed, thus no special
4177 * handling to avoid memleaks is necessary.
4179 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4180 * @param size size of the buffer *ptr points to
4181 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4182 * *size 0 if an error occurred.
4184 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4187 * Allocate a buffer with padding, reusing the given one if large enough.
4189 * Same behaviour av_fast_malloc but the buffer has additional
4190 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4193 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4196 * Encode extradata length to a buffer. Used by xiph codecs.
4198 * @param s buffer to write to; must be at least (v/255+1) bytes long
4199 * @param v size of extradata in bytes
4200 * @return number of bytes written to the buffer.
4202 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4204 #if FF_API_MISSING_SAMPLE
4206 * Log a generic warning message about a missing feature. This function is
4207 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4208 * only, and would normally not be used by applications.
4209 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4210 * a pointer to an AVClass struct
4211 * @param[in] feature string containing the name of the missing feature
4212 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4213 * If want_sample is non-zero, additional verbage will be added to the log
4214 * message which tells the user how to report samples to the development
4216 * @deprecated Use avpriv_report_missing_feature() instead.
4218 attribute_deprecated
4219 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4222 * Log a generic warning message asking for a sample. This function is
4223 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4224 * only, and would normally not be used by applications.
4225 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4226 * a pointer to an AVClass struct
4227 * @param[in] msg string containing an optional message, or NULL if no message
4228 * @deprecated Use avpriv_request_sample() instead.
4230 attribute_deprecated
4231 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4232 #endif /* FF_API_MISSING_SAMPLE */
4235 * Register the hardware accelerator hwaccel.
4237 void av_register_hwaccel(AVHWAccel *hwaccel);
4240 * If hwaccel is NULL, returns the first registered hardware accelerator,
4241 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4242 * after hwaccel, or NULL if hwaccel is the last one.
4244 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4248 * Lock operation used by lockmgr
4251 AV_LOCK_CREATE, ///< Create a mutex
4252 AV_LOCK_OBTAIN, ///< Lock the mutex
4253 AV_LOCK_RELEASE, ///< Unlock the mutex
4254 AV_LOCK_DESTROY, ///< Free mutex resources
4258 * Register a user provided lock manager supporting the operations
4259 * specified by AVLockOp. mutex points to a (void *) where the
4260 * lockmgr should store/get a pointer to a user allocated mutex. It's
4261 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4263 * @param cb User defined callback. Note: Libav may invoke calls to this
4264 * callback during the call to av_lockmgr_register().
4265 * Thus, the application must be prepared to handle that.
4266 * If cb is set to NULL the lockmgr will be unregistered.
4267 * Also note that during unregistration the previously registered
4268 * lockmgr callback may also be invoked.
4270 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4273 * Get the type of the given codec.
4275 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4278 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4279 * with no corresponding avcodec_close()), 0 otherwise.
4281 int avcodec_is_open(AVCodecContext *s);
4284 * @return a non-zero number if codec is an encoder, zero otherwise
4286 int av_codec_is_encoder(const AVCodec *codec);
4289 * @return a non-zero number if codec is a decoder, zero otherwise
4291 int av_codec_is_decoder(const AVCodec *codec);
4294 * @return descriptor for given codec ID or NULL if no descriptor exists.
4296 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4299 * Iterate over all codec descriptors known to libavcodec.
4301 * @param prev previous descriptor. NULL to get the first descriptor.
4303 * @return next descriptor or NULL after the last descriptor
4305 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4308 * @return codec descriptor with the given name or NULL if no such descriptor
4311 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4317 #endif /* AVCODEC_AVCODEC_H */